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: no end-to-end encryption module #1407

Merged
merged 9 commits into from
Apr 26, 2024

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Apr 26, 2024

WIP: #1406

👮🏻👮🏻👮🏻 !!!! 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 end-to-end encryption (E2EE) capabilities for secure messaging and key management.
    • Added functionality to register and query encryption keys.
  • Enhancements

    • Updated the app structure to support new encryption features.
  • Documentation

    • Added comprehensive documentation for the new E2EE module.
  • Bug Fixes

    • Ensured encryption keys are properly managed during app upgrades.

Copy link
Contributor

coderabbitai bot commented Apr 26, 2024

Walkthrough

The recent updates focus on integrating an end-to-end encryption (E2EE) service into a blockchain application. This includes defining a protocol buffer for querying encryption keys and introducing message types for registering encryption keys for specific accounts. Additionally, changes in various files like app/app.go and new files like x/e2ee/module.go and x/e2ee/types/keys.go enhance the E2EE module's functionality.

Changes

Files Changes
proto/e2ee/query.proto, proto/e2ee/tx.proto Introduced protocol buffer definitions for E2EE service with key querying methods and message types for key registration.
app/app.go Added imports related to E2EE, modified key storage to include E2EE keys, declared E2EEKeeper in App struct, and initialized E2EEKeeper in the New function.
x/e2ee/module.go Introduced functionality for managing the E2EE module in a blockchain application.
x/e2ee/types/codec.go, x/e2ee/types/keys.go Added functionality for Amino JSON serialization and defined constants/functions for encryption keys in the types package.

Possibly related issues

Poem

🐰✨✍️
Encryption keys in a dance, a tale to unfold,
Messages secure, in a world so bold.
Queries and transactions, in harmony they play,
Safeguarding secrets, night and day.
CodeRabbit whispers, in the language of the wise,
E2EE magic, a coder's prize. 🌟🔐
🐰✨


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.

@yihuang yihuang requested a review from mmsqe April 26, 2024 03:26
Copy link

codecov bot commented Apr 26, 2024

Codecov Report

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

Project coverage is 35.47%. Comparing base (a44402e) to head (42a012a).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##             main    #1407       +/-   ##
===========================================
+ Coverage   15.35%   35.47%   +20.12%     
===========================================
  Files          75      130       +55     
  Lines        4925     9570     +4645     
===========================================
+ Hits          756     3395     +2639     
- Misses       4094     5813     +1719     
- Partials       75      362      +287     
Files Coverage Δ
x/e2ee/autocli.go 100.00% <100.00%> (ø)
x/e2ee/types/codec.go 100.00% <100.00%> (ø)
x/e2ee/types/genesis.go 100.00% <100.00%> (ø)
app/upgrades.go 18.18% <0.00%> (-0.87%) ⬇️
x/e2ee/types/keys.go 0.00% <0.00%> (ø)
x/e2ee/module.go 62.79% <62.79%> (ø)
x/e2ee/keeper/keeper.go 14.63% <14.63%> (ø)

... and 70 files with indirect coverage changes

add keeper

add grpc query

signer option

getter/setter

genesis init/export

fix lint
@yihuang yihuang marked this pull request as ready for review April 26, 2024 06:45
@yihuang yihuang requested a review from a team as a code owner April 26, 2024 06:45
@yihuang yihuang requested review from thomas-nguy and removed request for a team April 26, 2024 06:45
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/types/genesis.go (1)

11-11: Clarify the purpose of the empty Validate function.

Consider adding a comment explaining why this function returns nil. If future validations are planned, note that as well.

x/e2ee/keeper/keeper.go Show resolved Hide resolved
x/e2ee/README.md Show resolved Hide resolved
Copy link
Collaborator

@mmsqe mmsqe left a comment

Choose a reason for hiding this comment

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

seems just miss a new query config for swagger

x/e2ee/types/keys.go Outdated Show resolved Hide resolved
x/e2ee/types/codec.go Outdated Show resolved Hide resolved
yihuang and others added 2 commits April 26, 2024 15:44
Co-authored-by: mmsqe <[email protected]>
Signed-off-by: yihuang <[email protected]>
Co-authored-by: mmsqe <[email protected]>
Signed-off-by: yihuang <[email protected]>
@yihuang yihuang enabled auto-merge April 26, 2024 08:05
@yihuang yihuang added this pull request to the merge queue Apr 26, 2024
Merged via the queue into crypto-org-chain:main with commit f69878b Apr 26, 2024
37 checks passed
@yihuang yihuang deleted the encryption branch April 26, 2024 09:09
yihuang added a commit to yihuang/cronos that referenced this pull request Apr 30, 2024
* 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 <[email protected]>
Signed-off-by: yihuang <[email protected]>

* Update x/e2ee/types/codec.go

Co-authored-by: mmsqe <[email protected]>
Signed-off-by: yihuang <[email protected]>

---------

Signed-off-by: yihuang <[email protected]>
Co-authored-by: mmsqe <[email protected]>
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 <[email protected]>
Signed-off-by: yihuang <[email protected]>

* Update x/e2ee/types/codec.go

Co-authored-by: mmsqe <[email protected]>
Signed-off-by: yihuang <[email protected]>

---------

Signed-off-by: yihuang <[email protected]>
Co-authored-by: mmsqe <[email protected]>

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 <[email protected]>

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 <[email protected]>

fix lint

---------

Signed-off-by: yihuang <[email protected]>
Co-authored-by: yihuang <[email protected]>
Co-authored-by: yihuang <[email protected]>

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

Update CHANGELOG.md

Signed-off-by: yihuang <[email protected]>

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 <[email protected]>
Signed-off-by: yihuang <[email protected]>

* Update x/e2ee/types/codec.go

Co-authored-by: mmsqe <[email protected]>
Signed-off-by: yihuang <[email protected]>

---------

Signed-off-by: yihuang <[email protected]>
Co-authored-by: mmsqe <[email protected]>

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 <[email protected]>

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 <[email protected]>

fix lint

---------

Signed-off-by: yihuang <[email protected]>
Co-authored-by: yihuang <[email protected]>
Co-authored-by: yihuang <[email protected]>

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

Update CHANGELOG.md

Signed-off-by: yihuang <[email protected]>

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 <[email protected]>

* 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 <[email protected]>

* cleanup

* proto-gen

---------

Signed-off-by: yihuang <[email protected]>
Signed-off-by: mmsqe <[email protected]>
Co-authored-by: mmsqe <[email protected]>
alienc0der pushed a commit to alienc0der/supernova that referenced this pull request Jun 8, 2024
* 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 <[email protected]>
Signed-off-by: yihuang <[email protected]>

* Update x/e2ee/types/codec.go

Co-authored-by: mmsqe <[email protected]>
Signed-off-by: yihuang <[email protected]>

---------

Signed-off-by: yihuang <[email protected]>
Co-authored-by: mmsqe <[email protected]>
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