← Back to branch summary

~gary/python-openid/python-openid-2.2.1-patched

« back to all changes in this revision

Viewing changes to doc/openid.server.server.DiffieHellmanServerSession-class.html

  • Committer: Launchpad Patch Queue Manager
  • Date: 2007-11-30 02:46:28 UTC
  • mfrom: (1.1.1 pyopenid-2.0)
  • Revision ID: launchpad@pqm.canonical.com-20071130024628-qktwsew3383iawmq
[rs=SteveA] upgrade to python-openid-2.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/openid.server.server.DiffieHellmanServerSession-class.html
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>openid.server.server.DiffieHellmanServerSession</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
 
  <!-- Home link -->
18
 
      <th>&nbsp;&nbsp;&nbsp;<a
19
 
        href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
20
 
 
21
 
  <!-- Tree link -->
22
 
      <th>&nbsp;&nbsp;&nbsp;<a
23
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
24
 
 
25
 
  <!-- Index link -->
26
 
      <th>&nbsp;&nbsp;&nbsp;<a
27
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
28
 
 
29
 
  <!-- Help link -->
30
 
      <th>&nbsp;&nbsp;&nbsp;<a
31
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
32
 
 
33
 
  <!-- Project homepage -->
34
 
      <th class="navbar" align="right" width="100%">
35
 
        <table border="0" cellpadding="0" cellspacing="0">
36
 
          <tr><th class="navbar" align="center"
37
 
            ><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
38
 
          </tr></table></th>
39
 
  </tr>
40
 
</table>
41
 
<table width="100%" cellpadding="0" cellspacing="0">
42
 
  <tr valign="top">
43
 
    <td width="100%">
44
 
      <span class="breadcrumbs">
45
 
        <a href="openid-module.html">Package&nbsp;openid</a> ::
46
 
        <a href="openid.server-module.html">Package&nbsp;server</a> ::
47
 
        <a href="openid.server.server-module.html">Module&nbsp;server</a> ::
48
 
        Class&nbsp;DiffieHellmanServerSession
49
 
      </span>
50
 
    </td>
51
 
    <td>
52
 
      <table cellpadding="0" cellspacing="0">
53
 
        <!-- hide/show private -->
54
 
        <tr><td align="right"><span class="options"
55
 
            >[<a href="frames.html" target="_top">frames</a
56
 
            >]&nbsp;|&nbsp;<a href="openid.server.server.DiffieHellmanServerSession-class.html"
57
 
            target="_top">no&nbsp;frames</a>]</span></td></tr>
58
 
      </table>
59
 
    </td>
60
 
  </tr>
61
 
</table>
62
 
<!-- ==================== CLASS DESCRIPTION ==================== -->
63
 
<h1 class="epydoc">Class DiffieHellmanServerSession</h1><span class="codelink"><a href="openid.server.server-pysrc.html#DiffieHellmanServerSession">source&nbsp;code</a></span><br /><br />
64
 
<pre class="base-tree">
65
 
object --+
66
 
         |
67
 
        <strong class="uidshort">DiffieHellmanServerSession</strong>
68
 
</pre>
69
 
 
70
 
<hr />
71
 
An object that knows how to handle association requests with the 
72
 
  Diffie-Hellman session type.<br /><br />
73
 
 
74
 
<hr />
75
 
      <dl><dt>See Also:</dt>
76
 
        <dd>
77
 
          <a href="http://openid.net/specs.bml#mode-associate" 
78
 
          target="_top">OpenID Specs, Mode: associate</a>,
79
 
          AssociateRequest
80
 
        </dd>
81
 
      </dl>
82
 
<!-- ==================== INSTANCE METHODS ==================== -->
83
 
<a name="section-InstanceMethods"></a>
84
 
<table class="summary" border="1" cellpadding="3"
85
 
       cellspacing="0" width="100%" bgcolor="white">
86
 
<tr bgcolor="#70b0f0" class="table-header">
87
 
  <td colspan="2" class="table-header">
88
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
89
 
      <tr valign="top">
90
 
        <td align="left"><span class="table-header">Instance Methods</span></td>
91
 
        <td align="right" valign="top"
92
 
         ><span class="options">[<a href="#section-InstanceMethods"
93
 
         class="privatelink" onclick="toggle_private();"
94
 
         >hide private</a>]</span></td>
95
 
      </tr>
96
 
    </table>
97
 
  </td>
98
 
</tr>
99
 
