uselesskey-rsa 0.10.0

RSA key fixtures (PKCS#8/SPKI, PEM/DER) with negative variants for tests.
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
use std::fmt;
use std::sync::Arc;

#[cfg(feature = "legacy-rsa09")]
use rand_chacha::ChaCha20Rng;
#[cfg(feature = "legacy-rsa09")]
use rand_chacha::rand_core::SeedableRng;
#[cfg(not(feature = "legacy-rsa09"))]
use rand_chacha10::ChaCha20Rng;
#[cfg(not(feature = "legacy-rsa09"))]
use rand_chacha10::rand_core::SeedableRng;
use rsa as rsa10;
#[cfg(feature = "legacy-rsa09")]
use rsa09::pkcs8::{EncodePrivateKey, EncodePublicKey, LineEnding};
#[cfg(feature = "legacy-rsa09")]
use rsa09::{RsaPrivateKey, RsaPublicKey};
#[cfg(feature = "legacy-rsa09")]
use rsa10::pkcs8::DecodePrivateKey;
#[cfg(feature = "jwk")]
use rsa10::pkcs8::DecodePublicKey;
#[cfg(not(feature = "legacy-rsa09"))]
use rsa10::pkcs8::{EncodePrivateKey, EncodePublicKey, LineEnding};
use uselesskey_core::Factory;
use uselesskey_core::srp::keypair_material::Pkcs8SpkiKeyMaterial;

use crate::RsaSpec;

/// Cache domain for RSA keypair fixtures.
///
/// Keep this stable: changing it changes deterministic outputs.
pub const DOMAIN_RSA_KEYPAIR: &str = "uselesskey:rsa:keypair";

/// An RSA keypair fixture with various output formats.
///
/// Created via [`RsaFactoryExt::rsa()`]. Provides access to:
/// - Private key in PKCS#8 PEM and DER formats
/// - Public key in SPKI PEM and DER formats
/// - Negative fixtures (corrupted PEM, truncated DER, mismatched keys)
/// - JWK output (with the `jwk` feature)
///
/// # Examples
///
/// ```
/// use uselesskey_core::Factory;
/// use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
///
/// let fx = Factory::random();
/// let keypair = fx.rsa("my-service", RsaSpec::rs256());
///
/// // Access key material
/// let private_pem = keypair.private_key_pkcs8_pem();
/// let public_der = keypair.public_key_spki_der();
///
/// assert!(private_pem.contains("BEGIN PRIVATE KEY"));
/// assert!(!public_der.is_empty());
/// ```
#[derive(Clone)]
pub struct RsaKeyPair {
    factory: Factory,
    label: String,
    spec: RsaSpec,
    inner: Arc<Inner>,
}

struct Inner {
    /// Kept for potential signing methods; not currently used.
    _private: rsa10::RsaPrivateKey,
    #[cfg(feature = "jwk")]
    public: rsa10::RsaPublicKey,
    material: Pkcs8SpkiKeyMaterial,
}

impl fmt::Debug for RsaKeyPair {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_struct("RsaKeyPair")
            .field("label", &self.label)
            .field("spec", &self.spec)
            .finish_non_exhaustive()
    }
}

/// Extension trait to hang RSA helpers off the core [`Factory`].
pub trait RsaFactoryExt {
    /// Generate (or retrieve from cache) an RSA keypair fixture.
    ///
    /// The `label` identifies this keypair within your test suite.
    /// In deterministic mode, `seed + label + spec` always produces the same key.
    ///
    /// # Examples
    ///
    /// ```
    /// use uselesskey_core::{Factory, Seed};
    /// use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    ///
    /// let seed = Seed::from_env_value("test-seed").unwrap();
    /// let fx = Factory::deterministic(seed);
    /// let keypair = fx.rsa("my-service", RsaSpec::rs256());
    ///
    /// let pem = keypair.private_key_pkcs8_pem();
    /// assert!(pem.contains("BEGIN PRIVATE KEY"));
    /// ```
    fn rsa(&self, label: impl AsRef<str>, spec: RsaSpec) -> RsaKeyPair;
}

impl RsaFactoryExt for Factory {
    fn rsa(&self, label: impl AsRef<str>, spec: RsaSpec) -> RsaKeyPair {
        RsaKeyPair::new(self.clone(), label.as_ref(), spec)
    }
}

impl RsaKeyPair {
    fn new(factory: Factory, label: &str, spec: RsaSpec) -> Self {
        let inner = load_inner(&factory, label, spec, "good");
        Self {
            factory,
            label: label.to_string(),
            spec,
            inner,
        }
    }

    fn load_variant(&self, variant: &str) -> Arc<Inner> {
        load_inner(&self.factory, &self.label, self.spec, variant)
    }

    /// Returns the spec used to create this keypair.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::Factory;
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::random();
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// assert_eq!(kp.spec(), RsaSpec::rs256());
    /// ```
    pub fn spec(&self) -> RsaSpec {
        self.spec
    }

    /// Returns the label used to create this keypair.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::Factory;
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::random();
    /// let kp = fx.rsa("my-svc", RsaSpec::rs256());
    /// assert_eq!(kp.label(), "my-svc");
    /// ```
    pub fn label(&self) -> &str {
        &self.label
    }

