-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
X509ThumbprintKeyIdentifierClause.xml
238 lines (225 loc) · 14.6 KB
/
X509ThumbprintKeyIdentifierClause.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
<Type Name="X509ThumbprintKeyIdentifierClause" FullName="System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause">
<TypeSignature Language="C#" Value="public class X509ThumbprintKeyIdentifierClause : System.IdentityModel.Tokens.BinaryKeyIdentifierClause" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit X509ThumbprintKeyIdentifierClause extends System.IdentityModel.Tokens.BinaryKeyIdentifierClause" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause" />
<TypeSignature Language="VB.NET" Value="Public Class X509ThumbprintKeyIdentifierClause
Inherits BinaryKeyIdentifierClause" />
<TypeSignature Language="F#" Value="type X509ThumbprintKeyIdentifierClause = class
 inherit BinaryKeyIdentifierClause" />
<TypeSignature Language="C++ CLI" Value="public ref class X509ThumbprintKeyIdentifierClause : System::IdentityModel::Tokens::BinaryKeyIdentifierClause" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>6.2.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Tokens.BinaryKeyIdentifierClause</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a key identifier clause that identifies a <see cref="T:System.IdentityModel.Tokens.X509SecurityToken" /> security tokens using the X.509 certificate's thumbprint.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Typically, the <xref:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause> does not need to be used, other than when a custom security token service is created. When a security token service returns a security token, the issued security token contains references to attached and unattached security tokens. Attached references refer to security tokens that are contained within the security header of a SOAP message token and unattached references reference security tokens that are not included within the security header of a SOAP message. These references typically affirm the authenticity of the issued security token. Use the <xref:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause> class to reference a <xref:System.IdentityModel.Tokens.X509SecurityToken> security token using the X.509 certificate's thumbprint. The <xref:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.GetX509Thumbprint%2A> method returns the thumbprint.
Windows Communication Foundation supports the following types of security token references for <xref:System.IdentityModel.Tokens.X509SecurityToken> security tokens.
- <xref:System.IdentityModel.Tokens.X509IssuerSerialKeyIdentifierClause>
- <xref:System.IdentityModel.Tokens.X509RawDataKeyIdentifierClause>
- <xref:System.IdentityModel.Tokens.X509SubjectKeyIdentifierClause>
- <xref:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause>
]]></format>
</remarks>
</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.X509ThumbprintKeyIdentifierClause" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509ThumbprintKeyIdentifierClause (byte[] thumbprint);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int8[] thumbprint) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.#ctor(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Sub New (thumbprint As Byte())" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause : byte[] -> System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause" Usage="new System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause thumbprint" />
<MemberSignature Language="C++ CLI" Value="public:
 X509ThumbprintKeyIdentifierClause(cli::array <System::Byte> ^ thumbprint);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="thumbprint" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="thumbprint">An array of <see cref="T:System.Byte" /> that contains the thumbprint of the X.509 certificate.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause" /> class using the specified thumbprint for an X.509 certificate.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="thumbprint" /> is <see langword="null" />.
-or-
<paramref name="thumbprint" /> is zero length.</exception>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public X509ThumbprintKeyIdentifierClause (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:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.#ctor(System.Security.Cryptography.X509Certificates.X509Certificate2)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (certificate As X509Certificate2)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause : System.Security.Cryptography.X509Certificates.X509Certificate2 -> System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause" Usage="new System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause certificate" />
<MemberSignature Language="C++ CLI" Value="public:
 X509ThumbprintKeyIdentifierClause(System::Security::Cryptography::X509Certificates::X509Certificate2 ^ certificate);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
</Parameters>
<Docs>
<param name="certificate">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> that contains the X.509 certificate.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause" /> class using the specified X.509 certificate.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor obtains the thumbprint (the SHA-1 hash value of the X.509 certificate raw data) by calling the <xref:System.Security.Cryptography.X509Certificates.X509Certificate.GetCertHash%2A> method.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="certificate" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="GetX509Thumbprint">
<MemberSignature Language="C#" Value="public byte[] GetX509Thumbprint ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetX509Thumbprint() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.GetX509Thumbprint" />
<MemberSignature Language="VB.NET" Value="Public Function GetX509Thumbprint () As Byte()" />
<MemberSignature Language="F#" Value="member this.GetX509Thumbprint : unit -> byte[]" Usage="x509ThumbprintKeyIdentifierClause.GetX509Thumbprint " />
<MemberSignature Language="C++ CLI" Value="public:
 cli::array <System::Byte> ^ GetX509Thumbprint();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the thumbprint for the X.509 certificate.</summary>
<returns>An array of <see cref="T:System.Byte" /> that contains the thumbprint of the X.509 certificate.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Matches">
<MemberSignature Language="C#" Value="public bool Matches (System.Security.Cryptography.X509Certificates.X509Certificate2 certificate);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Matches(class System.Security.Cryptography.X509Certificates.X509Certificate2 certificate) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.Matches(System.Security.Cryptography.X509Certificates.X509Certificate2)" />
<MemberSignature Language="VB.NET" Value="Public Function Matches (certificate As X509Certificate2) As Boolean" />
<MemberSignature Language="F#" Value="override this.Matches : System.Security.Cryptography.X509Certificates.X509Certificate2 -> bool" Usage="x509ThumbprintKeyIdentifierClause.Matches certificate" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Matches(System::Security::Cryptography::X509Certificates::X509Certificate2 ^ certificate);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="certificate" Type="System.Security.Cryptography.X509Certificates.X509Certificate2" />
</Parameters>
<Docs>
<param name="certificate">An <see cref="T:System.Security.Cryptography.X509Certificates.X509Certificate2" /> that contains the X.509 certificate to compare.</param>
<summary>Returns a value that indicates whether the key identifier for this instance is equivalent to the specified X.509 certificate's thumbprint.</summary>
<returns>
<see langword="true" /> if <paramref name="certificate" /> has the same thumbprint as the current instance; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ToString">
<MemberSignature Language="C#" Value="public override string ToString ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance string ToString() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="x509ThumbprintKeyIdentifierClause.ToString " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::String ^ ToString();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.ServiceModel.Primitives</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<AssemblyInfo>
<AssemblyName>System.Private.ServiceModel</AssemblyName>
<AssemblyVersion>4.10.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns a string that represents the current object.</summary>
<returns>A <see cref="T:System.String" /> that represents the current object.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.IdentityModel.Tokens.X509ThumbprintKeyIdentifierClause.ToString%2A> method returns the thumbprint.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>