mirror of https://github.com/oxen-io/oxen-core.git
450 lines
17 KiB
C++
450 lines
17 KiB
C++
// Copyright (c) 2017-2019, 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 <chrono>
|
|
#include <cstddef>
|
|
#include <string>
|
|
|
|
#include "device.hpp"
|
|
#include "device/io_ledger_tcp.hpp"
|
|
#include "io_hid.hpp"
|
|
#include "log.hpp"
|
|
|
|
namespace hw::ledger {
|
|
|
|
using namespace std::literals;
|
|
|
|
// Required coin value as returned by INS_GET_NETWORK during connection
|
|
constexpr auto COIN_NETWORK = "OXEN"sv;
|
|
|
|
/* Minimal supported version */
|
|
constexpr std::array<uint8_t, 3> MINIMUM_APP_VERSION{0, 9, 0};
|
|
|
|
void register_all(std::map<std::string, std::unique_ptr<device>>& registry);
|
|
|
|
#ifdef WITH_DEVICE_LEDGER
|
|
|
|
#define SW_OK 0x9000
|
|
|
|
#define SW_WRONG_LENGTH 0x6700
|
|
|
|
#define SW_SECURITY_PIN_LOCKED 0x6910
|
|
#define SW_SECURITY_LOAD_KEY 0x6911
|
|
#define SW_SECURITY_COMMITMENT_CONTROL 0x6912
|
|
#define SW_SECURITY_AMOUNT_CHAIN_CONTROL 0x6913
|
|
#define SW_SECURITY_COMMITMENT_CHAIN_CONTROL 0x6914
|
|
#define SW_SECURITY_OUTKEYS_CHAIN_CONTROL 0x6915
|
|
#define SW_SECURITY_MAXOUTPUT_REACHED 0x6916
|
|
#define SW_SECURITY_HMAC 0x6917
|
|
#define SW_SECURITY_RANGE_VALUE 0x6918
|
|
#define SW_SECURITY_INTERNAL 0x6919
|
|
#define SW_SECURITY_MAX_SIGNATURE_REACHED 0x691A
|
|
#define SW_SECURITY_PREFIX_HASH 0x691B
|
|
#define SW_SECURITY_LOCKED 0x69EE
|
|
|
|
#define SW_COMMAND_NOT_ALLOWED 0x6980
|
|
#define SW_SUBCOMMAND_NOT_ALLOWED 0x6981
|
|
#define SW_DENY 0x6982
|
|
#define SW_KEY_NOT_SET 0x6983
|
|
#define SW_WRONG_DATA 0x6984
|
|
#define SW_WRONG_DATA_RANGE 0x6985
|
|
#define SW_IO_FULL 0x6986
|
|
|
|
#define SW_CLIENT_NOT_SUPPORTED 0x6A30
|
|
|
|
#define SW_WRONG_P1P2 0x6B00
|
|
#define SW_INS_NOT_SUPPORTED 0x6D00
|
|
#define SW_PROTOCOL_NOT_SUPPORTED 0x6E00
|
|
|
|
#define SW_UNKNOWN 0x6F00
|
|
|
|
void set_apdu_verbose(bool verbose);
|
|
|
|
class ABPkeys {
|
|
public:
|
|
rct::key Aout;
|
|
rct::key Bout;
|
|
bool is_subaddress;
|
|
bool is_change_address;
|
|
bool additional_key;
|
|
size_t index;
|
|
rct::key Pout;
|
|
rct::key AKout;
|
|
ABPkeys(const rct::key& A,
|
|
const rct::key& B,
|
|
const bool is_subaddr,
|
|
bool is_subaddress,
|
|
bool is_change_address,
|
|
size_t index,
|
|
const rct::key& P,
|
|
const rct::key& AK);
|
|
ABPkeys(const ABPkeys& keys);
|
|
ABPkeys() {
|
|
index = 0;
|
|
is_subaddress = false;
|
|
is_change_address = false;
|
|
additional_key = false;
|
|
}
|
|
ABPkeys& operator=(const ABPkeys& keys);
|
|
};
|
|
|
|
class Keymap {
|
|
public:
|
|
std::vector<ABPkeys> ABP;
|
|
|
|
bool find(const rct::key& P, ABPkeys& keys) const;
|
|
void add(const ABPkeys& keys);
|
|
void clear();
|
|
void log();
|
|
};
|
|
|
|
class SecHMAC {
|
|
public:
|
|
uint32_t sec[32];
|
|
uint32_t hmac[32];
|
|
|
|
SecHMAC(const uint8_t s[32], const uint8_t m[32]);
|
|
};
|
|
|
|
class HMACmap {
|
|
public:
|
|
std::vector<SecHMAC> hmacs;
|
|
|
|
void find_mac(const unsigned char sec[32], unsigned char hmac[32]);
|
|
void add_mac(const unsigned char sec[32], const unsigned char hmac[32]);
|
|
void clear();
|
|
};
|
|
|
|
#define BUFFER_SEND_SIZE 262
|
|
#define BUFFER_RECV_SIZE 262
|
|
|
|
class device_ledger : public device {
|
|
private:
|
|
// Locker for concurrent access
|
|
mutable std::recursive_mutex device_locker;
|
|
mutable std::mutex command_locker;
|
|
|
|
// IO
|
|
std::unique_ptr<io::device> hw_device;
|
|
unsigned int length_send;
|
|
unsigned char buffer_send[BUFFER_SEND_SIZE];
|
|
unsigned int length_recv;
|
|
unsigned char buffer_recv[BUFFER_RECV_SIZE];
|
|
unsigned int sw;
|
|
unsigned int id;
|
|
std::chrono::steady_clock::time_point last_cmd;
|
|
void logCMD();
|
|
void logRESP();
|
|
unsigned int exchange(bool wait_on_input = false);
|
|
void reset_buffer();
|
|
int set_command_header(unsigned char ins, unsigned char p1 = 0x00, unsigned char p2 = 0x00);
|
|
int set_command_header_noopt(
|
|
unsigned char ins, unsigned char p1 = 0x00, unsigned char p2 = 0x00);
|
|
void send_simple(unsigned char ins, unsigned char p1 = 0x00);
|
|
void send_bytes(const void* buf, size_t size, int& offset);
|
|
void receive_bytes(void* dest, size_t size, int& offset);
|
|
void receive_bytes(void* dest, size_t size);
|
|
void send_u16(uint16_t x, int& offset);
|
|
void send_u32(uint32_t x, int& offset);
|
|
uint32_t receive_u32(int& offset);
|
|
uint32_t receive_u32();
|
|
void send_secret(const unsigned char sec[32], int& offset);
|
|
void send_secret(const char sec[32], int& offset) {
|
|
send_secret(reinterpret_cast<const unsigned char*>(sec), offset);
|
|
}
|
|
void receive_secret(unsigned char sec[32], int& offset);
|
|
void receive_secret(char sec[32], int& offset) {
|
|
receive_secret(reinterpret_cast<unsigned char*>(sec), offset);
|
|
}
|
|
void check_network_type();
|
|
void exchange_multipart_data(
|
|
uint8_t ins, uint8_t p1, std::string_view data, uint8_t chunk_size);
|
|
|
|
void send_finish(int& offset);
|
|
unsigned int finish_and_exchange(int& offset, bool wait_on_input = false);
|
|
|
|
bool tx_in_progress;
|
|
|
|
cryptonote::network_type nettype =
|
|
cryptonote::network_type::UNDEFINED; // Set by the wallet before connecting
|
|
|
|
// map public destination key to ephemeral destination key
|
|
Keymap key_map;
|
|
bool add_output_key_mapping(
|
|
const crypto::public_key& Aout,
|
|
const crypto::public_key& Bout,
|
|
bool is_subaddress,
|
|
bool is_change,
|
|
bool need_additional,
|
|
size_t real_output_index,
|
|
const rct::key& amount_key,
|
|
const crypto::public_key& out_eph_public_key);
|
|
// hmac for some encrypted value
|
|
HMACmap hmac_map;
|
|
|
|
// To speed up blockchain parsing the view key maybe handle here.
|
|
crypto::secret_key viewkey;
|
|
bool has_view_key;
|
|
|
|
// extra debug
|
|
#ifdef DEBUG_HWDEVICE
|
|
device* debug_device;
|
|
#endif
|
|
|
|
public:
|
|
// Constructs a ledger device object that connects to a physical ledger device plugged into
|
|
// the system.
|
|
device_ledger();
|
|
|
|
// Constructs a ledger device object that uses a TCP socket to communicate with the ledger
|
|
// device, typically for use with a Ledger emulator which doesn't emulated the USB layer.
|
|
explicit device_ledger(io::ledger_tcp&& tcp);
|
|
|
|
~device_ledger();
|
|
|
|
device_ledger(const device_ledger&) = delete;
|
|
device_ledger(device_ledger&&) = delete;
|
|
device_ledger& operator=(const device_ledger&) = delete;
|
|
device_ledger&& operator=(device_ledger&&) = delete;
|
|
|
|
bool is_hardware_device() const override {
|
|
return connected();
|
|
}
|
|
|
|
bool reset();
|
|
|
|
/* ======================================================================= */
|
|
/* SETUP/TEARDOWN */
|
|
/* ======================================================================= */
|
|
bool set_name(std::string_view name) override;
|
|
|
|
void set_address(std::string_view addr) override;
|
|
|
|
std::string get_name() const override;
|
|
bool init() override;
|
|
bool release() override;
|
|
bool connect() override;
|
|
bool disconnect() override;
|
|
bool connected() const;
|
|
|
|
bool set_mode(mode m) override;
|
|
|
|
type get_type() const override {
|
|
return type::LEDGER;
|
|
};
|
|
protocol device_protocol() const override {
|
|
return protocol::PROXY;
|
|
};
|
|
|
|
/* ======================================================================= */
|
|
/* LOCKER */
|
|
/* ======================================================================= */
|
|
void lock() override;
|
|
void unlock() override;
|
|
bool try_lock() override;
|
|
|
|
/* ======================================================================= */
|
|
/* WALLET & ADDRESS */
|
|
/* ======================================================================= */
|
|
bool get_public_address(cryptonote::account_public_address& pubkey) override;
|
|
bool get_secret_keys(crypto::secret_key& viewkey, crypto::secret_key& spendkey) override;
|
|
bool generate_chacha_key(
|
|
const cryptonote::account_keys& keys,
|
|
crypto::chacha_key& key,
|
|
uint64_t kdf_rounds) override;
|
|
void display_address(
|
|
const cryptonote::subaddress_index& index,
|
|
const std::optional<crypto::hash8>& payment_id) override;
|
|
void set_network_type(cryptonote::network_type network_type) override;
|
|
|
|
/* ======================================================================= */
|
|
/* SUB ADDRESS */
|
|
/* ======================================================================= */
|
|
bool derive_subaddress_public_key(
|
|
const crypto::public_key& pub,
|
|
const crypto::key_derivation& derivation,
|
|
const std::size_t output_index,
|
|
crypto::public_key& derived_pub) override;
|
|
crypto::public_key get_subaddress_spend_public_key(
|
|
const cryptonote::account_keys& keys,
|
|
const cryptonote::subaddress_index& index) override;
|
|
std::vector<crypto::public_key> get_subaddress_spend_public_keys(
|
|
const cryptonote::account_keys& keys,
|
|
uint32_t account,
|
|
uint32_t begin,
|
|
uint32_t end) override;
|
|
cryptonote::account_public_address get_subaddress(
|
|
const cryptonote::account_keys& keys,
|
|
const cryptonote::subaddress_index& index) override;
|
|
crypto::secret_key get_subaddress_secret_key(
|
|
const crypto::secret_key& sec, const cryptonote::subaddress_index& index) override;
|
|
|
|
/* ======================================================================= */
|
|
/* DERIVATION & KEY */
|
|
/* ======================================================================= */
|
|
bool verify_keys(
|
|
const crypto::secret_key& secret_key, const crypto::public_key& public_key) override;
|
|
bool scalarmultKey(rct::key& aP, const rct::key& P, const rct::key& a) override;
|
|
bool scalarmultBase(rct::key& aG, const rct::key& a) override;
|
|
bool sc_secret_add(
|
|
crypto::secret_key& r,
|
|
const crypto::secret_key& a,
|
|
const crypto::secret_key& b) override;
|
|
crypto::secret_key generate_keys(
|
|
crypto::public_key& pub,
|
|
crypto::secret_key& sec,
|
|
const crypto::secret_key& recovery_key = crypto::secret_key(),
|
|
bool recover = false) override;
|
|
crypto::key_derivation generate_key_derivation(
|
|
const crypto::public_key& pub, const crypto::secret_key& sec) override;
|
|
bool generate_key_derivation(
|
|
const crypto::public_key& pub,
|
|
const crypto::secret_key& sec,
|
|
crypto::key_derivation& derivation) override;
|
|
bool conceal_derivation(
|
|
crypto::key_derivation& derivation,
|
|
const crypto::public_key& tx_pub_key,
|
|
const std::vector<crypto::public_key>& additional_tx_pub_keys,
|
|
const crypto::key_derivation& main_derivation,
|
|
const std::vector<crypto::key_derivation>& additional_derivations) override;
|
|
bool derivation_to_scalar(
|
|
const crypto::key_derivation& derivation,
|
|
const size_t output_index,
|
|
crypto::ec_scalar& res) override;
|
|
bool derive_secret_key(
|
|
const crypto::key_derivation& derivation,
|
|
const std::size_t output_index,
|
|
const crypto::secret_key& sec,
|
|
crypto::secret_key& derived_sec) override;
|
|
bool derive_public_key(
|
|
const crypto::key_derivation& derivation,
|
|
const std::size_t output_index,
|
|
const crypto::public_key& pub,
|
|
crypto::public_key& derived_pub) override;
|
|
bool secret_key_to_public_key(const crypto::secret_key& sec, crypto::public_key& pub) override;
|
|
bool generate_key_image(
|
|
const crypto::public_key& pub,
|
|
const crypto::secret_key& sec,
|
|
crypto::key_image& image) override;
|
|
bool generate_key_image_signature(
|
|
const crypto::key_image& image,
|
|
const crypto::public_key& pub,
|
|
const crypto::secret_key& sec,
|
|
crypto::signature& sig) override;
|
|
bool generate_unlock_signature(
|
|
const crypto::public_key& pub,
|
|
const crypto::secret_key& sec,
|
|
crypto::signature& sig) override;
|
|
bool generate_ons_signature(
|
|
std::string_view sig_data,
|
|
const cryptonote::account_keys& keys,
|
|
const cryptonote::subaddress_index& index,
|
|
crypto::signature& sig) override;
|
|
|
|
/* ======================================================================= */
|
|
/* TRANSACTION */
|
|
/* ======================================================================= */
|
|
void generate_tx_proof(
|
|
const crypto::hash& prefix_hash,
|
|
const crypto::public_key& R,
|
|
const crypto::public_key& A,
|
|
const std::optional<crypto::public_key>& B,
|
|
const crypto::public_key& D,
|
|
const crypto::secret_key& r,
|
|
crypto::signature& sig) override;
|
|
|
|
bool open_tx(
|
|
crypto::secret_key& tx_key,
|
|
cryptonote::txversion tx_version,
|
|
cryptonote::txtype tx_type) override;
|
|
|
|
void get_transaction_prefix_hash(
|
|
const cryptonote::transaction_prefix& tx, crypto::hash& h) override;
|
|
|
|
bool encrypt_payment_id(
|
|
crypto::hash8& payment_id,
|
|
const crypto::public_key& public_key,
|
|
const crypto::secret_key& secret_key) override;
|
|
|
|
rct::key genCommitmentMask(const rct::key& amount_key) override;
|
|
|
|
bool ecdhEncode(
|
|
rct::ecdhTuple& unmasked, const rct::key& sharedSec, bool short_format) override;
|
|
bool ecdhDecode(rct::ecdhTuple& masked, const rct::key& sharedSec, bool short_format) override;
|
|
|
|
bool generate_output_ephemeral_keys(
|
|
size_t tx_version,
|
|
bool& found_change,
|
|
const cryptonote::account_keys& sender_account_keys,
|
|
const crypto::public_key& txkey_pub,
|
|
const crypto::secret_key& tx_key,
|
|
const cryptonote::tx_destination_entry& dst_entr,
|
|
const std::optional<cryptonote::tx_destination_entry>& change_addr,
|
|
size_t output_index,
|
|
bool need_additional_txkeys,
|
|
const std::vector<crypto::secret_key>& additional_tx_keys,
|
|
std::vector<crypto::public_key>& additional_tx_public_keys,
|
|
std::vector<rct::key>& amount_keys,
|
|
crypto::public_key& out_eph_public_key) override;
|
|
|
|
bool clsag_prehash(
|
|
const std::string& blob,
|
|
size_t inputs_size,
|
|
size_t outputs_size,
|
|
const rct::keyV& hashes,
|
|
const rct::ctkeyV& outPk,
|
|
rct::key& prehash) override;
|
|
bool clsag_prepare(
|
|
const rct::key& p,
|
|
const rct::key& z,
|
|
rct::key& I,
|
|
rct::key& D,
|
|
const rct::key& H,
|
|
rct::key& a,
|
|
rct::key& aG,
|
|
rct::key& aH) override;
|
|
bool clsag_hash(const rct::keyV& data, rct::key& hash) override;
|
|
bool clsag_sign(
|
|
const rct::key& c,
|
|
const rct::key& a,
|
|
const rct::key& p,
|
|
const rct::key& z,
|
|
const rct::key& mu_P,
|
|
const rct::key& mu_C,
|
|
rct::key& s) override;
|
|
|
|
bool update_staking_tx_secret_key(crypto::secret_key& key) override;
|
|
|
|
bool close_tx() override;
|
|
};
|
|
#endif // WITH_DEVICE_LEDGER
|
|
} // namespace hw::ledger
|