chie-crypto 0.2.0

Cryptographic primitives for CHIE Protocol
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
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
//! Stateless Hash-Based Signatures with SPHINCS+.
//!
//! This module implements SPHINCS+, a stateless hash-based post-quantum
//! signature scheme with minimal security assumptions. Unlike lattice-based
//! schemes, SPHINCS+ only relies on the security of hash functions.
//!
//! # Security Levels
//! - SPHINCS+-SHAKE-128f: Fast variant, security level 1 (AES-128 equivalent)
//! - SPHINCS+-SHAKE-192f: Fast variant, security level 3 (AES-192 equivalent)
//! - SPHINCS+-SHAKE-256f: Fast variant, security level 5 (AES-256 equivalent) - **Recommended**
//!
//! # Characteristics
//! - **Minimal assumptions**: Security relies only on hash functions
//! - **No quantum vulnerability**: Secure against quantum attacks
//! - **Larger signatures**: Trade-off for stronger security guarantees
//! - **Stateless**: No state management required (unlike XMSS)
//!
//! # Use Cases for CHIE Protocol
//! - Long-term archival signatures (decades of security)
//! - Maximum security for critical content
//! - Conservative post-quantum approach
//! - When signature size is less critical than security
//!
//! # Example
//! ```
//! use chie_crypto::sphincs::*;
//!
//! // Generate a keypair
//! let (pk, sk) = SphincsSHAKE256f::keypair();
//!
//! // Sign a message
//! let message = b"Critical archival content";
//! let signature = SphincsSHAKE256f::sign(message, &sk);
//!
//! // Verify the signature
//! assert!(SphincsSHAKE256f::verify(message, &signature, &pk).is_ok());
//!
//! // Invalid message should fail verification
//! let wrong_message = b"Different content";
//! assert!(SphincsSHAKE256f::verify(wrong_message, &signature, &pk).is_err());
//! ```

use pqcrypto_sphincsplus::{
    sphincsshake128fsimple, sphincsshake192fsimple, sphincsshake256fsimple,
};
use pqcrypto_traits::sign::{DetachedSignature as _, PublicKey as _, SecretKey as _};
use serde::{Deserialize, Serialize};
use zeroize::Zeroizing;

/// Errors that can occur during SPHINCS+ operations.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SphincsError {
    /// Invalid public key length
    InvalidPublicKey,
    /// Invalid secret key length
    InvalidSecretKey,
    /// Invalid signature length
    InvalidSignature,
    /// Signature verification failed
    VerificationFailed,
    /// Signing failed
    SigningFailed,
    /// Serialization/deserialization error
    SerializationError,
}

impl std::fmt::Display for SphincsError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            SphincsError::InvalidPublicKey => write!(f, "Invalid public key length"),
            SphincsError::InvalidSecretKey => write!(f, "Invalid secret key length"),
            SphincsError::InvalidSignature => write!(f, "Invalid signature length"),
            SphincsError::VerificationFailed => write!(f, "Signature verification failed"),
            SphincsError::SigningFailed => write!(f, "Signing failed"),
            SphincsError::SerializationError => write!(f, "Serialization/deserialization error"),
        }
    }
}

impl std::error::Error for SphincsError {}

/// Result type for SPHINCS+ operations.
pub type SphincsResult<T> = Result<T, SphincsError>;

/// SPHINCS+-SHAKE-128f public key (security level 1).
#[derive(Clone, Serialize, Deserialize)]
pub struct SphincsSHAKE128fPublicKey(Vec<u8>);

/// SPHINCS+-SHAKE-128f secret key (security level 1).
#[derive(Clone)]
pub struct SphincsSHAKE128fSecretKey(Zeroizing<Vec<u8>>);

impl Serialize for SphincsSHAKE128fSecretKey {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        self.0.as_slice().serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for SphincsSHAKE128fSecretKey {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let bytes = Vec::<u8>::deserialize(deserializer)?;
        Ok(SphincsSHAKE128fSecretKey(Zeroizing::new(bytes)))
    }
}

/// SPHINCS+-SHAKE-128f signature.
#[derive(Clone, Serialize, Deserialize)]
pub struct SphincsSHAKE128fSignature(Vec<u8>);

/// SPHINCS+-SHAKE-192f public key (security level 3).
#[derive(Clone, Serialize, Deserialize)]
pub struct SphincsSHAKE192fPublicKey(Vec<u8>);

