Struct ClientHello

pub struct ClientHello { /* private fields */ }

Available on crate feature tls only.

When a client first connects to a server, it is required to send the ClientHello as its first message.

The ClientHello contains random data, cipher suites, legacy content from <= TLS.12 and extensions.

For Rama however we only focus on the parts which a user might want to inspect and/or set.

Implementations

impl ClientHello

pub fn new( protocol_version: ProtocolVersion, cipher_suites: Vec<CipherSuite>, compression_algorithms: Vec<CompressionAlgorithm>, extensions: Vec<ClientHelloExtension>, ) -> Self

pub fn protocol_version(&self) -> ProtocolVersion

Return all ProtocolVersions defined in this ClientHello.

pub fn cipher_suites(&self) -> &[CipherSuite]

Return all CipherSuites defined in this ClientHello.

pub fn compression_algorithms(&self) -> &[CompressionAlgorithm]

Return all CompressionAlgorithms defined in this ClientHello.

pub fn extensions(&self) -> &[ClientHelloExtension]

Return all ClientHelloExtensions defined in this ClientHello.

pub fn ext_server_name(&self) -> Option<&Host>

Return the server name (SNI) if it is set in the ClientHelloExtension defined in this ClientHello.

See ClientHelloExtension::ServerName for more information about the server name.

pub fn ext_supported_groups(&self) -> Option<&[SupportedGroup]>

Return the elliptic curves supported by this client if it is set in the ClientHelloExtension defined in this ClientHello.

See ClientHelloExtension::SupportedGroups for more information about these curves.

pub fn ext_ec_point_formats(&self) -> Option<&[ECPointFormat]>

Return the EC point formats supported by this client if it is set in the ClientHelloExtension defined in this ClientHello.

See ClientHelloExtension::ECPointFormats for more information about this.

pub fn ext_signature_algorithms(&self) -> Option<&[SignatureScheme]>

Return the signature algorithms supported by this client if it is set in the ClientHelloExtension defined in this ClientHello.

See ClientHelloExtension::SignatureAlgorithms for more information about these algorithms

pub fn ext_alpn(&self) -> Option<&[ApplicationProtocol]>

Return the application layer protocols supported for negotiation by this client if it is set in the ClientHelloExtension defined in this ClientHello.

See ClientHelloExtension::ApplicationLayerProtocolNegotiation for more information about these protocols (ALPN).

pub fn supported_versions(&self) -> Option<&[ProtocolVersion]>

Return the TLS versions supported by this client if it is set in the ClientHelloExtension defined in this ClientHello.

See ClientHelloExtension::SupportedVersions for more information about these versions

Trait Implementations

impl Clone for ClientHello

fn clone(&self) -> ClientHello

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientHello

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ClientHello

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ClientConfig> for ClientHello

fn from(value: ClientConfig) -> Self

Converts to this type from the input type.

impl From<ClientHello> for ClientConfig

fn from(value: ClientHello) -> Self

Converts to this type from the input type.

impl Hash for ClientHello

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Serialize for ClientHello

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

where __S: Serializer,

Serialize this value into the given Serde serializer.