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]>

CHANGELOG.md

@@ -25,7 +25,8 @@
 
 ### Features
 
-*  [#1406](https://github.com/crypto-org-chain/cronos/pull/1406) Add set-encryption-key for encryption module.
+* [#1406](https://github.com/crypto-org-chain/cronos/pull/1406) Add set-encryption-key for encryption module.
+* [#1411](https://github.com/crypto-org-chain/cronos/pull/1411) Add encrypt and decrypt cmds for message.
 
 *April 8, 2024*
 

client/docs/config.json

@@ -15,12 +15,7 @@
       }
     },
     {
-      "url": "./tmp-swagger-gen/e2ee/query.swagger.json",
-      "operationIds": {
-        "rename": {
-          "Params": "Keys"
-        }
-      }
+      "url": "./tmp-swagger-gen/e2ee/query.swagger.json"
     },
     {
       "url": "./tmp-swagger-gen/ethermint/evm/v1/query.swagger.json",

cmd/cronosd/cmd/root.go

@@ -43,6 +43,7 @@ import (
 	"github.com/crypto-org-chain/cronos/v2/app"
 	"github.com/crypto-org-chain/cronos/v2/cmd/cronosd/opendb"
 	"github.com/crypto-org-chain/cronos/v2/x/cronos"
+	e2eecli "github.com/crypto-org-chain/cronos/v2/x/e2ee/client/cli"
 	// this line is used by starport scaffolding # stargate/root/import
 )
 
@@ -150,6 +151,7 @@ func initRootCmd(rootCmd *cobra.Command, encodingConfig ethermint.EncodingConfig
 		queryCommand(),
 		txCommand(),
 		ethermintclient.KeyCommands(app.DefaultNodeHome),
+		e2eecli.E2EECommand(),
 	)
 
 	// add rosetta

integration_tests/cosmoscli.py

@@ -1,6 +1,7 @@
 import binascii
 import enum
 import hashlib
+import itertools
 import json
 import os
 import re
@@ -1825,16 +1826,16 @@ def query_e2ee_key(self, address):
                 home=self.data_dir,
                 output="json",
             )
-        )
+        )["key"]
 
