wsc 0.8.0

WebAssembly Signature Component - WASM signing and verification toolkit
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
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
//! DSSE (Dead Simple Signing Envelope) implementation
//!
//! Implements the DSSE protocol for signing arbitrary payloads.
//! See: https://github.com/secure-systems-lab/dsse
//!
//! DSSE provides:
//! - Payload type authentication (prevents type confusion attacks)
//! - Multi-signature support
//! - Format-agnostic payload handling
//!
//! # Example
//!
//! ```ignore
//! use wsc::dsse::{DsseEnvelope, DsseSigner};
//!
//! let payload = b"my attestation data";
//! let envelope = DsseEnvelope::sign(
//!     payload,
//!     "application/vnd.in-toto+json",
//!     &signer,
//! )?;
//!
//! // Verify
//! let verified_payload = envelope.verify(&verifier)?;
//! ```

use base64::{engine::general_purpose::STANDARD as BASE64, Engine};
use serde::{Deserialize, Serialize};

use crate::error::WSError;

/// DSSE envelope containing a signed payload
///
/// The envelope wraps arbitrary data with cryptographic signatures,
/// ensuring both the payload and its type are authenticated.
#[derive(Debug, Clone, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DsseEnvelope {
    /// Base64-encoded payload
    pub payload: String,

    /// Media type of the payload (e.g., "application/vnd.in-toto+json")
    pub payload_type: String,

    /// One or more signatures over PAE(payloadType, payload)
    pub signatures: Vec<DsseSignature>,
}

/// A single signature within a DSSE envelope
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct DsseSignature {
    /// Key identifier (optional, unauthenticated hint)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub keyid: Option<String>,

    /// Base64-encoded signature over PAE(payloadType, payload)
    pub sig: String,
}

/// Trait for signing DSSE payloads
pub trait DsseSigner {
    /// Sign the PAE-encoded data and return the signature bytes
    fn sign(&self, pae: &[u8]) -> Result<Vec<u8>, WSError>;

    /// Return the key ID (optional)
    fn key_id(&self) -> Option<String> {
        None
    }
}

/// Trait for verifying DSSE signatures
pub trait DsseVerifier {
    /// Verify the signature over PAE-encoded data
    fn verify(&self, pae: &[u8], signature: &[u8]) -> Result<(), WSError>;
}

impl DsseEnvelope {
    /// Create a new DSSE envelope by signing a payload
    ///
    /// # Arguments
    ///
    /// * `payload` - Raw bytes to sign
    /// * `payload_type` - Media type (e.g., "application/vnd.in-toto+json")
    /// * `signer` - Implementation of DsseSigner
    pub fn sign(
        payload: &[u8],
        payload_type: &str,
        signer: &dyn DsseSigner,
    ) -> Result<Self, WSError> {
        // Compute PAE (Pre-Authentication Encoding)
        let pae = compute_pae(payload_type, payload);

        // Sign the PAE
        let sig_bytes = signer.sign(&pae)?;

        Ok(Self {
            payload: BASE64.encode(payload),
            payload_type: payload_type.to_string(),
            signatures: vec![DsseSignature {
                keyid: signer.key_id(),
                sig: BASE64.encode(sig_bytes),
            }],
        })
    }

    /// Create a DSSE envelope with multiple signatures
    pub fn sign_multi(
        payload: &[u8],
        payload_type: &str,
        signers: &[&dyn DsseSigner],
    ) -> Result<Self, WSError> {
        if signers.is_empty() {
            return Err(WSError::InvalidArgument);
        }

        let pae = compute_pae(payload_type, payload);
        let mut signatures = Vec::with_capacity(signers.len());

        for signer in signers {
            let sig_bytes = signer.sign(&pae)?;
            signatures.push(DsseSignature {
                keyid: signer.key_id(),
                sig: BASE64.encode(sig_bytes),
            });
        }

        Ok(Self {
            payload: BASE64.encode(payload),
            payload_type: payload_type.to_string(),
            signatures,
        })
    }

