-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
HmacRedactorOptions.xml
132 lines (131 loc) · 7.48 KB
/
HmacRedactorOptions.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
<Type Name="HmacRedactorOptions" FullName="Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions">
<TypeSignature Language="C#" Value="public class HmacRedactorOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit HmacRedactorOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions" />
<TypeSignature Language="VB.NET" Value="Public Class HmacRedactorOptions" />
<TypeSignature Language="F#" Value="type HmacRedactorOptions = class" />
<TypeSignature Language="C++ CLI" Value="public ref class HmacRedactorOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Compliance.Redaction</AssemblyName>
<AssemblyVersion>8.0.0.0</AssemblyVersion>
<AssemblyVersion>8.4.0.0</AssemblyVersion>
<AssemblyVersion>8.5.0.0</AssemblyVersion>
<AssemblyVersion>8.6.0.0</AssemblyVersion>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.Nullable(0)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.Nullable(0)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.CompilerServices.NullableContext(1)]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.CompilerServices.NullableContext(1)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>
Options to control the <see cref="T:Microsoft.Extensions.Compliance.Redaction.HmacRedactor" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HmacRedactorOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberSignature Language="C++ CLI" Value="public:
 HmacRedactorOptions();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Compliance.Redaction</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Key">
<MemberSignature Language="C#" Value="public string Key { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Key" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions.Key" />
<MemberSignature Language="VB.NET" Value="Public Property Key As String" />
<MemberSignature Language="F#" Value="member this.Key : string with get, set" Usage="Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions.Key" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ Key { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Compliance.Redaction</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="net-6.0;net-8.0;net-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode", Justification="Validating the Length attribute on a string does not require reflection, it is handled intrinsically.")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.UnconditionalSuppressMessage("ReflectionAnalysis", "IL2026:RequiresUnreferencedCode", Justification="Validating the Length attribute on a string does not require reflection, it is handled intrinsically.")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.ComponentModel.DataAnnotations.Base64String]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DataAnnotations.Base64String>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.StringSyntax("Base64")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.StringSyntax("Base64")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the hashing key.
</summary>
<value>
The default is <see cref="F:System.String.Empty" />.
</value>
<remarks>
The key is specified in base 64 format, and must be a minimum of 44 characters long.
We recommend using a distinct key for each major deployment of a service (for example, for each region the service is in). Additionally,
the key material should be kept secret and rotated on a regular basis.
</remarks>
</Docs>
</Member>
<Member MemberName="KeyId">
<MemberSignature Language="C#" Value="public int? KeyId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<int32> KeyId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions.KeyId" />
<MemberSignature Language="VB.NET" Value="Public Property KeyId As Nullable(Of Integer)" />
<MemberSignature Language="F#" Value="member this.KeyId : Nullable<int> with get, set" Usage="Microsoft.Extensions.Compliance.Redaction.HmacRedactorOptions.KeyId" />
<MemberSignature Language="C++ CLI" Value="public:
 property Nullable<int> KeyId { Nullable<int> get(); void set(Nullable<int> value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Extensions.Compliance.Redaction</AssemblyName>
<AssemblyVersion>8.7.0.0</AssemblyVersion>
<AssemblyVersion>9.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.Int32></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the key ID.
</summary>
<value>
The default is <see langword="null" />.
</value>
<remarks>
The key ID is appended to each redacted value and is intended to identify the key that was used to hash the data.
In general, every distinct key should have a unique ID associated with it. When the hashed values have different key IDs,
it means the values are unrelated and can't be used for correlation.
</remarks>
</Docs>
</Member>
</Members>
</Type>