Code modifications to integrate Ledger HW device into monero-wallet-cli.

The basic approach it to delegate all sensitive data (master key, secret
ephemeral key, key derivation, ....) and related operations to the device.
As device has low memory, it does not keep itself the values
(except for view/spend keys) but once computed there are encrypted (with AES
are equivalent) and return back to monero-wallet-cli. When they need to be
manipulated by the device, they are decrypted on receive.

Moreover, using the client for storing the value in encrypted form limits
the modification in the client code. Those values are transfered from one
C-structure to another one as previously.

The code modification has been done with the wishes to be open to any
other hardware wallet. To achieve that a C++ class hw::Device has been
introduced. Two initial implementations are provided: the "default", which
remaps all calls to initial Monero code, and  the "Ledger", which delegates
all calls to Ledger device.

1 files changed, 202 insertions, 0 deletions

diff --git a/src/device/device_ledger.hpp b/src/device/device_ledger.hpp
new file mode 100644
index 000000000..ab8e0c553
--- /dev/null
+++ b/src/device/device_ledger.hpp
@@ -0,0 +1,202 @@
+// Copyright (c) 2017-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.
+//
+
+
+#pragma once
+
+#include <cstddef>
+#include <string>
+#include <mutex>
+#include "device.hpp"
+#include <PCSC/winscard.h>
+#include <PCSC/wintypes.h>
+
+
+namespace hw {
+
+    namespace ledger {
+
+    void register_all(std::map<std::string, std::unique_ptr<device>> &registry);
+
+    #ifdef WITH_DEVICE_LEDGER
+
+    namespace {
+        bool apdu_verbose =true;
+    }
+
+    void set_apdu_verbose(bool verbose);
+
+    class ABPkeys {
+    public:
+        rct::key Aout;
+        rct::key Bout;
+        size_t   index;
+        rct::key Pout;
+        rct::key AKout;
+        ABPkeys(const rct::key& A, const rct::key& B, size_t index, const rct::key& P,const rct::key& AK);
+        ABPkeys(const ABPkeys& keys) ;
+        ABPkeys() {index=0;}
+    };
+
+    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();
+    };
+
+    #define BUFFER_SEND_SIZE 262
+    #define BUFFER_RECV_SIZE 262
+
+    class device_ledger : public hw::device {
+    private:
+        mutable std::mutex   device_locker;
+        mutable std::mutex   tx_locker;
+        void lock_device() ;
+        void unlock_device() ;
+        void lock_tx() ;
+        void unlock_tx() ;
+ 
+        std::string  full_name;
+        SCARDCONTEXT hContext;
+        SCARDHANDLE  hCard;
+        DWORD        length_send;
+        BYTE         buffer_send[BUFFER_SEND_SIZE];
+        DWORD        length_recv;
+        BYTE         buffer_recv[BUFFER_RECV_SIZE];
+        unsigned int id;
+
+        Keymap key_map;
+
+
+        void logCMD(void);
+        void logRESP(void);
+        unsigned int  exchange(unsigned int ok=0x9000, unsigned int mask=0xFFFF);
+        void reset_buffer(void);
+
+        #ifdef DEBUGLEDGER
+        Device &controle_device;
+        #endif
+
+    public:
+        device_ledger();
+        ~device_ledger();
+
+        device_ledger(const device_ledger &device) = delete ;
+        device_ledger& operator=(const device_ledger &device) = delete;
+
+        explicit operator bool() const override {return this->hContext != 0;}
+
+        bool  reset(void);
+
+        /* ======================================================================= */
+        /*                              SETUP/TEARDOWN                             */
+        /* ======================================================================= */
+        bool set_name(const std::string &name) override;
+
+        const std::string get_name() const override;
+        bool init(void) override;
+        bool release() override;
+        bool connect(void) override;
+        bool disconnect() 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) 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;
+        bool  get_subaddress_spend_public_key(const cryptonote::account_keys& keys, const cryptonote::subaddress_index& index, crypto::public_key &D) override;
+        bool  get_subaddress_spend_public_keys(const cryptonote::account_keys &keys, uint32_t account, uint32_t begin, uint32_t end, std::vector<crypto::public_key> &pkeys) override;
+        bool  get_subaddress(const cryptonote::account_keys& keys, const cryptonote::subaddress_index &index, cryptonote::account_public_address &address) override;
+        bool  get_subaddress_secret_key(const crypto::secret_key &sec, const cryptonote::subaddress_index &index, crypto::secret_key &sub_sec) 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;
+        bool  generate_keys(crypto::public_key &pub, crypto::secret_key &sec, const crypto::secret_key& recovery_key, bool recover, crypto::secret_key &rng) override;
+        bool  generate_key_derivation(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation) 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;
+
+        /* ======================================================================= */
+        /*                               TRANSACTION                               */
+        /* ======================================================================= */
+
+        bool  open_tx(crypto::secret_key &tx_key) override;
+
+        bool  set_signature_mode(unsigned int sig_mode) override;
+
+        bool  encrypt_payment_id(const crypto::public_key &public_key, const crypto::secret_key &secret_key, crypto::hash8 &payment_id ) override;
+
+        bool  ecdhEncode(rct::ecdhTuple & unmasked, const rct::key & sharedSec) override;
+        bool  ecdhDecode(rct::ecdhTuple & masked, const rct::key & sharedSec) override;
+
+        bool  add_output_key_mapping(const crypto::public_key &Aout, const crypto::public_key &Bout, size_t real_output_index,
+                                            const rct::key &amount_key,  const crypto::public_key &out_eph_public_key) override;
+
+
+        bool  mlsag_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  mlsag_prepare(const rct::key &H, const rct::key &xx, rct::key &a, rct::key &aG, rct::key &aHP, rct::key &rvII) override;
+        bool  mlsag_prepare(rct::key &a, rct::key &aG) override;
+        bool  mlsag_hash(const rct::keyV &long_message, rct::key &c) override;
+        bool  mlsag_sign( const rct::key &c, const rct::keyV &xx, const rct::keyV &alpha, const size_t rows, const size_t dsRows, rct::keyV &ss) override;
+
+        bool  close_tx(void) override;
+
+    };
+
+
+
+    #ifdef DEBUGLEDGER
+    extern crypto::secret_key viewkey;
+    extern crypto::secret_key spendkey;
+    #endif
+
+    #endif  //WITH_DEVICE_LEDGER
+  }
+
+}
+