/// SPHINCS+-SHAKE-192f secret key (security level 3).
#[derive(Clone)]
pub struct SphincsSHAKE192fSecretKey(Zeroizing<Vec<u8>>);

impl Serialize for SphincsSHAKE192fSecretKey {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        self.0.as_slice().serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for SphincsSHAKE192fSecretKey {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let bytes = Vec::<u8>::deserialize(deserializer)?;
        Ok(SphincsSHAKE192fSecretKey(Zeroizing::new(bytes)))
    }
}

/// SPHINCS+-SHAKE-192f signature.
#[derive(Clone, Serialize, Deserialize)]
pub struct SphincsSHAKE192fSignature(Vec<u8>);

/// SPHINCS+-SHAKE-256f public key (security level 5) - Recommended.
#[derive(Clone, Serialize, Deserialize)]
pub struct SphincsSHAKE256fPublicKey(Vec<u8>);

/// SPHINCS+-SHAKE-256f secret key (security level 5) - Recommended.
#[derive(Clone)]
pub struct SphincsSHAKE256fSecretKey(Zeroizing<Vec<u8>>);

impl Serialize for SphincsSHAKE256fSecretKey {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        self.0.as_slice().serialize(serializer)
    }
}

impl<'de> Deserialize<'de> for SphincsSHAKE256fSecretKey {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        let bytes = Vec::<u8>::deserialize(deserializer)?;
        Ok(SphincsSHAKE256fSecretKey(Zeroizing::new(bytes)))
    }
}

/// SPHINCS+-SHAKE-256f signature.
#[derive(Clone, Serialize, Deserialize)]
pub struct SphincsSHAKE256fSignature(Vec<u8>);

/// SPHINCS+-SHAKE-128f - Fast variant, security level 1 (AES-128 equivalent).
pub struct SphincsSHAKE128f;

impl SphincsSHAKE128f {
    /// Generate a new keypair.
    pub fn keypair() -> (SphincsSHAKE128fPublicKey, SphincsSHAKE128fSecretKey) {
        let (pk, sk) = sphincsshake128fsimple::keypair();
        (
            SphincsSHAKE128fPublicKey(pk.as_bytes().to_vec()),
            SphincsSHAKE128fSecretKey(Zeroizing::new(sk.as_bytes().to_vec())),
        )
    }

    /// Sign a message.
    pub fn sign(message: &[u8], sk: &SphincsSHAKE128fSecretKey) -> SphincsSHAKE128fSignature {
        let secret_key = sphincsshake128fsimple::SecretKey::from_bytes(&sk.0).unwrap();
        let sig = sphincsshake128fsimple::detached_sign(message, &secret_key);
        SphincsSHAKE128fSignature(sig.as_bytes().to_vec())
    }

    /// Verify a signature.
    pub fn verify(
        message: &[u8],
        signature: &SphincsSHAKE128fSignature,
        pk: &SphincsSHAKE128fPublicKey,
    ) -> SphincsResult<()> {
        let public_key = sphincsshake128fsimple::PublicKey::from_bytes(&pk.0)
            .map_err(|_| SphincsError::InvalidPublicKey)?;
        let sig = sphincsshake128fsimple::DetachedSignature::from_bytes(&signature.0)
            .map_err(|_| SphincsError::InvalidSignature)?;

        sphincsshake128fsimple::verify_detached_signature(&sig, message, &public_key)
            .map_err(|_| SphincsError::VerificationFailed)
    }
}

/// SPHINCS+-SHAKE-192f - Fast variant, security level 3 (AES-192 equivalent).
pub struct SphincsSHAKE192f;

impl SphincsSHAKE192f {
    /// Generate a new keypair.
    pub fn keypair() -> (SphincsSHAKE192fPublicKey, SphincsSHAKE192fSecretKey) {
        let (pk, sk) = sphincsshake192fsimple::keypair();
        (
            SphincsSHAKE192fPublicKey(pk.as_bytes().to_vec()),
            SphincsSHAKE192fSecretKey(Zeroizing::new(sk.as_bytes().to_vec())),
        )
    }

    /// Sign a message.
    pub fn sign(message: &[u8], sk: &SphincsSHAKE192fSecretKey) -> SphincsSHAKE192fSignature {
        let secret_key = sphincsshake192fsimple::SecretKey::from_bytes(&sk.0).unwrap();
        let sig = sphincsshake192fsimple::detached_sign(message, &secret_key);
        SphincsSHAKE192fSignature(sig.as_bytes().to_vec())
    }

