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 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
//! # Enc_File //! //! Encrypt / decrypt files or calculate hash from the command line. //! 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. //! //! Breaking change in Version 0.3: Changed input of some functions. To encrypt/decrypt and hash use e.g. "encrypt_chacha(readfile(example.file).unwrap(), key).unwrap()". Using a keymap to work with several keys conveniently. You can import your old keys, using "Add key" -> "manually". //! //! Breaking change in Version 0.2: Using XChaCha20Poly1305 as default encryption/decryption. AES is still available using encrypt_aes or decrypt_aes to maintain backwards compability. //! //! Uses XChaCha20Poly1305 (https://docs.rs/chacha20poly1305) or AES-GCM-SIV (https://docs.rs/aes-gcm-siv) for encryption, bincode (https://docs.rs/bincode) for encoding and BLAKE3 (https://docs.rs/blake3) or SHA256 / SHA512 (https://docs.rs/sha2) for hashing. //! //! Encrypted files are (and have to be) stored as .crpt. //! //! Can be used as library and a binary target. Install via cargo install enc_file //! //! Panics at errors making safe execution impossible. //! //! # Examples //! //! ``` //! use enc_file::{encrypt_chacha, decrypt_chacha, read_file}; //! //! //Plaintext to encrypt //! let text = b"This a test"; //! //Provide key. Key will normally be chosen from keymap and provided to the encrypt_chacha() function //! let key: &str = "an example very very secret key."; //! //Convert text to Vec<u8> //! let text_vec = text.to_vec(); //! //! //Encrypt text //! //Ciphertext stores the len() of encrypted content, the nonce and the actual ciphertext using bincode //! let ciphertext = encrypt_chacha(text_vec, key).unwrap(); //encrypt vec<u8>, returns result(Vec<u8>) //! //let ciphertext = encrypt_chacha(read_file(example.file).unwrap(), key).unwrap(); //read a file as Vec<u8> and then encrypt //! //Check that plaintext != ciphertext //! assert_ne!(&ciphertext, &text); //! //! //Decrypt ciphertext to plaintext //! let plaintext = decrypt_chacha(ciphertext, key).unwrap(); //! //Check that text == plaintext //! assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); //! ``` //! //! ``` //!use enc_file::{get_blake3_hash}; //! //!let test = b"Calculating the BLAKE3 Hash of this text"; //!let test_vec = test.to_vec(); //Convert text to Vec<u8> //!let hash1 = get_blake3_hash(test_vec.clone()).unwrap(); //!let hash2 = get_blake3_hash(test_vec).unwrap(); //!assert_eq!(hash1, hash2); //Make sure hash1 == hash2 //!let test2 = b"Calculating the BLAKE3 Hash of this text."; //"." added at the end //!let test2_vec = test2.to_vec(); //!let hash3 = get_blake3_hash(test2_vec).unwrap(); //!assert_ne!(hash1, hash3); //check that the added "." changes the hash and hash1 != hash3 //! ``` //! //! See https://github.com/LazyEmpiricist/enc_file //! // 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. // // Breaking change in Version 0.2: Using XChaCha20Poly1305 as default encryption/decryption. AES is still available using encrypt_aes or decrypt_aes to maintain backwards compability. // // // Uses XChaCha20Poly1305 (https://docs.rs/chacha20poly1305) or AES-GCM-SIV (https://docs.rs/aes-gcm-siv) for encryption, bincode (https://docs.rs/bincode) for encoding and BLAKE3 (https://docs.rs/blake3) or SHA256 / SHA512 (https://docs.rs/sha2) for hashing. // // Generate a new key.file on first run (you can also manually add keys). // // Encrypting "example.file" will create a new (encrypted) file "example.file.crpt" in the same directory. // // Decrypting "example.file.crpt" will create a new (decrypted) file "example.file" in the same directory. // // Both encrypt and decrypt override existing files! // // // # Examples // // Encrypt/decrypt using XChaCha20Poly1305 and random nonce // ``` // use enc_file::{encrypt_chacha, decrypt_chacha, read_file}; // // //Plaintext to encrypt // let text = b"This a test"; // //Provide key. Key will normally be chosen from keymap and provided to the encrypt_chacha() function // let key: &str = "an example very very secret key."; // //Convert text to Vec<u8> // let text_vec = text.to_vec(); // // //Encrypt text // let ciphertext = encrypt_chacha(text_vec, key).unwrap(); //encrypt vec<u8>, returns result(Vec<u8>) // //let ciphertext = encrypt_chacha(read_file(example.file).unwrap(), key).unwrap(); //read a file as Vec<u8> and then encrypt // //Check that plaintext != ciphertext // assert_ne!(&ciphertext, &text); // // //Decrypt ciphertext to plaintext // let plaintext = decrypt_chacha(ciphertext, key).unwrap(); // //Check that text == plaintext // assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); // ``` // // Calculate Blake3 Hash // ``` // use enc_file::{get_blake3_hash}; // // let test = b"Calculating the BLAKE3 Hash of this text"; // let test_vec = test.to_vec(); //Convert text to Vec<u8> // let hash1 = get_blake3_hash(test_vec.clone()).unwrap(); // let hash2 = get_blake3_hash(test_vec).unwrap(); // assert_eq!(hash1, hash2); //Make sure hash1 == hash2 // ``` use std::collections::HashMap; use std::fs::{self, File}; use std::io; use std::io::prelude::*; use std::iter; use std::path::PathBuf; use rand::distributions::Alphanumeric; use rand::{thread_rng, Rng}; use aes_gcm_siv::aead::{generic_array::GenericArray, Aead, NewAead}; use aes_gcm_siv::Aes256GcmSiv; use chacha20poly1305::XChaCha20Poly1305; use sha2::{Digest, Sha256, Sha512}; use serde::{Deserialize, Serialize}; //Struct to store ciphertext, nonce and ciphertext.len() in file and to read it from file #[derive(Serialize, Deserialize, PartialEq, Debug)] struct Cipher { len: usize, rand_string: String, ciphertext: Vec<u8>, } /// Encrypts cleartext (Vec<u8>) with a key (&str) using XChaCha20Poly1305 (24-byte nonce as compared to 12-byte in ChaCha20Poly1305). Returns result (ciphertext as Vec<u8>). /// /// # Examples /// /// ``` /// use enc_file::{encrypt_chacha, decrypt_chacha}; /// /// let text = b"This a test"; /// let key: &str = "an example very very secret key."; /// // encrypt_chacha takes plaintext as Vec<u8>. Text needs to be transformed into vector /// let text_vec = text.to_vec(); /// /// let ciphertext = encrypt_chacha(text_vec, key).unwrap(); /// assert_ne!(&ciphertext, &text); /// /// let plaintext = decrypt_chacha(ciphertext, key).unwrap(); /// assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); /// ``` pub fn encrypt_chacha( cleartext: Vec<u8>, key: &str, ) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let key = GenericArray::clone_from_slice(key.as_bytes()); let aead = XChaCha20Poly1305::new(&key); //generate random nonce let mut rng = thread_rng(); let rand_string: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(24) .collect(); let nonce = GenericArray::from_slice(rand_string.as_bytes()); let ciphertext: Vec<u8> = aead .encrypt(nonce, cleartext.as_ref()) .expect("encryption failure!"); //ciphertext_to_send includes the length of the ciphertext (to confirm upon decryption), the nonce (needed to decrypt) and the actual ciphertext let ciphertext_to_send = Cipher { len: ciphertext.len(), rand_string, ciphertext, }; //serialize using bincode. Facilitates storing in file. let encoded: Vec<u8> = bincode::serialize(&ciphertext_to_send)?; Ok(encoded) } /// Decrypts ciphertext (Vec<u8>) with a key (&str) using XChaCha20Poly1305 (24-byte nonce as compared to 12-byte in ChaCha20Poly1305). Panics with wrong key. Returns result (cleartext as Vec<u8>). /// /// # Examples /// /// ``` /// use enc_file::{encrypt_chacha, decrypt_chacha}; /// /// let text = b"This a test"; /// let key: &str = "an example very very secret key."; /// // encrypt_chacha takes plaintext as Vec<u8>. Text needs to be transformed into vector /// let text_vec = text.to_vec(); /// /// let ciphertext = encrypt_chacha(text_vec, key).unwrap(); /// assert_ne!(&ciphertext, &text); /// /// let plaintext = decrypt_chacha(ciphertext, key).unwrap(); /// assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); /// ``` pub fn decrypt_chacha(enc: Vec<u8>, key: &str) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let key = GenericArray::clone_from_slice(key.as_bytes()); let aead = XChaCha20Poly1305::new(&key); //deserialize input read from file let decoded: Cipher = bincode::deserialize(&enc[..])?; let (ciphertext2, len_ciphertext, rand_string2) = (decoded.ciphertext, decoded.len, decoded.rand_string); //check if included length of ciphertext == actual length of ciphertext if ciphertext2.len() != len_ciphertext { panic!("length of received ciphertext not ok") }; let nonce = GenericArray::from_slice(rand_string2.as_bytes()); //decrypt to plaintext let plaintext: Vec<u8> = aead .decrypt(nonce, ciphertext2.as_ref()) .expect("decryption failure!"); Ok(plaintext) } // Encrypts cleartext (Vec<u8>) with a key (&str) using AES256 GCM SIV. Returns result (ciphertext as Vec<u8>). /// /// # Examples /// /// ``` /// use enc_file::{encrypt_aes, decrypt_aes}; /// /// let text = b"This a test"; /// let key: &str = "an example very very secret key."; /// // encrypt_aes takes plaintext as Vec<u8>. Text needs to be transformed into vector /// let text_vec = text.to_vec(); /// /// let ciphertext = encrypt_aes(text_vec, key).unwrap(); /// assert_ne!(&ciphertext, &text); /// /// let plaintext = decrypt_aes(ciphertext, key).unwrap(); /// assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); /// ``` pub fn encrypt_aes(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); //generate random nonce let mut rng = thread_rng(); let rand_string: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(12) .collect(); let nonce = GenericArray::from_slice(rand_string.as_bytes()); let ciphertext: Vec<u8> = aead .encrypt(nonce, cleartext.as_ref()) .expect("encryption failure!"); //ciphertext_to_send includes the length of the ciphertext (to confirm upon decryption), the nonce (needed to decrypt) and the actual ciphertext let ciphertext_to_send = Cipher { len: ciphertext.len(), rand_string, ciphertext, }; //serialize using bincode. Facilitates storing in file. let encoded: Vec<u8> = bincode::serialize(&ciphertext_to_send)?; Ok(encoded) } /// Decrypts ciphertext (Vec<u8>) with a key (&str) using AES256 GCM SIV. Panics with wrong key. Returns result (cleartext as Vec<u8>). /// /// # Examples /// /// ``` /// use enc_file::{encrypt_aes, decrypt_aes}; /// /// let text = b"This a test"; /// let key: &str = "an example very very secret key."; /// // encrypt_aes takes plaintext as Vec<u8>. Text needs to be transformed into vector /// let text_vec = text.to_vec(); /// /// let ciphertext = encrypt_aes(text_vec, key).unwrap(); /// assert_ne!(&ciphertext, &text); /// /// let plaintext = decrypt_aes(ciphertext, key).unwrap(); /// assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); /// ``` pub fn decrypt_aes(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); //deserialize input read from file let decoded: Cipher = bincode::deserialize(&enc[..])?; let (ciphertext2, len_ciphertext, rand_string2) = (decoded.ciphertext, decoded.len, decoded.rand_string); //check if included length of ciphertext == actual length of ciphertext if ciphertext2.len() != len_ciphertext { panic!("length of received ciphertext not ok") }; let nonce = GenericArray::from_slice(rand_string2.as_bytes()); //decrypt to plaintext let plaintext: Vec<u8> = aead .decrypt(nonce, ciphertext2.as_ref()) .expect("decryption failure!"); Ok(plaintext) } /// Reads userinput from stdin and returns it as String. Returns result. pub fn get_input_string() -> Result<String, Box<dyn std::error::Error>> { let mut input = String::new(); io::stdin().read_line(&mut input)?; let trimmed = input.trim().to_string(); Ok(trimmed) } /// Reads file from same folder as Vec<u8>. Returns result. /// # Examples /// /// ``` /// use enc_file::{read_file, save_file}; /// use std::path::PathBuf; /// use std::fs::remove_file; /// /// let content: Vec<u8> = vec![1, 2, 3, 4, 5, 6, 7, 8, 9, 10]; /// let path: PathBuf = PathBuf::from("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); /// ``` pub fn read_file(path: &PathBuf) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let mut f = File::open(path)?; let mut buffer: Vec<u8> = 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 /// /// ``` /// use enc_file::save_file; /// use std::path::PathBuf; /// use std::fs::remove_file; /// /// let path: PathBuf = PathBuf::from("test123.testxyz"); /// let ciphertext: Vec<u8> = vec![1 as u8, 2 as u8]; /// save_file(ciphertext, &path).unwrap(); /// remove_file(&path).unwrap(); //remove file created for this text /// ``` pub fn save_file(data: Vec<u8>, path: &PathBuf) -> std::io::Result<()> { let mut file = File::create(path)?; file.write_all(&data)?; Ok(()) } /// Get BLAKE3 Hash from data. File needs to be read as Vac<u8> (e.g. use enc_file::read_file()). Returns result. /// # Examples /// /// ``` /// use enc_file::{get_blake3_hash, read_file}; /// /// //creating to different Vec<u8> to hash and compare /// let test = b"Calculating the BLAKE3 Hash of this text".to_vec(); /// let test2 = b"Calculating the BLAKE3 Hash of this different text".to_vec(); /// /// //hashing 2x test and 1x text2 to compare the hashes. hash1 == hash2 != hash3 /// let hash1 = get_blake3_hash(test.clone()).unwrap(); /// let hash2 = get_blake3_hash(test).unwrap(); /// let hash3 = get_blake3_hash(test2).unwrap(); /// assert_eq!(hash1, hash2); /// assert_ne!(hash1, hash3); /// ``` pub fn get_blake3_hash(data: Vec<u8>) -> Result<blake3::Hash, Box<dyn std::error::Error>> { let hash = blake3::hash(&data); Ok(hash) } /// Get SHA256 Hash from data. File needs to be read as Vac<u8> (e.g. use enc_file::read_file()). Returns result. /// # Examples /// /// ``` /// use enc_file::{get_sha256_hash, read_file}; /// /// //creating to different Vec<u8> to hash and compare /// let test = b"Calculating the BLAKE3 Hash of this text".to_vec(); /// let test2 = b"Calculating the BLAKE3 Hash of this different text".to_vec(); /// /// //hashing 2x test and 1x text2 to compare the hashes. hash1 == hash2 != hash3 /// let hash1 = get_sha256_hash(test.clone()).unwrap(); /// let hash2 = get_sha256_hash(test).unwrap(); /// let hash3 = get_sha256_hash(test2).unwrap(); /// assert_eq!(hash1, hash2); /// assert_ne!(hash1, hash3); /// ``` pub fn get_sha256_hash(data: Vec<u8>) -> Result<String, Box<dyn std::error::Error>> { // create a Sha256 object let mut hasher = Sha256::new(); // write input message hasher.update(data); // read hash digest and consume hasher let hash = hasher.finalize(); Ok(format!("{:?}", hash)) } /// Get SHA512 Hash from data. File needs to be read as Vac<u8> (e.g. use enc_file::read_file()). Returns result. /// # Examples /// /// ``` /// use enc_file::{get_sha512_hash, read_file}; /// /// //creating to different Vec<u8> to hash and compare /// let test = b"Calculating the BLAKE3 Hash of this text".to_vec(); /// let test2 = b"Calculating the BLAKE3 Hash of this different text".to_vec(); /// /// //hashing 2x test and 1x text2 to compare the hashes. hash1 == hash2 != hash3 /// let hash1 = get_sha512_hash(test.clone()).unwrap(); /// let hash2 = get_sha512_hash(test).unwrap(); /// let hash3 = get_sha512_hash(test2).unwrap(); /// assert_eq!(hash1, hash2); /// assert_ne!(hash1, hash3); /// ``` pub fn get_sha512_hash(data: Vec<u8>) -> Result<String, Box<dyn std::error::Error>> { // create a Sha256 object let mut hasher = Sha512::new(); // write input message hasher.update(data); // read hash digest and consume hasher let hash = hasher.finalize(); Ok(format!("{:?}", hash)) } /// Allows user to choose desired hashing function. Returns result. pub fn choose_hashing_function() -> Result<(), Box<dyn std::error::Error>> { println!("Please choose type of Hash:\n1 Blake3\n2 SHA256\n3 SHA5212"); //Get user input let answer = get_input_string()?; if answer == "1" { println!("Calculating Blake3 Hash: please enter file path "); let path = PathBuf::from(get_input_string()?); let hash = get_blake3_hash(read_file(&path)?)?; println!("Hash Blake3: {:?}", hash); } else if answer == "2" { println!("Calculating SHA256 Hash: please enter file path "); let path = PathBuf::from(get_input_string()?); let hash = get_sha256_hash(read_file(&path)?)?; println!("Hash SHA256: {:?}", hash); } else if answer == "3" { println!("Calculating SHA512 Hash: please enter file path "); let path = PathBuf::from(get_input_string()?); let hash = get_sha512_hash(read_file(&path)?)?; println!("Hash SHA512: {:?}", hash); } else { println!("Please choose a corresponding number betwenn 1 and 3") } Ok(()) } /// Decrypts file. Taking a keymap "keymap_plaintext" and the choosen encryption "enc" ("chacha" for ChaCha20Poly1305 or "aes" for AES256-GCM-SIV). Returns result. pub fn decrypt_file( keymap_plaintext: HashMap<String, String>, enc: &str, ) -> Result<(), Box<dyn std::error::Error>> { if keymap_plaintext.is_empty() { panic!("No keys avaible. Please first add a key.") } println!("Decrypting file: please enter file path "); let path = PathBuf::from(get_input_string()?); let ciphertext = read_file(&path)?; let new_filename = PathBuf::from( &path .to_str() .expect("Unable to parse filename!") .replace(r#".crpt"#, r#""#), ); println!("Existing keynames"); for entry in keymap_plaintext.keys() { println!("{}", entry) } println!("Please provide keyname to decrypt: "); let answer = get_input_string()?; let key = keymap_plaintext .get(&answer) .expect("No key with that name"); let plaintext = if enc == "chacha" { decrypt_chacha(ciphertext, key)? } else if enc == "aes" { decrypt_aes(ciphertext, key)? } else { panic!() }; save_file(plaintext, &new_filename)?; Ok(()) } /// Encrypts file. Taking a keymap "keymap_plaintext" and the choosen encryption "enc" ("chacha" for ChaCha20Poly1305 or "aes" for AES256-GCM-SIV). Returns result. pub fn encrypt_file( keymap_plaintext: HashMap<String, String>, enc: &str, ) -> Result<(), Box<dyn std::error::Error>> { if keymap_plaintext.is_empty() { panic!("No keys avaible. Please first add a key.") } println!("Encrypting file: please enter file path "); let path = PathBuf::from(get_input_string()?); let new_filename = PathBuf::from( path.clone() .into_os_string() .into_string() .expect("Unable to parse filename!") + r#".crpt"#, ); println!("Existing keynames"); for entry in keymap_plaintext.keys() { println!("{}", entry) } let cleartext = read_file(&path)?; println!("Please provide keyname to encrypt: "); let answer = get_input_string()?; let key = keymap_plaintext .get(&answer) .expect("No key with that name"); let ciphertext = if enc == "chacha" { encrypt_chacha(cleartext, key)? } else if enc == "aes" { encrypt_aes(cleartext, key)? } else { panic!() }; save_file(ciphertext, &new_filename)?; Ok(()) } /// Removes choosen key from keymap. Taking a keymap "keymap_plaintext" and user provided password. pub fn remove_key( mut keymap_plaintext: HashMap<String, String>, password: String, ) -> Result<(), Box<dyn std::error::Error>> { if keymap_plaintext.is_empty() { panic!("No keys avaible. Please first add a key.") } println!("Existing keynames"); for entry in keymap_plaintext.keys() { println!("{}", entry) } println!("Please provide keyname to delete: "); let answer = get_input_string()?; match keymap_plaintext.remove(&answer) { Some(_) => println!("Key removed"), None => println!("No key of this name"), } //Check if there is a key in keymap if keymap_plaintext.is_empty() { println!("Warning: No keys available. Please create a new entry") } let encoded: Vec<u8> = encrypt_hashmap(keymap_plaintext, &password)?; fs::write("key.file", encoded)?; Ok(()) } /// Adds key to keymap. Taking a keymap "keymap_plaintext" and user provided password. pub fn add_key( mut keymap_plaintext: HashMap<String, String>, password: String, ) -> Result<(), Box<dyn std::error::Error>> { println!("Please choose name for new key: "); //Ask for a name to be associated with the new key let key_name = get_input_string()?; //Ask if random key should be generate or key will be provided by user println!("Create new random key (r) or manually enter a key (m). Key needs to be valid 32-long char-utf8"); let answer = get_input_string()?; let mut key = String::new(); if answer == "r" { let mut rng = thread_rng(); let key_rand: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(32) .collect(); key.push_str(&key_rand); } else if answer == "m" { println!("Please enter key. Must be valid 32-long char-utf8"); let answer = get_input_string()?; // String is always valid utf8, len() still needs to be checked if answer.len() == 32 { key.push_str(&answer); } else { println!("Please provide a valid 32-long char-utf8") } } else { //to do panic!(); } keymap_plaintext.insert(key_name.trim().to_string(), key.trim().to_string()); let encoded: Vec<u8> = encrypt_hashmap(keymap_plaintext, &password)?; fs::write("key.file", encoded)?; Ok(()) } /// Creates a new keyfile. User can choose to create a random key or manually enter 32-long char-utf8 password in a keyfile. Key has to be valid utf8. Resturns result (password, keyfile and bool (true if new keyfile way created)). pub fn create_new_keyfile( ) -> Result<(String, HashMap<String, String>, bool), Box<dyn std::error::Error>> { println!("No keyfile found. Create a new one? Y/N"); let answer = get_input_string()?; if answer == "y" { //Enter a password to encrypt key.file println!("Please enter a password (lenth > 8) to encrypt the keyfile: "); let mut password = String::new(); io::stdin() .read_line(&mut password) .expect("Failed to read line"); if password.len() < 8 { panic!("Password too short!") } let mut file = File::create("key.file")?; println!("Please choose name for new key: "); //Ask for a name to be associated with the new key let key_name = get_input_string()?; //Ask if random key should be generate or key will be provided by user println!("Create new random key (r) or manually enter a key (m). Key needs to be valid 32-long char-utf8"); let answer = get_input_string()?; let mut key = String::new(); if answer == "r" { let mut rng = thread_rng(); let key_rand: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(32) .collect(); key.push_str(&key_rand); } else if answer == "m" { println!("Please enter key. Must be valid 32-long char-utf8"); let answer = get_input_string()?; // String is always valid utf8, len() still needs to be checked if answer.len() == 32 { key.push_str(&answer); } else { println!("Please provide a valid 32-long char-utf8") } } else { //to do panic!(); } let mut new_key_map = HashMap::new(); new_key_map.insert(key_name, key); let encoded: Vec<u8> = encrypt_hashmap(new_key_map.clone(), &password)?; file.write_all(&encoded)?; Ok((password, new_key_map, true)) } else { //TO DO panic!() } } /// Read keyfile to keymap. Asks for userpassword. Returns result (password, keymap and bool(false as no new keymap was created)) pub fn read_keyfile() -> Result<(String, HashMap<String, String>, bool), Box<dyn std::error::Error>> { println!("Enter password: "); let password = get_input_string()?; let hashed_password = blake3::hash(&password.trim().as_bytes()); //println!("{:?}", hashed_password); let mut f = File::open("key.file").expect("Could not open key.file"); let mut buffer = Vec::new(); f.read_to_end(&mut buffer)?; let key = GenericArray::clone_from_slice(hashed_password.as_bytes()); let decoded: Cipher = bincode::deserialize(&buffer[..])?; let (ciphertext, len_ciphertext, rand_string) = (decoded.ciphertext, decoded.len, decoded.rand_string); if ciphertext.len() != len_ciphertext { panic!("length of received ciphertext not ok") }; let nonce = GenericArray::from_slice(rand_string.as_bytes()); let aead = XChaCha20Poly1305::new(&key); let plaintext: Vec<u8> = aead .decrypt(nonce, ciphertext.as_ref()) .expect("decryption failure!"); let keymap_plaintext: HashMap<String, String> = bincode::deserialize(&plaintext[..])?; println!("Keys found in key.file:\n{:?}\n", &keymap_plaintext); Ok((password, keymap_plaintext, false)) } /// Encrypt a given hashmap with a given password using ChaCha20Poly1305. Returns result (Vec<u8>) /// # Examples /// /// ``` /// use std::collections::HashMap; /// use aes_gcm_siv::aead::{generic_array::GenericArray, Aead, NewAead}; /// use chacha20poly1305::XChaCha20Poly1305; /// use enc_file::{encrypt_hashmap}; /// use serde::{Deserialize, Serialize}; /// /// //create example keymap. Keymap constits of key-name and actual-key. Attention: Valid keys for cryptography needs to be 32-chars utf8! /// let mut keymap_plaintext: HashMap<String, String> = HashMap::new(); /// keymap_plaintext.insert("Hello".to_string(), "world".to_string()); /// /// //create (extremely insecure) password /// let password: String = "Password".to_string(); /// //encrypt keymap with password /// let encrypted: Vec<u8> = encrypt_hashmap(keymap_plaintext.clone(), &password).unwrap(); /// /// //test that encrypting 2 times results in different Vec<u8> /// let encrypted2: Vec<u8> = encrypt_hashmap(keymap_plaintext, &password).unwrap(); /// assert_ne!(encrypted, encrypted2); /// ``` pub fn encrypt_hashmap( keymap_plaintext: HashMap<String, String>, password: &str, ) -> Result<Vec<u8>, Box<dyn std::error::Error>> { let encoded: Vec<u8> = bincode::serialize(&keymap_plaintext).expect("Unable to encode keymap!"); //encrypt Hashmap with keys let mut rng = thread_rng(); let rand_string: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(24) .collect(); let nonce = GenericArray::from_slice(rand_string.as_bytes()); let hashed_password = blake3::hash(&password.trim().as_bytes()); let key = GenericArray::clone_from_slice(hashed_password.as_bytes()); let aead = XChaCha20Poly1305::new(&key); let ciphertext: Vec<u8> = aead .encrypt(nonce, encoded.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).expect("Unable to encode keymap!"); Ok(encoded) } #[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: PathBuf = PathBuf::from("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_aes() { let text = b"This a test"; let key: &str = "an example very very secret key."; let text_vec = text.to_vec(); let ciphertext = encrypt_aes(text_vec, key).unwrap(); assert_ne!(&ciphertext, &text); let plaintext = decrypt_aes(ciphertext, key).unwrap(); assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); } #[test] fn test_encryt_decrypt_chacha() { let text = b"This a test"; let key: &str = "an example very very secret key."; let text_vec = text.to_vec(); let ciphertext = encrypt_chacha(text_vec, key).unwrap(); assert_ne!(&ciphertext, &text); let plaintext = decrypt_chacha(ciphertext, key).unwrap(); assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); } #[test] fn test_multiple_encrypt_unequal_chacha() { use rand::{distributions::Uniform, Rng}; let range = Uniform::new(0, 255); let mut i = 1; while i < 1000 { let mut rng = thread_rng(); let key: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(32) .collect(); let content: Vec<u8> = (0..100).map(|_| rng.sample(&range)).collect(); let ciphertext1 = encrypt_chacha(content.clone(), &key).unwrap(); let ciphertext2 = encrypt_chacha(content.clone(), &key).unwrap(); let ciphertext3 = encrypt_chacha(content.clone(), &key).unwrap(); let ciphertext4 = encrypt_chacha(content.clone(), &key).unwrap(); let ciphertext5 = encrypt_chacha(content, &key).unwrap(); assert_ne!(&ciphertext1, &ciphertext2); assert_ne!(&ciphertext1, &ciphertext3); assert_ne!(&ciphertext1, &ciphertext4); assert_ne!(&ciphertext1, &ciphertext5); assert_ne!(&ciphertext2, &ciphertext3); assert_ne!(&ciphertext2, &ciphertext4); assert_ne!(&ciphertext2, &ciphertext5); assert_ne!(&ciphertext3, &ciphertext4); assert_ne!(&ciphertext3, &ciphertext5); assert_ne!(&ciphertext4, &ciphertext5); i += 1; } } #[test] fn test_multiple_encrypt_unequal_aes() { use rand::{distributions::Uniform, Rng}; let range = Uniform::new(0, 255); let mut i = 1; while i < 1000 { let mut rng = thread_rng(); let key: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(32) .collect(); let content: Vec<u8> = (0..100).map(|_| rng.sample(&range)).collect(); let ciphertext1 = encrypt_aes(content.clone(), &key).unwrap(); let ciphertext2 = encrypt_aes(content.clone(), &key).unwrap(); let ciphertext3 = encrypt_aes(content.clone(), &key).unwrap(); let ciphertext4 = encrypt_aes(content.clone(), &key).unwrap(); let ciphertext5 = encrypt_aes(content, &key).unwrap(); assert_ne!(&ciphertext1, &ciphertext2); assert_ne!(&ciphertext1, &ciphertext3); assert_ne!(&ciphertext1, &ciphertext4); assert_ne!(&ciphertext1, &ciphertext5); assert_ne!(&ciphertext2, &ciphertext3); assert_ne!(&ciphertext2, &ciphertext4); assert_ne!(&ciphertext2, &ciphertext5); assert_ne!(&ciphertext3, &ciphertext4); assert_ne!(&ciphertext3, &ciphertext5); assert_ne!(&ciphertext4, &ciphertext5); i += 1; } } #[test] fn test_hash_blake3() { let test = b"Calculating the BLAKE3 Hash of this text".to_vec(); let test2 = b"Calculating the BLAKE3 Hash of this different text".to_vec(); let hash1 = get_blake3_hash(test.clone()).unwrap(); let hash2 = get_blake3_hash(test).unwrap(); let hash3 = get_blake3_hash(test2).unwrap(); assert_eq!(hash1, hash2); assert_ne!(hash1, hash3); } #[test] fn test_hash_sha256() { let test = b"Calculating the BLAKE3 Hash of this text".to_vec(); let test2 = b"Calculating the BLAKE3 Hash of this different text".to_vec(); let hash1 = get_sha256_hash(test.clone()).unwrap(); let hash2 = get_sha256_hash(test).unwrap(); let hash3 = get_sha256_hash(test2).unwrap(); assert_eq!(hash1, hash2); assert_ne!(hash1, hash3); } #[test] fn test_hash_sha512() { let test = b"Calculating the BLAKE3 Hash of this text".to_vec(); let test2 = b"Calculating the BLAKE3 Hash of this different text".to_vec(); let hash1 = get_sha512_hash(test.clone()).unwrap(); let hash2 = get_sha512_hash(test).unwrap(); let hash3 = get_sha512_hash(test2).unwrap(); assert_eq!(hash1, hash2); assert_ne!(hash1, hash3); } #[test] fn test_multiple_random_chacha() { use rand::{distributions::Uniform, Rng}; let range = Uniform::new(0, 255); let mut i = 1; while i < 1000 { let mut rng = thread_rng(); let key: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(32) .collect(); let content: Vec<u8> = (0..100).map(|_| rng.sample(&range)).collect(); let ciphertext = encrypt_chacha(content.clone(), &key).unwrap(); assert_ne!(&ciphertext, &content); let plaintext = decrypt_chacha(ciphertext, &key).unwrap(); assert_eq!(format!("{:?}", content), format!("{:?}", plaintext)); i += 1; } } #[test] fn test_multiple_random_aes() { use rand::{distributions::Uniform, Rng}; let range = Uniform::new(0, 255); let mut i = 1; while i < 1000 { let mut rng = thread_rng(); let key: String = iter::repeat(()) .map(|()| rng.sample(Alphanumeric)) .map(char::from) .take(32) .collect(); let content: Vec<u8> = (0..100).map(|_| rng.sample(&range)).collect(); let ciphertext = encrypt_aes(content.clone(), &key).unwrap(); assert_ne!(&ciphertext, &content); let plaintext = decrypt_aes(ciphertext, &key).unwrap(); assert_eq!(format!("{:?}", content), format!("{:?}", plaintext)); i += 1; } } #[test] fn test_example() { let text = b"This a test"; //Text to encrypt let key: &str = "an example very very secret key."; //Key will normally be chosen from keymap and provided to the encrypt_chacha() function let text_vec = text.to_vec(); //Convert text to Vec<u8> let ciphertext = encrypt_chacha(text_vec, key).unwrap(); //encrypt vec<u8>, returns result(Vec<u8>) //let ciphertext = encrypt_chacha(read_file(example.file).unwrap(), key).unwrap(); //read a file as Vec<u8> and then encrypt assert_ne!(&ciphertext, &text); //Check that plaintext != ciphertext let plaintext = decrypt_chacha(ciphertext, key).unwrap(); //Decrypt ciphertext to plaintext assert_eq!(format!("{:?}", text), format!("{:?}", plaintext)); //Check that text == plaintext } #[test] #[should_panic] fn test_chacha_wrong_key_panic() { let text = b"This a another test"; //Text to encrypt let key: &str = "an example very very secret key."; //Key will normally be chosen from keymap and provided to the encrypt_chacha() function let text_vec = text.to_vec(); //Convert text to Vec<u8> let ciphertext = encrypt_chacha(text_vec, key).unwrap(); //encrypt vec<u8>, returns result(Vec<u8>) assert_ne!(&ciphertext, &text); //Check that plaintext != ciphertext let key: &str = "an example very very secret key!"; //The ! should result in decryption panic let _plaintext = decrypt_chacha(ciphertext, key).unwrap(); //Decrypt ciphertext to plaintext } #[test] #[should_panic] fn test_aes_wrong_key_panic() { let text = b"This a another test"; //Text to encrypt let key: &str = "an example very very secret key."; //Key will normally be chosen from keymap and provided to the encrypt_chacha() function let text_vec = text.to_vec(); //Convert text to Vec<u8> let ciphertext = encrypt_aes(text_vec, key).unwrap(); //encrypt vec<u8>, returns result(Vec<u8>) assert_ne!(&ciphertext, &text); //Check that plaintext != ciphertext let key: &str = "an example very very secret key!"; //The ! should result in decryption panic let _plaintext = decrypt_aes(ciphertext, key).unwrap(); //Decrypt ciphertext to plaintext } #[test] fn test_example_hash() { let test = b"Calculating the BLAKE3 Hash of this text"; let test_vec = test.to_vec(); //Convert text to Vec<u8> let hash1 = get_blake3_hash(test_vec.clone()).unwrap(); let hash2 = get_blake3_hash(test_vec).unwrap(); assert_eq!(hash1, hash2); //Make sure hash1 == hash2 let test2 = b"Calculating the BLAKE3 Hash of this text."; //"." added at the end let test2_vec = test2.to_vec(); let hash3 = get_blake3_hash(test2_vec).unwrap(); //check that the added "." changes the hash assert_ne!(hash1, hash3); } }