-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
RsaKeyIdentifierClause.xml
322 lines (316 loc) · 21.5 KB
/
RsaKeyIdentifierClause.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
<Type Name="RsaKeyIdentifierClause" FullName="System.IdentityModel.Tokens.RsaKeyIdentifierClause">
<TypeSignature Language="C#" Value="public class RsaKeyIdentifierClause : System.IdentityModel.Tokens.SecurityKeyIdentifierClause" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RsaKeyIdentifierClause extends System.IdentityModel.Tokens.SecurityKeyIdentifierClause" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Tokens.RsaKeyIdentifierClause" />
<TypeSignature Language="VB.NET" Value="Public Class RsaKeyIdentifierClause
Inherits SecurityKeyIdentifierClause" />
<TypeSignature Language="F#" Value="type RsaKeyIdentifierClause = class
 inherit SecurityKeyIdentifierClause" />
<TypeSignature Language="C++ CLI" Value="public ref class RsaKeyIdentifierClause : System::IdentityModel::Tokens::SecurityKeyIdentifierClause" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Tokens.SecurityKeyIdentifierClause</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Represents a key identifier clause that identifies a <see cref="T:System.IdentityModel.Tokens.RsaSecurityToken" /> security token.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Typically, the <xref:System.IdentityModel.Tokens.RsaKeyIdentifierClause> 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 and unattached references are security tokens that are not included within the security header in the SOAP message. These references typically affirm the authenticity of the issued security token. Use the <xref:System.IdentityModel.Tokens.RsaKeyIdentifierClause> class to reference a <xref:System.IdentityModel.Tokens.RsaSecurityToken> security token and to access the RSA algorithm. To access the RSA algorithm, get the value of the <xref:System.IdentityModel.Tokens.RsaKeyIdentifierClause.Rsa%2A> property.
]]></format>
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RsaKeyIdentifierClause (System.Security.Cryptography.RSA rsa);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Security.Cryptography.RSA rsa) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.#ctor(System.Security.Cryptography.RSA)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (rsa As RSA)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.RsaKeyIdentifierClause : System.Security.Cryptography.RSA -> System.IdentityModel.Tokens.RsaKeyIdentifierClause" Usage="new System.IdentityModel.Tokens.RsaKeyIdentifierClause rsa" />
<MemberSignature Language="C++ CLI" Value="public:
 RsaKeyIdentifierClause(System::Security::Cryptography::RSA ^ rsa);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="rsa" Type="System.Security.Cryptography.RSA" />
