crabgraph 0.3.3

A safe, ergonomic, high-performance cryptographic library for Rust built on audited primitives
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
//! Ed25519 digital signatures.
//!
//! Ed25519 is a fast, secure elliptic curve signature scheme.
//! It provides 128-bit security and is widely supported.

use crate::errors::{CrabError, CrabResult};
use ed25519_dalek::{
    Signature, Signer, SigningKey, Verifier, VerifyingKey, PUBLIC_KEY_LENGTH, SECRET_KEY_LENGTH,
    SIGNATURE_LENGTH,
};
use rand_core::OsRng;

/// Ed25519 signature (64 bytes).
///
/// With the `serde-support` feature, signatures can be serialized to/from JSON/TOML as base64 strings.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(
    feature = "serde-support",
    derive(serde::Serialize, serde::Deserialize)
)]
#[cfg_attr(feature = "serde-support", serde(transparent))]
pub struct Ed25519Signature(
    #[cfg_attr(feature = "serde-support", serde(with = "serde_sig_bytes"))]
    pub  [u8; SIGNATURE_LENGTH],
);

#[cfg(feature = "serde-support")]
mod serde_sig_bytes {
    use super::SIGNATURE_LENGTH;
    use serde::{Deserialize, Deserializer, Serializer};

    pub fn serialize<S>(bytes: &[u8; SIGNATURE_LENGTH], serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&crate::encoding::base64_encode(bytes))
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<[u8; SIGNATURE_LENGTH], D::Error>
    where
        D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        let bytes = crate::encoding::base64_decode(&s).map_err(serde::de::Error::custom)?;
        if bytes.len() != SIGNATURE_LENGTH {
            return Err(serde::de::Error::custom(format!(
                "Expected {} bytes, got {}",
                SIGNATURE_LENGTH,
                bytes.len()
            )));
        }
        let mut arr = [0u8; SIGNATURE_LENGTH];
        arr.copy_from_slice(&bytes);
        Ok(arr)
    }
}

impl Ed25519Signature {
    /// Creates a signature from bytes.
    pub fn from_bytes(bytes: &[u8]) -> CrabResult<Self> {
        if bytes.len() != SIGNATURE_LENGTH {
            return Err(CrabError::invalid_input(format!(
                "Ed25519 signature must be {} bytes, got {}",
                SIGNATURE_LENGTH,
                bytes.len()
            )));
        }

        let mut sig = [0u8; SIGNATURE_LENGTH];
        sig.copy_from_slice(bytes);
        Ok(Self(sig))
    }

    /// Returns signature as bytes.
    pub fn as_bytes(&self) -> &[u8; SIGNATURE_LENGTH] {
        &self.0
    }

    /// Encodes signature to base64.
    pub fn to_base64(&self) -> String {
        crate::encoding::base64_encode(&self.0)
    }

    /// Decodes signature from base64.
    pub fn from_base64(data: &str) -> CrabResult<Self> {
        let bytes = crate::encoding::base64_decode(data)?;
        Self::from_bytes(&bytes)
    }

    /// Encodes signature to hex.
    pub fn to_hex(&self) -> String {
        hex::encode(self.0)
    }

    /// Decodes signature from hex.
    pub fn from_hex(data: &str) -> CrabResult<Self> {
        let bytes = hex::decode(data)?;
        Self::from_bytes(&bytes)
    }
}

/// Ed25519 public key (32 bytes).
///
/// With the `serde-support` feature, public keys can be serialized to/from JSON/TOML as base64 strings.
#[derive(Clone, Debug, PartialEq)]
#[cfg_attr(
    feature = "serde-support",
    derive(serde::Serialize, serde::Deserialize)
)]
pub struct Ed25519PublicKey(
    #[cfg_attr(feature = "serde-support", serde(with = "serde_pub_key"))] VerifyingKey,
);

#[cfg(feature = "serde-support")]
mod serde_pub_key {
    use super::{VerifyingKey, PUBLIC_KEY_LENGTH};
    use serde::{Deserialize, Deserializer, Serializer};

    pub fn serialize<S>(key: &VerifyingKey, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        serializer.serialize_str(&crate::encoding::base64_encode(key.as_bytes()))
    }

