nawarun.cpp

Go to the documentation of this file.

/*
 * Copyright (C) 2019-2022 Tobias Flaig.
 *
 * This file is part of nawa.
 *
 * nawa is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License,
 * version 3, as published by the Free Software Foundation.
 *
 * nawa 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with nawa.  If not, see <https://www.gnu.org/licenses/>.
 */
 
#include <atomic>
#include <csignal>
#include <dlfcn.h>
#include <grp.h>
#include <nawa/Exception.h>
#include <nawa/RequestHandler/RequestHandler.h>
#include <nawa/application.h>
#include <nawa/config/Config.h>
#include <nawa/logging/Log.h>
#include <nawa/oss.h>
#include <nawa/util/utils.h>
#include <nawarun/nawarun.h>
#include <pwd.h>
#include <stdexcept>
#include <thread>
 
using namespace nawa;
using namespace nawarun;
using namespace std;
 
namespace {
    unique_ptr<RequestHandler> requestHandlerPtr;
    optional<string> configFile;
    atomic<bool> readyToReconfigure(false);
    Log logger;
    unsigned int terminationTimeout = 10;
 
    // signal handler for SIGINT, SIGTERM, and SIGUSR1
    void shutdown(int signum) {
        NLOG_INFO(logger, "Terminating on signal " << signum)
 
        // terminate worker threads
        if (requestHandlerPtr) {
            // should stop
            requestHandlerPtr->stop();
 
            // if this did not work, try harder after 10 seconds
            sleep(terminationTimeout);
            if (requestHandlerPtr && signum != SIGUSR1) {
                NLOG_INFO(logger, "Enforcing termination now, ignoring pending requests.")
                requestHandlerPtr->terminate();
            }
        } else {
            exit(0);
        }
    }
 
    // load a symbol from an app .so file
    void* loadAppSymbol(void* appOpen, char const* symbolName, string const& error) {
        void* symbol = dlsym(appOpen, symbolName);
        auto dlsymError = dlerror();
        if (dlsymError) {
            throw Exception(__FUNCTION__, 11, error, dlsymError);
        }
        return symbol;
    }
 
    // free memory of an open app
    void closeApp(void* appOpen) {
        dlclose(appOpen);
    }
 
    void setTerminationTimeout(Config const& config) {
        string terminationTimeoutStr = config[{"system", "termination_timeout"}];
        if (!terminationTimeoutStr.empty()) {
            try {
                auto newTerminationTimeout = stoul(terminationTimeoutStr);
                terminationTimeout = newTerminationTimeout;
            } catch (invalid_argument& e) {
                NLOG_WARNING(logger, "WARNING: Invalid termination timeout given in configuration, default value "
                                     "or previous value will be used.")
            }
        }
    }
 
    optional<Config> loadConfig(bool reload = false) {
        if (configFile) {
            try {
                return Config(*configFile);
            } catch (Exception const& e) {
                if (reload) {
                    NLOG_ERROR(logger, "ERROR: Could not reload config: " << e.getMessage())
                    NLOG_WARNING(logger, "WARNING: App will not be reloaded as well")
                } else {
                    NLOG_ERROR(logger, "Fatal Error: Could not load config: " << e.getMessage())
                }
                NLOG_DEBUG(logger, "Debug info: " << e.getDebugMessage())
                return nullopt;
            }
        }
        return Config();
    }
 
    void doPrivilegeDowngrade(PrivilegeDowngradeData const& data) {
        auto const& [uid, gid, supplementaryGroups] = data;
        if (uid != 0 && gid != 0 && setgroups(supplementaryGroups.size(), &supplementaryGroups[0]) != 0) {
            NLOG_ERROR(logger, "Fatal Error: Could not set supplementary groups during privilege downgrade.")
            exit(1);
        }
        if (setgid(gid) != 0 || setuid(uid) != 0) {
            NLOG_ERROR(logger, "Fatal Error: Could not set privileges during privilege downgrade.")
            exit(1);
        }
    }
 
