Use Change Cipher Mode REST Service to enable the Galois/Counter Mode
(GCM) encryption mode to secure data that is protected by the IBM Guardium Key Lifecycle Manager master key. The default encryption mode is Cipher
Block Chaining (CBC).
- Operation
POST- URL
- https://host:port/GKLM/rest/v1/ckms/masterKey/cipherMode
By default, IBM® Guardium Key Lifecycle Manager server
listens to the secure port 9443 (HTTPS) for communication.
During IBM Guardium Key Lifecycle Manager installation, you can modify this
default port.
Request Parameters
| Parameter |
Description |
| host |
Specify the IP address or hostname of the IBM Guardium Key Lifecycle Manager server. |
| port |
Specify the port number on which the IBM Guardium Key Lifecycle Manager server listens for requests. |
Request Headers
| Header name |
Value |
| Content-Type |
application/json |
| Accept |
application/json |
| Authorization |
SKLMAuth userAuthId=<authIdValue> |
| Accept-Language |
Any valid locale that is supported by IBM Guardium Key Lifecycle Manager. For example, en or
de. |
Request Body
JSON object with the following specification:
| JSON property name |
Description |
| gcmEnabled |
Specify true if you want to enable the GCM encryption mode. The
default encryption mode is CBC. |
Response Headers
| Header name |
Value and description |
| Status Code |
- 200 OK
- The request was successful. The response body contains the requested representation.
- 400 Bad Request
- The authentication information was not provided in the correct format.
- 401 Unauthorized
- The authentication credentials were missing or incorrect.
- 404 Not Found Error
- The processing of the request fails.
- 500 Internal Server Error
- The processing of the request fails because of an unexpected condition on the server.
|
| Content-Type |
application/json |
| Content-Language |
Locale for the response message. |
Success response body
JSON object with the following specification:
| JSON property name |
Description |
| code |
Returns the code that is specified by the status
property. |
| status |
Returns the status to indicate whether the operation was successful. |
Error Response Body
JSON object with the following specification.
| JSON property name |
Description |
| code |
Returns the application error code. |
| message |
Returns a message that describes the error. |
Examples
- Service request to change the encryption mode to GCM
-
POST https://localhost:port/GKLM/rest/v1/ckms/masterKey/cipherMode
{"gcmEnabled" : "true"}
Content-Type: application/json
Accept : application/json
Authorization: SKLMAuth userAuthId=4259b494-9cb2-4414-87b4-9a17b9f916c7
Accept-Language : en
- Success response
-
{
"code": "CTGKM7326I",
"status": "CTGKM7326I Changed the cipher mode to GCM successfully."
}
- Error response
-
{
"code": "CTGKM7323E",
"message": "CTGKM7323E The GCM cipher mode is already enabled."
}