code.vegaprotocol.io/vega@v0.79.0/cmd/vegawallet/commands/key_generate.go

// Copyright (C) 2023 Gobalsky Labs Limited
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.

package cmd

import (
	"context"
	"errors"
	"fmt"
	"io"
	"os"

	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/cli"
	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/flags"
	"code.vegaprotocol.io/vega/cmd/vegawallet/commands/printer"
	"code.vegaprotocol.io/vega/wallet/api"
	"code.vegaprotocol.io/vega/wallet/wallets"

	"github.com/spf13/cobra"
)

var (
	generateKeyLong = cli.LongDesc(`
		Generate a new Ed25519 key pair in the specified wallet.
	`)

	generateKeyExample = cli.Examples(`
		# Generate a key pair
		{{.Software}} key generate --wallet WALLET

		# Generate a key pair with additional metadata (name = my-wallet and type = validation)
		{{.Software}} key generate --wallet WALLET --meta "name:my-wallet,type:validation"

		# Generate a key pair with custom name
		{{.Software}} key generate --wallet WALLET --meta "name:my-wallet"
	`)
)

type GenerateKeyHandler func(api.AdminGenerateKeyParams, string) (api.AdminGenerateKeyResult, error)

func NewCmdGenerateKey(w io.Writer, rf *RootFlags) *cobra.Command {
	h := func(params api.AdminGenerateKeyParams, passphrase string) (api.AdminGenerateKeyResult, error) {
		ctx := context.Background()

		walletStore, err := wallets.InitialiseStore(rf.Home, false)
		if err != nil {
			return api.AdminGenerateKeyResult{}, fmt.Errorf("couldn't initialise wallets store: %w", err)
		}
		defer walletStore.Close()

		if _, errDetails := api.NewAdminUnlockWallet(walletStore).Handle(ctx, api.AdminUnlockWalletParams{
			Wallet:     params.Wallet,
			Passphrase: passphrase,
		}); errDetails != nil {
			return api.AdminGenerateKeyResult{}, errors.New(errDetails.Data)
		}

		rawResult, errDetails := api.NewAdminGenerateKey(walletStore).Handle(ctx, params)
		if errDetails != nil {
			return api.AdminGenerateKeyResult{}, errors.New(errDetails.Data)
		}
		return rawResult.(api.AdminGenerateKeyResult), nil
	}

	return BuildCmdGenerateKey(w, h, rf)
}

func BuildCmdGenerateKey(w io.Writer, handler GenerateKeyHandler, rf *RootFlags) *cobra.Command {
	f := &GenerateKeyFlags{}

	cmd := &cobra.Command{
		Use:     "generate",
		Short:   "Generate a new key pair in a given wallet",
		Long:    generateKeyLong,
		Example: generateKeyExample,
		RunE: func(_ *cobra.Command, _ []string) error {
			req, pass, err := f.Validate()
			if err != nil {
				return err
			}

			resp, err := handler(req, pass)
			if err != nil {
				return err
			}

			switch rf.Output {
			case flags.InteractiveOutput:
				PrintGenerateKeyResponse(w, req, resp)
			case flags.JSONOutput:
				return printer.FprintJSON(w, resp)
			}

			return nil
		},
	}

	cmd.Flags().StringVarP(&f.Wallet,
		"wallet", "w",
		"",
		"The wallet where the key is generated in",
	)
	cmd.Flags().StringVarP(&f.PassphraseFile,
		"passphrase-file", "p",
		"",
		"Path to the file containing the wallet's passphrase",
	)
	cmd.Flags().StringSliceVarP(&f.RawMetadata,
		"meta", "m",
		[]string{},
		`Metadata to add to the generated key-pair: "my-key1:my-value1,my-key2:my-value2"`,
	)

	autoCompleteWallet(cmd, rf.Home, "wallet")

	return cmd
}

type GenerateKeyFlags struct {
	Wallet         string
	PassphraseFile string
	RawMetadata    []string
}

func (f *GenerateKeyFlags) Validate() (api.AdminGenerateKeyParams, string, error) {
	req := api.AdminGenerateKeyParams{}

	if len(f.Wallet) == 0 {
		return api.AdminGenerateKeyParams{}, "", flags.MustBeSpecifiedError("wallet")
	}
	req.Wallet = f.Wallet

	metadata, err := cli.ParseMetadata(f.RawMetadata)
	if err != nil {
		return api.AdminGenerateKeyParams{}, "", err
	}
	req.Metadata = metadata

	passphrase, err := flags.GetPassphrase(f.PassphraseFile)
	if err != nil {
		return api.AdminGenerateKeyParams{}, "", err
	}

	return req, passphrase, nil
}

func PrintGenerateKeyResponse(w io.Writer, req api.AdminGenerateKeyParams, resp api.AdminGenerateKeyResult) {
	p := printer.NewInteractivePrinter(w)

	str := p.String()
	defer p.Print(str)

	str.CheckMark().Text("Key pair has been generated in wallet ").Bold(req.Wallet).NextLine()
	str.CheckMark().SuccessText("Generating a key pair succeeded").NextSection()
	str.Text("Public key:").NextLine()
	str.WarningText(resp.PublicKey).NextLine()
	str.Text("Metadata:").NextLine()
	printMeta(str, resp.Metadata)
	str.NextSection()
	str.BlueArrow().InfoText("Run the service").NextLine()
	str.Text("Now, you can run the service. See the following command:").NextSection()
	str.Code(fmt.Sprintf("%s service run --help", os.Args[0])).NextLine()
}