<tr>
100
 
  <td width="15%" align="right" valign="top" class="summary">
101
 
    <span class="summary-type">&nbsp;</span>
102
 
  </td><td class="summary">
103
 
    <span class="summary-sig"><a href="openid.server.server.DiffieHellmanServerSession-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
104
 
        <span class="summary-sig-arg">dh</span>,
105
 
        <span class="summary-sig-arg">consumer_pubkey</span>)</span><br />
106
 
      x.__init__(...) initializes x; see x.__class__.__doc__ for 
107
 
      signature
108
 
  </td>
109
 
</tr>
110
 
<tr>
111
 
  <td width="15%" align="right" valign="top" class="summary">
112
 
    <span class="summary-type">&nbsp;</span>
113
 
  </td><td class="summary">
114
 
    <span class="summary-sig"><a href="openid.server.server.DiffieHellmanServerSession-class.html#answer" class="summary-sig-name">answer</a>(<span class="summary-sig-arg">self</span>,
115
 
        <span class="summary-sig-arg">secret</span>)</span>
116
 
  </td>
117
 
</tr>
118
 
  <tr>
119
 
    <td colspan="2" class="summary">
120
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
121
 
      <code>__delattr__</code>,
122
 
      <code>__getattribute__</code>,
123
 
      <code>__hash__</code>,
124
 
      <code>__new__</code>,
125
 
      <code>__reduce__</code>,
126
 
      <code>__reduce_ex__</code>,
127
 
      <code>__repr__</code>,
128
 
      <code>__setattr__</code>,
129
 
      <code>__str__</code>
130
 
      </p>
131
 
    </td>
132
 
  </tr>
133
 
</table>
134
 
 
135
 
<br />
136
 
<!-- ==================== CLASS METHODS ==================== -->
137
 
<a name="section-ClassMethods"></a>
138
 
<table class="summary" border="1" cellpadding="3"
139
 
       cellspacing="0" width="100%" bgcolor="white">
140
 
<tr bgcolor="#70b0f0" class="table-header">
141
 
  <td colspan="2" class="table-header">
142
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
143
 
      <tr valign="top">
144
 
        <td align="left"><span class="table-header">Class Methods</span></td>
145
 
        <td align="right" valign="top"
146
 
         ><span class="options">[<a href="#section-ClassMethods"
147
 
         class="privatelink" onclick="toggle_private();"
148
 
         >hide private</a>]</span></td>
149
 
      </tr>
150
 
    </table>
151
 
  </td>
152
 
</tr>
153
 
<tr>
154
 
  <td width="15%" align="right" valign="top" class="summary">
155
 
    <span class="summary-type"><a 
156
 
      href="openid.server.server.DiffieHellmanServerSession-class.html" 
157
 
      class="link">DiffieHellmanServerSession</a></span>
158
 
  </td><td class="summary">
159
 
    <span class="summary-sig"><a href="openid.server.server.DiffieHellmanServerSession-class.html#fromQuery" class="summary-sig-name">fromQuery</a>(<span class="summary-sig-arg">cls</span>,
160
 
        <span class="summary-sig-arg">query</span>)</span>
161
 
  </td>
162
 
</tr>
163
 
</table>
164
 
 
165
 
<br />
166
 
<!-- ==================== CLASS VARIABLES ==================== -->
167
 
<a name="section-ClassVariables"></a>
168
 
<table class="summary" border="1" cellpadding="3"
169
 
       cellspacing="0" width="100%" bgcolor="white">
170
 
<tr bgcolor="#70b0f0" class="table-header">
171
 
  <td colspan="2" class="table-header">
172
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
173
 
      <tr valign="top">
174
 
        <td align="left"><span class="table-header">Class Variables</span></td>
175
 
        <td align="right" valign="top"
176
 
         ><span class="options">[<a href="#section-ClassVariables"
177
 
         class="privatelink" onclick="toggle_private();"
178
 
         >hide private</a>]</span></td>
179
 
      </tr>
180
 
    </table>
181
 
  </td>
182
 
</tr>
183
 
<tr>
184
 
  <td width="15%" align="right" valign="top" class="summary">
185
 
    <span class="summary-type">str</span>
186
 
  </td><td class="summary">
187
 
    <a href="openid.server.server.DiffieHellmanServerSession-class.html#session_type">session_type</a> = <code title="'DH-SHA1'">'DH-SHA1'</code><br />
188
 
      The session_type for this association session.
189
 
  </td>
