bijou 0.0.3

Bijou is a tiny embeddable encrypted file system.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88

// Copyright 2023 Mivik
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//

use crate::sodium::utils;
use std::ops::{Deref, DerefMut};

/// A wrapper around a byte array that is locked in memory
/// and is automatically zeroed out when dropped.
///
/// Please note that this is not aligned, and thus cannot
/// be used under some circumstances.
pub struct SecretBytes(Box<[u8]>);
impl SecretBytes {
    /// Creates a new [`SecretBytes`] from a byte array.
    pub fn new(mut bytes: Box<[u8]>) -> Self {
        // TODO handle this error
        utils::mlock(&mut bytes).unwrap();
        Self(bytes)
    }

    /// Creates a new [`SecretBytes`] from a byte slice,
    /// zeroing out the original slice.
    pub fn move_from(bytes: &mut [u8]) -> Self {
        let result = bytes.to_vec().into();
        utils::memzero(bytes);
        result
    }

    /// Allocates a new [`SecretBytes`] in heap with the given length.
    pub fn allocate(len: usize) -> Self {
        Self::new(vec![0; len].into_boxed_slice())
    }

    pub fn len(&self) -> usize {
        self.0.len()
    }

    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    pub fn as_ptr(&self) -> *const u8 {
        self.0.as_ptr()
    }
}

impl Clone for SecretBytes {
    fn clone(&self) -> Self {
        Self::new(self.0.clone())
    }
}

impl From<Vec<u8>> for SecretBytes {
    fn from(bytes: Vec<u8>) -> Self {
        Self(bytes.into_boxed_slice())
    }
}

impl Deref for SecretBytes {
    type Target = [u8];

    fn deref(&self) -> &Self::Target {
        &self.0
    }
}
impl DerefMut for SecretBytes {
    fn deref_mut(&mut self) -> &mut Self::Target {
        &mut self.0
    }
}

impl Drop for SecretBytes {
    fn drop(&mut self) {
        utils::munlock(&mut self.0).unwrap();
    }
}