passenger 5.3.7 → 6.0.0

data/src/agent/Core/TelemetryCollector.h

@@ -288,6 +288,7 @@ private:
 			lastTelemetryData.timestamp);
 		doc["end_time"] = (Json::UInt64) monoTimeToRealTime(
 			tmData.timestamp);
+		doc["version"] = PASSENGER_VERSION;
 		#ifdef PASSENGER_IS_ENTERPRISE
 			doc["edition"] = "enterprise";
 		#else

data/src/agent/FileReadHelper/FileReadHelperMain.cpp

@@ -0,0 +1,198 @@
+/*
+ *  Phusion Passenger - https://www.phusionpassenger.com/
+ *  Copyright (c) 2018 Phusion Holding B.V.
+ *
+ *  "Passenger", "Phusion Passenger" and "Union Station" are registered
+ *  trademarks of Phusion Holding B.V.
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining a copy
+ *  of this software and associated documentation files (the "Software"), to deal
+ *  in the Software without restriction, including without limitation the rights
+ *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ *  copies of the Software, and to permit persons to whom the Software is
+ *  furnished to do so, subject to the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be included in
+ *  all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ *  THE SOFTWARE.
+ */
+
+// A helper app that reads from an arbitrary file.
+// Its main reason for existance is to allow root processes (such as the Core)
+// to read from arbitrary files in a way that's safe from symlink and other
+// kinds of attacks. See the documentation for safeReadFile()
+// to learn more about the different types of attacks.
+//
+// file-read-helper is used when the caller cannot use safeReadFile(),
+// e.g. when the following two conditions hold at the same time:
+//
+//  1. The caller does not have control over the safety of the parent
+//     directories leading to the file.
+//  2. The caller cannot choose not to disclose the contents of the file.
+//
+// file-read-helper MUST be used in combination with exec-helper in order
+// to lower its privilege, otherwise no protection is provided.
+
+#include <cstdio>
+#include <cstdlib>
+#include <cstddef>
+#include <cerrno>
+#include <cstring>
+#include <string>
+#include <algorithm>
+#include <limits>
+
+#include <fcntl.h>
+#include <unistd.h>
+
+#include <Constants.h>
+#include <ProcessManagement/Utils.h>
+#include <IOTools/IOUtils.h>
+#include <Utils/OptionParsing.h>
+
+namespace Passenger {
+namespace FileReadHelper {
+
+using namespace std;
+
+
+struct Options {
+	size_t limit;
+	int programArgStart;
+
+	Options()
+		: limit(std::numeric_limits<size_t>::max()),
+		  programArgStart(2)
+		{ }
+};
+
+static void
+usage() {
+	// ....|---------------Keep output within standard terminal width (80 chars)------------|
+	printf("Usage: " AGENT_EXE " file-read-helper [OPTIONS...] <PATH>\n");
+	printf("Reads the given file with O_NONBLOCK.\n");
+	printf("\n");
+	printf("Options:\n");
+	printf("  --limit <SIZE>  Limit the number of bytes read (default: unlimited).\n");
+	printf("  --help          Show this help message.\n");
+}
+
+static bool
+parseOption(int argc, const char *argv[], int &i, Options &options) {
+	OptionParser p(usage);
+
+	if (p.isValueFlag(argc, i, argv[i], '\0', "--limit")) {
+		options.limit = atoi(argv[i + 1]);
+		i += 2;
+	} else {
+		return false;
+	}
+	return true;
+}
+
+static bool
+parseOptions(int argc, const char *argv[], Options &options) {
+	OptionParser p(usage);
+	int i = 2;
+
+	while (i < argc) {
+		if (parseOption(argc, argv, i, options)) {
+			continue;
+		} else if (p.isFlag(argv[i], 'h', "--help")) {
+			usage();
+			exit(0);
+		} else if (*argv[i] == '-') {
+			fprintf(stderr, "ERROR: unrecognized argument %s. Please type "
+				"'%s file-read-helper --help' for usage.\n", argv[i], argv[0]);
+			exit(1);
+		} else {
+			options.programArgStart = i;
+			return true;
+		}
+	}
+
+	return true;
+}
+
+int
+fileReadHelperMain(int argc, char *argv[]) {
+	if (argc < 3) {
+		usage();
+		exit(1);
+	}
+
+	Options options;
+	if (!parseOptions(argc, (const char **) argv, options)) {
+		fprintf(stderr, "Error parsing arguments.\n");
+		usage();
+		exit(1);
+	}
+
+	if (argc != options.programArgStart + 1) {
+		fprintf(stderr, "ERROR: no file path given. Please type "
+			"'%s file-read-helper --help' for usage.\n", argv[0]);
+		exit(1);
+	}
+
+	if (geteuid() == 0) {
+		fprintf(stderr, "ERROR: file-read-helper cannot be run with root"
+			" privileges. Please use in combination with exec-helper.\n");
+		exit(1);
+	}
+
+	resetSignalHandlersAndMask();
+	disableMallocDebugging();
+
+	const char *path = argv[options.programArgStart];
+	int fd;
+	do {
+		fd = open(path, O_RDONLY | O_NONBLOCK);
+	} while (fd == -1 && errno == EINTR);
+	if (fd == -1) {
+		int e = errno;
+		fprintf(stderr, "Error opening %s for reading: %s (errno=%d)\n",
+			path, strerror(e), e);
+		exit(1);
+	}
+
+	size_t totalRead = 0;
+	char buf[1024 * 16];
+
+	while (totalRead < options.limit) {
+		ssize_t ret;
+		do {
+			ret = read(fd, buf,
+				std::min<size_t>(sizeof(buf), options.limit - totalRead));
+		} while (ret == -1 && errno == EINTR);
+		if (ret == -1) {
+			int e = errno;
+			fprintf(stderr, "Error reading from %s: %s (errno=%d)\n",
+				path, strerror(e), e);
+			exit(1);
+		} else if (ret == 0) {
+			break;
+		} else {
+			totalRead += ret;
+			writeExact(1, StaticString(buf, ret));
+		}
+	}
+
+	return 0;
+}
+
+
+} // namespace FileReadHelper
+} // namespace Passenger
+
+
+int
+fileReadHelperMain(int argc, char *argv[]) {
+	return Passenger::FileReadHelper::fileReadHelperMain(argc, argv);
+}

