aes_256_gcm/
lib.rs

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
//!
//! Inspired by simplicity of (let's say JWT) this crate provide high-level
//! abstraction for AES-GCM Crate with some enhancement such as expiration check
//!
//! for detailed usage, please refer to the readme and example in the repository
//!
use aes_gcm::{
    aead::{generic_array::GenericArray, Aead, KeyInit, OsRng},
    aes::{
        cipher::typenum::{
            bit::{B0, B1},
            UInt, UTerm,
        },
        Aes256,
    },
    AeadCore, Aes256Gcm, AesGcm as AG,
};

type AesGcm = AG<
    Aes256,
    UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>,
    UInt<UInt<UInt<UInt<UInt<UTerm, B1>, B0>, B0>, B0>, B0>,
>;
type AesGeneric = GenericArray<u8, UInt<UInt<UInt<UInt<UTerm, B1>, B1>, B0>, B0>>;
type AesClient = AesGcm;

#[derive(Debug, PartialEq, PartialOrd, Eq)]
pub enum AesErrorCode {
    EncryptDataNotValid,
    EncryptOptionError,
    EncryptFailed,

    DecryptDataNotValid,
    DecryptStringConvention,

    Expired,
}

#[derive(Debug)]
pub struct AesError {
    pub code: AesErrorCode,
    pub note: &'static str,
}

#[derive(serde::Serialize, serde::Deserialize, Debug)]
pub struct AesOptions {
    expire: Option<String>,
}

impl AesOptions {
    pub fn with_expire_second(expire: i64) -> Self {
        let microsecond = expire * 1_000_000;
        let expire = chrono::Utc::now() + chrono::Duration::microseconds(microsecond);
        let expire = expire.to_rfc3339();
        Self {
            expire: Some(expire),
        }
    }

    pub fn with_expire_date(expire: chrono::DateTime<chrono::Utc>) -> Self {
        let expire = expire.to_rfc3339();
        Self {
            expire: Some(expire),
        }
    }

    pub fn build(self) -> AesOptions {
        self
    }
}

#[derive(Clone)]
pub struct Client {
    client: AesClient,
}

