Enum SupportedCipherSuite

pub enum SupportedCipherSuite {
    Tls12(&'static Tls12CipherSuite),
    Tls13(&'static Tls13CipherSuite),
}

A cipher suite supported by rustls.

This type carries both configuration and implementation. Compare with CipherSuite, which carries solely a cipher suite identifier.

Variants

Tls12(&'static Tls12CipherSuite)

A TLS 1.2 cipher suite

Tls13(&'static Tls13CipherSuite)

A TLS 1.3 cipher suite

Implementations

impl SupportedCipherSuite

pub fn suite(&self) -> CipherSuite

The cipher suite’s identifier

pub(crate) fn hash_provider(&self) -> &'static dyn Hash

The hash function the ciphersuite uses.

pub(crate) fn common(&self) -> &CipherSuiteCommon

pub fn tls13(&self) -> Option<&'static Tls13CipherSuite>

Return the inner Tls13CipherSuite for this suite, if it is a TLS1.3 suite.

pub fn version(&self) -> &'static SupportedProtocolVersion

Return supported protocol version for the cipher suite.

pub fn usable_for_signature_algorithm( &self, _sig_alg: SignatureAlgorithm, ) -> bool

Return true if this suite is usable for a key only offering sig_alg signatures. This resolves to true for all TLS1.3 suites.

pub(crate) fn usable_for_protocol(&self, proto: Protocol) -> bool

Return true if this suite is usable for the given Protocol.

All cipher suites are usable for TCP-TLS. Only TLS1.3 suites with Tls13CipherSuite::quic provided are usable for QUIC.

pub fn fips(&self) -> bool

Return true if this is backed by a FIPS-approved implementation.

pub(crate) fn key_exchange_algorithms(&self) -> &[KeyExchangeAlgorithm]

Return the list of KeyExchangeAlgorithms supported by this cipher suite.

TLS 1.3 cipher suites support both ECDHE and DHE key exchange, but TLS 1.2 suites support one or the other.

pub(crate) fn usable_for_kx_algorithm(&self, _kxa: KeyExchangeAlgorithm) -> bool

Say if the given KeyExchangeAlgorithm is supported by this cipher suite.

TLS 1.3 cipher suites support all key exchange types, but TLS 1.2 suites support only one.

Trait Implementations

impl Clone for SupportedCipherSuite

fn clone(&self) -> SupportedCipherSuite

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SupportedCipherSuite

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

Formats the value using the given formatter.

impl From<&'static Tls12CipherSuite> for SupportedCipherSuite

fn from(s: &'static Tls12CipherSuite) -> Self

Converts to this type from the input type.

impl From<&'static Tls13CipherSuite> for SupportedCipherSuite

fn from(s: &'static Tls13CipherSuite) -> Self

Converts to this type from the input type.

impl PartialEq for SupportedCipherSuite

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for SupportedCipherSuite

impl StructuralPartialEq for SupportedCipherSuite