-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
EncryptedSecurityToken.xml
334 lines (322 loc) · 21.8 KB
/
EncryptedSecurityToken.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
<Type Name="EncryptedSecurityToken" FullName="System.IdentityModel.Tokens.EncryptedSecurityToken">
<TypeSignature Language="C#" Value="public class EncryptedSecurityToken : System.IdentityModel.Tokens.SecurityToken" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit EncryptedSecurityToken extends System.IdentityModel.Tokens.SecurityToken" />
<TypeSignature Language="DocId" Value="T:System.IdentityModel.Tokens.EncryptedSecurityToken" />
<TypeSignature Language="VB.NET" Value="Public Class EncryptedSecurityToken
Inherits SecurityToken" />
<TypeSignature Language="F#" Value="type EncryptedSecurityToken = class
 inherit SecurityToken" />
<TypeSignature Language="C++ CLI" Value="public ref class EncryptedSecurityToken : System::IdentityModel::Tokens::SecurityToken" />
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.IdentityModel.Tokens.SecurityToken</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>A wrapping-token that handles encryption for a token that does not natively support it.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
For example, a <xref:System.IdentityModel.Tokens.SamlSecurityToken> cannot encrypt itself, so to issue an encrypted SAML11 assertion, wrap a <xref:System.IdentityModel.Tokens.SamlSecurityToken> with an <xref:System.IdentityModel.Tokens.EncryptedSecurityToken> and provide appropriate <xref:System.IdentityModel.Tokens.EncryptingCredentials>.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public EncryptedSecurityToken (System.IdentityModel.Tokens.SecurityToken token, System.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IdentityModel.Tokens.SecurityToken token, class System.IdentityModel.Tokens.EncryptingCredentials encryptingCredentials) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.EncryptedSecurityToken.#ctor(System.IdentityModel.Tokens.SecurityToken,System.IdentityModel.Tokens.EncryptingCredentials)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (token As SecurityToken, encryptingCredentials As EncryptingCredentials)" />
<MemberSignature Language="F#" Value="new System.IdentityModel.Tokens.EncryptedSecurityToken : System.IdentityModel.Tokens.SecurityToken * System.IdentityModel.Tokens.EncryptingCredentials -> System.IdentityModel.Tokens.EncryptedSecurityToken" Usage="new System.IdentityModel.Tokens.EncryptedSecurityToken (token, encryptingCredentials)" />
<MemberSignature Language="C++ CLI" Value="public:
 EncryptedSecurityToken(System::IdentityModel::Tokens::SecurityToken ^ token, System::IdentityModel::Tokens::EncryptingCredentials ^ encryptingCredentials);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="token" Type="System.IdentityModel.Tokens.SecurityToken" />
<Parameter Name="encryptingCredentials" Type="System.IdentityModel.Tokens.EncryptingCredentials" />
</Parameters>
<Docs>
<param name="token">The token to encrypt.</param>
<param name="encryptingCredentials">The credentials to use to encrypt the token.</param>
<summary>Initializes a new instance of the <see cref="T:System.IdentityModel.Tokens.EncryptedSecurityToken" /> class for the specified token by using the specified encrypting credentials.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Inherited from <xref:System.IdentityModel.Tokens.SecurityToken>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="CanCreateKeyIdentifierClause<T>">
<MemberSignature Language="C#" Value="public override bool CanCreateKeyIdentifierClause<T> () where T : System.IdentityModel.Tokens.SecurityKeyIdentifierClause;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool CanCreateKeyIdentifierClause<(class System.IdentityModel.Tokens.SecurityKeyIdentifierClause) T>() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.EncryptedSecurityToken.CanCreateKeyIdentifierClause``1" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CanCreateKeyIdentifierClause(Of T As SecurityKeyIdentifierClause) () As Boolean" />
<MemberSignature Language="F#" Value="override this.CanCreateKeyIdentifierClause : unit -> bool (requires 'T :> System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" Usage="encryptedSecurityToken.CanCreateKeyIdentifierClause " />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 where T : System::IdentityModel::Tokens::SecurityKeyIdentifierClause override bool CanCreateKeyIdentifierClause();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<BaseTypeName>System.IdentityModel.Tokens.SecurityKeyIdentifierClause</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="T">The type of the key identifier clause.</typeparam>
<summary>Gets a value that indicates whether the token can create a key identifier clause of the specified type.</summary>
<returns>
<see langword="true" /> if the token can create a key identifier clause of the specified type; otherwise, <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Inherited from <xref:System.IdentityModel.Tokens.SecurityToken>.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="CreateKeyIdentifierClause<T>">
<MemberSignature Language="C#" Value="public override T CreateKeyIdentifierClause<T> () where T : System.IdentityModel.Tokens.SecurityKeyIdentifierClause;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance !!T CreateKeyIdentifierClause<(class System.IdentityModel.Tokens.SecurityKeyIdentifierClause) T>() cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.EncryptedSecurityToken.CreateKeyIdentifierClause``1" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function CreateKeyIdentifierClause(Of T As SecurityKeyIdentifierClause) () As T" />
<MemberSignature Language="F#" Value="override this.CreateKeyIdentifierClause : unit -> 'T (requires 'T :> System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" Usage="encryptedSecurityToken.CreateKeyIdentifierClause " />
<MemberSignature Language="C++ CLI" Value="public:
generic <typename T>
 where T : System::IdentityModel::Tokens::SecurityKeyIdentifierClause override T CreateKeyIdentifierClause();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>T</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="T">
