api-keys-simplified 0.5.1

Secure API key generation and validation library
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
use api_keys_simplified::{
    ApiKeyManagerV0, Environment, ExposeSecret, HashConfig, KeyConfig, KeyStatus, SecureString,
};
use chrono::{Duration, Utc};

/// Test that a key with future expiry is valid
#[test]
fn test_future_expiry_is_valid() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() + Duration::days(7);

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Valid
    );
}

/// Test that a key with past expiry is expired
#[test]
fn test_past_expiry_is_expired() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() - Duration::days(1);

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Invalid
    );
}

/// Test that expiry exactly at current time is still valid (<=)
#[test]
fn test_expiry_at_current_time() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now();

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // Should be Valid since verification uses: now <= expiry
    let status = manager.verify(key.key(), key.expose_hash().hash()).unwrap();
    assert!(
        status == KeyStatus::Valid || status == KeyStatus::Invalid,
        "Status at boundary should be Valid or Expired depending on timing"
    );
}

/// Test that keys without expiry never expire
#[test]
fn test_no_expiry_never_expires() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let key = manager.generate(Environment::production()).unwrap();

    // Verify immediately
    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Valid
    );
}

/// Test expired key with wrong hash still returns Invalid (not Expired)
#[test]
fn test_expired_key_wrong_hash() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() - Duration::days(1);

    let expired_key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // Generate another key to get a different hash
    let other_key = manager.generate(Environment::production()).unwrap();

    // Verify expired key against wrong hash - should be Invalid, not Expired
    assert_eq!(
        manager
            .verify(expired_key.key(), other_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
}

/// Test very short expiry (seconds)
#[test]
fn test_short_expiry() {
    const EXPIRY: i64 = 3;
    let config = KeyConfig::default();
    let h_config = HashConfig::default();
    let manager = ApiKeyManagerV0::init("sk", config, h_config, std::time::Duration::ZERO).unwrap();
    let expiry = Utc::now() + Duration::seconds(EXPIRY);
    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // Should be valid immediately after creation
    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Valid
    );

    // Wait for expiry
    std::thread::sleep(std::time::Duration::from_secs(EXPIRY as u64 + 1));

    // Should now be expired
    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Invalid
    );
}

/// Test very long expiry (years)
#[test]
fn test_long_expiry() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() + Duration::days(365 * 10); // 10 years

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Valid
    );
}

