[ADP-322] Add metadata encryption to HTTP API. #4555

paweljakubas · 2024-04-19T14:01:48Z

Adding noninvasive api changes to constructTransaction
Applying changes to Api.Server
Extend ErrConstructTx
Implementing toMetadataEncryption according to https://github.com/cardano-foundation/CIPs/tree/master/CIP-0083
Prepare goldens in line to openSSL and CIP83 examples
Show error emitting works
Add salting to key gen and encryption
Add integration test showing error
Add integration test showing encryption

Comments

Issue Number

lib/crypto-primitives/src/Cryptography/Cipher/AES256CBC.hs

jonathanknowles · 2024-05-14T05:46:21Z

lib/api/src/Cardano/Wallet/Api/Types.hs

+
+data ApiEncryptMetadata = ApiEncryptMetadata
+    { passphrase :: ApiT (Passphrase "lenient")
+    , enc :: Maybe EncryptMetadataMethod


Hi @paweljakubas

For what reason do we allow this field to be Nothing?

If it is set to Nothing, then what do we expect the behaviour to be?

jonathanknowles · 2024-05-14T05:52:10Z

lib/api/src/Cardano/Wallet/Api/Types.hs

+        if txt == "basic" then
+            pure AES256CBC
+        else
+            fail "'basic' is expected."


Suggestion: derive this instance automatically.

See: #4588

lib/api/src/Cardano/Wallet/Api/Http/Shelley/Server.hs

jonathanknowles · 2024-05-14T06:04:53Z

specifications/api/swagger.yaml

+    Cipher algorithm uses 8-byte salt, PKCS#7 padding as specified in
+    https://datatracker.ietf.org/doc/html/rfc5652#section-6.3 is applied.
+    Only metadata value under `msg` field is encrypted. If `msg` field is missing error
+    will be emitted.


As a user who is new to this feature, I'm finding this description section a little hard to follow!

For example, it refers to a field called msg. However, this object only has two fields: enc and passphrase.

From reading through the tests (Api.TypesSpec), I can see that msg is supposed to be the key in a TxMetaMap.

Is there any way that we can give a more complete description of how to use this feature? (Ideally, so that the user doesn't have to go hunting through CIP 83.)

This PR contains suggestions for PR #4555.

jonathanknowles

Hi @paweljakubas

Many thanks for creating this PR and for your patience with waiting for reviews.

Given this PR adds just the encryption functionality, with decryption planned for a later PR, I think this PR is okay to merge for now.

However, I do have some proposals that I think should be addressed in subsequent PRs:

Currently, the "business logic" for metadata encryption is located within the Cardano.Wallet.Api.Http.Shelley.Server module. I would propose to extract this logic out into a pure function that (a). doesn't rely on HTTP API types and (b). lives in a more appropriate location, preferably outside of the Server module, so that the Server module only needs to handle concerns that directly relate to the HTTP API. Perhaps this new location could be something like Cardano.Write.Tx.Metadata.Encryption?
I would propose to replace all instances of the magic value 674 with references to the cip20MetadataKey constant (already used by toMetadataEncrypted), and similarly, to re-locate this constant to the proposed Cardano.Write.Tx.Metadata.Encryption module.
When we have a pure function that performs decryption, I would propose to:
1. add a new test module Cardano.Write.Tx.Metadata.EncryptionSpec.
2. add a QuickCheck property test for the encryption-decryption round-trip property: decrypt . encrypt == id.
3. add a selection of golden example-based unit tests (i.e., tests that are very quick to run that don't require us to fire up the integration test suite).
I still find the description of x-encryptMetadata in the swagger file a little hard to follow. Perhaps it would be possible to find someone who is completely new to this feature, and work with them to revise this description in a way that is easier for new users to understand? (See earlier review comment: https://github.com/cardano-foundation/cardano-wallet/pull/4555/files#r1599427620)

Again, many thanks again for creating this PR!

Jonathan

specifications/api/swagger.yaml

The key returned by `findMsgValue` was always equal to the value of the `cip20MetadataKey` constant. Other functions that need to refer to this constant can do so directly.

The `bimap` function is already widely used within this codebase, and is exported from `base`, whereas `mapBoth` requires the use of an additional library.

Of `encryptMessage`.

…ail in a few bullet points the work accomplished in this PR. Before you submit, don't forget to: CODE-OF-CONDUCT.md CONTRIBUTING.md LICENSE MAINTAINERS.md README.md cabal.project configs docker-compose.yml docs flake.lock flake.nix floskell.json fourmolu.yaml hie-direnv.yaml justfile lib nix prototypes reports scripts specifications test touch.me.CI weeder.dhall Make sure the GitHub PR fields are correct: ✓ Set a good Title for your PR. ✓ Assign yourself to the PR. ✓ Assign one or more reviewer(s). ✓ Link to a Jira issue, and/or other GitHub issues or PRs. ✓ In the PR description delete any empty sections and all text commented in  - [x] Adding noninvasive api changes to `constructTransaction` - [x] Applying changes to Api.Server - [x] Extend `ErrConstructTx` - [x] Implementing `toMetadataEncryption` according to https://github.com/cardano-foundation/CIPs/tree/master/CIP-0083 - [x] Prepare goldens in line to openSSL and CIP83 examples - [x] Show error emitting works - [x] Add salting to key gen and encryption - [x] Add integration test showing error - [x] Add integration test showing encryption ### Comments  ### Issue Number adp-322  Source commit: a2cac93

paweljakubas requested a review from jonathanknowles April 19, 2024 14:01

paweljakubas self-assigned this Apr 19, 2024

paweljakubas force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch 3 times, most recently from fa84e60 to 1842e52 Compare April 25, 2024 12:57

paweljakubas force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch 2 times, most recently from 0cb0d8b to 78798e7 Compare May 6, 2024 06:42

jonathanknowles force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch 2 times, most recently from fb38fbf to c2d8bb9 Compare May 7, 2024 08:29

jonathanknowles mentioned this pull request May 8, 2024

[ADP-322] Simplify functions within AES256CBC. #4581

Merged

paweljakubas force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch from eda0d55 to 1c48366 Compare May 10, 2024 09:46

jonathanknowles changed the title ~~Add metadata encryption to api~~ Add metadata encryption to HTTP API. May 14, 2024

jonathanknowles reviewed May 14, 2024

View reviewed changes

jonathanknowles changed the title ~~Add metadata encryption to HTTP API.~~ [ADP-322] Add metadata encryption to HTTP API. May 22, 2024

jonathanknowles mentioned this pull request May 22, 2024

[ADP-322] Test what happens if there are multiple messages to be encrypted. #4601

Closed

paweljakubas force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch from fbfb5a7 to 556012e Compare June 11, 2024 14:34

paweljakubas requested a review from jonathanknowles June 11, 2024 14:37

paweljakubas force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch from 556012e to 29d71c2 Compare June 17, 2024 07:47

jonathanknowles mentioned this pull request Jun 17, 2024

[ADP-322] Fix build of PR #4555 #4632

Closed

jonathanknowles force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch from dc28dc5 to 70a1c46 Compare June 20, 2024 05:52

jonathanknowles mentioned this pull request Jun 20, 2024

[ADP-322] More suggestions for PR #4555 #4639

Merged

paweljakubas added a commit that referenced this pull request Jun 24, 2024

[ADP-322] More suggestions for PR #4555 (#4639)

0e2ea8d

This PR contains suggestions for PR #4555.

jonathanknowles mentioned this pull request Jun 26, 2024

[ADP-322] Suggestions for PR #4555 #4645

Merged

paweljakubas added a commit that referenced this pull request Jun 26, 2024

[ADP-322] Suggestions for PR #4555 (#4645)

0bb3ed6

This PR contains suggestions for PR #4555.

jonathanknowles approved these changes Jun 26, 2024

View reviewed changes

specifications/api/swagger.yaml Outdated Show resolved Hide resolved

paweljakubas added 5 commits June 26, 2024 15:49

update swagger

b1c6cb6

introduce EncryptMetadataMethod

a14746a

add ErrConstructTxIncorrectRawMetadata

1c4b42c

more logic in toMetadataEncrypted

ec5a54e

even more logic in toMetadataEncrypted

a32d76d

jonathanknowles and others added 22 commits June 26, 2024 15:49

Defer creation of (redundant) singleton list.

e375cd6

Further defer creation of (redundant) singleton list.

e886518

Eliminate creation of redundant singleton list.

586dccd

Stop unnecessarily passing cip20MetadataKey around.

2f5f939

The key returned by `findMsgValue` was always equal to the value of the `cip20MetadataKey` constant. Other functions that need to refer to this constant can do so directly.

Remove unnecessary alias of "msg".

5773f24

Inline definition of encMethodEntry.

fcd9087

Extract out definition encryptedChunks.

61c35a8

Inline definition of encrypted.

9112310

Replace mapBoth with bimap.

d03219e

The `bimap` function is already widely used within this codebase, and is exported from `base`, whereas `mapBoth` requires the use of an additional library.

Inline definition of toBase64Text.

4d02b32

Rename function to parseMessage.

a0ddb4a

Rename function to getValue.

b9d5340

Rename function to validKeyAndMessage.

7432aaa

Rename function to extractMessage.

bbeec71

Rename function to encryptMessage.

9874963

Simplify definition of function encryptMessage.

f897727

Make encryptPairIfQualifies an inner function.

d9ff553

Of `encryptMessage`.

Extract out function encryptValue.

faa9827

Flatten where hierarchy for function encryptMessage.

b9a66a0

Add type signatures to inner functions of toMetadataEncrypted.

745c0ab

Simplify definition of toMetadataEncrypted.

2fd4565

swagger improve

a83c7e1

paweljakubas force-pushed the paweljakubas/adp-322/add-metadata-encryption-to-api branch from 0bb3ed6 to a83c7e1 Compare June 26, 2024 13:52

paweljakubas added this pull request to the merge queue Jun 26, 2024

github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 26, 2024

paweljakubas added this pull request to the merge queue Jun 26, 2024

Merged via the queue into master with commit a2cac93 Jun 26, 2024
3 checks passed

paweljakubas deleted the paweljakubas/adp-322/add-metadata-encryption-to-api branch June 26, 2024 15:32

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ADP-322] Add metadata encryption to HTTP API. #4555

[ADP-322] Add metadata encryption to HTTP API. #4555

paweljakubas commented Apr 19, 2024 •

edited

Loading

jonathanknowles May 14, 2024

jonathanknowles May 14, 2024

jonathanknowles May 14, 2024

jonathanknowles left a comment •

edited

Loading

[ADP-322] Add metadata encryption to HTTP API. #4555

[ADP-322] Add metadata encryption to HTTP API. #4555

Conversation

paweljakubas commented Apr 19, 2024 • edited Loading

Comments

Issue Number

jonathanknowles May 14, 2024

Choose a reason for hiding this comment

jonathanknowles May 14, 2024

Choose a reason for hiding this comment

jonathanknowles May 14, 2024

Choose a reason for hiding this comment

jonathanknowles left a comment • edited Loading

Choose a reason for hiding this comment

paweljakubas commented Apr 19, 2024 •

edited

Loading

jonathanknowles left a comment •

edited

Loading