toride-ssh-agent 0.1.0

SSH agent management: listing, adding, and removing keys
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
use super::*;

#[test]
fn parse_algorithm_ed25519() {
    assert_eq!(
        parse_key_type_from_algorithm("ssh-ed25519"),
        Some(KeyType::Ed25519)
    );
}

#[test]
fn parse_algorithm_ecdsa() {
    assert_eq!(
        parse_key_type_from_algorithm("ecdsa-sha2-nistp384"),
        Some(KeyType::EcdsaP384)
    );
}

#[test]
fn parse_algorithm_unknown_returns_none() {
    assert_eq!(parse_key_type_from_algorithm("unknown-algo"), None);
}

#[test]
fn parse_algorithm_empty_string_returns_none() {
    assert_eq!(parse_key_type_from_algorithm(""), None);
}

#[test]
fn parse_algorithm_all_known_types() {
    assert_eq!(
        parse_key_type_from_algorithm("ssh-ed25519"),
        Some(KeyType::Ed25519)
    );
    assert_eq!(
        parse_key_type_from_algorithm("ssh-rsa"),
        Some(KeyType::Rsa { bits: 0 })
    );
    assert_eq!(
        parse_key_type_from_algorithm("ecdsa-sha2-nistp256"),
        Some(KeyType::EcdsaP256)
    );
    assert_eq!(
        parse_key_type_from_algorithm("ecdsa-sha2-nistp384"),
        Some(KeyType::EcdsaP384)
    );
    assert_eq!(
        parse_key_type_from_algorithm("ecdsa-sha2-nistp521"),
        Some(KeyType::EcdsaP521)
    );
    assert_eq!(parse_key_type_from_algorithm("ssh-dss"), Some(KeyType::Dsa));
    assert_eq!(
        parse_key_type_from_algorithm("sk-ssh-ed25519@openssh.com"),
        Some(KeyType::SkEd25519)
    );
    assert_eq!(
        parse_key_type_from_algorithm("sk-ecdsa-sha2-nistp256@openssh.com"),
        Some(KeyType::SkEcdsaP256)
    );
}

#[test]
fn parse_ssh_add_line_ed25519() {
    let line = "256 SHA256:ABCDEFGH1234567890 comment here (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.key_type, KeyType::Ed25519);
    assert_eq!(key.comment.as_deref(), Some("comment here"));
}

#[test]
fn parse_ssh_add_line_rsa_no_comment() {
    let line = "2048 SHA256:xyz123  (RSA)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(matches!(key.key_type, KeyType::Rsa { .. }));
    assert!(key.comment.is_none());
}

#[test]
fn parse_ssh_add_no_identities() {
    assert!(parse_ssh_add_line("The agent has no identities").is_none());
}

#[test]
fn parse_ssh_add_empty_line() {
    assert!(parse_ssh_add_line("").is_none());
}

#[test]
fn parse_ssh_add_whitespace_only() {
    assert!(parse_ssh_add_line("   ").is_none());
}

#[test]
fn parse_ssh_add_unknown_type_returns_none() {
    // Unknown key type in parentheses should return None
    let line = "256 SHA256:AAAA comment (UNKNOWN-TYPE)";
    assert!(parse_ssh_add_line(line).is_none());
}

#[test]
fn parse_ssh_add_ecdsa_sk() {
    let line = "256 SHA256:AAAA user@host (ECDSA-SK)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.key_type, KeyType::SkEcdsaP256);
    assert_eq!(key.comment.as_deref(), Some("user@host"));
}

#[test]
fn parse_ssh_add_ed25519_sk() {
    let line = "256 SHA256:AAAA user@host (ED25519-SK)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.key_type, KeyType::SkEd25519);
}

#[test]
fn parse_ssh_add_dsa() {
    let line = "1024 SHA256:AAAA user@host (DSA)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.key_type, KeyType::Dsa);
}

#[test]
fn parse_ssh_add_agent_source() {
    let line = "256 SHA256:AAAA comment (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.source, KeySource::Agent);
    assert!(!key.encrypted);
    assert!(!key.has_public_pair);
    assert!(!key.has_certificate);
}

