Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b2cdd8046ef553a79d31cf0d6822482f76086ba4 / . / docs / epy / oauth2client.crypt-module.html
blob: 1853aa3482e6886099cb79f42b788fb47d0abe81 [file] [log] [blame]
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]1<?xml version="1.0" encoding="ascii"?>
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "DTD/xhtml1-transitional.dtd">
4<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
5<head>
6 <title>oauth2client.crypt</title>
7 <link rel="stylesheet" href="epydoc.css" type="text/css" />
8 <script type="text/javascript" src="epydoc.js"></script>
9</head>
10
11<body bgcolor="white" text="black" link="blue" vlink="#204080"
12 alink="#204080">
13<!-- ==================== NAVIGATION BAR ==================== -->
14<table class="navbar" border="0" width="100%" cellpadding="0"
15 bgcolor="#a0c0ff" cellspacing="0">
16 <tr valign="middle">
17
18 <!-- Tree link -->
19 <th>&nbsp;&nbsp;&nbsp;<a
20 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
21
22 <!-- Index link -->
23 <th>&nbsp;&nbsp;&nbsp;<a
24 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
25
26 <!-- Help link -->
27 <th>&nbsp;&nbsp;&nbsp;<a
28 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
29
30 <th class="navbar" width="100%"></th>
31 </tr>
32</table>
33<table width="100%" cellpadding="0" cellspacing="0">
34 <tr valign="top">
35 <td width="100%">
36 <span class="breadcrumbs">
37 <a href="oauth2client-module.html">Package&nbsp;oauth2client</a> ::
38 Module&nbsp;crypt
39 </span>
40 </td>
41 <td>
42 <table cellpadding="0" cellspacing="0">
43 <!-- hide/show private -->
44 <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
45 onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
46 <tr><td align="right"><span class="options"
47 >[<a href="frames.html" target="_top">frames</a
48 >]&nbsp;|&nbsp;<a href="oauth2client.crypt-module.html"
49 target="_top">no&nbsp;frames</a>]</span></td></tr>
50 </table>
51 </td>
52 </tr>
53</table>
54<!-- ==================== MODULE DESCRIPTION ==================== -->
55<h1 class="epydoc">Module crypt</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.crypt-pysrc.html">source&nbsp;code</a></span></p>
56<!-- ==================== CLASSES ==================== -->
57<a name="section-Classes"></a>
58<table class="summary" border="1" cellpadding="3"
59 cellspacing="0" width="100%" bgcolor="white">
60<tr bgcolor="#70b0f0" class="table-header">
61 <td colspan="2" class="table-header">
62 <table border="0" cellpadding="0" cellspacing="0" width="100%">
63 <tr valign="top">
64 <td align="left"><span class="table-header">Classes</span></td>
65 <td align="right" valign="top"
66 ><span class="options">[<a href="#section-Classes"
67 class="privatelink" onclick="toggle_private();"
68 >hide private</a>]</span></td>
69 </tr>
70 </table>
71 </td>
72</tr>
73<tr>
74 <td width="15%" align="right" valign="top" class="summary">
75 <span class="summary-type">&nbsp;</span>
76 </td><td class="summary">
77 <a href="oauth2client.crypt.AppIdentityError-class.html" class="summary-name">AppIdentityError</a>
78 </td>
79 </tr>
80<tr>
81 <td width="15%" align="right" valign="top" class="summary">
82 <span class="summary-type">&nbsp;</span>
83 </td><td class="summary">
84 <a href="oauth2client.crypt.Verifier-class.html" class="summary-name">Verifier</a><br />
85 Verifies the signature on a message.
86 </td>
87 </tr>
88<tr>
89 <td width="15%" align="right" valign="top" class="summary">
90 <span class="summary-type">&nbsp;</span>
91 </td><td class="summary">
92 <a href="oauth2client.crypt.Signer-class.html" class="summary-name">Signer</a><br />
93 Signs messages with a private key.
94 </td>
95 </tr>
96</table>
97<!-- ==================== FUNCTIONS ==================== -->
98<a name="section-Functions"></a>
99<table class="summary" border="1" cellpadding="3"
100 cellspacing="0" width="100%" bgcolor="white">
101<tr bgcolor="#70b0f0" class="table-header">
102 <td colspan="2" class="table-header">
103 <table border="0" cellpadding="0" cellspacing="0" width="100%">
104 <tr valign="top">
105 <td align="left"><span class="table-header">Functions</span></td>
106 <td align="right" valign="top"
107 ><span class="options">[<a href="#section-Functions"
108 class="privatelink" onclick="toggle_private();"
109 >hide private</a>]</span></td>
110 </tr>
111 </table>
112 </td>
113</tr>
114<tr class="private">
115 <td width="15%" align="right" valign="top" class="summary">
116 <span class="summary-type">&nbsp;</span>
117 </td><td class="summary">
118 <table width="100%" cellpadding="0" cellspacing="0" border="0">
119 <tr>
120 <td><span class="summary-sig"><a name="_urlsafe_b64encode"></a><span class="summary-sig-name">_urlsafe_b64encode</span>(<span class="summary-sig-arg">raw_bytes</span>)</span></td>
121 <td align="right" valign="top">
122 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#_urlsafe_b64encode">source&nbsp;code</a></span>
123
124 </td>
125 </tr>
126 </table>
127
128 </td>
129 </tr>
130<tr class="private">
131 <td width="15%" align="right" valign="top" class="summary">
132 <span class="summary-type">&nbsp;</span>
133 </td><td class="summary">
134 <table width="100%" cellpadding="0" cellspacing="0" border="0">
135 <tr>
136 <td><span class="summary-sig"><a name="_urlsafe_b64decode"></a><span class="summary-sig-name">_urlsafe_b64decode</span>(<span class="summary-sig-arg">b64string</span>)</span></td>
137 <td align="right" valign="top">
138 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#_urlsafe_b64decode">source&nbsp;code</a></span>
139
140 </td>
141 </tr>
142 </table>
143
144 </td>
145 </tr>
146<tr class="private">
147 <td width="15%" align="right" valign="top" class="summary">
148 <span class="summary-type">&nbsp;</span>
149 </td><td class="summary">
150 <table width="100%" cellpadding="0" cellspacing="0" border="0">
151 <tr>
152 <td><span class="summary-sig"><a name="_json_encode"></a><span class="summary-sig-name">_json_encode</span>(<span class="summary-sig-arg">data</span>)</span></td>
153 <td align="right" valign="top">
154 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#_json_encode">source&nbsp;code</a></span>
155
156 </td>
157 </tr>
158 </table>
159
160 </td>
161 </tr>
162<tr>
163 <td width="15%" align="right" valign="top" class="summary">
164 <span class="summary-type">&nbsp;</span>
165 </td><td class="summary">
166 <table width="100%" cellpadding="0" cellspacing="0" border="0">
167 <tr>
168 <td><span class="summary-sig"><a href="oauth2client.crypt-module.html#make_signed_jwt" class="summary-sig-name">make_signed_jwt</a>(<span class="summary-sig-arg">signer</span>,
169 <span class="summary-sig-arg">payload</span>)</span><br />
170 Make a signed JWT.</td>
171 <td align="right" valign="top">
172 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#make_signed_jwt">source&nbsp;code</a></span>
173
174 </td>
175 </tr>
176 </table>
177
178 </td>
179 </tr>
180<tr>
181 <td width="15%" align="right" valign="top" class="summary">
182 <span class="summary-type">&nbsp;</span>
183 </td><td class="summary">
184 <table width="100%" cellpadding="0" cellspacing="0" border="0">
185 <tr>
186 <td><span class="summary-sig"><a href="oauth2client.crypt-module.html#verify_signed_jwt_with_certs" class="summary-sig-name">verify_signed_jwt_with_certs</a>(<span class="summary-sig-arg">jwt</span>,
187 <span class="summary-sig-arg">certs</span>,
188 <span class="summary-sig-arg">audience</span>)</span><br />
189 Verify a JWT against public certs.</td>
190 <td align="right" valign="top">
191 <span class="codelink"><a href="oauth2client.crypt-pysrc.html#verify_signed_jwt_with_certs">source&nbsp;code</a></span>
192
193 </td>
194 </tr>
195 </table>
196
197 </td>
198 </tr>
199</table>
200<!-- ==================== VARIABLES ==================== -->
201<a name="section-Variables"></a>
202<table class="summary" border="1" cellpadding="3"
203 cellspacing="0" width="100%" bgcolor="white">
204<tr bgcolor="#70b0f0" class="table-header">
205 <td colspan="2" class="table-header">
206 <table border="0" cellpadding="0" cellspacing="0" width="100%">
207 <tr valign="top">
208 <td align="left"><span class="table-header">Variables</span></td>
209 <td align="right" valign="top"
210 ><span class="options">[<a href="#section-Variables"
211 class="privatelink" onclick="toggle_private();"
212 >hide private</a>]</span></td>
213 </tr>
214 </table>
215 </td>
216</tr>
217<tr>
218 <td width="15%" align="right" valign="top" class="summary">
219 <span class="summary-type">&nbsp;</span>
220 </td><td class="summary">
Joe Gregorioe7a0c472012-07-12 11:46:04 -0400[diff] [blame]221 <a name="logger"></a><span class="summary-name">logger</span> = <code title="logging.getLogger(__name__)">logging.getLogger(__name__)</code>
222 </td>
223 </tr>
224<tr>
225 <td width="15%" align="right" valign="top" class="summary">
226 <span class="summary-type">&nbsp;</span>
227 </td><td class="summary">
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]228 <a name="CLOCK_SKEW_SECS"></a><span class="summary-name">CLOCK_SKEW_SECS</span> = <code title="300">300</code>
229 </td>
230 </tr>
231<tr>
232 <td width="15%" align="right" valign="top" class="summary">
233 <span class="summary-type">&nbsp;</span>
234 </td><td class="summary">
235 <a name="AUTH_TOKEN_LIFETIME_SECS"></a><span class="summary-name">AUTH_TOKEN_LIFETIME_SECS</span> = <code title="300">300</code>
236 </td>
237 </tr>
238<tr>
239 <td width="15%" align="right" valign="top" class="summary">
240 <span class="summary-type">&nbsp;</span>
241 </td><td class="summary">
242 <a name="MAX_TOKEN_LIFETIME_SECS"></a><span class="summary-name">MAX_TOKEN_LIFETIME_SECS</span> = <code title="86400">86400</code>
243 </td>
244 </tr>
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]245</table>
246<!-- ==================== FUNCTION DETAILS ==================== -->
247<a name="section-FunctionDetails"></a>
248<table class="details" border="1" cellpadding="3"
249 cellspacing="0" width="100%" bgcolor="white">
250<tr bgcolor="#70b0f0" class="table-header">
251 <td colspan="2" class="table-header">
252 <table border="0" cellpadding="0" cellspacing="0" width="100%">
253 <tr valign="top">
254 <td align="left"><span class="table-header">Function Details</span></td>
255 <td align="right" valign="top"
256 ><span class="options">[<a href="#section-FunctionDetails"
257 class="privatelink" onclick="toggle_private();"
258 >hide private</a>]</span></td>
259 </tr>
260 </table>
261 </td>
262</tr>
263</table>
264<a name="make_signed_jwt"></a>
265<div>
266<table class="details" border="1" cellpadding="3"
267 cellspacing="0" width="100%" bgcolor="white">
268<tr><td>
269 <table width="100%" cellpadding="0" cellspacing="0" border="0">
270 <tr valign="top"><td>
271 <h3 class="epydoc"><span class="sig"><span class="sig-name">make_signed_jwt</span>(<span class="sig-arg">signer</span>,
272 <span class="sig-arg">payload</span>)</span>
273 </h3>
274 </td><td align="right" valign="top"
275 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#make_signed_jwt">source&nbsp;code</a></span>&nbsp;
276 </td>
277 </tr></table>
278
279 <pre class="literalblock">
280Make a signed JWT.
281
282See http://self-issued.info/docs/draft-jones-json-web-token.html.
283
284Args:
285 signer: crypt.Signer, Cryptographic signer.
286 payload: dict, Dictionary of data to convert to JSON and then sign.
287
288Returns:
289 string, The JWT for the payload.
290
291</pre>
292 <dl class="fields">
293 </dl>
294</td></tr></table>
295</div>
296<a name="verify_signed_jwt_with_certs"></a>
297<div>
298<table class="details" border="1" cellpadding="3"
299 cellspacing="0" width="100%" bgcolor="white">
300<tr><td>
301 <table width="100%" cellpadding="0" cellspacing="0" border="0">
302 <tr valign="top"><td>
303 <h3 class="epydoc"><span class="sig"><span class="sig-name">verify_signed_jwt_with_certs</span>(<span class="sig-arg">jwt</span>,
304 <span class="sig-arg">certs</span>,
305 <span class="sig-arg">audience</span>)</span>
306 </h3>
307 </td><td align="right" valign="top"
308 ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#verify_signed_jwt_with_certs">source&nbsp;code</a></span>&nbsp;
309 </td>
310 </tr></table>
311
312 <pre class="literalblock">
313Verify a JWT against public certs.
314
315See http://self-issued.info/docs/draft-jones-json-web-token.html.
316
317Args:
318 jwt: string, A JWT.
319 certs: dict, Dictionary where values of public keys in PEM format.
320 audience: string, The audience, 'aud', that this JWT should contain. If
321 None then the JWT's 'aud' parameter is not verified.
322
323Returns:
324 dict, The deserialized JSON payload in the JWT.
325
326Raises:
327 AppIdentityError if any checks are failed.
328
329</pre>
330 <dl class="fields">
331 </dl>
332</td></tr></table>
333</div>
334<br />
335<!-- ==================== NAVIGATION BAR ==================== -->
336<table class="navbar" border="0" width="100%" cellpadding="0"
337 bgcolor="#a0c0ff" cellspacing="0">
338 <tr valign="middle">
339
340 <!-- Tree link -->
341 <th>&nbsp;&nbsp;&nbsp;<a
342 href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
343
344 <!-- Index link -->
345 <th>&nbsp;&nbsp;&nbsp;<a
346 href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
347
348 <!-- Help link -->
349 <th>&nbsp;&nbsp;&nbsp;<a
350 href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
351
352 <th class="navbar" width="100%"></th>
353 </tr>
354</table>
355<table border="0" cellpadding="0" cellspacing="0" width="100%%">
356 <tr>
357 <td align="left" class="footer">
Joe Gregoriob2cdd802012-11-06 12:08:06 -0500[diff] [blame^]358 Generated by Epydoc 3.0.1 on Tue Nov 6 12:07:10 2012
Joe Gregorio5dc0f5c2012-06-05 13:34:31 -0400[diff] [blame]359 </td>
360 <td align="right" class="footer">
361 <a target="mainFrame" href="http://epydoc.sourceforge.net"
362 >http://epydoc.sourceforge.net</a>
363 </td>
364 </tr>
365</table>
366
367<script type="text/javascript">
368 <!--
369 // Private objects are initially displayed (because if
370 // javascript is turned off then we want them to be
371 // visible); but by default, we want to hide them. So hide
372 // them unless we have a cookie that says to show them.
373 checkCookie();
374 // -->
375</script>
376</body>
377</html>