Skip to main content

SniRouter

rama::tls::server

Struct SniRouter

pub struct SniRouter<S, F = RejectService<(), NoTlsRejectError>> { /* private fields */ }

Available on crate feature tls only.

Expand description

A Service router that can be used to support routing of tls traffic as well as non-tls traffic.

The difference with TlsPeekRouter is that the SniRouter continues to parse after the initial couple of bytes, in order to learn more about underlying traffic. This allowing you to route based on the SNI from the client hello, among other capabilities.

By default non-tls traffic is rejected using RejectService. Use SniRouter::with_fallback to configure the fallback service. A definitive non-TLS or malformed ClientHello prefix invokes that fallback under either timeout policy; an inconclusive timeout is fail-open by default and can be made fail-closed with SniRouter::with_peek_timeout_policy.

Implementations§

impl<S> SniRouter<S>

pub fn new(service: S) -> SniRouter<S>

Create a new SniRouter.

pub fn with_fallback<F>(self, fallback: F) -> SniRouter<S, F>

Attach a fallback Service to this SniRouter.

Used in case the traffic is not Tls traffic (defined by the first bytes).

impl<S, F> SniRouter<S, F>

pub fn maybe_with_peek_timeout( self, peek_timeout: Option<Duration>, ) -> SniRouter<S, F>

Set an optional timeout on the ClientHello peek.

Defaults to None (no timeout). A valid-but-partial ClientHello from an idle peer otherwise blocks until EOF; set a timeout for untrusted ingress. Use SniRouter::with_peek_timeout_policy to choose whether an inconclusive timeout invokes the fallback or rejects the connection.

pub fn maybe_set_peek_timeout( &mut self, peek_timeout: Option<Duration>, ) -> &mut SniRouter<S, F>

Set an optional timeout on the ClientHello peek.

Defaults to None (no timeout). A valid-but-partial ClientHello from an idle peer otherwise blocks until EOF; set a timeout for untrusted ingress. Use SniRouter::with_peek_timeout_policy to choose whether an inconclusive timeout invokes the fallback or rejects the connection.

pub fn with_peek_timeout(self, peek_timeout: Duration) -> SniRouter<S, F>

Set an optional timeout on the ClientHello peek.

Defaults to None (no timeout). A valid-but-partial ClientHello from an idle peer otherwise blocks until EOF; set a timeout for untrusted ingress. Use SniRouter::with_peek_timeout_policy to choose whether an inconclusive timeout invokes the fallback or rejects the connection.

pub fn set_peek_timeout( &mut self, peek_timeout: Duration, ) -> &mut SniRouter<S, F>

Set an optional timeout on the ClientHello peek.

Defaults to None (no timeout). A valid-but-partial ClientHello from an idle peer otherwise blocks until EOF; set a timeout for untrusted ingress. Use SniRouter::with_peek_timeout_policy to choose whether an inconclusive timeout invokes the fallback or rejects the connection.

pub fn without_peek_timeout(self) -> SniRouter<S, F>

Set an optional timeout on the ClientHello peek.

Defaults to None (no timeout). A valid-but-partial ClientHello from an idle peer otherwise blocks until EOF; set a timeout for untrusted ingress. Use SniRouter::with_peek_timeout_policy to choose whether an inconclusive timeout invokes the fallback or rejects the connection.

pub fn unset_peek_timeout(&mut self) -> &mut SniRouter<S, F>

Set an optional timeout on the ClientHello peek.

Defaults to None (no timeout). A valid-but-partial ClientHello from an idle peer otherwise blocks until EOF; set a timeout for untrusted ingress. Use SniRouter::with_peek_timeout_policy to choose whether an inconclusive timeout invokes the fallback or rejects the connection.

pub fn with_peek_timeout_policy( self, peek_timeout_policy: PeekTimeoutPolicy, ) -> SniRouter<S, F>

Set how an inconclusive ClientHello peek timeout is handled.

Defaults to PeekTimeoutPolicy::FailOpen. A definitive non-TLS or malformed ClientHello prefix invokes the fallback under either policy.

pub fn set_peek_timeout_policy( &mut self, peek_timeout_policy: PeekTimeoutPolicy, ) -> &mut SniRouter<S, F>

Set how an inconclusive ClientHello peek timeout is handled.

Defaults to PeekTimeoutPolicy::FailOpen. A definitive non-TLS or malformed ClientHello prefix invokes the fallback under either policy.

