Changes in This Release for Oracle Key Vault
This Oracle Key Vault release introduces new features that enhance the use of Oracle Key Vault in a large enterprise.
- Changes for Oracle Key Vault Release 21.5
Oracle Key Vault release 21.5 introduces several new features that affect this guide. - Changes for Oracle Key Vault Release 21.4
Oracle Key Vault release 21.4 introduces several new features that affect this guide. - Changes for Oracle Key Vault Release 21.3
Oracle Key Vault release 21.3 introduces one new feature that affects this guide.
Changes for Oracle Key Vault Release 21.5
Oracle Key Vault release 21.5 introduces several new features that affect this guide.
- Support for Cluster Management and Monitoring using RESTful Services Utility
Starting in Oracle Key Vault release 21.5, you can deploy, manage, and monitor the multi-master cluster using RESTful services utility. - Support for System Resources Monitoring using RESTful Services Utility
Starting in Oracle Key Vault release 21.5, you can obtain the current and historical utilization metrics of the system resources such as CPU and memory using RESTful services utility. These system metrics would help you appropriately configure system resources for the Oracle Key Vault servers to meet the performance and scalability requirements of your deployment. - RESTful Services Utility Commands to Support from Nested JSON Level
Starting in Oracle Key Vault release 21.5, you can now specify custom-attributes and certain KMIP attributes as the command line options when using RESTful services utility to create, register, fetch and locate security objects. - Support for Text Output Format in RESTful Services Utility
Starting in Oracle Key Vault release 21.5, several RESTful services utility commands are enhanced to support the output in the text format.
Parent topic: Changes in This Release for Oracle Key Vault
Support for Cluster Management and Monitoring using RESTful Services Utility
Starting in Oracle Key Vault release 21.5, you can deploy, manage, and monitor the multi-master cluster using RESTful services utility.
Using the RESTful Services Utility, you can now perform several cluster management operations including creating a cluster, adding or deleting a node, enabling or disabling a node. You can also monitor and manage the cluster services and replication links between nodes using RESTful services utility.
The new commands are as follows:
okv cluster node create
okv cluster node status
okv cluster node add
okv cluster node abort-pairing
okv cluster link enable
okv cluster link disable
okv cluster node cancel-disable
okv cluster node update
okv cluster service start
okv cluster service stop
okv cluster service monitor
okv cluster link enable
okv cluster link disable
okv cluster link monitor
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.5
Support for System Resources Monitoring using RESTful Services Utility
Starting in Oracle Key Vault release 21.5, you can obtain the current and historical utilization metrics of the system resources such as CPU and memory using RESTful services utility. These system metrics would help you appropriately configure system resources for the Oracle Key Vault servers to meet the performance and scalability requirements of your deployment.
- Configured system resources (CPU and memory)
- CPU and memory utilization metrics over a specified period, including load averages
The new or updated commands are as follows:
okv metrics server get
okv server status get
okv server info get
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.5
RESTful Services Utility Commands to Support from Nested JSON Level
Starting in Oracle Key Vault release 21.5, you can now specify custom-attributes and certain KMIP attributes as the command line options when using RESTful services utility to create, register, fetch and locate security objects.
In earlier releases, commands that use the attributes or custom-attributes could only be executed using the JSON input method only. The RESTful services utility is now enhanced to support the passing of attributes and custom-attributes as the command line options for the commands to create or register security objects. These commands also support simplified variants of the complex input.
The KMIP attributes "activation date" and "deactivation date" are now exposed as
the command line options --activation-date
and
--deactivation-date
respectively. You can pass the
custom-attributes using the new command line option --custom-attribute.
Several RESTful services utility commands also support simplified and
complex format on name and custom attribute.
The following commands have been updated to accommodate this enhancement:
okv managed-object key create
okv managed-object key register
managed-object secret register
okv managed-object certificate register
okv managed-object certificate-request register
okv managed-object opaque register
okv managed-object public-key register
okv managed-object private-key register
okv managed-object object fetch
okv managed-object object locate
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.5
Support for Text Output Format in RESTful Services Utility
Starting in Oracle Key Vault release 21.5, several RESTful services utility commands are enhanced to support the output in the text format.
In previous releases, the RESTful services utility commands always produced output in the JSON format. Now, you can use the new command line option –output_format to generate the command output in the text format. The text output format helps simplify the creation of automation scripts such as when the output of a command serves as input for another command.
- json (default value)
- text
The following commands have been updated to accommodate this enhancement:
okv managed-object certificate get
okv managed-object certificate register
okv managed-object certificate-request get
okv managed-object certificate-request register
okv managed-object key create
okv managed-object key get
okv managed-object key register
okv managed-object object activate
okv managed-object object destroy
okv managed-object object locate
okv managed-object object revoke
okv managed-object opaque get
okv managed-object private-key register
okv managed-object public-key get
okv managed-object public-key register
okv managed-object secret get
okv managed-object secret register
okv managed-object wallet add-member
okv managed-object wallet delete-member
okv managed-object wallet list
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.5
Changes for Oracle Key Vault Release 21.4
Oracle Key Vault release 21.4 introduces several new features that affect this guide.
- RESTful Services Utility Commands to Support the Extractable Attribute for Symmetric Encryption Keys
Starting in Oracle Key Vault release 21.4, to strengthen the protection of symmetric keys, you now can restrict these keys from leaving Oracle Key Vault by setting the extractable attribute. - Support for Cryptographic Operations in RESTful Services Utility
Oracle Key Vault release 21.4 adds the support for performing cryptographic operations within Oracle Key Vault. - Support for Policy Based Automatic Purging of Old Oracle Key Vault Backups in RESTful Services Utility
Starting in Oracle Key Vault release 21.4, you can create a policy to schedule the removal of one or more remote backups. - Enhancements to Endpoint, Endpoint Group, and Wallet-Related RESTful Services Utility Commands
Starting in Oracle Key Vault release 21.4, additional commands are available to enable you to perform more operations with endpoints, endpoint groups, and wallets. - Support Endpoint Configuration Using the RESTful Services Utility
Starting in Oracle Key Vault release 21.4, you can update the endpoint configuration parameters and endpoint settings for keys and secrets of an endpoint using the RESTful service utility commandokv admin endpoint update
. - RESTful Commands to Set Date and Time Accommodate ISO 8601 Standard
Starting in Oracle Key Vault release 21.4, theduration
time interval settings will follow the ISO 8601 standard, and the fixed format for date and time settings are compatible with ISO 8601 when using RESTful commands. - Support for Command Line Help for the RESTful Services Utility
Starting in Oracle Key Vault release 21.4, you can find the command line help information about the RESTful services utility commands.
Parent topic: Changes in This Release for Oracle Key Vault
RESTful Services Utility Commands to Support the Extractable Attribute for Symmetric Encryption Keys
Starting in Oracle Key Vault release 21.4, to strengthen the protection of symmetric keys, you now can restrict these keys from leaving Oracle Key Vault by setting the extractable attribute.
The following commands have been updated to accommodate this enhancement:
okv managed-object attribute get
okv managed-object attribute get-all
okv managed-object attribute list
okv managed-object attribute modify
okv managed-object key create
okv managed-object key register
okv managed-object object locate
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.4
Support for Cryptographic Operations in RESTful Services Utility
Oracle Key Vault release 21.4 adds the support for performing cryptographic operations within Oracle Key Vault.
You can use either RESTful services utility commands or C and Java SDK to perform encryption and decryption operations.
This enhancement accommodates the use of symmetric keys that have been configured to not be extracted from Oracle Key Vault.
The new commands are as follows:
okv crypto data decrypt
okv crypto data encrypt
Parent topic: Changes for Oracle Key Vault Release 21.4
Support for Policy Based Automatic Purging of Old Oracle Key Vault Backups in RESTful Services Utility
Starting in Oracle Key Vault release 21.4, you can create a policy to schedule the removal of one or more remote backups.
The following commands have been updated:
okv backup destination create
okv backup destination update
The following commands are new:
okv backup destination delete-backup
okv backup destination-policy create
okv backup destination-policy delete
okv backup destination-policy get
okv backup destination-policy list
okv backup destination-policy list-purged-backups
okv backup destination-policy update
okv backup destination resume-policy
okv backup destination suspend-policy
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.4
Enhancements to Endpoint, Endpoint Group, and Wallet-Related RESTful Services Utility Commands
Starting in Oracle Key Vault release 21.4, additional commands are available to enable you to perform more operations with endpoints, endpoint groups, and wallets.
The new commands are as follows:
okv admin endpoint get
okv admin endpoint list
okv admin endpoint list-objects
okv admin endpoint resume
okv admin endpoint suspend
okv manage-access endpoint-group get
okv manage-access endpoint-group list
okv manage-access wallet add-object
okv manage-access wallet get
okv manage-access wallet list
okv manage-access wallet list-objects
okv manage-access wallet remove-object
The commands to list objects for an endpoint (okv admin endpoint list-objects
) and a wallet (okv admin wallet list-objects
) provide an option to show or hide the wallet membership of the objects. Omitting wallet membership information of objects can improve command's performance.
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.4
Support Endpoint Configuration Using the RESTful Services Utility
Starting in Oracle Key Vault release 21.4, you can update the endpoint configuration parameters and endpoint settings for keys and secrets of an endpoint using the RESTful service utility command okv admin endpoint update
.
The endpoint configuration parameters includes various PKCS#11 settings and endpoint settings for keys and secrets includes the extractable
attribute setting for the new symmetric keys.
RESTful Commands to Set Date and Time Accommodate ISO 8601 Standard
Starting in Oracle Key Vault release 21.4, the duration
time interval settings will follow the ISO 8601 standard, and the fixed format for date and time settings are compatible with ISO 8601 when using RESTful commands.
You can specify the following formats:
duration
(follows the ISO 8601 standard)timestamp
(is in a format that is compatible with the ISO 8601 standard)now
(represents the current time when a command is run)
You can use these formats in the following combinations:
timestamp
now
timestamp
+duration
now
+duration
The timestamp
format that has been used in previous releases is still supported.
The following commands have been updated for this enhancement:
okv backup schedule create
okv backup schedule update
okv managed-object attribute add
okv managed-object attribute delete
okv managed-object attribute modify
okv managed-object certificate-request register
okv managed-object key register
okv managed-object object locate
okv managed-object opaque register
okv managed-object private_key register
okv managed-object public-key register
okv managed-object secret register
Support for Command Line Help for the RESTful Services Utility
Starting in Oracle Key Vault release 21.4, you can find the command line help information about the RESTful services utility commands.
This enhancement enables you to find the detailed help information about the various categories, resources, and actions that are supported for all Oracle Key Vault RESTful services utility commands. The help information shows the command's syntax, and definitions for the available categories, resources, and actions as well as the configuration parameters that are applicable to all the commands.
Parent topic: Changes for Oracle Key Vault Release 21.4
Changes for Oracle Key Vault Release 21.3
Oracle Key Vault release 21.3 introduces one new feature that affects this guide.
- Enhancements for RESTful Services Utility Commands Used for Registration
In Oracle Key Vault release 21.3, RESTful services utility commands that are used for the registration of managed objects will have additional attributes.
Parent topic: Changes in This Release for Oracle Key Vault
Enhancements for RESTful Services Utility Commands Used for Registration
In Oracle Key Vault release 21.3, RESTful services utility commands that are used for the registration of managed objects will have additional attributes.
The affected commands are as follows:
okv managed-object certificate register
okv managed-object certificate-request register
okv managed-object key register
okv managed-object opaque register
okv managed-object private-key register
okv managed-object public-key register
okv managed-object secret register
In previous releases, these commands provided two attributes, name
and contactInfo
. In this release, in addition to these two attributes, the following new attributes are included:
activationDate
deactivationDate
processStartDate
protectStopDate
Related Topics
Parent topic: Changes for Oracle Key Vault Release 21.3