Encrypt metadata impl #4204

paweljakubas · 2023-11-03T15:59:46Z

adding cryptographic primitives
support for shelley
integration tests for shelley
support for shared with integration tests

Comments

spec and api defined in #4176

Issue Number

Unisay · 2023-11-16T16:06:48Z

lib/crypto-primitives/src/Crypto/Encryption/ChaChaPoly1305.hs

+    :: ByteString
+       -- ^ Symmetric key / passphrase, 32-byte long
+    -> ByteString
+       -- ^ Nonce, 12-byte long
+    -> ByteString
+        -- ^ Payload to be encrypted


I suggest to use newtypes or Tagged to distinguish parameters on the type level.

Unisay · 2023-11-16T16:10:06Z

lib/crypto-primitives/src/Crypto/Encryption/ChaChaPoly1305.hs

+-- | The caller must ensure that the passphrase length is 32 bytes and
+-- | nonce is 12 bytes
+encryptPayload
+    :: ByteString


Consider using https://hackage.haskell.org/package/memory-0.18.0/docs/Data-ByteArray.html#t:ScrubbedBytes to store sensitive bytes?

Unisay · 2023-11-16T16:13:53Z

lib/crypto-primitives/src/Crypto/Encryption/ChaChaPoly1305.hs

+    unsafeSerialize =
+        CBOR.toStrictByteString . CBOR.encodeBytes . useInvariant
+    -- Encryption fails if the key is the wrong size, but that won't happen
+    -- if the key was created with 'toSymmetricKey'.


Another upside of using newtypes is that you can enforce this invariant avoiding partiality.

Unisay · 2023-11-16T16:14:42Z

lib/crypto-primitives/src/Crypto/Encryption/ChaChaPoly1305.hs

+toSymmetricKey
+    :: ByteString
+    -> ByteString


Suggested change

toSymmetricKey

:: ByteString

-> ByteString

toSymmetricKey :: ByteString -> ByteString

Unisay · 2023-11-16T16:21:34Z

lib/crypto-primitives/src/Crypto/Encryption/ChaChaPoly1305.hs

+    :: ByteString
+    -> ByteString
+toSymmetricKey rawKey =
+    PBKDF2.generate


Argon2 was specifically crafted to fix the inherent flaws of compute bounded key derivation functions like pbkdf2. With pbkdf2, you can double your iterations, which will double the time you have to wait to unlock your vault, but also double the time an attacker will take to crack your password (if they have your masterpasswordhash). In contrast to this, argon2 is not just compute-bounded but also memory bounded. This means that - for the same unlock time for you - password cracking will be significantly slower for an attacker attempting to crack your password on a GPU or ASIC, because an attacker cannot run as many instances of argon2 in parallel on a GPU, as they could with PBKDF2 due to memory limitations. This means that for the same unlock time for the user, password cracking becomes orders of magnitude slower compared to pbkdf2.

OWASP recommends Argon2

Unisay · 2023-11-16T16:23:15Z

lib/crypto-primitives/src/Crypto/Encryption/ChaChaPoly1305.hs

+    (PBKDF2.prfHMAC SHA512)
+    (PBKDF2.Parameters 500 32)
+    rawKey
+    ("metadata-encryption" :: ByteString)


What is the point of this bytestring?

Unisay · 2023-11-16T16:45:32Z

lib/wallet/api/http/Cardano/Wallet/Api/Http/Shelley/Server.hs

@@ -3013,6 +3028,90 @@ constructTransaction api argGenChange knownPools poolStatus apiWalletId body = d
            . Map.toList
            . foldr (uncurry (Map.insertWith (<>))) Map.empty

+encryptionNonce :: ByteString
+encryptionNonce = "encrypt-data"


Nonce means "number used once". Here I see that this encryptionNonce will be reused.

According to this doc, nonce has to be 12 random bytes.

🇨🇳

Unisay · 2023-11-16T17:20:00Z

lib/wallet/api/http/Cardano/Wallet/Api/Http/Shelley/Server.hs

+    toMetadata =
+        Cardano.TxMetadata .
+        Map.fromList .
+        zipWith (,) [0..] .


Suggested change

zipWith (,) [0..] .

zip [0..] .

Unisay · 2023-11-16T17:23:45Z

lib/wallet/integration/src/Test/Integration/Scenario/API/Shared/Transactions.hs

@@ -3330,3 +3357,143 @@ spec = describe "SHARED_TRANSACTIONS" $ do
                        (#balance . #available . #getQuantity)
                        (`shouldBe` amt)
                ]
+
+     checkMetadataEncrytion


Typo:

Suggested change

checkMetadataEncrytion

checkMetadataEncryption

Unisay · 2023-11-16T17:24:28Z

lib/wallet/api/http/Cardano/Wallet/Api/Types/SchemaMetadata.hs

