/
X509SecurityTokenHandler.xml
606 lines (584 loc) · 43.6 KB
/
X509SecurityTokenHandler.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
<Type Name="X509SecurityTokenHandler" FullName="System.IdentityModel.Tokens.X509SecurityTokenHandler">
<TypeSignature Language="C#" Value="public class X509SecurityTokenHandler : System.IdentityModel.Tokens.SecurityTokenHandler" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit X509SecurityTokenHandler extends System.IdentityModel.Tokens.SecurityTokenHandler" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Tokens.X509SecurityTokenHandler" />
<TypeSignature Language="VB.NET" Value="Public Class X509SecurityTokenHandler
Inherits SecurityTokenHandler" />
<TypeSignature Language="F#" Value="type X509SecurityTokenHandler = class
 inherit SecurityTokenHandler" />
<TypeSignature Language="C++ CLI" Value="public ref class X509SecurityTokenHandler : System::IdentityModel::Tokens::SecurityTokenHandler" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Tokens.SecurityTokenHandler</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a security token handler that processes tokens of type <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />. By default, the handler will perform chain-trust validation of the X.509 certificate.</summary>
<remarks>To be added.</remarks>
<related type="Article" href="/dotnet/framework/configure-apps/file-schema/windows-identity-foundation/x509securitytokenhandlerrequirement"><x509SecurityTokenHandlerRequirement></related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509SecurityTokenHandler" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509SecurityTokenHandler ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 X509SecurityTokenHandler();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509SecurityTokenHandler" /> class with default values.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Tokens.X509SecurityTokenHandler.MapToWindows%2A> property is set to `false` and the <xref:System.IdentityModel.Selectors.X509CertificateValidator.PeerOrChainTrust%2A> validator is used as the default certificate validator.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509SecurityTokenHandler (bool mapToWindows);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool mapToWindows) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.#ctor(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (mapToWindows As Boolean)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.X509SecurityTokenHandler : bool -> System.IdentityModel.Tokens.X509SecurityTokenHandler" Usage="new System.IdentityModel.Tokens.X509SecurityTokenHandler mapToWindows" />
<MemberSignature Language="C++ CLI" Value="public:
 X509SecurityTokenHandler(bool mapToWindows);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="mapToWindows" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="mapToWindows">
<see langword="true" /> if the certificate should be mapped to a Windows account; otherwise, <see langword="false" />. Sets the <see cref="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.MapToWindows" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509SecurityTokenHandler" /> class by using a value that indicates whether the certificate should be mapped to a Windows account.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Selectors.X509CertificateValidator.PeerOrChainTrust%2A> validator is used as the default certificate validator.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509SecurityTokenHandler (System.IdentityModel.Selectors.X509CertificateValidator certificateValidator);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IdentityModel.Selectors.X509CertificateValidator certificateValidator) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.#ctor(System.IdentityModel.Selectors.X509CertificateValidator)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (certificateValidator As X509CertificateValidator)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.X509SecurityTokenHandler : System.IdentityModel.Selectors.X509CertificateValidator -> System.IdentityModel.Tokens.X509SecurityTokenHandler" Usage="new System.IdentityModel.Tokens.X509SecurityTokenHandler certificateValidator" />
<MemberSignature Language="C++ CLI" Value="public:
 X509SecurityTokenHandler(System::IdentityModel::Selectors::X509CertificateValidator ^ certificateValidator);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="certificateValidator" Type="System.IdentityModel.Selectors.X509CertificateValidator" />
