Enum FileVaultError 

#[non_exhaustive]
pub enum FileVaultError {
    Io(Error),
    NotCoreStorage {
        found: u16,
    },
    UnsupportedEncryptionMethod {
        found: u32,
    },
    MetadataStructureMissing {
        what: &'static str,
    },
    Base64 {
        what: &'static str,
    },
    KeyUnwrap {
        what: &'static str,
    },
    OutOfRange {
        what: &'static str,
    },
}

Errors surfaced while parsing or decrypting a CoreStorage / FileVault volume.

Every failure is loud and named (Fail-loud): a bootstrap failure — a missing CoreStorage signature, an unreadable metadata block, a failed key unwrap — is an explicit error, never an empty/Ok degrade. A per-artifact miss inside a validated volume is the only place a silent skip is legitimate.

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.

Io(Error)

An I/O error reading the underlying image.

NotCoreStorage

The physical volume header does not carry the CoreStorage "CS" signature at offset 88 — this is not a CoreStorage volume. Carries the bytes that WERE found (Show-the-unrecognized-value).

Fields

found: u16

The 2 signature bytes actually found, little-endian.

UnsupportedEncryptionMethod

The encryption method is not AES-XTS-128 (the only supported method).

Fields

found: u32

The encryption-method code found in the header at offset 172.

MetadataStructureMissing

A required metadata structure could not be located in the (decrypted) metadata — the encryption context, a wrapped-key struct, or the family UUID. Names which one so the investigator knows what was missing.

Fields

what: &'static str

Which structure was missing (e.g. “encryption context plist”).

Base64

A base64 blob in the encryption context did not decode.

Fields

what: &'static str

Which blob failed to decode.

KeyUnwrap

An RFC 3394 AES key-unwrap failed (wrong password, or corrupt wrapped key): the integrity check value did not match 0xA6A6A6A6A6A6A6A6. The password-derived unwrap failing is the “wrong password” signal.

Fields

what: &'static str

Which key failed to unwrap (KEK or VMK).

OutOfRange

A length or count field taken from the image was out of range.

Fields

what: &'static str

What was out of range.

Trait Implementations

impl Debug for FileVaultError

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

Formats the value using the given formatter.

impl Display for FileVaultError

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

Formats the value using the given formatter.

impl Error for FileVaultError

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 FileVaultError

fn from(source: Error) -> Self

Converts to this type from the input type.