merge from release/0.1.2alpha

Author: ounsworth

Cargo.toml

@@ -7,22 +7,22 @@ edition = "2024"
 [workspace.dependencies]
 
 # *** Internal Dependencies ***
-bouncycastle = { path = "./", version = "0.1.1" }
-bouncycastle-base64 = { path = "./crypto/base64", version = "0.1.1" }
-bouncycastle-core = { path = "crypto/core", version = "0.1.1" }
-bouncycastle-core-test-framework = { path = "./crypto/core-test-framework", version = "0.1.1" }
-bouncycastle-factory = { path = "./crypto/factory", version = "0.1.1" }
-bouncycastle-hex = { path = "./crypto/hex", version = "0.1.1" }
-bouncycastle-hkdf = { path = "./crypto/hkdf", version = "0.1.1" }
-bouncycastle-hmac = { path = "./crypto/hmac", version = "0.1.1" }
+bouncycastle = { path = "./", version = "0.1.2" }
+bouncycastle-base64 = { path = "./crypto/base64", version = "0.1.2" }
+bouncycastle-core = { path = "crypto/core", version = "0.1.2" }
+bouncycastle-core-test-framework = { path = "./crypto/core-test-framework", version = "0.1.2" }
+bouncycastle-factory = { path = "./crypto/factory", version = "0.1.2" }
+bouncycastle-hex = { path = "./crypto/hex", version = "0.1.2" }
+bouncycastle-hkdf = { path = "./crypto/hkdf", version = "0.1.2" }
+bouncycastle-hmac = { path = "./crypto/hmac", version = "0.1.2" }
 bouncycastle-mlkem = { path = "./crypto/mlkem", version = "0.1.2" }
 bouncycastle-mlkem-lowmemory = { path = "./crypto/mlkem-lowmemory", version = "0.1.2" }
 bouncycastle-mldsa = { path = "./crypto/mldsa", version = "0.1.2" }
 bouncycastle-mldsa-lowmemory = { path = "./crypto/mldsa-lowmemory", version = "0.1.2" }
-bouncycastle-rng = { path = "./crypto/rng", version = "0.1.1" }
-bouncycastle-sha2 = { path = "./crypto/sha2", version = "0.1.1" }
-bouncycastle-sha3 = { path = "./crypto/sha3", version = "0.1.1" }
-bouncycastle-utils = { path = "./crypto/utils", version = "0.1.1" }
+bouncycastle-rng = { path = "./crypto/rng", version = "0.1.2" }
+bouncycastle-sha2 = { path = "./crypto/sha2", version = "0.1.2" }
+bouncycastle-sha3 = { path = "./crypto/sha3", version = "0.1.2" }
+bouncycastle-utils = { path = "./crypto/utils", version = "0.1.2" }
 
 
 # *** External Dependencies ***

QUALITY_AND_STYLE.md

@@ -32,7 +32,7 @@ Where the behaviour of a function is critical to test but cannot be tested from
 private function, in-line tests in the source file should be used.
 
 All traits in `bouncycastle-core` must have corresponding tests in `bouncycastle-core-test-framework` that exercise all
-behaviours and error conditions that are comment to all implementations of that trait.
+behaviours and error conditions that are common to all implementations of that trait.
 
 All crypto algorithms must have tests against the bc-test-data repo and against wycheproof.
 
@@ -61,6 +61,17 @@ yourself whether this function would take 6-months-from-now-you more than 10 min
 there comments you could add that would help future you get back up to speed faster about what this code is doing and
 which parts were done for a very specific reason and should not be changed on a whim.
 
+## Naming Conventions
+
+All normal rust naming convensions from clippy apply. In addition, some library-specific naming conventions:
+
+* In constants, "LEN" is the length of a value in bytes (typically used for sizing arrays), whereas "SIZE" is a value in
+  bits (typically used as a security parameter). For example SHA256 could have constants `HASH_SIZE = 256` and
+  `HASH_LEN = 32`.
+* Functions that are part of a stateful streaming api should be named `do_*()`.
+* We use "pk" for public key and "sk" for secret key / private key. (some other libraries use "pub" and "priv", but "
+  pub" is a keyword in rust, and "pubkey / privkey" is verbose :P )
+
 ## APIs
 
 Where possible, primitives should expose "one-shot APIs" that simply take data and return a result as a static member

crypto/base64/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bouncycastle-base64"
-version = "0.1.1"
+version = "0.1.2"
 edition.workspace = true
 
 [dependencies]

crypto/core-test-framework/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "bouncycastle-core-test-framework"
-version = "0.1.1"
+version = "0.1.2"
 edition.workspace = true
 
 [dependencies]

crypto/core-test-framework/src/lib.rs

@@ -15,6 +15,7 @@ pub mod kem;
 pub mod mac;
 pub mod signature;
 pub mod suspendable_state;
+pub mod symmetric_ciphers;
 
 mod fixed_seed_rng;
 pub use fixed_seed_rng::FixedSeedRNG;