#[test]
fn parse_ssh_add_fingerprint_format() {
    let line = "256 SHA256:abcdef1234567890 comment (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    let fp = key.fingerprint.unwrap();
    assert_eq!(fp.hash, "abcdef1234567890");
    assert_eq!(fp.key_type, KeyType::Ed25519);
}

#[test]
fn parse_ssh_add_path_is_agent_identifier() {
    let line = "256 SHA256:AAAA my-key (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(key.path.to_str().unwrap().starts_with("agent:"));
}

// ---------------------------------------------------------------------------
// Weird edge-case tests
// ---------------------------------------------------------------------------

#[test]
fn parse_ssh_add_line_with_unicode_comment() {
    let line = "256 SHA256:AAAA utilisateur@hôte (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.comment.as_deref(), Some("utilisateur@hôte"));
}

#[test]
fn parse_ssh_add_line_with_very_long_comment() {
    let long_comment = "a".repeat(1000);
    let line = format!("256 SHA256:AAAA {long_comment} (ED25519)");
    let key = parse_ssh_add_line(&line).unwrap();
    assert_eq!(key.comment.as_deref(), Some(long_comment.as_str()));
}

#[test]
fn parse_ssh_add_line_with_empty_comment_field() {
    // Two spaces between fingerprint and type (empty comment)
    let line = "256 SHA256:AAAA  (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(key.comment.is_none());
}

#[test]
fn parse_ssh_add_line_with_spaces_in_comment() {
    let line = "256 SHA256:AAAA my ssh key (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.comment.as_deref(), Some("my ssh key"));
}

#[test]
fn parse_ssh_add_line_case_insensitive_type() {
    // ssh-add output uses uppercase: (ED25519), (RSA), etc.
    // But our parser should handle case variations
    let line = "256 SHA256:AAAA comment (ed25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.key_type, KeyType::Ed25519);
}

#[test]
fn parse_ssh_add_line_with_special_chars_in_fingerprint() {
    // Fingerprint with + and / characters (base64)
    let line = "256 SHA256:abc+/def comment (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.fingerprint.unwrap().hash, "abc+/def");
}

#[test]
fn parse_ssh_add_line_bits_field() {
    // The bits field is parsed but not stored - verify it doesn't cause issues
    let line = "4096 SHA256:AAAA comment (RSA)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(matches!(key.key_type, KeyType::Rsa { .. }));
}

#[test]
fn parse_algorithm_whitespace_around() {
    // Algorithm name with whitespace should not match
    assert_eq!(parse_key_type_from_algorithm(" ssh-ed25519 "), None);
    assert_eq!(parse_key_type_from_algorithm(" ssh-ed25519"), None);
}

#[test]
fn parse_algorithm_prefix_only() {
    // Just the prefix without the full algorithm name
    assert_eq!(parse_key_type_from_algorithm("ssh-"), None);
    assert_eq!(parse_key_type_from_algorithm("ecdsa"), None);
}

#[test]
fn parse_ssh_add_line_with_extra_spaces() {
    // Multiple spaces between fields
    let line = "256  SHA256:AAAA  comment  (ED25519)";
    // This should fail because split_once(' ') expects single space
    let result = parse_ssh_add_line(line);
    // May return None due to parsing failure
    let _ = result;
}

// ---------------------------------------------------------------------------
// Production-grade weird edge cases
// ---------------------------------------------------------------------------

#[test]
fn parse_ssh_add_line_with_tab_in_comment() {
    let line = "256 SHA256:AAAA comment\twith\ttabs (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(key.comment.unwrap().contains('\t'));
}

#[test]
fn parse_ssh_add_line_with_newline_in_comment() {
    // Newline in comment would break the line format
    let line = "256 SHA256:AAAA comment\nextra (ED25519)";
    // This should fail because the line is split at \n
    let result = parse_ssh_add_line(line);
    // May parse the first part or fail
    let _ = result;
}

#[test]
fn parse_ssh_add_line_bits_zero() {
    let line = "0 SHA256:AAAA comment (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.key_type, KeyType::Ed25519);
}

#[test]
fn parse_ssh_add_line_bits_very_large() {
    let line = "999999 SHA256:AAAA comment (RSA)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(matches!(key.key_type, KeyType::Rsa { .. }));
}

#[test]
fn parse_ssh_add_line_fingerprint_with_plus_slash() {
    // Base64 uses + and / characters
    let line = "256 SHA256:abc+/def+/ghi comment (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.fingerprint.unwrap().hash, "abc+/def+/ghi");
}

