Struct rocket::mtls::Name

pub struct Name<'a>(/* private fields */);

Available on crate feature mtls only.

An X.509 Distinguished Name (DN) found in a Certificate.

This type is a wrapper over X509Name with convenient methods and complete documentation. Should the data exposed by the inherent methods not suffice, this type derefs to X509Name.

Implementations

impl<'a> Name<'a>

pub fn common_name(&self) -> Option<&'a str>

Returns the first UTF-8 string common name, if any.

Note that common names need not be UTF-8 strings, or strings at all. This method returns the first common name attribute that is.

Example

use rocket::mtls::Certificate;

#[get("/auth")]
fn auth(cert: Certificate<'_>) {
    if let Some(name) = cert.subject().common_name() {
        println!("Hello, {}!", name);
    }
}

pub fn common_names(&self) -> impl Iterator<Item = &'a str> + '_

Returns an iterator over all of the UTF-8 string common names in self.

Note that common names need not be UTF-8 strings, or strings at all. This method filters the common names in self to those that are. Use the raw iter_common_name() to iterate over all value types.

Example

use rocket::mtls::Certificate;

#[get("/auth")]
fn auth(cert: Certificate<'_>) {
    for name in cert.issuer().common_names() {
        println!("Issued by {}.", name);
    }
}

pub fn email(&self) -> Option<&'a str>

Returns the first UTF-8 string email address, if any.

Note that email addresses need not be UTF-8 strings, or strings at all. This method returns the first email address attribute that is.

Example

use rocket::mtls::Certificate;

#[get("/auth")]
fn auth(cert: Certificate<'_>) {
    if let Some(email) = cert.subject().email() {
        println!("Hello, {}!", email);
    }
}

pub fn emails(&self) -> impl Iterator<Item = &'a str> + '_

Returns an iterator over all of the UTF-8 string email addresses in self.

Note that email addresses need not be UTF-8 strings, or strings at all. This method filters the email address in self to those that are. Use the raw iter_email() to iterate over all value types.

Example

use rocket::mtls::Certificate;

#[get("/auth")]
fn auth(cert: Certificate<'_>) {
    for email in cert.subject().emails() {
        println!("Reach me at: {}", email);
    }
}

pub fn is_empty(&self) -> bool

Returns true if self has no data.

When this is the case for a subject(), the subject data can be found in the subjectAlt extension.

Example

use rocket::mtls::Certificate;

#[get("/auth")]
fn auth(cert: Certificate<'_>) {
    let no_data = cert.subject().is_empty();
}

Methods from Deref<Target = X509Name<'a>>

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> Debug for Name<'a>

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

Formats the value using the given formatter.

impl<'a> Deref for Name<'a>

type Target = X509Name<'a>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Display for Name<'_>

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

Formats the value using the given formatter.

impl<'a> PartialEq for Name<'a>

fn eq(&self, other: &Name<'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> RefCast for Name<'a>

type From = X509Name<'a>

fn ref_cast(_from: &Self::From) -> &Self

fn ref_cast_mut(_from: &mut Self::From) -> &mut Self

impl<'a> StructuralPartialEq for Name<'a>