rebase changes

Author: lonerapier

mfkdf2/src/definitions/bytearray.rs

@@ -1,3 +1,5 @@
+//! Generic ByteArray type for FFI boundaries, typically used for fixed-size byte arrays like keys
+//! and salts.
 use serde::{Deserialize, Serialize};
 
 /// Generic fixed-size byte array used as the basis for key-like types.

mfkdf2/src/definitions/mod.rs

@@ -1,8 +1,17 @@
-pub mod bytearray;
-pub mod mfkdf_derived_key;
-use serde::{Deserialize, Serialize};
-#[cfg(feature = "bindings")] mod uniffi_types;
-
+//! # MFKDF2 Definitions
+//!
+//! This module contains the definitions for the MFKDF2 protocol.
+//!
+//! - [`MFKDF2Options`]: Options for setting up a [`MFKDF2DerivedKey`] key.
+//! - [`MFKDF2Entropy`]: Entropy estimation for the derived key.
+//! - [`MFKDF2Factor`]: Factor type.
+//! - [`MFKDF2DerivedKey`]: Derived key after setup or derive operation.
+//! - [`FactorMetadata`]: Trait for factor metadata.
+//! - [`FactorType`]: Factor type enum.
+//! - [`ByteArray`]: Generic byte array type.
+//! - [`Key`]: 32 byte key.
+//! - [`Salt`]: 32 byte salt.
+mod bytearray;
 mod entropy;
 pub mod factor;
 pub mod mfkdf_derived_key;

mfkdf2/src/lib.rs

@@ -1,5 +1,5 @@
 #![doc = include_str!("../README.md")]
-#![warn(missing_docs, rustdoc::missing_doc_code_examples)]
+#![warn(missing_docs)]
 #![warn(unused_extern_crates, unreachable_pub, nonstandard_style)]
 
 pub mod constants;

mfkdf2/src/otpauth.rs

@@ -86,7 +86,7 @@ pub struct OtpAuthUrlOptions {
   pub counter:   Option<u64>,
   /// The period parameter defines a validity period in seconds for the TOTP code. It is only
   /// applicable for TOTP credentials and defaults to 30 seconds
-  pub period:    Option<u64>,
+  pub period:    Option<u32>,
   /// The encoding of the secret
   pub encoding:  Option<Encoding>,
   /// The hash algorithm to use for the credential

mfkdf2/src/setup/factors/stack.rs

@@ -9,7 +9,9 @@ use serde::{Deserialize, Serialize};
 use serde_json::Value;
 
 use crate::{
-  definitions::{FactorMetadata, FactorType, Key, MFKDF2DerivedKey, MFKDF2Factor, Salt},
+  definitions::{
+    FactorMetadata, FactorType, Key, MFKDF2DerivedKey, MFKDF2Factor, MFKDF2Options, Salt,
+  },
   error::{MFKDF2Error, MFKDF2Result},
   setup::{FactorSetup, key},
 };

mfkdf2/src/setup/key.rs

@@ -117,11 +117,12 @@ use crate::{
 /// };
 ///
 /// let factor = password("password123", PasswordOptions { id: Some("pw".to_string()) })?;
-/// let salt = vec![42u8; 32];
-/// let options =
-///   MFKDF2Options {
-///     id: Some("my‑policy‑id".to_string()), salt: Some(salt), ..Default::default()
-///   };
+/// let salt = [42u8; 32];
+/// let options = MFKDF2Options {
+///   id: Some("my‑policy‑id".to_string()),
+///   salt: Some(salt.into()),
+///   ..Default::default()
+/// };
 ///
 /// let setup_key = setup::key(&[factor], options)?;
 ///

mfkdf2/tests/integration.rs

@@ -250,7 +250,7 @@ fn totp_static() -> Result<(), mfkdf2::error::MFKDF2Error> {
       time: Some(1),
       ..Default::default()
     })?],
-    mfkdf2::setup::key::MFKDF2Options::default(),
+    mfkdf2::definitions::MFKDF2Options::default(),
   )?;
 
   let derived_key1 = mfkdf2::derive::key(

mfkdf2/tests/integrity.rs

@@ -14,11 +14,8 @@ use crate::common::{create_derive_factor, create_setup_factor};
 fn make_policy(setup_factor_names: &[&str], threshold: u8, integrity: bool) -> MFKDF2DerivedKey {
   let setup_factors: Vec<_> = setup_factor_names.iter().copied().map(create_setup_factor).collect();
 
-  let options = mfkdf2::setup::key::MFKDF2Options {
-    threshold: Some(threshold),
-    integrity: Some(integrity),
-    ..Default::default()
-  };
+  let options =
+    MFKDF2Options { threshold: Some(threshold), integrity: Some(integrity), ..Default::default() };
 
   mfkdf2::setup::key(&setup_factors, options).unwrap()
 }