-
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMicrosoft.IdentityModel.Tokens.xml
2943 lines (2943 loc) · 193 KB
/
Microsoft.IdentityModel.Tokens.xml
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
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<doc>
<assembly>
<name>Microsoft.IdentityModel.Tokens</name>
</assembly>
<members>
<member name="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey">
<summary>
Base class for a Security Key that contains Asymmetric key material.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.HasPrivateKey">
<summary>
This must be overridden to get a bool indicating if a private key exists.
</summary>
<return>true if it has a private key; otherwise, false.</return>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey.PrivateKeyStatus">
<summary>
Gets the status of the private key.
</summary>
<return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.PrivateKeyStatus">
<summary>
Enum for the existence of private key
</summary>
</member>
<member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Exists">
<summary>
private key exists for sure
</summary>
</member>
<member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.DoesNotExist">
<summary>
private key doesn't exist for sure
</summary>
</member>
<member name="F:Microsoft.IdentityModel.Tokens.PrivateKeyStatus.Unknown">
<summary>
unable to determine the existence of private key
</summary>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider">
<summary>
Provides signing and verifying operations when working with an <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>
</summary>
</member>
<member name="F:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.DefaultMinimumAsymmetricKeySizeInBitsForSigningMap">
<summary>
Mapping from algorithm to minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize when creating signatures.
</summary>
</member>
<member name="F:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.DefaultMinimumAsymmetricKeySizeInBitsForVerifyingMap">
<summary>
Mapping from algorithm to minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize when verifying signatures.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> class used to create and verify signatures.
</summary>
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
<param name="algorithm">The signature algorithm to apply.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> class used to create and verify signatures.
</summary>
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for signature operations.</param>
<param name="algorithm">The signature algorithm to apply.</param>
<param name="willCreateSignatures">Whether this <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> is required to create signatures then set this to true.</param>
<para>
Creating signatures requires that the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> has access to a private key.
Verifying signatures (the default), does not require access to the private key.
</para>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
willCreateSignatures is true and <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize is less than the size corresponding to the given algorithm in <see cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap"/>.
</exception>
<exception cref="T:System.ArgumentOutOfRangeException">
<see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.KeySize is less than the size corresponding to the algorithm in <see cref="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap"/>. Note: this is always checked.
</exception>
<exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">If the runtime is unable to create a suitable cryptographic provider.</exception>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForSigningMap">
<summary>
Gets the mapping from algorithm to the minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize for creating signatures.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.MinimumAsymmetricKeySizeInBitsForVerifyingMap">
<summary>
Gets the mapping from algorithm to the minimum <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>.KeySize for verifying signatures.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.GetHashAlgorithmString(System.String)">
<summary>
Returns the algorithm name.
</summary>
<param name="algorithm">The hash algorithm to use to create the hash value.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Sign(System.Byte[])">
<summary>
Produces a signature over the 'input' using the <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> and algorithm passed to <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)"/>.
</summary>
<param name="input">The bytes to be signed.</param>
<returns>A signature over the input.</returns>
<exception cref="T:System.ArgumentNullException">'input' is null. </exception>
<exception cref="T:System.ArgumentException">'input.Length' == 0. </exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called. </exception>
<exception cref="T:System.InvalidOperationException">If the internal <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> is null. This can occur if the constructor parameter 'willBeUsedforSigning' was not 'true'.</exception>
<exception cref="T:System.InvalidOperationException">If the internal <see cref="T:System.Security.Cryptography.HashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.ValidateAsymmetricSecurityKeySize(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
<summary>
Validates that the asymmetric key size is more than the allowed minimum
</summary>
<param name="key">The asymmetric key to validate</param>
<param name="algorithm">Algorithm for which this key will be used</param>
<param name="willCreateSignatures">Whether they key will be used for creating signatures</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Verify(System.Byte[],System.Byte[])">
<summary>
Verifies that a signature over the' input' matches the signature.
</summary>
<param name="input">The bytes to generate the signature over.</param>
<param name="signature">The value to verify against.</param>
<returns>true if signature matches, false otherwise.</returns>
<exception cref="T:System.ArgumentNullException">'input' is null.</exception>
<exception cref="T:System.ArgumentNullException">'signature' is null.</exception>
<exception cref="T:System.ArgumentException">'input.Length' == 0.</exception>
<exception cref="T:System.ArgumentException">'signature.Length' == 0.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)"/> has been called. </exception>
<exception cref="T:System.InvalidOperationException">If the internal <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider"/> is null. This can occur if a derived type does not call the base constructor.</exception>
<exception cref="T:System.InvalidOperationException">If the internal <see cref="T:System.Security.Cryptography.HashAlgorithm"/> is null. This can occur if a derived type deletes it or does not create it.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AsymmetricSignatureProvider.Dispose(System.Boolean)">
<summary>
Calls <see cref="M:System.Security.Cryptography.HashAlgorithm.Dispose"/> to release this managed resources.
</summary>
<param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.Base64UrlEncoder">
<summary>
Encodes and Decodes strings as Base64Url encoding.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.String)">
<summary>
The following functions perform base64url encoding which differs from regular base64 encoding as follows
* padding is skipped so the pad character '=' doesn't have to be percent encoded
* the 62nd and 63rd regular base64 encoding characters ('+' and '/') are replace with ('-' and '_')
The changes make the encoding alphabet file and URL safe.
</summary>
<param name="arg">string to encode.</param>
<returns>Base64Url encoding of the UTF8 bytes.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.Byte[],System.Int32,System.Int32)">
<summary>
Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify
the subset as an offset in the input array, and the number of elements in the array to convert.
</summary>
<param name="inArray">An array of 8-bit unsigned integers.</param>
<param name="length">An offset in inArray.</param>
<param name="offset">The number of elements of inArray to convert.</param>
<returns>The string representation in base 64 url encodingof length elements of inArray, starting at position offset.</returns>
<exception cref="T:System.ArgumentNullException">'inArray' is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">offset or length is negative OR offset plus length is greater than the length of inArray.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Encode(System.Byte[])">
<summary>
Converts a subset of an array of 8-bit unsigned integers to its equivalent string representation that is encoded with base-64-url digits. Parameters specify
the subset as an offset in the input array, and the number of elements in the array to convert.
</summary>
<param name="inArray">An array of 8-bit unsigned integers.</param>
<returns>The string representation in base 64 url encodingof length elements of inArray, starting at position offset.</returns>
<exception cref="T:System.ArgumentNullException">'inArray' is null.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">offset or length is negative OR offset plus length is greater than the length of inArray.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.DecodeBytes(System.String)">
<summary>
Converts the specified string, which encodes binary data as base-64-url digits, to an equivalent 8-bit unsigned integer array.</summary>
<param name="str">base64Url encoded string.</param>
<returns>UTF8 bytes.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.Base64UrlEncoder.Decode(System.String)">
<summary>
Decodes the string from Base64UrlEncoded to UTF8.
</summary>
<param name="arg">string to decode.</param>
<returns>UTF8 string.</returns>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderCache">
<summary>
Definition of cache for crypto providers
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SignatureProvider)">
<summary>
Returns the cache key to use when looking up an entry into the cache for a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider" />
</summary>
<param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to create the key for.</param>
<returns>the cache key to use for finding a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.GetCacheKey(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)">
<summary>
Returns the 'key' that will be used to find a crypto provider in this cache.
</summary>
<param name="securityKey">the key that is used to by the crypto provider.</param>
<param name="algorithm">the algorithm that is used by the crypto provider.</param>
<param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
<returns>the cache key to use for finding a crypto provider.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryAdd(Microsoft.IdentityModel.Tokens.SignatureProvider)">
<summary>
Trys to adds a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to this cache.
</summary>
<param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to cache.</param>
<returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was added, false if the cache already contained the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/></returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryGetSignatureProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String,System.Boolean,Microsoft.IdentityModel.Tokens.SignatureProvider@)">
<summary>
Trys to find a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> in this cache.
</summary>
<param name="securityKey">the key that is used to by the crypto provider.</param>
<param name="algorithm">the algorithm that is used by the crypto provider.</param>
<param name="typeofProvider">the typeof the crypto provider obtained by calling object.GetType().</param>
<param name="willCreateSignatures">a bool to indicate if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> will be used to sign.</param>
<param name="signatureProvider">the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> if found.</param>
<returns>true if a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was found, false otherwise.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderCache.TryRemove(Microsoft.IdentityModel.Tokens.SignatureProvider)">
<summary>
Trys to remove a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> from this cache.
</summary>
<param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to remove.</param>
<returns>true if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was removed, false if the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> was not found.</returns>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory">
<summary>
Creates <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/>s by specifying a <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.
<para>Supports both <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</para>
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.Default">
<summary>
Returns the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> instance.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.DefaultCacheSignatureProviders">
<summary>
Gets or sets the default value for caching
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#cctor">
<summary>
Static constructor that initializes the default <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor">
<summary>
Default constructor for <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/>.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.#ctor(Microsoft.IdentityModel.Tokens.CryptoProviderFactory)">
<summary>
Constructor that creates a deep copy of given <see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> object.
</summary>
<param name="other"><see cref="T:Microsoft.IdentityModel.Tokens.CryptoProviderFactory"/> to copy from.</param>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CryptoProviderCache">
<summary>
Gets the <see cref="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CryptoProviderCache"/>
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CustomCryptoProvider">
<summary>
Extensibility point for custom crypto support application wide.
</summary>
<remarks>By default, if set, <see cref="M:Microsoft.IdentityModel.Tokens.ICryptoProvider.IsSupportedAlgorithm(System.String,System.Object[])"/> will be called before crypto operations.
If true is returned, then this will be called for operations.</remarks>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CacheSignatureProviders">
<summary>
Gets or sets a bool controlling if <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> should be cached.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateAuthenticatedEncryptionProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/> for a specific <SecurityKey, Algorithm>.
</summary>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
<param name="algorithm">the algorithm to use.</param>
<returns>an instance of <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/></returns>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.ArgumentException">'key' is not a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
<exception cref="T:System.ArgumentException">'algorithm, key' pair is not supported.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyWrapProvider(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> for a specific <SecurityKey, Algorithm>.
</summary>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
<param name="algorithm">the algorithm to use.</param>
<returns>an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/></returns>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
<remarks>
<para>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para>
</remarks>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyWrapProviderForUnwrap(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Creates an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> for a specific <SecurityKey, Algorithm>.
</summary>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use.</param>
<param name="algorithm">the algorithm to use.</param>
<returns>an instance of <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/></returns>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
<remarks>
<para>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)"/>.</para>
</remarks>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForSigning(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Creates a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> that supports the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.
</summary>
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signing.</param>
<param name="algorithm">The algorithm to use for signing.</param>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/>' is too small.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> is too small.</exception>
<exception cref="T:System.ArgumentException"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> is not a <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
<remarks>
AsymmetricSignatureProviders require access to a PrivateKey for Signing.
<para>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</para>
</remarks>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateForVerifying(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Returns a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> instance supports the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm.
</summary>
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> to use for signing.</param>
<param name="algorithm">The algorithm to use for verifying.</param>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> is too small.</exception>
<exception cref="T:System.ArgumentOutOfRangeException"><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> is too small.</exception>
<exception cref="T:System.ArgumentException"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>' is not a <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey"/> or a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/>.</exception>
<remarks>When finished with the <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)"/>.</remarks>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateHashAlgorithm(System.String)">
<summary>
Returns a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> for a specific algorithm.
</summary>
<param name="algorithm">the name of the hash algorithm to create.</param>
<returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
<remarks>When finished with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>.</remarks>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.InvalidOperationException">'algorithm' is not supported.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.CreateKeyedHashAlgorithm(System.Byte[],System.String)">
<summary>
Returns a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/> for a specific algorithm.
</summary>
<param name="algorithm">the keyed hash algorithm to create.</param>
<param name="keyBytes">bytes to use to create the Keyed Hash</param>
<returns>A <see cref="T:System.Security.Cryptography.HashAlgorithm"/></returns>
<remarks>When finished with the <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call <see cref="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)"/>.</remarks>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or empty.</exception>
<exception cref="T:System.InvalidOperationException">'algorithm' is not supported.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.IsSupportedAlgorithm(System.String)">
<summary>
Answers if an algorithm is supported
</summary>
<param name="algorithm">the name of the crypto algorithm</param>
<returns></returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.IsSupportedAlgorithm(System.String,Microsoft.IdentityModel.Tokens.SecurityKey)">
<summary>
Checks if an 'algorithm, key' pair is supported.
</summary>
<param name="algorithm">the algorithm to check.</param>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.</param>
<returns>true if 'algorithm, key' pair is supported.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseHashAlgorithm(System.Security.Cryptography.HashAlgorithm)">
<summary>
When finished with a <see cref="T:System.Security.Cryptography.HashAlgorithm"/> call this method for cleanup. The default behavior is to call <see cref="M:System.Security.Cryptography.HashAlgorithm.Dispose"/>
</summary>
<param name="hashAlgorithm"><see cref="T:System.Security.Cryptography.HashAlgorithm"/> to be released.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseKeyWrapProvider(Microsoft.IdentityModel.Tokens.KeyWrapProvider)">
<summary>
When finished with a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> call this method for cleanup."/>
</summary>
<param name="provider"><see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> to be released.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseRsaKeyWrapProvider(Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider)">
<summary>
When finished with a <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> call this method for cleanup."/>
</summary>
<param name="provider"><see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> to be released.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.CryptoProviderFactory.ReleaseSignatureProvider(Microsoft.IdentityModel.Tokens.SignatureProvider)">
<summary>
When finished with a <see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> call this method for cleanup. The default behavior is to call <see cref="M:Microsoft.IdentityModel.Tokens.SignatureProvider.Dispose"/>
</summary>
<param name="signatureProvider"><see cref="T:Microsoft.IdentityModel.Tokens.SignatureProvider"/> to be released.</param>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.DateTimeUtil">
<summary>
Helper class for adding DateTimes and Timespans.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.Add(System.DateTime,System.TimeSpan)">
<summary>
Add a DateTime and a TimeSpan.
The maximum time is DateTime.MaxTime. It is not an error if time + timespan > MaxTime.
Just return MaxTime.
</summary>
<param name="time">Initial <see cref="T:System.DateTime"/> value.</param>
<param name="timespan"><see cref="T:System.TimeSpan"/> to add.</param>
<returns><see cref="T:System.DateTime"/> as the sum of time and timespan.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.GetMaxValue(System.DateTimeKind)">
<summary>
Gets the Maximum value for a DateTime specifying kind.
</summary>
<param name="kind">DateTimeKind to use.</param>
<returns>DateTime of specified kind.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.GetMinValue(System.DateTimeKind)">
<summary>
Gets the Minimum value for a DateTime specifying kind.
</summary>
<param name="kind">DateTimeKind to use.</param>
<returns>DateTime of specified kind.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.ToUniversalTime(System.Nullable{System.DateTime})">
<summary>
Ensures that DataTime is UTC.
</summary>
<param name="value"><see cref="T:System.DateTime"/>to convert.</param>
<returns></returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.DateTimeUtil.ToUniversalTime(System.DateTime)">
<summary>
Ensures that DateTime is UTC.
</summary>
<param name="value"><see cref="T:System.DateTime"/>to convert.</param>
<returns></returns>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey">
<summary>
Represents a ECDsa security key.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.#ctor(System.Security.Cryptography.ECDsa)">
<summary>
Returns a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey"/>.
</summary>
<param name="ecdsa"><see cref="T:System.Security.Cryptography.ECDsa"/></param>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.ECDsa">
<summary>
<see cref="T:System.Security.Cryptography.ECDsa"/> instance used to initialize the key.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.HasPrivateKey">
<summary>
Gets a bool indicating if a private key exists.
</summary>
<return>true if it has a private key; otherwise, false.</return>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.PrivateKeyStatus">
<summary>
Gets an enum indicating if a private key exists.
</summary>
<return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.ECDsaSecurityKey.KeySize">
<summary>
Gets <see cref="T:System.Security.Cryptography.ECDsa"/> key size.
</summary>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials">
<summary>
A wrapper class for properties that are used for token encryption.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.EncryptingCredentials.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.EncryptingCredentials"/> class.
</summary>
<param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
<param name="alg">The key encryption algorithm to apply.</param>
<param name="enc">The encryption algorithm to apply.</param>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Alg">
<summary>
Gets the algorithm which used for token encryption.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Enc">
<summary>
Gets the algorithm which used for token encryption.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory">
<summary>
Users can override the default <see cref="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.CryptoProviderFactory"/> with this property. This factory will be used for creating encryition providers.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.EncryptingCredentials.Key">
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> which used for signature valdiation.
</summary>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider">
<summary>
Provides authenticated encryption and decryption services.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/> class used for encryption and decryption.
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
<param name="algorithm">The encryption algorithm to apply.</param>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null or whitespace.</exception>
<exception cref="T:System.ArgumentOutOfRangeException">key size is not large enough.</exception>
<exception cref="T:System.ArgumentException">'algorithm' is not supported.</exception>
<exception cref="T:System.ArgumentException">a symmetricSignatureProvider is not created.</exception>
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Algorithm">
<summary>
Gets the encryption algorithm that is being used.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Context">
<summary>
Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider"/>.
</summary>
<remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Key">
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])">
<summary>
Encrypts the 'plaintext'
</summary>
<param name="plaintext">the data to be encrypted.</param>
<param name="authenticatedData">will be combined with iv and ciphertext to create an authenticationtag.</param>
<returns><see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/>containing ciphertext, iv, authenticationtag.</returns>
<exception cref="T:System.ArgumentNullException">plaintext is null or empty.</exception>
<exception cref="T:System.ArgumentNullException">authenticationData is null or empty.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">AES crypto operation threw. See inner exception for details.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[],System.Byte[])">
<summary>
Encrypts the 'plaintext'
</summary>
<param name="plaintext">the data to be encrypted.</param>
<param name="authenticatedData">will be combined with iv and ciphertext to create an authenticationtag.</param>
<param name="iv">initialization vector for encryption.</param>
<returns><see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/>containing ciphertext, iv, authenticationtag.</returns>
<exception cref="T:System.ArgumentNullException">plaintext is null or empty.</exception>
<exception cref="T:System.ArgumentNullException">authenticationData is null or empty.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">AES crypto operation threw. See inner exception for details.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Decrypt(System.Byte[],System.Byte[],System.Byte[],System.Byte[])">
<summary>
Decrypts ciphertext into plaintext
</summary>
<param name="ciphertext">the encrypted text to decrypt.</param>
<param name="authenticatedData">the authenticateData that is used in verification.</param>
<param name="iv">the initialization vector used when creating the ciphertext.</param>
<param name="authenticationTag">the authenticationTag that was created during the encyption.</param>
<returns>decrypted ciphertext</returns>
<exception cref="T:System.ArgumentNullException">'ciphertext' is null or empty.</exception>
<exception cref="T:System.ArgumentNullException">'authenticatedData' is null or empty.</exception>
<exception cref="T:System.ArgumentNullException">'iv' is null or empty.</exception>
<exception cref="T:System.ArgumentNullException">'authenticationTag' is null or empty.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">signature over authenticationTag fails to verify.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">AES crypto operation threw. See inner exception.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Checks if an 'key, algorithm' pair is supported
</summary>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
<param name="algorithm">the algorithm to check.</param>
<returns>true if 'key, algorithm' pair is supported.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.GetKeyBytes(Microsoft.IdentityModel.Tokens.SecurityKey)">
<summary>
Called to obtain the byte[] needed to create a <see cref="T:System.Security.Cryptography.KeyedHashAlgorithm"/>
</summary>
<param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>that will be used to obtain the byte[].</param>
<returns><see cref="T:System.Byte"/>[] that is used to populated the KeyedHashAlgorithm.</returns>
<exception cref="T:System.ArgumentNullException">if key is null.</exception>
<exception cref="T:System.ArgumentException">if a byte[] can not be obtained from SecurityKey.</exception>
<remarks><see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> and <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/> are supported.
<para>For a <see cref="T:Microsoft.IdentityModel.Tokens.SymmetricSecurityKey"/> .Key is returned</para>
<para>For a <see cref="T:Microsoft.IdentityModel.Tokens.JsonWebKey"/>Base64UrlEncoder.DecodeBytes is called with <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.K"/> if <see cref="P:Microsoft.IdentityModel.Tokens.JsonWebKey.Kty"/> == JsonWebAlgorithmsKeyTypes.Octet</para>
</remarks>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.ValidateKeySize(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Checks that the key has sufficient length
</summary>
<param name="key"><see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that contains bytes.</param>
<param name="algorithm">the algorithm to apply.</param>
<exception cref="T:System.ArgumentNullException">if 'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">if 'algorithm' is null or empty.</exception>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult">
<summary>
Contains the results of <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"/> operation.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.Byte[],System.Byte[],System.Byte[])">
<summary>
Initializes a new <see cref="T:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult"/>
</summary>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> used during <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Encrypt(System.Byte[],System.Byte[])"/></param>
<param name="ciphertext">protected text.</param>
<param name="iv">the initialization vector used.</param>
<param name="authenticationTag">the bytes that need be passed to <see cref="M:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionProvider.Decrypt(System.Byte[],System.Byte[],System.Byte[],System.Byte[])"/>.</param>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.Key">
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/>.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.Ciphertext">
<summary>
Gets the Ciphertext.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.IV">
<summary>
Gets the initialization vector.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.AuthenticatedEncryptionResult.AuthenticationTag">
<summary>
Gets the authentication tag
</summary>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider">
<summary>
Provides Wrap key and Unwrap key services.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Algorithm">
<summary>
Gets the KeyWrap algorithm that is being used.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Context">
<summary>
Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.
</summary>
<remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Key">
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose">
<summary>
Calls <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> and <see cref="M:System.GC.SuppressFinalize(System.Object)"/>
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)">
<summary>
Can be over written in descendants to dispose of internal components.
</summary>
<param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.UnwrapKey(System.Byte[])">
<summary>
Unwrap a key.
</summary>
<param name="keyBytes">key to unwrap.</param>
<returns>Unwrapped key.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.WrapKey(System.Byte[])">
<summary>
Wrap a key.
</summary>
<param name="keyBytes">the key to be wrapped</param>
<returns>wrapped key.</returns>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider">
<summary>
Provides RSA Wrap key and Unwrap key services.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> class used for wrap key and unwrap key.
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
<param name="algorithm">The KeyWrap algorithm to apply.</param>
<param name="willUnwrap">Whether this <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider"/> is required to create decrypts then set this to true.</param>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null.</exception>
<exception cref="T:System.ArgumentException">The keysize doesn't match the algorithm.</exception>
<exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
<exception cref="T:System.InvalidOperationException">Failed to create RSA algorithm with provided key and algorithm.</exception>
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Algorithm">
<summary>
Gets the KeyWrap algorithm that is being used.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Context">
<summary>
Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.
</summary>
<remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Key">
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)">
<summary>
Disposes of internal components.
</summary>
<param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Checks if an algorithm is supported.
</summary>
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
<param name="algorithm">The KeyWrap algorithm to apply.</param>
<returns>true if the algorithm is supported; otherwise, false.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.UnwrapKey(System.Byte[])">
<summary>
Unwrap a key using RSA decryption.
</summary>
<param name="keyBytes">the bytes to unwrap.</param>
<returns>Unwrapped key</returns>
<exception cref="T:System.ArgumentNullException">'keyBytes' is null or length == 0.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to unwrap the wrappedKey.</exception>
<exception cref="T:System.InvalidOperationException">If the internal RSA algorithm is null.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.WrapKey(System.Byte[])">
<summary>
Wrap a key using RSA encryption.
</summary>
<param name="keyBytes">the key to be wrapped</param>
<returns>A wrapped key</returns>
<exception cref="T:System.ArgumentNullException">'keyBytes' is null or has length == 0.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to wrap the 'keyBytes'.</exception>
<exception cref="T:System.InvalidOperationException">If the internal RSA algorithm is null.</exception>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider">
<summary>
Provides Wrap key and Unwrap key services.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/> class used for wrap key and unwrap key.
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that will be used for crypto operations.</param>
<param name="algorithm">The KeyWrap algorithm to apply.</param>
<exception cref="T:System.ArgumentNullException">'key' is null.</exception>
<exception cref="T:System.ArgumentNullException">'algorithm' is null.</exception>
<exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> and algorithm pair are not supported.</exception>
<exception cref="T:System.ArgumentException">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> cannot be converted to byte array</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The keysize doesn't match the algorithm.</exception>
<exception cref="T:System.InvalidOperationException">Failed to create symmetric algorithm with provided key and algorithm.</exception>
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Algorithm">
<summary>
Gets the KeyWrap algorithm that is being used.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Context">
<summary>
Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider"/>.
</summary>
<remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Key">
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> that is being used.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Dispose(System.Boolean)">
<summary>
Disposes of internal components.
</summary>
<param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.GetSymmetricAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Returns the <see cref="T:System.Security.Cryptography.SymmetricAlgorithm"/>.
</summary>
<returns></returns>
<exception cref="T:System.ArgumentException">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/> cannot be converted to byte array</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The keysize doesn't match the algorithm.</exception>
<exception cref="T:System.InvalidOperationException">Failed to create symmetric algorithm with provided key and algorithm.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)">
<summary>
Answers if an algorithm is supported
</summary>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey"/></param>
<param name="algorithm">the algorithm to use</param>
<returns>true if the algorithm is supported; otherwise, false.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.UnwrapKey(System.Byte[])">
<summary>
Unwrap a key using Symmmetric decryption.
</summary>
<param name="keyBytes">bytes to unwrap</param>
<returns>Unwraped key</returns>
<exception cref="T:System.ArgumentNullException">'keyBytes' is null or length == 0.</exception>
<exception cref="T:System.ArgumentException">'keyBytes' is not a multiple of 8.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to unwrap the wrappedKey.</exception>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.WrapKey(System.Byte[])">
<summary>
Wrap a key using Symmetric encryption.
</summary>
<param name="keyBytes">the key to be wrapped</param>
<returns>The wrapped key result</returns>
<exception cref="T:System.ArgumentNullException">'keyBytes' is null or has length 0.</exception>
<exception cref="T:System.ArgumentException">'keyBytes' is not a multiple of 8.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)"/> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to wrap 'keyBytes'.</exception>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.EpochTime">
<summary>
Returns the absolute DateTime or the Seconds since Unix Epoch, where Epoch is UTC 1970-01-01T0:0:0Z.
</summary>
</member>
<member name="F:Microsoft.IdentityModel.Tokens.EpochTime.UnixEpoch">
<summary>
DateTime as UTV for UnixEpoch
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.EpochTime.GetIntDate(System.DateTime)">
<summary>
Per JWT spec:
Gets the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the desired date/time.
</summary>
<param name="datetime">The DateTime to convert to seconds.</param>
<remarks>if dateTimeUtc less than UnixEpoch, return 0</remarks>
<returns>the number of seconds since Unix Epoch.</returns>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.EpochTime.DateTime(System.Int64)">
<summary>
Creates a DateTime from epoch time.
</summary>
<param name="secondsSinceUnixEpoch">Number of seconds.</param>
<returns>The DateTime in UTC.</returns>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException">
<summary>
Represents a security token exception when decryption failed.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenDecryptionFailedException"/> class with a specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException">
<summary>
Represents a security token exception when encryption failed.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionFailedException"/> class with a specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException">
<summary>
This exception is thrown when a security token contained a key identifier but the key was not found by the runtime
when decrypting a token.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class.
</summary>
<param name="message">Addtional information to be included in the exception and displayed to user.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenEncryptionKeyNotFoundException"/> class.
</summary>
<param name="message">Addtional information to be included in the exception and displayed to user.</param>
<param name="innerException">A <see cref="T:System.Exception"/> that represents the root cause of the exception.</param>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenException">
<summary>
Represents a security token exception.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.String)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenException.#ctor(System.String,System.Exception)">
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenException"/> class with a specified error message
and a reference to the inner exception that is the cause of this exception.
</summary>
<param name="message">The error message that explains the reason for the exception.</param>
<param name="innerException">The <see cref="T:System.Exception"/> that is the cause of the current exception, or a null reference if no inner exception is specified.</param>
</member>
<member name="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException">
<summary>
Throw this exception when a received Security Token has expiration time in the past.
</summary>
</member>
<member name="P:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.Expires">
<summary>
Gets or sets the Expires value that created the validation exception.
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor">
<summary>
Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/>
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.String)">
<summary>
Initializes a new instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException"/>
</summary>
</member>
<member name="M:Microsoft.IdentityModel.Tokens.SecurityTokenExpiredException.#ctor(System.String,System.Exception)">