Struct pkcs5::AlgorithmIdentifier

source · [−]

pub struct AlgorithmIdentifier<'a> {
    pub oid: ObjectIdentifier,
    pub parameters: Option<AnyRef<'a>>,
}

Expand description

X.509 AlgorithmIdentifier as defined in RFC 5280 Section 4.1.1.2.

AlgorithmIdentifier  ::=  SEQUENCE  {
     algorithm               OBJECT IDENTIFIER,
     parameters              ANY DEFINED BY algorithm OPTIONAL  }

Fields

oid: ObjectIdentifier

Algorithm OID, i.e. the algorithm field in the AlgorithmIdentifier ASN.1 schema.

parameters: Option<AnyRef<'a>>

Algorithm parameters.

Implementations

source

impl<'a> AlgorithmIdentifier<'a>

source

pub fn assert_algorithm_oid(
&self,
expected_oid: ObjectIdentifier
) -> Result<ObjectIdentifier, Error>

Assert the algorithm OID is an expected value.

source

pub fn assert_parameters_oid(
&self,
expected_oid: ObjectIdentifier
) -> Result<ObjectIdentifier, Error>

Assert parameters is an OID and has the expected value.

source

pub fn assert_oids(
 &self,
 algorithm: ObjectIdentifier,
 parameters: ObjectIdentifier
) -> Result<(), Error>

Assert the values of the algorithm and parameters OIDs.

source

pub fn parameters_any(&self) -> Result<AnyRef<'a>, Error>

Get the parameters field as an AnyRef.

Returns an error if parameters are None.

source

pub fn parameters_oid(&self) -> Result<ObjectIdentifier, Error>

Get the parameters field as an ObjectIdentifier.

Returns an error if it is absent or not an OID.

source

pub fn oids(
&self
) -> Result<(ObjectIdentifier, Option<ObjectIdentifier>), Error>

Convert to a pair of ObjectIdentifiers.

This method is helpful for decomposing in match statements. Note in particular that NULL parameters are treated the same as missing parameters.

Returns an error if parameters are present but not an OID.

Trait Implementations

source

impl<'a> Clone for AlgorithmIdentifier<'a>

source

fn clone(&self) -> AlgorithmIdentifier<'a>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl<'a> Debug for AlgorithmIdentifier<'a>

source

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

Formats the value using the given formatter. Read more

source

impl<'a> DecodeValue<'a> for AlgorithmIdentifier<'a>

source

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

Attempt to decode this message using the provided Reader.

source

impl<'a> From<Pbkdf2Prf> for AlgorithmIdentifier<'a>

source

fn from(prf: Pbkdf2Prf) -> Self

Converts to this type from the input type.

source

impl<'a> Ord for AlgorithmIdentifier<'a>

source

