use std::fmt::Display;
use std::ops::Deref;
use anyhow::bail;
use openssl::hash::MessageDigest;
use openssl::pkey::{PKey, Private, Public};
use openssl::sign::{Signer, Verifier};
use crate::jwk::{alg::rsa::RsaKeyPair, Jwk};
use crate::jws::{JwsAlgorithm, JwsSigner, JwsVerifier};
use crate::util::der::{DerBuilder, DerType};
use crate::util::{self, HashAlgorithm};
use crate::{JoseError, Value};
#[derive(Debug, Eq, PartialEq, Copy, Clone)]
pub enum RsassaJwsAlgorithm {
Rs256,
Rs384,
Rs512,
}
impl RsassaJwsAlgorithm {
pub fn generate_key_pair(&self, bits: u32) -> Result<RsaKeyPair, JoseError> {
(|| -> anyhow::Result<RsaKeyPair> {
if bits < 2048 {
bail!("key length must be 2048 or more.");
}
let mut key_pair = RsaKeyPair::generate(bits)?;
key_pair.set_algorithm(Some(self.name()));
Ok(key_pair)
})()
.map_err(|err| match err.downcast::<JoseError>() {
Ok(err) => err,
Err(err) => JoseError::InvalidKeyFormat(err),
})
}
pub fn key_pair_from_der(&self, input: impl AsRef<[u8]>) -> Result<RsaKeyPair, JoseError> {
(|| -> anyhow::Result<RsaKeyPair> {
let mut key_pair = RsaKeyPair::from_der(input)?;
if key_pair.key_len() * 8 < 2048 {
bail!("key length must be 2048 or more.");
}
key_pair.set_algorithm(Some(self.name()));
Ok(key_pair)
})()
.map_err(|err| match err.downcast::<JoseError>() {
Ok(err) => err,
Err(err) => JoseError::InvalidKeyFormat(err),
})
}
pub fn key_pair_from_pem(&self, input: impl AsRef<[u8]>) -> Result<RsaKeyPair, JoseError> {
(|| -> anyhow::Result<RsaKeyPair> {
let mut key_pair = RsaKeyPair::from_pem(input.as_ref())?;
if key_pair.key_len() * 8 < 2048 {
bail!("key length must be 2048 or more.");
}
key_pair.set_algorithm(Some(self.name()));
Ok(key_pair)
})()
.map_err(|err| match err.downcast::<JoseError>() {
Ok(err) => err,
Err(err) => JoseError::InvalidKeyFormat(err),
})
}
pub fn signer_from_der(&self, input: impl AsRef<[u8]>) -> Result<RsassaJwsSigner, JoseError> {
let key_pair = self.key_pair_from_der(input.as_ref())?;
Ok(RsassaJwsSigner {
algorithm: self.clone(),
private_key: key_pair.into_private_key(),
key_id: None,
})
}
pub fn signer_from_pem(&self, input: impl AsRef<[u8]>) -> Result<RsassaJwsSigner, JoseError> {
let key_pair = self.key_pair_from_pem(input.as_ref())?;
Ok(RsassaJwsSigner {
algorithm: self.clone(),
private_key: key_pair.into_private_key(),
key_id: None,
})
}
pub fn signer_from_jwk(&self, jwk: &Jwk) -> Result<RsassaJwsSigner, JoseError> {
(|| -> anyhow::Result<RsassaJwsSigner> {
match jwk.key_use() {
Some(val) if val == "sig" => {}
None => {}
Some(val) => bail!("A parameter use must be sig: {}", val),
}
if !jwk.is_for_key_operation("sign") {
bail!("A parameter key_ops must contains sign.");
}
match jwk.algorithm() {
Some(val) if val == self.name() => {}
None => {}
Some(val) => bail!("A parameter alg must be {} but {}", self.name(), val),
}
let key_pair = RsaKeyPair::from_jwk(jwk)?;
if key_pair.key_len() * 8 < 2048 {
bail!("key length must be 2048 or more.");
}
let private_key = key_pair.into_private_key();
let key_id = jwk.key_id().map(|val| val.to_string());
Ok(RsassaJwsSigner {
algorithm: self.clone(),
private_key,
key_id,
})
})()
.map_err(|err| JoseError::InvalidKeyFormat(err))
}
pub fn verifier_from_der(
&self,
input: impl AsRef<[u8]>,
) -> Result<RsassaJwsVerifier, JoseError> {
(|| -> anyhow::Result<RsassaJwsVerifier> {
let spki_der_vec;
let spki_der = match RsaKeyPair::detect_pkcs8(input.as_ref(), true) {
Some(_) => input.as_ref(),
None => {
spki_der_vec = RsaKeyPair::to_pkcs8(input.as_ref(), true);
spki_der_vec.as_slice()
}
};
let public_key = PKey::public_key_from_der(spki_der)?;
let rsa = public_key.rsa()?;
if rsa.size() * 8 < 2048 {
bail!("key length must be 2048 or more.");
}
Ok(RsassaJwsVerifier {
algorithm: self.clone(),
public_key,
key_id: None,
})
})()
.map_err(|err| JoseError::InvalidKeyFormat(err))
}
pub fn verifier_from_pem(
&self,
input: impl AsRef<[u8]>,
) -> Result<RsassaJwsVerifier, JoseError> {
(|| -> anyhow::Result<RsassaJwsVerifier> {
let (alg, data) = util::parse_pem(input.as_ref())?;
let spki_der_vec;
let spki_der = match alg.as_str() {
"PUBLIC KEY" => match RsaKeyPair::detect_pkcs8(&data, true) {
Some(_) => &data,
None => bail!("Invalid PEM contents."),
},
"RSA PUBLIC KEY" => {
spki_der_vec = RsaKeyPair::to_pkcs8(&data, true);
spki_der_vec.as_slice()
}
alg => bail!("Inappropriate algorithm: {}", alg),
};
let public_key = PKey::public_key_from_der(spki_der)?;
let rsa = public_key.rsa()?;
if rsa.size() * 8 < 2048 {
bail!("key length must be 2048 or more.");
}
Ok(RsassaJwsVerifier {
algorithm: self.clone(),
public_key,
key_id: None,
})
})()
.map_err(|err| JoseError::InvalidKeyFormat(err))
}
pub fn verifier_from_jwk(&self, jwk: &Jwk) -> Result<RsassaJwsVerifier, JoseError> {
(|| -> anyhow::Result<RsassaJwsVerifier> {
match jwk.key_type() {
val if val == "RSA" => {}
val => bail!("A parameter kty must be RSA: {}", val),
}
match jwk.key_use() {
Some(val) if val == "sig" => {}
None => {}
Some(val) => bail!("A parameter use must be sig: {}", val),
}
if !jwk.is_for_key_operation("verify") {
bail!("A parameter key_ops must contains verify.");
}
match jwk.algorithm() {
Some(val) if val == self.name() => {}
None => {}
Some(val) => bail!("A parameter alg must be {} but {}", self.name(), val),
}
let n = match jwk.parameter("n") {
Some(Value::String(val)) => util::decode_base64_urlsafe_no_pad(val)?,
Some(_) => bail!("A parameter n must be a string."),
None => bail!("A parameter n is required."),
};
let e = match jwk.parameter("e") {
Some(Value::String(val)) => util::decode_base64_urlsafe_no_pad(val)?,
Some(_) => bail!("A parameter e must be a string."),
None => bail!("A parameter e is required."),
};
let mut builder = DerBuilder::new();
builder.begin(DerType::Sequence);
{
builder.append_integer_from_be_slice(&n, true); builder.append_integer_from_be_slice(&e, true); }
builder.end();
let pkcs8 = RsaKeyPair::to_pkcs8(&builder.build(), true);
let public_key = PKey::public_key_from_der(&pkcs8)?;
let key_id = jwk.key_id().map(|val| val.to_string());
let rsa = public_key.rsa()?;
if rsa.size() * 8 < 2048 {
bail!("key length must be 2048 or more.");
}
Ok(RsassaJwsVerifier {
algorithm: self.clone(),
public_key,
key_id,
})
})()
.map_err(|err| JoseError::InvalidKeyFormat(err))
}
fn hash_algorithm(&self) -> HashAlgorithm {
match self {
Self::Rs256 => HashAlgorithm::Sha256,
Self::Rs384 => HashAlgorithm::Sha384,
Self::Rs512 => HashAlgorithm::Sha512,
}
}
}
impl JwsAlgorithm for RsassaJwsAlgorithm {
fn name(&self) -> &str {
match self {
Self::Rs256 => "RS256",
Self::Rs384 => "RS384",
Self::Rs512 => "RS512",
}
}
fn box_clone(&self) -> Box<dyn JwsAlgorithm> {
Box::new(self.clone())
}
}
impl Display for RsassaJwsAlgorithm {
fn fmt(&self, fmt: &mut std::fmt::Formatter<'_>) -> Result<(), std::fmt::Error> {
fmt.write_str(self.name())
}
}
impl Deref for RsassaJwsAlgorithm {
type Target = dyn JwsAlgorithm;
fn deref(&self) -> &Self::Target {
self
}
}
#[derive(Debug, Clone)]
pub struct RsassaJwsSigner {
algorithm: RsassaJwsAlgorithm,
private_key: PKey<Private>,
key_id: Option<String>,
}
impl RsassaJwsSigner {
pub fn set_key_id(&mut self, value: impl Into<String>) {
self.key_id = Some(value.into());
}
pub fn remove_key_id(&mut self) {
self.key_id = None;
}
}
impl JwsSigner for RsassaJwsSigner {
fn algorithm(&self) -> &dyn JwsAlgorithm {
&self.algorithm
}
fn signature_len(&self) -> usize {
256
}
fn key_id(&self) -> Option<&str> {
match &self.key_id {
Some(val) => Some(val.as_ref()),
None => None,
}
}
fn sign(&self, message: &[u8]) -> Result<Vec<u8>, JoseError> {
(|| -> anyhow::Result<Vec<u8>> {
let md = match &self.algorithm.hash_algorithm() {
HashAlgorithm::Sha1 => MessageDigest::sha1(),
HashAlgorithm::Sha256 => MessageDigest::sha256(),
HashAlgorithm::Sha384 => MessageDigest::sha384(),
HashAlgorithm::Sha512 => MessageDigest::sha512(),
};
let mut signer = Signer::new(md, &self.private_key)?;
signer.update(message)?;
let signature = signer.sign_to_vec()?;
Ok(signature)
})()
.map_err(|err| JoseError::InvalidSignature(err))
}
fn box_clone(&self) -> Box<dyn JwsSigner> {
Box::new(self.clone())
}
}
impl Deref for RsassaJwsSigner {
type Target = dyn JwsSigner;
fn deref(&self) -> &Self::Target {
self
}
}
#[derive(Debug, Clone)]
pub struct RsassaJwsVerifier {
algorithm: RsassaJwsAlgorithm,
public_key: PKey<Public>,
key_id: Option<String>,
}
impl RsassaJwsVerifier {
pub fn set_key_id(&mut self, value: impl Into<String>) {
self.key_id = Some(value.into());
}
pub fn remove_key_id(&mut self) {
self.key_id = None;
}
}
impl JwsVerifier for RsassaJwsVerifier {
fn algorithm(&self) -> &dyn JwsAlgorithm {
&self.algorithm
}
fn key_id(&self) -> Option<&str> {
match &self.key_id {
Some(val) => Some(val.as_ref()),
None => None,
}
}
fn verify(&self, message: &[u8], signature: &[u8]) -> Result<(), JoseError> {
(|| -> anyhow::Result<()> {
let md = match &self.algorithm.hash_algorithm() {
HashAlgorithm::Sha1 => MessageDigest::sha1(),
HashAlgorithm::Sha256 => MessageDigest::sha256(),
HashAlgorithm::Sha384 => MessageDigest::sha384(),
HashAlgorithm::Sha512 => MessageDigest::sha512(),
};
let mut verifier = Verifier::new(md, &self.public_key)?;
verifier.update(message)?;
if !verifier.verify(signature)? {
bail!("The signature does not match.")
}
Ok(())
})()
.map_err(|err| JoseError::InvalidSignature(err))
}
fn box_clone(&self) -> Box<dyn JwsVerifier> {
Box::new(self.clone())
}
}
impl Deref for RsassaJwsVerifier {
type Target = dyn JwsVerifier;
fn deref(&self) -> &Self::Target {
self
}
}
#[cfg(test)]
mod tests {
use super::*;
use anyhow::Result;
use std::fs;
use std::path::PathBuf;
#[test]
fn sign_and_verify_rsassa_generated_der() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let key_pair = alg.generate_key_pair(2048)?;
let signer = alg.signer_from_der(&key_pair.to_der_private_key())?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_der(&key_pair.to_der_public_key())?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_generated_raw() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let key_pair = alg.generate_key_pair(2048)?;
let signer = alg.signer_from_der(&key_pair.to_raw_private_key())?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_der(&key_pair.to_raw_public_key())?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_generated_pem() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let key_pair = alg.generate_key_pair(2048)?;
let signer = alg.signer_from_pem(&key_pair.to_pem_private_key())?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_pem(&key_pair.to_pem_public_key())?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_generated_traditional_pem() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let key_pair = alg.generate_key_pair(2048)?;
let signer = alg.signer_from_pem(&key_pair.to_traditional_pem_private_key())?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_pem(&key_pair.to_traditional_pem_public_key())?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_generated_jwk() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let key_pair = alg.generate_key_pair(2048)?;
let signer = alg.signer_from_jwk(&key_pair.to_jwk_private_key())?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_jwk(&key_pair.to_jwk_public_key())?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_jwt() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let private_key = load_file("jwk/RSA_private.jwk")?;
let public_key = load_file("jwk/RSA_public.jwk")?;
let signer = alg.signer_from_jwk(&Jwk::from_bytes(&private_key)?)?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_jwk(&Jwk::from_bytes(&public_key)?)?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_pkcs8_pem() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let private_key = load_file("pem/RSA_2048bit_private.pem")?;
let public_key = load_file("pem/RSA_2048bit_public.pem")?;
let signer = alg.signer_from_pem(&private_key)?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_pem(&public_key)?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_pkcs8_der() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let private_key = load_file("der/RSA_2048bit_pkcs8_private.der")?;
let public_key = load_file("der/RSA_2048bit_spki_public.der")?;
let signer = alg.signer_from_der(&private_key)?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_der(&public_key)?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_pkcs1_pem() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let private_key = load_file("pem/RSA_2048bit_private.pem")?;
let public_key = load_file("pem/RSA_2048bit_public.pem")?;
let signer = alg.signer_from_pem(&private_key)?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_pem(&public_key)?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_pkcs1_der() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let private_key = load_file("der/RSA_2048bit_raw_private.der")?;
let public_key = load_file("der/RSA_2048bit_raw_public.der")?;
let signer = alg.signer_from_der(&private_key)?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_der(&public_key)?;
verifier.verify(input, &signature)?;
}
Ok(())
}
#[test]
fn sign_and_verify_rsassa_mismatch() -> Result<()> {
let input = b"abcde12345";
for alg in &[
RsassaJwsAlgorithm::Rs256,
RsassaJwsAlgorithm::Rs384,
RsassaJwsAlgorithm::Rs512,
] {
let signer_key_pair = alg.generate_key_pair(2048)?;
let verifier_key_pair = alg.generate_key_pair(2048)?;
let signer = alg.signer_from_der(&signer_key_pair.to_der_private_key())?;
let signature = signer.sign(input)?;
let verifier = alg.verifier_from_der(&verifier_key_pair.to_der_public_key())?;
verifier
.verify(input, &signature)
.expect_err("Unmatched signature did not fail");
}
Ok(())
}
fn load_file(path: &str) -> Result<Vec<u8>> {
let mut pb = PathBuf::from(env!("CARGO_MANIFEST_DIR"));
pb.push("data");
pb.push(path);
let data = fs::read(&pb)?;
Ok(data)
}
}