data/src/agent/Watchdog/Config.h

@@ -150,6 +150,7 @@ using namespace std;
  *   setsid                                                                   boolean            -          default(false)
  *   show_version_in_header                                                   boolean            -          default(true)
  *   single_app_mode_app_root                                                 string             -          default,read_only
+ *   single_app_mode_app_start_command                                        string             -          read_only
  *   single_app_mode_app_type                                                 string             -          read_only
  *   single_app_mode_startup_file                                             string             -          read_only
  *   standalone_engine                                                        string             -          default

data/src/apache2_module/ConfigGeneral/AutoGeneratedDefinitions.cpp

@@ -107,6 +107,11 @@ extern "C" const command_rec passenger_commands[] = {
 		NULL,
 		RSRC_CONF | ACCESS_CONF,
 		"The application's root directory."),
+	AP_INIT_TAKE1("PassengerAppStartCommand",
+		(Take1Func) cmd_passenger_app_start_command,
+		NULL,
+		RSRC_CONF | ACCESS_CONF,
+		"Command string for starting the application."),
 	AP_INIT_TAKE1("PassengerAppType",
 		(Take1Func) cmd_passenger_app_type,
 		NULL,

data/src/apache2_module/ConfigGeneral/AutoGeneratedSetterFuncs.cpp

@@ -203,6 +203,21 @@ cmd_passenger_app_root(cmd_parms *cmd, void *pcfg, const char *arg) {
 	return NULL;
 }
 
+static const char *
+cmd_passenger_app_start_command(cmd_parms *cmd, void *pcfg, const char *arg) {
+	const char *err = ap_check_cmd_context(cmd, NOT_IN_FILES);
+	if (err != NULL) {
+		return err;
+	}
+
+	DirConfig *config = (DirConfig *) pcfg;
+	config->mAppStartCommandSourceFile = cmd->directive->filename;
+	config->mAppStartCommandSourceLine = cmd->directive->line_num;
+	config->mAppStartCommandExplicitlySet = true;
+	config->mAppStartCommand = arg;
+	return NULL;
+}
+
 static const char *
 cmd_passenger_app_type(cmd_parms *cmd, void *pcfg, const char *arg) {
 	const char *err = ap_check_cmd_context(cmd, NOT_IN_FILES);

data/src/apache2_module/DirConfig/AutoGeneratedCreateFunction.cpp

@@ -64,6 +64,9 @@ createDirConfig_autoGenerated(DirConfig *config) {
 	/*
 	 * config->mAppRoot: default initialized
 	 */
+	/*
+	 * config->mAppStartCommand: default initialized
+	 */
 	/*
 	 * config->mAppType: default initialized
 	 */
@@ -124,6 +127,7 @@ createDirConfig_autoGenerated(DirConfig *config) {
 	config->mAppGroupNameSourceLine = 0;
 	config->mAppLogFileSourceLine = 0;
 	config->mAppRootSourceLine = 0;
+	config->mAppStartCommandSourceLine = 0;
 	config->mAppTypeSourceLine = 0;
 	config->mBaseURIsSourceLine = 0;
 	config->mBufferResponseSourceLine = 0;
@@ -158,6 +162,7 @@ createDirConfig_autoGenerated(DirConfig *config) {
 	config->mAppGroupNameExplicitlySet = false;
 	config->mAppLogFileExplicitlySet = false;
 	config->mAppRootExplicitlySet = false;
+	config->mAppStartCommandExplicitlySet = false;
 	config->mAppTypeExplicitlySet = false;
 	config->mBaseURIsExplicitlySet = false;
 	config->mBufferResponseExplicitlySet = false;

data/src/apache2_module/DirConfig/AutoGeneratedManifestGeneration.cpp

@@ -116,6 +116,19 @@ ConfigManifestGenerator::autoGenerated_generateConfigManifestForDirConfig(server
 			pdconf->mAppRoot.data(),
 			pdconf->mAppRoot.data() + pdconf->mAppRoot.size());
 	}
+	if (pdconf->mAppStartCommandExplicitlySet) {
+		findOrCreateAppAndLocOptionsContainers(serverRec, csconf, cdconf,
+			pdconf, context, &appOptionsContainer, &locOptionsContainer);
+		Json::Value &optionContainer = findOrCreateOptionContainer(*appOptionsContainer,
+			"PassengerAppStartCommand",
+			sizeof("PassengerAppStartCommand") - 1);
+		Json::Value &hierarchyMember = addOptionContainerHierarchyMember(optionContainer,
+			pdconf->mAppStartCommandSourceFile,
+			pdconf->mAppStartCommandSourceLine);
+		hierarchyMember["value"] = Json::Value(
+			pdconf->mAppStartCommand.data(),
+			pdconf->mAppStartCommand.data() + pdconf->mAppStartCommand.size());
+	}
 	if (pdconf->mAppTypeExplicitlySet) {
 		findOrCreateAppAndLocOptionsContainers(serverRec, csconf, cdconf,
 			pdconf, context, &appOptionsContainer, &locOptionsContainer);

data/src/apache2_module/DirConfig/AutoGeneratedMergeFunction.cpp

@@ -68,6 +68,10 @@ mergeDirConfig_autoGenerated(DirConfig *config, DirConfig *base, DirConfig *add)
 		(!add->mAppRoot.empty())
 		? add->mAppRoot
 		: base->mAppRoot;
+	config->mAppStartCommand =
+		(!add->mAppStartCommand.empty())
+		? add->mAppStartCommand
+		: base->mAppStartCommand;
 	config->mAppType =
 		(!add->mAppType.empty())
 		? add->mAppType
@@ -186,6 +190,7 @@ mergeDirConfig_autoGenerated(DirConfig *config, DirConfig *base, DirConfig *add)
 	config->mAppGroupNameSourceFile = add->mAppGroupNameSourceFile;
 	config->mAppLogFileSourceFile = add->mAppLogFileSourceFile;
 	config->mAppRootSourceFile = add->mAppRootSourceFile;
+	config->mAppStartCommandSourceFile = add->mAppStartCommandSourceFile;
 	config->mAppTypeSourceFile = add->mAppTypeSourceFile;
 	config->mBaseURIsSourceFile = add->mBaseURIsSourceFile;
 	config->mBufferResponseSourceFile = add->mBufferResponseSourceFile;
@@ -220,6 +225,7 @@ mergeDirConfig_autoGenerated(DirConfig *config, DirConfig *base, DirConfig *add)
 	config->mAppGroupNameSourceLine = add->mAppGroupNameSourceLine;
 	config->mAppLogFileSourceLine = add->mAppLogFileSourceLine;
 	config->mAppRootSourceLine = add->mAppRootSourceLine;
+	config->mAppStartCommandSourceLine = add->mAppStartCommandSourceLine;
 	config->mAppTypeSourceLine = add->mAppTypeSourceLine;
 	config->mBaseURIsSourceLine = add->mBaseURIsSourceLine;
 	config->mBufferResponseSourceLine = add->mBufferResponseSourceLine;
@@ -254,6 +260,7 @@ mergeDirConfig_autoGenerated(DirConfig *config, DirConfig *base, DirConfig *add)
 	config->mAppGroupNameExplicitlySet = add->mAppGroupNameExplicitlySet;
 	config->mAppLogFileExplicitlySet = add->mAppLogFileExplicitlySet;
 	config->mAppRootExplicitlySet = add->mAppRootExplicitlySet;
+	config->mAppStartCommandExplicitlySet = add->mAppStartCommandExplicitlySet;
 	config->mAppTypeExplicitlySet = add->mAppTypeExplicitlySet;
 	config->mBaseURIsExplicitlySet = add->mBaseURIsExplicitlySet;
 	config->mBufferResponseExplicitlySet = add->mBufferResponseExplicitlySet;

data/src/apache2_module/DirConfig/AutoGeneratedStruct.h

@@ -156,6 +156,11 @@ struct AutoGeneratedDirConfig {
 	 */
 	StaticString mAppRoot;
 
+	/*
+	 * Command string for starting the application.
+	 */
+	StaticString mAppStartCommand;
+
 	/*
 	 * Force specific application type.
 	 */
@@ -242,6 +247,7 @@ struct AutoGeneratedDirConfig {
 	StaticString mAppGroupNameSourceFile;
 	StaticString mAppLogFileSourceFile;
 	StaticString mAppRootSourceFile;
+	StaticString mAppStartCommandSourceFile;
 	StaticString mAppTypeSourceFile;
 	StaticString mGroupSourceFile;
 	StaticString mMeteorAppSettingsSourceFile;
@@ -276,6 +282,7 @@ struct AutoGeneratedDirConfig {
 	unsigned int mAppGroupNameSourceLine;
 	unsigned int mAppLogFileSourceLine;
 	unsigned int mAppRootSourceLine;
+	unsigned int mAppStartCommandSourceLine;
 	unsigned int mAppTypeSourceLine;
 	unsigned int mGroupSourceLine;
 	unsigned int mMeteorAppSettingsSourceLine;
@@ -310,6 +317,7 @@ struct AutoGeneratedDirConfig {
 	bool mAppGroupNameExplicitlySet: 1;
 	bool mAppLogFileExplicitlySet: 1;
 	bool mAppRootExplicitlySet: 1;
+	bool mAppStartCommandExplicitlySet: 1;
 	bool mAppTypeExplicitlySet: 1;
 	bool mGroupExplicitlySet: 1;
 	bool mMeteorAppSettingsExplicitlySet: 1;
@@ -489,6 +497,11 @@ struct AutoGeneratedDirConfig {
 		return mAppRoot;
 	}
 
+	StaticString
+	getAppStartCommand() const {
+		return mAppStartCommand;
+	}
+
 	StaticString
 	getAppType() const {
 		return mAppType;

data/src/apache2_module/DirectoryMapper.h

@@ -77,6 +77,7 @@ private:
 	request_rec *r;
 	CachedFileStat *cstat;
 	boost::mutex *cstatMutex;
+	boost::mutex *configMutex;
 	const char *baseURI;
 	string publicDir;
 	string appRoot;
@@ -148,10 +149,16 @@ private:
 
 		UPDATE_TRACE_POINT();
 		AppTypeDetector::Detector detector(registry, cstat,
-			cstatMutex, throttleRate);
+			cstatMutex, throttleRate, configMutex);
 		AppTypeDetector::Detector::Result detectorResult;
 		string appRoot;
-		if (config->getAppType().empty()) {
+		// If `AppStartCommand` is set, then it means the config specified that it is
+		// either a generic app or a Kuria app.
+		if (!config->getAppStartCommand().empty()) {
+			appRoot = config->getAppRoot();
+		} else if (config->getAppType().empty()) {
+			// If neither `AppStartCommand` nor `AppType` are set, then
+			// autodetect what kind of app this is.
 			if (config->getAppRoot().empty()) {
 				detectorResult = detector.checkDocumentRoot(publicDir,
 					baseURI != NULL,
@@ -161,6 +168,9 @@ private:
 				detectorResult = detector.checkAppRoot(appRoot);
 			}
 		} else if (!config->getAppRoot().empty()) {
+			// If `AppStartCommand` is not set but `AppType` is (as well as
+			// the required `AppRoot`), then verify whether the given
+			// `AppType` value is supported and resolve aliases.
 			appRoot = config->getAppRoot().toString();
 			detectorResult.wrapperRegistryEntry = &registry.lookup(
 				config->getAppType());
@@ -186,13 +196,14 @@ public:
 	DirectoryMapper(request_rec *r, DirConfig *config,
 		const WrapperRegistry::Registry &_registry,
 		CachedFileStat *cstat, boost::mutex *cstatMutex,
-		unsigned int throttleRate)
+		unsigned int throttleRate, boost::mutex *configMutex)
 		: registry(_registry)
 	{
 		this->r = r;
 		this->config = config;
 		this->cstat = cstat;
 		this->cstatMutex = cstatMutex;
+		this->configMutex = configMutex;
 		this->throttleRate = throttleRate;
 		baseURI = NULL;
 		autoDetectionDone = false;

data/src/apache2_module/Hooks.cpp

@@ -237,6 +237,7 @@ private:
 	CachedFileStat cstat;
 	WatchdogLauncher watchdogLauncher;
 	boost::mutex cstatMutex;
+	boost::mutex configMutex;
 
 	static Json::Value strsetToJson(const set<string> &input) {
 		Json::Value result(Json::arrayValue);
@@ -446,9 +447,11 @@ private:
 		TRACE_POINT();
 
 		DirectoryMapper mapper(r, config, wrapperRegistry, &cstat,
-			&cstatMutex, serverConfig.statThrottleRate);
+		    &cstatMutex, serverConfig.statThrottleRate, &configMutex);
 		try {
-			if (mapper.getDetectorResult().isNull()) {
+			if (config->getAppStartCommand().empty()
+			 && mapper.getDetectorResult().isNull())
+			{
 				// (B) is not true.
 				disableRequestNote(r);
 				return false;
@@ -988,8 +991,16 @@ private:
 		// Phusion Passenger options.
 		addHeader(result, P_STATIC_STRING("!~PASSENGER_APP_ROOT"),
 			mapper.getAppRoot());
-		addHeader(result, P_STATIC_STRING("!~PASSENGER_APP_TYPE"),
-			mapper.getDetectorResult().wrapperRegistryEntry->language);
+		if (!config->getAppStartCommand().empty()) {
+			addHeader(result, P_STATIC_STRING("!~PASSENGER_APP_START_COMMAND"),
+				config->getAppStartCommand());
+		} else if (mapper.getDetectorResult().wrapperRegistryEntry != NULL) {
+			addHeader(result, P_STATIC_STRING("!~PASSENGER_APP_TYPE"),
+				mapper.getDetectorResult().wrapperRegistryEntry->language);
+		} else {
+			addHeader(result, P_STATIC_STRING("!~PASSENGER_APP_START_COMMAND"),
+				mapper.getDetectorResult().appStartCommand);
+		}
 		constructRequestHeaders_autoGenerated(r, config, result);
 
 		/*********************/