fn cmp(&self, other: &AlgorithmIdentifier<'a>) -> Ordering

This method returns an Ordering between self and other. Read more

1.21.0 · source

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

Compares and returns the maximum of two values. Read more

1.21.0 · source

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

Compares and returns the minimum of two values. Read more

1.50.0 · source

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval. Read more

source

impl<'a> PartialEq<AlgorithmIdentifier<'a>> for AlgorithmIdentifier<'a>

source

fn eq(&self, other: &AlgorithmIdentifier<'a>) -> bool

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

source

fn ne(&self, other: &AlgorithmIdentifier<'a>) -> bool

This method tests for !=.

source

impl<'a> PartialOrd<AlgorithmIdentifier<'a>> for AlgorithmIdentifier<'a>

source

fn partial_cmp(&self, other: &AlgorithmIdentifier<'a>) -> Option<Ordering>

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

1.0.0 · source

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

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

source

impl<'a> Sequence<'a> for AlgorithmIdentifier<'a>

source

fn fields<F, T>(&self, f: F) -> Result<T, Error> where
F: FnOnce(&[&dyn Encode ]) -> Result<T, Error>,

Call the provided function with a slice of Encode trait objects representing the fields of this SEQUENCE. Read more

source

impl<'a> TryFrom<&'a [u8 ]> for AlgorithmIdentifier<'a>

type Error = Error

The type returned in the event of a conversion error.

source

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

Performs the conversion.

source

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for Algorithm

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

Performs the conversion.

source

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for Kdf<'a>

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

Performs the conversion.

source

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for Pbkdf2Prf

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

Performs the conversion.

source

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for EncryptionScheme<'a>

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

Performs the conversion.

source

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for EncryptionScheme<'a>

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<EncryptionScheme<'_>>

Performs the conversion.

source

impl<'a> TryFrom<EncryptionScheme<'a>> for AlgorithmIdentifier<'a>

type Error = Error

The type returned in the event of a conversion error.

source

fn try_from(scheme: EncryptionScheme<'a>) -> Result<Self>

Performs the conversion.

source

impl<'_> ValueOrd for AlgorithmIdentifier<'_>

source

fn value_cmp(&self, other: &AlgorithmIdentifier<'_>) -> Result<Ordering, Error>

Return an Ordering between value portion of TLV-encoded self and other when serialized as ASN.1 DER. Read more

source

impl<'a> StructuralPartialEq for AlgorithmIdentifier<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for AlgorithmIdentifier<'a>

impl<'a> Send for AlgorithmIdentifier<'a>

impl<'a> Sync for AlgorithmIdentifier<'a>

impl<'a> Unpin for AlgorithmIdentifier<'a>

impl<'a> UnwindSafe for AlgorithmIdentifier<'a>

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

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

source

fn can_decode(tag: Tag) -> bool

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

source

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

source

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

Attempt to decode this message using the provided decoder.

source

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

Parse Self from the provided DER-encoded byte slice.

source

impl<T> DerOrd for T where
T: EncodeValue + ValueOrd + Tagged,

source

fn der_cmp(&self, other: &T) -> Result<Ordering, Error>

Return an Ordering between self and other when serialized as ASN.1 DER. Read more

source

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

source

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

Compute the length of this value in bytes when encoded as ASN.1 DER.

source

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

Encode this value as ASN.1 DER using the provided Writer.

source

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

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

source

impl<'a, M> EncodeValue for M where
M: Sequence<'a>,

source

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

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

source

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

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

Get the Header used to encode this value.

source

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

source

const TAG: Tag = Tag::Sequence

ASN.1 tag

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

source

impl<T> Same<T> for T

type Output = T

Should always be Self

source

impl<T> Tagged for T where
T: FixedTag,

source

fn tag(&self) -> Tag

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

source

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

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

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

source

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

Struct pkcs5::AlgorithmIdentifier

Fields

Implementations

impl<'a> AlgorithmIdentifier<'a>

pub fn assert_algorithm_oid( &self, expected_oid: ObjectIdentifier) -> Result<ObjectIdentifier, Error>

pub fn assert_parameters_oid( &self, expected_oid: ObjectIdentifier) -> Result<ObjectIdentifier, Error>

pub fn assert_oids( &self, algorithm: ObjectIdentifier, parameters: ObjectIdentifier) -> Result<(), Error>

pub fn parameters_any(&self) -> Result<AnyRef<'a>, Error>

pub fn parameters_oid(&self) -> Result<ObjectIdentifier, Error>

pub fn oids( &self) -> Result<(ObjectIdentifier, Option<ObjectIdentifier>), Error>

Trait Implementations

impl<'a> Clone for AlgorithmIdentifier<'a>

fn clone(&self) -> AlgorithmIdentifier<'a>

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

impl<'a> Debug for AlgorithmIdentifier<'a>

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

impl<'a> DecodeValue<'a> for AlgorithmIdentifier<'a>

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

impl<'a> From<Pbkdf2Prf> for AlgorithmIdentifier<'a>

fn from(prf: Pbkdf2Prf) -> Self

impl<'a> Ord for AlgorithmIdentifier<'a>

fn cmp(&self, other: &AlgorithmIdentifier<'a>) -> Ordering

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

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

fn clamp(self, min: Self, max: Self) -> Self

impl<'a> PartialEq<AlgorithmIdentifier<'a>> for AlgorithmIdentifier<'a>

fn eq(&self, other: &AlgorithmIdentifier<'a>) -> bool

fn ne(&self, other: &AlgorithmIdentifier<'a>) -> bool

impl<'a> PartialOrd<AlgorithmIdentifier<'a>> for AlgorithmIdentifier<'a>

fn partial_cmp(&self, other: &AlgorithmIdentifier<'a>) -> Option<Ordering>

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

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

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

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

impl<'a> Sequence<'a> for AlgorithmIdentifier<'a>

fn fields<F, T>(&self, f: F) -> Result<T, Error> where F: FnOnce(&[&dyn Encode]) -> Result<T, Error>,

impl<'a> TryFrom<&'a [u8]> for AlgorithmIdentifier<'a>

type Error = Error

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

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for Algorithm

type Error = Error

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for Kdf<'a>

type Error = Error

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for Pbkdf2Prf

type Error = Error

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for EncryptionScheme<'a>

type Error = Error

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<Self>

impl<'a> TryFrom<AlgorithmIdentifier<'a>> for EncryptionScheme<'a>

type Error = Error

fn try_from(alg: AlgorithmIdentifier<'a>) -> Result<EncryptionScheme<'_>>

impl<'a> TryFrom<EncryptionScheme<'a>> for AlgorithmIdentifier<'a>

type Error = Error

fn try_from(scheme: EncryptionScheme<'a>) -> Result<Self>

impl<'_> ValueOrd for AlgorithmIdentifier<'_>

fn value_cmp(&self, other: &AlgorithmIdentifier<'_>) -> Result<Ordering, Error>

impl<'a> Copy for AlgorithmIdentifier<'a>

impl<'a> Eq for AlgorithmIdentifier<'a>

impl<'a> StructuralEq for AlgorithmIdentifier<'a>

impl<'a> StructuralPartialEq for AlgorithmIdentifier<'a>

Auto Trait Implementations

impl<'a> RefUnwindSafe for AlgorithmIdentifier<'a>

impl<'a> Send for AlgorithmIdentifier<'a>

impl<'a> Sync for AlgorithmIdentifier<'a>

impl<'a> Unpin for AlgorithmIdentifier<'a>

impl<'a> UnwindSafe for AlgorithmIdentifier<'a>

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

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

fn can_decode(tag: Tag) -> bool

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

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

pub fn assert_algorithm_oid(
&self,
expected_oid: ObjectIdentifier
) -> Result<ObjectIdentifier, Error>

pub fn assert_parameters_oid(
&self,
expected_oid: ObjectIdentifier
) -> Result<ObjectIdentifier, Error>

pub fn assert_oids(
&self,
algorithm: ObjectIdentifier,
parameters: ObjectIdentifier
) -> Result<(), Error>

pub fn oids(
&self
) -> Result<(ObjectIdentifier, Option<ObjectIdentifier>), Error>

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

fn fields<F, T>(&self, f: F) -> Result<T, Error> where
F: FnOnce(&[&dyn Encode ]) -> Result<T, Error>,

impl<'a> TryFrom<&'a [u8 ]> for AlgorithmIdentifier<'a>

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

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

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

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

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

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

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

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

impl<T> DerOrd for T where
T: EncodeValue + ValueOrd + Tagged,

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

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

impl<'a, M> EncodeValue for M where
M: Sequence<'a>,

fn header(&self) -> Result<Header, Error> where
Self: Tagged,

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

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

impl<T> Tagged for T where
T: FixedTag,

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

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

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

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