Skip to content

Commit 4e8bd5f

Browse files
committed
feat: add Jwk::from_decoding_key
Allow for constructing a Jwk from a decoding key. This allows it to be created from a DER encoded file, for example. This patch flattens JwkUtils but adds separate structs for RSA and EC component extraction.
1 parent 245858f commit 4e8bd5f

4 files changed

Lines changed: 219 additions & 70 deletions

File tree

src/crypto/aws_lc/mod.rs

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ use aws_lc_rs::{
88

99
use crate::{
1010
Algorithm, DecodingKey, EncodingKey,
11-
crypto::{CryptoProvider, JwkUtils, JwtSigner, JwtVerifier},
11+
crypto::{CryptoProvider, JwtSigner, JwtVerifier},
1212
errors::{self, Error, ErrorKind},
1313
jwk::{EllipticCurve, ThumbprintHash},
1414
};
@@ -18,15 +18,23 @@ mod eddsa;
1818
mod hmac;
1919
mod rsa;
2020

21-
fn extract_rsa_public_key_components(key_content: &[u8]) -> errors::Result<(Vec<u8>, Vec<u8>)> {
21+
fn rsa_components_from_private_key(key_content: &[u8]) -> errors::Result<(Vec<u8>, Vec<u8>)> {
2222
let key_pair = aws_sig::RsaKeyPair::from_der(key_content)
2323
.map_err(|e| ErrorKind::InvalidRsaKey(e.to_string()))?;
2424
let public = key_pair.public_key();
2525
let components = aws_sig::RsaPublicKeyComponents::<Vec<u8>>::from(public);
2626
Ok((components.n, components.e))
2727
}
2828

29-
fn extract_ec_public_key_coordinates(
29+
fn rsa_components_from_public_key(key_content: &[u8]) -> errors::Result<(Vec<u8>, Vec<u8>)> {
30+
let public = aws_lc_rs::rsa::PublicKey::from_der(key_content)
31+
.map_err(|e| ErrorKind::InvalidRsaKey(e.to_string()))?;
32+
33+
let components = aws_sig::RsaPublicKeyComponents::<Vec<u8>>::from(&public);
34+
Ok((components.n, components.e))
35+
}
36+
37+
fn ec_components_from_private_key(
3038
key_content: &[u8],
3139
alg: Algorithm,
3240
) -> errors::Result<(EllipticCurve, Vec<u8>, Vec<u8>)> {
@@ -102,9 +110,13 @@ fn new_verifier(
102110
pub static DEFAULT_PROVIDER: CryptoProvider = CryptoProvider {
103111
signer_factory: new_signer,
104112
verifier_factory: new_verifier,
105-
jwk_utils: JwkUtils {
106-
extract_rsa_public_key_components,
107-
extract_ec_public_key_coordinates,
108-
compute_digest,
113+
rsa_public_components: super::RsaPublicComponents {
114+
from_private_key: rsa_components_from_private_key,
115+
from_public_key: rsa_components_from_public_key,
116+
},
117+
ec_public_components: super::EcPublicComponents {
118+
from_private_key: ec_components_from_private_key,
119+
from_public_key: super::ec_components_from_public_key,
109120
},
121+
compute_digest,
110122
};

src/crypto/mod.rs

Lines changed: 67 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,15 @@
1010
//! [`CryptoProvider`]: crate::crypto::CryptoProvider
1111
1212
use crate::algorithms::Algorithm;
13-
use crate::errors::Result;
13+
use crate::errors::{self, ErrorKind, Result};
1414
use crate::jwk::{EllipticCurve, ThumbprintHash};
1515
use crate::{DecodingKey, EncodingKey};
1616

17+
const NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR: &'static str = r###"
18+
Could not automatically determine the process-level CryptoProvider from jsonwebtoken crate features, or your CryptoProvider does not support JWKs.
19+
Call CryptoProvider::install_default() before this point to select a provider manually, or make sure exactly one of the 'rust_crypto' and 'aws_lc_rs' features is enabled.
20+
See the documentation of the CryptoProvider type for more information.
21+
"###;
1722
/// `aws_lc_rs` based CryptoProvider.
1823
#[cfg(feature = "aws_lc_rs")]
1924
pub mod aws_lc;
@@ -85,8 +90,13 @@ pub struct CryptoProvider {
8590
pub signer_factory: fn(&Algorithm, &EncodingKey) -> Result<Box<dyn JwtSigner>>,
8691
/// A function that produces a [`JwtVerifier`] for a given [`Algorithm`]
8792
pub verifier_factory: fn(&Algorithm, &DecodingKey) -> Result<Box<dyn JwtVerifier>>,
88-
/// Struct with utility functions for JWK processing.
89-
pub jwk_utils: JwkUtils,
93+
/// Functions to extract RSA public key components from private and public keys
94+
pub rsa_public_components: RsaPublicComponents,
95+
/// Functions to extract EC public key components from private and public keys
96+
pub ec_public_components: EcPublicComponents,
97+
98+
/// Given some data and a name of a hash function, compute hash_function(data)
99+
pub compute_digest: fn(&[u8], ThumbprintHash) -> Vec<u8>,
90100
}
91101

92102
impl CryptoProvider {
@@ -123,51 +133,81 @@ See the documentation of the CryptoProvider type for more information.
123133
static INSTANCE: CryptoProvider = CryptoProvider {
124134
signer_factory: |_, _| panic!("{}", NOT_INSTALLED_ERROR),
125135
verifier_factory: |_, _| panic!("{}", NOT_INSTALLED_ERROR),
126-
jwk_utils: JwkUtils::new_unimplemented(),
136+
rsa_public_components: RsaPublicComponents::new_unimplemented(),
137+
ec_public_components: EcPublicComponents::new_unimplemented(),
138+
compute_digest: |_, _| panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR),
127139
};
128140

129141
&INSTANCE
130142
}
131143
}
132144
}
133145

134-
/// Holds utility functions required for JWK processing.
135-
/// Use the [`JwkUtils::new_unimplemented`] function to initialize all values to dummies.
146+
/// Holds utility functions to extract RSA public key components from private and public keys
147+
/// Use the [`RsaPublicComponents::new_unimplemented`] function to initialize all values to dummies.
136148
#[derive(Clone, Debug)]
137-
pub struct JwkUtils {
149+
pub struct RsaPublicComponents {
138150
/// Given a DER encoded private key, extract the RSA public key components (n, e)
139151
#[allow(clippy::type_complexity)]
140-
pub extract_rsa_public_key_components: fn(&[u8]) -> Result<(Vec<u8>, Vec<u8>)>,
152+
pub from_private_key: fn(&[u8]) -> Result<(Vec<u8>, Vec<u8>)>,
153+
/// Given a DER encoded public key, extract the RSA public key components (n, e)
154+
#[allow(clippy::type_complexity)]
155+
pub from_public_key: fn(&[u8]) -> Result<(Vec<u8>, Vec<u8>)>,
156+
}
157+
158+
impl RsaPublicComponents {
159+
/// Creates an instance filled with dummy functions that always panic
160+
pub const fn new_unimplemented() -> Self {
161+
Self {
162+
from_private_key: |_| panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR),
163+
164+
from_public_key: |_| panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR),
165+
}
166+
}
167+
}
168+
169+
/// Holds utility functions to extract EC public key components from private and public keys
170+
/// Use the [`EcPublicComponents::new_unimplemented`] function to initialize all values to dummies.
171+
#[derive(Clone, Debug)]
172+
pub struct EcPublicComponents {
141173
/// Given a DER encoded private key and an algorithm, extract the associated curve
142174
/// and the EC public key components (x, y)
143175
#[allow(clippy::type_complexity)]
144-
pub extract_ec_public_key_coordinates:
145-
fn(&[u8], Algorithm) -> Result<(EllipticCurve, Vec<u8>, Vec<u8>)>,
146-
/// Given some data and a name of a hash function, compute hash_function(data)
147-
pub compute_digest: fn(&[u8], ThumbprintHash) -> Vec<u8>,
176+
pub from_private_key: fn(&[u8], Algorithm) -> Result<(EllipticCurve, Vec<u8>, Vec<u8>)>,
177+
/// Given a DER encoded public key and an algorithm, extract the associated curve
178+
/// and the EC public key components (x, y)
179+
#[allow(clippy::type_complexity)]
180+
pub from_public_key: fn(&[u8]) -> Result<(EllipticCurve, Vec<u8>, Vec<u8>)>,
148181
}
149182

150-
impl JwkUtils {
151-
/// Initialises all values to dummies.
152-
/// Will lead to a panic when JWKs are required, so only use it if you don't want to support JWKs.
183+
impl EcPublicComponents {
184+
/// Creates a instance filled with dummy functions that always panic
153185
pub const fn new_unimplemented() -> Self {
154-
const NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR: &str = r###"
155-
Could not automatically determine the process-level CryptoProvider from jsonwebtoken crate features, or your CryptoProvider does not support JWKs.
156-
Call CryptoProvider::install_default() before this point to select a provider manually, or make sure exactly one of the 'rust_crypto' and 'aws_lc_rs' features is enabled.
157-
See the documentation of the CryptoProvider type for more information.
158-
"###;
159186
Self {
160-
extract_rsa_public_key_components: |_| {
161-
panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR)
162-
},
163-
extract_ec_public_key_coordinates: |_, _| {
164-
panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR)
165-
},
166-
compute_digest: |_, _| panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR),
187+
from_private_key: |_, _| panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR),
188+
189+
from_public_key: |_| panic!("{}", NOT_INSTALLED_OR_UNIMPLEMENTED_ERROR),
167190
}
168191
}
169192
}
170193

