github.com/SmartMeshFoundation/Spectrum@v0.0.0-20220621030607-452a266fee1e/cmd/smc/accountcmd.go (about)

     1  // Copyright 2016 The Spectrum Authors
     2  // This file is part of Spectrum.
     3  //
     4  // Spectrum is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // Spectrum is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU General Public License
    15  // along with Spectrum. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package main
    18  
    19  import (
    20  	"fmt"
    21  	"io/ioutil"
    22  
    23  	"github.com/SmartMeshFoundation/Spectrum/accounts"
    24  	"github.com/SmartMeshFoundation/Spectrum/accounts/keystore"
    25  	"github.com/SmartMeshFoundation/Spectrum/cmd/utils"
    26  	"github.com/SmartMeshFoundation/Spectrum/console"
    27  	"github.com/SmartMeshFoundation/Spectrum/crypto"
    28  	"github.com/SmartMeshFoundation/Spectrum/log"
    29  	"gopkg.in/urfave/cli.v1"
    30  )
    31  
    32  var (
    33  	walletCommand = cli.Command{
    34  		Name:      "wallet",
    35  		Usage:     "Manage Ethereum presale wallets",
    36  		ArgsUsage: "",
    37  		Category:  "ACCOUNT COMMANDS",
    38  		Description: `
    39      geth wallet import /path/to/my/presale.wallet
    40  
    41  will prompt for your password and imports your ether presale account.
    42  It can be used non-interactively with the --password option taking a
    43  passwordfile as argument containing the wallet password in plaintext.`,
    44  		Subcommands: []cli.Command{
    45  			{
    46  
    47  				Name:      "import",
    48  				Usage:     "Import Ethereum presale wallet",
    49  				ArgsUsage: "<keyFile>",
    50  				Action:    utils.MigrateFlags(importWallet),
    51  				Category:  "ACCOUNT COMMANDS",
    52  				Flags: []cli.Flag{
    53  					utils.DataDirFlag,
    54  					utils.KeyStoreDirFlag,
    55  					utils.PasswordFileFlag,
    56  					utils.LightKDFFlag,
    57  				},
    58  				Description: `
    59  	geth wallet [options] /path/to/my/presale.wallet
    60  
    61  will prompt for your password and imports your ether presale account.
    62  It can be used non-interactively with the --password option taking a
    63  passwordfile as argument containing the wallet password in plaintext.`,
    64  			},
    65  		},
    66  	}
    67  
    68  	accountCommand = cli.Command{
    69  		Name:     "account",
    70  		Usage:    "Manage accounts",
    71  		Category: "ACCOUNT COMMANDS",
    72  		Description: `
    73  
    74  Manage accounts, list all existing accounts, import a private key into a new
    75  account, create a new account or update an existing account.
    76  
    77  It supports interactive mode, when you are prompted for password as well as
    78  non-interactive mode where passwords are supplied via a given password file.
    79  Non-interactive mode is only meant for scripted use on test networks or known
    80  safe environments.
    81  
    82  Make sure you remember the password you gave when creating a new account (with
    83  either new or import). Without it you are not able to unlock your account.
    84  
    85  Note that exporting your key in unencrypted format is NOT supported.
    86  
    87  Keys are stored under <DATADIR>/keystore.
    88  It is safe to transfer the entire directory or the individual keys therein
    89  between ethereum nodes by simply copying.
    90  
    91  Make sure you backup your keys regularly.`,
    92  		Subcommands: []cli.Command{
    93  			{
    94  				Name:   "list",
    95  				Usage:  "Print summary of existing accounts",
    96  				Action: utils.MigrateFlags(accountList),
    97  				Flags: []cli.Flag{
    98  					utils.DataDirFlag,
    99  					utils.KeyStoreDirFlag,
   100  				},
   101  				Description: `
   102  Print a short summary of all accounts`,
   103  			},
   104  			{
   105  				Name:   "new",
   106  				Usage:  "Create a new account",
   107  				Action: utils.MigrateFlags(accountCreate),
   108  				Flags: []cli.Flag{
   109  					utils.DataDirFlag,
   110  					utils.KeyStoreDirFlag,
   111  					utils.PasswordFileFlag,
   112  					utils.LightKDFFlag,
   113  				},
   114  				Description: `
   115      geth account new
   116  
   117  Creates a new account and prints the address.
   118  
   119  The account is saved in encrypted format, you are prompted for a passphrase.
   120  
   121  You must remember this passphrase to unlock your account in the future.
   122  
   123  For non-interactive use the passphrase can be specified with the --password flag:
   124  
   125  Note, this is meant to be used for testing only, it is a bad idea to save your
   126  password to file or expose in any other way.
   127  `,
   128  			},
   129  			{
   130  				Name:      "update",
   131  				Usage:     "Update an existing account",
   132  				Action:    utils.MigrateFlags(accountUpdate),
   133  				ArgsUsage: "<address>",
   134  				Flags: []cli.Flag{
   135  					utils.DataDirFlag,
   136  					utils.KeyStoreDirFlag,
   137  					utils.LightKDFFlag,
   138  				},
   139  				Description: `
   140      geth account update <address>
   141  
   142  Update an existing account.
   143  
   144  The account is saved in the newest version in encrypted format, you are prompted
   145  for a passphrase to unlock the account and another to save the updated file.
   146  
   147  This same command can therefore be used to migrate an account of a deprecated
   148  format to the newest format or change the password for an account.
   149  
   150  For non-interactive use the passphrase can be specified with the --password flag:
   151  
   152      geth account update [options] <address>
   153  
   154  Since only one password can be given, only format update can be performed,
   155  changing your password is only possible interactively.
   156  `,
   157  			},
   158  			{
   159  				Name:   "import",
   160  				Usage:  "Import a private key into a new account",
   161  				Action: utils.MigrateFlags(accountImport),
   162  				Flags: []cli.Flag{
   163  					utils.DataDirFlag,
   164  					utils.KeyStoreDirFlag,
   165  					utils.PasswordFileFlag,
   166  					utils.LightKDFFlag,
   167  				},
   168  				ArgsUsage: "<keyFile>",
   169  				Description: `
   170      geth account import <keyfile>
   171  
   172  Imports an unencrypted private key from <keyfile> and creates a new account.
   173  Prints the address.
   174  
   175  The keyfile is assumed to contain an unencrypted private key in hexadecimal format.
   176  
   177  The account is saved in encrypted format, you are prompted for a passphrase.
   178  
   179  You must remember this passphrase to unlock your account in the future.
   180  
   181  For non-interactive use the passphrase can be specified with the -password flag:
   182  
   183      geth account import [options] <keyfile>
   184  
   185  Note:
   186  As you can directly copy your encrypted accounts to another ethereum instance,
   187  this import mechanism is not needed when you transfer an account between
   188  nodes.
   189  `,
   190  			},
   191  		},
   192  	}
   193  )
   194  
   195  func accountList(ctx *cli.Context) error {
   196  	stack, _ := makeConfigNode(ctx)
   197  	var index int
   198  	for _, wallet := range stack.AccountManager().Wallets() {
   199  		for _, account := range wallet.Accounts() {
   200  			fmt.Printf("Account #%d: {%x} %s\n", index, account.Address, &account.URL)
   201  			index++
   202  		}
   203  	}
   204  	return nil
   205  }
   206  
   207  // tries unlocking the specified account a few times.
   208  func unlockAccount(ctx *cli.Context, ks *keystore.KeyStore, address string, i int, passwords []string) (accounts.Account, string) {
   209  	account, err := utils.MakeAddress(ks, address)
   210  	if err != nil {
   211  		utils.Fatalf("Could not list accounts: %v", err)
   212  	}
   213  	for trials := 0; trials < 3; trials++ {
   214  		prompt := fmt.Sprintf("Unlocking account %s | Attempt %d/%d", address, trials+1, 3)
   215  		password := getPassPhrase(prompt, false, i, passwords)
   216  		err = ks.Unlock(account, password)
   217  		if err == nil {
   218  			log.Info("Unlocked account", "address", account.Address.Hex())
   219  			return account, password
   220  		}
   221  		if err, ok := err.(*keystore.AmbiguousAddrError); ok {
   222  			log.Info("Unlocked account", "address", account.Address.Hex())
   223  			return ambiguousAddrRecovery(ks, err, password), password
   224  		}
   225  		if err != keystore.ErrDecrypt {
   226  			// No need to prompt again if the error is not decryption-related.
   227  			break
   228  		}
   229  	}
   230  	// All trials expended to unlock account, bail out
   231  	utils.Fatalf("Failed to unlock account %s (%v)", address, err)
   232  
   233  	return accounts.Account{}, ""
   234  }
   235  
   236  // getPassPhrase retrieves the password associated with an account, either fetched
   237  // from a list of preloaded passphrases, or requested interactively from the user.
   238  func getPassPhrase(prompt string, confirmation bool, i int, passwords []string) string {
   239  	// If a list of passwords was supplied, retrieve from them
   240  	if len(passwords) > 0 {
   241  		if i < len(passwords) {
   242  			return passwords[i]
   243  		}
   244  		return passwords[len(passwords)-1]
   245  	}
   246  	// Otherwise prompt the user for the password
   247  	if prompt != "" {
   248  		fmt.Println(prompt)
   249  	}
   250  	password, err := console.Stdin.PromptPassword("Passphrase: ")
   251  	if err != nil {
   252  		utils.Fatalf("Failed to read passphrase: %v", err)
   253  	}
   254  	if confirmation {
   255  		confirm, err := console.Stdin.PromptPassword("Repeat passphrase: ")
   256  		if err != nil {
   257  			utils.Fatalf("Failed to read passphrase confirmation: %v", err)
   258  		}
   259  		if password != confirm {
   260  			utils.Fatalf("Passphrases do not match")
   261  		}
   262  	}
   263  	return password
   264  }
   265  
   266  func ambiguousAddrRecovery(ks *keystore.KeyStore, err *keystore.AmbiguousAddrError, auth string) accounts.Account {
   267  	fmt.Printf("Multiple key files exist for address %x:\n", err.Addr)
   268  	for _, a := range err.Matches {
   269  		fmt.Println("  ", a.URL)
   270  	}
   271  	fmt.Println("Testing your passphrase against all of them...")
   272  	var match *accounts.Account
   273  	for _, a := range err.Matches {
   274  		if err := ks.Unlock(a, auth); err == nil {
   275  			match = &a
   276  			break
   277  		}
   278  	}
   279  	if match == nil {
   280  		utils.Fatalf("None of the listed files could be unlocked.")
   281  	}
   282  	fmt.Printf("Your passphrase unlocked %s\n", match.URL)
   283  	fmt.Println("In order to avoid this warning, you need to remove the following duplicate key files:")
   284  	for _, a := range err.Matches {
   285  		if a != *match {
   286  			fmt.Println("  ", a.URL)
   287  		}
   288  	}
   289  	return *match
   290  }
   291  
   292  // accountCreate creates a new account into the keystore defined by the CLI flags.
   293  func accountCreate(ctx *cli.Context) error {
   294  	cfg := gethConfig{Node: defaultNodeConfig()}
   295  	// Load config file.
   296  	if file := ctx.GlobalString(configFileFlag.Name); file != "" {
   297  		if err := loadConfig(file, &cfg); err != nil {
   298  			utils.Fatalf("%v", err)
   299  		}
   300  	}
   301  	utils.SetNodeConfig(ctx, &cfg.Node)
   302  	scryptN, scryptP, keydir, err := cfg.Node.AccountConfig()
   303  
   304  	if err != nil {
   305  		utils.Fatalf("Failed to read configuration: %v", err)
   306  	}
   307  
   308  	password := getPassPhrase("Your new account is locked with a password. Please give a password. Do not forget this password.", true, 0, utils.MakePasswordList(ctx))
   309  
   310  	address, err := keystore.StoreKey(keydir, password, scryptN, scryptP)
   311  
   312  	if err != nil {
   313  		utils.Fatalf("Failed to create account: %v", err)
   314  	}
   315  	fmt.Printf("Address: {%x}\n", address)
   316  	return nil
   317  }
   318  
   319  // accountUpdate transitions an account from a previous format to the current
   320  // one, also providing the possibility to change the pass-phrase.
   321  func accountUpdate(ctx *cli.Context) error {
   322  	if len(ctx.Args()) == 0 {
   323  		utils.Fatalf("No accounts specified to update")
   324  	}
   325  	stack, _ := makeConfigNode(ctx)
   326  	ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
   327  
   328  	for _, addr := range ctx.Args() {
   329  		account, oldPassword := unlockAccount(ctx, ks, addr, 0, nil)
   330  		newPassword := getPassPhrase("Please give a new password. Do not forget this password.", true, 0, nil)
   331  		if err := ks.Update(account, oldPassword, newPassword); err != nil {
   332  			utils.Fatalf("Could not update the account: %v", err)
   333  		}
   334  	}
   335  	return nil
   336  }
   337  
   338  func importWallet(ctx *cli.Context) error {
   339  	keyfile := ctx.Args().First()
   340  	if len(keyfile) == 0 {
   341  		utils.Fatalf("keyfile must be given as argument")
   342  	}
   343  	keyJson, err := ioutil.ReadFile(keyfile)
   344  	if err != nil {
   345  		utils.Fatalf("Could not read wallet file: %v", err)
   346  	}
   347  
   348  	stack, _ := makeConfigNode(ctx)
   349  	passphrase := getPassPhrase("", false, 0, utils.MakePasswordList(ctx))
   350  
   351  	ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
   352  	acct, err := ks.ImportPreSaleKey(keyJson, passphrase)
   353  	if err != nil {
   354  		utils.Fatalf("%v", err)
   355  	}
   356  	fmt.Printf("Address: {%x}\n", acct.Address)
   357  	return nil
   358  }
   359  
   360  func accountImport(ctx *cli.Context) error {
   361  	keyfile := ctx.Args().First()
   362  	if len(keyfile) == 0 {
   363  		utils.Fatalf("keyfile must be given as argument")
   364  	}
   365  	key, err := crypto.LoadECDSA(keyfile)
   366  	if err != nil {
   367  		utils.Fatalf("Failed to load the private key: %v", err)
   368  	}
   369  	stack, _ := makeConfigNode(ctx)
   370  	passphrase := getPassPhrase("Your new account is locked with a password. Please give a password. Do not forget this password.", true, 0, utils.MakePasswordList(ctx))
   371  
   372  	ks := stack.AccountManager().Backends(keystore.KeyStoreType)[0].(*keystore.KeyStore)
   373  	acct, err := ks.ImportECDSA(key, passphrase)
   374  	if err != nil {
   375  		utils.Fatalf("Could not create the account: %v", err)
   376  	}
   377  	fmt.Printf("Address: {%x}\n", acct.Address)
   378  	return nil
   379  }