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
//! # CryptGuard Programming Library
//! 
//! [![Crates.io][crates-badge]][crates-url]
//! [![MIT licensed][mit-badge]][mit-url]
//! [![Documentation][doc-badge]][doc-url]
//! [![Hashnode Blog][blog-badge]][blog-url]
//! [![GitHub Library][lib-badge]][lib-link]
//! 
//!  [blog-badge]: https://img.shields.io/badge/blog-hashnode-lightblue.svg?style=for-the-badge
//!  [blog-url]: https://blog.mm29942.com/
//!  [crates-badge]: https://img.shields.io/badge/crates.io-v1.2-blue.svg?style=for-the-badge
//!  [crates-url]: https://crates.io/crates/crypt_guard
//!  [mit-badge]: https://img.shields.io/badge/license-MIT-green.svg?style=for-the-badge
//!  [mit-url]: https://github.com/mm9942/CryptGuardLib/blob/main/LICENSE
//!  [doc-badge]: https://img.shields.io/badge/docs-v1.2-yellow.svg?style=for-the-badge
//!  [doc-url]: https://docs.rs/crypt_guard/
//!  [lib-badge]: https://img.shields.io/badge/github-lib-black.svg?style=for-the-badge
//!  [lib-link]: https://github.com/mm9942/CryptGuardLib
//! 
//! ## Introduction
//! 
//! CryptGuard is a comprehensive cryptographic library, offering robust encryption and decryption capabilities. It integrates traditional cryptography with post-quantum algorithms, ensuring resilience against quantum computing threats. Designed for developers, CryptGuard empowers applications to withstand future digital security challenges. Embrace CryptGuard as your trusted ally in safeguarding privacy in the digital realm.
//! 
//! ## Key Features and Capabilities
//! 
//! This library supports AES-256 and XChaCha20 encryption algorithms, providing a secure means to protect data. To cater to a variety of security requirements and operational contexts, CryptGuard integrates seamlessly with Kyber512, Kyber768, and Kyber1024 for encryption, ensuring compatibility with post-quantum cryptography standards.
//! 
//! For developers who require digital signing capabilities, CryptGuard incorporates Falcon and Dilithium algorithms, offering robust options for creating and verifying digital signatures. This feature is particularly crucial for applications that necessitate authenticity and integrity of data, ensuring that digital communications remain secure and verifiable.
//! 
//! An additional layer of security is provided through the appending of a HMAC (Hash-Based Message Authentication Code) to encrypted data. This critical feature enables the authentication of encrypted information, ensuring that any tampering with the data can be reliably detected. This HMAC attachment underscores CryptGuard's commitment to comprehensive data integrity and security, offering developers and end-users peace of mind regarding the authenticity and safety of their data.
//!
//! # Examples
//! 
//! ### Encryption:
//!
//! The encryption functions `encrypt_msg`, `encrypt_data`, and `encrypt_file` are specifically tailored for different types of data. Using distinct functions ensures that the correct methods and optimizations are applied depending on whether you're encrypting raw bytes, structured data, or files. Each encryption function requires a new instance of the Kyber object, tailored for the type of encryption (Message, Data, Files), to guarantee that the cryptographic parameters are initialized correctly and securely for each session.
//!
//! ```rust
//! use crypt_guard::{*, error::*};
//! use std::{
//!     path::{Path, PathBuf},
//!     fs,
//! };
//!
//! let message = "Hey, how are you doing?";
//! let passphrase = "Test Passphrase";
//! 
//! let (public_key, secret_key) = KyberKeypair!(1024);
//! 
//! // Creating new Kyber AES message instance
//! let mut encryptor = Kyber::<Encryption, Kyber1024, Message, AES>::new(public_key.clone(), None).expect("");
//! 
//! // Now are multiple options available:
//! // Using the Macro
//! let (encrypt_message, cipher) = Encryption!(public_key.clone(), 1024, message.clone().as_bytes().to_owned(), passphrase.clone(), AES).expect("");
//! 
//! // Using the encrypt_ functions:
//! 
//! // Message:
//! let (encrypt_message, cipher) = encryptor.encrypt_msg(message.clone(), passphrase.clone()).expect("");
//! 
//! // Data:
//! // Creating new Kyber AES data instance
//! let mut encryptor = Kyber::<Encryption, Kyber1024, Data, AES>::new(public_key.clone(), None).expect("");
//! let (encrypt_message, cipher) = encryptor.encrypt_data(message.clone().as_bytes().to_owned(), passphrase.clone()).expect("");
//! 
//! // Last but not least the encryption function for files:
//! fs::write(PathBuf::from("message.txt"), message.clone().as_bytes()).expect("");
//! 
//! // Creating new Kyber AES file instance
//! let mut encryptor = Kyber::<Encryption, Kyber1024, Files, AES>::new(public_key.clone(), None).expect("");
//! 
//! // Encrypt file macro:
//! let (encrypt_message, cipher) = EncryptFile!(public_key.clone(), 1024, PathBuf::from("message.txt"), passphrase.clone(), AES).expect("");
//! 
//! // Encrypt file function:
//! let (encrypt_message, cipher) = encryptor.encrypt_file(PathBuf::from("message.txt"), passphrase.clone()).expect("");
//! ```
//!
//! #### Infos about XChaCha20 differences
//!
//! XChaCha20, unlike AES, requires handling of a nonce (number used once) which must be generated during encryption and subsequently used during decryption. This introduces additional steps in the cryptographic process when using XChaCha20 compared to AES, which does not explicitly require nonce management by the user.
//!
//! ```rust
//! use crypt_guard::{*, error::*, KDF::*};
//! use std::{
//!     path::{Path, PathBuf},
//!     fs,
//! };
//!
//! let (public_key, secret_key) = KyberKeypair!(768);
//!
//! let message = "Hey, how are you doing?";
//! let passphrase = "Test Passphrase";
//! 
//! fs::write(PathBuf::from("message.txt"), message.clone().as_bytes()).expect("");
//!
//! // You need to save the nonce when not using AES but XChaCha20 instead:
//! // Creating new Kyber XChaCha20 file encryption instance
//! let mut encryptor = Kyber::<Encryption, Kyber768, Files, XChaCha20>::new(public_key.clone(), None).expect("");
//! 
//! // Encrypt file
//! let (encrypt_message, cipher) = encryptor.encrypt_file(PathBuf::from("message.txt"), passphrase.clone()).expect("");
//!
//! // Should be executed after encryption is already done, since doing it before that would trigger an error.
//! let nonce = encryptor.get_nonce().expect("").to_string(); 
//! 
//! // Creating new Kyber XChaCha20 file decryption instance (this time also adding the nonce beside the key)
//! let mut decryptor = Kyber::<Decryption, Kyber768, Files, XChaCha20>::new(secret_key.clone(), Some(nonce)).expect("");
//! 
//! // Decrypt message
//! let decrypt_message = decryptor.decrypt_file(PathBuf::from("message.txt.enc"), passphrase.clone(), cipher.clone()).expect("");
//! ```
//!
//! ### Using Encryption and Decryption macros
//!
//! Beside the main macros encrypt, decrypt, encrypt_file, decrypt_file, I've added the Encryption and Decryption macros. Instead of linking the encryption/ decryption instance, we define the macro by using Encryption!(public_key, keysize [ 1024 | 768 | 512 ] contents_bytes_vec, passphrase_as_str, [ AES | XChaCha20 ]) and get the content and ciphertext returned, or additionally when using XChaCha20, we also get the nonce.
//!
//! ```rust
//! use crypt_guard::{*, error::*};
//! use std::{
//!     fs::{self, File}, 
//!     marker::PhantomData,
//!     path::{PathBuf, Path},
//!     io::{Read, Write},
//! 
//! };
//! //use crypt_guard_proc::{*, log_activity, write_log};
//! use tempfile::{TempDir, Builder};
//! use crypt_guard::KeyControler::KeyControl;
//! 
//! //#[crypt_guard_proc]
//! #[activate_log("log.txt")]
//! fn main() -> Result<(), Box<dyn std::error::Error>> {
//!     let _ = initialize_logger(); 
//!     let message = "Hey, how are you doing?";
//!     let passphrase = "Test Passphrase";
//! 
//!     let mut key_control = KeyControl::<KeyControKyber1024>::new();
//!     let _ = log_activity!("Starting with signing of the message.", "Test");
//! 
//!     // Generate key pair
//!     let (public_key, secret_key) = KyberKeypair!(1024);
//! 
//!     // Instantiate Kyber for encryption of a message with Kyber1024 and AES
//!     // Fails when not using either of these properties since it would be the wrong type of algorithm, data, keysize or process!    
//!     // Encrypt message
//!     let (encrypt_message, cipher) = Encryption!(public_key.clone(), 1024, message.as_bytes().to_owned(), passphrase.clone(), AES)?;
//! 
//!     key_control.set_ciphertext(cipher.clone()).unwrap();
//!     key_control.save(KeyTypes::Ciphertext, "./key".into()).unwrap();
//! 
//!     // Decrypt message
//!     let decrypt_message = Decryption!(secret_key, 1024, encrypt_message.clone(), passphrase.clone(), cipher, AES)?;
//! 
//!     let decrypted_text = String::from_utf8(decrypt_message).expect("Failed to convert decrypted message to string");
//!     write_log!();
//!     println!("{:?}", decrypted_text);
//!     Ok(())
//! }  
//! ```