Trait Implementations§

impl<S, F> Clone for SniRouter<S, F>
where S: Clone, F: Clone,

fn clone(&self) -> SniRouter<S, F>

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

impl<S, F> Debug for SniRouter<S, F>
where S: Debug, F: Debug,

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

Formats the value using the given formatter. Read more

impl<Stream, Output, S, F> Service<Stream> for SniRouter<S, F>
where Stream: Io + Unpin, Output: Send + 'static, S: Service<SniRequest<Stream>, Output = Output>, <S as Service<SniRequest<Stream>>>::Error: Into<Box<dyn Error + Send + Sync>>, F: Service<PrefixedIo<HeapReader, Stream>, Output = Output>, <F as Service<PrefixedIo<HeapReader, Stream>>>::Error: Into<Box<dyn Error + Send + Sync>>,

type Output = Output

The type of the output returned by the service.

type Error = Box<dyn Error + Send + Sync>

The type of error returned by the service.

async fn serve( &self, stream: Stream, ) -> Result<<SniRouter<S, F> as Service<Stream>>::Output, <SniRouter<S, F> as Service<Stream>>::Error>

Serve an output or an error for the given input

fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>

Box this service to allow for dynamic dispatch.

Auto Trait Implementations§

impl<S, F> Freeze for SniRouter<S, F>
where S: Freeze, F: Freeze,

impl<S, F> RefUnwindSafe for SniRouter<S, F>
where S: RefUnwindSafe, F: RefUnwindSafe,

impl<S, F> Send for SniRouter<S, F>
where S: Send, F: Send,

impl<S, F> Sync for SniRouter<S, F>
where S: Sync, F: Sync,

impl<S, F> Unpin for SniRouter<S, F>
where S: Unpin, F: Unpin,

impl<S, F> UnsafeUnpin for SniRouter<S, F>
where S: UnsafeUnpin, F: UnsafeUnpin,

impl<S, F> UnwindSafe for SniRouter<S, F>
where S: UnwindSafe, F: UnwindSafe,

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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

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

impl<S, Input, Connection> ConnectorService<Input> for S
where S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>, <S as Service<Input>>::Error: Into<ConnectionError>, Connection: Send + ExtensionsRef,

type Connection = Connection

Connection returned by the ConnectorService

fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send

Establish a connection, which often involves some kind of handshake, or connection revival. Read more

impl<T> From<T> for T

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

fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ

Attaches the provided Context to this type, returning a WithContext wrapper. Read more

fn with_current_context(self) -> WithContext<Self> ⓘ

Attaches the current Context to this type, returning a WithContext wrapper. Read more

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

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

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

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

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

fn into_request(self) -> Request<T>

Wrap the input message T in a rama_grpc::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.

impl<T> Pointable for T

const ALIGN: usize

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

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

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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

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

fn rama_from(value: T) -> U

impl<T, U, CrateMarker> RamaInto<U, CrateMarker> for T
where U: RamaFrom<T, CrateMarker>,

fn rama_into(self) -> U

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

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

fn rama_try_from(value: T) -> Result<U, <U as RamaTryFrom<T>>::Error>

impl<T, U, CrateMarker> RamaTryInto<U, CrateMarker> for T
where U: RamaTryFrom<T, CrateMarker>,

type Error = <U as RamaTryFrom<T, CrateMarker>>::Error

fn rama_try_into(self) -> Result<U, <U as RamaTryFrom<T, CrateMarker>>::Error>

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

impl<T> Same for T

type Output = T

Should always be Self

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

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

type Error = !

The type returned in the event of a conversion error.

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

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<V, F> ValueFormatter<&V> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &&V)

Write value to writer

impl<V, F> ValueFormatter<Arc<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Arc<V>)

Write value to writer

impl<V, F> ValueFormatter<Box<V>> for F
where F: ValueFormatter<V> + ?Sized, V: ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Box<V>)

Write value to writer

impl<V, F> ValueFormatter<Cow<'_, V>> for F
where V: ToOwned + ?Sized, F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Cow<'_, V>)

Write value to writer

impl<V, F> ValueFormatter<Option<V>> for F
where F: ValueFormatter<V> + ?Sized,

const SHAPE: FieldShape<'static>

Available on non-metrique_require_explicit_impls only.

The shape of values produced by this formatter. Read more

fn format_value(writer: impl ValueWriter, value: &Option<V>)

Write value to writer

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