summaryrefslogtreecommitdiff
path: root/src/mongo/util/net/ssl_options_client.cpp
blob: 36a34325cb1c95b18520af6d046b330ca2d1c471 (plain)
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

/**
 *    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.
 */

#include "mongo/platform/basic.h"

#include "mongo/util/net/ssl_options.h"

#include <boost/filesystem/operations.hpp>

#include "mongo/base/status.h"
#include "mongo/config.h"
#include "mongo/util/options_parser/startup_option_init.h"
#include "mongo/util/options_parser/startup_options.h"

#if MONGO_CONFIG_SSL_PROVIDER == MONGO_CONFIG_SSL_PROVIDER_OPENSSL
#include <openssl/ssl.h>
#endif

using namespace mongo;
namespace moe = mongo::optionenvironment;
using std::string;

namespace {
MONGO_GENERAL_STARTUP_OPTIONS_REGISTER(SSLClientOptions)(InitializerContext*) {
    auto& options = moe::startupOptions;

    options.addOptionChaining(
        "tls", "tls", moe::Switch, "use TLS for all connections", {"ssl"}, {"ssl"});

    options
        .addOptionChaining("tls.CAFile",
                           "tlsCAFile",
                           moe::String,
                           "Certificate Authority file for TLS",
                           {"ssl.CAFile"},
                           {"sslCAFile"})
        .requires("tls");

    options
        .addOptionChaining("tls.PEMKeyFile",
                           "tlsPEMKeyFile",
                           moe::String,
                           "PEM certificate/key file for TLS",
                           {"ssl.PEMKeyFile"},
                           {"sslPEMKeyFile"})
        .requires("tls");

    options
        .addOptionChaining("tls.PEMKeyPassword",
                           "tlsPEMKeyPassword",
                           moe::String,
                           "Password for key in PEM file for TLS",
                           {"ssl.PEMKeyPassword"},
                           {"sslPEMKeyPassword"})
        .requires("tls");

    options
        .addOptionChaining("tls.CRLFile",
                           "tlsCRLFile",
                           moe::String,
                           "Certificate Revocation List file for TLS",
                           {"ssl.CRLFile"},
                           {"sslCRLFile"})
        .requires("tls")
        .requires("tls.CAFile");

    options
        .addOptionChaining("net.tls.allowInvalidHostnames",
                           "tlsAllowInvalidHostnames",
                           moe::Switch,
                           "Allow connections to servers with non-matching hostnames",
                           {"net.ssl.allowInvalidHostnames"},
                           {"sslAllowInvalidHostnames"})
        .requires("tls");

    options
        .addOptionChaining("tls.allowInvalidCertificates",
                           "tlsAllowInvalidCertificates",
                           moe::Switch,
                           "Allow connections to servers with invalid certificates",
                           {"ssl.allowInvalidCertificates"},
                           {"sslAllowInvalidCertificates"})
        .requires("tls");

    options.addOptionChaining("tls.FIPSMode",
                              "tlsFIPSMode",
                              moe::Switch,
                              "Activate FIPS 140-2 mode at startup",
                              {"ssl.FIPSMode"},
                              {"sslFIPSMode"});

#ifdef MONGO_CONFIG_SSL_CERTIFICATE_SELECTORS
    options
        .addOptionChaining("tls.certificateSelector",
                           "tlsCertificateSelector",
                           moe::String,
                           "TLS Certificate in system store",
                           {"ssl.certificateSelector"},
                           {"sslCertificateSelector"})
        .incompatibleWith("tls.PEMKeyFile")
        .incompatibleWith("tls.PEMKeyPassword");
#endif

    options.addOptionChaining(
        "tls.disabledProtocols",
        "tlsDisabledProtocols",
        moe::String,
        "Comma separated list of TLS protocols to disable [TLS1_0,TLS1_1,TLS1_2]",
        {"ssl.disabledProtocols"},
        {"sslDisabledProtocols"});

    return Status::OK();
}

MONGO_STARTUP_OPTIONS_STORE(SSLClientOptions)(InitializerContext*) {
    const auto& params = moe::startupOptionsParsed;

    if (params.count("tls") && params["tls"].as<bool>() == true) {
        sslGlobalParams.sslMode.store(SSLParams::SSLMode_requireSSL);
    }

    if (params.count("tls.PEMKeyFile")) {
        sslGlobalParams.sslPEMKeyFile = params["tls.PEMKeyFile"].as<std::string>();
    }

    if (params.count("tls.PEMKeyPassword")) {
        sslGlobalParams.sslPEMKeyPassword = params["tls.PEMKeyPassword"].as<std::string>();
    }

    if (params.count("tls.CAFile")) {
        sslGlobalParams.sslCAFile = params["tls.CAFile"].as<std::string>();
    }

    if (params.count("tls.CRLFile")) {
        sslGlobalParams.sslCRLFile = params["tls.CRLFile"].as<std::string>();
    }


    if (params.count("net.tls.allowInvalidHostnames")) {
        sslGlobalParams.sslAllowInvalidHostnames =
            params["net.tls.allowInvalidHostnames"].as<bool>();
    }

    if (params.count("tls.allowInvalidCertificates")) {
        sslGlobalParams.sslAllowInvalidCertificates = true;
    }

    if (params.count("tls.FIPSMode")) {
        sslGlobalParams.sslFIPSMode = true;
    }

    if (params.count("tls.disabledProtocols")) {
        const auto status =
            storeSSLDisabledProtocols(params["tls.disabledProtocols"].as<std::string>());
        if (!status.isOK()) {
            return status;
        }
#if ((MONGO_CONFIG_SSL_PROVIDER != MONGO_CONFIG_SSL_PROVIDER_OPENSSL) || \
     (OPENSSL_VERSION_NUMBER >= 0x100000cf)) /* 1.0.0l */
    } else {
        /* Similar to the server setting above, we auto-disable TLS 1.0
         * for shell clients which support TLS 1.1 and later.
         * Unlike above, we don't have a blanket exception for Apple,
         * since the reason for supporting external tooling does not apply.
         *
         * We also skip logging to keep the spam away from the interactive client op.
         */
        sslGlobalParams.sslDisabledProtocols.push_back(SSLParams::Protocols::TLS1_0);
#endif
    }

#ifdef MONGO_CONFIG_SSL_CERTIFICATE_SELECTORS
    if (params.count("tls.certificateSelector")) {
        const auto status =
            parseCertificateSelector(&sslGlobalParams.sslCertificateSelector,
                                     "tls.certificateSelector",
                                     params["tls.certificateSelector"].as<std::string>());
        if (!status.isOK()) {
            return status;
        }
    }
#endif

    return Status::OK();
}

}  // namespace