#[macro_use]
extern crate lazy_static;
pub use crypt_guard_proc::*;

/// Core functionalitys for control of Kyber keys as well as encryption and decryption
mod Core;
/// Cryptographic related functionalitys, enums structs and modules
pub mod cryptography;
/// File and Key related functionalitys, enums structs and modules
pub mod KeyControl;
/// Logging related functionalitys
pub mod log;
/// Error types
pub mod error;

#[cfg(test)]
mod tests;

pub use crate::{
    log::*,
    KeyControl::{
        *,
        file, 
    },
    Core::{
        *,
        KDF,
        kyber::*,
    },
};




use std::{
    fmt::{*}
};
use hex;

/// Function activating the log, it takes one arg: `&str` which represents the location of the logfile
/*pub fn activate_log<P: AsRef<Path>>(log_file: P) {
    let mut logger = LOGGER.lock().unwrap();
    logger.activated = true;
    logger.location = Some(log_file.as_ref().to_path_buf());
}*/

/// Macro for signing and encrypting data, a 1024 falcon secret key is required for signing
#[macro_export]
macro_rules! EncryptSign {
    ($key:expr, $sign:expr, $content:expr, $passphrase:expr)  => {{
        let mut encryptor = Kyber::<Encryption, Kyber1024, Data, AES>::new($key, None).unwrap();
        let sign = Signature::<Falcon1024, Message>::new();
        let signed_message = sign.signature($content, $sign).unwrap();
        encryptor.encrypt_data(signed_message, $passphrase)
    }};
}

