Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Problem: encryption-key cmd is not supported #1409

Merged
merged 3 commits into from
Apr 26, 2024

Conversation

mmsqe
Copy link
Collaborator

@mmsqe mmsqe commented Apr 26, 2024

👮🏻👮🏻👮🏻 !!!! REFERENCE THE PROBLEM YOUR ARE SOLVING IN THE PR TITLE AND DESCRIBE YOUR SOLUTION HERE !!!! DO NOT FORGET !!!! 👮🏻👮🏻👮🏻

PR Checklist:

  • Have you read the CONTRIBUTING.md?
  • Does your PR follow the C4 patch requirements?
  • Have you rebased your work on top of the latest master?
  • Have you checked your code compiles? (make)
  • Have you included tests for any non-trivial functionality?
  • Have you checked your code passes the unit tests? (make test)
  • Have you checked your code formatting is correct? (go fmt)
  • Have you checked your basic code style is fine? (golangci-lint run)
  • If you added any dependencies, have you checked they do not contain any known vulnerabilities? (go list -json -m all | nancy sleuth)
  • If your changes affect the client infrastructure, have you run the integration test?
  • If your changes affect public APIs, does your PR follow the C4 evolution of public contracts?
  • If your code changes public APIs, have you incremented the crate version numbers and documented your changes in the CHANGELOG.md?
  • If you are contributing for the first time, please read the agreement in CONTRIBUTING.md now and add a comment to this pull request stating that your PR is in accordance with the Developer's Certificate of Origin.

Thank you for your code, it's appreciated! :)

Summary by CodeRabbit

  • New Features
    • Introduced a new encryption key management functionality, allowing users to set and query encryption keys directly through the application interface.
    • Added end-to-end encryption test to ensure the reliability of encryption key settings.
    • Added a new endpoint for querying encryption keys and defined a response schema for encryption key queries in the Swagger documentation.

Copy link
Contributor

coderabbitai bot commented Apr 26, 2024

Warning

Rate Limit Exceeded

@mmsqe has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 34 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 9f61496 and d14d232.

Walkthrough

The recent updates enhance security in the cronos project by introducing encryption key management features. Users can now set and query encryption keys, improving data protection. These changes span across CLI commands, testing frameworks, and interactions with the Cosmos network.

Changes

File Path Change Summary
CHANGELOG.md Added set-encryption-key functionality to the cronos project.
integration_tests/cosmoscli.py Updated with new functions for encryption key management: query_e2ee_key, set_e2ee_key.
integration_tests/test_e2ee.py Introduces a test for setting end-to-end encryption keys using base64 encoding.
x/e2ee/autocli.go Added a new RPC command RegisterEncryptionKey for setting encryption keys in AutoCLIOptions.
client/docs/config.json Added a new entry in the configuration JSON file to rename "Params" to "Keys" in a Swagger JSON file.
client/docs/swagger-ui/swagger.yaml Added a new endpoint for querying encryption keys and defined a response schema.

Possibly related issues

  • Issue Problem: no e2e encrypted messaging support #1406: This issue aligns with the implementation of encryption key management commands, such as gen-encryption-key and set-encryption-key, addressing the need for end-to-end encrypted messaging support.

Poem

🐇💻✨
In the land of code, where secrets hide,
A rabbit hops, with pride it strides.
Keys to lock, and keys to free,
Secure the data, for you and me.
Hop, hop, hop, on silicon leaves,
Crafting safety, in digital sheaves.
🌟🔐🌌


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@mmsqe mmsqe marked this pull request as ready for review April 26, 2024 09:13
@mmsqe mmsqe requested a review from a team as a code owner April 26, 2024 09:13
@mmsqe mmsqe requested review from JayT106 and devashishdxt and removed request for a team April 26, 2024 09:13
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

Out of diff range and nitpick comments (1)
x/e2ee/autocli.go (1)

21-33: Review the description in the Short field for clarity and accuracy.

The description "Set encryption key is stored associated with the user address." could be improved for clarity. Consider rephrasing to "Store an encryption key associated with a user address."

CHANGELOG.md Outdated Show resolved Hide resolved
integration_tests/cosmoscli.py Outdated Show resolved Hide resolved
Copy link

codecov bot commented Apr 26, 2024

Codecov Report

Attention: Patch coverage is 71.42857% with 6 lines in your changes are missing coverage. Please review.

Project coverage is 34.30%. Comparing base (f69878b) to head (d14d232).

Additional details and impacted files

Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1409      +/-   ##
==========================================
- Coverage   35.47%   34.30%   -1.18%     
==========================================
  Files         130      130              
  Lines        9570     9591      +21     
==========================================
- Hits         3395     3290     -105     
- Misses       5813     5955     +142     
+ Partials      362      346      -16     
Files Coverage Δ
x/e2ee/autocli.go 100.00% <100.00%> (ø)
x/e2ee/types/genesis.go 71.42% <33.33%> (-28.58%) ⬇️
x/e2ee/types/keys.go 18.18% <33.33%> (+18.18%) ⬆️

... and 10 files with indirect coverage changes

@mmsqe mmsqe requested a review from yihuang April 26, 2024 09:46
@mmsqe mmsqe added this pull request to the merge queue Apr 26, 2024
Merged via the queue into crypto-org-chain:main with commit 3275b57 Apr 26, 2024
36 of 37 checks passed
yihuang pushed a commit to yihuang/cronos that referenced this pull request Apr 30, 2024
* Problem: encryption-key cmd is not supported

* gen doc

