.\" Man page generated from reStructuredText.
.
.TH "XBCRYPT" "1" "Nov 30, 2023" "8.0" "Percona XtraBackup"
.SH NAME
xbcrypt \- Percona xbcrypt Documentation
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.sp
To support encryption and decryption of the backups, a new tool \fBxbcrypt\fP was
introduced to \fIPercona XtraBackup\fP\&.
.sp
\fBPercona XtraBackup\fP 8.0.28\-20 implements the XBCRYPT_ENCRYPTION_KEY environment variable. The variable is only used in place of the \fB\-\-encrypt_key=name\fP option. You can use the environment variable or command line option. If you use both, the command line option takes precedence over the value specified in the environment variable.
.sp
This utility has been modeled after xbstream_binary to perform
encryption and decryption outside of \fIPercona XtraBackup\fP\&. \fBxbcrypt\fP has
following command line options:
.INDENT 0.0
.TP
.B \-d, \-\-decrypt
Decrypt data input to output.
.UNINDENT
.INDENT 0.0
.TP
.B \-i, \-\-input=name
Optional input file. If not specified, input will be read from standard
input.
.UNINDENT
.INDENT 0.0
.TP
.B \-o, \-\-output=name
Optional output file. If not specified, output will be written to standard
output.
.UNINDENT
.INDENT 0.0
.TP
.B \-a, \-\-encrypt\-algo=name
Encryption algorithm.
.UNINDENT
.INDENT 0.0
.TP
.B \-k, \-\-encrypt\-key=name
Encryption key.
.UNINDENT
.INDENT 0.0
.TP
.B \-f, \-\-encrypt\-key\-file=name
File which contains encryption key.
.UNINDENT
.INDENT 0.0
.TP
.B \-s, \-\-encrypt\-chunk\-size=#
Size of working buffer for encryption in bytes. The default value is 64K.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-encrypt\-threads=#
This option specifies the number of worker threads that will be used for
parallel encryption/decryption.
.UNINDENT
.INDENT 0.0
.TP
.B \-v, \-\-verbose
Display verbose status output.
.UNINDENT
.SH AUTHOR
Percona LLC and/or its affiliates
.SH COPYRIGHT
2009-2022, Percona LLC and/or its affiliates
.\" Generated by docutils manpage writer.
.