Skip to main content

CipherAlg

Struct CipherAlg 

Source
pub struct CipherAlg { /* private fields */ }
Expand description

An OpenSSL symmetric cipher algorithm descriptor (EVP_CIPHER*).

Fetched once and reused. Implements Clone via EVP_CIPHER_up_ref.

Implementations§

Source§

impl CipherAlg

Source

pub fn fetch(name: &CStr, props: Option<&CStr>) -> Result<Self, ErrorStack>

Fetch a cipher algorithm from the global default library context.

§Errors

Returns Err if the algorithm is not available.

Source

pub fn fetch_in( ctx: &Arc<LibCtx>, name: &CStr, props: Option<&CStr>, ) -> Result<Self, ErrorStack>

Fetch a cipher algorithm from an explicit library context.

§Errors
Source

pub fn key_len(&self) -> usize

Expected key length in bytes (e.g. 32 for AES-256).

Source

pub fn iv_len(&self) -> usize

Expected IV length in bytes (0 for ECB mode).

Source

pub fn block_size(&self) -> usize

Block size in bytes (1 for stream ciphers; 16 for AES).

Source

pub fn flags(&self) -> u64

OpenSSL flags for this cipher (e.g. EVP_CIPH_FLAG_AEAD_CIPHER).

Source

pub fn is_aead(&self) -> bool

Return true if this is an AEAD cipher (GCM, CCM, ChaCha20-Poly1305).

Source

pub fn as_ptr(&self) -> *const EVP_CIPHER

Return the raw EVP_CIPHER* pointer. Valid for the lifetime of self.

Source§

impl CipherAlg

Source

pub fn encrypt( &self, key: &[u8], iv: &[u8], params: Option<&Params<'_>>, ) -> Result<CipherCtx<Encrypt>, ErrorStack>

Create an encryption context.

key and iv are copied into OpenSSL’s internal state by EVP_EncryptInit_ex2 (key scheduling + zeroization on free).

§Errors
Source

pub fn decrypt( &self, key: &[u8], iv: &[u8], params: Option<&Params<'_>>, ) -> Result<CipherCtx<Decrypt>, ErrorStack>

Create a decryption context.

Same key/IV copy semantics as encrypt.

§Errors

Trait Implementations§

Source§

impl Clone for CipherAlg

Source§

fn clone(&self) -> Self

Returns a duplicate 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 Drop for CipherAlg

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl Send for CipherAlg

Source§

impl Sync for CipherAlg

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, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> 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.