190
 
</tr>
191
 
</table>
192
 
 
193
 
<br />
194
 
<!-- ==================== INSTANCE VARIABLES ==================== -->
195
 
<a name="section-InstanceVariables"></a>
196
 
<table class="summary" border="1" cellpadding="3"
197
 
       cellspacing="0" width="100%" bgcolor="white">
198
 
<tr bgcolor="#70b0f0" class="table-header">
199
 
  <td colspan="2" class="table-header">
200
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
201
 
      <tr valign="top">
202
 
        <td align="left"><span class="table-header">Instance Variables</span></td>
203
 
        <td align="right" valign="top"
204
 
         ><span class="options">[<a href="#section-InstanceVariables"
205
 
         class="privatelink" onclick="toggle_private();"
206
 
         >hide private</a>]</span></td>
207
 
      </tr>
208
 
    </table>
209
 
  </td>
210
 
</tr>
211
 
<tr>
212
 
  <td width="15%" align="right" valign="top" class="summary">
213
 
    <span class="summary-type">long</span>
214
 
  </td><td class="summary">
215
 
    <a href="openid.server.server.DiffieHellmanServerSession-class.html#consumer_pubkey">consumer_pubkey</a><br />
216
 
      The public key sent by the consumer in the associate request
217
 
  </td>
218
 
</tr>
219
 
<tr>
220
 
  <td width="15%" align="right" valign="top" class="summary">
221
 
    <span class="summary-type">DiffieHellman</span>
222
 
  </td><td class="summary">
223
 
    <a href="openid.server.server.DiffieHellmanServerSession-class.html#dh">dh</a><br />
224
 
      The Diffie-Hellman algorithm values for this request
225
 
  </td>
226
 
</tr>
227
 
</table>
228
 
 
229
 
<br />
230
 
<!-- ==================== PROPERTIES ==================== -->
231
 
<a name="section-Properties"></a>
232
 
<table class="summary" border="1" cellpadding="3"
233
 
       cellspacing="0" width="100%" bgcolor="white">
234
 
<tr bgcolor="#70b0f0" class="table-header">
235
 
  <td colspan="2" class="table-header">
236
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
237
 
      <tr valign="top">
238
 
        <td align="left"><span class="table-header">Properties</span></td>
239
 
        <td align="right" valign="top"
240
 
         ><span class="options">[<a href="#section-Properties"
241
 
         class="privatelink" onclick="toggle_private();"
242
 
         >hide private</a>]</span></td>
243
 
      </tr>
244
 
    </table>
245
 
  </td>
246
 
</tr>
247
 
  <tr>
248
 
    <td colspan="2" class="summary">
249
 
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
250
 
      <code>__class__</code>
251
 
      </p>
252
 
    </td>
253
 
  </tr>
254
 
</table>
255
 
 
256
 
<br />
257
 
<!-- ==================== METHOD DETAILS ==================== -->
258
 
<a name="section-MethodDetails"></a>
259
 
<table class="summary" border="1" cellpadding="3"
260
 
       cellspacing="0" width="100%" bgcolor="white">
261
 
<tr bgcolor="#70b0f0" class="table-header">
262
 
  <td colspan="2" class="table-header">
263
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
264
 
      <tr valign="top">
265
 
        <td align="left"><span class="table-header">Method Details</span></td>
266
 
        <td align="right" valign="top"
267
 
         ><span class="options">[<a href="#section-MethodDetails"
268
 
         class="privatelink" onclick="toggle_private();"
269
 
         >hide private</a>]</span></td>
270
 
      </tr>
271
 
    </table>
272
 
  </td>
273
 
</tr>
274
 
</table>
275
 
<a name="__init__"></a>
276
 
<div>
277
 
<table class="details" border="1" cellpadding="3"
278
 
       cellspacing="0" width="100%" bgcolor="white">
279
 
<tr><td>
280
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
281
 
  <tr valign="top"><td>
282
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
283
 
        <span class="sig-arg">dh</span>,
284
 
        <span class="sig-arg">consumer_pubkey</span>)</span>
285
 
    <br /><em class="fname">(Constructor)</em>
286
 
  </h3>
287
 
  </td><td align="right" valign="top"
288
 
    ><span class="codelink"><a href="openid.server.server-pysrc.html#DiffieHellmanServerSession.__init__">source&nbsp;code</a></span>&nbsp;
289
 
    </td>
290
 
  </table>
