logo
#[repr(transparent)]
pub struct Name<'a>(_);
Available on crate feature mtls only.
Expand description

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

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

Implementations

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);
    }
}

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);
    }
}

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);
    }
}

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 addresss 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);
    }
}

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>>

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.

Return an iterator over the RelativeDistinguishedName components of the name

Return an iterator over the RelativeDistinguishedName components of the name

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

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

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).

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

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

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

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

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

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

Trait Implementations

Formats the value using the given formatter. Read more

The resulting type after dereferencing.

Dereferences the value.

Formats the value using the given formatter. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

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

Converts self into a collection.

Should always be Self

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more