</Parameters>
<Docs>
<param name="rsa">An <see cref="T:System.Security.Cryptography.RSA" /> that represents an RSA algorithm. Sets the value of the <see cref="P:System.IdentityModel.Tokens.RsaKeyIdentifierClause.Rsa" /> property.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.RsaKeyIdentifierClause" /> class using the specified RSA algorithm.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="rsa" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="CanCreateKey">
<MemberSignature Language="C#" Value="public override bool CanCreateKey { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool CanCreateKey" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.RsaKeyIdentifierClause.CanCreateKey" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property CanCreateKey As Boolean" />
<MemberSignature Language="F#" Value="member this.CanCreateKey : bool" Usage="System.IdentityModel.Tokens.RsaKeyIdentifierClause.CanCreateKey" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property bool CanCreateKey { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value that indicates whether a key can be created from the key identifier clause.</summary>
<value>
<see langword="true" /> in all cases.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To create the key, call the <xref:System.IdentityModel.Tokens.RsaKeyIdentifierClause.CreateKey%2A> method.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CreateKey">
<MemberSignature Language="C#" Value="public override System.IdentityModel.Tokens.SecurityKey CreateKey ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IdentityModel.Tokens.SecurityKey CreateKey() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.CreateKey" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CreateKey () As SecurityKey" />
<MemberSignature Language="F#" Value="override this.CreateKey : unit -> System.IdentityModel.Tokens.SecurityKey" Usage="rsaKeyIdentifierClause.CreateKey " />
<MemberSignature Language="C++ CLI" Value="public:
 override System::IdentityModel::Tokens::SecurityKey ^ CreateKey();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityKey</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates a key using the RSA algorithm.</summary>
<returns>A <see cref="T:System.IdentityModel.Tokens.RsaSecurityKey" /> that is a key created using the RSA algorithm specified in the constructor.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetExponent">
<MemberSignature Language="C#" Value="public byte[] GetExponent ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetExponent() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetExponent" />
<MemberSignature Language="VB.NET" Value="Public Function GetExponent () As Byte()" />
<MemberSignature Language="F#" Value="member this.GetExponent : unit -> byte[]" Usage="rsaKeyIdentifierClause.GetExponent " />
<MemberSignature Language="C++ CLI" Value="public:
 cli::array <System::Byte> ^ GetExponent();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the <see langword="Exponent" /> parameter for the RSA algorithm.</summary>
<returns>An array of <see cref="T:System.Byte" /> that contains the <see langword="Exponent" /> parameter for the RSA algorithm.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetModulus">
<MemberSignature Language="C#" Value="public byte[] GetModulus ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance unsigned int8[] GetModulus() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetModulus" />
<MemberSignature Language="VB.NET" Value="Public Function GetModulus () As Byte()" />
<MemberSignature Language="F#" Value="member this.GetModulus : unit -> byte[]" Usage="rsaKeyIdentifierClause.GetModulus " />
<MemberSignature Language="C++ CLI" Value="public:
 cli::array <System::Byte> ^ GetModulus();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the <see langword="Modulus" /> parameter for the RSA algorithm.</summary>
<returns>An array of <see cref="T:System.Byte" /> that contains the <see langword="Modulus" /> parameter for the RSA algorithm.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<MemberGroup MemberName="Matches">
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Returns a value that indicates whether the key identifier for this instance is equivalent to the specified object.</summary>
</Docs>
</MemberGroup>
<Member MemberName="Matches">
<MemberSignature Language="C#" Value="public override bool Matches (System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Matches(class System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.Matches(System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Matches (keyIdentifierClause As SecurityKeyIdentifierClause) As Boolean" />
<MemberSignature Language="F#" Value="override this.Matches : System.IdentityModel.Tokens.SecurityKeyIdentifierClause -> bool" Usage="rsaKeyIdentifierClause.Matches keyIdentifierClause" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool Matches(System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ keyIdentifierClause);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyIdentifierClause" Type="System.IdentityModel.Tokens.SecurityKeyIdentifierClause" />
</Parameters>
<Docs>
<param name="keyIdentifierClause">A <see cref="T:System.IdentityModel.Tokens.SecurityKeyIdentifierClause" /> to compare to.</param>
<summary>Returns a value that indicates whether the key identifier for this instance is equivalent to the specified key identifier clause.</summary>
<returns>
<see langword="true" /> if <paramref name="keyIdentifierClause" /> is of type <see cref="T:System.IdentityModel.Tokens.RsaKeyIdentifierClause" /> and the arrays returned by the <see cref="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetModulus" /> and <see cref="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetExponent" /> methods for the <paramref name="keyIdentifierClause" /> parameter are identical to the current instance; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Matches">
<MemberSignature Language="C#" Value="public bool Matches (System.Security.Cryptography.RSA rsa);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance bool Matches(class System.Security.Cryptography.RSA rsa) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.Matches(System.Security.Cryptography.RSA)" />
<MemberSignature Language="VB.NET" Value="Public Function Matches (rsa As RSA) As Boolean" />
<MemberSignature Language="F#" Value="override this.Matches : System.Security.Cryptography.RSA -> bool" Usage="rsaKeyIdentifierClause.Matches rsa" />
<MemberSignature Language="C++ CLI" Value="public:
 bool Matches(System::Security::Cryptography::RSA ^ rsa);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="rsa" Type="System.Security.Cryptography.RSA" />
</Parameters>
<Docs>
<param name="rsa">An <see cref="T:System.Security.Cryptography.RSA" /> that represents an RSA algorithm.</param>
<summary>Returns a value that indicates whether the key identifier for this instance matches the specified RSA algorithm.</summary>
<returns>
<see langword="true" /> if the <see cref="F:System.Security.Cryptography.RSAParameters.Exponent" /> and <see cref="F:System.Security.Cryptography.RSAParameters.Modulus" /> fields of the <paramref name="rsa" /> parameter match the values returned by the <see cref="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetModulus" /> and <see cref="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetExponent" /> methods for the current instance; otherwise, <see langword="false" />.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Rsa">
<MemberSignature Language="C#" Value="public System.Security.Cryptography.RSA Rsa { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Security.Cryptography.RSA Rsa" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.RsaKeyIdentifierClause.Rsa" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Rsa As RSA" />
<MemberSignature Language="F#" Value="member this.Rsa : System.Security.Cryptography.RSA" Usage="System.IdentityModel.Tokens.RsaKeyIdentifierClause.Rsa" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Security::Cryptography::RSA ^ Rsa { System::Security::Cryptography::RSA ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.RSA</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the RSA algorithm that is associated with the key identifier clause.</summary>
<value>An <see cref="T:System.Security.Cryptography.RSA" /> that represents an RSA algorithm.</value>
<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.RsaKeyIdentifierClause.ToString" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ToString () As String" />
<MemberSignature Language="F#" Value="override this.ToString : unit -> string" Usage="rsaKeyIdentifierClause.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>
<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.RsaKeyIdentifierClause.ToString%2A> method returns a string that contains the `Modulus` and `Exponent` values of the RSA algorithm. The `Modulus` and `Exponent` values are the values returned by the <xref:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetModulus%2A> and <xref:System.IdentityModel.Tokens.RsaKeyIdentifierClause.GetExponent%2A> methods that are Base64 encoded.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="WriteExponentAsBase64">
<MemberSignature Language="C#" Value="public void WriteExponentAsBase64 (System.Xml.XmlWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteExponentAsBase64(class System.Xml.XmlWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.WriteExponentAsBase64(System.Xml.XmlWriter)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteExponentAsBase64 (writer As XmlWriter)" />
<MemberSignature Language="F#" Value="member this.WriteExponentAsBase64 : System.Xml.XmlWriter -> unit" Usage="rsaKeyIdentifierClause.WriteExponentAsBase64 writer" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteExponentAsBase64(System::Xml::XmlWriter ^ writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlWriter" />
</Parameters>
<Docs>
<param name="writer">A <see cref="T:System.Xml.XmlWriter" /> to write the Base64 encoded <see langword="Exponent" /> parameter of the RSA algorithm.</param>
<summary>Writes the Base64 encoded <see langword="Exponent" /> parameter of the RSA algorithm into the specified XML serializer.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="writer" /> is <see langword="null" />.</exception>
</Docs>
</Member>
<Member MemberName="WriteModulusAsBase64">
<MemberSignature Language="C#" Value="public void WriteModulusAsBase64 (System.Xml.XmlWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void WriteModulusAsBase64(class System.Xml.XmlWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.RsaKeyIdentifierClause.WriteModulusAsBase64(System.Xml.XmlWriter)" />
<MemberSignature Language="VB.NET" Value="Public Sub WriteModulusAsBase64 (writer As XmlWriter)" />
<MemberSignature Language="F#" Value="member this.WriteModulusAsBase64 : System.Xml.XmlWriter -> unit" Usage="rsaKeyIdentifierClause.WriteModulusAsBase64 writer" />
<MemberSignature Language="C++ CLI" Value="public:
 void WriteModulusAsBase64(System::Xml::XmlWriter ^ writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Xml.XmlWriter" />
</Parameters>
<Docs>
<param name="writer">A <see cref="T:System.Xml.XmlWriter" /> to write the Base64 encoded <see langword="Modulus" /> parameter of the RSA algorithm.</param>
<summary>Writes the Base64 encoded <see langword="Modulus" /> parameter of the RSA algorithm into the specified XML serializer.</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="writer" /> is <see langword="null" />.</exception>
</Docs>
</Member>
</Members>
</Type>