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
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
|
/**
* Copyright (C) 2018-present MongoDB, Inc.
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the Server Side Public License, version 1,
* as published by MongoDB, Inc.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* Server Side Public License for more details.
*
* You should have received a copy of the Server Side Public License
* along with this program. If not, see
* <http://www.mongodb.com/licensing/server-side-public-license>.
*
* As a special exception, the copyright holders give permission to link the
* code of portions of this program with the OpenSSL library under certain
* conditions as described in each individual source file and distribute
* linked combinations including the program with the OpenSSL library. You
* must comply with the Server Side Public License in all respects for
* all of the code used other than as permitted herein. If you modify file(s)
* with this exception, you may extend this exception to your version of the
* file(s), but you are not obligated to do so. If you do not wish to do so,
* delete this exception statement from your version. If you delete this
* exception statement from all source files in the program, then also delete
* it in the license file.
*/
#define MONGO_LOG_DEFAULT_COMPONENT ::mongo::logger::LogComponent::kNetwork
#include "mongo/platform/basic.h"
#include "mongo/util/net/ssl_manager.h"
#include <boost/algorithm/string.hpp>
#include <string>
#include <vector>
#include "mongo/base/init.h"
#include "mongo/bson/bsonobjbuilder.h"
#include "mongo/config.h"
#include "mongo/db/commands/server_status.h"
#include "mongo/db/server_parameters.h"
#include "mongo/platform/overflow_arithmetic.h"
#include "mongo/transport/session.h"
#include "mongo/util/hex.h"
#include "mongo/util/icu.h"
#include "mongo/util/log.h"
#include "mongo/util/mongoutils/str.h"
#include "mongo/util/net/ssl_options.h"
#include "mongo/util/text.h"
namespace mongo {
namespace {
// Some of these duplicate the std::isalpha/std::isxdigit because we don't want them to be
// affected by the current locale.
inline bool isAlpha(char ch) {
return (ch >= 'a' && ch <= 'z') || (ch >= 'A' && ch <= 'Z');
}
inline bool isDigit(char ch) {
return (ch >= '0' && ch <= '9');
}
inline bool isHex(char ch) {
return isDigit(ch) || (ch >= 'A' && ch <= 'F') || (ch >= 'a' && ch <= 'f');
}
// This function returns true if the character is supposed to be escaped according to the rules
// in RFC4514. The exception to the RFC the space character ' ' and the '#', because we've not
// required users to escape spaces or sharps in DNs in the past.
inline bool isEscaped(char ch) {
switch (ch) {
case '"':
case '+':
case ',':
case ';':
case '<':
case '>':
case '\\':
return true;
default:
return false;
}
}
// These characters may appear escaped in a string or not, but must not appear as the first
// character.
inline bool isMayBeEscaped(char ch) {
switch (ch) {
case ' ':
case '#':
case '=':
return true;
default:
return false;
}
}
/*
* This class parses out the components of a DN according to RFC4514.
*
* It takes in a StringData to the DN to be parsed, the buffer containing the StringData
* must remain in scope for the duration that it is being parsed.
*/
class RFC4514Parser {
public:
explicit RFC4514Parser(StringData sd) : _str(sd), _it(_str.begin()) {}
std::string extractAttributeName();
enum ValueTerminator {
NewRDN, // The value ended in ','
MultiValue, // The value ended in '+'
Done // The value ended with the end of the string
};
// Returns a decoded string representing one value in an RDN, and the way the value was
// terminated.
std::pair<std::string, ValueTerminator> extractValue();
bool done() const {
return _it == _str.end();
}
void skipSpaces() {
while (!done() && _cur() == ' ') {
_advance();
}
}
private:
char _cur() const {
uassert(51036, "Overflowed string while parsing DN string", !done());
return *_it;
}
char _advance() {
invariant(!done());
++_it;
return done() ? '\0' : _cur();
}
StringData _str;
StringData::const_iterator _it;
};
// Parses an attribute name according to the rules for the "descr" type defined in
// https://tools.ietf.org/html/rfc4512
std::string RFC4514Parser::extractAttributeName() {
StringBuilder sb;
auto ch = _cur();
stdx::function<bool(char ch)> characterCheck;
// If the first character is a digit, then this is an OID and can only contain
// numbers and '.'
if (isDigit(ch)) {
characterCheck = [](char ch) { return (isDigit(ch) || ch == '.'); };
// If the first character is an alpha, then this is a short name and can only
// contain alpha/digit/hyphen characters.
} else if (isAlpha(ch)) {
characterCheck = [](char ch) { return (isAlpha(ch) || isDigit(ch) || ch == '-'); };
// Otherwise this is an invalid attribute name
} else {
uasserted(ErrorCodes::BadValue,
str::stream() << "DN attribute names must begin with either a digit or an alpha"
<< " not \'"
<< ch
<< "\'");
}
for (; ch != '=' && !done(); ch = _advance()) {
if (ch == ' ') {
continue;
}
uassert(ErrorCodes::BadValue,
str::stream() << "DN attribute name contains an invalid character \'" << ch << "\'",
characterCheck(ch));
sb << ch;
}
if (!done()) {
_advance();
}
return sb.str();
}
std::pair<std::string, RFC4514Parser::ValueTerminator> RFC4514Parser::extractValue() {
StringBuilder sb;
// The RFC states the spaces at the beginning and end of the value must be escaped, which
// means we should skip any leading unescaped spaces.
skipSpaces();
// Every time we see an escaped space ("\ "), we increment this counter. Every time we see
// anything non-space character we reset this counter to zero. That way we'll know the number
// of consecutive escaped spaces at the end of the string there are.
int trailingSpaces = 0;
char ch = _cur();
uassert(ErrorCodes::BadValue, "Raw DER sequences are not supported in DN strings", ch != '#');
for (; ch != ',' && ch != '+' && !done(); ch = _advance()) {
if (ch == '\\') {
ch = _advance();
if (isEscaped(ch)) {
sb << ch;
trailingSpaces = 0;
} else if (isHex(ch)) {
const std::array<char, 2> hexValStr = {ch, _advance()};
uassert(ErrorCodes::BadValue,
str::stream() << "Escaped hex value contains invalid character \'"
<< hexValStr[1]
<< "\'",
isHex(hexValStr[1]));
const char hexVal = uassertStatusOK(fromHex(StringData(hexValStr.data(), 2)));
sb << hexVal;
if (hexVal != ' ') {
trailingSpaces = 0;
} else {
trailingSpaces++;
}
} else if (isMayBeEscaped(ch)) {
// It is legal to escape whitespace, but we don't count it as an "escaped"
// character because we don't require it to be escaped within the value, that is
// "C=New York" is legal, and so is "C=New\ York"
//
// The exception is that leading and trailing whitespace must be escaped or else
// it will be trimmed.
sb << ch;
if (ch == ' ') {
trailingSpaces++;
} else {
trailingSpaces = 0;
}
} else {
uasserted(ErrorCodes::BadValue,
str::stream() << "Invalid escaped character \'" << ch << "\'");
}
} else if (isEscaped(ch)) {
uasserted(ErrorCodes::BadValue,
str::stream() << "Found unescaped character that should be escaped: \'" << ch
<< "\'");
} else {
if (ch != ' ') {
trailingSpaces = 0;
}
sb << ch;
}
}
std::string val = sb.str();
// It's legal to have trailing spaces as long as they are escaped, so if we have some trailing
// escaped spaces, trim the size of the string to the last non-space character + the number of
// escaped trailing spaces.
if (trailingSpaces > 0) {
auto lastNonSpace = val.find_last_not_of(' ');
lastNonSpace += trailingSpaces + 1;
val.erase(lastNonSpace);
}
// Consume the + or , character
if (!done()) {
_advance();
}
switch (ch) {
case '+':
return {std::move(val), MultiValue};
case ',':
return {std::move(val), NewRDN};
default:
invariant(done());
return {std::move(val), Done};
}
}
const auto getTLSVersionCounts = ServiceContext::declareDecoration<TLSVersionCounts>();
// These represent the ASN.1 type bytes for strings used in an X509 DirectoryString
constexpr int kASN1UTF8String = 12;
constexpr int kASN1PrintableString = 19;
constexpr int kASN1TeletexString = 20;
constexpr int kASN1UniversalString = 28;
constexpr int kASN1BMPString = 30;
constexpr int kASN1OctetString = 4;
} // namespace
StatusWith<SSLX509Name> parseDN(StringData sd) try {
uassert(ErrorCodes::BadValue, "DN strings must be valid UTF-8 strings", isValidUTF8(sd));
RFC4514Parser parser(sd);
std::vector<std::vector<SSLX509Name::Entry>> entries;
auto curRDN = entries.emplace(entries.end());
while (!parser.done()) {
// Allow spaces to separate RDNs for readability, e.g. "CN=foo, OU=bar, DC=bizz"
parser.skipSpaces();
auto attributeName = parser.extractAttributeName();
auto oid = x509ShortNameToOid(attributeName);
uassert(ErrorCodes::BadValue, str::stream() << "DN contained an unknown OID " << oid, oid);
std::string value;
char terminator;
std::tie(value, terminator) = parser.extractValue();
curRDN->emplace_back(std::move(*oid), kASN1UTF8String, std::move(value));
if (terminator == RFC4514Parser::NewRDN) {
curRDN = entries.emplace(entries.end());
}
}
uassert(ErrorCodes::BadValue,
"Cannot parse empty DN",
entries.size() > 1 || !entries.front().empty());
return SSLX509Name(std::move(entries));
} catch (const DBException& e) {
return e.toStatus();
}
#if MONGO_CONFIG_SSL_PROVIDER == MONGO_CONFIG_SSL_PROVIDER_OPENSSL
// OpenSSL has a more complete library of OID to SN mappings.
std::string x509OidToShortName(StringData name) {
const auto nid = OBJ_txt2nid(name.rawData());
if (nid == 0) {
return name.toString();
}
const auto* sn = OBJ_nid2sn(nid);
if (!sn) {
return name.toString();
}
return sn;
}
boost::optional<std::string> x509ShortNameToOid(StringData name) {
// Converts the OID to an ASN1_OBJECT
const auto obj = OBJ_txt2obj(name.rawData(), 0);
if (!obj) {
return boost::none;
}
// OBJ_obj2txt doesn't let you pass in a NULL buffer and a negative size to discover how
// big the buffer should be, but the man page gives 80 as a good guess for buffer size.
constexpr auto kDefaultBufferSize = 80;
std::vector<char> buffer(kDefaultBufferSize);
size_t realSize = OBJ_obj2txt(buffer.data(), buffer.size(), obj, 1);
// Resize the buffer down or up to the real size.
buffer.resize(realSize);
// If the real size is greater than the default buffer size we picked, then just call
// OBJ_obj2txt again now that the buffer is correctly sized.
if (realSize > kDefaultBufferSize) {
OBJ_obj2txt(buffer.data(), buffer.size(), obj, 1);
}
return std::string(buffer.data(), buffer.size());
}
#else
// On Apple/Windows we have to provide our own mapping.
// Generate the 2.5.4.* portions of this list from OpenSSL sources with:
// grep -E '^X509 ' "$OPENSSL/crypto/objects/objects.txt" | tr -d '\t' |
// sed -e 's/^X509 *\([0-9]\+\) *\(: *\)\+\([[:alnum:]]\+\).*/{"2.5.4.\1", "\3"},/g'
static const std::initializer_list<std::pair<StringData, StringData>> kX509OidToShortNameMappings =
{
{"0.9.2342.19200300.100.1.1"_sd, "UID"_sd},
{"0.9.2342.19200300.100.1.25"_sd, "DC"_sd},
{"1.2.840.113549.1.9.1"_sd, "emailAddress"_sd},
{"2.5.29.17"_sd, "subjectAltName"_sd},
// X509 OIDs Generated from objects.txt
{"2.5.4.3"_sd, "CN"_sd},
{"2.5.4.4"_sd, "SN"_sd},
{"2.5.4.5"_sd, "serialNumber"_sd},
{"2.5.4.6"_sd, "C"_sd},
{"2.5.4.7"_sd, "L"_sd},
{"2.5.4.8"_sd, "ST"_sd},
{"2.5.4.9"_sd, "street"_sd},
{"2.5.4.10"_sd, "O"_sd},
{"2.5.4.11"_sd, "OU"_sd},
{"2.5.4.12"_sd, "title"_sd},
{"2.5.4.13"_sd, "description"_sd},
{"2.5.4.14"_sd, "searchGuide"_sd},
{"2.5.4.15"_sd, "businessCategory"_sd},
{"2.5.4.16"_sd, "postalAddress"_sd},
{"2.5.4.17"_sd, "postalCode"_sd},
{"2.5.4.18"_sd, "postOfficeBox"_sd},
{"2.5.4.19"_sd, "physicalDeliveryOfficeName"_sd},
{"2.5.4.20"_sd, "telephoneNumber"_sd},
{"2.5.4.21"_sd, "telexNumber"_sd},
{"2.5.4.22"_sd, "teletexTerminalIdentifier"_sd},
{"2.5.4.23"_sd, "facsimileTelephoneNumber"_sd},
{"2.5.4.24"_sd, "x121Address"_sd},
{"2.5.4.25"_sd, "internationaliSDNNumber"_sd},
{"2.5.4.26"_sd, "registeredAddress"_sd},
{"2.5.4.27"_sd, "destinationIndicator"_sd},
{"2.5.4.28"_sd, "preferredDeliveryMethod"_sd},
{"2.5.4.29"_sd, "presentationAddress"_sd},
{"2.5.4.30"_sd, "supportedApplicationContext"_sd},
{"2.5.4.31"_sd, "member"_sd},
{"2.5.4.32"_sd, "owner"_sd},
{"2.5.4.33"_sd, "roleOccupant"_sd},
{"2.5.4.34"_sd, "seeAlso"_sd},
{"2.5.4.35"_sd, "userPassword"_sd},
{"2.5.4.36"_sd, "userCertificate"_sd},
{"2.5.4.37"_sd, "cACertificate"_sd},
{"2.5.4.38"_sd, "authorityRevocationList"_sd},
{"2.5.4.39"_sd, "certificateRevocationList"_sd},
{"2.5.4.40"_sd, "crossCertificatePair"_sd},
{"2.5.4.41"_sd, "name"_sd},
{"2.5.4.42"_sd, "GN"_sd},
{"2.5.4.43"_sd, "initials"_sd},
{"2.5.4.44"_sd, "generationQualifier"_sd},
{"2.5.4.45"_sd, "x500UniqueIdentifier"_sd},
{"2.5.4.46"_sd, "dnQualifier"_sd},
{"2.5.4.47"_sd, "enhancedSearchGuide"_sd},
{"2.5.4.48"_sd, "protocolInformation"_sd},
{"2.5.4.49"_sd, "distinguishedName"_sd},
{"2.5.4.50"_sd, "uniqueMember"_sd},
{"2.5.4.51"_sd, "houseIdentifier"_sd},
{"2.5.4.52"_sd, "supportedAlgorithms"_sd},
{"2.5.4.53"_sd, "deltaRevocationList"_sd},
{"2.5.4.54"_sd, "dmdName"_sd},
{"2.5.4.65"_sd, "pseudonym"_sd},
{"2.5.4.72"_sd, "role"_sd},
};
std::string x509OidToShortName(StringData oid) {
auto it = std::find_if(
kX509OidToShortNameMappings.begin(),
kX509OidToShortNameMappings.end(),
[&](const std::pair<StringData, StringData>& entry) { return entry.first == oid; });
if (it == kX509OidToShortNameMappings.end()) {
return oid.toString();
}
return it->second.toString();
}
boost::optional<std::string> x509ShortNameToOid(StringData name) {
auto it = std::find_if(
kX509OidToShortNameMappings.begin(),
kX509OidToShortNameMappings.end(),
[&](const std::pair<StringData, StringData>& entry) { return entry.second == name; });
if (it == kX509OidToShortNameMappings.end()) {
// If the name is a known oid in our mapping list then just return it.
if (std::find_if(kX509OidToShortNameMappings.begin(),
kX509OidToShortNameMappings.end(),
[&](const auto& entry) { return entry.first == name; }) !=
kX509OidToShortNameMappings.end()) {
return name.toString();
}
return boost::none;
}
return it->first.toString();
}
#endif
TLSVersionCounts& TLSVersionCounts::get(ServiceContext* serviceContext) {
return getTLSVersionCounts(serviceContext);
}
MONGO_INITIALIZER_WITH_PREREQUISITES(SSLManagerLogger, ("SSLManager", "GlobalLogManager"))
(InitializerContext*) {
if (!isSSLServer || (sslGlobalParams.sslMode.load() != SSLParams::SSLMode_disabled)) {
const auto& config = getSSLManager()->getSSLConfiguration();
if (!config.clientSubjectName.empty()) {
LOG(1) << "Client Certificate Name: " << config.clientSubjectName;
}
if (!config.serverSubjectName().empty()) {
LOG(1) << "Server Certificate Name: " << config.serverSubjectName();
LOG(1) << "Server Certificate Expiration: " << config.serverCertificateExpirationDate;
}
}
return Status::OK();
}
Status SSLX509Name::normalizeStrings() {
for (auto& rdn : _entries) {
for (auto& entry : rdn) {
switch (entry.type) {
// For each type of valid DirectoryString, do the string prep algorithm.
case kASN1UTF8String:
case kASN1PrintableString:
case kASN1TeletexString:
case kASN1UniversalString:
case kASN1BMPString:
case kASN1OctetString: {
auto res = icuX509DNPrep(entry.value);
if (!res.isOK()) {
return res.getStatus();
}
entry.value = std::move(res.getValue());
entry.type = kASN1UTF8String;
break;
}
}
}
}
return Status::OK();
}
StatusWith<std::string> SSLX509Name::getOID(StringData oid) const {
for (const auto& rdn : _entries) {
for (const auto& entry : rdn) {
if (entry.oid == oid) {
return entry.value;
}
}
}
return {ErrorCodes::KeyNotFound, "OID does not exist"};
}
StringBuilder& operator<<(StringBuilder& os, const SSLX509Name& name) {
std::string comma;
for (const auto& rdn : name._entries) {
std::string plus;
os << comma;
for (const auto& entry : rdn) {
os << plus << x509OidToShortName(entry.oid) << "=" << escapeRfc2253(entry.value);
plus = "+";
}
comma = ",";
}
return os;
}
std::string SSLX509Name::toString() const {
StringBuilder os;
os << *this;
return os.str();
}
namespace {
void canonicalizeClusterDN(std::vector<std::string>* dn) {
// remove all RDNs we don't care about
for (size_t i = 0; i < dn->size(); i++) {
std::string& comp = dn->at(i);
boost::algorithm::trim(comp);
if (!mongoutils::str::startsWith(comp.c_str(), "DC=") &&
!mongoutils::str::startsWith(comp.c_str(), "O=") &&
!mongoutils::str::startsWith(comp.c_str(), "OU=")) {
dn->erase(dn->begin() + i);
i--;
}
}
std::stable_sort(dn->begin(), dn->end());
}
constexpr StringData kOID_DC = "0.9.2342.19200300.100.1.25"_sd;
constexpr StringData kOID_O = "2.5.4.10"_sd;
constexpr StringData kOID_OU = "2.5.4.11"_sd;
std::vector<SSLX509Name::Entry> canonicalizeClusterDN(
const std::vector<std::vector<SSLX509Name::Entry>>& entries) {
std::vector<SSLX509Name::Entry> ret;
for (const auto& rdn : entries) {
for (const auto& entry : rdn) {
if ((entry.oid != kOID_DC) && (entry.oid != kOID_O) && (entry.oid != kOID_OU)) {
continue;
}
ret.push_back(entry);
}
}
std::stable_sort(ret.begin(), ret.end());
return ret;
}
} // namespace
Status SSLConfiguration::setServerSubjectName(SSLX509Name name) {
auto status = name.normalizeStrings();
if (!status.isOK()) {
return status;
}
_serverSubjectName = std::move(name);
_canonicalServerSubjectName = canonicalizeClusterDN(_serverSubjectName.entries());
return Status::OK();
}
/**
* The behavior of isClusterMember() is subtly different when passed
* an SSLX509Name versus a StringData.
*
* The SSLX509Name version (immediately below) compares distinguished
* names in their normalized, unescaped forms and provides a more reliable match.
*
* The StringData version attempts to canonicalize the stringified subject name
* according to RFC4514 and compare that to the normalized/unescaped version of
* the server's distinguished name.
*/
bool SSLConfiguration::isClusterMember(SSLX509Name subject) const {
if (!subject.normalizeStrings().isOK()) {
return false;
}
auto client = canonicalizeClusterDN(subject.entries());
return !client.empty() && (client == _canonicalServerSubjectName);
}
bool SSLConfiguration::isClusterMember(StringData subjectName) const {
auto swClient = parseDN(subjectName);
if (!swClient.isOK()) {
warning() << "Unable to parse client subject name: " << swClient.getStatus();
return false;
}
auto& client = swClient.getValue();
auto status = client.normalizeStrings();
if (!status.isOK()) {
warning() << "Unable to normalize client subject name: " << status;
return false;
}
auto canonicalClient = canonicalizeClusterDN(client.entries());
return !canonicalClient.empty() && (canonicalClient == _canonicalServerSubjectName);
}
BSONObj SSLConfiguration::getServerStatusBSON() const {
BSONObjBuilder security;
security.append("SSLServerSubjectName", _serverSubjectName.toString());
security.appendBool("SSLServerHasCertificateAuthority", hasCA);
security.appendDate("SSLServerCertificateExpirationDate", serverCertificateExpirationDate);
return security.obj();
}
SSLManagerInterface::~SSLManagerInterface() {}
SSLConnectionInterface::~SSLConnectionInterface() {}
namespace {
/**
* Enum of supported Abstract Syntax Notation One (ASN.1) Distinguished Encoding Rules (DER) types.
*
* This is a subset of all DER types.
*/
enum class DERType : char {
// Primitive, not supported by the parser
// Only exists when BER indefinite form is used which is not valid DER.
EndOfContent = 0,
// Primitive
UTF8String = 12,
// Sequence or Sequence Of, Constructed
SEQUENCE = 16,
// Set or Set Of, Constructed
SET = 17,
};
/**
* Distinguished Encoding Rules (DER) are a strict subset of Basic Encoding Rules (BER).
*
* For more details, see X.690 from ITU-T.
*
* It is a Tag + Length + Value format. The tag is generally 1 byte, the length is 1 or more
* and then followed by the value.
*/
class DERToken {
public:
DERToken() {}
DERToken(DERType type, size_t length, const char* const data)
: _type(type), _length(length), _data(data) {}
/**
* Get the ASN.1 type of the current token.
*/
DERType getType() const {
return _type;
}
/**
* Get a ConstDataRange for the value of this SET or SET OF.
*/
ConstDataRange getSetRange() {
invariant(_type == DERType::SET);
return ConstDataRange(_data, _data + _length);
}
/**
* Get a ConstDataRange for the value of this SEQUENCE or SEQUENCE OF.
*/
ConstDataRange getSequenceRange() {
invariant(_type == DERType::SEQUENCE);
return ConstDataRange(_data, _data + _length);
}
/**
* Get a std::string for the value of this Utf8String.
*/
std::string readUtf8String() {
invariant(_type == DERType::UTF8String);
return std::string(_data, _length);
}
/**
* Parse a buffer of bytes and return the number of bytes we read for this token.
*
* Returns a DERToken which consists of the (tag, length, value) tuple.
*/
static StatusWith<DERToken> parse(ConstDataRange cdr, size_t* outLength);
private:
DERType _type{DERType::EndOfContent};
size_t _length{0};
const char* _data{nullptr};
};
} // namespace
template <>
struct DataType::Handler<DERToken> {
static Status load(DERToken* t,
const char* ptr,
size_t length,
size_t* advanced,
std::ptrdiff_t debug_offset) {
size_t outLength;
auto swPair = DERToken::parse(ConstDataRange(ptr, length), &outLength);
if (!swPair.isOK()) {
return swPair.getStatus();
}
if (t) {
*t = std::move(swPair.getValue());
}
if (advanced) {
*advanced = outLength;
}
return Status::OK();
}
static DERToken defaultConstruct() {
return DERToken();
}
};
namespace {
StatusWith<std::string> readDERString(ConstDataRangeCursor& cdc) {
auto swString = cdc.readAndAdvance<DERToken>();
if (!swString.isOK()) {
return swString.getStatus();
}
auto derString = swString.getValue();
if (derString.getType() != DERType::UTF8String) {
return Status(ErrorCodes::InvalidSSLConfiguration,
str::stream() << "Unexpected DER Tag, Got "
<< static_cast<char>(derString.getType())
<< ", Expected UTF8String");
}
return derString.readUtf8String();
}
StatusWith<DERToken> DERToken::parse(ConstDataRange cdr, size_t* outLength) {
const size_t kTagLength = 1;
const size_t kTagLengthAndInitialLengthByteLength = kTagLength + 1;
ConstDataRangeCursor cdrc(cdr);
auto swTagByte = cdrc.readAndAdvance<char>();
if (!swTagByte.getStatus().isOK()) {
return swTagByte.getStatus();
}
const char tagByte = swTagByte.getValue();
// Get the tag number from the first 5 bits
const char tag = tagByte & 0x1f;
// Check the 6th bit
const bool constructed = tagByte & 0x20;
const bool primitive = !constructed;
// Check bits 7 and 8 for the tag class, we only want Universal (i.e. 0)
const char tagClass = tagByte & 0xC0;
if (tagClass != 0) {
return Status(ErrorCodes::InvalidSSLConfiguration, "Unsupported tag class");
}
// Validate the 6th bit is correct, and it is a known type
switch (static_cast<DERType>(tag)) {
case DERType::UTF8String:
if (!primitive) {
return Status(ErrorCodes::InvalidSSLConfiguration, "Unknown DER tag");
}
break;
case DERType::SEQUENCE:
case DERType::SET:
if (!constructed) {
return Status(ErrorCodes::InvalidSSLConfiguration, "Unknown DER tag");
}
break;
default:
return Status(ErrorCodes::InvalidSSLConfiguration, "Unknown DER tag");
}
// Do we have at least 1 byte for the length
if (cdrc.length() < kTagLengthAndInitialLengthByteLength) {
return Status(ErrorCodes::InvalidSSLConfiguration, "Invalid DER length");
}
// Read length
// Depending on the high bit, either read 1 byte or N bytes
auto swInitialLengthByte = cdrc.readAndAdvance<char>();
if (!swInitialLengthByte.getStatus().isOK()) {
return swInitialLengthByte.getStatus();
}
const char initialLengthByte = swInitialLengthByte.getValue();
uint64_t derLength = 0;
// How many bytes does it take to encode the length?
size_t encodedLengthBytesCount = 1;
if (initialLengthByte & 0x80) {
// Length is > 127 bytes, i.e. Long form of length
const size_t lengthBytesCount = 0x7f & initialLengthByte;
// If length is encoded in more then 8 bytes, we disallow it
if (lengthBytesCount > 8) {
return Status(ErrorCodes::InvalidSSLConfiguration, "Invalid DER length");
}
// Ensure we have enough data for the length bytes
const char* lengthLongFormPtr = cdrc.data();
Status statusLength = cdrc.advance(lengthBytesCount);
if (!statusLength.isOK()) {
return statusLength;
}
encodedLengthBytesCount = 1 + lengthBytesCount;
std::array<char, 8> lengthBuffer;
lengthBuffer.fill(0);
// Copy the length into the end of the buffer
memcpy(lengthBuffer.data() + (8 - lengthBytesCount), lengthLongFormPtr, lengthBytesCount);
// We now have 0x00..NN in the buffer and it can be properly decoded as BigEndian
derLength = ConstDataView(lengthBuffer.data()).read<BigEndian<uint64_t>>();
} else {
// Length is <= 127 bytes, i.e. short form of length
derLength = initialLengthByte;
}
// This is the total length of the TLV and all data
// This will not overflow since encodedLengthBytesCount <= 9
const uint64_t tagAndLengthByteCount = kTagLength + encodedLengthBytesCount;
// This may overflow since derLength is from user data so check our arithmetic carefully.
if (mongoUnsignedAddOverflow64(tagAndLengthByteCount, derLength, outLength) ||
*outLength > cdr.length()) {
return Status(ErrorCodes::InvalidSSLConfiguration, "Invalid DER length");
}
return DERToken(static_cast<DERType>(tag), derLength, cdr.data() + tagAndLengthByteCount);
}
} // namespace
StatusWith<stdx::unordered_set<RoleName>> parsePeerRoles(ConstDataRange cdrExtension) {
stdx::unordered_set<RoleName> roles;
ConstDataRangeCursor cdcExtension(cdrExtension);
/**
* MongoDBAuthorizationGrants ::= SET OF MongoDBAuthorizationGrant
*
* MongoDBAuthorizationGrant ::= CHOICE {
* MongoDBRole,
* ...!UTF8String:"Unrecognized entity in MongoDBAuthorizationGrant"
* }
*/
auto swSet = cdcExtension.readAndAdvance<DERToken>();
if (!swSet.isOK()) {
return swSet.getStatus();
}
if (swSet.getValue().getType() != DERType::SET) {
return Status(ErrorCodes::InvalidSSLConfiguration,
str::stream() << "Unexpected DER Tag, Got "
<< static_cast<char>(swSet.getValue().getType())
<< ", Expected SET");
}
ConstDataRangeCursor cdcSet(swSet.getValue().getSetRange());
while (!cdcSet.empty()) {
/**
* MongoDBRole ::= SEQUENCE {
* role UTF8String,
* database UTF8String
* }
*/
auto swSequence = cdcSet.readAndAdvance<DERToken>();
if (!swSequence.isOK()) {
return swSequence.getStatus();
}
auto sequenceStart = swSequence.getValue();
if (sequenceStart.getType() != DERType::SEQUENCE) {
return Status(ErrorCodes::InvalidSSLConfiguration,
str::stream() << "Unexpected DER Tag, Got "
<< static_cast<char>(sequenceStart.getType())
<< ", Expected SEQUENCE");
}
ConstDataRangeCursor cdcSequence(sequenceStart.getSequenceRange());
auto swRole = readDERString(cdcSequence);
if (!swRole.isOK()) {
return swRole.getStatus();
}
auto swDatabase = readDERString(cdcSequence);
if (!swDatabase.isOK()) {
return swDatabase.getStatus();
}
roles.emplace(swRole.getValue(), swDatabase.getValue());
}
return roles;
}
std::string removeFQDNRoot(std::string name) {
if (name.back() == '.') {
name.pop_back();
}
return name;
};
namespace {
// Characters that need to be escaped in RFC 2253
const std::array<char, 7> rfc2253EscapeChars = {',', '+', '"', '\\', '<', '>', ';'};
} // namespace
// See section "2.4 Converting an AttributeValue from ASN.1 to a String" in RFC 2243
std::string escapeRfc2253(StringData str) {
std::string ret;
if (str.size() > 0) {
size_t pos = 0;
// a space or "#" character occurring at the beginning of the string
if (str[0] == ' ') {
ret = "\\ ";
pos = 1;
} else if (str[0] == '#') {
ret = "\\#";
pos = 1;
}
while (pos < str.size()) {
if (static_cast<signed char>(str[pos]) < 0) {
ret += '\\';
ret += integerToHex(str[pos]);
} else {
if (std::find(rfc2253EscapeChars.cbegin(), rfc2253EscapeChars.cend(), str[pos]) !=
rfc2253EscapeChars.cend()) {
ret += '\\';
}
ret += str[pos];
}
++pos;
}
// a space character occurring at the end of the string
if (ret.size() > 2 && ret[ret.size() - 1] == ' ') {
ret[ret.size() - 1] = '\\';
ret += ' ';
}
}
return ret;
}
namespace {
/**
* Status section of which tls versions connected to MongoDB and completed an SSL handshake.
* Note: Clients are only not counted if they try to connect to the server with a unsupported TLS
* version. They are still counted if the server rejects them for certificate issues in
* parseAndValidatePeerCertificate.
*/
class TLSVersionSatus : public ServerStatusSection {
public:
TLSVersionSatus() : ServerStatusSection("transportSecurity") {}
bool includeByDefault() const override {
return true;
}
BSONObj generateSection(OperationContext* opCtx,
const BSONElement& configElement) const override {
auto& counts = TLSVersionCounts::get(opCtx->getServiceContext());
BSONObjBuilder builder;
builder.append("1.0", counts.tls10.load());
builder.append("1.1", counts.tls11.load());
builder.append("1.2", counts.tls12.load());
builder.append("1.3", counts.tls13.load());
builder.append("unknown", counts.tlsUnknown.load());
return builder.obj();
}
} tlsVersionStatus;
} // namespace
void recordTLSVersion(TLSVersion version, const HostAndPort& hostForLogging) {
StringData versionString;
auto& counts = mongo::TLSVersionCounts::get(getGlobalServiceContext());
switch (version) {
case TLSVersion::kTLS10:
counts.tls10.addAndFetch(1);
if (std::find(sslGlobalParams.tlsLogVersions.cbegin(),
sslGlobalParams.tlsLogVersions.cend(),
SSLParams::Protocols::TLS1_0) != sslGlobalParams.tlsLogVersions.cend()) {
versionString = "1.0"_sd;
}
break;
case TLSVersion::kTLS11:
counts.tls11.addAndFetch(1);
if (std::find(sslGlobalParams.tlsLogVersions.cbegin(),
sslGlobalParams.tlsLogVersions.cend(),
SSLParams::Protocols::TLS1_1) != sslGlobalParams.tlsLogVersions.cend()) {
versionString = "1.1"_sd;
}
break;
case TLSVersion::kTLS12:
counts.tls12.addAndFetch(1);
if (std::find(sslGlobalParams.tlsLogVersions.cbegin(),
sslGlobalParams.tlsLogVersions.cend(),
SSLParams::Protocols::TLS1_2) != sslGlobalParams.tlsLogVersions.cend()) {
versionString = "1.2"_sd;
}
break;
case TLSVersion::kTLS13:
counts.tls13.addAndFetch(1);
if (std::find(sslGlobalParams.tlsLogVersions.cbegin(),
sslGlobalParams.tlsLogVersions.cend(),
SSLParams::Protocols::TLS1_3) != sslGlobalParams.tlsLogVersions.cend()) {
versionString = "1.3"_sd;
}
break;
default:
counts.tlsUnknown.addAndFetch(1);
if (!sslGlobalParams.tlsLogVersions.empty()) {
versionString = "unknown"_sd;
}
break;
}
if (!versionString.empty()) {
log() << "Accepted connection with TLS Version " << versionString << " from connection "
<< hostForLogging;
}
}
} // namespace mongo
// TODO SERVER-11601 Use NFC Unicode canonicalization
bool mongo::hostNameMatchForX509Certificates(std::string nameToMatch, std::string certHostName) {
nameToMatch = removeFQDNRoot(std::move(nameToMatch));
certHostName = removeFQDNRoot(std::move(certHostName));
if (certHostName.size() < 2) {
return false;
}
// match wildcard DNS names
if (certHostName[0] == '*' && certHostName[1] == '.') {
// allow name.example.com if the cert is *.example.com, '*' does not match '.'
const char* subName = strchr(nameToMatch.c_str(), '.');
return subName && !strcasecmp(certHostName.c_str() + 1, subName);
} else {
return !strcasecmp(nameToMatch.c_str(), certHostName.c_str());
}
}
|