    /// Verify the envelope and return the decoded payload
    ///
    /// Verifies at least one signature is valid (1-of-N).
    ///
    /// # Security Warning
    ///
    /// This method returns `Ok` if **any single** signature is valid. An attacker
    /// who can append signatures to an envelope could add a valid signature alongside
    /// forged ones. If you need to verify that ALL signatures are valid (e.g., for
    /// multi-party signing where every signer must be trusted), use [`verify_all()`]
    /// instead.
    pub fn verify(&self, verifier: &dyn DsseVerifier) -> Result<Vec<u8>, WSError> {
        if self.signatures.is_empty() {
            return Err(WSError::VerificationFailed);
        }

        // Decode payload
        let payload = BASE64.decode(&self.payload).map_err(|e| {
            WSError::InternalError(format!("Invalid base64 payload: {}", e))
        })?;

        // Compute PAE
        let pae = compute_pae(&self.payload_type, &payload);

        // Verify at least one signature
        let mut verified = false;
        for sig in &self.signatures {
            let sig_bytes = BASE64.decode(&sig.sig).map_err(|e| {
                WSError::InternalError(format!("Invalid base64 signature: {}", e))
            })?;

            if verifier.verify(&pae, &sig_bytes).is_ok() {
                verified = true;
                break;
            }
        }

        if !verified {
            return Err(WSError::VerificationFailed);
        }

        Ok(payload)
    }

    /// Verify all signatures in the envelope
    ///
    /// Returns error if any signature fails verification.
    pub fn verify_all(&self, verifier: &dyn DsseVerifier) -> Result<Vec<u8>, WSError> {
        if self.signatures.is_empty() {
            return Err(WSError::VerificationFailed);
        }

        let payload = BASE64.decode(&self.payload).map_err(|e| {
            WSError::InternalError(format!("Invalid base64 payload: {}", e))
        })?;

        let pae = compute_pae(&self.payload_type, &payload);

        for sig in &self.signatures {
            let sig_bytes = BASE64.decode(&sig.sig).map_err(|e| {
                WSError::InternalError(format!("Invalid base64 signature: {}", e))
            })?;

            verifier.verify(&pae, &sig_bytes)?;
        }

        Ok(payload)
    }

    /// Get the decoded payload without verification
    ///
    /// # Warning
    ///
    /// This does not verify signatures. Use only when verification
    /// is done separately or not required.
    pub fn payload_bytes(&self) -> Result<Vec<u8>, WSError> {
        BASE64.decode(&self.payload).map_err(|e| {
            WSError::InternalError(format!("Invalid base64 payload: {}", e))
        })
    }

    /// Serialize to JSON
    pub fn to_json(&self) -> Result<String, WSError> {
        serde_json::to_string(self).map_err(|e| {
            WSError::InternalError(format!("Failed to serialize DSSE envelope: {}", e))
        })
    }

    /// Serialize to pretty JSON
    pub fn to_json_pretty(&self) -> Result<String, WSError> {
        serde_json::to_string_pretty(self).map_err(|e| {
            WSError::InternalError(format!("Failed to serialize DSSE envelope: {}", e))
        })
    }

    /// Deserialize from JSON
    pub fn from_json(json: &str) -> Result<Self, WSError> {
        serde_json::from_str(json).map_err(|e| {
            WSError::InternalError(format!("Failed to parse DSSE envelope: {}", e))
        })
    }

    /// Create an unsigned envelope (for testing or deferred signing)
    pub fn unsigned(payload: &[u8], payload_type: &str) -> Self {
        Self {
            payload: BASE64.encode(payload),
            payload_type: payload_type.to_string(),
            signatures: vec![],
        }
    }

    /// Add a signature to an existing envelope
    pub fn add_signature(&mut self, signer: &dyn DsseSigner) -> Result<(), WSError> {
        let payload = self.payload_bytes()?;
        let pae = compute_pae(&self.payload_type, &payload);
        let sig_bytes = signer.sign(&pae)?;

        self.signatures.push(DsseSignature {
            keyid: signer.key_id(),
            sig: BASE64.encode(sig_bytes),
        });

        Ok(())
    }
}

