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 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
// SPDX-FileCopyrightText: © 2020 Etebase Authors
// SPDX-License-Identifier: LGPL-2.1-only
use std::convert::TryInto;
use sodiumoxide::{
base64,
padding::{pad, unpad},
};
use super::error::{Error, Result};
pub type StrBase64 = str;
pub type StringBase64 = String;
/// The size of the salt added to the password to derive the symmetric encryption key
pub const SALT_SIZE: usize = 16; // sodium.crypto_pwhash_argon2id_SALTBYTES
/// The size of the private encryption key
pub const PRIVATE_KEY_SIZE: usize = 32; // sodium.crypto_box_curve25519xsalsa20poly1305_SECRETKEYBYTES;
/// The size of a symmetric encryption key
pub const SYMMETRIC_KEY_SIZE: usize = 32; // sodium.crypto_aead_xchacha20poly1305_ietf_KEYBYTES;
/// The size of a symmetric encryption tag
pub const SYMMETRIC_TAG_SIZE: usize = 16; // sodium.crypto_aead_xchacha20poly1305_ietf_ABYTES;
/// The size of a symmetric encryption nonce
pub const SYMMETRIC_NONCE_SIZE: usize = 24; // sodium.crypto_aead_xchacha20poly1305_ietf_NPUBBYTES;
/// Returns a buffer filled with cryptographically random bytes.
///
/// # Examples
///
/// ```
/// use etebase::utils::randombytes;
///
/// let a = randombytes(5);
/// assert_eq!(5, a.len());
///
/// let b = randombytes(0);
/// assert!(b.is_empty());
/// ```
pub fn randombytes(size: usize) -> Vec<u8> {
sodiumoxide::randombytes::randombytes(size)
}
/// A version of [`randombytes`] that returns a fixed-size array instead of a Vec.
///
/// # Examples
///
/// ```
/// use etebase::utils::randombytes_array;
///
/// // Explicitly specifying the length as a type generic
/// let a = randombytes_array::<5>();
///
/// // Letting the length be inferred from the result type
/// let b: [u8; 10] = randombytes_array();
/// ```
pub fn randombytes_array<const N: usize>() -> [u8; N] {
sodiumoxide::randombytes::randombytes(N)
.try_into()
.expect("randombytes() returned a Vec with wrong size")
}
/// Return a buffer filled with deterministically cryptographically random bytes
///
/// This function is similar to [`randombytes`] but always returns the same data for the same seed.
/// Useful for testing purposes.
///
/// # Arguments:
/// * `seed` - the seed to generate the random data from
/// * `size` - the size of the returned buffer (in bytes)
///
/// # Examples
///
/// ```
/// use etebase::utils::randombytes_deterministic;
///
/// let seed = [42; 32];
///
/// // Equal seeds produce equal sequences, regardless of length
/// let a = randombytes_deterministic(10, &seed);
/// let b = randombytes_deterministic(5, &seed);
///
/// assert_eq!(a[..5], b);
///
/// // Different seeds produce different sequences
/// let c = randombytes_deterministic(10, &[0; 32]);
///
/// assert_ne!(a, c);
/// assert_eq!(c, &[5, 67, 208, 128, 105, 110, 24, 70, 104, 100]);
/// ```
pub fn randombytes_deterministic(size: usize, seed: &[u8; 32]) -> Vec<u8> {
// Not exactly like the sodium randombytes_deterministic but close enough
let nonce =
sodiumoxide::crypto::stream::xchacha20::Nonce(*b"LibsodiumDRG\0\0\0\0\0\0\0\0\0\0\0\0");
let key = sodiumoxide::crypto::stream::xchacha20::Key(*seed);
sodiumoxide::crypto::stream::xchacha20::stream(size, &nonce, &key)
}
/// A constant-time comparison function. Returns `true` if `x` and `y` are equal.
///
/// Use this when comparing secret data in order to prevent side-channel attacks.
///
/// # Examples
///
/// ```
/// use etebase::utils::memcmp;
///
/// fn validate_password(input: &[u8]) -> Result<(), ()> {
/// let password = b"hunter2";
///
/// if memcmp(input, password) {
/// Ok(())
/// } else {
/// Err(())
/// }
/// }
///
/// assert_eq!(Err(()), validate_password(b"letmein"));
/// assert_eq!(Err(()), validate_password(b""));
/// assert_eq!(Ok(()), validate_password(b"hunter2"));
/// ```
pub fn memcmp(x: &[u8], y: &[u8]) -> bool {
sodiumoxide::utils::memcmp(x, y)
}
/// Converts a Base64 URL encoded string to a Vec of bytes.
///
/// # Examples
///
/// ```
/// use etebase::utils::from_base64;
///
/// let data = "SGVsbG8_IFdvcmxkIQ";
/// let decoded = from_base64(data);
///
/// assert_eq!(Ok(b"Hello? World!".to_vec()), decoded);
///
/// assert_eq!(Ok(b"".to_vec()), from_base64(""));
/// ```
pub fn from_base64(string: &StrBase64) -> Result<Vec<u8>> {
match base64::decode(string, base64::Variant::UrlSafeNoPadding) {
Ok(bytes) => Ok(bytes),
Err(_) => Err(Error::Base64("Failed decoding base64 string")),
}
}
/// Convert a buffer to a Base64 URL encoded string
///
/// # Examples
///
/// ```
/// use etebase::utils::to_base64;
///
/// let data = b"Hello? World!";
/// let encoded = to_base64(data);
///
/// assert_eq!(Ok("SGVsbG8_IFdvcmxkIQ"), encoded.as_deref());
///
/// assert_eq!(Ok(""), to_base64(b"").as_deref());
/// ```
pub fn to_base64(bytes: &[u8]) -> Result<StringBase64> {
Ok(base64::encode(bytes, base64::Variant::UrlSafeNoPadding))
}
/// Fisher–Yates shuffle - an unbiased shuffler
///
/// Shuffles the passed slice in-place and returns the new indices of all input items.
///
/// # Examples
///
/// ```no_compile
/// let mut data = vec!["foo", "bar", "baz"];
///
/// let ret = shuffle(&mut data);
/// // Let's assume the data was randomly shuffled like this:
/// # data = vec!["bar", "baz", "foo"];
/// assert_eq!(data, &["bar", "baz", "foo"]);
///
/// // The first element (foo) is now at index 2, the second is at index 0, the third is at index 1
/// assert_eq!(ret, &[2, 0, 1]);
/// ```
pub(crate) fn shuffle<T>(a: &mut [T]) -> Vec<usize> {
let len = a.len();
let mut shuffled_indices: Vec<usize> = (0..len).collect();
for i in 0..len {
let j = i + sodiumoxide::randombytes::randombytes_uniform((len - i) as u32) as usize;
a.swap(i, j);
shuffled_indices.swap(i, j);
}
let mut ret = vec![0; len];
for i in 0..len {
ret[shuffled_indices[i]] = i;
}
ret
}
/// Return the recommended padding length for a buffer of specific length
///
/// Padding data before encrypting it is important for preventing fingerprint analysis attacks.
/// This function aims to return the optimal balance between space efficiently and fingerprint
/// resistance. The returned values may change between versions.
///
/// # Arguments:
/// * `length` - the length of the buffer to pad
pub fn get_padding(length: u32) -> u32 {
// Use the padme padding scheme for efficiently
// https://www.petsymposium.org/2019/files/papers/issue4/popets-2019-0056.pdf
// We want a minimum pad size of 4k
if length < (1 << 14) {
let size = (1 << 10) - 1;
// We add 1 so we always have some padding
return (length | size) + 1;
}
let e = (length as f64).log2().floor();
let s = (e.log2().floor() as u32) + 1;
let last_bits = (e as u32) - s;
let bit_mask = (1 << last_bits) - 1;
(length + bit_mask) & !bit_mask
}
// FIXME: we should properly pad the meta and probably change these functions
pub(crate) fn buffer_pad_small(buf: &[u8]) -> Result<Vec<u8>> {
let len = buf.len();
let padding = len + 1;
buffer_pad_fixed(buf, padding)
}
pub(crate) fn buffer_pad(buf: &[u8]) -> Result<Vec<u8>> {
let len = buf.len();
let padding = get_padding(len as u32) as usize;
buffer_pad_fixed(buf, padding)
}
pub(crate) fn buffer_unpad(buf: &[u8]) -> Result<Vec<u8>> {
let len = buf.len();
// We pass the buffer's length as the block size because due to padme there's always some variable-sized padding.
buffer_unpad_fixed(buf, len)
}
pub(crate) fn buffer_pad_fixed(buf: &[u8], blocksize: usize) -> Result<Vec<u8>> {
let len = buf.len();
let missing = blocksize - (len % blocksize);
let padding = len + missing;
let mut ret = vec![0; padding];
ret[..len].copy_from_slice(buf);
pad(&mut ret[..], len, blocksize).map_err(|_| Error::Padding("Failed padding"))?;
Ok(ret)
}
pub(crate) fn buffer_unpad_fixed(buf: &[u8], blocksize: usize) -> Result<Vec<u8>> {
let len = buf.len();
if len == 0 {
return Ok(vec![0; 0]);
}
let mut buf = buf.to_vec();
let new_len =
unpad(&buf[..], len, blocksize).map_err(|_| Error::Padding("Failed unpadding"))?;
buf.truncate(new_len);
Ok(buf)
}
/// A trait for serializing and deserializing to MsgPack
pub trait MsgPackSerilization {
/// The type of the struct implementing this trait
type Output;
/// Convert self to a msgpack encoded buffer
fn to_msgpack(&self) -> Result<Vec<u8>>;
/// Create the struct from a MsgPack encoded buffer
///
/// # Arguments:
/// * `data` - the MsgPack buffer
fn from_msgpack(data: &[u8]) -> Result<Self::Output>;
}
#[cfg(test)]
mod tests {
#[test]
fn padding() {
crate::init().unwrap();
// Because of how we use padding (unpadding) we need to make sure padding is always larger than the content
// Otherwise we risk the unpadder to fail thinking it should unpad when it shouldn't.
for i in 1..(1 << 14) {
if super::get_padding(i) <= i {
println!("Yo");
assert_eq!(format!("Failed for {}", i), "");
}
}
assert_eq!(super::get_padding(2343242), 2359296);
}
#[test]
fn pad_unpad() {
crate::init().unwrap();
let buf = [0; 1076];
let padded = super::buffer_pad(&buf).unwrap();
let unpadded = super::buffer_unpad(&padded[..]).unwrap();
assert_eq!(unpadded, &buf[..]);
}
#[test]
fn pad_unpad_fixed() {
crate::init().unwrap();
let blocksize = 32;
for i in 0..(blocksize * 2) {
let buf = vec![60; i];
let padded = super::buffer_pad_fixed(&buf, blocksize).unwrap();
let unpadded = super::buffer_unpad_fixed(&padded[..], blocksize).unwrap();
assert_eq!(unpadded, &buf[..]);
}
}
}