hiss 0.1.0

Static, type-level Noise Protocol Framework with pluggable hardware-backed crypto.
Documentation
//! Noise handshake errors.

use super::cipher_state::MAX_MESSAGE_LEN;

/// Errors that can occur during a Noise handshake.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum HandshakeError {
    /// A cryptographic operation failed (e.g. DH, key generation).
    ///
    /// The underlying curve/provider error is preserved as the
    /// [`source`](std::error::Error::source).
    #[error("crypto operation failed: {0}")]
    Crypto(#[source] Box<dyn std::error::Error + Send + Sync>),

    /// The incoming message is shorter than expected.
    #[error("incoming message too short — expected more data")]
    MessageTooShort,

    /// AEAD decryption failed — authentication tag mismatch.
    #[error("decryption failed — authentication tag mismatch")]
    DecryptionFailed,

    /// A local static key was required but not provided.
    #[error("missing local static key")]
    MissingStaticKey,

    /// A local ephemeral key was expected but has not been generated.
    #[error("missing local ephemeral key")]
    MissingEphemeralKey,

    /// The remote party's static public key was required but not available.
    #[error("missing remote static public key")]
    MissingRemoteStatic,

    /// The remote party's ephemeral public key was expected but not received.
    #[error("missing remote ephemeral public key")]
    MissingRemoteEphemeral,

    /// The nonce counter has overflowed (2^64 − 1 messages encrypted).
    #[error("nonce overflow — session must be rekeyed")]
    NonceOverflow,

    /// A public key could not be deserialised from the wire.
    #[error("invalid public key: {0}")]
    InvalidPublicKey(#[source] Box<dyn std::error::Error + Send + Sync>),

    /// A peer public key was not in its canonical on-wire encoding
    /// (e.g. a P-256 key sent compressed or with trailing bytes on the
    /// fixed-width uncompressed wire field).
    #[error("peer public key is not in canonical wire encoding")]
    NonCanonicalPublicKey,

    /// A message exceeds the Noise 65535-byte maximum length (spec §3).
    #[error("message too long: {len} bytes exceeds the {MAX_MESSAGE_LEN}-byte Noise maximum")]
    MessageTooLong {
        /// Length of the offending message (on the wire, including any tag).
        len: usize,
    },

    /// The output buffer is too small for the result.
    #[error("output buffer too small: need {needed} bytes, got {actual}")]
    OutputBufferTooSmall {
        /// Minimum required buffer size.
        needed: usize,
        /// Actual buffer size provided.
        actual: usize,
    },

    /// Rekey was called on a CipherState without a key.
    #[error("cannot rekey — no key has been established")]
    RekeyWithoutKey,

    /// An I/O error occurred while reading or writing the handshake
    /// transcript. This variant is always present: the blocking
    /// [`SyncHandshake`](super::io_sync::SyncHandshake) driver surfaces
    /// [`std::io`] failures through it,
    /// and the `AsyncHandshake` driver (feature `async-io`) surfaces
    /// `tokio::io` failures through it.
    #[error("handshake I/O error: {0}")]
    Io(#[from] std::io::Error),
}