/// Compute PAE (Pre-Authentication Encoding)
///
/// PAE(type, payload) = "DSSEv1" SP LEN(type) SP type SP LEN(payload) SP payload
///
/// Where:
/// - SP is a space character (0x20)
/// - LEN is the length as a decimal ASCII string
fn compute_pae(payload_type: &str, payload: &[u8]) -> Vec<u8> {
    let mut pae = Vec::new();

    // "DSSEv1 "
    pae.extend_from_slice(b"DSSEv1 ");

    // LEN(type) SP type SP
    pae.extend_from_slice(payload_type.len().to_string().as_bytes());
    pae.push(b' ');
    pae.extend_from_slice(payload_type.as_bytes());
    pae.push(b' ');

    // LEN(payload) SP payload
    pae.extend_from_slice(payload.len().to_string().as_bytes());
    pae.push(b' ');
    pae.extend_from_slice(payload);

    pae
}

/// Ed25519 signer implementation for DSSE
pub struct Ed25519DsseSigner {
    secret_key: ed25519_compact::SecretKey,
    key_id: Option<String>,
}

impl Ed25519DsseSigner {
    /// Create a new Ed25519 signer
    pub fn new(secret_key: ed25519_compact::SecretKey, key_id: Option<String>) -> Self {
        Self { secret_key, key_id }
    }

    /// Create from raw secret key bytes
    pub fn from_bytes(bytes: &[u8], key_id: Option<String>) -> Result<Self, WSError> {
        let secret_key = ed25519_compact::SecretKey::from_slice(bytes)
            .map_err(|e| WSError::CryptoError(e))?;
        Ok(Self { secret_key, key_id })
    }
}

impl DsseSigner for Ed25519DsseSigner {
    fn sign(&self, pae: &[u8]) -> Result<Vec<u8>, WSError> {
        let signature = self.secret_key.sign(pae, None);
        Ok(signature.to_vec())
    }

    fn key_id(&self) -> Option<String> {
        self.key_id.clone()
    }
}

/// Ed25519 verifier implementation for DSSE
pub struct Ed25519DsseVerifier {
    public_key: ed25519_compact::PublicKey,
}

impl Ed25519DsseVerifier {
    /// Create a new Ed25519 verifier
    pub fn new(public_key: ed25519_compact::PublicKey) -> Self {
        Self { public_key }
    }

    /// Create from raw public key bytes
    pub fn from_bytes(bytes: &[u8]) -> Result<Self, WSError> {
        let public_key = ed25519_compact::PublicKey::from_slice(bytes)
            .map_err(|e| WSError::CryptoError(e))?;
        Ok(Self { public_key })
    }
}

impl DsseVerifier for Ed25519DsseVerifier {
    fn verify(&self, pae: &[u8], signature: &[u8]) -> Result<(), WSError> {
        let sig = ed25519_compact::Signature::from_slice(signature)
            .map_err(|e| WSError::CryptoError(e))?;

        self.public_key
            .verify(pae, &sig)
            .map_err(|_| WSError::VerificationFailed)
    }
}

/// Standard payload types
pub mod payload_types {
    /// in-toto statement
    pub const IN_TOTO: &str = "application/vnd.in-toto+json";

    /// SLSA provenance
    pub const SLSA_PROVENANCE: &str = "application/vnd.slsa.provenance+json";

    /// CycloneDX SBOM
    pub const CYCLONEDX: &str = "application/vnd.cyclonedx+json";

