Struct X509Name

pub struct X509Name<'a> { /* private fields */ }

Available on crate feature mtls only.

X.509 Name (as used in Issuer and Subject fields)

The Name describes a hierarchical name composed of attributes, such as country name, and corresponding values, such as US. The type of the component AttributeValue is determined by the AttributeType; in general it will be a DirectoryString.

Implementations

impl<'a> X509Name<'a>

pub const fn new( rdn_seq: Vec<RelativeDistinguishedName<'a>>, raw: &'a [u8], ) -> X509Name<'a>

Builds a new X509Name from the provided elements.

pub fn to_string_with_registry( &self, oid_registry: &OidRegistry<'_>, ) -> Result<String, X509Error>

Attempt to format the current name, using the given registry to convert OIDs to strings.

Note: a default registry is provided with this crate, and is returned by the oid_registry() method.

pub fn as_raw(&self) -> &'a [u8]

pub fn iter(&self) -> impl Iterator<Item = &RelativeDistinguishedName<'a>>

Return an iterator over the RelativeDistinguishedName components of the name

pub fn iter_rdn(&self) -> impl Iterator<Item = &RelativeDistinguishedName<'a>>

Return an iterator over the RelativeDistinguishedName components of the name

pub fn iter_attributes( &self, ) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the attribute types and values of the name

pub fn iter_by_oid( &self, oid: &Oid<'a>, ) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the components identified by the given OID

The type of the component AttributeValue is determined by the AttributeType; in general it will be a DirectoryString.

Attributes with same OID may be present multiple times, so the returned object is an iterator. Expected number of objects in this iterator are

• 0: not found
• 1: present once (common case)
• 2 or more: attribute is present multiple times

pub fn iter_common_name( &self, ) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the CommonName attributes of the X.509 Name.

Returned iterator can be empty if there are no CommonName attributes. If you expect only one CommonName to be present, then using next() will get an Option<&AttributeTypeAndValue>.

A common operation is to extract the CommonName as a string.

use x509_parser::x509::X509Name;

fn get_first_cn_as_str<'a>(name: &'a X509Name<'_>) -> Option<&'a str> {
    name.iter_common_name()
        .next()
        .and_then(|cn| cn.as_str().ok())
}

Note that there are multiple reasons for failure or incorrect behavior, for ex. if the attribute is present multiple times, or is not a UTF-8 encoded string (it can be UTF-16, or even an OCTETSTRING according to the standard).

pub fn iter_country(&self) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the Country attributes of the X.509 Name.

pub fn iter_organization( &self, ) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the Organization attributes of the X.509 Name.

pub fn iter_organizational_unit( &self, ) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the OrganizationalUnit attributes of the X.509 Name.

pub fn iter_state_or_province( &self, ) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the StateOrProvinceName attributes of the X.509 Name.

pub fn iter_locality(&self) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the Locality attributes of the X.509 Name.

pub fn iter_email(&self) -> impl Iterator<Item = &AttributeTypeAndValue<'a>>

Return an iterator over the EmailAddress attributes of the X.509 Name.

Trait Implementations

impl<'a> Clone for X509Name<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for X509Name<'a>

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

Formats the value using the given formatter.

impl<'a> Display for X509Name<'a>

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

Formats the value using the given formatter.

impl<'a> From<X509Name<'a>> for Vec<RelativeDistinguishedName<'a>>

fn from(name: X509Name<'a>) -> Vec<RelativeDistinguishedName<'a>>

Converts to this type from the input type.

impl<'a> FromDer<'a, X509Error> for X509Name<'a>

fn from_der(i: &'a [u8]) -> Result<(&'a [u8], X509Name<'a>), Err<X509Error>>

Parse the X.501 type Name, used for ex in issuer and subject of a X.509 certificate

impl<'a> FromIterator<RelativeDistinguishedName<'a>> for X509Name<'a>

fn from_iter<T>(iter: T) -> X509Name<'a>

where T: IntoIterator<Item = RelativeDistinguishedName<'a>>,

Creates a value from an iterator.

impl<'a> PartialEq for X509Name<'a>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a> StructuralPartialEq for X509Name<'a>