Struct SecretKey 

pub struct SecretKey(/* private fields */);

A secret key; wraps a single prime field element. The field element is heap allocated to avoid any stack copying that result when passing SecretKeys between stack frames.

Serde integration

SecretKey implements Deserialize but not Serialize to avoid accidental serialization in insecure contexts. To enable both use the ::serde_impl::SerdeSecret wrapper which implements both Deserialize and Serialize.

Implementations

impl SecretKey

pub fn from_mut(fr: &mut Scalar) -> SecretKey

Creates a new SecretKey from a mutable reference to a field element. This constructor takes a reference to avoid any unnecessary stack copying/moving of secrets (i.e. the field element). The field element is copied bytewise onto the heap, the resulting Box is stored in the returned SecretKey.

WARNING this constructor will overwrite the referenced Fr element with zeros after it has been copied onto the heap.

pub fn random() -> SecretKey

Creates a new random instance of SecretKey.

If you want to use/define your own random number generator, you should use the constructor: SecretKey::sample(). If you do not need to specify your own RNG, you should use the SecretKey::random() constructor, which uses rand::thread_rng() internally as its RNG.

pub fn public_key(&self) -> PublicKey

Returns the matching public key.

pub fn sign_g2<H>(&self, hash: H) -> Signature

where H: Into<G2Affine>,

Signs the given element of G2.

pub fn sign<M>(&self, msg: M) -> Signature

where M: AsRef<[u8]>,

Signs the given message.

pub fn to_bytes(&self) -> [u8; 32]

Converts the secret key to big endian bytes

pub fn from_bytes(bytes: [u8; 32]) -> Result<SecretKey, Error>

Deserialize from big endian bytes

pub fn from_hex(hex: &str) -> Result<SecretKey, Error>

Deserialize a hex-encoded representation of a SecretKey to a SecretKey instance.

pub fn to_hex(&self) -> String

Serialize this SecretKey instance to a hex-encoded String.

pub fn decrypt(&self, ct: &Ciphertext) -> Option<Vec<u8>>

Returns the decrypted text, or None, if the ciphertext isn’t valid.

pub fn reveal(&self) -> String

Generates a non-redacted debug string. This method differs from the Debug implementation in that it does leak the secret prime field element.

pub fn derive_child(&self, index: &[u8]) -> SecretKey

Derives a child secret key for a given index.

Trait Implementations

impl Clone for SecretKey

fn clone(&self) -> SecretKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SecretKey

A debug statement where the secret prime field element is redacted.

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

Formats the value using the given formatter.

impl Default for SecretKey

Creates a SecretKey containing the zero prime field element.

fn default() -> SecretKey

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SecretKey

fn deserialize<D>( deserializer: D, ) -> Result<SecretKey, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Drop for SecretKey

fn drop(&mut self)

Executes the destructor for this type.

impl From<DerivedSecretKey> for SecretKey

fn from(derived_secret_key: DerivedSecretKey) -> Self

Converts to this type from the input type.

impl From<MainSecretKey> for SecretKey

fn from(main_secret_key: MainSecretKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for DerivedSecretKey

fn from(secret_key: SecretKey) -> Self

Converts to this type from the input type.

impl From<SecretKey> for MainSecretKey

fn from(secret_key: SecretKey) -> Self

Converts to this type from the input type.

impl Ord for SecretKey

fn cmp(&self, other: &SecretKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<Scalar> for SecretKey

Utility to compare between blsttc and blst types

fn eq(&self, other: &Scalar) -> 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 PartialEq for SecretKey

fn eq(&self, other: &SecretKey) -> 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 PartialOrd for SecretKey

fn partial_cmp(&self, other: &SecretKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Zeroize for SecretKey

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 Eq for SecretKey

impl StructuralPartialEq for SecretKey