1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!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>openid.store.nonce</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="openid-module.html">Package openid</a> ::
<a href="openid.store-module.html">Package store</a> ::
Module nonce
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.store.nonce-module.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF MODULE DESCRIPTION =========== -->
<h2 class="module">Module openid.store.nonce</h2>
<!-- =========== START OF FUNCTION SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Function Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.nonce-module.html#checkTimestamp" class="summary-sig-name"><code>checkTimestamp</code></a>(<span class=summary-sig-arg>nonce_string</span>,
<span class=summary-sig-arg>allowed_skew</span>,
<span class=summary-sig-arg>now</span>)</span></code>
<br />
Is the timestamp that is part of the specified nonce string within the
allowed clock-skew of the current time?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> str
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.nonce-module.html#mkNonce" class="summary-sig-name"><code>mkNonce</code></a>(<span class=summary-sig-arg>when</span>)</span></code>
<br />
Generate a nonce with the current timestamp</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> (int, str)
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.nonce-module.html#split" class="summary-sig-name"><code>split</code></a>(<span class=summary-sig-arg>nonce_string</span>)</span></code>
<br />
Extract a timestamp from the given nonce string</td></tr>
</table><br />
<!-- =========== START OF FUNCTION DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Function Details</th></tr>
</table>
<a name="checkTimestamp"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">checkTimestamp</span>(<span class=sig-arg>nonce_string</span>,
<span class=sig-arg>allowed_skew</span>=<span class=sig-default>18000</span>,
<span class=sig-arg>now</span>=<span class=sig-default>None</span>)</span>
</h3>
Is the timestamp that is part of the specified nonce string within
the allowed clock-skew of the current time?
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>nonce_string</b></code> -
The nonce that is being checked
<br /><i>
(type=str)</i>
<dd><code><b>allowed_skew</b></code> -
How many seconds should be allowed for completing the request,
allowing for clock skew.
<br /><i>
(type=int)</i>
<dd><code><b>now</b></code> -
The current time, as a Unix timestamp
<br /><i>
(type=int)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
Whether the timestamp is correctly formatted and within the
allowed skew of the current time.
<br /><i>
(type=bool)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="mkNonce"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">mkNonce</span>(<span class=sig-arg>when</span>=<span class=sig-default>None</span>)</span>
</h3>
Generate a nonce with the current timestamp
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>when</b></code> -
Unix timestamp representing the issue time of the nonce.
Defaults to the current time.
<br /><i>
(type=int)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A string that should be usable as a one-way nonce
<br /><i>
(type=str)</i>
</dd>
</dl>
<p><b>See Also:</b> time
</p>
</dd></dl>
</td></tr></table>
<a name="split"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">split</span>(<span class=sig-arg>nonce_string</span>)</span>
</h3>
Extract a timestamp from the given nonce string
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>nonce_string</b></code> -
the nonce from which to extract the timestamp
<br /><i>
(type=str)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
A pair of a Unix timestamp and the salt characters
<br /><i>
(type=(int, str))</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ValueError</b></code> -
if the nonce does not start with a correctly formatted time
string
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Apr 22 16:14:20 2009</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