#[test]
fn parse_ssh_add_line_comment_with_equals() {
    let line = "256 SHA256:AAAA user=host (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.comment.as_deref(), Some("user=host"));
}

#[test]
fn parse_ssh_add_line_comment_with_colon() {
    let line = "256 SHA256:AAAA user:host (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.comment.as_deref(), Some("user:host"));
}

#[test]
fn parse_ssh_add_line_comment_with_at() {
    let line = "256 SHA256:AAAA user@host (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert_eq!(key.comment.as_deref(), Some("user@host"));
}

#[test]
fn parse_algorithm_with_whitespace_prefix() {
    assert_eq!(parse_key_type_from_algorithm(" ssh-ed25519"), None);
}

#[test]
fn parse_algorithm_with_whitespace_suffix() {
    assert_eq!(parse_key_type_from_algorithm("ssh-ed25519 "), None);
}

#[test]
fn parse_algorithm_with_tab() {
    assert_eq!(parse_key_type_from_algorithm("ssh-ed25519\t"), None);
}

#[test]
fn parse_algorithm_with_newline() {
    assert_eq!(parse_key_type_from_algorithm("ssh-ed25519\n"), None);
}

#[test]
fn parse_algorithm_empty() {
    assert_eq!(parse_key_type_from_algorithm(""), None);
}

#[test]
fn parse_algorithm_only_whitespace() {
    assert_eq!(parse_key_type_from_algorithm("   "), None);
}

#[test]
fn parse_ssh_add_line_no_parentheses() {
    // Missing key type in parentheses
    let line = "256 SHA256:AAAA comment ED25519";
    let result = parse_ssh_add_line(line);
    // Should fail because no parentheses
    assert!(result.is_none());
}

#[test]
fn parse_ssh_add_line_empty_parentheses() {
    let line = "256 SHA256:AAAA comment ()";
    let result = parse_ssh_add_line(line);
    // Empty type should fail
    assert!(result.is_none());
}

#[test]
fn parse_ssh_add_line_unknown_type_in_parens() {
    let line = "256 SHA256:AAAA comment (UNKNOWN)";
    let result = parse_ssh_add_line(line);
    // Unknown type should return None
    assert!(result.is_none());
}

// ---------------------------------------------------------------------------
// parse_key_type_from_display tests
// ---------------------------------------------------------------------------

#[test]
fn parse_display_ed25519() {
    assert_eq!(
        parse_key_type_from_display("ED25519"),
        Some(KeyType::Ed25519)
    );
}

#[test]
fn parse_display_ed25519_sk() {
    assert_eq!(
        parse_key_type_from_display("ED25519-SK"),
        Some(KeyType::SkEd25519)
    );
}

#[test]
fn parse_display_rsa() {
    assert_eq!(
        parse_key_type_from_display("RSA"),
        Some(KeyType::Rsa { bits: 0 })
    );
}

#[test]
fn parse_display_ecdsa() {
    assert_eq!(
        parse_key_type_from_display("ECDSA"),
        Some(KeyType::EcdsaP256)
    );
}

#[test]
fn parse_display_ecdsa_sk() {
    assert_eq!(
        parse_key_type_from_display("ECDSA-SK"),
        Some(KeyType::SkEcdsaP256)
    );
}

#[test]
fn parse_display_dsa() {
    assert_eq!(parse_key_type_from_display("DSA"), Some(KeyType::Dsa));
}

#[test]
fn parse_display_case_insensitive() {
    assert_eq!(
        parse_key_type_from_display("ed25519"),
        Some(KeyType::Ed25519)
    );
    assert_eq!(
        parse_key_type_from_display("rsa"),
        Some(KeyType::Rsa { bits: 0 })
    );
    assert_eq!(
        parse_key_type_from_display("Ed25519-Sk"),
        Some(KeyType::SkEd25519)
    );
}

#[test]
fn parse_display_unknown() {
    assert_eq!(parse_key_type_from_display("UNKNOWN"), None);
    assert_eq!(parse_key_type_from_display(""), None);
}

#[test]
fn parse_display_whitespace() {
    assert_eq!(parse_key_type_from_display("  "), None);
}

