Skip to content

feat: add base64 Pubkeys from cli #17639

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.

Sign up for GitHub

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

Merged
julienrbrt merged 7 commits into from
Sep 7, 2023
Merged

feat: add base64 Pubkeys from cli #17639

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
97569c3
add: pubkey b64 cli
JulianToledano Sep 6, 2023
ae3f37b
changelog
JulianToledano Sep 6, 2023
31e5315
typo
JulianToledano Sep 6, 2023
54876fa
lint
JulianToledano Sep 6, 2023
b4cf069
Update client/keys/add.go
JulianToledano Sep 6, 2023
8549694
fix: JSON templating
JulianToledano Sep 6, 2023
71f7288
typo
JulianToledano Sep 6, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ Ref: https://keepachangelog.com/en/1.0.0/

### Features

* (client/keys) [#17639](https://github.com/cosmos/cosmos-sdk/pull/17639) Allows to add public keys in base64
Comment thread
JulianToledano marked this conversation as resolved.
Outdated
* (client) [#17513](https://github.com/cosmos/cosmos-sdk/pull/17513) Allow overwritting `client.toml`. Use `client.CreateClientConfig` in place of `client.ReadFromClientConfig` and provide a custom template and a custom config.
* (x/bank) [#14224](https://github.com/cosmos/cosmos-sdk/pull/14224) Allow injection of restrictions on transfers using `AppendSendRestriction` or `PrependSendRestriction`.
* (genutil) [#17571](https://github.com/cosmos/cosmos-sdk/pull/17571) Allow creation of `AppGenesis` without a file lookup.
Expand Down
47 changes: 38 additions & 9 deletions client/keys/add.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ package keys
import (
"bufio"
"bytes"
"encoding/base64"
"encoding/json"
"errors"
"fmt"
Expand All @@ -15,6 +16,7 @@ import (
"github.com/cosmos/cosmos-sdk/client"
"github.com/cosmos/cosmos-sdk/client/flags"
"github.com/cosmos/cosmos-sdk/client/input"
codectypes "github.com/cosmos/cosmos-sdk/codec/types"
"github.com/cosmos/cosmos-sdk/crypto/hd"
"github.com/cosmos/cosmos-sdk/crypto/keyring"
"github.com/cosmos/cosmos-sdk/crypto/keys/multisig"
Expand All @@ -23,15 +25,16 @@ import (
)

const (
flagInteractive = "interactive"
flagRecover = "recover"
flagNoBackup = "no-backup"
flagCoinType = "coin-type"
flagAccount = "account"
flagIndex = "index"
flagMultisig = "multisig"
flagNoSort = "nosort"
flagHDPath = "hd-path"
flagInteractive = "interactive"
flagRecover = "recover"
flagNoBackup = "no-backup"
flagCoinType = "coin-type"
flagAccount = "account"
flagIndex = "index"
flagMultisig = "multisig"
flagNoSort = "nosort"
flagHDPath = "hd-path"
flagPubKeyBase64 = "pubkey-base64"

// DefaultKeyPass contains the default key password for genesis transactions
DefaultKeyPass = "12345678"
Expand Down Expand Up @@ -69,6 +72,7 @@ Example:
f.Int(flagMultiSigThreshold, 1, "K out of N required signatures. For use in conjunction with --multisig")
f.Bool(flagNoSort, false, "Keys passed to --multisig are taken in the order they're supplied")
f.String(FlagPublicKey, "", "Parse a public key in JSON format and saves key info to <name> file.")
f.String(flagPubKeyBase64, "", "Parse a public key in base64 format and saves key info.")
f.BoolP(flagInteractive, "i", false, "Interactively prompt user for BIP39 passphrase and mnemonic")
f.Bool(flags.FlagUseLedger, false, "Store a local reference to a private key on a Ledger device")
f.Bool(flagRecover, false, "Provide seed phrase to recover existing key instead of creating")
Expand Down Expand Up @@ -189,6 +193,10 @@ func runAddCmd(ctx client.Context, cmd *cobra.Command, args []string, inBuf *buf
}

pubKey, _ := cmd.Flags().GetString(FlagPublicKey)
pubKeyBase64, _ := cmd.Flags().GetString(flagPubKeyBase64)
if pubKey != "" && pubKeyBase64 != "" {
return fmt.Errorf(`flags %s and %s cannot be used simultaneously`, FlagPublicKey, flagPubKeyBase64)
}
if pubKey != "" {
var pk cryptotypes.PubKey
if err = ctx.Codec.UnmarshalInterfaceJSON([]byte(pubKey), &pk); err != nil {
Expand All @@ -202,6 +210,27 @@ func runAddCmd(ctx client.Context, cmd *cobra.Command, args []string, inBuf *buf

return printCreate(ctx, cmd, k, false, "", outputFormat)
}
if pubKeyBase64 != "" {
b64, err := base64.StdEncoding.DecodeString(pubKeyBase64)
if err != nil {
return err
}
var pk cryptotypes.PubKey
// create an empty pubkey in order to get the algo TypeUrl.
tempAny, err := codectypes.NewAnyWithValue(algo.Generate()([]byte{}).PubKey())
if err != nil {
return err
}
jsonPub := fmt.Sprintf(`{"@type":"%s","key":"%s"}`, tempAny.TypeUrl, b64)
Copy link
Copy Markdown
Contributor

@alexanderbez alexanderbez Sep 6, 2023

Choose a reason for hiding this comment

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

Is there a way to avoid manual JSON templating?

Copy link
Copy Markdown
Contributor

@odeke-em odeke-em Sep 6, 2023

Choose a reason for hiding this comment

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

Yeah this is susceptible to some sneak attacks, we can invoke this

jsonPubB, err := json.Marshal(struct{
     Type string `json:"@type,omitempty"`
     Key string `json:"key,omitempty"`
}{tempAny.TypeURL, b64})
if err != nil {
    return fmt.Errorf("failed to JSON marshal typeURL and base64 key: %w", err)
}

Copy link
Copy Markdown
Contributor Author

@JulianToledano JulianToledano Sep 6, 2023

Choose a reason for hiding this comment

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

nice catch guys!! Resolved in last commit!

if err = ctx.Codec.UnmarshalInterfaceJSON([]byte(jsonPub), &pk); err != nil {
return err
}
k, err := kb.SaveOfflineKey(name, pk)
if err != nil {
return err
Comment thread
JulianToledano marked this conversation as resolved.
Outdated
}
return printCreate(ctx, cmd, k, false, "", outputFormat)
Comment thread
JulianToledano marked this conversation as resolved.
}

coinType, _ := cmd.Flags().GetUint32(flagCoinType)
account, _ := cmd.Flags().GetUint32(flagAccount)
Expand Down
19 changes: 19 additions & 0 deletions client/keys/add_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,6 +130,7 @@ func Test_runAddCmdBasic(t *testing.T) {
func Test_runAddCmdDryRun(t *testing.T) {
pubkey1 := `{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AtObiFVE4s+9+RX5SP8TN9r2mxpoaT4eGj9CJfK7VRzN"}`
pubkey2 := `{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"A/se1vkqgdQ7VJQCM4mxN+L+ciGhnnJ4XYsQCRBMrdRi"}`
b64Pubkey := "QWhnOHhpdXBJcGZ2UlR2ak5la1ExclROUThTOW96YjdHK2RYQmFLVjl4aUo="
cdc := moduletestutil.MakeTestEncodingConfig().Codec

testData := []struct {
Expand Down Expand Up @@ -189,6 +190,24 @@ func Test_runAddCmdDryRun(t *testing.T) {
},
added: false,
},
{
name: "base64 pubkey account is added",
args: []string{
"testkey",
fmt.Sprintf("--%s=%s", flags.FlagDryRun, "false"),
fmt.Sprintf("--%s=%s", flagPubKeyBase64, b64Pubkey),
},
added: true,
},
{
name: "base64 pubkey account is not added with dry run",
args: []string{
"testkey",
fmt.Sprintf("--%s=%s", flags.FlagDryRun, "true"),
fmt.Sprintf("--%s=%s", flagPubKeyBase64, b64Pubkey),
},
added: false,
},
}
for _, tt := range testData {
tt := tt
Expand Down