feat: add example

examples/bench.rs

@@ -0,0 +1,53 @@
+use benchmark_simple::{Bench, Options};
+
+use aes_gcm_stream::{Aes128GcmStreamEncryptor, Aes192GcmStreamEncryptor, Aes256GcmStreamEncryptor};
+
+fn test_aes128_encrypt(m: &mut [u8]) {
+    let key = [0u8; 16];
+    let nonce = [0u8; 12];
+    let mut encryptor = Aes128GcmStreamEncryptor::new(key, &nonce);
+
+    encryptor.update(m);
+    encryptor.finalize();
+}
+
+fn test_aes192_encrypt(m: &mut [u8]) {
+    let key = [0u8; 24];
+    let nonce = [0u8; 12];
+    let mut encryptor = Aes192GcmStreamEncryptor::new(key, &nonce);
+
+    encryptor.update(m);
+    encryptor.finalize();
+}
+
+fn test_aes256_encrypt(m: &mut [u8]) {
+    let key = [0u8; 32];
+    let nonce = [0u8; 12];
+    let mut encryptor = Aes256GcmStreamEncryptor::new(key, &nonce);
+
+    encryptor.update(m);
+    encryptor.finalize();
+}
+
+fn main() {
+    let bench = Bench::new();
+    let mut m = vec![0xd0u8; 16384];
+
+    let options = &Options {
+        iterations: 1_000,
+        warmup_iterations: 1_00,
+        min_samples: 5,
+        max_samples: 10,
+        max_rsd: 1.0,
+        ..Default::default()
+    };
+
+    let res = bench.run(options, || test_aes128_encrypt(&mut m));
+    println!("AES128 encrypt  : {}", res.throughput(m.len() as _));
+
+    let res = bench.run(options, || test_aes192_encrypt(&mut m));
+    println!("AES192 encrypt  : {}", res.throughput(m.len() as _));
+
+    let res = bench.run(options, || test_aes256_encrypt(&mut m));
+    println!("AES256 encrypt  : {}", res.throughput(m.len() as _));
+}

examples/encrypt_and_decrypt.rs

@@ -0,0 +1,30 @@
+use aes_gcm_stream::{Aes256GcmStreamDecryptor, Aes256GcmStreamEncryptor};
+use zeroize::Zeroize;
+
+fn main() {
+    // IMPORTANT! key and nonce SHOULD generate by random
+    let mut key = [0u8; 32];
+    let mut nonce = [0; 12];
+
+    let mut encryptor = Aes256GcmStreamEncryptor::new(key.clone(), &nonce);
+
+    let mut ciphertext = vec![];
+    ciphertext.extend_from_slice(&encryptor.update(b"Hello "));
+    ciphertext.extend_from_slice(&encryptor.update(b" World"));
+    ciphertext.extend_from_slice(&encryptor.update(b"!"));
+    let (last_block, tag) = encryptor.finalize();
+    ciphertext.extend_from_slice(&last_block);
+    ciphertext.extend_from_slice(&tag);
+
+    println!("Ciphertext: {}", hex::encode(&ciphertext));
+
+    let mut decryptor = Aes256GcmStreamDecryptor::new(key.clone(), &nonce);
+
+    let mut plaintext = vec![];
+    plaintext.extend_from_slice(decryptor.update(&ciphertext).as_slice());
+    plaintext.extend_from_slice(&decryptor.finalize().expect("decrypt error"));
+
+    println!("Plaintext: {}", String::from_utf8_lossy(&plaintext));
+    key.zeroize();
+    nonce.zeroize();
+}