Enum osshkeys::cipher::Cipher

#[non_exhaustive]
pub enum Cipher {
    Aes128_Cbc,
    Aes192_Cbc,
    Aes256_Cbc,
    Aes128_Ctr,
    Aes192_Ctr,
    Aes256_Ctr,
    TDes_Cbc,
    Null,
}

Indicate the algorithm used by encryption/decryption

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.

Aes128_Cbc

Aes192_Cbc

Aes256_Cbc

Aes128_Ctr

Aes192_Ctr

Aes256_Ctr

TDes_Cbc

Null

Implementations

impl Cipher

pub fn encrypt(self, src: &[u8], key: &[u8], iv: &[u8]) -> OsshResult<Vec<u8>>

Encrypt the data

Mostly used by the internal codes. Usually you don’t need to call it directly.

pub fn decrypt(self, src: &[u8], key: &[u8], iv: &[u8]) -> OsshResult<Vec<u8>>

Decrypt the data

Mostly used by the internal codes. Usually you don’t need to call it directly.

pub fn decrypt_to(
    self,
    dest: &mut [u8],
    src: &[u8],
    key: &[u8],
    iv: &[u8]
) -> OsshResult<usize>

pub fn calc_buffer_len(self, len: usize) -> usize

Get the required buffer length of the underlying backend

Different cipher backend have different destination buffer length requirement. You should make sure the length of dest buffer passed to decrypt_to() is equal to the result of this function.

let cipher = Cipher::Aes128_Cbc;
let src = hex!("ed58042b83e18d59bde732638136ac0e");
let key = hex!("2b7e151628aed2a6abf7158809cf4f3c");
let iv = hex!("000102030405060708090a0b0c0d0e0f");

let mut buf = vec![0; cipher.calc_buffer_len(src.len())];
let n = cipher.decrypt_to(&mut buf, &src, &key, &iv).unwrap();
buf.truncate(n);

pub fn key_len(self) -> usize

Return the required key length in bytes

pub fn iv_len(self) -> usize

Return the required IV length in bytes

pub fn block_size(self) -> usize

Return the block size of the algorithm

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

Return the name using in OpenSSH

pub fn is_null(self) -> bool

Return true if Cipher::Null

This is a method for check the null cipher easily

pub fn is_some(self) -> bool

Return true if not Cipher::Null

This is a method to check the null cipher easily

Trait Implementations

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 FromStr for Cipher

type Err = OsshError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

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

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 !=.

impl Copy for Cipher

impl Eq for Cipher

impl StructuralEq for Cipher

impl StructuralPartialEq for Cipher