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
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
//! Key serialization and deserialization utilities.
//!
//! Provides import/export of keys in various formats:
//! - PEM format for Ed25519 keys
//! - Hex encoding
//! - Base64 encoding

use crate::signing::{KeyPair, PublicKey, SecretKey, SigningError};
use thiserror::Error;

/// Key serialization error.
#[derive(Debug, Error)]
pub enum KeySerdeError {
    #[error("Invalid PEM format")]
    InvalidPemFormat,

    #[error("Invalid base64 encoding: {0}")]
    InvalidBase64(String),

    #[error("Invalid hex encoding: {0}")]
    InvalidHex(String),

    #[error("Invalid key length: expected {expected}, got {actual}")]
    InvalidKeyLength { expected: usize, actual: usize },

    #[error("Signing error: {0}")]
    SigningError(#[from] SigningError),

    #[error("Unknown key type: {0}")]
    UnknownKeyType(String),
}

/// PEM header for Ed25519 private keys.
const ED25519_PRIVATE_KEY_HEADER: &str = "-----BEGIN ED25519 PRIVATE KEY-----";
const ED25519_PRIVATE_KEY_FOOTER: &str = "-----END ED25519 PRIVATE KEY-----";

/// PEM header for Ed25519 public keys.
const ED25519_PUBLIC_KEY_HEADER: &str = "-----BEGIN ED25519 PUBLIC KEY-----";
const ED25519_PUBLIC_KEY_FOOTER: &str = "-----END ED25519 PUBLIC KEY-----";

/// Key serializer for various formats.
pub struct KeySerializer;

impl KeySerializer {
    // ========================================================================
    // Hex encoding
    // ========================================================================

    /// Encode a secret key as hexadecimal string.
    pub fn secret_key_to_hex(key: &SecretKey) -> String {
        hex::encode(key)
    }

    /// Decode a secret key from hexadecimal string.
    pub fn secret_key_from_hex(hex_str: &str) -> Result<SecretKey, KeySerdeError> {
        let bytes = hex::decode(hex_str).map_err(|e| KeySerdeError::InvalidHex(e.to_string()))?;

        if bytes.len() != 32 {
            return Err(KeySerdeError::InvalidKeyLength {
                expected: 32,
                actual: bytes.len(),
            });
        }

        let mut key = [0u8; 32];
        key.copy_from_slice(&bytes);
        Ok(key)
    }

    /// Encode a public key as hexadecimal string.
    pub fn public_key_to_hex(key: &PublicKey) -> String {
        hex::encode(key)
    }

    /// Decode a public key from hexadecimal string.
    pub fn public_key_from_hex(hex_str: &str) -> Result<PublicKey, KeySerdeError> {
        let bytes = hex::decode(hex_str).map_err(|e| KeySerdeError::InvalidHex(e.to_string()))?;

        if bytes.len() != 32 {
            return Err(KeySerdeError::InvalidKeyLength {
                expected: 32,
                actual: bytes.len(),
            });
        }

        let mut key = [0u8; 32];
        key.copy_from_slice(&bytes);
        Ok(key)
    }

    // ========================================================================
    // Base64 encoding
    // ========================================================================

    /// Encode a secret key as base64 string.
    pub fn secret_key_to_base64(key: &SecretKey) -> String {
        base64_encode(key)
    }

    /// Decode a secret key from base64 string.
    pub fn secret_key_from_base64(b64_str: &str) -> Result<SecretKey, KeySerdeError> {
        let bytes = base64_decode(b64_str)?;

        if bytes.len() != 32 {
            return Err(KeySerdeError::InvalidKeyLength {
                expected: 32,
                actual: bytes.len(),
            });
        }

        let mut key = [0u8; 32];
        key.copy_from_slice(&bytes);
        Ok(key)
    }

    /// Encode a public key as base64 string.
    pub fn public_key_to_base64(key: &PublicKey) -> String {
        base64_encode(key)
    }

    /// Decode a public key from base64 string.
    pub fn public_key_from_base64(b64_str: &str) -> Result<PublicKey, KeySerdeError> {
        let bytes = base64_decode(b64_str)?;

        if bytes.len() != 32 {
            return Err(KeySerdeError::InvalidKeyLength {
                expected: 32,
                actual: bytes.len(),
            });
        }

        let mut key = [0u8; 32];
        key.copy_from_slice(&bytes);
        Ok(key)
    }

    // ========================================================================
    // PEM encoding
    // ========================================================================