/// Macro for decrypting and opening data, a 1024 falcon public key is required
#[macro_export]
macro_rules! DecryptOpen {
    ($key:expr, $sign:expr, $content:expr, $passphrase:expr, $cipher:expr)  => {{
        let decryptor = Kyber::<Decryption, Kyber1024, Data, AES>::new($key, None).unwrap();
        let data = decryptor.decrypt_data($content, $passphrase, $cipher).unwrap();
        let sign = Signature::<Falcon1024, Message>::new();
        sign.open(data, $sign).unwrap()
    }};
}

/// Macro for kyber keypair generation
#[macro_export]
macro_rules! KyberKeypair {
    ($size:expr) => {{
        let (public_key, secret_key) = match $size {
            1024 => {
                KeyControKyber1024::keypair().expect("Failed to generate keypair")
            },
            768 => {
                KeyControKyber768::keypair().expect("Failed to generate keypair")
            },
            512 => {
                KeyControKyber512::keypair().expect("Failed to generate keypair")
            },
            _ => {
                Err(Box::new(CryptError::new("Wrong key size!")) as Box<dyn std::error::Error>)
            }.unwrap()
        };
        (public_key, secret_key)
    }};
}

/// Macro for falcon keypair generation
#[macro_export]
macro_rules! FalconKeypair {
    ($size:expr) => {{
        let (public_key, secret_key) = match $size {
            1024 => {
                Falcon1024::keypair().expect("Failed to generate keypair")
            },
            512 => {
                Falcon512::keypair().expect("Failed to generate keypair")
            },
            _ => {
                Err(Box::new(CryptError::new("Wrong key size!")) as Box<dyn std::error::Error>)
            }.unwrap()
        };
        (public_key, secret_key)
    }};
}

/// Macro for dilithium keypair generation
#[macro_export]
macro_rules! DilithiumKeypair {
    ($version:expr) => {{
        let (public_key, secret_key) = match $version {
            5 => {
                Dilithium5::keypair().expect("Failed to generate keypair")
            },
            3 => {
                Dilithium3::keypair().expect("Failed to generate keypair")
            },
            2 => {
                Dilithium2::keypair().expect("Failed to generate keypair")
            },
            _ => {
                return eprintln!("Unsupported key size")
            }
        };
        (public_key, secret_key)
    }};
}

