userpass.hpp

Go to the documentation of this file.

//    OpenVPN -- An application to securely tunnel IP networks
//               over a single port, with support for SSL/TLS-based
//               session authentication and key exchange,
//               packet encryption, packet authentication, and
//               packet compression.
//
//    Copyright (C) 2012- OpenVPN Inc.
//
//    SPDX-License-Identifier: MPL-2.0 OR AGPL-3.0-only WITH openvpn3-openssl-exception
//
 
#ifndef OPENVPN_COMMON_USERPASS_H
#define OPENVPN_COMMON_USERPASS_H
 
#include <string>
#include <vector>
#include <utility>
 
#include <openvpn/common/exception.hpp>
#include <openvpn/common/options.hpp>
#include <openvpn/common/splitlines.hpp>
#include <openvpn/common/string.hpp>
#include <openvpn/common/file.hpp>
 
namespace openvpn::UserPass {
 
OPENVPN_EXCEPTION(creds_error);
 
enum Flags
{
    OPT_REQUIRED = (1 << 0),      
    OPT_OPTIONAL = (1 << 1),      
    USERNAME_REQUIRED = (1 << 2), 
    PASSWORD_REQUIRED = (1 << 3), 
    TRY_FILE = (1 << 4),          
};
 
inline bool parse(const OptionList &options,
                  const std::string &opt_name,
                  const unsigned int flags,
                  std::vector<std::string> *user_pass)
{
    const Option *auth_user_pass = options.get_ptr(opt_name);
    if (!auth_user_pass)
    {
        if (flags & OPT_REQUIRED)
            throw creds_error(opt_name + " : credentials option missing");
        return false;
    }
    if (auth_user_pass->size() == 1 && !(flags & OPT_REQUIRED))
        return true;
    if (auth_user_pass->size() != 2)
        throw creds_error(opt_name + " : credentials option incorrectly specified");
 
    std::string str = auth_user_pass->get(1, 1024 | Option::MULTILINE);
    if ((flags & TRY_FILE) && !string::is_multiline(str))
        str = read_text_utf8(str);
    SplitLines in(str, 1024);
    for (int i = 0; in(true) && i < 2; ++i)
    {
        if (user_pass)
            user_pass->push_back(in.line_move());
    }
    return true;
}
 
inline void parse(const OptionList &options,
                  const std::string &opt_name,
                  const unsigned int flags,
                  std::string &user,
                  std::string &pass)
{
    user.clear();
    pass.clear();
    std::vector<std::string> up;
    up.reserve(2);
    if (!parse(options, opt_name, flags, &up) && (flags & OPT_OPTIONAL))
        return;
    if (up.size() >= 1)
    {
        user = std::move(up[0]);
        if (up.size() >= 2)
            pass = std::move(up[1]);
    }
    if ((flags & USERNAME_REQUIRED) && string::is_empty(user))
        throw creds_error(opt_name + " : username empty");
    if ((flags & PASSWORD_REQUIRED) && string::is_empty(pass))
        throw creds_error(opt_name + " : password empty");
}
 
inline void parse_file(const std::string &path,
                       const unsigned int flags,
                       std::string &user,
                       std::string &pass)
{
    user.clear();
    pass.clear();
    const std::string str = read_text_utf8(path);
    SplitLines in(str, 1024);
    if (in(true))
    {
        user = in.line_move();
        if (in(true))
            pass = in.line_move();
    }
    if ((flags & USERNAME_REQUIRED) && string::is_empty(user))
        throw creds_error(path + " : username empty");
    if ((flags & PASSWORD_REQUIRED) && string::is_empty(pass))
        throw creds_error(path + " : password empty");
}
 
} // namespace openvpn::UserPass
 
#endif