forked from mongodb/mongo-csharp-driver
-
Notifications
You must be signed in to change notification settings - Fork 0
/
SslSettings.cs
296 lines (271 loc) · 11.8 KB
/
SslSettings.cs
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
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
/* Copyright 2010-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System;
using System.Collections;
using System.Collections.Generic;
using System.Linq;
using System.Net.Security;
using System.Reflection;
using System.Security.Authentication;
using System.Security.Cryptography.X509Certificates;
using MongoDB.Driver.Core.Configuration;
using MongoDB.Shared;
namespace MongoDB.Driver
{
/// <summary>
/// Represents the settings for using SSL.
/// </summary>
public class SslSettings : IEquatable<SslSettings>
{
// private static fields
private static readonly IEqualityComparer<X509CertificateCollection> __certificateCollectionEqualityComparer = new X509CertificateCollectionEqualityComparer();
// private fields
private bool _checkCertificateRevocation = false;
private X509CertificateCollection _clientCertificateCollection;
private LocalCertificateSelectionCallback _clientCertificateSelectionCallback;
private SslProtocols _enabledSslProtocols = SslStreamSettings.SslProtocolsTls13 | SslProtocols.Tls12 | SslProtocols.Tls11 | SslProtocols.Tls;
private RemoteCertificateValidationCallback _serverCertificateValidationCallback;
// the following fields are set when the SslSettings are frozen
private bool _isFrozen;
private int _hashCode;
// public properties
/// <summary>
/// Gets or sets a value indicating whether to check for certificate revocation.
/// </summary>
public bool CheckCertificateRevocation
{
get { return _checkCertificateRevocation; }
set
{
if (_isFrozen) { throw new InvalidOperationException("SslSettings is frozen."); }
_checkCertificateRevocation = value;
}
}
/// <summary>
/// Gets or sets the client certificates.
/// </summary>
public IEnumerable<X509Certificate> ClientCertificates
{
get { return (_clientCertificateCollection == null) ? null : ((IEnumerable)_clientCertificateCollection).Cast<X509Certificate>(); }
set
{
if (_isFrozen) { throw new InvalidOperationException("SslSettings is frozen."); }
_clientCertificateCollection = (value == null) ? null : new X509CertificateCollection(value.ToArray());
}
}
/// <summary>
/// Gets or sets the client certificate selection callback.
/// </summary>
public LocalCertificateSelectionCallback ClientCertificateSelectionCallback
{
get { return _clientCertificateSelectionCallback; }
set
{
if (_isFrozen) { throw new InvalidOperationException("SslSettings is frozen."); }
_clientCertificateSelectionCallback = value;
}
}
/// <summary>
/// Gets or sets the enabled SSL protocols.
/// </summary>
public SslProtocols EnabledSslProtocols
{
get { return _enabledSslProtocols; }
set
{
if (_isFrozen) { throw new InvalidOperationException("SslSettings is frozen."); }
_enabledSslProtocols = value;
}
}
/// <summary>
/// Gets or sets the server certificate validation callback.
/// </summary>
public RemoteCertificateValidationCallback ServerCertificateValidationCallback
{
get { return _serverCertificateValidationCallback; }
set
{
if (_isFrozen) { throw new InvalidOperationException("SslSettings is frozen."); }
_serverCertificateValidationCallback = value;
}
}
// internal properties
internal X509CertificateCollection ClientCertificateCollection
{
get { return _clientCertificateCollection; }
}
// public operators
/// <summary>
/// Determines whether two <see cref="SslSettings"/> instances are equal.
/// </summary>
/// <param name="lhs">The LHS.</param>
/// <param name="rhs">The RHS.</param>
/// <returns>
/// <c>true</c> if the left hand side is equal to the right hand side; otherwise, <c>false</c>.
/// </returns>
public static bool operator ==(SslSettings lhs, SslSettings rhs)
{
return object.Equals(lhs, rhs); // handles lhs == null correctly
}
/// <summary>
/// Determines whether two <see cref="SslSettings"/> instances are not equal.
/// </summary>
/// <param name="lhs">The LHS.</param>
/// <param name="rhs">The RHS.</param>
/// <returns>
/// <c>true</c> if the left hand side is not equal to the right hand side; otherwise, <c>false</c>.
/// </returns>
public static bool operator !=(SslSettings lhs, SslSettings rhs)
{
return !(lhs == rhs);
}
// public methods
/// <summary>
/// Clones an SslSettings.
/// </summary>
/// <returns>The cloned SslSettings.</returns>
public SslSettings Clone()
{
var clone = new SslSettings();
clone._checkCertificateRevocation = _checkCertificateRevocation;
clone._clientCertificateCollection = _clientCertificateCollection; // is immutable
clone._clientCertificateSelectionCallback = _clientCertificateSelectionCallback;
clone._enabledSslProtocols = _enabledSslProtocols;
clone._serverCertificateValidationCallback = _serverCertificateValidationCallback;
return clone;
}
/// <summary>
/// Determines whether the specified <see cref="SslSettings" /> is equal to this instance.
/// </summary>
/// <param name="obj">The <see cref="SslSettings" /> to compare with this instance.</param>
/// <returns>
/// <c>true</c> if the specified <see cref="SslSettings" /> is equal to this instance; otherwise, <c>false</c>.
/// </returns>
public bool Equals(SslSettings obj)
{
return Equals((object)obj); // handles obj == null correctly
}
/// <summary>
/// Determines whether the specified <see cref="System.Object" /> is equal to this instance.
/// </summary>
/// <param name="obj">The <see cref="System.Object" /> to compare with this instance.</param>
/// <returns>
/// <c>true</c> if the specified <see cref="System.Object" /> is equal to this instance; otherwise, <c>false</c>.
/// </returns>
public override bool Equals(object obj)
{
if (object.ReferenceEquals(obj, null) || GetType() != obj.GetType()) { return false; }
var rhs = (SslSettings)obj;
return
_checkCertificateRevocation == rhs._checkCertificateRevocation &&
__certificateCollectionEqualityComparer.Equals(_clientCertificateCollection, rhs._clientCertificateCollection) &&
object.Equals(_clientCertificateSelectionCallback, rhs._clientCertificateSelectionCallback) &&
_enabledSslProtocols == rhs._enabledSslProtocols &&
object.Equals(_serverCertificateValidationCallback, rhs._serverCertificateValidationCallback);
}
/// <summary>
/// Freezes the settings.
/// </summary>
/// <returns>The frozen settings.</returns>
public SslSettings Freeze()
{
if (!_isFrozen)
{
_hashCode = GetHashCode();
_isFrozen = true;
}
return this;
}
/// <summary>
/// Returns a hash code for this instance.
/// </summary>
/// <returns>
/// A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.
/// </returns>
public override int GetHashCode()
{
if (_isFrozen)
{
return _hashCode;
}
return new Hasher()
.Hash(_checkCertificateRevocation)
.HashElements(_clientCertificateCollection?.Cast<object>())
.Hash(_clientCertificateSelectionCallback)
.Hash(_enabledSslProtocols)
.Hash(_serverCertificateValidationCallback)
.GetHashCode();
}
/// <summary>
/// Returns a string representation of the settings.
/// </summary>
/// <returns>A string representation of the settings.</returns>
public override string ToString()
{
var parts = new List<string>();
parts.Add(string.Format("CheckCertificateRevocation={0}", _checkCertificateRevocation));
if (_clientCertificateCollection != null)
{
parts.Add(string.Format("ClientCertificates=[{0}]", string.Join(",", ((IEnumerable)_clientCertificateCollection).Cast<X509Certificate>().Select(c => c.Subject).ToArray())));
}
if (_clientCertificateSelectionCallback != null)
{
parts.Add(string.Format("ClientCertificateSelectionCallback={0}", _clientCertificateSelectionCallback.GetMethodInfo().Name));
}
parts.Add(string.Format("EnabledProtocols={0}", _enabledSslProtocols));
if (_serverCertificateValidationCallback != null)
{
parts.Add(string.Format("ServerCertificateValidationCallback={0}", _serverCertificateValidationCallback.GetMethodInfo().Name));
}
return string.Format("{{{0}}}", string.Join(",", parts.ToArray()));
}
// internal methods
internal SslStreamSettings ToSslStreamSettings()
{
var clientCertificates = _clientCertificateCollection != null ? ((IEnumerable)_clientCertificateCollection).Cast<X509Certificate>() : Enumerable.Empty<X509Certificate>();
return new SslStreamSettings(
checkCertificateRevocation: _checkCertificateRevocation,
clientCertificates: Optional.Create(clientCertificates),
clientCertificateSelectionCallback: _clientCertificateSelectionCallback,
enabledProtocols: _enabledSslProtocols,
serverCertificateValidationCallback: _serverCertificateValidationCallback);
}
// nested classes
private class X509CertificateCollectionEqualityComparer : IEqualityComparer<X509CertificateCollection>
{
public bool Equals(X509CertificateCollection lhs, X509CertificateCollection rhs)
{
if (lhs == null || rhs == null)
{
return rhs == lhs;
}
return ((IEnumerable)lhs).Cast<X509Certificate>().SequenceEqual(((IEnumerable)rhs).Cast<X509Certificate>());
}
public int GetHashCode(X509CertificateCollection obj)
{
if (obj == null)
{
throw new ArgumentNullException("obj");
}
var hash = 17;
foreach (X509Certificate certificate in obj)
{
hash += 37 * hash + certificate.GetHashCode();
}
return hash;
}
}
}
}