// Copyright (c) 2014-2023, The Monero Project // // All rights reserved. // // Redistribution and use in source and binary forms, with or without modification, are // permitted provided that the following conditions are met: // // 1. Redistributions of source code must retain the above copyright notice, this list of // conditions and the following disclaimer. // // 2. Redistributions in binary form must reproduce the above copyright notice, this list // of conditions and the following disclaimer in the documentation and/or other // materials provided with the distribution. // // 3. Neither the name of the copyright holder nor the names of its contributors may be // used to endorse or promote products derived from this software without specific // prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. // #pragma once #include #include #include #include #include "common/command_line.h" #include "common/password.h" #include "net/net_ssl.h" namespace cryptonote { //! Processes command line arguments related to server-side RPC struct rpc_args { // non-static construction prevents initialization order issues struct descriptors { descriptors(); descriptors(const descriptors&) = delete; descriptors(descriptors&&) = delete; descriptors& operator=(const descriptors&) = delete; descriptors& operator=(descriptors&&) = delete; const command_line::arg_descriptor rpc_bind_ip; const command_line::arg_descriptor rpc_bind_ipv6_address; const command_line::arg_descriptor rpc_restricted_bind_ip; const command_line::arg_descriptor rpc_restricted_bind_ipv6_address; const command_line::arg_descriptor rpc_use_ipv6; const command_line::arg_descriptor rpc_ignore_ipv4; const command_line::arg_descriptor rpc_login; const command_line::arg_descriptor confirm_external_bind; const command_line::arg_descriptor rpc_access_control_origins; const command_line::arg_descriptor rpc_ssl; const command_line::arg_descriptor rpc_ssl_private_key; const command_line::arg_descriptor rpc_ssl_certificate; const command_line::arg_descriptor rpc_ssl_ca_certificates; const command_line::arg_descriptor> rpc_ssl_allowed_fingerprints; const command_line::arg_descriptor rpc_ssl_allow_chained; const command_line::arg_descriptor rpc_ssl_allow_any_cert; const command_line::arg_descriptor disable_rpc_ban; }; // `allow_any_cert` bool toggles `--rpc-ssl-allow-any-cert` configuration static const char* tr(const char* str); static void init_options(boost::program_options::options_description& desc, const bool any_cert_option = false); //! \return Arguments specified by user, or `boost::none` if error static boost::optional process(const boost::program_options::variables_map& vm, const bool any_cert_option = false); //! \return SSL arguments specified by user, or `boost::none` if error static boost::optional process_ssl(const boost::program_options::variables_map& vm, const bool any_cert_option = false); std::string bind_ip; std::string bind_ipv6_address; std::string restricted_bind_ip; std::string restricted_bind_ipv6_address; bool use_ipv6; bool require_ipv4; std::vector access_control_origins; boost::optional login; // currently `boost::none` if unspecified by user epee::net_utils::ssl_options_t ssl_options = epee::net_utils::ssl_support_t::e_ssl_support_enabled; bool disable_rpc_ban = false; }; }