Add support for MLDSA in hsmtool #29202
+1,744
−168
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| // Copyright lowRISC contributors (OpenTitan project). | ||
| // Licensed under the Apache License, Version 2.0, see LICENSE for details. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| use anyhow::{Result, anyhow}; | ||
| use cryptoki::object::{Attribute, ObjectHandle}; | ||
| use cryptoki::session::Session; | ||
| use serde::{Deserialize, Serialize}; | ||
| use std::any::Any; | ||
| use std::fs; | ||
| use std::path::PathBuf; | ||
|
|
||
| use crate::commands::{BasicResult, Dispatch}; | ||
| use crate::error::HsmError; | ||
| use crate::module::Module; | ||
| use crate::util::attribute::{AttributeMap, AttributeType, KeyType, ObjectClass}; | ||
| use crate::util::helper; | ||
| use crate::util::key::KeyEncoding; | ||
| use crate::util::wrap::{Wrap, WrapPrivateKey}; | ||
|
|
||
| #[derive(clap::Args, Debug, Serialize, Deserialize)] | ||
| pub struct Export { | ||
| #[arg(long)] | ||
| id: Option<String>, | ||
| #[arg(short, long)] | ||
| label: Option<String>, | ||
| /// Export the private key. | ||
| #[arg(long)] | ||
| private: bool, | ||
| /// Wrap the exported key a wrapping key. | ||
| #[arg(long)] | ||
| wrap: Option<String>, | ||
| // Wrapping key mechanism. Required when wrap is specified. | ||
| #[arg(long, default_value = "aes-key-wrap-pad")] | ||
| wrap_mechanism: Option<WrapPrivateKey>, | ||
| #[arg(short, long, value_enum, default_value = "der")] | ||
| format: KeyEncoding, | ||
| filename: PathBuf, | ||
| } | ||
|
|
||
| impl Export { | ||
| fn export(&self, session: &Session, object: ObjectHandle) -> Result<()> { | ||
| let map = AttributeMap::from_object(session, object)?; | ||
| let val = map.get(&AttributeType::Value).ok_or(anyhow!("Key does not contain a value"))?; | ||
| let key_value: Vec<u8> = val.try_into()?; | ||
|
||
|
|
||
| match self.format { | ||
| KeyEncoding::Der | KeyEncoding::Pkcs8Der => { | ||
| fs::write(&self.filename, &key_value)?; | ||
| } | ||
| KeyEncoding::Pem | KeyEncoding::Pkcs8Pem => { | ||
| let label = if self.private { "PRIVATE KEY" } else { "PUBLIC KEY" }; | ||
| let pem = pem_rfc7468::encode_string(label, pem_rfc7468::LineEnding::LF, &key_value)?; | ||
| fs::write(&self.filename, pem.as_bytes())?; | ||
| } | ||
| _ => return Err(anyhow!("Unsupported format for MLDSA export")), | ||
| } | ||
| Ok(()) | ||
| } | ||
|
|
||
| fn wrap_key(&self, session: &Session, object: ObjectHandle) -> Result<()> { | ||
| let wrapper: Wrap = self | ||
| .wrap_mechanism | ||
| .ok_or(anyhow!("wrap_mechanism is required when wrap is specified"))? | ||
| .into(); | ||
| let wrapped = wrapper.wrap(session, object, self.wrap.as_deref())?; | ||
| fs::write(&self.filename, &wrapped)?; | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[typetag::serde(name = "mldsa-export")] | ||
| impl Dispatch for Export { | ||
| fn run( | ||
| &self, | ||
| _context: &dyn Any, | ||
| _hsm: &Module, | ||
| session: Option<&Session>, | ||
| ) -> Result<Box<dyn erased_serde::Serialize>> { | ||
| let session = session.ok_or(HsmError::SessionRequired)?; | ||
| let mut attrs = helper::search_spec(self.id.as_deref(), self.label.as_deref())?; | ||
| attrs.push(Attribute::KeyType(KeyType::MlDsa.try_into()?)); | ||
| if self.private { | ||
| attrs.push(Attribute::Class(ObjectClass::PrivateKey.try_into()?)); | ||
| } else { | ||
| attrs.push(Attribute::Class(ObjectClass::PublicKey.try_into()?)); | ||
| } | ||
| let object = helper::find_one_object(session, &attrs)?; | ||
|
|
||
| if self.wrap.is_some() { | ||
| self.wrap_key(session, object)?; | ||
| } else { | ||
| self.export(session, object)?; | ||
| } | ||
| Ok(Box::<BasicResult>::default()) | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| // Copyright lowRISC contributors (OpenTitan project). | ||
| // Licensed under the Apache License, Version 2.0, see LICENSE for details. | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| use anyhow::{Result, anyhow}; | ||
| use const_oid::ObjectIdentifier; | ||
| use cryptoki::mechanism::vendor_defined::VendorDefinedMechanism; | ||
| use cryptoki::mechanism::Mechanism; | ||
| use cryptoki::object::Attribute; | ||
| use cryptoki::session::Session; | ||
| use der::{Encode, EncodePem}; | ||
| use serde::{Deserialize, Serialize}; | ||
| use std::any::Any; | ||
| use std::fs; | ||
| use std::path::PathBuf; | ||
| use std::str::FromStr; | ||
| use x509_cert::name::Name; | ||
| use x509_cert::request::{CertReq, CertReqInfo}; | ||
| use x509_cert::spki::{AlgorithmIdentifierOwned, SubjectPublicKeyInfoOwned}; | ||
|
|
||
| use crate::commands::{BasicResult, Dispatch}; | ||
| use crate::error::HsmError; | ||
| use crate::module::Module; | ||
| use crate::util::attribute::{AttributeMap, AttributeType, KeyType, MechanismType, ObjectClass}; | ||
| use crate::util::helper; | ||
|
|
||
| // ML-DSA-87 OID: 2.16.840.1.101.3.4.3.19 | ||
| const OID_MLDSA_87: ObjectIdentifier = ObjectIdentifier::new_unwrap("2.16.840.1.101.3.4.3.19"); | ||
|
|
||
| #[derive(clap::Args, Debug, Serialize, Deserialize)] | ||
| pub struct ExportCsr { | ||
| #[arg(long)] | ||
| id: Option<String>, | ||
| #[arg(short, long)] | ||
| label: Option<String>, | ||
| #[arg(long)] | ||
| subject: String, | ||
| #[arg(short, long)] | ||
| output: PathBuf, | ||
| } | ||
|
|
||
| impl ExportCsr { | ||
| fn run_command(&self, session: &Session) -> Result<()> { | ||
| // Find the private key | ||
| let mut attrs = helper::search_spec(self.id.as_deref(), self.label.as_deref())?; | ||
| attrs.push(Attribute::Class(ObjectClass::PrivateKey.try_into()?)); | ||
| attrs.push(Attribute::KeyType(KeyType::MlDsa.try_into()?)); | ||
| let private_key = helper::find_one_object(session, &attrs)?; | ||
|
|
||
| // Determine public key label | ||
| let pub_label_string = if let Some(l) = self.label.as_deref() { | ||
| if l.ends_with(".priv") { | ||
| Some(l.replace(".priv", ".pub")) | ||
| } else { | ||
| Some(l.to_string()) | ||
| } | ||
| } else { | ||
| None | ||
| }; | ||
| let pub_label = pub_label_string.as_deref(); | ||
|
|
||
| // Find the public key (needed for CSR) | ||
| let mut pub_attrs = helper::search_spec(self.id.as_deref(), pub_label)?; | ||
| pub_attrs.push(Attribute::Class(ObjectClass::PublicKey.try_into()?)); | ||
| pub_attrs.push(Attribute::KeyType(KeyType::MlDsa.try_into()?)); | ||
| let public_key = helper::find_one_object(session, &pub_attrs)?; | ||
|
|
||
| // Get public key value | ||
| let map = AttributeMap::from_object(session, public_key)?; | ||
| let val = map.get(&AttributeType::Value).ok_or(anyhow!("Public key does not contain a value"))?; | ||
| let pub_key_bytes: Vec<u8> = val.try_into()?; | ||
|
|
||
| // Construct Subject Name | ||
| let subject = Name::from_str(&self.subject).map_err(|e| anyhow!("Invalid subject: {}", e))?; | ||
|
|
||
| // Create CertReqInfo | ||
| let algorithm = AlgorithmIdentifierOwned { | ||
| oid: OID_MLDSA_87, | ||
| parameters: None, | ||
| }; | ||
| let subject_public_key_info = SubjectPublicKeyInfoOwned { | ||
| algorithm: algorithm.clone(), | ||
| subject_public_key: x509_cert::der::asn1::BitString::from_bytes(&pub_key_bytes) | ||
| .map_err(|e| anyhow!("Invalid public key bytes: {}", e))?, | ||
| }; | ||
|
|
||
| let info = CertReqInfo { | ||
| version: x509_cert::request::Version::V1, | ||
| subject, | ||
| public_key: subject_public_key_info, | ||
| attributes: Default::default(), | ||
| }; | ||
|
|
||
| // Serialize Info to sign | ||
| let tbs_bytes = info.to_der().map_err(|e| anyhow!("Failed to encode CertReqInfo: {}", e))?; | ||
|
|
||
| // Sign the request using HSM | ||
| // Using VendorDefinedMechanism for MLDSA signature generation | ||
| // to avoid type mismatch with native Mechanism::MlDsa if params are tricky. | ||
| let mechanism = Mechanism::VendorDefined(VendorDefinedMechanism::new::<()>( | ||
| MechanismType::MlDsa.try_into()?, | ||
| None, | ||
| )); | ||
|
|
||
| let signature_bytes = session.sign(&mechanism, private_key, &tbs_bytes) | ||
| .map_err(|e| anyhow!("HSM signing failed: {}", e))?; | ||
|
|
||
| let signature = x509_cert::der::asn1::BitString::from_bytes(&signature_bytes) | ||
| .map_err(|e| anyhow!("Invalid signature bytes: {}", e))?; | ||
|
|
||
| let cert_req = CertReq { | ||
| info, | ||
| algorithm, | ||
| signature, | ||
| }; | ||
|
|
||
| // Encode to PEM | ||
| let pem = cert_req.to_pem(Default::default()) | ||
| .map_err(|e| anyhow!("Failed to encode CSR to PEM: {}", e))?; | ||
|
|
||
| fs::write(&self.output, pem.as_bytes())?; | ||
|
|
||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[typetag::serde(name = "mldsa-export-csr")] | ||
| impl Dispatch for ExportCsr { | ||
| fn run( | ||
| &self, | ||
| _context: &dyn Any, | ||
| _hsm: &Module, | ||
| session: Option<&Session>, | ||
| ) -> Result<Box<dyn erased_serde::Serialize>> { | ||
| let session = session.ok_or(HsmError::SessionRequired)?; | ||
| self.run_command(session)?; | ||
| Ok(Box::<BasicResult>::default()) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: can you provide doc comments for each parameter?