Skip to main content

L7Summary

Struct L7Summary 

Source
#[non_exhaustive]
pub struct L7Summary { pub app_proto: Option<&'static str>, pub server_name: Option<String>, pub ja3: Option<String>, pub ja4: Option<String>, pub tls_version: Option<u16>, pub tls_cipher: Option<u16>, pub user_agent: Option<String>, pub http_method: Option<String>, pub http_uri: Option<String>, pub dns_queries: Vec<String>, }
Available on crate feature analysis only.
Expand description

Curated security-relevant L7 facts observed on a flow.

Every field is optional / additive; a flow with no observed L7 yields the Default (all-empty) summary. #[non_exhaustive] — future protocols add fields without breaking construction (build via Default and the observe_* mutators).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§app_proto: Option<&'static str>

Detected application protocol label ("tls" / "http" / "dns"). Last writer wins when a flow upgrades (e.g. HTTP CONNECT → TLS).

§server_name: Option<String>

The server name the client asked for — TLS SNI or HTTP Host. The single most useful pivot field.

§ja3: Option<String>

JA3 TLS client fingerprint (MD5 hex), if observed.

§ja4: Option<String>

JA4 TLS client fingerprint (FoxIO format), if observed.

§tls_version: Option<u16>

Negotiated TLS version as the raw 16-bit code point (e.g. 0x0303 = TLS 1.2).

§tls_cipher: Option<u16>

Negotiated TLS cipher suite code point.

§user_agent: Option<String>

HTTP User-Agent header value.

§http_method: Option<String>

HTTP request method (GET / POST / …).

§http_uri: Option<String>

HTTP request path / URI.

§dns_queries: Vec<String>

DNS query names observed on the flow (bounded to MAX_DNS_QUERIES).

Implementations§

Source§

impl L7Summary

Source

pub fn is_empty(&self) -> bool

true if nothing L7 was observed (the default state).

Source

pub fn observe_tls(&mut self, hs: &TlsHandshake)

Available on crate feature tls only.

Fold the facts from a completed TLS handshake into the summary: SNI → Self::server_name, JA3/JA4, negotiated version + cipher.

Source

pub fn observe_http(&mut self, msg: &HttpMessage)

Available on crate feature http only.

Fold the facts from an HTTP message into the summary. Only requests carry security-relevant identity (Host / UA / method / path); responses are ignored here.

Source

pub fn observe_dns_query(&mut self, q: &DnsQuery)

Available on crate feature dns only.

Record the query names from a parsed DNS query, bounded to MAX_DNS_QUERIES.

Source

pub fn observe_dns_response(&mut self, r: &DnsResponse)

Available on crate feature dns only.

Record the query names from a parsed DNS response, bounded to MAX_DNS_QUERIES.

Trait Implementations§

Source§

impl Clone for L7Summary

Source§

fn clone(&self) -> L7Summary

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 Debug for L7Summary

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for L7Summary

Source§

fn default() -> L7Summary

Returns the “default value” for a type. Read more
Source§

impl Deserialize<'static> for L7Summary

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'static>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for L7Summary

Source§

fn eq(&self, other: &L7Summary) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for L7Summary

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for L7Summary

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

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

Source§

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

Source§

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

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.

Source§

impl<T> Instrument for T

Source§

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

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

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

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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