Struct solana_zk_token_sdk::encryption::elgamal::ElGamalSecretKey

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

Secret key for the ElGamal encryption scheme.

Instances of ElGamal secret key are zeroized on drop.

Implementations

impl ElGamalSecretKey

pub fn new_from_signer( signer: &dyn Signer, public_seed: &[u8], ) -> Result<Self, Box<dyn Error>>

Deterministically derives an ElGamal secret key from a Solana signer and a public seed.

See ElGamalKeypair::new_from_signer for more context on the key derivation.

pub fn seed_from_signer( signer: &dyn Signer, public_seed: &[u8], ) -> Result<Vec<u8>, SignerError>

Derive a seed from a Solana signer used to generate an ElGamal secret key.

The seed is derived as the hash of the signature of a public seed.

pub fn new_rand() -> Self

Randomly samples an ElGamal secret key.

This function is randomized. It internally samples a scalar element using OsRng.

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

Derive an ElGamal secret key from an entropy seed.

pub fn get_scalar(&self) -> &Scalar

pub fn decrypt(&self, ciphertext: &ElGamalCiphertext) -> DiscreteLog

Decrypts a ciphertext using the ElGamal secret key.

The output of this function is of type DiscreteLog. To recover, the originally encrypted message, use DiscreteLog::decode.

pub fn decrypt_u32(&self, ciphertext: &ElGamalCiphertext) -> Option<u64>

Decrypts a ciphertext using the ElGamal secret key interpretting the message as type u32.

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

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

👎Deprecated: please use into() instead

pub fn from_bytes(bytes: &[u8]) -> Option<ElGamalSecretKey>

👎Deprecated: please use try_from() instead

Trait Implementations

impl Clone for ElGamalSecretKey

fn clone(&self) -> ElGamalSecretKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ConstantTimeEq for ElGamalSecretKey

fn ct_eq(&self, other: &Self) -> Choice

Determine if two items are equal.

fn ct_ne(&self, other: &Self) -> Choice

Determine if two items are NOT equal.

impl Debug for ElGamalSecretKey

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ElGamalSecretKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl EncodableKey for ElGamalSecretKey

fn read<R: Read>(reader: &mut R) -> Result<Self, Box<dyn Error>>

fn write<W: Write>(&self, writer: &mut W) -> Result<String, Box<dyn Error>>

fn read_from_file<F>(path: F) -> Result<Self, Box<dyn Error>>

where F: AsRef<Path>,

fn write_to_file<F>(&self, outfile: F) -> Result<String, Box<dyn Error>>

where F: AsRef<Path>,

impl From<&ElGamalSecretKey> for [u8; 32]

fn from(secret_key: &ElGamalSecretKey) -> Self

Converts to this type from the input type.

impl From<ElGamalSecretKey> for [u8; 32]

fn from(secret_key: ElGamalSecretKey) -> Self

Converts to this type from the input type.

impl From<Scalar> for ElGamalSecretKey

fn from(scalar: Scalar) -> ElGamalSecretKey

Converts to this type from the input type.

impl PartialEq for ElGamalSecretKey

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl SeedDerivable for ElGamalSecretKey

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

fn from_seed_and_derivation_path( _seed: &[u8], _derivation_path: Option<DerivationPath>, ) -> Result<Self, Box<dyn Error>>

fn from_seed_phrase_and_passphrase( seed_phrase: &str, passphrase: &str, ) -> Result<Self, Box<dyn Error>>

impl Serialize for ElGamalSecretKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&[u8]> for ElGamalSecretKey

type Error = ElGamalError

The type returned in the event of a conversion error.

fn try_from(bytes: &[u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl Zeroize for ElGamalSecretKey

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 ElGamalSecretKey