    pub fn deserialize<'de, D>(deserializer: D) -> Result<VerifyingKey, D::Error>
    where
        D: Deserializer<'de>,
    {
        let s = String::deserialize(deserializer)?;
        let bytes = crate::encoding::base64_decode(&s).map_err(serde::de::Error::custom)?;
        if bytes.len() != PUBLIC_KEY_LENGTH {
            return Err(serde::de::Error::custom(format!(
                "Expected {} bytes, got {}",
                PUBLIC_KEY_LENGTH,
                bytes.len()
            )));
        }
        VerifyingKey::from_bytes(bytes[..PUBLIC_KEY_LENGTH].try_into().unwrap())
            .map_err(serde::de::Error::custom)
    }
}

impl Ed25519PublicKey {
    /// Creates a public key from bytes.
    pub fn from_bytes(bytes: &[u8]) -> CrabResult<Self> {
        if bytes.len() != PUBLIC_KEY_LENGTH {
            return Err(CrabError::invalid_input(format!(
                "Ed25519 public key must be {} bytes, got {}",
                PUBLIC_KEY_LENGTH,
                bytes.len()
            )));
        }

        let key = VerifyingKey::from_bytes(bytes.try_into().expect("length already checked"))
            .map_err(|e| CrabError::key_error(format!("Invalid Ed25519 public key: {}", e)))?;

        Ok(Self(key))
    }

    /// Returns public key as bytes.
    pub fn as_bytes(&self) -> &[u8; PUBLIC_KEY_LENGTH] {
        self.0.as_bytes()
    }

    /// Verifies a signature on a message.
    ///
    /// # Returns
    /// `Ok(true)` if signature is valid, `Ok(false)` if invalid
    pub fn verify(&self, message: &[u8], signature: &Ed25519Signature) -> CrabResult<bool> {
        let sig = Signature::from_bytes(&signature.0);
        Ok(self.0.verify(message, &sig).is_ok())
    }

    /// Encodes public key to base64.
    pub fn to_base64(&self) -> String {
        crate::encoding::base64_encode(self.0.as_bytes())
    }

    /// Decodes public key from base64.
    pub fn from_base64(data: &str) -> CrabResult<Self> {
        let bytes = crate::encoding::base64_decode(data)?;
        Self::from_bytes(&bytes)
    }

    /// Encodes public key to hex.
    pub fn to_hex(&self) -> String {
        hex::encode(self.0.as_bytes())
    }

    /// Decodes public key from hex.
    pub fn from_hex(data: &str) -> CrabResult<Self> {
        let bytes = hex::decode(data)?;
        Self::from_bytes(&bytes)
    }
}

/// Ed25519 keypair for signing and verification.
pub struct Ed25519KeyPair {
    signing_key: SigningKey,
}

impl Ed25519KeyPair {
    /// Generates a new random Ed25519 keypair.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// ```
    pub fn generate() -> CrabResult<Self> {
        let signing_key = SigningKey::generate(&mut OsRng);
        Ok(Self { signing_key })
    }

    /// Creates a keypair from a 32-byte secret key.
    ///
    /// # Security Warning
    /// The secret key must be kept confidential and zeroized after use.
    pub fn from_secret_bytes(secret: &[u8]) -> CrabResult<Self> {
        if secret.len() != SECRET_KEY_LENGTH {
            return Err(CrabError::invalid_input(format!(
                "Ed25519 secret key must be {} bytes, got {}",
                SECRET_KEY_LENGTH,
                secret.len()
            )));
        }

        let signing_key =
            SigningKey::from_bytes(secret.try_into().expect("length already checked"));

        Ok(Self { signing_key })
    }

    /// Returns the secret key bytes.
    ///
    /// # Security Warning
    /// Handle with care! Zeroize after use.
    pub fn secret_bytes(&self) -> &[u8; SECRET_KEY_LENGTH] {
        self.signing_key.as_bytes()
    }

    /// Returns the public key.
    pub fn public_key(&self) -> Ed25519PublicKey {
        Ed25519PublicKey(self.signing_key.verifying_key())
    }

    /// Signs a message and returns the signature.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let message = b"Important message";
    /// let signature = keypair.sign(message);
    /// ```
    pub fn sign(&self, message: &[u8]) -> Ed25519Signature {
        let sig = self.signing_key.sign(message);
        Ed25519Signature(sig.to_bytes())
    }

    /// Signs a message and verifies it's correct (paranoid mode).
    ///
    /// This performs an extra verification step to ensure the signature is valid.
    pub fn sign_with_verification(&self, message: &[u8]) -> CrabResult<Ed25519Signature> {
        let signature = self.sign(message);

        // Verify immediately
        if !self.verify(message, &signature)? {
            return Err(CrabError::Internal("Signature verification failed after signing".into()));
        }

        Ok(signature)
    }