    void printHelpAndExit() {
        cout << "nawarun is the runner for NAWA web applications.\n\n"
                "Usage: nawarun [<overrides>] [<config-file> | --no-config-file]\n\n"
                "Format for configuration overrides: --<category>:<key>=<value>\n\n"
                "If no config file is given, nawarun will try to use config.ini from the current\n"
                "working directory, unless the --no-config-file option is given. The config file\n"
                "as well as --no-config-file are only accepted as the last command line argument\n"
                "after the overrides.\n\n"
                "nawarun version "
             << nawa_version_major << '.' << nawa_version_minor << '\n';
        exit(0);
    }
 
    void printVersionAndExit() {
        cout << nawa_version_major << '.' << nawa_version_minor << '\n';
        exit(0);
    }
 
    void setUpSignalHandlers() {
        signal(SIGINT, shutdown);
        signal(SIGTERM, shutdown);
        signal(SIGUSR1, shutdown);
        signal(SIGHUP, reload);
    }
 
    void setUpLogging(Config const& config) {
        auto configuredLogLevel = config[{"logging", "level"}];
        if (configuredLogLevel == "off") {
            Log::setOutputLevel(Log::Level::OFF);
        } else if (configuredLogLevel == "error") {
            Log::setOutputLevel(Log::Level::ERROR);
        } else if (configuredLogLevel == "warning") {
            Log::setOutputLevel(Log::Level::WARNING);
        } else if (configuredLogLevel == "debug") {
            Log::setOutputLevel(Log::Level::DEBUG);
        }
        if (config[{"logging", "extended"}] == "on") {
            Log::setExtendedFormat(true);
        }
        Log::lockStream();
    }
}// namespace
 
unsigned int nawarun::getConcurrency(Config const& config) {
    double cReal;
    try {
        cReal = config.isSet({"system", "threads"})
                        ? stod(config[{"system", "threads"}])
                        : 1.0;
    } catch (invalid_argument& e) {
        NLOG_WARNING(logger, "WARNING: Invalid value given for system/concurrency given in the config file.")
        cReal = 1.0;
    }
    if (config[{"system", "concurrency"}] == "hardware") {
        cReal = max(1.0, thread::hardware_concurrency() * cReal);
    }
    return static_cast<unsigned int>(cReal);
}
 
pair<init_t*, shared_ptr<HandleRequestFunctionWrapper>> nawarun::loadAppFunctions(Config const& config) {
    // load application init function
    string appPath = config[{"application", "path"}];
    if (appPath.empty()) {
        throw Exception(__FUNCTION__, 1, "Application path not set in config file.");
    }
    void* appOpen = dlopen(appPath.c_str(), RTLD_LAZY);
    if (!appOpen) {
        throw Exception(__FUNCTION__, 2, "Application file could not be loaded.", dlerror());
    }
 
    // reset dl errors
    dlerror();
 
    // load symbols and check for errors
    // first load nawa_version_major (defined in Application.h, included in Connection.h)
    // the version the app has been compiled against should match the version of this nawarun
    string appVersionError = "Could not read nawa version from application.";
    auto appNawaVersionMajor = (int*) loadAppSymbol(appOpen, "nawa_version_major", appVersionError);
    auto appNawaVersionMinor = (int*) loadAppSymbol(appOpen, "nawa_version_minor", appVersionError);
    if (*appNawaVersionMajor != nawa_version_major || *appNawaVersionMinor != nawa_version_minor) {
        throw Exception(__FUNCTION__, 3, "App has been compiled against another version of NAWA.");
    }
    auto appInit = (init_t*) loadAppSymbol(appOpen, "init", "Could not load init function from application.");
    auto appHandleRequest = (handleRequest_t*) loadAppSymbol(appOpen, "handleRequest",
                                                             "Could not load handleRequest function from application.");
    return {appInit, make_shared<HandleRequestFunctionWrapper>(appHandleRequest, appOpen, closeApp)};
}
 
