1 个不稳定版本

0.0.3 2022年10月24日

#11#aptos

Apache-2.0

29KB
581

加密操作的 derive 宏

这个 crate 包含四种类型的 derive 宏

  • SilentDebug 和 SilentDisplay 宏旨在用于私钥类型,并省略它们的输入以保密。
  • Deref 宏有助于为新的类型推导出规范实例。
  • aptos_crypto::traits 的 derive 宏,即 ValidCryptoMaterialPublicKeyPrivateKeyVerifyingKeySigningKeySignature,旨在在实现这些 trait 的类型的简单联合上推导。
  • aptos_crypto::hash::CryptoHasher 的 derive 宏,它定义了在 aptos_crypto::hash 中描述的域分离散列器结构(有关详细信息,请参阅此处)。此 derive 宏的唯一不同之处在于它会自动为您选择一个唯一的盐,使用 Serde 名称。对于一个容器 Foo,这通常相当于
    define_hasher! {
     (
          FooHasher,
          FOO_HASHER,
          b"Foo"
      )
    }
    

签名 trait 联合的详细说明

这些类型通常在您需要运行时接受几种签名和验证方案的多个替代方案(例如,BLS或EdDSA,见下文)时发挥作用。在这种情况下,可以声明一个由枚举类型组成的元组,每个类型都描述了这些替代方案的“求和类型”(并代数)。这实际上是一种签名方案(它有规范签名、签名和验证密钥类型,并通过平凡分发验证所有预期的属性)。

下面的宏可以在以下两个条件下让您轻松地定义这种类型的联合:

  • 枚举的变体标签具有相同的名称,即如果BLS变体对于SignatureUnionSignatureUnion::BLS(BLS12381Signature),那么BLS的PublicKeyUnion变体也必须是PublicKeyUnion::BLS,
  • 您为每个联合指定关联类型PrivateKeyTypeSignatureTypePublicKeyTypePrivateKeyTypeVerifyingKeyMaterialPublicKeyMaterial关联类型提供值,PublicKeyTypeSigningKeyMaterialPrivateKeyMaterial关联类型提供值,而SignatureTypeSignatureMaterial关联类型提供值。

示例

# #[macro_use] extern crate crypto-derive;
use aptos_crypto::{
    hash::HashValue,
    bls12381::{BLS12381PrivateKey, BLS12381PublicKey, BLS12381Signature},
    ed25519::{Ed25519PrivateKey, Ed25519PublicKey, Ed25519Signature},
};
use aptos_crypto_derive::{
    SilentDebug, PrivateKey, PublicKey, Signature, SigningKey, ValidCryptoMaterial, VerifyingKey,
};

/// Generic public key enum
#[derive(
    Debug, Clone, PartialEq, Eq, Hash, ValidCryptoMaterial, PublicKey, VerifyingKey,
)]
#[PrivateKeyType = "GenericPrivateKey"]
#[SignatureType = "GenericSignature"]
pub enum GenericPublicKey {
    /// Ed25519 public key
    Ed(Ed25519PublicKey),
    /// BLS12-381 public key
    BLS(BLS12381PublicKey),
}
/// Generic private key enum
#[derive(SilentDebug, ValidCryptoMaterial, PrivateKey, SigningKey)]
#[PublicKeyType = "GenericPublicKey"]
#[SignatureType = "GenericSignature"]
pub enum GenericPrivateKey {
    /// Ed25519 private key
    Ed(Ed25519PrivateKey),
    /// BLS12-381 private key
    BLS(BLS12381PrivateKey),
}
/// Generic signature enum
#[allow(clippy::large_enum_variant)]
#[derive(Clone, Debug, PartialEq, Eq, Hash, Signature)]
#[PrivateKeyType = "GenericPrivateKey"]
#[PublicKeyType = "GenericPublicKey"]
pub enum GenericSignature {
    /// Ed25519 signature
    Ed(Ed25519Signature),
    /// BLS12-381 signature
    BLS(BLS12381Signature),
}

依赖项

~1.5MB
~35K SLoC