/// Test expiry with different environments
#[test]
fn test_expiry_across_environments() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let future = Utc::now() + Duration::days(1);
    let past = Utc::now() - Duration::days(1);

    let dev_valid = manager
        .generate_with_expiry(Environment::dev(), future)
        .unwrap();
    let test_expired = manager
        .generate_with_expiry(Environment::test(), past)
        .unwrap();
    let staging_valid = manager
        .generate_with_expiry(Environment::staging(), future)
        .unwrap();
    let live_expired = manager
        .generate_with_expiry(Environment::production(), past)
        .unwrap();

    assert_eq!(
        manager
            .verify(dev_valid.key(), dev_valid.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
    assert_eq!(
        manager
            .verify(test_expired.key(), test_expired.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
    assert_eq!(
        manager
            .verify(staging_valid.key(), staging_valid.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
    assert_eq!(
        manager
            .verify(live_expired.key(), live_expired.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
}

/// Test that expiry is embedded in key and survives hashing
#[test]
fn test_expiry_embedded_in_key() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() - Duration::days(1);

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // Store hash separately
    let hash_str = key.expose_hash().hash().to_string();

    // Verify using the stored hash - expiry should still work
    assert_eq!(
        manager.verify(key.key(), &hash_str).unwrap(),
        KeyStatus::Invalid
    );
}

/// Test expiry with checksum disabled
#[test]
fn test_expiry_without_checksum() {
    use api_keys_simplified::{HashConfig, KeyConfig};

    let config = KeyConfig::default().disable_checksum();
    let manager = ApiKeyManagerV0::init(
        "sk",
        config,
        HashConfig::default(),
        std::time::Duration::ZERO,
    )
    .unwrap();

    let past = Utc::now() - Duration::hours(1);
    let future = Utc::now() + Duration::hours(1);

    let expired_key = manager
        .generate_with_expiry(Environment::production(), past)
        .unwrap();
    let valid_key = manager
        .generate_with_expiry(Environment::production(), future)
        .unwrap();

    // Expiry works independently of checksum
    assert_eq!(
        manager
            .verify(expired_key.key(), expired_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
    assert_eq!(
        manager
            .verify(valid_key.key(), valid_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
}

/// Test multiple keys with same expiry
#[test]
fn test_multiple_keys_same_expiry() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() + Duration::days(30);

    let key1 = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();
    let key2 = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();
    let key3 = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // All keys should be unique
    assert_ne!(key1.key().expose_secret(), key2.key().expose_secret());
    assert_ne!(key2.key().expose_secret(), key3.key().expose_secret());
    assert_ne!(
        key1.expose_hash().hash().to_string(),
        key2.expose_hash().hash().to_string()
    );

    // All should be valid
    assert_eq!(
        manager
            .verify(key1.key(), key1.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
    assert_eq!(
        manager
            .verify(key2.key(), key2.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
    assert_eq!(
        manager
            .verify(key3.key(), key3.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
}

/// Test that expired keys with valid checksum still return Expired (not Invalid)
#[test]
fn test_expired_with_valid_checksum() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() - Duration::days(1);

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // Key has valid checksum and correct hash, but is expired
    assert_eq!(
        manager.verify(key.key(), key.expose_hash().hash()).unwrap(),
        KeyStatus::Invalid
    );
}

/// Test expiry timestamp encoding/decoding
#[test]
fn test_expiry_timestamp_round_trip() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();

    // Test various timestamps
    let timestamps = vec![
        Utc::now(),
        Utc::now() + Duration::days(1),
        Utc::now() + Duration::days(365),
        Utc::now() - Duration::days(1),
    ];

    for ts in timestamps {
        let key = manager
            .generate_with_expiry(Environment::production(), ts)
            .unwrap();

        // Verify doesn't panic and returns a valid status
        let status = manager.verify(key.key(), key.expose_hash().hash()).unwrap();
        assert!(
            matches!(status, KeyStatus::Valid | KeyStatus::Invalid),
            "Expected Valid or Expired, got {:?}",
            status
        );
    }
}

/// Test expiry with high security config
#[test]
fn test_expiry_with_high_security() {
    let manager = ApiKeyManagerV0::init_high_security_config("sk").unwrap();

    let future = Utc::now() + Duration::days(7);
    let past = Utc::now() - Duration::days(1);

    let valid_key = manager
        .generate_with_expiry(Environment::production(), future)
        .unwrap();
    let expired_key = manager
        .generate_with_expiry(Environment::production(), past)
        .unwrap();

    assert_eq!(
        manager
            .verify(valid_key.key(), valid_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );
    assert_eq!(
        manager
            .verify(expired_key.key(), expired_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
}

/// Test that corrupted expiry data returns Invalid (not panic)
#[test]
fn test_corrupted_expiry_returns_invalid() {
    let manager = ApiKeyManagerV0::init_default_config("sk").unwrap();
    let expiry = Utc::now() + Duration::days(1);

    let key = manager
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    // Corrupt the key by modifying expiry portion
    let key_str = key.key().expose_secret();
    let parts: Vec<&str> = key_str.split('.').collect();

    if parts.len() >= 2 {
        // Replace expiry with corrupted data (wrong length)
        let corrupted = format!("{}.corrupted.{}", parts[0], parts.get(2).unwrap_or(&""));
        let corrupted_key = SecureString::from(corrupted);

        // Should return Invalid (or Expired), not panic
        let result = manager.verify(&corrupted_key, key.expose_hash().hash());
        assert!(result.is_ok(), "Corrupted expiry should not cause panic");
    }
}

/// Test real-world scenario: trial key lifecycle
#[test]
fn test_trial_key_lifecycle() {
    let manager = ApiKeyManagerV0::init_default_config("trial").unwrap();

    // Create 7-day trial key
    let trial_expiry = Utc::now() + Duration::days(7);
    let trial_key = manager
        .generate_with_expiry(Environment::production(), trial_expiry)
        .unwrap();

    // Day 1: Valid
    assert_eq!(
        manager
            .verify(trial_key.key(), trial_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Valid
    );

    // Create expired trial (simulate 8 days passing)
    let expired_trial = Utc::now() - Duration::days(1);
    let expired_key = manager
        .generate_with_expiry(Environment::production(), expired_trial)
        .unwrap();

    // After expiry: Expired
    assert_eq!(
        manager
            .verify(expired_key.key(), expired_key.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
}

/// Test that expiry works with different key prefixes
#[test]
fn test_expiry_with_custom_prefix() {
    let manager1 = ApiKeyManagerV0::init_default_config("api").unwrap();
    let manager2 = ApiKeyManagerV0::init_default_config("partner").unwrap();

    let expiry = Utc::now() - Duration::hours(1);

    let key1 = manager1
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();
    let key2 = manager2
        .generate_with_expiry(Environment::production(), expiry)
        .unwrap();

    assert_eq!(
        manager1
            .verify(key1.key(), key1.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
    assert_eq!(
        manager2
            .verify(key2.key(), key2.expose_hash().hash())
            .unwrap(),
        KeyStatus::Invalid
    );
}