void nawarun::reload(int signum) {
    if (!configFile) {
        NLOG_WARNING(logger, "WARNING: Reloading is not supported without config file and will therefore not "
                             "happen.")
        return;
    }
 
    if (requestHandlerPtr && readyToReconfigure) {
        NLOG_INFO(logger, "Reloading config and app on signal " << signum)
        readyToReconfigure = false;
 
        optional<Config> config = loadConfig(true);
        if (!config) {
            readyToReconfigure = true;
            return;
        }
 
        // set new termination timeout, if given
        setTerminationTimeout(*config);
 
        init_t* appInit;
        shared_ptr<HandleRequestFunctionWrapper> appHandleRequest;
        try {
            tie(appInit, appHandleRequest) = loadAppFunctions(*config);
        } catch (Exception const& e) {
            NLOG_ERROR(logger, "ERROR: Could not reload app: " << e.getMessage())
            NLOG_DEBUG(logger, "Debug info: " << e.getDebugMessage())
            NLOG_WARNING(logger, "WARNING: Configuration will be reloaded anyway")
 
            // just reload config, not app
            requestHandlerPtr->reconfigure(nullopt, nullopt, config);
            readyToReconfigure = true;
            return;
        }
 
        {
            AppInit appInitStruct(*config, getConcurrency(*config));
            auto initReturn = appInit(appInitStruct);
 
            // init function of the app should return 0 on success, otherwise we will not reload
            if (initReturn != 0) {
                NLOG_ERROR(logger,
                           "ERROR: App init function returned " << initReturn << " -- cancelling reload of app.")
                NLOG_WARNING(logger, "WARNING: Configuration will be reloaded anyway")
 
                // just reload config, not app
                requestHandlerPtr->reconfigure(nullopt, nullopt, config);
                readyToReconfigure = true;
                return;
            }
 
            // reconfigure everything
            requestHandlerPtr->reconfigure(appHandleRequest, appInitStruct.accessFilters(), appInitStruct.config());
            readyToReconfigure = true;
        }
    }
}
 
optional<PrivilegeDowngradeData> nawarun::preparePrivilegeDowngrade(Config const& config) {
    auto initialUID = getuid();
    uid_t privUID = -1;
    gid_t privGID = -1;
    vector<gid_t> supplementaryGroups;
 
    if (initialUID == 0) {
        if (!config.isSet({"privileges", "user"}) || !config.isSet({"privileges", "group"})) {
            throw Exception(__PRETTY_FUNCTION__, 1,
                            "Running as root and user or group for privilege downgrade is not set in the configuration.");
        }
        string username = config[{"privileges", "user"}];
        string groupname = config[{"privileges", "group"}];
        passwd* privUser;
        group* privGroup;
        privUser = getpwnam(username.c_str());
        privGroup = getgrnam(groupname.c_str());
        if (privUser == nullptr || privGroup == nullptr) {
            throw Exception(__PRETTY_FUNCTION__, 2,
                            "The user or group name for privilege downgrade given in the configuration is invalid.");
        }
        privUID = privUser->pw_uid;
        privGID = privGroup->gr_gid;
        if (privUID == 0 || privGID == 0) {
            NLOG_WARNING(logger, "WARNING: nawarun will be running as user or group root. Security risk!")
        } else {
            // get supplementary groups for non-root user
            int n = 0;
            getgrouplist(username.c_str(), privGID, nullptr, &n);
            supplementaryGroups.resize(n, 0);
            if (getgrouplist(username.c_str(), privGID, oss::getGIDPtrForGetgrouplist(&supplementaryGroups[0]), &n) != n) {
                NLOG_WARNING(logger, "WARNING: Could not get supplementary groups for user " << username)
                supplementaryGroups = {privGID};
            }
        }
        return make_tuple(privUID, privGID, supplementaryGroups);
    }
 
    NLOG_WARNING(logger, "WARNING: Not starting as root, cannot set privileges.")
    return nullopt;
}
 
void nawarun::replaceLogger(Log const& log) {
    logger = log;
}
 
