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
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>Class: OpenID::Server::CheckIDRequest</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<meta http-equiv="Content-Script-Type" content="text/javascript" />
<link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript">
// <![CDATA[
function popupCode( url ) {
window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
function toggleCode( id ) {
if ( document.getElementById )
elem = document.getElementById( id );
else if ( document.all )
elem = eval( "document.all." + id );
else
return false;
elemStyle = elem.style;
if ( elemStyle.display != "block" ) {
elemStyle.display = "block"
} else {
elemStyle.display = "none"
}
return true;
}
// Make codeblocks hidden by default
document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
// ]]>
</script>
</head>
<body>
<div id="classHeader">
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Class</strong></td>
<td class="class-name-in-header">OpenID::Server::CheckIDRequest</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../../files/lib/openid/server_rb.html">
lib/openid/server.rb
</a>
<br />
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Parent:</strong></td>
<td>
<a href="OpenIDRequest.html">
OpenIDRequest
</a>
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
A request to confirm the identity of a user.
</p>
<p>
This class handles requests for openid modes <tt>checkid_immediate</tt> and
<tt>checkid_setup</tt> .
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000221">answer</a>
<a href="#M000223">cancel_url</a>
<a href="#M000222">encode_to_url</a>
<a href="#M000217">from_message</a>
<a href="#M000218">id_select</a>
<a href="#M000216">new</a>
<a href="#M000220">return_to_verified</a>
<a href="#M000224">to_s</a>
<a href="#M000219">trust_root_valid</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="attribute-list">
<h3 class="section-bar">Attributes</h3>
<div class="name-list">
<table>
<tr class="top-aligned-row context-row">
<td class="context-item-name">assoc_handle</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
Provided in smart mode requests, a handle for a previously established
association. nil for dumb mode requests.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">claimed_id</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
The claimed identifier. Not present in <a
href="../../OpenID.html">OpenID</a> 1.x messages.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">identity</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
The OP-local identifier being checked.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">immediate</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
Is this an immediate-mode request?
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">mode</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"><table>
<tr><td valign="top">mode:</td><td><tt>checkid_immediate</tt> or <tt>checkid_setup</tt>
</td></tr>
</table>
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">op_endpoint</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc"></td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">return_to</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
The URL to send the user agent back to to reply to this request.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">trust_root</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
This URL identifies the party making the request, and the user will use
that to make her decision about what <a
href="CheckIDRequest.html#M000221">answer</a> she trusts them to have.
Referred to as "realm" in <a href="../../OpenID.html">OpenID</a>
2.0.
</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000217" class="method-detail">
<a name="M000217"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000217.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000217.html');return false;">
<span class="method-name">from_message</span><span class="method-args">(message, op_endpoint)</span>
</a>
</div>
<div class="method-description">
<p>
Construct me from an <a href="../../OpenID.html">OpenID</a> message.
</p>
<table>
<tr><td valign="top">message:</td><td>An <a href="../../OpenID.html">OpenID</a> checkid_* request <a
href="../Message.html">Message</a>
</td></tr>
<tr><td valign="top">op_endpoint:</td><td>The endpoint URL of the server that this message was sent to.
</td></tr>
</table>
<p>
Raises:
</p>
<table>
<tr><td valign="top"><a href="ProtocolError.html">ProtocolError</a>:</td><td>When not all required parameters are present in the message.
</td></tr>
<tr><td valign="top"><a href="MalformedReturnURL.html">MalformedReturnURL</a>:</td><td>When the <tt>return_to</tt> URL is not a URL.
</td></tr>
<tr><td valign="top"><a href="UntrustedReturnURL.html">UntrustedReturnURL</a>:</td><td>When the <tt>return_to</tt> URL is outside the <tt>trust_root</tt>.
</td></tr>
</table>
</div>
</div>
<div id="method-M000216" class="method-detail">
<a name="M000216"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000216.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000216.html');return false;">
<span class="method-name">new</span><span class="method-args">(identity, return_to, op_endpoint, trust_root=nil, immediate=false, assoc_handle=nil, claimed_id=nil)</span>
</a>
</div>
<div class="method-description">
<p>
These parameters are assigned directly as attributes, see the <a
href="CheckIDRequest.html">CheckIDRequest</a> class documentation for their
descriptions.
</p>
<p>
Raises <a href="MalformedReturnURL.html">MalformedReturnURL</a> when the
<tt>return_to</tt> URL is not a URL.
</p>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000221" class="method-detail">
<a name="M000221"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000221.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000221.html');return false;">
<span class="method-name">answer</span><span class="method-args">(allow, server_url=nil, identity=nil, claimed_id=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Respond to this request.
</p>
<table>
<tr><td valign="top">allow:</td><td>Allow this user to claim this identity, and allow the consumer to have this
information?
</td></tr>
<tr><td valign="top">server_url:</td><td>DEPRECATED. Passing op_endpoint to the <a href="../Server.html">Server</a>
constructor makes this optional.
<p>
When an <a href="../../OpenID.html">OpenID</a> 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. <tt><a
href="http://example.com/server">example.com/server</a></tt>), and I will
use it as a base for the URL for a <a
href="CheckIDRequest.html#M000216">new</a> request.
</p>
<p>
Optional for requests where <a
href="CheckIDRequest.html">CheckIDRequest</a>.immediate is false or
<tt>allow</tt> is true.
</p>
</td></tr>
<tr><td valign="top">identity:</td><td>The OP-local identifier to <a href="CheckIDRequest.html#M000221">answer</a>
with. Only for use when the relying party requested identifier selection.
</td></tr>
<tr><td valign="top">claimed_id:</td><td>The claimed identifier to <a href="CheckIDRequest.html#M000221">answer</a>
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>
If <tt>identity</tt> is provided but this is not, <tt>claimed_id</tt> will
default to the value of <tt>identity</tt>. When answering requests that did
not ask for identifier selection, the response <tt>claimed_id</tt> will
default to that of the request.
</p>
<p>
This parameter is <a href="CheckIDRequest.html#M000216">new</a> in <a
href="../../OpenID.html">OpenID</a> 2.0.
</p>
</td></tr>
</table>
<p>
Returns an <a href="OpenIDResponse.html">OpenIDResponse</a> object
containing a <a href="../../OpenID.html">OpenID</a> id_res message.
</p>
<p>
Raises <a href="NoReturnToError.html">NoReturnToError</a> if the return_to
is missing.
</p>
<p>
Version 2.0 deprecates <tt>server_url</tt> and adds <tt>claimed_id</tt>.
</p>
</div>
</div>
<div id="method-M000223" class="method-detail">
<a name="M000223"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000223.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000223.html');return false;">
<span class="method-name">cancel_url</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000222" class="method-detail">
<a name="M000222"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000222.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000222.html');return false;">
<span class="method-name">encode_to_url</span><span class="method-args">(server_url)</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000218" class="method-detail">
<a name="M000218"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000218.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000218.html');return false;">
<span class="method-name">id_select</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Is the identifier to be selected by the IDP?
</p>
</div>
</div>
<div id="method-M000220" class="method-detail">
<a name="M000220"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000220.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000220.html');return false;">
<span class="method-name">return_to_verified</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<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,
corss-site-scripting, or open redirectors.
</p>
<p>
This check should only be performed after making sure that the return_to
URL matches the realm.
</p>
<p>
Raises <a href="../DiscoveryFailure.html">DiscoveryFailure</a> if the realm
URL does not support <a href="../Yadis.html">Yadis</a> discovery (and so
does not support the verification process).
</p>
<p>
Returns true if the realm publishes a document with the return_to URL
listed
</p>
</div>
</div>
<div id="method-M000224" class="method-detail">
<a name="M000224"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000224.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000224.html');return false;">
<span class="method-name">to_s</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
</div>
</div>
<div id="method-M000219" class="method-detail">
<a name="M000219"></a>
<div class="method-heading">
<a href="CheckIDRequest.src/M000219.html" target="Code" class="method-signature"
onclick="popupCode('CheckIDRequest.src/M000219.html');return false;">
<span class="method-name">trust_root_valid</span><span class="method-args">()</span>
</a>
</div>
<div class="method-description">
<p>
Is my return_to under my trust_root?
</p>
</div>
</div>
</div>
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>
|
