Skip to main content

HpkeError

Enum HpkeError 

Source
pub enum HpkeError {
Show 16 variants ValidationError, DeserializeError, EncapError, DecapError, OpenError, DeriveKeyPairError, MessageLimitReached, NotSupported, InvalidPseudorandomKey, InvalidKey, KdfOutputTooLong, Aead(AeadError), EllipticCurve(EllipticCurveError), MlKem(MlKemError), Random(RandomError), Unspecified,
}
Expand description

Errors that can occur during HPKE setup, key encapsulation, key derivation or message encryption/decryption.

Variants§

§

ValidationError

A KEM input or output failed validation (e.g. an invalid or low-order public key was provided), or a pre-shared key mode input is missing (an empty pre-shared key or pre-shared key identifier).

§

DeserializeError

A key, encapsulated key or ciphertext could not be deserialized (e.g. wrong length or malformed encoding).

§

EncapError

The encapsulation step failed (e.g. the recipient’s public key is invalid).

§

DecapError

The decapsulation step failed (e.g. the encapsulated key is invalid, or the Diffie-Hellman output was rejected).

§

OpenError

The AEAD failed to decrypt the ciphertext (wrong key, tampered ciphertext or wrong associated data).

§

DeriveKeyPairError

Deriving a key pair from input keying material failed after exhausting all rejection-sampling candidates.

§

MessageLimitReached

A message length or sequence-number limit was reached: the plaintext exceeds the AEAD’s P_MAX, the ciphertext exceeds C_MAX, or the context has exhausted its sequence numbers, so no further messages can be sealed or opened with this context (draft-ietf-hpke-hpke-05 Sections 4.3 and 5.2).

§

NotSupported

The operation is not supported by this KEM, KDF or AEAD (e.g. an authenticated mode with a KEM that does not support it, or sealing a message with the Export-Only pseudo-AEAD).

§

InvalidPseudorandomKey

The pseudorandom key given to the KDF expand step does not have the expected length.

§

InvalidKey

The key given to the AEAD does not have the expected length.

§

KdfOutputTooLong

The KDF was asked for more output than it can produce (255 * OUTPUT_SIZE for two-stage KDFs, 2^16 - 1 bytes for single-stage KDFs).

§

Aead(AeadError)

An underlying AEAD error.

§

EllipticCurve(EllipticCurveError)

An underlying elliptic-curve error.

§

MlKem(MlKemError)

An underlying ML-KEM error.

§

Random(RandomError)

The operating system’s random number generator failed.

§

Unspecified

Something went wrong, without further details.

Trait Implementations§

Source§

impl Clone for HpkeError

Source§

fn clone(&self) -> Self

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 Copy for HpkeError

Source§

impl Debug for HpkeError

Source§

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

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

impl Display for HpkeError

Source§

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

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

impl Eq for HpkeError

Source§

impl Error for HpkeError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<AeadError> for HpkeError

Source§

fn from(err: AeadError) -> Self

Converts to this type from the input type.
Source§

impl From<EllipticCurveError> for HpkeError

Source§

fn from(err: EllipticCurveError) -> Self

Converts to this type from the input type.
Source§

impl From<HkdfError> for HpkeError

Source§

fn from(err: HkdfError) -> Self

Converts to this type from the input type.
Source§

impl From<MlKemError> for HpkeError

Source§

fn from(err: MlKemError) -> Self

Converts to this type from the input type.
Source§

impl From<RandomError> for HpkeError

Source§

fn from(err: RandomError) -> Self

Converts to this type from the input type.
Source§

impl From<XWingError> for HpkeError

Source§

fn from(err: XWingError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for HpkeError

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for HpkeError

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<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, 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> 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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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.