#[macro_export]
macro_rules! Encryption {
    // AES
    ($key:expr, 1024, $data:expr, $passphrase:expr, AES) => {{
        let mut encryptor = Kyber::<Encryption, Kyber1024, Data, AES>::new($key, None).expect("");
        encryptor.encrypt_data($data, $passphrase)
    }};
    ($key:expr, 768, $data:expr, $passphrase:expr, AES) => {{
        let mut encryptor = Kyber::<Encryption, Kyber768, Data, AES>::new($key, None).expect("");
        encryptor.encrypt_data($data, $passphrase)
    }};
    ($key:expr, 512, $data:expr, $passphrase:expr, AES) => {{
        let mut encryptor = Kyber::<Encryption, Kyber512, Data, AES>::new($key, None).expect("");
        encryptor.encrypt_data($data, $passphrase)
    }};
    // XChaCha20
    ($key:expr, 1024, $data:expr, $passphrase:expr, XChaCha20) => {{
        let mut encryptor = Kyber::<Encryption, Kyber1024, Data, XChaCha20>::new($key, None).expect("");
        let (encrypt_message, cipher) = encryptor.encrypt_data($data, $passphrase);
        let nonce = encryptor.get_nonce();
        (encrypt_message, cipher, nonce)
    }};
    ($key:expr, 768, $data:expr, $passphrase:expr, XChaCha20) => {{
        let mut encryptor = Kyber::<Encryption, Kyber768, Data, XChaCha20>::new($key, None).expect("");
        let (encrypt_message, cipher) = encryptor.encrypt_data($data, $passphrase);
        let nonce = encryptor.get_nonce();
        (encrypt_message, cipher, nonce)
    }};
    ($key:expr, 512, $data:expr, $passphrase:expr, XChaCha20) => {{
        let mut encryptor = Kyber::<Encryption, Kyber512, Data, XChaCha20>::new($key, None).expect("");
        let (encrypt_message, cipher) = encryptor.encrypt_data($data, $passphrase);
        let nonce = encryptor.get_nonce();
        (encrypt_message, cipher, nonce)
    }};
}

#[macro_export]
macro_rules! Decryption {
    // AES
    ($key:expr, 1024, $data:expr, $passphrase:expr, $cipher:expr, AES) => {{
        let decryptor = Kyber::<Decryption, Kyber1024, Data, AES>::new($key, None).expect("");
        decryptor.decrypt_data($data, $passphrase, $cipher)
    }};
    ($key:expr, 768, $data:expr, $passphrase:expr, $cipher:expr, AES) => {{
        let mut decryptor = Kyber::<Decryption, Kyber768, Data, AES>::new($key, None).expect("");
        decryptor.decrypt_data($data, $passphrase, $cipher)
    }};
    ($key:expr, 512, $data:expr, $passphrase:expr, $cipher:expr, AES) => {{
        let mut decryptor = Kyber::<Decryption, Kyber512, Data, AES>::new($key, None).expect("");
        decryptor.decrypt_data($data, $passphrase, $cipher)
    }};
    // XChaCha20
    ($key:expr, 1024, $data:expr, $passphrase:expr, $cipher:expr, $nonce:expr, XChaCha20) => {{
        let mut decryptor = Kyber::<Decryption, Kyber1024, Data, XChaCha20>::new($key, $nonce).expect("");
        decryptor.decrypt_data($data, $passphrase)
    }};
    ($key:expr, 768, $data:expr, $passphrase:expr, $cipher:expr, $nonce:expr, XChaCha20) => {{
        let mut decryptor = Kyber::<Decryption, Kyber768, Data, XChaCha20>::new($key, $nonce).expect("");
        decryptor.decrypt_data($data, $passphrase)
    }};
    ($key:expr, 512, $data:expr, $passphrase:expr, $cipher:expr, $nonce:expr, XChaCha20) => {{
        let mut decryptor = Kyber::<Decryption, Kyber512, Data, XChaCha20>::new($key, $nonce).expect("");
        decryptor.decrypt_data($data, $passphrase)
    }};
}

/* /// Macro for encryption of data, taking a Kyber encryption instance, a `Vec<u8>` as well as a passphrase and ciphertext as arguments
#[macro_export]
macro_rules! encrypt {
    ($kyber:expr, $data:expr, $passphrase:expr) => {{
        $kyber.encrypt_data($data, $passphrase)
    }};
}

/// Macro for decryption of data, taking a Kyber decryption instance, a `Vec<u8>` as well as a passphrase and ciphertext as arguments
#[macro_export]
macro_rules! decrypt {
    ($kyber:expr, $encrypted_data:expr, $passphrase:expr, $cipher:expr) => {{
        $kyber.decrypt_data($encrypted_data, $passphrase, $cipher)
    }};
}*/

