Trait Cipher 

pub trait Cipher:
    Debug
    + Send
    + Sync {
    // Required methods
    fn encrypt(
        &self,
        ino: u64,
        attribute_id: u64,
        device_offset: u64,
        file_offset: u64,
        buffer: MutPtrByteSlice<'_>,
    ) -> Result<(), Error>;
    fn decrypt(
        &self,
        ino: u64,
        attribute_id: u64,
        device_offset: u64,
        file_offset: u64,
        buffer: MutPtrByteSlice<'_>,
    ) -> Result<(), Error>;
    fn encrypt_filename(
        &self,
        object_id: u64,
        buffer: &mut Vec<u8>,
    ) -> Result<(), Error>;
    fn decrypt_filename(
        &self,
        object_id: u64,
        buffer: &mut Vec<u8>,
    ) -> Result<(), Error>;
    fn hash_code(&self, _raw_filename: &[u8], filename: &str) -> Option<u32>;
    fn hash_code_casefold(&self, _filename: &str) -> u32;
    fn supports_inline_encryption(&self) -> bool;
    fn crypt_ctx(
        &self,
        ino: u64,
        attribute_id: u64,
        file_offset: u64,
    ) -> Option<(u64, u8)>;

    // Provided methods
    fn decrypt_to(
        &self,
        ino: u64,
        attribute_id: u64,
        device_offset: u64,
        file_offset: u64,
        src: PtrByteSlice<'_>,
        dst: MutPtrByteSlice<'_>,
    ) -> Result<(), Error> { ... }
    fn encrypt_symlink(
        &self,
        object_id: u64,
        buffer: &mut Vec<u8>,
    ) -> Result<(), Error> { ... }
    fn decrypt_symlink(
        &self,
        object_id: u64,
        buffer: &mut Vec<u8>,
    ) -> Result<(), Error> { ... }
}

Trait defining common methods shared across all ciphers.

Required Methods

fn encrypt( &self, ino: u64, attribute_id: u64, device_offset: u64, file_offset: u64, buffer: MutPtrByteSlice<'_>, ) -> Result<(), Error>

Encrypts data in the buffer.

• offset is the byte offset within the file.
• buffer is mutated in place.

buffer must be 16 byte aligned.

fn decrypt( &self, ino: u64, attribute_id: u64, device_offset: u64, file_offset: u64, buffer: MutPtrByteSlice<'_>, ) -> Result<(), Error>

Decrypt the data in buffer.

• offset is the byte offset within the file.
• buffer is mutated in place.

buffer must be 16 byte aligned.

fn encrypt_filename( &self, object_id: u64, buffer: &mut Vec<u8>, ) -> Result<(), Error>

Encrypts the filename contained in buffer.

fn decrypt_filename( &self, object_id: u64, buffer: &mut Vec<u8>, ) -> Result<(), Error>

Decrypts the filename contained in buffer.

fn hash_code(&self, _raw_filename: &[u8], filename: &str) -> Option<u32>

Returns a hash_code to use. Note in the case of encrypted filenames, takes the raw encrypted bytes.

fn hash_code_casefold(&self, _filename: &str) -> u32

Returns a case-folded hash_code to use for ‘filename’.

fn supports_inline_encryption(&self) -> bool

True if supports inline encryption

fn crypt_ctx( &self, ino: u64, attribute_id: u64, file_offset: u64, ) -> Option<(u64, u8)>

If this cipher type supports inline encryption, returns the (dun, slot) value. Else returns None.

Provided Methods

fn decrypt_to( &self, ino: u64, attribute_id: u64, device_offset: u64, file_offset: u64, src: PtrByteSlice<'_>, dst: MutPtrByteSlice<'_>, ) -> Result<(), Error>

Decrypts data from src into dst.

• file_offset is the byte offset within the file.
• src and dst must have the same length.
• src and dst must both be aligned to 64 bytes.

fn encrypt_symlink( &self, object_id: u64, buffer: &mut Vec<u8>, ) -> Result<(), Error>

Encrypts the symlink target contained in buffer.

fn decrypt_symlink( &self, object_id: u64, buffer: &mut Vec<u8>, ) -> Result<(), Error>

Decrypts the symlink target contained in buffer.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl Cipher for FxfsCipher