    /// WSC transformation attestation
    pub const WSC_TRANSFORMATION: &str = "application/vnd.wsc.transformation+json";
}

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

    fn generate_test_keypair() -> (ed25519_compact::SecretKey, ed25519_compact::PublicKey) {
        let kp = ed25519_compact::KeyPair::generate();
        (kp.sk, kp.pk)
    }

    #[test]
    fn test_pae_computation() {
        let pae = compute_pae("application/example", b"hello");
        let expected = b"DSSEv1 19 application/example 5 hello";
        assert_eq!(pae, expected);
    }

    #[test]
    fn test_pae_empty_payload() {
        let pae = compute_pae("text/plain", b"");
        let expected = b"DSSEv1 10 text/plain 0 ";
        assert_eq!(pae, expected);
    }

    #[test]
    fn test_sign_and_verify() {
        let (sk, pk) = generate_test_keypair();
        let signer = Ed25519DsseSigner::new(sk, Some("test-key".to_string()));
        let verifier = Ed25519DsseVerifier::new(pk);

        let payload = b"test payload";
        let envelope = DsseEnvelope::sign(
            payload,
            payload_types::IN_TOTO,
            &signer,
        ).unwrap();

        assert_eq!(envelope.payload_type, payload_types::IN_TOTO);
        assert_eq!(envelope.signatures.len(), 1);
        assert_eq!(envelope.signatures[0].keyid, Some("test-key".to_string()));

        let verified = envelope.verify(&verifier).unwrap();
        assert_eq!(verified, payload);
    }

    #[test]
    fn test_json_roundtrip() {
        let (sk, _pk) = generate_test_keypair();
        let signer = Ed25519DsseSigner::new(sk, None);

        let envelope = DsseEnvelope::sign(
            b"test data",
            "application/json",
            &signer,
        ).unwrap();

        let json = envelope.to_json().unwrap();
        let parsed = DsseEnvelope::from_json(&json).unwrap();

        assert_eq!(parsed.payload, envelope.payload);
        assert_eq!(parsed.payload_type, envelope.payload_type);
        assert_eq!(parsed.signatures.len(), envelope.signatures.len());
    }

    #[test]
    fn test_multi_signature() {
        let (sk1, pk1) = generate_test_keypair();
        let (sk2, pk2) = generate_test_keypair();

        let signer1 = Ed25519DsseSigner::new(sk1, Some("key1".to_string()));
        let signer2 = Ed25519DsseSigner::new(sk2, Some("key2".to_string()));
        let verifier1 = Ed25519DsseVerifier::new(pk1);
        let verifier2 = Ed25519DsseVerifier::new(pk2);

        let envelope = DsseEnvelope::sign_multi(
            b"multi-signed payload",
            "application/json",
            &[&signer1, &signer2],
        ).unwrap();

        assert_eq!(envelope.signatures.len(), 2);

        // Either verifier should work with verify()
        assert!(envelope.verify(&verifier1).is_ok());
        assert!(envelope.verify(&verifier2).is_ok());
    }

    #[test]
    fn test_verify_fails_wrong_key() {
        let (sk, _pk) = generate_test_keypair();
        let (_, other_pk) = generate_test_keypair();

        let signer = Ed25519DsseSigner::new(sk, None);
        let wrong_verifier = Ed25519DsseVerifier::new(other_pk);

        let envelope = DsseEnvelope::sign(
            b"test",
            "application/json",
            &signer,
        ).unwrap();

        assert!(envelope.verify(&wrong_verifier).is_err());
    }

    #[test]
    fn test_unsigned_envelope() {
        let envelope = DsseEnvelope::unsigned(b"unsigned data", "text/plain");

        assert!(envelope.signatures.is_empty());
        assert_eq!(envelope.payload_bytes().unwrap(), b"unsigned data");
    }

    #[test]
    fn test_add_signature() {
        let (sk, pk) = generate_test_keypair();
        let signer = Ed25519DsseSigner::new(sk, Some("added".to_string()));
        let verifier = Ed25519DsseVerifier::new(pk);

        let mut envelope = DsseEnvelope::unsigned(b"deferred signing", "text/plain");
        assert!(envelope.signatures.is_empty());

        envelope.add_signature(&signer).unwrap();
        assert_eq!(envelope.signatures.len(), 1);

        let verified = envelope.verify(&verifier).unwrap();
        assert_eq!(verified, b"deferred signing");
    }

    #[test]
    fn test_payload_types() {
        assert!(payload_types::IN_TOTO.contains("in-toto"));
        assert!(payload_types::CYCLONEDX.contains("cyclonedx"));
        assert!(payload_types::SLSA_PROVENANCE.contains("slsa"));
    }

    #[test]
    fn test_key_id_propagation() {
        let (sk, _pk) = generate_test_keypair();
        let signer_with_id = Ed25519DsseSigner::new(sk.clone(), Some("my-key-id".to_string()));
        assert_eq!(signer_with_id.key_id(), Some("my-key-id".to_string()));

        let signer_no_id = Ed25519DsseSigner::new(sk, None);
        assert_eq!(signer_no_id.key_id(), None);
    }

    #[test]
    fn test_verify_all_returns_correct_payload() {
        let (sk, pk) = generate_test_keypair();
        let signer = Ed25519DsseSigner::new(sk, None);
        let verifier = Ed25519DsseVerifier::new(pk);

        let payload = b"verify_all test payload";
        let envelope = DsseEnvelope::sign(payload, "text/plain", &signer).unwrap();

        let result = envelope.verify_all(&verifier).unwrap();
        assert_eq!(result, payload);
        assert!(!result.is_empty());
    }

    #[test]
    fn test_verify_all_rejects_empty_signatures() {
        let (_sk, pk) = generate_test_keypair();
        let verifier = Ed25519DsseVerifier::new(pk);

        let envelope = DsseEnvelope::unsigned(b"no sigs", "text/plain");
        assert!(envelope.verify_all(&verifier).is_err());
    }

    #[test]
    fn test_to_json_pretty_valid_output() {
        let (sk, _pk) = generate_test_keypair();
        let signer = Ed25519DsseSigner::new(sk, Some("pretty-key".to_string()));

        let envelope = DsseEnvelope::sign(b"pretty test", "text/plain", &signer).unwrap();
        let json = envelope.to_json_pretty().unwrap();

        assert!(json.contains("payload"));
        assert!(json.contains("payloadType"));
        assert!(json.contains("signatures"));
        assert!(json.contains('\n')); // Pretty-printed has newlines
        assert!(!json.is_empty());

        // Must roundtrip
        let parsed = DsseEnvelope::from_json(&json).unwrap();
        assert_eq!(parsed.payload, envelope.payload);
    }
}

