Update CCryptoKeyStore with Sapling support #3396

arcalinea · 2018-07-12T22:00:03Z

Sapling crypter overrides for various CCryptoKeyStore functions such as:

HaveSaplingSpendingKey()
GetSaplingSpendingKey()

Also includes some changes to prepare for diversified addresses and ZIP 32.

Closes #3389

str4d

Also add Sapling support to CCryptoKeyStore::EncryptKeys

str4d · 2018-07-13T10:39:03Z

src/zcash/Address.cpp

+uint256 SaplingFullViewingKey::GetHash() const {
+    CDataStream ss(SER_NETWORK, PROTOCOL_VERSION);
+    ss << *this;
+    return Hash(ss.begin(), ss.end());


We should use the fingerprint defined in ZIP 32, for consistency: BLAKE2b-256("ZcashSaplingFVFP", fvk)

CBLAKE2bWriter ss(SER_GETHASH, 0, ZCASH_SAPLING_FVFP_PERSONALIZATION); ss << *this; return ss.GetHash();

str4d · 2018-07-13T10:53:17Z

src/wallet/crypter.cpp

+    if(!DecryptSecret(vMasterKey, vchCryptedSecret, fvk.GetHash(), vchSecret))
+        return false;
+
+    if (vchSecret.size() != libzcash::SerializedSpendingKeySize)


This is technically incorrect, because it's the Sprout spending key size. But in practice both Sprout and Sapling spending keys serialize to the same size. If another reviewer wants it changed, I'll support that.

Will add const size_t SerializedSaplingSpendingKeySize = 32; and use that, for clarity

str4d · 2018-07-13T10:54:03Z

src/wallet/crypter.cpp

@@ -340,7 +357,7 @@ bool CCryptoKeyStore::AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &
        CKeyingMaterial vchSecret(ss.begin(), ss.end());
        auto address = sk.default_address();


This can be removed now.

zkbot · 2018-07-13T11:58:09Z

☔ The latest upstream changes (presumably #3390) made this pull request unmergeable. Please resolve the merge conflicts.

arcalinea · 2018-07-17T20:52:46Z

Addressed comments - review needed on Sapling key encryption in CCryptoKeyStore::EncryptKeys

ebfull · 2018-07-25T18:12:34Z

src/wallet/crypter.cpp

+    {
+        LOCK(cs_SpendingKeyStore);
+        if (!IsCrypted())
+            return CBasicKeyStore::GetSaplingSpendingKey(fvk, skOut);


~~I'm confused about what this calls, is this not recursing?~~ unconfused

No, it's a superclass call.

str4d · 2018-07-25T15:26:11Z

src/zcash/Address.hpp

        READWRITE(ak);
        READWRITE(nk);
        READWRITE(ovk);
    }
+
+    //! Get the 256-bit SHA256d hash of this full viewing key.


Update this comment to match the implementation and ZIP 32.

str4d · 2018-07-25T15:30:18Z

src/zcash/Address.hpp

        READWRITE(ak);
        READWRITE(nk);
        READWRITE(ovk);
    }
+
+    //! Get the 256-bit SHA256d hash of this full viewing key.
+    uint256 GetHash() const;


Rename this to GetFingerprint() to match ZIP 32.

str4d · 2018-08-01T14:22:31Z

I'm taking over this PR, as @arcalinea is away this week.

str4d · 2018-08-01T15:13:03Z

Rebased on master, addressed my comments, and added a few missing parts.

@zkbot try

zkbot · 2018-08-01T15:13:11Z

⌛ Trying commit 37de067 with merge 068314e...

Add Sapling have/get spendingkey crypter overrides Sapling crypter overrides for: - `HaveSaplingSpendingKey()` - `GetSaplingSpendingKey()` Closes #3389

zkbot · 2018-08-01T16:45:56Z

💔 Test failed - pr-try

To be filled in when we implement Sapling persistence to disk.

I've taken over the PR, so I can't review it.

daira

Renaming changes requested. (Some of my comments are on individual commits.)

daira · 2018-08-03T00:15:55Z

src/wallet/crypter.cpp

+                               libzcash::SaplingSpendingKey& sk)
+{
+    CKeyingMaterial vchSecret;
+    if(!DecryptSecret(vMasterKey, vchCryptedSecret, fvk.GetFingerprint(), vchSecret))


nit: if (

daira · 2018-08-03T00:17:27Z

src/wallet/crypter.cpp

+    if (vchSecret.size() != libzcash::SerializedSaplingSpendingKeySize)
+        return false;
+
+    CSecureDataStream ss(vchSecret, SER_NETWORK, PROTOCOL_VERSION);


Is this actually dependent on the network protocol version? That doesn't sound right to me.

It matches what we do in e.g. src/key_io.h. The distinction from upstream, as I understand it, is that anything that might get communicated spatially between nodes is technically part of the protocol, whereas anything that is only communicated temporally between a single node's past and future selves is SER_DISK, CLIENT_VERSION.

I think this is questionable because, if we were to substantially change the network protocol, that would have to be versioned and upgraded quite differently from changing the external key formats. In any case, it's ok for this PR.

daira · 2018-08-03T00:18:31Z

src/wallet/crypter.cpp

+    {
+        LOCK(cs_SpendingKeyStore);
+        if (!IsCrypted())
+            return CBasicKeyStore::GetSaplingSpendingKey(fvk, skOut);


No, it's a superclass call.

daira · 2018-08-03T00:21:28Z

src/zcash/Address.hpp

@@ -19,6 +19,8 @@ const size_t SerializedPaymentAddressSize = 64;
 const size_t SerializedViewingKeySize = 64;
 const size_t SerializedSpendingKeySize = 32;


These should be renamed to SerializedSprout....

daira · 2018-08-03T00:24:40Z

src/wallet/crypter.cpp

@@ -173,7 +173,7 @@ bool CCryptoKeyStore::SetCrypted()
    LOCK2(cs_KeyStore, cs_SpendingKeyStore);
    if (fUseCrypto)
        return true;
-    if (!(mapKeys.empty() && mapSpendingKeys.empty()))
+    if (!(mapKeys.empty() && mapSpendingKeys.empty() && mapSaplingSpendingKeys.empty()))


mapSpendingKeys should be renamed to mapSproutSpendingKeys.

I was hoping to avoid that large rename for now, but I'll go rip off the plaster 😂

Oh, turns out it's not a large rename after all!

daira · 2018-08-03T00:26:16Z

src/wallet/wallet.h

@@ -999,14 +999,16 @@ class CWallet : public CCryptoKeyStore, public CValidationInterface
    bool RemoveViewingKey(const libzcash::SproutViewingKey &vk);
    //! Adds a viewing key to the store, without saving it to disk (used by LoadWallet)
    bool LoadViewingKey(const libzcash::SproutViewingKey &dest);


These methods should be renamed to include Sprout.

str4d · 2018-08-03T01:26:31Z

Addressed @daira's comments.

ebfull · 2018-08-03T02:04:15Z

re-ACK

addressed

daira · 2018-08-03T08:05:38Z

And rename these too (sorry I didn't catch them before):

     //! Add a spending key to the store.
     virtual bool AddSpendingKey(const libzcash::SproutSpendingKey &sk) =0;
 
     //! Check whether a spending key corresponding to a given payment address is present in the store.
     virtual bool HaveSpendingKey(const libzcash::SproutPaymentAddress &address) const =0;
     virtual bool GetSpendingKey(const libzcash::SproutPaymentAddress &address, libzcash::SproutSpendingKey& skOut) const =0;
     virtual void GetPaymentAddresses(std::set<libzcash::SproutPaymentAddress> &setAddress) const =0;

Also GetPaymentAddresses -> GetSproutPaymentAddresses

str4d · 2018-08-03T09:11:59Z

@daira Done (that was the big one).

daira

ut(ACK+cov).

ebfull · 2018-08-03T15:36:43Z

re-ACK

str4d · 2018-08-03T15:37:44Z

@zkbot r+

zkbot · 2018-08-03T15:37:44Z

📌 Commit 25d5e80 has been approved by str4d

Update CCryptoKeyStore with Sapling support Sapling crypter overrides for various `CCryptoKeyStore` functions such as: - `HaveSaplingSpendingKey()` - `GetSaplingSpendingKey()` Also includes some changes to prepare for diversified addresses and ZIP 32. Closes #3389

zkbot · 2018-08-03T16:48:26Z

⌛ Testing commit 25d5e80 with merge aa32786...

zkbot · 2018-08-03T18:53:54Z

☀️ Test successful - pr-merge
Approved by: str4d
Pushing aa32786 to master...

arcalinea added the NU1-sapling Network upgrade: Sapling-specific tasks label Jul 12, 2018

arcalinea added this to the v2.0.0 milestone Jul 12, 2018

arcalinea self-assigned this Jul 12, 2018

arcalinea requested review from bitcartel, str4d and Eirik0 July 12, 2018 22:00

arcalinea added this to Review Backlog in Arborist Team Jul 12, 2018

arcalinea changed the title ~~Add Sapling have/get sk crypter overrides~~ Add Sapling have/get spendingkey crypter overrides Jul 12, 2018

str4d moved this from Review Backlog to In Review in Arborist Team Jul 13, 2018

str4d added the A-wallet Area: Wallet label Jul 13, 2018

str4d previously requested changes Jul 13, 2018

View reviewed changes

str4d moved this from In Review to In Progress in Arborist Team Jul 13, 2018

arcalinea force-pushed the 3389_sapling_crypter branch from 15e1dea to 8b55ddf Compare July 17, 2018 19:16

arcalinea requested a review from str4d July 17, 2018 20:52

arcalinea moved this from In Progress to Review Backlog in Arborist Team Jul 17, 2018

mdr0id moved this from Review Backlog to In Review in Arborist Team Jul 18, 2018

mdr0id requested a review from gtank July 23, 2018 18:28

arcalinea force-pushed the 3389_sapling_crypter branch from e59702b to 07442c6 Compare July 24, 2018 21:40

ebfull reviewed Jul 25, 2018

View reviewed changes

str4d reviewed Aug 1, 2018

View reviewed changes

str4d assigned str4d and unassigned arcalinea Aug 1, 2018

str4d force-pushed the 3389_sapling_crypter branch from 07442c6 to 37de067 Compare August 1, 2018 15:12

zkbot added a commit that referenced this pull request Aug 1, 2018

Auto merge of #3396 - arcalinea:3389_sapling_crypter, r=<try>

068314e

Add Sapling have/get spendingkey crypter overrides Sapling crypter overrides for: - `HaveSaplingSpendingKey()` - `GetSaplingSpendingKey()` Closes #3389

str4d added 3 commits August 3, 2018 00:23

Remove outdated comment

9c9258c

Add CWallet::AddCryptedSaplingSpendingKey() hook

bc6344b

To be filled in when we implement Sapling persistence to disk.

Pass SaplingPaymentAddress to store through the CKeyStore

5175a7f

str4d force-pushed the 3389_sapling_crypter branch from e65383b to 5175a7f Compare August 3, 2018 00:04

ebfull approved these changes Aug 3, 2018

View reviewed changes

daira previously requested changes Aug 3, 2018

View reviewed changes

str4d added 4 commits August 3, 2018 01:47

Rename SpendingKeyMap -> SproutSpendingKeyMap

93fcf89

Rename Serialized*Size -> SerializedSprout*Size

74f5b01

Rename *ViewingKey* -> *SproutViewingKey*

4c77517

Formatting nits

f84cf5f

ebfull approved these changes Aug 3, 2018

View reviewed changes

Rename *SpendingKey -> *SproutSpendingKey

25d5e80

Also GetPaymentAddresses -> GetSproutPaymentAddresses

daira mentioned this pull request Aug 3, 2018

Track Sapling notes and nullifiers in the wallet (in-memory only, no persistence to disk) #3422

Merged

daira approved these changes Aug 3, 2018

View reviewed changes

zkbot merged commit 25d5e80 into zcash:master Aug 3, 2018

Arborist Team automation moved this from In Review to Released (Merged in Master) Aug 3, 2018

This was referenced Aug 3, 2018

Only include the change field if we have a spending key #3438

Merged

Add Sapling support to z_getbalance and z_gettotalbalance #3436

Merged

		@@ -340,7 +357,7 @@ bool CCryptoKeyStore::AddSaplingSpendingKey(const libzcash::SaplingSpendingKey &
		CKeyingMaterial vchSecret(ss.begin(), ss.end());
		auto address = sk.default_address();

		@@ -19,6 +19,8 @@ const size_t SerializedPaymentAddressSize = 64;
		const size_t SerializedViewingKeySize = 64;
		const size_t SerializedSpendingKeySize = 32;

Update CCryptoKeyStore with Sapling support #3396

Update CCryptoKeyStore with Sapling support #3396

Conversation

arcalinea commented Jul 12, 2018 • edited by str4d

str4d left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zkbot commented Jul 13, 2018

arcalinea commented Jul 17, 2018

ebfull Jul 25, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

str4d commented Aug 1, 2018

str4d commented Aug 1, 2018

zkbot commented Aug 1, 2018

zkbot commented Aug 1, 2018

daira left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

str4d commented Aug 3, 2018

ebfull commented Aug 3, 2018

daira commented Aug 3, 2018

str4d commented Aug 3, 2018

daira left a comment

Choose a reason for hiding this comment

ebfull commented Aug 3, 2018

str4d commented Aug 3, 2018

zkbot commented Aug 3, 2018

zkbot commented Aug 3, 2018

zkbot commented Aug 3, 2018

arcalinea commented Jul 12, 2018 •

edited by str4d

ebfull Jul 25, 2018 •

edited