Skip to main content

AuthInterceptor

Struct AuthInterceptor 

Source
pub struct AuthInterceptor { /* private fields */ }
Expand description

Adds authorization: Bearer <token> (and x-app-name) to every request.

The authorization value is marked sensitive, so tonic does not print it in debug output. One interceptor serves one token. TbankClient builds it from the config, build it yourself only when you wrap your own channel.

§Examples

use brokapi_tbank_protocol::AuthInterceptor;
use tonic::service::Interceptor;

let mut auth = AuthInterceptor::new("t.my-token", Some("me.my-robot"))?;
let request = auth.call(tonic::Request::new(())).expect("the interceptor never refuses");
assert_eq!(request.metadata().get("authorization").unwrap(), "Bearer t.my-token");
assert_eq!(request.metadata().get("x-app-name").unwrap(), "me.my-robot");

// A token a header cannot carry is a configuration error, not a panic.
assert!(AuthInterceptor::new("line\nbreak", None).is_err());

Implementations§

Source§

impl AuthInterceptor

Source

pub fn new(token: &str, app_name: Option<&str>) -> Result<Self, ProtocolError>

Prepares the headers for token and the optional app_name.

app_name becomes the x-app-name header (the T-Bank convention is <github nick>.<repo>).

§Errors

ProtocolError::Config when the token or the app name contains characters a header value cannot carry (control characters such as a line break). The message does not repeat the token.

Trait Implementations§

Source§

impl Clone for AuthInterceptor

Source§

fn clone(&self) -> AuthInterceptor

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Interceptor for AuthInterceptor

Source§

fn call(&mut self, req: Request<()>) -> Result<Request<()>, Status>

Intercept a request before it is sent, optionally cancelling it.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T> IntoRequest<T> for T

§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

impl<L> LayerExt<L> for L

§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in [Layered].
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more