// ============================================================================
// Kani proof harnesses for DSSE Pre-Authentication Encoding
// ============================================================================
#[cfg(kani)]
mod proofs {
    use super::compute_pae;

    /// Prove: PAE is injective — different (type, payload) pairs produce
    /// different encodings.
    ///
    /// This prevents type confusion attacks where a signed envelope
    /// could be reinterpreted with a different payload type.
    /// Prove: PAE is injective — different types produce different output.
    #[kani::proof]
    fn proof_pae_injective_different_types() {
        let pae_a = compute_pae("a", &[]);
        let pae_b = compute_pae("b", &[]);
        assert_ne!(pae_a, pae_b, "PAE collision for different types");
    }

    /// Prove: PAE is injective — different payloads produce different output.
    #[kani::proof]
    fn proof_pae_injective_different_payloads() {
        let pae_a = compute_pae("", &[0]);
        let pae_b = compute_pae("", &[1]);
        assert_ne!(pae_a, pae_b, "PAE collision for different payloads");
    }

    /// Prove: PAE is deterministic.
    #[kani::proof]
    fn proof_pae_deterministic() {
        let pae1 = compute_pae("", &[]);
        let pae2 = compute_pae("", &[]);
        assert_eq!(pae1, pae2);
    }

    /// Prove: PAE output always starts with "DSSEv1 " prefix.
    #[kani::proof]
    fn proof_pae_has_dsse_prefix() {
        let pae = compute_pae("", &[]);
        assert!(pae.starts_with(b"DSSEv1 "), "PAE missing DSSEv1 prefix");
    }

    /// Prove: PAE length encoding prevents ambiguity.
    #[kani::proof]
    fn proof_pae_length_prefix_prevents_ambiguity() {
        let pae_a = compute_pae("a", b"");
        let pae_b = compute_pae("", b"a");
        assert_ne!(pae_a, pae_b, "PAE ambiguity: different type/payload split produced same encoding");
    }
}