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
//! # Enc_File //! //! `Enc_File` is a simple tool to encrypt and decrypt files. Warning: This crate hasn't been audited or reviewed in any sense. I created it to easily encrypt und decrypt non-important files which won't cause harm if known by third parties. Don't use for anything important, use VeraCrypt or similar instead. //! //! Uses AES-GCM-SIV (https://docs.rs/aes-gcm-siv) for cryptography, bincode (https://docs.rs/bincode) for encoding and BLAKE3 (https://docs.rs/blake3) for hashing. //! //! It's a binary target. Install via cargo install enc_file //! //! See https://github.com/LazyEmpiricist/enc_file //! //! # Examples //! //! ``` //! use ::enc_file::{create_key, decrypt_file, encrypt_file, read_file, save_file}; //! use serde::{Deserialize, Serialize}; //! use std::env; //! use std::str::from_utf8; //! //! fn main() -> Result<(), Box<dyn std::error::Error>> { //! let args: Vec<String> = env::args().collect(); //! //args[0] will be the filename or the cargo command! //! if args.len() >= 2 { //! let operation = &args[1]; //! println!("Operation: {}", &operation); //! if operation == "encrypt" && args.len() == 4 { //! let filename = &args[2]; //! let keyfile = &args[3]; //! println!("File {}", &filename); //! println!("Keyfile: {}", &keyfile); //! let key = read_file(keyfile)?; //! let key: &str = from_utf8(&key)?; //! let content = read_file(&filename)?; //! let ciphertext: Vec<u8> = encrypt_file(content, &key)?; //! let new_filename: String = filename.to_owned() + ".crypt"; //! //println!("Ciphertext: {:?}", &ciphertext); //! save_file(ciphertext, &new_filename)?; //! println!("Successfully enrypted file to {:?}", &new_filename); //! } else if operation == "decrypt" && args.len() == 4 { //! let filename = &args[2]; //! let keyfile = &args[3]; //! println!("File {}", &filename); //! println!("Keyfile: {}", &keyfile); //! let key = read_file(keyfile)?; //! let key: &str = from_utf8(&key)?; //! let filename_decrypted: &str = &filename[0..filename.find("crypt").unwrap()]; //! let ciphertext = read_file(filename)?; //! //println!("Ciphertext read from file: {:?}", &ciphertext); //! //println!("Decrypted"); //! let plaintext: Vec<u8> = decrypt_file(ciphertext, &key)?; //! save_file(plaintext, filename_decrypted)?; //! println!("Successfully decrypted file to {:?}", &filename_decrypted); //! } else if operation == "create-key" && args.len() == 3 { //! let filename = &args[2]; //! println!("File {}", &filename); //! create_key(&filename)?; //! println!("Keyfile {:?} created", &filename); //! } else if operation == "hash" && args.len() == 3 { //! let filename = &args[2]; //! let hash = get_blake3_hash(&filename)?; //! println!("File: {}. BLAKE3 hash: {:?}", filename, hash); //! } //! } else { //! println!( //! r#"Use "encrypt filename-to_encrypt filename-keyfile" or "decrypt filename-to_decrypt filename-keyfile" or "create-key filename-keyfile" "# //! ); //! println!(r#"Example: "encrypt text.txt key.file""#); //! } //! Ok(()) //! } //! ``` // Warning: Don't use for anything important! This crate hasn't been audited or reviewed in any sense. I created it to easily encrypt und decrypt non-important files which won't cause harm if known by third parties. // // Uses AES-GCM-SIV (https://docs.rs/aes-gcm-siv) for cryptography and bincode (https://docs.rs/bincode) for encoding. // // Either generate a keyfile via "cargo run create-key key.file" or use own 32-long char-utf8 password in a keyfile. // // "cargo run encrypt .example.file .key.file" will create a new (encrypted) file "example.file.crypt" in the same directory. // // "cargo run decrypt example.file.crypt key.file" will create a new (decrypted) file "example.file" in the same directory. // // Both encrypt and decrypt override existing files! aes_gcm_siv::aead::{generic_array::GenericArray, Aead, NewAead}; // Calculate hash using BLAKE3 (recommended), SHA256 or SHA512 use aes_gcm_siv::aead::{generic_array::GenericArray, Aead, NewAead}; use aes_gcm_siv::Aes256GcmSiv; use rand::distributions::Alphanumeric; use rand::rngs::OsRng; use rand::Rng; use serde::{Deserialize, Serialize}; use sha2::{Digest, Sha256, Sha512}; use std::fs::File; use std::io::prelude::*; #[derive(Serialize, Deserialize, PartialEq, Debug)] struct Cipher { len: usize, rand_string: String, ciphertext: Vec<u8>, } /// Reads file from same folder as Vec<u8>. Returns result. /// # Examples /// /// ``` /// let path: &str = "test.file"; /// let content_read: Vec<u8> = read_file(&path).unwrap(); /// ``` pub fn read_file(path: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let mut f = File::open(path)?; let mut buffer = Vec::new(); // read the whole file f.read_to_end(&mut buffer)?; //println!("{:?}", from_utf8(&buffer)?); Ok(buffer) } /// Saves file to same folder. Returns result /// # Examples /// /// ``` /// let new_filename: String = filename.to_owned() + ".crpt"; /// save_file(ciphertext, &new_filename).unwrap(); /// ``` pub fn save_file(data: Vec<u8>, path: &str) -> std::io::Result<()> { let mut file = File::create(path)?; file.write_all(&data)?; Ok(()) } /// Creates a new key from given charset. Does not use crypto_rand at this time. Returns result. /// # Examples /// /// ``` /// let filename: &str = "test.file"; /// create_key(&filename).unwrap(); /// ``` pub fn create_key(path: &str) -> std::io::Result<()> { let key: String = OsRng .sample_iter(&Alphanumeric) .take(32) .collect::<String>(); let mut file = File::create(path)?; file.write_all(&key.as_bytes())?; Ok(()) } /// Encrypts cleartext (Vec<u8>) into ciphertext (Vec<u8>) using provided key from keyfile. Returns result. /// # Examples /// /// ``` /// let text = b"This a test"; /// let key: &str = "an example very very secret key."; /// let text_vec = text.to_vec(); /// let ciphertext: Vec<u8> = encrypt_file(text_vec, key).unwrap(); /// ``` pub fn encrypt_file(cleartext: Vec<u8>, key: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let key = GenericArray::clone_from_slice(key.as_bytes()); let aead = Aes256GcmSiv::new(key); let rand_string: String = OsRng .sample_iter(&Alphanumeric) .take(12) .collect::<String>(); let nonce = GenericArray::from_slice(rand_string.as_bytes()); let ciphertext: Vec<u8> = aead .encrypt(nonce, cleartext.as_ref()) .expect("encryption failure!"); let ciphertext_to_send = Cipher { len: ciphertext.len(), rand_string, ciphertext, }; let encoded: Vec<u8> = bincode::serialize(&ciphertext_to_send).unwrap(); Ok(encoded) } /// Decrypts ciphertext (Vec<u8>) into cleartext (Vec<u8>) using provided key from keyfile. Returns result. /// # Examples /// /// ``` /// let key: &str = "an example very very secret key."; /// let plaintext: Vec<u8> = decrypt_file(ciphertext, key).unwrap(); /// assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); /// ``` pub fn decrypt_file(enc: Vec<u8>, key: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let key = GenericArray::clone_from_slice(key.as_bytes()); let aead = Aes256GcmSiv::new(key); let decoded: Cipher = bincode::deserialize(&enc[..]).unwrap(); let (ciphertext2, len_ciphertext, rand_string2) = (decoded.ciphertext, decoded.len, decoded.rand_string); if ciphertext2.len() != len_ciphertext { panic!("length of received ciphertext not ok") }; let nonce = GenericArray::from_slice(rand_string2.as_bytes()); let plaintext: Vec<u8> = aead .decrypt(nonce, ciphertext2.as_ref()) .expect("decryption failure!"); //println!("{:?}", std::str::from_utf8(&plaintext).unwrap()); Ok(plaintext) } /// Get BLAKE3 Hash from file. Returns result. /// # Examples /// /// ``` /// let filename = "cargo.toml"; /// let hash1 = get_blake3_hash(&filename).unwrap(); /// let hash2 = get_blake3_hash(&filename).unwrap(); /// println!("File: {}. hash1: {:?}, hash2: {:?}", filename, hash1, hash2); /// assert_eq!(hash1, hash2); /// ``` pub fn get_blake3_hash(path: &str) -> Result<blake3::Hash, Box<dyn std::error::Error>> { let data = read_file(path)?; let hash = blake3::hash(&data); Ok(hash) } /// Get SHA256 Hash from file. Returns result. /// # Examples /// /// ``` /// let filename = "cargo.toml"; /// let hash1 = get_sha256_hash(&filename).unwrap(); /// let hash2 = get_sha256_hash(&filename).unwrap(); /// println!("File: {}. hash1: {:?}, hash2: {:?}", filename, hash1, hash2); /// assert_eq!(hash1, hash2); /// ``` pub fn get_sha256_hash(path: &str) -> Result<String, Box<dyn std::error::Error>> { let data = read_file(path)?; // create a Sha256 object let mut hasher = Sha256::new(); // write input message hasher.input(data); // read hash digest and consume hasher let hash = hasher.result(); Ok(format!("{:?}", hash)) } /// Get SHA512 Hash from file. Returns result. /// # Examples /// /// ``` /// let filename = "cargo.toml"; /// let hash1 = get_sha512_hash(&filename).unwrap(); /// let hash2 = get_sha512_hash(&filename).unwrap(); /// println!("File: {}. hash1: {:?}, hash2: {:?}", filename, hash1, hash2); /// assert_eq!(hash1, hash2); /// ``` pub fn get_sha512_hash(path: &str) -> Result<String, Box<dyn std::error::Error>> { let data = read_file(path)?; // create a Sha256 object let mut hasher = Sha512::new(); // write input message hasher.input(data); // read hash digest and consume hasher let hash = hasher.result(); Ok(format!("{:?}", hash)) } #[cfg(test)] mod tests { use super::*; use std::fs::remove_file; #[test] fn test_save_read_file() { let content: Vec<u8> = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]; let path: &str = "test_abcdefg.file"; save_file(content.clone(), &path).unwrap(); let content_read: Vec<u8> = read_file(&path).unwrap(); remove_file(&path).unwrap(); //remove file created for this test assert_eq!(content, content_read); } #[test] fn test_encryt_decrypt() { let text = b"This a test"; let key: &str = "an example very very secret key."; let text_vec = text.to_vec(); let ciphertext = encrypt_file(text_vec, key).unwrap(); let plaintext = decrypt_file(ciphertext, key).unwrap(); assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); } #[test] fn test_hash_blake3() { let filename = "cargo.toml"; let hash1 = get_blake3_hash(&filename).unwrap(); let hash2 = get_blake3_hash(&filename).unwrap(); assert_eq!(hash1, hash2); } #[test] fn test_hash_sha256() { let filename = "cargo.toml"; let hash1 = get_sha256_hash(&filename).unwrap(); let hash2 = get_sha256_hash(&filename).unwrap(); assert_eq!(hash1, hash2); } #[test] fn test_hash_sha512() { let filename = "cargo.toml"; let hash1 = get_sha512_hash(&filename).unwrap(); let hash2 = get_sha512_hash(&filename).unwrap(); assert_eq!(hash1, hash2); } }