    #[cfg(feature = "jwk")]
    fn jwk_alg(&self) -> &'static str {
        match self.spec.bits {
            3072 => "RS384",
            4096 => "RS512",
            _ => "RS256",
        }
    }

    uselesskey_core::impl_pkcs8_spki_fixture_accessors!();

    /// Alias for [`Self::public_jwk`].
    ///
    /// Requires the `jwk` feature.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let jwk = kp.public_key_jwk();
    /// assert_eq!(jwk.to_value()["kty"], "RSA");
    /// ```
    #[cfg(feature = "jwk")]
    pub fn public_key_jwk(&self) -> uselesskey_jwk::PublicJwk {
        self.public_jwk()
    }

    /// Public JWK for this keypair (kty=RSA, use=sig, kid=...).
    ///
    /// Requires the `jwk` feature.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let jwk = kp.public_jwk();
    /// let val = jwk.to_value();
    /// assert_eq!(val["kty"], "RSA");
    /// assert_eq!(val["alg"], "RS256");
    /// ```
    #[cfg(feature = "jwk")]
    pub fn public_jwk(&self) -> uselesskey_jwk::PublicJwk {
        use base64::Engine as _;
        use base64::engine::general_purpose::URL_SAFE_NO_PAD;
        use rsa10::traits::PublicKeyParts;
        use uselesskey_jwk::{PublicJwk, RsaPublicJwk};

        let n = self.inner.public.n_bytes();
        let e = self.inner.public.e_bytes();

        PublicJwk::Rsa(RsaPublicJwk {
            kty: "RSA",
            use_: "sig",
            alg: self.jwk_alg(),
            kid: self.kid(),
            n: URL_SAFE_NO_PAD.encode(n),
            e: URL_SAFE_NO_PAD.encode(e),
        })
    }

    /// Private JWK for this keypair (kty=RSA, use=sig, kid=...).
    ///
    /// Requires the `jwk` feature.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let jwk = kp.private_key_jwk();
    /// let val = jwk.to_value();
    /// assert_eq!(val["kty"], "RSA");
    /// assert!(val["d"].is_string());
    /// ```
    #[cfg(feature = "jwk")]
    pub fn private_key_jwk(&self) -> uselesskey_jwk::PrivateJwk {
        use base64::Engine as _;
        use base64::engine::general_purpose::URL_SAFE_NO_PAD;
        use rsa10::traits::{PrivateKeyParts, PublicKeyParts};
        use uselesskey_jwk::{PrivateJwk, RsaPrivateJwk};

        let private = &self.inner._private;
        let primes = private.primes();
        assert!(primes.len() >= 2, "expected at least two RSA primes");

        let n = private.n_bytes();
        let e = private.e_bytes();
        let d = private.d().to_be_bytes_trimmed_vartime();
        let p = primes[0].to_be_bytes_trimmed_vartime();
        let q = primes[1].to_be_bytes_trimmed_vartime();
        let dp = private.dp().expect("dp").to_be_bytes_trimmed_vartime();
        let dq = private.dq().expect("dq").to_be_bytes_trimmed_vartime();
        let qi = private
            .qinv()
            .expect("qinv")
            .retrieve()
            .to_be_bytes_trimmed_vartime();

        PrivateJwk::Rsa(RsaPrivateJwk {
            kty: "RSA",
            use_: "sig",
            alg: self.jwk_alg(),
            kid: self.kid(),
            n: URL_SAFE_NO_PAD.encode(n),
            e: URL_SAFE_NO_PAD.encode(e),
            d: URL_SAFE_NO_PAD.encode(d),
            p: URL_SAFE_NO_PAD.encode(p),
            q: URL_SAFE_NO_PAD.encode(q),
            dp: URL_SAFE_NO_PAD.encode(dp),
            dq: URL_SAFE_NO_PAD.encode(dq),
            qi: URL_SAFE_NO_PAD.encode(qi),
        })
    }

    /// JWKS containing a single public key.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let jwks = kp.public_jwks();
    /// assert!(jwks.to_value()["keys"].is_array());
    /// ```
    #[cfg(feature = "jwk")]
    pub fn public_jwks(&self) -> uselesskey_jwk::Jwks {
        use uselesskey_jwk::JwksBuilder;

        let mut builder = JwksBuilder::new();
        builder.push_public(self.public_jwk());
        builder.build()
    }

    /// Public JWK serialized to `serde_json::Value`.
    ///
    /// Requires the `jwk` feature.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let val = kp.public_jwk_json();
    /// assert_eq!(val["kty"], "RSA");
    /// ```
    #[cfg(feature = "jwk")]
    pub fn public_jwk_json(&self) -> serde_json::Value {
        self.public_jwk().to_value()
    }

    /// JWKS serialized to `serde_json::Value`.
    ///
    /// Requires the `jwk` feature.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let val = kp.public_jwks_json();
    /// assert!(val["keys"].is_array());
    /// ```
    #[cfg(feature = "jwk")]
    pub fn public_jwks_json(&self) -> serde_json::Value {
        self.public_jwks().to_value()
    }

    /// Private JWK serialized to `serde_json::Value`.
    ///
    /// Requires the `jwk` feature.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// # use uselesskey_core::{Factory, Seed};
    /// # use uselesskey_rsa::{RsaFactoryExt, RsaSpec};
    /// let fx = Factory::deterministic(Seed::from_env_value("test-seed").unwrap());
    /// let kp = fx.rsa("svc", RsaSpec::rs256());
    /// let val = kp.private_key_jwk_json();
    /// assert_eq!(val["kty"], "RSA");
    /// assert!(val["d"].is_string());
    /// ```
    #[cfg(feature = "jwk")]
    pub fn private_key_jwk_json(&self) -> serde_json::Value {
        self.private_key_jwk().to_value()
    }
}