-    def set_e2ee_key(self, key, **kwargs):
+    def register_e2ee_key(self, key, **kwargs):
         kwargs.setdefault("gas_prices", DEFAULT_GAS_PRICE)
         kwargs.setdefault("gas", DEFAULT_GAS)
         rsp = json.loads(
             self.raw(
                 "tx",
                 "e2ee",
-                "set-encryption-key",
+                "register-encryption-key",
                 key,
                 "-y",
                 home=self.data_dir,
@@ -1844,3 +1845,34 @@ def set_e2ee_key(self, key, **kwargs):
         if rsp["code"] == 0:
             rsp = self.event_query_tx_for(rsp["txhash"])
         return rsp
+
+    def keygen(self, **kwargs):
+        return self.raw("e2ee", "keygen", home=self.data_dir, **kwargs).strip().decode()
+
+    def encrypt(self, input, *recipients, **kwargs):
+        return (
+            self.raw(
+                "e2ee",
+                "encrypt",
+                input,
+                *itertools.chain.from_iterable(("-r", r) for r in recipients),
+                home=self.data_dir,
+                **kwargs,
+            )
+            .strip()
+            .decode()
+        )
+
+    def decrypt(self, input, identity="e2ee-identity", **kwargs):
+        return (
+            self.raw(
+                "e2ee",
+                "decrypt",
+                input,
+                home=self.data_dir,
+                identity=identity,
+                **kwargs,
+            )
+            .strip()
+            .decode()
+        )

integration_tests/test_e2ee.py

@@ -1,10 +1,26 @@
-import base64
+def test_encrypt_decrypt(cronos):
+    cli = cronos.cosmos_cli()
 
+    # gen two keys for two accounts
+    pubkey0 = cli.keygen(keyring_name="key0")
+    cli.register_e2ee_key(pubkey0, _from="validator")
+    assert cli.query_e2ee_key(cli.address("validator")) == pubkey0
+    pubkey1 = cli.keygen(keyring_name="key1")
+    cli.register_e2ee_key(pubkey1, _from="community")
+    assert cli.query_e2ee_key(cli.address("community")) == pubkey1
 
-def test_set_key(cronos):
-    cli = cronos.cosmos_cli()
-    key = base64.b64encode(b"new_key").decode("utf-8")
-    cli.set_e2ee_key(key, _from="community")
-    adr = cli.address("community")
-    p = cli.query_e2ee_key(adr)
-    assert p["key"] == key
+    # prepare data file to encrypt
+    content = "Hello World!"
+    plainfile = cli.data_dir / "plaintext"
+    plainfile.write_text(content)
+
+    cipherfile = cli.data_dir / "ciphertext"
+    cli.encrypt(
+        plainfile,
+        cli.address("validator"),
+        cli.address("community"),
+        output=cipherfile,
+    )
+
+    assert cli.decrypt(cipherfile, identity="key0") == content
+    assert cli.decrypt(cipherfile, identity="key1") == content

proto/e2ee/genesis.proto

@@ -8,7 +8,7 @@ option go_package = "github.com/crypto-org-chain/cronos/v2/x/e2ee/types";
 // EncryptionKeyEntry is a type that contains the owner and the public key.
 message EncryptionKeyEntry {
   string address = 1;
-  bytes key = 2;
+  string key = 2;
 }
 
 // GenesisState defines the e2ee module's genesis state.

proto/e2ee/query.proto

@@ -20,5 +20,5 @@ message KeyRequest {
 
 // KeyResponse is the response type for the Query/Key RPC method.
 message KeyResponse {
-  bytes key = 1;
+  string key = 1;
 }

proto/e2ee/tx.proto

@@ -18,7 +18,7 @@ message MsgRegisterEncryptionKey {
   option (cosmos.msg.v1.signer) = "address";
 
   string address = 1;
-  bytes key = 2;
+  string key = 2;
 }
 
 // MsgRegisterEncryptionKeyResponse defines the Msg/RegisterEncryptionKey response type

x/e2ee/autocli.go

@@ -23,8 +23,8 @@ func (am AppModule) AutoCLIOptions() *autocliv1.ModuleOptions {
 			RpcCommandOptions: []*autocliv1.RpcCommandOptions{
 				{
 					RpcMethod: "RegisterEncryptionKey",
-					Use:       "set-encryption-key [key]",
-					Short:     "Set encryption key is stored associated with the user address.",
+					Use:       "register-encryption-key [key]",
+					Short:     "Register encryption key stores an public key for asymmetric encryption with the user address.",
 					PositionalArgs: []*autocliv1.PositionalArgDescriptor{
 						{ProtoField: "key"},
 					},

x/e2ee/client/cli/cmd.go

@@ -0,0 +1,18 @@
+package cli
+
+import "github.com/spf13/cobra"
+
+func E2EECommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "e2ee",
+		Short: "End-to-end encryption commands",
+	}
+
+	cmd.AddCommand(
+		KeygenCommand(),
+		EncryptCommand(),
+		DecryptCommand(),
+	)
+
+	return cmd
+}

x/e2ee/client/cli/decrypt.go

@@ -0,0 +1,108 @@
+package cli
+
+import (
+	"fmt"
+	"io"
+	"os"
+
+	"filippo.io/age"
+	"github.com/spf13/cobra"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/flags"
+
+	"github.com/crypto-org-chain/cronos/v2/x/e2ee/keyring"
+	"github.com/crypto-org-chain/cronos/v2/x/e2ee/types"
+)
+
+const FlagIdentity = "identity"
+
+func DecryptCommand() *cobra.Command {
+	cmd := &cobra.Command{
+		Use:   "decrypt [input-file]",
+		Short: "Decrypt input file to local identity",
+		Args:  cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx, err := client.GetClientQueryContext(cmd)
+			if err != nil {
+				return err
+			}
+
+			kr, err := keyring.New("cronosd", clientCtx.Keyring.Backend(), clientCtx.HomeDir, os.Stdin)
+			if err != nil {
+				return err
+			}
+
+			outputFile, err := cmd.Flags().GetString(flags.FlagOutput)
+			if err != nil {
+				return err
+			}
+
+			identityNames, err := cmd.Flags().GetStringArray(FlagIdentity)
+			if err != nil {
+				return err
+			}
+
+			if len(identityNames) == 0 {
+				return fmt.Errorf("no identity provided")
+			}
+
+			identities := make([]age.Identity, len(identityNames))
+			for i, name := range identityNames {
+				secret, err := kr.Get(name)
+				if err != nil {
+					return err
+				}
+
+				identity, err := age.ParseX25519Identity(string(secret))
+				if err != nil {
+					return err
+				}
+
+				identities[i] = identity
+			}
+
+			var input io.Reader
+			inputFile := args[0]
+			if inputFile == "-" {
+				input = os.Stdin
+			} else {
+				f, err := os.Open(inputFile)
+				if err != nil {
+					return err
+				}
+				defer f.Close()
+				input = f
+			}
+
+			var output io.Writer
+			if outputFile == "-" {
+				output = os.Stdout
+			} else {
+				f, err := os.Create(outputFile)
+				if err != nil {
+					return err
+				}
+				defer f.Close()
+				output = f
+			}
+			return decrypt(identities, input, output)
+		},
+	}
+
+	cmd.Flags().StringArrayP(FlagIdentity, "i", []string{types.DefaultKeyringName}, "identity (can be repeated)")
+	cmd.Flags().StringP(flags.FlagOutput, "o", "-", "output file (default stdout)")
+
+	return cmd
+}
+
+func decrypt(identities []age.Identity, in io.Reader, out io.Writer) error {
+	r, err := age.Decrypt(in, identities...)
+	if err != nil {
+		return err
+	}
+	if _, err := io.Copy(out, r); err != nil {
+		return err
+	}
+	return nil
+}