impl Client {
    pub fn new<'a>(secret: impl Into<Option<&'a str>>) -> Self {
        let data: Option<&'a str> = secret.into();

        let aes_secret = match data {
            Some(d) => Some(d.to_string()),
            None => None,
        };

        let aes_secret = match aes_secret {
            Some(data) => data,
            None => {
                let env = std::env::var("AES_GCM_SECRET").expect(
                    "if you are not using parameter, AES_GCM_SECRET os ENV must present or fill the Client::new(secret) parameter"
                );
                env
            }
        };

        let mut aes_secret = aes_secret.as_bytes().to_vec();
        if aes_secret.len() > 32 {
            aes_secret.truncate(32);
        } else {
            while aes_secret.len() < 32 {
                aes_secret.push(0);
            }
        }
        let aes_key = GenericArray::from_slice(&aes_secret);
        let client: AesClient = Aes256Gcm::new(&aes_key);
        Self { client }
    }

    pub fn encrypt<T>(
        &self,
        data: T,
        option: impl Into<Option<AesOptions>>,
    ) -> Result<String, AesError>
    where
        T: serde::Serialize,
    {
        let data = match serde_json::to_string(&data) {
            Ok(data) => data,
            Err(_) => return Err(AesError {
                code: AesErrorCode::EncryptDataNotValid,
                note:
                    "Data of encryption is not valid data, data must be able to serialize to json",
            }),
        };
        let mut opt = String::new();
        let optx: Option<AesOptions> = option.into();
        if let Some(optn) = optx {
            let json_opt = match serde_json::to_string(&optn) {
                Ok(data) => data,
                Err(_) => {
                    return Err(AesError {
                        code: AesErrorCode::EncryptOptionError,
                        note: "Option failed to build, please check correct parameter",
                    })
                }
            };
            opt = json_opt;
        }
        let data = format!("{}::{}", data, opt);
        let data = data.as_bytes();
        let nonce = Aes256Gcm::generate_nonce(&mut OsRng);
        let encrypt = match self.client.encrypt(&nonce, data.as_ref()) {
            Ok(data) => data,
            Err(_) => {
                return Err(AesError {
                    code: AesErrorCode::EncryptFailed,
                    note: "Failed to encrypt data, please check correct parameter",
                })
            }
        };
        let nonce = nonce
            .iter()
            .map(|b| format!("{:02x}", b))
            .collect::<String>();
        let data = encrypt
            .iter()
            .map(|x| format!("{:02x}", x))
            .collect::<String>();
        let data = format!("{}{}", data, nonce);
        Ok(data)
    }

    pub fn decrypt<'a, T>(&self, data: &'a str) -> Result<T, AesError>
    where
        for<'de> T: serde::Deserialize<'de>,
    {
        let (data, nonce) = data.split_at(data.len() - 24);
        let nonce = nonce
            .chars()
            .collect::<Vec<char>>()
            .chunks(2)
            .map(|x| x.iter().collect::<String>())
            .map(|x| u8::from_str_radix(&x, 16).unwrap_or(0))
            .collect::<AesGeneric>();
        let data = data
            .chars()
            .collect::<Vec<char>>()
            .chunks(2)
            .map(|x| x.iter().collect::<String>())
            .map(|x| u8::from_str_radix(&x, 16).unwrap_or(0))
            .collect::<Vec<u8>>();
        let decrypt = match self.client.decrypt(&nonce, data.as_ref()) {
            Ok(data) => data,
            Err(_) => {
                return Err(AesError {
                    code: AesErrorCode::DecryptDataNotValid,
                    note: "Input data or token does not have valid encryption data",
                })
            }
        };
        // to string
        let str_decrypt = match std::str::from_utf8(&decrypt) {
            Ok(data) => data,
            Err(_) => {
                return Err(AesError {
                    code: AesErrorCode::DecryptStringConvention,
                    note:
                        "String convention failed, either it is not valid string or not utf8 string",
                })
            }
        };
        let str_decrypt: Vec<&str> = str_decrypt.split("::").collect();
        let decrypt = str_decrypt[0];
        // decrypt to byte
        let decrypt = decrypt.as_bytes();

        if str_decrypt.len() > 1 {
            let option_decrypt = str_decrypt[1].as_bytes();
            let data_expiry = match serde_json::from_slice::<AesOptions>(&option_decrypt) {
                Ok(data) => data,
                Err(_) => AesOptions { expire: None },
            };

            if let Some(expire) = data_expiry.expire {
                let date_now = chrono::Utc::now();
                let date_exp = chrono::DateTime::parse_from_rfc3339(&expire);
                match date_exp {
                    Ok(date_exp) => {
                        if date_now > date_exp {
                            return Err(AesError {
                                code: AesErrorCode::Expired,
                                note: "This data/token simply expired",
                            });
                        }
                    }
                    Err(_) => {}
                }
            }
        }

        let data = match serde_json::from_slice::<T>(&decrypt) {
            Ok(data) => data,
            Err(_) => {
                return Err(AesError {
                    code: AesErrorCode::DecryptDataNotValid,
                    note: "Data of decryption is not valid encrypted data",
                })
            }
        };
        Ok(data)
    }
}

#[allow(dead_code)]
fn main() {}

#[cfg(test)]
mod tests {
    use super::*;

    ///
    /// Test case 1 \
    /// Simple encrypt and decrypt string
    ///
    #[test]
    fn test_case_1() {
        std::env::set_var("AES_GCM_SECRET", "some key");
        let client = Client::new(None);
        let encrypted = client.encrypt("my thing", None);
        let decrypted: String = client.decrypt(&encrypted.unwrap()).unwrap();
        assert_eq!(decrypted, "my thing");
    }

    ///
    /// Test case 2 \
    /// Simple encrypt and decrypt struct
    ///
    #[test]
    fn test_case_2() {
        std::env::set_var("AES_GCM_SECRET", "some key");
        #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
        struct TestCase2 {
            pub name: String,
        }

        let client = Client::new(None);
        let data = TestCase2 {
            name: "my name".to_string(),
        };

        let encrypted = client.encrypt(&data, None);
        let decrypted: TestCase2 = client.decrypt(&encrypted.unwrap()).unwrap();
        assert_eq!(decrypted, data);
    }

