reth_rpc_layer

Struct AuthLayer

Source
pub struct AuthLayer<V> { /* private fields */ }
Expand description

This is an Http middleware layer that acts as an interceptor for Authorization headers. Incoming requests are dispatched to an inner AuthValidator. Invalid requests are blocked and the validator’s error response is returned. Valid requests are instead dispatched to the next layer along the chain.

§How to integrate

async fn build_layered_rpc_server() {
    use jsonrpsee::server::ServerBuilder;
    use reth_rpc_layer::{AuthLayer, JwtAuthValidator, JwtSecret};
    use std::net::SocketAddr;

    const AUTH_PORT: u32 = 8551;
    const AUTH_ADDR: &str = "0.0.0.0";
    const AUTH_SECRET: &str =
        "f79ae8046bc11c9927afe911db7143c51a806c4a537cc08e0d37140b0192f430";

    let addr = format!("{AUTH_ADDR}:{AUTH_PORT}");
    let secret = JwtSecret::from_hex(AUTH_SECRET).unwrap();
    let validator = JwtAuthValidator::new(secret);
    let layer = AuthLayer::new(validator);
    let middleware = tower::ServiceBuilder::default().layer(layer);

    let _server = ServerBuilder::default()
        .set_http_middleware(middleware)
        .build(addr.parse::<SocketAddr>().unwrap())
        .await
        .unwrap();
}

Implementations§

Source§

impl<V> AuthLayer<V>

Source

pub const fn new(validator: V) -> Self

Creates an instance of AuthLayer. validator is a generic trait able to validate requests (see AuthValidator).

Trait Implementations§

Source§

impl<S, V> Layer<S> for AuthLayer<V>
where V: Clone,

Source§

type Service = AuthService<S, V>

The wrapped service
Source§

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

Auto Trait Implementations§

§

impl<V> Freeze for AuthLayer<V>
where V: Freeze,

§

impl<V> RefUnwindSafe for AuthLayer<V>
where V: RefUnwindSafe,

§

impl<V> Send for AuthLayer<V>
where V: Send,

§

impl<V> Sync for AuthLayer<V>
where V: Sync,

§

impl<V> Unpin for AuthLayer<V>
where V: Unpin,

§

impl<V> UnwindSafe for AuthLayer<V>
where V: UnwindSafe,

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

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
§

impl<T> ErasedDestructor for T
where T: 'static,

§

impl<T> MaybeSend for T
where T: Send,

§

impl<T> MaybeSendSync for T

Layout§

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.