Verifying a Digital Signature

The post /v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/asymmetric-verify API verifies a digital signature generated using an asymmetric key stored in a keystore on CipherTrust Manager. The key specified in the key_id path variable MUST be an asymmetric key with SIGN and VERIFY attributes.

The asymmetric verify API accepts the signature and verifies it using the specified algorithm. The message, message type, algorithm and key version ID must be the same as used to generate the signature, otherwise, the signature verification fails.

Request Parameters

Parameter	Type	Description
signature	string	The signature to be verified.
message	string	Message or message digest to sign. The maximum length of the message is 4096 bytes.
message_type	string	The type of the message. It can be `RAW` or `DIGEST`.
algorithm	string	The algorithm of signing. It can be `RSASSA_PSS_SHA_256`, `RSASSA_PSS_SHA_384`, or `RSASSA_PSS_SHA_512`.
key_version_id	string	ID of the key version.
sap_tenant_id	string	ID of the SAP Tenant.

Example Request

post https://<Host IP Address>/api/v1/cckm/sap/hyok/v1/keystores/{keystore_id}/keys/{external_key_id}/asymmetric-verify
<authorization token and other headers>
{
    "signature": "YTQzZDRmNzgxYTExYjIxZjgxNWJiNjc4OWU4ZmMyODRlYmM2NzA2MWI1ZDc0MDVjNWJlOTdjZDc2NzJhZWNjZTU4ZDljY2VkZDc1NzhhNWM3ODhkNDczZjE2ZWU0M2U4MTAyMmU0ZTcxZGNjMjcyZTBkNjVjYTM3MzljZGRjNmZiMjAyYTQxYTgzMzFkYTA2MGM3M2YzN2FmYWExOTYwOTcyZGNmZjViYzI5NzJiZjNjNTg0ZDdlY2Y1YzcwZGU4ZjcxOWRjYWZiMmQxOTNlZjI0ODFhY2JiZTEyYTVmMTUwMzk0OTYwNTk0ZTZlMDYzZDZkMDQxNmFiZGRlYTE1ZWQyNTI5ZjhjZDc5OGQyYTk4MTQ0ZmM3ZGQ4ZmQ5MzM2ZjU0MmRiYzI5MGRiZGRiNTJjODZlYWQ5MTJlMTc0ZDMyMDZjZTY2MWM4MmVlOGZjMzVjNjk2NmIzODZiOTdiMmM3NjU0MWEwNGIyZmQ2ODRlNzAwYjM3ZjFlNzQwNzNlMzNhMjQ4NjUzOTc0M2E2OTBlMzM4NmI3MTEyYjk2Y2NjOGQ1Zjk3N2UxNjAyMmM5ZjRmMTQ0YjdmMWRlOGE1OTJjMjQwZDcwMDVjNGM4OTczYzE3MmM4ZTIxMDA2MDFlY2U2ODYzYmYyYmE1YTI0NWY0YzMzMDk5MjAyNDBiMmFhOWYxNzY4MWQ5OWM2ZTU5ZTU5M2VhMzkxNDVkZDQxOTI1Y2NmM2VlMDdlN2I1OGJkZDY5YTg2YTliNzgxM2I5OTkwMGU2ZTVjMTViZDg1M2FmYjgzYjAxYzg1Y2YwNWRiMTdlMzBhOGYyMjYwYjA2MDE1MjA2Y2M2ZTc0OWZjYzQyOWIyZjFlNmIyMmEyZGJmYWZkNWRlMTZmZjNlODc4OTM3YmQyM2NiNGQ1Mjg5NmVkN2Y3MWRhY2FkZTNjYjQ0ZDk2MTU1YmFlZjc4Yjk2MTIxZTE0YTg0Mjg3OWU2ZmRhZGFlYzZjYmQzNThkZjRhOTlkYjk4ZjViMGUyMTU1OWQwN2FkYTNiYmJiNjllY2U4NjM4MTAzNWFmMmU5NzUzNTljMDczY2JiZDI3M2UxNWE3N2Q3Y2ZiMDNkZDZiNmRlZmY2ODFhYzI1N2FlY2VhMWQ3MjBlNjc4NGYyMjFkNmJkYmRkMTllOTNmM2RiYzQ0MmFlMTJlOTBjZmY1YjQ4MGZhMzE3Y2JiYTA0NjBhMmQwODQ2ZjRlN2YyM2ZhMzM3Zjc3MDQ0MGJkODI1MjdmMWRjYTZhNzNiYTY2ZGNiYTI3NzA0YWRmYWEwYTY0MWQwYWNhZTFkMTUyYWQzZmViZTAzNDdhOTE2NTUyOGZiZDFmZDNmNDYxYTQwODdjMw==",
    "message": "MDcxNjM4ZDI2ZmZjZjNhMzA2ZmI1M2UwNGZmOWFhNGUxZjg0OWZlZWYwZTIzYTk2YzUyMDhmYTg4NjlkMzBjYzI0NWRjNmIxZWRhOGE3ODBjODNkYzRmZDhlZWMxMGUxYWIxMjEwNTcyMzUzZjZlNWVjMzZmZDZlMmY1YjdlZTQ=",
    "message_type": "DIGEST",
    "algorithm": "RSASSA_PSS_SHA_512",
    "key_version_id": "56358acc-a1c8-4de1-b8c7-8de9adbe71e7"
    "request_metadata": {
        "sap_tenant_id": "86428acc-a1c8-6de1-b8f7-8de9a436gdr3"
    }
}

Example Response

{
    "signature_valid": true
}

Response Codes

Response Code	Description
200	Ok
400	Bad request
401	Unauthorized
404	Not found
403	Forbidden
500	Internal server error

Refer to HTTP status codes for details.

Verifying a Digital Signature

Request Parameters

Example Request

Example Response

Response Codes

On this page

Suggest A Change