</Parameters>
<Docs>
<param name="certificateValidator">The certificate validator to use. Sets the <see cref="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.CertificateValidator" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509SecurityTokenHandler" /> class by using the specified certificate validator.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Tokens.X509SecurityTokenHandler.MapToWindows%2A> property is set to `false`.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509SecurityTokenHandler (bool mapToWindows, System.IdentityModel.Selectors.X509CertificateValidator certificateValidator);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(bool mapToWindows, class System.IdentityModel.Selectors.X509CertificateValidator certificateValidator) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.#ctor(System.Boolean,System.IdentityModel.Selectors.X509CertificateValidator)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (mapToWindows As Boolean, certificateValidator As X509CertificateValidator)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.X509SecurityTokenHandler : bool * System.IdentityModel.Selectors.X509CertificateValidator -> System.IdentityModel.Tokens.X509SecurityTokenHandler" Usage="new System.IdentityModel.Tokens.X509SecurityTokenHandler (mapToWindows, certificateValidator)" />
<MemberSignature Language="C++ CLI" Value="public:
 X509SecurityTokenHandler(bool mapToWindows, System::IdentityModel::Selectors::X509CertificateValidator ^ certificateValidator);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="mapToWindows" Type="System.Boolean" />
<Parameter Name="certificateValidator" Type="System.IdentityModel.Selectors.X509CertificateValidator" />
</Parameters>
<Docs>
<param name="mapToWindows">
<see langword="true" /> if the certificate should be mapped to a Windows account; otherwise, <see langword="false" />. Sets the <see cref="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.MapToWindows" /> property.</param>
<param name="certificateValidator">The certificate validator to use. Sets the <see cref="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.CertificateValidator" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509SecurityTokenHandler" /> class by using a value that indicates whether the certificate should be mapped to a Windows account and the specified certificate validator.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanReadKeyIdentifierClause">
<MemberSignature Language="C#" Value="public override bool CanReadKeyIdentifierClause (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanReadKeyIdentifierClause(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.CanReadKeyIdentifierClause(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanReadKeyIdentifierClause (reader As XmlReader) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanReadKeyIdentifierClause : System.Xml.XmlReader -> bool" Usage="x509SecurityTokenHandler.CanReadKeyIdentifierClause reader" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanReadKeyIdentifierClause(System::Xml::XmlReader ^ reader);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">An XML reader positioned at the start element of the key identifier clause.</param>
<summary>Returns a value that indicates whether the specified reader is referring to an <see langword="<ds:X509Data>" /> element.</summary>
<returns>
<see langword="true" /> if the reader is referring to an <see langword="<ds:X509Data>" /> element; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reader" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CanReadToken">
<MemberSignature Language="C#" Value="public override bool CanReadToken (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanReadToken(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.CanReadToken(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanReadToken (reader As XmlReader) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanReadToken : System.Xml.XmlReader -> bool" Usage="x509SecurityTokenHandler.CanReadToken reader" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanReadToken(System::Xml::XmlReader ^ reader);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">A reader pointing to the token XML.</param>
<summary>Returns a value that indicates whether the reader points to an X.509 security token as defined in the WS-Security specification.</summary>
<returns>
<see langword="true" /> if the reader is pointing to an X.509 security token; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reader" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CanValidateToken">
<MemberSignature Language="C#" Value="public override bool CanValidateToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanValidateToken" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.CanValidateToken" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanValidateToken As Boolean" />
<MemberSignature Language="F#" Value="member this.CanValidateToken : bool" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.CanValidateToken" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanValidateToken { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this handler supports validation of tokens of type <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />.</summary>
<value>
<see langword="true" /> if the handler supports validation of tokens of type <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />; otherwise, <see langword="false" />. Always <see langword="true" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CanWriteKeyIdentifierClause">
<MemberSignature Language="C#" Value="public override bool CanWriteKeyIdentifierClause (System.IdentityModel.Tokens.SecurityKeyIdentifierClause securityKeyIdentifierClause);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanWriteKeyIdentifierClause(class System.IdentityModel.Tokens.SecurityKeyIdentifierClause securityKeyIdentifierClause) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.CanWriteKeyIdentifierClause(System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanWriteKeyIdentifierClause (securityKeyIdentifierClause As SecurityKeyIdentifierClause) As Boolean" />
<MemberSignature Language="F#" Value="override this.CanWriteKeyIdentifierClause : System.IdentityModel.Tokens.SecurityKeyIdentifierClause -> bool" Usage="x509SecurityTokenHandler.CanWriteKeyIdentifierClause securityKeyIdentifierClause" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool CanWriteKeyIdentifierClause(System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ securityKeyIdentifierClause);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="securityKeyIdentifierClause" Type="System.IdentityModel.Tokens.SecurityKeyIdentifierClause" />
</Parameters>
<Docs>
<param name="securityKeyIdentifierClause">The key identifier clause to be serialized.</param>
<summary>Returns a value that indicates whether the specified key identifier clause can be serialized by this handler.</summary>
<returns>
<see langword="true" /> if the <paramref name="securityKeyIdentifierClause" /> is supported and if the <see cref="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.WriteXmlDSigDefinedClauseTypes" /> property is set to <see langword="true" />; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The supported key identifier clause types are:
1. <xref:System.IdentityModel.Tokens.X509IssuerSerialKeyIdentifierClause>
2. <xref:System.IdentityModel.Tokens.X509RawDataKeyIdentifierClause>
3. <xref:System.IdentityModel.Tokens.X509SubjectKeyIdentifierClause>
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="securityKeyIdentifierClause" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CanWriteToken">
<MemberSignature Language="C#" Value="public override bool CanWriteToken { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanWriteToken" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.CanWriteToken" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanWriteToken As Boolean" />
<MemberSignature Language="F#" Value="member this.CanWriteToken : bool" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.CanWriteToken" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanWriteToken { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether this handler can write tokens of type <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />.</summary>
<value>
<see langword="true" /> if the handler can write tokens of type <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />; otherwise, <see langword="false" />. Always <see langword="true" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CertificateValidator">
<MemberSignature Language="C#" Value="public System.IdentityModel.Selectors.X509CertificateValidator CertificateValidator { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Selectors.X509CertificateValidator CertificateValidator" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.CertificateValidator" />
<MemberSignature Language="VB.NET" Value="Public Property CertificateValidator As X509CertificateValidator" />
<MemberSignature Language="F#" Value="member this.CertificateValidator : System.IdentityModel.Selectors.X509CertificateValidator with get, set" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.CertificateValidator" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Selectors::X509CertificateValidator ^ CertificateValidator { System::IdentityModel::Selectors::X509CertificateValidator ^ get(); void set(System::IdentityModel::Selectors::X509CertificateValidator ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Selectors.X509CertificateValidator</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.IdentityModel.Selectors.X509CertificateValidator" /> that is used by the current instance.</summary>
<value>The X.509 certificate validator that is used by the current instance.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetTokenTypeIdentifiers">
<MemberSignature Language="C#" Value="public override string[] GetTokenTypeIdentifiers ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string[] GetTokenTypeIdentifiers() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.GetTokenTypeIdentifiers" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetTokenTypeIdentifiers () As String()" />
<MemberSignature Language="F#" Value="override this.GetTokenTypeIdentifiers : unit -> string[]" Usage="x509SecurityTokenHandler.GetTokenTypeIdentifiers " />
<MemberSignature Language="C++ CLI" Value="public:
 override cli::array <System::String ^> ^ GetTokenTypeIdentifiers();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the X.509 security token type defined in the WS-Security X.509 Token Profile.</summary>
