Enum sequoia_openpgp::crypto::s2k::S2K

pub enum S2K {
    Simple {
        hash: HashAlgorithm,
    },
    Salted {
        hash: HashAlgorithm,
        salt: [u8; 8],
    },
    Iterated {
        hash: HashAlgorithm,
        salt: [u8; 8],
        iterations: 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.

iterations: u32

Number of bytes to hash.

Private(u8)

Private S2K algorithm

Unknown(u8)

Unknown S2K algorithm

Methods

impl S2K

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

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

pub fn nearest_iteration_count(iters: usize) -> u32

Not all iteration counts are encodable as Iterated and Salted S2K. This function returns an encodabled iteration count larger or equal iters.

Note

The largest encodable iteration count is 0x3e00000.

pub fn decode_count(coded: u8) -> u32

Decodes the OpenPGP encoding of S2K iterations.

pub fn encode_count(iters: u32) -> Result<u8>

Converts iters into coded count representation. Fails if iters cannot be encoded. See also nearest_iteration_count.

impl S2K

pub fn serialized_len(&self) -> usize

Return the length of the serialized S2K data structure.

Trait Implementations

impl Serialize for S2K

fn serialize<W: Write>(&self, w: &mut W) -> Result<()>

Serializes this S2K instance.

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

Serializes the packet to a vector.

impl Eq for S2K

impl Copy for S2K

impl Default for S2K

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<S2K> for S2K

fn eq(&self, other: &S2K) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &S2K) -> bool

This method tests for !=.

impl Clone for S2K

fn clone(&self) -> S2K

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for S2K

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

Formats the value using the given formatter.

impl Hash for S2K

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, 

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

impl Debug for S2K

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

Formats the value using the given formatter.

impl Arbitrary for S2K

fn arbitrary<G: Gen>(g: &mut G) -> Self

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