'\" t
.\"     Title: nvme-keys-check-kxchap-secret
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/18/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-KEYS\-CHECK\-K" "1" "09/18/2026" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-keys-check-kxchap-secret \- Check a host KX\-HMAC\-CHAP secret
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIkeys check\-kxchap\-secret\fR [\-\-keydata=<secret> | \-d <secret>]
                        [\-\-keyring=<name> | \-k <name>]
                        [\-\-keytype=<type> | \-t <type>]
                        [\-\-identity=<identity> | \-i <identity>]
.fi
.SH "DESCRIPTION"
.sp
Checks if the given string is a valid KX\-HMAC\-CHAP host secret of the form: DHHC\-1:00:ia6zGodOr4SEG0Zzaw398rpY0wqipUWj4jWjUh4HWUz6aQ2n: and prints the hash algorithm it records, the secret length, and the CRC\&.
.sp
If \fI\-\-keydata\fR is not given the secret is read from stdin, which also allows checking a secret stored in a file, e\&.g\&. \fInvme keys check\-kxchap\-secret < keyfile\fR\&.
.sp
If \fI\-\-identity\fR is given the specified keyring is also checked for a secret already stored under that identity (as inserted by \fBnvme-keys-import\fR(1)); the result (not loaded, loaded and matching, or loaded but different) is reported\&. This command never modifies the keyring\&.
.sp
Looking up a secret requires the \fIkxchap\fR keyring key type, which is not yet provided by any released Linux kernel; see \fBnvme-keys-import\fR(1) for details\&.
.SH "OPTIONS"
.PP
\-d <secret>, \-\-keydata=<secret>
.RS 4
Secret to be checked\&. If not given, the secret is read from stdin\&.
.RE
.PP
\-k <name>, \-\-keyring=<name>
.RS 4
Name of the keyring to check for an already loaded secret\&. Default is
\fI\&.nvme\fR\&.
.RE
.PP
\-t <type>, \-\-keytype=<type>
.RS 4
Key type of the secret to look up\&. Default is
\fIkxchap\fR\&.
.RE
.PP
\-i <identity>, \-\-identity=<identity>
.RS 4
Identity to look up in the keyring to check if the secret is already loaded\&. If not given, only the secret format is validated\&.
.RE
.SH "GLOBAL OPTIONS"
.sp
The following options are defined at the top\-level nvme command and are available to this subcommand:
.PP
\-\-dry\-run
.RS 4
Print the command that would be executed, but do not actually execute it\&.
.RE
.PP
\-\-no\-ioctl\-probing
.RS 4
Disable probing for 64\-bit IOCTL support\&.
.RE
.PP
\-\-no\-retries
.RS 4
Disable retry logic on transient errors\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fItabular, \*(Aqjson\fR, or
\fIbinary\fR\&. Only one output format may be used at a time\&.
.RE
.PP
\-\-output\-format\-version=<version>
.RS 4
Select the output format version\&. Version
\fI1\fR
uses the original field naming, while version
\fI2\fR
(default) provides more consistent and script\-friendly field names\&.
.RE
.PP
\-\-timeout=<ms>
.RS 4
Set the timeout for the command in milliseconds\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
.RE
.sp
These options can also be set as machine\-wide defaults in nvme\-cli\&.conf(5)\&. A command\-line flag always overrides the file\&.
.SH "EXAMPLES"
.sp
No Examples
.SH "NVME"
.sp
Part of the nvme\-user suite