<returns>The X.509 token type URI. By default, the value of the <see cref="P:System.IdentityModel.Tokens.SecurityTokenTypes.X509Certificate" /> property.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="LoadCustomConfiguration">
<MemberSignature Language="C#" Value="public override void LoadCustomConfiguration (System.Xml.XmlNodeList customConfigElements);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void LoadCustomConfiguration(class System.Xml.XmlNodeList customConfigElements) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.LoadCustomConfiguration(System.Xml.XmlNodeList)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub LoadCustomConfiguration (customConfigElements As XmlNodeList)" />
<MemberSignature Language="F#" Value="override this.LoadCustomConfiguration : System.Xml.XmlNodeList -> unit" Usage="x509SecurityTokenHandler.LoadCustomConfiguration customConfigElements" />
<MemberSignature Language="C++ CLI" Value="public:
 override void LoadCustomConfiguration(System::Xml::XmlNodeList ^ customConfigElements);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="customConfigElements" Type="System.Xml.XmlNodeList" />
</Parameters>
<Docs>
<param name="customConfigElements">The XML elements that contain the custom configuration.</param>
<summary>Loads custom configuration from XML.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="customConfigElements" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The custom configuration specified is not valid.</exception>
</Docs>
</Member>
<Member MemberName="MapToWindows">
<MemberSignature Language="C#" Value="public bool MapToWindows { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool MapToWindows" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.MapToWindows" />
<MemberSignature Language="VB.NET" Value="Public Property MapToWindows As Boolean" />
<MemberSignature Language="F#" Value="member this.MapToWindows : bool with get, set" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.MapToWindows" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool MapToWindows { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets a value that indicates whether the validating token should be mapped to a Windows account.</summary>
<value>
<see langword="true" /> if the validating token should be mapped to a Windows account; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReadKeyIdentifierClause">
<MemberSignature Language="C#" Value="public override System.IdentityModel.Tokens.SecurityKeyIdentifierClause ReadKeyIdentifierClause (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IdentityModel.Tokens.SecurityKeyIdentifierClause ReadKeyIdentifierClause(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.ReadKeyIdentifierClause(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ReadKeyIdentifierClause (reader As XmlReader) As SecurityKeyIdentifierClause" />
<MemberSignature Language="F#" Value="override this.ReadKeyIdentifierClause : System.Xml.XmlReader -> System.IdentityModel.Tokens.SecurityKeyIdentifierClause" Usage="x509SecurityTokenHandler.ReadKeyIdentifierClause reader" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ ReadKeyIdentifierClause(System::Xml::XmlReader ^ reader);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityKeyIdentifierClause</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">The XML reader referencing the key identifier clause.</param>
<summary>Deserializes a key identifier clause referenced by the specified XML reader.</summary>
<returns>The key identifier clause that was deserialized from the XML.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reader" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="ReadToken">
<MemberSignature Language="C#" Value="public override System.IdentityModel.Tokens.SecurityToken ReadToken (System.Xml.XmlReader reader);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IdentityModel.Tokens.SecurityToken ReadToken(class System.Xml.XmlReader reader) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.ReadToken(System.Xml.XmlReader)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ReadToken (reader As XmlReader) As SecurityToken" />
<MemberSignature Language="F#" Value="override this.ReadToken : System.Xml.XmlReader -> System.IdentityModel.Tokens.SecurityToken" Usage="x509SecurityTokenHandler.ReadToken reader" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::IdentityModel::Tokens::SecurityToken ^ ReadToken(System::Xml::XmlReader ^ reader);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityToken</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="reader" Type="System.Xml.XmlReader" />
</Parameters>
<Docs>
<param name="reader">An XML reader that is pointing to an X.509 security token.</param>
<summary>Deserializes the X.509 security token referenced by the specified XML reader.</summary>
<returns>The security token deserialized from the XML. An instance of <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="reader" /> is <see langword="null" />.</exception>
<exception cref="T:System.Xml.XmlException">
<paramref name="reader" /> is not pointing to a valid X.509 security token as defined in the WS-Security X.509 Token Profile. Or the encodingType specified is other than Base64 or HexBinary.</exception>
</Docs>
</Member>
<Member MemberName="TokenType">
<MemberSignature Language="C#" Value="public override Type TokenType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Type TokenType" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.TokenType" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property TokenType As Type" />
<MemberSignature Language="F#" Value="member this.TokenType : Type" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.TokenType" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property Type ^ TokenType { Type ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the <see cref="T:System.Type" /> of the tokens that this handler processes.</summary>
<value>By default, the type of the <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" /> class.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValidateToken">
<MemberSignature Language="C#" Value="public override System.Collections.ObjectModel.ReadOnlyCollection<System.Security.Claims.ClaimsIdentity> ValidateToken (System.IdentityModel.Tokens.SecurityToken token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class System.Security.Claims.ClaimsIdentity> ValidateToken(class System.IdentityModel.Tokens.SecurityToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.ValidateToken(System.IdentityModel.Tokens.SecurityToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ValidateToken (token As SecurityToken) As ReadOnlyCollection(Of ClaimsIdentity)" />
<MemberSignature Language="F#" Value="override this.ValidateToken : System.IdentityModel.Tokens.SecurityToken -> System.Collections.ObjectModel.ReadOnlyCollection<System.Security.Claims.ClaimsIdentity>" Usage="x509SecurityTokenHandler.ValidateToken token" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::Collections::ObjectModel::ReadOnlyCollection<System::Security::Claims::ClaimsIdentity ^> ^ ValidateToken(System::IdentityModel::Tokens::SecurityToken ^ token);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<System.Security.Claims.ClaimsIdentity></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="token" Type="System.IdentityModel.Tokens.SecurityToken" />
</Parameters>
<Docs>
<param name="token">The token to be validated.</param>
<summary>Validates the specified X.509 security token.</summary>
<returns>The identities contained in the token.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">
<paramref name="token" /> is not assignable from <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />.</exception>
<exception cref="T:System.ArgumentNullException">
<paramref name="token" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IdentityModel.Tokens.SecurityTokenHandler.Configuration" /> property is <see langword="null" />.
-or-
There is no issuer name registry (<see cref="T:System.IdentityModel.Tokens.IssuerNameRegistry" />) configured. (The <see cref="P:System.IdentityModel.Tokens.SecurityTokenHandlerConfiguration.IssuerNameRegistry" /> property of the <see cref="T:System.IdentityModel.Tokens.SecurityTokenHandlerConfiguration" /> referenced by the <see cref="P:System.IdentityModel.Tokens.SecurityTokenHandler.Configuration" /> property is <see langword="null" />.)</exception>
<exception cref="T:System.IdentityModel.Tokens.SecurityTokenValidationException">The current <see cref="T:System.IdentityModel.Selectors.X509CertificateValidator" /> was unable to validate the certificate in the token.</exception>
<exception cref="T:System.IdentityModel.Tokens.SecurityTokenException">The current <see cref="T:System.IdentityModel.Tokens.IssuerNameRegistry" /> returned <see langword="null" /> when trying to resolve the issuer of the certificate in the token.</exception>
</Docs>
</Member>
<Member MemberName="WriteKeyIdentifierClause">
<MemberSignature Language="C#" Value="public override void WriteKeyIdentifierClause (System.Xml.XmlWriter writer, System.IdentityModel.Tokens.SecurityKeyIdentifierClause securityKeyIdentifierClause);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteKeyIdentifierClause(class System.Xml.XmlWriter writer, class System.IdentityModel.Tokens.SecurityKeyIdentifierClause securityKeyIdentifierClause) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.WriteKeyIdentifierClause(System.Xml.XmlWriter,System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub WriteKeyIdentifierClause (writer As XmlWriter, securityKeyIdentifierClause As SecurityKeyIdentifierClause)" />
<MemberSignature Language="F#" Value="override this.WriteKeyIdentifierClause : System.Xml.XmlWriter * System.IdentityModel.Tokens.SecurityKeyIdentifierClause -> unit" Usage="x509SecurityTokenHandler.WriteKeyIdentifierClause (writer, securityKeyIdentifierClause)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void WriteKeyIdentifierClause(System::Xml::XmlWriter ^ writer, System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ securityKeyIdentifierClause);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlWriter" />
<Parameter Name="securityKeyIdentifierClause" Type="System.IdentityModel.Tokens.SecurityKeyIdentifierClause" />
</Parameters>
<Docs>
<param name="writer">The XML writer to which the key identifier clause should be serialized.</param>
<param name="securityKeyIdentifierClause">The key identifier clause to serialize.</param>
<summary>Serializes the specified key identifier clause to the XML writer.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="securityKeyIdentifierClause" /> is <see langword="null" />.
-or-
<paramref name="writer" /> is <see langword="null" />.</exception>
<exception cref="T:System.InvalidOperationException">The <see cref="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.WriteXmlDSigDefinedClauseTypes" /> property is <see langword="false" />.</exception>
</Docs>
</Member>
<Member MemberName="WriteToken">
<MemberSignature Language="C#" Value="public override void WriteToken (System.Xml.XmlWriter writer, System.IdentityModel.Tokens.SecurityToken token);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void WriteToken(class System.Xml.XmlWriter writer, class System.IdentityModel.Tokens.SecurityToken token) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509SecurityTokenHandler.WriteToken(System.Xml.XmlWriter,System.IdentityModel.Tokens.SecurityToken)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Sub WriteToken (writer As XmlWriter, token As SecurityToken)" />
<MemberSignature Language="F#" Value="override this.WriteToken : System.Xml.XmlWriter * System.IdentityModel.Tokens.SecurityToken -> unit" Usage="x509SecurityTokenHandler.WriteToken (writer, token)" />
<MemberSignature Language="C++ CLI" Value="public:
 override void WriteToken(System::Xml::XmlWriter ^ writer, System::IdentityModel::Tokens::SecurityToken ^ token);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlWriter" />
