[zk-keygen] create cli utility and add `new` command (#31641)
* create `solana-zk-keygen` cli util * add `new` key generation command * add basic tests * add Cargo.toml for `zk-keygen` * replace `KeyType::Symmetric` to `KeyType::Aes128` and update crate description * remove shortopts for key type * use stderr for status update * add clap `debug_assert` tests * drop all shortopts * drop unnecessary tests * remove config file args since it is not needed * Update zk-keygen/src/main.rs Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com> * clippy * add shortopt for `outfile` * move `silent` match to outer scope * change `--key-type` arg to `--type` * Update zk-keygen/Cargo.toml Co-authored-by: Tyera <teulberg@gmail.com> --------- Co-authored-by: Trent Nelson <trent.a.b.nelson@gmail.com> Co-authored-by: Tyera <teulberg@gmail.com>
This commit is contained in:
samkim-crypto
GitHub
parent
83f692ce67
commit
fd69ae77ff
|
|
@ -7061,6 +7061,24 @@ dependencies = [
|
|||
"solana-version",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "solana-zk-keygen"
|
||||
version = "1.16.0"
|
||||
dependencies = [
|
||||
"bs58",
|
||||
"clap 3.2.23",
|
||||
"dirs-next",
|
||||
"num_cpus",
|
||||
"solana-clap-v3-utils",
|
||||
"solana-cli-config",
|
||||
"solana-remote-wallet",
|
||||
"solana-sdk 1.16.0",
|
||||
"solana-version",
|
||||
"solana-zk-token-sdk 1.16.0",
|
||||
"tempfile",
|
||||
"tiny-bip39",
|
||||
]
|
||||
|
||||
[[package]]
|
||||
name = "solana-zk-token-proof-program"
|
||||
version = "1.16.0"
|
||||
|
|
|
|||
|
|
@ -102,6 +102,7 @@ members = [
|
|||
"validator",
|
||||
"version",
|
||||
"watchtower",
|
||||
"zk-keygen",
|
||||
"zk-token-sdk",
|
||||
]
|
||||
|
||||
|
|
@ -356,6 +357,7 @@ solana-transaction-status = { path = "transaction-status", version = "=1.16.0" }
|
|||
solana-udp-client = { path = "udp-client", version = "=1.16.0" }
|
||||
solana-version = { path = "version", version = "=1.16.0" }
|
||||
solana-vote-program = { path = "programs/vote", version = "=1.16.0" }
|
||||
solana-zk-keygen = { path = "zk-keygen", version = "=1.16.0" }
|
||||
solana-zk-token-proof-program = { path = "programs/zk-token-proof", version = "=1.16.0" }
|
||||
solana-zk-token-sdk = { path = "zk-token-sdk", version = "=1.16.0" }
|
||||
spl-associated-token-account = "=1.1.3"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,39 @@
|
|||
[package]
|
||||
name = "solana-zk-keygen"
|
||||
description = """
|
||||
Solana privacy-related key generation utility
|
||||
|
||||
The tool currently supports two types of encryption keys that are used in the SPL Token-2022 program:
|
||||
- ElGamal keypair that can be used for public key encryption
|
||||
- AES128 key that can be used for an authenticated symmetric encryption (e.g. AES-GCM-SIV)
|
||||
"""
|
||||
publish = false
|
||||
version = { workspace = true }
|
||||
authors = { workspace = true }
|
||||
repository = { workspace = true }
|
||||
homepage = { workspace = true }
|
||||
license = { workspace = true }
|
||||
edition = { workspace = true }
|
||||
|
||||
[dependencies]
|
||||
bs58 = { workspace = true }
|
||||
clap = { version = "3.1.5", features = ["cargo", "derive"] }
|
||||
dirs-next = { workspace = true }
|
||||
num_cpus = { workspace = true }
|
||||
solana-clap-v3-utils = { workspace = true }
|
||||
solana-cli-config = { workspace = true }
|
||||
solana-remote-wallet = { workspace = true, features = ["default"] }
|
||||
solana-sdk = { workspace = true }
|
||||
solana-version = { workspace = true }
|
||||
solana-zk-token-sdk = { workspace = true }
|
||||
tiny-bip39 = { workspace = true }
|
||||
|
||||
[dev-dependencies]
|
||||
tempfile = { workspace = true }
|
||||
|
||||
[[bin]]
|
||||
name = "solana-zk-keygen"
|
||||
path = "src/main.rs"
|
||||
|
||||
[package.metadata.docs.rs]
|
||||
targets = ["x86_64-unknown-linux-gnu"]
|
||||
|
|
@ -0,0 +1,299 @@
|
|||
use {
|
||||
bip39::{Mnemonic, MnemonicType, Seed},
|
||||
clap::{crate_description, crate_name, Arg, ArgMatches, Command},
|
||||
solana_clap_v3_utils::{
|
||||
input_parsers::STDOUT_OUTFILE_TOKEN,
|
||||
keygen::{
|
||||
check_for_overwrite,
|
||||
mnemonic::{acquire_language, acquire_passphrase_and_message, WORD_COUNT_ARG},
|
||||
no_outfile_arg, KeyGenerationCommonArgs, NO_OUTFILE_ARG,
|
||||
},
|
||||
DisplayError,
|
||||
},
|
||||
solana_sdk::signer::EncodableKey,
|
||||
solana_zk_token_sdk::encryption::{auth_encryption::AeKey, elgamal::ElGamalKeypair},
|
||||
std::error,
|
||||
};
|
||||
|
||||
fn output_encodable_key<K: EncodableKey>(
|
||||
key: &K,
|
||||
outfile: &str,
|
||||
source: &str,
|
||||
) -> Result<(), Box<dyn error::Error>> {
|
||||
if outfile == STDOUT_OUTFILE_TOKEN {
|
||||
let mut stdout = std::io::stdout();
|
||||
key.write(&mut stdout)?;
|
||||
} else {
|
||||
key.write_to_file(outfile)?;
|
||||
println!("Wrote {source} to {outfile}");
|
||||
}
|
||||
Ok(())
|
||||
}
|
||||
|
||||
fn app(crate_version: &str) -> Command {
|
||||
Command::new(crate_name!())
|
||||
.about(crate_description!())
|
||||
.version(crate_version)
|
||||
.subcommand_required(true)
|
||||
.arg_required_else_help(true)
|
||||
.subcommand(
|
||||
Command::new("new")
|
||||
.about("Generate a new encryption key/keypair file from a random seed phrase and optional BIP39 passphrase")
|
||||
.disable_version_flag(true)
|
||||
.arg(
|
||||
Arg::new("type")
|
||||
.long("type")
|
||||
.takes_value(true)
|
||||
.possible_values(["elgamal", "aes128"])
|
||||
.value_name("TYPE")
|
||||
.required(true)
|
||||
.help("The type of encryption key")
|
||||
)
|
||||
.arg(
|
||||
Arg::new("outfile")
|
||||
.short('o')
|
||||
.long("outfile")
|
||||
.value_name("FILEPATH")
|
||||
.takes_value(true)
|
||||
.help("Path to generated file"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("force")
|
||||
.long("force")
|
||||
.help("Overwrite the output file if it exists"),
|
||||
)
|
||||
.arg(
|
||||
Arg::new("silent")
|
||||
.long("silent")
|
||||
.help("Do not display seed phrase. Useful when piping output to other programs that prompt for user input, like gpg"),
|
||||
)
|
||||
.key_generation_common_args()
|
||||
.arg(no_outfile_arg().conflicts_with_all(&["outfile", "silent"]))
|
||||
)
|
||||
}
|
||||
|
||||
fn main() -> Result<(), Box<dyn error::Error>> {
|
||||
let matches = app(solana_version::version!())
|
||||
.try_get_matches()
|
||||
.unwrap_or_else(|e| e.exit());
|
||||
do_main(&matches).map_err(|err| DisplayError::new_as_boxed(err).into())
|
||||
}
|
||||
|
||||
fn do_main(matches: &ArgMatches) -> Result<(), Box<dyn error::Error>> {
|
||||
let subcommand = matches.subcommand().unwrap();
|
||||
match subcommand {
|
||||
("new", matches) => {
|
||||
let key_type = match matches.value_of("type").unwrap() {
|
||||
"elgamal" => KeyType::ElGamal,
|
||||
"aes128" => KeyType::Aes128,
|
||||
_ => unreachable!(),
|
||||
};
|
||||
|
||||
let mut path = dirs_next::home_dir().expect("home directory");
|
||||
let outfile = if matches.is_present("outfile") {
|
||||
matches.value_of("outfile")
|
||||
} else if matches.is_present(NO_OUTFILE_ARG.name) {
|
||||
None
|
||||
} else {
|
||||
path.extend([".config", "solana", key_type.default_file_name()]);
|
||||
Some(path.to_str().unwrap())
|
||||
};
|
||||
|
||||
match outfile {
|
||||
Some(STDOUT_OUTFILE_TOKEN) => (),
|
||||
Some(outfile) => check_for_overwrite(outfile, matches)?,
|
||||
None => (),
|
||||
}
|
||||
|
||||
let word_count: usize = matches.value_of_t(WORD_COUNT_ARG.name).unwrap();
|
||||
let mnemonic_type = MnemonicType::for_word_count(word_count)?;
|
||||
let language = acquire_language(matches);
|
||||
|
||||
let mnemonic = Mnemonic::new(mnemonic_type, language);
|
||||
let (passphrase, passphrase_message) = acquire_passphrase_and_message(matches).unwrap();
|
||||
let seed = Seed::new(&mnemonic, &passphrase);
|
||||
|
||||
let silent = matches.is_present("silent");
|
||||
|
||||
match key_type {
|
||||
KeyType::ElGamal => {
|
||||
if !silent {
|
||||
eprintln!("Generating a new ElGamal keypair");
|
||||
}
|
||||
|
||||
let elgamal_keypair = ElGamalKeypair::from_seed(seed.as_bytes())?;
|
||||
if let Some(outfile) = outfile {
|
||||
output_encodable_key(&elgamal_keypair, outfile, "new ElGamal keypair")
|
||||
.map_err(|err| format!("Unable to write {outfile}: {err}"))?;
|
||||
}
|
||||
|
||||
if !silent {
|
||||
let phrase: &str = mnemonic.phrase();
|
||||
let divider = String::from_utf8(vec![b'='; phrase.len()]).unwrap();
|
||||
println!(
|
||||
"{}\npubkey: {}\n{}\nSave this seed phrase{} to recover your new ElGamal keypair:\n{}\n{}",
|
||||
÷r, elgamal_keypair.public, ÷r, passphrase_message, phrase, ÷r
|
||||
);
|
||||
}
|
||||
}
|
||||
KeyType::Aes128 => {
|
||||
if !silent {
|
||||
eprintln!("Generating a new AES128 encryption key");
|
||||
}
|
||||
|
||||
let aes_key = AeKey::from_seed(seed.as_bytes())?;
|
||||
if let Some(outfile) = outfile {
|
||||
output_encodable_key(&aes_key, outfile, "new AES128 key")
|
||||
.map_err(|err| format!("Unable to write {outfile}: {err}"))?;
|
||||
}
|
||||
|
||||
if !silent {
|
||||
let phrase: &str = mnemonic.phrase();
|
||||
let divider = String::from_utf8(vec![b'='; phrase.len()]).unwrap();
|
||||
println!(
|
||||
"{}\nSave this seed phrase{} to recover your new AES128 key:\n{}\n{}",
|
||||
÷r, passphrase_message, phrase, ÷r
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
_ => unreachable!(),
|
||||
}
|
||||
|
||||
Ok(())
|
||||
}
|
||||
|
||||
enum KeyType {
|
||||
ElGamal,
|
||||
Aes128,
|
||||
}
|
||||
|
||||
impl KeyType {
|
||||
fn default_file_name(&self) -> &str {
|
||||
match self {
|
||||
KeyType::ElGamal => "elgamal.json",
|
||||
KeyType::Aes128 => "aes128.json",
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use {
|
||||
super::*,
|
||||
solana_sdk::pubkey::Pubkey,
|
||||
tempfile::{tempdir, TempDir},
|
||||
};
|
||||
|
||||
fn process_test_command(args: &[&str]) -> Result<(), Box<dyn error::Error>> {
|
||||
let solana_version = solana_version::version!();
|
||||
let app_matches = app(solana_version).get_matches_from(args);
|
||||
do_main(&app_matches)
|
||||
}
|
||||
|
||||
fn tmp_outfile_path(out_dir: &TempDir, name: &str) -> String {
|
||||
let path = out_dir.path().join(name);
|
||||
path.into_os_string().into_string().unwrap()
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_arguments() {
|
||||
let solana_version = solana_version::version!();
|
||||
|
||||
// run clap internal assert statements
|
||||
app(solana_version).debug_assert();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_new_elgamal() {
|
||||
let outfile_dir = tempdir().unwrap();
|
||||
// use `Pubkey::new_unique()` to generate names for temporary key files
|
||||
let outfile_path = tmp_outfile_path(&outfile_dir, &Pubkey::new_unique().to_string());
|
||||
|
||||
// general success case
|
||||
process_test_command(&[
|
||||
"solana-zk-keygen",
|
||||
"new",
|
||||
"--type",
|
||||
"elgamal",
|
||||
"--outfile",
|
||||
&outfile_path,
|
||||
"--no-bip39-passphrase",
|
||||
])
|
||||
.unwrap();
|
||||
|
||||
// refuse to overwrite file
|
||||
let result = process_test_command(&[
|
||||
"solana-zk-keygen",
|
||||
"new",
|
||||
"--type",
|
||||
"elgamal",
|
||||
"--outfile",
|
||||
&outfile_path,
|
||||
"--no-bip39-passphrase",
|
||||
])
|
||||
.unwrap_err()
|
||||
.to_string();
|
||||
|
||||
let expected = format!("Refusing to overwrite {outfile_path} without --force flag");
|
||||
assert_eq!(result, expected);
|
||||
|
||||
// no outfile
|
||||
process_test_command(&[
|
||||
"solana-keygen",
|
||||
"new",
|
||||
"--type",
|
||||
"elgamal",
|
||||
"--no-bip39-passphrase",
|
||||
"--no-outfile",
|
||||
])
|
||||
.unwrap();
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn test_new_aes128() {
|
||||
let outfile_dir = tempdir().unwrap();
|
||||
// use `Pubkey::new_unique()` to generate names for temporary key files
|
||||
let outfile_path = tmp_outfile_path(&outfile_dir, &Pubkey::new_unique().to_string());
|
||||
|
||||
// general success case
|
||||
process_test_command(&[
|
||||
"solana-zk-keygen",
|
||||
"new",
|
||||
"--type",
|
||||
"aes128",
|
||||
"--outfile",
|
||||
&outfile_path,
|
||||
"--no-bip39-passphrase",
|
||||
])
|
||||
.unwrap();
|
||||
|
||||
// refuse to overwrite file
|
||||
let result = process_test_command(&[
|
||||
"solana-zk-keygen",
|
||||
"new",
|
||||
"--type",
|
||||
"aes128",
|
||||
"--outfile",
|
||||
&outfile_path,
|
||||
"--no-bip39-passphrase",
|
||||
])
|
||||
.unwrap_err()
|
||||
.to_string();
|
||||
|
||||
let expected = format!("Refusing to overwrite {outfile_path} without --force flag");
|
||||
assert_eq!(result, expected);
|
||||
|
||||
// no outfile
|
||||
process_test_command(&[
|
||||
"solana-keygen",
|
||||
"new",
|
||||
"--type",
|
||||
"aes128",
|
||||
"--no-bip39-passphrase",
|
||||
"--no-outfile",
|
||||
])
|
||||
.unwrap();
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue