Struct actix_middleware_ed25519_authentication::AuthenticatorBuilder

pub struct AuthenticatorBuilder { /* private fields */ }

AuthenticatorBuilder is a builder struct that holds the public key, signature header, timestamp header, and a boolean value that indicates whether or not to reject requests.

Properties:

• public_key: The public key that will be used to verify the signature. For a successful build of the authenticator, a public key will be required.
• signature_header: The name of the header that contains the signature.
• timestamp_header: The name of the header that contains the timestamp.
• reject: If true, the middleware will reject the request if it is not signed. If false, the middleware will allow the request to continue, adding AuthenticationInfo to the request extensions.

Implementations

impl AuthenticatorBuilder

pub fn new() -> Self

Creates a new AuthenticatorBuilder with default values. Without a public key, the builder will panic on build.

pub fn public_key(self, public_key: &str) -> Self

Sets the public key that will be used to verify the signature. Required.

Arguments

• public_key: The public key that will be used to verify the signature. Must be a valid ed25519 public key for successful validation. Must be a hex-encoded string.

pub fn signature_header(self, header: &str) -> Self

Sets the name of the header that contains the signature. If not set, the default value is X-Signature-Ed25519. optional

Arguments

• header: The name of the header that contains the signature.

pub fn timestamp_header(self, header: &str) -> Self

Sets the name of the header that contains the timestamp. If not set, the default value is X-Signature-Timestamp. optional

Arguments

• header: The name of the header that contains the timestamp.

pub fn reject(self) -> Self

Sets whether or not to reject requests that are not signed. If not set, the default value is false. optional

pub fn build(self) -> Ed25519Authenticator

Converts the builder into the service factory Ed25519Authenticator, as expected by actix-web’s wrap function.

Panics

If the builder is missing a public key, this function will panic.

If the public key is not a valid ed25519 public key provided as a hex string, this function will panic.

Trait Implementations

impl Default for AuthenticatorBuilder

fn default() -> AuthenticatorBuilder

Returns the “default value” for a type.

impl From<AuthenticatorBuilder> for MiddlewareData

fn from(builder: AuthenticatorBuilder) -> Self

Converts to this type from the input type.