Struct SniRouter
pub struct SniRouter<S, F = RejectService<(), NoTlsRejectError>, Pol = PeekPolicy> { /* private fields */ }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.
Non-TLS traffic invokes that fallback. By default malformed, over-limit, or
EOF-truncated TLS also invokes it, with a super::ClientHelloPeekStatus
extension identifying the failure. Use SniRouter::with_malformed_tls_policy
to opt into rejection. With the default PeekPolicy::FAIL_OPEN, a
prefix cut off by a cancelled scope also invokes the fallback. Strict SNI routing should select
MalformedTlsPolicy::Reject and a PeekPolicy that never falls back on
partial input, see SniRouter::with_peek_policy.
Implementations§
§impl<S, Pol> SniRouter<S, RejectService<(), NoTlsRejectError>, Pol>
impl<S, Pol> SniRouter<S, RejectService<(), NoTlsRejectError>, Pol>
pub fn with_fallback<F>(self, fallback: F) -> SniRouter<S, F, Pol>
pub fn with_fallback<F>(self, fallback: F) -> SniRouter<S, F, Pol>
§impl<S, F, Pol> SniRouter<S, F, Pol>
impl<S, F, Pol> SniRouter<S, F, Pol>
pub fn with_malformed_tls_policy(
self,
policy: MalformedTlsPolicy,
) -> SniRouter<S, F, Pol>
pub fn with_malformed_tls_policy( self, policy: MalformedTlsPolicy, ) -> SniRouter<S, F, Pol>
Choose whether unparseable, over-limit, or EOF-truncated TLS is sent to the fallback (the default) or rejected. Keep rejection when route policy depends on validated SNI. This does not change the reassembly bounds or peek policy.
pub fn set_malformed_tls_policy(
&mut self,
policy: MalformedTlsPolicy,
) -> &mut SniRouter<S, F, Pol>
pub fn set_malformed_tls_policy( &mut self, policy: MalformedTlsPolicy, ) -> &mut SniRouter<S, F, Pol>
Choose whether unparseable, over-limit, or EOF-truncated TLS is sent to the fallback (the default) or rejected. Keep rejection when route policy depends on validated SNI. This does not change the reassembly bounds or peek policy.
pub fn with_reassembly_config(
self,
config: ClientHelloReassemblyConfig,
) -> SniRouter<S, F, Pol>
pub fn with_reassembly_config( self, config: ClientHelloReassemblyConfig, ) -> SniRouter<S, F, Pol>
Configure ClientHello size, record count, and legacy-version checks. Defaults to 256 KiB across 256 records with tolerant legacy versions.
pub fn set_reassembly_config(
&mut self,
config: ClientHelloReassemblyConfig,
) -> &mut SniRouter<S, F, Pol>
pub fn set_reassembly_config( &mut self, config: ClientHelloReassemblyConfig, ) -> &mut SniRouter<S, F, Pol>
Configure ClientHello size, record count, and legacy-version checks. Defaults to 256 KiB across 256 records with tolerant legacy versions.
pub fn with_peek_policy<Pol2>(self, peek_policy: Pol2) -> SniRouter<S, F, Pol2>
pub fn with_peek_policy<Pol2>(self, peek_policy: Pol2) -> SniRouter<S, F, Pol2>
Set how a ClientHello peek cutoff is handled, using
a static PeekPolicy or a PeekPolicyProvider that selects one per input.
Defaults to PeekPolicy::FAIL_OPEN. Non-TLS traffic invokes
the fallback; malformed TLS follows the separate malformed-TLS policy.
Trait Implementations§
§impl<Stream, Output, S, F, Pol> Service<Stream> for SniRouter<S, F, Pol>where
Stream: Io + Unpin + ExtensionsRef,
Output: Send + 'static,
Pol: PeekPolicyProvider<Stream>,
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>>,
impl<Stream, Output, S, F, Pol> Service<Stream> for SniRouter<S, F, Pol>where
Stream: Io + Unpin + ExtensionsRef,
Output: Send + 'static,
Pol: PeekPolicyProvider<Stream>,
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>>,
§async fn serve(
&self,
stream: Stream,
) -> Result<<SniRouter<S, F, Pol> as Service<Stream>>::Output, <SniRouter<S, F, Pol> as Service<Stream>>::Error>
async fn serve( &self, stream: Stream, ) -> Result<<SniRouter<S, F, Pol> as Service<Stream>>::Output, <SniRouter<S, F, Pol> as Service<Stream>>::Error>
§fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>
fn boxed(self) -> BoxService<Input, Self::Output, Self::Error>
Auto Trait Implementations§
impl<S, F, Pol> Forget for SniRouter<S, F, Pol>
impl<S, F, Pol> Freeze for SniRouter<S, F, Pol>
impl<S, F, Pol> Move for SniRouter<S, F, Pol>
impl<S, F, Pol> RefUnwindSafe for SniRouter<S, F, Pol>
impl<S, F, Pol> Send for SniRouter<S, F, Pol>
impl<S, F, Pol> Sync for SniRouter<S, F, Pol>
impl<S, F, Pol> Unpin for SniRouter<S, F, Pol>
impl<S, F, Pol> UnsafeUnpin for SniRouter<S, F, Pol>
impl<S, F, Pol> UnwindSafe for SniRouter<S, F, Pol>
Blanket Implementations§
§impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedExplicit<'a, E> for Twhere
T: 'a,
§impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
impl<'a, T, E> AsTaggedImplicit<'a, E> for Twhere
T: 'a,
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
§impl<S, Input, Connection> ConnectorService<Input> for Swhere
S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>,
<S as Service<Input>>::Error: Into<ConnectionError>,
Connection: Send + ExtensionsRef,
impl<S, Input, Connection> ConnectorService<Input> for Swhere
S: Service<Input, Output = EstablishedClientConnection<Connection, Input>>,
<S as Service<Input>>::Error: Into<ConnectionError>,
Connection: Send + ExtensionsRef,
§type Connection = Connection
type Connection = Connection
ConnectorService§fn connect(
&self,
input: Input,
) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send
fn connect( &self, input: Input, ) -> impl Future<Output = Result<EstablishedClientConnection<<S as ConnectorService<Input>>::Connection, Input>, ConnectionError>> + Send
§impl<T> FutureExt for T
impl<T> FutureExt for T
§fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
fn with_context(self, otel_cx: Context) -> WithContext<Self> ⓘ
§fn with_current_context(self) -> WithContext<Self> ⓘ
fn with_current_context(self) -> WithContext<Self> ⓘ
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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
impl<T> IntoRequest<T> for T
§fn into_request(self) -> Request<T>
fn into_request(self) -> Request<T>
T in a rama_grpc::Request§impl<T> Pointable for T
impl<T> Pointable for T
§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
§fn and<P, B, E>(self, other: P) -> And<T, P>
fn and<P, B, E>(self, other: P) -> And<T, P>
Policy that returns Action::Follow only if self and other return
Action::Follow. Read more