Struct BlsKeyPair

pub struct BlsKeyPair<Pk: BlsPublicKeyType> { /* private fields */ }

Available on crate feature bls only.

A BLS12-381 key pair

Implementations

impl<Pk: BlsPublicKeyType> BlsKeyPair<Pk>

pub fn from_seed(seed: &[u8]) -> Result<Self, Error>

Generate a new BLS key from a seed according to the KeyGen algorithm

pub fn bls_public_key(&self) -> &Pk::Buffer

Accessor for the associated public key

pub fn bls_secret_scalar(&self) -> Option<&Scalar>

Accessor for the associated secret key value, if any

Trait Implementations

impl<Pk: Clone + BlsPublicKeyType> Clone for BlsKeyPair<Pk>

where Pk::Buffer: Clone,

fn clone(&self) -> BlsKeyPair<Pk>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<Pk: BlsPublicKeyType> Debug for BlsKeyPair<Pk>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl From<&BlsKeyPair<G1G2>> for BlsKeyPair<G1>

fn from(kp: &BlsKeyPair<G1G2>) -> Self

Converts to this type from the input type.

impl From<&BlsKeyPair<G1G2>> for BlsKeyPair<G2>

fn from(kp: &BlsKeyPair<G1G2>) -> Self

Converts to this type from the input type.

impl<Pk: BlsPublicKeyType> FromJwk for BlsKeyPair<Pk>

fn from_jwk_parts(jwk: JwkParts<'_>) -> Result<Self, Error>

Import the key from a pre-parsed JWK

fn from_jwk(jwk: &str) -> Result<Self, Error>

Import the key from a JWK string reference

fn from_jwk_slice(jwk: &[u8]) -> Result<Self, Error>

Import the key from a JWK byte slice

impl<Pk: BlsPublicKeyType> HasKeyAlg for BlsKeyPair<Pk>

fn algorithm(&self) -> KeyAlg

Get the corresponding key algorithm.

impl<Pk: BlsPublicKeyType> HasKeyBackend for BlsKeyPair<Pk>

fn key_backend(&self) -> KeyBackend

Get the corresponding key backend.

impl<Pk: BlsPublicKeyType> KeyGen for BlsKeyPair<Pk>

fn generate(rng: impl KeyMaterial) -> Result<Self, Error>

Create a new key from a key material generator.

fn random() -> Result<Self, Error>

Generate a new random key.

impl<Pk: BlsPublicKeyType> KeyMeta for BlsKeyPair<Pk>

type KeySize = UInt<UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>, B0>

The size of the key secret bytes

impl<Pk: BlsPublicKeyType> KeyPublicBytes for BlsKeyPair<Pk>

where Self: KeypairMeta,

fn from_public_bytes(key: &[u8]) -> Result<Self, Error>

Create a new key instance from a slice of public key bytes.

fn with_public_bytes<O>(&self, f: impl FnOnce(&[u8]) -> O) -> O

Access a temporary slice of the key public bytes.

impl<Pk: BlsPublicKeyType> KeySecretBytes for BlsKeyPair<Pk>

fn from_secret_bytes(key: &[u8]) -> Result<Self, Error>

where Self: Sized,

Create a new key instance from a slice of key secret bytes.

fn with_secret_bytes<O>(&self, f: impl FnOnce(Option<&[u8]>) -> O) -> O

Access a temporary slice of the key secret bytes, if any.

impl<Pk> KeypairMeta for BlsKeyPair<Pk>

where Pk: BlsPublicKeyType, U32: Add<Pk::BufferSize>, <U32 as Add<Pk::BufferSize>>::Output: ArrayLength<u8>,

type PublicKeySize = <Pk as BlsPublicKeyType>::BufferSize

The size of the key public bytes

type KeypairSize = <<BlsKeyPair<Pk> as KeyMeta>::KeySize as Add<<Pk as BlsPublicKeyType>::BufferSize>>::Output

The size of the secret bytes and public bytes combined

impl<Pk: BlsPublicKeyType> PartialEq for BlsKeyPair<Pk>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Pk: BlsPublicKeyType> ToJwk for BlsKeyPair<Pk>

fn encode_jwk(&self, enc: &mut dyn JwkEncoder) -> Result<(), Error>

Write the JWK representation to an encoder

fn to_jwk_thumbprint(&self, alg: Option<KeyAlg>) -> Result<String, Error>

Available on crate feature alloc only.

Create the JWK thumbprint of the key

fn to_jwk_public(&self, alg: Option<KeyAlg>) -> Result<String, Error>

Available on crate feature alloc only.

Create a JWK of the public key

fn to_jwk_secret(&self, alg: Option<KeyAlg>) -> Result<SecretBytes, Error>

Available on crate feature alloc only.

Create a JWK of the secret key

impl<Pk: BlsPublicKeyType> Zeroize for BlsKeyPair<Pk>

fn zeroize(&mut self)

Zero out this object from memory using Rust intrinsics which ensure the zeroization operation is not “optimized away” by the compiler.

impl<Pk: BlsPublicKeyType> Eq for BlsKeyPair<Pk>