-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Expand file tree
/
Copy pathServerOptions.cpp
More file actions
350 lines (298 loc) · 11 KB
/
Copy pathServerOptions.cpp
File metadata and controls
350 lines (298 loc) · 11 KB
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
/*
* ServerOptions.cpp
*
* Copyright (C) 2021 by RStudio, PBC
*
* Unless you have received this program directly from RStudio pursuant
* to the terms of a commercial license agreement with RStudio, then
* this program is licensed to you under the terms of version 3 of the
* GNU Affero General Public License. This program is distributed WITHOUT
* ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT,
* MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the
* AGPL (http://www.gnu.org/licenses/agpl-3.0.txt) for more details.
*
*/
#include <server/ServerOptions.hpp>
#include <server/ServerConstants.hpp>
#include <iosfwd>
#include <fstream>
#include <boost/algorithm/string/trim.hpp>
#include <core/FileSerializer.hpp>
#include <core/r_util/RSessionContext.hpp>
using namespace rstudio::core;
namespace rstudio {
namespace server {
namespace {
struct Deprecated
{
Deprecated()
: memoryLimitMb(0),
stackLimitMb(0),
userProcessLimit(0),
authPamRequiresPriv(true)
{
}
int memoryLimitMb;
int stackLimitMb;
int userProcessLimit;
bool authPamRequiresPriv;
};
void reportDeprecationWarning(const std::string& option, std::ostream& os)
{
os << "The option '" << option << "' is deprecated and will be discarded."
<< std::endl;
}
void reportDeprecationWarnings(const Deprecated& userOptions,
std::ostream& os)
{
Deprecated defaultOptions;
if (userOptions.memoryLimitMb != defaultOptions.memoryLimitMb)
reportDeprecationWarning("rsession-memory-limit-mb", os);
if (userOptions.stackLimitMb != defaultOptions.stackLimitMb)
reportDeprecationWarning("rsession-stack-limit-mb", os);
if (userOptions.userProcessLimit != defaultOptions.userProcessLimit)
reportDeprecationWarning("rsession-process-limit", os);
if (userOptions.authPamRequiresPriv != defaultOptions.authPamRequiresPriv)
reportDeprecationWarning("auth-pam-requires-priv", os);
}
unsigned int stringToUserId(std::string minimumUserId,
unsigned int defaultMinimumId,
std::ostream& osWarnings)
{
try
{
return boost::lexical_cast<unsigned int>(minimumUserId);
}
catch(boost::bad_lexical_cast&)
{
osWarnings << "Invalid value for auth-minimum-user-id '"
<< minimumUserId << "'. Using default of "
<< defaultMinimumId << "." << std::endl;
return defaultMinimumId;
}
}
unsigned int resolveMinimumUserId(std::string minimumUserId,
std::ostream& osWarnings)
{
// default for invalid input
const unsigned int kDefaultMinimumId = 1000;
// auto-detect if requested
if (minimumUserId == "auto")
{
// if /etc/login.defs exists, scan it and look for a UID_MIN setting
FilePath loginDefs("/etc/login.defs");
if (loginDefs.exists())
{
const char uidMin[] = "UID_MIN";
std::ifstream defStream(loginDefs.getAbsolutePath().c_str());
std::string line;
while (std::getline(defStream, line))
{
if (line.substr(0, sizeof(uidMin) - 1) == uidMin)
{
std::string value = boost::algorithm::trim_copy(
line.substr(sizeof(uidMin) + 1));
return stringToUserId(value, kDefaultMinimumId, osWarnings);
}
}
}
// none found, return default
return kDefaultMinimumId;
}
else
{
return stringToUserId(minimumUserId, kDefaultMinimumId, osWarnings);
}
}
} // anonymous namespace
Options& options()
{
static Options instance;
return instance;
}
ProgramStatus Options::read(int argc,
char * const argv[],
std::ostream& osWarnings)
{
using namespace boost::program_options;
// compute install path
Error error = core::system::installPath("..", argv[0], &installPath_);
if (error)
{
LOG_ERROR_MESSAGE("Unable to determine install path: "+error.getSummary());
return ProgramStatus::exitFailure();
}
// compute the resource and binary paths
FilePath resourcePath = installPath_;
FilePath binaryPath = installPath_.completeChildPath("bin");
// detect running in OSX bundle and tweak paths
#ifdef __APPLE__
if (installPath_.completePath("Info.plist").exists())
{
resourcePath = installPath_.completePath("Resources");
binaryPath = installPath_.completePath("MacOS");
}
#endif
// special program offline option (based on file existence at
// startup for easy bash script enable/disable of offline state)
serverOffline_ = FilePath("/var/lib/rstudio-server/offline").exists();
// generate monitor shared secret
monitorSharedSecret_ = core::system::generateUuid();
// build options
options_description verify("verify");
options_description server("server");
options_description www("www");
options_description rsession("rsession");
options_description database("database");
options_description auth("auth");
options_description monitor("monitor");
std::vector<std::string> wwwAllowedOrigins;
std::string authLoginPageHtml;
std::string authRdpLoginPageHtml;
std::string authMinimumUserId;
std::string sameSite;
program_options::OptionsDescription optionsDesc =
buildOptions(&verify, &server, &www, &rsession, &database, &auth, &monitor,
&sameSite, &wwwAllowedOrigins, &authLoginPageHtml, &authRdpLoginPageHtml,
&authMinimumUserId);
// overlay hook
addOverlayOptions(&verify, &server, &www, &rsession, &database, &auth, &monitor);
optionsDesc.commandLine.add(verify).add(server).add(www).add(rsession).add(database).add(auth).add(monitor);
optionsDesc.configFile.add(server).add(www).add(rsession).add(database).add(auth).add(monitor);
// read options
bool help = false;
ProgramStatus status = core::program_options::read(optionsDesc,
argc,
argv,
&help);
// terminate if this was a help request
if (help)
return ProgramStatus::exitSuccess();
// report deprecation warnings
Deprecated dep;
dep.userProcessLimit = deprecatedUserProcessLimit_;
dep.stackLimitMb = deprecatedStackLimitMb_;
dep.memoryLimitMb = deprecatedMemoryLimitMb_;
dep.authPamRequiresPriv = deprecatedAuthPamRequiresPriv_;
reportDeprecationWarnings(dep, osWarnings);
// check auth revocation dir - if unspecified, it should be put under the server data dir
if (authRevocationListDir_.empty())
authRevocationListDir_ = serverDataDir_;
if (sameSite != kSameSiteOmitOption &&
sameSite != kSameSiteNoneOption &&
sameSite != kSameSiteLaxOption)
{
program_options::reportError("Invalid SameSite option: " + sameSite, ERROR_LOCATION, true);
return ProgramStatus::exitFailure();
}
if (sameSite == kSameSiteNoneOption)
wwwSameSite_ = rstudio::core::http::Cookie::SameSite::None;
else if (sameSite == kSameSiteLaxOption)
wwwSameSite_ = rstudio::core::http::Cookie::SameSite::Lax;
else
wwwSameSite_ = rstudio::core::http::Cookie::SameSite::Undefined;
// call overlay hooks
resolveOverlayOptions();
std::string errMsg;
if (!validateOverlayOptions(&errMsg, osWarnings))
{
program_options::reportError(errMsg, ERROR_LOCATION, true);
return ProgramStatus::exitFailure();
}
// exit if the call to read indicated we should -- note we don't do this
// immediately so that we can allow overlay validation to occur (otherwise
// a --test-config wouldn't test overlay options)
if (status.exit())
return status;
// rationalize auth settings
if (authNone_)
authValidateUsers_ = false;
// if specified, confirm that the program user exists. however, if the
// program user is the default and it doesn't exist then allow that to pass,
// this just means that the user did a simple make install and hasn't setup
// an rserver user yet. in this case the program will run as root
if (!serverUser_.empty())
{
// if we aren't running as root then forget the programUser
if (!core::system::realUserIsRoot())
{
serverUser_ = "";
}
// if there is a program user specified and it doesn't exist....
else
{
system::User user;
Error error = system::User::getUserFromIdentifier(serverUser_, user);
if (error || !user.exists())
{
if (serverUser_ == "rstudio-server")
{
// administrator hasn't created an rserver system account yet
// so we'll end up running as root
serverUser_ = "";
LOG_WARNING_MESSAGE("Running as root user is not recommended!");
}
else
{
LOG_ERROR_MESSAGE("Server user " + serverUser_ + " does not exist");
return ProgramStatus::exitFailure();
}
}
}
}
// convert relative paths by completing from the system installation
// path (this allows us to be relocatable)
resolvePath(resourcePath, &wwwLocalPath_);
resolvePath(resourcePath, &wwwSymbolMapsPath_);
resolvePath(binaryPath, &authPamHelperPath_);
resolvePath(binaryPath, &rsessionPath_);
resolvePath(binaryPath, &rldpathPath_);
resolvePath(resourcePath, &rsessionConfigFile_);
// resolve minimum user id
authMinimumUserId_ = resolveMinimumUserId(authMinimumUserId, osWarnings);
core::r_util::setMinUid(authMinimumUserId_);
// read auth login html
FilePath loginPageHtmlPath(authLoginPageHtml);
if (loginPageHtmlPath.exists())
{
Error error = core::readStringFromFile(loginPageHtmlPath, &authLoginPageHtml_);
if (error)
LOG_ERROR(error);
}
// read rdp auth login html
FilePath rdpLoginPageHtmlPath(authRdpLoginPageHtml);
if (rdpLoginPageHtmlPath.exists())
{
Error error = core::readStringFromFile(rdpLoginPageHtmlPath, &authRdpLoginPageHtml_);
if (error)
LOG_ERROR(error);
}
// trim any whitespace in allowed origins
for (std::string& origin : wwwAllowedOrigins)
{
try
{
// escape domain part separators
boost::replace_all(origin, ".", "\\.");
// fix up wildcards
boost::replace_all(origin, "*", ".*");
boost::regex re(origin);
wwwAllowedOrigins_.push_back(re);
}
catch (boost::bad_expression&)
{
LOG_ERROR_MESSAGE("Specified origin " + origin + " is an invalid domain. "
"It will not be available when performing origin safety checks.");
}
}
// return status
return status;
}
void Options::resolvePath(const FilePath& basePath,
std::string* pPath) const
{
if (!pPath->empty())
*pPath = basePath.completePath(*pPath).getAbsolutePath();
}
} // namespace server
} // namespace rstudio