<Constraints>
<BaseTypeName>System.IdentityModel.Tokens.SecurityKeyIdentifierClause</BaseTypeName>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters />
<Docs>
<typeparam name="T">The type of the key identifier clause to create.</typeparam>
<summary>Creates a key identifier clause of the specified type for the token.</summary>
<returns>A key identifier clause of the specified type.</returns>
<remarks>To be added.</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="EncryptingCredentials">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.EncryptingCredentials EncryptingCredentials { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.EncryptingCredentials EncryptingCredentials" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.EncryptedSecurityToken.EncryptingCredentials" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property EncryptingCredentials As EncryptingCredentials" />
<MemberSignature Language="F#" Value="member this.EncryptingCredentials : System.IdentityModel.Tokens.EncryptingCredentials" Usage="System.IdentityModel.Tokens.EncryptedSecurityToken.EncryptingCredentials" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::EncryptingCredentials ^ EncryptingCredentials { System::IdentityModel::Tokens::EncryptingCredentials ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.EncryptingCredentials</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the credentials to use for encryption.</summary>
<value>The credentials to use for encryption.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public override string Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Id" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.EncryptedSecurityToken.Id" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Id As String" />
<MemberSignature Language="F#" Value="member this.Id : string" Usage="System.IdentityModel.Tokens.EncryptedSecurityToken.Id" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ Id { System::String ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the unique identifier of the security token.</summary>
<value>The unique identifier of the security token.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="MatchesKeyIdentifierClause">
<MemberSignature Language="C#" Value="public override bool MatchesKeyIdentifierClause (System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool MatchesKeyIdentifierClause(class System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.EncryptedSecurityToken.MatchesKeyIdentifierClause(System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function MatchesKeyIdentifierClause (keyIdentifierClause As SecurityKeyIdentifierClause) As Boolean" />
<MemberSignature Language="F#" Value="override this.MatchesKeyIdentifierClause : System.IdentityModel.Tokens.SecurityKeyIdentifierClause -> bool" Usage="encryptedSecurityToken.MatchesKeyIdentifierClause keyIdentifierClause" />
<MemberSignature Language="C++ CLI" Value="public:
 override bool MatchesKeyIdentifierClause(System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ keyIdentifierClause);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<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 key identifier clause to compare to this instance.</param>
<summary>Returns a value that indicates whether the key identifier for this instance can be resolved to the specified key identifier.</summary>
<returns>
<see langword="true" /> if the specified key identifier clause can be resolved by this instance; otherwise <see langword="false" />.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Inherited from <xref:System.IdentityModel.Tokens.SecurityToken>.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="ResolveKeyIdentifierClause">
<MemberSignature Language="C#" Value="public override System.IdentityModel.Tokens.SecurityKey ResolveKeyIdentifierClause (System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance class System.IdentityModel.Tokens.SecurityKey ResolveKeyIdentifierClause(class System.IdentityModel.Tokens.SecurityKeyIdentifierClause keyIdentifierClause) cil managed" />
<MemberSignature Language="DocId" Value="M:System.IdentityModel.Tokens.EncryptedSecurityToken.ResolveKeyIdentifierClause(System.IdentityModel.Tokens.SecurityKeyIdentifierClause)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function ResolveKeyIdentifierClause (keyIdentifierClause As SecurityKeyIdentifierClause) As SecurityKey" />
<MemberSignature Language="F#" Value="override this.ResolveKeyIdentifierClause : System.IdentityModel.Tokens.SecurityKeyIdentifierClause -> System.IdentityModel.Tokens.SecurityKey" Usage="encryptedSecurityToken.ResolveKeyIdentifierClause keyIdentifierClause" />
<MemberSignature Language="C++ CLI" Value="public:
 override System::IdentityModel::Tokens::SecurityKey ^ ResolveKeyIdentifierClause(System::IdentityModel::Tokens::SecurityKeyIdentifierClause ^ keyIdentifierClause);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityKey</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyIdentifierClause" Type="System.IdentityModel.Tokens.SecurityKeyIdentifierClause" />
</Parameters>
<Docs>
<param name="keyIdentifierClause">The key identifier clause to get the key for.</param>
<summary>Gets the key for the specified key identifier clause.</summary>
<returns>The key.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Inherited from <xref:System.IdentityModel.Tokens.SecurityToken>.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="SecurityKeys">
<MemberSignature Language="C#" Value="public override System.Collections.ObjectModel.ReadOnlyCollection<System.IdentityModel.Tokens.SecurityKey> SecurityKeys { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.ObjectModel.ReadOnlyCollection`1<class System.IdentityModel.Tokens.SecurityKey> SecurityKeys" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.EncryptedSecurityToken.SecurityKeys" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property SecurityKeys As ReadOnlyCollection(Of SecurityKey)" />
<MemberSignature Language="F#" Value="member this.SecurityKeys : System.Collections.ObjectModel.ReadOnlyCollection<System.IdentityModel.Tokens.SecurityKey>" Usage="System.IdentityModel.Tokens.EncryptedSecurityToken.SecurityKeys" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Collections::ObjectModel::ReadOnlyCollection<System::IdentityModel::Tokens::SecurityKey ^> ^ SecurityKeys { System::Collections::ObjectModel::ReadOnlyCollection<System::IdentityModel::Tokens::SecurityKey ^> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.ObjectModel.ReadOnlyCollection<System.IdentityModel.Tokens.SecurityKey></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the cryptographic keys associated with the security token.</summary>
<value>The set of keys associated with the security token.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Inherited from <xref:System.IdentityModel.Tokens.SecurityToken>.
]]></format>
</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="Token">
<MemberSignature Language="C#" Value="public System.IdentityModel.Tokens.SecurityToken Token { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.IdentityModel.Tokens.SecurityToken Token" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.EncryptedSecurityToken.Token" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Token As SecurityToken" />
<MemberSignature Language="F#" Value="member this.Token : System.IdentityModel.Tokens.SecurityToken" Usage="System.IdentityModel.Tokens.EncryptedSecurityToken.Token" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::IdentityModel::Tokens::SecurityToken ^ Token { System::IdentityModel::Tokens::SecurityToken ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.IdentityModel.Tokens.SecurityToken</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the encrypted token.</summary>
<value>The encrypted token.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ValidFrom">
<MemberSignature Language="C#" Value="public override DateTime ValidFrom { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ValidFrom" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.EncryptedSecurityToken.ValidFrom" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property ValidFrom As DateTime" />
<MemberSignature Language="F#" Value="member this.ValidFrom : DateTime" Usage="System.IdentityModel.Tokens.EncryptedSecurityToken.ValidFrom" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property DateTime ValidFrom { DateTime get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the first instant in time at which the security token is valid.</summary>
<value>The instant in time at which the security token is valid.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
<Member MemberName="ValidTo">
<MemberSignature Language="C#" Value="public override DateTime ValidTo { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.DateTime ValidTo" />
<MemberSignature Language="DocId" Value="P:System.IdentityModel.Tokens.EncryptedSecurityToken.ValidTo" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property ValidTo As DateTime" />
<MemberSignature Language="F#" Value="member this.ValidTo : DateTime" Usage="System.IdentityModel.Tokens.EncryptedSecurityToken.ValidTo" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property DateTime ValidTo { DateTime get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.IdentityModel</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.DateTime</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the last instant in time at which the security token is valid.</summary>
<value>The last instant in time at which the security token is valid.</value>
<remarks>To be added.</remarks>
<altmember cref="T:System.IdentityModel.Tokens.SecurityToken" />
</Docs>
</Member>
</Members>
</Type>