Struct SpiffeId

Source

pub struct SpiffeId { /* private fields */ }

Expand description

A validated [SPIFFE ID].

This type guarantees that the contained trust domain and path conform to the SPIFFE ID specification: https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE-ID.md#2-spiffe-identity.

Instances of SpiffeId are always valid and can be safely compared, formatted, and reused across the API.

Implementations§

Source §

impl SpiffeId

Source

pub fn new(id: impl AsRef<str>) -> Result<SpiffeId, SpiffeIdError>

Attempts to parse a SPIFFE ID from the given id string.

§Arguments

id - A SPIFFE ID, e.g. spiffe://trustdomain/path/other

§Errors

If the function cannot parse the input as a SPIFFE ID, a SpiffeIdError variant will be returned.

§Examples

use spiffe::SpiffeId;

let spiffe_id = SpiffeId::new("spiffe://trustdomain/path").unwrap();
assert_eq!("trustdomain", spiffe_id.trust_domain().to_string());
assert_eq!("/path", spiffe_id.path());

Source

pub fn from_segments( trust_domain: TrustDomain, segments: &[&str], ) -> Result<SpiffeId, SpiffeIdError>

Returns a new SPIFFE ID in the given trust domain with joined path segments. The path segments must be valid according to the SPIFFE specification and must not contain path separators. See https://github.com/spiffe/spiffe/blob/main/standards/SPIFFE-ID.md#22-path

§Arguments

trust_domain - A TrustDomain object.
segments - A slice of path segments.

§Errors

If the segments contain not allowed characters, a SpiffeIdError variant will be returned.

§Examples

use spiffe::{SpiffeId, TrustDomain};

let trust_domain = TrustDomain::new("trustdomain").unwrap();
let spiffe_id = SpiffeId::from_segments(trust_domain, &["path1", "path2", "path3"]).unwrap();
assert_eq!(
    "spiffe://trustdomain/path1/path2/path3",
    spiffe_id.to_string()
);

Source

pub fn trust_domain(&self) -> &TrustDomain

Returns the trust domain of the SPIFFE ID.

§Examples

use spiffe::{SpiffeId, TrustDomain};

let spiffe_id = SpiffeId::new("spiffe://example.org/service")?;
let trust_domain = spiffe_id.trust_domain();
assert_eq!(trust_domain.to_string(), "example.org");

Source

pub fn trust_domain_name(&self) -> &str

Returns the trust domain name of this SPIFFE ID.

This is equivalent to self.trust_domain().as_str() and does not allocate. The returned string is guaranteed to be a valid SPIFFE trust domain.

Source

pub fn path(&self) -> &str

Returns the path of the SPIFFE ID.

§Examples

use spiffe::SpiffeId;

let spiffe_id = SpiffeId::new("spiffe://example.org/service/api")?;
assert_eq!(spiffe_id.path(), "/service/api");

let spiffe_id = SpiffeId::new("spiffe://example.org")?;
assert_eq!(spiffe_id.path(), "");

Source

pub fn is_member_of(&self, trust_domain: &TrustDomain) -> bool

Returns true if this SPIFFE ID has the given TrustDomain.

§Examples

use spiffe::{SpiffeId, TrustDomain};

let spiffe_id = SpiffeId::new("spiffe://example.org/service")?;
let trust_domain = TrustDomain::new("example.org")?;
assert!(spiffe_id.is_member_of(&trust_domain));

let other_domain = TrustDomain::new("other.org")?;
assert!(!spiffe_id.is_member_of(&other_domain));