Enum ssh_cipher::Cipher

#[non_exhaustive]
pub enum Cipher {
    None,
    Aes128Cbc,
    Aes192Cbc,
    Aes256Cbc,
    Aes128Ctr,
    Aes192Ctr,
    Aes256Ctr,
    Aes128Gcm,
    Aes256Gcm,
    ChaCha20Poly1305,
    TDesCbc,
}

Cipher algorithms.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

None

No cipher.

Aes128Cbc

AES-128 in cipher block chaining (CBC) mode.

Aes192Cbc

AES-192 in cipher block chaining (CBC) mode.

Aes256Cbc

AES-256 in cipher block chaining (CBC) mode.

Aes128Ctr

AES-128 in counter (CTR) mode.

Aes192Ctr

AES-192 in counter (CTR) mode.

Aes256Ctr

AES-256 in counter (CTR) mode.

Aes128Gcm

AES-128 in Galois/Counter Mode (GCM).

Aes256Gcm

AES-256 in Galois/Counter Mode (GCM).

ChaCha20Poly1305

ChaCha20-Poly1305

TDesCbc

TripleDES in block chaining (CBC) mode

Implementations

impl Cipher

pub fn new(ciphername: &str) -> Result<Self, LabelError>

Decode cipher algorithm from the given ciphername.

Supported cipher names

• aes256-ctr

pub fn as_str(self) -> &'static str

Get the string identifier which corresponds to this algorithm.

pub fn key_and_iv_size(self) -> Option<(usize, usize)>

Get the key and IV size for this cipher in bytes.

pub fn block_size(self) -> usize

Get the block size for this cipher in bytes.

pub fn padding_len(self, input_size: usize) -> usize

Compute the length of padding necessary to pad the given input to the block size.

pub fn has_tag(self) -> bool

Does this cipher have an authentication tag? (i.e. is it an AEAD mode?)

pub fn is_none(self) -> bool

Is this cipher none?

pub fn is_some(self) -> bool

Is the cipher anything other than none?

pub fn decrypt( self, key: &[u8], iv: &[u8], buffer: &mut [u8], tag: Option<Tag> ) -> Result<()>

Decrypt the ciphertext in the buffer in-place using this cipher.

pub fn encrypt( self, key: &[u8], iv: &[u8], buffer: &mut [u8] ) -> Result<Option<Tag>>

Encrypt the ciphertext in the buffer in-place using this cipher.

Trait Implementations

impl AsRef<str> for Cipher

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for Cipher

fn clone(&self) -> Cipher

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cipher

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

Formats the value using the given formatter.

impl Display for Cipher

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

Formats the value using the given formatter.

impl FromStr for Cipher

type Err = LabelError

The associated error which can be returned from parsing.

fn from_str(ciphername: &str) -> Result<Self, LabelError>

Parses a string s to return a value of this type.

impl Hash for Cipher

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Cipher

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<Cipher> for Cipher

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

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Cipher

impl Eq for Cipher

impl Label for Cipher

impl StructuralEq for Cipher

impl StructuralPartialEq for Cipher