-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
CipherSuitesPolicy.xml
135 lines (127 loc) · 8.96 KB
/
CipherSuitesPolicy.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
<Type Name="CipherSuitesPolicy" FullName="System.Net.Security.CipherSuitesPolicy">
<TypeSignature Language="C#" Value="public sealed class CipherSuitesPolicy" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit CipherSuitesPolicy extends System.Object" />
<TypeSignature Language="DocId" Value="T:System.Net.Security.CipherSuitesPolicy" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class CipherSuitesPolicy" />
<TypeSignature Language="F#" Value="type CipherSuitesPolicy = class" />
<TypeSignature Language="C++ CLI" Value="public ref class CipherSuitesPolicy sealed" />
<AssemblyInfo>
<AssemblyName>System.Net.Security</AssemblyName>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.1.2.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>
<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>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.Versioning.UnsupportedOSPlatform("android")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.UnsupportedOSPlatform("android")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="net-8.0;net-9.0">
<AttributeName Language="C#">[System.Runtime.Versioning.UnsupportedOSPlatform("windows")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Versioning.UnsupportedOSPlatform("windows")>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Specifies allowed cipher suites.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CipherSuitesPolicy (System.Collections.Generic.IEnumerable<System.Net.Security.TlsCipherSuite> allowedCipherSuites);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Collections.Generic.IEnumerable`1<valuetype System.Net.Security.TlsCipherSuite> allowedCipherSuites) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Net.Security.CipherSuitesPolicy.#ctor(System.Collections.Generic.IEnumerable{System.Net.Security.TlsCipherSuite})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (allowedCipherSuites As IEnumerable(Of TlsCipherSuite))" />
<MemberSignature Language="F#" Value="new System.Net.Security.CipherSuitesPolicy : seq<System.Net.Security.TlsCipherSuite> -> System.Net.Security.CipherSuitesPolicy" Usage="new System.Net.Security.CipherSuitesPolicy allowedCipherSuites" />
<MemberSignature Language="C++ CLI" Value="public:
 CipherSuitesPolicy(System::Collections::Generic::IEnumerable<System::Net::Security::TlsCipherSuite> ^ allowedCipherSuites);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Security</AssemblyName>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.1.2.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>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>
<AttributeName Language="F#">[<System.CLSCompliant(false)>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="allowedCipherSuites" Type="System.Collections.Generic.IEnumerable<System.Net.Security.TlsCipherSuite>" />
</Parameters>
<Docs>
<param name="allowedCipherSuites">The collection of cipher suites allowed in this policy for negotiation.</param>
<summary>Initializes a new instance of the <see cref="T:System.Net.Security.CipherSuitesPolicy" /> class that can be used for client or server authentication.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
> [!NOTE]
> Defining a cipher suite policy on <xref:System.Net.Security.SslStream> authentication will prevent the OS from deciding which are the best cipher suites to negotiate with and requires that you manually check and update this code. We strongly recommend that you avoid using this feature and rely on your constantly updated OS policy.
## Remarks
Unlike the operating system's underlying SSL/TLS implementation, the order of the <xref:System.Net.Security.TlsCipherSuite> elements in `allowedCipherSuites` doesn't guarantee their priority in client-server negotiation. You can only initialize an instance of this class if you're using Linux systems with OpenSSL 1.1.1 or higher or macOS.
]]></format>
</remarks>
<exception cref="T:System.PlatformNotSupportedException">Platform is not a Linux system with OpenSSL 1.1.1 or higher or a macOS.</exception>
</Docs>
</Member>
<Member MemberName="AllowedCipherSuites">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<System.Net.Security.TlsCipherSuite> AllowedCipherSuites { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<valuetype System.Net.Security.TlsCipherSuite> AllowedCipherSuites" />
<MemberSignature Language="DocId" Value="P:System.Net.Security.CipherSuitesPolicy.AllowedCipherSuites" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AllowedCipherSuites As IEnumerable(Of TlsCipherSuite)" />
<MemberSignature Language="F#" Value="member this.AllowedCipherSuites : seq<System.Net.Security.TlsCipherSuite>" Usage="System.Net.Security.CipherSuitesPolicy.AllowedCipherSuites" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::IEnumerable<System::Net::Security::TlsCipherSuite> ^ AllowedCipherSuites { System::Collections::Generic::IEnumerable<System::Net::Security::TlsCipherSuite> ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Net.Security</AssemblyName>
<AssemblyVersion>4.1.1.0</AssemblyVersion>
<AssemblyVersion>4.1.2.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>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.CLSCompliant(false)]</AttributeName>
<AttributeName Language="F#">[<System.CLSCompliant(false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<System.Net.Security.TlsCipherSuite></ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a subset of valid cipher suites passed into <see cref="M:System.Net.Security.CipherSuitesPolicy.#ctor(System.Collections.Generic.IEnumerable{System.Net.Security.TlsCipherSuite})" /> constructor as a collection of cipher suites allowed in this policy for negotiation.</summary>
<value>The collection of cipher suites allowed in this policy for negotiation.</value>
<remarks>
<format type="text/markdown"><![CDATA[
> [!NOTE]
> Defining a cipher suite policy on <xref:System.Net.Security.SslStream> authentication will prevent the OS from deciding which are the best cipher suites to negotiate with and requires that you manually check and update this code. We strongly recommend that you avoid using this feature and rely on your constantly updated OS policy.
## Remarks
Unlike the operating system's underlying SSL/TLS implementation, the order of the <xref:System.Net.Security.TlsCipherSuite> elements in `allowedCipherSuites` doesn't guarantee their priority in client-server negotiation. You can only initialize an instance of this class if you're using Linux systems with OpenSSL 1.1.1 or higher or macOS.
]]></format>
</remarks>
</Docs>
</Member>
</Members>
</Type>