Skip to main content

This is unreleased documentation for the main (development) branch of crypto-glue.

ScryptParams

Struct ScryptParams

pub struct ScryptParams {
    pub salt: Salt,
    pub cost_parameter: u64,
    pub block_size: u16,
    pub parallelization: u16,
    pub key_length: Option<u16>,
}

Expand description

scrypt parameters as defined in RFC 7914 Section 7.1.

scrypt-params ::= SEQUENCE {
    salt OCTET STRING,
    costParameter INTEGER (1..MAX),
    blockSize INTEGER (1..MAX),
    parallelizationParameter INTEGER (1..MAX),
    keyLength INTEGER (1..MAX) OPTIONAL
}

Fields§

§salt: Salt

scrypt salt

§cost_parameter: u64

CPU/Memory cost parameter N.

§block_size: u16

Block size parameter r.

§parallelization: u16

Parallelization parameter p.

§key_length: Option<u16>

PBKDF2 output length

Implementations§

impl ScryptParams

pub fn from_params_and_salt(params: Params, salt: &[u8]) -> Result<Self>

Get the ScryptParams for the provided upstream scrypt::Params and a provided salt string.

§Errors

Returns Error::AlgorithmParametersInvalid if the parameters are invalid.

Trait Implementations§

impl Clone for ScryptParams

fn clone(&self) -> Self

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

impl Copy for ScryptParams

impl Debug for ScryptParams

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

Formats the value using the given formatter. Read more

impl<'a> DecodeValue<'a> for ScryptParams

type Error = Error

Type returned in the event of a decoding error.

fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self>

Attempt to decode this value using the provided Reader. Read more

impl EncodeValue for ScryptParams

fn value_len(&self) -> Result<Length>

Compute the length of this value (sans [Tag]+Length header) when encoded as ASN.1 DER. Read more

fn encode_value(&self, writer: &mut impl Writer) -> Result<()>

Encode value (sans [Tag]+Length header) as ASN.1 DER using the provided Writer. Read more

Get the Header used to encode this value. Read more

impl Eq for ScryptParams

impl From<ScryptParams> for Kdf

fn from(params: ScryptParams) -> Self

Converts to this type from the input type.

impl PartialEq for ScryptParams

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

Equality operator ==. Read more

1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more

impl Sequence<'_> for ScryptParams

impl StructuralPartialEq for ScryptParams

impl TryFrom<&ScryptParams> for Params

Available on crate feature pbes2 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(params: &ScryptParams) -> Result<Params>

Performs the conversion.

impl TryFrom<AnyRef<'_>> for ScryptParams

type Error = Error

The type returned in the event of a conversion error.

fn try_from(any: AnyRef<'_>) -> Result<Self>

Performs the conversion.

impl TryFrom<ScryptParams> for Params

Available on crate feature pbes2 only.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(params: ScryptParams) -> Result<Params>

Performs the conversion.

Auto Trait Implementations§

impl Freeze for ScryptParams

impl RefUnwindSafe for ScryptParams

impl Send for ScryptParams

impl Sync for ScryptParams

impl Unpin for ScryptParams

impl UnsafeUnpin for ScryptParams

impl UnwindSafe for ScryptParams

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<'a, T> Choice<'a> for T
where T: Decode<'a> + FixedTag,

fn can_decode(tag: Tag) -> bool

Is the provided Tag decodable as a variant of this CHOICE?

impl<T> CloneToUninit for T
where T: Clone,

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

impl<'a, T> Decode<'a> for T
where T: DecodeValue<'a> + FixedTag + 'a,

type Error = <T as DecodeValue<'a>>::Error

Type returned in the event of a decoding error.

fn decode<R>(reader: &mut R) -> Result<T, <T as DecodeValue<'a>>::Error>
where R: Reader<'a>,

Attempt to decode this TLV message using the provided decoder. Read more

fn from_der(bytes: &'a [u8]) -> Result<Self, Self::Error>

Parse Self from the provided DER-encoded byte slice. Read more

fn from_der_partial(bytes: &'a [u8]) -> Result<(Self, &'a [u8]), Self::Error>

Parse Self from the provided DER-encoded byte slice. Read more

impl<T> DecodeOwned for T
where T: for<'a> Decode<'a>,

impl<T> Encode for T
where T: EncodeValue + Tagged + ?Sized,

fn encoded_len(&self) -> Result<Length, Error>

Compute the length of this TLV object in bytes when encoded as ASN.1 DER. Read more

fn encode(&self, writer: &mut impl Writer) -> Result<(), Error>

Encode this TLV object as ASN.1 DER using the provided Writer. Read more

fn encode_to_slice<'a>(&self, buf: &'a mut [u8]) -> Result<&'a [u8], Error>

Encode this TLV object to the provided byte slice, returning a sub-slice containing the encoded message. Read more

fn encode_to_vec(&self, buf: &mut Vec<u8>) -> Result<Length, Error>

Encode this TLV object as ASN.1 DER, appending it to the provided byte vector. Read more

fn to_der(&self) -> Result<Vec<u8>, Error>

Encode this TLV object as ASN.1 DER, returning a byte vector. Read more

impl<'a, S> FixedTag for S
where S: Sequence<'a>,

const TAG: Tag = Tag::Sequence

ASN.1 tag

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> IsConstructed for T
where T: FixedTag + ?Sized,

const CONSTRUCTED: bool

ASN.1 constructed bit

impl<T> Same for T

type Output = T

Should always be Self

impl<T> Tagged for T
where T: FixedTag + ?Sized,

fn tag(&self) -> Tag

Get the ASN.1 tag that this type is encoded with.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = !

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, !>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

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

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.