[][src]Enum sequoia_openpgp::crypto::s2k::S2K

pub enum S2K {
    Simple {
        hash: HashAlgorithm,
    },
    Salted {
        hash: HashAlgorithm,
        salt: [u8; 8],
    },
    Iterated {
        hash: HashAlgorithm,
        salt: [u8; 8],
        hash_bytes: u32,
    },
    Private(u8),
    Unknown(u8),
}

String-to-Key (S2K) specifiers.

String-to-key (S2K) specifiers are used to convert password strings into symmetric-key encryption/decryption keys. See Section 3.7 of RFC 4880.

Variants

Simple

Simply hashes the password.

Fields of Simple

hash: HashAlgorithm

Hash used for key derivation.

Salted

Hashes the password with a public salt value.

Fields of Salted

hash: HashAlgorithm

Hash used for key derivation.

salt: [u8; 8]

Public salt value mixed into the password.

Iterated

Repeatently hashes the password with a public salt value.

Fields of Iterated

hash: HashAlgorithm

Hash used for key derivation.

salt: [u8; 8]

Public salt value mixed into the password.

hash_bytes: u32

Number of bytes to hash.

Private(u8)

Private S2K algorithm

Unknown(u8)

Unknown S2K algorithm

Methods

impl S2K[src]

pub fn derive_key(
    &self,
    string: &Password,
    key_size: usize
) -> Result<SessionKey>
[src]

Convert the string to a key using the S2K's parameters.

pub fn nearest_hash_count(hash_bytes: usize) -> u32[src]

This function returns an encodabled iteration count larger or equal hash_bytes.

Not all iteration counts are encodable as Iterated and Salted S2K. The largest encodable hash count is 0x3e00000.

pub fn decode_count(coded: u8) -> u32[src]

Decodes the OpenPGP encoding of the number of bytes to hash.

pub fn encode_count(hash_bytes: u32) -> Result<u8>[src]

Converts hash_bytes into coded count representation.

Errors

Fails with Error::InvalidArgument if hash_bytes cannot be encoded. See also S2K::nearest_hash_count().

Trait Implementations

impl Serialize for S2K[src]

fn export(&self, o: &mut dyn Write) -> Result<()>[src]

Exports a serialized version of the object to o. Read more

impl SerializeInto for S2K[src]

fn to_vec(&self) -> Result<Vec<u8>>[src]

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>[src]

Exports into the given buffer. Read more

fn export_to_vec(&self) -> Result<Vec<u8>>[src]

Exports to a vector. Read more

impl<'a> Parse<'a, S2K> for S2K[src]

fn from_reader<R: 'a + Read>(reader: R) -> Result<Self>[src]

Reads an S2K from reader.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>[src]

Reads from the given file. Read more

fn from_bytes<D: AsRef<[u8]> + ?Sized>(data: &'a D) -> Result<T>[src]

Reads from the given slice. Read more

impl Eq for S2K[src]

impl Copy for S2K[src]

impl Default for S2K[src]

impl PartialEq<S2K> for S2K[src]

impl Clone for S2K[src]

fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Display for S2K[src]

impl Hash for S2K[src]

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

Feeds a slice of this type into the given [Hasher]. Read more

impl Debug for S2K[src]

impl Arbitrary for S2K[src]

fn shrink(&self) -> Box<dyn Iterator<Item = Self> + 'static>

Auto Trait Implementations

impl Send for S2K

impl Sync for S2K

Blanket Implementations

impl<T> From for T[src]

impl<T, U> Into for T where
    U: From<T>, 
[src]

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

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