<Parameter Name="token" Type="System.IdentityModel.Tokens.SecurityToken" />
</Parameters>
<Docs>
<param name="writer">The XML writer to which the token should be serialized.</param>
<param name="token">The X.509 security token to serialize. An instance of <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />.</param>
<summary>Serializes the specified X.509 security token to the specified XML writer.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="token" /> is <see langword="null" />.
-or-
<paramref name="writer" /> is <see langword="null" />.</exception>
<exception cref="T:System.ArgumentException">
<paramref name="token" /> is not assignable from <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" />.</exception>
</Docs>
</Member>
<Member MemberName="WriteXmlDSigDefinedClauseTypes">
<MemberSignature Language="C#" Value="public bool WriteXmlDSigDefinedClauseTypes { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool WriteXmlDSigDefinedClauseTypes" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.WriteXmlDSigDefinedClauseTypes" />
<MemberSignature Language="VB.NET" Value="Public Property WriteXmlDSigDefinedClauseTypes As Boolean" />
<MemberSignature Language="F#" Value="member this.WriteXmlDSigDefinedClauseTypes : bool with get, set" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.WriteXmlDSigDefinedClauseTypes" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool WriteXmlDSigDefinedClauseTypes { bool get(); void set(bool value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or Sets the value that specifies whether XmlDsig-defined clause types are preferred.</summary>
<value>
<see langword="true" /> if XmlDsig-defined clause types are preferred; otherwise, <see langword="false" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Supported XmlDSig-defined <xref:System.IdentityModel.Tokens.SecurityKeyIdentifierClause> types are:
- X509IssuerSerial
- X509SKI
- X509Certificate
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="X509NTAuthChainTrustValidator">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.X509NTAuthChainTrustValidator X509NTAuthChainTrustValidator { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.X509NTAuthChainTrustValidator X509NTAuthChainTrustValidator" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.X509SecurityTokenHandler.X509NTAuthChainTrustValidator" />
<MemberSignature Language="VB.NET" Value="Public Property X509NTAuthChainTrustValidator As X509NTAuthChainTrustValidator" />
<MemberSignature Language="F#" Value="member this.X509NTAuthChainTrustValidator : System.IdentityModel.Tokens.X509NTAuthChainTrustValidator with get, set" Usage="System.IdentityModel.Tokens.X509SecurityTokenHandler.X509NTAuthChainTrustValidator" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::X509NTAuthChainTrustValidator ^ X509NTAuthChainTrustValidator { System::IdentityModel::Tokens::X509NTAuthChainTrustValidator ^ get(); void set(System::IdentityModel::Tokens::X509NTAuthChainTrustValidator ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.X509NTAuthChainTrustValidator</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the <see cref="T:System.IdentityModel.Tokens.X509NTAuthChainTrustValidator" /> that is used by the current instance during certificate validation when the incoming X.509 certificate is mapped to a Windows account.</summary>
<value>An X.509 certificate validator that will validate a specified X.509 certificate and verify whether the certificate can be mapped to a Windows account and whether the certificate chain is trusted.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>