'\" t
.\"     Title: nvme-tls-key
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net>
.\"      Date: 02/16/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: Persian
.\"
.TH "NVME\-TLS\-KEY" "1" "02/16/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\-tls\-key \- مدیریت و تولید کلیدهای امنیتی TLS برای NVMe-oF
.SH "خلاصه دستور (SYNOPSIS)"
.sp
.nf
\fInvme tls\-key\fR [\-\-keyring=<name> | \-k <name>]
                        [\-\-keytype=<type> | \-t <type>]
                        [\-\-keyfile=<file> | \-f <file>]
                        [\-\-import | \-i] [\-\-export | \-e]
                        [\-\-revoke=<description>| \-r <description>]
                        [\-\-verbose | \-v]
.fi
.SH "توضیحات (DESCRIPTION)"
.sp
وارد کردن (Import)، صادر کردن (Export) یا حذف کلیدهای از پیش به اشتراک گذاشته شده (PSK) مربوط به NVMe TLS از جاکلیدی (keystore) سیستم\&. زمانی که گزینه
\fI\-\-export\fR
مشخص شود، تمام کلیدهای NVMe TLS PSK در قالب زیر صادر می‌شوند:
.sp
<descriptions> <psk>
.sp
که در آن
\fI<description>\fR
توضیحات کلید صادرشده و
\fI<psk>\fR
داده‌های کلید در قالب تبادل PSK به صورت
\fINVMeTLSkey\-1:01:<base64 encoded data>:\fR
است\&. هر کلید در یک خط جداگانه صادر می‌شود\&. زمانی که گزینه
\fI\-\-import\fR
مشخص شود، داده‌های کلید با همین قالب خوانده شده و به جاکلیدی هسته (kernel keystore) وارد می‌شوند\&.
.SH "گزینه‌ها (OPTIONS)"
.PP
\-k <name>, \-\-keyring=<name>
.RS 4
نام جاکلیدی (keyring) که کلید TLS
\fIنگهداری‌شده (retained)\fR
باید در آن ذخیره شود\&. مقدار پیش‌فرض
\fI\&.nvme\fR
است\&.
.RE
.PP
\-t <type>, \-\-keytype=<type>
.RS 4
نوع کلید برای کلید TLS حاصل\&. مقدار پیش‌فرض
\fIpsk\fR
است\&.
.RE
.PP
\-f <file>, \-\-keyfile=<file>
.RS 4
فایلی که باید کلیدها از آن خوانده یا در آن نوشته شوند به‌جای ورودی استاندارد (stdin) / خروجی استاندارد (stdout)\&.
.RE
.PP
\-i, \-\-import
.RS 4
خواندن داده‌های کلید از فایل تعیین‌شده توسط
\fI\-\-keyfile\fR
یا ورودی استاندارد (stdin) در صورت عدم تعیین فایل\&.
.RE
.PP
\-e, \-\-export
.RS 4
نوشتن داده‌های کلید در فایل تعیین‌شده توسط
\fI\-\-keyfile\fR
یا خروجی استاندارد (stdout) در صورت عدم تعیین فایل\&.
.RE
.PP
\-r <description>, \-\-revoke=<description>
.RS 4
ابطال یک کلید از جاکلیدی (keyring)\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
افزایش سطح جزئیات اطلاعات در خروجی\&.
.RE
.SH "مثال‌ها (EXAMPLES)"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ایجاد یک کلید TLS جدید و درج مستقیم آن در جاکلیدی \&.nvme:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme gen\-tls\-key \-i \-n hostnqn0 \-c subsys0
NVMeTLSkey\-1:01:/b9tVz2OXJVISnoFgrPAygyS86XYJWkAapQeULns6PMpM8wv:
Inserted TLS key 26b3260e
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
صادر کردن کلید قبلاً ایجاد شده از جاکلیدی هسته و ذخیره آن در یک فایل:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme tls\-key \-e \-f nvme\-tls\-keys\&.txt
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
صادر کردن/فهرست کردن همه کلیدها از جاکلیدی \&.nvme با استفاده از nvme و keyctl:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme tls\-key \-\-export
NVMe0R01 hostnqn0 subsys0 NVMeTLSkey\-1:01:/b9tVz2OXJVISnoFgrPAygyS86XYJWkAapQeULns6PMpM8wv:

# keyctl show
Session Keyring
 573249525 \-\-alswrv      0     0  keyring: _ses
 353599402 \-\-alswrv      0 65534   \e_ keyring: _uid\&.0
 475911922 \-\-\-lswrv      0     0   \e_ keyring: \&.nvme
 649274894 \-\-als\-rv      0     0       \e_ psk: NVMe0R01 hostnqn0 subsys0
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
ابطال یک کلید با استفاده از توضیحات آن و اعتبارسنجی عملیات با keyctl:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme tls\-key \-\-revoke="NVMe0R01 hostnqn0 subsys0"

# keyctl show
Session Keyring
 573249525 \-\-alswrv      0     0  keyring: _ses
 353599402 \-\-alswrv      0 65534   \e_ keyring: _uid\&.0
 475911922 \-\-\-lswrv      0     0   \e_ keyring: \&.nvme
649274894: key inaccessible (Key has been revoked)
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
وارد کردن مجدد کلید قبلاً ایجادشده از فایل و اعتبارسنجی با keyctl:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme tls\-key \-\-import \-f nvme\-tls\-keys\&.txt

# keyctl show
Session Keyring
 573249525 \-\-alswrv      0     0  keyring: _ses
 353599402 \-\-alswrv      0 65534   \e_ keyring: _uid\&.0
 475911922 \-\-\-lswrv      0     0   \e_ keyring: \&.nvme
 734343968 \-\-als\-rv      0     0       \e_ psk: NVMe0R01 hostnqn0 subsys0
.fi
.if n \{\
.RE
.\}
.RE
.SH "NVME"
.sp
بخشی از مجموعه ابزارهای nvme\-user