Debian Codegraph @

doc/man/nbft_security_flags.2

raw
1 .TH "libnvme" 9 "enum nbft_security_flags" "November 2025" "API Manual" LINUX
2 .SH NAME
3 enum nbft_security_flags \- Security Profile Descriptor Flags (Figure 22)
4 .SH SYNOPSIS
5 enum nbft_security_flags {
6 .br
7 .BI " NBFT_SECURITY_VALID"
8 ,
9 .br
10 .br
11 .BI " NBFT_SECURITY_IN_BAND_AUTH_MASK"
12 ,
13 .br
14 .br
15 .BI " NBFT_SECURITY_IN_BAND_AUTH_NOT_SUPPORTED"
16 ,
17 .br
18 .br
19 .BI " NBFT_SECURITY_IN_BAND_AUTH_NOT_REQUIRED"
20 ,
21 .br
22 .br
23 .BI " NBFT_SECURITY_IN_BAND_AUTH_REQUIRED"
24 ,
25 .br
26 .br
27 .BI " NBFT_SECURITY_AUTH_POLICY_LIST_MASK"
28 ,
29 .br
30 .br
31 .BI " NBFT_SECURITY_AUTH_POLICY_LIST_NOT_SUPPORTED"
32 ,
33 .br
34 .br
35 .BI " NBFT_SECURITY_AUTH_POLICY_LIST_DRIVER"
36 ,
37 .br
38 .br
39 .BI " NBFT_SECURITY_AUTH_POLICY_LIST_ADMIN"
40 ,
41 .br
42 .br
43 .BI " NBFT_SECURITY_SEC_CHAN_NEG_MASK"
44 ,
45 .br
46 .br
47 .BI " NBFT_SECURITY_SEC_CHAN_NEG_NOT_SUPPORTED"
48 ,
49 .br
50 .br
51 .BI " NBFT_SECURITY_SEC_CHAN_NEG_NOT_REQUIRED"
52 ,
53 .br
54 .br
55 .BI " NBFT_SECURITY_SEC_CHAN_NEG_REQUIRED"
56 ,
57 .br
58 .br
59 .BI " NBFT_SECURITY_SEC_POLICY_LIST_MASK"
60 ,
61 .br
62 .br
63 .BI " NBFT_SECURITY_SEC_POLICY_LIST_NOT_SUPPORTED"
64 ,
65 .br
66 .br
67 .BI " NBFT_SECURITY_SEC_POLICY_LIST_DRIVER"
68 ,
69 .br
70 .br
71 .BI " NBFT_SECURITY_SEC_POLICY_LIST_ADMIN"
72 ,
73 .br
74 .br
75 .BI " NBFT_SECURITY_CIPHER_RESTRICTED"
76 ,
77 .br
78 .br
79 .BI " NBFT_SECURITY_AUTH_DH_GROUPS_RESTRICTED"
80 ,
81 .br
82 .br
83 .BI " NBFT_SECURITY_SEC_HASH_FUNC_POLICY_LIST"
84
85 };
86 .SH Constants
87 .IP "NBFT_SECURITY_VALID" 12
88 Descriptor Valid: If set to 1h, then
89 this descriptor is valid. If cleared
90 to 0h, then this descriptor is not valid.
91 .IP "NBFT_SECURITY_IN_BAND_AUTH_MASK" 12
92 Mask to get the In-Band Authentication
93 Required field.
94 .IP "NBFT_SECURITY_IN_BAND_AUTH_NOT_SUPPORTED" 12
95 In-band authentication is not supported
96 by the NVM subsystem.
97 .IP "NBFT_SECURITY_IN_BAND_AUTH_NOT_REQUIRED" 12
98 In-band authentication is supported by
99 the NVM subsystem and is not required.
100 .IP "NBFT_SECURITY_IN_BAND_AUTH_REQUIRED" 12
101 In-band authentication is supported by
102 the NVM subsystem and is required.
103 .IP "NBFT_SECURITY_AUTH_POLICY_LIST_MASK" 12
104 Mask to get the Authentication Policy List
105 flag: This field indicates whether
106 authentication protocols were indicated
107 by policy from driver defaults or
108 administrative configuration.
109 .IP "NBFT_SECURITY_AUTH_POLICY_LIST_NOT_SUPPORTED" 12
110 Authentication Protocols Heap Object Reference
111 field Offset and Length are reserved.
112 .IP "NBFT_SECURITY_AUTH_POLICY_LIST_DRIVER" 12
113 Authentication Protocols Offset field and
114 the Authentication Protocols Length field
115 indicate a list of authentication protocols
116 used by the driver.
117 .IP "NBFT_SECURITY_AUTH_POLICY_LIST_ADMIN" 12
118 Authentication Protocols Offset field and
119 the Authentication Protocols Length field
120 indicate a list of authentication protocols
121 that were administratively set and used
122 by the driver.
123 .IP "NBFT_SECURITY_SEC_CHAN_NEG_MASK" 12
124 Mask to get the Secure Channel Negotiation
125 Required flag: This field indicates whether
126 secure channel negotiation (e.g. TLS)
127 is required.
128 .IP "NBFT_SECURITY_SEC_CHAN_NEG_NOT_SUPPORTED" 12
129 Secure channel negotiation is not supported
130 by the NVM subsystem.
131 .IP "NBFT_SECURITY_SEC_CHAN_NEG_NOT_REQUIRED" 12
132 Secure channel negotiation is supported
133 by the NVM subsystem and is not required.
134 .IP "NBFT_SECURITY_SEC_CHAN_NEG_REQUIRED" 12
135 Secure channel negotiation is supported
136 by the NVM subsystem and is required.
137 .IP "NBFT_SECURITY_SEC_POLICY_LIST_MASK" 12
138 Mask to get the Security Policy List flag:
139 This field indicates whether secure channel
140 protocols were indicated by policy from driver
141 defaults or administrative configuration.
142 .IP "NBFT_SECURITY_SEC_POLICY_LIST_NOT_SUPPORTED" 12
143 The Offset field and Length field in the
144 Secure Channel Algorithm Heap Object Reference
145 field are reserved.
146 .IP "NBFT_SECURITY_SEC_POLICY_LIST_DRIVER" 12
147 The Heap Object specified by the Secure Channel
148 Algorithm Heap Object Reference field indicates
149 a list of authentication protocols used
150 by the driver.
151 .IP "NBFT_SECURITY_SEC_POLICY_LIST_ADMIN" 12
152 The Heap Object specified by the Secure Channel
153 Algorithm Heap Object Reference field indicates
154 a list of authentication protocols that were
155 administratively set and used by the driver.
156 .IP "NBFT_SECURITY_CIPHER_RESTRICTED" 12
157 Cipher Suites Restricted by Policy: If set to 1h,
158 then the Cipher Suite Offset field and the
159 Ciper Suite Length field indicate a list
160 of supported cipher suites by the driver.
161 If cleared to 0h, then the Cipher Suite Offset
162 field and the Cipher Suite Length field
163 are reserved.
164 .IP "NBFT_SECURITY_AUTH_DH_GROUPS_RESTRICTED" 12
165 Authentication DH Groups Restricted
166 by Policy List: If set to 1h, then connections
167 shall use one of the authentication DH groups
168 in the Authentication DH Groups List is required.
169 If cleared to 0h, then no Authentication DH Groups
170 List is indicated and use of an authentication
171 DH Group is not required.
172 .IP "NBFT_SECURITY_SEC_HASH_FUNC_POLICY_LIST" 12
173 Secure Hash Functions Policy List: If set to 1h,
174 then connections shall use one of the secure
175 hash functions in the Secure Hash Functions
176 Policy List is required. If cleared to 0h,
177 then no Secure Hash Functions Policy
178 List is indicated and use of a secure
179 hash function is not required.