cosmian_kms_cli 5.20.0

Command Line Interface used to manage the KMS server If any assistance is needed, please either visit the Cosmian technical documentation at https://docs.cosmian.com or contact the Cosmian support team on Discord https://discord.com/invite/7kPMNtHpnz
Documentation
#[cfg(feature = "non-fips")]
use std::path::PathBuf;

#[cfg(feature = "non-fips")]
use cosmian_kms_client::{
    cosmian_kmip::kmip_2_1::kmip_types::CryptographicAlgorithm,
    kmip_2_1::kmip_types::UniqueIdentifier, read_object_from_json_ttlv_file,
};
#[cfg(feature = "non-fips")]
use cosmian_logger::log_init;
#[cfg(feature = "non-fips")]
use test_kms_server::start_default_test_kms_server;

#[cfg(feature = "non-fips")]
use crate::actions::kms::{
    cover_crypt::keys::create_key_pair::CreateMasterKeyPairAction,
    elliptic_curves::keys::create_key_pair::CreateKeyPairAction as CreateEcKeyPairAction,
    symmetric::keys::create_key::CreateKeyAction,
};
#[cfg(feature = "non-fips")]
use crate::{
    actions::kms::shared::{ExportSecretDataOrKeyAction, ImportSecretDataOrKeyAction},
    error::{KmsCliError, result::KmsCliResult},
};

#[cfg(feature = "non-fips")]
#[tokio::test]
pub(crate) async fn test_import_cover_crypt() -> KmsCliResult<()> {
    use tempfile::TempDir;

    let ctx = start_default_test_kms_server().await;

    // generate a new master key pair
    let (_master_secret_key_id, master_public_key_id) = {
        let action = CreateMasterKeyPairAction {
            specification: PathBuf::from("../../test_data/access_structure_specifications.json"),
            tags: vec![],
            sensitive: false,
            wrapping_key_id: None,
        };
        let key_ids = Box::pin(action.run(ctx.get_owner_client())).await?;
        (key_ids.0.to_string(), key_ids.1.to_string())
    };

    // create a temp dir
    let tmp_dir = TempDir::new()?;
    let tmp_path = tmp_dir.path();
    let public_key_path = format!("{}", tmp_path.join("public_key.json").display());

    ExportSecretDataOrKeyAction {
        key_id: Some(master_public_key_id.clone()),
        key_file: PathBuf::from(&public_key_path),
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?;

    // reimporting the same key with the same id should fail
    ImportSecretDataOrKeyAction {
        key_file: PathBuf::from(&public_key_path.clone()),
        key_id: Some(master_public_key_id.clone()),
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await
    .unwrap_err();

    //...unless we force it with replace_existing
    let master_public_key_id_: String = ImportSecretDataOrKeyAction {
        key_file: PathBuf::from(&public_key_path.clone()),
        replace_existing: true,
        key_id: Some(master_public_key_id.clone()),
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?
    .to_string();
    assert_eq!(master_public_key_id_, master_public_key_id);

    Ok(())
}

#[cfg(feature = "non-fips")]
#[tokio::test]
pub(crate) async fn test_generate_export_import() -> KmsCliResult<()> {
    log_init(option_env!("RUST_LOG"));
    // log_init(Some("info,cosmian_kms_server=debug"));

    let ctx = start_default_test_kms_server().await;

    // Covercrypt import/export test
    let (private_key_id, _public_key_id) = {
        let action = CreateMasterKeyPairAction {
            specification: PathBuf::from("../../test_data/access_structure_specifications.json"),
            tags: vec![],
            sensitive: false,
            wrapping_key_id: None,
        };
        let key_ids = Box::pin(action.run(ctx.get_owner_client())).await?;
        (key_ids.0, key_ids.1)
    };
    Box::pin(export_import_test(
        &private_key_id,
        Some(CryptographicAlgorithm::CoverCrypt),
    ))
    .await?;

    // Test import/export of an EC Key Pair
    let (private_key_id, _public_key_id) = CreateEcKeyPairAction::default()
        .run(ctx.get_owner_client())
        .await?;
    Box::pin(export_import_test(
        &private_key_id,
        Some(CryptographicAlgorithm::ECDH),
    ))
    .await?;

    // generate a symmetric key
    let key_id = CreateKeyAction::default()
        .run(ctx.get_owner_client())
        .await?;
    Box::pin(export_import_test(
        &key_id,
        Some(CryptographicAlgorithm::AES),
    ))
    .await?;

    // generate a secret data
    let secret_id =
        crate::actions::kms::secret_data::create_secret::CreateSecretDataAction::default()
            .run(ctx.get_owner_client())
            .await?;
    Box::pin(export_import_test(&secret_id, None)).await?;

    Ok(())
}

#[cfg(feature = "non-fips")]
pub(crate) async fn export_import_test(
    private_key_id: &UniqueIdentifier,
    algorithm: Option<CryptographicAlgorithm>,
) -> KmsCliResult<()> {
    use tempfile::TempDir;

    let ctx = start_default_test_kms_server().await;

    // Create a temp dir
    let tmp_dir = TempDir::new()?;
    let tmp_path = tmp_dir.path();
    let output_export = tmp_path.join("output.export");
    let output2_export = tmp_path.join("output2.export");

    // Export
    ExportSecretDataOrKeyAction {
        key_id: Some(private_key_id.to_string()),
        key_file: output_export.clone(),
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?;

    let object = read_object_from_json_ttlv_file(&output_export)?;
    let key_bytes = match algorithm {
        None => object.key_block()?.secret_data_bytes()?,
        Some(CryptographicAlgorithm::AES) => object.key_block()?.key_bytes()?,
        Some(CryptographicAlgorithm::ECDH) => object.key_block()?.ec_raw_bytes()?,
        Some(CryptographicAlgorithm::CoverCrypt) => object.key_block()?.covercrypt_key_bytes()?,
        x => {
            return Err(KmsCliError::Default(format!(
                "unsupported algorithm for export: {x:?}"
            )));
        }
    };

    // import and re-export
    let uid: String = ImportSecretDataOrKeyAction {
        key_file: output_export,
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?
    .to_string();

    ExportSecretDataOrKeyAction {
        key_id: Some(uid),
        key_file: output2_export.clone(),
        ..Default::default()
    }
    .run(ctx.get_owner_client())
    .await?;
    let object2 = read_object_from_json_ttlv_file(&output2_export)?;
    let object2_key_bytes = match algorithm {
        None => object.key_block()?.secret_data_bytes()?,
        Some(CryptographicAlgorithm::AES) => object2.key_block()?.key_bytes()?,
        Some(CryptographicAlgorithm::ECDH) => object2.key_block()?.ec_raw_bytes()?,
        Some(CryptographicAlgorithm::CoverCrypt) => object2.key_block()?.covercrypt_key_bytes()?,
        x => {
            return Err(KmsCliError::Default(format!(
                "unsupported algorithm for export: {x:?}"
            )));
        }
    };
    assert_eq!(object2_key_bytes, key_bytes);
    assert_eq!(object2.key_block()?.cryptographic_algorithm, algorithm);
    assert!(object2.key_block()?.key_wrapping_data.is_none());

    Ok(())
}