solana_zk_token_sdk::encryption::elgamal

Struct ElGamalSecretKey

Source
pub struct ElGamalSecretKey(/* private fields */);
Expand description

Secret key for the ElGamal encryption scheme.

Instances of ElGamal secret key are zeroized on drop.

Implementations§

Source§

impl ElGamalSecretKey

Source

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.

Source

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.

Source

pub fn new_rand() -> Self

Randomly samples an ElGamal secret key.

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

Source

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

Derive an ElGamal secret key from an entropy seed.

Source

pub fn get_scalar(&self) -> &Scalar

Source

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.

Source

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

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

Source

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

Source

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

👎Deprecated since 2.0.0: please use into() instead
Source

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

👎Deprecated since 2.0.0: please use try_from() instead

Trait Implementations§

Source§

impl Clone for ElGamalSecretKey

Source§

fn clone(&self) -> ElGamalSecretKey

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl ConstantTimeEq for ElGamalSecretKey

Source§

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

Determine if two items are equal. Read more
Source§

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

Determine if two items are NOT equal. Read more
Source§

impl Debug for ElGamalSecretKey

Source§

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

Formats the value using the given formatter. Read more
Source§

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

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl EncodableKey for ElGamalSecretKey

Source§

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

Source§

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

Source§

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

Source§

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

Source§

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

Source§

fn from(secret_key: &ElGamalSecretKey) -> Self

Converts to this type from the input type.
Source§

impl From<ElGamalSecretKey> for [u8; 32]

Source§

fn from(secret_key: ElGamalSecretKey) -> Self

Converts to this type from the input type.
Source§

impl From<Scalar> for ElGamalSecretKey

Source§

fn from(scalar: Scalar) -> ElGamalSecretKey

Converts to this type from the input type.
Source§

impl PartialEq for ElGamalSecretKey

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl SeedDerivable for ElGamalSecretKey

Source§

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

Source§

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

Source§

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

Source§

impl Serialize for ElGamalSecretKey

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<&[u8]> for ElGamalSecretKey

Source§

type Error = ElGamalError

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl Zeroize for ElGamalSecretKey

Source§

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.
Source§

impl Eq for ElGamalSecretKey

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,