    /// Export a key pair to PEM format (private key).
    pub fn keypair_to_pem(keypair: &KeyPair) -> String {
        let secret = keypair.secret_key();
        Self::secret_key_to_pem(&secret)
    }

    /// Export a secret key to PEM format.
    pub fn secret_key_to_pem(key: &SecretKey) -> String {
        let b64 = base64_encode(key);
        let wrapped = wrap_base64(&b64, 64);
        format!(
            "{}\n{}\n{}",
            ED25519_PRIVATE_KEY_HEADER, wrapped, ED25519_PRIVATE_KEY_FOOTER
        )
    }

    /// Import a key pair from PEM format.
    pub fn keypair_from_pem(pem: &str) -> Result<KeyPair, KeySerdeError> {
        let secret = Self::secret_key_from_pem(pem)?;
        KeyPair::from_secret_key(&secret).map_err(KeySerdeError::SigningError)
    }

    /// Import a secret key from PEM format.
    pub fn secret_key_from_pem(pem: &str) -> Result<SecretKey, KeySerdeError> {
        let pem = pem.trim();

        if !pem.starts_with(ED25519_PRIVATE_KEY_HEADER) {
            return Err(KeySerdeError::InvalidPemFormat);
        }
        if !pem.ends_with(ED25519_PRIVATE_KEY_FOOTER) {
            return Err(KeySerdeError::InvalidPemFormat);
        }

        // Extract base64 content
        let content = pem
            .strip_prefix(ED25519_PRIVATE_KEY_HEADER)
            .and_then(|s| s.strip_suffix(ED25519_PRIVATE_KEY_FOOTER))
            .ok_or(KeySerdeError::InvalidPemFormat)?;

        // Remove whitespace
        let b64: String = content.chars().filter(|c| !c.is_whitespace()).collect();

        Self::secret_key_from_base64(&b64)
    }

    /// Export a public key to PEM format.
    pub fn public_key_to_pem(key: &PublicKey) -> String {
        let b64 = base64_encode(key);
        let wrapped = wrap_base64(&b64, 64);
        format!(
            "{}\n{}\n{}",
            ED25519_PUBLIC_KEY_HEADER, wrapped, ED25519_PUBLIC_KEY_FOOTER
        )
    }