* add validate
yihuang added a commit to yihuang/cronos that referenced this pull request May 3, 2024
Problem: no end-to-end encryption module (crypto-org-chain#1407)

* Problem: no end-to-end encryption module

add keeper

add grpc query

signer option

getter/setter

genesis init/export

fix lint

* fix proto lint

* fix test

* register codec

* changelog

* fix build

* Update x/e2ee/types/keys.go

Co-authored-by: mmsqe <mavis@crypto.com>
Signed-off-by: yihuang <huang@crypto.com>

* Update x/e2ee/types/codec.go

Co-authored-by: mmsqe <mavis@crypto.com>
Signed-off-by: yihuang <huang@crypto.com>

---------

Signed-off-by: yihuang <huang@crypto.com>
Co-authored-by: mmsqe <mavis@crypto.com>

Problem: encryption-key cmd is not supported (crypto-org-chain#1409)

* Problem: encryption-key cmd is not supported

* gen doc

* add validate

Problem: no keyring interface for e2ee to store arbitrary payload (crypto-org-chain#1413)

changelo

add age encrypt/decrypt in unit test

Update x/e2ee/keyring/keyring.go

Signed-off-by: yihuang <huang@crypto.com>

fix lint

fix build

Problem: no encrypt and decrypt cmds for message (crypto-org-chain#1411)

* Problem: no encrypt and decrypt cmds for message

* fix doc

* add gen

* test

* cleanup

* move command to e2ee module

move encrypt cmd to e2ee module

move decrypt cmd to e2ee

update integration test

store key as string, to make autocli better

fix integration test

Update x/e2ee/client/cli/encrypt.go

Signed-off-by: yihuang <huang@crypto.com>

fix lint

---------

Signed-off-by: yihuang <huang@crypto.com>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: yihuang <yi.codeplayer@gmail.com>

Problem: no efficient batch query for encryption keys (crypto-org-chain#1415)

Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

update swagger

typo

fix build

proposal handler

update version

check exist

Problem: proto-gen fails in CI (crypto-org-chain#1392)

* Problem: proto-gen fails in CI

* Apply suggestions from code review

add cronos msg

add store-block-list cmd

refresh block list

add handler

update deps

add handler

lint

fix cmd

test store list

set with ante

move to util

fix ibc

Revert "set with ante"

This reverts commit c2700f5.

reject on err

fix prepare proposal

fix proto lint
yihuang added a commit that referenced this pull request May 6, 2024
* Problem: e2ee module is not backported

Problem: no end-to-end encryption module (#1407)

* Problem: no end-to-end encryption module

add keeper

add grpc query

signer option

getter/setter

genesis init/export

fix lint

* fix proto lint

* fix test

* register codec

* changelog

* fix build

* Update x/e2ee/types/keys.go

Co-authored-by: mmsqe <mavis@crypto.com>
Signed-off-by: yihuang <huang@crypto.com>

* Update x/e2ee/types/codec.go

Co-authored-by: mmsqe <mavis@crypto.com>
Signed-off-by: yihuang <huang@crypto.com>

---------

Signed-off-by: yihuang <huang@crypto.com>
Co-authored-by: mmsqe <mavis@crypto.com>

Problem: encryption-key cmd is not supported (#1409)

* Problem: encryption-key cmd is not supported

* gen doc

* add validate

Problem: no keyring interface for e2ee to store arbitrary payload (#1413)

changelo

add age encrypt/decrypt in unit test

Update x/e2ee/keyring/keyring.go

Signed-off-by: yihuang <huang@crypto.com>

fix lint

fix build

Problem: no encrypt and decrypt cmds for message (#1411)

* Problem: no encrypt and decrypt cmds for message

* fix doc

* add gen

* test

* cleanup

* move command to e2ee module

move encrypt cmd to e2ee module

move decrypt cmd to e2ee

update integration test

store key as string, to make autocli better

fix integration test

Update x/e2ee/client/cli/encrypt.go

Signed-off-by: yihuang <huang@crypto.com>

fix lint

---------

Signed-off-by: yihuang <huang@crypto.com>
Co-authored-by: yihuang <huang@crypto.com>
Co-authored-by: yihuang <yi.codeplayer@gmail.com>

Problem: no efficient batch query for encryption keys (#1415)

Update CHANGELOG.md

Signed-off-by: yihuang <huang@crypto.com>

update swagger

typo

fix build

proposal handler

update version

check exist

Problem: proto-gen fails in CI (#1392)

* Problem: proto-gen fails in CI

* Apply suggestions from code review

add cronos msg

add store-block-list cmd

refresh block list

add handler

update deps

add handler

lint

fix cmd

test store list

set with ante

move to util

fix ibc

Revert "set with ante"

This reverts commit c2700f5.

reject on err

fix prepare proposal

fix proto lint

* cmd to encrypt to validators

* fix test

* temp

* fix test

* improve test

* Problem: no validate for malformed e2ee key in register (#1421)

* Problem: no validate for malformed e2ee key in register

* update doc

* Apply suggestions from code review

* cleanup

---------

Co-authored-by: yihuang <yi.codeplayer@gmail.com>

* cleanup test

* revert

* fix test

* fix test

* remove mempool blocked-addresses

* fix test

* fix test

* fix test

* fix patch

* avoid prompt

* encrypt clear list

* cleanup

* add validate

* avoid concurrent mutate

* Update app/proposal.go

Signed-off-by: mmsqe <mavis@crypto.com>

* cleanup

* proto-gen

---------

Signed-off-by: yihuang <huang@crypto.com>
Signed-off-by: mmsqe <mavis@crypto.com>
Co-authored-by: mmsqe <mavis@crypto.com>
alienc0der pushed a commit to alienc0der/supernova that referenced this pull request Jun 8, 2024
* Problem: encryption-key cmd is not supported

* gen doc

* add validate
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants