]>
Commit | Line | Data |
---|---|---|
db9ecf05 | 1 | /* SPDX-License-Identifier: LGPL-2.1-or-later */ |
e23a0ce8 | 2 | |
7f4e0805 | 3 | #include <errno.h> |
07630cea | 4 | #include <mntent.h> |
07630cea | 5 | #include <sys/mman.h> |
ca78ad1d ZJS |
6 | #include <sys/stat.h> |
7 | #include <sys/types.h> | |
8 | #include <unistd.h> | |
e23a0ce8 | 9 | |
4f5dd394 LP |
10 | #include "sd-device.h" |
11 | ||
b5efdb8a | 12 | #include "alloc-util.h" |
4f5dd394 | 13 | #include "ask-password-api.h" |
2bc5c425 | 14 | #include "cryptsetup-fido2.h" |
1e2f3230 | 15 | #include "cryptsetup-keyfile.h" |
08669709 | 16 | #include "cryptsetup-pkcs11.h" |
18843ecc | 17 | #include "cryptsetup-tpm2.h" |
7407f689 | 18 | #include "cryptsetup-util.h" |
4f5dd394 | 19 | #include "device-util.h" |
7be4b236 | 20 | #include "efi-api.h" |
64c590fb | 21 | #include "env-util.h" |
4f5dd394 | 22 | #include "escape.h" |
8cf3ca80 | 23 | #include "fileio.h" |
d3d49e76 | 24 | #include "fs-util.h" |
ed4ad488 | 25 | #include "fstab-util.h" |
08669709 | 26 | #include "hexdecoct.h" |
2bc5c425 | 27 | #include "libfido2-util.h" |
e23a0ce8 | 28 | #include "log.h" |
3a40f366 | 29 | #include "main-func.h" |
7407f689 | 30 | #include "memory-util.h" |
4349cd7c | 31 | #include "mount-util.h" |
d8b4d14d | 32 | #include "nulstr-util.h" |
6bedfcbb | 33 | #include "parse-util.h" |
9eb977db | 34 | #include "path-util.h" |
08669709 | 35 | #include "pkcs11-util.h" |
d8b4d14d | 36 | #include "pretty-print.h" |
542bb9be | 37 | #include "process-util.h" |
e2c2f868 | 38 | #include "random-util.h" |
b6c0bd11 | 39 | #include "string-table.h" |
21bc923a | 40 | #include "strv.h" |
18843ecc | 41 | #include "tpm2-util.h" |
7f4e0805 | 42 | |
b3b4ebab OK |
43 | /* internal helper */ |
44 | #define ANY_LUKS "LUKS" | |
a9fc6406 | 45 | /* as in src/cryptsetup.h */ |
63b98386 JJ |
46 | #define CRYPT_SECTOR_SIZE 512U |
47 | #define CRYPT_MAX_SECTOR_SIZE 4096U | |
b3b4ebab | 48 | |
b6c0bd11 AAF |
49 | typedef enum PassphraseType { |
50 | PASSPHRASE_NONE, | |
51 | PASSPHRASE_REGULAR = 1 << 0, | |
52 | PASSPHRASE_RECOVERY_KEY = 1 << 1, | |
53 | PASSPHRASE_BOTH = PASSPHRASE_REGULAR|PASSPHRASE_RECOVERY_KEY, | |
54 | _PASSPHRASE_TYPE_MAX, | |
55 | _PASSPHRASE_TYPE_INVALID = -1, | |
56 | } PassphraseType; | |
57 | ||
6cc27c29 | 58 | static const char *arg_type = NULL; /* ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2, CRYPT_TCRYPT, CRYPT_BITLK or CRYPT_PLAIN */ |
f75cac37 LP |
59 | static char *arg_cipher = NULL; |
60 | static unsigned arg_key_size = 0; | |
a9fc6406 | 61 | static unsigned arg_sector_size = CRYPT_SECTOR_SIZE; |
f75cac37 LP |
62 | static int arg_key_slot = CRYPT_ANY_SLOT; |
63 | static unsigned arg_keyfile_size = 0; | |
dc0a3555 | 64 | static uint64_t arg_keyfile_offset = 0; |
d3d49e76 | 65 | static bool arg_keyfile_erase = false; |
0ba6f85e | 66 | static bool arg_try_empty_password = false; |
f75cac37 | 67 | static char *arg_hash = NULL; |
7376e835 | 68 | static char *arg_header = NULL; |
f75cac37 LP |
69 | static unsigned arg_tries = 3; |
70 | static bool arg_readonly = false; | |
71 | static bool arg_verify = false; | |
2cbca51a | 72 | static AskPasswordFlags arg_ask_password_flags = 0; |
f75cac37 | 73 | static bool arg_discards = false; |
2c65512e YW |
74 | static bool arg_same_cpu_crypt = false; |
75 | static bool arg_submit_from_crypt_cpus = false; | |
227acf00 JU |
76 | static bool arg_no_read_workqueue = false; |
77 | static bool arg_no_write_workqueue = false; | |
f75cac37 LP |
78 | static bool arg_tcrypt_hidden = false; |
79 | static bool arg_tcrypt_system = false; | |
52028838 | 80 | static bool arg_tcrypt_veracrypt = false; |
f75cac37 | 81 | static char **arg_tcrypt_keyfiles = NULL; |
4eac2773 MP |
82 | static uint64_t arg_offset = 0; |
83 | static uint64_t arg_skip = 0; | |
0864d311 | 84 | static usec_t arg_timeout = USEC_INFINITY; |
08669709 | 85 | static char *arg_pkcs11_uri = NULL; |
b997d111 | 86 | static bool arg_pkcs11_uri_auto = false; |
2bc5c425 LP |
87 | static char *arg_fido2_device = NULL; |
88 | static bool arg_fido2_device_auto = false; | |
89 | static void *arg_fido2_cid = NULL; | |
90 | static size_t arg_fido2_cid_size = 0; | |
91 | static char *arg_fido2_rp_id = NULL; | |
18843ecc LP |
92 | static char *arg_tpm2_device = NULL; |
93 | static bool arg_tpm2_device_auto = false; | |
94 | static uint32_t arg_tpm2_pcr_mask = UINT32_MAX; | |
dc63b2c9 | 95 | static char *arg_tpm2_signature = NULL; |
4005d41e | 96 | static bool arg_tpm2_pin = false; |
cd5f57bd | 97 | static bool arg_headless = false; |
5cbe70af | 98 | static usec_t arg_token_timeout_usec = 30*USEC_PER_SEC; |
7f4e0805 | 99 | |
3a40f366 YW |
100 | STATIC_DESTRUCTOR_REGISTER(arg_cipher, freep); |
101 | STATIC_DESTRUCTOR_REGISTER(arg_hash, freep); | |
102 | STATIC_DESTRUCTOR_REGISTER(arg_header, freep); | |
103 | STATIC_DESTRUCTOR_REGISTER(arg_tcrypt_keyfiles, strv_freep); | |
08669709 | 104 | STATIC_DESTRUCTOR_REGISTER(arg_pkcs11_uri, freep); |
2bc5c425 LP |
105 | STATIC_DESTRUCTOR_REGISTER(arg_fido2_device, freep); |
106 | STATIC_DESTRUCTOR_REGISTER(arg_fido2_cid, freep); | |
107 | STATIC_DESTRUCTOR_REGISTER(arg_fido2_rp_id, freep); | |
18843ecc | 108 | STATIC_DESTRUCTOR_REGISTER(arg_tpm2_device, freep); |
dc63b2c9 | 109 | STATIC_DESTRUCTOR_REGISTER(arg_tpm2_signature, freep); |
3a40f366 | 110 | |
b6c0bd11 AAF |
111 | static const char* const passphrase_type_table[_PASSPHRASE_TYPE_MAX] = { |
112 | [PASSPHRASE_REGULAR] = "passphrase", | |
113 | [PASSPHRASE_RECOVERY_KEY] = "recovery key", | |
114 | [PASSPHRASE_BOTH] = "passphrase or recovery key", | |
115 | }; | |
116 | ||
117 | const char* passphrase_type_to_string(PassphraseType t); | |
118 | PassphraseType passphrase_type_from_string(const char *s); | |
119 | ||
120 | DEFINE_STRING_TABLE_LOOKUP(passphrase_type, PassphraseType); | |
121 | ||
1fc76335 LP |
122 | /* Options Debian's crypttab knows we don't: |
123 | ||
1fc76335 LP |
124 | check= |
125 | checkargs= | |
8ced40c0 LP |
126 | noearly |
127 | loud | |
128 | quiet | |
1fc76335 | 129 | keyscript= |
8ced40c0 | 130 | initramfs |
1fc76335 LP |
131 | */ |
132 | ||
7f4e0805 | 133 | static int parse_one_option(const char *option) { |
fb4650aa ZJS |
134 | const char *val; |
135 | int r; | |
136 | ||
7f4e0805 LP |
137 | assert(option); |
138 | ||
139 | /* Handled outside of this tool */ | |
50d2eba2 | 140 | if (STR_IN_SET(option, "noauto", "auto", "nofail", "fail", "_netdev", "keyfile-timeout")) |
141 | return 0; | |
142 | ||
143 | if (startswith(option, "keyfile-timeout=")) | |
7f4e0805 LP |
144 | return 0; |
145 | ||
fb4650aa ZJS |
146 | if ((val = startswith(option, "cipher="))) { |
147 | r = free_and_strdup(&arg_cipher, val); | |
148 | if (r < 0) | |
4b93637f | 149 | return log_oom(); |
7f4e0805 | 150 | |
fb4650aa | 151 | } else if ((val = startswith(option, "size="))) { |
7f4e0805 | 152 | |
fb4650aa ZJS |
153 | r = safe_atou(val, &arg_key_size); |
154 | if (r < 0) { | |
155 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
7f4e0805 LP |
156 | return 0; |
157 | } | |
158 | ||
6131a78b DH |
159 | if (arg_key_size % 8) { |
160 | log_error("size= not a multiple of 8, ignoring."); | |
161 | return 0; | |
162 | } | |
163 | ||
164 | arg_key_size /= 8; | |
165 | ||
a9fc6406 DJL |
166 | } else if ((val = startswith(option, "sector-size="))) { |
167 | ||
a9fc6406 DJL |
168 | r = safe_atou(val, &arg_sector_size); |
169 | if (r < 0) { | |
170 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
171 | return 0; | |
172 | } | |
173 | ||
174 | if (arg_sector_size % 2) { | |
175 | log_error("sector-size= not a multiple of 2, ignoring."); | |
176 | return 0; | |
177 | } | |
178 | ||
179 | if (arg_sector_size < CRYPT_SECTOR_SIZE || arg_sector_size > CRYPT_MAX_SECTOR_SIZE) { | |
180 | log_error("sector-size= is outside of %u and %u, ignoring.", CRYPT_SECTOR_SIZE, CRYPT_MAX_SECTOR_SIZE); | |
181 | return 0; | |
182 | } | |
a9fc6406 | 183 | |
8ced40c0 LP |
184 | } else if ((val = startswith(option, "key-slot=")) || |
185 | (val = startswith(option, "keyslot="))) { | |
b4a11878 | 186 | |
b3b4ebab | 187 | arg_type = ANY_LUKS; |
fb4650aa ZJS |
188 | r = safe_atoi(val, &arg_key_slot); |
189 | if (r < 0) { | |
190 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
b4a11878 CS |
191 | return 0; |
192 | } | |
193 | ||
fb4650aa | 194 | } else if ((val = startswith(option, "tcrypt-keyfile="))) { |
8cf3ca80 | 195 | |
f75cac37 | 196 | arg_type = CRYPT_TCRYPT; |
fb4650aa ZJS |
197 | if (path_is_absolute(val)) { |
198 | if (strv_extend(&arg_tcrypt_keyfiles, val) < 0) | |
4b93637f LP |
199 | return log_oom(); |
200 | } else | |
fb4650aa | 201 | log_error("Key file path \"%s\" is not absolute. Ignoring.", val); |
8cf3ca80 | 202 | |
fb4650aa | 203 | } else if ((val = startswith(option, "keyfile-size="))) { |
4271d823 | 204 | |
fb4650aa ZJS |
205 | r = safe_atou(val, &arg_keyfile_size); |
206 | if (r < 0) { | |
207 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
4271d823 TG |
208 | return 0; |
209 | } | |
210 | ||
fb4650aa | 211 | } else if ((val = startswith(option, "keyfile-offset="))) { |
880a599e | 212 | |
d90874b4 | 213 | r = safe_atou64(val, &arg_keyfile_offset); |
fb4650aa ZJS |
214 | if (r < 0) { |
215 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
880a599e TG |
216 | return 0; |
217 | } | |
218 | ||
d3d49e76 LP |
219 | } else if ((val = startswith(option, "keyfile-erase="))) { |
220 | ||
221 | r = parse_boolean(val); | |
222 | if (r < 0) { | |
223 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
224 | return 0; | |
225 | } | |
226 | ||
227 | arg_keyfile_erase = r; | |
228 | ||
229 | } else if (streq(option, "keyfile-erase")) | |
230 | arg_keyfile_erase = true; | |
231 | ||
232 | else if ((val = startswith(option, "hash="))) { | |
fb4650aa ZJS |
233 | r = free_and_strdup(&arg_hash, val); |
234 | if (r < 0) | |
4b93637f | 235 | return log_oom(); |
7f4e0805 | 236 | |
fb4650aa | 237 | } else if ((val = startswith(option, "header="))) { |
b3b4ebab | 238 | arg_type = ANY_LUKS; |
7376e835 | 239 | |
baaa35ad ZJS |
240 | if (!path_is_absolute(val)) |
241 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
242 | "Header path \"%s\" is not absolute, refusing.", val); | |
7376e835 | 243 | |
baaa35ad ZJS |
244 | if (arg_header) |
245 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
246 | "Duplicate header= option, refusing."); | |
7376e835 | 247 | |
fb4650aa | 248 | arg_header = strdup(val); |
7376e835 AC |
249 | if (!arg_header) |
250 | return log_oom(); | |
251 | ||
fb4650aa | 252 | } else if ((val = startswith(option, "tries="))) { |
7f4e0805 | 253 | |
fb4650aa ZJS |
254 | r = safe_atou(val, &arg_tries); |
255 | if (r < 0) { | |
256 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
7f4e0805 LP |
257 | return 0; |
258 | } | |
259 | ||
f75cac37 LP |
260 | } else if (STR_IN_SET(option, "readonly", "read-only")) |
261 | arg_readonly = true; | |
7f4e0805 | 262 | else if (streq(option, "verify")) |
f75cac37 | 263 | arg_verify = true; |
2cbca51a SB |
264 | else if ((val = startswith(option, "password-echo="))) { |
265 | if (streq(val, "masked")) | |
266 | arg_ask_password_flags &= ~(ASK_PASSWORD_ECHO|ASK_PASSWORD_SILENT); | |
267 | else { | |
268 | r = parse_boolean(val); | |
269 | if (r < 0) { | |
270 | log_warning_errno(r, "Invalid password-echo= option \"%s\", ignoring.", val); | |
271 | return 0; | |
272 | } | |
273 | ||
274 | SET_FLAG(arg_ask_password_flags, ASK_PASSWORD_ECHO, r); | |
275 | SET_FLAG(arg_ask_password_flags, ASK_PASSWORD_SILENT, !r); | |
276 | } | |
277 | } else if (STR_IN_SET(option, "allow-discards", "discard")) | |
f75cac37 | 278 | arg_discards = true; |
2c65512e YW |
279 | else if (streq(option, "same-cpu-crypt")) |
280 | arg_same_cpu_crypt = true; | |
281 | else if (streq(option, "submit-from-crypt-cpus")) | |
282 | arg_submit_from_crypt_cpus = true; | |
227acf00 JU |
283 | else if (streq(option, "no-read-workqueue")) |
284 | arg_no_read_workqueue = true; | |
285 | else if (streq(option, "no-write-workqueue")) | |
286 | arg_no_write_workqueue = true; | |
260ab287 | 287 | else if (streq(option, "luks")) |
b3b4ebab | 288 | arg_type = ANY_LUKS; |
6cc27c29 MF |
289 | /* since cryptsetup 2.3.0 (Feb 2020) */ |
290 | #ifdef CRYPT_BITLK | |
291 | else if (streq(option, "bitlk")) | |
292 | arg_type = CRYPT_BITLK; | |
293 | #endif | |
8cf3ca80 | 294 | else if (streq(option, "tcrypt")) |
f75cac37 | 295 | arg_type = CRYPT_TCRYPT; |
8ced40c0 | 296 | else if (STR_IN_SET(option, "tcrypt-hidden", "tcrypthidden")) { |
f75cac37 LP |
297 | arg_type = CRYPT_TCRYPT; |
298 | arg_tcrypt_hidden = true; | |
8cf3ca80 | 299 | } else if (streq(option, "tcrypt-system")) { |
f75cac37 LP |
300 | arg_type = CRYPT_TCRYPT; |
301 | arg_tcrypt_system = true; | |
8ced40c0 | 302 | } else if (STR_IN_SET(option, "tcrypt-veracrypt", "veracrypt")) { |
52028838 GH |
303 | arg_type = CRYPT_TCRYPT; |
304 | arg_tcrypt_veracrypt = true; | |
53ac130b LP |
305 | } else if (STR_IN_SET(option, "plain", "swap", "tmp") || |
306 | startswith(option, "tmp=")) | |
f75cac37 | 307 | arg_type = CRYPT_PLAIN; |
fb4650aa | 308 | else if ((val = startswith(option, "timeout="))) { |
7f4e0805 | 309 | |
0004f698 | 310 | r = parse_sec_fix_0(val, &arg_timeout); |
fb4650aa ZJS |
311 | if (r < 0) { |
312 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
7f4e0805 LP |
313 | return 0; |
314 | } | |
315 | ||
fb4650aa | 316 | } else if ((val = startswith(option, "offset="))) { |
4eac2773 | 317 | |
fb4650aa ZJS |
318 | r = safe_atou64(val, &arg_offset); |
319 | if (r < 0) | |
320 | return log_error_errno(r, "Failed to parse %s: %m", option); | |
4eac2773 | 321 | |
fb4650aa | 322 | } else if ((val = startswith(option, "skip="))) { |
4eac2773 | 323 | |
fb4650aa ZJS |
324 | r = safe_atou64(val, &arg_skip); |
325 | if (r < 0) | |
326 | return log_error_errno(r, "Failed to parse %s: %m", option); | |
4eac2773 | 327 | |
08669709 LP |
328 | } else if ((val = startswith(option, "pkcs11-uri="))) { |
329 | ||
b997d111 LP |
330 | if (streq(val, "auto")) { |
331 | arg_pkcs11_uri = mfree(arg_pkcs11_uri); | |
332 | arg_pkcs11_uri_auto = true; | |
333 | } else { | |
334 | if (!pkcs11_uri_valid(val)) | |
335 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "pkcs11-uri= parameter expects a PKCS#11 URI, refusing"); | |
08669709 | 336 | |
b997d111 LP |
337 | r = free_and_strdup(&arg_pkcs11_uri, val); |
338 | if (r < 0) | |
339 | return log_oom(); | |
340 | ||
341 | arg_pkcs11_uri_auto = false; | |
342 | } | |
08669709 | 343 | |
2bc5c425 LP |
344 | } else if ((val = startswith(option, "fido2-device="))) { |
345 | ||
346 | if (streq(val, "auto")) { | |
347 | arg_fido2_device = mfree(arg_fido2_device); | |
348 | arg_fido2_device_auto = true; | |
349 | } else { | |
350 | r = free_and_strdup(&arg_fido2_device, val); | |
351 | if (r < 0) | |
352 | return log_oom(); | |
353 | ||
354 | arg_fido2_device_auto = false; | |
355 | } | |
356 | ||
357 | } else if ((val = startswith(option, "fido2-cid="))) { | |
358 | ||
359 | if (streq(val, "auto")) | |
360 | arg_fido2_cid = mfree(arg_fido2_cid); | |
361 | else { | |
362 | _cleanup_free_ void *cid = NULL; | |
363 | size_t cid_size; | |
364 | ||
f5fbe71d | 365 | r = unbase64mem(val, SIZE_MAX, &cid, &cid_size); |
2bc5c425 LP |
366 | if (r < 0) |
367 | return log_error_errno(r, "Failed to decode FIDO2 CID data: %m"); | |
368 | ||
369 | free(arg_fido2_cid); | |
370 | arg_fido2_cid = TAKE_PTR(cid); | |
371 | arg_fido2_cid_size = cid_size; | |
372 | } | |
373 | ||
374 | /* Turn on FIDO2 as side-effect, if not turned on yet. */ | |
375 | if (!arg_fido2_device && !arg_fido2_device_auto) | |
376 | arg_fido2_device_auto = true; | |
377 | ||
378 | } else if ((val = startswith(option, "fido2-rp="))) { | |
379 | ||
380 | r = free_and_strdup(&arg_fido2_rp_id, val); | |
381 | if (r < 0) | |
382 | return log_oom(); | |
383 | ||
18843ecc LP |
384 | } else if ((val = startswith(option, "tpm2-device="))) { |
385 | ||
386 | if (streq(val, "auto")) { | |
387 | arg_tpm2_device = mfree(arg_tpm2_device); | |
388 | arg_tpm2_device_auto = true; | |
389 | } else { | |
390 | r = free_and_strdup(&arg_tpm2_device, val); | |
391 | if (r < 0) | |
392 | return log_oom(); | |
393 | ||
394 | arg_tpm2_device_auto = false; | |
395 | } | |
396 | ||
397 | } else if ((val = startswith(option, "tpm2-pcrs="))) { | |
398 | ||
222a951f LP |
399 | r = tpm2_parse_pcr_argument(val, &arg_tpm2_pcr_mask); |
400 | if (r < 0) | |
401 | return r; | |
18843ecc | 402 | |
dc63b2c9 LP |
403 | } else if ((val = startswith(option, "tpm2-signature="))) { |
404 | ||
405 | if (!path_is_absolute(val)) | |
406 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
407 | "TPM2 signature path \"%s\" is not absolute, refusing.", val); | |
408 | ||
409 | r = free_and_strdup(&arg_tpm2_signature, val); | |
410 | if (r < 0) | |
411 | return log_oom(); | |
412 | ||
4005d41e GG |
413 | } else if ((val = startswith(option, "tpm2-pin="))) { |
414 | ||
415 | r = parse_boolean(val); | |
416 | if (r < 0) { | |
417 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
418 | return 0; | |
419 | } | |
420 | ||
421 | arg_tpm2_pin = r; | |
422 | ||
0ba6f85e LP |
423 | } else if ((val = startswith(option, "try-empty-password="))) { |
424 | ||
425 | r = parse_boolean(val); | |
426 | if (r < 0) { | |
427 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
428 | return 0; | |
429 | } | |
430 | ||
431 | arg_try_empty_password = r; | |
432 | ||
433 | } else if (streq(option, "try-empty-password")) | |
434 | arg_try_empty_password = true; | |
cd5f57bd LB |
435 | else if ((val = startswith(option, "headless="))) { |
436 | ||
437 | r = parse_boolean(val); | |
438 | if (r < 0) { | |
439 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
440 | return 0; | |
441 | } | |
442 | ||
443 | arg_headless = r; | |
444 | } else if (streq(option, "headless")) | |
445 | arg_headless = true; | |
0ba6f85e | 446 | |
5cbe70af LP |
447 | else if ((val = startswith(option, "token-timeout="))) { |
448 | ||
449 | r = parse_sec_fix_0(val, &arg_token_timeout_usec); | |
450 | if (r < 0) { | |
451 | log_error_errno(r, "Failed to parse %s, ignoring: %m", option); | |
452 | return 0; | |
453 | } | |
454 | ||
455 | } else if (!streq(option, "x-initrd.attach")) | |
fb4650aa | 456 | log_warning("Encountered unknown /etc/crypttab option '%s', ignoring.", option); |
7f4e0805 LP |
457 | |
458 | return 0; | |
459 | } | |
460 | ||
461 | static int parse_options(const char *options) { | |
7f4e0805 LP |
462 | assert(options); |
463 | ||
dd2fff3a ZJS |
464 | for (;;) { |
465 | _cleanup_free_ char *word = NULL; | |
466 | int r; | |
467 | ||
7bb553bb | 468 | r = extract_first_word(&options, &word, ",", EXTRACT_DONT_COALESCE_SEPARATORS | EXTRACT_UNESCAPE_SEPARATORS); |
dd2fff3a | 469 | if (r < 0) |
be36bc1e | 470 | return log_error_errno(r, "Failed to parse options: %m"); |
dd2fff3a ZJS |
471 | if (r == 0) |
472 | break; | |
7f4e0805 | 473 | |
dd2fff3a | 474 | r = parse_one_option(word); |
7f4e0805 LP |
475 | if (r < 0) |
476 | return r; | |
477 | } | |
478 | ||
4eac2773 | 479 | /* sanity-check options */ |
9c5253ff LP |
480 | if (arg_type && !streq(arg_type, CRYPT_PLAIN)) { |
481 | if (arg_offset != 0) | |
4eac2773 | 482 | log_warning("offset= ignored with type %s", arg_type); |
9c5253ff | 483 | if (arg_skip != 0) |
4eac2773 MP |
484 | log_warning("skip= ignored with type %s", arg_type); |
485 | } | |
486 | ||
7f4e0805 LP |
487 | return 0; |
488 | } | |
489 | ||
1ca208fb | 490 | static char* disk_description(const char *path) { |
f75cac37 | 491 | static const char name_fields[] = |
74b1c371 LP |
492 | "DM_NAME\0" |
493 | "ID_MODEL_FROM_DATABASE\0" | |
f75cac37 | 494 | "ID_MODEL\0"; |
74b1c371 | 495 | |
4afd3348 | 496 | _cleanup_(sd_device_unrefp) sd_device *device = NULL; |
2c740afd | 497 | const char *i, *name; |
b1a2da0a | 498 | struct stat st; |
b1a2da0a LP |
499 | |
500 | assert(path); | |
501 | ||
502 | if (stat(path, &st) < 0) | |
503 | return NULL; | |
504 | ||
505 | if (!S_ISBLK(st.st_mode)) | |
506 | return NULL; | |
507 | ||
930aa88f | 508 | if (sd_device_new_from_stat_rdev(&device, &st) < 0) |
1ca208fb | 509 | return NULL; |
b1a2da0a | 510 | |
fadd34dd LP |
511 | if (sd_device_get_property_value(device, "ID_PART_ENTRY_NAME", &name) >= 0) { |
512 | _cleanup_free_ char *unescaped = NULL; | |
e437538f | 513 | ssize_t l; |
fadd34dd LP |
514 | |
515 | /* ID_PART_ENTRY_NAME uses \x style escaping, using libblkid's blkid_encode_string(). Let's | |
516 | * reverse this here to make the string more human friendly in case people embed spaces or | |
517 | * other weird stuff. */ | |
518 | ||
e437538f ZJS |
519 | l = cunescape(name, UNESCAPE_RELAX, &unescaped); |
520 | if (l < 0) { | |
521 | log_debug_errno(l, "Failed to unescape ID_PART_ENTRY_NAME, skipping device: %m"); | |
fadd34dd LP |
522 | return NULL; |
523 | } | |
524 | ||
525 | if (!isempty(unescaped) && !string_has_cc(unescaped, NULL)) | |
526 | return TAKE_PTR(unescaped); | |
527 | } | |
528 | ||
529 | /* These need no unescaping. */ | |
2c740afd YW |
530 | NULSTR_FOREACH(i, name_fields) |
531 | if (sd_device_get_property_value(device, i, &name) >= 0 && | |
532 | !isempty(name)) | |
1ca208fb | 533 | return strdup(name); |
b1a2da0a | 534 | |
1ca208fb | 535 | return NULL; |
b1a2da0a LP |
536 | } |
537 | ||
b61e476f | 538 | static char *disk_mount_point(const char *label) { |
e7d90b71 | 539 | _cleanup_free_ char *device = NULL; |
5862d652 | 540 | _cleanup_endmntent_ FILE *f = NULL; |
b61e476f LP |
541 | struct mntent *m; |
542 | ||
543 | /* Yeah, we don't support native systemd unit files here for now */ | |
544 | ||
090685b5 LP |
545 | device = strjoin("/dev/mapper/", label); |
546 | if (!device) | |
5862d652 | 547 | return NULL; |
b61e476f | 548 | |
ed4ad488 | 549 | f = setmntent(fstab_path(), "re"); |
e0295d26 | 550 | if (!f) |
5862d652 | 551 | return NULL; |
b61e476f LP |
552 | |
553 | while ((m = getmntent(f))) | |
5862d652 ZJS |
554 | if (path_equal(m->mnt_fsname, device)) |
555 | return strdup(m->mnt_dir); | |
b61e476f | 556 | |
5862d652 | 557 | return NULL; |
b61e476f LP |
558 | } |
559 | ||
08669709 LP |
560 | static char *friendly_disk_name(const char *src, const char *vol) { |
561 | _cleanup_free_ char *description = NULL, *mount_point = NULL; | |
562 | char *name_buffer = NULL; | |
563 | int r; | |
e7d90b71 | 564 | |
e51b9486 | 565 | assert(src); |
08669709 | 566 | assert(vol); |
e7d90b71 | 567 | |
e51b9486 HH |
568 | description = disk_description(src); |
569 | mount_point = disk_mount_point(vol); | |
570 | ||
08669709 | 571 | /* If the description string is simply the volume name, then let's not show this twice */ |
ece174c5 | 572 | if (description && streq(vol, description)) |
97b11eed | 573 | description = mfree(description); |
e51b9486 HH |
574 | |
575 | if (mount_point && description) | |
576 | r = asprintf(&name_buffer, "%s (%s) on %s", description, vol, mount_point); | |
577 | else if (mount_point) | |
578 | r = asprintf(&name_buffer, "%s on %s", vol, mount_point); | |
579 | else if (description) | |
580 | r = asprintf(&name_buffer, "%s (%s)", description, vol); | |
08669709 LP |
581 | else |
582 | return strdup(vol); | |
e51b9486 | 583 | if (r < 0) |
08669709 LP |
584 | return NULL; |
585 | ||
586 | return name_buffer; | |
587 | } | |
588 | ||
b6c0bd11 AAF |
589 | static PassphraseType check_registered_passwords(struct crypt_device *cd) { |
590 | _cleanup_free_ bool *slots = NULL; | |
591 | int slot_max; | |
592 | PassphraseType passphrase_type = PASSPHRASE_NONE; | |
593 | ||
594 | assert(cd); | |
595 | ||
596 | if (!streq_ptr(crypt_get_type(cd), CRYPT_LUKS2)) { | |
597 | log_debug("%s: not a LUKS2 device, only passphrases are supported", crypt_get_device_name(cd)); | |
598 | return PASSPHRASE_REGULAR; | |
599 | } | |
600 | ||
601 | /* Search all used slots */ | |
602 | assert_se((slot_max = crypt_keyslot_max(CRYPT_LUKS2)) > 0); | |
603 | slots = new(bool, slot_max); | |
604 | if (!slots) | |
605 | return log_oom(); | |
606 | ||
607 | for (int slot = 0; slot < slot_max; slot++) | |
608 | slots[slot] = IN_SET(crypt_keyslot_status(cd, slot), CRYPT_SLOT_ACTIVE, CRYPT_SLOT_ACTIVE_LAST); | |
609 | ||
610 | /* Iterate all LUKS2 tokens and keep track of all their slots */ | |
611 | for (int token = 0; token < sym_crypt_token_max(CRYPT_LUKS2); token++) { | |
612 | _cleanup_(json_variant_unrefp) JsonVariant *v = NULL; | |
613 | const char *type; | |
614 | JsonVariant *w, *z; | |
615 | int tk; | |
616 | ||
617 | tk = cryptsetup_get_token_as_json(cd, token, NULL, &v); | |
618 | if (IN_SET(tk, -ENOENT, -EINVAL)) | |
619 | continue; | |
620 | if (tk < 0) { | |
621 | log_warning_errno(tk, "Failed to read JSON token data, ignoring: %m"); | |
622 | continue; | |
623 | } | |
624 | ||
625 | w = json_variant_by_key(v, "type"); | |
626 | if (!w || !json_variant_is_string(w)) { | |
627 | log_warning("Token JSON data lacks type field, ignoring."); | |
628 | continue; | |
629 | } | |
630 | ||
631 | type = json_variant_string(w); | |
632 | if (STR_IN_SET(type, "systemd-recovery", "systemd-pkcs11", "systemd-fido2", "systemd-tpm2")) { | |
633 | ||
634 | /* At least exists one recovery key */ | |
635 | if (streq(type, "systemd-recovery")) | |
636 | passphrase_type |= PASSPHRASE_RECOVERY_KEY; | |
637 | ||
638 | w = json_variant_by_key(v, "keyslots"); | |
639 | if (!w || !json_variant_is_array(w)) { | |
640 | log_warning("Token JSON data lacks keyslots field, ignoring."); | |
641 | continue; | |
642 | } | |
643 | ||
644 | JSON_VARIANT_ARRAY_FOREACH(z, w) { | |
645 | unsigned u; | |
646 | int at; | |
647 | ||
648 | if (!json_variant_is_string(z)) { | |
649 | log_warning("Token JSON data's keyslot field is not an array of strings, ignoring."); | |
650 | continue; | |
651 | } | |
652 | ||
653 | at = safe_atou(json_variant_string(z), &u); | |
654 | if (at < 0) { | |
655 | log_warning_errno(at, "Token JSON data's keyslot field is not an integer formatted as string, ignoring."); | |
656 | continue; | |
657 | } | |
658 | ||
659 | if (u >= (unsigned) slot_max) { | |
660 | log_warning_errno(at, "Token JSON data's keyslot field exceeds the maximum value allowed, ignoring."); | |
661 | continue; | |
662 | } | |
663 | ||
664 | slots[u] = false; | |
665 | } | |
666 | } | |
667 | } | |
668 | ||
669 | /* Check if any of the slots is not referenced by systemd tokens */ | |
670 | for (int slot = 0; slot < slot_max; slot++) | |
671 | if (slots[slot]) { | |
672 | passphrase_type |= PASSPHRASE_REGULAR; | |
673 | break; | |
674 | } | |
675 | ||
676 | /* All the slots are referenced by systemd tokens, so if a recovery key is not enrolled, | |
677 | * we will not be able to enter a passphrase. */ | |
678 | return passphrase_type; | |
679 | } | |
680 | ||
08669709 LP |
681 | static int get_password( |
682 | const char *vol, | |
683 | const char *src, | |
684 | usec_t until, | |
685 | bool accept_cached, | |
b6c0bd11 | 686 | PassphraseType passphrase_type, |
08669709 LP |
687 | char ***ret) { |
688 | ||
689 | _cleanup_free_ char *friendly = NULL, *text = NULL, *disk_path = NULL; | |
690 | _cleanup_strv_free_erase_ char **passwords = NULL; | |
de010b0b | 691 | char *id; |
08669709 | 692 | int r = 0; |
2cbca51a | 693 | AskPasswordFlags flags = arg_ask_password_flags | ASK_PASSWORD_PUSH_CACHE; |
08669709 LP |
694 | |
695 | assert(vol); | |
696 | assert(src); | |
697 | assert(ret); | |
698 | ||
cd5f57bd LB |
699 | if (arg_headless) |
700 | return log_error_errno(SYNTHETIC_ERRNO(ENOPKG), "Password querying disabled via 'headless' option."); | |
701 | ||
08669709 LP |
702 | friendly = friendly_disk_name(src, vol); |
703 | if (!friendly) | |
e51b9486 HH |
704 | return log_oom(); |
705 | ||
b6c0bd11 | 706 | if (asprintf(&text, "Please enter %s for disk %s:", passphrase_type_to_string(passphrase_type), friendly) < 0) |
08669709 | 707 | return log_oom(); |
e51b9486 | 708 | |
08669709 LP |
709 | disk_path = cescape(src); |
710 | if (!disk_path) | |
e7d90b71 JJ |
711 | return log_oom(); |
712 | ||
ea7e7c1e | 713 | id = strjoina("cryptsetup:", disk_path); |
9fa1de96 | 714 | |
8806bb4b | 715 | r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", "cryptsetup.passphrase", until, |
1fa94a31 | 716 | flags | (accept_cached*ASK_PASSWORD_ACCEPT_CACHED), |
ab84f5b9 | 717 | &passwords); |
23bbb0de MS |
718 | if (r < 0) |
719 | return log_error_errno(r, "Failed to query password: %m"); | |
e7d90b71 | 720 | |
f75cac37 | 721 | if (arg_verify) { |
ab84f5b9 ZJS |
722 | _cleanup_strv_free_erase_ char **passwords2 = NULL; |
723 | ||
1602b008 | 724 | assert(strv_length(passwords) == 1); |
e7d90b71 | 725 | |
b6c0bd11 | 726 | if (asprintf(&text, "Please enter %s for disk %s (verification):", passphrase_type_to_string(passphrase_type), friendly) < 0) |
ab84f5b9 | 727 | return log_oom(); |
e7d90b71 | 728 | |
ea7e7c1e | 729 | id = strjoina("cryptsetup-verification:", disk_path); |
9fa1de96 | 730 | |
1fa94a31 | 731 | r = ask_password_auto(text, "drive-harddisk", id, "cryptsetup", "cryptsetup.passphrase", until, flags, &passwords2); |
ab84f5b9 ZJS |
732 | if (r < 0) |
733 | return log_error_errno(r, "Failed to query verification password: %m"); | |
e7d90b71 JJ |
734 | |
735 | assert(strv_length(passwords2) == 1); | |
736 | ||
8bc6ade7 LP |
737 | if (!streq(passwords[0], passwords2[0])) |
738 | return log_warning_errno(SYNTHETIC_ERRNO(EAGAIN), | |
739 | "Passwords did not match, retrying."); | |
e7d90b71 JJ |
740 | } |
741 | ||
1602b008 | 742 | strv_uniq(passwords); |
e7d90b71 | 743 | |
1602b008 | 744 | STRV_FOREACH(p, passwords) { |
e7d90b71 JJ |
745 | char *c; |
746 | ||
f75cac37 | 747 | if (strlen(*p)+1 >= arg_key_size) |
e7d90b71 JJ |
748 | continue; |
749 | ||
750 | /* Pad password if necessary */ | |
1602b008 | 751 | c = new(char, arg_key_size); |
ab84f5b9 ZJS |
752 | if (!c) |
753 | return log_oom(); | |
e7d90b71 | 754 | |
f75cac37 | 755 | strncpy(c, *p, arg_key_size); |
d3ad474f LP |
756 | erase_and_free(*p); |
757 | *p = TAKE_PTR(c); | |
e7d90b71 JJ |
758 | } |
759 | ||
ae2a15bc | 760 | *ret = TAKE_PTR(passwords); |
1602b008 | 761 | |
ab84f5b9 | 762 | return 0; |
e7d90b71 JJ |
763 | } |
764 | ||
1602b008 LP |
765 | static int attach_tcrypt( |
766 | struct crypt_device *cd, | |
767 | const char *name, | |
768 | const char *key_file, | |
7407f689 LP |
769 | const void *key_data, |
770 | size_t key_data_size, | |
1602b008 LP |
771 | char **passwords, |
772 | uint32_t flags) { | |
773 | ||
8cf3ca80 | 774 | int r = 0; |
d3ad474f | 775 | _cleanup_(erase_and_freep) char *passphrase = NULL; |
8cf3ca80 JJ |
776 | struct crypt_params_tcrypt params = { |
777 | .flags = CRYPT_TCRYPT_LEGACY_MODES, | |
f75cac37 LP |
778 | .keyfiles = (const char **)arg_tcrypt_keyfiles, |
779 | .keyfiles_count = strv_length(arg_tcrypt_keyfiles) | |
8cf3ca80 JJ |
780 | }; |
781 | ||
782 | assert(cd); | |
783 | assert(name); | |
7407f689 | 784 | assert(key_file || key_data || !strv_isempty(passwords)); |
8cf3ca80 | 785 | |
18843ecc | 786 | if (arg_pkcs11_uri || arg_pkcs11_uri_auto || arg_fido2_device || arg_fido2_device_auto || arg_tpm2_device || arg_tpm2_device_auto) |
e514aa1e FS |
787 | /* Ask for a regular password */ |
788 | return log_error_errno(SYNTHETIC_ERRNO(EAGAIN), | |
18843ecc | 789 | "Sorry, but tcrypt devices are currently not supported in conjunction with pkcs11/fido2/tpm2 support."); |
08669709 | 790 | |
f75cac37 | 791 | if (arg_tcrypt_hidden) |
8cf3ca80 JJ |
792 | params.flags |= CRYPT_TCRYPT_HIDDEN_HEADER; |
793 | ||
f75cac37 | 794 | if (arg_tcrypt_system) |
8cf3ca80 JJ |
795 | params.flags |= CRYPT_TCRYPT_SYSTEM_HEADER; |
796 | ||
52028838 GH |
797 | if (arg_tcrypt_veracrypt) |
798 | params.flags |= CRYPT_TCRYPT_VERA_MODES; | |
52028838 | 799 | |
7407f689 LP |
800 | if (key_data) { |
801 | params.passphrase = key_data; | |
802 | params.passphrase_size = key_data_size; | |
803 | } else { | |
804 | if (key_file) { | |
805 | r = read_one_line_file(key_file, &passphrase); | |
806 | if (r < 0) { | |
807 | log_error_errno(r, "Failed to read password file '%s': %m", key_file); | |
808 | return -EAGAIN; /* log with the actual error, but return EAGAIN */ | |
809 | } | |
8cf3ca80 | 810 | |
7407f689 LP |
811 | params.passphrase = passphrase; |
812 | } else | |
813 | params.passphrase = passwords[0]; | |
814 | ||
815 | params.passphrase_size = strlen(params.passphrase); | |
816 | } | |
8cf3ca80 JJ |
817 | |
818 | r = crypt_load(cd, CRYPT_TCRYPT, ¶ms); | |
819 | if (r < 0) { | |
7407f689 | 820 | if (r == -EPERM) { |
cb6c9283 | 821 | if (key_data) |
7407f689 | 822 | log_error_errno(r, "Failed to activate using discovered key. (Key not correct?)"); |
7407f689 | 823 | |
cb6c9283 | 824 | if (key_file) |
7407f689 | 825 | log_error_errno(r, "Failed to activate using password file '%s'. (Key data not correct?)", key_file); |
cb6c9283 LP |
826 | |
827 | return -EAGAIN; /* log the actual error, but return EAGAIN */ | |
6f177c7d LP |
828 | } |
829 | ||
830 | return log_error_errno(r, "Failed to load tcrypt superblock on device %s: %m", crypt_get_device_name(cd)); | |
8cf3ca80 JJ |
831 | } |
832 | ||
6f177c7d LP |
833 | r = crypt_activate_by_volume_key(cd, name, NULL, 0, flags); |
834 | if (r < 0) | |
835 | return log_error_errno(r, "Failed to activate tcrypt device %s: %m", crypt_get_device_name(cd)); | |
836 | ||
837 | return 0; | |
8cf3ca80 JJ |
838 | } |
839 | ||
e2c2f868 LP |
840 | static char *make_bindname(const char *volume) { |
841 | char *s; | |
842 | ||
843 | if (asprintf(&s, "@%" PRIx64"/cryptsetup/%s", random_u64(), volume) < 0) | |
844 | return NULL; | |
845 | ||
846 | return s; | |
847 | } | |
848 | ||
5cbe70af LP |
849 | static int make_security_device_monitor( |
850 | sd_event **ret_event, | |
851 | sd_device_monitor **ret_monitor) { | |
8414cd48 | 852 | _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL; |
5cbe70af | 853 | _cleanup_(sd_event_unrefp) sd_event *event = NULL; |
8414cd48 LP |
854 | int r; |
855 | ||
5cbe70af LP |
856 | assert(ret_event); |
857 | assert(ret_monitor); | |
858 | ||
859 | /* Waits for a device with "security-device" tag to show up in udev */ | |
860 | ||
861 | r = sd_event_default(&event); | |
862 | if (r < 0) | |
863 | return log_error_errno(r, "Failed to allocate event loop: %m"); | |
864 | ||
865 | r = sd_event_add_time_relative(event, NULL, CLOCK_MONOTONIC, arg_token_timeout_usec, USEC_PER_SEC, NULL, INT_TO_PTR(-ETIMEDOUT)); | |
866 | if (r < 0) | |
867 | return log_error_errno(r, "Failed to install timeout event source: %m"); | |
8414cd48 LP |
868 | |
869 | r = sd_device_monitor_new(&monitor); | |
870 | if (r < 0) | |
871 | return log_error_errno(r, "Failed to allocate device monitor: %m"); | |
872 | ||
17bf3c55 YW |
873 | (void) sd_device_monitor_set_description(monitor, "security-device"); |
874 | ||
8414cd48 LP |
875 | r = sd_device_monitor_filter_add_match_tag(monitor, "security-device"); |
876 | if (r < 0) | |
877 | return log_error_errno(r, "Failed to configure device monitor: %m"); | |
878 | ||
879 | r = sd_device_monitor_attach_event(monitor, event); | |
880 | if (r < 0) | |
881 | return log_error_errno(r, "Failed to attach device monitor: %m"); | |
882 | ||
883 | r = sd_device_monitor_start(monitor, NULL, NULL); | |
884 | if (r < 0) | |
885 | return log_error_errno(r, "Failed to start device monitor: %m"); | |
886 | ||
5cbe70af LP |
887 | *ret_event = TAKE_PTR(event); |
888 | *ret_monitor = TAKE_PTR(monitor); | |
8414cd48 LP |
889 | return 0; |
890 | } | |
891 | ||
5cbe70af LP |
892 | static int run_security_device_monitor( |
893 | sd_event *event, | |
894 | sd_device_monitor *monitor) { | |
895 | bool processed = false; | |
896 | int r; | |
897 | ||
898 | assert(event); | |
899 | assert(monitor); | |
900 | ||
901 | /* Runs the event loop for the device monitor until either something happens, or the time-out is | |
902 | * hit. */ | |
903 | ||
904 | for (;;) { | |
905 | int x; | |
906 | ||
907 | r = sd_event_get_exit_code(event, &x); | |
908 | if (r < 0) { | |
909 | if (r != -ENODATA) | |
910 | return log_error_errno(r, "Failed to query exit code from event loop: %m"); | |
911 | ||
912 | /* On ENODATA we aren't told to exit yet. */ | |
913 | } else { | |
914 | assert(x == -ETIMEDOUT); | |
915 | return log_notice_errno(SYNTHETIC_ERRNO(EAGAIN), | |
916 | "Timed out waiting for security device, aborting security device based authentication attempt."); | |
917 | } | |
918 | ||
919 | /* Wait for one event, and then eat all subsequent events until there are no further ones */ | |
920 | r = sd_event_run(event, processed ? 0 : UINT64_MAX); | |
921 | if (r < 0) | |
922 | return log_error_errno(r, "Failed to run event loop: %m"); | |
923 | if (r == 0) /* no events queued anymore */ | |
924 | return 0; | |
925 | ||
926 | processed = true; | |
927 | } | |
928 | } | |
929 | ||
351716e1 OK |
930 | static bool libcryptsetup_plugins_support(void) { |
931 | #if HAVE_LIBCRYPTSETUP_PLUGINS | |
64c590fb LP |
932 | int r; |
933 | ||
934 | /* Permit a way to disable libcryptsetup token module support, for debugging purposes. */ | |
935 | r = getenv_bool("SYSTEMD_CRYPTSETUP_USE_TOKEN_MODULE"); | |
936 | if (r < 0 && r != -ENXIO) | |
937 | log_debug_errno(r, "Failed to parse $SYSTEMD_CRYPTSETUP_USE_TOKEN_MODULE env var: %m"); | |
938 | if (r == 0) | |
939 | return false; | |
940 | ||
941 | return crypt_token_external_path(); | |
351716e1 OK |
942 | #else |
943 | return false; | |
944 | #endif | |
945 | } | |
946 | ||
947 | #if HAVE_LIBCRYPTSETUP_PLUGINS | |
948 | static int acquire_pins_from_env_variable(char ***ret_pins) { | |
e99ca147 | 949 | _cleanup_(erase_and_freep) char *envpin = NULL; |
351716e1 | 950 | _cleanup_strv_free_erase_ char **pins = NULL; |
e99ca147 | 951 | int r; |
351716e1 OK |
952 | |
953 | assert(ret_pins); | |
954 | ||
e99ca147 LP |
955 | r = getenv_steal_erase("PIN", &envpin); |
956 | if (r < 0) | |
957 | return log_error_errno(r, "Failed to acquire PIN from environment: %m"); | |
958 | if (r > 0) { | |
959 | pins = strv_new(envpin); | |
351716e1 OK |
960 | if (!pins) |
961 | return log_oom(); | |
351716e1 OK |
962 | } |
963 | ||
964 | *ret_pins = TAKE_PTR(pins); | |
965 | ||
966 | return 0; | |
967 | } | |
968 | #endif | |
969 | ||
d1411499 | 970 | static int crypt_activate_by_token_pin_ask_password( |
351716e1 OK |
971 | struct crypt_device *cd, |
972 | const char *name, | |
d1411499 | 973 | const char *type, |
351716e1 OK |
974 | usec_t until, |
975 | bool headless, | |
976 | void *usrptr, | |
d1411499 JW |
977 | uint32_t activation_flags, |
978 | const char *message, | |
979 | const char *key_name, | |
980 | const char *credential_name) { | |
351716e1 | 981 | |
351716e1 | 982 | #if HAVE_LIBCRYPTSETUP_PLUGINS |
351716e1 | 983 | AskPasswordFlags flags = ASK_PASSWORD_PUSH_CACHE | ASK_PASSWORD_ACCEPT_CACHED; |
a2236110 | 984 | _cleanup_strv_free_erase_ char **pins = NULL; |
a2236110 | 985 | int r; |
351716e1 | 986 | |
d1411499 | 987 | r = crypt_activate_by_token_pin(cd, name, type, CRYPT_ANY_TOKEN, NULL, 0, usrptr, activation_flags); |
351716e1 OK |
988 | if (r > 0) /* returns unlocked keyslot id on success */ |
989 | r = 0; | |
990 | if (r != -ENOANO) /* needs pin or pin is wrong */ | |
991 | return r; | |
992 | ||
993 | r = acquire_pins_from_env_variable(&pins); | |
994 | if (r < 0) | |
995 | return r; | |
996 | ||
997 | STRV_FOREACH(p, pins) { | |
d1411499 | 998 | r = crypt_activate_by_token_pin(cd, name, type, CRYPT_ANY_TOKEN, *p, strlen(*p), usrptr, activation_flags); |
351716e1 OK |
999 | if (r > 0) /* returns unlocked keyslot id on success */ |
1000 | r = 0; | |
1001 | if (r != -ENOANO) /* needs pin or pin is wrong */ | |
1002 | return r; | |
1003 | } | |
1004 | ||
1005 | if (headless) | |
1006 | return log_error_errno(SYNTHETIC_ERRNO(ENOPKG), "PIN querying disabled via 'headless' option. Use the '$PIN' environment variable."); | |
1007 | ||
351716e1 OK |
1008 | for (;;) { |
1009 | pins = strv_free_erase(pins); | |
d1411499 | 1010 | r = ask_password_auto(message, "drive-harddisk", NULL, key_name, credential_name, until, flags, &pins); |
351716e1 OK |
1011 | if (r < 0) |
1012 | return r; | |
1013 | ||
1014 | STRV_FOREACH(p, pins) { | |
d1411499 | 1015 | r = crypt_activate_by_token_pin(cd, name, type, CRYPT_ANY_TOKEN, *p, strlen(*p), usrptr, activation_flags); |
351716e1 OK |
1016 | if (r > 0) /* returns unlocked keyslot id on success */ |
1017 | r = 0; | |
1018 | if (r != -ENOANO) /* needs pin or pin is wrong */ | |
1019 | return r; | |
1020 | } | |
92828080 LP |
1021 | |
1022 | flags &= ~ASK_PASSWORD_ACCEPT_CACHED; | |
351716e1 | 1023 | } |
351716e1 | 1024 | return r; |
a2236110 LP |
1025 | #else |
1026 | return -EOPNOTSUPP; | |
1027 | #endif | |
351716e1 OK |
1028 | } |
1029 | ||
d1411499 JW |
1030 | static int attach_luks2_by_fido2_via_plugin( |
1031 | struct crypt_device *cd, | |
1032 | const char *name, | |
1033 | usec_t until, | |
1034 | bool headless, | |
1035 | void *usrptr, | |
1036 | uint32_t activation_flags) { | |
1037 | ||
1038 | return crypt_activate_by_token_pin_ask_password( | |
1039 | cd, | |
1040 | name, | |
1041 | "systemd-fido2", | |
1042 | until, | |
1043 | headless, | |
1044 | usrptr, | |
1045 | activation_flags, | |
1046 | "Please enter security token PIN:", | |
1047 | "fido2-pin", | |
1048 | "cryptsetup.fido2-pin"); | |
1049 | } | |
1050 | ||
2bc5c425 LP |
1051 | static int attach_luks_or_plain_or_bitlk_by_fido2( |
1052 | struct crypt_device *cd, | |
1053 | const char *name, | |
1054 | const char *key_file, | |
1055 | const void *key_data, | |
1056 | size_t key_data_size, | |
1057 | usec_t until, | |
1058 | uint32_t flags, | |
1059 | bool pass_volume_key) { | |
1060 | ||
1061 | _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL; | |
1062 | _cleanup_(erase_and_freep) void *decrypted_key = NULL; | |
1063 | _cleanup_(sd_event_unrefp) sd_event *event = NULL; | |
1064 | _cleanup_free_ void *discovered_salt = NULL, *discovered_cid = NULL; | |
351716e1 | 1065 | size_t discovered_salt_size, discovered_cid_size, decrypted_key_size, cid_size = 0; |
2bc5c425 LP |
1066 | _cleanup_free_ char *friendly = NULL, *discovered_rp_id = NULL; |
1067 | int keyslot = arg_key_slot, r; | |
351716e1 OK |
1068 | const char *rp_id = NULL; |
1069 | const void *cid = NULL; | |
cde2f860 | 1070 | Fido2EnrollFlags required; |
351716e1 | 1071 | bool use_libcryptsetup_plugin = libcryptsetup_plugins_support(); |
2bc5c425 LP |
1072 | |
1073 | assert(cd); | |
1074 | assert(name); | |
1075 | assert(arg_fido2_device || arg_fido2_device_auto); | |
1076 | ||
1077 | if (arg_fido2_cid) { | |
1078 | if (!key_file && !key_data) | |
8205c151 ZJS |
1079 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), |
1080 | "FIDO2 mode with manual parameters selected, but no keyfile specified, refusing."); | |
2bc5c425 LP |
1081 | |
1082 | rp_id = arg_fido2_rp_id; | |
1083 | cid = arg_fido2_cid; | |
1084 | cid_size = arg_fido2_cid_size; | |
8205c151 | 1085 | |
3cc00ba6 LP |
1086 | /* For now and for compatibility, if the user explicitly configured FIDO2 support and we do |
1087 | * not read FIDO2 metadata off the LUKS2 header, default to the systemd 248 logic, where we | |
1088 | * use PIN + UP when needed, and do not configure UV at all. Eventually, we should make this | |
1089 | * explicitly configurable. */ | |
1090 | required = FIDO2ENROLL_PIN_IF_NEEDED | FIDO2ENROLL_UP_IF_NEEDED | FIDO2ENROLL_UV_OMIT; | |
351716e1 | 1091 | } else if (!use_libcryptsetup_plugin) { |
2bc5c425 LP |
1092 | r = find_fido2_auto_data( |
1093 | cd, | |
1094 | &discovered_rp_id, | |
1095 | &discovered_salt, | |
1096 | &discovered_salt_size, | |
1097 | &discovered_cid, | |
1098 | &discovered_cid_size, | |
cde2f860 LB |
1099 | &keyslot, |
1100 | &required); | |
2bc5c425 LP |
1101 | |
1102 | if (IN_SET(r, -ENOTUNIQ, -ENXIO)) | |
1103 | return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), | |
1104 | "Automatic FIDO2 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking."); | |
1105 | if (r < 0) | |
1106 | return r; | |
1107 | ||
9d59f5b2 | 1108 | if ((required & (FIDO2ENROLL_PIN | FIDO2ENROLL_UP | FIDO2ENROLL_UV)) && arg_headless) |
cde2f860 | 1109 | return log_error_errno(SYNTHETIC_ERRNO(ENOPKG), |
06f08719 | 1110 | "Local verification is required to unlock this volume, but the 'headless' parameter was set."); |
cde2f860 | 1111 | |
2bc5c425 LP |
1112 | rp_id = discovered_rp_id; |
1113 | key_data = discovered_salt; | |
1114 | key_data_size = discovered_salt_size; | |
1115 | cid = discovered_cid; | |
1116 | cid_size = discovered_cid_size; | |
1117 | } | |
1118 | ||
1119 | friendly = friendly_disk_name(crypt_get_device_name(cd), name); | |
1120 | if (!friendly) | |
1121 | return log_oom(); | |
1122 | ||
1123 | for (;;) { | |
351716e1 | 1124 | if (use_libcryptsetup_plugin && !arg_fido2_cid) { |
dcbc38c9 | 1125 | r = attach_luks2_by_fido2_via_plugin(cd, name, until, arg_headless, arg_fido2_device, flags); |
351716e1 OK |
1126 | if (IN_SET(r, -ENOTUNIQ, -ENXIO, -ENOENT)) |
1127 | return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), | |
1128 | "Automatic FIDO2 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking."); | |
1129 | ||
1130 | } else { | |
1131 | r = acquire_fido2_key( | |
1132 | name, | |
1133 | friendly, | |
1134 | arg_fido2_device, | |
1135 | rp_id, | |
1136 | cid, cid_size, | |
1137 | key_file, arg_keyfile_size, arg_keyfile_offset, | |
1138 | key_data, key_data_size, | |
1139 | until, | |
1140 | arg_headless, | |
1141 | required, | |
1142 | &decrypted_key, &decrypted_key_size, | |
1143 | arg_ask_password_flags); | |
1144 | if (r >= 0) | |
1145 | break; | |
1146 | } | |
1147 | ||
2bc5c425 LP |
1148 | if (r != -EAGAIN) /* EAGAIN means: token not found */ |
1149 | return r; | |
1150 | ||
1151 | if (!monitor) { | |
1152 | /* We didn't find the token. In this case, watch for it via udev. Let's | |
1153 | * create an event loop and monitor first. */ | |
1154 | ||
1155 | assert(!event); | |
1156 | ||
5cbe70af | 1157 | r = make_security_device_monitor(&event, &monitor); |
2bc5c425 LP |
1158 | if (r < 0) |
1159 | return r; | |
1160 | ||
1161 | log_notice("Security token not present for unlocking volume %s, please plug it in.", friendly); | |
1162 | ||
1163 | /* Let's immediately rescan in case the token appeared in the time we needed | |
1164 | * to create and configure the monitor */ | |
1165 | continue; | |
1166 | } | |
1167 | ||
5cbe70af LP |
1168 | r = run_security_device_monitor(event, monitor); |
1169 | if (r < 0) | |
1170 | return r; | |
2bc5c425 LP |
1171 | |
1172 | log_debug("Got one or more potentially relevant udev events, rescanning FIDO2..."); | |
1173 | } | |
1174 | ||
1175 | if (pass_volume_key) | |
1176 | r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags); | |
1177 | else { | |
1178 | _cleanup_(erase_and_freep) char *base64_encoded = NULL; | |
1179 | ||
1180 | /* Before using this key as passphrase we base64 encode it, for compat with homed */ | |
1181 | ||
1182 | r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded); | |
1183 | if (r < 0) | |
1184 | return log_oom(); | |
1185 | ||
1186 | r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags); | |
1187 | } | |
1188 | if (r == -EPERM) { | |
1189 | log_error_errno(r, "Failed to activate with FIDO2 decrypted key. (Key incorrect?)"); | |
1190 | return -EAGAIN; /* log actual error, but return EAGAIN */ | |
1191 | } | |
1192 | if (r < 0) | |
1193 | return log_error_errno(r, "Failed to activate with FIDO2 acquired key: %m"); | |
1194 | ||
1195 | return 0; | |
1196 | } | |
1197 | ||
dcbc38c9 | 1198 | static int attach_luks2_by_pkcs11_via_plugin( |
8186022c OK |
1199 | struct crypt_device *cd, |
1200 | const char *name, | |
1201 | const char *friendly_name, | |
1202 | usec_t until, | |
1203 | bool headless, | |
1204 | uint32_t flags) { | |
1205 | ||
8186022c | 1206 | #if HAVE_LIBCRYPTSETUP_PLUGINS |
a2236110 LP |
1207 | int r; |
1208 | ||
1209 | if (!streq_ptr(crypt_get_type(cd), CRYPT_LUKS2)) | |
8186022c OK |
1210 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Automatic PKCS#11 metadata requires LUKS2 device."); |
1211 | ||
1212 | systemd_pkcs11_plugin_params params = { | |
1213 | .friendly_name = friendly_name, | |
1214 | .until = until, | |
1215 | .headless = headless | |
1216 | }; | |
1217 | ||
1218 | r = crypt_activate_by_token_pin(cd, name, "systemd-pkcs11", CRYPT_ANY_TOKEN, NULL, 0, ¶ms, flags); | |
1219 | if (r > 0) /* returns unlocked keyslot id on success */ | |
1220 | r = 0; | |
a2236110 | 1221 | |
8186022c | 1222 | return r; |
a2236110 LP |
1223 | #else |
1224 | return -EOPNOTSUPP; | |
1225 | #endif | |
8186022c OK |
1226 | } |
1227 | ||
b8c80b56 LP |
1228 | static int attach_luks_or_plain_or_bitlk_by_pkcs11( |
1229 | struct crypt_device *cd, | |
1230 | const char *name, | |
1231 | const char *key_file, | |
1232 | const void *key_data, | |
1233 | size_t key_data_size, | |
1234 | usec_t until, | |
1235 | uint32_t flags, | |
1236 | bool pass_volume_key) { | |
1237 | ||
1238 | _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL; | |
1239 | _cleanup_free_ char *friendly = NULL, *discovered_uri = NULL; | |
1240 | size_t decrypted_key_size = 0, discovered_key_size = 0; | |
1241 | _cleanup_(erase_and_freep) void *decrypted_key = NULL; | |
1242 | _cleanup_(sd_event_unrefp) sd_event *event = NULL; | |
1243 | _cleanup_free_ void *discovered_key = NULL; | |
1244 | int keyslot = arg_key_slot, r; | |
8186022c OK |
1245 | const char *uri = NULL; |
1246 | bool use_libcryptsetup_plugin = libcryptsetup_plugins_support(); | |
b8c80b56 LP |
1247 | |
1248 | assert(cd); | |
1249 | assert(name); | |
1250 | assert(arg_pkcs11_uri || arg_pkcs11_uri_auto); | |
1251 | ||
1252 | if (arg_pkcs11_uri_auto) { | |
8186022c OK |
1253 | if (!use_libcryptsetup_plugin) { |
1254 | r = find_pkcs11_auto_data(cd, &discovered_uri, &discovered_key, &discovered_key_size, &keyslot); | |
1255 | if (IN_SET(r, -ENOTUNIQ, -ENXIO)) | |
1256 | return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), | |
1257 | "Automatic PKCS#11 metadata discovery was not possible because missing or not unique, falling back to traditional unlocking."); | |
1258 | if (r < 0) | |
1259 | return r; | |
b8c80b56 | 1260 | |
8186022c OK |
1261 | uri = discovered_uri; |
1262 | key_data = discovered_key; | |
1263 | key_data_size = discovered_key_size; | |
1264 | } | |
b8c80b56 LP |
1265 | } else { |
1266 | uri = arg_pkcs11_uri; | |
1267 | ||
1268 | if (!key_file && !key_data) | |
1269 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "PKCS#11 mode selected but no key file specified, refusing."); | |
1270 | } | |
1271 | ||
1272 | friendly = friendly_disk_name(crypt_get_device_name(cd), name); | |
1273 | if (!friendly) | |
1274 | return log_oom(); | |
1275 | ||
1276 | for (;;) { | |
8186022c | 1277 | if (use_libcryptsetup_plugin && arg_pkcs11_uri_auto) |
dcbc38c9 | 1278 | r = attach_luks2_by_pkcs11_via_plugin(cd, name, friendly, until, arg_headless, flags); |
8186022c OK |
1279 | else { |
1280 | r = decrypt_pkcs11_key( | |
1281 | name, | |
1282 | friendly, | |
1283 | uri, | |
1284 | key_file, arg_keyfile_size, arg_keyfile_offset, | |
1285 | key_data, key_data_size, | |
1286 | until, | |
1287 | arg_headless, | |
1288 | &decrypted_key, &decrypted_key_size); | |
1289 | if (r >= 0) | |
1290 | break; | |
1291 | } | |
1292 | ||
b8c80b56 LP |
1293 | if (r != -EAGAIN) /* EAGAIN means: token not found */ |
1294 | return r; | |
1295 | ||
1296 | if (!monitor) { | |
1297 | /* We didn't find the token. In this case, watch for it via udev. Let's | |
1298 | * create an event loop and monitor first. */ | |
1299 | ||
1300 | assert(!event); | |
1301 | ||
5cbe70af | 1302 | r = make_security_device_monitor(&event, &monitor); |
b8c80b56 LP |
1303 | if (r < 0) |
1304 | return r; | |
1305 | ||
1306 | log_notice("Security token %s not present for unlocking volume %s, please plug it in.", | |
1307 | uri, friendly); | |
1308 | ||
1309 | /* Let's immediately rescan in case the token appeared in the time we needed | |
1310 | * to create and configure the monitor */ | |
1311 | continue; | |
1312 | } | |
1313 | ||
5cbe70af LP |
1314 | r = run_security_device_monitor(event, monitor); |
1315 | if (r < 0) | |
1316 | return r; | |
b8c80b56 LP |
1317 | |
1318 | log_debug("Got one or more potentially relevant udev events, rescanning PKCS#11..."); | |
1319 | } | |
8186022c | 1320 | assert(decrypted_key); |
b8c80b56 LP |
1321 | |
1322 | if (pass_volume_key) | |
1323 | r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags); | |
1324 | else { | |
1325 | _cleanup_(erase_and_freep) char *base64_encoded = NULL; | |
1326 | ||
1327 | /* Before using this key as passphrase we base64 encode it. Why? For compatibility | |
1328 | * with homed's PKCS#11 hookup: there we want to use the key we acquired through | |
1329 | * PKCS#11 for other authentication/decryption mechanisms too, and some of them do | |
ad337e55 | 1330 | * not take arbitrary binary blobs, but require NUL-terminated strings — most |
b8c80b56 LP |
1331 | * importantly UNIX password hashes. Hence, for compatibility we want to use a string |
1332 | * without embedded NUL here too, and that's easiest to generate from a binary blob | |
1333 | * via base64 encoding. */ | |
1334 | ||
1335 | r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded); | |
1336 | if (r < 0) | |
1337 | return log_oom(); | |
1338 | ||
1339 | r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags); | |
1340 | } | |
1341 | if (r == -EPERM) { | |
1342 | log_error_errno(r, "Failed to activate with PKCS#11 decrypted key. (Key incorrect?)"); | |
1343 | return -EAGAIN; /* log actual error, but return EAGAIN */ | |
1344 | } | |
1345 | if (r < 0) | |
1346 | return log_error_errno(r, "Failed to activate with PKCS#11 acquired key: %m"); | |
1347 | ||
1348 | return 0; | |
1349 | } | |
1350 | ||
5cbe70af LP |
1351 | static int make_tpm2_device_monitor( |
1352 | sd_event **ret_event, | |
1353 | sd_device_monitor **ret_monitor) { | |
1354 | ||
18843ecc | 1355 | _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL; |
5cbe70af | 1356 | _cleanup_(sd_event_unrefp) sd_event *event = NULL; |
18843ecc LP |
1357 | int r; |
1358 | ||
5cbe70af LP |
1359 | assert(ret_event); |
1360 | assert(ret_monitor); | |
1361 | ||
1362 | r = sd_event_default(&event); | |
1363 | if (r < 0) | |
1364 | return log_error_errno(r, "Failed to allocate event loop: %m"); | |
1365 | ||
1366 | r = sd_event_add_time_relative(event, NULL, CLOCK_MONOTONIC, arg_token_timeout_usec, USEC_PER_SEC, NULL, INT_TO_PTR(-ETIMEDOUT)); | |
1367 | if (r < 0) | |
1368 | return log_error_errno(r, "Failed to install timeout event source: %m"); | |
18843ecc LP |
1369 | |
1370 | r = sd_device_monitor_new(&monitor); | |
1371 | if (r < 0) | |
1372 | return log_error_errno(r, "Failed to allocate device monitor: %m"); | |
1373 | ||
17bf3c55 YW |
1374 | (void) sd_device_monitor_set_description(monitor, "tpmrm"); |
1375 | ||
18843ecc LP |
1376 | r = sd_device_monitor_filter_add_match_subsystem_devtype(monitor, "tpmrm", NULL); |
1377 | if (r < 0) | |
1378 | return log_error_errno(r, "Failed to configure device monitor: %m"); | |
1379 | ||
1380 | r = sd_device_monitor_attach_event(monitor, event); | |
1381 | if (r < 0) | |
1382 | return log_error_errno(r, "Failed to attach device monitor: %m"); | |
1383 | ||
1384 | r = sd_device_monitor_start(monitor, NULL, NULL); | |
1385 | if (r < 0) | |
1386 | return log_error_errno(r, "Failed to start device monitor: %m"); | |
1387 | ||
5cbe70af LP |
1388 | *ret_event = TAKE_PTR(event); |
1389 | *ret_monitor = TAKE_PTR(monitor); | |
18843ecc LP |
1390 | return 0; |
1391 | } | |
1392 | ||
dcbc38c9 | 1393 | static int attach_luks2_by_tpm2_via_plugin( |
d1ae38d8 OK |
1394 | struct crypt_device *cd, |
1395 | const char *name, | |
35ba2b4f JW |
1396 | usec_t until, |
1397 | bool headless, | |
d1ae38d8 OK |
1398 | uint32_t flags) { |
1399 | ||
1400 | #if HAVE_LIBCRYPTSETUP_PLUGINS | |
d1ae38d8 OK |
1401 | systemd_tpm2_plugin_params params = { |
1402 | .search_pcr_mask = arg_tpm2_pcr_mask, | |
75a9681e LP |
1403 | .device = arg_tpm2_device, |
1404 | .signature_path = arg_tpm2_signature, | |
d1ae38d8 OK |
1405 | }; |
1406 | ||
d1b2e043 | 1407 | if (!libcryptsetup_plugins_support()) |
d1ae38d8 OK |
1408 | return log_debug_errno(SYNTHETIC_ERRNO(EOPNOTSUPP), |
1409 | "Libcryptsetup has external plugins support disabled."); | |
1410 | ||
35ba2b4f JW |
1411 | return crypt_activate_by_token_pin_ask_password( |
1412 | cd, | |
1413 | name, | |
1414 | "systemd-tpm2", | |
1415 | until, | |
1416 | headless, | |
1417 | ¶ms, | |
1418 | flags, | |
1419 | "Please enter TPM2 PIN:", | |
1420 | "tpm2-pin", | |
1421 | "cryptsetup.tpm2-pin"); | |
d1ae38d8 OK |
1422 | #else |
1423 | return -EOPNOTSUPP; | |
1424 | #endif | |
1425 | } | |
1426 | ||
18843ecc LP |
1427 | static int attach_luks_or_plain_or_bitlk_by_tpm2( |
1428 | struct crypt_device *cd, | |
1429 | const char *name, | |
1430 | const char *key_file, | |
1431 | const void *key_data, | |
1432 | size_t key_data_size, | |
1433 | usec_t until, | |
1434 | uint32_t flags, | |
1435 | bool pass_volume_key) { | |
1436 | ||
1437 | _cleanup_(sd_device_monitor_unrefp) sd_device_monitor *monitor = NULL; | |
1438 | _cleanup_(erase_and_freep) void *decrypted_key = NULL; | |
1439 | _cleanup_(sd_event_unrefp) sd_event *event = NULL; | |
1440 | _cleanup_free_ char *friendly = NULL; | |
1441 | int keyslot = arg_key_slot, r; | |
67e9c83b | 1442 | size_t decrypted_key_size; |
18843ecc LP |
1443 | |
1444 | assert(cd); | |
1445 | assert(name); | |
1446 | assert(arg_tpm2_device || arg_tpm2_device_auto); | |
1447 | ||
1448 | friendly = friendly_disk_name(crypt_get_device_name(cd), name); | |
1449 | if (!friendly) | |
1450 | return log_oom(); | |
1451 | ||
1452 | for (;;) { | |
18843ecc LP |
1453 | if (key_file || key_data) { |
1454 | /* If key data is specified, use that */ | |
1455 | ||
1456 | r = acquire_tpm2_key( | |
1457 | name, | |
1458 | arg_tpm2_device, | |
1459 | arg_tpm2_pcr_mask == UINT32_MAX ? TPM2_PCR_MASK_DEFAULT : arg_tpm2_pcr_mask, | |
07697bfe | 1460 | UINT16_MAX, |
dc63b2c9 LP |
1461 | /* pubkey= */ NULL, /* pubkey_size= */ 0, |
1462 | /* pubkey_pcr_mask= */ 0, | |
1463 | /* signature_path= */ NULL, | |
1464 | /* primary_alg= */ 0, | |
18843ecc LP |
1465 | key_file, arg_keyfile_size, arg_keyfile_offset, |
1466 | key_data, key_data_size, | |
dc63b2c9 | 1467 | /* policy_hash= */ NULL, /* policy_hash_size= */ 0, /* we don't know the policy hash */ |
3fab44b2 | 1468 | arg_tpm2_pin ? TPM2_FLAGS_USE_PIN : 0, |
bea344a1 GG |
1469 | until, |
1470 | arg_headless, | |
1471 | arg_ask_password_flags, | |
18843ecc LP |
1472 | &decrypted_key, &decrypted_key_size); |
1473 | if (r >= 0) | |
1474 | break; | |
bea344a1 GG |
1475 | if (IN_SET(r, -EACCES, -ENOLCK)) |
1476 | return log_error_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 PIN unlock failed, falling back to traditional unlocking."); | |
cad10544 LP |
1477 | if (ERRNO_IS_NOT_SUPPORTED(r)) /* TPM2 support not compiled in? */ |
1478 | return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 support not available, falling back to traditional unlocking."); | |
49be0383 AAF |
1479 | /* EAGAIN means: no tpm2 chip found */ |
1480 | if (r != -EAGAIN) { | |
1481 | log_notice_errno(r, "TPM2 operation failed, falling back to traditional unlocking: %m"); | |
1482 | return -EAGAIN; /* Mangle error code: let's make any form of TPM2 failure non-fatal. */ | |
1483 | } | |
18843ecc | 1484 | } else { |
35ba2b4f JW |
1485 | r = attach_luks2_by_tpm2_via_plugin(cd, name, until, arg_headless, flags); |
1486 | if (r >= 0) | |
1487 | return 0; | |
d1ae38d8 OK |
1488 | /* EAGAIN means: no tpm2 chip found |
1489 | * EOPNOTSUPP means: no libcryptsetup plugins support */ | |
1490 | if (r == -ENXIO) | |
2e4aae98 LP |
1491 | return log_notice_errno(SYNTHETIC_ERRNO(EAGAIN), |
1492 | "No TPM2 metadata matching the current system state found in LUKS2 header, falling back to traditional unlocking."); | |
d1ae38d8 OK |
1493 | if (r == -ENOENT) |
1494 | return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), | |
1495 | "No TPM2 metadata enrolled in LUKS2 header or TPM2 support not available, falling back to traditional unlocking."); | |
49be0383 AAF |
1496 | if (!IN_SET(r, -EOPNOTSUPP, -EAGAIN)) { |
1497 | log_notice_errno(r, "TPM2 operation failed, falling back to traditional unlocking: %m"); | |
1498 | return -EAGAIN; /* Mangle error code: let's make any form of TPM2 failure non-fatal. */ | |
1499 | } | |
d1ae38d8 OK |
1500 | } |
1501 | ||
dcbc38c9 | 1502 | if (r == -EOPNOTSUPP) { /* Plugin not available, let's process TPM2 stuff right here instead */ |
18843ecc LP |
1503 | _cleanup_free_ void *blob = NULL, *policy_hash = NULL; |
1504 | size_t blob_size, policy_hash_size; | |
1505 | bool found_some = false; | |
1506 | int token = 0; /* first token to look at */ | |
1507 | ||
1508 | /* If no key data is specified, look for it in the header. In order to support | |
1509 | * software upgrades we'll iterate through all suitable tokens, maybe one of them | |
1510 | * works. */ | |
1511 | ||
1512 | for (;;) { | |
dc63b2c9 LP |
1513 | _cleanup_free_ void *pubkey = NULL; |
1514 | size_t pubkey_size = 0; | |
1515 | uint32_t hash_pcr_mask, pubkey_pcr_mask; | |
2b92a672 | 1516 | uint16_t pcr_bank, primary_alg; |
bea344a1 | 1517 | TPM2Flags tpm2_flags; |
18843ecc LP |
1518 | |
1519 | r = find_tpm2_auto_data( | |
1520 | cd, | |
1521 | arg_tpm2_pcr_mask, /* if != UINT32_MAX we'll only look for tokens with this PCR mask */ | |
1522 | token, /* search for the token with this index, or any later index than this */ | |
dc63b2c9 | 1523 | &hash_pcr_mask, |
07697bfe | 1524 | &pcr_bank, |
dc63b2c9 LP |
1525 | &pubkey, &pubkey_size, |
1526 | &pubkey_pcr_mask, | |
2b92a672 | 1527 | &primary_alg, |
18843ecc LP |
1528 | &blob, &blob_size, |
1529 | &policy_hash, &policy_hash_size, | |
fdf6c27c | 1530 | &tpm2_flags, |
18843ecc | 1531 | &keyslot, |
fdf6c27c | 1532 | &token); |
c26f7dd9 | 1533 | if (r == -ENXIO) |
7802194a | 1534 | /* No further TPM2 tokens found in the LUKS2 header. */ |
2e4aae98 LP |
1535 | return log_full_errno(found_some ? LOG_NOTICE : LOG_DEBUG, |
1536 | SYNTHETIC_ERRNO(EAGAIN), | |
1537 | found_some | |
1538 | ? "No TPM2 metadata matching the current system state found in LUKS2 header, falling back to traditional unlocking." | |
1539 | : "No TPM2 metadata enrolled in LUKS2 header, falling back to traditional unlocking."); | |
cad10544 LP |
1540 | if (ERRNO_IS_NOT_SUPPORTED(r)) /* TPM2 support not compiled in? */ |
1541 | return log_debug_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 support not available, falling back to traditional unlocking."); | |
18843ecc LP |
1542 | if (r < 0) |
1543 | return r; | |
1544 | ||
1545 | found_some = true; | |
1546 | ||
1547 | r = acquire_tpm2_key( | |
1548 | name, | |
1549 | arg_tpm2_device, | |
dc63b2c9 | 1550 | hash_pcr_mask, |
07697bfe | 1551 | pcr_bank, |
dc63b2c9 LP |
1552 | pubkey, pubkey_size, |
1553 | pubkey_pcr_mask, | |
1554 | arg_tpm2_signature, | |
2b92a672 | 1555 | primary_alg, |
dc63b2c9 | 1556 | /* key_file= */ NULL, /* key_file_size= */ 0, /* key_file_offset= */ 0, /* no key file */ |
18843ecc LP |
1557 | blob, blob_size, |
1558 | policy_hash, policy_hash_size, | |
bea344a1 GG |
1559 | tpm2_flags, |
1560 | until, | |
1561 | arg_headless, | |
1562 | arg_ask_password_flags, | |
18843ecc | 1563 | &decrypted_key, &decrypted_key_size); |
bea344a1 | 1564 | if (IN_SET(r, -EACCES, -ENOLCK)) |
2e4aae98 | 1565 | return log_notice_errno(SYNTHETIC_ERRNO(EAGAIN), "TPM2 PIN unlock failed, falling back to traditional unlocking."); |
18843ecc LP |
1566 | if (r != -EPERM) |
1567 | break; | |
1568 | ||
1569 | token++; /* try a different token next time */ | |
1570 | } | |
1571 | ||
1572 | if (r >= 0) | |
1573 | break; | |
49be0383 AAF |
1574 | /* EAGAIN means: no tpm2 chip found */ |
1575 | if (r != -EAGAIN) { | |
1576 | log_notice_errno(r, "TPM2 operation failed, falling back to traditional unlocking: %m"); | |
1577 | return -EAGAIN; /* Mangle error code: let's make any form of TPM2 failure non-fatal. */ | |
1578 | } | |
18843ecc LP |
1579 | } |
1580 | ||
1581 | if (!monitor) { | |
1582 | /* We didn't find the TPM2 device. In this case, watch for it via udev. Let's create | |
1583 | * an event loop and monitor first. */ | |
1584 | ||
1585 | assert(!event); | |
1586 | ||
71b25dea LP |
1587 | if (is_efi_boot() && !efi_has_tpm2()) |
1588 | return log_notice_errno(SYNTHETIC_ERRNO(EAGAIN), | |
88a65c93 | 1589 | "No TPM2 hardware discovered and EFI firmware does not see it either, falling back to traditional unlocking."); |
71b25dea | 1590 | |
5cbe70af | 1591 | r = make_tpm2_device_monitor(&event, &monitor); |
18843ecc LP |
1592 | if (r < 0) |
1593 | return r; | |
1594 | ||
1595 | log_info("TPM2 device not present for unlocking %s, waiting for it to become available.", friendly); | |
1596 | ||
1597 | /* Let's immediately rescan in case the device appeared in the time we needed | |
1598 | * to create and configure the monitor */ | |
1599 | continue; | |
1600 | } | |
1601 | ||
5cbe70af LP |
1602 | r = run_security_device_monitor(event, monitor); |
1603 | if (r < 0) | |
1604 | return r; | |
18843ecc LP |
1605 | |
1606 | log_debug("Got one or more potentially relevant udev events, rescanning for TPM2..."); | |
1607 | } | |
26fbc5aa | 1608 | assert(decrypted_key); |
18843ecc LP |
1609 | |
1610 | if (pass_volume_key) | |
1611 | r = crypt_activate_by_volume_key(cd, name, decrypted_key, decrypted_key_size, flags); | |
1612 | else { | |
1613 | _cleanup_(erase_and_freep) char *base64_encoded = NULL; | |
1614 | ||
1615 | /* Before using this key as passphrase we base64 encode it, for compat with homed */ | |
1616 | ||
1617 | r = base64mem(decrypted_key, decrypted_key_size, &base64_encoded); | |
1618 | if (r < 0) | |
1619 | return log_oom(); | |
1620 | ||
1621 | r = crypt_activate_by_passphrase(cd, name, keyslot, base64_encoded, strlen(base64_encoded), flags); | |
1622 | } | |
1623 | if (r == -EPERM) { | |
1624 | log_error_errno(r, "Failed to activate with TPM2 decrypted key. (Key incorrect?)"); | |
1625 | return -EAGAIN; /* log actual error, but return EAGAIN */ | |
1626 | } | |
1627 | if (r < 0) | |
1628 | return log_error_errno(r, "Failed to activate with TPM2 acquired key: %m"); | |
1629 | ||
1630 | return 0; | |
1631 | } | |
1632 | ||
b8c80b56 LP |
1633 | static int attach_luks_or_plain_or_bitlk_by_key_data( |
1634 | struct crypt_device *cd, | |
1635 | const char *name, | |
1636 | const void *key_data, | |
1637 | size_t key_data_size, | |
1638 | uint32_t flags, | |
1639 | bool pass_volume_key) { | |
1640 | ||
1641 | int r; | |
1642 | ||
1643 | assert(cd); | |
1644 | assert(name); | |
1645 | assert(key_data); | |
1646 | ||
1647 | if (pass_volume_key) | |
1648 | r = crypt_activate_by_volume_key(cd, name, key_data, key_data_size, flags); | |
1649 | else | |
1650 | r = crypt_activate_by_passphrase(cd, name, arg_key_slot, key_data, key_data_size, flags); | |
1651 | if (r == -EPERM) { | |
1652 | log_error_errno(r, "Failed to activate. (Key incorrect?)"); | |
1653 | return -EAGAIN; /* Log actual error, but return EAGAIN */ | |
1654 | } | |
1655 | if (r < 0) | |
1656 | return log_error_errno(r, "Failed to activate: %m"); | |
1657 | ||
1658 | return 0; | |
1659 | } | |
1660 | ||
1661 | static int attach_luks_or_plain_or_bitlk_by_key_file( | |
1662 | struct crypt_device *cd, | |
1663 | const char *name, | |
1664 | const char *key_file, | |
1665 | uint32_t flags, | |
1666 | bool pass_volume_key) { | |
1667 | ||
1668 | _cleanup_(erase_and_freep) char *kfdata = NULL; | |
1669 | _cleanup_free_ char *bindname = NULL; | |
1670 | size_t kfsize; | |
1671 | int r; | |
1672 | ||
1673 | assert(cd); | |
1674 | assert(name); | |
1675 | assert(key_file); | |
1676 | ||
1677 | /* If we read the key via AF_UNIX, make this client recognizable */ | |
1678 | bindname = make_bindname(name); | |
1679 | if (!bindname) | |
1680 | return log_oom(); | |
1681 | ||
1682 | r = read_full_file_full( | |
1683 | AT_FDCWD, key_file, | |
1684 | arg_keyfile_offset == 0 ? UINT64_MAX : arg_keyfile_offset, | |
1685 | arg_keyfile_size == 0 ? SIZE_MAX : arg_keyfile_size, | |
1686 | READ_FULL_FILE_SECURE|READ_FULL_FILE_WARN_WORLD_READABLE|READ_FULL_FILE_CONNECT_SOCKET, | |
1687 | bindname, | |
1688 | &kfdata, &kfsize); | |
871f35af LP |
1689 | if (r == -E2BIG) { |
1690 | log_error_errno(r, "Failed to activate, key file '%s' too large.", key_file); | |
1691 | return -EAGAIN; | |
1692 | } | |
b8c80b56 LP |
1693 | if (r == -ENOENT) { |
1694 | log_error_errno(r, "Failed to activate, key file '%s' missing.", key_file); | |
1695 | return -EAGAIN; /* Log actual error, but return EAGAIN */ | |
1696 | } | |
abc50cf6 LP |
1697 | if (r < 0) |
1698 | return log_error_errno(r, "Failed to read key file '%s': %m", key_file); | |
b8c80b56 LP |
1699 | |
1700 | if (pass_volume_key) | |
1701 | r = crypt_activate_by_volume_key(cd, name, kfdata, kfsize, flags); | |
1702 | else | |
1703 | r = crypt_activate_by_passphrase(cd, name, arg_key_slot, kfdata, kfsize, flags); | |
1704 | if (r == -EPERM) { | |
1705 | log_error_errno(r, "Failed to activate with key file '%s'. (Key data incorrect?)", key_file); | |
1706 | return -EAGAIN; /* Log actual error, but return EAGAIN */ | |
1707 | } | |
1708 | if (r < 0) | |
1709 | return log_error_errno(r, "Failed to activate with key file '%s': %m", key_file); | |
1710 | ||
1711 | return 0; | |
1712 | } | |
1713 | ||
1714 | static int attach_luks_or_plain_or_bitlk_by_passphrase( | |
1715 | struct crypt_device *cd, | |
1716 | const char *name, | |
1717 | char **passwords, | |
1718 | uint32_t flags, | |
1719 | bool pass_volume_key) { | |
1720 | ||
b8c80b56 LP |
1721 | int r; |
1722 | ||
1723 | assert(cd); | |
1724 | assert(name); | |
1725 | ||
1726 | r = -EINVAL; | |
1727 | STRV_FOREACH(p, passwords) { | |
1728 | if (pass_volume_key) | |
1729 | r = crypt_activate_by_volume_key(cd, name, *p, arg_key_size, flags); | |
1730 | else | |
1731 | r = crypt_activate_by_passphrase(cd, name, arg_key_slot, *p, strlen(*p), flags); | |
1732 | if (r >= 0) | |
1733 | break; | |
1734 | } | |
1735 | if (r == -EPERM) { | |
1736 | log_error_errno(r, "Failed to activate with specified passphrase. (Passphrase incorrect?)"); | |
1737 | return -EAGAIN; /* log actual error, but return EAGAIN */ | |
1738 | } | |
1739 | if (r < 0) | |
1740 | return log_error_errno(r, "Failed to activate with specified passphrase: %m"); | |
1741 | ||
1742 | return 0; | |
1743 | } | |
1744 | ||
6cc27c29 | 1745 | static int attach_luks_or_plain_or_bitlk( |
9c5253ff LP |
1746 | struct crypt_device *cd, |
1747 | const char *name, | |
1748 | const char *key_file, | |
7407f689 LP |
1749 | const void *key_data, |
1750 | size_t key_data_size, | |
9c5253ff | 1751 | char **passwords, |
08669709 LP |
1752 | uint32_t flags, |
1753 | usec_t until) { | |
9c5253ff | 1754 | |
10fb4e35 | 1755 | bool pass_volume_key = false; |
b8c80b56 | 1756 | int r; |
10fb4e35 JJ |
1757 | |
1758 | assert(cd); | |
1759 | assert(name); | |
10fb4e35 | 1760 | |
2e4beb87 | 1761 | if ((!arg_type && !crypt_get_type(cd)) || streq_ptr(arg_type, CRYPT_PLAIN)) { |
4eac2773 MP |
1762 | struct crypt_params_plain params = { |
1763 | .offset = arg_offset, | |
1764 | .skip = arg_skip, | |
a9fc6406 | 1765 | .sector_size = arg_sector_size, |
4eac2773 | 1766 | }; |
10fb4e35 JJ |
1767 | const char *cipher, *cipher_mode; |
1768 | _cleanup_free_ char *truncated_cipher = NULL; | |
1769 | ||
b8c80b56 | 1770 | if (streq_ptr(arg_hash, "plain")) |
10fb4e35 | 1771 | /* plain isn't a real hash type. it just means "use no hash" */ |
b8c80b56 LP |
1772 | params.hash = NULL; |
1773 | else if (arg_hash) | |
1774 | params.hash = arg_hash; | |
1775 | else if (!key_file) | |
1776 | /* for CRYPT_PLAIN, the behaviour of cryptsetup package is to not hash when a key | |
1777 | * file is provided */ | |
10fb4e35 JJ |
1778 | params.hash = "ripemd160"; |
1779 | ||
f75cac37 | 1780 | if (arg_cipher) { |
10fb4e35 JJ |
1781 | size_t l; |
1782 | ||
f75cac37 LP |
1783 | l = strcspn(arg_cipher, "-"); |
1784 | truncated_cipher = strndup(arg_cipher, l); | |
10fb4e35 JJ |
1785 | if (!truncated_cipher) |
1786 | return log_oom(); | |
1787 | ||
1788 | cipher = truncated_cipher; | |
f75cac37 | 1789 | cipher_mode = arg_cipher[l] ? arg_cipher+l+1 : "plain"; |
10fb4e35 JJ |
1790 | } else { |
1791 | cipher = "aes"; | |
1792 | cipher_mode = "cbc-essiv:sha256"; | |
1793 | } | |
1794 | ||
aed68083 | 1795 | /* for CRYPT_PLAIN limit reads from keyfile to key length, and ignore keyfile-size */ |
6131a78b | 1796 | arg_keyfile_size = arg_key_size; |
10fb4e35 | 1797 | |
30747265 | 1798 | /* In contrast to what the name crypt_format() might suggest this doesn't actually format |
aed68083 | 1799 | * anything, it just configures encryption parameters when used for plain mode. */ |
1602b008 | 1800 | r = crypt_format(cd, CRYPT_PLAIN, cipher, cipher_mode, NULL, NULL, arg_keyfile_size, ¶ms); |
2e4beb87 MB |
1801 | if (r < 0) |
1802 | return log_error_errno(r, "Loading of cryptographic parameters failed: %m"); | |
10fb4e35 JJ |
1803 | |
1804 | /* hash == NULL implies the user passed "plain" */ | |
b8c80b56 | 1805 | pass_volume_key = !params.hash; |
10fb4e35 | 1806 | } |
10fb4e35 JJ |
1807 | |
1808 | log_info("Set cipher %s, mode %s, key size %i bits for device %s.", | |
1809 | crypt_get_cipher(cd), | |
1810 | crypt_get_cipher_mode(cd), | |
1811 | crypt_get_volume_key_size(cd)*8, | |
1812 | crypt_get_device_name(cd)); | |
1813 | ||
18843ecc LP |
1814 | if (arg_tpm2_device || arg_tpm2_device_auto) |
1815 | return attach_luks_or_plain_or_bitlk_by_tpm2(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key); | |
2bc5c425 LP |
1816 | if (arg_fido2_device || arg_fido2_device_auto) |
1817 | return attach_luks_or_plain_or_bitlk_by_fido2(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key); | |
b8c80b56 LP |
1818 | if (arg_pkcs11_uri || arg_pkcs11_uri_auto) |
1819 | return attach_luks_or_plain_or_bitlk_by_pkcs11(cd, name, key_file, key_data, key_data_size, until, flags, pass_volume_key); | |
1820 | if (key_data) | |
1821 | return attach_luks_or_plain_or_bitlk_by_key_data(cd, name, key_data, key_data_size, flags, pass_volume_key); | |
1822 | if (key_file) | |
1823 | return attach_luks_or_plain_or_bitlk_by_key_file(cd, name, key_file, flags, pass_volume_key); | |
10fb4e35 | 1824 | |
b8c80b56 | 1825 | return attach_luks_or_plain_or_bitlk_by_passphrase(cd, name, passwords, flags, pass_volume_key); |
10fb4e35 JJ |
1826 | } |
1827 | ||
dd5e696d | 1828 | static int help(void) { |
37ec0fdd LP |
1829 | _cleanup_free_ char *link = NULL; |
1830 | int r; | |
1831 | ||
1832 | r = terminal_urlify_man("systemd-cryptsetup@.service", "8", &link); | |
1833 | if (r < 0) | |
1834 | return log_oom(); | |
dd5e696d | 1835 | |
b7de9651 | 1836 | printf("%s attach VOLUME SOURCEDEVICE [KEY-FILE] [OPTIONS]\n" |
dd5e696d | 1837 | "%s detach VOLUME\n\n" |
37ec0fdd | 1838 | "Attaches or detaches an encrypted block device.\n" |
bc556335 DDM |
1839 | "\nSee the %s for details.\n", |
1840 | program_invocation_short_name, | |
1841 | program_invocation_short_name, | |
1842 | link); | |
dd5e696d LP |
1843 | |
1844 | return 0; | |
1845 | } | |
1846 | ||
d5d1ae15 LP |
1847 | static uint32_t determine_flags(void) { |
1848 | uint32_t flags = 0; | |
1849 | ||
1850 | if (arg_readonly) | |
1851 | flags |= CRYPT_ACTIVATE_READONLY; | |
1852 | ||
1853 | if (arg_discards) | |
1854 | flags |= CRYPT_ACTIVATE_ALLOW_DISCARDS; | |
1855 | ||
1856 | if (arg_same_cpu_crypt) | |
1857 | flags |= CRYPT_ACTIVATE_SAME_CPU_CRYPT; | |
1858 | ||
1859 | if (arg_submit_from_crypt_cpus) | |
1860 | flags |= CRYPT_ACTIVATE_SUBMIT_FROM_CRYPT_CPUS; | |
1861 | ||
227acf00 JU |
1862 | if (arg_no_read_workqueue) |
1863 | flags |= CRYPT_ACTIVATE_NO_READ_WORKQUEUE; | |
1864 | ||
1865 | if (arg_no_write_workqueue) | |
1866 | flags |= CRYPT_ACTIVATE_NO_WRITE_WORKQUEUE; | |
1867 | ||
408c81f6 MS |
1868 | #ifdef CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF |
1869 | /* Try to decrease the risk of OOM event if memory hard key derivation function is in use */ | |
1870 | /* https://gitlab.com/cryptsetup/cryptsetup/issues/446/ */ | |
1871 | flags |= CRYPT_ACTIVATE_SERIALIZE_MEMORY_HARD_PBKDF; | |
1872 | #endif | |
1873 | ||
d5d1ae15 LP |
1874 | return flags; |
1875 | } | |
1876 | ||
d3d49e76 LP |
1877 | static void remove_and_erasep(const char **p) { |
1878 | int r; | |
1879 | ||
1880 | if (!*p) | |
1881 | return; | |
1882 | ||
1883 | r = unlinkat_deallocate(AT_FDCWD, *p, UNLINK_ERASE); | |
1884 | if (r < 0 && r != -ENOENT) | |
1885 | log_warning_errno(r, "Unable to erase key file '%s', ignoring: %m", *p); | |
1886 | } | |
1887 | ||
3a40f366 | 1888 | static int run(int argc, char *argv[]) { |
294bd454 | 1889 | _cleanup_(crypt_freep) struct crypt_device *cd = NULL; |
da2268f9 | 1890 | const char *verb; |
3a40f366 | 1891 | int r; |
e23a0ce8 | 1892 | |
542bb9be | 1893 | if (argv_looks_like_help(argc, argv)) |
3a40f366 | 1894 | return help(); |
dd5e696d | 1895 | |
d7a0f1f4 FS |
1896 | if (argc < 3) |
1897 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), | |
1898 | "This program requires at least two arguments."); | |
e23a0ce8 | 1899 | |
d2acb93d | 1900 | log_setup(); |
e23a0ce8 | 1901 | |
2f678640 | 1902 | cryptsetup_enable_logging(NULL); |
568a8404 | 1903 | |
4c12626c LP |
1904 | umask(0022); |
1905 | ||
da2268f9 LP |
1906 | verb = argv[1]; |
1907 | ||
1908 | if (streq(verb, "attach")) { | |
d7ac0952 | 1909 | _unused_ _cleanup_(remove_and_erasep) const char *destroy_key_file = NULL; |
7407f689 | 1910 | _cleanup_(erase_and_freep) void *key_data = NULL; |
da2268f9 LP |
1911 | const char *volume, *source, *key_file, *options; |
1912 | crypt_status_info status; | |
7407f689 | 1913 | size_t key_data_size = 0; |
da2268f9 LP |
1914 | uint32_t flags = 0; |
1915 | unsigned tries; | |
1916 | usec_t until; | |
b6c0bd11 | 1917 | PassphraseType passphrase_type = PASSPHRASE_NONE; |
7f4e0805 | 1918 | |
b7de9651 | 1919 | /* Arguments: systemd-cryptsetup attach VOLUME SOURCE-DEVICE [KEY-FILE] [OPTIONS] */ |
b61e476f | 1920 | |
0ffff81a LP |
1921 | if (argc < 4) |
1922 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "attach requires at least two arguments."); | |
7f4e0805 | 1923 | |
da2268f9 LP |
1924 | volume = argv[2]; |
1925 | source = argv[3]; | |
2fabbad8 LP |
1926 | key_file = mangle_none(argc >= 5 ? argv[4] : NULL); |
1927 | options = mangle_none(argc >= 6 ? argv[5] : NULL); | |
7407f689 | 1928 | |
da2268f9 LP |
1929 | if (!filename_is_valid(volume)) |
1930 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Volume name '%s' is not valid.", volume); | |
1931 | ||
1932 | if (key_file && !path_is_absolute(key_file)) { | |
1933 | log_warning("Password file path '%s' is not absolute. Ignoring.", key_file); | |
1934 | key_file = NULL; | |
7f4e0805 LP |
1935 | } |
1936 | ||
da2268f9 LP |
1937 | if (options) { |
1938 | r = parse_options(options); | |
3a40f366 YW |
1939 | if (r < 0) |
1940 | return r; | |
74b1c371 | 1941 | } |
e23a0ce8 | 1942 | |
7bb553bb | 1943 | log_debug("%s %s ← %s type=%s cipher=%s", __func__, |
da2268f9 | 1944 | volume, source, strempty(arg_type), strempty(arg_cipher)); |
7bb553bb | 1945 | |
b853f6e9 | 1946 | /* A delicious drop of snake oil */ |
9c5253ff | 1947 | (void) mlockall(MCL_FUTURE); |
b853f6e9 | 1948 | |
7407f689 | 1949 | if (!key_file) { |
e060ed32 | 1950 | _cleanup_free_ char *bindname = NULL; |
7407f689 LP |
1951 | const char *fn; |
1952 | ||
da2268f9 | 1953 | bindname = make_bindname(volume); |
e060ed32 LP |
1954 | if (!bindname) |
1955 | return log_oom(); | |
1956 | ||
7407f689 LP |
1957 | /* If a key file is not explicitly specified, search for a key in a well defined |
1958 | * search path, and load it. */ | |
1959 | ||
da2268f9 | 1960 | fn = strjoina(volume, ".key"); |
e060ed32 LP |
1961 | r = find_key_file( |
1962 | fn, | |
1963 | STRV_MAKE("/etc/cryptsetup-keys.d", "/run/cryptsetup-keys.d"), | |
1964 | bindname, | |
1965 | &key_data, &key_data_size); | |
7407f689 LP |
1966 | if (r < 0) |
1967 | return r; | |
1968 | if (r > 0) | |
da2268f9 | 1969 | log_debug("Automatically discovered key for volume '%s'.", volume); |
7407f689 | 1970 | } else if (arg_keyfile_erase) |
d3d49e76 LP |
1971 | destroy_key_file = key_file; /* let's get this baby erased when we leave */ |
1972 | ||
7376e835 AC |
1973 | if (arg_header) { |
1974 | log_debug("LUKS header: %s", arg_header); | |
5f4bfe56 | 1975 | r = crypt_init(&cd, arg_header); |
7376e835 | 1976 | } else |
da2268f9 | 1977 | r = crypt_init(&cd, source); |
3a40f366 YW |
1978 | if (r < 0) |
1979 | return log_error_errno(r, "crypt_init() failed: %m"); | |
e23a0ce8 | 1980 | |
efc3b12f | 1981 | cryptsetup_enable_logging(cd); |
7f4e0805 | 1982 | |
da2268f9 | 1983 | status = crypt_status(cd, volume); |
3742095b | 1984 | if (IN_SET(status, CRYPT_ACTIVE, CRYPT_BUSY)) { |
da2268f9 | 1985 | log_info("Volume %s already active.", volume); |
3a40f366 | 1986 | return 0; |
7f4e0805 LP |
1987 | } |
1988 | ||
d5d1ae15 | 1989 | flags = determine_flags(); |
2c65512e | 1990 | |
496db330 YW |
1991 | until = usec_add(now(CLOCK_MONOTONIC), arg_timeout); |
1992 | if (until == USEC_INFINITY) | |
7dcda352 | 1993 | until = 0; |
260ab287 | 1994 | |
714c5869 LP |
1995 | if (arg_key_size == 0) |
1996 | arg_key_size = 256U / 8U; | |
e2d480b9 | 1997 | |
10fb4e35 JJ |
1998 | if (key_file) { |
1999 | struct stat st; | |
e2d480b9 | 2000 | |
10fb4e35 JJ |
2001 | /* Ideally we'd do this on the open fd, but since this is just a |
2002 | * warning it's OK to do this in two steps. */ | |
3f4d56a0 MP |
2003 | if (stat(key_file, &st) >= 0 && S_ISREG(st.st_mode) && (st.st_mode & 0005)) |
2004 | log_warning("Key file %s is world-readable. This is not a good idea!", key_file); | |
e2d480b9 LP |
2005 | } |
2006 | ||
6930d069 LP |
2007 | if (!arg_type || STR_IN_SET(arg_type, ANY_LUKS, CRYPT_LUKS1, CRYPT_LUKS2)) { |
2008 | r = crypt_load(cd, !arg_type || streq(arg_type, ANY_LUKS) ? CRYPT_LUKS : arg_type, NULL); | |
ea9a9d49 MB |
2009 | if (r < 0) |
2010 | return log_error_errno(r, "Failed to load LUKS superblock on device %s: %m", crypt_get_device_name(cd)); | |
2011 | ||
2012 | if (arg_header) { | |
da2268f9 | 2013 | r = crypt_set_data_device(cd, source); |
ea9a9d49 | 2014 | if (r < 0) |
da2268f9 | 2015 | return log_error_errno(r, "Failed to set LUKS data device %s: %m", source); |
ea9a9d49 | 2016 | } |
d90874b4 | 2017 | |
894bb3ca | 2018 | /* Tokens are available in LUKS2 only, but it is ok to call (and fail) with LUKS1. */ |
a0789e5f | 2019 | if (!key_file && !key_data && getenv_bool("SYSTEMD_CRYPTSETUP_USE_TOKEN_MODULE") != 0) { |
ee6c66ac JW |
2020 | r = crypt_activate_by_token_pin_ask_password( |
2021 | cd, | |
2022 | volume, | |
2023 | NULL, | |
2024 | until, | |
2025 | arg_headless, | |
2026 | NULL, | |
2027 | flags, | |
2028 | "Please enter LUKS2 token PIN:", | |
2029 | "luks2-pin", | |
2030 | "cryptsetup.luks2-pin"); | |
894bb3ca | 2031 | if (r >= 0) { |
da2268f9 | 2032 | log_debug("Volume %s activated with LUKS token id %i.", volume, r); |
894bb3ca MB |
2033 | return 0; |
2034 | } | |
2035 | ||
2036 | log_debug_errno(r, "Token activation unsuccessful for device %s: %m", crypt_get_device_name(cd)); | |
2037 | } | |
ea9a9d49 MB |
2038 | } |
2039 | ||
6cc27c29 MF |
2040 | /* since cryptsetup 2.3.0 (Feb 2020) */ |
2041 | #ifdef CRYPT_BITLK | |
5af39ac8 | 2042 | if (streq_ptr(arg_type, CRYPT_BITLK)) { |
6cc27c29 MF |
2043 | r = crypt_load(cd, CRYPT_BITLK, NULL); |
2044 | if (r < 0) | |
2045 | return log_error_errno(r, "Failed to load Bitlocker superblock on device %s: %m", crypt_get_device_name(cd)); | |
2046 | } | |
2047 | #endif | |
2048 | ||
f75cac37 | 2049 | for (tries = 0; arg_tries == 0 || tries < arg_tries; tries++) { |
ab84f5b9 | 2050 | _cleanup_strv_free_erase_ char **passwords = NULL; |
260ab287 | 2051 | |
0ba6f85e LP |
2052 | /* When we were able to acquire multiple keys, let's always process them in this order: |
2053 | * | |
18843ecc | 2054 | * 1. A key acquired via PKCS#11 or FIDO2 token, or TPM2 chip |
0ba6f85e LP |
2055 | * 2. The discovered key: i.e. key_data + key_data_size |
2056 | * 3. The configured key: i.e. key_file + arg_keyfile_offset + arg_keyfile_size | |
2057 | * 4. The empty password, in case arg_try_empty_password is set | |
2058 | * 5. We enquire the user for a password | |
2059 | */ | |
2060 | ||
18843ecc | 2061 | if (!key_file && !key_data && !arg_pkcs11_uri && !arg_pkcs11_uri_auto && !arg_fido2_device && !arg_fido2_device_auto && !arg_tpm2_device && !arg_tpm2_device_auto) { |
0ba6f85e LP |
2062 | |
2063 | if (arg_try_empty_password) { | |
2064 | /* Hmm, let's try an empty password now, but only once */ | |
2065 | arg_try_empty_password = false; | |
2066 | ||
2067 | key_data = strdup(""); | |
2068 | if (!key_data) | |
2069 | return log_oom(); | |
2070 | ||
2071 | key_data_size = 0; | |
2072 | } else { | |
b6c0bd11 | 2073 | /* Ask the user for a passphrase or recovery key only as last resort, if we have |
0ba6f85e | 2074 | * nothing else to check for */ |
b6c0bd11 AAF |
2075 | if (passphrase_type == PASSPHRASE_NONE) { |
2076 | passphrase_type = check_registered_passwords(cd); | |
2077 | if (passphrase_type == PASSPHRASE_NONE) | |
2078 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "No passphrase or recovery key registered."); | |
2079 | } | |
0ba6f85e | 2080 | |
b6c0bd11 | 2081 | r = get_password(volume, source, until, tries == 0 && !arg_verify, passphrase_type, &passwords); |
0ba6f85e LP |
2082 | if (r == -EAGAIN) |
2083 | continue; | |
2084 | if (r < 0) | |
2085 | return r; | |
2086 | } | |
260ab287 LP |
2087 | } |
2088 | ||
f75cac37 | 2089 | if (streq_ptr(arg_type, CRYPT_TCRYPT)) |
da2268f9 | 2090 | r = attach_tcrypt(cd, volume, key_file, key_data, key_data_size, passwords, flags); |
8cf3ca80 | 2091 | else |
da2268f9 | 2092 | r = attach_luks_or_plain_or_bitlk(cd, volume, key_file, key_data, key_data_size, passwords, flags, until); |
5f4bfe56 | 2093 | if (r >= 0) |
260ab287 | 2094 | break; |
6f177c7d LP |
2095 | if (r != -EAGAIN) |
2096 | return r; | |
260ab287 | 2097 | |
2424fb7e LP |
2098 | /* Key not correct? Let's try again! */ |
2099 | ||
6f177c7d | 2100 | key_file = NULL; |
7407f689 LP |
2101 | key_data = erase_and_free(key_data); |
2102 | key_data_size = 0; | |
2424fb7e | 2103 | arg_pkcs11_uri = mfree(arg_pkcs11_uri); |
b997d111 | 2104 | arg_pkcs11_uri_auto = false; |
2bc5c425 LP |
2105 | arg_fido2_device = mfree(arg_fido2_device); |
2106 | arg_fido2_device_auto = false; | |
18843ecc LP |
2107 | arg_tpm2_device = mfree(arg_tpm2_device); |
2108 | arg_tpm2_device_auto = false; | |
7f4e0805 LP |
2109 | } |
2110 | ||
0ffff81a LP |
2111 | if (arg_tries != 0 && tries >= arg_tries) |
2112 | return log_error_errno(SYNTHETIC_ERRNO(EPERM), "Too many attempts to activate; giving up."); | |
7f4e0805 | 2113 | |
da2268f9 LP |
2114 | } else if (streq(verb, "detach")) { |
2115 | const char *volume; | |
2116 | ||
2117 | volume = argv[2]; | |
7f4e0805 | 2118 | |
da2268f9 LP |
2119 | if (!filename_is_valid(volume)) |
2120 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Volume name '%s' is not valid.", volume); | |
7407f689 | 2121 | |
da2268f9 | 2122 | r = crypt_init_by_name(&cd, volume); |
5f4bfe56 | 2123 | if (r == -ENODEV) { |
da2268f9 | 2124 | log_info("Volume %s already inactive.", volume); |
3a40f366 | 2125 | return 0; |
7f4e0805 | 2126 | } |
3a40f366 YW |
2127 | if (r < 0) |
2128 | return log_error_errno(r, "crypt_init_by_name() failed: %m"); | |
7f4e0805 | 2129 | |
efc3b12f | 2130 | cryptsetup_enable_logging(cd); |
7f4e0805 | 2131 | |
da2268f9 | 2132 | r = crypt_deactivate(cd, volume); |
3a40f366 YW |
2133 | if (r < 0) |
2134 | return log_error_errno(r, "Failed to deactivate: %m"); | |
e23a0ce8 | 2135 | |
0ffff81a | 2136 | } else |
da2268f9 | 2137 | return log_error_errno(SYNTHETIC_ERRNO(EINVAL), "Unknown verb %s.", verb); |
e23a0ce8 | 2138 | |
3a40f366 | 2139 | return 0; |
e23a0ce8 | 2140 | } |
3a40f366 YW |
2141 | |
2142 | DEFINE_MAIN_FUNCTION(run); |