Struct ruma_server_util::authorization::XMatrix

#[non_exhaustive]
pub struct XMatrix {
    pub origin: OwnedServerName,
    pub destination: Option<OwnedServerName>,
    pub key: OwnedServerSigningKeyId,
    pub sig: String,
}

Typed representation of an Authorization header of scheme X-Matrix, as defined in the Matrix Server-Server API. Includes an implementation of headers::authorization::Credentials for automatically handling the encoding and decoding when using a web framework that supports typed headers.

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

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

sig: String

The signature of the JSON.

Implementations

impl XMatrix

pub fn new( origin: OwnedServerName, destination: Option<OwnedServerName>, key: OwnedServerSigningKeyId, sig: String ) -> Self

Construct a new X-Matrix Authorization header.

Trait Implementations

impl Credentials for XMatrix

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

The scheme identify the format of these credentials.

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

Try to decode the credentials from the HeaderValue.

fn encode(&self) -> HeaderValue

Encode the credentials to a HeaderValue.