Add the possibility to export private view key for fast scan.

On client startup the device asks for authorization to export the private view key.
If user agree, the client hold the private view key allowing a fast blockchain scan.
If the user does not agree, the blockchain scan is fully done via the device.

6 files changed, 156 insertions, 82 deletions

diff --git a/src/device/device.hpp b/src/device/device.hpp
index dee191234..db489ff0c 100644
--- a/src/device/device.hpp
+++ b/src/device/device.hpp
@@ -78,6 +78,7 @@ namespace hw {
            return false;
     }
 
+
     class device {
     protected:
         std::string  name;
@@ -89,10 +90,12 @@ namespace hw {
         virtual ~device()   {}
 
         explicit virtual operator bool() const = 0;
-
-        static const int SIGNATURE_REAL = 0;
-        static const int SIGNATURE_FAKE = 1;
-
+        enum device_mode {
+            NONE,
+            TRANSACTION_CREATE_REAL,
+            TRANSACTION_CREATE_FAKE,
+            TRANSACTION_PARSE
+        };
 
         /* ======================================================================= */
         /*                              SETUP/TEARDOWN                             */
@@ -106,6 +109,9 @@ namespace hw {
         virtual bool connect(void) = 0;
         virtual bool disconnect(void) = 0;
 
+        virtual bool  set_mode(device_mode mode) = 0;
+
+
         /* ======================================================================= */
         /*  LOCKER                                                                 */
         /* ======================================================================= */ 
@@ -166,8 +172,6 @@ namespace hw {
 
         virtual bool  open_tx(crypto::secret_key &tx_key) = 0;
 
-        virtual bool  set_signature_mode(unsigned int sig_mode) = 0;
-
         virtual bool  encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) = 0;
         bool  decrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key)
         {
@@ -191,6 +195,12 @@ namespace hw {
         virtual bool  close_tx(void) = 0;
     } ;
 
+    struct reset_mode {
+        device& hwref;
+        reset_mode(hw::device& dev) : hwref(dev) { }
+        ~reset_mode() { hwref.set_mode(hw::device::NONE);}
+    };
+
     device& get_device(const std::string device_descriptor) ;
 }
 
diff --git a/src/device/device_default.cpp b/src/device/device_default.cpp
index fd6d1e5e2..96838a289 100644
--- a/src/device/device_default.cpp
+++ b/src/device/device_default.cpp
@@ -81,6 +81,9 @@ namespace hw {
             dfns();
         }
 
+        bool  device_default::set_mode(device_mode mode) {
+            return true;
+        }
 
         /* ======================================================================= */
         /*  LOCKER                                                                 */
@@ -273,10 +276,6 @@ namespace hw {
             return true;
         }
 
-        bool  device_default::set_signature_mode(unsigned int sig_mode) {
-            return true;
-        }
-
         bool  device_default::encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) {
             crypto::key_derivation derivation;
             crypto::hash hash;
diff --git a/src/device/device_default.hpp b/src/device/device_default.hpp
index f6a3261eb..53942f53a 100644
--- a/src/device/device_default.hpp
+++ b/src/device/device_default.hpp
@@ -58,6 +58,8 @@ namespace hw {
 
             bool connect(void) override;
             bool disconnect() override;
+ 
+            bool set_mode(device_mode mode) override;
 
             /* ======================================================================= */
             /*  LOCKER                                                                 */
@@ -104,9 +106,6 @@ namespace hw {
 
             bool  open_tx(crypto::secret_key &tx_key) override;
 
-            //bool  get_additional_key(const bool subaddr, cryptonote::keypair &additional_txkey) override;
-            bool  set_signature_mode(unsigned int sig_mode) override;
-
             bool  encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) override;
 
             bool  ecdhEncode(rct::ecdhTuple & unmasked, const rct::key & sharedSec) override;
diff --git a/src/device/device_ledger.cpp b/src/device/device_ledger.cpp
index 30ecb67bb..ee1497438 100644
--- a/src/device/device_ledger.cpp
+++ b/src/device/device_ledger.cpp
@@ -58,8 +58,8 @@ namespace hw {
     #define ASSERT_T0(exp)       CHECK_AND_ASSERT_THROW_MES(exp, "Protocol assert failure: "#exp ) ;
 
     #ifdef DEBUG_HWDEVICE
-      crypto::secret_key viewkey;
-      crypto::secret_key spendkey;
+      crypto::secret_key dbg_viewkey;
+      crypto::secret_key dbg_spendkey;
     #endif
 
     /* ===================================================================== */
@@ -119,7 +119,14 @@ namespace hw {
     #endif
 
     /* ===================================================================== */
-    /* ===                         Device                               ==== */
+    /* ===                       Internal Helpers                       ==== */
+    /* ===================================================================== */
+    static bool is_fake_view_key(const crypto::secret_key &sec) {
+      return sec == crypto::null_skey;
+    }
+
+    /* ===================================================================== */
+    /* ===                             Device                           ==== */
     /* ===================================================================== */
 
     static int device_id = 0;
@@ -197,6 +204,8 @@ namespace hw {
       this->hCard   = 0;
       this->hContext = 0;
       this->reset_buffer();      
+      this->mode = NONE;
+      this->has_view_key = false;
       MDEBUG( "Device "<<this->id <<" Created");
     }
 
@@ -403,10 +412,10 @@ namespace hw {
       #ifdef DEBUG_HWDEVICE
       cryptonote::account_public_address pubkey;
       this->get_public_address(pubkey);
+      #endif
       crypto::secret_key vkey;
       crypto::secret_key skey;
       this->get_secret_keys(vkey,skey);
-      #endif
 
       return rv==SCARD_S_SUCCESS;
     }
@@ -420,6 +429,47 @@ namespace hw {
       return true;
     }
 
+    bool  device_ledger::set_mode(device_mode mode) {
+        AUTO_LOCK_CMD();
+
+        int offset;
+
+        reset_buffer();
+
+        switch(mode) {
+        case TRANSACTION_CREATE_REAL:
+        case TRANSACTION_CREATE_FAKE:
+          this->buffer_send[0] = 0x00;
+          this->buffer_send[1] = INS_SET_SIGNATURE_MODE;
+          this->buffer_send[2] = 0x01;
+          this->buffer_send[3] = 0x00;
+          this->buffer_send[4] = 0x00;
+          offset = 5;
+          //options
+          this->buffer_send[offset] = 0x00;
+          offset += 1;
+          //account
+          this->buffer_send[offset] = mode;
+          offset += 1;
+
+          this->buffer_send[4] = offset-5;
+          this->length_send = offset;
+          this->exchange();
+
+          this->mode = mode;
+          break;
+
+        case TRANSACTION_PARSE: 
+        case NONE:
+          this->mode = mode;
+          break;
+        default:
+           CHECK_AND_ASSERT_THROW_MES(false, " device_ledger::set_mode(unsigned int mode): invalid mode: "<<mode);
+        }
+        MDEBUG("Switch to mode: " <<mode);
+        return true;
+    }
+
 
     /* ======================================================================= */
     /*                             WALLET & ADDRESS                            */
@@ -451,12 +501,13 @@ namespace hw {
         return true;
     }
 
-    bool  device_ledger::get_secret_keys(crypto::secret_key &viewkey , crypto::secret_key &spendkey) {
+    bool  device_ledger::get_secret_keys(crypto::secret_key &vkey , crypto::secret_key &skey) {
         AUTO_LOCK_CMD();
-      memset(viewkey.data, 0x00, 32);
-      memset(spendkey.data, 0xFF, 32);
 
-      #ifdef DEBUG_HWDEVICE
+        //secret key are represented as fake key on the wallet side
+        memset(vkey.data, 0x00, 32);
+        memset(skey.data, 0xFF, 32);
+
         //spcialkey, normal conf handled in decrypt
         int offset;
         reset_buffer();
@@ -475,12 +526,22 @@ namespace hw {
         this->length_send = offset;
         this->exchange();
 
-        //clear key
-        memmove(ledger::viewkey.data,  this->buffer_recv+64, 32);
-        memmove(ledger::spendkey.data, this->buffer_recv+96, 32);
+        //View key is retrievied, if allowed, to speed up blockchain parsing
+        memmove(this->viewkey.data,  this->buffer_recv+0,  32);
+        if (is_fake_view_key(this->viewkey)) {
+          MDEBUG("Have Not view key");
+          this->has_view_key = false;
+        } else {
+          MDEBUG("Have view key");
+          this->has_view_key = true;
+        }
+      
+        #ifdef DEBUG_HWDEVICE
+        memmove(dbg_viewkey.data, this->buffer_recv+0, 32);
+        memmove(dbg_spendkey.data, this->buffer_recv+32, 32);
+        #endif
 
-      #endif
-      return true;
+        return true;
     }
 
     bool  device_ledger::generate_chacha_key(const cryptonote::account_keys &keys, crypto::chacha_key &key) {
@@ -525,11 +586,14 @@ namespace hw {
 
     bool device_ledger::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){
         AUTO_LOCK_CMD();
-        int offset;
-
         #ifdef DEBUG_HWDEVICE
         const crypto::public_key pub_x = pub;
-        const crypto::key_derivation derivation_x  = hw::ledger::decrypt(derivation);
+        crypto::key_derivation derivation_x;
+         if ((this->mode == TRANSACTION_PARSE) && has_view_key) {    
+          derivation_x = derivation;
+        } else {
+          derivation_x = hw::ledger::decrypt(derivation);
+        }
         const std::size_t output_index_x = output_index;
         crypto::public_key derived_pub_x;
         hw::ledger::log_hexbuffer("derive_subaddress_public_key: [[IN]]  pub       ", pub_x.data, 32);
@@ -539,6 +603,15 @@ namespace hw {
         hw::ledger::log_hexbuffer("derive_subaddress_public_key: [[OUT]] derived_pub", derived_pub_x.data, 32);
         #endif
 
+      if ((this->mode == TRANSACTION_PARSE) && has_view_key) {     
+        //If we are in TRANSACTION_PARSE, the given derivation has been retrieved uncrypted (wihtout the help
+        //of the device), so continue that way.
+        MDEBUG( "derive_subaddress_public_key  : PARSE mode with known viewkey");     
+        crypto::derive_subaddress_public_key(pub, derivation, output_index,derived_pub);
+      } else {
+       
+        int offset =0;
+ 
         reset_buffer();
 
         this->buffer_send[0] = 0x00;
@@ -569,10 +642,10 @@ namespace hw {
 
         //pub key
         memmove(derived_pub.data, &this->buffer_recv[0], 32);
-
-        #ifdef DEBUG_HWDEVICE
-        hw::ledger::check32("derive_subaddress_public_key", "derived_pub", derived_pub_x.data, derived_pub.data);
-        #endif
+      }
+      #ifdef DEBUG_HWDEVICE
+      hw::ledger::check32("derive_subaddress_public_key", "derived_pub", derived_pub_x.data, derived_pub.data);
+      #endif
 
       return true;
     }
@@ -959,7 +1032,7 @@ namespace hw {
 
     bool device_ledger::generate_key_derivation(const crypto::public_key &pub, const crypto::secret_key &sec, crypto::key_derivation &derivation) {
         AUTO_LOCK_CMD();
-        int offset;
+        bool r = false;
 
         #ifdef DEBUG_HWDEVICE
         const crypto::public_key pub_x = pub;
@@ -971,6 +1044,17 @@ namespace hw {
         hw::ledger::log_hexbuffer("generate_key_derivation: [[OUT]] derivation", derivation_x.data, 32);
         #endif
 
+      if ((this->mode == TRANSACTION_PARSE)  && has_view_key) {
+        //A derivation is resquested in PASRE mode and we have the view key,
+        //so do that wihtout the device and return the derivation unencrypted.
+        MDEBUG( "generate_key_derivation  : PARSE mode with known viewkey");     
+        //Note derivation in PARSE mode can only happen with viewkey, so assert it!
+        assert(is_fake_view_key(sec));
+        r = crypto::generate_key_derivation(pub, this->viewkey, derivation);
+      } else {
+
+        int offset;
+
         reset_buffer();
 
         this->buffer_send[0] = 0x00;
@@ -995,14 +1079,19 @@ namespace hw {
 
         //derivattion data
         memmove(derivation.data, &this->buffer_recv[0], 32);
+        r = true;
+      }
+      #ifdef DEBUG_HWDEVICE
+      crypto::key_derivation derivation_clear ;
+        if ((this->mode == TRANSACTION_PARSE)  && has_view_key) {
+          derivation_clear  = derivation;
+        }else {
+          derivation_clear  = hw::ledger::decrypt(derivation);
+        }
+      hw::ledger::check32("generate_key_derivation", "derivation", derivation_x.data, derivation_clear.data);
+      #endif
 
-        #ifdef DEBUG_HWDEVICE
-        crypto::key_derivation derivation_clear  = hw::ledger::decrypt(derivation);
-        hw::ledger::check32("generate_key_derivation", "derivation", derivation_x.data, derivation_clear.data);
-        #endif
-
-
-      return true;
+      return r;
     }
 
     bool device_ledger::derivation_to_scalar(const crypto::key_derivation &derivation, const size_t output_index, crypto::ec_scalar &res) {
@@ -1290,32 +1379,6 @@ namespace hw {
         return true;
     }
 
-    bool  device_ledger::set_signature_mode(unsigned int sig_mode) {
-        AUTO_LOCK_CMD();
-        int offset ;
-
-        reset_buffer();
-
-        this->buffer_send[0] = 0x00;
-        this->buffer_send[1] = INS_SET_SIGNATURE_MODE;
-        this->buffer_send[2] = 0x01;
-        this->buffer_send[3] = 0x00;
-        this->buffer_send[4] = 0x00;
-        offset = 5;
-        //options
-        this->buffer_send[offset] = 0x00;
-        offset += 1;
-        //account
-        this->buffer_send[offset] = sig_mode;
-        offset += 1;
-
-        this->buffer_send[4] = offset-5;
-        this->length_send = offset;
-        this->exchange();
-        
-      return true;
-    }
-
     bool device_ledger::encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) {
         AUTO_LOCK_CMD();
         int offset;
diff --git a/src/device/device_ledger.hpp b/src/device/device_ledger.hpp
index 2053067bd..652cfb34b 100644
--- a/src/device/device_ledger.hpp
+++ b/src/device/device_ledger.hpp
@@ -32,7 +32,6 @@
 
 #include <cstddef>
 #include <string>
-#include <mutex>
 #include "device.hpp"
 #include <PCSC/winscard.h>
 #include <PCSC/wintypes.h>
@@ -94,15 +93,21 @@ namespace hw {
         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);
 
+        // hw running mode
+        device_mode mode;
+        // map public destination key to ephemeral destination key
+        Keymap key_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 *controle_device;
         #endif
@@ -129,6 +134,7 @@ namespace hw {
         bool connect(void) override;
         bool disconnect() override;
 
+        bool  set_mode(device_mode mode) override;
 
         /* ======================================================================= */
         /*  LOCKER                                                                 */
@@ -175,8 +181,6 @@ namespace hw {
 
         bool  open_tx(crypto::secret_key &tx_key) override;
 
-        bool  set_signature_mode(unsigned int sig_mode) override;
-
         bool  encrypt_payment_id(crypto::hash8 &payment_id, const crypto::public_key &public_key, const crypto::secret_key &secret_key) override;
 
         bool  ecdhEncode(rct::ecdhTuple & unmasked, const rct::key & sharedSec) override;
@@ -197,10 +201,9 @@ namespace hw {
     };
 
 
-
     #ifdef DEBUG_HWDEVICE
-    extern crypto::secret_key viewkey;
-    extern crypto::secret_key spendkey;
+    extern crypto::secret_key dbg_viewkey;
+    extern crypto::secret_key dbg_spendkey;
     #endif
 
     #endif  //WITH_DEVICE_LEDGER
diff --git a/src/device/log.cpp b/src/device/log.cpp
index a2ad0f4f4..cbbcfc953 100644
--- a/src/device/log.cpp
+++ b/src/device/log.cpp
@@ -56,8 +56,8 @@ namespace hw {
     }
 
     #ifdef DEBUG_HWDEVICE
-    extern crypto::secret_key viewkey;
-    extern crypto::secret_key spendkey;
+    extern crypto::secret_key dbg_viewkey;
+    extern crypto::secret_key dbg_spendkey;
 
 
     void decrypt(char* buf, size_t len) {
@@ -69,7 +69,7 @@ namespace hw {
           if (buf[i] != 0) break;
         }
         if (i == 32) {
-          memmove(buf, hw::ledger::viewkey.data, 32);
+          memmove(buf, hw::ledger::dbg_viewkey.data, 32);
           return;
         }
         //spend key?
@@ -77,7 +77,7 @@ namespace hw {
           if (buf[i] != (char)0xff) break;
         }
         if (i == 32) {
-          memmove(buf, hw::ledger::spendkey.data, 32);
+          memmove(buf, hw::ledger::dbg_spendkey.data, 32);
           return;
         }
       }
@@ -161,4 +161,4 @@ namespace hw {
   }
   #endif //WITH_DEVICE_LEDGER    
 
-}
\ No newline at end of file
+}