-
Notifications
You must be signed in to change notification settings - Fork 112
/
IDataProtectionBuilder.xml
97 lines (97 loc) · 6.43 KB
/
IDataProtectionBuilder.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
<Type Name="IDataProtectionBuilder" FullName="Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder">
<TypeSignature Language="C++ CLI" Value="public interface class IDataProtectionBuilder" />
<TypeSignature Language="C#" Value="public interface IDataProtectionBuilder" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IDataProtectionBuilder" 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.IDataProtectionBuilder" />
<TypeSignature Language="VB.NET" Value="Public Interface IDataProtectionBuilder" />
<TypeSignature Language="F#" Value="type IDataProtectionBuilder = interface" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract beforefieldinit IDataProtectionBuilder" FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-8.0;aspnetcore-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Provides access to configuration for the data protection system, which allows the
developer to configure default cryptographic algorithms, key storage locations,
and the mechanism by which keys are protected at rest.
</summary>
<remarks>
<para>
If the developer changes the at-rest key protection mechanism, it is intended that
they also change the key storage location, and vice versa. For instance, a call to
<see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionBuilderExtensions.ProtectKeysWithCertificate(Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder,System.String)" /> should generally be accompanied by
a call to <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionBuilderExtensions.PersistKeysToFileSystem(Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder,System.IO.DirectoryInfo)" />, or exceptions may
occur at runtime due to the data protection system not knowing where to persist keys.
</para>
<para>
Similarly, when a developer modifies the default protected payload cryptographic
algorithms, they should also set an explicit key storage location.
A call to <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionBuilderExtensions.UseCryptographicAlgorithms(Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder,Microsoft.AspNetCore.DataProtection.AuthenticatedEncryption.ConfigurationModel.AuthenticatedEncryptorConfiguration)" />
should therefore generally be paired with a call to <see cref="M:Microsoft.AspNetCore.DataProtection.DataProtectionBuilderExtensions.PersistKeysToFileSystem(Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder,System.IO.DirectoryInfo)" />,
for example.
</para>
<para>
When the default cryptographic algorithms or at-rest key protection mechanisms are
changed, they only affect <strong>new</strong> keys in the repository. The repository may
contain existing keys that use older algorithms or protection mechanisms.
</para>
</remarks>
</Docs>
<Members>
<Member MemberName="Services">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::Extensions::DependencyInjection::IServiceCollection ^ Services { Microsoft::Extensions::DependencyInjection::IServiceCollection ^ get(); };" />
<MemberSignature Language="C#" Value="public Microsoft.Extensions.DependencyInjection.IServiceCollection Services { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Extensions.DependencyInjection.IServiceCollection Services" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder.Services" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Services As IServiceCollection" />
<MemberSignature Language="F#" Value="member this.Services : Microsoft.Extensions.DependencyInjection.IServiceCollection" Usage="Microsoft.AspNetCore.DataProtection.IDataProtectionBuilder.Services" />
<MemberType>Property</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>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Extensions.DependencyInjection.IServiceCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>
Provides access to the <see cref="T:Microsoft.Extensions.DependencyInjection.IServiceCollection" /> passed to this object's constructor.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>