-
Notifications
You must be signed in to change notification settings - Fork 32
/
RsaKeyWrapProvider.xml
262 lines (262 loc) · 15.7 KB
/
RsaKeyWrapProvider.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
<Type Name="RsaKeyWrapProvider" FullName="Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider">
<TypeSignature Language="C#" Value="public class RsaKeyWrapProvider : Microsoft.IdentityModel.Tokens.KeyWrapProvider" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit RsaKeyWrapProvider extends Microsoft.IdentityModel.Tokens.KeyWrapProvider" />
<TypeSignature Language="DocId" Value="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider" />
<TypeSignature Language="VB.NET" Value="Public Class RsaKeyWrapProvider
Inherits KeyWrapProvider" />
<TypeSignature Language="F#" Value="type RsaKeyWrapProvider = 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>
<AssemblyVersion>7.6.3.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.1.0</AssemblyVersion>
<AssemblyVersion>8.0.2.0</AssemblyVersion>
<AssemblyVersion>8.1.0.0</AssemblyVersion>
<AssemblyVersion>8.1.1.0</AssemblyVersion>
<AssemblyVersion>8.1.2.0</AssemblyVersion>
<AssemblyVersion>8.2.0.0</AssemblyVersion>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.IdentityModel.Tokens.KeyWrapProvider</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Provides RSA Wrap key and Unwrap key services.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public RsaKeyWrapProvider (Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm, bool willUnwrap);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.IdentityModel.Tokens.SecurityKey key, string algorithm, bool willUnwrap) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.#ctor(Microsoft.IdentityModel.Tokens.SecurityKey,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (key As SecurityKey, algorithm As String, willUnwrap As Boolean)" />
<MemberSignature Language="F#" Value="new Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider : Microsoft.IdentityModel.Tokens.SecurityKey * string * bool -> Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider" Usage="new Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider (key, algorithm, willUnwrap)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="key" Type="Microsoft.IdentityModel.Tokens.SecurityKey" />
<Parameter Name="algorithm" Type="System.String" />
<Parameter Name="willUnwrap" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="key">The <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> that will be used for cryptographic operations.</param>
<param name="algorithm">The KeyWrap algorithm to be used.</param>
<param name="willUnwrap">Whether this <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider" /> is required to unwrap keys. If true, the private key is required.</param>
<summary>
Initializes a new instance of the <see cref="T:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider" /> class used for wrapping and unwrapping keys.
These keys are usually symmetric session keys that are wrapped using the recipient's public key.
</summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="algorithm" /> is null.</exception>
<exception cref="T:System.ArgumentException">Thrown if the <see cref="T:Microsoft.IdentityModel.Tokens.SecurityKey" /> and <paramref name="algorithm" /> pair are not supported.</exception>
<exception cref="T:System.NotSupportedException">Thrown if failed to create RSA algorithm with the provided key and algorithm.</exception>
</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.RsaKeyWrapProvider.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.RsaKeyWrapProvider.Algorithm" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.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.RsaKeyWrapProvider.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.RsaKeyWrapProvider.Context" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.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 is for use by the application and not used by this SDK.</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.RsaKeyWrapProvider.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="rsaKeyWrapProvider.Dispose disposing" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="disposing" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="disposing">If true, release both managed and unmanaged resources; otherwise, release only unmanaged resources.</param>
<summary>
Releases the resources used by the current instance.
</summary>
<remarks>To be added.</remarks>
</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.RsaKeyWrapProvider.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="rsaKeyWrapProvider.IsSupportedAlgorithm (key, algorithm)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.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" /> that will be used for cryptographic operations.</param>
<param name="algorithm">The KeyWrap algorithm to be used.</param>
<summary>
Checks if the specified 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.RsaKeyWrapProvider.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.RsaKeyWrapProvider.Key" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.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.RsaKeyWrapProvider.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="rsaKeyWrapProvider.UnwrapKey keyBytes" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="keyBytes" Type="System.Byte[]" />
</Parameters>
<Docs>
<param name="keyBytes">The bytes to unwrap.</param>
<summary>
Unwraps a key using RSA decryption.
</summary>
<returns>The unwrapped key.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes" /> is null or has a length of 0.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)" /> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Thrown if the key unwrapping operation fails.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the internal RSA algorithm is null.</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.RsaKeyWrapProvider.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="rsaKeyWrapProvider.WrapKey keyBytes" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.IdentityModel.Tokens</AssemblyName>
<AssemblyVersion>8.2.1.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>
Wraps a key using RSA encryption.
</summary>
<returns>A wrapped key.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="keyBytes" /> is null or has a length of 0.</exception>
<exception cref="T:System.ObjectDisposedException">Thrown if <see cref="M:Microsoft.IdentityModel.Tokens.RsaKeyWrapProvider.Dispose(System.Boolean)" /> has been called.</exception>
<exception cref="T:Microsoft.IdentityModel.Tokens.SecurityTokenKeyWrapException">Thrown if the key wrapping operation fails.</exception>
<exception cref="T:System.InvalidOperationException">Thrown if the internal RSA algorithm is null.</exception>
</Docs>
</Member>
</Members>
</Type>