291
 
  
292
 
  <br />x.__init__(...) initializes x; see x.__class__.__doc__ for 
293
 
  signature
294
 
  <dl><dt></dt><dd>
295
 
    <dl><dt>Overrides:
296
 
      object.__init__
297
 
        <dd><em class="note">(inherited documentation)</em></dd>
298
 
    </dt></dl>
299
 
  </dd></dl>
300
 
</td></tr></table>
301
 
</div>
302
 
<a name="fromQuery"></a>
303
 
<div>
304
 
<table class="details" border="1" cellpadding="3"
305
 
       cellspacing="0" width="100%" bgcolor="white">
306
 
<tr><td>
307
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
308
 
  <tr valign="top"><td>
309
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">fromQuery</span>(<span class="sig-arg">cls</span>,
310
 
        <span class="sig-arg">query</span>)</span>
311
 
    <br /><em class="fname">Class Method</em>
312
 
  </h3>
313
 
  </td><td align="right" valign="top"
314
 
    ><span class="codelink"><a href="openid.server.server-pysrc.html#DiffieHellmanServerSession.fromQuery">source&nbsp;code</a></span>&nbsp;
315
 
    </td>
316
 
  </table>
317
 
  
318
 
  
319
 
  <dl><dt></dt><dd>
320
 
    <dl><dt>Parameters:</dt></dl>
321
 
    <ul class="nomargin">
322
 
        <li><strong class="pname"><code>query</code></strong> ({str:str}) - The associate request's query parameters</li>
323
 
    </ul>
324
 
    <dl><dt>Returns: <a 
325
 
      href="openid.server.server.DiffieHellmanServerSession-class.html" 
326
 
      class="link">DiffieHellmanServerSession</a></dt></dl>
327
 
    <dl><dt>Raises:</dt></dl>
328
 
    <ul class="nomargin">
329
 
        <li><code><strong class='fraise'><a href="openid.server.server.ProtocolError-class.html">ProtocolError</a></strong></code> - When parameters required to establish the session are 
330
 
        missing.</li>
331
 
    </ul>
332
 
  </dd></dl>
333
 
</td></tr></table>
334
 
</div>
335
 
<a name="answer"></a>
336
 
<div>
337
 
<table class="details" border="1" cellpadding="3"
338
 
       cellspacing="0" width="100%" bgcolor="white">
339
 
<tr><td>
340
 
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
341
 
  <tr valign="top"><td>
342
 
  <h3 class="epydoc"><span class="sig"><span class="sig-name">answer</span>(<span class="sig-arg">self</span>,
343
 
        <span class="sig-arg">secret</span>)</span>
344
 
  </h3>
345
 
  </td><td align="right" valign="top"
346
 
    ><span class="codelink"><a href="openid.server.server-pysrc.html#DiffieHellmanServerSession.answer">source&nbsp;code</a></span>&nbsp;
347
 
    </td>
348
 
  </table>
349
 
  
350
 
  
351
 
  <dl><dt></dt><dd>
352
 
  </dd></dl>
353
 
</td></tr></table>
354
 
</div>
355
 
<br />
356
 
<!-- ==================== CLASS VARIABLE DETAILS ==================== -->
357
 
<a name="section-ClassVariableDetails"></a>
358
 
<table class="summary" border="1" cellpadding="3"
359
 
       cellspacing="0" width="100%" bgcolor="white">
360
 
<tr bgcolor="#70b0f0" class="table-header">
361
 
  <td colspan="2" class="table-header">
362
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
363
 
      <tr valign="top">
364
 
        <td align="left"><span class="table-header">Class Variable Details</span></td>
365
 
        <td align="right" valign="top"
366
 
         ><span class="options">[<a href="#section-ClassVariableDetails"
367
 
         class="privatelink" onclick="toggle_private();"
368
 
         >hide private</a>]</span></td>
369
 
      </tr>
370
 
    </table>
371
 
  </td>
372
 
</tr>
373
 
</table>
374
 
<a name="session_type"></a>
375
 
<div>
376
 
<table class="details" border="1" cellpadding="3"
377
 
       cellspacing="0" width="100%" bgcolor="white">
378
 
<tr><td>
379
 
  <h3 class="epydoc">session_type</h3>
380
 
  <br />The session_type for this association session.
381
 
  <dl><dt></dt><dd>
382
 
    <dl><dt>Type:</dt>
383
 
      <dd>str</dd></dl>
384
 
    <dl><dt>Value:</dt>
