m2m_keygen 0.2.1 → 0.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +14 -1
- data/Gemfile.lock +1 -1
- data/README.md +87 -4
- data/docs/M2mKeygen/Error.html +1 -1
- data/docs/M2mKeygen/ParamsEncoder.html +321 -0
- data/docs/M2mKeygen/Signature.html +680 -0
- data/docs/M2mKeygen/Types.html +147 -0
- data/docs/M2mKeygen.html +7 -5
- data/docs/_index.html +46 -1
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +94 -5
- data/docs/index.html +94 -5
- data/docs/method_list.html +56 -0
- data/docs/top-level-namespace.html +1 -1
- data/lib/m2m_keygen/params_encoder.rb +56 -0
- data/lib/m2m_keygen/signature.rb +78 -0
- data/lib/m2m_keygen/types/params_type.rb +25 -0
- data/lib/m2m_keygen/version.rb +1 -1
- data/lib/m2m_keygen.rb +5 -2
- data/sorbet/rbi/gems/{rb-fsevent@0.11.1.rbi → rb-fsevent@0.11.2.rbi} +0 -0
- data/sorbet/rbi/gems/zeitwerk@2.6.0.rbi +861 -2
- data/sorbet/rbi/manual.rbi +7 -0
- metadata +10 -3
|
@@ -0,0 +1,680 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: M2mKeygen::Signature
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.28
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "M2mKeygen::Signature";
|
|
19
|
+
relpath = '../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../_index.html">Index (S)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../M2mKeygen.html" title="M2mKeygen (module)">M2mKeygen</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">Signature</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: M2mKeygen::Signature
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">M2mKeygen::Signature</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
<dl>
|
|
89
|
+
<dt>Extended by:</dt>
|
|
90
|
+
<dd>T::Sig</dd>
|
|
91
|
+
</dl>
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
<dl>
|
|
101
|
+
<dt>Defined in:</dt>
|
|
102
|
+
<dd>lib/m2m_keygen/signature.rb</dd>
|
|
103
|
+
</dl>
|
|
104
|
+
|
|
105
|
+
</div>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
112
|
+
<ul class="summary">
|
|
113
|
+
|
|
114
|
+
<li class="public ">
|
|
115
|
+
<span class="summary_signature">
|
|
116
|
+
|
|
117
|
+
<a href="#algorithm-instance_method" title="#algorithm (instance method)">#<strong>algorithm</strong> ⇒ String </a>
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</span>
|
|
122
|
+
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
<span class="note title readonly">readonly</span>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
137
|
+
|
|
138
|
+
</li>
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
<li class="public ">
|
|
142
|
+
<span class="summary_signature">
|
|
143
|
+
|
|
144
|
+
<a href="#secret-instance_method" title="#secret (instance method)">#<strong>secret</strong> ⇒ String </a>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
</span>
|
|
149
|
+
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
<span class="note title readonly">readonly</span>
|
|
154
|
+
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
164
|
+
|
|
165
|
+
</li>
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
</ul>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
<h2>
|
|
175
|
+
Instance Method Summary
|
|
176
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
177
|
+
</h2>
|
|
178
|
+
|
|
179
|
+
<ul class="summary">
|
|
180
|
+
|
|
181
|
+
<li class="public ">
|
|
182
|
+
<span class="summary_signature">
|
|
183
|
+
|
|
184
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(secret, algorithm: "sha512") ⇒ void </a>
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
</span>
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
<span class="note title constructor">constructor</span>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
201
|
+
|
|
202
|
+
</li>
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<li class="public ">
|
|
206
|
+
<span class="summary_signature">
|
|
207
|
+
|
|
208
|
+
<a href="#sign-instance_method" title="#sign (instance method)">#<strong>sign</strong>(params:, verb:, path:) ⇒ String </a>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
223
|
+
|
|
224
|
+
</li>
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
<li class="public ">
|
|
228
|
+
<span class="summary_signature">
|
|
229
|
+
|
|
230
|
+
<a href="#validate-instance_method" title="#validate (instance method)">#<strong>validate</strong>(params:, verb:, path:, signature:) ⇒ Boolean </a>
|
|
231
|
+
|
|
232
|
+
|
|
233
|
+
|
|
234
|
+
</span>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
<span class="summary_desc"><div class='inline'></div></span>
|
|
245
|
+
|
|
246
|
+
</li>
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
</ul>
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<div id="constructor_details" class="method_details_list">
|
|
254
|
+
<h2>Constructor Details</h2>
|
|
255
|
+
|
|
256
|
+
<div class="method_details first">
|
|
257
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
258
|
+
|
|
259
|
+
#<strong>initialize</strong>(secret, algorithm: "sha512") ⇒ <tt>void</tt>
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
</h3><div class="docstring">
|
|
266
|
+
<div class="discussion">
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
</div>
|
|
270
|
+
</div>
|
|
271
|
+
<div class="tags">
|
|
272
|
+
<p class="tag_title">Parameters:</p>
|
|
273
|
+
<ul class="param">
|
|
274
|
+
|
|
275
|
+
<li>
|
|
276
|
+
|
|
277
|
+
<span class='name'>secret</span>
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</li>
|
|
285
|
+
|
|
286
|
+
<li>
|
|
287
|
+
|
|
288
|
+
<span class='name'>algorithm</span>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<em class="default">(defaults to: <tt>"sha512"</tt>)</em>
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
</li>
|
|
298
|
+
|
|
299
|
+
</ul>
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
</div><table class="source_code">
|
|
303
|
+
<tr>
|
|
304
|
+
<td>
|
|
305
|
+
<pre class="lines">
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
17
|
|
309
|
+
18
|
|
310
|
+
19
|
|
311
|
+
20
|
|
312
|
+
21</pre>
|
|
313
|
+
</td>
|
|
314
|
+
<td>
|
|
315
|
+
<pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 17</span>
|
|
316
|
+
|
|
317
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_secret'>secret</span><span class='comma'>,</span> <span class='label'>algorithm:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>sha512</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
318
|
+
<span class='ivar'>@secret</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='id identifier rubyid_secret'>secret</span><span class='comma'>,</span> <span class='const'>String</span><span class='rparen'>)</span>
|
|
319
|
+
<span class='ivar'>@algorithm</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='id identifier rubyid_algorithm'>algorithm</span><span class='comma'>,</span> <span class='const'>String</span><span class='rparen'>)</span>
|
|
320
|
+
<span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>HMAC</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span><span class='ivar'>@algorithm</span><span class='comma'>,</span> <span class='ivar'>@secret</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
321
|
+
<span class='kw'>end</span></pre>
|
|
322
|
+
</td>
|
|
323
|
+
</tr>
|
|
324
|
+
</table>
|
|
325
|
+
</div>
|
|
326
|
+
|
|
327
|
+
</div>
|
|
328
|
+
|
|
329
|
+
<div id="instance_attr_details" class="attr_details">
|
|
330
|
+
<h2>Instance Attribute Details</h2>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<span id=""></span>
|
|
334
|
+
<div class="method_details first">
|
|
335
|
+
<h3 class="signature first" id="algorithm-instance_method">
|
|
336
|
+
|
|
337
|
+
#<strong>algorithm</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
</h3><div class="docstring">
|
|
344
|
+
<div class="discussion">
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
</div>
|
|
348
|
+
</div>
|
|
349
|
+
<div class="tags">
|
|
350
|
+
|
|
351
|
+
<p class="tag_title">Returns:</p>
|
|
352
|
+
<ul class="return">
|
|
353
|
+
|
|
354
|
+
<li>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
358
|
+
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
</li>
|
|
362
|
+
|
|
363
|
+
</ul>
|
|
364
|
+
|
|
365
|
+
</div><table class="source_code">
|
|
366
|
+
<tr>
|
|
367
|
+
<td>
|
|
368
|
+
<pre class="lines">
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
14
|
|
372
|
+
15
|
|
373
|
+
16</pre>
|
|
374
|
+
</td>
|
|
375
|
+
<td>
|
|
376
|
+
<pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 14</span>
|
|
377
|
+
|
|
378
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_algorithm'>algorithm</span>
|
|
379
|
+
<span class='ivar'>@algorithm</span>
|
|
380
|
+
<span class='kw'>end</span></pre>
|
|
381
|
+
</td>
|
|
382
|
+
</tr>
|
|
383
|
+
</table>
|
|
384
|
+
</div>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
<span id=""></span>
|
|
388
|
+
<div class="method_details ">
|
|
389
|
+
<h3 class="signature " id="secret-instance_method">
|
|
390
|
+
|
|
391
|
+
#<strong>secret</strong> ⇒ <tt>String</tt> <span class="extras">(readonly)</span>
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
</h3><div class="docstring">
|
|
398
|
+
<div class="discussion">
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
</div>
|
|
402
|
+
</div>
|
|
403
|
+
<div class="tags">
|
|
404
|
+
|
|
405
|
+
<p class="tag_title">Returns:</p>
|
|
406
|
+
<ul class="return">
|
|
407
|
+
|
|
408
|
+
<li>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
</li>
|
|
416
|
+
|
|
417
|
+
</ul>
|
|
418
|
+
|
|
419
|
+
</div><table class="source_code">
|
|
420
|
+
<tr>
|
|
421
|
+
<td>
|
|
422
|
+
<pre class="lines">
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
11
|
|
426
|
+
12
|
|
427
|
+
13</pre>
|
|
428
|
+
</td>
|
|
429
|
+
<td>
|
|
430
|
+
<pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 11</span>
|
|
431
|
+
|
|
432
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_secret'>secret</span>
|
|
433
|
+
<span class='ivar'>@secret</span>
|
|
434
|
+
<span class='kw'>end</span></pre>
|
|
435
|
+
</td>
|
|
436
|
+
</tr>
|
|
437
|
+
</table>
|
|
438
|
+
</div>
|
|
439
|
+
|
|
440
|
+
</div>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
<div id="instance_method_details" class="method_details_list">
|
|
444
|
+
<h2>Instance Method Details</h2>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
<div class="method_details first">
|
|
448
|
+
<h3 class="signature first" id="sign-instance_method">
|
|
449
|
+
|
|
450
|
+
#<strong>sign</strong>(params:, verb:, path:) ⇒ <tt>String</tt>
|
|
451
|
+
|
|
452
|
+
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</h3><div class="docstring">
|
|
457
|
+
<div class="discussion">
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
</div>
|
|
461
|
+
</div>
|
|
462
|
+
<div class="tags">
|
|
463
|
+
<p class="tag_title">Parameters:</p>
|
|
464
|
+
<ul class="param">
|
|
465
|
+
|
|
466
|
+
<li>
|
|
467
|
+
|
|
468
|
+
<span class='name'>params</span>
|
|
469
|
+
|
|
470
|
+
|
|
471
|
+
<span class='type'>(<tt><span class='object_link'><a href="Types.html#ParamsType-constant" title="M2mKeygen::Types::ParamsType (constant)">Types::ParamsType</a></span></tt>)</span>
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
|
|
475
|
+
</li>
|
|
476
|
+
|
|
477
|
+
<li>
|
|
478
|
+
|
|
479
|
+
<span class='name'>verb</span>
|
|
480
|
+
|
|
481
|
+
|
|
482
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</li>
|
|
487
|
+
|
|
488
|
+
<li>
|
|
489
|
+
|
|
490
|
+
<span class='name'>path</span>
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</li>
|
|
498
|
+
|
|
499
|
+
</ul>
|
|
500
|
+
|
|
501
|
+
<p class="tag_title">Returns:</p>
|
|
502
|
+
<ul class="return">
|
|
503
|
+
|
|
504
|
+
<li>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
</li>
|
|
512
|
+
|
|
513
|
+
</ul>
|
|
514
|
+
|
|
515
|
+
</div><table class="source_code">
|
|
516
|
+
<tr>
|
|
517
|
+
<td>
|
|
518
|
+
<pre class="lines">
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
30
|
|
522
|
+
31
|
|
523
|
+
32
|
|
524
|
+
33
|
|
525
|
+
34
|
|
526
|
+
35
|
|
527
|
+
36</pre>
|
|
528
|
+
</td>
|
|
529
|
+
<td>
|
|
530
|
+
<pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 30</span>
|
|
531
|
+
|
|
532
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='label'>params:</span><span class='comma'>,</span> <span class='label'>verb:</span><span class='comma'>,</span> <span class='label'>path:</span><span class='rparen'>)</span>
|
|
533
|
+
<span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>HMAC</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span>
|
|
534
|
+
<span class='ivar'>@algorithm</span><span class='comma'>,</span>
|
|
535
|
+
<span class='ivar'>@secret</span><span class='comma'>,</span>
|
|
536
|
+
<span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_verb'>verb</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="ParamsEncoder.html" title="M2mKeygen::ParamsEncoder (class)">ParamsEncoder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ParamsEncoder.html#initialize-instance_method" title="M2mKeygen::ParamsEncoder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span>
|
|
537
|
+
<span class='rparen'>)</span>
|
|
538
|
+
<span class='kw'>end</span></pre>
|
|
539
|
+
</td>
|
|
540
|
+
</tr>
|
|
541
|
+
</table>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
<div class="method_details ">
|
|
545
|
+
<h3 class="signature " id="validate-instance_method">
|
|
546
|
+
|
|
547
|
+
#<strong>validate</strong>(params:, verb:, path:, signature:) ⇒ <tt>Boolean</tt>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
</h3><div class="docstring">
|
|
554
|
+
<div class="discussion">
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
</div>
|
|
558
|
+
</div>
|
|
559
|
+
<div class="tags">
|
|
560
|
+
<p class="tag_title">Parameters:</p>
|
|
561
|
+
<ul class="param">
|
|
562
|
+
|
|
563
|
+
<li>
|
|
564
|
+
|
|
565
|
+
<span class='name'>params</span>
|
|
566
|
+
|
|
567
|
+
|
|
568
|
+
<span class='type'>(<tt><span class='object_link'><a href="Types.html#ParamsType-constant" title="M2mKeygen::Types::ParamsType (constant)">Types::ParamsType</a></span></tt>)</span>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
</li>
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
|
|
576
|
+
<span class='name'>verb</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
</li>
|
|
584
|
+
|
|
585
|
+
<li>
|
|
586
|
+
|
|
587
|
+
<span class='name'>path</span>
|
|
588
|
+
|
|
589
|
+
|
|
590
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
591
|
+
|
|
592
|
+
|
|
593
|
+
|
|
594
|
+
</li>
|
|
595
|
+
|
|
596
|
+
<li>
|
|
597
|
+
|
|
598
|
+
<span class='name'>signature</span>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
<span class='type'>(<tt>String</tt>)</span>
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
</li>
|
|
606
|
+
|
|
607
|
+
</ul>
|
|
608
|
+
|
|
609
|
+
<p class="tag_title">Returns:</p>
|
|
610
|
+
<ul class="return">
|
|
611
|
+
|
|
612
|
+
<li>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
<span class='type'>(<tt>Boolean</tt>)</span>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
</li>
|
|
620
|
+
|
|
621
|
+
</ul>
|
|
622
|
+
|
|
623
|
+
</div><table class="source_code">
|
|
624
|
+
<tr>
|
|
625
|
+
<td>
|
|
626
|
+
<pre class="lines">
|
|
627
|
+
|
|
628
|
+
|
|
629
|
+
46
|
|
630
|
+
47
|
|
631
|
+
48
|
|
632
|
+
49
|
|
633
|
+
50
|
|
634
|
+
51
|
|
635
|
+
52
|
|
636
|
+
53
|
|
637
|
+
54
|
|
638
|
+
55
|
|
639
|
+
56
|
|
640
|
+
57
|
|
641
|
+
58
|
|
642
|
+
59
|
|
643
|
+
60</pre>
|
|
644
|
+
</td>
|
|
645
|
+
<td>
|
|
646
|
+
<pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 46</span>
|
|
647
|
+
|
|
648
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='label'>params:</span><span class='comma'>,</span> <span class='label'>verb:</span><span class='comma'>,</span> <span class='label'>path:</span><span class='comma'>,</span> <span class='label'>signature:</span><span class='rparen'>)</span>
|
|
649
|
+
<span class='kw'>if</span> <span class='const'>OpenSSL</span><span class='period'>.</span><span class='id identifier rubyid_method_defined?'>method_defined?</span><span class='lparen'>(</span><span class='symbol'>:fixed_length_secure_compare</span><span class='rparen'>)</span>
|
|
650
|
+
<span class='const'>OpenSSL</span><span class='period'>.</span><span class='id identifier rubyid_fixed_length_secure_compare'>fixed_length_secure_compare</span><span class='lparen'>(</span>
|
|
651
|
+
<span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='label'>verb:</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
652
|
+
<span class='id identifier rubyid_signature'>signature</span>
|
|
653
|
+
<span class='rparen'>)</span>
|
|
654
|
+
<span class='kw'>else</span>
|
|
655
|
+
<span class='id identifier rubyid_fallback_fixed_length_secure_compare'>fallback_fixed_length_secure_compare</span><span class='lparen'>(</span>
|
|
656
|
+
<span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='label'>verb:</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span>
|
|
657
|
+
<span class='id identifier rubyid_signature'>signature</span>
|
|
658
|
+
<span class='rparen'>)</span>
|
|
659
|
+
<span class='kw'>end</span>
|
|
660
|
+
<span class='kw'>rescue</span> <span class='const'>StandardError</span>
|
|
661
|
+
<span class='kw'>false</span>
|
|
662
|
+
<span class='kw'>end</span></pre>
|
|
663
|
+
</td>
|
|
664
|
+
</tr>
|
|
665
|
+
</table>
|
|
666
|
+
</div>
|
|
667
|
+
|
|
668
|
+
</div>
|
|
669
|
+
|
|
670
|
+
</div>
|
|
671
|
+
|
|
672
|
+
<div id="footer">
|
|
673
|
+
Generated on Tue Aug 30 11:26:10 2022 by
|
|
674
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
675
|
+
0.9.28 (ruby-3.1.2).
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
</div>
|
|
679
|
+
</body>
|
|
680
|
+
</html>
|