.TH "GCLOUD_ALPHA_KMS_DECAPSULATE" 1



.SH "NAME"
.HP
gcloud alpha kms decapsulate \- decapsulate an input file using a key\-encapsulation key version



.SH "SYNOPSIS"
.HP
\f5gcloud alpha kms decapsulate\fR \fB\-\-ciphertext\-file\fR=\fICIPHERTEXT_FILE\fR \fB\-\-shared\-secret\-file\fR=\fISHARED_SECRET_FILE\fR [\fB\-\-key\fR=\fIKEY\fR] [\fB\-\-keyring\fR=\fIKEYRING\fR] [\fB\-\-location\fR=\fILOCATION\fR] [\fB\-\-skip\-integrity\-verification\fR] [\fB\-\-version\fR=\fIVERSION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Decapsulates the given ciphertext file using the provided
key\-encapsulation key version and saves the decapsulated shared secret to the
shared secret file.

By default, the command performs integrity verification on data sent to and
received from Cloud KMS. Use \f5\-\-skip\-integrity\-verification\fR to disable
integrity verification.



.SH "EXAMPLES"

The following command will read the file '/tmp/my/secret.file.enc', decapsulate
it using the key encapsulation CryptoKey \f5my\-key\fR Version 3 and write the
shared secret to '/tmp/my/secret.file.dec'.

.RS 2m
$ gcloud alpha kms decapsulate \-\-location=us\-central1 \e
    \-\-keyring=my\-keyring \-\-key=my\-key \-\-version=3 \e
    \-\-ciphertext\-file=/tmp/my/secret.file.enc \e
    \-\-shared\-secret\-file=/tmp/my/secret.file.dec
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-ciphertext\-file\fR=\fICIPHERTEXT_FILE\fR

File path of the ciphertext file to decapsulate.

.TP 2m
\fB\-\-shared\-secret\-file\fR=\fISHARED_SECRET_FILE\fR

File path of the shared secret file to output.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-key\fR=\fIKEY\fR

to use for decapsulation.

.TP 2m
\fB\-\-keyring\fR=\fIKEYRING\fR

Key ring of the key.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Location of the keyring.

.TP 2m
\fB\-\-skip\-integrity\-verification\fR

Skip integrity verification on request and response API fields.

.TP 2m
\fB\-\-version\fR=\fIVERSION\fR

Version to use for decapsulation.


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud kms decapsulate
.RE

.RS 2m
$ gcloud beta kms decapsulate
.RE