forked from corona-warn-app/Swift-JWT
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathJWTDecoder.html
469 lines (434 loc) · 24.9 KB
/
JWTDecoder.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<title>JWTDecoder Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset="utf-8">
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>
<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/JWTDecoder" class="dashAnchor"></a>
<a title="JWTDecoder Class Reference"></a>
<header class="header">
<p class="header-col header-col--primary">
<a class="header-link" href="../index.html">
SwiftJWT 3.6.200 Docs
</a>
(100% documented)
</p>
<p class="header-col--secondary">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
<p class="header-col header-col--secondary">
<a class="header-link" href="https://github.com/Kitura/Swift-JWT/">
<img class="header-icon" src="../img/gh.png"/>
View on GitHub
</a>
</p>
</header>
<p class="breadcrumbs">
<a class="breadcrumb" href="../index.html">SwiftJWT Reference</a>
<img class="carat" src="../img/carat.png" />
JWTDecoder Class Reference
</p>
<div class="content-wrapper">
<nav class="navigation">
<ul class="nav-groups">
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ClaimsMicroProfile.html">ClaimsMicroProfile</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ClaimsOpenID.html">ClaimsOpenID</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/ClaimsStandardJWT.html">ClaimsStandardJWT</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/JWTDecoder.html">JWTDecoder</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Classes/JWTEncoder.html">JWTEncoder</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Protocols/Claims.html">Claims</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a class="nav-group-name-link" href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/AddressClaim.html">AddressClaim</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/Header.html">Header</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/JWT.html">JWT</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/JWTError.html">JWTError</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/JWTSigner.html">JWTSigner</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/JWTVerifier.html">JWTVerifier</a>
</li>
<li class="nav-group-task">
<a class="nav-group-task-link" href="../Structs/ValidateClaimsResult.html">ValidateClaimsResult</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section class="section">
<div class="section-content top-matter">
<h1>JWTDecoder</h1>
<div class="declaration">
<div class="language">
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">class</span> <span class="kt">JWTDecoder</span> <span class="p">:</span> <span class="kt">BodyDecoder</span></code></pre>
</div>
</div>
<p>A thread safe decoder that decodes either Data or a JWT String as a <code><a href="../Structs/JWT.html">JWT</a></code> instance and verifies the signiture using the provided algorithm.</p>
<h3 id='usage-example' class='heading'>Usage Example:</h3>
<pre class="highlight swift"><code><span class="kd">struct</span> <span class="kt">MyClaims</span><span class="p">:</span> <span class="kt">Claims</span> <span class="p">{</span>
<span class="k">var</span> <span class="nv">name</span><span class="p">:</span> <span class="kt">String</span>
<span class="p">}</span>
<span class="k">let</span> <span class="nv">publicKey</span> <span class="o">=</span> <span class="s">"<PublicKey>"</span><span class="o">.</span><span class="nf">data</span><span class="p">(</span><span class="nv">using</span><span class="p">:</span> <span class="o">.</span><span class="n">utf8</span><span class="p">)</span><span class="o">!</span>
<span class="k">let</span> <span class="nv">rsaJWTDecoder</span> <span class="o">=</span> <span class="kt">JWTDecoder</span><span class="p">(</span><span class="nv">jwtVerifier</span><span class="p">:</span> <span class="kt">JWTVerifier</span><span class="o">.</span><span class="nf">rs256</span><span class="p">(</span><span class="nv">publicKey</span><span class="p">:</span> <span class="n">publicKey</span><span class="p">))</span>
<span class="k">do</span> <span class="p">{</span>
<span class="k">let</span> <span class="nv">jwt</span> <span class="o">=</span> <span class="k">try</span> <span class="n">rsaJWTDecoder</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="kt">JWT</span><span class="o"><</span><span class="kt">MyClaims</span><span class="o">>.</span><span class="k">self</span><span class="p">,</span> <span class="nv">fromString</span><span class="p">:</span> <span class="n">exampleJWTString</span><span class="p">)</span>
<span class="p">}</span> <span class="k">catch</span> <span class="p">{</span>
<span class="nf">print</span><span class="p">(</span><span class="s">"Failed to decode JWT: </span><span class="se">\(</span><span class="n">error</span><span class="se">)</span><span class="s">"</span><span class="p">)</span>
<span class="p">}</span>
</code></pre>
</div>
</section>
<section class="section">
<div class="section-content">
<div class="task-group">
<div class="task-name-container">
<a name="/Initializers"></a>
<a name="//apple_ref/swift/Section/Initializers" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Initializers"></a>
<h3 class="section-name"><p>Initializers</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:8SwiftJWT10JWTDecoderC11jwtVerifierAcA11JWTVerifierV_tcfc"></a>
<a name="//apple_ref/swift/Method/init(jwtVerifier:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftJWT10JWTDecoderC11jwtVerifierAcA11JWTVerifierV_tcfc">init(jwtVerifier:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initialize a <code>JWTDecoder</code> instance with a single <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code>.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">jwtVerifier</span><span class="p">:</span> <span class="kt"><a href="../Structs/JWTVerifier.html">JWTVerifier</a></span><span class="p">)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>JWTVerifier</em>
</code>
</td>
<td>
<div>
<p>The <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code> that will be used to verify the signiture of the JWT.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A new instance of <code>JWTDecoder</code>.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftJWT10JWTDecoderC15keyIDToVerifierAcA11JWTVerifierVSgSSc_tcfc"></a>
<a name="//apple_ref/swift/Method/init(keyIDToVerifier:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftJWT10JWTDecoderC15keyIDToVerifierAcA11JWTVerifierVSgSSc_tcfc">init(keyIDToVerifier:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initialize a <code>JWTDecoder</code> instance with a function to generate the <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code> from the JWT <code>kid</code> header.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="nf">init</span><span class="p">(</span><span class="nv">keyIDToVerifier</span><span class="p">:</span> <span class="kd">@escaping</span> <span class="p">(</span><span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt"><a href="../Structs/JWTVerifier.html">JWTVerifier</a></span><span class="p">?)</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>keyIDToVerifier</em>
</code>
</td>
<td>
<div>
<p>The function that will generate the <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code> using the “kid” header.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A new instance of <code>JWTDecoder</code>.</p>
</div>
</section>
</div>
</li>
</ul>
</div>
<div class="task-group">
<div class="task-name-container">
<a name="/Decode"></a>
<a name="//apple_ref/swift/Section/Decode" class="dashAnchor"></a>
<div class="section-name-container">
<a class="section-name-link" href="#/Decode"></a>
<h3 class="section-name"><p>Decode</p>
</h3>
</div>
</div>
<ul class="item-container">
<li class="item">
<div>
<code>
<a name="/s:8SwiftJWT10JWTDecoderC6decode_10fromStringxxm_SStKSeRzlF"></a>
<a name="//apple_ref/swift/Method/decode(_:fromString:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftJWT10JWTDecoderC6decode_10fromStringxxm_SStKSeRzlF">decode(_:<wbr>fromString:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decode a <code><a href="../Structs/JWT.html">JWT</a></code> instance from a JWT String.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV16invalidJWTStringACvpZ">JWTError.invalidJWTString</a></code> if the provided String is not in the form mandated by the JWT specification.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV12invalidKeyIDACvpZ">JWTError.invalidKeyID</a></code> if the KeyID <code>kid</code> header fails to generate a jwtVerifier.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV18failedVerificationACvpZ">JWTError.failedVerification</a></code> if the <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code> fails to verify the decoded String.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code>DecodingError</code> if the decoder fails to decode the String as the provided type.
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">decode</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span><span class="p">,</span> <span class="nv">fromString</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">T</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>type</em>
</code>
</td>
<td>
<div>
<p>The JWT type the String will be decoded as.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>fromString</em>
</code>
</td>
<td>
<div>
<p>The JWT String that will be decoded.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A <code><a href="../Structs/JWT.html">JWT</a></code> instance of the provided type.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftJWT10JWTDecoderC6decode_4fromxxm_10Foundation4DataVtKSeRzlF"></a>
<a name="//apple_ref/swift/Method/decode(_:from:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftJWT10JWTDecoderC6decode_4fromxxm_10Foundation4DataVtKSeRzlF">decode(_:<wbr>from:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Decode a <code><a href="../Structs/JWT.html">JWT</a></code> instance from a utf8 encoded JWT String.</p>
<div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV15invalidUTF8DataACvpZ">JWTError.invalidUTF8Data</a></code> if the provided Data can’t be decoded to a String.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV16invalidJWTStringACvpZ">JWTError.invalidJWTString</a></code> if the provided String is not in the form mandated by the JWT specification.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV12invalidKeyIDACvpZ">JWTError.invalidKeyID</a></code> if the KeyID <code>kid</code> header fails to generate a <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code>.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code><a href="../Structs/JWTError.html#/s:8SwiftJWT8JWTErrorV18failedVerificationACvpZ">JWTError.failedVerification</a></code> if the <code><a href="../Structs/JWTVerifier.html">JWTVerifier</a></code> fails to verify the decoded String.
</div><div class="aside aside-throws">
<p class="aside-title">Throws</p>
<code>DecodingError</code> if the decoder fails to decode the String as the provided type.
</div>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">func</span> <span class="n">decode</span><span class="o"><</span><span class="kt">T</span><span class="o">></span><span class="p">(</span><span class="n">_</span> <span class="nv">type</span><span class="p">:</span> <span class="kt">T</span><span class="o">.</span><span class="k">Type</span><span class="p">,</span> <span class="n">from</span> <span class="nv">data</span><span class="p">:</span> <span class="kt">Data</span><span class="p">)</span> <span class="k">throws</span> <span class="o">-></span> <span class="kt">T</span> <span class="k">where</span> <span class="kt">T</span> <span class="p">:</span> <span class="kt">Decodable</span></code></pre>
</div>
</div>
<div>
<h4>Parameters</h4>
<table class="graybox">
<tbody>
<tr>
<td>
<code>
<em>type</em>
</code>
</td>
<td>
<div>
<p>The JWT type the Data will be decoded as.</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>data</em>
</code>
</td>
<td>
<div>
<p>The utf8 encoded JWT String that will be decoded.</p>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<div>
<h4>Return Value</h4>
<p>A <code><a href="../Structs/JWT.html">JWT</a></code> instance of the provided type.</p>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:8SwiftJWT10JWTDecoderC4data16base64urlEncoded10Foundation4DataVSgSS_tFZ"></a>
<a name="//apple_ref/swift/Method/data(base64urlEncoded:)" class="dashAnchor"></a>
<a class="token" href="#/s:8SwiftJWT10JWTDecoderC4data16base64urlEncoded10Foundation4DataVSgSS_tFZ">data(base64urlEncoded:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Initializes a new <code>Data</code> from the base64url-encoded <code>String</code> provided. The
base64url encoding is defined in RFC4648 (<a href="https://tools.ietf.org/html/rfc4648">https://tools.ietf.org/html/rfc4648</a>).</p>
<p>This is appropriate for reading the header or claims portion of a JWT string.</p>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">data</span><span class="p">(</span><span class="nv">base64urlEncoded</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-></span> <span class="kt">Data</span><span class="p">?</span></code></pre>
</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</div>
</section>
</article>
</div>
<section class="footer">
<p>© 2020 <a class="link" href="https://github.com/Kitura/Swift-JWT" target="_blank" rel="external">IBM & Kitura Project Contributors</a>. All rights reserved. (Last updated: 2020-11-25)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</body>
</div>
</html>