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 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612
|
<?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.server.server.CheckIDRequest</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.server-module.html">Package server</a> ::
<a href="openid.server.server-module.html">Module server</a> ::
Class CheckIDRequest
</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.server.server.CheckIDRequest-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type CheckIDRequest</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<a href="openid.server.server.OpenIDRequest-class.html"><code>OpenIDRequest</code></a> --+
|
<b>CheckIDRequest</b>
</pre><br />
<hr/>
<p>A request to confirm the identity of a user.</p>
This class handles requests for openid modes <a
name="index-checkid_immediate"></a><i
class="indexterm"><code>checkid_immediate</code></i> and <a
name="index-checkid_setup"></a><i
class="indexterm"><code>checkid_setup</code></i>.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.CheckIDRequest-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>identity</span>,
<span class=summary-sig-arg>return_to</span>,
<span class=summary-sig-arg>trust_root</span>,
<span class=summary-sig-arg>immediate</span>,
<span class=summary-sig-arg>assoc_handle</span>,
<span class=summary-sig-arg>op_endpoint</span>,
<span class=summary-sig-arg>claimed_id</span>)</span></code>
<br />
Construct me.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__repr__"></a><span class="summary-sig"><span class="summary-sig-name">__repr__</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="openid.server.server.OpenIDResponse-class.html"
class="link"><code>OpenIDResponse</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.CheckIDRequest-class.html#answer" class="summary-sig-name"><code>answer</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>allow</span>,
<span class=summary-sig-arg>server_url</span>,
<span class=summary-sig-arg>identity</span>,
<span class=summary-sig-arg>claimed_id</span>)</span></code>
<br />
Respond to this request.</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.server.server.CheckIDRequest-class.html#encodeToURL" class="summary-sig-name"><code>encodeToURL</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server_url</span>)</span></code>
<br />
Encode this request as a URL to GET.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="openid.server.server.CheckIDRequest-class.html"
class="link"><code>CheckIDRequest</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.CheckIDRequest-class.html#fromMessage" class="summary-sig-name"><code>fromMessage</code></a>(<span class=summary-sig-arg>klass</span>,
<span class=summary-sig-arg>message</span>,
<span class=summary-sig-arg>op_endpoint</span>)</span></code>
<br />
Construct me from an OpenID message. <i>(Class method)</i>
</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.server.server.CheckIDRequest-class.html#getCancelURL" class="summary-sig-name"><code>getCancelURL</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get the URL to cancel this request.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.CheckIDRequest-class.html#idSelect" class="summary-sig-name"><code>idSelect</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Is the identifier to be selected by the IDP?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.CheckIDRequest-class.html#returnToVerified" class="summary-sig-name"><code>returnToVerified</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Does the relying party publish the return_to URL for this response
under the realm? It is up to the provider to set a policy for what kinds
of realms should be allowed.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> bool
</font></td>
<td><code><span class="summary-sig"><a href="openid.server.server.CheckIDRequest-class.html#trustRootValid" class="summary-sig-name"><code>trustRootValid</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Is my return_to under my trust_root?</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>,
<a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
</td></tr>
</table><br />
<!-- =========== START OF PROPERTY SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Property Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><a name="namespace"></a><b><code>namespace</code></b></td></tr></table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#assoc_handle"><code>assoc_handle</code></a></b>: Provided in smart mode requests, a handle for a previously established
association.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#claimed_id"><code>claimed_id</code></a></b>: The claimed identifier.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#identity"><code>identity</code></a></b>: The OP-local identifier being checked.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">bool</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#immediate"><code>immediate</code></a></b>: Is this an immediate-mode request?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#return_to"><code>return_to</code></a></b>: The URL to send the user agent back to to reply to this request.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#trust_root"><code>trust_root</code></a></b>: "Are you Frank?" asks the checkid request.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">str</font></td>
<td><b><a href="openid.server.server.CheckIDRequest-class.html#mode"><code>mode</code></a></b>: "<a name="index-checkid_immediate"></a><i
class="indexterm"><code>checkid_immediate</code></i>" or "<a
name="index-checkid_setup"></a><i
class="indexterm"><code>checkid_setup</code></i>"</td></tr>
</table><br />
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>identity</span>,
<span class=sig-arg>return_to</span>,
<span class=sig-arg>trust_root</span>=<span class=sig-default>None</span>,
<span class=sig-arg>immediate</span>=<span class=sig-default>False</span>,
<span class=sig-arg>assoc_handle</span>=<span class=sig-default>None</span>,
<span class=sig-arg>op_endpoint</span>=<span class=sig-default>None</span>,
<span class=sig-arg>claimed_id</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>Construct me.</p>
These parameters are assigned directly as class attributes, see my
<a href="openid.server.server.CheckIDRequest-class.html"
class="link"><code>class documentation</code></a> for their
descriptions.
<dl><dt></dt><dd>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>MalformedReturnURL</b></code> -
When the <code>return_to</code> URL is not a URL.
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="answer"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">answer</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>allow</span>,
<span class=sig-arg>server_url</span>=<span class=sig-default>None</span>,
<span class=sig-arg>identity</span>=<span class=sig-default>None</span>,
<span class=sig-arg>claimed_id</span>=<span class=sig-default>None</span>)</span>
</h3>
Respond to this request.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>allow</b></code> -
Allow this user to claim this identity, and allow the consumer
to have this information?
<br /><i>
(type=bool)</i>
<dd><code><b>server_url</b></code> -
<p>DEPRECATED. Passing <code>op_endpoint</code> to the <a
href="openid.server.server.Server-class.html"
class="link"><code>Server</code></a> constructor makes this
optional.</p>
<p>When an OpenID 1.x immediate mode request does not succeed, it
gets back a URL where the request may be carried out in a
not-so-immediate fashion. Pass my URL in here (the fully
qualified address of this server's endpoint, i.e.
<code>http://example.com/server</code>), and I will use it as a
base for the URL for a new request.</p>
Optional for requests where
<code>CheckIDRequest.immediate</code> is <code>False</code> or
<code>allow</code> is <code>True</code>.
<br /><i>
(type=str)</i>
<dd><code><b>identity</b></code> -
The OP-local identifier to answer with. Only for use when the
relying party requested identifier selection.
<br /><i>
(type=str or None)</i>
<dd><code><b>claimed_id</b></code> -
<p>The claimed identifier to answer with, for use with identifier
selection in the case where the claimed identifier and the
OP-local identifier differ, i.e. when the claimed_id uses
delegation.</p>
<p>If <code>identity</code> is provided but this is not,
<code>claimed_id</code> will default to the value of
<code>identity</code>. When answering requests that did not ask
for identifier selection, the response <code>claimed_id</code>
will default to that of the request.</p>
This parameter is new in OpenID 2.0.
<br /><i>
(type=str or None)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="openid.server.server.OpenIDResponse-class.html"
class="link"><code>OpenIDResponse</code></a>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>NoReturnError</b></code> -
when I do not have a return_to.
</dl>
</dd></dl>
</td></tr></table>
<a name="encodeToURL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">encodeToURL</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>server_url</span>)</span>
</h3>
Encode this request as a URL to GET.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>server_url</b></code> -
The URL of the OpenID server to make this request of.
<br /><i>
(type=str)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
str
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>NoReturnError</b></code> -
when I do not have a return_to.
</dl>
</dd></dl>
</td></tr></table>
<a name="getCancelURL"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getCancelURL</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Get the URL to cancel this request.</p>
<p>Useful for creating a "Cancel" button on a web form so
that operation can be carried out directly without another trip through
the server.</p>
(Except you probably want to make another trip through the server so
that it knows that the user did make a decision. Or you could simulate
this method by doing <code>.answer(False).encodeToURL()</code>)
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
The return_to URL with openid.mode = cancel.
<br /><i>
(type=str)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>NoReturnError</b></code> -
when I do not have a return_to.
</dl>
</dd></dl>
</td></tr></table>
<a name="idSelect"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">idSelect</span>(<span class=sig-arg>self</span>)</span>
</h3>
Is the identifier to be selected by the IDP?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
bool
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="returnToVerified"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">returnToVerified</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Does the relying party publish the return_to URL for this response
under the realm? It is up to the provider to set a policy for what
kinds of realms should be allowed. This return_to URL verification
reduces vulnerability to data-theft attacks based on open proxies,
cross-site-scripting, or open redirectors.</p>
This check should only be performed after making sure that the
return_to URL matches the realm.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
True if the realm publishes a document with the return_to URL
listed
<br /><i>
(type=bool)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>openid.yadis.discover.DiscoveryFailure</b></code> -
if the realm URL does not support Yadis discovery (and so does
not support the verification process).
<dd><code><b>openid.fetchers.HTTPFetchingError</b></code> -
if the realm URL is not reachable. When this is the case, the
RP may be hosted on the user's intranet.
</dl>
<p><b>Since:</b> 2.1.0
</p>
<p><b>See Also:</b> <a
href="openid.server.server.CheckIDRequest-class.html#trustRootValid"
class="link"><code>trustRootValid</code></a>
</p>
</dd></dl>
</td></tr></table>
<a name="trustRootValid"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">trustRootValid</span>(<span class=sig-arg>self</span>)</span>
</h3>
Is my return_to under my trust_root?
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
bool
</dd>
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF CLASS METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Method Details</th></tr>
</table>
<a name="fromMessage"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">fromMessage</span>(<span class=sig-arg>klass</span>,
<span class=sig-arg>message</span>,
<span class=sig-arg>op_endpoint</span>)</span>
</h3>
Construct me from an OpenID message.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>message</b></code> -
An OpenID checkid_* request Message
<br /><i>
(type=openid.message.Message)</i>
<dd><code><b>op_endpoint</b></code> -
The endpoint URL of the server that this message was sent
to.
<br /><i>
(type=str)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<a href="openid.server.server.CheckIDRequest-class.html"
class="link"><code>CheckIDRequest</code></a>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>ProtocolError</b></code> -
When not all required parameters are present in the
message.
<dd><code><b>MalformedReturnURL</b></code> -
When the <code>return_to</code> URL is not a URL.
<dd><code><b>UntrustedReturnURL</b></code> -
When the <code>return_to</code> URL is outside the
<code>trust_root</code>.
</dl>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="assoc_handle"></a>
<h3>assoc_handle</h3>
Provided in smart mode requests, a handle for a previously established
association. <code>None</code> for dumb mode requests.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="claimed_id"></a>
<h3>claimed_id</h3>
The claimed identifier. Not present in OpenID 1.x messages.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="identity"></a>
<h3>identity</h3>
The OP-local identifier being checked.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="immediate"></a>
<h3>immediate</h3>
Is this an immediate-mode request?
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
bool
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="return_to"></a>
<h3>return_to</h3>
The URL to send the user agent back to to reply to this request.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="trust_root"></a>
<h3>trust_root</h3>
"Are you Frank?" asks the checkid request. "Who wants
to know?" <code>trust_root</code>, that's who. This URL identifies
the party making the request, and the user will use that to make her
decision about what answer she trusts them to have. Referred to as
"realm" in OpenID 2.0.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="mode"></a>
<h3>mode</h3>
"<a name="index-checkid_immediate"></a><i
class="indexterm"><code>checkid_immediate</code></i>" or "<a
name="index-checkid_setup"></a><i
class="indexterm"><code>checkid_setup</code></i>"
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
str
</dd>
</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:21 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>
|