385
 
      <dd><table><tr><td><pre class="variable">
386
 
<span class="variable-quote">'</span>DH-SHA1<span class="variable-quote">'</span>                                                              
387
 
      </pre></td></tr></table></dd>
388
 
    </dl>
389
 
  </dd></dl>
390
 
</td></tr></table>
391
 
</div>
392
 
<br />
393
 
<!-- ==================== INSTANCE VARIABLE DETAILS ==================== -->
394
 
<a name="section-InstanceVariableDetails"></a>
395
 
<table class="summary" border="1" cellpadding="3"
396
 
       cellspacing="0" width="100%" bgcolor="white">
397
 
<tr bgcolor="#70b0f0" class="table-header">
398
 
  <td colspan="2" class="table-header">
399
 
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
400
 
      <tr valign="top">
401
 
        <td align="left"><span class="table-header">Instance Variable Details</span></td>
402
 
        <td align="right" valign="top"
403
 
         ><span class="options">[<a href="#section-InstanceVariableDetails"
404
 
         class="privatelink" onclick="toggle_private();"
405
 
         >hide private</a>]</span></td>
406
 
      </tr>
407
 
    </table>
408
 
  </td>
409
 
</tr>
410
 
</table>
411
 
<a name="consumer_pubkey"></a>
412
 
<div>
413
 
<table class="details" border="1" cellpadding="3"
414
 
       cellspacing="0" width="100%" bgcolor="white">
415
 
<tr><td>
416
 
  <h3 class="epydoc">consumer_pubkey</h3>
417
 
  <br />The public key sent by the consumer in the associate request
418
 
  <dl><dt></dt><dd>
419
 
    <dl><dt>Type:</dt>
420
 
      <dd>long</dd></dl>
421
 
  </dd></dl>
422
 
</td></tr></table>
423
 
</div>
424
 
<a name="dh"></a>
425
 
<div>
426
 
<table class="details" border="1" cellpadding="3"
427
 
       cellspacing="0" width="100%" bgcolor="white">
428
 
<tr><td>
429
 
  <h3 class="epydoc">dh</h3>
430
 
  <br />The Diffie-Hellman algorithm values for this request
431
 
  <dl><dt></dt><dd>
432
 
    <dl><dt>Type:</dt>
433
 
      <dd>DiffieHellman</dd></dl>
434
 
  </dd></dl>
435
 
</td></tr></table>
436
 
</div>
437
 
<br />
438
 
<!-- ==================== NAVIGATION BAR ==================== -->
439
 
<table class="navbar" border="0" width="100%" cellpadding="0"
440
 
       bgcolor="#a0c0ff" cellspacing="0">
441
 
  <tr valign="middle">
442
 
  <!-- Home link -->
443
 
      <th>&nbsp;&nbsp;&nbsp;<a
444
 
        href="openid-module.html">Home</a>&nbsp;&nbsp;&nbsp;</th>
445
 
 
446
 
  <!-- Tree link -->
447
 
      <th>&nbsp;&nbsp;&nbsp;<a
448
 
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>
449
 
 
450
 
  <!-- Index link -->
451
 
      <th>&nbsp;&nbsp;&nbsp;<a
452
 
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>
453
 
 
454
 
  <!-- Help link -->
455
 
      <th>&nbsp;&nbsp;&nbsp;<a
456
 
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>
457
 
 
458
 
  <!-- Project homepage -->
459
 
      <th class="navbar" align="right" width="100%">
460
 
        <table border="0" cellpadding="0" cellspacing="0">
461
 
          <tr><th class="navbar" align="center"
462
 
            ><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
463
 
          </tr></table></th>
464
 
  </tr>
465
 
</table>
466
 
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
467
 
  <tr>
468
 
    <td align="left" class="footer">Generated by Epydoc
469
 
        3.0alpha3 on Fri Dec  8 13:26:20 2006</td>
470
 
    <td align="right" class="footer">
471
 
      <a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
472
 
    </td>
473
 
  </tr>
474
 
</table>
475
 
 
476
 
<script type="text/javascript">
477
 
  <!--
478
 
  // Private objects are initially displayed (because if
479
 
  // javascript is turned off then we want them to be
480
 
  // visible); but by default, we want to hide them.  So hide
481
 
  // them unless we have a cookie that says to show them.
482
 
  checkCookie()
483
 
  // -->
484
 
</script>
485
 
  
486
 
</body>
487
 
</html>