/// Macro for encryption of a file, taking a Kyber decryption instance, a `PathBuf` as well as a passphrase and ciphertext as arguments
#[macro_export]
macro_rules! EncryptFile {
    // AES
    ($key:expr, 1024, $path:expr, $passphrase:expr, AES) => {{
        let mut encryptor = Kyber::<Encryption, Kyber1024, Data, AES>::new($key, None).expect("");
        encryptor.encrypt_file($path, $passphrase)
    }};
    ($key:expr, 768, $path:expr, $passphrase:expr, AES) => {{
        let mut encryptor = Kyber::<Encryption, Kyber768, Data, AES>::new($key, None).expect("");
        encryptor.encrypt_file($path, $passphrase)
    }};
    ($key:expr, 512, $path:expr, $passphrase:expr, AES) => {{
        let mut encryptor = Kyber::<Encryption, Kyber512, Data, AES>::new($key, None).expect("");
        encryptor.encrypt_file($path, $passphrase)
    }};
    // XChaCha20
    ($key:expr, 1024, $path:expr, $passphrase:expr, XChaCha20) => {{
        let mut encryptor = Kyber::<Encryption, Kyber1024, Data, XChaCha20>::new($key, None).expect("");
        let (encrypt_message, cipher) = encryptor.encrypt_file($path, $passphrase);
        let nonce = encryptor.get_nonce();
        (encrypt_message, cipher, nonce)
    }};
    ($key:expr, 768, $path:expr, $passphrase:expr, XChaCha20) => {{
        let mut encryptor = Kyber::<Encryption, Kyber768, Data, XChaCha20>::new($key, None).expect("");
        let (encrypt_message, cipher) = encryptor.encrypt_file($path, $passphrase);
        let nonce = encryptor.get_nonce();
        (encrypt_message, cipher, nonce)
    }};
    ($key:expr, 512, $path:expr, $passphrase:expr, XChaCha20) => {{
        let mut encryptor = Kyber::<Encryption, Kyber512, Data, XChaCha20>::new($key, None).expect("");
        let (encrypt_message, cipher) = encryptor.encrypt_file($path, $passphrase);
        let nonce = encryptor.get_nonce();
        (encrypt_message, cipher, nonce)
    }};
}

/// Macro for encryption of a file, taking a Kyber decryption instance, a `PathBuf` as well as a passphrase and ciphertext as arguments
#[macro_export]
macro_rules! DecryptFile {
    // AES
    ($key:expr, 1024, $path:expr, $passphrase:expr, $cipher:expr, AES) => {{
        let decryptor = Kyber::<Decryption, Kyber1024, Data, AES>::new($key, None).expect("");
        decryptor.decrypt_file($path, $passphrase, $cipher)
    }};
    ($key:expr, 768, $path:expr, $passphrase:expr, $cipher:expr, AES) => {{
        let mut decryptor = Kyber::<Decryption, Kyber768, Data, AES>::new($key, None).expect("");
        decryptor.decrypt_file($path, $passphrase, $cipher)
    }};
    ($key:expr, 512, $path:expr, $passphrase:expr, $cipher:expr, AES) => {{
        let mut decryptor = Kyber::<Decryption, Kyber512, Data, AES>::new($key, None).expect("");
        decryptor.decrypt_file($path, $passphrase, $cipher)
    }};
    // XChaCha20
    ($key:expr, 1024, $path:expr, $passphrase:expr, $cipher:expr, $nonce:expr, XChaCha20) => {{
        let mut decryptor = Kyber::<Decryption, Kyber1024, Data, XChaCha20>::new($key, $nonce).expect("");
        decryptor.decrypt_file($path, $passphrase, $cipher)
    }};
    ($key:expr, 768, $path:expr, $passphrase:expr, $cipher:expr, $nonce:expr, XChaCha20) => {{
        let mut decryptor = Kyber::<Decryption, Kyber768, Data, XChaCha20>::new($key, $nonce).expect("");
        decryptor.decrypt_file($path, $passphrase, $cipher)
    }};
    ($key:expr, 512, $path:expr, $passphrase:expr, $cipher:expr, $nonce:expr, XChaCha20) => {{
        let mut decryptor = Kyber::<Decryption, Kyber512, Data, XChaCha20>::new($key, $nonce).expect("");
        decryptor.decrypt_file($path, $passphrase, $cipher)
    }};
}