Struct XMatrix 

#[non_exhaustive]
pub struct XMatrix {
    pub origin: OwnedServerName,
    pub destination: Option<OwnedServerName>,
    pub key: OwnedKeyId<SigningKeyAlgorithm, ServerSigningKeyVersion>,
    pub sig: Base64,
}

Typed representation of an Authorization header of scheme X-Matrix, as defined in the Matrix Server-Server API.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

origin: OwnedServerName

The server name of the sending server.

destination: Option<OwnedServerName>

The server name of the receiving sender.

For compatibility with older servers, recipients should accept requests without this parameter, but MUST always send it. If this property is included, but the value does not match the receiving server’s name, the receiving server must deny the request with an HTTP status code 401 Unauthorized.

key: OwnedKeyId<SigningKeyAlgorithm, ServerSigningKeyVersion>

The ID - including the algorithm name - of the sending server’s key that was used to sign the request.

sig: Base64

The signature of the JSON.

Implementations

impl XMatrix

pub fn new( origin: OwnedServerName, destination: OwnedServerName, key: OwnedKeyId<SigningKeyAlgorithm, ServerSigningKeyVersion>, sig: Base64, ) -> XMatrix

Construct a new X-Matrix Authorization header.

pub fn parse(s: impl AsRef<str>) -> Result<XMatrix, XMatrixParseError>

Parse an X-Matrix Authorization header from the given string.

pub fn request_object<T>( request: &Request<T>, origin: &ServerName, destination: &ServerName, ) -> Result<BTreeMap<String, CanonicalJsonValue>, Error>

where T: AsRef<[u8]>,

Construct the canonical JSON object representation of the request to sign for the XMatrix scheme.

pub fn try_from_http_request<T>( request: &Request<T>, input: ServerSignaturesInput<'_>, ) -> Result<XMatrix, XMatrixFromRequestError>

where T: AsRef<[u8]>,

Try to construct this header from the given HTTP request and input.

pub fn verify_request<T>( &self, request: &Request<T>, destination: &ServerName, public_key_map: &BTreeMap<String, BTreeMap<String, Base64>>, ) -> Result<(), XMatrixVerificationError>

where T: AsRef<[u8]>,

Verify that the signature in the sig field is valid for the given incoming HTTP request, with the given public keys map from the origin.

Trait Implementations

impl Clone for XMatrix

fn clone(&self) -> XMatrix

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Credentials for XMatrix

const SCHEME: &'static str = "X-Matrix"

The scheme identify the format of these credentials.

fn decode(value: &HeaderValue) -> Option<XMatrix>

Try to decode the credentials from the HeaderValue.

fn encode(&self) -> HeaderValue

Encode the credentials to a HeaderValue.

impl Debug for XMatrix

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

Formats the value using the given formatter.

impl Display for XMatrix

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

Formats the value using the given formatter.

impl From<&XMatrix> for HeaderValue

fn from(value: &XMatrix) -> HeaderValue

Converts to this type from the input type.

impl FromStr for XMatrix

type Err = XMatrixParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<XMatrix, <XMatrix as FromStr>::Err>

Parses a string s to return a value of this type.

impl TryFrom<&HeaderValue> for XMatrix

type Error = XMatrixParseError

The type returned in the event of a conversion error.

fn try_from( value: &HeaderValue, ) -> Result<XMatrix, <XMatrix as TryFrom<&HeaderValue>>::Error>

Performs the conversion.