// Copyright (c) 2018-2020, 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. #include "client.h" #include #include #include #include #include #include "common/error.h" // monero/contrib/epee/include #include "error.h" #include "misc_log_ex.h" // monero/contrib/epee/include #include "net/http_client.h" // monero/contrib/epee/include #include "net/zmq.h" // monero/src #include "serialization/json_object.h" // monero/src #if MLWS_RMQ_ENABLED #include #include #endif namespace lws { namespace rpc { namespace http = epee::net_utils::http; namespace { constexpr const char signal_endpoint[] = "inproc://signal"; constexpr const char abort_scan_signal[] = "SCAN"; constexpr const char abort_process_signal[] = "PROCESS"; constexpr const char minimal_chain_topic[] = "json-minimal-chain_main"; constexpr const char full_txpool_topic[] = "json-full-txpool_add"; constexpr const int daemon_zmq_linger = 0; constexpr const std::chrono::seconds chain_poll_timeout{20}; constexpr const std::chrono::minutes chain_sub_timeout{4}; struct terminate { void operator()(void* ptr) const noexcept { if (ptr) { while (zmq_term(ptr)) { if (zmq_errno() != EINTR) break; } } } }; using zcontext = std::unique_ptr; #ifdef MLWS_RMQ_ENABLED constexpr const unsigned rmq_channel = 1; struct rdestroy { void operator()(amqp_connection_state_t ptr) const noexcept { if (ptr) { amqp_channel_close(ptr, rmq_channel, AMQP_REPLY_SUCCESS); amqp_connection_close(ptr, AMQP_REPLY_SUCCESS); amqp_destroy_connection(ptr); } } }; struct rcontext { using connection = std::unique_ptr; bool is_available() const noexcept { return conn != nullptr; } connection conn; std::string exchange; std::string routing; }; #else // !MLWS_RMQ_ENABLED struct rcontext { static constexpr bool is_available() noexcept { return false; } }; #endif expect do_wait(void* daemon, void* signal_sub, short events, std::chrono::milliseconds timeout) noexcept { if (timeout <= std::chrono::seconds{0}) return {lws::error::daemon_timeout}; zmq_pollitem_t items[2] { {daemon, 0, short(events | ZMQ_POLLERR), 0}, {signal_sub, 0, short(ZMQ_POLLIN | ZMQ_POLLERR), 0} }; for (;;) { const auto start = std::chrono::steady_clock::now(); const int ready = zmq_poll(items, 2, timeout.count()); const auto end = std::chrono::steady_clock::now(); const auto spent = std::chrono::duration_cast(start - end); timeout -= std::min(spent, timeout); if (ready == 0) return {lws::error::daemon_timeout}; if (0 < ready) break; const int err = zmq_errno(); if (err != EINTR) return net::zmq::make_error_code(err); } if (items[0].revents) return success(); char buf[1]; MONERO_ZMQ_CHECK(zmq_recv(signal_sub, buf, 1, 0)); switch (buf[0]) { case 'P': return {lws::error::signal_abort_process}; case 'S': return {lws::error::signal_abort_scan}; default: break; } return {lws::error::signal_unknown}; } template expect do_signal(void* signal_pub, const char (&signal)[N]) noexcept { MONERO_ZMQ_CHECK(zmq_send(signal_pub, signal, sizeof(signal) - 1, 0)); return success(); } template expect do_subscribe(void* signal_sub, const char (&signal)[N]) noexcept { MONERO_ZMQ_CHECK(zmq_setsockopt(signal_sub, ZMQ_SUBSCRIBE, signal, sizeof(signal) - 1)); return success(); } } // anonymous namespace detail { struct context { explicit context(zcontext comm, socket signal_pub, socket external_pub, rcontext rmq, std::string daemon_addr, std::string sub_addr, std::chrono::minutes interval) : comm(std::move(comm)) , signal_pub(std::move(signal_pub)) , external_pub(std::move(external_pub)) , rmq(std::move(rmq)) , daemon_addr(std::move(daemon_addr)) , sub_addr(std::move(sub_addr)) , rates_conn() , cache_time() , cache_interval(interval) , cached{} , sync_pub() , sync_rates() { if (std::chrono::minutes{0} < cache_interval) rates_conn.set_server(crypto_compare.host, boost::none, epee::net_utils::ssl_support_t::e_ssl_support_enabled); } zcontext comm; socket signal_pub; socket external_pub; rcontext rmq; const std::string daemon_addr; const std::string sub_addr; http::http_simple_client rates_conn; std::chrono::steady_clock::time_point cache_time; const std::chrono::minutes cache_interval; rates cached; boost::mutex sync_pub; boost::mutex sync_rates; }; } // detail expect client::get_response(cryptonote::rpc::Message& response, const std::chrono::seconds timeout, const source_location loc) { expect message = get_message(timeout); if (!message) return message.error(); try { cryptonote::rpc::FullMessage fm{std::move(*message)}; const cryptonote::rpc::error json_error = fm.getError(); if (!json_error.use) { response.fromJson(fm.getMessage()); return success(); } MERROR("Server returned RPC error: " << json_error.message << " with code " << json_error.code << " called from " << loc); } catch (const cryptonote::json::JSON_ERROR& error) { MERROR("Failed to parse json response: " << error.what() << " called from " << loc); } return {lws::error::bad_daemon_response}; } expect client::get_message(std::chrono::seconds timeout) { MONERO_PRECOND(ctx != nullptr); assert(daemon != nullptr); assert(signal_sub != nullptr); expect msg{common_error::kInvalidArgument}; while (!(msg = net::zmq::receive(daemon.get(), ZMQ_DONTWAIT))) { if (msg != net::zmq::make_error_code(EAGAIN)) break; MONERO_CHECK(do_wait(daemon.get(), signal_sub.get(), ZMQ_POLLIN, timeout)); timeout = std::chrono::seconds{0}; } // std::string move constructor is noexcept return msg; } expect client::make(std::shared_ptr ctx) noexcept { MONERO_PRECOND(ctx != nullptr); int option = daemon_zmq_linger; client out{std::move(ctx)}; out.daemon.reset(zmq_socket(out.ctx->comm.get(), ZMQ_REQ)); if (out.daemon.get() == nullptr) return net::zmq::get_error_code(); MONERO_ZMQ_CHECK(zmq_connect(out.daemon.get(), out.ctx->daemon_addr.c_str())); MONERO_ZMQ_CHECK(zmq_setsockopt(out.daemon.get(), ZMQ_LINGER, &option, sizeof(option))); if (!out.ctx->sub_addr.empty()) { out.daemon_sub.reset(zmq_socket(out.ctx->comm.get(), ZMQ_SUB)); if (out.daemon_sub.get() == nullptr) return net::zmq::get_error_code(); MONERO_ZMQ_CHECK(zmq_connect(out.daemon_sub.get(), out.ctx->sub_addr.c_str())); MONERO_CHECK(do_subscribe(out.daemon_sub.get(), minimal_chain_topic)); MONERO_CHECK(do_subscribe(out.daemon_sub.get(), full_txpool_topic)); } out.signal_sub.reset(zmq_socket(out.ctx->comm.get(), ZMQ_SUB)); if (out.signal_sub.get() == nullptr) return net::zmq::get_error_code(); MONERO_ZMQ_CHECK(zmq_connect(out.signal_sub.get(), signal_endpoint)); MONERO_CHECK(do_subscribe(out.signal_sub.get(), abort_process_signal)); return {std::move(out)}; } client::~client() noexcept {} bool client::has_publish() const noexcept { return ctx && (ctx->external_pub || ctx->rmq.is_available()); } expect client::watch_scan_signals() noexcept { MONERO_PRECOND(ctx != nullptr); assert(signal_sub != nullptr); return do_subscribe(signal_sub.get(), abort_scan_signal); } expect>> client::wait_for_block() { MONERO_PRECOND(ctx != nullptr); assert(daemon != nullptr); assert(signal_sub != nullptr); if (daemon_sub == nullptr) { MONERO_CHECK(do_wait(daemon.get(), signal_sub.get(), 0, chain_poll_timeout)); return {lws::error::daemon_timeout}; } { const expect ready = do_wait(daemon_sub.get(), signal_sub.get(), ZMQ_POLLIN, chain_sub_timeout); if (!ready) { if (ready == lws::error::daemon_timeout) MWARNING("ZeroMQ Pub/Sub chain timeout, check connection settings"); return ready.error(); } } std::vector> messages{}; for (; /*every message */ ;) { expect pub = net::zmq::receive(daemon_sub.get(), ZMQ_DONTWAIT); if (!pub) { if (pub == net::zmq::make_error_code(EAGAIN)) return {std::move(messages)}; return pub.error(); } if (pub->size() < 5) break; // for loop switch (pub->at(5)) { case 'm': // json-minimal-chain_main if (boost::string_ref{*pub}.starts_with(minimal_chain_topic)) { pub->erase(0, sizeof(minimal_chain_topic)); messages.emplace_back(topic::block, std::move(*pub)); } else MWARNING("Unexpected pub/sub message"); break; case 'f': // json-full-txpool_add if (boost::string_ref{*pub}.starts_with(full_txpool_topic)) { pub->erase(0, sizeof(full_txpool_topic)); messages.emplace_back(topic::txpool, std::move(*pub)); } else MWARNING("Unexpected pub/sub message"); break; default: break; } } // for every message return {lws::error::bad_daemon_response}; } expect client::send(epee::byte_slice message, std::chrono::seconds timeout) noexcept { MONERO_PRECOND(ctx != nullptr); assert(daemon != nullptr); assert(signal_sub != nullptr); expect sent; while (!(sent = net::zmq::send(message.clone(), daemon.get(), ZMQ_DONTWAIT))) { if (sent != net::zmq::make_error_code(EAGAIN)) return sent.error(); MONERO_CHECK(do_wait(daemon.get(), signal_sub.get(), ZMQ_POLLOUT, timeout)); timeout = std::chrono::seconds{0}; } return success(); } expect client::publish(epee::byte_slice payload) { MONERO_PRECOND(ctx != nullptr); assert(daemon != nullptr); if (ctx->external_pub == nullptr && !ctx->rmq.is_available()) return success(); expect rc = success(); const boost::unique_lock guard{ctx->sync_pub}; if (ctx->external_pub) rc = net::zmq::send(payload.clone(), ctx->external_pub.get(), 0); #ifdef MLWS_RMQ_ENABLED if (ctx->rmq.is_available() && boost::algorithm::starts_with(payload, boost::string_ref{payment_topic_json()})) { const auto topic = reinterpret_cast(std::memchr(payload.data(), ':', payload.size())); if (topic && topic >= payload.data()) payload.remove_prefix(topic - payload.data() + 1); amqp_bytes_t message{}; message.len = payload.size(); message.bytes = const_cast(payload.data()); const int rmq_rc = amqp_basic_publish(ctx->rmq.conn.get(), rmq_channel, amqp_cstring_bytes(ctx->rmq.exchange.c_str()), amqp_cstring_bytes(ctx->rmq.routing.c_str()), 0, 0, nullptr, message); if (rmq_rc != 0) { MERROR("Failed RMQ Publish with return code: " << rmq_rc); return {error::rmq_failure}; } } #endif return rc; } expect client::get_rates() const { MONERO_PRECOND(ctx != nullptr); if (ctx->cache_interval <= std::chrono::minutes{0}) return {lws::error::exchange_rates_disabled}; const auto now = std::chrono::steady_clock::now(); const boost::unique_lock lock{ctx->sync_rates}; if (now - ctx->cache_time >= ctx->cache_interval + std::chrono::seconds{30}) return {lws::error::exchange_rates_old}; return ctx->cached; } context context::make(std::string daemon_addr, std::string sub_addr, std::string pub_addr, rmq_details rmq_info, std::chrono::minutes rates_interval) { zcontext comm{zmq_init(1)}; if (comm == nullptr) MONERO_THROW(net::zmq::get_error_code(), "zmq_init"); detail::socket pub{zmq_socket(comm.get(), ZMQ_PUB)}; if (pub == nullptr) MONERO_THROW(net::zmq::get_error_code(), "zmq_socket"); if (zmq_bind(pub.get(), signal_endpoint) < 0) MONERO_THROW(net::zmq::get_error_code(), "zmq_bind"); detail::socket external_pub = nullptr; if (!pub_addr.empty()) { external_pub = detail::socket{zmq_socket(comm.get(), ZMQ_PUB)}; if (external_pub == nullptr) MONERO_THROW(net::zmq::get_error_code(), "zmq_socket"); if (zmq_bind(external_pub.get(), pub_addr.c_str()) < 0) MONERO_THROW(net::zmq::get_error_code(), "zmq_bind"); } rcontext rmq{}; #ifdef MLWS_RMQ_ENABLED if (!rmq_info.address.empty()) { rmq.exchange = std::move(rmq_info.exchange); rmq.routing = std::move(rmq_info.routing); epee::net_utils::http::url_content url{}; if (!epee::net_utils::parse_url(rmq_info.address, url)) MONERO_THROW(error::configuration, "Invalid URL spec given for RMQ"); if (url.port == 0) MONERO_THROW(error::configuration, "No port specified for RMQ"); if (url.uri.empty()) url.uri = "/"; std::string user; std::string pass; boost::regex expression{"(\\w+):(\\w+)"}; boost::smatch matcher; if (boost::regex_search(rmq_info.credentials, matcher, expression)) { user = matcher[1]; pass = matcher[2]; } rmq.conn.reset(amqp_new_connection()); const auto socket = amqp_tcp_socket_new(rmq.conn.get()); if (!socket) MONERO_THROW(error::configuration, "Unable to create RMQ socket"); int status = amqp_socket_open(socket, url.host.c_str(), url.port); if (status != 0) { MERROR("Unable to open RMQ socket: " << status); MONERO_THROW(error::rmq_failure, "Unable to open RMQ socket"); } if (!user.empty() || !pass.empty()) { if (amqp_login(rmq.conn.get(), url.uri.c_str(), 0, 131072, 0, AMQP_SASL_METHOD_PLAIN, user.c_str(), pass.c_str()).reply_type != AMQP_RESPONSE_NORMAL) MONERO_THROW(error::rmq_failure, "Failure to login RMQ socket"); } if (amqp_channel_open(rmq.conn.get(), rmq_channel) == nullptr) MONERO_THROW(error::rmq_failure, "Unabe to open RMQ channel"); if (amqp_get_rpc_reply(rmq.conn.get()).reply_type != AMQP_RESPONSE_NORMAL) MONERO_THROW(error::rmq_failure, "Failed receiving channel open reply"); MINFO("Connected to RMQ server " << url.host << ":" << url.port); } #else // !MLWS_RMQ_ENABLED if (!rmq_info.address.empty() || !rmq_info.exchange.empty() || !rmq_info.routing.empty() || !rmq_info.credentials.empty()) MONERO_THROW(error::configuration, "RabbitMQ support not enabled"); #endif return context{ std::make_shared( std::move(comm), std::move(pub), std::move(external_pub), std::move(rmq), std::move(daemon_addr), std::move(sub_addr), rates_interval ) }; } context::~context() noexcept { if (ctx) raise_abort_process(); } std::string const& context::daemon_address() const { if (ctx == nullptr) MONERO_THROW(common_error::kInvalidArgument, "Invalid lws::rpc::context"); return ctx->daemon_addr; } expect context::raise_abort_scan() noexcept { MONERO_PRECOND(ctx != nullptr); assert(ctx->signal_pub != nullptr); return do_signal(ctx->signal_pub.get(), abort_scan_signal); } expect context::raise_abort_process() noexcept { MONERO_PRECOND(ctx != nullptr); assert(ctx->signal_pub != nullptr); return do_signal(ctx->signal_pub.get(), abort_process_signal); } expect> context::retrieve_rates() { MONERO_PRECOND(ctx != nullptr); if (ctx->cache_interval <= std::chrono::minutes{0}) return boost::make_optional(false, ctx->cached); const auto now = std::chrono::steady_clock::now(); if (now - ctx->cache_time < ctx->cache_interval) return boost::make_optional(false, ctx->cached); expect fresh{lws::error::exchange_rates_fetch}; const http::http_response_info* info = nullptr; const bool retrieved = ctx->rates_conn.invoke_get(crypto_compare.path, std::chrono::seconds{20}, std::string{}, std::addressof(info)) && info != nullptr && info->m_response_code == 200; // \TODO Remove copy below if (retrieved) fresh = crypto_compare(std::string{info->m_body}); const boost::unique_lock lock{ctx->sync_rates}; ctx->cache_time = now; if (fresh) { ctx->cached = *fresh; return boost::make_optional(*fresh); } return fresh.error(); } } // rpc } // lws