good morning!!!!

Skip to content
Snippets Groups Projects
main.go 39.4 KiB
Newer Older
  • Learn to ignore specific revisions
  • // Copyright 2018 The go-ethereum Authors
    // This file is part of go-ethereum.
    //
    // go-ethereum is free software: you can redistribute it and/or modify
    // it under the terms of the GNU General Public License as published by
    // the Free Software Foundation, either version 3 of the License, or
    // (at your option) any later version.
    //
    // go-ethereum 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 General Public License for more details.
    //
    // You should have received a copy of the GNU General Public License
    // along with go-ethereum. If not, see <http://www.gnu.org/licenses/>.
    
    package main
    
    import (
    	"bufio"
    	"context"
    	"crypto/rand"
    	"crypto/sha256"
    
    	"encoding/hex"
    
    	"os/signal"
    
    	"github.com/ethereum/go-ethereum/accounts"
    
    	"github.com/ethereum/go-ethereum/accounts/keystore"
    
    	"github.com/ethereum/go-ethereum/cmd/utils"
    	"github.com/ethereum/go-ethereum/common"
    
    	"github.com/ethereum/go-ethereum/common/hexutil"
    
    	"github.com/ethereum/go-ethereum/core/types"
    
    	"github.com/ethereum/go-ethereum/crypto"
    
    	"github.com/ethereum/go-ethereum/internal/ethapi"
    
    	"github.com/ethereum/go-ethereum/internal/flags"
    
    	"github.com/ethereum/go-ethereum/log"
    	"github.com/ethereum/go-ethereum/node"
    
    	"github.com/ethereum/go-ethereum/params"
    
    	"github.com/ethereum/go-ethereum/rlp"
    
    	"github.com/ethereum/go-ethereum/rpc"
    	"github.com/ethereum/go-ethereum/signer/core"
    
    	"github.com/ethereum/go-ethereum/signer/fourbyte"
    
    	"github.com/ethereum/go-ethereum/signer/rules"
    	"github.com/ethereum/go-ethereum/signer/storage"
    
    	"github.com/mattn/go-colorable"
    
    	"github.com/mattn/go-isatty"
    
    	"gopkg.in/urfave/cli.v1"
    )
    
    const legalWarning = `
    
    Clef is an account management tool. It may, like any software, contain bugs.
    
    Please take care to
    
    - backup your keystore files,
    
    - verify that the keystore(s) can be opened with your password.
    
    Clef 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 General Public License for more details.
    
    `
    
    var (
    	logLevelFlag = cli.IntFlag{
    		Name:  "loglevel",
    		Value: 4,
    		Usage: "log level to emit to the screen",
    	}
    
    	advancedMode = cli.BoolFlag{
    		Name:  "advanced",
    		Usage: "If enabled, issues warnings instead of rejections for suspicious requests. Default off",
    	}
    
    	acceptFlag = cli.BoolFlag{
    		Name:  "suppress-bootwarn",
    		Usage: "If set, does not show the warning during boot",
    	}
    
    	keystoreFlag = cli.StringFlag{
    		Name:  "keystore",
    		Value: filepath.Join(node.DefaultDataDir(), "keystore"),
    		Usage: "Directory for the keystore",
    	}
    	configdirFlag = cli.StringFlag{
    		Name:  "configdir",
    		Value: DefaultConfigDir(),
    		Usage: "Directory for Clef configuration",
    	}
    
    	chainIdFlag = cli.Int64Flag{
    		Name:  "chainid",
    		Value: params.MainnetChainConfig.ChainID.Int64(),
    
    		Usage: "Chain id to use for signing (1=mainnet, 3=Ropsten, 4=Rinkeby, 5=Goerli)",
    
    		Usage: "HTTP-RPC server listening port",
    		Value: node.DefaultHTTPPort + 5,
    	}
    
    	legacyRPCPortFlag = cli.IntFlag{
    		Name:  "rpcport",
    		Usage: "HTTP-RPC server listening port (Deprecated, please use --http.port).",
    		Value: node.DefaultHTTPPort + 5,
    	}
    
    	signerSecretFlag = cli.StringFlag{
    		Name:  "signersecret",
    
    		Usage: "A file containing the (encrypted) master seed to encrypt Clef data, e.g. keystore credentials and ruleset hash",
    
    	}
    	customDBFlag = cli.StringFlag{
    		Name:  "4bytedb-custom",
    		Usage: "File used for writing new 4byte-identifiers submitted via API",
    		Value: "./4byte-custom.json",
    	}
    	auditLogFlag = cli.StringFlag{
    		Name:  "auditlog",
    		Usage: "File used to emit audit logs. Set to \"\" to disable",
    		Value: "audit.log",
    	}
    	ruleFlag = cli.StringFlag{
    		Name:  "rules",
    
    		Usage: "Path to the rule file to auto-authorize requests with",
    
    	}
    	stdiouiFlag = cli.BoolFlag{
    		Name: "stdio-ui",
    		Usage: "Use STDIN/STDOUT as a channel for an external UI. " +
    			"This means that an STDIN/STDOUT is used for RPC-communication with a e.g. a graphical user " +
    			"interface, and can be used when Clef is started by an external process.",
    	}
    	testFlag = cli.BoolFlag{
    		Name:  "stdio-ui-test",
    		Usage: "Mechanism to test interface between Clef and UI. Requires 'stdio-ui'.",
    	}
    	app         = cli.NewApp()
    	initCommand = cli.Command{
    		Action:    utils.MigrateFlags(initializeSecrets),
    		Name:      "init",
    		Usage:     "Initialize the signer, generate secret storage",
    		ArgsUsage: "",
    		Flags: []cli.Flag{
    			logLevelFlag,
    			configdirFlag,
    		},
    		Description: `
    
    The init command generates a master seed which Clef can use to store credentials and data needed for
    
    the rule-engine to work.`,
    	}
    	attestCommand = cli.Command{
    		Action:    utils.MigrateFlags(attestFile),
    		Name:      "attest",
    		Usage:     "Attest that a js-file is to be used",
    		ArgsUsage: "<sha256sum>",
    		Flags: []cli.Flag{
    			logLevelFlag,
    			configdirFlag,
    			signerSecretFlag,
    		},
    		Description: `
    
    The attest command stores the sha256 of the rule.js-file that you want to use for automatic processing of
    incoming requests.
    
    Whenever you make an edit to the rule file, you need to use attestation to tell
    
    Clef that the file is 'safe' to execute.`,
    	}
    
    	setCredentialCommand = cli.Command{
    		Action:    utils.MigrateFlags(setCredential),
    		Name:      "setpw",
    
    		Usage:     "Store a credential for a keystore file",
    
    		ArgsUsage: "<address>",
    
    		Flags: []cli.Flag{
    			logLevelFlag,
    			configdirFlag,
    			signerSecretFlag,
    		},
    		Description: `
    
    The setpw command stores a password for a given address (keyfile).
    `}
    	delCredentialCommand = cli.Command{
    		Action:    utils.MigrateFlags(removeCredential),
    		Name:      "delpw",
    		Usage:     "Remove a credential for a keystore file",
    		ArgsUsage: "<address>",
    		Flags: []cli.Flag{
    			logLevelFlag,
    			configdirFlag,
    			signerSecretFlag,
    		},
    		Description: `
    The delpw command removes a password for a given address (keyfile).
    
    	newAccountCommand = cli.Command{
    		Action:    utils.MigrateFlags(newAccount),
    		Name:      "newaccount",
    		Usage:     "Create a new account",
    		ArgsUsage: "",
    		Flags: []cli.Flag{
    			logLevelFlag,
    			keystoreFlag,
    			utils.LightKDFFlag,
    
    		},
    		Description: `
    The newaccount command creates a new keystore-backed account. It is a convenience-method
    which can be used in lieu of an external UI.`,
    	}
    
    
    	gendocCommand = cli.Command{
    		Action: GenDoc,
    		Name:   "gendoc",
    		Usage:  "Generate documentation about json-rpc format",
    		Description: `
    The gendoc generates example structures of the json-rpc communication types.
    `}
    
    // AppHelpFlagGroups is the application flags, grouped by functionality.
    var AppHelpFlagGroups = []flags.FlagGroup{
    	{
    		Name: "FLAGS",
    		Flags: []cli.Flag{
    			logLevelFlag,
    			keystoreFlag,
    			configdirFlag,
    			chainIdFlag,
    			utils.LightKDFFlag,
    			utils.NoUSBFlag,
    			utils.SmartCardDaemonPathFlag,
    			utils.HTTPListenAddrFlag,
    			utils.HTTPVirtualHostsFlag,
    			utils.IPCDisabledFlag,
    			utils.IPCPathFlag,
    			utils.HTTPEnabledFlag,
    			rpcPortFlag,
    			signerSecretFlag,
    			customDBFlag,
    			auditLogFlag,
    			ruleFlag,
    			stdiouiFlag,
    			testFlag,
    			advancedMode,
    			acceptFlag,
    		},
    	},
    	{
    		Name: "ALIASED (deprecated)",
    		Flags: []cli.Flag{
    			legacyRPCPortFlag,
    		},
    	},
    }
    
    
    func init() {
    	app.Name = "Clef"
    	app.Usage = "Manage Ethereum account operations"
    	app.Flags = []cli.Flag{
    		logLevelFlag,
    		keystoreFlag,
    		configdirFlag,
    
    		utils.SmartCardDaemonPathFlag,
    
    		utils.HTTPListenAddrFlag,
    		utils.HTTPVirtualHostsFlag,
    
    		utils.IPCDisabledFlag,
    		utils.IPCPathFlag,
    
    		utils.HTTPEnabledFlag,
    
    		rpcPortFlag,
    		signerSecretFlag,
    		customDBFlag,
    		auditLogFlag,
    		ruleFlag,
    		stdiouiFlag,
    		testFlag,
    
    	app.Commands = []cli.Command{initCommand,
    		attestCommand,
    		setCredentialCommand,
    		delCredentialCommand,
    		newAccountCommand,
    		gendocCommand}
    
    	cli.CommandHelpTemplate = flags.CommandHelpTemplate
    	// Override the default app help template
    	cli.AppHelpTemplate = flags.ClefAppHelpTemplate
    
    	// Override the default app help printer, but only for the global app help
    	originalHelpPrinter := cli.HelpPrinter
    	cli.HelpPrinter = func(w io.Writer, tmpl string, data interface{}) {
    		if tmpl == flags.ClefAppHelpTemplate {
    			// Render out custom usage screen
    			originalHelpPrinter(w, tmpl, flags.HelpData{App: data, FlagGroups: AppHelpFlagGroups})
    		} else if tmpl == flags.CommandHelpTemplate {
    			// Iterate over all command specific flags and categorize them
    			categorized := make(map[string][]cli.Flag)
    			for _, flag := range data.(cli.Command).Flags {
    				if _, ok := categorized[flag.String()]; !ok {
    					categorized[flags.FlagCategory(flag, AppHelpFlagGroups)] = append(categorized[flags.FlagCategory(flag, AppHelpFlagGroups)], flag)
    				}
    			}
    
    			// sort to get a stable ordering
    			sorted := make([]flags.FlagGroup, 0, len(categorized))
    			for cat, flgs := range categorized {
    				sorted = append(sorted, flags.FlagGroup{Name: cat, Flags: flgs})
    			}
    			sort.Sort(flags.ByCategory(sorted))
    
    			// add sorted array to data and render with default printer
    			originalHelpPrinter(w, tmpl, map[string]interface{}{
    				"cmd":              data,
    				"categorizedFlags": sorted,
    			})
    		} else {
    			originalHelpPrinter(w, tmpl, data)
    		}
    	}
    
    func main() {
    	if err := app.Run(os.Args); err != nil {
    		fmt.Fprintln(os.Stderr, err)
    		os.Exit(1)
    	}
    }
    
    func initializeSecrets(c *cli.Context) error {
    
    	if err := initialize(c); err != nil {
    		return err
    	}
    
    	// Ensure the master key does not yet exist, we're not willing to overwrite
    
    	configDir := c.GlobalString(configdirFlag.Name)
    
    	if err := os.Mkdir(configDir, 0700); err != nil && !os.IsExist(err) {
    		return err
    	}
    	location := filepath.Join(configDir, "masterseed.json")
    	if _, err := os.Stat(location); err == nil {
    		return fmt.Errorf("master key %v already exists, will not overwrite", location)
    	}
    	// Key file does not exist yet, generate a new one and encrypt it
    
    	num, err := io.ReadFull(rand.Reader, masterSeed)
    
    	if num != len(masterSeed) {
    
    		return fmt.Errorf("failed to read enough random")
    	}
    
    	n, p := keystore.StandardScryptN, keystore.StandardScryptP
    	if c.GlobalBool(utils.LightKDFFlag.Name) {
    		n, p = keystore.LightScryptN, keystore.LightScryptP
    	}
    
    	text := "The master seed of clef will be locked with a password.\nPlease specify a password. Do not forget this password!"
    
    		password = utils.GetPassPhrase(text, true)
    
    		if err := core.ValidatePasswordFormat(password); err != nil {
    			fmt.Printf("invalid password: %v\n", err)
    		} else {
    
    			break
    		}
    	}
    	cipherSeed, err := encryptSeed(masterSeed, []byte(password), n, p)
    	if err != nil {
    		return fmt.Errorf("failed to encrypt master seed: %v", err)
    	}
    
    	// Double check the master key path to ensure nothing wrote there in between
    	if err = os.Mkdir(configDir, 0700); err != nil && !os.IsExist(err) {
    
    		return err
    	}
    	if _, err := os.Stat(location); err == nil {
    
    		return fmt.Errorf("master key %v already exists, will not overwrite", location)
    
    	// Write the file and print the usual warning message
    	if err = ioutil.WriteFile(location, cipherSeed, 0400); err != nil {
    
    		return err
    	}
    	fmt.Printf("A master seed has been generated into %s\n", location)
    	fmt.Printf(`
    
    This is required to be able to store credentials, such as:
    
    * Passwords for keystores (used by rule engine)
    
    * Storage for JavaScript auto-signing rules
    * Hash of JavaScript rule-file
    
    You should treat 'masterseed.json' with utmost secrecy and make a backup of it!
    * The password is necessary but not enough, you need to back up the master seed too!
    * The master seed does not contain your accounts, those need to be backed up separately!
    
    
    `)
    	return nil
    }
    func attestFile(ctx *cli.Context) error {
    	if len(ctx.Args()) < 1 {
    		utils.Fatalf("This command requires an argument.")
    	}
    	if err := initialize(ctx); err != nil {
    		return err
    	}
    
    
    	stretchedKey, err := readMasterKey(ctx, nil)
    
    	if err != nil {
    		utils.Fatalf(err.Error())
    	}
    
    	configDir := ctx.GlobalString(configdirFlag.Name)
    
    	vaultLocation := filepath.Join(configDir, common.Bytes2Hex(crypto.Keccak256([]byte("vault"), stretchedKey)[:10]))
    	confKey := crypto.Keccak256([]byte("config"), stretchedKey)
    
    	// Initialize the encrypted storages
    	configStorage := storage.NewAESEncryptedStorage(filepath.Join(vaultLocation, "config.json"), confKey)
    	val := ctx.Args().First()
    	configStorage.Put("ruleset_sha256", val)
    	log.Info("Ruleset attestation updated", "sha256", val)
    	return nil
    }
    
    
    func setCredential(ctx *cli.Context) error {
    
    		utils.Fatalf("This command requires an address to be passed as an argument")
    
    	}
    	if err := initialize(ctx); err != nil {
    		return err
    	}
    
    	addr := ctx.Args().First()
    	if !common.IsHexAddress(addr) {
    		utils.Fatalf("Invalid address specified: %s", addr)
    	}
    	address := common.HexToAddress(addr)
    
    	password := utils.GetPassPhrase("Please enter a password to store for this address:", true)
    
    	fmt.Println()
    
    	stretchedKey, err := readMasterKey(ctx, nil)
    	if err != nil {
    		utils.Fatalf(err.Error())
    	}
    	configDir := ctx.GlobalString(configdirFlag.Name)
    	vaultLocation := filepath.Join(configDir, common.Bytes2Hex(crypto.Keccak256([]byte("vault"), stretchedKey)[:10]))
    	pwkey := crypto.Keccak256([]byte("credentials"), stretchedKey)
    
    	pwStorage := storage.NewAESEncryptedStorage(filepath.Join(vaultLocation, "credentials.json"), pwkey)
    	pwStorage.Put(address.Hex(), password)
    
    	log.Info("Credential store updated", "set", address)
    	return nil
    }
    
    func removeCredential(ctx *cli.Context) error {
    	if len(ctx.Args()) < 1 {
    		utils.Fatalf("This command requires an address to be passed as an argument")
    	}
    	if err := initialize(ctx); err != nil {
    		return err
    	}
    	addr := ctx.Args().First()
    	if !common.IsHexAddress(addr) {
    		utils.Fatalf("Invalid address specified: %s", addr)
    	}
    	address := common.HexToAddress(addr)
    
    	stretchedKey, err := readMasterKey(ctx, nil)
    
    	if err != nil {
    		utils.Fatalf(err.Error())
    	}
    
    	configDir := ctx.GlobalString(configdirFlag.Name)
    
    	vaultLocation := filepath.Join(configDir, common.Bytes2Hex(crypto.Keccak256([]byte("vault"), stretchedKey)[:10]))
    	pwkey := crypto.Keccak256([]byte("credentials"), stretchedKey)
    
    	pwStorage := storage.NewAESEncryptedStorage(filepath.Join(vaultLocation, "credentials.json"), pwkey)
    
    	pwStorage.Del(address.Hex())
    
    	log.Info("Credential store updated", "unset", address)
    
    func newAccount(c *cli.Context) error {
    	if err := initialize(c); err != nil {
    		return err
    	}
    	// The newaccount is meant for users using the CLI, since 'real' external
    	// UIs can use the UI-api instead. So we'll just use the native CLI UI here.
    	var (
    		ui                        = core.NewCommandlineUI()
    		pwStorage storage.Storage = &storage.NoStorage{}
    		ksLoc                     = c.GlobalString(keystoreFlag.Name)
    		lightKdf                  = c.GlobalBool(utils.LightKDFFlag.Name)
    	)
    	log.Info("Starting clef", "keystore", ksLoc, "light-kdf", lightKdf)
    	am := core.StartClefAccountManager(ksLoc, true, lightKdf, "")
    	// This gives is us access to the external API
    	apiImpl := core.NewSignerAPI(am, 0, true, ui, nil, false, pwStorage)
    	// This gives us access to the internal API
    	internalApi := core.NewUIServerAPI(apiImpl)
    	addr, err := internalApi.New(context.Background())
    	if err == nil {
    		fmt.Printf("Generated account %v\n", addr.String())
    	}
    	return err
    }
    
    
    func initialize(c *cli.Context) error {
    	// Set up the logger to print everything
    	logOutput := os.Stdout
    
    	if c.GlobalBool(stdiouiFlag.Name) {
    
    		logOutput = os.Stderr
    		// If using the stdioui, we can't do the 'confirm'-flow
    
    		if !c.GlobalBool(acceptFlag.Name) {
    			fmt.Fprint(logOutput, legalWarning)
    		}
    	} else if !c.GlobalBool(acceptFlag.Name) {
    
    		if !confirm(legalWarning) {
    			return fmt.Errorf("aborted by user")
    		}
    
    	usecolor := (isatty.IsTerminal(os.Stderr.Fd()) || isatty.IsCygwinTerminal(os.Stderr.Fd())) && os.Getenv("TERM") != "dumb"
    	output := io.Writer(logOutput)
    	if usecolor {
    		output = colorable.NewColorable(logOutput)
    	}
    	log.Root().SetHandler(log.LvlFilterHandler(log.Lvl(c.Int(logLevelFlag.Name)), log.StreamHandler(output, log.TerminalFormat(usecolor))))
    
    
    // ipcEndpoint resolves an IPC endpoint based on a configured value, taking into
    // account the set data folders as well as the designated platform we're currently
    // running on.
    func ipcEndpoint(ipcPath, datadir string) string {
    	// On windows we can only use plain top-level pipes
    	if runtime.GOOS == "windows" {
    		if strings.HasPrefix(ipcPath, `\\.\pipe\`) {
    			return ipcPath
    		}
    		return `\\.\pipe\` + ipcPath
    	}
    	// Resolve names into the data directory full paths otherwise
    	if filepath.Base(ipcPath) == ipcPath {
    		if datadir == "" {
    			return filepath.Join(os.TempDir(), ipcPath)
    		}
    		return filepath.Join(datadir, ipcPath)
    	}
    	return ipcPath
    }
    
    
    func signer(c *cli.Context) error {
    
    	// If we have some unrecognized command, bail out
    	if args := c.Args(); len(args) > 0 {
    		return fmt.Errorf("invalid command: %q", args[0])
    	}
    
    	if err := initialize(c); err != nil {
    		return err
    	}
    	var (
    
    	if c.GlobalBool(stdiouiFlag.Name) {
    
    		log.Info("Using stdin/stdout as UI-channel")
    		ui = core.NewStdIOUI()
    	} else {
    		log.Info("Using CLI as UI-channel")
    		ui = core.NewCommandlineUI()
    	}
    
    	fourByteLocal := c.GlobalString(customDBFlag.Name)
    
    	db, err := fourbyte.NewWithFile(fourByteLocal)
    
    	if err != nil {
    		utils.Fatalf(err.Error())
    	}
    
    	embeds, locals := db.Size()
    	log.Info("Loaded 4byte database", "embeds", embeds, "locals", locals, "local", fourByteLocal)
    
    		api       core.ExternalAPI
    		pwStorage storage.Storage = &storage.NoStorage{}
    
    	configDir := c.GlobalString(configdirFlag.Name)
    	if stretchedKey, err := readMasterKey(c, ui); err != nil {
    
    		log.Warn("Failed to open master, rules disabled", "err", err)
    
    	} else {
    		vaultLocation := filepath.Join(configDir, common.Bytes2Hex(crypto.Keccak256([]byte("vault"), stretchedKey)[:10]))
    
    		// Generate domain specific keys
    		pwkey := crypto.Keccak256([]byte("credentials"), stretchedKey)
    		jskey := crypto.Keccak256([]byte("jsstorage"), stretchedKey)
    		confkey := crypto.Keccak256([]byte("config"), stretchedKey)
    
    		// Initialize the encrypted storages
    
    		pwStorage = storage.NewAESEncryptedStorage(filepath.Join(vaultLocation, "credentials.json"), pwkey)
    
    		jsStorage := storage.NewAESEncryptedStorage(filepath.Join(vaultLocation, "jsstorage.json"), jskey)
    		configStorage := storage.NewAESEncryptedStorage(filepath.Join(vaultLocation, "config.json"), confkey)
    
    
    		if ruleFile := c.GlobalString(ruleFlag.Name); ruleFile != "" {
    
    			ruleJS, err := ioutil.ReadFile(ruleFile)
    
    				log.Warn("Could not load rules, disabling", "file", ruleFile, "err", err)
    
    				shasum := sha256.Sum256(ruleJS)
    				foundShaSum := hex.EncodeToString(shasum[:])
    
    				storedShasum, _ := configStorage.Get("ruleset_sha256")
    
    					log.Warn("Rule hash not attested, disabling", "hash", foundShaSum, "attested", storedShasum)
    
    				} else {
    					// Initialize rules
    					ruleEngine, err := rules.NewRuleEvaluator(ui, jsStorage)
    					if err != nil {
    						utils.Fatalf(err.Error())
    					}
    					ruleEngine.Init(string(ruleJS))
    					ui = ruleEngine
    					log.Info("Rule engine configured", "file", c.String(ruleFlag.Name))
    
    	var (
    		chainId  = c.GlobalInt64(chainIdFlag.Name)
    		ksLoc    = c.GlobalString(keystoreFlag.Name)
    		lightKdf = c.GlobalBool(utils.LightKDFFlag.Name)
    		advanced = c.GlobalBool(advancedMode.Name)
    		nousb    = c.GlobalBool(utils.NoUSBFlag.Name)
    
    		scpath   = c.GlobalString(utils.SmartCardDaemonPathFlag.Name)
    
    	)
    	log.Info("Starting signer", "chainid", chainId, "keystore", ksLoc,
    		"light-kdf", lightKdf, "advanced", advanced)
    
    	am := core.StartClefAccountManager(ksLoc, nousb, lightKdf, scpath)
    
    	apiImpl := core.NewSignerAPI(am, chainId, nousb, ui, db, advanced, pwStorage)
    
    
    	// Establish the bidirectional communication, by creating a new UI backend and registering
    	// it with the UI.
    	ui.RegisterUIServer(core.NewUIServerAPI(apiImpl))
    
    	if logfile := c.GlobalString(auditLogFlag.Name); logfile != "" {
    
    		api, err = core.NewAuditLogger(logfile, api)
    		if err != nil {
    			utils.Fatalf(err.Error())
    		}
    		log.Info("Audit logs configured", "file", logfile)
    	}
    	// register signer API with server
    	var (
    
    		extapiURL = "n/a"
    		ipcapiURL = "n/a"
    
    	rpcAPI := []rpc.API{
    
    		{
    			Namespace: "account",
    			Public:    true,
    			Service:   api,
    			Version:   "1.0"},
    	}
    
    	if c.GlobalBool(utils.HTTPEnabledFlag.Name) {
    
    		vhosts := utils.SplitAndTrim(c.GlobalString(utils.HTTPVirtualHostsFlag.Name))
    		cors := utils.SplitAndTrim(c.GlobalString(utils.HTTPCORSDomainFlag.Name))
    
    		srv := rpc.NewServer()
    		err := node.RegisterApisFromWhitelist(rpcAPI, []string{"account"}, srv, false)
    		if err != nil {
    			utils.Fatalf("Could not register API: %w", err)
    		}
    		handler := node.NewHTTPHandlerStack(srv, cors, vhosts)
    
    
    		// set port
    		port := c.Int(rpcPortFlag.Name)
    		if c.GlobalIsSet(legacyRPCPortFlag.Name) {
    			if !c.GlobalIsSet(rpcPortFlag.Name) {
    				port = c.Int(legacyRPCPortFlag.Name)
    			}
    			log.Warn("The flag --rpcport is deprecated and will be removed in the future, please use --http.port")
    		}
    
    
    		httpEndpoint := fmt.Sprintf("%s:%d", c.GlobalString(utils.HTTPListenAddrFlag.Name), port)
    
    		httpServer, addr, err := node.StartHTTPEndpoint(httpEndpoint, rpc.DefaultHTTPTimeouts, handler)
    
    		if err != nil {
    			utils.Fatalf("Could not start RPC api: %v", err)
    		}
    
    		extapiURL = fmt.Sprintf("http://%v/", addr)
    
    		log.Info("HTTP endpoint opened", "url", extapiURL)
    
    			// Don't bother imposing a timeout here.
    			httpServer.Shutdown(context.Background())
    
    			log.Info("HTTP endpoint closed", "url", extapiURL)
    
    	if !c.GlobalBool(utils.IPCDisabledFlag.Name) {
    
    		givenPath := c.GlobalString(utils.IPCPathFlag.Name)
    		ipcapiURL = ipcEndpoint(filepath.Join(givenPath, "clef.ipc"), configDir)
    
    		listener, _, err := rpc.StartIPCEndpoint(ipcapiURL, rpcAPI)
    
    		if err != nil {
    			utils.Fatalf("Could not start IPC api: %v", err)
    		}
    
    		log.Info("IPC endpoint opened", "url", ipcapiURL)
    
    			log.Info("IPC endpoint closed", "url", ipcapiURL)
    
    	if c.GlobalBool(testFlag.Name) {
    
    		log.Info("Performing UI test")
    		go testExternalUI(apiImpl)
    	}
    	ui.OnSignerStartup(core.StartupInfo{
    		Info: map[string]interface{}{
    
    			"intapi_version": core.InternalAPIVersion,
    
    			"extapi_version": core.ExternalAPIVersion,
    
    			"extapi_http":    extapiURL,
    			"extapi_ipc":     ipcapiURL,
    
    	abortChan := make(chan os.Signal, 1)
    
    	signal.Notify(abortChan, os.Interrupt)
    
    	sig := <-abortChan
    	log.Info("Exiting...", "signal", sig)
    
    	return nil
    }
    
    // DefaultConfigDir is the default config directory to use for the vaults and other
    // persistence requirements.
    func DefaultConfigDir() string {
    	// Try to place the data folder in the user's home dir
    
    	home := utils.HomeDir()
    
    	if home != "" {
    		if runtime.GOOS == "darwin" {
    			return filepath.Join(home, "Library", "Signer")
    		} else if runtime.GOOS == "windows" {
    
    			appdata := os.Getenv("APPDATA")
    			if appdata != "" {
    				return filepath.Join(appdata, "Signer")
    			}
    
    			return filepath.Join(home, "AppData", "Roaming", "Signer")
    
    	}
    	// As we cannot guess a stable location, return empty and handle later
    	return ""
    }
    
    
    func readMasterKey(ctx *cli.Context, ui core.UIClientAPI) ([]byte, error) {
    
    		configDir = ctx.GlobalString(configdirFlag.Name)
    
    	if ctx.GlobalIsSet(signerSecretFlag.Name) {
    		file = ctx.GlobalString(signerSecretFlag.Name)
    
    		file = filepath.Join(configDir, "masterseed.json")
    
    	}
    	if err := checkFile(file); err != nil {
    		return nil, err
    	}
    
    	cipherKey, err := ioutil.ReadFile(file)
    
    	var password string
    	// If ui is not nil, get the password from ui.
    	if ui != nil {
    		resp, err := ui.OnInputRequired(core.UserInputRequest{
    			Title:      "Master Password",
    			Prompt:     "Please enter the password to decrypt the master seed",
    			IsPassword: true})
    		if err != nil {
    			return nil, err
    		}
    		password = resp.Text
    	} else {
    
    		password = utils.GetPassPhrase("Decrypt master seed of clef", false)
    
    	}
    	masterSeed, err := decryptSeed(cipherKey, password)
    	if err != nil {
    		return nil, fmt.Errorf("failed to decrypt the master seed of clef")
    	}
    	if len(masterSeed) < 256 {
    		return nil, fmt.Errorf("master seed of insufficient length, expected >255 bytes, got %d", len(masterSeed))
    
    	vaultLocation := filepath.Join(configDir, common.Bytes2Hex(crypto.Keccak256([]byte("vault"), masterSeed)[:10]))
    
    	err = os.Mkdir(vaultLocation, 0700)
    	if err != nil && !os.IsExist(err) {
    		return nil, err
    	}
    
    }
    
    // checkFile is a convenience function to check if a file
    // * exists
    
    // * is mode 0400 (unix only)
    
    func checkFile(filename string) error {
    	info, err := os.Stat(filename)
    	if err != nil {
    		return fmt.Errorf("failed stat on %s: %v", filename, err)
    	}
    	// Check the unix permission bits
    
    	// However, on windows, we cannot use the unix perm-bits, see
    	// https://github.com/ethereum/go-ethereum/issues/20123
    	if runtime.GOOS != "windows" && info.Mode().Perm()&0377 != 0 {
    
    		return fmt.Errorf("file (%v) has insecure file permissions (%v)", filename, info.Mode().String())
    	}
    	return nil
    }
    
    // confirm displays a text and asks for user confirmation
    func confirm(text string) bool {
    
    	fmt.Print(text)
    
    	fmt.Printf("\nEnter 'ok' to proceed:\n> ")
    
    
    	text, err := bufio.NewReader(os.Stdin).ReadString('\n')
    	if err != nil {
    		log.Crit("Failed to read user input", "err", err)
    	}
    	if text := strings.TrimSpace(text); text == "ok" {
    		return true
    	}
    	return false
    }
    
    func testExternalUI(api *core.SignerAPI) {
    
    	ctx := context.WithValue(context.Background(), "remote", "clef binary")
    	ctx = context.WithValue(ctx, "scheme", "in-proc")
    	ctx = context.WithValue(ctx, "local", "main")
    	errs := make([]string, 0)
    
    
    	a := common.HexToAddress("0xdeadbeef000000000000000000000000deadbeef")
    
    		log.Info("Test error", "err", errStr)
    
    	queryUser := func(q string) string {
    		resp, err := api.UI.OnInputRequired(core.UserInputRequest{
    			Title:  "Testing",
    			Prompt: q,
    		})
    		if err != nil {
    
    	expectResponse := func(testcase, question, expect string) {
    		if got := queryUser(question); got != expect {
    
    			addErr(fmt.Sprintf("%s: got %v, expected %v", testcase, got, expect))
    
    	expectApprove := func(testcase string, err error) {
    		if err == nil || err == accounts.ErrUnknownAccount {
    			return
    		}
    
    		addErr(fmt.Sprintf("%v: expected no error, got %v", testcase, err.Error()))
    
    	}
    	expectDeny := func(testcase string, err error) {
    		if err == nil || err != core.ErrRequestDenied {
    
    			addErr(fmt.Sprintf("%v: expected ErrRequestDenied, got %v", testcase, err))
    
    	// Test display of info and error
    	{
    		api.UI.ShowInfo("If you see this message, enter 'yes' to next question")
    
    		expectResponse("showinfo", "Did you see the message? [yes/no]", "yes")
    		api.UI.ShowError("If you see this message, enter 'yes' to the next question")
    
    		expectResponse("showerror", "Did you see the message? [yes/no]", "yes")
    	}
    	{ // Sign data test - clique header
    		api.UI.ShowInfo("Please approve the next request for signing a clique header")
    
    			ParentHash:  common.HexToHash("0000H45H"),
    			UncleHash:   common.HexToHash("0000H45H"),
    			Coinbase:    common.HexToAddress("0000H45H"),
    			Root:        common.HexToHash("0000H00H"),
    			TxHash:      common.HexToHash("0000H45H"),
    			ReceiptHash: common.HexToHash("0000H45H"),
    			Difficulty:  big.NewInt(1337),
    			Number:      big.NewInt(1337),
    			GasLimit:    1338,
    			GasUsed:     1338,
    			Time:        1338,
    			Extra:       []byte("Extra data Extra data Extra data  Extra data  Extra data  Extra data  Extra data Extra data"),
    			MixDigest:   common.HexToHash("0x0000H45H"),
    
    		}
    		cliqueRlp, err := rlp.EncodeToBytes(cliqueHeader)
    		if err != nil {
    			utils.Fatalf("Should not error: %v", err)
    		}
    		addr, _ := common.NewMixedcaseAddressFromString("0x0011223344556677889900112233445566778899")
    		_, err = api.SignData(ctx, accounts.MimetypeClique, *addr, hexutil.Encode(cliqueRlp))
    		expectApprove("signdata - clique header", err)
    	}
    
    	{ // Sign data test - typed data
    		api.UI.ShowInfo("Please approve the next request for signing EIP-712 typed data")
    		time.Sleep(delay)
    		addr, _ := common.NewMixedcaseAddressFromString("0x0011223344556677889900112233445566778899")
    		data := `{"types":{"EIP712Domain":[{"name":"name","type":"string"},{"name":"version","type":"string"},{"name":"chainId","type":"uint256"},{"name":"verifyingContract","type":"address"}],"Person":[{"name":"name","type":"string"},{"name":"test","type":"uint8"},{"name":"wallet","type":"address"}],"Mail":[{"name":"from","type":"Person"},{"name":"to","type":"Person"},{"name":"contents","type":"string"}]},"primaryType":"Mail","domain":{"name":"Ether Mail","version":"1","chainId":"1","verifyingContract":"0xCCCcccccCCCCcCCCCCCcCcCccCcCCCcCcccccccC"},"message":{"from":{"name":"Cow","test":"3","wallet":"0xcD2a3d9F938E13CD947Ec05AbC7FE734Df8DD826"},"to":{"name":"Bob","wallet":"0xbBbBBBBbbBBBbbbBbbBbbbbBBbBbbbbBbBbbBBbB","test":"2"},"contents":"Hello, Bob!"}}`
    		//_, err := api.SignData(ctx, accounts.MimetypeTypedData, *addr, hexutil.Encode([]byte(data)))
    		var typedData core.TypedData
    
    		json.Unmarshal([]byte(data), &typedData)
    		_, err := api.SignTypedData(ctx, *addr, typedData)
    
    	{ // Sign data test - plain text
    		api.UI.ShowInfo("Please approve the next request for signing text")
    
    		addr, _ := common.NewMixedcaseAddressFromString("0x0011223344556677889900112233445566778899")
    		_, err := api.SignData(ctx, accounts.MimetypeTextPlain, *addr, hexutil.Encode([]byte("hello world")))
    		expectApprove("signdata - text", err)
    	}
    	{ // Sign data test - plain text reject
    		api.UI.ShowInfo("Please deny the next request for signing text")
    
    		addr, _ := common.NewMixedcaseAddressFromString("0x0011223344556677889900112233445566778899")
    		_, err := api.SignData(ctx, accounts.MimetypeTextPlain, *addr, hexutil.Encode([]byte("hello world")))
    		expectDeny("signdata - text", err)
    	}
    	{ // Sign transaction
    
    		api.UI.ShowInfo("Please reject next transaction")
    
    		data := hexutil.Bytes([]byte{})
    		to := common.NewMixedcaseAddress(a)
    		tx := core.SendTxArgs{
    			Data:     &data,
    			Nonce:    0x1,
    			Value:    hexutil.Big(*big.NewInt(6)),
    			From:     common.NewMixedcaseAddress(a),
    			To:       &to,
    			GasPrice: hexutil.Big(*big.NewInt(5)),
    			Gas:      1000,
    			Input:    nil,
    		}
    		_, err := api.SignTransaction(ctx, tx, nil)
    		expectDeny("signtransaction [1]", err)
    		expectResponse("signtransaction [2]", "Did you see any warnings for the last transaction? (yes/no)", "no")
    	}
    	{ // Listing
    		api.UI.ShowInfo("Please reject listing-request")
    
    		_, err := api.List(ctx)
    		expectDeny("list", err)
    	}
    	{ // Import
    		api.UI.ShowInfo("Please reject new account-request")
    
    		_, err := api.New(ctx)
    		expectDeny("newaccount", err)
    	}
    	{ // Metadata
    		api.UI.ShowInfo("Please check if you see the Origin in next listing (approve or deny)")
    
    		api.List(context.WithValue(ctx, "Origin", "origin.com"))
    		expectResponse("metadata - origin", "Did you see origin (origin.com)? [yes/no] ", "yes")
    	}
    
    	for _, e := range errs {
    		log.Error(e)
    	}
    	result := fmt.Sprintf("Tests completed. %d errors:\n%s\n", len(errs), strings.Join(errs, "\n"))
    	api.UI.ShowInfo(result)
    
    
    type encryptedSeedStorage struct {
    	Description string              `json:"description"`
    	Version     int                 `json:"version"`
    	Params      keystore.CryptoJSON `json:"params"`
    }
    
    // encryptSeed uses a similar scheme as the keystore uses, but with a different wrapping,
    // to encrypt the master seed
    func encryptSeed(seed []byte, auth []byte, scryptN, scryptP int) ([]byte, error) {
    	cryptoStruct, err := keystore.EncryptDataV3(seed, auth, scryptN, scryptP)
    	if err != nil {
    		return nil, err
    	}
    	return json.Marshal(&encryptedSeedStorage{"Clef seed", 1, cryptoStruct})
    }