SAM Peering Interface: Delete Signer Key Pair | Utimaco Integration Guides

The following figure shows an overview of the process of deleting a key pair of a Signer by the SAM service.

Figure 20: Overview of the Delete_Signer_Key_Pair operation flow

A Privileged User or Signer uses the SAM peer interface to request the operation. Authentication and identification of the requesting user is required beforehand.

When the request is retrieved, the SAM service verifies that the requestor is authenticated and identified (based on the processes and configuration shown above).

If the authenticity and identity check is successful, the SAM service deletes the Signer key pair referenced by the data it received through the request. More specifically, the SAM service requests the deletion of the Wrapped Key associated with the Signer key pair to be deleted from the KM. Otherwise, an error is returned.

Since Wrapped Keys do not contain keys in plaintext, they do not require any further destruction method.

Purpose	This operation is invoked by the requestor to delete a Signer key pair.
Interface	SAM Peer Interface (see [IF_SPI])
Method of use	The operation is called by client software according to the SAM peer interface specification (see [IF_SPI]).
Inputs	Parameter	Typ	Description
	keyid	String	The ID of the key to be deleted
Output	Parameter	Typ	Description
		void	A result without error indicates a positive operation.
Error Messages	Typ		Reason
	ContainerParseError		If the input cannot be parsed into a message container
	MessageParseError		If the input data cannot be parsed into the specified message type
	UnknownMessageType		The contained message type was not known to the processor.
	UnknownCredentialType		The credential type included was not known to the processor.
	AuthenticationError		The credential could not be validated.
	UnknownUser		The credential could not be associated with a user.

	NotAuthorized	If the acting user is not authorized to perform the current operation If the acting user does not have access to the specified KeyID
	NotOperational	A component (i.e. database, HSM) is not available or not in an operative state.
	UnexpectedError	When an error condition occurs that was not anticipated
	NotFound	Wenn kein Schlüssel für die eingegebene keyid existiert
Security Audit Log Entry	In case of success An audit record is created that contains at least the following information the acting UserID the timestamp of the action the name of the action that the action was successful the UserID for which the key was removed the KeyID of the key pair that was deleted In case of an error The following errors issue regular log messages, but no audit log entries (since no acting user could be inferred): ContainerParseError UnknownCredentialType AuthenticationError UnknownUser Otherwise An audit record is created containing at least the following information the acting UserID the timestamp of the action the name of the action that the action failed a brief description of the cause of the failure

Table 21: Description of Delete_Signer_Key_Pair operation