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, 263 insertions, 0 deletions

diff --git a/src/device/device_default.cpp b/src/device/device_default.cpp
new file mode 100644
index 000000000..a38d96c15
--- /dev/null
+++ b/src/device/device_default.cpp
@@ -0,0 +1,263 @@
+// 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.
+//
+
+
+
+
+#include "device_default.hpp"
+
+#include "cryptonote_basic/cryptonote_format_utils.h"
+#include "ringct/rctOps.h"
+
+namespace hw {
+
+    namespace core {
+
+        device_default::device_default() { }
+
+        device_default::~device_default() { }
+
+        /* ===================================================================== */
+        /* ===                        Misc                                ==== */
+        /* ===================================================================== */
+        static inline unsigned char *operator &(crypto::ec_scalar &scalar) {
+            return &reinterpret_cast<unsigned char &>(scalar);
+        }
+        static inline const unsigned char *operator &(const crypto::ec_scalar &scalar) {
+            return &reinterpret_cast<const unsigned char &>(scalar);
+        }
+
+        /* ======================================================================= */
+        /*                              SETUP/TEARDOWN                             */
+        /* ======================================================================= */
+        bool device_default::set_name(const std::string &name)  {
+            this->name = name;
+            return true;
+        }
+        const std::string device_default::get_name()  const {
+            return this->name;
+        }
+        
+        bool device_default::init(void) {
+            dfns();
+        }
+        bool device_default::release() {
+            dfns();
+        }
+
+        bool device_default::connect(void) {
+            dfns();
+        }
+        bool device_default::disconnect() {
+            dfns();
+        }
+
+        /* ======================================================================= */
+        /*                             WALLET & ADDRESS                            */
+        /* ======================================================================= */
+
+        bool  device_default::generate_chacha_key(const cryptonote::account_keys &keys, crypto::chacha_key &key) {
+            return cryptonote::generate_chacha_key_from_secret_keys(keys, key);
+        }
+        bool  device_default::get_public_address(cryptonote::account_public_address &pubkey) {
+             dfns();
+        }
+        bool  device_default::get_secret_keys(crypto::secret_key &viewkey , crypto::secret_key &spendkey)  {
+             dfns();
+        }
+        /* ======================================================================= */
+        /*                               SUB ADDRESS                               */
+        /* ======================================================================= */
+
+        bool device_default::derive_subaddress_public_key(const crypto::public_key &out_key, const crypto::key_derivation &derivation, const std::size_t output_index, crypto::public_key &derived_key) {
+            return crypto::derive_subaddress_public_key(out_key, derivation, output_index,derived_key);
+        }
+
+        bool device_default::get_subaddress_spend_public_key(const cryptonote::account_keys& keys, const cryptonote::subaddress_index &index, crypto::public_key &D) {
+            D = cryptonote::get_subaddress_spend_public_key(keys,index);
+            return true;
+        }
+
+        bool  device_default::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) {
+            pkeys = cryptonote::get_subaddress_spend_public_keys(keys, account, begin, end);
+            return true;
+        }
+
+        bool device_default::get_subaddress(const cryptonote::account_keys& keys, const cryptonote::subaddress_index &index, cryptonote::account_public_address &address) {
+            address = cryptonote::get_subaddress(keys,index);
+            return true;
+        }
+
+        bool  device_default::get_subaddress_secret_key(const crypto::secret_key &a, const cryptonote::subaddress_index &index, crypto::secret_key &m) {
+            m = cryptonote::get_subaddress_secret_key(a,index);
+            return true;
+        }
+
+        /* ======================================================================= */
+        /*                            DERIVATION & KEY                             */
+        /* ======================================================================= */
+
+        bool  device_default::verify_keys(const crypto::secret_key &secret_key, const crypto::public_key &public_key) {
+            return cryptonote::verify_keys(secret_key, public_key);
+        }
+
+        bool device_default::scalarmultKey(rct::key & aP, const rct::key &P, const rct::key &a) {
+            rct::scalarmultKey(aP, P,a);
+            return true;
+        }
+
+        bool device_default::scalarmultBase(rct::key &aG, const rct::key &a) {
+            rct::scalarmultBase(aG,a);
+            return true;
+        }
+
+        bool device_default::sc_secret_add(crypto::secret_key &r, const crypto::secret_key &a, const crypto::secret_key &b) {
+            sc_add(&r, &a, &b);
+            return true;
+        }
+
+        bool  device_default::generate_keys(crypto::public_key &pub, crypto::secret_key &sec, const crypto::secret_key& recovery_key, bool recover, crypto::secret_key &rng) {
+            rng = crypto::generate_keys(pub, sec, recovery_key, recover);
+            return true;
+        }
+
+        bool device_default::generate_key_derivation(const crypto::public_key &key1, const crypto::secret_key &key2, crypto::key_derivation &derivation) {
+            return crypto::generate_key_derivation(key1, key2, derivation);
+        }
+
+        bool device_default::derivation_to_scalar(const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res){
+            crypto::derivation_to_scalar(derivation,output_index, res);
+            return true;
+        }
+
+        bool device_default::derive_secret_key(const crypto::key_derivation &derivation, const std::size_t output_index, const crypto::secret_key &base, crypto::secret_key &derived_key){
+            crypto::derive_secret_key(derivation, output_index, base, derived_key);
+            return true;
+        }
+
+        bool device_default::derive_public_key(const crypto::key_derivation &derivation, const std::size_t output_index, const crypto::public_key &base, crypto::public_key &derived_key){
+            return crypto::derive_public_key(derivation, output_index, base, derived_key);
+        }
+
+        bool device_default::secret_key_to_public_key(const crypto::secret_key &sec, crypto::public_key &pub) {
+            return crypto::secret_key_to_public_key(sec,pub);
+        }
+
+        bool device_default::generate_key_image(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_image &image){
+            crypto::generate_key_image(pub, sec,image);
+            return true;
+        }
+
+        /* ======================================================================= */
+        /*                               TRANSACTION                               */
+        /* ======================================================================= */
+
+        bool device_default::open_tx(crypto::secret_key &tx_key) {
+            cryptonote::keypair txkey = cryptonote::keypair::generate();
+            tx_key = txkey.sec;
+            return true;
+        }
+
+
+        bool device_default::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)  {
+            return true;
+        }
+
+        bool  device_default::set_signature_mode(unsigned int sig_mode) {
+            return true;
+        }
+
+        bool  device_default::encrypt_payment_id(const crypto::public_key &public_key, const crypto::secret_key &secret_key, crypto::hash8 &payment_id ) {
+            return cryptonote::encrypt_payment_id(payment_id, public_key, secret_key);
+        }
+
+        bool  device_default::ecdhEncode(rct::ecdhTuple & unmasked, const rct::key & sharedSec) {
+            rct::ecdhEncode(unmasked, sharedSec);
+            return true;
+        }
+
+        bool  device_default::ecdhDecode(rct::ecdhTuple & masked, const rct::key & sharedSec) {
+            rct::ecdhDecode(masked, sharedSec);
+            return true;
+        }
+
+        bool device_default::mlsag_prepare(const rct::key &H, const rct::key &xx,
+                                         rct::key &a, rct::key &aG, rct::key &aHP, rct::key &II) {
+            rct::skpkGen(a, aG);
+            rct::scalarmultKey(aHP, H, a);
+            rct::scalarmultKey(II, H, xx);
+            return true;
+        }
+        bool  device_default::mlsag_prepare(rct::key &a, rct::key &aG) {
+            rct::skpkGen(a, aG);
+            return true;
+        }
+        bool  device_default::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) {
+            prehash = rct::cn_fast_hash(hashes);
+            return true;
+        }
+
+
+        bool device_default::mlsag_hash(const rct::keyV &toHash, rct::key &c_old) {
+            c_old = rct::hash_to_scalar(toHash);
+            return true;
+        }
+
+        bool device_default::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 ) {
+            CHECK_AND_ASSERT_THROW_MES(dsRows<=rows, "dsRows greater than rows");
+            CHECK_AND_ASSERT_THROW_MES(xx.size() == rows, "xx size does not match rows");
+            CHECK_AND_ASSERT_THROW_MES(alpha.size() == rows, "alpha size does not match rows");
+            CHECK_AND_ASSERT_THROW_MES(ss.size() == rows, "ss size does not match rows");
+            for (size_t j = 0; j < rows; j++) {
+                sc_mulsub(ss[j].bytes, c.bytes, xx[j].bytes, alpha[j].bytes);
+            }
+            return true;
+        }
+
+        bool device_default::close_tx() {
+            return true;
+        }
+
+
+        /* ---------------------------------------------------------- */
+        static device_default *default_core_device = NULL;
+        void register_all(std::map<std::string, std::unique_ptr<device>> &registry) {
+            if (!default_core_device) {
+                default_core_device = new device_default();
+                default_core_device->set_name("default_core_device");
+
+            }
+            registry.insert(std::make_pair("default",default_core_device));
+        }
+
+
+    }
+
+}
\ No newline at end of file