Enum AlertDescription 

#[non_exhaustive]
pub enum AlertDescription {
    CloseNotify,
    UnexpectedMessage,
    BadRecordMac,
    RecordOverflow,
    HandshakeFailure,
    BadCertificate,
    UnsupportedCertificate,
    CertificateRevoked,
    CertificateExpired,
    CertificateUnknown,
    IllegalParameter,
    UnknownCa,
    AccessDenied,
    DecodeError,
    DecryptError,
    ProtocolVersion,
    InsufficientSecurity,
    InternalError,
    InappropriateFallback,
    UserCanceled,
    MissingExtension,
    UnsupportedExtension,
    UnrecognizedName,
    BadCertificateStatusResponse,
    UnknownPskIdentity,
    CertificateRequired,
    NoApplicationProtocol,
    Unknown(u8),
}

A TLS alert description code (RFC 8446 §6).

The Unknown(u8) catch-all carries any code not listed in RFC 8446, allowing the type to remain forwards-compatible without breaking consumers.

Examples

use oxitls_core::AlertDescription;

let d = AlertDescription::from(40u8);
assert_eq!(d, AlertDescription::HandshakeFailure);
assert_eq!(d.to_u8(), 40);

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

CloseNotify

close_notify (0) — orderly TLS shutdown.

UnexpectedMessage

unexpected_message (10) — inappropriate message received.

BadRecordMac

bad_record_mac (20) — record authentication failure.

RecordOverflow

record_overflow (22) — TLSCiphertext record too long.

HandshakeFailure

handshake_failure (40) — unable to negotiate acceptable security parameters.

BadCertificate

bad_certificate (42) — unacceptable certificate.

UnsupportedCertificate

unsupported_certificate (43) — certificate type not supported.

CertificateRevoked

certificate_revoked (44) — certificate has been revoked.

CertificateExpired

certificate_expired (45) — certificate has expired.

CertificateUnknown

certificate_unknown (46) — unspecified certificate problem.

IllegalParameter

illegal_parameter (47) — field in the handshake was out of range or inconsistent.

UnknownCa

unknown_ca (48) — certificate’s CA is not trusted.

AccessDenied

access_denied (49) — valid certificate, but access control denied.

DecodeError

decode_error (50) — unable to decode a message.

DecryptError

decrypt_error (51) — handshake cryptographic operation failed.

ProtocolVersion

protocol_version (70) — protocol version not supported.

InsufficientSecurity

insufficient_security (71) — server requires ciphers more secure than those supported by client.

InternalError

internal_error (80) — internal error unrelated to the peer or correctness of the protocol.

InappropriateFallback

inappropriate_fallback (86) — TLS_FALLBACK_SCSV in response to version downgrade.

UserCanceled

user_canceled (90) — handshake is being canceled for a reason unrelated to a protocol failure.

MissingExtension

missing_extension (109) — negotiated extension was missing from the ClientHello.

UnsupportedExtension

unsupported_extension (110) — extension not permitted for this message.

UnrecognizedName

unrecognized_name (112) — SNI name not recognized.

BadCertificateStatusResponse

bad_certificate_status_response (113) — OCSP response invalid.

UnknownPskIdentity

unknown_psk_identity (115) — no acceptable PSK identity was supplied.

CertificateRequired

certificate_required (116) — client certificate required.

NoApplicationProtocol

no_application_protocol (120) — no ALPN protocol overlap.

Unknown(u8)

An alert code not listed in RFC 8446.

The wrapped value is the raw numeric alert code.

Implementations

impl AlertDescription

pub fn to_u8(&self) -> u8

Return the raw RFC 8446 numeric alert code for this description.

Trait Implementations

impl Clone for AlertDescription

fn clone(&self) -> AlertDescription

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AlertDescription

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

Formats the value using the given formatter.

impl Display for AlertDescription

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

Formats the value using the given formatter.

impl From<u8> for AlertDescription

fn from(code: u8) -> Self

Converts to this type from the input type.

impl PartialEq for AlertDescription

fn eq(&self, other: &AlertDescription) -> 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 Eq for AlertDescription

impl StructuralPartialEq for AlertDescription