    /// Verifies a signature on a message using this keypair's public key.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let message = b"Important message";
    /// let signature = keypair.sign(message);
    ///
    /// assert!(keypair.verify(message, &signature).unwrap());
    /// assert!(!keypair.verify(b"Wrong message", &signature).unwrap());
    /// ```
    pub fn verify(&self, message: &[u8], signature: &Ed25519Signature) -> CrabResult<bool> {
        self.public_key().verify(message, signature)
    }

    /// Exports the keypair to PKCS#8 DER format.
    ///
    /// This is the binary encoding format for private keys.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let der = keypair.to_pkcs8_der().unwrap();
    /// let restored = Ed25519KeyPair::from_pkcs8_der(&der).unwrap();
    /// ```
    pub fn to_pkcs8_der(&self) -> CrabResult<Vec<u8>> {
        use ed25519_dalek::pkcs8::EncodePrivateKey;

        self.signing_key
            .to_pkcs8_der()
            .map(|doc| doc.as_bytes().to_vec())
            .map_err(|e| CrabError::key_error(format!("Failed to encode PKCS#8 DER: {}", e)))
    }

    /// Imports a keypair from PKCS#8 DER format.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let der = keypair.to_pkcs8_der().unwrap();
    /// let restored = Ed25519KeyPair::from_pkcs8_der(&der).unwrap();
    ///
    /// let message = b"Test";
    /// let sig = keypair.sign(message);
    /// assert!(restored.verify(message, &sig).unwrap());
    /// ```
    pub fn from_pkcs8_der(der: &[u8]) -> CrabResult<Self> {
        use ed25519_dalek::pkcs8::DecodePrivateKey;

        let signing_key = SigningKey::from_pkcs8_der(der)
            .map_err(|e| CrabError::key_error(format!("Failed to decode PKCS#8 DER: {}", e)))?;

        Ok(Self { signing_key })
    }

    /// Exports the keypair to PKCS#8 PEM format.
    ///
    /// This is the text-based encoding format commonly used in configuration files.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let pem = keypair.to_pkcs8_pem().unwrap();
    /// assert!(pem.starts_with("-----BEGIN PRIVATE KEY-----"));
    /// ```
    pub fn to_pkcs8_pem(&self) -> CrabResult<String> {
        use ed25519_dalek::pkcs8::EncodePrivateKey;

        self.signing_key
            .to_pkcs8_pem(Default::default())
            .map(|s| s.to_string())
            .map_err(|e| CrabError::key_error(format!("Failed to encode PKCS#8 PEM: {}", e)))
    }

    /// Imports a keypair from PKCS#8 PEM format.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let pem = keypair.to_pkcs8_pem().unwrap();
    /// let restored = Ed25519KeyPair::from_pkcs8_pem(&pem).unwrap();
    ///
    /// let message = b"Test";
    /// let sig = keypair.sign(message);
    /// assert!(restored.verify(message, &sig).unwrap());
    /// ```
    pub fn from_pkcs8_pem(pem: &str) -> CrabResult<Self> {
        use ed25519_dalek::pkcs8::DecodePrivateKey;

        let signing_key = SigningKey::from_pkcs8_pem(pem)
            .map_err(|e| CrabError::key_error(format!("Failed to decode PKCS#8 PEM: {}", e)))?;

        Ok(Self { signing_key })
    }
}

impl Ed25519PublicKey {
    /// Exports the public key to SPKI DER format (SubjectPublicKeyInfo).
    ///
    /// This is the standard binary encoding for public keys.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let pubkey = keypair.public_key();
    /// let der = pubkey.to_public_key_der().unwrap();
    /// ```
    pub fn to_public_key_der(&self) -> CrabResult<Vec<u8>> {
        use ed25519_dalek::pkcs8::EncodePublicKey;

        self.0
            .to_public_key_der()
            .map(|doc| doc.as_bytes().to_vec())
            .map_err(|e| CrabError::key_error(format!("Failed to encode public key DER: {}", e)))
    }

    /// Imports a public key from SPKI DER format.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let pubkey = keypair.public_key();
    /// let der = pubkey.to_public_key_der().unwrap();
    /// let restored = crabgraph::asym::Ed25519PublicKey::from_public_key_der(&der).unwrap();
    /// ```
    pub fn from_public_key_der(der: &[u8]) -> CrabResult<Self> {
        use ed25519_dalek::pkcs8::DecodePublicKey;

        let key = VerifyingKey::from_public_key_der(der)
            .map_err(|e| CrabError::key_error(format!("Failed to decode public key DER: {}", e)))?;

        Ok(Self(key))
    }

