|
15 | 15 | namespace Yubico.YubiKey
|
16 | 16 | {
|
17 | 17 | /// <summary>
|
18 |
| - /// Named YubiKey features or distinct behaviors that have been added or changed over the years that can be queried. |
| 18 | + /// Named YubiKey features or distinct behaviors that have been added or changed over the years that can be queried. |
19 | 19 | /// </summary>
|
20 | 20 | public enum YubiKeyFeature
|
21 | 21 | {
|
22 | 22 | // General YubiKey features
|
23 | 23 |
|
24 | 24 | /// <summary>
|
25 |
| - /// The (Yubico)OTP application. Corresponds to the functionality located in the Yubico.YubiKey.Otp namespace. |
| 25 | + /// The (Yubico)OTP application. Corresponds to the functionality located in the Yubico.YubiKey.Otp namespace. |
26 | 26 | /// </summary>
|
27 | 27 | OtpApplication,
|
28 | 28 |
|
29 | 29 | /// <summary>
|
30 |
| - /// The OATH application. Corresponds to the functionality located in the Yubico.YubiKey.Oath namespace. |
| 30 | + /// The OATH application. Corresponds to the functionality located in the Yubico.YubiKey.Oath namespace. |
31 | 31 | /// </summary>
|
32 | 32 | OathApplication,
|
33 | 33 |
|
34 | 34 | /// <summary>
|
35 |
| - /// The PIV application. Corresponds to the functionality located in the Yubico.YubiKey.Piv namespace. |
| 35 | + /// The PIV application. Corresponds to the functionality located in the Yubico.YubiKey.Piv namespace. |
36 | 36 | /// </summary>
|
37 | 37 | PivApplication,
|
38 | 38 |
|
39 | 39 | /// <summary>
|
40 |
| - /// The FIDO U2F application. Corresponds to the functionality located in |
41 |
| - /// the Yubico.YubiKey.U2f namespace. |
| 40 | + /// The FIDO U2F application. Corresponds to the functionality located in |
| 41 | + /// the Yubico.YubiKey.U2f namespace. |
42 | 42 | /// </summary>
|
43 | 43 | U2fApplication,
|
44 | 44 |
|
45 | 45 | /// <summary>
|
46 |
| - /// The FIDO2 application. Corresponds to the functionality located in |
47 |
| - /// the Yubico.YubiKey.Fido2 namespace. |
| 46 | + /// The FIDO2 application. Corresponds to the functionality located in |
| 47 | + /// the Yubico.YubiKey.Fido2 namespace. |
48 | 48 | /// </summary>
|
49 | 49 | Fido2Application,
|
50 | 50 |
|
51 | 51 | /// <summary>
|
52 |
| - /// The YubiKey management application. Corresponds to the functionality located in the |
53 |
| - /// Yubico.YubiKey.Management namespace. |
| 52 | + /// The YubiKey management application. Corresponds to the functionality located in the |
| 53 | + /// Yubico.YubiKey.Management namespace. |
54 | 54 | /// </summary>
|
55 | 55 | ManagementApplication,
|
56 | 56 |
|
57 | 57 | /// <summary>
|
58 |
| - /// The ability to change the visibility of the serial number over USB, API, and Button-press. |
| 58 | + /// The ability to change the visibility of the serial number over USB, API, and Button-press. |
59 | 59 | /// </summary>
|
60 | 60 | SerialNumberVisibilityControls,
|
61 | 61 |
|
62 | 62 | /// <summary>
|
63 |
| - /// The ability to communicate using Secure Channel Protocol 3 (SCP03). |
| 63 | + /// The ability to communicate using Secure Channel Protocol 3 (SCP03). |
64 | 64 | /// </summary>
|
65 | 65 | Scp03,
|
66 | 66 |
|
67 | 67 | /// <summary>
|
68 |
| - /// The YubiKey is capable of switching USB interfaces without the lengthy 3-second reclaim timeout. |
| 68 | + /// The YubiKey is capable of switching USB interfaces without the lengthy 3-second reclaim timeout. |
69 | 69 | /// </summary>
|
70 | 70 | FastUsbReclaim,
|
71 | 71 |
|
72 | 72 | /// <summary>
|
73 |
| - /// The YubiKey allows temporarily adjusting the sensitivity of the capacitive touch sensor. |
| 73 | + /// The YubiKey allows temporarily adjusting the sensitivity of the capacitive touch sensor. |
74 | 74 | /// </summary>
|
75 | 75 | TemporaryTouchThreshold,
|
76 | 76 |
|
77 | 77 | // OTP application features
|
78 | 78 |
|
79 | 79 | /// <summary>
|
80 |
| - /// Support for programming an OATH HOTP-based credential into one of the OTP application slots. |
| 80 | + /// Support for programming an OATH HOTP-based credential into one of the OTP application slots. |
81 | 81 | /// </summary>
|
82 | 82 | OtpOathHotpMode,
|
83 | 83 |
|
84 | 84 | /// <summary>
|
85 |
| - /// A configuration slot that is activated by a longer duration touch of the YubiKey. |
86 |
| - /// This is also sometimes referred to as "Slot 2". |
| 85 | + /// A configuration slot that is activated by a longer duration touch of the YubiKey. |
| 86 | + /// This is also sometimes referred to as "Slot 2". |
87 | 87 | /// </summary>
|
88 | 88 | OtpProtectedLongPressSlot,
|
89 | 89 |
|
90 | 90 | /// <summary>
|
91 |
| - /// Ability to use the HID codes from the numeric keypad for numbers. |
| 91 | + /// Ability to use the HID codes from the numeric keypad for numbers. |
92 | 92 | /// </summary>
|
93 | 93 | OtpNumericKeypad,
|
94 | 94 |
|
95 | 95 | /// <summary>
|
96 |
| - /// Cause the trigger action of the YubiKey button to become faster. |
| 96 | + /// Cause the trigger action of the YubiKey button to become faster. |
97 | 97 | /// </summary>
|
98 | 98 | OtpFastTrigger,
|
99 | 99 |
|
100 | 100 | /// <summary>
|
101 |
| - /// Allow certain non-security related flags to be modified after the configuration |
102 |
| - /// has been written. |
| 101 | + /// Allow certain non-security related flags to be modified after the configuration |
| 102 | + /// has been written. |
103 | 103 | /// </summary>
|
104 | 104 | OtpUpdatableSlots,
|
105 | 105 |
|
106 | 106 | /// <summary>
|
107 |
| - /// Allow a configuration to be stored without being accessible. |
| 107 | + /// Allow a configuration to be stored without being accessible. |
108 | 108 | /// </summary>
|
109 | 109 | OtpDormantSlots,
|
110 | 110 |
|
111 | 111 | /// <summary>
|
112 |
| - /// Invert the configured state of the LED. |
| 112 | + /// Invert the configured state of the LED. |
113 | 113 | /// </summary>
|
114 | 114 | OtpInvertLed,
|
115 | 115 |
|
116 | 116 | /// <summary>
|
117 |
| - /// Truncate the OTP string to 16 characters. |
| 117 | + /// Truncate the OTP string to 16 characters. |
118 | 118 | /// </summary>
|
119 | 119 | OtpShortTickets,
|
120 | 120 |
|
121 | 121 | /// <summary>
|
122 |
| - /// Configure the slot to emit a static password. |
| 122 | + /// Configure the slot to emit a static password. |
123 | 123 | /// </summary>
|
124 | 124 | OtpStaticPasswordMode,
|
125 | 125 |
|
126 | 126 | /// <summary>
|
127 |
| - /// Use the HMAC message which is less than 64 bytes. |
| 127 | + /// Use the HMAC message which is less than 64 bytes. |
128 | 128 | /// </summary>
|
129 | 129 | OtpVariableSizeHmac,
|
130 | 130 |
|
131 | 131 | /// <summary>
|
132 |
| - /// The YubiKey button touch for challenge response configuration. |
| 132 | + /// The YubiKey button touch for challenge response configuration. |
133 | 133 | /// </summary>
|
134 | 134 | OtpButtonTrigger,
|
135 | 135 |
|
136 | 136 | /// <summary>
|
137 |
| - /// Generation of mixed-case characters. |
| 137 | + /// Generation of mixed-case characters. |
138 | 138 | /// </summary>
|
139 | 139 | OtpMixedCasePasswords,
|
140 | 140 |
|
141 | 141 | /// <summary>
|
142 |
| - /// Specify that the first byte of the token identifier should be modhex. |
| 142 | + /// Specify that the first byte of the token identifier should be modhex. |
143 | 143 | /// </summary>
|
144 | 144 | OtpFixedModhex,
|
145 | 145 |
|
146 | 146 | /// <summary>
|
147 |
| - /// Challenge-Response mode instead of an OTP mode. |
| 147 | + /// Challenge-Response mode instead of an OTP mode. |
148 | 148 | /// </summary>
|
149 | 149 | OtpChallengeResponseMode,
|
150 | 150 |
|
151 | 151 | /// <summary>
|
152 |
| - /// Generation of mixed character and digits. |
| 152 | + /// Generation of mixed character and digits. |
153 | 153 | /// </summary>
|
154 | 154 | OtpAlphaNumericPasswords,
|
155 | 155 |
|
156 | 156 | /// <summary>
|
157 |
| - /// Configure the slot to allow for user-triggered static password change. |
| 157 | + /// Configure the slot to allow for user-triggered static password change. |
158 | 158 | /// </summary>
|
159 | 159 | OtpPasswordManualUpdates,
|
160 | 160 |
|
161 | 161 | // PIV application features
|
162 | 162 |
|
163 | 163 | /// <summary>
|
164 |
| - /// An attestation statement which is an X.509 certificate that certifies a |
165 |
| - /// private key was generated by a YubiKey. |
| 164 | + /// An attestation statement which is an X.509 certificate that certifies a |
| 165 | + /// private key was generated by a YubiKey. |
166 | 166 | /// </summary>
|
167 | 167 | PivAttestation,
|
168 | 168 |
|
169 | 169 | /// <summary>
|
170 |
| - /// Ability to use an AES key as the PIV management key. A YubiKey |
171 |
| - /// that can set the management key to AES, can still set it to |
172 |
| - /// Triple-DES. |
| 170 | + /// Ability to use an AES key as the PIV management key. A YubiKey |
| 171 | + /// that can set the management key to AES, can still set it to |
| 172 | + /// Triple-DES. |
173 | 173 | /// </summary>
|
174 | 174 | PivAesManagementKey,
|
175 | 175 |
|
176 | 176 | /// <summary>
|
177 |
| - /// Ability to get data about the key in a slot. |
| 177 | + /// Ability to get data about the key in a slot. |
178 | 178 | /// </summary>
|
179 | 179 | PivMetadata,
|
180 | 180 |
|
181 | 181 | /// <summary>
|
182 |
| - /// The cryptographic RSA algorithm with the key size 1024 bits |
183 |
| - /// supported by the PIV Application on the YubiKey. |
| 182 | + /// The cryptographic RSA algorithm with the key size 1024 bits |
| 183 | + /// supported by the PIV Application on the YubiKey. |
184 | 184 | /// </summary>
|
185 | 185 | PivRsa1024,
|
186 | 186 |
|
187 | 187 | /// <summary>
|
188 |
| - /// The cryptographic RSA algorithm with the key size 2048 bits |
189 |
| - /// supported by the PIV Application on the YubiKey. |
| 188 | + /// The cryptographic RSA algorithm with the key size 2048 bits |
| 189 | + /// supported by the PIV Application on the YubiKey. |
190 | 190 | /// </summary>
|
191 | 191 | PivRsa2048,
|
192 | 192 |
|
193 | 193 | /// <summary>
|
194 |
| - /// The cryptographic RSA algorithm with the key size 3072 bits |
195 |
| - /// supported by the PIV Application on the YubiKey. |
| 194 | + /// The cryptographic RSA algorithm with the key size 3072 bits |
| 195 | + /// supported by the PIV Application on the YubiKey. |
196 | 196 | /// </summary>
|
197 | 197 | PivRsa3072,
|
198 | 198 |
|
199 | 199 | /// <summary>
|
200 |
| - /// The cryptographic RSA algorithm with the key size 4096 bits |
201 |
| - /// supported by the PIV Application on the YubiKey. |
| 200 | + /// The cryptographic RSA algorithm with the key size 4096 bits |
| 201 | + /// supported by the PIV Application on the YubiKey. |
202 | 202 | /// </summary>
|
203 | 203 | PivRsa4096,
|
204 | 204 |
|
205 | 205 | /// <summary>
|
206 |
| - /// The cryptographic ECC algorithm with the parameters P-256, |
207 |
| - /// specified in FIPS 186-4 supported by the PIV Application on the YubiKey. |
| 206 | + /// The cryptographic ECC algorithm with the parameters P-256, |
| 207 | + /// specified in FIPS 186-4 supported by the PIV Application on the YubiKey. |
208 | 208 | /// </summary>
|
209 | 209 | PivEccP256,
|
210 | 210 |
|
211 | 211 | /// <summary>
|
212 |
| - /// The cryptographic ECC algorithm with the parameters P-384, |
213 |
| - /// specified in FIPS 186-4 supported by the PIV Application on the YubiKey. |
| 212 | + /// The cryptographic ECC algorithm with the parameters P-384, |
| 213 | + /// specified in FIPS 186-4 supported by the PIV Application on the YubiKey. |
214 | 214 | /// </summary>
|
215 | 215 | PivEccP384,
|
216 |
| - |
| 216 | + |
217 | 217 | /// <summary>
|
218 |
| - /// Support for deleting PIV keys or moving PIV keys between slots. |
| 218 | + /// Support for deleting PIV keys or moving PIV keys between slots. |
219 | 219 | /// </summary>
|
220 | 220 | PivMoveOrDeleteKey,
|
221 | 221 |
|
222 | 222 | /// <summary>
|
223 |
| - /// The touch policy refers to whether use of the management key will |
224 |
| - /// require touch or not. |
| 223 | + /// The touch policy refers to whether use of the management key will |
| 224 | + /// require touch or not. |
225 | 225 | /// </summary>
|
226 | 226 | PivManagementKeyTouchPolicy,
|
227 | 227 |
|
228 | 228 | /// <summary>
|
229 |
| - /// Ability to set touch policy to cached. |
230 |
| - /// It means that touch is cached for 15 seconds. |
| 229 | + /// Ability to set touch policy to cached. |
| 230 | + /// It means that touch is cached for 15 seconds. |
231 | 231 | /// </summary>
|
232 | 232 | PivTouchPolicyCached,
|
233 | 233 |
|
234 | 234 | /// <summary>
|
235 |
| - /// Ability to set touch policy on private key to cached. |
236 |
| - /// It means that touch is cached for 15 seconds. |
| 235 | + /// Ability to set touch policy on private key to cached. |
| 236 | + /// It means that touch is cached for 15 seconds. |
237 | 237 | /// </summary>
|
238 | 238 | PivPrivateKeyTouchPolicyCached,
|
239 | 239 |
|
240 | 240 | // OATH application features
|
241 | 241 |
|
242 | 242 | /// <summary>
|
243 |
| - /// The ability to rename existing OATH credentials. |
| 243 | + /// The ability to rename existing OATH credentials. |
244 | 244 | /// </summary>
|
245 | 245 | OathRenameCredential,
|
246 | 246 |
|
247 | 247 | /// <summary>
|
248 |
| - /// The ability to "hide" an OATH credential until the YubiKey's button has been touched. |
| 248 | + /// The ability to "hide" an OATH credential until the YubiKey's button has been touched. |
249 | 249 | /// </summary>
|
250 | 250 | OathTouchCredential,
|
251 | 251 |
|
252 | 252 | /// <summary>
|
253 |
| - /// Support for SHA-512 based OTP credentials. |
| 253 | + /// Support for SHA-512 based OTP credentials. |
254 | 254 | /// </summary>
|
255 | 255 | OathSha512,
|
256 | 256 |
|
257 | 257 | // YubiHSM Auth application
|
258 | 258 |
|
259 | 259 | /// <summary>
|
260 |
| - /// The YubiHSM Auth application. Corresponds to the functionality located in the |
261 |
| - /// Yubico.YubiKey.YubiHsmAuth namespace. |
| 260 | + /// The YubiHSM Auth application. Corresponds to the functionality located in the |
| 261 | + /// Yubico.YubiKey.YubiHsmAuth namespace. |
262 | 262 | /// </summary>
|
263 | 263 | YubiHsmAuthApplication,
|
264 | 264 |
|
265 | 265 | /// <summary>
|
266 |
| - /// Allows temporarily disabling NFC until the next time the YubiKey is powered over USB. |
| 266 | + /// Allows temporarily disabling NFC until the next time the YubiKey is powered over USB. |
267 | 267 | /// </summary>
|
268 | 268 | ManagementNfcRestricted
|
269 | 269 | }
|
|
0 commit comments