Prep for 1.0 release.
diff --git a/docs/epy/oauth2client.xsrfutil-module.html b/docs/epy/oauth2client.xsrfutil-module.html
index c255c76..7f878ab 100644
--- a/docs/epy/oauth2client.xsrfutil-module.html
+++ b/docs/epy/oauth2client.xsrfutil-module.html
@@ -65,7 +65,66 @@
"Joe Gregorio" <jcgregorio@google.com>
</dd>
</dl>
-</div><!-- ==================== VARIABLES ==================== -->
+</div><!-- ==================== 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>
+ <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.xsrfutil-module.html#generate_token" class="summary-sig-name">generate_token</a>(<span class="summary-sig-arg">key</span>,
+ <span class="summary-sig-arg">user_id</span>,
+ <span class="summary-sig-arg">action_id</span>=<span class="summary-sig-default">""</span>,
+ <span class="summary-sig-arg">when</span>=<span class="summary-sig-default">None</span>)</span><br />
+ Generates a URL-safe token for the given user, action, time tuple.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.xsrfutil-pysrc.html#generate_token">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.xsrfutil-module.html#validate_token" class="summary-sig-name">validate_token</a>(<span class="summary-sig-arg">key</span>,
+ <span class="summary-sig-arg">token</span>,
+ <span class="summary-sig-arg">user_id</span>,
+ <span class="summary-sig-arg">action_id</span>=<span class="summary-sig-default">""</span>,
+ <span class="summary-sig-arg">current_time</span>=<span class="summary-sig-default">None</span>)</span><br />
+ Validates that the given token authorizes the user for the action.</td>
+ <td align="right" valign="top">
+ <span class="codelink"><a href="oauth2client.xsrfutil-pysrc.html#validate_token">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">
@@ -86,24 +145,120 @@
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a name="DELIMITER"></a><span class="summary-name">DELIMITER</span> = <code title="':'"><code class="variable-quote">'</code><code class="variable-string">:</code><code class="variable-quote">'</code></code>
+ <a name="DELIMITER"></a><span class="summary-name">DELIMITER</span> = <code title="':'">':'</code>
</td>
</tr>
<tr>
<td width="15%" align="right" valign="top" class="summary">
<span class="summary-type"> </span>
</td><td class="summary">
- <a name="DEFAULT_TIMEOUT_SECS"></a><span class="summary-name">DEFAULT_TIMEOUT_SECS</span> = <code title="3600">3600</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>
+ <a name="DEFAULT_TIMEOUT_SECS"></a><span class="summary-name">DEFAULT_TIMEOUT_SECS</span> = <code title="1* 60* 60">1* 60* 60</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="generate_token"></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">generate_token</span>(<span class="sig-arg">key</span>,
+ <span class="sig-arg">user_id</span>,
+ <span class="sig-arg">action_id</span>=<span class="sig-default">""</span>,
+ <span class="sig-arg">when</span>=<span class="sig-default">None</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="oauth2client.xsrfutil-pysrc.html#generate_token">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Generates a URL-safe token for the given user, action, time tuple.
+
+Args:
+ key: secret key to use.
+ user_id: the user ID of the authenticated user.
+ action_id: a string identifier of the action they requested
+ authorization for.
+ when: the time in seconds since the epoch at which the user was
+ authorized for this action. If not set the current time is used.
+
+Returns:
+ A string XSRF protection token.
+
+</pre>
+ <dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(2)</code></li>
+ </ul></dd>
+ </dl>
+</td></tr></table>
+</div>
+<a name="validate_token"></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">validate_token</span>(<span class="sig-arg">key</span>,
+ <span class="sig-arg">token</span>,
+ <span class="sig-arg">user_id</span>,
+ <span class="sig-arg">action_id</span>=<span class="sig-default">""</span>,
+ <span class="sig-arg">current_time</span>=<span class="sig-default">None</span>)</span>
+ </h3>
+ </td><td align="right" valign="top"
+ ><span class="codelink"><a href="oauth2client.xsrfutil-pysrc.html#validate_token">source code</a></span>
+ </td>
+ </tr></table>
+
+ <pre class="literalblock">
+Validates that the given token authorizes the user for the action.
+
+Tokens are invalid if the time of issue is too old or if the token
+does not match what generateToken outputs (i.e. the token was forged).
+
+Args:
+ key: secret key to use.
+ token: a string of the token generated by generateToken.
+ user_id: the user ID of the authenticated user.
+ action_id: a string identifier of the action they requested
+ authorization for.
+
+Returns:
+ A boolean - True if the user is authorized for the action, False
+ otherwise.
+
+</pre>
+ <dl class="fields">
+ <dt>Decorators:</dt>
+ <dd><ul class="nomargin-top">
+ <li><code>@util.positional(3)</code></li>
+ </ul></dd>
+ </dl>
+</td></tr></table>
+</div>
+<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
bgcolor="#a0c0ff" cellspacing="0">
@@ -127,7 +282,7 @@
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
<tr>
<td align="left" class="footer">
- Generated by Epydoc 3.0.1 on Thu Aug 30 07:12:42 2012
+ Generated by Epydoc 3.0.1 on Thu Sep 6 13:36:11 2012
</td>
<td align="right" class="footer">
<a target="mainFrame" href="http://epydoc.sourceforge.net"