Skip to main content

ChaChaEngine

Struct ChaChaEngine 

Source
pub struct ChaChaEngine { /* private fields */ }
Expand description

ChaCha20-Poly1305 based crypto engine. Derives the actual encryption key from a master key using HKDF.

Implementations§

Source§

impl ChaChaEngine

Source

pub fn new(master_key: &[u8]) -> FsResult<Self>

Create from a raw master key. The encryption key is derived via HKDF-SHA256.

Source

pub fn generate() -> FsResult<Self>

Convenience: create with a randomly generated master key (for testing / new FS).

Examples found in repository?
examples/create_image.rs (line 32)
15fn main() {
16    let path = std::env::current_dir()
17        .unwrap()
18        .join("sample.dcfs")
19        .to_string_lossy()
20        .to_string();
21
22    // Remove leftover from a previous run, if any.
23    let _ = std::fs::remove_file(&path);
24
25    // 64 blocks × 64 KiB = 4 MiB image.
26    let total_blocks: u64 = 64;
27    let store = Arc::new(
28        DiskBlockStore::create(&path, DEFAULT_BLOCK_SIZE, total_blocks)
29            .expect("failed to create image file"),
30    );
31
32    let crypto = Arc::new(ChaChaEngine::generate().expect("failed to init crypto"));
33    let mut fs = FilesystemCore::new(store, crypto);
34
35    fs.init_filesystem().expect("init_filesystem failed");
36
37    // Create a text file.
38    fs.create_file("hello.txt").expect("create_file failed");
39    fs.write_file("hello.txt", 0, b"Hello, hex editor!")
40        .expect("write_file failed");
41
42    // Create a directory.
43    fs.create_directory("notes")
44        .expect("create_directory failed");
45
46    // Create a larger binary file so there's more to look at.
47    let pattern: Vec<u8> = (0..=255).cycle().take(200_000).collect();
48    fs.create_file("pattern.bin").expect("create_file failed");
49    fs.write_file("pattern.bin", 0, &pattern)
50        .expect("write_file failed");
51
52    fs.sync().expect("sync failed");
53
54    println!("Filesystem image written to:\n  {path}");
55    println!(
56        "  {} blocks × {} bytes = {} bytes total",
57        total_blocks,
58        DEFAULT_BLOCK_SIZE,
59        total_blocks as usize * DEFAULT_BLOCK_SIZE
60    );
61}

Trait Implementations§

Source§

impl CryptoEngine for ChaChaEngine

Source§

fn encrypt(&self, plaintext: &[u8]) -> FsResult<(Vec<u8>, Vec<u8>)>

Encrypt plaintext into ciphertext with a nonce. Returns (nonce, ciphertext).
Source§

fn decrypt(&self, nonce: &[u8], ciphertext: &[u8]) -> FsResult<Vec<u8>>

Decrypt ciphertext with the given nonce. Returns plaintext.
Source§

impl Drop for ChaChaEngine

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more

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, 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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V