    /// Import a public key from PEM format.
    pub fn public_key_from_pem(pem: &str) -> Result<PublicKey, KeySerdeError> {
        let pem = pem.trim();

        if !pem.starts_with(ED25519_PUBLIC_KEY_HEADER) {
            return Err(KeySerdeError::InvalidPemFormat);
        }
        if !pem.ends_with(ED25519_PUBLIC_KEY_FOOTER) {
            return Err(KeySerdeError::InvalidPemFormat);
        }

        // Extract base64 content
        let content = pem
            .strip_prefix(ED25519_PUBLIC_KEY_HEADER)
            .and_then(|s| s.strip_suffix(ED25519_PUBLIC_KEY_FOOTER))
            .ok_or(KeySerdeError::InvalidPemFormat)?;

        // Remove whitespace
        let b64: String = content.chars().filter(|c| !c.is_whitespace()).collect();

        Self::public_key_from_base64(&b64)
    }
}

// ============================================================================
// Helper functions
// ============================================================================

/// Encode bytes to base64 (standard alphabet, no padding).
fn base64_encode(data: &[u8]) -> String {
    const ALPHABET: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";

    let mut result = String::new();
    let mut i = 0;

    while i < data.len() {
        let b0 = data[i];
        let b1 = if i + 1 < data.len() { data[i + 1] } else { 0 };
        let b2 = if i + 2 < data.len() { data[i + 2] } else { 0 };

        result.push(ALPHABET[(b0 >> 2) as usize] as char);
        result.push(ALPHABET[(((b0 & 0x03) << 4) | (b1 >> 4)) as usize] as char);

        if i + 1 < data.len() {
            result.push(ALPHABET[(((b1 & 0x0f) << 2) | (b2 >> 6)) as usize] as char);
        } else {
            result.push('=');
        }

        if i + 2 < data.len() {
            result.push(ALPHABET[(b2 & 0x3f) as usize] as char);
        } else {
            result.push('=');
        }

        i += 3;
    }

    result
}

/// Decode base64 to bytes.
fn base64_decode(data: &str) -> Result<Vec<u8>, KeySerdeError> {
    const DECODE_TABLE: [i8; 128] = [
        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1,
        -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 62, -1, -1,
        -1, 63, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, -1, -1, -1, -1, -1, -1, -1, 0, 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, -1, -1, -1,
        -1, -1, -1, 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, -1, -1, -1, -1, -1,
    ];

    let data = data.trim_end_matches('=');
    let len = data.len();

    if len == 0 {
        return Ok(Vec::new());
    }

    let output_len = (len * 3) / 4;
    let mut result = Vec::with_capacity(output_len);

    let bytes = data.as_bytes();
    let mut i = 0;

    while i + 3 < len {
        let b0 = decode_char(bytes[i], &DECODE_TABLE)?;
        let b1 = decode_char(bytes[i + 1], &DECODE_TABLE)?;
        let b2 = decode_char(bytes[i + 2], &DECODE_TABLE)?;
        let b3 = decode_char(bytes[i + 3], &DECODE_TABLE)?;

        result.push((b0 << 2) | (b1 >> 4));
        result.push((b1 << 4) | (b2 >> 2));
        result.push((b2 << 6) | b3);

        i += 4;
    }

    // Handle remaining bytes
    if i < len {
        let remaining = len - i;
        let b0 = decode_char(bytes[i], &DECODE_TABLE)?;
        let b1 = if i + 1 < len {
            decode_char(bytes[i + 1], &DECODE_TABLE)?
        } else {
            0
        };
        let b2 = if i + 2 < len {
            decode_char(bytes[i + 2], &DECODE_TABLE)?
        } else {
            0
        };

        result.push((b0 << 2) | (b1 >> 4));
        if remaining > 2 {
            result.push((b1 << 4) | (b2 >> 2));
        }
        if remaining > 3 {
            let b3 = decode_char(bytes[i + 3], &DECODE_TABLE)?;
            result.push((b2 << 6) | b3);
        }
    }

    Ok(result)
}

fn decode_char(c: u8, table: &[i8; 128]) -> Result<u8, KeySerdeError> {
    if c >= 128 {
        return Err(KeySerdeError::InvalidBase64(format!(
            "Invalid character: {}",
            c as char
        )));
    }
    let val = table[c as usize];
    if val < 0 {
        return Err(KeySerdeError::InvalidBase64(format!(
            "Invalid character: {}",
            c as char
        )));
    }
    Ok(val as u8)
}

/// Wrap base64 string at specified line length.
fn wrap_base64(b64: &str, line_len: usize) -> String {
    let mut result = String::new();
    let mut i = 0;

    while i < b64.len() {
        let end = (i + line_len).min(b64.len());
        result.push_str(&b64[i..end]);
        if end < b64.len() {
            result.push('\n');
        }
        i = end;
    }

    result
}

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

    #[test]
    fn test_hex_roundtrip() {
        let keypair = KeyPair::generate();
        let secret = keypair.secret_key();
        let public = keypair.public_key();

        let secret_hex = KeySerializer::secret_key_to_hex(&secret);
        let public_hex = KeySerializer::public_key_to_hex(&public);

        let secret2 = KeySerializer::secret_key_from_hex(&secret_hex).unwrap();
        let public2 = KeySerializer::public_key_from_hex(&public_hex).unwrap();

        assert_eq!(secret, secret2);
        assert_eq!(public, public2);
    }

    #[test]
    fn test_base64_roundtrip() {
        let keypair = KeyPair::generate();
        let secret = keypair.secret_key();
        let public = keypair.public_key();

        let secret_b64 = KeySerializer::secret_key_to_base64(&secret);
        let public_b64 = KeySerializer::public_key_to_base64(&public);

        let secret2 = KeySerializer::secret_key_from_base64(&secret_b64).unwrap();
        let public2 = KeySerializer::public_key_from_base64(&public_b64).unwrap();

        assert_eq!(secret, secret2);
        assert_eq!(public, public2);
    }

    #[test]
    fn test_pem_roundtrip() {
        let keypair = KeyPair::generate();
        let secret = keypair.secret_key();
        let public = keypair.public_key();

        let secret_pem = KeySerializer::secret_key_to_pem(&secret);
        let public_pem = KeySerializer::public_key_to_pem(&public);

        let secret2 = KeySerializer::secret_key_from_pem(&secret_pem).unwrap();
        let public2 = KeySerializer::public_key_from_pem(&public_pem).unwrap();

        assert_eq!(secret, secret2);
        assert_eq!(public, public2);
    }

