// Copyright (c) 2018, 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 "message_transporter.h" #include "string_coding.h" #include #include "wallet_errors.h" #include "net/http_client.h" #include "net/net_parse_helpers.h" #include #undef MONERO_DEFAULT_LOG_CATEGORY #define MONERO_DEFAULT_LOG_CATEGORY "wallet.mms" #define PYBITMESSAGE_DEFAULT_API_PORT 8442 namespace mms { namespace bitmessage_rpc { struct message_info_t { uint32_t encodingType; std::string toAddress; uint32_t read; std::string msgid; std::string message; std::string fromAddress; std::string receivedTime; std::string subject; BEGIN_KV_SERIALIZE_MAP() KV_SERIALIZE(encodingType) KV_SERIALIZE(toAddress) KV_SERIALIZE(read) KV_SERIALIZE(msgid) KV_SERIALIZE(message); KV_SERIALIZE(fromAddress) KV_SERIALIZE(receivedTime) KV_SERIALIZE(subject) END_KV_SERIALIZE_MAP() }; typedef epee::misc_utils::struct_init message_info; struct inbox_messages_response_t { std::vector inboxMessages; BEGIN_KV_SERIALIZE_MAP() KV_SERIALIZE(inboxMessages) END_KV_SERIALIZE_MAP() }; typedef epee::misc_utils::struct_init inbox_messages_response; } message_transporter::message_transporter() { m_run = true; } void message_transporter::set_options(const std::string &bitmessage_address, const epee::wipeable_string &bitmessage_login) { m_bitmessage_url = bitmessage_address; epee::net_utils::http::url_content address_parts{}; epee::net_utils::parse_url(m_bitmessage_url, address_parts); if (address_parts.port == 0) { address_parts.port = PYBITMESSAGE_DEFAULT_API_PORT; } m_bitmessage_login = bitmessage_login; m_http_client.set_server(address_parts.host, std::to_string(address_parts.port), boost::none); } bool message_transporter::receive_messages(const std::vector &destination_transport_addresses, std::vector &messages) { // The message body of the Bitmessage message is basically the transport message, as JSON (and nothing more). // Weeding out other, non-MMS messages is done in a simple way: If it deserializes without error, it's an MMS message // That JSON is Base64-encoded by the MMS because the Monero epee JSON serializer does not escape anything and happily // includes even 0 (NUL) in strings, which might confuse Bitmessage or at least display confusingly in the client. // There is yet another Base64-encoding of course as part of the Bitmessage API for the message body parameter // The Bitmessage API call "getAllInboxMessages" gives back a JSON array with all the messages (despite using // XML-RPC for the calls, and not JSON-RPC ...) m_run.store(true, std::memory_order_relaxed); std::string request; start_xml_rpc_cmd(request, "getAllInboxMessages"); end_xml_rpc_cmd(request); std::string answer; post_request(request, answer); std::string json = get_str_between_tags(answer, "", ""); bitmessage_rpc::inbox_messages_response bitmessage_res; epee::serialization::load_t_from_json(bitmessage_res, json); size_t size = bitmessage_res.inboxMessages.size(); messages.clear(); for (size_t i = 0; i < size; ++i) { if (!m_run.load(std::memory_order_relaxed)) { // Stop was called, don't waste time processing any more messages return false; } const bitmessage_rpc::message_info &message_info = bitmessage_res.inboxMessages[i]; if (std::find(destination_transport_addresses.begin(), destination_transport_addresses.end(), message_info.toAddress) != destination_transport_addresses.end()) { transport_message message; bool is_mms_message = false; try { // First Base64-decoding: The message body is Base64 in the Bitmessage API std::string message_body = epee::string_encoding::base64_decode(message_info.message); // Second Base64-decoding: The MMS uses Base64 to hide non-textual data in its JSON from Bitmessage json = epee::string_encoding::base64_decode(message_body); epee::serialization::load_t_from_json(message, json); is_mms_message = true; } catch(const std::exception& e) { } if (is_mms_message) { message.transport_id = message_info.msgid; messages.push_back(message); } } } return true; } bool message_transporter::send_message(const transport_message &message) { // [encodingType [TTL]] std::string request; start_xml_rpc_cmd(request, "sendMessage"); add_xml_rpc_string_param(request, message.destination_transport_address); add_xml_rpc_string_param(request, message.source_transport_address); add_xml_rpc_base64_param(request, message.subject); std::string json = epee::serialization::store_t_to_json(message); std::string message_body = epee::string_encoding::base64_encode(json); // See comment in "receive_message" about reason for (double-)Base64 encoding add_xml_rpc_base64_param(request, message_body); add_xml_rpc_integer_param(request, 2); end_xml_rpc_cmd(request); std::string answer; post_request(request, answer); return true; } bool message_transporter::delete_message(const std::string &transport_id) { std::string request; start_xml_rpc_cmd(request, "trashMessage"); add_xml_rpc_string_param(request, transport_id); end_xml_rpc_cmd(request); std::string answer; post_request(request, answer); return true; } // Deterministically derive a transport / Bitmessage address from 'seed' (the 10-hex-digits // auto-config token will be used), but do not set it up for receiving in PyBitmessage as // well, because it's possible the address will only ever be used to SEND auto-config data std::string message_transporter::derive_transport_address(const std::string &seed) { std::string request; start_xml_rpc_cmd(request, "getDeterministicAddress"); add_xml_rpc_base64_param(request, seed); add_xml_rpc_integer_param(request, 4); // addressVersionNumber add_xml_rpc_integer_param(request, 1); // streamNumber end_xml_rpc_cmd(request); std::string answer; post_request(request, answer); std::string address = get_str_between_tags(answer, "", ""); return address; } // Derive a transport address and configure it for receiving in PyBitmessage, typically // for receiving auto-config messages by the wallet of the auto-config organizer std::string message_transporter::derive_and_receive_transport_address(const std::string &seed) { // We need to call both "get_deterministic_address" AND "createDeterministicAddresses" // because we won't get back the address from the latter call if it exists already std::string address = derive_transport_address(seed); std::string request; start_xml_rpc_cmd(request, "createDeterministicAddresses"); add_xml_rpc_base64_param(request, seed); add_xml_rpc_integer_param(request, 1); // numberOfAddresses add_xml_rpc_integer_param(request, 4); // addressVersionNumber end_xml_rpc_cmd(request); std::string answer; post_request(request, answer); return address; } bool message_transporter::delete_transport_address(const std::string &transport_address) { std::string request; start_xml_rpc_cmd(request, "deleteAddress"); add_xml_rpc_string_param(request, transport_address); end_xml_rpc_cmd(request); std::string answer; return post_request(request, answer); } bool message_transporter::post_request(const std::string &request, std::string &answer) { // Somehow things do not work out if one tries to connect "m_http_client" to Bitmessage // and keep it connected over the course of several calls. But with a new connection per // call and disconnecting after the call there is no problem (despite perhaps a small // slowdown) epee::net_utils::http::fields_list additional_params; // Basic access authentication according to RFC 7617 (which the epee HTTP classes do not seem to support?) // "m_bitmessage_login" just contains what is needed here, "user:password" std::string auth_string = epee::string_encoding::base64_encode((const unsigned char*)m_bitmessage_login.data(), m_bitmessage_login.size()); auth_string.insert(0, "Basic "); additional_params.push_back(std::make_pair("Authorization", auth_string)); additional_params.push_back(std::make_pair("Content-Type", "application/xml; charset=utf-8")); const epee::net_utils::http::http_response_info* response = NULL; std::chrono::milliseconds timeout = std::chrono::seconds(15); bool r = m_http_client.invoke("/", "POST", request, timeout, std::addressof(response), std::move(additional_params)); if (r) { answer = response->m_body; } else { LOG_ERROR("POST request to Bitmessage failed: " << request.substr(0, 300)); THROW_WALLET_EXCEPTION(tools::error::no_connection_to_bitmessage, m_bitmessage_url); } m_http_client.disconnect(); // see comment above std::string string_value = get_str_between_tags(answer, "", ""); if ((string_value.find("API Error") == 0) || (string_value.find("RPC ") == 0)) { THROW_WALLET_EXCEPTION(tools::error::bitmessage_api_error, string_value); } return r; } // Pick some string between two delimiters // When parsing the XML returned by PyBitmessage, don't bother to fully parse it but as a little hack rely on the // fact that e.g. a single string returned will be, however deeply nested in "...", delivered // between the very first "" and "" tags to be found in the XML std::string message_transporter::get_str_between_tags(const std::string &s, const std::string &start_delim, const std::string &stop_delim) { size_t first_delim_pos = s.find(start_delim); if (first_delim_pos != std::string::npos) { size_t end_pos_of_first_delim = first_delim_pos + start_delim.length(); size_t last_delim_pos = s.find(stop_delim); if (last_delim_pos != std::string::npos) { return s.substr(end_pos_of_first_delim, last_delim_pos - end_pos_of_first_delim); } } return std::string(); } void message_transporter::start_xml_rpc_cmd(std::string &xml, const std::string &method_name) { xml = (boost::format("%s") % method_name).str(); } void message_transporter::add_xml_rpc_string_param(std::string &xml, const std::string ¶m) { xml += (boost::format("%s") % param).str(); } void message_transporter::add_xml_rpc_base64_param(std::string &xml, const std::string ¶m) { // Bitmessage expects some arguments Base64-encoded, but it wants them as parameters of type "string", not "base64" that is also part of XML-RPC std::string encoded_param = epee::string_encoding::base64_encode(param); xml += (boost::format("%s") % encoded_param).str(); } void message_transporter::add_xml_rpc_integer_param(std::string &xml, const int32_t ¶m) { xml += (boost::format("%i") % param).str(); } void message_transporter::end_xml_rpc_cmd(std::string &xml) { xml += ""; } }