Struct AeKey

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

Implementations

impl AeKey

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

Deterministically derives an authenticated encryption key from a Solana signer and a public seed.

This function exists for applications where a user may not wish to maintain a Solana signer and an authenticated encryption key separately. Instead, a user can derive the ElGamal keypair on-the-fly whenever encrytion/decryption is needed.

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 authenticated encryption key.

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

pub fn new_rand() -> Self

Generates a random authenticated encryption key.

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

pub fn encrypt(&self, amount: u64) -> AeCiphertext

Encrypts an amount under the authenticated encryption key.

pub fn decrypt(&self, ciphertext: &AeCiphertext) -> Option<u64>

Trait Implementations

impl Debug for AeKey

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

Formats the value using the given formatter.

impl EncodableKey for AeKey

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<[u8; 16]> for AeKey

fn from(bytes: [u8; 16]) -> Self

Converts to this type from the input type.

impl From<AeKey> for [u8; 16]

fn from(key: AeKey) -> Self

Converts to this type from the input type.

impl PartialEq for AeKey

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

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 TryFrom<&[u8]> for AeKey

type Error = AuthenticatedEncryptionError

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 AeKey

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 AeKey

impl StructuralPartialEq for AeKey