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 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89

use clap::Parser;
use cosmian_kms_client::{
    KmsClient,
    cosmian_kmip::kmip_2_1::kmip_types::UniqueIdentifier,
    kmip_2_1::{
        kmip_attributes::Attribute,
        kmip_operations::{ModifyAttribute, ModifyAttributeResponse},
    },
};
use cosmian_logger::{info, trace};

use super::set::SetOrDeleteAttributes;
use crate::{
    actions::kms::{console, labels::ATTRIBUTE_ID, shared::get_key_uid},
    cli_bail,
    error::result::KmsCliResult,
};

/// Modify existing KMIP object attributes.
///
/// The `ModifyAttribute` operation replaces the value of an attribute that
/// already exists on a managed object.  Unlike `SetAttribute`, it does not
/// create the attribute if it is absent.
///
/// A notable side-effect: setting an `activation_date` that is ≤ the current
/// time on a *Pre-Active* object will automatically transition the object to
/// the *Active* state (KMIP spec §3.22).
#[derive(Parser, Debug)]
#[clap(verbatim_doc_comment)]
pub struct ModifyAttributesAction {
    #[clap(flatten)]
    pub(crate) requested_attributes: SetOrDeleteAttributes,
}

impl ModifyAttributesAction {
    pub(crate) async fn modify_attribute(
        &self,
        kms_rest_client: &KmsClient,
        id: &str,
        attribute: Attribute,
    ) -> KmsCliResult<()> {
        let uid = UniqueIdentifier::TextString(id.to_owned());
        let ModifyAttributeResponse {
            unique_identifier, ..
        } = kms_rest_client
            .modify_attribute(ModifyAttribute {
                unique_identifier: Some(uid.clone()),
                new_attribute: attribute.clone(),
            })
            .await?;
        let effective_uid = unique_identifier.unwrap_or(uid);
        info!("ModifyAttributes response for {effective_uid}: {attribute}");
        let mut stdout = console::Stdout::new("Attribute modified successfully");
        stdout.set_tags(self.requested_attributes.tags.as_ref());
        stdout.set_unique_identifier(&effective_uid);
        stdout.set_attribute(attribute);
        stdout.write()?;
        Ok(())
    }

    /// Processes the `ModifyAttributes` action.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - Neither `--id` nor `--tag` is specified.
    /// - No attribute to modify is specified.
    /// - The server rejects the modification.
    pub async fn process(&self, kms_rest_client: KmsClient) -> KmsCliResult<()> {
        trace!("{self:?}");
        let id = get_key_uid(
            self.requested_attributes.id.as_ref(),
            self.requested_attributes.tags.as_ref(),
            ATTRIBUTE_ID,
        )?;

        let attributes_to_modify = self.requested_attributes.get_attributes_from_args()?;
        if attributes_to_modify.is_empty() {
            cli_bail!("No attribute specified")
        }

        for attribute in attributes_to_modify {
            self.modify_attribute(&kms_rest_client, &id, attribute)
                .await?;
        }

        Ok(())
    }
}