oxicrypto-core 0.1.0

Pure Rust cryptography trait surface (no_std + alloc)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44

use alloc::vec::Vec;

use crate::{CryptoError, KeyPair, SecretVec};

/// Asymmetric signing operation.
pub trait Signer: Send + Sync {
    /// Human-readable algorithm identifier (e.g. `"Ed25519"`).
    #[must_use]
    fn name(&self) -> &'static str;
    /// Fixed signature length in bytes.
    #[must_use]
    fn signature_len(&self) -> usize;
    /// Sign `msg` with `sk` (raw secret-key bytes) and write the signature
    /// into `sig_out`.
    ///
    /// Returns the number of bytes written.
    #[must_use = "result must be checked"]
    fn sign(&self, sk: &[u8], msg: &[u8], sig_out: &mut [u8]) -> Result<usize, CryptoError>;
}

/// Asymmetric signature verification.
pub trait Verifier: Send + Sync {
    /// Human-readable algorithm identifier (e.g. `"Ed25519"`).
    #[must_use]
    fn name(&self) -> &'static str;
    /// Verify `sig` over `msg` with `pk` (raw public-key bytes).
    ///
    /// Returns [`CryptoError::InvalidTag`] on verification failure.
    #[must_use = "result must be checked"]
    fn verify(&self, pk: &[u8], msg: &[u8], sig: &[u8]) -> Result<(), CryptoError>;
}

/// Key pair generator for asymmetric algorithms.
pub trait KeyGenerator: Send + Sync {
    /// Human-readable algorithm identifier (e.g. `"Ed25519"`).
    #[must_use]
    fn name(&self) -> &'static str;
    /// Generate a fresh key pair.
    ///
    /// Returns `(secret_key, public_key)` wrapped in [`KeyPair`].
    /// The secret half uses [`SecretVec`] (auto-zeroized on drop).
    #[must_use = "result must be checked"]
    fn generate_keypair(&self) -> Result<KeyPair<SecretVec, Vec<u8>>, CryptoError>;
}