fn load_inner(factory: &Factory, label: &str, spec: RsaSpec, variant: &str) -> Arc<Inner> {
    // Validate what we can, up front.
    assert!(
        spec.bits >= 1024,
        "RSA bits too small for most parsers; got {}",
        spec.bits
    );
    assert!(
        spec.exponent == 65537,
        "custom RSA public exponent not supported in v1; got {}",
        spec.exponent
    );

    let spec_bytes = spec.stable_bytes();

    factory.get_or_init(DOMAIN_RSA_KEYPAIR, label, &spec_bytes, variant, |seed| {
        let mut rng = ChaCha20Rng::from_seed(*seed.bytes());

        #[cfg(feature = "legacy-rsa09")]
        let private09 = RsaPrivateKey::new(&mut rng, spec.bits).expect("RSA keygen failed");
        #[cfg(feature = "legacy-rsa09")]
        let public09 = RsaPublicKey::from(&private09);

        #[cfg(feature = "legacy-rsa09")]
        let pkcs8_der_doc = private09
            .to_pkcs8_der()
            .expect("failed to encode RSA private key as PKCS#8 DER");
        #[cfg(feature = "legacy-rsa09")]
        let pkcs8_der: Arc<[u8]> = Arc::from(pkcs8_der_doc.as_bytes());

        #[cfg(feature = "legacy-rsa09")]
        let pkcs8_pem = private09
            .to_pkcs8_pem(LineEnding::LF)
            .expect("failed to encode RSA private key as PKCS#8 PEM")
            .to_string();

        #[cfg(feature = "legacy-rsa09")]
        let spki_der_doc = public09
            .to_public_key_der()
            .expect("failed to encode RSA public key as SPKI DER");
        #[cfg(feature = "legacy-rsa09")]
        let spki_der: Arc<[u8]> = Arc::from(spki_der_doc.as_bytes());

        #[cfg(feature = "legacy-rsa09")]
        let spki_pem = public09
            .to_public_key_pem(LineEnding::LF)
            .expect("failed to encode RSA public key as SPKI PEM")
            .to_string();

        #[cfg(feature = "legacy-rsa09")]
        let private = rsa10::RsaPrivateKey::from_pkcs8_der(&pkcs8_der)
            .expect("failed to parse V1 RSA private key into rsa 0.10");
        #[cfg(feature = "jwk")]
        #[cfg(feature = "legacy-rsa09")]
        let public = rsa10::RsaPublicKey::from_public_key_der(&spki_der)
            .expect("failed to parse V1 RSA public key into rsa 0.10");
        #[cfg(not(feature = "legacy-rsa09"))]
        let private = rsa10::RsaPrivateKey::new(&mut rng, spec.bits).expect("RSA keygen failed");
        #[cfg(not(feature = "legacy-rsa09"))]
        let public = rsa10::RsaPublicKey::from(&private);
        #[cfg(not(feature = "legacy-rsa09"))]
        let pkcs8_der_doc = private
            .to_pkcs8_der()
            .expect("failed to encode RSA private key as PKCS#8 DER");
        #[cfg(not(feature = "legacy-rsa09"))]
        let pkcs8_der: Arc<[u8]> = Arc::from(pkcs8_der_doc.as_bytes());
        #[cfg(not(feature = "legacy-rsa09"))]
        let pkcs8_pem = private
            .to_pkcs8_pem(LineEnding::LF)
            .expect("failed to encode RSA private key as PKCS#8 PEM")
            .to_string();
        #[cfg(not(feature = "legacy-rsa09"))]
        let spki_der_doc = public
            .to_public_key_der()
            .expect("failed to encode RSA public key as SPKI DER");
        #[cfg(not(feature = "legacy-rsa09"))]
        let spki_der: Arc<[u8]> = Arc::from(spki_der_doc.as_bytes());
        #[cfg(not(feature = "legacy-rsa09"))]
        let spki_pem = public
            .to_public_key_pem(LineEnding::LF)
            .expect("failed to encode RSA public key as SPKI PEM")
            .to_string();

        let material = Pkcs8SpkiKeyMaterial::new(pkcs8_der, pkcs8_pem, spki_der, spki_pem);

        Inner {
            _private: private,
            #[cfg(feature = "jwk")]
            public,
            material,
        }
    })
}