# beacon_chain # Copyright (c) 2018-2024 Status Research & Development GmbH # Licensed and distributed under either of # * MIT license (license terms in the root directory or at https://opensource.org/licenses/MIT). # * Apache v2 license (license terms in the root directory or at https://www.apache.org/licenses/LICENSE-2.0). # at your option. This file may not be copied, modified, or distributed except according to those terms. {.push raises: [].} import std/[os, unicode, sequtils], chronicles, chronos, json_serialization, bearssl/rand, serialization, blscurve, eth/common/eth_types, confutils, nimbus_security_resources, ".."/spec/[eth2_merkleization, keystore, crypto], ".."/spec/datatypes/base, stew/[io2, byteutils], libp2p/crypto/crypto as lcrypto, nimcrypto/utils as ncrutils, ".."/[conf, filepath, beacon_clock], ".."/networking/network_metadata, ./validator_pool from std/terminal import ForegroundColor, Style, readPasswordFromStdin, getch, resetAttributes, setForegroundColor, setStyle from std/wordwrap import wrapWords from zxcvbn import passwordEntropy export keystore, validator_pool, crypto, rand, Web3SignerUrl when defined(windows): import stew/[windows/acl] {.localPassC: "-fno-lto".} # no LTO for crypto const KeystoreFileName* = "keystore.json" RemoteKeystoreFileName* = "remote_keystore.json" FeeRecipientFilename = "suggested_fee_recipient.hex" GasLimitFilename = "suggested_gas_limit.json" GraffitiBytesFilename = "graffiti.hex" BuilderConfigPath = "payload_builder.json" KeyNameSize = 98 # 0x + hexadecimal key representation 96 characters. MaxKeystoreFileSize = 65536 type WalletPathPair* = object wallet*: Wallet path*: string CreatedWallet* = object walletPath*: WalletPathPair seed*: KeySeed KmResult[T] = Result[T, cstring] RemoveValidatorStatus* {.pure.} = enum deleted = "Deleted" notFound = "Not found" AddValidatorStatus* {.pure.} = enum existingArtifacts = "Keystore artifacts already exists" failed = "Validator not added" AddValidatorFailure = object status*: AddValidatorStatus message*: string ImportResult[T] = Result[T, AddValidatorFailure] ValidatorPubKeyToDataFn* = proc (pubkey: ValidatorPubKey): Opt[ValidatorAndIndex] {.raises: [], gcsafe.} GetCapellaForkVersionFn* = proc (): Opt[Version] {.raises: [], gcsafe.} GetDenebForkEpochFn* = proc (): Opt[Epoch] {.raises: [], gcsafe.} GetForkFn* = proc (epoch: Epoch): Opt[Fork] {.raises: [], gcsafe.} GetGenesisFn* = proc (): Eth2Digest {.raises: [], gcsafe.} KeymanagerHost* = object validatorPool*: ref ValidatorPool keystoreCache*: KeystoreCacheRef rng*: ref HmacDrbgContext keymanagerToken*: string validatorsDir*: string secretsDir*: string defaultFeeRecipient*: Opt[Eth1Address] defaultGasLimit*: uint64 defaultGraffiti*: GraffitiBytes defaultBuilderAddress*: Opt[string] getValidatorAndIdxFn*: ValidatorPubKeyToDataFn getBeaconTimeFn*: GetBeaconTimeFn getCapellaForkVersionFn*: GetCapellaForkVersionFn getDenebForkEpochFn*: GetDenebForkEpochFn getForkFn*: GetForkFn getGenesisFn*: GetGenesisFn MultipleKeystoresDecryptor* = object previouslyUsedPassword*: string QueryResult = Result[seq[KeystoreData], string] ConfigFileKind* {.pure.} = enum KeystoreFile, RemoteKeystoreFile, FeeRecipientFile, GasLimitFile, BuilderConfigFile, GraffitiFile const minPasswordLen = 12 minPasswordEntropy = 60.0 mostCommonPasswords = wordListArray( nimbusSecurityResourcesPath / "passwords" / "10-million-password-list-top-100000.txt", minWordLen = minPasswordLen) func dispose*(decryptor: var MultipleKeystoresDecryptor) = burnMem(decryptor.previouslyUsedPassword) func init*(T: type KeymanagerHost, validatorPool: ref ValidatorPool, keystoreCache: KeystoreCacheRef, rng: ref HmacDrbgContext, keymanagerToken: string, validatorsDir: string, secretsDir: string, defaultFeeRecipient: Opt[Eth1Address], defaultGasLimit: uint64, defaultGraffiti: GraffitiBytes, defaultBuilderAddress: Opt[string], getValidatorAndIdxFn: ValidatorPubKeyToDataFn, getBeaconTimeFn: GetBeaconTimeFn, getCapellaForkVersionFn: GetCapellaForkVersionFn, getDenebForkEpochFn: GetDenebForkEpochFn, getForkFn: GetForkFn, getGenesisFn: GetGenesisFn): T = T(validatorPool: validatorPool, keystoreCache: keystoreCache, rng: rng, keymanagerToken: keymanagerToken, validatorsDir: validatorsDir, secretsDir: secretsDir, defaultFeeRecipient: defaultFeeRecipient, defaultGasLimit: defaultGasLimit, defaultGraffiti: defaultGraffiti, defaultBuilderAddress: defaultBuilderAddress, getValidatorAndIdxFn: getValidatorAndIdxFn, getBeaconTimeFn: getBeaconTimeFn, getCapellaForkVersionFn: getCapellaForkVersionFn, getDenebForkEpochFn: getDenebForkEpochFn, getForkFn: getForkFn, getGenesisFn: getGenesisFn) proc echoP*(msg: string) = ## Prints a paragraph aligned to 80 columns echo "" echo wrapWords(msg, 80) func init*(T: type KeystoreData, privateKey: ValidatorPrivKey, keystore: Keystore, handle: FileLockHandle): T {.raises: [].} = KeystoreData( kind: KeystoreKind.Local, privateKey: privateKey, description: keystore.description, path: keystore.path, uuid: keystore.uuid, handle: handle, version: uint64(keystore.version), pubkey: privateKey.toPubKey().toPubKey() ) func init(T: type KeystoreData, keystore: RemoteKeystore, handle: FileLockHandle): Result[T, cstring] {.raises: [].} = let cookedKey = keystore.pubkey.load().valueOr: return err("Invalid validator's public key") ok case keystore.remoteType of RemoteSignerType.Web3Signer: KeystoreData( kind: KeystoreKind.Remote, handle: handle, pubkey: cookedKey.toPubKey, description: keystore.description, version: keystore.version, remotes: keystore.remotes, threshold: keystore.threshold, remoteType: RemoteSignerType.Web3Signer) of RemoteSignerType.VerifyingWeb3Signer: KeystoreData( kind: KeystoreKind.Remote, handle: handle, pubkey: cookedKey.toPubKey, description: keystore.description, version: keystore.version, remotes: keystore.remotes, threshold: keystore.threshold, remoteType: RemoteSignerType.VerifyingWeb3Signer, provenBlockProperties: keystore.provenBlockProperties) func init(T: type KeystoreData, cookedKey: CookedPubKey, remotes: seq[RemoteSignerInfo], threshold: uint32, handle: FileLockHandle): T = KeystoreData( kind: KeystoreKind.Remote, handle: handle, pubkey: cookedKey.toPubKey(), version: 2'u64, remotes: remotes, threshold: threshold, ) func init(T: type AddValidatorFailure, status: AddValidatorStatus, msg = ""): AddValidatorFailure {.raises: [].} = AddValidatorFailure(status: status, message: msg) func toKeystoreKind(kind: ValidatorKind): KeystoreKind {.raises: [].} = case kind of ValidatorKind.Local: KeystoreKind.Local of ValidatorKind.Remote: KeystoreKind.Remote proc checkAndCreateDataDir*(dataDir: string): bool = when defined(posix): let requiredPerms = 0o700 if isDir(dataDir): let currPermsRes = getPermissions(dataDir) if currPermsRes.isErr(): fatal "Could not check data directory permissions", data_dir = dataDir, errorCode = $currPermsRes.error, errorMsg = ioErrorMsg(currPermsRes.error) return false else: let currPerms = currPermsRes.get() if currPerms != requiredPerms: warn "Data directory has insecure permissions. Correcting them.", data_dir = dataDir, current_permissions = currPerms.toOct(4), required_permissions = requiredPerms.toOct(4) let newPermsRes = setPermissions(dataDir, requiredPerms) if newPermsRes.isErr(): fatal "Could not set data directory permissions", data_dir = dataDir, errorCode = $newPermsRes.error, errorMsg = ioErrorMsg(newPermsRes.error), old_permissions = currPerms.toOct(4), new_permissions = requiredPerms.toOct(4) return false else: if (let res = secureCreatePath(dataDir); res.isErr): fatal "Could not create data directory", path = dataDir, err = ioErrorMsg(res.error), errorCode = $res.error return false elif defined(windows): let amask = {AccessFlags.Read, AccessFlags.Write, AccessFlags.Execute} if fileAccessible(dataDir, amask): let cres = checkCurrentUserOnlyACL(dataDir) if cres.isErr(): fatal "Could not check data folder's ACL", path = dataDir, errorCode = $cres.error, errorMsg = ioErrorMsg(cres.error) return false else: if cres.get() == false: fatal "Data folder has insecure ACL", path = dataDir return false else: if (let res = secureCreatePath(dataDir); res.isErr): fatal "Could not create data folder", path = dataDir, err = ioErrorMsg(res.error), errorCode = $res.error return false else: fatal "Unsupported operation system" return false return true proc checkSensitiveFilePermissions*(filePath: string): bool = ## Check if ``filePath`` has only "(600) rw-------" permissions. ## Procedure returns ``false`` if permissions are different and we can't ## correct them. when defined(windows): let cres = checkCurrentUserOnlyACL(filePath) if cres.isErr(): fatal "Could not check file's ACL", key_path = filePath, errorCode = $cres.error, errorMsg = ioErrorMsg(cres.error) return false else: if cres.get() == false: fatal "File has insecure permissions", key_path = filePath return false else: let requiredPerms = 0o600 let currPermsRes = getPermissions(filePath) if currPermsRes.isErr(): error "Could not check file permissions", key_path = filePath, errorCode = $currPermsRes.error, errorMsg = ioErrorMsg(currPermsRes.error) return false else: let currPerms = currPermsRes.get() if currPerms != requiredPerms: warn "File has insecure permissions. Correcting them.", key_path = filePath, current_permissions = currPerms.toOct(4), required_permissions = requiredPerms.toOct(4) let newPermsRes = setPermissions(filePath, requiredPerms) if newPermsRes.isErr(): fatal "Could not set data directory permissions", key_path = filePath, errorCode = $newPermsRes.error, errorMsg = ioErrorMsg(newPermsRes.error), old_permissions = currPerms.toOct(4), new_permissions = requiredPerms.toOct(4) return false return true proc keyboardCreatePassword(prompt: string, confirm: string, allowEmpty = false): KsResult[string] = while true: let password = try: readPasswordFromStdin(prompt) except IOError: error "Could not read password from stdin" return err("Could not read password from stdin") if password.len == 0 and allowEmpty: return ok("") # We treat `password` as UTF-8 encoded string. if validateUtf8(password) == -1: if runeLen(password) < minPasswordLen: echoP "The entered password should be at least " & $minPasswordLen & " characters." echo "" continue elif passwordEntropy(password) < minPasswordEntropy: echoP "The entered password has low entropy and may be easy to " & "brute-force with automated tools. Please increase the " & "variety of the user characters." continue elif cstring(password) in mostCommonPasswords: echoP "The entered password is too commonly used and it would be " & "easy to brute-force with automated tools." echo "" continue else: echoP "Entered password is not valid UTF-8 string" echo "" continue let confirmedPassword = try: readPasswordFromStdin(confirm) except IOError: error "Could not read password from stdin" return err("Could not read password from stdin") if password != confirmedPassword: echo "Passwords don't match, please try again\n" continue return ok(password) proc keyboardGetPassword[T](prompt: string, attempts: int, pred: proc(p: string): KsResult[T] {. gcsafe, raises: [].}): KsResult[T] = var remainingAttempts = attempts counter = 1 while remainingAttempts > 0: let passphrase = try: readPasswordFromStdin(prompt) except IOError: error "Could not read password from stdin" return os.sleep(1000 * counter) let res = pred(passphrase) if res.isOk(): return res else: inc(counter) dec(remainingAttempts) err("Failed to decrypt keystore") proc loadSecretFile(path: string): KsResult[KeystorePass] {. raises: [].} = let res = readAllChars(path) if res.isErr(): return err(ioErrorMsg(res.error())) ok(KeystorePass.init(res.get())) proc loadRemoteKeystoreImpl(validatorsDir, keyName: string): Opt[KeystoreData] = let keystorePath = validatorsDir / keyName / RemoteKeystoreFileName if not(checkSensitiveFilePermissions(keystorePath)): error "Remote keystorage file has insecure permissions", key_path = keystorePath return Opt.none(KeystoreData) let handle = block: let res = openLockedFile(keystorePath) if res.isErr(): error "Unable to lock keystore file", key_path = keystorePath, error_msg = ioErrorMsg(res.error()) return Opt.none(KeystoreData) res.get() var success = false defer: if not(success): discard handle.closeLockedFile() let keystore = block: let gres = handle.getData(MaxKeystoreFileSize) if gres.isErr(): error "Could not read remote keystore file", key_path = keystorePath, error_msg = ioErrorMsg(gres.error()) return Opt.none(KeystoreData) let buffer = gres.get() let data = try: parseRemoteKeystore(buffer) except SerializationError as e: error "Invalid remote keystore file", key_path = keystorePath, error_msg = e.formatMsg(keystorePath) return Opt.none(KeystoreData) let kres = KeystoreData.init(data, handle) if kres.isErr(): error "Invalid remote keystore file", key_path = keystorePath, error_msg = kres.error() return Opt.none(KeystoreData) kres.get() success = true Opt.some(keystore) proc loadLocalKeystoreImpl(validatorsDir, secretsDir, keyName: string, nonInteractive: bool, cache: KeystoreCacheRef): Opt[KeystoreData] = let keystorePath = validatorsDir / keyName / KeystoreFileName passphrasePath = secretsDir / keyName handle = block: let res = openLockedFile(keystorePath) if res.isErr(): error "Unable to lock keystore file", key_path = keystorePath, error_msg = ioErrorMsg(res.error()) return Opt.none(KeystoreData) res.get() var success = false defer: if not(success): discard handle.closeLockedFile() let keystore = block: let gres = handle.getData(MaxKeystoreFileSize) if gres.isErr(): error "Could not read local keystore file", key_path = keystorePath, error_msg = ioErrorMsg(gres.error()) return Opt.none(KeystoreData) let buffer = gres.get() let data = try: parseKeystore(buffer) except SerializationError as e: error "Invalid local keystore file", key_path = keystorePath, error_msg = e.formatMsg(keystorePath) return Opt.none(KeystoreData) data if fileExists(passphrasePath): if not(checkSensitiveFilePermissions(passphrasePath)): error "Password file has insecure permissions", key_path = keystorePath return Opt.none(KeystoreData) let passphrase = block: let res = loadSecretFile(passphrasePath) if res.isErr(): error "Failed to read passphrase file", error_msg = res.error(), path = passphrasePath return Opt.none(KeystoreData) res.get() let res = decryptKeystore(keystore, passphrase, cache) if res.isOk(): success = true return Opt.some(KeystoreData.init(res.get(), keystore, handle)) else: error "Failed to decrypt keystore", key_path = keystorePath, secure_path = passphrasePath return Opt.none(KeystoreData) if nonInteractive: error "Unable to load validator key store. Please ensure matching " & "passphrase exists in the secrets dir", key_path = keystorePath, key_name = keyName, validatorsDir, secretsDir = secretsDir return Opt.none(KeystoreData) let prompt = "Please enter passphrase for key \"" & (validatorsDir / keyName) & "\": " let res = keyboardGetPassword[ValidatorPrivKey](prompt, 3, proc (password: string): KsResult[ValidatorPrivKey] = let decrypted = decryptKeystore(keystore, KeystorePass.init password, cache) if decrypted.isErr(): error "Keystore decryption failed. Please try again", keystore_path = keystorePath decrypted ) if res.isErr(): return Opt.none(KeystoreData) success = true Opt.some(KeystoreData.init(res.get(), keystore, handle)) proc loadKeystore*(validatorsDir, secretsDir, keyName: string, nonInteractive: bool, cache: KeystoreCacheRef): Opt[KeystoreData] = let keystorePath = validatorsDir / keyName localKeystorePath = keystorePath / KeystoreFileName remoteKeystorePath = keystorePath / RemoteKeystoreFileName if fileExists(localKeystorePath): loadLocalKeystoreImpl(validatorsDir, secretsDir, keyName, nonInteractive, cache) elif fileExists(remoteKeystorePath): loadRemoteKeystoreImpl(validatorsDir, keyName) else: error "Unable to find any keystore files", keystorePath Opt.none(KeystoreData) proc removeValidatorFiles*(validatorsDir, secretsDir, keyName: string, kind: KeystoreKind ): KmResult[RemoveValidatorStatus] {. raises: [].} = let keystoreDir = validatorsDir / keyName keystoreFile = case kind of KeystoreKind.Local: keystoreDir / KeystoreFileName of KeystoreKind.Remote: keystoreDir / RemoteKeystoreFileName secretFile = secretsDir / keyName if not(dirExists(keystoreDir)): return ok(RemoveValidatorStatus.notFound) if not(fileExists(keystoreFile)): return ok(RemoveValidatorStatus.notFound) case kind of KeystoreKind.Local: block: let res = io2.removeFile(keystoreFile) if res.isErr(): return err("Could not remove keystore file") block: let res = io2.removeFile(secretFile) if res.isErr() and fileExists(secretFile): return err("Could not remove password file") # We remove folder with all subfolders and files inside. try: removeDir(keystoreDir, false) except OSError: return err("Could not remove keystore directory") of KeystoreKind.Remote: block: let res = io2.removeFile(keystoreFile) if res.isErr(): return err("Could not remove keystore file") # We remove folder with all subfolders and files inside. try: removeDir(keystoreDir, false) except OSError: return err("Could not remove keystore directory") ok(RemoveValidatorStatus.deleted) func fsName(pubkey: ValidatorPubKey|CookedPubKey): string = "0x" & pubkey.toHex() proc removeValidator*(pool: var ValidatorPool, validatorsDir, secretsDir: string, publicKey: ValidatorPubKey, kind: KeystoreKind): KmResult[RemoveValidatorStatus] {. raises: [].} = let validator = pool.getValidator(publicKey).valueOr: return ok(RemoveValidatorStatus.notFound) if validator.kind.toKeystoreKind() != kind: return ok(RemoveValidatorStatus.notFound) let cres = validator.data.handle.closeLockedFile() if cres.isErr(): return err("Could not unlock validator keystore file") let res = removeValidatorFiles(validatorsDir, secretsDir, publicKey.fsName, kind) if res.isErr(): return err(res.error()) pool.removeValidator(publicKey) ok(res.value()) func checkKeyName(keyName: string): Result[void, string] = const keyAlphabet = {'a'..'f', 'A'..'F', '0'..'9'} if len(keyName) != KeyNameSize: return err("Length should be at least " & $KeyNameSize & " characters") if keyName[0] != '0' or keyName[1] != 'x': return err("Name should be prefixed with '0x' characters") for index in 2 ..< len(keyName): if keyName[index] notin keyAlphabet: return err("Incorrect characters found in name") ok() proc existsKeystore(keystoreDir: string, keyKind: KeystoreKind): bool {. raises: [].} = case keyKind of KeystoreKind.Local: fileExists(keystoreDir / KeystoreFileName) of KeystoreKind.Remote: fileExists(keystoreDir / RemoteKeystoreFileName) proc existsKeystore(keystoreDir: string, keysMask: set[KeystoreKind]): bool {.raises: [].} = if KeystoreKind.Local in keysMask: if existsKeystore(keystoreDir, KeystoreKind.Local): return true if KeystoreKind.Remote in keysMask: if existsKeystore(keystoreDir, KeystoreKind.Remote): return true false proc queryValidatorsSource*(web3signerUrl: Web3SignerUrl): Future[QueryResult] {.async: (raises: [CancelledError]).} = var keystores: seq[KeystoreData] logScope: web3signer_url = web3signerUrl.url let httpFlags: HttpClientFlags = {} prestoFlags = {RestClientFlag.CommaSeparatedArray} socketFlags = {SocketFlags.TcpNoDelay} client = block: let res = RestClientRef.new($web3signerUrl.url, prestoFlags, httpFlags, socketFlags = socketFlags) if res.isErr(): warn "Unable to resolve validator's source distributed signer " & "address", reason = $res.error return QueryResult.err($res.error) res.get() keys = try: let response = await getKeysPlain(client) if response.status != 200: warn "Remote validator's source responded with error", error = response.status return QueryResult.err( "Remote validator's source responded with error [" & $response.status & "]") let res = decodeBytes(Web3SignerKeysResponse, response.data, response.contentType) if res.isErr(): warn "Unable to obtain validator's source response", reason = res.error return QueryResult.err($res.error) res.get() except RestError as exc: warn "Unable to poll validator's source", reason = $exc.msg return QueryResult.err($exc.msg) remoteType = if web3signerUrl.provenBlockProperties.len == 0: RemoteSignerType.Web3Signer else: RemoteSignerType.VerifyingWeb3Signer provenBlockProperties = mapIt(web3signerUrl.provenBlockProperties, block: parseProvenBlockProperty(it).valueOr: return QueryResult.err(error)) for pubkey in keys: keystores.add(KeystoreData( kind: KeystoreKind.Remote, handle: FileLockHandle(opened: false), pubkey: pubkey, remotes: @[RemoteSignerInfo( url: HttpHostUri(web3signerUrl.url), pubkey: pubkey)], flags: {RemoteKeystoreFlag.DynamicKeystore}, remoteType: remoteType)) if provenBlockProperties.len > 0: keystores[^1].provenBlockProperties = provenBlockProperties QueryResult.ok(keystores) iterator listLoadableKeys*(validatorsDir, secretsDir: string, keysMask: set[KeystoreKind]): CookedPubKey = const IncorrectName = "Incorrect keystore directory name, ignoring" try: logScope: keystore_dir = keystoreDir for kind, file in walkDir(validatorsDir): if kind == pcDir: let keyName = splitFile(file).name keystoreDir = validatorsDir / keyName nameres = checkKeyName(keyName) if nameres.isErr(): notice IncorrectName, reason = nameres.error continue if not(existsKeystore(keystoreDir, keysMask)): notice "Incorrect keystore directory, ignoring", reason = "Missing keystore files ('keystore.json' or " & "'remote_keystore.json')" continue let kres = ValidatorPubKey.fromHex(keyName) if kres.isErr(): let reason = "Directory name should be correct validators public key" notice IncorrectName, reason = reason continue let publicKey = kres.get() let cres = publicKey.load().valueOr: let reason = "Directory name should be correct validators public " & "key (point is not in curve)" notice IncorrectName, reason = reason continue yield cres except OSError as err: error "Validator keystores directory is not accessible", path = validatorsDir, err = err.msg quit 1 iterator listLoadableKeystores*(validatorsDir, secretsDir: string, nonInteractive: bool, keysMask: set[KeystoreKind], cache: KeystoreCacheRef): KeystoreData = const IncorrectName = "Incorrect keystore directory name, ignoring" try: logScope: keystore_dir = keystoreDir for kind, file in walkDir(validatorsDir): if kind == pcDir: let keyName = splitFile(file).name keystoreDir = validatorsDir / keyName nameres = checkKeyName(keyName) if nameres.isErr(): notice IncorrectName, reason = nameres.error continue if not(existsKeystore(keystoreDir, keysMask)): notice "Incorrect keystore directory, ignoring", reason = "Missing keystore files ('keystore.json' or " & "'remote_keystore.json')" continue let keystore = loadKeystore(validatorsDir, secretsDir, keyName, nonInteractive, cache).valueOr: fatal "Unable to load keystore", keystore = file quit 1 yield keystore except OSError as err: error "Validator keystores directory is not accessible", path = validatorsDir, err = err.msg quit 1 iterator listLoadableKeystores*(config: AnyConf, cache: KeystoreCacheRef): KeystoreData = for el in listLoadableKeystores(config.validatorsDir(), config.secretsDir(), config.nonInteractive, {KeystoreKind.Local, KeystoreKind.Remote}, cache): yield el type ValidatorConfigFileStatus* = enum noSuchValidator noConfigFile malformedConfigFile func validatorKeystoreDir( validatorsDir: string, pubkey: ValidatorPubKey): string = validatorsDir / pubkey.fsName proc checkValidatorKeystoreDir(validatorsDir: string, pubkey: ValidatorPubKey): bool = dirExists(validatorsDir.validatorKeystoreDir(pubkey)) func configFilePath*(validatorsDir: string, kind: ConfigFileKind, pubkey: ValidatorPubKey): string = case kind of ConfigFileKind.KeystoreFile: validatorsDir.validatorKeystoreDir(pubkey) / KeystoreFileName of ConfigFileKind.RemoteKeystoreFile: validatorsDir.validatorKeystoreDir(pubkey) / RemoteKeystoreFileName of ConfigFileKind.FeeRecipientFile: validatorsDir.validatorKeystoreDir(pubkey) / FeeRecipientFilename of ConfigFileKind.GasLimitFile: validatorsDir.validatorKeystoreDir(pubkey) / GasLimitFilename of ConfigFileKind.BuilderConfigFile: validatorsDir.validatorKeystoreDir(pubkey) / BuilderConfigPath of ConfigFileKind.GraffitiFile: validatorsDir.validatorKeystoreDir(pubkey) / GraffitiBytesFilename proc checkConfigFile*(validatorsDir: string, kind: ConfigFileKind, pubkey: ValidatorPubKey): bool = fileExists(validatorsDir.configFilePath(kind, pubkey)) proc getSuggestedFeeRecipient*( validatorsDir: string, pubkey: ValidatorPubKey, defaultFeeRecipient: Eth1Address): Result[Eth1Address, ValidatorConfigFileStatus] = # In this particular case, an error might be by design. If the file exists, # but doesn't load or parse that is more urgent. People might prefer not to # override default suggested fee recipients per validator, so don't warn. if not dirExists(validatorsDir.validatorKeystoreDir(pubkey)): return err noSuchValidator let feeRecipientPath = validatorsDir.configFilePath(ConfigFileKind.FeeRecipientFile, pubkey) if not fileExists(feeRecipientPath): return ok defaultFeeRecipient try: # Avoid being overly flexible initially. Trailing whitespace is common # enough it probably should be allowed, but it is reasonable to simply # disallow the mostly-pointless flexibility of leading whitespace. ok Eth1Address.fromHex(strutils.strip( readFile(feeRecipientPath), leading = false, trailing = true)) except CatchableError as exc: # Because the nonexistent validator case was already checked, any failure # at this point is serious enough to alert the user. warn "Failed to load fee recipient file; falling back to default fee recipient", feeRecipientPath, defaultFeeRecipient, err = exc.msg err malformedConfigFile proc getSuggestedGasLimit*( validatorsDir: string, pubkey: ValidatorPubKey, defaultGasLimit: uint64): Result[uint64, ValidatorConfigFileStatus] = # In this particular case, an error might be by design. If the file exists, # but doesn't load or parse that is more urgent. People might prefer not to # override their default suggested gas limit per validator, so don't warn. if not dirExists(validatorsDir.validatorKeystoreDir(pubkey)): return err noSuchValidator let gasLimitPath = validatorsDir.configFilePath(ConfigFileKind.GasLimitFile, pubkey) if not fileExists(gasLimitPath): return ok defaultGasLimit try: ok parseBiggestUInt(strutils.strip( readFile(gasLimitPath), leading = false, trailing = true)) except SerializationError as e: warn "Invalid local gas limit file", gasLimitPath, err = e.formatMsg(gasLimitPath) err malformedConfigFile except CatchableError as exc: warn "Failed to load gas limit file; falling back to default gas limit", gasLimitPath, defaultGasLimit, err = exc.msg err malformedConfigFile proc getSuggestedGraffiti*( validatorsDir: string, pubkey: ValidatorPubKey, defaultGraffitiBytes: GraffitiBytes ): Result[GraffitiBytes, ValidatorConfigFileStatus] = # In this particular case, an error might be by design. If the file exists, # but doesn't load or parse that is more urgent. People might prefer not to # override their default suggested gas limit per validator, so don't warn. if not dirExists(validatorsDir.validatorKeystoreDir(pubkey)): return err noSuchValidator let graffitiPath = validatorsDir.configFilePath(ConfigFileKind.GraffitiFile, pubkey) if not fileExists(graffitiPath): return ok defaultGraffitiBytes let data = readAllChars(graffitiPath).valueOr: warn "Failed to load graffiti file; falling back to default graffiti", reason = ioErrorMsg(error), error = int(error) return err malformedConfigFile try: ok GraffitiBytes.init(data) except ValueError as exc: warn "Invalid local graffiti file", graffitiPath, reason = exc.msg return err malformedConfigFile type BuilderConfig = object payloadBuilderEnable: bool payloadBuilderUrl: string proc getBuilderConfig*( validatorsDir: string, pubkey: ValidatorPubKey, defaultBuilderAddress: Opt[string]): Result[Opt[string], ValidatorConfigFileStatus] = # In this particular case, an error might be by design. If the file exists, # but doesn't load or parse that is more urgent. People might prefer not to # override default builder configs per validator, so don't warn. if not dirExists(validatorsDir.validatorKeystoreDir(pubkey)): return err noSuchValidator let builderConfigPath = validatorsDir.configFilePath(ConfigFileKind.BuilderConfigFile, pubkey) if not fileExists(builderConfigPath): return ok defaultBuilderAddress let builderConfig = try: Json.loadFile(builderConfigPath, BuilderConfig, requireAllFields = true) except IOError as err: # Any exception must be in the presence of such a file, and therefore # an actual error worth logging error "Failed to read payload builder configuration", err = err.msg, path = builderConfigPath return err malformedConfigFile except SerializationError as err: error "Invalid payload builder configuration", err = err.formatMsg(builderConfigPath) return err malformedConfigFile ok( if builderConfig.payloadBuilderEnable: Opt.some builderConfig.payloadBuilderUrl else: Opt.none string) type KeystoreGenerationErrorKind* = enum FailedToCreateValidatorsDir FailedToCreateKeystoreDir FailedToCreateSecretsDir FailedToCreateSecretFile FailedToCreateKeystoreFile DuplicateKeystoreDir DuplicateKeystoreFile KeystoreGenerationError* = object case kind*: KeystoreGenerationErrorKind of FailedToCreateKeystoreDir, FailedToCreateValidatorsDir, FailedToCreateSecretsDir, FailedToCreateSecretFile, FailedToCreateKeystoreFile, DuplicateKeystoreDir, DuplicateKeystoreFile: error*: string func mapErrTo*[T, E](r: Result[T, E], v: static KeystoreGenerationErrorKind): Result[T, KeystoreGenerationError] = r.mapErr(proc (e: E): KeystoreGenerationError = KeystoreGenerationError(kind: v, error: $e)) proc loadNetKeystore*(keystorePath: string, insecurePwd: Opt[string]): Opt[lcrypto.PrivateKey] = if not(checkSensitiveFilePermissions(keystorePath)): error "Network keystorage file has insecure permissions", key_path = keystorePath return let keyStore = try: Json.loadFile(keystorePath, NetKeystore, requireAllFields = true, allowUnknownFields = true) except IOError as err: error "Failed to read network keystore", err = err.msg, path = keystorePath return except SerializationError as err: error "Invalid network keystore", err = err.formatMsg(keystorePath) return if insecurePwd.isSome(): warn "Using insecure password to unlock networking key" let decrypted = decryptNetKeystore(keyStore, KeystorePass.init(insecurePwd.get())) if decrypted.isOk: return ok(decrypted.get()) else: error "Network keystore decryption failed", key_store = keystorePath return else: let prompt = "Please enter passphrase to unlock networking key: " let res = keyboardGetPassword[lcrypto.PrivateKey](prompt, 3, proc (password: string): KsResult[lcrypto.PrivateKey] = let decrypted = decryptNetKeystore(keyStore, KeystorePass.init password) if decrypted.isErr(): error "Keystore decryption failed. Please try again", keystorePath decrypted ) if res.isOk(): ok(res.get()) else: return proc saveNetKeystore*(rng: var HmacDrbgContext, keystorePath: string, netKey: lcrypto.PrivateKey, insecurePwd: Opt[string] ): Result[void, KeystoreGenerationError] = let password = if insecurePwd.isSome(): warn "Using insecure password to lock networking key", key_path = keystorePath insecurePwd.get() else: let prompt = "Please enter NEW password to lock network key storage: " let confirm = "Please confirm, network key storage password: " ? keyboardCreatePassword(prompt, confirm).mapErrTo( FailedToCreateKeystoreFile) let keyStore = createNetKeystore(kdfScrypt, rng, netKey, KeystorePass.init password) let encodedStorage = Json.encode(keyStore) let res = secureWriteFile(keystorePath, encodedStorage) if res.isOk(): ok() else: error "Could not write to network key storage file", key_path = keystorePath res.mapErrTo(FailedToCreateKeystoreFile) proc createLocalValidatorFiles*( secretsDir, validatorsDir, keystoreDir, secretFile, passwordAsString, keystoreFile, encodedStorage: string ): Result[void, KeystoreGenerationError] {.raises: [].} = var success = false # becomes true when everything is created successfully # secretsDir: let secretsDirExisted: bool = dirExists(secretsDir) if not(secretsDirExisted): ? secureCreatePath(secretsDir).mapErrTo(FailedToCreateSecretsDir) defer: if not (success or secretsDirExisted): discard io2.removeDir(secretsDir) # validatorsDir: let validatorsDirExisted: bool = dirExists(validatorsDir) if not(validatorsDirExisted): ? secureCreatePath(validatorsDir).mapErrTo(FailedToCreateValidatorsDir) defer: if not (success or validatorsDirExisted): discard io2.removeDir(validatorsDir) # keystoreDir: ? secureCreatePath(keystoreDir).mapErrTo(FailedToCreateKeystoreDir) defer: if not success: discard io2.removeDir(keystoreDir) # secretFile: ? secureWriteFile(secretFile, passwordAsString).mapErrTo(FailedToCreateSecretFile) defer: if not success: discard io2.removeFile(secretFile) # keystoreFile: ? secureWriteFile(keystoreFile, encodedStorage).mapErrTo(FailedToCreateKeystoreFile) success = true ok() proc createLockedLocalValidatorFiles( secretsDir, validatorsDir, keystoreDir, secretFile, passwordAsString, keystoreFile, encodedStorage: string ): Result[FileLockHandle, KeystoreGenerationError] {.raises: [].} = var success = false # becomes true when everything is created successfully # secretsDir: let secretsDirExisted: bool = dirExists(secretsDir) if not(secretsDirExisted): ? secureCreatePath(secretsDir).mapErrTo(FailedToCreateSecretsDir) defer: if not (success or secretsDirExisted): discard io2.removeDir(secretsDir) # validatorsDir: let validatorsDirExisted: bool = dirExists(validatorsDir) if not(validatorsDirExisted): ? secureCreatePath(validatorsDir).mapErrTo(FailedToCreateValidatorsDir) defer: if not (success or validatorsDirExisted): discard io2.removeDir(validatorsDir) # keystoreDir: ? secureCreatePath(keystoreDir).mapErrTo(FailedToCreateKeystoreDir) defer: if not success: discard io2.removeDir(keystoreDir) # secretFile: ? secureWriteFile(secretFile, passwordAsString).mapErrTo(FailedToCreateSecretFile) defer: if not success: discard io2.removeFile(secretFile) # keystoreFile: let lock = ? secureWriteLockedFile(keystoreFile, encodedStorage).mapErrTo(FailedToCreateKeystoreFile) success = true ok(lock) proc createRemoteValidatorFiles*( validatorsDir, keystoreDir, keystoreFile, encodedStorage: string ): Result[void, KeystoreGenerationError] {.raises: [].} = var success = false # becomes true when everything is created successfully # validatorsDir: let validatorsDirExisted: bool = dirExists(validatorsDir) if not(validatorsDirExisted): ? secureCreatePath(validatorsDir).mapErrTo(FailedToCreateValidatorsDir) defer: if not (success or validatorsDirExisted): discard io2.removeDir(validatorsDir) # keystoreDir: ? secureCreatePath(keystoreDir).mapErrTo(FailedToCreateKeystoreDir) defer: if not success: discard io2.removeDir(keystoreDir) # keystoreFile: ? secureWriteFile(keystoreFile, encodedStorage).mapErrTo(FailedToCreateKeystoreFile) success = true ok() proc createLockedRemoteValidatorFiles( validatorsDir, keystoreDir, keystoreFile, encodedStorage: string ): Result[FileLockHandle, KeystoreGenerationError] {.raises: [].} = var success = false # becomes true when everything is created successfully # validatorsDir: let validatorsDirExisted: bool = dirExists(validatorsDir) if not(validatorsDirExisted): ? secureCreatePath(validatorsDir).mapErrTo(FailedToCreateValidatorsDir) defer: if not (success or validatorsDirExisted): discard io2.removeDir(validatorsDir) # keystoreDir: ? secureCreatePath(keystoreDir).mapErrTo(FailedToCreateKeystoreDir) defer: if not success: discard io2.removeDir(keystoreDir) # keystoreFile: let lock = ? secureWriteLockedFile( keystoreFile, encodedStorage).mapErrTo(FailedToCreateKeystoreFile) success = true ok(lock) proc saveKeystore*( rng: var HmacDrbgContext, validatorsDir, secretsDir: string, signingKey: ValidatorPrivKey, signingPubKey: CookedPubKey, signingKeyPath: KeyPath, password: string, salt: openArray[byte] = @[], mode = Secure ): Result[void, KeystoreGenerationError] {.raises: [].} = let keypass = KeystorePass.init(password) keyName = signingPubKey.fsName keystoreDir = validatorsDir / keyName keystoreFile = keystoreDir / KeystoreFileName if dirExists(keystoreDir): return err(KeystoreGenerationError(kind: DuplicateKeystoreDir, error: "Keystore directory already exists")) if fileExists(keystoreFile): return err(KeystoreGenerationError(kind: DuplicateKeystoreFile, error: "Keystore file already exists")) let keyStore = createKeystore(kdfPbkdf2, rng, signingKey, keypass, signingKeyPath, mode = mode, salt = salt) let encodedStorage = Json.encode(keyStore) ? createLocalValidatorFiles(secretsDir, validatorsDir, keystoreDir, secretsDir / keyName, keypass.str, keystoreFile, encodedStorage) ok() proc saveLockedKeystore( rng: var HmacDrbgContext, validatorsDir, secretsDir: string, signingKey: ValidatorPrivKey, signingPubKey: CookedPubKey, signingKeyPath: KeyPath, password: string, mode = Secure ): Result[FileLockHandle, KeystoreGenerationError] {.raises: [].} = let keypass = KeystorePass.init(password) keyName = signingPubKey.fsName keystoreDir = validatorsDir / keyName keystoreFile = keystoreDir / KeystoreFileName if dirExists(keystoreDir): return err(KeystoreGenerationError(kind: DuplicateKeystoreDir, error: "Keystore directory already exists")) if fileExists(keystoreFile): return err(KeystoreGenerationError(kind: DuplicateKeystoreFile, error: "Keystore file already exists")) let keyStore = createKeystore(kdfPbkdf2, rng, signingKey, keypass, signingKeyPath, mode = mode) let encodedStorage = Json.encode(keyStore) let lock = ? createLockedLocalValidatorFiles(secretsDir, validatorsDir, keystoreDir, secretsDir / keyName, keypass.str, keystoreFile, encodedStorage) ok(lock) proc saveKeystore( validatorsDir: string, publicKey: ValidatorPubKey, urls: seq[RemoteSignerInfo], threshold: uint32, flags: set[RemoteKeystoreFlag] = {}, remoteType = RemoteSignerType.Web3Signer, desc = "" ): Result[void, KeystoreGenerationError] {.raises: [].} = let keyName = publicKey.fsName keystoreDir = validatorsDir / keyName keystoreFile = keystoreDir / RemoteKeystoreFileName keystoreDesc = if len(desc) == 0: none[string]() else: some(desc) keyStore = RemoteKeystore( version: 2'u64, description: keystoreDesc, remoteType: remoteType, pubkey: publicKey, threshold: threshold, remotes: urls, flags: flags) if dirExists(keystoreDir): return err(KeystoreGenerationError(kind: DuplicateKeystoreDir, error: "Keystore directory already exists")) if fileExists(keystoreFile): return err(KeystoreGenerationError(kind: DuplicateKeystoreFile, error: "Keystore file already exists")) let encodedStorage = Json.encode(keyStore) ? createRemoteValidatorFiles(validatorsDir, keystoreDir, keystoreFile, encodedStorage) ok() proc saveLockedKeystore( validatorsDir: string, publicKey: ValidatorPubKey, urls: seq[RemoteSignerInfo], threshold: uint32, flags: set[RemoteKeystoreFlag] = {}, remoteType = RemoteSignerType.Web3Signer, desc = "" ): Result[FileLockHandle, KeystoreGenerationError] {.raises: [].} = let keyName = publicKey.fsName keystoreDir = validatorsDir / keyName keystoreFile = keystoreDir / RemoteKeystoreFileName keystoreDesc = if len(desc) == 0: none[string]() else: some(desc) keyStore = RemoteKeystore( version: 2'u64, description: keystoreDesc, remoteType: remoteType, pubkey: publicKey, threshold: threshold, remotes: urls, flags: flags) if dirExists(keystoreDir): return err(KeystoreGenerationError(kind: DuplicateKeystoreDir, error: "Keystore directory already exists")) if fileExists(keystoreFile): return err(KeystoreGenerationError(kind: DuplicateKeystoreFile, error: "Keystore file already exists")) let encodedStorage = Json.encode(keyStore) let lock = ? createLockedRemoteValidatorFiles(validatorsDir, keystoreDir, keystoreFile, encodedStorage) ok(lock) proc saveKeystore*( validatorsDir: string, publicKey: ValidatorPubKey, url: HttpHostUri ): Result[void, KeystoreGenerationError] {.raises: [].} = let remoteInfo = RemoteSignerInfo(url: url, id: 0) saveKeystore(validatorsDir, publicKey, @[remoteInfo], 1) proc importKeystore*(pool: var ValidatorPool, validatorsDir: string, keystore: RemoteKeystore): ImportResult[KeystoreData] {. raises: [].} = let publicKey = keystore.pubkey keyName = publicKey.fsName keystoreDir = validatorsDir / keyName # We check `publicKey`. let cookedKey = publicKey.load().valueOr: return err( AddValidatorFailure.init(AddValidatorStatus.failed, "Invalid validator's public key")) # We check `publicKey` in memory storage first. if publicKey in pool: return err(AddValidatorFailure.init(AddValidatorStatus.existingArtifacts)) # We check `publicKey` in filesystem. if existsKeystore(keystoreDir, {KeystoreKind.Local, KeystoreKind.Remote}): return err(AddValidatorFailure.init(AddValidatorStatus.existingArtifacts)) let res = saveLockedKeystore(validatorsDir, publicKey, keystore.remotes, keystore.threshold) if res.isErr(): return err(AddValidatorFailure.init(AddValidatorStatus.failed, $res.error())) ok(KeystoreData.init(cookedKey, keystore.remotes, keystore.threshold, res.get())) proc importKeystore*(pool: var ValidatorPool, rng: var HmacDrbgContext, validatorsDir, secretsDir: string, keystore: Keystore, password: string, cache: KeystoreCacheRef): ImportResult[KeystoreData] {. raises: [].} = let keypass = KeystorePass.init(password) privateKey = decryptKeystore(keystore, keypass, cache).valueOr: return err(AddValidatorFailure.init(AddValidatorStatus.failed, error)) publicKey = privateKey.toPubKey() keyName = publicKey.fsName keystoreDir = validatorsDir / keyName # We check `publicKey` in memory storage first. if publicKey.toPubKey() in pool: return err(AddValidatorFailure.init(AddValidatorStatus.existingArtifacts)) # We check `publicKey` in filesystem. if existsKeystore(keystoreDir, {KeystoreKind.Local, KeystoreKind.Remote}): return err(AddValidatorFailure.init(AddValidatorStatus.existingArtifacts)) let res = saveLockedKeystore(rng, validatorsDir, secretsDir, privateKey, publicKey, keystore.path, password) if res.isErr(): return err(AddValidatorFailure.init(AddValidatorStatus.failed, $res.error())) ok(KeystoreData.init(privateKey, keystore, res.get())) proc generateDistributedStore*(rng: var HmacDrbgContext, shares: seq[SecretShare], pubKey: ValidatorPubKey, validatorIdx: Natural, shareSecretsDir: string, shareValidatorDir: string, remoteValidatorDir: string, remoteSignersUrls: seq[string], threshold: uint32, mode = KeystoreMode.Secure): Result[void, KeystoreGenerationError] = var signers: seq[RemoteSignerInfo] for idx, share in shares: var password = KeystorePass.init ncrutils.toHex(rng.generateBytes(32)) # remote signer shares defer: burnMem(password) ? saveKeystore(rng, shareValidatorDir / $share.id, shareSecretsDir / $share.id, share.key, share.key.toPubKey, makeKeyPath(validatorIdx, signingKeyKind), password.str, @[], mode) signers.add RemoteSignerInfo( url: HttpHostUri(parseUri(remoteSignersUrls[idx])), id: share.id, pubkey: share.key.toPubKey.toPubKey) # actual validator saveKeystore(remoteValidatorDir, pubKey, signers, threshold) func validatorKeystoreDir(host: KeymanagerHost, pubkey: ValidatorPubKey): string = host.validatorsDir.validatorKeystoreDir(pubkey) proc checkValidatorKeystoreDir*(host: KeymanagerHost, pubkey: ValidatorPubKey): bool = host.validatorsDir.checkValidatorKeystoreDir(pubkey) proc checkConfigFile*(host: KeymanagerHost, kind: ConfigFileKind, pubkey: ValidatorPubKey): bool = fileExists(host.validatorsDir.configFilePath(kind, pubkey)) func feeRecipientPath(host: KeymanagerHost, pubkey: ValidatorPubKey): string = host.validatorsDir.configFilePath(ConfigFileKind.FeeRecipientFile, pubkey) func gasLimitPath(host: KeymanagerHost, pubkey: ValidatorPubKey): string = host.validatorsDir.configFilePath(ConfigFileKind.GasLimitFile, pubkey) func graffitiPath(host: KeymanagerHost, pubkey: ValidatorPubKey): string = host.validatorsDir.configFilePath(ConfigFileKind.GraffitiFile, pubkey) proc removeFeeRecipientFile*(host: KeymanagerHost, pubkey: ValidatorPubKey): Result[void, string] = let path = host.feeRecipientPath(pubkey) if fileExists(path): io2.removeFile(path).isOkOr: return err($uint(error) & " " & ioErrorMsg(error)) host.validatorPool[].invalidateValidatorRegistration(pubkey) ok() proc removeGasLimitFile*(host: KeymanagerHost, pubkey: ValidatorPubKey): Result[void, string] = let path = host.gasLimitPath(pubkey) if fileExists(path): io2.removeFile(path).isOkOr: return err($uint(error) & " " & ioErrorMsg(error)) ok() proc removeGraffitiFile*(host: KeymanagerHost, pubkey: ValidatorPubKey): Result[void, string] = let path = host.graffitiPath(pubkey) if fileExists(path): io2.removeFile(path).isOkOr: return err($uint(error) & " " & ioErrorMsg(error)) ok() proc setFeeRecipient*( host: KeymanagerHost, pubkey: ValidatorPubKey, feeRecipient: Eth1Address): Result[void, string] = let validatorKeystoreDir = host.validatorKeystoreDir(pubkey) ? secureCreatePath(validatorKeystoreDir).mapErr(proc(e: auto): string = "Could not create wallet directory [" & validatorKeystoreDir & "]: " & $e) let res = io2.writeFile( validatorKeystoreDir / FeeRecipientFilename, $feeRecipient) .mapErr(proc(e: auto): string = "Failed to write fee recipient file: " & $e) if res.isOk: host.validatorPool[].invalidateValidatorRegistration(pubkey) res proc setGasLimit*(host: KeymanagerHost, pubkey: ValidatorPubKey, gasLimit: uint64): Result[void, string] = let validatorKeystoreDir = host.validatorKeystoreDir(pubkey) ? secureCreatePath(validatorKeystoreDir).mapErr(proc(e: auto): string = "Could not create wallet directory [" & validatorKeystoreDir & "]: " & $e) io2.writeFile(validatorKeystoreDir / GasLimitFilename, $gasLimit) .mapErr(proc(e: auto): string = "Failed to write gas limit file: " & $e) proc setGraffiti*(host: KeymanagerHost, pubkey: ValidatorPubKey, graffiti: GraffitiBytes): Result[void, string] = let validatorKeystoreDir = host.validatorKeystoreDir(pubkey) path = host.graffitiPath(pubkey) ? secureCreatePath(validatorKeystoreDir) .mapErr(proc(e: auto): string = "Could not create wallet directory [" & validatorKeystoreDir & "], " & "reason: (" & $int(e) & ") " & ioErrorMsg(e)) io2.writeFile(path, to0xHex(distinctBase(graffiti))) .mapErr(proc(e: auto): string = "Failed to write graffiti file," & " reason: (" & $int(e) & ") " & ioErrorMsg(e)) from ".."/spec/beaconstate import has_eth1_withdrawal_credential proc getValidatorWithdrawalAddress*( host: KeymanagerHost, pubkey: ValidatorPubKey): Opt[Eth1Address] = if host.getValidatorAndIdxFn.isNil: Opt.none Eth1Address else: let validatorAndIndex = host.getValidatorAndIdxFn(pubkey) if validatorAndIndex.isNone: Opt.none Eth1Address else: template validator: auto = validatorAndIndex.get.validator if has_eth1_withdrawal_credential(validator): var address: distinctBase(Eth1Address) address[0..^1] = validator.withdrawal_credentials.data[12..^1] Opt.some Eth1Address address else: Opt.none Eth1Address func getPerValidatorDefaultFeeRecipient*( defaultFeeRecipient: Opt[Eth1Address], withdrawalAddress: Opt[Eth1Address]): Eth1Address = defaultFeeRecipient.valueOr: withdrawalAddress.valueOr: (static(default(Eth1Address))) proc getSuggestedFeeRecipient*( host: KeymanagerHost, pubkey: ValidatorPubKey, defaultFeeRecipient: Eth1Address): Result[Eth1Address, ValidatorConfigFileStatus] = host.validatorsDir.getSuggestedFeeRecipient(pubkey, defaultFeeRecipient) proc getSuggestedFeeRecipient( host: KeymanagerHost, pubkey: ValidatorPubKey, withdrawalAddress: Opt[Eth1Address]): Eth1Address = # Enforce the gsfr(foo).valueOr(foo) pattern where feasible let perValidatorDefaultFeeRecipient = getPerValidatorDefaultFeeRecipient( host.defaultFeeRecipient, withdrawalAddress) host.getSuggestedFeeRecipient( pubkey, perValidatorDefaultFeeRecipient).valueOr: perValidatorDefaultFeeRecipient proc getSuggestedGasLimit*( host: KeymanagerHost, pubkey: ValidatorPubKey): Result[uint64, ValidatorConfigFileStatus] = host.validatorsDir.getSuggestedGasLimit(pubkey, host.defaultGasLimit) proc getSuggestedGraffiti*( host: KeymanagerHost, pubkey: ValidatorPubKey ): Result[GraffitiBytes, ValidatorConfigFileStatus] = host.validatorsDir.getSuggestedGraffiti(pubkey, host.defaultGraffiti) proc getBuilderConfig*( host: KeymanagerHost, pubkey: ValidatorPubKey): Result[Opt[string], ValidatorConfigFileStatus] = host.validatorsDir.getBuilderConfig(pubkey, host.defaultBuilderAddress) proc addValidator*( host: KeymanagerHost, keystore: KeystoreData, withdrawalAddress: Opt[Eth1Address]) = let feeRecipient = host.getSuggestedFeeRecipient( keystore.pubkey, withdrawalAddress) gasLimit = host.getSuggestedGasLimit(keystore.pubkey).valueOr( host.defaultGasLimit) v = host.validatorPool[].addValidator(keystore, feeRecipient, gasLimit) if not isNil(host.getValidatorAndIdxFn): let data = host.getValidatorAndIdxFn(keystore.pubkey) host.validatorPool[].updateValidator(v, data) proc generateDeposits*(cfg: RuntimeConfig, rng: var HmacDrbgContext, seed: KeySeed, firstValidatorIdx, totalNewValidators: int, validatorsDir: string, secretsDir: string, remoteSignersUrls: seq[string] = @[], threshold: uint32 = 1, remoteValidatorsCount: uint32 = 0, mode = Secure): Result[seq[DepositData], KeystoreGenerationError] = var deposits: seq[DepositData] notice "Generating deposits", totalNewValidators, validatorsDir, secretsDir # We'll reuse a single variable here to make the secret # scrubbing (burnMem) easier to handle: var baseKey = deriveMasterKey(seed) defer: burnMem(baseKey) baseKey = deriveChildKey(baseKey, baseKeyPath) var salt = rng.generateKeystoreSalt() password = KeystorePass.init ncrutils.toHex(rng.generateBytes(32)) defer: burnMem(salt) burnMem(password) let localValidatorsCount = totalNewValidators - int(remoteValidatorsCount) for i in 0 ..< localValidatorsCount: let validatorIdx = firstValidatorIdx + i # We'll reuse a single variable here to make the secret # scrubbing (burnMem) easier to handle: var derivedKey = baseKey defer: burnMem(derivedKey) derivedKey = deriveChildKey(derivedKey, validatorIdx) derivedKey = deriveChildKey(derivedKey, 0) # This is witdrawal key let withdrawalPubKey = derivedKey.toPubKey derivedKey = deriveChildKey(derivedKey, 0) # This is the signing key let signingPubKey = derivedKey.toPubKey ? saveKeystore(rng, validatorsDir, secretsDir, derivedKey, signingPubKey, makeKeyPath(validatorIdx, signingKeyKind), password.str, salt, mode) deposits.add prepareDeposit( cfg, withdrawalPubKey, derivedKey, signingPubKey) for i in 0 ..< remoteValidatorsCount: let validatorIdx = int(firstValidatorIdx) + localValidatorsCount + int(i) # We'll reuse a single variable here to make the secret # scrubbing (burnMem) easier to handle: var derivedKey = baseKey defer: burnMem(derivedKey) derivedKey = deriveChildKey(derivedKey, validatorIdx) derivedKey = deriveChildKey(derivedKey, 0) # This is witdrawal key let withdrawalPubKey = derivedKey.toPubKey derivedKey = deriveChildKey(derivedKey, 0) # This is the signing key let signingPubKey = derivedKey.toPubKey let sharesCount = uint32 len(remoteSignersUrls) let shares = generateSecretShares(derivedKey, rng, threshold, sharesCount) if shares.isErr(): error "Failed to generate distributed key: ", threshold, sharesCount continue ? generateDistributedStore(rng, shares.get, signingPubKey.toPubKey, validatorIdx, secretsDir & "_shares", validatorsDir & "_shares", validatorsDir, remoteSignersUrls, threshold, mode) deposits.add prepareDeposit( cfg, withdrawalPubKey, derivedKey, signingPubKey) ok deposits proc saveWallet(wallet: Wallet, outWalletPath: string): Result[void, string] = let walletDir = splitFile(outWalletPath).dir encodedWallet = Json.encode(wallet, pretty = true) ? secureCreatePath(walletDir).mapErr(proc(e: auto): string = "Could not create wallet directory [" & walletDir & "]: " & $e) ? secureWriteFile(outWalletPath, encodedWallet).mapErr(proc(e: auto): string = "Could not write wallet to file [" & outWalletPath & "]: " & $e) ok() proc saveWallet*(wallet: WalletPathPair): Result[void, string] = saveWallet(wallet.wallet, wallet.path) proc readPasswordInput(prompt: string, password: var string): bool = burnMem password try: when defined(windows): # readPasswordFromStdin() on Windows always returns `false`. # https://github.com/nim-lang/Nim/issues/15207 discard readPasswordFromStdin(prompt, password) true else: readPasswordFromStdin(prompt, password) except IOError: false proc setStyleNoError(styles: set[Style]) = when defined(windows): try: stdout.setStyle(styles) except: discard else: try: stdout.setStyle(styles) except IOError, ValueError: discard proc setForegroundColorNoError(color: ForegroundColor) = when defined(windows): try: stdout.setForegroundColor(color) except: discard else: try: stdout.setForegroundColor(color) except IOError, ValueError: discard proc resetAttributesNoError() = when defined(windows): try: stdout.resetAttributes() except: discard else: try: stdout.resetAttributes() except IOError: discard proc importKeystoreFromFile*( decryptor: var MultipleKeystoresDecryptor, fileName: string ): Result[ValidatorPrivKey, string] = let data = readAllChars(fileName).valueOr: return err("Unable to read keystore file [" & ioErrorMsg(error) & "]") keystore = try: parseKeystore(data) except SerializationError as e: return err("Invalid keystore file format [" & e.formatMsg(fileName) & "]") var firstDecryptionAttempt = true while true: var secret: seq[byte] let status = decryptCryptoField( keystore.crypto, KeystorePass.init(decryptor.previouslyUsedPassword), secret) case status of DecryptionStatus.Success: let privateKey = ValidatorPrivKey.fromRaw(secret).valueOr: return err("Keystore holds invalid private key [" & $error & "]") return ok(privateKey) of DecryptionStatus.InvalidKeystore: return err("Invalid keystore format") of DecryptionStatus.InvalidPassword: if firstDecryptionAttempt: try: const msg = "Please enter the password for decrypting '$1'" echo msg % [fileName] except ValueError: raiseAssert "The format string above is correct" firstDecryptionAttempt = false else: echo "The entered password was incorrect. Please try again." if not(readPasswordInput("Password: ", decryptor.previouslyUsedPassword)): echo "System error while entering password. Please try again." if len(decryptor.previouslyUsedPassword) == 0: break proc importKeystoresFromDir*(rng: var HmacDrbgContext, meth: ImportMethod, importedDir, validatorsDir, secretsDir: string) = var password: string # TODO consider using a SecretString type defer: burnMem(password) var (singleSaltPassword, singleSaltSalt) = case meth of ImportMethod.Normal: var defaultSeq: seq[byte] (KeystorePass.init(""), defaultSeq) of ImportMethod.SingleSalt: (KeystorePass.init(ncrutils.toHex(rng.generateBytes(32))), rng.generateBytes(32)) defer: burnMem(singleSaltPassword) burnMem(singleSaltSalt) try: for file in walkDirRec(importedDir): let filenameParts = splitFile(file) if toLowerAscii(filenameParts.ext) != ".json": continue # In case we are importing from eth2.0-deposits-cli, the imported # validator_keys directory will also include a "deposit_data" file # intended for uploading to the launchpad. We'll skip it to avoid # the "Invalid keystore" warning that it will trigger. if filenameParts.name.startsWith("deposit_data"): continue let keystore = try: Json.loadFile(file, Keystore, requireAllFields = true, allowUnknownFields = true) except SerializationError as e: warn "Invalid keystore", err = e.formatMsg(file) continue except IOError as e: warn "Failed to read keystore file", file, err = e.msg continue var firstDecryptionAttempt = true while true: var secret: seq[byte] let status = decryptCryptoField(keystore.crypto, KeystorePass.init password, secret) case status of DecryptionStatus.Success: let privKey = ValidatorPrivKey.fromRaw(secret) if privKey.isOk: let pubkey = privKey.value.toPubKey var (password, salt) = case meth of ImportMethod.Normal: var defaultSeq: seq[byte] (KeystorePass.init ncrutils.toHex(rng.generateBytes(32)), defaultSeq) of ImportMethod.SingleSalt: (singleSaltPassword, singleSaltSalt) defer: burnMem(password) burnMem(salt) let status = saveKeystore(rng, validatorsDir, secretsDir, privKey.value, pubkey, keystore.path, password.str, salt) if status.isOk: notice "Keystore imported", file else: error "Failed to import keystore", file, validatorsDir, secretsDir, err = status.error else: error "Imported keystore holds invalid key", file, err = privKey.error break of DecryptionStatus.InvalidKeystore: warn "Invalid keystore", file break of DecryptionStatus.InvalidPassword: if firstDecryptionAttempt: try: const msg = "Please enter the password for decrypting '$1' " & "or press ENTER to skip importing this keystore" echo msg % [file] except ValueError: raiseAssert "The format string above is correct" else: echo "The entered password was incorrect. Please try again." firstDecryptionAttempt = false if not readPasswordInput("Password: ", password): echo "System error while entering password. Please try again." if password.len == 0: break except OSError: fatal "Failed to access the imported deposits directory" quit 1 template ask(prompt: string): string = try: stdout.write prompt, ": " stdin.readLine() except IOError: return err "failure to read data from stdin" proc pickPasswordAndSaveWallet(rng: var HmacDrbgContext, config: BeaconNodeConf, seed: KeySeed): Result[WalletPathPair, string] = echoP "When you perform operations with your wallet such as withdrawals " & "and additional deposits, you'll be asked to enter a signing " & "password. Please note that this password is local to the current " & "machine and you can change it at any time." echo "" var password = block: let prompt = "Please enter a password: " let confirm = "Please repeat the password: " ? keyboardCreatePassword(prompt, confirm) defer: burnMem(password) var name: WalletName let outWalletName = config.outWalletName if outWalletName.isSome: name = outWalletName.get else: echoP "For your convenience, the wallet can be identified with a name " & "of your choice. Please enter a wallet name below or press ENTER " & "to continue with a machine-generated name." echo "" while true: let enteredName = ask "Wallet name" if enteredName.len > 0: name = try: WalletName.parseCmdArg(enteredName) except CatchableError as err: echo err.msg & ". Please try again." continue break let nextAccount = if config.cmd == wallets and config.walletsCmd == WalletsCmd.restore: config.restoredDepositsCount else: none Natural let wallet = createWallet(kdfPbkdf2, rng, seed, name = name, nextAccount = nextAccount, password = KeystorePass.init password) let outWalletFileFlag = config.outWalletFile let outWalletFile = if outWalletFileFlag.isSome: string outWalletFileFlag.get else: config.walletsDir / addFileExt(string wallet.name, "json") let status = saveWallet(wallet, outWalletFile) if status.isErr: return err("failure to create wallet file due to " & status.error) echo "\nWallet file successfully written to \"", outWalletFile, "\"" return ok WalletPathPair(wallet: wallet, path: outWalletFile) when defined(windows): proc clearScreen = discard execShellCmd("cls") else: template clearScreen = echo "\e[1;1H\e[2J\e[3J" proc createWalletInteractively*( rng: var HmacDrbgContext, config: BeaconNodeConf): Result[CreatedWallet, string] = if config.nonInteractive: return err "not running in interactive mode" echoP "The generated wallet is uniquely identified by a seed phrase " & "consisting of 24 words. In case you lose your wallet and you " & "need to restore it on a different machine, you can use the " & "seed phrase to re-generate your signing and withdrawal keys." echoP "The seed phrase should be kept secret in a safe location as if " & "you are protecting a sensitive password. It can be used to withdraw " & "funds from your wallet." echoP "We will display the seed phrase on the next screen. Please make sure " & "you are in a safe environment and there are no cameras or potentially " & "unwanted eye witnesses around you. Please prepare everything necessary " & "to copy the seed phrase to a safe location and type 'continue' in " & "the prompt below to proceed to the next screen or 'q' to exit now." echo "" while true: let answer = ask "Action" if answer.len > 0 and answer[0] == 'q': quit 1 if answer == "continue": break echoP "To proceed to your seed phrase, please type 'continue' (without the quotes). " & "Type 'q' to exit now." echo "" var mnemonic = generateMnemonic(rng) defer: burnMem(mnemonic) try: echoP "Your seed phrase is:" setStyleNoError({styleBright}) setForegroundColorNoError fgCyan echoP $mnemonic resetAttributesNoError() except IOError, ValueError: return err "failure to write to the standard output" echoP "Press any key to continue." try: discard getch() except IOError as err: fatal "Failed to read a key from stdin", err = err.msg quit 1 clearScreen() echoP "To confirm that you've saved the seed phrase, please enter the " & "first and the last three words of it. In case you've saved the " & "seek phrase in your clipboard, we strongly advice clearing the " & "clipboard now." echo "" for i in countdown(2, 0): let answer = ask "Answer" let parts = answer.split(' ', maxsplit = 1) if parts.len == 2: if count(parts[1], ' ') == 2 and mnemonic.string.startsWith(parts[0]) and mnemonic.string.endsWith(parts[1]): break else: doAssert parts.len == 1 if i > 0: echo "\nYour answer was not correct. You have ", i, " more attempts" echoP "Please enter 4 words separated with a single space " & "(the first word from the seed phrase, followed by the last 3)" echo "" else: quit 1 clearScreen() var mnenomicPassword = KeystorePass.init "" defer: burnMem(mnenomicPassword) echoP "The recovery of your wallet can be additionally protected by a" & "recovery password. Since the seed phrase itself can be considered " & "a password, setting such an additional password is optional. " & "To ensure the strongest possible security, we recommend writing " & "down your seed phrase and remembering your recovery password. " & "If you don't want to set a recovery password, just press ENTER." var recoveryPassword = keyboardCreatePassword( "Recovery password: ", "Confirm password: ", allowEmpty = true) defer: if recoveryPassword.isOk: burnMem(recoveryPassword.get) if recoveryPassword.isErr: fatal "Failed to read password from stdin: " quit 1 var keystorePass = KeystorePass.init recoveryPassword.get defer: burnMem(keystorePass) var seed = getSeed(mnemonic, keystorePass) defer: burnMem(seed) let walletPath = ? pickPasswordAndSaveWallet(rng, config, seed) return ok CreatedWallet(walletPath: walletPath, seed: seed) proc restoreWalletInteractively*(rng: var HmacDrbgContext, config: BeaconNodeConf) = var enteredMnemonic: string validatedMnemonic: Mnemonic defer: burnMem enteredMnemonic burnMem validatedMnemonic echo "To restore your wallet, please enter your backed-up seed phrase." while true: if not readPasswordInput("Seedphrase: ", enteredMnemonic): fatal "failure to read password from stdin" quit 1 if validateMnemonic(enteredMnemonic, validatedMnemonic): break else: echo "The entered mnemonic was not valid. Please try again." echoP "If your seed phrase was protected with a recovery password, " & "please enter it below. Please ENTER to attempt to restore " & "the wallet without a recovery password." var recoveryPassword = keyboardCreatePassword( "Recovery password: ", "Confirm password: ", allowEmpty = true) defer: if recoveryPassword.isOk: burnMem(recoveryPassword.get) if recoveryPassword.isErr: fatal "Failed to read password from stdin" quit 1 var keystorePass = KeystorePass.init recoveryPassword.get defer: burnMem(keystorePass) var seed = getSeed(validatedMnemonic, keystorePass) defer: burnMem(seed) discard pickPasswordAndSaveWallet(rng, config, seed) proc unlockWalletInteractively*(wallet: Wallet): Result[KeySeed, string] = echo "Please enter the password for unlocking the wallet" let res = keyboardGetPassword[KeySeed]("Password: ", 3, proc (password: string): KsResult[KeySeed] = var secret: seq[byte] defer: burnMem(secret) let status = decryptCryptoField(wallet.crypto, KeystorePass.init password, secret) case status of DecryptionStatus.Success: ok(KeySeed secret) else: # TODO Handle InvalidKeystore in a special way here let failed = "Unlocking of the wallet failed. Please try again" echo failed err(failed) ) if res.isOk(): ok(res.get()) else: err "Unlocking of the wallet failed." proc loadWallet*(fileName: string): Result[Wallet, string] = try: ok Json.loadFile(fileName, Wallet) except SerializationError as err: err "Invalid wallet syntax: " & err.formatMsg(fileName) except IOError as err: err "Error accessing wallet file \"" & fileName & "\": " & err.msg proc findWallet*(config: BeaconNodeConf, name: WalletName): Result[Opt[WalletPathPair], string] = var walletFiles = newSeq[string]() try: for kind, walletFile in walkDir(config.walletsDir): if kind != pcFile: continue let walletId = splitFile(walletFile).name if cmpIgnoreCase(walletId, name.string) == 0: let wallet = ? loadWallet(walletFile) return ok Opt.some WalletPathPair(wallet: wallet, path: walletFile) walletFiles.add walletFile except OSError as err: return err("Error accessing the wallets directory \"" & config.walletsDir & "\": " & err.msg) for walletFile in walletFiles: let wallet = ? loadWallet(walletFile) if cmpIgnoreCase(wallet.name.string, name.string) == 0 or cmpIgnoreCase(wallet.uuid.string, name.string) == 0: return ok Opt.some WalletPathPair(wallet: wallet, path: walletFile) return ok Opt.none(WalletPathPair) type # This is not particularly well-standardized yet. # Some relevant code for generating (1) and validating (2) the data can be found below: # 1) https://github.com/ethereum/eth2.0-deposit-cli/blob/dev/eth2deposit/credentials.py # 2) https://github.com/ethereum/eth2.0-deposit/blob/dev/src/pages/UploadValidator/validateDepositKey.ts LaunchPadDeposit* = object pubkey*: ValidatorPubKey withdrawal_credentials*: Eth2Digest amount*: Gwei signature*: ValidatorSig deposit_message_root*: Eth2Digest deposit_data_root*: Eth2Digest fork_version*: Version func init*(T: type LaunchPadDeposit, cfg: RuntimeConfig, d: DepositData): T = T(pubkey: d.pubkey, withdrawal_credentials: d.withdrawal_credentials, amount: d.amount, signature: d.signature, deposit_message_root: hash_tree_root(d as DepositMessage), deposit_data_root: hash_tree_root(d), fork_version: cfg.GENESIS_FORK_VERSION) func `as`*(copied: LaunchPadDeposit, T: type DepositData): T = T(pubkey: copied.pubkey, withdrawal_credentials: copied.withdrawal_credentials, amount: copied.amount, signature: copied.signature)