Struct Metadata 

pub struct Metadata { /* private fields */ }

Parsed entity metadata (the base shared by SP and IdP).

Implementations

impl Metadata

pub fn parse(xml: &str, extra: Vec<ExtractorField>) -> Result<Self, SamlError>

Parse xml, adding the role-specific extra extractor fields.

Rejects documents carrying more than one top-level <EntityDescriptor>.

Errors

Returns SamlError when XML parsing, parser resource limits, extraction, or the single-EntityDescriptor check fails.

pub fn parse_with_limits( xml: &str, extra: Vec<ExtractorField>, limits: XmlLimits, ) -> Result<Self, SamlError>

Parse xml with explicit XML parser resource limits.

Errors

Returns SamlError when XML parsing, parser resource limits, extraction, or the single-EntityDescriptor check fails.

pub fn get_metadata(&self) -> &str

The original metadata XML.

pub fn get_entity_id(&self) -> Option<&str>

entityID.

pub fn get_name_id_format(&self) -> Vec<String>

Declared <NameIDFormat> values.

pub fn x509_certificates(&self, use_: CertUse) -> Vec<String>

All X.509 certificates declared for use (raw, as written in metadata).

pub fn get_x509_certificate(&self, use_: CertUse) -> Option<String>

First X.509 certificate declared for use.

pub fn get_single_logout_service(&self, binding: Binding) -> Option<String>

SingleLogoutService location for binding.

pub fn export_metadata(&self, path: impl AsRef<Path>) -> Result<()>

Write the metadata XML to path.

Errors

Returns std::io::Error if the filesystem write fails.

pub fn get_support_bindings(&self) -> Vec<Binding>

Bindings for which a SingleLogoutService endpoint is declared.

pub fn verify_signature( &self, trusted_certificates: &[String], ) -> Result<bool, SamlError>

Verify this metadata document’s enveloped signature against trusted certificate(s) (federation trust anchor). Requires crypto-bergshamra.

Errors

Returns SamlError when XML parsing, certificate loading, cryptographic verification, or signed <EntityDescriptor> coverage checks fail.

pub fn verify_signature_with_limits( &self, trusted_certificates: &[String], limits: XmlLimits, ) -> Result<bool, SamlError>

Verify this metadata document’s signature with explicit XML parser limits.

Errors

Returns SamlError when XML parsing, certificate loading, cryptographic verification, or signed <EntityDescriptor> coverage checks fail.

pub fn verify_signature_detailed( &self, trusted_certificates: &[String], ) -> Result<MetadataSignatureVerification, SamlError>

Verify this metadata document’s signature and preserve signed <EntityDescriptor> coverage evidence using default XML parser limits.

Errors

Returns SamlError when XML parsing, certificate loading, cryptographic verification, transform policy, or signed <EntityDescriptor> coverage checks fail.

pub fn verify_signature_detailed_with_limits( &self, trusted_certificates: &[String], limits: XmlLimits, ) -> Result<MetadataSignatureVerification, SamlError>

Verify this metadata document’s signature and preserve signed <EntityDescriptor> coverage evidence.

Errors

Returns SamlError when XML parsing, certificate loading, cryptographic verification, transform policy, or signed <EntityDescriptor> coverage checks fail.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.