    ///
    /// Test case 3 \
    /// Simple encrypt and decrypt string with expire
    ///
    #[test]
    fn test_case_3() {
        std::env::set_var("AES_GCM_SECRET", "some key");
        let client = Client::new(None);
        let encrypted = client.encrypt("my thing", AesOptions::with_expire_second(3).build());
        // sleep 5 second
        std::thread::sleep(std::time::Duration::from_secs(2));
        let decrypted = client.decrypt::<String>(&encrypted.unwrap());
        if let Ok(data) = decrypted {
            assert_eq!(data, "my thing");
        } else {
            assert!(false);
        }
    }

    ///
    /// Test case 4 \
    /// Simple encrypt and decrypt string with expire
    ///
    #[test]
    fn test_case_4() {
        std::env::set_var("AES_GCM_SECRET", "some key");
        let client = Client::new(None);
        let encrypted = client.encrypt("my thing", AesOptions::with_expire_second(3).build());
        // sleep 5 second
        std::thread::sleep(std::time::Duration::from_secs(4));
        let decrypted = client.decrypt::<String>(&encrypted.unwrap());
        if let Err(e) = decrypted {
            assert_eq!(e.code, AesErrorCode::Expired);
        } else {
            assert!(false);
        }
    }

    ///
    /// Test case 5 \
    /// Simple encrypt and decrypt struct with expire
    ///
    #[test]
    fn test_case_5() {
        std::env::set_var("AES_GCM_SECRET", "some key");
        #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
        struct TestCase2 {
            pub name: String,
        }

        let client = Client::new(None);
        let data = TestCase2 {
            name: "my name".to_string(),
        };
        let encrypted = client.encrypt(data, AesOptions::with_expire_second(3).build());
        // sleep 5 second
        std::thread::sleep(std::time::Duration::from_secs(2));
        let decrypted = client.decrypt::<TestCase2>(&encrypted.unwrap());
        if let Ok(data) = decrypted {
            assert_eq!(
                data,
                TestCase2 {
                    name: "my name".to_string()
                }
            );
        } else {
            assert!(false);
        }
    }

    ///
    /// Test case 6 \
    /// Simple encrypt and decrypt struct with expire
    ///
    #[test]
    fn test_case_6() {
        std::env::set_var("AES_GCM_SECRET", "some key");
        #[derive(serde::Serialize, serde::Deserialize, Debug, PartialEq)]
        struct TestCase2 {
            pub name: String,
        }

        let client = Client::new(None);
        let data = TestCase2 {
            name: "my name".to_string(),
        };
        let encrypted = client.encrypt(data, AesOptions::with_expire_second(3).build());
        // sleep 5 second
        std::thread::sleep(std::time::Duration::from_secs(4));
        let decrypted = client.decrypt::<TestCase2>(&encrypted.unwrap());
        if let Err(e) = decrypted {
            assert_eq!(e.code, AesErrorCode::Expired);
        } else {
            assert!(false);
        }
    }

    ///
    /// Test case 7
    /// secret with &str
    ///
    #[test]
    fn test_case_7() {
        // remove os env
        std::env::remove_var("AES_GCM_SECRET");
        let secrets = "my secret";
        let client = Client::new(secrets);
        let encrypted = client.encrypt("my thing", None);
        let decrypted: String = client.decrypt(&encrypted.unwrap()).unwrap();
        assert_eq!(decrypted, "my thing");
    }

    ///
    /// Test case 8
    /// secret with String
    ///
    #[test]
    fn test_case_8() {
        std::env::remove_var("AES_GCM_SECRET");
        let secrets = String::from("my secret");
        let client = Client::new(&*secrets);
        let encrypted = client.encrypt("my thing", None);
        let decrypted: String = client.decrypt(&encrypted.unwrap()).unwrap();
        assert_eq!(decrypted, "my thing");
    }

    ///
    /// Test case 9
    /// no secret and no env
    ///
    #[test]
    #[should_panic]
    fn test_case_9() {
        std::env::remove_var("AES_GCM_SECRET");
        // expect it to be panic
        Client::new(None);
    }
}