287 lines
12 KiB
JavaScript
287 lines
12 KiB
JavaScript
/**
|
|
* The JSON Wallet formats allow a simple way to store the private
|
|
* keys needed in Ethereum along with related information and allows
|
|
* for extensible forms of encryption.
|
|
*
|
|
* These utilities facilitate decrypting and encrypting the most common
|
|
* JSON Wallet formats.
|
|
*
|
|
* @_subsection: api/wallet:JSON Wallets [json-wallets]
|
|
*/
|
|
import { CTR } from "aes-js";
|
|
import { getAddress } from "../address/index.js";
|
|
import { keccak256, pbkdf2, randomBytes, scrypt, scryptSync } from "../crypto/index.js";
|
|
import { computeAddress } from "../transaction/index.js";
|
|
import { concat, getBytes, hexlify, uuidV4, assert, assertArgument } from "../utils/index.js";
|
|
import { getPassword, spelunk, zpad } from "./utils.js";
|
|
import { version } from "../_version.js";
|
|
const defaultPath = "m/44'/60'/0'/0/0";
|
|
/**
|
|
* Returns true if %%json%% is a valid JSON Keystore Wallet.
|
|
*/
|
|
export function isKeystoreJson(json) {
|
|
try {
|
|
const data = JSON.parse(json);
|
|
const version = ((data.version != null) ? parseInt(data.version) : 0);
|
|
if (version === 3) {
|
|
return true;
|
|
}
|
|
}
|
|
catch (error) { }
|
|
return false;
|
|
}
|
|
function decrypt(data, key, ciphertext) {
|
|
const cipher = spelunk(data, "crypto.cipher:string");
|
|
if (cipher === "aes-128-ctr") {
|
|
const iv = spelunk(data, "crypto.cipherparams.iv:data!");
|
|
const aesCtr = new CTR(key, iv);
|
|
return hexlify(aesCtr.decrypt(ciphertext));
|
|
}
|
|
assert(false, "unsupported cipher", "UNSUPPORTED_OPERATION", {
|
|
operation: "decrypt"
|
|
});
|
|
}
|
|
function getAccount(data, _key) {
|
|
const key = getBytes(_key);
|
|
const ciphertext = spelunk(data, "crypto.ciphertext:data!");
|
|
const computedMAC = hexlify(keccak256(concat([key.slice(16, 32), ciphertext]))).substring(2);
|
|
assertArgument(computedMAC === spelunk(data, "crypto.mac:string!").toLowerCase(), "incorrect password", "password", "[ REDACTED ]");
|
|
const privateKey = decrypt(data, key.slice(0, 16), ciphertext);
|
|
const address = computeAddress(privateKey);
|
|
if (data.address) {
|
|
let check = data.address.toLowerCase();
|
|
if (check.substring(0, 2) !== "0x") {
|
|
check = "0x" + check;
|
|
}
|
|
assertArgument(getAddress(check) === address, "keystore address/privateKey mismatch", "address", data.address);
|
|
}
|
|
const account = { address, privateKey };
|
|
// Version 0.1 x-ethers metadata must contain an encrypted mnemonic phrase
|
|
const version = spelunk(data, "x-ethers.version:string");
|
|
if (version === "0.1") {
|
|
const mnemonicKey = key.slice(32, 64);
|
|
const mnemonicCiphertext = spelunk(data, "x-ethers.mnemonicCiphertext:data!");
|
|
const mnemonicIv = spelunk(data, "x-ethers.mnemonicCounter:data!");
|
|
const mnemonicAesCtr = new CTR(mnemonicKey, mnemonicIv);
|
|
account.mnemonic = {
|
|
path: (spelunk(data, "x-ethers.path:string") || defaultPath),
|
|
locale: (spelunk(data, "x-ethers.locale:string") || "en"),
|
|
entropy: hexlify(getBytes(mnemonicAesCtr.decrypt(mnemonicCiphertext)))
|
|
};
|
|
}
|
|
return account;
|
|
}
|
|
function getDecryptKdfParams(data) {
|
|
const kdf = spelunk(data, "crypto.kdf:string");
|
|
if (kdf && typeof (kdf) === "string") {
|
|
if (kdf.toLowerCase() === "scrypt") {
|
|
const salt = spelunk(data, "crypto.kdfparams.salt:data!");
|
|
const N = spelunk(data, "crypto.kdfparams.n:int!");
|
|
const r = spelunk(data, "crypto.kdfparams.r:int!");
|
|
const p = spelunk(data, "crypto.kdfparams.p:int!");
|
|
// Make sure N is a power of 2
|
|
assertArgument(N > 0 && (N & (N - 1)) === 0, "invalid kdf.N", "kdf.N", N);
|
|
assertArgument(r > 0 && p > 0, "invalid kdf", "kdf", kdf);
|
|
const dkLen = spelunk(data, "crypto.kdfparams.dklen:int!");
|
|
assertArgument(dkLen === 32, "invalid kdf.dklen", "kdf.dflen", dkLen);
|
|
return { name: "scrypt", salt, N, r, p, dkLen: 64 };
|
|
}
|
|
else if (kdf.toLowerCase() === "pbkdf2") {
|
|
const salt = spelunk(data, "crypto.kdfparams.salt:data!");
|
|
const prf = spelunk(data, "crypto.kdfparams.prf:string!");
|
|
const algorithm = prf.split("-").pop();
|
|
assertArgument(algorithm === "sha256" || algorithm === "sha512", "invalid kdf.pdf", "kdf.pdf", prf);
|
|
const count = spelunk(data, "crypto.kdfparams.c:int!");
|
|
const dkLen = spelunk(data, "crypto.kdfparams.dklen:int!");
|
|
assertArgument(dkLen === 32, "invalid kdf.dklen", "kdf.dklen", dkLen);
|
|
return { name: "pbkdf2", salt, count, dkLen, algorithm };
|
|
}
|
|
}
|
|
assertArgument(false, "unsupported key-derivation function", "kdf", kdf);
|
|
}
|
|
/**
|
|
* Returns the account details for the JSON Keystore Wallet %%json%%
|
|
* using %%password%%.
|
|
*
|
|
* It is preferred to use the [async version](decryptKeystoreJson)
|
|
* instead, which allows a [[ProgressCallback]] to keep the user informed
|
|
* as to the decryption status.
|
|
*
|
|
* This method will block the event loop (freezing all UI) until decryption
|
|
* is complete, which can take quite some time, depending on the wallet
|
|
* paramters and platform.
|
|
*/
|
|
export function decryptKeystoreJsonSync(json, _password) {
|
|
const data = JSON.parse(json);
|
|
const password = getPassword(_password);
|
|
const params = getDecryptKdfParams(data);
|
|
if (params.name === "pbkdf2") {
|
|
const { salt, count, dkLen, algorithm } = params;
|
|
const key = pbkdf2(password, salt, count, dkLen, algorithm);
|
|
return getAccount(data, key);
|
|
}
|
|
assert(params.name === "scrypt", "cannot be reached", "UNKNOWN_ERROR", { params });
|
|
const { salt, N, r, p, dkLen } = params;
|
|
const key = scryptSync(password, salt, N, r, p, dkLen);
|
|
return getAccount(data, key);
|
|
}
|
|
function stall(duration) {
|
|
return new Promise((resolve) => { setTimeout(() => { resolve(); }, duration); });
|
|
}
|
|
/**
|
|
* Resolves to the decrypted JSON Keystore Wallet %%json%% using the
|
|
* %%password%%.
|
|
*
|
|
* If provided, %%progress%% will be called periodically during the
|
|
* decrpytion to provide feedback, and if the function returns
|
|
* ``false`` will halt decryption.
|
|
*
|
|
* The %%progressCallback%% will **always** receive ``0`` before
|
|
* decryption begins and ``1`` when complete.
|
|
*/
|
|
export async function decryptKeystoreJson(json, _password, progress) {
|
|
const data = JSON.parse(json);
|
|
const password = getPassword(_password);
|
|
const params = getDecryptKdfParams(data);
|
|
if (params.name === "pbkdf2") {
|
|
if (progress) {
|
|
progress(0);
|
|
await stall(0);
|
|
}
|
|
const { salt, count, dkLen, algorithm } = params;
|
|
const key = pbkdf2(password, salt, count, dkLen, algorithm);
|
|
if (progress) {
|
|
progress(1);
|
|
await stall(0);
|
|
}
|
|
return getAccount(data, key);
|
|
}
|
|
assert(params.name === "scrypt", "cannot be reached", "UNKNOWN_ERROR", { params });
|
|
const { salt, N, r, p, dkLen } = params;
|
|
const key = await scrypt(password, salt, N, r, p, dkLen, progress);
|
|
return getAccount(data, key);
|
|
}
|
|
function getEncryptKdfParams(options) {
|
|
// Check/generate the salt
|
|
const salt = (options.salt != null) ? getBytes(options.salt, "options.salt") : randomBytes(32);
|
|
// Override the scrypt password-based key derivation function parameters
|
|
let N = (1 << 17), r = 8, p = 1;
|
|
if (options.scrypt) {
|
|
if (options.scrypt.N) {
|
|
N = options.scrypt.N;
|
|
}
|
|
if (options.scrypt.r) {
|
|
r = options.scrypt.r;
|
|
}
|
|
if (options.scrypt.p) {
|
|
p = options.scrypt.p;
|
|
}
|
|
}
|
|
assertArgument(typeof (N) === "number" && N > 0 && Number.isSafeInteger(N) && (BigInt(N) & BigInt(N - 1)) === BigInt(0), "invalid scrypt N parameter", "options.N", N);
|
|
assertArgument(typeof (r) === "number" && r > 0 && Number.isSafeInteger(r), "invalid scrypt r parameter", "options.r", r);
|
|
assertArgument(typeof (p) === "number" && p > 0 && Number.isSafeInteger(p), "invalid scrypt p parameter", "options.p", p);
|
|
return { name: "scrypt", dkLen: 32, salt, N, r, p };
|
|
}
|
|
function _encryptKeystore(key, kdf, account, options) {
|
|
const privateKey = getBytes(account.privateKey, "privateKey");
|
|
// Override initialization vector
|
|
const iv = (options.iv != null) ? getBytes(options.iv, "options.iv") : randomBytes(16);
|
|
assertArgument(iv.length === 16, "invalid options.iv length", "options.iv", options.iv);
|
|
// Override the uuid
|
|
const uuidRandom = (options.uuid != null) ? getBytes(options.uuid, "options.uuid") : randomBytes(16);
|
|
assertArgument(uuidRandom.length === 16, "invalid options.uuid length", "options.uuid", options.iv);
|
|
// This will be used to encrypt the wallet (as per Web3 secret storage)
|
|
// - 32 bytes As normal for the Web3 secret storage (derivedKey, macPrefix)
|
|
// - 32 bytes AES key to encrypt mnemonic with (required here to be Ethers Wallet)
|
|
const derivedKey = key.slice(0, 16);
|
|
const macPrefix = key.slice(16, 32);
|
|
// Encrypt the private key
|
|
const aesCtr = new CTR(derivedKey, iv);
|
|
const ciphertext = getBytes(aesCtr.encrypt(privateKey));
|
|
// Compute the message authentication code, used to check the password
|
|
const mac = keccak256(concat([macPrefix, ciphertext]));
|
|
// See: https://github.com/ethereum/wiki/wiki/Web3-Secret-Storage-Definition
|
|
const data = {
|
|
address: account.address.substring(2).toLowerCase(),
|
|
id: uuidV4(uuidRandom),
|
|
version: 3,
|
|
Crypto: {
|
|
cipher: "aes-128-ctr",
|
|
cipherparams: {
|
|
iv: hexlify(iv).substring(2),
|
|
},
|
|
ciphertext: hexlify(ciphertext).substring(2),
|
|
kdf: "scrypt",
|
|
kdfparams: {
|
|
salt: hexlify(kdf.salt).substring(2),
|
|
n: kdf.N,
|
|
dklen: 32,
|
|
p: kdf.p,
|
|
r: kdf.r
|
|
},
|
|
mac: mac.substring(2)
|
|
}
|
|
};
|
|
// If we have a mnemonic, encrypt it into the JSON wallet
|
|
if (account.mnemonic) {
|
|
const client = (options.client != null) ? options.client : `ethers/${version}`;
|
|
const path = account.mnemonic.path || defaultPath;
|
|
const locale = account.mnemonic.locale || "en";
|
|
const mnemonicKey = key.slice(32, 64);
|
|
const entropy = getBytes(account.mnemonic.entropy, "account.mnemonic.entropy");
|
|
const mnemonicIv = randomBytes(16);
|
|
const mnemonicAesCtr = new CTR(mnemonicKey, mnemonicIv);
|
|
const mnemonicCiphertext = getBytes(mnemonicAesCtr.encrypt(entropy));
|
|
const now = new Date();
|
|
const timestamp = (now.getUTCFullYear() + "-" +
|
|
zpad(now.getUTCMonth() + 1, 2) + "-" +
|
|
zpad(now.getUTCDate(), 2) + "T" +
|
|
zpad(now.getUTCHours(), 2) + "-" +
|
|
zpad(now.getUTCMinutes(), 2) + "-" +
|
|
zpad(now.getUTCSeconds(), 2) + ".0Z");
|
|
const gethFilename = ("UTC--" + timestamp + "--" + data.address);
|
|
data["x-ethers"] = {
|
|
client, gethFilename, path, locale,
|
|
mnemonicCounter: hexlify(mnemonicIv).substring(2),
|
|
mnemonicCiphertext: hexlify(mnemonicCiphertext).substring(2),
|
|
version: "0.1"
|
|
};
|
|
}
|
|
return JSON.stringify(data);
|
|
}
|
|
/**
|
|
* Return the JSON Keystore Wallet for %%account%% encrypted with
|
|
* %%password%%.
|
|
*
|
|
* The %%options%% can be used to tune the password-based key
|
|
* derivation function parameters, explicitly set the random values
|
|
* used. Any provided [[ProgressCallback]] is ignord.
|
|
*/
|
|
export function encryptKeystoreJsonSync(account, password, options) {
|
|
if (options == null) {
|
|
options = {};
|
|
}
|
|
const passwordBytes = getPassword(password);
|
|
const kdf = getEncryptKdfParams(options);
|
|
const key = scryptSync(passwordBytes, kdf.salt, kdf.N, kdf.r, kdf.p, 64);
|
|
return _encryptKeystore(getBytes(key), kdf, account, options);
|
|
}
|
|
/**
|
|
* Resolved to the JSON Keystore Wallet for %%account%% encrypted
|
|
* with %%password%%.
|
|
*
|
|
* The %%options%% can be used to tune the password-based key
|
|
* derivation function parameters, explicitly set the random values
|
|
* used and provide a [[ProgressCallback]] to receive periodic updates
|
|
* on the completion status..
|
|
*/
|
|
export async function encryptKeystoreJson(account, password, options) {
|
|
if (options == null) {
|
|
options = {};
|
|
}
|
|
const passwordBytes = getPassword(password);
|
|
const kdf = getEncryptKdfParams(options);
|
|
const key = await scrypt(passwordBytes, kdf.salt, kdf.N, kdf.r, kdf.p, 64, options.progressCallback);
|
|
return _encryptKeystore(getBytes(key), kdf, account, options);
|
|
}
|
|
//# sourceMappingURL=json-keystore.js.map
|