Parameters nawarun::parseCommandLine(int argc, char** argv) {
    // start from arg 1 (as 0 is the program), iterate through all arguments and add valid options in the format
    // --category:key=value to overrides
    optional<string> configPath;
    vector<pair<pair<string, string>, string>> overrides;
    bool noConfigFile = false;
    for (size_t i = 1; i < argc; ++i) {
        string currentArg(argv[i]);
 
        if (i == 1 && (currentArg == "--help" || currentArg == "-h")) {
            printHelpAndExit();
        }
 
        if (i == 1 && (currentArg == "--version" || currentArg == "-v")) {
            printVersionAndExit();
        }
 
        if (currentArg.substr(0, 2) == "--") {
            auto idAndVal = utils::splitString(currentArg.substr(2), '=', true);
            if (idAndVal.size() == 2) {
                auto categoryAndKey = utils::splitString(idAndVal.at(0), ':', true);
                string const& value = idAndVal.at(1);
                if (categoryAndKey.size() == 2) {
                    string const& category = categoryAndKey.at(0);
                    string const& key = categoryAndKey.at(1);
                    overrides.push_back({{category, key}, value});
                    continue;
                }
            }
        }
 
        // last argument is interpreted as config file if it does not match the pattern
        // if "--no-config-file" is given as the last argument, no config file is used
        if (i == argc - 1) {
            if (currentArg != "--no-config-file") {
                configPath = currentArg;
            } else {
                noConfigFile = true;
            }
        } else {
            NLOG_WARNING(logger, "WARNING: Invalid command line argument \"" << currentArg << "\" will be ignored")
        }
    }
 
    // use config.ini in current directory if no config file was given and --no-config-file option is not set
    if (!configPath && !noConfigFile) {
        configPath = "config.ini";
    }
 
    return {configPath, overrides};
}
 
int nawarun::run(Parameters const& parameters) {
    setUpSignalHandlers();
 
    configFile = parameters.configFile;
    optional<Config> config = loadConfig();
    if (!config)
        return 1;
    config->override(parameters.configOverrides);
 
    setTerminationTimeout(*config);
    setUpLogging(*config);
 
    // prepare privilege downgrade and check for errors (downgrade will happen after socket setup)
    optional<PrivilegeDowngradeData> privilegeDowngradeData;
    try {
        privilegeDowngradeData = preparePrivilegeDowngrade(*config);
    } catch (Exception const& e) {
        NLOG_ERROR(logger, "Fatal Error: " << e.getMessage())
        NLOG_DEBUG(logger, "Debug info: " << e.getDebugMessage())
        return 1;
    }
 
    // load init and handleRequest symbols from app
    init_t* appInit;
    shared_ptr<HandleRequestFunctionWrapper> appHandleRequest;
    try {
        tie(appInit, appHandleRequest) = loadAppFunctions(*config);
    } catch (Exception const& e) {
        NLOG_ERROR(logger, "Fatal Error: " << e.getMessage())
        NLOG_DEBUG(logger, "Debug info: " << e.getDebugMessage())
        return 1;
    }
 
    // pass config, app function, and concurrency to RequestHandler
    // already here to make (socket) preparation possible before privilege downgrade
    auto concurrency = getConcurrency(*config);
    try {
        requestHandlerPtr = RequestHandler::newRequestHandler(appHandleRequest, *config, concurrency);
    } catch (Exception const& e) {
        NLOG_ERROR(logger, "Fatal Error: " << e.getMessage())
        NLOG_DEBUG(logger, "Debug info: " << e.getDebugMessage())
        return 1;
    }
 
    // do privilege downgrade if possible
    if (privilegeDowngradeData) {
        doPrivilegeDowngrade(*privilegeDowngradeData);
    }
 
    // before request handling starts, init app
    {
        AppInit appInitStruct(*config, concurrency);
        auto initReturn = appInit(appInitStruct);
 
        // init function of the app should return 0 on success
        if (initReturn != 0) {
            NLOG_ERROR(logger, "Fatal Error: App init function returned " << initReturn << " -- exiting.")
            return 1;
        }
 
        // reconfigure request handler using access filters and (potentially altered by app init) config
        requestHandlerPtr->reconfigure(nullopt, appInitStruct.accessFilters(), appInitStruct.config());
    }
 
    try {
        requestHandlerPtr->start();
        readyToReconfigure = true;
    } catch (const Exception& e) {
        NLOG_ERROR(logger, "Fatal Error: " << e.getMessage())
        NLOG_DEBUG(logger, "Debug info: " << e.getDebugMessage())
    }
 
    requestHandlerPtr->join();
 
    // the request handler has to be destroyed before unloading the app (using dlclose)
    requestHandlerPtr.reset(nullptr);
 
    return 0;
}