From e6c387dc2d9bcd4cfaa8a82317e46202f9a53e52 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Rodolphe=20Br=C3=A9ard?= <v.code.ngyvz7vf@what.tf>
Date: Mon, 24 Jun 2024 19:07:37 +0200
Subject: [PATCH] Add crate-level documentation

---
 src/lib.rs | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 86 insertions(+)

diff --git a/src/lib.rs b/src/lib.rs
index 91b69c1..6f673a0 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -1,3 +1,89 @@
+#![warn(missing_docs)]
+
+//! # Supported use case
+//!
+//! Coffio has been made to encrypt data of moderate size (less than 1/3 of the available memory)
+//! using a secret key.
+//!
+//! # Unsupported use cases
+//!
+//! Coffio cannot:
+//! - encrypt data using a password
+//! - handle files that cannot fit into 1/3 of the available memory
+//! - be used in a communication protocol
+//! - be used as a key exchange
+//! - etc.
+//!
+//! # The IKM list
+//!
+//! The encryption keys are automatically derived from a random seed called input key material
+//! (IKM). Because an IKM is bound to a specific encryption algorithm, is limited to a time period
+//! and can be revoked, Coffio requires a list of IKM, although the list could have only one.
+//!
+//! Therefore, before encrypting data, you have to generate an IKM list. Most of the time, you
+//! might want to generate it outside of your application and handle it as you would handle a
+//! secret key.
+//!
+//! # Features
+//!
+//! The following features allows you to control which interfaces are exposed.
+//!
+//! - `encryption` (default): interfaces related to data encryption and decryption
+//! - `ikm-management` (default): interfaces related to the IKM list management
+//! - `encrypt-at`: add a function allowing to encrypt data using a specified timestamp
+//!
+//! The following features allows you to control which encryption algorithms are activated.
+//!
+//! - `chacha` (default): [Scheme::XChaCha20Poly1305WithBlake3]
+//! - `aes` (default): [Scheme::Aes128GcmWithSha256]
+//!
+//! Other features are:
+//!
+//! - `benchmark`: useful only to run the benchmark
+//!
+//! # Examples
+//!
+//! ## Generating an IKM list.
+//!
+//! ```
+//! use coffio::InputKeyMaterialList;
+//!
+//! let mut ikml = InputKeyMaterialList::new();
+//! let _ = ikml.add_ikm()?;
+//! let ikml_str = ikml.export()?;
+//!
+//! println!("Generated IKM list: {ikml_str}");
+//!
+//! # Ok::<(), coffio::Error>(())
+//! ```
+//!
+//! ## Encrypting and decrypting data.
+//!
+//! ```
+//! use coffio::{Coffio, DataContext, InputKeyMaterialList, KeyContext};
+//!
+//! let ikml_raw = "ikml-v1:AQAAAA:AQAAAAEAAAC_vYEw1ujVG5i-CtoPYSzik_6xaAq59odjPm5ij01-e6zz4mUAAAAALJGBiwAAAAAA";
+//! let ikm_list = InputKeyMaterialList::import(ikml_raw)?;
+//! let my_key_ctx: KeyContext = [
+//!     "db name",
+//!     "table name",
+//!     "column name",
+//! ].into();
+//! let my_data_ctx: DataContext = [
+//!     "694c721a-29e8-4793-b7a4-46a4a0bf1a70",
+//!     "some username",
+//! ].into();
+//! let data = b"Hello, World!";
+//!
+//! let coffio = Coffio::new(&ikm_list);
+//! let encrypted_data = coffio.encrypt(&my_key_ctx, &my_data_ctx, data)?;
+//! let decrypted_data = coffio.decrypt(&my_key_ctx, &my_data_ctx, &encrypted_data)?;
+//!
+//! assert_eq!(data, decrypted_data.as_slice());
+//!
+//! # Ok::<(), coffio::Error>(())
+//! ```
+
 #[cfg(feature = "encryption")]
 mod canonicalization;
 #[cfg(feature = "encryption")]