    /// Verify a signature.
    pub fn verify(
        message: &[u8],
        signature: &SphincsSHAKE192fSignature,
        pk: &SphincsSHAKE192fPublicKey,
    ) -> SphincsResult<()> {
        let public_key = sphincsshake192fsimple::PublicKey::from_bytes(&pk.0)
            .map_err(|_| SphincsError::InvalidPublicKey)?;
        let sig = sphincsshake192fsimple::DetachedSignature::from_bytes(&signature.0)
            .map_err(|_| SphincsError::InvalidSignature)?;

        sphincsshake192fsimple::verify_detached_signature(&sig, message, &public_key)
            .map_err(|_| SphincsError::VerificationFailed)
    }
}

/// SPHINCS+-SHAKE-256f - Fast variant, security level 5 (AES-256 equivalent) - **Recommended**.
pub struct SphincsSHAKE256f;

impl SphincsSHAKE256f {
    /// Generate a new keypair.
    pub fn keypair() -> (SphincsSHAKE256fPublicKey, SphincsSHAKE256fSecretKey) {
        let (pk, sk) = sphincsshake256fsimple::keypair();
        (
            SphincsSHAKE256fPublicKey(pk.as_bytes().to_vec()),
            SphincsSHAKE256fSecretKey(Zeroizing::new(sk.as_bytes().to_vec())),
        )
    }

    /// Sign a message.
    pub fn sign(message: &[u8], sk: &SphincsSHAKE256fSecretKey) -> SphincsSHAKE256fSignature {
        let secret_key = sphincsshake256fsimple::SecretKey::from_bytes(&sk.0).unwrap();
        let sig = sphincsshake256fsimple::detached_sign(message, &secret_key);
        SphincsSHAKE256fSignature(sig.as_bytes().to_vec())
    }

