Struct cryptsetup_rs::api::CryptDeviceHandle

pub struct CryptDeviceHandle<P: Debug> { /* fields omitted */ }

An opaque handle on an initialized crypt device

Trait Implementations

impl<P: Debug> CryptDevice for CryptDeviceHandle<P>

fn path(&self) -> &Path

Path the device was opened/created with

fn cipher(&self) -> &str

Name of cipher used

fn cipher_mode(&self) -> &str

Name of cipher mode used

fn device_name(&self) -> &str

Path to the underlying device (as reported by libcryptsetup)

fn rng_type(&self) -> crypt_rng_type

Random number generator used for operations on this crypt device

fn set_rng_type(&mut self, rng_type: crypt_rng_type)

Sets the random number generator to use

fn set_iteration_time(&mut self, iteration_time_ms: u64)

Sets the iteration time for the PBKDF2 function. Note that this does not affect the MK iterations.

fn volume_key_size(&self) -> u8

Volume key size (in bytes)

impl CryptDeviceType for CryptDeviceHandle<Luks1Params>

fn device_type(&self) -> crypt_device_type

Type of the crypt device

impl CryptDeviceType for CryptDeviceHandle<Luks2Params>

fn device_type(&self) -> crypt_device_type

Type of the crypt device

impl<P: Debug> Debug for CryptDeviceHandle<P>

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

Formats the value using the given formatter.

impl<P: Debug> Drop for CryptDeviceHandle<P>

fn drop(&mut self)

Executes the destructor for this type.

impl Luks1CryptDevice for CryptDeviceHandle<Luks1Params>

fn hash_spec(&self) -> &str

Get the hash algorithm used

fn mk_bits(&self) -> u32

Number of bits in the master key

fn mk_digest(&self) -> &[u8; 20]

Master key header digest

fn mk_iterations(&self) -> u32

Master key PBKDF2 iterations

fn mk_salt(&self) -> &[u8; 32]

Master key salt

fn payload_offset(&self) -> u32

Get the offset of the payload

impl Luks2CryptDevice for CryptDeviceHandle<Luks2Params>

fn register_new_token_handler<Handler: Luks2TokenHandlerRaw>(
) -> Result<Luks2TokenHandlerBox<Handler>>

Register a LUKS2 token handler

fn register_token_handler<Handler: Luks2TokenHandlerRaw>(
    handler: &Luks2TokenHandlerBox<Handler>
) -> Result<()>

Register a LUKS2 token handler given a reference to it

fn token_status(
    &mut self,
    token_id: Luks2TokenId
) -> (crypt_token_info, Option<String>)

Get token status for a given token id

fn get_token(&mut self, token_id: Luks2TokenId) -> Result<Luks2Token>

Get a token by id

fn add_token_with_id(
    &mut self,
    token: &Luks2Token,
    token_id: Luks2TokenId
) -> Result<()>

Add a token with a specific id

fn add_token(&mut self, token: &Luks2Token) -> Result<Luks2TokenId>

Add a token, returning the allocated token id

fn remove_token(&mut self, token_id: Luks2TokenId) -> Result<()>

Remove a token by id

fn assign_token_to_keyslot(
    &mut self,
    token_id: Luks2TokenId,
    keyslot_opt: Option<Keyslot>
) -> Result<()>

Assign a token id to a keyslot (or all active keyslots if no keyslot is specified)

fn unassign_token_keyslot(
    &mut self,
    token_id: Luks2TokenId,
    keyslot_opt: Option<Keyslot>
) -> Result<()>

Unassing a token from a keyslot (or all active keyslots if no keyslot is specified)

fn token_keyslot_is_assigned(
    &mut self,
    token_id: Luks2TokenId,
    keyslot: Keyslot
) -> Result<bool>

Check whether a token is assigned to a given keyslot

fn activate_with_token(
    &mut self,
    name: &str,
    token_id: Luks2TokenId
) -> Result<Keyslot>

Activate the crypt device with the specified name and token

fn check_activation_with_token(
    &mut self,
    token_id: Luks2TokenId
) -> Result<Keyslot>

Check activation of a device with a token

impl LuksCryptDevice for CryptDeviceHandle<Luks1Params>

fn activate(&mut self, name: &str, key: &[u8]) -> Result<Keyslot>

Activate the crypt device, and give it the specified name

fn deactivate(self, name: &str) -> Result<()>

Deactivate the crypt device, remove the device-mapper mapping and key information from kernel

fn destroy_keyslot(&mut self, slot: Keyslot) -> Result<()>

Destroy (and disable) key slot

fn keyslot_status(&self, keyslot: Keyslot) -> crypt_keyslot_info

Get status of key slot

fn dump(&self)

Dump text-formatted information about the current device to stdout

fn uuid(&self) -> Uuid

UUID of the current device

fn add_keyslot(
    &mut self,
    key: &[u8],
    maybe_prev_key: Option<&[u8]>,
    maybe_keyslot: Option<Keyslot>
) -> Result<Keyslot>

Add a new keyslot with the specified key

fn update_keyslot(
    &mut self,
    key: &[u8],
    prev_key: &[u8],
    maybe_keyslot: Option<Keyslot>
) -> Result<Keyslot>

Replace an old key with a new one

impl LuksCryptDevice for CryptDeviceHandle<Luks2Params>

fn activate(&mut self, name: &str, key: &[u8]) -> Result<u8>

Activate the crypt device, and give it the specified name

fn deactivate(self, name: &str) -> Result<()>

Deactivate the crypt device, remove the device-mapper mapping and key information from kernel

fn destroy_keyslot(&mut self, slot: Keyslot) -> Result<()>

Destroy (and disable) key slot

fn keyslot_status(&self, keyslot: Keyslot) -> crypt_keyslot_info

Get status of key slot

fn dump(&self)

Dump text-formatted information about the current device to stdout

fn uuid(&self) -> Uuid

UUID of the current device

fn add_keyslot(
    &mut self,
    key: &[u8],
    maybe_prev_key: Option<&[u8]>,
    maybe_keyslot: Option<Keyslot>
) -> Result<Keyslot>

Add a new keyslot with the specified key

fn update_keyslot(
    &mut self,
    key: &[u8],
    prev_key: &[u8],
    maybe_keyslot: Option<Keyslot>
) -> Result<Keyslot>

Replace an old key with a new one

impl<P: PartialEq + Debug> PartialEq<CryptDeviceHandle<P>> for CryptDeviceHandle<P>

fn eq(&self, other: &CryptDeviceHandle<P>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &CryptDeviceHandle<P>) -> bool

This method tests for !=.

impl<P: Debug> StructuralPartialEq for CryptDeviceHandle<P>