    /// Exports the public key to PEM format.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let pubkey = keypair.public_key();
    /// let pem = pubkey.to_public_key_pem().unwrap();
    /// assert!(pem.starts_with("-----BEGIN PUBLIC KEY-----"));
    /// ```
    pub fn to_public_key_pem(&self) -> CrabResult<String> {
        use ed25519_dalek::pkcs8::EncodePublicKey;

        self.0
            .to_public_key_pem(Default::default())
            .map_err(|e| CrabError::key_error(format!("Failed to encode public key PEM: {}", e)))
    }

    /// Imports a public key from PEM format.
    ///
    /// # Example
    /// ```
    /// use crabgraph::asym::Ed25519KeyPair;
    ///
    /// let keypair = Ed25519KeyPair::generate().unwrap();
    /// let pubkey = keypair.public_key();
    /// let pem = pubkey.to_public_key_pem().unwrap();
    /// let restored = crabgraph::asym::Ed25519PublicKey::from_public_key_pem(&pem).unwrap();
    /// ```
    pub fn from_public_key_pem(pem: &str) -> CrabResult<Self> {
        use ed25519_dalek::pkcs8::DecodePublicKey;

        let key = VerifyingKey::from_public_key_pem(pem)
            .map_err(|e| CrabError::key_error(format!("Failed to decode public key PEM: {}", e)))?;

        Ok(Self(key))
    }
}

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

    #[test]
    fn test_ed25519_generate_and_sign() {
        let keypair = Ed25519KeyPair::generate().unwrap();
        let message = b"Test message";
        let signature = keypair.sign(message);

        assert!(keypair.verify(message, &signature).unwrap());
    }

    #[test]
    fn test_ed25519_verify_wrong_message() {
        let keypair = Ed25519KeyPair::generate().unwrap();
        let message = b"Test message";
        let signature = keypair.sign(message);

        assert!(!keypair.verify(b"Wrong message", &signature).unwrap());
    }

    #[test]
    fn test_ed25519_public_key_verify() {
        let keypair = Ed25519KeyPair::generate().unwrap();
        let public_key = keypair.public_key();
        let message = b"Test message";
        let signature = keypair.sign(message);

        assert!(public_key.verify(message, &signature).unwrap());
        assert!(!public_key.verify(b"Wrong", &signature).unwrap());
    }

    #[test]
    fn test_ed25519_from_secret_bytes() {
        let keypair1 = Ed25519KeyPair::generate().unwrap();
        let secret = keypair1.secret_bytes();

        let keypair2 = Ed25519KeyPair::from_secret_bytes(secret).unwrap();

        // Same secret should produce same public key
        assert_eq!(keypair1.public_key().as_bytes(), keypair2.public_key().as_bytes());
    }

    #[test]
    fn test_ed25519_signature_serialization() {
        let keypair = Ed25519KeyPair::generate().unwrap();
        let message = b"Test";
        let signature = keypair.sign(message);

        // Base64
        let b64 = signature.to_base64();
        let recovered = Ed25519Signature::from_base64(&b64).unwrap();
        assert_eq!(signature, recovered);

        // Hex
        let hex = signature.to_hex();
        let recovered = Ed25519Signature::from_hex(&hex).unwrap();
        assert_eq!(signature, recovered);
    }

    #[test]
    fn test_ed25519_public_key_serialization() {
        let keypair = Ed25519KeyPair::generate().unwrap();
        let public_key = keypair.public_key();

        // Base64
        let b64 = public_key.to_base64();
        let recovered = Ed25519PublicKey::from_base64(&b64).unwrap();
        assert_eq!(public_key.as_bytes(), recovered.as_bytes());

        // Hex
        let hex = public_key.to_hex();
        let recovered = Ed25519PublicKey::from_hex(&hex).unwrap();
        assert_eq!(public_key.as_bytes(), recovered.as_bytes());
    }

    #[test]
    fn test_ed25519_sign_with_verification() {
        let keypair = Ed25519KeyPair::generate().unwrap();
        let message = b"Test message";
        let signature = keypair.sign_with_verification(message).unwrap();

        assert!(keypair.verify(message, &signature).unwrap());
    }
}