-
Notifications
You must be signed in to change notification settings - Fork 27
/
SymmetricKeyWrapProvider.xml
278 lines (278 loc) · 17.5 KB
/
SymmetricKeyWrapProvider.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
<Type Name="SymmetricKeyWrapProvider" FullName="Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider">
<TypeSignature Language="C#" Value="public class SymmetricKeyWrapProvider : Microsoft.IdentityModel.Tokens.KeyWrapProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SymmetricKeyWrapProvider extends Microsoft.IdentityModel.Tokens.KeyWrapProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider" />
<TypeSignature Language="VB.NET" Value="Public Class SymmetricKeyWrapProvider
Inherits KeyWrapProvider" />
<TypeSignature Language="F#" Value="type SymmetricKeyWrapProvider = class
 inherit KeyWrapProvider" />
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>6.27.0.0</AssemblyVersion>
<AssemblyVersion>6.28.1.0</AssemblyVersion>
<AssemblyVersion>6.29.0.0</AssemblyVersion>
<AssemblyVersion>6.30.0.0</AssemblyVersion>
<AssemblyVersion>6.30.1.0</AssemblyVersion>
<AssemblyVersion>6.31.0.0</AssemblyVersion>
<AssemblyVersion>6.32.0.0</AssemblyVersion>
<AssemblyVersion>6.32.1.0</AssemblyVersion>
<AssemblyVersion>6.32.2.0</AssemblyVersion>
<AssemblyVersion>6.32.3.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.2.0</AssemblyVersion>
<AssemblyVersion>7.0.3.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
<AssemblyVersion>7.3.1.0</AssemblyVersion>
<AssemblyVersion>7.4.0.0</AssemblyVersion>
<AssemblyVersion>7.4.1.0</AssemblyVersion>
<AssemblyVersion>7.5.0.0</AssemblyVersion>
<AssemblyVersion>7.5.1.0</AssemblyVersion>
<AssemblyVersion>7.5.2.0</AssemblyVersion>
<AssemblyVersion>7.6.0.0</AssemblyVersion>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.IdentityModel.Tokens.KeyWrapProvider</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides Wrap key and Unwrap key services.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SymmetricKeyWrapProvider (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (key As SecurityKey, algorithm As String)" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string -> Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider" Usage="new Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider (key, algorithm)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="key" Type="Microsoft.IdentityModel.Tokens.SecurityKey" />
<Parameter Name="algorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="algorithm">To be added.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider" /> class used for wrap key and unwrap key.
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> that will be used for crypto operations.</param><param name="algorithm">The KeyWrap algorithm to apply.</param><exception cref="T:System.ArgumentNullException">'key' is null.</exception><exception cref="T:System.ArgumentNullException">'algorithm' is null.</exception><exception cref="T:System.ArgumentException">If <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> and algorithm pair are not supported.</exception><exception cref="T:System.ArgumentException">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> cannot be converted to byte array</exception><exception cref="T:System.ArgumentOutOfRangeException">The keysize doesn't match the algorithm.</exception><exception cref="T:System.InvalidOperationException">Failed to create symmetric algorithm with provided key and algorithm.</exception></summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Algorithm">
<MemberSignature Language="C#" Value="public override string Algorithm { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Algorithm" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Algorithm" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Algorithm As String" />
<MemberSignature Language="F#" Value="member this.Algorithm : string" Usage="Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Algorithm" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the KeyWrap algorithm that is being used.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Context">
<MemberSignature Language="C#" Value="public override string Context { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Context" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Context" />
<MemberSignature Language="VB.NET" Value="Public Overrides Property Context As String" />
<MemberSignature Language="F#" Value="member this.Context : string with get, set" Usage="Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Context" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets a user context for a <see cref="T:Microsoft.IdentityModel.Tokens.KeyWrapProvider" />.
</summary>
<value>To be added.</value>
<remarks>This is null by default. This can be used by runtimes or for extensibility scenarios.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="protected override void Dispose (bool disposing);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig virtual instance void Dispose(bool disposing) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Dispose(System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Protected Overrides Sub Dispose (disposing As Boolean)" />
<MemberSignature Language="F#" Value="override this.Dispose : bool -> unit" Usage="symmetricKeyWrapProvider.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">true, if called from Dispose(), false, if invoked inside a finalizer.</param>
<summary>
Disposes of internal components.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetSymmetricAlgorithm">
<MemberSignature Language="C#" Value="protected virtual System.Security.Cryptography.SymmetricAlgorithm GetSymmetricAlgorithm (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Security.Cryptography.SymmetricAlgorithm GetSymmetricAlgorithm(class Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.GetSymmetricAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function GetSymmetricAlgorithm (key As SecurityKey, algorithm As String) As SymmetricAlgorithm" />
<MemberSignature Language="F#" Value="abstract member GetSymmetricAlgorithm : Microsoft.IdentityModel.Tokens.SecurityKey * string -> System.Security.Cryptography.SymmetricAlgorithm
override this.GetSymmetricAlgorithm : Microsoft.IdentityModel.Tokens.SecurityKey * string -> System.Security.Cryptography.SymmetricAlgorithm" Usage="symmetricKeyWrapProvider.GetSymmetricAlgorithm (key, algorithm)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Security.Cryptography.SymmetricAlgorithm</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.IdentityModel.Tokens.SecurityKey" />
<Parameter Name="algorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="key">To be added.</param>
<param name="algorithm">To be added.</param>
<summary>
Returns the <see cref="T:System.Security.Cryptography.SymmetricAlgorithm" />.
</summary>
<returns />
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentException">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> cannot be converted to byte array</exception>
<exception cref="T:System.ArgumentOutOfRangeException">The keysize doesn't match the algorithm.</exception>
<exception cref="T:System.InvalidOperationException">Failed to create symmetric algorithm with provided key and algorithm.</exception>
</Docs>
</Member>
<Member MemberName="IsSupportedAlgorithm">
<MemberSignature Language="C#" Value="protected virtual bool IsSupportedAlgorithm (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool IsSupportedAlgorithm(class Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.IsSupportedAlgorithm(Microsoft.IdentityModel.Tokens.SecurityKey,System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function IsSupportedAlgorithm (key As SecurityKey, algorithm As String) As Boolean" />
<MemberSignature Language="F#" Value="abstract member IsSupportedAlgorithm : Microsoft.IdentityModel.Tokens.SecurityKey * string -> bool
override this.IsSupportedAlgorithm : Microsoft.IdentityModel.Tokens.SecurityKey * string -> bool" Usage="symmetricKeyWrapProvider.IsSupportedAlgorithm (key, algorithm)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="Microsoft.IdentityModel.Tokens.SecurityKey" />
<Parameter Name="algorithm" Type="System.String" />
</Parameters>
<Docs>
<param name="key">the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /></param>
<param name="algorithm">the algorithm to use</param>
<summary>
Answers if an algorithm is supported
</summary>
<returns>true if the algorithm is supported; otherwise, false.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public override Microsoft.IdentityModel.Tokens.SecurityKey Key { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.IdentityModel.Tokens.SecurityKey Key" />
<MemberSignature Language="DocId" Value="P:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Key" />
<MemberSignature Language="VB.NET" Value="Public Overrides ReadOnly Property Key As SecurityKey" />
<MemberSignature Language="F#" Value="member this.Key : Microsoft.IdentityModel.Tokens.SecurityKey" Usage="Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.Key" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.IdentityModel.Tokens.SecurityKey</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> that is being used.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UnwrapKey">
<MemberSignature Language="C#" Value="public override byte[] UnwrapKey (byte[] keyBytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance unsigned int8[] UnwrapKey(unsigned int8[] keyBytes) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.UnwrapKey(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function UnwrapKey (keyBytes As Byte()) As Byte()" />
<MemberSignature Language="F#" Value="override this.UnwrapKey : byte[] -> byte[]" Usage="symmetricKeyWrapProvider.UnwrapKey keyBytes" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyBytes" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="keyBytes">bytes to unwrap</param>
<summary>
Unwrap a key using Symmetric decryption.
</summary>
<returns>Unwraped key</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">'keyBytes' is null or length == 0.</exception>
<exception cref="T:System.ArgumentException">'keyBytes' is not a multiple of 8.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)" /> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to unwrap the wrappedKey.</exception>
</Docs>
</Member>
<Member MemberName="WrapKey">
<MemberSignature Language="C#" Value="public override byte[] WrapKey (byte[] keyBytes);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance unsigned int8[] WrapKey(unsigned int8[] keyBytes) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.SymmetricKeyWrapProvider.WrapKey(System.Byte[])" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function WrapKey (keyBytes As Byte()) As Byte()" />
<MemberSignature Language="F#" Value="override this.WrapKey : byte[] -> byte[]" Usage="symmetricKeyWrapProvider.WrapKey keyBytes" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>7.6.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyBytes" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="keyBytes">the key to be wrapped</param>
<summary>
Wrap a key using Symmetric encryption.
</summary>
<returns>The wrapped key result</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">'keyBytes' is null or has length 0.</exception>
<exception cref="T:System.ArgumentException">'keyBytes' is not a multiple of 8.</exception>
<exception cref="T:System.ObjectDisposedException">If <see cref="M:Microsoft.IdentityModel.Tokens.KeyWrapProvider.Dispose(System.Boolean)" /> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Failed to wrap 'keyBytes'.</exception>
</Docs>
</Member>
</Members>
</Type>