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
|
<?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::Server</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::Server</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>
Object
</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>
I handle requests for an <a href="../../OpenID.html">OpenID</a> server.
</p>
<p>
Some types of requests (those which are not checkid requests) may be handed
to my handleRequest method, and I will take care of it and return a
response.
</p>
<p>
For your convenience, I also provide an interface to <a
href="Decoder.html#M000231">Decoder.decode</a> and <a
href="SigningEncoder.html#M000215">SigningEncoder.encode</a> through my
methods decodeRequest and encodeResponse.
</p>
<p>
All my state is encapsulated in an store, which means I‘m not
generally pickleable but I am easy to reconstruct.
</p>
</div>
</div>
<div id="method-list">
<h3 class="section-bar">Methods</h3>
<div class="name-list">
<a href="#M000254">decode_request</a>
<a href="#M000255">encode_response</a>
<a href="#M000251">handle_request</a>
<a href="#M000250">new</a>
<a href="#M000253">openid_associate</a>
<a href="#M000252">openid_check_authentication</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">decoder</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
I‘m using this to decode things.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">encoder</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
I‘m using this to encode things.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">negotiator</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
I use this instance of <a
href="../AssociationNegotiator.html">OpenID::AssociationNegotiator</a> to
determine which kinds of associations I can make and how.
</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">
My URL.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">signatory</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
I‘m using this for associate requests and to sign things.
</td>
</tr>
<tr class="top-aligned-row context-row">
<td class="context-item-name">store</td>
<td class="context-item-value"> [RW] </td>
<td class="context-item-desc">
The back-end where my associations and nonces are stored.
</td>
</tr>
</table>
</div>
</div>
<!-- if method_list -->
<div id="methods">
<h3 class="section-bar">Public Class methods</h3>
<div id="method-M000250" class="method-detail">
<a name="M000250"></a>
<div class="method-heading">
<a href="Server.src/M000250.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000250.html');return false;">
<span class="method-name">new</span><span class="method-args">(store, op_endpoint)</span>
</a>
</div>
<div class="method-description">
<p>
op_endpoint is <a href="Server.html#M000250">new</a> in library version
2.0.
</p>
</div>
</div>
<h3 class="section-bar">Public Instance methods</h3>
<div id="method-M000254" class="method-detail">
<a name="M000254"></a>
<div class="method-heading">
<a href="Server.src/M000254.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000254.html');return false;">
<span class="method-name">decode_request</span><span class="method-args">(query)</span>
</a>
</div>
<div class="method-description">
<p>
Transform query parameters into an <a
href="OpenIDRequest.html">OpenIDRequest</a>. query should contain the query
parameters as a Hash with each key mapping to one value.
</p>
<p>
If the query does not seem to be an <a href="../../OpenID.html">OpenID</a>
request at all, I return nil.
</p>
</div>
</div>
<div id="method-M000255" class="method-detail">
<a name="M000255"></a>
<div class="method-heading">
<a href="Server.src/M000255.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000255.html');return false;">
<span class="method-name">encode_response</span><span class="method-args">(response)</span>
</a>
</div>
<div class="method-description">
<p>
Encode a response to a <a href="WebResponse.html">WebResponse</a>, signing
it first if appropriate.
</p>
<p>
Raises <a href="EncodingError.html">EncodingError</a> when I can‘t
figure out how to encode this message.
</p>
<p>
Raises <a href="AlreadySigned.html">AlreadySigned</a> When this response is
already signed.
</p>
</div>
</div>
<div id="method-M000251" class="method-detail">
<a name="M000251"></a>
<div class="method-heading">
<a href="Server.src/M000251.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000251.html');return false;">
<span class="method-name">handle_request</span><span class="method-args">(request)</span>
</a>
</div>
<div class="method-description">
<p>
Handle a request.
</p>
<p>
Give me a request, I will give you a response. Unless it‘s a type of
request I cannot handle myself, in which case I will raise RuntimeError. In
that case, you can handle it yourself, or add a method to me for handling
that request type.
</p>
</div>
</div>
<div id="method-M000253" class="method-detail">
<a name="M000253"></a>
<div class="method-heading">
<a href="Server.src/M000253.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000253.html');return false;">
<span class="method-name">openid_associate</span><span class="method-args">(request)</span>
</a>
</div>
<div class="method-description">
<p>
Handle and respond to associate requests.
</p>
</div>
</div>
<div id="method-M000252" class="method-detail">
<a name="M000252"></a>
<div class="method-heading">
<a href="Server.src/M000252.html" target="Code" class="method-signature"
onclick="popupCode('Server.src/M000252.html');return false;">
<span class="method-name">openid_check_authentication</span><span class="method-args">(request)</span>
</a>
</div>
<div class="method-description">
<p>
Handle and respond to check_authentication requests.
</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>
|
