---
name: "nbft_security"
section: "2"
platform: "linux"
package: "libnvme-dev"
version: "1.13-2"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/nbft_security"
---

# nbft\_security(2)

Security Profile Descriptor (Figure 21)

## NAME

struct nbft\_security - Security Profile Descriptor (Figure 21)

## SYNOPSIS

struct nbft\_security {\
     **\_\_u8 structure\_id;**\
     **\_\_u8 index;**\
     **\_\_le16 flags;**\
     **\_\_u8 secret\_type;**\
     **\_\_u8 reserved1;**\
     **struct nbft\_heap\_obj sec\_chan\_alg\_obj;**\
     **struct nbft\_heap\_obj auth\_proto\_obj;**\
     **struct nbft\_heap\_obj cipher\_suite\_obj;**\
     **struct nbft\_heap\_obj dh\_grp\_obj;**\
     **struct nbft\_heap\_obj sec\_hash\_func\_obj;**\
     **struct nbft\_heap\_obj sec\_keypath\_obj;**\
     **\_\_u8 reserved2\[22\];**\
 };\

## Members

- structure\_id

  Structure ID: This field shall be set to 5h (i.e., Security; #NBFT\_DESC\_SECURITY).

- index

  Security Profile Descriptor Index: This field indicates the number of this Security Profile Descriptor in the Security Profile Descriptor List.

- flags

  Security Profile Descriptor Flags, see *enum nbft\_security\_flags*.

- secret\_type

  Secret Type, see *enum nbft\_security\_secret\_type*.

- reserved1

  Reserved.

- sec\_chan\_alg\_obj

  Secure Channel Algorithm Heap Object Reference: If the Security Policy List field is set to 1h, then this field indicates the location and size of a heap object containing a list of secure channel algorithms. The list is an array of bytes and the values are defined in the Security Type (SECTYPE) field in the Transport Specific Address Subtype Definition in the NVMe TCP Transport Specification. If the Security Policy List field is cleared to 0h, then this field is reserved.

- auth\_proto\_obj

  Authentication Protocols Heap Object Reference: If the Authentication Policy List field is set to 1h, then this field indicates the location and size of a heap object containing a list of authentication protocol identifiers. If the Authentication Policy List field is cleared to 0h, then this field is reserved.

- cipher\_suite\_obj

  Cipher Suite Offset Heap Object Reference: If the Cipher Suites Restricted by Policy bit is set to 1h, then this field indicates the location and size of a heap object containing a list of cipher suite identifiers. The list, if any, is an array of bytes and the values are defined in the IANA TLS Parameters Registry. If the Cipher Suites Restricted by Policy bit is cleared to 0h, then this field is reserved.

- dh\_grp\_obj

  DH Groups Heap Object Reference: If the Authentication DH Groups Restricted by Policy List bit is set to 1h, then this field indicates the location and size of a heap object containing a list of DH-HMAC-CHAP Diffie-Hellman (DH) group identifiers. If the Authentication DH Groups Restricted by Policy List bit is cleared to 0h, then this field is reserved.

- sec\_hash\_func\_obj

  Secure Hash Functions Offset Heap Object Reference: If the Secure Hash Functions Policy List bit is set to 1h, then this field indicates the offset in bytes of a heap object containing a list of DH-HMAC-CHAP hash function identifiers. The list is an array of bytes and the values are defined in the NVM Express Base Specification. If the Secure Hash Functions Policy List bit is cleared to 0h, then this field is reserved.

- sec\_keypath\_obj

  Secret Keypath Offset Heap Object Reference: if this field is set to a non-zero value, then this field indicates the location and size of a heap object containing a URI. The type of the URI is specified in the Secret Type field. If this field is cleared to 0h, then this field is reserved.

- reserved2

  Reserved.