2 * LUKS - Linux Unified Key Setup v2, digest handling
4 * Copyright (C) 2015-2023 Red Hat, Inc. All rights reserved.
5 * Copyright (C) 2015-2023 Milan Broz
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License
9 * as published by the Free Software Foundation; either version 2
10 * of the License, or (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include "luks2_internal.h"
24 extern const digest_handler PBKDF2_digest;
26 static const digest_handler *digest_handlers[LUKS2_DIGEST_MAX] = {
31 static const digest_handler *LUKS2_digest_handler_type(const char *type)
35 for (i = 0; i < LUKS2_DIGEST_MAX && digest_handlers[i]; i++) {
36 if (!strcmp(digest_handlers[i]->name, type))
37 return digest_handlers[i];
43 static const digest_handler *LUKS2_digest_handler(struct crypt_device *cd, int digest)
45 struct luks2_hdr *hdr;
46 json_object *jobj1, *jobj2;
51 if (!(hdr = crypt_get_hdr(cd, CRYPT_LUKS2)))
54 if (!(jobj1 = LUKS2_get_digest_jobj(hdr, digest)))
57 if (!json_object_object_get_ex(jobj1, "type", &jobj2))
60 return LUKS2_digest_handler_type(json_object_get_string(jobj2));
63 static int LUKS2_digest_find_free(struct luks2_hdr *hdr)
67 while (LUKS2_get_digest_jobj(hdr, digest) && digest < LUKS2_DIGEST_MAX)
70 return digest < LUKS2_DIGEST_MAX ? digest : -1;
73 int LUKS2_digest_create(struct crypt_device *cd,
75 struct luks2_hdr *hdr,
76 const struct volume_key *vk)
79 const digest_handler *dh;
81 dh = LUKS2_digest_handler_type(type);
85 digest = LUKS2_digest_find_free(hdr);
89 log_dbg(cd, "Creating new digest %d (%s).", digest, type);
91 return dh->store(cd, digest, vk->key, vk->keylength) ?: digest;
94 int LUKS2_digest_by_keyslot(struct luks2_hdr *hdr, int keyslot)
96 char keyslot_name[16];
97 json_object *jobj_digests, *jobj_digest_keyslots;
99 if (snprintf(keyslot_name, sizeof(keyslot_name), "%u", keyslot) < 1)
102 json_object_object_get_ex(hdr->jobj, "digests", &jobj_digests);
104 json_object_object_foreach(jobj_digests, key, val) {
105 json_object_object_get_ex(val, "keyslots", &jobj_digest_keyslots);
106 if (LUKS2_array_jobj(jobj_digest_keyslots, keyslot_name))
113 int LUKS2_digest_verify_by_digest(struct crypt_device *cd,
115 const struct volume_key *vk)
117 const digest_handler *h;
120 h = LUKS2_digest_handler(cd, digest);
124 r = h->verify(cd, digest, vk->key, vk->keylength);
126 log_dbg(cd, "Digest %d (%s) verify failed with %d.", digest, h->name, r);
133 int LUKS2_digest_verify(struct crypt_device *cd,
134 struct luks2_hdr *hdr,
135 const struct volume_key *vk,
140 digest = LUKS2_digest_by_keyslot(hdr, keyslot);
144 log_dbg(cd, "Verifying key from keyslot %d, digest %d.", keyslot, digest);
146 return LUKS2_digest_verify_by_digest(cd, digest, vk);
149 int LUKS2_digest_dump(struct crypt_device *cd, int digest)
151 const digest_handler *h;
153 if (!(h = LUKS2_digest_handler(cd, digest)))
156 return h->dump(cd, digest);
159 int LUKS2_digest_any_matching(struct crypt_device *cd,
160 struct luks2_hdr *hdr,
161 const struct volume_key *vk)
165 for (digest = 0; digest < LUKS2_DIGEST_MAX; digest++)
166 if (LUKS2_digest_verify_by_digest(cd, digest, vk) == digest)
172 int LUKS2_digest_verify_by_segment(struct crypt_device *cd,
173 struct luks2_hdr *hdr,
175 const struct volume_key *vk)
177 return LUKS2_digest_verify_by_digest(cd, LUKS2_digest_by_segment(hdr, segment), vk);
180 /* FIXME: segment can have more digests */
181 int LUKS2_digest_by_segment(struct luks2_hdr *hdr, int segment)
183 char segment_name[16];
184 json_object *jobj_digests, *jobj_digest_segments;
186 if (segment == CRYPT_DEFAULT_SEGMENT)
187 segment = LUKS2_get_default_segment(hdr);
189 json_object_object_get_ex(hdr->jobj, "digests", &jobj_digests);
191 if (snprintf(segment_name, sizeof(segment_name), "%u", segment) < 1)
194 json_object_object_foreach(jobj_digests, key, val) {
195 json_object_object_get_ex(val, "segments", &jobj_digest_segments);
196 if (!LUKS2_array_jobj(jobj_digest_segments, segment_name))
205 static int assign_one_digest(struct crypt_device *cd, struct luks2_hdr *hdr,
206 int keyslot, int digest, int assign)
208 json_object *jobj1, *jobj_digest, *jobj_digest_keyslots;
211 log_dbg(cd, "Keyslot %i %s digest %i.", keyslot, assign ? "assigned to" : "unassigned from", digest);
213 jobj_digest = LUKS2_get_digest_jobj(hdr, digest);
217 json_object_object_get_ex(jobj_digest, "keyslots", &jobj_digest_keyslots);
218 if (!jobj_digest_keyslots)
221 if (snprintf(num, sizeof(num), "%d", keyslot) < 0)
225 jobj1 = LUKS2_array_jobj(jobj_digest_keyslots, num);
227 json_object_array_add(jobj_digest_keyslots, json_object_new_string(num));
229 jobj1 = LUKS2_array_remove(jobj_digest_keyslots, num);
231 json_object_object_add(jobj_digest, "keyslots", jobj1);
237 int LUKS2_digest_assign(struct crypt_device *cd, struct luks2_hdr *hdr,
238 int keyslot, int digest, int assign, int commit)
240 json_object *jobj_digests;
243 if (digest == CRYPT_ANY_DIGEST) {
244 json_object_object_get_ex(hdr->jobj, "digests", &jobj_digests);
246 json_object_object_foreach(jobj_digests, key, val) {
248 r = assign_one_digest(cd, hdr, keyslot, atoi(key), assign);
253 r = assign_one_digest(cd, hdr, keyslot, digest, assign);
258 return commit ? LUKS2_hdr_write(cd, hdr) : 0;
261 static int assign_all_segments(struct luks2_hdr *hdr, int digest, int assign)
263 json_object *jobj1, *jobj_digest, *jobj_digest_segments;
265 jobj_digest = LUKS2_get_digest_jobj(hdr, digest);
269 json_object_object_get_ex(jobj_digest, "segments", &jobj_digest_segments);
270 if (!jobj_digest_segments)
274 json_object_object_foreach(LUKS2_get_segments_jobj(hdr), key, value) {
276 jobj1 = LUKS2_array_jobj(jobj_digest_segments, key);
278 json_object_array_add(jobj_digest_segments, json_object_new_string(key));
281 jobj1 = json_object_new_array();
284 json_object_object_add(jobj_digest, "segments", jobj1);
290 static int assign_one_segment(struct crypt_device *cd, struct luks2_hdr *hdr,
291 int segment, int digest, int assign)
293 json_object *jobj1, *jobj_digest, *jobj_digest_segments;
296 log_dbg(cd, "Segment %i %s digest %i.", segment, assign ? "assigned to" : "unassigned from", digest);
298 jobj_digest = LUKS2_get_digest_jobj(hdr, digest);
302 json_object_object_get_ex(jobj_digest, "segments", &jobj_digest_segments);
303 if (!jobj_digest_segments)
306 if (snprintf(num, sizeof(num), "%d", segment) < 0)
310 jobj1 = LUKS2_array_jobj(jobj_digest_segments, num);
312 json_object_array_add(jobj_digest_segments, json_object_new_string(num));
314 jobj1 = LUKS2_array_remove(jobj_digest_segments, num);
316 json_object_object_add(jobj_digest, "segments", jobj1);
322 int LUKS2_digest_segment_assign(struct crypt_device *cd, struct luks2_hdr *hdr,
323 int segment, int digest, int assign, int commit)
325 json_object *jobj_digests;
328 if (segment == CRYPT_DEFAULT_SEGMENT)
329 segment = LUKS2_get_default_segment(hdr);
331 if (digest == CRYPT_ANY_DIGEST) {
332 json_object_object_get_ex(hdr->jobj, "digests", &jobj_digests);
334 json_object_object_foreach(jobj_digests, key, val) {
336 if (segment == CRYPT_ANY_SEGMENT)
337 r = assign_all_segments(hdr, atoi(key), assign);
339 r = assign_one_segment(cd, hdr, segment, atoi(key), assign);
344 if (segment == CRYPT_ANY_SEGMENT)
345 r = assign_all_segments(hdr, digest, assign);
347 r = assign_one_segment(cd, hdr, segment, digest, assign);
353 return commit ? LUKS2_hdr_write(cd, hdr) : 0;
356 static int digest_unused(json_object *jobj_digest)
360 json_object_object_get_ex(jobj_digest, "segments", &jobj);
361 if (!jobj || !json_object_is_type(jobj, json_type_array) || json_object_array_length(jobj) > 0)
364 json_object_object_get_ex(jobj_digest, "keyslots", &jobj);
365 if (!jobj || !json_object_is_type(jobj, json_type_array))
368 return json_object_array_length(jobj) > 0 ? 0 : 1;
371 void LUKS2_digests_erase_unused(struct crypt_device *cd,
372 struct luks2_hdr *hdr)
374 json_object *jobj_digests;
376 json_object_object_get_ex(hdr->jobj, "digests", &jobj_digests);
377 if (!jobj_digests || !json_object_is_type(jobj_digests, json_type_object))
380 json_object_object_foreach(jobj_digests, key, val) {
381 if (digest_unused(val)) {
382 log_dbg(cd, "Erasing unused digest %d.", atoi(key));
383 json_object_object_del(jobj_digests, key);
388 /* Key description helpers */
389 static char *get_key_description_by_digest(struct crypt_device *cd, int digest)
391 char *desc, digest_str[3];
395 if (!crypt_get_uuid(cd))
398 r = snprintf(digest_str, sizeof(digest_str), "d%u", digest);
399 if (r < 0 || (size_t)r >= sizeof(digest_str))
402 /* "cryptsetup:<uuid>-<digest_str>" + \0 */
403 len = strlen(crypt_get_uuid(cd)) + strlen(digest_str) + 13;
409 r = snprintf(desc, len, "%s:%s-%s", "cryptsetup", crypt_get_uuid(cd), digest_str);
410 if (r < 0 || (size_t)r >= len) {
418 int LUKS2_key_description_by_segment(struct crypt_device *cd,
419 struct luks2_hdr *hdr, struct volume_key *vk, int segment)
421 char *desc = get_key_description_by_digest(cd, LUKS2_digest_by_segment(hdr, segment));
424 r = crypt_volume_key_set_description(vk, desc);
429 int LUKS2_volume_key_load_in_keyring_by_keyslot(struct crypt_device *cd,
430 struct luks2_hdr *hdr, struct volume_key *vk, int keyslot)
432 char *desc = get_key_description_by_digest(cd, LUKS2_digest_by_keyslot(hdr, keyslot));
435 r = crypt_volume_key_set_description(vk, desc);
437 r = crypt_volume_key_load_in_keyring(cd, vk);
443 int LUKS2_volume_key_load_in_keyring_by_digest(struct crypt_device *cd,
444 struct volume_key *vk, int digest)
446 char *desc = get_key_description_by_digest(cd, digest);
449 r = crypt_volume_key_set_description(vk, desc);
451 r = crypt_volume_key_load_in_keyring(cd, vk);