forked from cryptape/ckb-auth
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
232 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| # [Ethereum Lock](../README.md) | ||
|
|
||
| Here, we are conducting comparative testing using the official Ethereum tool [go-ethereum](https://geth.ethereum.org/) (Version 1.12.2). | ||
|
|
||
| ## Install | ||
| Supported installation methods: | ||
|
|
||
| * Package Managers, supported on: Mac (brew), Ubuntu, FreeBSD, Arch Linux. For specific instructions, please refer to the [official documentation](https://geth.ethereum.org/docs/getting-started/installing-geth). | ||
| * [Download the standalone bundle](https://geth.ethereum.org/downloads) | ||
| * Building from [source code](https://github.com/ethereum/go-ethereum) | ||
|
|
||
| Within the `geth` package, there are multiple executable files. Here, we will focus on using `geth` and `ethkey`. | ||
|
|
||
| * `geth` for creating accounts and generating addresses. | ||
| * `ethkey` for signature and verification. | ||
|
|
||
| Note that if using a standalone bundle or building from source, it's advisable to add the installation directory to environment variables for ease of use. | ||
|
|
||
| ### Build from source code | ||
| Keep in mind that compiling `geth` requires a [golang environment](https://go.dev/doc/install). | ||
|
|
||
| ``` | ||
| git clone https://github.com/ethereum/go-ethereum.git | ||
| cd go-ethereum | ||
| make all | ||
| ``` | ||
|
|
||
| As `ethkey` is required, we compile all components for convenience. The compiled results can be found in the `build/bin` directory. It's recommended to add this directory to 'PATH' environment variable for ease of use. | ||
|
|
||
| ## Address | ||
| First, A test account is required: | ||
| ```shell | ||
| geth account new | ||
| ``` | ||
|
|
||
| Once created, look for this line in the output: | ||
| ``` | ||
| Public address of the key: <BIN> | ||
| Path of the secret key file: <FILE_PATH> | ||
| ``` | ||
|
|
||
| Here, the account's address and private key file are displayed. To query account information again, use: `geth account list`. | ||
|
|
||
| In Ethereum, the `Address` is a 20-byte fixed-length array. When used in programs (geth and ckb-auth-cli), it will handle the leading `0x`. | ||
|
|
||
| If automation testing is needed, the passwordfile and keystore parameters can be employed to handle password and key storage. | ||
|
|
||
| ```shell | ||
| eth_password_file=`pwd`/password.txt | ||
| echo $RANDOM > $eth_password_file | ||
| eth_account_dir=`pwd`/account | ||
| rm -rf $eth_account_dir | ||
| mkdir -p $eth_account_dir | ||
| geth account new --password $eth_password_file --keystore $eth_account_dir > /dev/null 2>&1 | ||
|
|
||
| eth_account_info=`geth account list --keystore $eth_account_dir 2>/dev/null` | ||
| eth_address=`echo $eth_account_info | grep -oE -m 1 '\{[a-f0-9]+\}' | sed 's/{\(.*\)}/\1/'` | ||
| eth_privkey_file=`echo $eth_account_info | grep -oE 'keystore://[^ ]+' | awk -F 'keystore:' '{print $2}'` | ||
|
|
||
| echo Address: $eth_address | ||
| echo PrivateKeyFile: $eth_privkey_file | ||
| ``` | ||
|
|
||
| After executing the above code. The value `eth_address` is ethereum address, `eth_privkey_file` is private key file path. In subsequent operations, these two variables can be used directly. | ||
|
|
||
| ## Signature | ||
|
|
||
| Ethereum's message is calculated using sha3: `Ethereum Signed Message:\n` + 'message' hash. While ckb-auth's message is a fixed length of 32 bytes, so here, `ethkey` supports the input of messages in both textual form and through a file (by using the `--msgfile` parameter). In this context, Ethereum's message is directly utilized as a data parameter hash, necessitating the use of the `--msgfile` to input a file. | ||
|
|
||
| Here, ethkey needs to use message_file, use `ckb-auth-cli ethereum generate` to convert the message to file: | ||
| ```shell | ||
| message=0011223344556677889900112233445500112233445566778899001122334455 | ||
| message_file=`pwd`/message_file.bin | ||
| ckb-auth-cli ethereum generate -m $message --msgfile $message_file | ||
| ``` | ||
| (Other paths can also be used) | ||
|
|
||
| After generating the message file, ethkey can be used for signing: | ||
| ```shell | ||
| ethkey signmessage --msgfile $message_file --passwordfile $eth_password_file $eth_privkey_file | ||
| ``` | ||
| output: | ||
| ``` | ||
| Signature: 5a62aa66a32a41fb44a58e7284ca964952da485dc0fcec24dadb7402d65274d8733f9a2c34274c573d09743d04f25fdfb00ffee8d821a1422c7d3f4e97ce97e100 | ||
| ``` | ||
|
|
||
| If it's an automated test, obtaining the signature can also be accomplished through a script. | ||
|
|
||
| ```shell | ||
| eth_sign_info=`ethkey signmessage --msgfile $message_file --passwordfile $eth_password_file $eth_privkey_file` | ||
| eth_signature=`echo $eth_sign_info | awk -F 'Signature: ' '{print $2}'` | ||
| echo Signature: $eth_signature | ||
| ``` | ||
|
|
||
| Now, the value in `eth_signature` is signature. | ||
|
|
||
| After signing, verification can be done using geth to prevent any basic errors: | ||
| ```shell | ||
| ethkey verifymessage --msgfile $message_file $eth_address $eth_signature | ||
| ``` | ||
|
|
||
| * Here need to pay attention to the order of command parameters. | ||
|
|
||
| ## Verify | ||
|
|
||
| This can now be verified in ckb-auth: | ||
|
|
||
| ```shell | ||
| ckb-auth-cli ethereum verify -a $eth_address -s $eth_signature -m $message | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 1.71 | ||
| 1.71.1 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| use super::{BlockChain, BlockChainArgs}; | ||
| use anyhow::{anyhow, Error}; | ||
| use ckb_auth_rs::AlgorithmType; | ||
| use clap::{arg, ArgMatches, Command}; | ||
| use hex::decode; | ||
|
|
||
| pub struct EthereumLockArgs {} | ||
|
|
||
| impl BlockChainArgs for EthereumLockArgs { | ||
| fn block_chain_name(&self) -> &'static str { | ||
| "ethereum" | ||
| } | ||
|
|
||
| fn reg_parse_args(&self, cmd: Command) -> Command { | ||
| cmd | ||
| } | ||
| fn reg_generate_args(&self, cmd: Command) -> Command { | ||
| cmd.arg(arg!(-m --message <MESSAGE> "Generate message binary for ethereum signing")) | ||
| .arg(arg!(--msgfile <MESSAGE_FILE> "Output file")) | ||
| } | ||
| fn reg_verify_args(&self, cmd: Command) -> Command { | ||
| cmd.arg(arg!(-a --address <PUBKEYHASH> "The ethereum address")) | ||
| .arg(arg!(-s --signature <SIGNATURE> "The signature to verify")) | ||
| .arg(arg!(-m --message <MESSAGE> "The signature message")) | ||
| } | ||
|
|
||
| fn get_block_chain(&self) -> Box<dyn BlockChain> { | ||
| Box::new(BitcoinLock {}) | ||
| } | ||
| } | ||
|
|
||
| pub struct BitcoinLock {} | ||
|
|
||
| impl BlockChain for BitcoinLock { | ||
| fn parse(&self, _operate_mathches: &ArgMatches) -> Result<(), Error> { | ||
| Err(anyhow!("ethereum does not generate")) | ||
| } | ||
|
|
||
| fn generate(&self, operate_mathches: &ArgMatches) -> Result<(), Error> { | ||
| let message = decode( | ||
| operate_mathches | ||
| .get_one::<String>("message") | ||
| .expect("Get signature message"), | ||
| ) | ||
| .expect("Decode message"); | ||
| if message.len() != 32 { | ||
| return Err(anyhow!("Signature length must be 32")); | ||
| } | ||
|
|
||
| let msgfile = operate_mathches | ||
| .get_one::<String>("msgfile") | ||
| .expect("Get signature message output file"); | ||
|
|
||
| let msgfile = std::path::PathBuf::from(msgfile); | ||
| // if msgfile.exists() && msgfile.is_file() { | ||
| // std::fs::remove_file(&msgfile); | ||
| // } | ||
|
|
||
| std::fs::write(msgfile, message).expect("write message file"); | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| fn verify(&self, operate_mathches: &ArgMatches) -> Result<(), Error> { | ||
| let mut address = operate_mathches | ||
| .get_one::<String>("address") | ||
| .expect("Get address from args") | ||
| .clone(); | ||
| if address.starts_with("0x") { | ||
| address = address[2..].to_string(); | ||
| } | ||
| let address = decode(&address).expect("decode address"); | ||
|
|
||
| let signature = decode( | ||
| operate_mathches | ||
| .get_one::<String>("signature") | ||
| .expect("Get signature from args"), | ||
| ) | ||
| .expect("decode ethereum signature"); | ||
|
|
||
| let message = decode( | ||
| operate_mathches | ||
| .get_one::<String>("message") | ||
| .expect("Get message from args"), | ||
| ) | ||
| .expect("decode ethereum message"); | ||
|
|
||
| if address.len() != 20 { | ||
| return Err(anyhow!("ethereum address invalidate")); | ||
| } | ||
| if signature.len() != 65 { | ||
| return Err(anyhow!("ethereum signature size is not 65")); | ||
| } | ||
| if message.len() != 32 { | ||
| return Err(anyhow!("ethereum message size is not 32")); | ||
| } | ||
|
|
||
| super::auth_script::run_auth_exec(AlgorithmType::Ethereum, &address, &message, &signature)?; | ||
|
|
||
| println!("Ethereum Signature verification succeeded!"); | ||
| Ok(()) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters