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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: OAuth2::Strategy::Assertion
— Documentation by YARD 0.9.37
</title>
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "OAuth2::Strategy::Assertion";
relpath = '../../';
</script>
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="../../class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="../../_index.html">Index (A)</a> »
<span class='title'><span class='object_link'><a href="../../OAuth2.html" title="OAuth2 (module)">OAuth2</a></span></span> » <span class='title'><span class='object_link'><a href="../Strategy.html" title="OAuth2::Strategy (module)">Strategy</a></span></span>
»
<span class="title">Assertion</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="../../class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Class: OAuth2::Strategy::Assertion
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName"><span class='object_link'><a href="Base.html" title="OAuth2::Strategy::Base (class)">Base</a></span></span>
<ul class="fullTree">
<li>Object</li>
<li class="next"><span class='object_link'><a href="Base.html" title="OAuth2::Strategy::Base (class)">Base</a></span></li>
<li class="next">OAuth2::Strategy::Assertion</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/oauth2/strategy/assertion.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>The Client Assertion Strategy</p>
<p>Sample usage:<br />
client = OAuth2::Client.new(client_id, client_secret,<br />
:site => ‘http://localhost:8080’,<br />
:auth_scheme => :request_body)</p>
<p>claim_set = {<br />
:iss => “http://localhost:3001”,<br />
:aud => “http://localhost:8080/oauth2/token”,<br />
:sub => “me@example.com”,<br />
:exp => Time.now.utc.to_i + 3600,<br />
}</p>
<p>encoding = {<br />
:algorithm => ‘HS256’,<br />
:key => ‘secret_key’,<br />
}</p>
<p>access = client.assertion.get_token(claim_set, encoding)<br />
access.token # actual access_token string<br />
access.get(“/api/stuff”) # making api calls with access token in header</p>
</div>
</div>
<div class="tags">
<p class="tag_title">See Also:</p>
<ul class="see">
<li><a href="https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-10#section-4.1.3" target="_parent" title="https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-10#section-4.1.3">https://datatracker.ietf.org/doc/html/draft-ietf-oauth-v2-10#section-4.1.3</a></li>
</ul>
</div>
<h2>
Instance Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#authorize_url-instance_method" title="#authorize_url (instance method)">#<strong>authorize_url</strong> ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Not used for this strategy.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#get_token-instance_method" title="#get_token (instance method)">#<strong>get_token</strong>(claims, encoding_opts, request_opts = {}, response_opts = {}) ⇒ Object </a>
</span>
<span class="summary_desc"><div class='inline'><p>Retrieve an access token given the specified client.</p>
</div></span>
</li>
</ul>
<h3 class="inherited">Methods inherited from <span class='object_link'><a href="Base.html" title="OAuth2::Strategy::Base (class)">Base</a></span></h3>
<p class="inherited"><span class='object_link'><a href="Base.html#initialize-instance_method" title="OAuth2::Strategy::Base#initialize (method)">#initialize</a></span></p>
<div id="constructor_details" class="method_details_list">
<h2>Constructor Details</h2>
<p class="notice">This class inherits a constructor from <span class='object_link'><a href="Base.html#initialize-instance_method" title="OAuth2::Strategy::Base#initialize (method)">OAuth2::Strategy::Base</a></span></p>
</div>
<div id="instance_method_details" class="method_details_list">
<h2>Instance Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="authorize_url-instance_method">
#<strong>authorize_url</strong> ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Not used for this strategy</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Raises:</p>
<ul class="raise">
<li>
<span class='type'>(<tt>NotImplementedError</tt>)</span>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
36
37
38</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/oauth2/strategy/assertion.rb', line 36</span>
<span class='kw'>def</span> <span class='id identifier rubyid_authorize_url'>authorize_url</span>
<span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='const'>NotImplementedError</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>The authorization endpoint is not used in this strategy</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="get_token-instance_method">
#<strong>get_token</strong>(claims, encoding_opts, request_opts = {}, response_opts = {}) ⇒ <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Retrieve an access token given the specified client.</p>
<p>For reading on JWT and claim keys:<br />
@see https://github.com/jwt/ruby-jwt<br />
@see https://datatracker.ietf.org/doc/html/rfc7519#section-4.1<br />
@see https://datatracker.ietf.org/doc/html/rfc7523#section-3<br />
@see https://www.iana.org/assignments/jwt/jwt.xhtml</p>
<p>There are many possible claim keys, and applications may ask for their own custom keys.<br />
Some typically required ones:<br />
:iss (issuer)<br />
:aud (audience)<br />
:sub (subject) – formerly :prn https://datatracker.ietf.org/doc/html/draft-ietf-oauth-json-web-token-06#appendix-F<br />
:exp, (expiration time) – in seconds, e.g. Time.now.utc.to_i + 3600</p>
<p>Note that this method does <em>not</em> validate presence of those four claim keys indicated as required by RFC 7523.<br />
There are endpoints that may not conform with this RFC, and this gem should still work for those use cases.</p>
<p>These two options are passed directly to <code>JWT.encode</code>. For supported encoding arguments:<br />
@see https://github.com/jwt/ruby-jwt#algorithms-and-usage<br />
@see https://datatracker.ietf.org/doc/html/rfc7518#section-3.1</p>
<p>The object type of <code>:key</code> may depend on the value of <code>:algorithm</code>. Sample arguments:<br />
get_token(claim_set, => ‘HS256’, :key => ‘secret_key’)<br />
get_token(claim_set, => ‘RS256’, :key => OpenSSL::PKCS12.new(File.read(‘my_key.p12’), ‘not_secret’))</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">
<li>
<span class='name'>claims</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>the hash representation of the claims that should be encoded as a JWT (JSON Web Token)</p>
</div>
</li>
<li>
<span class='name'>encoding_opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>a hash containing instructions on how the JWT should be encoded</p>
</div>
</li>
<li>
<span class='name'>request_opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>options that will be used to assemble the request</p>
</div>
</li>
<li>
<span class='name'>response_opts</span>
<span class='type'>(<tt>Hash</tt>)</span>
<em class="default">(defaults to: <tt>{}</tt>)</em>
—
<div class='inline'><p>this will be merged with the token response to create the AccessToken object<br />
@see the access_token_opts argument to Client#get_token</p>
</div>
</li>
<li>
<span class='name'>algorithm</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>a customizable set of options</p>
</div>
</li>
<li>
<span class='name'>key</span>
<span class='type'>(<tt>Hash</tt>)</span>
—
<div class='inline'><p>a customizable set of options</p>
</div>
</li>
</ul>
<p class="tag_title">Options Hash (<tt>request_opts</tt>):</p>
<ul class="option">
<li>
<span class="name">:scope</span>
<span class="type">(<tt>String</tt>)</span>
<span class="default">
</span>
— <div class='inline'><p>the url parameter <code>scope</code> that may be required by some endpoints<br />
@see https://datatracker.ietf.org/doc/html/rfc7521#section-4.1</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
79
80
81
82
83
84</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/oauth2/strategy/assertion.rb', line 79</span>
<span class='kw'>def</span> <span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='id identifier rubyid_claims'>claims</span><span class='comma'>,</span> <span class='id identifier rubyid_encoding_opts'>encoding_opts</span><span class='comma'>,</span> <span class='id identifier rubyid_request_opts'>request_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='comma'>,</span> <span class='id identifier rubyid_response_opts'>response_opts</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
<span class='id identifier rubyid_assertion'>assertion</span> <span class='op'>=</span> <span class='id identifier rubyid_build_assertion'>build_assertion</span><span class='lparen'>(</span><span class='id identifier rubyid_claims'>claims</span><span class='comma'>,</span> <span class='id identifier rubyid_encoding_opts'>encoding_opts</span><span class='rparen'>)</span>
<span class='id identifier rubyid_params'>params</span> <span class='op'>=</span> <span class='id identifier rubyid_build_request'>build_request</span><span class='lparen'>(</span><span class='id identifier rubyid_assertion'>assertion</span><span class='comma'>,</span> <span class='id identifier rubyid_request_opts'>request_opts</span><span class='rparen'>)</span>
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get_token'>get_token</span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='id identifier rubyid_response_opts'>response_opts</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Sep 15 21:28:40 2025 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.37 (ruby-3.4.5).
</div>
</div>
</body>
</html>
|