194+
pub(crate) fn ec_components_from_public_key(
195+
pub_bytes: &[u8],
196+
) -> errors::Result<(EllipticCurve, Vec<u8>, Vec<u8>)> {
197+
let (curve, pub_elem_bytes) = match pub_bytes.len() {
198+
65 => (EllipticCurve::P256, 32),
199+
97 => (EllipticCurve::P384, 48),
200+
_ => return Err(ErrorKind::InvalidEcdsaKey.into()),
201+
};
202+
203+
if pub_bytes[0] != 4 {
204+
return Err(ErrorKind::InvalidEcdsaKey.into());
205+
}
206+
207+
let (x, y) = pub_bytes[1..].split_at(pub_elem_bytes);
208+
Ok((curve, x.to_vec(), y.to_vec()))
209+
}
210+
171211
mod static_default {
172212
use std::sync::OnceLock;
173213

src/crypto/rust_crypto/mod.rs

Lines changed: 22 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
1-
use ::rsa::{RsaPrivateKey, pkcs1::DecodeRsaPrivateKey, traits::PublicKeyParts};
1+
use ::rsa::{
2+
RsaPrivateKey, RsaPublicKey,
3+
pkcs1::{DecodeRsaPrivateKey, DecodeRsaPublicKey},
4+
traits::PublicKeyParts,
5+
};
26
use p256::{ecdsa::SigningKey as P256SigningKey, pkcs8::DecodePrivateKey};
37
use p384::ecdsa::SigningKey as P384SigningKey;
48
use sha2::{Digest, Sha256, Sha384, Sha512};
59

610
use crate::{
711
Algorithm, DecodingKey, EncodingKey,
8-
crypto::{CryptoProvider, JwkUtils, JwtSigner, JwtVerifier},
12+
crypto::{CryptoProvider, JwtSigner, JwtVerifier},
913
errors::{self, Error, ErrorKind},
1014
jwk::{EllipticCurve, ThumbprintHash},
1115
};
@@ -15,14 +19,20 @@ mod eddsa;
1519
mod hmac;
1620
mod rsa;
1721

18-
fn extract_rsa_public_key_components(key_content: &[u8]) -> errors::Result<(Vec<u8>, Vec<u8>)> {
22+
fn rsa_components_from_private_key(key_content: &[u8]) -> errors::Result<(Vec<u8>, Vec<u8>)> {
1923
let private_key = RsaPrivateKey::from_pkcs1_der(key_content)
2024
.map_err(|e| ErrorKind::InvalidRsaKey(e.to_string()))?;
2125
let public_key = private_key.to_public_key();
2226
Ok((public_key.n().to_bytes_be(), public_key.e().to_bytes_be()))
2327
}
2428

25-
fn extract_ec_public_key_coordinates(
29+
fn rsa_components_from_public_key(key_content: &[u8]) -> errors::Result<(Vec<u8>, Vec<u8>)> {
30+
let public_key = RsaPublicKey::from_pkcs1_der(key_content)
31+
.map_err(|e| ErrorKind::InvalidRsaKey(e.to_string()))?;
32+
Ok((public_key.n().to_bytes_be(), public_key.e().to_bytes_be()))
33+
}
34+
35+
fn ec_components_from_private_key(
2636
key_content: &[u8],
2737
alg: Algorithm,
2838
) -> errors::Result<(EllipticCurve, Vec<u8>, Vec<u8>)> {
@@ -108,9 +118,13 @@ fn new_verifier(
108118
pub static DEFAULT_PROVIDER: CryptoProvider = CryptoProvider {
109119
signer_factory: new_signer,
110120
verifier_factory: new_verifier,
111-
jwk_utils: JwkUtils {
112-
extract_rsa_public_key_components,
113-
extract_ec_public_key_coordinates,
114-
compute_digest,
121+
rsa_public_components: super::RsaPublicComponents {
122+
from_private_key: rsa_components_from_private_key,
123+
from_public_key: rsa_components_from_public_key,
124+
},
125+
ec_public_components: super::EcPublicComponents {
126+
from_private_key: ec_components_from_private_key,
127+
from_public_key: super::ec_components_from_public_key,
115128
},
129+
compute_digest,
116130
};

0 commit comments

Comments
 (0)