key_describe.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"

	"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 (
	describeKeyLong = cli.LongDesc(`
		Describe all known information about the specified key pair
	`)

	describeKeyExample = cli.Examples(`
		# Describe a key
		{{.Software}} key describe --wallet WALLET --pubkey PUBLIC_KEY
	`)
)

type DescribeKeyHandler func(api.AdminDescribeKeyParams, string) (api.AdminDescribeKeyResult, error)

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

		walletStore, err := wallets.InitialiseStore(rf.Home, false)
		if err != nil {
			return api.AdminDescribeKeyResult{}, 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.AdminDescribeKeyResult{}, errors.New(errDetails.Data)
		}

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

	return BuildCmdDescribeKey(w, h, rf)
}

func BuildCmdDescribeKey(w io.Writer, handler DescribeKeyHandler, rf *RootFlags) *cobra.Command {
	f := &DescribeKeyFlags{}

	cmd := &cobra.Command{
		Use:     "describe",
		Short:   "Describe the specified key pair",
		Long:    describeKeyLong,
		Example: describeKeyExample,
		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:
				PrintDescribeKeyResponse(w, resp)
			case flags.JSONOutput:
				return printer.FprintJSON(w, resp)
			}

			return nil
		},
	}

	cmd.Flags().StringVarP(&f.Wallet,
		"wallet", "w",
		"",
		"Name of the wallet to use",
	)
	cmd.Flags().StringVarP(&f.PublicKey,
		"pubkey", "k",
		"",
		"Public key to describe (hex-encoded)",
	)
	cmd.Flags().StringVarP(&f.PassphraseFile,
		"passphrase-file", "p",
		"",
		"Path to the file containing the wallet's passphrase",
	)

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

	return cmd
}

type DescribeKeyFlags struct {
	Wallet         string
	PassphraseFile string
	PublicKey      string
}

func (f *DescribeKeyFlags) Validate() (api.AdminDescribeKeyParams, string, error) {
	if len(f.Wallet) == 0 {
		return api.AdminDescribeKeyParams{}, "", flags.MustBeSpecifiedError("wallet")
	}

	if len(f.PublicKey) == 0 {
		return api.AdminDescribeKeyParams{}, "", flags.MustBeSpecifiedError("pubkey")
	}

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

	return api.AdminDescribeKeyParams{
		Wallet:    f.Wallet,
		PublicKey: f.PublicKey,
	}, passphrase, nil
}

func PrintDescribeKeyResponse(w io.Writer, resp api.AdminDescribeKeyResult) {
	p := printer.NewInteractivePrinter(w)

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

	str.Text("Name:              ").WarningText(resp.Name).NextLine()
	str.Text("Public key:        ").WarningText(resp.PublicKey).NextLine()
	str.Text("Algorithm Name:    ").WarningText(resp.Algorithm.Name).NextLine()
	str.Text("Algorithm Version: ").WarningText(fmt.Sprint(resp.Algorithm.Version)).NextSection()

	str.Text("Key pair is: ")
	switch resp.IsTainted {
	case true:
		str.DangerText("tainted").NextLine()
	case false:
		str.SuccessText("not tainted").NextLine()
	}
	str.Text("Tainting a key marks it as unsafe to use and ensures it will not be used to sign transactions.").NextLine()
	str.Text("This mechanism is useful when the key pair has been compromised.").NextSection()

	str.Text("Metadata:").NextLine()
	printMeta(str, resp.Metadata)
}