@@ -75,12 +75,12 @@ public SslOption()
75
75
}
76
76
77
77
/// <summary>
78
- /// Retrieve or set the set of TLS policy errors that are deemed acceptable.
78
+ /// Retrieve or set the set of TLS policy (peer verification) errors that are deemed acceptable.
79
79
/// </summary>
80
80
public SslPolicyErrors AcceptablePolicyErrors { get ; set ; }
81
81
82
82
/// <summary>
83
- /// Retrieve or set the path to client certificate.
83
+ /// Retrieve or set the client certificate passphrase .
84
84
/// </summary>
85
85
public string CertPassphrase { get ; set ; }
86
86
@@ -90,15 +90,15 @@ public SslOption()
90
90
public string CertPath { get ; set ; }
91
91
92
92
/// <summary>
93
- /// An optional client specified TLS certificate selection callback. If this is not specified,
93
+ /// An optional client TLS certificate selection callback. If this is not specified,
94
94
/// the first valid certificate found will be used.
95
95
/// </summary>
96
96
public LocalCertificateSelectionCallback CertificateSelectionCallback { get ; set ; }
97
97
98
98
/// <summary>
99
- /// An optional client specified TLS certificate validation callback. If this is not specified,
99
+ /// An optional peer verification ( TLS certificate validation) callback. If this is not specified,
100
100
/// the default callback will be used in conjunction with the <see cref="AcceptablePolicyErrors"/> property to
101
- /// determine if the remote server certificate is valid.
101
+ /// determine if the peer's ( server's) certificate should be considered valid (acceptable) .
102
102
/// </summary>
103
103
public RemoteCertificateValidationCallback CertificateValidationCallback { get ; set ; }
104
104
@@ -128,25 +128,37 @@ public X509CertificateCollection Certs
128
128
}
129
129
130
130
/// <summary>
131
- /// Attempts to check certificate revocation status. Default is false. True if peer certificate should be
132
- /// checked for revocation, false otherwise .
131
+ /// Attempts to check certificate revocation status. Default is false.
132
+ /// Set to true to check peer certificate for revocation .
133
133
/// </summary>
134
- /// <remarks>Uses the built-in .NET mechanics for checking a certificate against CRLs.</remarks>
134
+ /// <remarks>
135
+ /// Uses the built-in .NET TLS implementation machinery for checking a certificate against
136
+ /// certificate revocation lists.
137
+ /// </remarks>
135
138
public bool CheckCertificateRevocation { get ; set ; }
136
139
137
140
/// <summary>
138
- /// Flag specifying if TLS should indeed be used.
141
+ /// Controls if TLS should indeed be used. Set to false to disable TLS
142
+ /// on the connection.
139
143
/// </summary>
140
144
public bool Enabled { get ; set ; }
141
145
142
146
/// <summary>
143
- /// Retrieve or set server's Canonical Name.
144
- /// This MUST match the Subject Alternative Name or CN on the Certificate else the TLS connection will fail.
147
+ /// Retrieve or set server's expected name.
148
+ /// This MUST match the Subject Alternative Name (SAN) or CN on the peer's (server's) leaf certificate,
149
+ /// otherwise the TLS connection will fail.
145
150
/// </summary>
146
151
public string ServerName { get ; set ; }
147
152
148
153
/// <summary>
149
- /// Retrieve or set the Ssl protocol version.
154
+ /// Retrieve or set the TLS protocol version.
155
+ /// The client will let the OS pick a suitable version by using <see cref="SslProtocols.None" />.
156
+ /// If this option is disabled, e.g.see via app context, the client will attempt to fall back
157
+ /// to TLSv1.2 (<see cref="SslProtocols.Tls12" />).
158
+ /// <see cref="System.Security.Authentication.SslProtocols" />
159
+ /// <see href="https://www.rabbitmq.com/ssl.html#dotnet-client" />
160
+ /// <see href="https://docs.microsoft.com/en-us/dotnet/framework/network-programming/tls?view=netframework-4.6.2" />
161
+ /// <see href="https://docs.microsoft.com/en-us/dotnet/api/system.security.authentication.sslprotocols?view=netframework-4.8" />
150
162
/// </summary>
151
163
public SslProtocols Version { get ; set ; }
152
164
0 commit comments