Enum LuksError 

#[non_exhaustive]
pub enum LuksError {
    NotLuks {
        found: [u8; 6],
    },
    UnsupportedVersion {
        version: u16,
    },
    Unsupported {
        what: &'static str,
        value: String,
    },
    DerivationBudgetExceeded {
        iterations: u32,
        projected_secs: u64,
        budget_secs: u64,
    },
    ImplausibleStripes {
        stripes: usize,
        max: usize,
        block_size: usize,
    },
    DerivationMemoryExceeded {
        requested_kib: u32,
        max_kib: u32,
    },
    MalformedHeader {
        what: &'static str,
        need: usize,
        got: usize,
    },
    AuthenticationFailed,
    NoActiveKeyslot,
    Io(Error),
}

A LUKS parse or unlock failure. Every variant names the offending value so an investigator can act on it (never a bare “invalid”).

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.

NotLuks

The LUKS\xba\xbe magic is absent — not a LUKS container.

Fields

found: [u8; 6]

The first six bytes actually found.

UnsupportedVersion

The header version is neither 1 nor 2.

Fields

version: u16

The version field value.

Unsupported

The cipher/mode/hash combination has no validated decrypt path.

Fields

what: &'static str

Which axis is unsupported (cipher, mode, hash).

value: String

The offending value verbatim.

DerivationBudgetExceeded

The keyslot demands more key-derivation work than the wall-clock budget allows. The iteration count comes from the header, so a crafted container can ask for billions of rounds; refusing is the only way the tool stays responsive on hostile input.

A refusal, never a silent reduction: deriving with fewer rounds than the header specifies produces a different key, which would report a wrong passphrase for a container that would in fact have opened.

Fields

iterations: u32

The iteration count the header asked for, verbatim.

projected_secs: u64

Projected cost on this machine, measured from a calibration run.

budget_secs: u64

The budget that was exceeded.

ImplausibleStripes

The keyslot’s anti-forensic stripe count is not plausible.

stripes is a header field, so the container chooses it. It multiplies the key size to give the key-material length the caller then allocates, and it is the trip count of the AF merge loop — so an unbounded value is both an allocation and a spin, on the container’s say-so.

LUKS1 fixes the count at 4000 and cryptsetup writes the same for LUKS2, so the ceiling sits far above anything genuine.

Fields

stripes: usize

The stripe count the header asked for, verbatim.

max: usize

The ceiling that was exceeded.

block_size: usize

The key size the count would have been multiplied by.

DerivationMemoryExceeded

The Argon2 keyslot demands more memory than the ceiling allows.

Separate from Self::DerivationBudgetExceeded because memory cannot be bounded the same way: a time cost can be measured and projected, but attempting an oversized allocation is itself the harm — the process is killed by the OS before any deadline could fire. argon2::Params caps m_cost at u32::MAX 1 KiB blocks (4 TiB) and the header chooses the value, so the ceiling has to be ours.

Fields

requested_kib: u32

The memory cost the header asked for, verbatim, in KiB blocks.

max_kib: u32

The ceiling that was exceeded, in KiB blocks.

MalformedHeader

The header is structurally malformed (a field runs past the buffer).

Fields

what: &'static str

What was being read.

need: usize

Bytes needed.

got: usize

Bytes available.

AuthenticationFailed

No keyslot could be unlocked with the supplied passphrase, or the derived master key failed the mk-digest check (wrong passphrase).

NoActiveKeyslot

The container carries no active (enabled) keyslot.

Io(Error)

An I/O error reading the container.

Trait Implementations

impl Debug for LuksError

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

Formats the value using the given formatter.

impl Display for LuksError

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

Formats the value using the given formatter.

impl Error for LuksError

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

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

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

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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.

impl From<Error> for LuksError

fn from(source: Error) -> Self

Converts to this type from the input type.