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
|
<?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>Module: OpenID::TrustRoot</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>Module</strong></td>
<td class="class-name-in-header">OpenID::TrustRoot</td>
</tr>
<tr class="top-aligned-row">
<td><strong>In:</strong></td>
<td>
<a href="../../files/lib/openid/trustroot_rb.html">
lib/openid/trustroot.rb
</a>
<br />
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000287">_extract_return_url</a>
<a href="#M000289">get_allowed_return_urls</a>
<a href="#M000288">return_to_matches</a>
<a href="#M000290">verify_return_to</a>
</div>
</div>
</div>
<!-- if includes -->
<div id="section">
<div id="class-list">
<h3 class="section-bar">Classes and Modules</h3>
Class <a href="TrustRoot/TrustRoot.html" class="link">OpenID::TrustRoot::TrustRoot</a><br />
</div>
<div id="constants-list">
<h3 class="section-bar">Constants</h3>
<div class="name-list">
<table summary="Constants">
<tr class="top-aligned-row context-row">
<td class="context-item-name">TOP_LEVEL_DOMAINS</td>
<td>=</td>
<td class="context-item-value">%w' ac ad ae aero af ag ai al am an ao aq ar arpa as asia at au aw ax az ba bb bd be bf bg bh bi biz bj bm bn bo br bs bt bv bw by bz ca cat cc cd cf cg ch ci ck cl cm cn co com coop cr cu cv cx cy cz de dj dk dm do dz ec edu ee eg er es et eu fi fj fk fm fo fr ga gb gd ge gf gg gh gi gl gm gn gov gp gq gr gs gt gu gw gy hk hm hn hr ht hu id ie il im in info int io iq ir is it je jm jo jobs jp ke kg kh ki km kn kp kr kw ky kz la lb lc li lk lr ls lt lu lv ly ma mc md me mg mh mil mk ml mm mn mo mobi mp mq mr ms mt mu museum mv mw mx my mz na name nc ne net nf ng ni nl no np nr nu nz om org pa pe pf pg ph pk pl pm pn pr pro ps pt pw py qa re ro rs ru rw sa sb sc sd se sg sh si sj sk sl sm sn so sr st su sv sy sz tc td tel tf tg th tj tk tl tm tn to tp tr travel tt tv tw tz ua ug uk us uy uz va vc ve vg vi vn vu wf ws xn--0zwm56d xn--11b5bs3a9aj6g xn--80akhbyknj4f xn--9t4b11yi5a xn--deba0ad xn--g6w251d xn--hgbk6aj7f53bba xn--hlcj6aya9esc7a xn--jxalpdlp xn--kgbechtv xn--zckzah ye yt yu za zm zw'</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">ALLOWED_PROTOCOLS</td>
<td>=</td>
<td class="context-item-value">['http', 'https']</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">RP_RETURN_TO_URL_TYPE</td>
<td>=</td>
<td class="context-item-value">'http://specs.openid.net/auth/2.0/return_to'</td>
<td width="3em"> </td>
<td class="context-item-desc">
The URI for relying party discovery, used in realm verification.
<p>
XXX: This should probably live somewhere else (like in <a
href="../OpenID.html">OpenID</a> or <a href="Yadis.html">OpenID::Yadis</a>
somewhere)
</p>
</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000287" class="method-detail">
<a name="M000287"></a>
<div class="method-heading">
<a href="TrustRoot.src/M000287.html" target="Code" class="method-signature"
onclick="popupCode('TrustRoot.src/M000287.html');return false;">
<span class="method-name">_extract_return_url</span><span class="method-args">(endpoint)</span>
</a>
</div>
<div class="method-description">
<p>
If the endpoint is a relying party <a href="../OpenID.html">OpenID</a>
return_to endpoint, return the endpoint URL. Otherwise, return None.
</p>
<p>
This function is intended to be used as a filter for the <a
href="Yadis.html">Yadis</a> filtering interface.
</p>
<p>
endpoint: An XRDS BasicServiceEndpoint, as returned by performing <a
href="Yadis.html">Yadis</a> dicovery.
</p>
<p>
returns the endpoint URL or None if the endpoint is not a relying party
endpoint.
</p>
</div>
</div>
<div id="method-M000289" class="method-detail">
<a name="M000289"></a>
<div class="method-heading">
<a href="TrustRoot.src/M000289.html" target="Code" class="method-signature"
onclick="popupCode('TrustRoot.src/M000289.html');return false;">
<span class="method-name">get_allowed_return_urls</span><span class="method-args">(relying_party_url)</span>
</a>
</div>
<div class="method-description">
<p>
Given a relying party discovery URL return a list of return_to URLs.
</p>
</div>
</div>
<div id="method-M000288" class="method-detail">
<a name="M000288"></a>
<div class="method-heading">
<a href="TrustRoot.src/M000288.html" target="Code" class="method-signature"
onclick="popupCode('TrustRoot.src/M000288.html');return false;">
<span class="method-name">return_to_matches</span><span class="method-args">(allowed_return_to_urls, return_to)</span>
</a>
</div>
<div class="method-description">
<p>
Is the return_to URL under one of the supplied allowed return_to URLs?
</p>
</div>
</div>
<div id="method-M000290" class="method-detail">
<a name="M000290"></a>
<div class="method-heading">
<a href="TrustRoot.src/M000290.html" target="Code" class="method-signature"
onclick="popupCode('TrustRoot.src/M000290.html');return false;">
<span class="method-name">verify_return_to</span><span class="method-args">(realm_str, return_to, _vrfy=nil)</span>
</a>
</div>
<div class="method-description">
<p>
Verify that a return_to URL is valid for the given realm.
</p>
<p>
This function builds a discovery URL, performs <a
href="Yadis.html">Yadis</a> discovery on it, makes sure that the URL does
not redirect, parses out the return_to URLs, and finally checks to see if
the current return_to URL matches the return_to.
</p>
<p>
raises <a href="DiscoveryFailure.html">DiscoveryFailure</a> when <a
href="Yadis.html">Yadis</a> discovery fails returns true if the return_to
URL is valid for the realm
</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>
|