// ---------------------------------------------------------------------------
// Agent-only keys (listing without filesystem presence)
// ---------------------------------------------------------------------------

#[test]
fn agent_keys_parsed_from_ssh_add_output() {
    // Simulate ssh-add -l output for keys that have no file on disk.
    let lines = [
        "256 SHA256:AAAA agent-key-1 (ED25519)",
        "4096 SHA256:BBBB agent-key-rsa (RSA)",
        "256 SHA256:CCCC agent-hardware-key (ED25519-SK)",
    ];

    let keys: Vec<_> = lines.iter().filter_map(|l| parse_ssh_add_line(l)).collect();
    assert_eq!(keys.len(), 3);

    // All should be agent-sourced.
    assert!(keys.iter().all(|k| k.source == KeySource::Agent));

    // Verify key types.
    assert_eq!(keys[0].key_type, KeyType::Ed25519);
    assert!(matches!(keys[1].key_type, KeyType::Rsa { .. }));
    assert_eq!(keys[2].key_type, KeyType::SkEd25519);

    // Agent keys should not have filesystem artifacts.
    assert!(keys.iter().all(|k| !k.has_public_pair));
    assert!(keys.iter().all(|k| !k.has_certificate));
    assert!(keys.iter().all(|k| !k.encrypted));
    assert!(keys.iter().all(|k| k.permissions.is_none()));

    // Path should be agent identifier, not a real file path.
    assert!(keys[0].path.to_str().unwrap().starts_with("agent:"));
}

#[test]
fn agent_keys_have_fingerprints() {
    let line = "256 SHA256:abc123def456 my-key (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    let fp = key.fingerprint.unwrap();
    assert_eq!(fp.hash, "abc123def456");
    assert_eq!(fp.key_type, KeyType::Ed25519);
    assert_eq!(format!("{fp}"), "SHA256:abc123def456");
}

#[test]
fn agent_keys_no_filesystem_path() {
    // Agent-only keys should have paths like "agent:comment", not real filesystem paths.
    let line = "256 SHA256:AAAA my-deploy-key (ED25519)";
    let key = parse_ssh_add_line(line).unwrap();
    assert!(key.path.to_str().unwrap().starts_with("agent:"));
    assert!(
        !key.path.exists(),
        "agent key path should not exist on filesystem"
    );
}

#[test]
fn agent_keys_mixed_types_from_output() {
    // Simulate a full ssh-add -l output with all supported key types.
    let output = "\
256 SHA256:AAAA key-ed (ED25519)
4096 SHA256:BBBB key-rsa (RSA)
256 SHA256:CCCC key-ecdsa (ECDSA)
256 SHA256:DDDD key-sk-ed (ED25519-SK)
256 SHA256:EEEE key-sk-ecdsa (ECDSA-SK)
1024 SHA256:FFFF key-dsa (DSA)
";

    let keys: Vec<_> = output.lines().filter_map(parse_ssh_add_line).collect();
    assert_eq!(keys.len(), 6);
    assert_eq!(keys[0].key_type, KeyType::Ed25519);
    assert!(matches!(keys[1].key_type, KeyType::Rsa { .. }));
    assert_eq!(keys[2].key_type, KeyType::EcdsaP256);
    assert_eq!(keys[3].key_type, KeyType::SkEd25519);
    assert_eq!(keys[4].key_type, KeyType::SkEcdsaP256);
    assert_eq!(keys[5].key_type, KeyType::Dsa);
}

// ---------------------------------------------------------------------------
// destination_constrained_add validation tests
// ---------------------------------------------------------------------------

#[test]
fn destination_constrained_host_separator() {
    // Verify the > separator convention used by ssh-add -h.
    let hosts = ["host1", "host2", "host3"];
    let constraint = hosts.join(">");
    assert_eq!(constraint, "host1>host2>host3");
}

#[test]
fn destination_constrained_single_host() {
    let hosts = ["myserver"];
    let constraint = hosts.join(">");
    assert_eq!(constraint, "myserver");
}

#[test]
fn destination_constrained_hosts_with_ports() {
    let hosts = ["example.com:2222", "10.0.0.1:22"];
    let constraint = hosts.join(">");
    assert_eq!(constraint, "example.com:2222>10.0.0.1:22");
}