| 1 |
.TH "libnvme" 9 "struct nbft_security" "November 2025" "API Manual" LINUX |
| 2 |
.SH NAME |
| 3 |
struct nbft_security \- Security Profile Descriptor (Figure 21) |
| 4 |
.SH SYNOPSIS |
| 5 |
struct nbft_security { |
| 6 |
.br |
| 7 |
.BI " __u8 structure_id;" |
| 8 |
.br |
| 9 |
.BI " __u8 index;" |
| 10 |
.br |
| 11 |
.BI " __le16 flags;" |
| 12 |
.br |
| 13 |
.BI " __u8 secret_type;" |
| 14 |
.br |
| 15 |
.BI " __u8 reserved1;" |
| 16 |
.br |
| 17 |
.BI " struct nbft_heap_obj sec_chan_alg_obj;" |
| 18 |
.br |
| 19 |
.BI " struct nbft_heap_obj auth_proto_obj;" |
| 20 |
.br |
| 21 |
.BI " struct nbft_heap_obj cipher_suite_obj;" |
| 22 |
.br |
| 23 |
.BI " struct nbft_heap_obj dh_grp_obj;" |
| 24 |
.br |
| 25 |
.BI " struct nbft_heap_obj sec_hash_func_obj;" |
| 26 |
.br |
| 27 |
.BI " struct nbft_heap_obj sec_keypath_obj;" |
| 28 |
.br |
| 29 |
.BI " __u8 reserved2[22];" |
| 30 |
.br |
| 31 |
.BI " |
| 32 |
}; |
| 33 |
.br |
| 34 |
|
| 35 |
.SH Members |
| 36 |
.IP "structure_id" 12 |
| 37 |
Structure ID: This field shall be set to 5h |
| 38 |
(i.e., Security; #NBFT_DESC_SECURITY). |
| 39 |
.IP "index" 12 |
| 40 |
Security Profile Descriptor Index: This field indicates |
| 41 |
the number of this Security Profile Descriptor in the |
| 42 |
Security Profile Descriptor List. |
| 43 |
.IP "flags" 12 |
| 44 |
Security Profile Descriptor Flags, see \fIenum nbft_security_flags\fP. |
| 45 |
.IP "secret_type" 12 |
| 46 |
Secret Type, see \fIenum nbft_security_secret_type\fP. |
| 47 |
.IP "reserved1" 12 |
| 48 |
Reserved. |
| 49 |
.IP "sec_chan_alg_obj" 12 |
| 50 |
Secure Channel Algorithm Heap Object Reference: If the |
| 51 |
Security Policy List field is set to 1h, then this field |
| 52 |
indicates the location and size of a heap object containing |
| 53 |
a list of secure channel algorithms. The list is an array |
| 54 |
of bytes and the values are defined in the Security Type |
| 55 |
(SECTYPE) field in the Transport Specific Address Subtype |
| 56 |
Definition in the NVMe TCP Transport Specification. |
| 57 |
If the Security Policy List field is cleared to 0h, then |
| 58 |
this field is reserved. |
| 59 |
.IP "auth_proto_obj" 12 |
| 60 |
Authentication Protocols Heap Object Reference: If the |
| 61 |
Authentication Policy List field is set to 1h, then this |
| 62 |
field indicates the location and size of a heap object |
| 63 |
containing a list of authentication protocol identifiers. |
| 64 |
If the Authentication Policy List field is cleared to 0h, |
| 65 |
then this field is reserved. |
| 66 |
.IP "cipher_suite_obj" 12 |
| 67 |
Cipher Suite Offset Heap Object Reference: If the Cipher |
| 68 |
Suites Restricted by Policy bit is set to 1h, then this |
| 69 |
field indicates the location and size of a heap object |
| 70 |
containing a list of cipher suite identifiers. The list, |
| 71 |
if any, is an array of bytes and the values are defined |
| 72 |
in the IANA TLS Parameters Registry. If the Cipher Suites |
| 73 |
Restricted by Policy bit is cleared to 0h, then this field |
| 74 |
is reserved. |
| 75 |
.IP "dh_grp_obj" 12 |
| 76 |
DH Groups Heap Object Reference: If the Authentication DH Groups |
| 77 |
Restricted by Policy List bit is set to 1h, then this field |
| 78 |
indicates the location and size of a heap object containing |
| 79 |
a list of DH-HMAC-CHAP Diffie-Hellman (DH) group identifiers. |
| 80 |
If the Authentication DH Groups Restricted by Policy List |
| 81 |
bit is cleared to 0h, then this field is reserved. |
| 82 |
.IP "sec_hash_func_obj" 12 |
| 83 |
Secure Hash Functions Offset Heap Object Reference: If the |
| 84 |
Secure Hash Functions Policy List bit is set to 1h, then |
| 85 |
this field indicates the offset in bytes of a heap object |
| 86 |
containing a list of DH-HMAC-CHAP hash function identifiers. |
| 87 |
The list is an array of bytes and the values are defined |
| 88 |
in the NVM Express Base Specification. If the Secure Hash |
| 89 |
Functions Policy List bit is cleared to 0h, then this |
| 90 |
field is reserved. |
| 91 |
.IP "sec_keypath_obj" 12 |
| 92 |
Secret Keypath Offset Heap Object Reference: if this field |
| 93 |
is set to a non-zero value, then this field indicates |
| 94 |
the location and size of a heap object containing a URI. |
| 95 |
The type of the URI is specified in the Secret Type field. |
| 96 |
If this field is cleared to 0h, then this field is reserved. |
| 97 |
.IP "reserved2" 12 |
| 98 |
Reserved. |