/
IAuthenticatedEncryptorDescriptor.xml
112 lines (112 loc) · 8.24 KB
/
IAuthenticatedEncryptorDescriptor.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
<Type Name="IAuthenticatedEncryptorDescriptor" FullName="Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.IAuthenticatedEncryptorDescriptor">
<TypeSignature Language="C++ CLI" Value="public interface class IAuthenticatedEncryptorDescriptor" />
<TypeSignature Language="C#" Value="public interface IAuthenticatedEncryptorDescriptor" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IAuthenticatedEncryptorDescriptor" FrameworkAlternate="aspnetcore-1.0;aspnetcore-1.1;aspnetcore-2.0;aspnetcore-2.1;aspnetcore-2.2;aspnetcore-3.0;aspnetcore-3.1;aspnetcore-5.0;aspnetcore-6.0;aspnetcore-7.0" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.IAuthenticatedEncryptorDescriptor" />
<TypeSignature Language="VB.NET" Value="Public Interface IAuthenticatedEncryptorDescriptor" />
<TypeSignature Language="F#" Value="type IAuthenticatedEncryptorDescriptor = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IAuthenticatedEncryptorDescriptor" FrameworkAlternate="aspnetcore-8.0" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.DataProtection</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
A self-contained descriptor that wraps all information (including secret key
material) necessary to create an instance of an <see cref="T:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CreateEncryptorInstance">
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::AspNetCore::DataProtection::AuthenticatedEncryption::IAuthenticatedEncryptor ^ CreateEncryptorInstance();" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor CreateEncryptorInstance ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor CreateEncryptorInstance() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.IAuthenticatedEncryptorDescriptor.CreateEncryptorInstance" />
<MemberSignature Language="VB.NET" Value="Public Function CreateEncryptorInstance () As IAuthenticatedEncryptor" />
<MemberSignature Language="F#" Value="abstract member CreateEncryptorInstance : unit -> Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor" Usage="iAuthenticatedEncryptorDescriptor.CreateEncryptorInstance " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.DataProtection</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Creates an <see cref="T:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor" /> instance based on the current descriptor.
</summary>
<returns>An <see cref="T:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor" /> instance.</returns>
<remarks>
For a given descriptor, any two instances returned by this method should
be considered equivalent, e.g., the payload returned by one's <see cref="M:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor.Encrypt(System.ArraySegment{System.Byte},System.ArraySegment{System.Byte})" />
method should be consumable by the other's <see cref="M:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.IAuthenticatedEncryptor.Decrypt(System.ArraySegment{System.Byte},System.ArraySegment{System.Byte})" /> method.
</remarks>
</Docs>
</Member>
<Member MemberName="ExportToXml">
<MemberSignature Language="C++ CLI" Value="public:
 Microsoft::AspNetCore::DataProtection::AuthenticatedEncryption::ConfigurationModel::XmlSerializedDescriptorInfo ^ ExportToXml();" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.XmlSerializedDescriptorInfo ExportToXml ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.XmlSerializedDescriptorInfo ExportToXml() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.IAuthenticatedEncryptorDescriptor.ExportToXml" />
<MemberSignature Language="VB.NET" Value="Public Function ExportToXml () As XmlSerializedDescriptorInfo" />
<MemberSignature Language="F#" Value="abstract member ExportToXml : unit -> Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.XmlSerializedDescriptorInfo" Usage="iAuthenticatedEncryptorDescriptor.ExportToXml " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.DataProtection</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>2.2.0.0</AssemblyVersion>
<AssemblyVersion>3.0.3.0</AssemblyVersion>
<AssemblyVersion>3.1.18.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.XmlSerializedDescriptorInfo</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Exports the current descriptor to XML.
</summary>
<returns>
An <see cref="T:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.XmlSerializedDescriptorInfo" /> wrapping the <see cref="T:System.Xml.Linq.XElement" /> which represents the serialized
current descriptor object. The deserializer type must be assignable to <see cref="T:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.IAuthenticatedEncryptorDescriptorDeserializer" />.
</returns>
<remarks>
If an element contains sensitive information (such as key material), the
element should be marked via the <see cref="M:Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.XmlExtensions.MarkAsRequiresEncryption(System.Xml.Linq.XElement)" />
extension method, and the caller should encrypt the element before persisting
the XML to storage.
</remarks>
</Docs>
</Member>
</Members>
</Type>