    /// Verify a signature.
    pub fn verify(
        message: &[u8],
        signature: &SphincsSHAKE256fSignature,
        pk: &SphincsSHAKE256fPublicKey,
    ) -> SphincsResult<()> {
        let public_key = sphincsshake256fsimple::PublicKey::from_bytes(&pk.0)
            .map_err(|_| SphincsError::InvalidPublicKey)?;
        let sig = sphincsshake256fsimple::DetachedSignature::from_bytes(&signature.0)
            .map_err(|_| SphincsError::InvalidSignature)?;

        sphincsshake256fsimple::verify_detached_signature(&sig, message, &public_key)
            .map_err(|_| SphincsError::VerificationFailed)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_sphincs128_keypair_generation() {
        let (_pk, _sk) = SphincsSHAKE128f::keypair();
        // Just verify it doesn't panic
    }

    #[test]
    fn test_sphincs128_sign_verify() {
        let (pk, sk) = SphincsSHAKE128f::keypair();
        let message = b"Test message";

        let signature = SphincsSHAKE128f::sign(message, &sk);
        assert!(SphincsSHAKE128f::verify(message, &signature, &pk).is_ok());
    }

    #[test]
    fn test_sphincs128_wrong_message_fails() {
        let (pk, sk) = SphincsSHAKE128f::keypair();
        let message = b"Original message";
        let wrong_message = b"Wrong message";

        let signature = SphincsSHAKE128f::sign(message, &sk);
        assert!(SphincsSHAKE128f::verify(wrong_message, &signature, &pk).is_err());
    }

    #[test]
    fn test_sphincs128_wrong_public_key_fails() {
        let (_pk1, sk1) = SphincsSHAKE128f::keypair();
        let (pk2, _sk2) = SphincsSHAKE128f::keypair();
        let message = b"Test message";

        let signature = SphincsSHAKE128f::sign(message, &sk1);
        assert!(SphincsSHAKE128f::verify(message, &signature, &pk2).is_err());
    }

    #[test]
    fn test_sphincs192_keypair_generation() {
        let (_pk, _sk) = SphincsSHAKE192f::keypair();
        // Just verify it doesn't panic
    }

    #[test]
    fn test_sphincs192_sign_verify() {
        let (pk, sk) = SphincsSHAKE192f::keypair();
        let message = b"Test message";

        let signature = SphincsSHAKE192f::sign(message, &sk);
        assert!(SphincsSHAKE192f::verify(message, &signature, &pk).is_ok());
    }

    #[test]
    fn test_sphincs256_keypair_generation() {
        let (_pk, _sk) = SphincsSHAKE256f::keypair();
        // Just verify it doesn't panic
    }

    #[test]
    fn test_sphincs256_sign_verify() {
        let (pk, sk) = SphincsSHAKE256f::keypair();
        let message = b"Test message";

        let signature = SphincsSHAKE256f::sign(message, &sk);
        assert!(SphincsSHAKE256f::verify(message, &signature, &pk).is_ok());
    }

    #[test]
    fn test_sphincs256_wrong_message_fails() {
        let (pk, sk) = SphincsSHAKE256f::keypair();
        let message = b"Original message";
        let wrong_message = b"Wrong message";

        let signature = SphincsSHAKE256f::sign(message, &sk);
        assert!(SphincsSHAKE256f::verify(wrong_message, &signature, &pk).is_err());
    }

    #[test]
    fn test_sphincs256_wrong_public_key_fails() {
        let (_pk1, sk1) = SphincsSHAKE256f::keypair();
        let (pk2, _sk2) = SphincsSHAKE256f::keypair();
        let message = b"Test message";

        let signature = SphincsSHAKE256f::sign(message, &sk1);
        assert!(SphincsSHAKE256f::verify(message, &signature, &pk2).is_err());
    }

    #[test]
    fn test_sphincs256_serialization() {
        let (pk, sk) = SphincsSHAKE256f::keypair();

        let pk_serialized = crate::codec::encode(&pk).unwrap();
        let sk_serialized = crate::codec::encode(&sk).unwrap();

        let pk_deserialized: SphincsSHAKE256fPublicKey =
            crate::codec::decode(&pk_serialized).unwrap();
        let sk_deserialized: SphincsSHAKE256fSecretKey =
            crate::codec::decode(&sk_serialized).unwrap();

        let message = b"Test message";
        let signature = SphincsSHAKE256f::sign(message, &sk_deserialized);
        assert!(SphincsSHAKE256f::verify(message, &signature, &pk_deserialized).is_ok());
    }

    #[test]
    fn test_sphincs256_signature_serialization() {
        let (pk, sk) = SphincsSHAKE256f::keypair();
        let message = b"Test message";
        let signature = SphincsSHAKE256f::sign(message, &sk);

        let sig_serialized = crate::codec::encode(&signature).unwrap();
        let sig_deserialized: SphincsSHAKE256fSignature =
            crate::codec::decode(&sig_serialized).unwrap();

        assert!(SphincsSHAKE256f::verify(message, &sig_deserialized, &pk).is_ok());
    }

    #[test]
    fn test_sphincs_all_levels_independent() {
        let (pk128, sk128) = SphincsSHAKE128f::keypair();
        let (pk192, sk192) = SphincsSHAKE192f::keypair();
        let (pk256, sk256) = SphincsSHAKE256f::keypair();

        let message = b"Test message";

        let sig128 = SphincsSHAKE128f::sign(message, &sk128);
        let sig192 = SphincsSHAKE192f::sign(message, &sk192);
        let sig256 = SphincsSHAKE256f::sign(message, &sk256);

        assert!(SphincsSHAKE128f::verify(message, &sig128, &pk128).is_ok());
        assert!(SphincsSHAKE192f::verify(message, &sig192, &pk192).is_ok());
        assert!(SphincsSHAKE256f::verify(message, &sig256, &pk256).is_ok());
    }

    #[test]
    fn test_sphincs256_empty_message() {
        let (pk, sk) = SphincsSHAKE256f::keypair();
        let message = b"";

        let signature = SphincsSHAKE256f::sign(message, &sk);
        assert!(SphincsSHAKE256f::verify(message, &signature, &pk).is_ok());
    }

    #[test]
    fn test_sphincs256_large_message() {
        let (pk, sk) = SphincsSHAKE256f::keypair();
        let message = vec![42u8; 10_000];

        let signature = SphincsSHAKE256f::sign(&message, &sk);
        assert!(SphincsSHAKE256f::verify(&message, &signature, &pk).is_ok());
    }

    #[test]
    fn test_sphincs256_multiple_signatures() {
        let (pk, sk) = SphincsSHAKE256f::keypair();
        let message = b"Test message";

        let sig1 = SphincsSHAKE256f::sign(message, &sk);
        let sig2 = SphincsSHAKE256f::sign(message, &sk);

        // SPHINCS+ may use randomization, so signatures might differ
        // But both should be valid
        assert!(SphincsSHAKE256f::verify(message, &sig1, &pk).is_ok());
        assert!(SphincsSHAKE256f::verify(message, &sig2, &pk).is_ok());
    }
}