From e91ede7cc18b45fd3653c5ebcb2baee3670cb331 Mon Sep 17 00:00:00 2001
From: Tim Trippel <ttrippel@google.com>
Date: Wed, 30 Oct 2024 14:01:10 -0700
Subject: [PATCH] [ot_certs] move CertFormat enum to ot_certs lib

This consolidates several definitions of the `CertFormat` enum, and
moves the single definition to the `ot_certs` lib where it can be shared
across the code base.

Signed-off-by: Tim Trippel <ttrippel@google.com>
---
 sw/host/opentitantool/src/command/certificate.rs | 9 ++-------
 sw/host/ot_certs/BUILD                           | 1 +
 sw/host/ot_certs/src/lib.rs                      | 9 +++++++++
 sw/host/provisioning/cert_lib/BUILD              | 1 -
 sw/host/provisioning/cert_lib/src/lib.rs         | 8 +-------
 sw/host/provisioning/ft_lib/src/lib.rs           | 3 ++-
 6 files changed, 15 insertions(+), 16 deletions(-)

diff --git a/sw/host/opentitantool/src/command/certificate.rs b/sw/host/opentitantool/src/command/certificate.rs
index 30ff42a44ddb26..8a54cbd02ac308 100644
--- a/sw/host/opentitantool/src/command/certificate.rs
+++ b/sw/host/opentitantool/src/command/certificate.rs
@@ -3,7 +3,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use anyhow::{bail, Context, Result};
-use clap::{Args, Subcommand, ValueEnum};
+use clap::{Args, Subcommand};
 use serde_annotate::Annotate;
 use std::any::Any;
 use std::fs::{self, File};
@@ -14,6 +14,7 @@ use opentitanlib::app::command::CommandDispatch;
 use opentitanlib::app::TransportWrapper;
 use ot_certs::template::subst::{Subst, SubstData};
 use ot_certs::template::Template;
+use ot_certs::CertFormat;
 use ot_certs::{codegen, x509};
 
 fn load_template(path: &PathBuf) -> Result<Template> {
@@ -44,12 +45,6 @@ pub enum CertificateCommand {
     Subst(SubstCommand),
 }
 
-/// Generate a certificate template.
-#[derive(Clone, Debug, ValueEnum)]
-pub enum CertFormat {
-    X509,
-}
-
 /// Generate a certificate template.
 #[derive(Debug, Args)]
 pub struct CodegenCommand {
diff --git a/sw/host/ot_certs/BUILD b/sw/host/ot_certs/BUILD
index bf864dc959a1bb..7db239954453d5 100644
--- a/sw/host/ot_certs/BUILD
+++ b/sw/host/ot_certs/BUILD
@@ -44,6 +44,7 @@ rust_library(
     deps = [
         "@crate_index//:anyhow",
         "@crate_index//:asn1",
+        "@crate_index//:clap",
         "@crate_index//:deser-hjson",
         "@crate_index//:heck",
         "@crate_index//:hex",
diff --git a/sw/host/ot_certs/src/lib.rs b/sw/host/ot_certs/src/lib.rs
index 8f70a4c7c2225c..87bb06ce2a985b 100644
--- a/sw/host/ot_certs/src/lib.rs
+++ b/sw/host/ot_certs/src/lib.rs
@@ -19,3 +19,12 @@ pub mod asn1;
 pub mod codegen;
 pub mod template;
 pub mod x509;
+
+use clap::ValueEnum;
+
+/// Supported OpenTitan certificate formats.
+#[derive(Clone, Debug, ValueEnum)]
+pub enum CertFormat {
+    X509,
+    // TODO(#24281): Cbor,
+}
diff --git a/sw/host/provisioning/cert_lib/BUILD b/sw/host/provisioning/cert_lib/BUILD
index b9d2c5994b464c..515b9912df50ce 100644
--- a/sw/host/provisioning/cert_lib/BUILD
+++ b/sw/host/provisioning/cert_lib/BUILD
@@ -15,7 +15,6 @@ rust_library(
         "//sw/host/ot_certs",
         "@crate_index//:anyhow",
         "@crate_index//:arrayvec",
-        "@crate_index//:clap",
         "@crate_index//:elliptic-curve",
         "@crate_index//:hex",
         "@crate_index//:log",
diff --git a/sw/host/provisioning/cert_lib/src/lib.rs b/sw/host/provisioning/cert_lib/src/lib.rs
index 7b63d094d409c5..fba023579f1ccb 100644
--- a/sw/host/provisioning/cert_lib/src/lib.rs
+++ b/sw/host/provisioning/cert_lib/src/lib.rs
@@ -7,7 +7,6 @@ use std::io::{Read, Write};
 use std::process::Command;
 
 use anyhow::{bail, Context, Result};
-use clap::ValueEnum;
 use elliptic_curve::SecretKey;
 use num_bigint_dig::BigUint;
 use openssl::ecdsa::EcdsaSig;
@@ -18,6 +17,7 @@ use opentitanlib::crypto::sha256::sha256;
 use opentitanlib::util::tmpfilename;
 use ot_certs::template::{EcdsaSignature, Signature, Value};
 use ot_certs::x509::generate_certificate_from_tbs;
+use ot_certs::CertFormat;
 
 /// Execute an openssl invocation, passing the args[] as command line parameters.
 ///
@@ -151,12 +151,6 @@ fn parse_and_endorse_x509_cert_ckms(tbs: Vec<u8>, ckms_key_id: &str) -> Result<V
     generate_certificate_from_tbs(tbs, &signature)
 }
 
-#[derive(Clone, Debug, ValueEnum)]
-pub enum CertFormat {
-    X509,
-    // TODO(#24281): Cbor,
-}
-
 pub struct HostEndorsedCert {
     pub format: CertFormat,
     pub bytes: Vec<u8>,
diff --git a/sw/host/provisioning/ft_lib/src/lib.rs b/sw/host/provisioning/ft_lib/src/lib.rs
index e93309da92950a..fa6a189cd84225 100644
--- a/sw/host/provisioning/ft_lib/src/lib.rs
+++ b/sw/host/provisioning/ft_lib/src/lib.rs
@@ -15,7 +15,7 @@ use zerocopy::AsBytes;
 
 use cert_lib::{
     get_cert_size, parse_and_endorse_x509_cert, validate_certs_chain, CertEndorsementKey,
-    CertFormat, HostEndorsedCert,
+    HostEndorsedCert,
 };
 use ft_ext_lib::ft_ext;
 use opentitanlib::app::TransportWrapper;
@@ -30,6 +30,7 @@ use opentitanlib::test_utils::load_sram_program::{
 use opentitanlib::test_utils::rpc::{ConsoleRecv, ConsoleSend};
 use opentitanlib::uart::console::UartConsole;
 use ot_certs::x509::parse_certificate;
+use ot_certs::CertFormat;
 use perso_tlv_lib::perso_tlv_get_field;
 use perso_tlv_lib::{CertHeader, CertHeaderType, ObjHeader, ObjHeaderType, ObjType};
 use ujson_lib::provisioning_data::{