Index: docs/epy/oauth2client.crypt-module.html |
=================================================================== |
new file mode 100644 |
--- /dev/null |
+++ b/docs/epy/oauth2client.crypt-module.html |
@@ -0,0 +1,377 @@ |
+<?xml version="1.0" encoding="ascii"?> |
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" |
+ "DTD/xhtml1-transitional.dtd"> |
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
+<head> |
+ <title>oauth2client.crypt</title> |
+ <link rel="stylesheet" href="epydoc.css" type="text/css" /> |
+ <script type="text/javascript" src="epydoc.js"></script> |
+</head> |
+ |
+<body bgcolor="white" text="black" link="blue" vlink="#204080" |
+ alink="#204080"> |
+<!-- ==================== NAVIGATION BAR ==================== --> |
+<table class="navbar" border="0" width="100%" cellpadding="0" |
+ bgcolor="#a0c0ff" cellspacing="0"> |
+ <tr valign="middle"> |
+ |
+ <!-- Tree link --> |
+ <th> <a |
+ href="module-tree.html">Trees</a> </th> |
+ |
+ <!-- Index link --> |
+ <th> <a |
+ href="identifier-index.html">Indices</a> </th> |
+ |
+ <!-- Help link --> |
+ <th> <a |
+ href="help.html">Help</a> </th> |
+ |
+ <th class="navbar" width="100%"></th> |
+ </tr> |
+</table> |
+<table width="100%" cellpadding="0" cellspacing="0"> |
+ <tr valign="top"> |
+ <td width="100%"> |
+ <span class="breadcrumbs"> |
+ <a href="oauth2client-module.html">Package oauth2client</a> :: |
+ Module crypt |
+ </span> |
+ </td> |
+ <td> |
+ <table cellpadding="0" cellspacing="0"> |
+ <!-- hide/show private --> |
+ <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink" |
+ onclick="toggle_private();">hide private</a>]</span></td></tr> |
+ <tr><td align="right"><span class="options" |
+ >[<a href="frames.html" target="_top">frames</a |
+ >] | <a href="oauth2client.crypt-module.html" |
+ target="_top">no frames</a>]</span></td></tr> |
+ </table> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== MODULE DESCRIPTION ==================== --> |
+<h1 class="epydoc">Module crypt</h1><p class="nomargin-top"><span class="codelink"><a href="oauth2client.crypt-pysrc.html">source code</a></span></p> |
+<!-- ==================== CLASSES ==================== --> |
+<a name="section-Classes"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Classes</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-Classes" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a href="oauth2client.crypt.AppIdentityError-class.html" class="summary-name">AppIdentityError</a> |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a href="oauth2client.crypt.Verifier-class.html" class="summary-name">Verifier</a><br /> |
+ Verifies the signature on a message. |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a href="oauth2client.crypt.Signer-class.html" class="summary-name">Signer</a><br /> |
+ Signs messages with a private key. |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== FUNCTIONS ==================== --> |
+<a name="section-Functions"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Functions</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-Functions" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+<tr class="private"> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr> |
+ <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> |
+ <td align="right" valign="top"> |
+ <span class="codelink"><a href="oauth2client.crypt-pysrc.html#_urlsafe_b64encode">source code</a></span> |
+ |
+ </td> |
+ </tr> |
+ </table> |
+ |
+ </td> |
+ </tr> |
+<tr class="private"> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr> |
+ <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> |
+ <td align="right" valign="top"> |
+ <span class="codelink"><a href="oauth2client.crypt-pysrc.html#_urlsafe_b64decode">source code</a></span> |
+ |
+ </td> |
+ </tr> |
+ </table> |
+ |
+ </td> |
+ </tr> |
+<tr class="private"> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr> |
+ <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> |
+ <td align="right" valign="top"> |
+ <span class="codelink"><a href="oauth2client.crypt-pysrc.html#_json_encode">source code</a></span> |
+ |
+ </td> |
+ </tr> |
+ </table> |
+ |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr> |
+ <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>, |
+ <span class="summary-sig-arg">payload</span>)</span><br /> |
+ Make a signed JWT.</td> |
+ <td align="right" valign="top"> |
+ <span class="codelink"><a href="oauth2client.crypt-pysrc.html#make_signed_jwt">source code</a></span> |
+ |
+ </td> |
+ </tr> |
+ </table> |
+ |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr> |
+ <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>, |
+ <span class="summary-sig-arg">certs</span>, |
+ <span class="summary-sig-arg">audience</span>)</span><br /> |
+ Verify a JWT against public certs.</td> |
+ <td align="right" valign="top"> |
+ <span class="codelink"><a href="oauth2client.crypt-pysrc.html#verify_signed_jwt_with_certs">source code</a></span> |
+ |
+ </td> |
+ </tr> |
+ </table> |
+ |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== VARIABLES ==================== --> |
+<a name="section-Variables"></a> |
+<table class="summary" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Variables</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-Variables" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a name="CLOCK_SKEW_SECS"></a><span class="summary-name">CLOCK_SKEW_SECS</span> = <code title="300">300</code> |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a name="AUTH_TOKEN_LIFETIME_SECS"></a><span class="summary-name">AUTH_TOKEN_LIFETIME_SECS</span> = <code title="300">300</code> |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a name="MAX_TOKEN_LIFETIME_SECS"></a><span class="summary-name">MAX_TOKEN_LIFETIME_SECS</span> = <code title="86400">86400</code> |
+ </td> |
+ </tr> |
+<tr> |
+ <td width="15%" align="right" valign="top" class="summary"> |
+ <span class="summary-type"> </span> |
+ </td><td class="summary"> |
+ <a name="__package__"></a><span class="summary-name">__package__</span> = <code title="'oauth2client'"><code class="variable-quote">'</code><code class="variable-string">oauth2client</code><code class="variable-quote">'</code></code> |
+ </td> |
+ </tr> |
+</table> |
+<!-- ==================== FUNCTION DETAILS ==================== --> |
+<a name="section-FunctionDetails"></a> |
+<table class="details" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr bgcolor="#70b0f0" class="table-header"> |
+ <td colspan="2" class="table-header"> |
+ <table border="0" cellpadding="0" cellspacing="0" width="100%"> |
+ <tr valign="top"> |
+ <td align="left"><span class="table-header">Function Details</span></td> |
+ <td align="right" valign="top" |
+ ><span class="options">[<a href="#section-FunctionDetails" |
+ class="privatelink" onclick="toggle_private();" |
+ >hide private</a>]</span></td> |
+ </tr> |
+ </table> |
+ </td> |
+</tr> |
+</table> |
+<a name="make_signed_jwt"></a> |
+<div> |
+<table class="details" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr><td> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr valign="top"><td> |
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">make_signed_jwt</span>(<span class="sig-arg">signer</span>, |
+ <span class="sig-arg">payload</span>)</span> |
+ </h3> |
+ </td><td align="right" valign="top" |
+ ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#make_signed_jwt">source code</a></span> |
+ </td> |
+ </tr></table> |
+ |
+ <pre class="literalblock"> |
+Make a signed JWT. |
+ |
+See http://self-issued.info/docs/draft-jones-json-web-token.html. |
+ |
+Args: |
+ signer: crypt.Signer, Cryptographic signer. |
+ payload: dict, Dictionary of data to convert to JSON and then sign. |
+ |
+Returns: |
+ string, The JWT for the payload. |
+ |
+</pre> |
+ <dl class="fields"> |
+ </dl> |
+</td></tr></table> |
+</div> |
+<a name="verify_signed_jwt_with_certs"></a> |
+<div> |
+<table class="details" border="1" cellpadding="3" |
+ cellspacing="0" width="100%" bgcolor="white"> |
+<tr><td> |
+ <table width="100%" cellpadding="0" cellspacing="0" border="0"> |
+ <tr valign="top"><td> |
+ <h3 class="epydoc"><span class="sig"><span class="sig-name">verify_signed_jwt_with_certs</span>(<span class="sig-arg">jwt</span>, |
+ <span class="sig-arg">certs</span>, |
+ <span class="sig-arg">audience</span>)</span> |
+ </h3> |
+ </td><td align="right" valign="top" |
+ ><span class="codelink"><a href="oauth2client.crypt-pysrc.html#verify_signed_jwt_with_certs">source code</a></span> |
+ </td> |
+ </tr></table> |
+ |
+ <pre class="literalblock"> |
+Verify a JWT against public certs. |
+ |
+See http://self-issued.info/docs/draft-jones-json-web-token.html. |
+ |
+Args: |
+ jwt: string, A JWT. |
+ certs: dict, Dictionary where values of public keys in PEM format. |
+ audience: string, The audience, 'aud', that this JWT should contain. If |
+ None then the JWT's 'aud' parameter is not verified. |
+ |
+Returns: |
+ dict, The deserialized JSON payload in the JWT. |
+ |
+Raises: |
+ AppIdentityError if any checks are failed. |
+ |
+</pre> |
+ <dl class="fields"> |
+ </dl> |
+</td></tr></table> |
+</div> |
+<br /> |
+<!-- ==================== NAVIGATION BAR ==================== --> |
+<table class="navbar" border="0" width="100%" cellpadding="0" |
+ bgcolor="#a0c0ff" cellspacing="0"> |
+ <tr valign="middle"> |
+ |
+ <!-- Tree link --> |
+ <th> <a |
+ href="module-tree.html">Trees</a> </th> |
+ |
+ <!-- Index link --> |
+ <th> <a |
+ href="identifier-index.html">Indices</a> </th> |
+ |
+ <!-- Help link --> |
+ <th> <a |
+ href="help.html">Help</a> </th> |
+ |
+ <th class="navbar" width="100%"></th> |
+ </tr> |
+</table> |
+<table border="0" cellpadding="0" cellspacing="0" width="100%%"> |
+ <tr> |
+ <td align="left" class="footer"> |
+ Generated by Epydoc 3.0.1 on Tue Jun 5 09:03:05 2012 |
+ </td> |
+ <td align="right" class="footer"> |
+ <a target="mainFrame" href="http://epydoc.sourceforge.net" |
+ >http://epydoc.sourceforge.net</a> |
+ </td> |
+ </tr> |
+</table> |
+ |
+<script type="text/javascript"> |
+ <!-- |
+ // Private objects are initially displayed (because if |
+ // javascript is turned off then we want them to be |
+ // visible); but by default, we want to hide them. So hide |
+ // them unless we have a cookie that says to show them. |
+ checkCookie(); |
+ // --> |
+</script> |
+</body> |
+</html> |