use crate::crypto::traits::{PublicKey, Signature, Signer, Verifier};
use crate::error::{AptosError, AptosResult};
use ed25519_dalek::{Signer as DalekSigner, Verifier as DalekVerifier};
use serde::{Deserialize, Serialize};
use std::fmt;
use zeroize::Zeroize;
pub const ED25519_PRIVATE_KEY_LENGTH: usize = 32;
pub const ED25519_PUBLIC_KEY_LENGTH: usize = 32;
pub const ED25519_SIGNATURE_LENGTH: usize = 64;
#[derive(Clone, Zeroize)]
#[zeroize(drop)]
pub struct Ed25519PrivateKey {
#[zeroize(skip)]
#[allow(unused)] inner: ed25519_dalek::SigningKey,
}
impl Ed25519PrivateKey {
pub fn generate() -> Self {
let mut csprng = rand::rngs::OsRng;
let signing_key = ed25519_dalek::SigningKey::generate(&mut csprng);
Self { inner: signing_key }
}
pub fn from_bytes(bytes: &[u8]) -> AptosResult<Self> {
if bytes.len() != ED25519_PRIVATE_KEY_LENGTH {
return Err(AptosError::InvalidPrivateKey(format!(
"expected {} bytes, got {}",
ED25519_PRIVATE_KEY_LENGTH,
bytes.len()
)));
}
let mut key_bytes = [0u8; ED25519_PRIVATE_KEY_LENGTH];
key_bytes.copy_from_slice(bytes);
let signing_key = ed25519_dalek::SigningKey::from_bytes(&key_bytes);
zeroize::Zeroize::zeroize(&mut key_bytes);
Ok(Self { inner: signing_key })
}
pub fn from_hex(hex_str: &str) -> AptosResult<Self> {
let bytes = const_hex::decode(hex_str)?;
Self::from_bytes(&bytes)
}
pub fn from_aip80(s: &str) -> AptosResult<Self> {
const PREFIX: &str = "ed25519-priv-";
if let Some(hex_part) = s.strip_prefix(PREFIX) {
Self::from_hex(hex_part)
} else {
Err(AptosError::InvalidPrivateKey(format!(
"invalid AIP-80 format: expected prefix '{PREFIX}'"
)))
}
}
pub fn to_bytes(&self) -> [u8; ED25519_PRIVATE_KEY_LENGTH] {
self.inner.to_bytes()
}
pub fn to_hex(&self) -> String {
const_hex::encode_prefixed(self.inner.to_bytes())
}
pub fn to_aip80(&self) -> String {
format!("ed25519-priv-{}", self.to_hex())
}
pub fn public_key(&self) -> Ed25519PublicKey {
Ed25519PublicKey {
inner: self.inner.verifying_key(),
}
}
pub fn sign(&self, message: &[u8]) -> Ed25519Signature {
let signature = self.inner.sign(message);
Ed25519Signature { inner: signature }
}
}
impl Signer for Ed25519PrivateKey {
type Signature = Ed25519Signature;
fn sign(&self, message: &[u8]) -> Ed25519Signature {
Ed25519PrivateKey::sign(self, message)
}
fn public_key(&self) -> Ed25519PublicKey {
Ed25519PrivateKey::public_key(self)
}
}
impl fmt::Debug for Ed25519PrivateKey {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Ed25519PrivateKey([REDACTED])")
}
}
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Ed25519PublicKey {
inner: ed25519_dalek::VerifyingKey,
}
impl Ed25519PublicKey {
pub fn from_bytes(bytes: &[u8]) -> AptosResult<Self> {
if bytes.len() != ED25519_PUBLIC_KEY_LENGTH {
return Err(AptosError::InvalidPublicKey(format!(
"expected {} bytes, got {}",
ED25519_PUBLIC_KEY_LENGTH,
bytes.len()
)));
}
let mut key_bytes = [0u8; ED25519_PUBLIC_KEY_LENGTH];
key_bytes.copy_from_slice(bytes);
let verifying_key = ed25519_dalek::VerifyingKey::from_bytes(&key_bytes)
.map_err(|e| AptosError::InvalidPublicKey(e.to_string()))?;
Ok(Self {
inner: verifying_key,
})
}
pub fn from_hex(hex_str: &str) -> AptosResult<Self> {
let bytes = const_hex::decode(hex_str)?;
Self::from_bytes(&bytes)
}
pub fn from_aip80(s: &str) -> AptosResult<Self> {
const PREFIX: &str = "ed25519-pub-";
if let Some(hex_part) = s.strip_prefix(PREFIX) {
Self::from_hex(hex_part)
} else {
Err(AptosError::InvalidPublicKey(format!(
"invalid AIP-80 format: expected prefix '{PREFIX}'"
)))
}
}
pub fn to_bytes(&self) -> [u8; ED25519_PUBLIC_KEY_LENGTH] {
self.inner.to_bytes()
}
pub fn to_hex(&self) -> String {
const_hex::encode_prefixed(self.inner.to_bytes())
}
pub fn to_aip80(&self) -> String {
format!("ed25519-pub-{}", self.to_hex())
}
pub fn verify(&self, message: &[u8], signature: &Ed25519Signature) -> AptosResult<()> {
self.inner
.verify(message, &signature.inner)
.map_err(|_| AptosError::SignatureVerificationFailed)
}
pub fn to_address(&self) -> crate::types::AccountAddress {
crate::crypto::derive_address(&self.to_bytes(), crate::crypto::ED25519_SCHEME)
}
pub fn to_authentication_key(&self) -> [u8; 32] {
crate::crypto::derive_authentication_key(&self.to_bytes(), crate::crypto::ED25519_SCHEME)
}
}
impl PublicKey for Ed25519PublicKey {
const LENGTH: usize = ED25519_PUBLIC_KEY_LENGTH;
fn from_bytes(bytes: &[u8]) -> AptosResult<Self> {
Ed25519PublicKey::from_bytes(bytes)
}
fn to_bytes(&self) -> Vec<u8> {
self.inner.to_bytes().to_vec()
}
}
impl Verifier for Ed25519PublicKey {
type Signature = Ed25519Signature;
fn verify(&self, message: &[u8], signature: &Ed25519Signature) -> AptosResult<()> {
Ed25519PublicKey::verify(self, message, signature)
}
}
impl fmt::Debug for Ed25519PublicKey {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Ed25519PublicKey({})", self.to_hex())
}
}
impl fmt::Display for Ed25519PublicKey {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.to_hex())
}
}
impl Serialize for Ed25519PublicKey {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
if serializer.is_human_readable() {
serializer.serialize_str(&self.to_hex())
} else {
serializer.serialize_bytes(&self.inner.to_bytes())
}
}
}
impl<'de> Deserialize<'de> for Ed25519PublicKey {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
if deserializer.is_human_readable() {
let s = String::deserialize(deserializer)?;
Self::from_hex(&s).map_err(serde::de::Error::custom)
} else {
let bytes = <[u8; ED25519_PUBLIC_KEY_LENGTH]>::deserialize(deserializer)?;
Self::from_bytes(&bytes).map_err(serde::de::Error::custom)
}
}
}
#[derive(Clone, Copy, PartialEq, Eq)]
pub struct Ed25519Signature {
inner: ed25519_dalek::Signature,
}
impl Ed25519Signature {
pub fn from_bytes(bytes: &[u8]) -> AptosResult<Self> {
if bytes.len() != ED25519_SIGNATURE_LENGTH {
return Err(AptosError::InvalidSignature(format!(
"expected {} bytes, got {}",
ED25519_SIGNATURE_LENGTH,
bytes.len()
)));
}
let signature = ed25519_dalek::Signature::from_slice(bytes)
.map_err(|e| AptosError::InvalidSignature(e.to_string()))?;
Ok(Self { inner: signature })
}
pub fn from_hex(hex_str: &str) -> AptosResult<Self> {
let bytes = const_hex::decode(hex_str)?;
Self::from_bytes(&bytes)
}
pub fn to_bytes(&self) -> [u8; ED25519_SIGNATURE_LENGTH] {
self.inner.to_bytes()
}
pub fn to_hex(&self) -> String {
const_hex::encode_prefixed(self.inner.to_bytes())
}
}
impl Signature for Ed25519Signature {
type PublicKey = Ed25519PublicKey;
const LENGTH: usize = ED25519_SIGNATURE_LENGTH;
fn from_bytes(bytes: &[u8]) -> AptosResult<Self> {
Ed25519Signature::from_bytes(bytes)
}
fn to_bytes(&self) -> Vec<u8> {
self.inner.to_bytes().to_vec()
}
}
impl fmt::Debug for Ed25519Signature {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "Ed25519Signature({})", self.to_hex())
}
}
impl fmt::Display for Ed25519Signature {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "{}", self.to_hex())
}
}
impl Serialize for Ed25519Signature {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
if serializer.is_human_readable() {
serializer.serialize_str(&self.to_hex())
} else {
serializer.serialize_bytes(&self.inner.to_bytes())
}
}
}
impl<'de> Deserialize<'de> for Ed25519Signature {
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
where
D: serde::Deserializer<'de>,
{
if deserializer.is_human_readable() {
let s = String::deserialize(deserializer)?;
Self::from_hex(&s).map_err(serde::de::Error::custom)
} else {
let bytes = Vec::<u8>::deserialize(deserializer)?;
Self::from_bytes(&bytes).map_err(serde::de::Error::custom)
}
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_generate_and_sign() {
let private_key = Ed25519PrivateKey::generate();
let message = b"hello world";
let signature = private_key.sign(message);
let public_key = private_key.public_key();
assert!(public_key.verify(message, &signature).is_ok());
}
#[test]
fn test_wrong_message_fails() {
let private_key = Ed25519PrivateKey::generate();
let message = b"hello world";
let wrong_message = b"hello world!";
let signature = private_key.sign(message);
let public_key = private_key.public_key();
assert!(public_key.verify(wrong_message, &signature).is_err());
}
#[test]
fn test_from_bytes_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let bytes = private_key.to_bytes();
let restored = Ed25519PrivateKey::from_bytes(&bytes).unwrap();
assert_eq!(private_key.to_bytes(), restored.to_bytes());
}
#[test]
fn test_from_hex_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let hex = private_key.to_hex();
let restored = Ed25519PrivateKey::from_hex(&hex).unwrap();
assert_eq!(private_key.to_bytes(), restored.to_bytes());
}
#[test]
fn test_public_key_serialization() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let json = serde_json::to_string(&public_key).unwrap();
let restored: Ed25519PublicKey = serde_json::from_str(&json).unwrap();
assert_eq!(public_key, restored);
}
#[test]
fn test_address_derivation() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let address = public_key.to_address();
assert!(!address.is_zero());
let address2 = public_key.to_address();
assert_eq!(address, address2);
}
#[test]
fn test_private_key_aip80_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let aip80 = private_key.to_aip80();
assert!(aip80.starts_with("ed25519-priv-0x"));
let restored = Ed25519PrivateKey::from_aip80(&aip80).unwrap();
assert_eq!(private_key.to_bytes(), restored.to_bytes());
}
#[test]
fn test_private_key_aip80_format() {
let bytes = [0x01; 32];
let private_key = Ed25519PrivateKey::from_bytes(&bytes).unwrap();
let aip80 = private_key.to_aip80();
let expected = format!("ed25519-priv-0x{}", "01".repeat(32));
assert_eq!(aip80, expected);
}
#[test]
fn test_private_key_aip80_invalid_prefix() {
let result = Ed25519PrivateKey::from_aip80("secp256k1-priv-0x01");
assert!(result.is_err());
}
#[test]
fn test_public_key_aip80_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let aip80 = public_key.to_aip80();
assert!(aip80.starts_with("ed25519-pub-0x"));
let restored = Ed25519PublicKey::from_aip80(&aip80).unwrap();
assert_eq!(public_key.to_bytes(), restored.to_bytes());
}
#[test]
fn test_public_key_aip80_invalid_prefix() {
let result = Ed25519PublicKey::from_aip80("secp256k1-pub-0x01");
assert!(result.is_err());
}
#[test]
fn test_invalid_private_key_bytes_length() {
let bytes = vec![0u8; 16]; let result = Ed25519PrivateKey::from_bytes(&bytes);
assert!(result.is_err());
}
#[test]
fn test_invalid_public_key_bytes_length() {
let bytes = vec![0u8; 16]; let result = Ed25519PublicKey::from_bytes(&bytes);
assert!(result.is_err());
}
#[test]
fn test_invalid_signature_bytes_length() {
let bytes = vec![0u8; 32]; let result = Ed25519Signature::from_bytes(&bytes);
assert!(result.is_err());
}
#[test]
fn test_public_key_from_hex_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let hex = public_key.to_hex();
let restored = Ed25519PublicKey::from_hex(&hex).unwrap();
assert_eq!(public_key, restored);
}
#[test]
fn test_signature_from_hex_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let signature = private_key.sign(b"test");
let hex = signature.to_hex();
let restored = Ed25519Signature::from_hex(&hex).unwrap();
assert_eq!(signature.to_bytes(), restored.to_bytes());
}
#[test]
fn test_public_key_bytes_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let bytes = public_key.to_bytes();
let restored = Ed25519PublicKey::from_bytes(&bytes).unwrap();
assert_eq!(public_key, restored);
}
#[test]
fn test_signature_bytes_roundtrip() {
let private_key = Ed25519PrivateKey::generate();
let signature = private_key.sign(b"test");
let bytes = signature.to_bytes();
let restored = Ed25519Signature::from_bytes(&bytes).unwrap();
assert_eq!(signature.to_bytes(), restored.to_bytes());
}
#[test]
fn test_private_key_debug() {
let private_key = Ed25519PrivateKey::generate();
let debug = format!("{private_key:?}");
assert!(debug.contains("REDACTED"));
assert!(!debug.contains(&private_key.to_hex()));
}
#[test]
fn test_public_key_debug() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let debug = format!("{public_key:?}");
assert!(debug.contains("Ed25519PublicKey"));
}
#[test]
fn test_public_key_display() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let display = format!("{public_key}");
assert!(display.starts_with("0x"));
}
#[test]
fn test_signature_debug() {
let private_key = Ed25519PrivateKey::generate();
let signature = private_key.sign(b"test");
let debug = format!("{signature:?}");
assert!(debug.contains("Ed25519Signature"));
}
#[test]
fn test_signature_display() {
let private_key = Ed25519PrivateKey::generate();
let signature = private_key.sign(b"test");
let display = format!("{signature}");
assert!(display.starts_with("0x"));
}
#[test]
fn test_signer_trait() {
use crate::crypto::traits::Signer;
let private_key = Ed25519PrivateKey::generate();
let message = b"trait test";
let signature = Signer::sign(&private_key, message);
let public_key = Signer::public_key(&private_key);
assert!(public_key.verify(message, &signature).is_ok());
}
#[test]
fn test_verifier_trait() {
use crate::crypto::traits::Verifier;
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let message = b"verifier test";
let signature = private_key.sign(message);
assert!(Verifier::verify(&public_key, message, &signature).is_ok());
}
#[test]
fn test_public_key_trait() {
use crate::crypto::traits::PublicKey;
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let bytes = PublicKey::to_bytes(&public_key);
let restored = Ed25519PublicKey::from_bytes(&bytes).unwrap();
assert_eq!(public_key, restored);
}
#[test]
fn test_signature_trait() {
use crate::crypto::traits::Signature;
let private_key = Ed25519PrivateKey::generate();
let signature = private_key.sign(b"test");
let bytes = Signature::to_bytes(&signature);
let restored = Ed25519Signature::from_bytes(&bytes).unwrap();
assert_eq!(signature.to_bytes(), restored.to_bytes());
}
#[test]
fn test_authentication_key() {
let private_key = Ed25519PrivateKey::generate();
let public_key = private_key.public_key();
let auth_key = public_key.to_authentication_key();
assert_eq!(auth_key.len(), 32);
}
#[test]
fn test_signature_json_serialization() {
let private_key = Ed25519PrivateKey::generate();
let signature = private_key.sign(b"test");
let json = serde_json::to_string(&signature).unwrap();
let restored: Ed25519Signature = serde_json::from_str(&json).unwrap();
assert_eq!(signature.to_bytes(), restored.to_bytes());
}
#[test]
fn test_private_key_clone() {
let private_key = Ed25519PrivateKey::generate();
let cloned = private_key.clone();
assert_eq!(private_key.to_bytes(), cloned.to_bytes());
}
#[test]
fn test_public_key_equality() {
let private_key = Ed25519PrivateKey::generate();
let pk1 = private_key.public_key();
let pk2 = private_key.public_key();
assert_eq!(pk1, pk2);
let different = Ed25519PrivateKey::generate().public_key();
assert_ne!(pk1, different);
}
}