@@ -50,7 +50,7 @@ data TxMetadataWithSchema = TxMetadataWithSchema
    { -- | How to codec the metadata into json
        txMetadataWithSchema_schema :: TxMetadataSchema
    , -- | The metadata
-        txMetadataWithSchema_metadata :: TxMetadata
+         txMetadataWithSchema_metadata :: TxMetadata


Suggested change

txMetadataWithSchema_metadata :: TxMetadata

txMetadataWithSchema_metadata :: TxMetadata

Unisay · 2023-11-16T17:28:35Z

lib/wallet/api/http/Cardano/Wallet/Api/Http/Shelley/Server.hs

+toMetadataEncryptedKey apiEncrypt =
+    toSymmetricKey (BA.convert $ unPassphrase passphrase)
+  where
+    (ApiEncryptMetadata (ApiT passphrase)) = apiEncrypt


Suggested change

(ApiEncryptMetadata (ApiT passphrase)) = apiEncrypt

ApiEncryptMetadata (ApiT passphrase) = apiEncrypt

Unisay · 2023-11-16T17:32:49Z

lib/wallet/api/http/Cardano/Wallet/Api/Http/Shelley/Server.hs

+toMetadataEncrypted
+    :: ApiEncryptMetadata
+    -> TxMetadataWithSchema
+    -> Cardano.TxMetadata


Metadata encryption is not a HTTP API concern, and therefore shouldn't be placed in the lib/wallet/api/http/**.

paweljakubas · 2024-07-31T11:57:23Z

closing in favor of #4667

paweljakubas self-assigned this Nov 3, 2023

paweljakubas force-pushed the paweljakubas/adp-322/encrypt-metadata-impl branch 2 times, most recently from 367e64b to c412cf1 Compare November 9, 2023 15:05

paweljakubas requested review from HeinrichApfelmus, jonathanknowles, Anviking, Unisay and paolino November 9, 2023 15:10

paweljakubas marked this pull request as ready for review November 9, 2023 15:10

paweljakubas force-pushed the paweljakubas/adp-322/encrypt-metadata-impl branch 4 times, most recently from ad14d04 to c3a2d7f Compare November 16, 2023 11:21

Unisay reviewed Nov 16, 2023

View reviewed changes

paweljakubas force-pushed the paweljakubas/adp-322/encrypt-metadata-impl branch 2 times, most recently from 936a644 to a212ebe Compare November 29, 2023 16:42

paweljakubas force-pushed the paweljakubas/adp-322/encrypt-metadata-impl branch 3 times, most recently from 73a474f to e752ce8 Compare December 8, 2023 11:59

paweljakubas added 26 commits January 15, 2024 09:35

encrypt integration test - part 1

f7c74d7

encrypt integration test - part 2

07d7c9c

fromMetadataEncrypted

96f67ed

use fromMetadataEncrypted in decodeTransaction

8e0cbb6

integration test decrypt plus fix

721e75f

code reshuffling

1951596

reorganize integration test for better reuse

3e3c404

add integration test for bigger metadata

89e95a4

handle metadata encrypted in constructSharedTransaction

f1af4a3

integration test for shared 1

18f4139

integration test for shared 2

57e866f

integration test for shared 3

f9e616e

introduce Crypto.KeyDerivationFunction.PBKDF2

d39be12

post rebase fix

c4c7e9e

add AES256 with CBC mode

ed0ed40

add more decumentation in AES256CBC module

b3a0e24

rename directories and clean-up before refactoring

b35fcee

major refactoring and now clean

dc6a2fb

add EncryptMetadataMethod

fdcbdb5

deal with crypto-hash-extra apperance

85e3214

refactoring - part 1

cbf4f71

refactoring - part 2

c5b0eed

refactoring - part 3

eb58a91

allow one msg per key

e062e55

handle multiple msg

3a27987

make TxMetadata update

4223ba6

paweljakubas force-pushed the paweljakubas/adp-322/encrypt-metadata-impl branch from e6887f4 to 4223ba6 Compare January 15, 2024 15:31

paweljakubas closed this Jul 31, 2024

paweljakubas deleted the paweljakubas/adp-322/encrypt-metadata-impl branch July 31, 2024 11:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Encrypt metadata impl #4204

Encrypt metadata impl #4204

paweljakubas commented Nov 3, 2023 •

edited

Loading

Unisay Nov 16, 2023

Unisay Nov 16, 2023

Unisay Nov 16, 2023 •

edited

Loading

Unisay Nov 16, 2023

Unisay Nov 16, 2023

Unisay Nov 16, 2023

Unisay Nov 16, 2023 •

edited

Loading

Unisay Nov 16, 2023

Unisay Nov 16, 2023

Unisay Nov 16, 2023

Unisay Nov 16, 2023

Unisay Nov 16, 2023

paweljakubas commented Jul 31, 2024

	txMetadataWithSchema_metadata :: TxMetadata
	txMetadataWithSchema_metadata :: TxMetadata

	(ApiEncryptMetadata (ApiT passphrase)) = apiEncrypt
	ApiEncryptMetadata (ApiT passphrase) = apiEncrypt

Encrypt metadata impl #4204

Encrypt metadata impl #4204

Conversation

paweljakubas commented Nov 3, 2023 • edited Loading

Comments

Issue Number

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Unisay Nov 16, 2023 • edited Loading

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

Unisay Nov 16, 2023 • edited Loading

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

paweljakubas commented Jul 31, 2024

paweljakubas commented Nov 3, 2023 •

edited

Loading

Unisay Nov 16, 2023 •

edited

Loading

Unisay Nov 16, 2023 •

edited

Loading