Skip to main content

CryptoError

Enum CryptoError 

Source
pub enum CryptoError {
    KeyNotSet,
    Keychain(String),
    InvalidFormat,
    InvalidNonce,
    Base64(DecodeError),
    InvalidStoredKey,
    EncryptionFailed,
    DecryptionFailed,
    InvalidUtf8,
}
Expand description

Errors returned by this crate.

Notes:

  • Decryption failures are intentionally generic (see CryptoError::DecryptionFailed) to avoid leaking details useful for oracle-style attacks.
  • Some errors are “format” errors (bad input string), others are environment errors (keychain), and others are cryptographic failures (auth/tag mismatch).

Variants§

§

KeyNotSet

The key does not exist in the OS keychain.

This is expected if you call decrypt / decrypt_bytes before any successful call to encrypt / encrypt_bytes (or before init_keychain_key).

§

Keychain(String)

A keychain operation failed (read/write/permission/backing service failure).

§

InvalidFormat

The encrypted payload string was not in a recognized format.

Expected:

  • v1:nonce:ciphertext (current)
  • nonce:ciphertext (legacy)
§

InvalidNonce

The decoded nonce length was not 12 bytes (AES-GCM standard).

§

Base64(DecodeError)

Base64 decoding failed.

§

InvalidStoredKey

The stored key existed but was not the correct size (must be 32 bytes after decoding).

This can happen if the keychain entry is corrupted or replaced.

§

EncryptionFailed

Encryption failed.

In practice this is rare and usually indicates an internal library failure.

§

DecryptionFailed

Decryption failed.

This occurs when:

  • the wrong key is used,
  • the ciphertext is corrupted,
  • the authentication tag does not verify,
  • the AAD does not match.
§

InvalidUtf8

Decrypted bytes were not valid UTF-8 when calling decrypt.

Trait Implementations§

Source§

impl Debug for CryptoError

Source§

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

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

impl Display for CryptoError

Source§

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

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

impl Error for CryptoError

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<DecodeError> for CryptoError

Source§

fn from(source: DecodeError) -> Self

Converts to this type from the input type.

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> 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> Same for T

Source§

type Output = T

Should always be Self
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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.