    #[test]
    fn test_keypair_pem_roundtrip() {
        let keypair = KeyPair::generate();
        let pem = KeySerializer::keypair_to_pem(&keypair);
        let keypair2 = KeySerializer::keypair_from_pem(&pem).unwrap();

        assert_eq!(keypair.public_key(), keypair2.public_key());
    }

    #[test]
    fn test_invalid_hex_length() {
        // Too short
        let result = KeySerializer::secret_key_from_hex("0123456789abcdef");
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidKeyLength { .. }
        ));

        // Too long
        let long_hex = "0".repeat(80);
        let result = KeySerializer::secret_key_from_hex(&long_hex);
        assert!(result.is_err());
    }

    #[test]
    fn test_invalid_hex_characters() {
        let invalid_hex = "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz";
        let result = KeySerializer::secret_key_from_hex(invalid_hex);
        assert!(result.is_err());
        assert!(matches!(result.unwrap_err(), KeySerdeError::InvalidHex(_)));
    }

    #[test]
    fn test_invalid_base64_characters() {
        let invalid_b64 = "!!!invalid-base64!!!";
        let result = KeySerializer::secret_key_from_base64(invalid_b64);
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidBase64(_)
        ));
    }

    #[test]
    fn test_invalid_base64_length() {
        // Valid base64 but wrong length (16 bytes instead of 32)
        let short_b64 = base64_encode(&[0u8; 16]);
        let result = KeySerializer::secret_key_from_base64(&short_b64);
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidKeyLength { .. }
        ));
    }

    #[test]
    fn test_invalid_pem_format_missing_header() {
        let pem = "-----END ED25519 PRIVATE KEY-----";
        let result = KeySerializer::secret_key_from_pem(pem);
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidPemFormat
        ));
    }

    #[test]
    fn test_invalid_pem_format_missing_footer() {
        let pem = "-----BEGIN ED25519 PRIVATE KEY-----\nYWJjZGVm";
        let result = KeySerializer::secret_key_from_pem(pem);
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidPemFormat
        ));
    }

    #[test]
    fn test_invalid_pem_format_wrong_header() {
        let pem = "-----BEGIN RSA PRIVATE KEY-----\nYWJjZGVm\n-----END RSA PRIVATE KEY-----";
        let result = KeySerializer::secret_key_from_pem(pem);
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidPemFormat
        ));
    }

    #[test]
    fn test_pem_with_extra_whitespace() {
        let keypair = KeyPair::generate();
        let secret = keypair.secret_key();

        let pem = KeySerializer::secret_key_to_pem(&secret);
        // Add extra whitespace
        let pem_with_spaces = format!("  {}  \n\n", pem);

        let secret2 = KeySerializer::secret_key_from_pem(&pem_with_spaces).unwrap();
        assert_eq!(secret, secret2);
    }

    #[test]
    fn test_hex_case_insensitive() {
        let keypair = KeyPair::generate();
        let secret = keypair.secret_key();

        let hex_lower = KeySerializer::secret_key_to_hex(&secret);
        let hex_upper = hex_lower.to_uppercase();

        let secret_from_lower = KeySerializer::secret_key_from_hex(&hex_lower).unwrap();
        let secret_from_upper = KeySerializer::secret_key_from_hex(&hex_upper).unwrap();

        assert_eq!(secret, secret_from_lower);
        assert_eq!(secret, secret_from_upper);
    }

    #[test]
    fn test_public_key_hex_roundtrip() {
        let keypair = KeyPair::generate();
        let public = keypair.public_key();

        let hex = KeySerializer::public_key_to_hex(&public);
        let public2 = KeySerializer::public_key_from_hex(&hex).unwrap();

        assert_eq!(public, public2);
        // Hex should be 64 characters (32 bytes * 2)
        assert_eq!(hex.len(), 64);
    }

    #[test]
    fn test_public_key_invalid_hex_length() {
        let result = KeySerializer::public_key_from_hex("0123");
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidKeyLength { .. }
        ));
    }

    #[test]
    fn test_public_key_pem_invalid_format() {
        let pem = "-----BEGIN ED25519 PRIVATE KEY-----\ndata\n-----END ED25519 PRIVATE KEY-----";
        let result = KeySerializer::public_key_from_pem(pem);
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidPemFormat
        ));
    }

    #[test]
    fn test_base64_empty_string() {
        let result = KeySerializer::secret_key_from_base64("");
        assert!(result.is_err());
        assert!(matches!(
            result.unwrap_err(),
            KeySerdeError::InvalidKeyLength { .. }
        ));
    }
}