Decrypt encrypted metadata #4667
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
from
c95d74c to
5435a5b
Compare
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
from
5435a5b to
fe20c90
Compare
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
2 times, most recently
from
0fee12a to
642f5e2
Compare
| -- [TxMetaText base64_1, TxMetaText base64_2, ..., TxMetaText base64_n] | ||
| -- (d) add `enc` field with encryption method value 'basic' | ||
| toMetadataEncrypted | ||
| :: ByteString |
There was a problem hiding this comment.
Suggested change
| :: ByteString | |
| :: Passphrase "lenient" |
This type documents the purpose of the parameter more clearly.
| -- (d) update structure | ||
| -- (e) decode metadata | ||
| fromMetadataEncrypted | ||
| :: ByteString |
There was a problem hiding this comment.
Suggested change
| :: ByteString | |
| :: Passphrase "lenient" |
There was a problem hiding this comment.
Second round of review. I insist on the separation of concerns. 🤓
After addressing the separation of concerns, I would also like to see property tests for
toMetadataEncrypted pwd . fromMetadataEncrypted pwd = id
fromMetadataEncrypted pwd . toMetadataEncrypted pwd = id
These two properties are vital to the whole feature and we need to cover them with extensive property tests in a way that integration tests cannot achieve.
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
2 times, most recently
from
153408d to
d9f8a2d
Compare
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
from
481cf05 to
099416a
Compare
There was a problem hiding this comment.
Much better, thank you! 😊 The new module is much more, well, modular, and also captures the possible error conditions nicely.
But I still have a couple of comments that I would like to see fixed before merging:
isRight encryptedin the tests — having this here decreases my confidence in the tests unless we also usecover, fortunately, I don't think that it's necessary here.errorinfromMetadaEncrypted— unfortunately, I think that this case can be hit when the metadata is sufficiently malformed. We need to turn this into aLeftinstead.
See detailed comments.
lib/primitive/test/spec/Cardano/Wallet/Primitive/Types/MetadataEncryptionSpec.hs
Outdated
Show resolved
Hide resolved
lib/primitive/test/spec/Cardano/Wallet/Primitive/Types/MetadataEncryptionSpec.hs
Outdated
Show resolved
Hide resolved
lib/primitive/test/spec/Cardano/Wallet/Primitive/Types/MetadataEncryptionSpec.hs
Outdated
Show resolved
Hide resolved
lib/primitive/test/spec/Cardano/Wallet/Primitive/Types/MetadataEncryptionSpec.hs
Outdated
Show resolved
Hide resolved
lib/primitive/lib/Cardano/Wallet/Primitive/Types/MetadataEncryption.hs
Outdated
Show resolved
Hide resolved
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
2 times, most recently
from
55868d2 to
df60f0c
Compare
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
from
df60f0c to
81231cc
Compare
HeinrichApfelmus
approved these changes
Aug 6, 2024
relocation to primitive 2 relocation to primitive 3 relocation to primitive 4 relocation to primitive 5
adjust unit tests another property
hlint rebase cleanup
improve on unit tests - part 2 improve on unit tests - part 3 and add better error handling
paweljakubas
force-pushed
the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
from
81231cc to
3027af8
Compare
paweljakubas
deleted the
paweljakubas/adp-3348/decrypt-encrypted-metadata
branch
WilliamKingNoel-Bot
pushed a commit
that referenced
this pull request
Aug 6, 2024
…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 run 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 <!--, so that this text does not appear in merge commit messages. 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 run scripts specifications test touch.me.CI weeder.dhall Don't waste reviewers' time: ✓ If it's a draft, select the Create Draft PR option. ✓ Self-review your changes to make sure nothing unexpected slipped through. 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 run scripts specifications test touch.me.CI weeder.dhall Try to make your intent clear: ✓ Write a good Description that explains what this PR is meant to do. ✓ Jira will detect and link to this PR once created, but you can also link this PR in the description of the corresponding Jira ticket. ✓ Highlight what Testing you have done. ✓ Acknowledge any changes required to the Documentation. --> Idea is to enable decryption of already encrypted metadata in decodeTransaction. The user specifies passphrase in which metadata was encrypted and the metadata located as in CIP83 is decrypted. The change is added in non-intrusive way. Due to lack of JSON instances exposure in cardano-api the needed functions were added (they are about to be erased when cardano-api exposes `metadataValueFromJsonNoSchema` in next node versions). The heart of solution is `fromMetadataEncrypted`. Api spec was updated. Integration tests expanded to show the case. ### Comments <!-- Additional comments, links, or screenshots to attach, if any. --> ### Issue Number adp-3348 <!-- Reference the Jira/GitHub issue that this PR relates to, and which requirements it tackles. Note: Jira issues of the form ADP- will be auto-linked. --> Source commit: b887956
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Idea is to enable decryption of already encrypted metadata in decodeTransaction. The user specifies passphrase in which metadata was encrypted and the metadata located as in CIP83 is decrypted. The change is added in non-intrusive way. Due to lack of JSON instances exposure in cardano-api the needed functions were added (they are about to be erased when cardano-api exposes
metadataValueFromJsonNoSchemain next node versions).The heart of solution is
fromMetadataEncrypted. Api spec was updated. Integration tests expanded to show the case.Comments
Issue Number
adp-3348