Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!(iota): remove KeyToolCommand::{LoadKeypair, Unpack} #3223

Merged
merged 4 commits into from
Oct 29, 2024
Merged

feat!(iota): remove KeyToolCommand::{LoadKeypair, Unpack} #3223

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3b201ea
feat!(iota): remove KeyToolCommand::LoadKeypair
Thoralf-M Oct 11, 2024
35085a1
Remove unused struct KeypairData
Thoralf-M Oct 14, 2024
11d09e1
feat!(iota): remove KeyToolCommand::Unpack
Thoralf-M Oct 29, 2024
028fe0e
Merge branch 'develop' into dev-tools/remove-keytool-loadKeypair
thibault-martinez Oct 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 2 additions & 71 deletions crates/iota/src/keytool.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@

use std::{
fmt::{Debug, Display, Formatter},
fs,
path::{Path, PathBuf},
path::PathBuf,
sync::Arc,
};

Expand Down Expand Up @@ -150,12 +149,6 @@ pub enum KeyToolCommand {
#[clap(long, short = 's')]
sort_by_alias: bool,
},
/// This reads the content at the provided file path. The accepted format
/// is a Bech32 encoded [enum IotaKeyPair] or `type AuthorityKeyPair`
/// (Base64 encoded `privkey`). This prints out the account keypair as
/// Base64 encoded `flag || privkey`, the network keypair, protocol
/// keypair, authority keypair as Base64 encoded `privkey`.
LoadKeypair { file: PathBuf },
/// To MultiSig Iota Address. Pass in a list of all public keys `flag || pk`
/// in Base64. See `keytool list` for example public keys.
MultiSigAddress {
Expand Down Expand Up @@ -220,11 +213,6 @@ pub enum KeyToolCommand {
#[clap(long)]
base64pk: String,
},
/// This takes a bech32 encoded [enum IotaKeyPair]. It outputs the keypair
/// into a file at the current directory where the address is the
/// filename, and prints out its Iota address, Base64 encoded public
/// key, the key scheme, and the key scheme flag.
Unpack { keypair: String },
// Commented for now: https://github.com/iotaledger/iota/issues/1777
// /// Given the max_epoch, generate an OAuth url, ask user to paste the
// /// redirect with id_token, call salt server, then call the prover server,
Expand Down Expand Up @@ -356,15 +344,6 @@ pub struct ExportedKey {
key: Key,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct KeypairData {
account_keypair: String,
network_keypair: Option<String>,
protocol_keypair: Option<String>,
key_scheme: String,
}

#[derive(Serialize)]
#[serde(rename_all = "camelCase")]
pub struct MultiSigAddress {
Expand Down Expand Up @@ -456,7 +435,6 @@ pub enum CommandOutput {
Import(Key),
Export(ExportedKey),
List(Vec<Key>),
LoadKeypair(KeypairData),
MultiSigAddress(MultiSigAddress),
MultiSigCombinePartialSig(MultiSigCombinePartialSig),
Show(Key),
Expand Down Expand Up @@ -665,44 +643,6 @@ impl KeyToolCommand {
}
CommandOutput::List(keys)
}
KeyToolCommand::LoadKeypair { file } => {
let output = match read_keypair_from_file(&file) {
Ok(keypair) => {
// Account keypair is encoded with the key scheme flag {},
// and network and protocol keypair are not.
let network_protocol_keypair = match &keypair {
IotaKeyPair::Ed25519(kp) => kp.encode_base64(),
IotaKeyPair::Secp256k1(kp) => kp.encode_base64(),
IotaKeyPair::Secp256r1(kp) => kp.encode_base64(),
};
KeypairData {
account_keypair: keypair.encode_base64(),
network_keypair: Some(network_protocol_keypair.clone()),
protocol_keypair: Some(network_protocol_keypair),
key_scheme: keypair.public().scheme().to_string(),
}
}
Err(_) => {
// Authority keypair file is not stored with the flag, it will try read as
// BLS keypair..
match read_authority_keypair_from_file(&file) {
Ok(keypair) => KeypairData {
account_keypair: keypair.encode_base64(),
network_keypair: None,
protocol_keypair: None,
key_scheme: SignatureScheme::BLS12381.to_string(),
},
Err(e) => {
return Err(anyhow!(format!(
"Failed to read keypair at path {:?} err: {:?}",
file, e
)));
}
}
}
};
CommandOutput::LoadKeypair(output)
}
KeyToolCommand::MultiSigAddress {
threshold,
pks,
Expand Down Expand Up @@ -854,16 +794,7 @@ impl KeyToolCommand {
serialized_sig_base64: serialized_sig,
})
}
KeyToolCommand::Unpack { keypair } => {
let key = Key::from(
&IotaKeyPair::decode(&keypair)
.map_err(|_| anyhow!("Invalid Bech32 encoded keypair"))?,
);
let path_str = format!("{}.key", key.iota_address).to_lowercase();
let path = Path::new(&path_str);
fs::write(path, keypair)?;
CommandOutput::Show(key)
} /* Commented for now: https://github.com/iotaledger/iota/issues/1777
/* Commented for now: https://github.com/iotaledger/iota/issues/1777
* KeyToolCommand::ZkLoginInsecureSignPersonalMessage { data, max_epoch } => {
* let msg = PersonalMessage {
* message: data.as_bytes().to_vec(),
Expand Down
5 changes: 0 additions & 5 deletions docs/content/references/cli/keytool.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,6 @@ Commands:
provided, the tool will automatically generate one
export Output the private key of the given key identity in Iota CLI Keystore as Bech32 encoded string starting with `iotaprivkey`
list List all keys by its Iota address, Base64 encoded public key, key scheme name in iota.keystore
load-keypair This reads the content at the provided file path. The accepted format can be [enum IotaKeyPair] (Base64 encoded of 33-byte `flag || privkey`) or `type
AuthorityKeyPair` (Base64 encoded `privkey`). This prints out the account keypair as Base64 encoded `flag || privkey`, the network keypair, protocol keypair,
authority keypair as Base64 encoded `privkey`
multi-sig-address To MultiSig Iota Address. Pass in a list of all public keys `flag || pk` in Base64. See `keytool list` for example public keys
multi-sig-combine-partial-sig Provides a list of participating signatures (`flag || sig || pk` encoded in Base64), threshold, a list of all public keys and a list of their weights that
define the MultiSig address. Returns a valid MultiSig signature and its sender address. The result can be used as signature field for `iota client
Expand All @@ -43,8 +40,6 @@ Commands:
sign-kms Creates a signature by leveraging AWS KMS. Pass in a key-id to leverage Amazon KMS to sign a message and the base64 pubkey. Generate PubKey from pem using
iotaledger/base64pemkey Any signature commits to a [struct IntentMessage] consisting of the Base64 encoded of the BCS serialized transaction bytes itself and
its intent. If intent is absent, default will be used
unpack This takes [enum IotaKeyPair] of Base64 encoded of 33-byte `flag || privkey`). It outputs the keypair into a file at the current directory where the address is
the filename, and prints out its Iota address, Base64 encoded public key, the key scheme, and the key scheme flag
help Print this message or the help of the given subcommand(s)

Options:
Expand Down
Loading