"export"
********

* Description

* Usage

* Required Parameters

* Optional Parameters

* Global Parameters

* Examples


Description
===========

Exports a specific version of a master encryption key according to the
details of the request. For their protection, keys that you create and
store on a hardware security module (HSM) can never leave the HSM. You
can only export keys stored on the server. For export, the key version
is encrypted by an RSA public key that you provide.

The top level –endpoint parameter must be supplied for this operation.


Usage
=====

   oci kms crypto key export [OPTIONS]


Required Parameters
===================

--algorithm [text]

The encryption algorithm to use to encrypt exportable key material
from a software-backed key. Specifying *RSA_OAEP_AES_SHA256* invokes
the RSA AES key wrap mechanism, which generates a temporary AES key.
The temporary AES key is wrapped by the RSA public wrapping key
provided along with the request, creating a wrapped temporary AES key.
The temporary AES key is also used to wrap the exportable key
material. The wrapped temporary AES key and the wrapped exportable key
material are concatenated, producing concatenated blob output that
jointly represents them. Specifying *RSA_OAEP_SHA256* means that the
software key is wrapped by the RSA public wrapping key provided along
with the request.

Accepted values are:

   RSA_OAEP_AES_SHA256, RSA_OAEP_SHA256

--key-id [text]

The OCID of the master encryption key associated with the key version
you want to export.

--public-key [text]

The PEM format of the 2048-bit, 3072-bit, or 4096-bit RSA wrapping key
in your possession that you want to use to encrypt the key.


Optional Parameters
===================

--from-json [text]

Provide input to this command as a JSON document from a file using the
file://path-to/file syntax.

The "--generate-full-command-json-input" option can be used to
generate a sample json file to be used with this command option. The
key names are pre-populated and match the command option names
(converted to camelCase format, e.g. compartment-id –> compartmentId),
while the values of the keys need to be populated by the user before
using the sample file as an input to this command. For any command
option that accepts multiple values, the value of the key can be a
JSON array.

Options can still be provided on the command line. If an option exists
in both the JSON document and the command line then the command line
specified value will be used.

For examples on usage of this option, please see our “using CLI with
advanced JSON options” link: https://docs.cloud.oracle.com/iaas/Conte
nt/API/SDKDocs/cliusing.htm#AdvancedJSONOptions

--key-version-id [text]

The OCID of the specific key version to export. If not specified, the
service exports the current key version.

--logging-context [complex type]

Information that provides context for audit logging. You can provide
this additional data as key-value pairs to include in the audit logs
when audit logging is enabled. This is a complex type whose value must
be valid JSON. The value can be provided as a string on the command
line or passed in as a file using the file://path/to/file syntax.

The "--generate-param-json-input" option can be used to generate an
example of the JSON which must be provided. We recommend storing this
example in a file, modifying it as needed and then passing it back in
via the file:// syntax.


Global Parameters
=================

Use "oci --help" for help on global parameters.

"--auth-purpose", "--auth", "--cert-bundle", "--cli-rc-file", "--
config-file", "--debug", "--defaults-file", "--endpoint", "--generate-
full-command-json-input", "--generate-param-json-input", "--help", "--
latest-version", "--max-retries", "--no-retry", "--opc-client-request-
id", "--opc-request-id", "--output", "--profile", "--query", "--raw-
output", "--region", "--release-info", "--request-id", "--version",
"-?", "-d", "-h", "-v"


Examples
========

Copy and paste the following example into a JSON file, replacing the
example parameters with your own.

       oci kms management key create --generate-param-json-input key-shape > key-shape.json

Copy the following CLI commands into a file named example.sh. Run the
command by typing “bash example.sh” and replacing the example
parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-
like shell. You need to set up the OCI configuration and appropriate
security policies before trying the examples.

       export compartment_id=<substitute-value-of-compartment_id> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-compartment-id
       export display_name=<substitute-value-of-display_name> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/management/key/create.html#cmdoption-display-name
       export algorithm=<substitute-value-of-algorithm> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/crypto/key/export.html#cmdoption-algorithm
       export public_key=<substitute-value-of-public_key> # https://docs.cloud.oracle.com/en-us/iaas/tools/oci-cli/latest/oci_cli_docs/cmdref/kms/crypto/key/export.html#cmdoption-public-key

       key_id=$(oci kms management key create --compartment-id $compartment_id --display-name $display_name --endpoint https://region.domain.com --key-shape file://key-shape.json --query data.id --raw-output)

       oci kms crypto key export --algorithm $algorithm --key-id $key_id --public-key $public_key
