Enum vector::http::HttpClientAuthorizationStrategy

pub enum HttpClientAuthorizationStrategy {
    Basic {
        user: String,
        password: SensitiveString,
    },
    OAuth2 {
        token_endpoint: String,
        client_id: String,
        client_secret: Option<SensitiveString>,
        grace_period: u32,
    },
}

A Configuration of the authentication strategy for HTTP requests.

HTTP authentication should be used with HTTPS only, as the authentication credentials are passed as an HTTP header without any additional encryption beyond what is provided by the transport itself.

Variants

Basic

Basic authentication.

The username and password are concatenated and encoded via base64.

Fields

user: String

The basic authentication username.

password: SensitiveString

The basic authentication password.

OAuth2

Authentication based on OAuth 2.0 protocol.

This strategy allows to dynamically acquire and use token based on provided parameters. Both standard client_credentials and mTLS extension is supported, for standard client_credentials just provide both client_id and client_secret parameters:

Example

strategy:
 strategy: "o_auth2"
 client_id: "client.id"
 client_secret: "secret-value"
 token_endpoint: "https://yourendpoint.com/oauth/token"

In case you want to use mTLS extension rfc8705, provide desired key and certificate, together with client_id (with no client_secret parameter).

Example

strategy:
 strategy: "o_auth2"
 client_id: "client.id"
 token_endpoint: "https://yourendpoint.com/oauth/token"
tls:
 crt_path: cert.pem
 key_file: key.pem

Fields

token_endpoint: String

Token endpoint location, required for token acquisition.

client_id: String

The client id.

client_secret: Option<SensitiveString>

The sensitive client secret.

grace_period: u32

The grace period configuration for a bearer token. To avoid random authorization failures caused by expired token exception, we will acquire new token, some time (grace period) before current token will be expired, because of that, we will always execute request with fresh enough token.

Trait Implementations

impl Clone for HttpClientAuthorizationStrategy

fn clone(&self) -> HttpClientAuthorizationStrategy

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Configurable for HttpClientAuthorizationStrategy

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for HttpClientAuthorizationStrategy

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HttpClientAuthorizationStrategy

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HttpClientAuthorizationStrategy

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToValue for HttpClientAuthorizationStrategy

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.