use crate::error::{Error, Result};
use crate::scheme::{Scheme, SchemeSerializeType};
use std::time::{Duration, SystemTime};
pub(crate) const IKM_BASE_STRUCT_SIZE: usize = 25;
pub(crate) type CounterId = u32;
pub type IkmId = u32;
#[derive(Debug)]
pub struct InputKeyMaterial {
pub(crate) id: IkmId,
pub(crate) scheme: Scheme,
pub(crate) content: Vec<u8>,
pub(crate) not_before: SystemTime,
pub(crate) not_after: SystemTime,
pub(crate) is_revoked: bool,
}
impl InputKeyMaterial {
#[cfg(feature = "ikm-management")]
pub fn get_id(&self) -> IkmId {
self.id
}
#[cfg(feature = "ikm-management")]
pub fn get_scheme(&self) -> Scheme {
self.scheme
}
#[cfg(feature = "ikm-management")]
pub fn get_not_before(&self) -> SystemTime {
self.not_before
}
#[cfg(feature = "ikm-management")]
pub fn get_not_after(&self) -> SystemTime {
self.not_after
}
#[cfg(feature = "ikm-management")]
pub fn is_revoked(&self) -> bool {
self.is_revoked
}
#[cfg(feature = "ikm-management")]
pub(crate) fn as_bytes(&self) -> Result<Vec<u8>> {
let mut res = Vec::with_capacity(IKM_BASE_STRUCT_SIZE + self.scheme.get_ikm_size());
res.extend_from_slice(&self.id.to_le_bytes());
res.extend_from_slice(&(self.scheme as SchemeSerializeType).to_le_bytes());
res.extend_from_slice(&self.content);
res.extend_from_slice(
&self
.not_before
.duration_since(SystemTime::UNIX_EPOCH)?
.as_secs()
.to_le_bytes(),
);
res.extend_from_slice(
&self
.not_after
.duration_since(SystemTime::UNIX_EPOCH)?
.as_secs()
.to_le_bytes(),
);
res.push(self.is_revoked as u8);
Ok(res)
}
pub(crate) fn from_bytes(b: &[u8]) -> Result<Self> {
if b.len() < IKM_BASE_STRUCT_SIZE {
return Err(Error::ParsingEncodedDataInvalidIkmLen(b.len()));
}
let scheme: Scheme =
SchemeSerializeType::from_le_bytes(b[4..8].try_into().unwrap()).try_into()?;
let is = scheme.get_ikm_size();
if b.len() != IKM_BASE_STRUCT_SIZE + is {
return Err(Error::ParsingEncodedDataInvalidIkmLen(b.len()));
}
Ok(Self {
id: IkmId::from_le_bytes(b[0..4].try_into().unwrap()),
scheme,
content: b[8..8 + is].into(),
not_before: InputKeyMaterial::bytes_to_system_time(&b[8 + is..8 + is + 8])?,
not_after: InputKeyMaterial::bytes_to_system_time(&b[8 + is + 8..8 + is + 8 + 8])?,
is_revoked: b[8 + is + 8 + 8] != 0,
})
}
fn bytes_to_system_time(ts_slice: &[u8]) -> Result<SystemTime> {
let ts_array: [u8; 8] = ts_slice.try_into().unwrap();
let ts = u64::from_le_bytes(ts_array);
SystemTime::UNIX_EPOCH
.checked_add(Duration::from_secs(ts))
.ok_or(Error::SystemTimeReprError(ts))
}
}
#[derive(Debug, Default)]
pub struct InputKeyMaterialList {
pub(crate) ikm_lst: Vec<InputKeyMaterial>,
#[allow(dead_code)]
pub(crate) id_counter: CounterId,
}
impl InputKeyMaterialList {
#[cfg(feature = "ikm-management")]
pub fn new() -> Self {
Self::default()
}
#[cfg(feature = "ikm-management")]
pub fn add_ikm(&mut self) -> Result<IkmId> {
let not_before = SystemTime::now();
let not_after = not_before + Duration::from_secs(crate::DEFAULT_IKM_DURATION);
self.add_custom_ikm(crate::DEFAULT_SCHEME, not_before, not_after)
}
#[cfg(feature = "ikm-management")]
pub fn add_custom_ikm(
&mut self,
scheme: Scheme,
not_before: SystemTime,
not_after: SystemTime,
) -> Result<IkmId> {
let ikm_len = scheme.get_ikm_size();
let mut content: Vec<u8> = vec![0; ikm_len];
getrandom::getrandom(content.as_mut_slice())?;
self.id_counter += 1;
self.ikm_lst.push(InputKeyMaterial {
id: self.id_counter,
scheme,
not_before,
not_after,
is_revoked: false,
content,
});
Ok(self.id_counter)
}
#[cfg(feature = "ikm-management")]
pub fn delete_ikm(&mut self, id: IkmId) -> Result<IkmId> {
let initial_len = self.ikm_lst.len();
self.ikm_lst.retain(|ikm| ikm.id != id);
if self.ikm_lst.len() == initial_len {
Err(Error::IkmNotFound(id))
} else {
Ok(id)
}
}
#[cfg(feature = "ikm-management")]
pub fn revoke_ikm(&mut self, id: IkmId) -> Result<IkmId> {
let ikm = self
.ikm_lst
.iter_mut()
.find(|ikm| ikm.id == id)
.ok_or(Error::IkmNotFound(id))?;
ikm.is_revoked = true;
Ok(id)
}
#[cfg(feature = "ikm-management")]
pub fn export(&self) -> Result<String> {
crate::storage::encode_ikm_list(self)
}
#[cfg_attr(
feature = "chacha",
doc = r##"
# Examples
```
let stored_ikml = "ikml-v1:AQAAAA:AQAAAAEAAAC_vYEw1ujVG5i-CtoPYSzik_6xaAq59odjPm5ij01-e6zz4mUAAAAALJGBiwAAAAAA";
let mut ikml = coffio::InputKeyMaterialList::import(stored_ikml)?;
assert_eq!(ikml.len(), 1);
# Ok::<(), coffio::Error>(())
```
"##
)]
pub fn import(s: &str) -> Result<Self> {
crate::storage::decode_ikm_list(s)
}
#[cfg(any(test, feature = "encryption"))]
pub(crate) fn get_latest_ikm(&self, encryption_time: SystemTime) -> Result<&InputKeyMaterial> {
self.ikm_lst
.iter()
.rev()
.find(|&ikm| {
!ikm.is_revoked
&& ikm.not_before < encryption_time
&& ikm.not_after > encryption_time
})
.ok_or(Error::IkmNoneAvailable)
}
#[cfg(feature = "encryption")]
pub(crate) fn get_ikm_by_id(&self, id: IkmId) -> Result<&InputKeyMaterial> {
self.ikm_lst
.iter()
.find(|&ikm| ikm.id == id)
.ok_or(Error::IkmNotFound(id))
}
}
impl std::str::FromStr for InputKeyMaterialList {
type Err = Error;
fn from_str(s: &str) -> Result<Self, Self::Err> {
Self::import(s)
}
}
#[cfg(feature = "ikm-management")]
impl std::ops::Deref for InputKeyMaterialList {
type Target = Vec<InputKeyMaterial>;
fn deref(&self) -> &Self::Target {
&self.ikm_lst
}
}
#[cfg(test)]
mod tests {
use super::*;
use std::str::FromStr;
#[test]
#[cfg(feature = "chacha")]
fn import() {
let s =
"ikml-v1:AQAAAA:AQAAAAEAAAC_vYEw1ujVG5i-CtoPYSzik_6xaAq59odjPm5ij01-e6zz4mUAAAAALJGBiwAAAAAA";
let res = InputKeyMaterialList::import(s);
assert!(res.is_ok(), "res: {res:?}");
let lst = res.unwrap();
assert_eq!(lst.id_counter, 1);
assert_eq!(lst.ikm_lst.len(), 1);
let ikm = lst.ikm_lst.first().unwrap();
assert_eq!(ikm.id, 1);
assert_eq!(ikm.scheme, Scheme::XChaCha20Poly1305WithBlake3);
assert_eq!(
ikm.content,
[
191, 189, 129, 48, 214, 232, 213, 27, 152, 190, 10, 218, 15, 97, 44, 226, 147, 254,
177, 104, 10, 185, 246, 135, 99, 62, 110, 98, 143, 77, 126, 123
]
);
assert_eq!(ikm.is_revoked, false);
}
#[test]
#[cfg(feature = "chacha")]
fn from_str() {
let s =
"ikml-v1:AQAAAA:AQAAAAEAAAC_vYEw1ujVG5i-CtoPYSzik_6xaAq59odjPm5ij01-e6zz4mUAAAAALJGBiwAAAAAA";
let res = InputKeyMaterialList::from_str(s);
assert!(res.is_ok(), "res: {res:?}");
let lst = res.unwrap();
assert_eq!(lst.id_counter, 1);
assert_eq!(lst.ikm_lst.len(), 1);
let ikm = lst.ikm_lst.first().unwrap();
assert_eq!(ikm.id, 1);
assert_eq!(ikm.scheme, Scheme::XChaCha20Poly1305WithBlake3);
assert_eq!(
ikm.content,
[
191, 189, 129, 48, 214, 232, 213, 27, 152, 190, 10, 218, 15, 97, 44, 226, 147, 254,
177, 104, 10, 185, 246, 135, 99, 62, 110, 98, 143, 77, 126, 123
]
);
assert_eq!(ikm.is_revoked, false);
}
}
#[cfg(test)]
fn get_default_time_period() -> (SystemTime, SystemTime) {
let not_before = SystemTime::now();
let not_after = not_before + Duration::from_secs(crate::DEFAULT_IKM_DURATION);
(not_before, not_after)
}
#[cfg(all(test, feature = "ikm-management"))]
mod ikm_management {
use super::*;
const TEST_STR: &str = "ikml-v1:BgAAAA:AQAAAAEAAACUAPcqngJ46_HMtJSdIw-WeUtImcCVxOA47n6UIN5K2TbmoVwAAAAANmuEXgAAAAAB:AgAAAAEAAADf7CR8vl_aWOUyfsO0ek0YQr_Yi7L_sJmF2nIt_XOaCzYNal4AAAAAtkBLYAAAAAAA:AwAAAAEAAAAMoNIW9gIGkzegUDEsU3N1Rf_Zz0OMuylUSiQjUzLXqzY0MmAAAAAANsk0iwEAAAAA:BAAAAAEAAABbwRrMz3x3DkfOEFg1BHfLLRHoNqg6d_xGWwdh48hH8rZm9mEAAAAANjy9YwAAAAAA:BQAAAAEAAAA2LwnTgDUF7qn7dy79VA24JSSgo6vllAtU5zmhrxNJu7YIz4sBAAAANoUMjgEAAAAB:BgAAAAEAAAAn0Vqe2f9YRXBt6xVYaeSLs0Gf0S0_5B-hk-a2b0rhlraCJbwAAAAAtlErjAEAAAAA";
fn round_time(t: SystemTime) -> SystemTime {
let secs = t.duration_since(SystemTime::UNIX_EPOCH).unwrap().as_secs();
SystemTime::UNIX_EPOCH
.checked_add(Duration::from_secs(secs))
.unwrap()
}
#[test]
#[cfg(feature = "chacha")]
fn gen_ikm_list() {
let mut lst = InputKeyMaterialList::new();
assert_eq!(lst.id_counter, 0);
assert_eq!(lst.ikm_lst.len(), 0);
let res = lst.add_ikm();
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(lst.id_counter, 1);
assert_eq!(lst.ikm_lst.len(), 1);
assert!(lst.ikm_lst.first().is_some());
let el = lst.ikm_lst.first().unwrap();
assert_eq!(el.id, res.unwrap());
assert_eq!(el.id, 1);
assert_eq!(el.is_revoked, false);
let (not_before, not_after) = get_default_time_period();
let res = lst.add_custom_ikm(Scheme::XChaCha20Poly1305WithBlake3, not_before, not_after);
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(lst.id_counter, 2);
assert_eq!(lst.ikm_lst.len(), 2);
let res = lst.add_ikm();
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(lst.id_counter, 3);
assert_eq!(lst.ikm_lst.len(), 3);
}
#[test]
fn export_empty() {
let lst = InputKeyMaterialList::new();
assert_eq!(lst.id_counter, 0);
assert_eq!(lst.ikm_lst.len(), 0);
let res = lst.export();
assert!(res.is_ok(), "res: {res:?}");
let s = res.unwrap();
assert_eq!(&s, "ikml-v1:AAAAAA");
}
#[test]
fn export() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let res = lst.export();
assert!(res.is_ok(), "res: {res:?}");
let s = res.unwrap();
assert_eq!(s.len(), 91);
}
#[test]
#[cfg(feature = "chacha")]
fn import() {
let res = InputKeyMaterialList::import(TEST_STR);
assert!(res.is_ok(), "res: {res:?}");
let lst = res.unwrap();
assert_eq!(lst.id_counter, 6);
assert_eq!(lst.ikm_lst.len(), 6);
}
#[test]
fn export_import_empty() {
let lst = InputKeyMaterialList::new();
let res = lst.export();
assert!(res.is_ok(), "res: {res:?}");
let s = res.unwrap();
let res = InputKeyMaterialList::import(&s);
assert!(res.is_ok(), "res: {res:?}");
let lst_bis = res.unwrap();
assert_eq!(lst_bis.id_counter, lst.id_counter);
assert_eq!(lst_bis.id_counter, 0);
assert_eq!(lst_bis.ikm_lst.len(), lst.ikm_lst.len());
assert_eq!(lst_bis.ikm_lst.len(), 0);
}
#[test]
fn export_import() {
let mut lst = InputKeyMaterialList::new();
for _ in 0..10 {
let _ = lst.add_ikm();
}
let res = lst.export();
assert!(res.is_ok(), "res: {res:?}");
let s = res.unwrap();
let res = InputKeyMaterialList::import(&s);
assert!(res.is_ok(), "res: {res:?}");
let lst_bis = res.unwrap();
assert_eq!(lst_bis.id_counter, lst.id_counter);
assert_eq!(lst_bis.id_counter, 10);
assert_eq!(lst_bis.ikm_lst.len(), lst.ikm_lst.len());
assert_eq!(lst_bis.ikm_lst.len(), 10);
for i in 0..10 {
let el = &lst.ikm_lst[i];
let el_bis = &lst_bis.ikm_lst[i];
assert_eq!(el_bis.id, el.id);
assert_eq!(el_bis.content, el.content);
assert_eq!(el_bis.not_before, round_time(el.not_before));
assert_eq!(el_bis.not_after, round_time(el.not_after));
assert_eq!(el_bis.is_revoked, el.is_revoked);
}
}
#[test]
fn delete_ikm() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let latest_ikm = lst.get_latest_ikm(SystemTime::now()).unwrap();
assert_eq!(latest_ikm.id, 2);
let res = lst.delete_ikm(2);
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(res.unwrap(), 2);
let latest_ikm = lst.get_latest_ikm(SystemTime::now()).unwrap();
assert_eq!(latest_ikm.id, 1);
let res = lst.delete_ikm(1);
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(res.unwrap(), 1);
let res = lst.get_latest_ikm(SystemTime::now());
assert!(res.is_err());
let res = lst.delete_ikm(42);
assert!(res.is_err(), "res: {res:?}");
}
#[test]
fn revoke_ikm() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let latest_ikm = lst.get_latest_ikm(SystemTime::now()).unwrap();
assert_eq!(latest_ikm.id, 2);
let res = lst.revoke_ikm(2);
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(res.unwrap(), 2);
let latest_ikm = lst.get_latest_ikm(SystemTime::now()).unwrap();
assert_eq!(latest_ikm.id, 1);
let res = lst.revoke_ikm(1);
assert!(res.is_ok(), "res: {res:?}");
assert_eq!(res.unwrap(), 1);
let res = lst.get_latest_ikm(SystemTime::now());
assert!(res.is_err());
let res = lst.revoke_ikm(42);
assert!(res.is_err(), "res: {res:?}");
}
#[test]
fn iterate() {
let mut lst = InputKeyMaterialList::new();
for _ in 0..10 {
let _ = lst.add_ikm();
}
let mut id = 1;
for ikm in lst.iter() {
assert_eq!(id, ikm.id);
id += 1;
}
}
#[test]
#[cfg(feature = "chacha")]
fn get_latest_ikm_epoch() {
let res = InputKeyMaterialList::import(TEST_STR);
assert!(res.is_ok(), "res: {res:?}");
let lst = res.unwrap();
let res = lst.get_latest_ikm(SystemTime::UNIX_EPOCH);
assert_eq!(res.err(), Some(Error::IkmNoneAvailable))
}
#[test]
#[cfg(feature = "chacha")]
fn get_latest_ikm_1_712_475_802() {
let ts = SystemTime::UNIX_EPOCH + Duration::from_secs(1_712_475_802);
let res = InputKeyMaterialList::import(TEST_STR);
assert!(res.is_ok(), "res: {res:?}");
let lst = res.unwrap();
let res = lst.get_latest_ikm(ts);
assert!(res.is_ok(), "res: {res:?}");
let ikm = res.unwrap();
assert_eq!(ikm.id, 3);
}
#[test]
#[cfg(feature = "chacha")]
fn get_latest_ikm_1_592_734_902() {
let ts = SystemTime::UNIX_EPOCH + Duration::from_secs(1_592_734_902);
let res = InputKeyMaterialList::import(TEST_STR);
assert!(res.is_ok(), "res: {res:?}");
let lst = res.unwrap();
let res = lst.get_latest_ikm(ts);
assert!(res.is_ok(), "res: {res:?}");
let ikm = res.unwrap();
assert_eq!(ikm.id, 2);
}
}
#[cfg(all(test, feature = "encryption", feature = "ikm-management"))]
mod encryption {
use super::*;
#[test]
#[cfg(feature = "chacha")]
fn get_latest_ikm_xchacha20poly1305_blake3() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let (not_before, not_after) = get_default_time_period();
let _ = lst.add_custom_ikm(Scheme::XChaCha20Poly1305WithBlake3, not_before, not_after);
let res = lst.get_latest_ikm(SystemTime::now());
assert!(res.is_ok(), "res: {res:?}");
let latest_ikm = res.unwrap();
assert_eq!(latest_ikm.id, 3);
assert_eq!(latest_ikm.scheme, Scheme::XChaCha20Poly1305WithBlake3);
assert_eq!(latest_ikm.content.len(), 32);
}
#[test]
#[cfg(feature = "sha")]
fn get_latest_ikm_aes128gcm_sha256() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let (not_before, not_after) = get_default_time_period();
let _ = lst.add_custom_ikm(Scheme::Aes128GcmWithSha256, not_before, not_after);
let res = lst.get_latest_ikm(SystemTime::now());
assert!(res.is_ok(), "res: {res:?}");
let latest_ikm = res.unwrap();
assert_eq!(latest_ikm.id, 3);
assert_eq!(latest_ikm.scheme, Scheme::Aes128GcmWithSha256);
assert_eq!(latest_ikm.content.len(), 32);
}
#[test]
fn get_latest_ikm_empty() {
let lst = InputKeyMaterialList::new();
let res = lst.get_latest_ikm(SystemTime::now());
assert!(res.is_err());
}
#[test]
fn get_ikm_by_id() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
for i in 1..=3 {
let res = lst.get_ikm_by_id(i);
assert!(res.is_ok(), "res: {res:?}");
let latest_ikm = res.unwrap();
assert_eq!(latest_ikm.id, i);
}
}
#[test]
fn get_ikm_by_id_noexists() {
let mut lst = InputKeyMaterialList::new();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let _ = lst.add_ikm();
let res = lst.get_ikm_by_id(42);
assert!(res.is_err());
}
}