-
Notifications
You must be signed in to change notification settings - Fork 26
/
TokenHandler.xml
245 lines (245 loc) · 16.1 KB
/
TokenHandler.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
<Type Name="TokenHandler" FullName="Microsoft.IdentityModel.Tokens.TokenHandler">
<TypeSignature Language="C#" Value="public abstract class TokenHandler" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit TokenHandler extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Tokens.TokenHandler" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class TokenHandler" />
<TypeSignature Language="F#" Value="type TokenHandler = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>6.27.0.0</AssemblyVersion>
<AssemblyVersion>6.28.1.0</AssemblyVersion>
<AssemblyVersion>6.29.0.0</AssemblyVersion>
<AssemblyVersion>6.30.0.0</AssemblyVersion>
<AssemblyVersion>6.30.1.0</AssemblyVersion>
<AssemblyVersion>6.31.0.0</AssemblyVersion>
<AssemblyVersion>6.32.0.0</AssemblyVersion>
<AssemblyVersion>6.32.1.0</AssemblyVersion>
<AssemblyVersion>6.32.2.0</AssemblyVersion>
<AssemblyVersion>6.32.3.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.2.0</AssemblyVersion>
<AssemblyVersion>7.0.3.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
<AssemblyVersion>7.3.1.0</AssemblyVersion>
<AssemblyVersion>7.4.0.0</AssemblyVersion>
<AssemblyVersion>7.4.1.0</AssemblyVersion>
<AssemblyVersion>7.5.0.0</AssemblyVersion>
<AssemblyVersion>7.5.1.0</AssemblyVersion>
<AssemblyVersion>7.5.2.0</AssemblyVersion>
<AssemblyVersion>7.6.0.0</AssemblyVersion>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Defines properties shared across all security token handlers.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected TokenHandler ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.TokenHandler.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DefaultTokenLifetimeInMinutes">
<MemberSignature Language="C#" Value="public static readonly int DefaultTokenLifetimeInMinutes;" />
<MemberSignature Language="ILAsm" Value=".field public static initonly int32 DefaultTokenLifetimeInMinutes" />
<MemberSignature Language="DocId" Value="F:Microsoft.IdentityModel.Tokens.TokenHandler.DefaultTokenLifetimeInMinutes" />
<MemberSignature Language="VB.NET" Value="Public Shared ReadOnly DefaultTokenLifetimeInMinutes As Integer " />
<MemberSignature Language="F#" Value=" staticval mutable DefaultTokenLifetimeInMinutes : int" Usage="Microsoft.IdentityModel.Tokens.TokenHandler.DefaultTokenLifetimeInMinutes" />
<MemberType>Field</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Default lifetime of tokens created. When creating tokens, if 'expires', 'notbefore' or 'issuedat' are null,
then a default will be set to: issuedat = DateTime.UtcNow, notbefore = DateTime.UtcNow, expires = DateTime.UtcNow + TimeSpan.FromMinutes(TokenLifetimeInMinutes).
</summary>
<remarks>See: <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.SetDefaultTimesOnTokenCreation" /> for configuration.</remarks>
</Docs>
</Member>
<Member MemberName="MaximumTokenSizeInBytes">
<MemberSignature Language="C#" Value="public virtual int MaximumTokenSizeInBytes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 MaximumTokenSizeInBytes" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property MaximumTokenSizeInBytes As Integer" />
<MemberSignature Language="F#" Value="member this.MaximumTokenSizeInBytes : int with get, set" Usage="Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets and sets the maximum token size in bytes that will be processed.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">'value' less than 1.</exception>
</Docs>
</Member>
<Member MemberName="ReadToken">
<MemberSignature Language="C#" Value="public virtual Microsoft.IdentityModel.Tokens.SecurityToken ReadToken (string token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.IdentityModel.Tokens.SecurityToken ReadToken(string token) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.TokenHandler.ReadToken(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ReadToken (token As String) As SecurityToken" />
<MemberSignature Language="F#" Value="abstract member ReadToken : string -> Microsoft.IdentityModel.Tokens.SecurityToken
override this.ReadToken : string -> Microsoft.IdentityModel.Tokens.SecurityToken" Usage="tokenHandler.ReadToken token" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.SecurityToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" />
</Parameters>
<Docs>
<param name="token">The string to be deserialized.</param>
<summary>
Converts a string into an instance of <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken" />.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="token" /> is null or empty.</exception>
<exception cref="T:System.ArgumentException">'token.Length' is greater than <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.MaximumTokenSizeInBytes" />.</exception>
</Docs>
</Member>
<Member MemberName="SetDefaultTimesOnTokenCreation">
<MemberSignature Language="C#" Value="public bool SetDefaultTimesOnTokenCreation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool SetDefaultTimesOnTokenCreation" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.TokenHandler.SetDefaultTimesOnTokenCreation" />
<MemberSignature Language="VB.NET" Value="Public Property SetDefaultTimesOnTokenCreation As Boolean" />
<MemberSignature Language="F#" Value="member this.SetDefaultTimesOnTokenCreation : bool with get, set" Usage="Microsoft.IdentityModel.Tokens.TokenHandler.SetDefaultTimesOnTokenCreation" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a bool that controls if token creation will set default 'exp', 'nbf' and 'iat' if not specified.
</summary>
<value>To be added.</value>
<remarks>See: <see cref="P:Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes" /> for configuration.</remarks>
</Docs>
</Member>
<Member MemberName="TokenLifetimeInMinutes">
<MemberSignature Language="C#" Value="public int TokenLifetimeInMinutes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 TokenLifetimeInMinutes" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes" />
<MemberSignature Language="VB.NET" Value="Public Property TokenLifetimeInMinutes As Integer" />
<MemberSignature Language="F#" Value="member this.TokenLifetimeInMinutes : int with get, set" Usage="Microsoft.IdentityModel.Tokens.TokenHandler.TokenLifetimeInMinutes" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the token lifetime in minutes.
</summary>
<value>To be added.</value>
<remarks>Used during token creation to set the default expiration ('exp'). </remarks>
<exception cref="T:System.ArgumentOutOfRangeException">'value' less than 1.</exception>
</Docs>
</Member>
<Member MemberName="ValidateTokenAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult> ValidateTokenAsync (Microsoft.IdentityModel.Tokens.SecurityToken token, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.IdentityModel.Tokens.TokenValidationResult> ValidateTokenAsync(class Microsoft.IdentityModel.Tokens.SecurityToken token, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.TokenHandler.ValidateTokenAsync(Microsoft.IdentityModel.Tokens.SecurityToken,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateTokenAsync (token As SecurityToken, validationParameters As TokenValidationParameters) As Task(Of TokenValidationResult)" />
<MemberSignature Language="F#" Value="abstract member ValidateTokenAsync : Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult>
override this.ValidateTokenAsync : Microsoft.IdentityModel.Tokens.SecurityToken * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult>" Usage="tokenHandler.ValidateTokenAsync (token, validationParameters)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="Microsoft.IdentityModel.Tokens.SecurityToken" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
</Parameters>
<Docs>
<param name="token">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityToken" /> to be validated.</param>
<param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters" /> required for validation.</param>
<summary>
Validates a token.
On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property.
Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValidateTokenAsync">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult> ValidateTokenAsync (string token, Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.IdentityModel.Tokens.TokenValidationResult> ValidateTokenAsync(string token, class Microsoft.IdentityModel.Tokens.TokenValidationParameters validationParameters) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.TokenHandler.ValidateTokenAsync(System.String,Microsoft.IdentityModel.Tokens.TokenValidationParameters)" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function ValidateTokenAsync (token As String, validationParameters As TokenValidationParameters) As Task(Of TokenValidationResult)" />
<MemberSignature Language="F#" Value="abstract member ValidateTokenAsync : string * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult>
override this.ValidateTokenAsync : string * Microsoft.IdentityModel.Tokens.TokenValidationParameters -> System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult>" Usage="tokenHandler.ValidateTokenAsync (token, validationParameters)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.IdentityModel.Tokens.TokenValidationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.String" />
<Parameter Name="validationParameters" Type="Microsoft.IdentityModel.Tokens.TokenValidationParameters" />
</Parameters>
<Docs>
<param name="token">The token to be validated.</param>
<param name="validationParameters">A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationParameters" /> required for validation.</param>
<summary>
Validates a token.
On a validation failure, no exception will be thrown; instead, the exception will be set in the returned TokenValidationResult.Exception property.
Callers should always check the TokenValidationResult.IsValid property to verify the validity of the result.
</summary>
<returns>A <see cref="T:Microsoft.IdentityModel.Tokens.TokenValidationResult" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>