-
Notifications
You must be signed in to change notification settings - Fork 28
/
X509SecurityKey.xml
350 lines (350 loc) Β· 19.9 KB
/
X509SecurityKey.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
<Type Name="X509SecurityKey" FullName="Microsoft.IdentityModel.Tokens.X509SecurityKey">
<TypeSignature Language="C#" Value="public class X509SecurityKey : Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit X509SecurityKey extends Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" />
<TypeSignature Language="VB.NET" Value="Public Class X509SecurityKey
Inherits AsymmetricSecurityKey" />
<TypeSignature Language="F#" Value="type X509SecurityKey = class
 inherit AsymmetricSecurityKey" />
<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>Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
An <see cref="T:Microsoft.IdentityModel.Tokens.AsymmetricSecurityKey" /> that is backed by a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /></summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509SecurityKey (System.Security.Cryptography.X509Certificates.X509Certificate2 certificate);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (certificate As X509Certificate2)" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.Tokens.X509SecurityKey : System.Security.Cryptography.X509Certificates.X509Certificate2 -> Microsoft.IdentityModel.Tokens.X509SecurityKey" Usage="new Microsoft.IdentityModel.Tokens.X509SecurityKey certificate" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
</Parameters>
<Docs>
<param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> to use.</param>
<summary>
Instantiates a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" /> using a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /></summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">if <paramref name="certificate" /> is null.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509SecurityKey (System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, string keyId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Security.Cryptography.X509Certificates.X509Certificate2 certificate, string keyId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (certificate As X509Certificate2, keyId As String)" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.Tokens.X509SecurityKey : System.Security.Cryptography.X509Certificates.X509Certificate2 * string -> Microsoft.IdentityModel.Tokens.X509SecurityKey" Usage="new Microsoft.IdentityModel.Tokens.X509SecurityKey (certificate, keyId)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
<Parameter Name="keyId" Type="System.String" />
</Parameters>
<Docs>
<param name="certificate">The <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> to use.</param>
<param name="keyId">The value to set for the KeyId</param>
<summary>
Instantiates a <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" /> using a <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" />.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">if <paramref name="keyId" /> is null or empty.</exception>
</Docs>
</Member>
<Member MemberName="CanComputeJwkThumbprint">
<MemberSignature Language="C#" Value="public override bool CanComputeJwkThumbprint ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanComputeJwkThumbprint() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.CanComputeJwkThumbprint" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanComputeJwkThumbprint () As Boolean" />
<MemberSignature Language="F#" Value="override this.CanComputeJwkThumbprint : unit -> bool" Usage="x509SecurityKey.CanComputeJwkThumbprint " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Determines whether the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" /> can compute a JWK thumbprint.
</summary>
<returns>
<c>true</c> if JWK thumbprint can be computed; otherwise, <c>false</c>.</returns>
<remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks>
</Docs>
</Member>
<Member MemberName="Certificate">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.X509Certificates.X509Certificate2 Certificate" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.Certificate" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Certificate As X509Certificate2" />
<MemberSignature Language="F#" Value="member this.Certificate : System.Security.Cryptography.X509Certificates.X509Certificate2" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.Certificate" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.X509Certificates.X509Certificate2</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ComputeJwkThumbprint">
<MemberSignature Language="C#" Value="public override byte[] ComputeJwkThumbprint ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance unsigned int8[] ComputeJwkThumbprint() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.ComputeJwkThumbprint" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ComputeJwkThumbprint () As Byte()" />
<MemberSignature Language="F#" Value="override this.ComputeJwkThumbprint : unit -> byte[]" Usage="x509SecurityKey.ComputeJwkThumbprint " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Computes a sha256 hash over the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" />.
</summary>
<returns>A JWK thumbprint.</returns>
<remarks>https://datatracker.ietf.org/doc/html/rfc7638</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="x509SecurityKey.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">To be added.</param>
<summary>
Returns a bool indicating if this key is equivalent to another key.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<return>true if the keys are equal; otherwise, false.</return>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.X509SecurityKey.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="x509SecurityKey.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns an int hash code.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<return>An int hash code</return>
</Docs>
</Member>
<Member MemberName="HasPrivateKey">
<MemberSignature Language="C#" Value="public override bool HasPrivateKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool HasPrivateKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.HasPrivateKey" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property HasPrivateKey As Boolean" />
<MemberSignature Language="F#" Value="member this.HasPrivateKey : bool" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.HasPrivateKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("HasPrivateKey method is deprecated, please use PrivateKeyStatus.")]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("HasPrivateKey method is deprecated, please use PrivateKeyStatus.")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets a bool indicating if a private key exists.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<return>true if it has a private key; otherwise, false.</return>
</Docs>
</Member>
<Member MemberName="KeySize">
<MemberSignature Language="C#" Value="public override int KeySize { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 KeySize" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.KeySize" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property KeySize As Integer" />
<MemberSignature Language="F#" Value="member this.KeySize : int" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.KeySize" />
<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 the key size.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrivateKey">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.AsymmetricAlgorithm PrivateKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.AsymmetricAlgorithm PrivateKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PrivateKey As AsymmetricAlgorithm" />
<MemberSignature Language="F#" Value="member this.PrivateKey : System.Security.Cryptography.AsymmetricAlgorithm" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.AsymmetricAlgorithm</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns the private key from the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PrivateKeyStatus">
<MemberSignature Language="C#" Value="public override Microsoft.IdentityModel.Tokens.PrivateKeyStatus PrivateKeyStatus { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.IdentityModel.Tokens.PrivateKeyStatus PrivateKeyStatus" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKeyStatus" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property PrivateKeyStatus As PrivateKeyStatus" />
<MemberSignature Language="F#" Value="member this.PrivateKeyStatus : Microsoft.IdentityModel.Tokens.PrivateKeyStatus" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.PrivateKeyStatus" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.PrivateKeyStatus</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets an enum indicating if a private key exists.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<return>'Exists' if private key exists for sure; 'DoesNotExist' if private key doesn't exist for sure; 'Unknown' if we cannot determine.</return>
</Docs>
</Member>
<Member MemberName="PublicKey">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.AsymmetricAlgorithm PublicKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.AsymmetricAlgorithm PublicKey" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.PublicKey" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PublicKey As AsymmetricAlgorithm" />
<MemberSignature Language="F#" Value="member this.PublicKey : System.Security.Cryptography.AsymmetricAlgorithm" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.PublicKey" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.AsymmetricAlgorithm</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the public key from the <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="X5t">
<MemberSignature Language="C#" Value="public string X5t { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string X5t" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.X509SecurityKey.X5t" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property X5t As String" />
<MemberSignature Language="F#" Value="member this.X5t : string" Usage="Microsoft.IdentityModel.Tokens.X509SecurityKey.X5t" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the X5t of this <see cref="T:Microsoft.IdentityModel.Tokens.X509SecurityKey" />.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>