Struct der_parser::ber::BerObject

pub struct BerObject<'a> {
    pub header: Header<'a>,
    pub content: BerObjectContent<'a>,
}

Representation of a BER-encoded (X.690) object

A BER object is composed of a header describing the object class, type and length, and the content.

Note that the content may sometimes not match the header tag (for ex when parsing IMPLICIT tagged values).

Fields

header: Header<'a>

content: BerObjectContent<'a>

Implementations

impl<'a> BerObject<'a>

pub const fn from_header_and_content<'o>(
    header: Header<'o>,
    content: BerObjectContent<'o>
) -> BerObject<'o>

Build a BerObject from a header and content.

Note: values are not checked, so the tag can be different from the real content, or flags can be invalid.

pub const fn from_obj(c: BerObjectContent<'_>) -> BerObject<'_>

Build a BerObject from its content, using default flags (no class, correct tag, and constructed flag set only for Set and Sequence)

pub const fn from_int_slice(i: &'a [u8]) -> BerObject<'a>

Build a DER integer object from a slice containing an encoded integer

pub fn set_raw_tag(self, raw_tag: Option<&'a [u8]>) -> BerObject<'_>

Set a tag for the BER object

pub const fn from_seq(l: Vec<BerObject<'_>>) -> BerObject<'_>

Build a DER sequence object from a vector of DER objects

pub const fn from_set(l: Vec<BerObject<'_>>) -> BerObject<'_>

Build a DER set object from a vector of DER objects

pub fn as_i64(&self) -> Result<i64, BerError>

Attempt to read a signed integer value from DER object.

This can fail if the object is not an integer, or if it is too large.

Examples

let der_int  = BerObject::from_int_slice(b"\x80");
assert_eq!(
    der_int.as_i64(),
    Ok(-128)
);

pub fn as_i32(&self) -> Result<i32, BerError>

Attempt to read a signed integer value from DER object.

This can fail if the object is not an integer, or if it is too large.

Examples

let der_int  = BerObject::from_int_slice(b"\x80");
assert_eq!(
    der_int.as_i32(),
    Ok(-128)
);

pub fn as_u64(&self) -> Result<u64, BerError>

Attempt to read integer value from DER object.

This can fail if the object is not an unsigned integer, or if it is too large.

Examples

let der_int  = BerObject::from_int_slice(b"\x01\x00\x01");
assert_eq!(
    der_int.as_u64(),
    Ok(0x10001)
);

pub fn as_u32(&self) -> Result<u32, BerError>

Attempt to read integer value from DER object.

This can fail if the object is not an unsigned integer, or if it is too large.

Examples

let der_int  = BerObject::from_obj(BerObjectContent::Integer(b"\x01\x00\x01"));
assert_eq!(
    der_int.as_u32(),
    Ok(0x10001)
);

pub fn as_bool(&self) -> Result<bool, BerError>

Attempt to read integer value from DER object. This can fail if the object is not a boolean.

pub fn as_oid(&self) -> Result<&Oid<'a>, BerError>

Attempt to read an OID value from DER object. This can fail if the object is not an OID.

pub fn as_oid_val(&self) -> Result<Oid<'a>, BerError>

Attempt to read an OID value from DER object. This can fail if the object is not an OID.

pub fn as_optional(&self) -> Result<Option<&BerObject<'a>>, BerError>

Attempt to get a reference on the content from an optional object. This can fail if the object is not optional.

pub fn as_tagged(&self) -> Result<(Class, Tag, &BerObject<'a>), BerError>

Attempt to get a reference on the content from a tagged object. This can fail if the object is not tagged.

pub fn as_bitstring_ref(&self) -> Result<&BitStringObject<'_>, BerError>

Attempt to read a reference to a BitString value from DER object. This can fail if the object is not an BitString.

Note that this function returns a reference to the BitString. To get an owned value, use as_bitstring

pub fn as_bitstring(&self) -> Result<BitStringObject<'a>, BerError>

Attempt to read a BitString value from DER object. This can fail if the object is not an BitString.

pub fn as_sequence(&self) -> Result<&Vec<BerObject<'a>>, BerError>

Attempt to extract the list of objects from a DER sequence. This can fail if the object is not a sequence.

pub fn as_set(&self) -> Result<&Vec<BerObject<'a>>, BerError>

Attempt to extract the list of objects from a DER set. This can fail if the object is not a set.

pub fn as_slice(&self) -> Result<&'a [u8], BerError>

Attempt to get the content from a DER object, as a slice. This can fail if the object does not contain a type directly equivalent to a slice (e.g a sequence). This function mostly concerns string types, integers, or unknown DER objects.

pub fn as_str(&self) -> Result<&'a str, BerError>

Attempt to get the content from a DER object, as a str. This can fail if the object does not contain a string type.

Only some string types are considered here. Other string types can be read using as_slice.

pub const fn class(&self) -> Class

Get the BER object header’s class.

pub const fn tag(&self) -> Tag

Get the BER object header’s tag.

pub const fn length(&self) -> Length

Get the BER object header’s length.

pub const fn is_universal(&self) -> bool

Test if object class is Universal

pub const fn is_application(&self) -> bool

Test if object class is Application

pub const fn is_contextspecific(&self) -> bool

Test if object class is Context-specific

pub fn is_private(&self) -> bool

Test if object class is Private

pub const fn is_primitive(&self) -> bool

Test if object is primitive

pub const fn is_constructed(&self) -> bool

Test if object is constructed

pub const fn assert_class(&self, class: Class) -> Result<(), BerError>

Return error if class is not the expected class

pub const fn assert_tag(&self, tag: Tag) -> Result<(), BerError>

Return error if tag is not the expected tag

pub const fn assert_constructed(&self) -> Result<(), BerError>

Return error if object is not constructed

pub const fn assert_primitive(&self) -> Result<(), BerError>

Return error if object is not primitive

impl<'a> BerObject<'a>

pub fn as_bigint(&self) -> Result<BigInt, BerError>

This is supported on crate feature bigint only.

Attempt to read an integer value from this object.

This can fail if the object is not an integer.

Examples

use der_parser::ber::*;

let data = &[0x02, 0x03, 0x01, 0x00, 0x01];

let (_, object) = parse_ber_integer(data).expect("parsing failed");
assert_eq!(object.as_bigint(), Ok(65537.into()))

pub fn as_biguint(&self) -> Result<BigUint, BerError>

This is supported on crate feature bigint only.

Attempt to read a positive integer value from this object.

This can fail if the object is not an integer, or is negative.

Examples

use der_parser::ber::*;

let data = &[0x02, 0x03, 0x01, 0x00, 0x01];

let (_, object) = parse_ber_integer(data).expect("parsing failed");
assert_eq!(object.as_biguint(), Ok(65537_u32.into()))

impl<'a> BerObject<'a>

pub fn ref_iter(&'a self) -> BerObjectRefIterator<'a>

impl<'a> BerObject<'a>

pub fn as_pretty(&'a self, indent: usize, increment: usize) -> PrettyBer<'a>

impl<'a> BerObject<'a>

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

This is supported on crate feature serialize only.

Attempt to encode object as BER

Note that the encoding will not check that the values of the BerObject fields are correct. The length is automatically calculated, and the field is ignored.

Tagged objects will be encoded as EXPLICIT.

This function is only available if the serialize feature is enabled.

Trait Implementations

impl<'a> Clone for BerObject<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BerObject<'a>

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

Formats the value using the given formatter.

impl<'a> From<BerObjectContent<'a>> for BerObject<'a>

Build a DER object from a BerObjectContent.

fn from(obj: BerObjectContent<'a>) -> BerObject<'a>

Performs the conversion.

impl<'a> From<Oid<'a>> for BerObject<'a>

Build a DER object from an OID.

fn from(oid: Oid<'a>) -> BerObject<'a>

Performs the conversion.

impl<'a> Index<usize> for BerObject<'a>

type Output = BerObject<'a>

The returned type after indexing.

fn index(&self, idx: usize) -> &BerObject<'a>

Performs the indexing (container[index]) operation.

impl<'a> IntoIterator for BerObject<'a>

type Item = BerObject<'a>

The type of the elements being iterated over.

type IntoIter = BerObjectIntoIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq<BerObject<'a>> for BerObject<'a>

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

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

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

This method tests for !=.

impl<'a> StructuralPartialEq for BerObject<'a>