cryptonote::rpc_args Struct Reference

Processes command line arguments related to server-side RPC. More...

#include <rpc_args.h>

Collaboration diagram for cryptonote::rpc_args:

Classes
struct	descriptors

Static Public Member Functions
static const char *	tr (const char *str)
static void	init_options (boost::program_options::options_description &desc, const bool any_cert_option=false)
static boost::optional< rpc_args >	process (const boost::program_options::variables_map &vm, const bool any_cert_option=false)
static boost::optional< epee::net_utils::ssl_options_t >	process_ssl (const boost::program_options::variables_map &vm, const bool any_cert_option=false)

Public Attributes
std::string	bind_ip
std::vector< std::string >	access_control_origins
boost::optional< tools::login >	login
epee::net_utils::ssl_options_t	ssl_options = epee::net_utils::ssl_support_t::e_ssl_support_enabled

Detailed Description

Processes command line arguments related to server-side RPC.

Definition at line 44 of file rpc_args.h.

Member Function Documentation

init_options()

void cryptonote::rpc_args::init_options ( boost::program_options::options_description & desc, const bool any_cert_option = false )

static

Definition at line 108 of file rpc_args.cpp.

  {
    const descriptors arg{};
    command_line::add_arg(desc, arg.rpc_bind_ip);
    command_line::add_arg(desc, arg.rpc_login);
    command_line::add_arg(desc, arg.confirm_external_bind);
    command_line::add_arg(desc, arg.rpc_access_control_origins);
    command_line::add_arg(desc, arg.rpc_ssl);
    command_line::add_arg(desc, arg.rpc_ssl_private_key);
    command_line::add_arg(desc, arg.rpc_ssl_certificate);
    command_line::add_arg(desc, arg.rpc_ssl_ca_certificates);
    command_line::add_arg(desc, arg.rpc_ssl_allowed_fingerprints);
    command_line::add_arg(desc, arg.rpc_ssl_allow_chained);
    if (any_cert_option)
      command_line::add_arg(desc, arg.rpc_ssl_allow_any_cert);
  }

Here is the call graph for this function:

Here is the caller graph for this function:

process()

boost::optional< rpc_args > cryptonote::rpc_args::process ( const boost::program_options::variables_map & vm, const bool any_cert_option = false )

static

Returns

Arguments specified by user, or boost::none if error

Definition at line 125 of file rpc_args.cpp.

  {
    const descriptors arg{};
    rpc_args config{};
    
    config.bind_ip = command_line::get_arg(vm, arg.rpc_bind_ip);
    if (!config.bind_ip.empty())
    {
      // always parse IP here for error consistency
      boost::system::error_code ec{};
      const auto parsed_ip = boost::asio::ip::address::from_string(config.bind_ip, ec);
      if (ec)
      {
        LOG_ERROR(tr("Invalid IP address given for --") << arg.rpc_bind_ip.name);
        return boost::none;
      }
 
      if (!parsed_ip.is_loopback() && !command_line::get_arg(vm, arg.confirm_external_bind))
      {
        LOG_ERROR(
          "--" << arg.rpc_bind_ip.name <<
          tr(" permits inbound unencrypted external connections. Consider SSH tunnel or SSL proxy instead. Override with --") <<
          arg.confirm_external_bind.name
        );
        return boost::none;
      }
    }
 
    const char *env_rpc_login = nullptr;
    const bool has_rpc_arg = command_line::has_arg(vm, arg.rpc_login);
    const bool use_rpc_env = !has_rpc_arg && (env_rpc_login = getenv("RPC_LOGIN")) != nullptr && strlen(env_rpc_login) > 0;
    boost::optional<tools::login> login{};
    if (has_rpc_arg || use_rpc_env)
    {
      config.login = tools::login::parse(
          has_rpc_arg ? command_line::get_arg(vm, arg.rpc_login) : std::string(env_rpc_login), true, [](bool verify) {
            return tools::password_container::prompt(verify, "RPC server password");
          });
 
      if (!config.login)
        return boost::none;
 
      if (config.login->username.empty())
      {
        LOG_ERROR(tr("Username specified with --") << arg.rpc_login.name << tr(" cannot be empty"));
        return boost::none;
      }
    }
 
    auto access_control_origins_input = command_line::get_arg(vm, arg.rpc_access_control_origins);
    if (!access_control_origins_input.empty())
    {
      if (!config.login)
      {
        LOG_ERROR(arg.rpc_access_control_origins.name  << tr(" requires RPC server password --") << arg.rpc_login.name << tr(" cannot be empty"));
        return boost::none;
      }
 
      std::vector<std::string> access_control_origins;
      boost::split(access_control_origins, access_control_origins_input, boost::is_any_of(","));
      std::for_each(access_control_origins.begin(), access_control_origins.end(), std::bind(&boost::trim<std::string>, std::placeholders::_1, std::locale::classic()));
      config.access_control_origins = std::move(access_control_origins);
    }
 
    auto ssl_options = do_process_ssl(vm, arg, any_cert_option);
    if (!ssl_options)
      return boost::none;
    config.ssl_options = std::move(*ssl_options);
 
    return {std::move(config)};
  }

Here is the call graph for this function:

Here is the caller graph for this function:

process_ssl()

boost::optional< epee::net_utils::ssl_options_t > cryptonote::rpc_args::process_ssl ( const boost::program_options::variables_map & vm, const bool any_cert_option = false )

static

Returns

SSL arguments specified by user, or boost::none if error

Definition at line 197 of file rpc_args.cpp.

  {
    const descriptors arg{};
    return do_process_ssl(vm, arg, any_cert_option);
  }

Here is the caller graph for this function:

tr()

const char * cryptonote::rpc_args::tr ( const char * str )

static

Definition at line 106 of file rpc_args.cpp.

{ return i18n_translate(str, "cryptonote::rpc_args"); }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

access_control_origins

std::vector<std::string> cryptonote::rpc_args::access_control_origins

Definition at line 80 of file rpc_args.h.

bind_ip

std::string cryptonote::rpc_args::bind_ip

Definition at line 79 of file rpc_args.h.

login

boost::optional<tools::login> cryptonote::rpc_args::login

Definition at line 81 of file rpc_args.h.

ssl_options

epee::net_utils::ssl_options_t cryptonote::rpc_args::ssl_options = epee::net_utils::ssl_support_t::e_ssl_support_enabled

Definition at line 82 of file rpc_args.h.

---

The documentation for this struct was generated from the following files:

• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/src/rpc/rpc_args.h
• /home/abuild/rpmbuild/BUILD/electroneum-5.1.3.1-build/electroneum-5.1.3.1/src/rpc/rpc_args.cpp