summaryrefslogtreecommitdiff
path: root/src/mongo/db/server_options.cpp
blob: c3d2ecb0f9c1bbd6388d6c99179888da660acbf0 (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
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
/*
 *    Copyright (C) 2013 10gen Inc.
 *
 *    This program is free software: you can redistribute it and/or  modify
 *    it under the terms of the GNU Affero General Public License, version 3,
 *    as published by the Free Software Foundation.
 *
 *    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
 *    GNU Affero General Public License for more details.
 *
 *    You should have received a copy of the GNU Affero General Public License
 *    along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 *    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 GNU Affero General 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/db/server_options.h"

#include "mongo/base/status.h"
#include "mongo/bson/util/builder.h"
#include "mongo/db/cmdline.h" // For CmdLine::DefaultDBPort
#include "mongo/util/net/listen.h" // For DEFAULT_MAX_CONN
#include "mongo/util/options_parser/option_description.h"
#include "mongo/util/options_parser/option_section.h"

namespace mongo {

    typedef moe::OptionDescription OD;
    typedef moe::PositionalOptionDescription POD;

    Status addGeneralServerOptions(moe::OptionSection* options) {
        StringBuilder portInfoBuilder;
        StringBuilder maxConnInfoBuilder;

        portInfoBuilder << "specify port number - " << CmdLine::DefaultDBPort << " by default";
        maxConnInfoBuilder << "max number of simultaneous connections - "
                           << DEFAULT_MAX_CONN << " by default";

        Status ret = options->addOption(OD("help", "help,h", moe::Switch,
                    "show this usage information", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("version", "version", moe::Switch, "show version information",
                    true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("config", "config,f", moe::String,
                    "configuration file specifying additional options", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("verbose", "verbose,v", moe::Switch,
                    "be more verbose (include multiple times for more verbosity e.g. -vvvvv)",
                    true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("quiet", "quiet", moe::Switch, "quieter output", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("port", "port", moe::Int, portInfoBuilder.str().c_str(), true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("bind_ip", "bind_ip", moe::String,
                    "comma separated list of ip addresses to listen on - all local ips by default",
                    true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("maxConns", "maxConns", moe::Int,
                    maxConnInfoBuilder.str().c_str(), true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("logpath", "logpath", moe::String,
                    "log file to send write to instead of stdout - has to be a file, not directory",
                    true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("logappend", "logappend", moe::Switch,
                    "append to logpath instead of over-writing", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("logTimestampFormat", "logTimestampFormat", moe::String,
                    "Desired format for timestamps in log messages. One of ctime, "
                    "iso8601-utc or iso8601-local", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("pidfilepath", "pidfilepath", moe::String,
                    "full path to pidfile (if not set, no pidfile is created)", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("keyFile", "keyFile", moe::String,
                    "private key for cluster authentication", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("setParameter", "setParameter", moe::StringVector,
                    "Set a configurable parameter", true, moe::Value(), moe::Value(), true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("httpinterface", "httpinterface", moe::Switch,
                    "enable http interface", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("clusterAuthMode", "clusterAuthMode", moe::String,
                    "Authentication mode used for cluster authentication. Alternatives are "
                    "(keyfile|sendKeyfile|sendX509|x509)", true));
        if (!ret.isOK()) {
            return ret;
        }
#ifndef _WIN32
        ret = options->addOption(OD("nounixsocket", "nounixsocket", moe::Switch,
                    "disable listening on unix sockets", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("unixSocketPrefix", "unixSocketPrefix", moe::String,
                    "alternative directory for UNIX domain sockets (defaults to /tmp)", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("fork", "fork", moe::Switch, "fork server process", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("syslog", "syslog", moe::Switch,
                    "log to system's syslog facility instead of file or stdout", true));
        if (!ret.isOK()) {
            return ret;
        }
#endif

        /* support for -vv -vvvv etc. */
        for (string s = "vv"; s.length() <= 12; s.append("v")) {
            ret = options->addOption(OD(s.c_str(), s.c_str(), moe::Switch, "verbose", false));
            if(!ret.isOK()) {
                return ret;
            }
        }

        // Extra hidden options
        ret = options->addOption(OD("nohttpinterface", "nohttpinterface", moe::Switch,
                    "disable http interface", false));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("objcheck", "objcheck", moe::Switch,
                    "inspect client data for validity on receipt (DEFAULT)", false));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("noobjcheck", "noobjcheck", moe::Switch,
                    "do NOT inspect client data for validity on receipt", false));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("traceExceptions", "traceExceptions", moe::Switch,
                    "log stack traces for every exception", false));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("enableExperimentalIndexStatsCmd",
                    "enableExperimentalIndexStatsCmd", moe::Switch,
                    "EXPERIMENTAL (UNSUPPORTED). "
                    "Enable command computing aggregate statistics on indexes.", false));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("enableExperimentalStorageDetailsCmd",
                    "enableExperimentalStorageDetailsCmd", moe::Switch,
                    "EXPERIMENTAL (UNSUPPORTED). "
                    "Enable command computing aggregate statistics on storage.", false));
        if (!ret.isOK()) {
            return ret;
        }

        return Status::OK();
    }

    Status addWindowsServerOptions(moe::OptionSection* options) {
        Status ret = options->addOption(OD("install", "install", moe::Switch,
                    "install Windows service", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("remove", "remove", moe::Switch, "remove Windows service",
                    true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("reinstall", "reinstall", moe::Switch,
                    "reinstall Windows service (equivalent to --remove followed by --install)",
                    true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("serviceName", "serviceName", moe::String,
                    "Windows service name", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("serviceDisplayName", "serviceDisplayName", moe::String,
                    "Windows service display name", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("serviceDescription", "serviceDescription", moe::String,
                    "Windows service description", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("serviceUser", "serviceUser", moe::String,
                    "account for service execution", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("servicePassword", "servicePassword", moe::String,
                    "password used to authenticate serviceUser", true));
        if (!ret.isOK()) {
            return ret;
        }

        ret = options->addOption(OD("service", "service", moe::Switch, "start mongodb service",
                    false));
        if (!ret.isOK()) {
            return ret;
        }

        return Status::OK();
    }

    Status addSSLServerOptions(moe::OptionSection* options) {
        Status ret = options->addOption(OD("ssl.sslOnNormalPorts", "sslOnNormalPorts", moe::Switch,
                    "use ssl on configured ports", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.PEMKeyFile", "sslPEMKeyFile", moe::String,
                    "PEM file for ssl" , true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.PEMKeyPassword", "sslPEMKeyPassword", moe::String,
                    "PEM file password" , true, moe::Value(), moe::Value(std::string(""))));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.clusterFile", "sslClusterFile", moe::String,
                    "Key file for internal SSL authentication" , true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.clusterPassword", "sslClusterPassword", moe::String,
                    "Internal authentication key file password" , true, moe::Value(), moe::Value(std::string(""))));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.CAFile", "sslCAFile", moe::String,
                    "Certificate Authority file for SSL", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.CRLFile", "sslCRLFile", moe::String,
                    "Certificate Revocation List file for SSL", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.weakCertificateValidation", "sslWeakCertificateValidation",
                    moe::Switch, "allow client to connect without presenting a certificate", true));
        if (!ret.isOK()) {
            return ret;
        }
        ret = options->addOption(OD("ssl.FIPSMode", "sslFIPSMode", moe::Switch,
                    "activate FIPS 140-2 mode at startup", true));
        if (!ret.isOK()) {
            return ret;
        }

        return Status::OK();
    }

} // namespace mongo