Coverage Report

Created: 2026-09-05 06:08

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/cryptsetup/lib/luks2/luks2_luks1_convert.c
Line
Count
Source
1
// SPDX-License-Identifier: GPL-2.0-or-later
2
/*
3
 * LUKS - Linux Unified Key Setup v2, LUKS1 conversion code
4
 *
5
 * Copyright (C) 2015-2026 Red Hat, Inc. All rights reserved.
6
 * Copyright (C) 2015-2026 Ondrej Kozina
7
 * Copyright (C) 2015-2026 Milan Broz
8
 */
9
10
#include "luks2_internal.h"
11
#include "../luks1/luks.h"
12
#include "../luks1/af.h"
13
14
static int json_luks1_keyslot(const struct luks_phdr *hdr_v1, int keyslot, json_object **keyslot_object)
15
0
{
16
0
  char *base64_str, cipher[LUKS_CIPHERNAME_L+LUKS_CIPHERMODE_L];
17
0
  size_t base64_len;
18
0
  json_object *keyslot_obj, *field, *jobj_kdf, *jobj_af, *jobj_area;
19
0
  uint64_t offset, area_size, length;
20
0
  int r;
21
22
0
  keyslot_obj = json_object_new_object();
23
0
  if (!keyslot_obj) {
24
0
    r = -ENOMEM;
25
0
    goto err;
26
0
  }
27
28
0
  json_object_object_add(keyslot_obj, "type", json_object_new_string("luks2"));
29
0
  json_object_object_add(keyslot_obj, "key_size", json_object_new_int64(hdr_v1->keyBytes));
30
31
  /* KDF */
32
0
  jobj_kdf = json_object_new_object();
33
0
  if (!jobj_kdf) {
34
0
    r = -ENOMEM;
35
0
    goto err;
36
0
  }
37
38
0
  json_object_object_add(jobj_kdf, "type", json_object_new_string(CRYPT_KDF_PBKDF2));
39
0
  json_object_object_add(jobj_kdf, "hash", json_object_new_string(hdr_v1->hashSpec));
40
0
  json_object_object_add(jobj_kdf, "iterations", json_object_new_int64(hdr_v1->keyblock[keyslot].passwordIterations));
41
  /* salt field */
42
0
  r = crypt_base64_encode(&base64_str, &base64_len, hdr_v1->keyblock[keyslot].passwordSalt, LUKS_SALTSIZE);
43
0
  if (r < 0) {
44
0
    json_object_put(keyslot_obj);
45
0
    json_object_put(jobj_kdf);
46
0
    return r;
47
0
  }
48
0
  field = json_object_new_string_len(base64_str, base64_len);
49
0
  free(base64_str);
50
0
  json_object_object_add(jobj_kdf, "salt", field);
51
0
  json_object_object_add(keyslot_obj, "kdf", jobj_kdf);
52
53
  /* AF */
54
0
  jobj_af = json_object_new_object();
55
0
  if (!jobj_af) {
56
0
    r = -ENOMEM;
57
0
    goto err;
58
0
  }
59
60
0
  json_object_object_add(jobj_af, "type", json_object_new_string("luks1"));
61
0
  json_object_object_add(jobj_af, "hash", json_object_new_string(hdr_v1->hashSpec));
62
  /* stripes field ignored, fixed to LUKS_STRIPES (4000) */
63
0
  json_object_object_add(jobj_af, "stripes", json_object_new_int(LUKS_STRIPES));
64
0
  json_object_object_add(keyslot_obj, "af", jobj_af);
65
66
  /* Area */
67
0
  jobj_area = json_object_new_object();
68
0
  if (!jobj_area) {
69
0
    r = -ENOMEM;
70
0
    goto err;
71
0
  }
72
73
0
  json_object_object_add(jobj_area, "type", json_object_new_string("raw"));
74
75
  /* encryption algorithm field */
76
0
  if (*hdr_v1->cipherMode != '\0') {
77
0
    if (snprintf(cipher, sizeof(cipher), "%s-%s", hdr_v1->cipherName, hdr_v1->cipherMode) < 0) {
78
0
      json_object_put(keyslot_obj);
79
0
      json_object_put(jobj_area);
80
0
      return -EINVAL;
81
0
    }
82
0
    json_object_object_add(jobj_area, "encryption", json_object_new_string(cipher));
83
0
  } else
84
0
    json_object_object_add(jobj_area, "encryption", json_object_new_string(hdr_v1->cipherName));
85
86
  /* area */
87
0
  if (LUKS_keyslot_area(hdr_v1, keyslot, &offset, &length)) {
88
0
    json_object_put(keyslot_obj);
89
0
    json_object_put(jobj_area);
90
0
    return -EINVAL;
91
0
  }
92
0
  area_size = size_round_up(length, 4096);
93
0
  json_object_object_add(jobj_area, "key_size", json_object_new_int(hdr_v1->keyBytes));
94
0
  json_object_object_add(jobj_area, "offset", crypt_jobj_new_uint64(offset));
95
0
  json_object_object_add(jobj_area, "size", crypt_jobj_new_uint64(area_size));
96
0
  json_object_object_add(keyslot_obj, "area", jobj_area);
97
98
0
  *keyslot_object = keyslot_obj;
99
0
  return 0;
100
0
err:
101
0
  json_object_put(keyslot_obj);
102
0
  return r;
103
0
}
104
105
static int json_luks1_keyslots(const struct luks_phdr *hdr_v1, json_object **keyslots_object)
106
0
{
107
0
  int keyslot, r;
108
0
  json_object *keyslot_obj, *field;
109
110
0
  keyslot_obj = json_object_new_object();
111
0
  if (!keyslot_obj)
112
0
    return -ENOMEM;
113
114
0
  for (keyslot = 0; keyslot < LUKS_NUMKEYS; keyslot++) {
115
0
    if (hdr_v1->keyblock[keyslot].active != LUKS_KEY_ENABLED)
116
0
      continue;
117
0
    r = json_luks1_keyslot(hdr_v1, keyslot, &field);
118
0
    if (r) {
119
0
      json_object_put(keyslot_obj);
120
0
      return r;
121
0
    }
122
0
    r = json_object_object_add_by_uint(keyslot_obj, keyslot, field);
123
0
    if (r) {
124
0
      json_object_put(field);
125
0
      json_object_put(keyslot_obj);
126
0
      return r;
127
0
    }
128
0
  }
129
130
0
  *keyslots_object = keyslot_obj;
131
0
  return 0;
132
0
}
133
134
static int json_luks1_segment(const struct luks_phdr *hdr_v1, json_object **segment_object)
135
0
{
136
0
  const char *c;
137
0
  char cipher[LUKS_CIPHERNAME_L+LUKS_CIPHERMODE_L];
138
0
  json_object *segment_obj, *field;
139
0
  uint64_t number;
140
141
0
  segment_obj = json_object_new_object();
142
0
  if (!segment_obj)
143
0
    return -ENOMEM;
144
145
  /* type field */
146
0
  field = json_object_new_string("crypt");
147
0
  if (!field) {
148
0
    json_object_put(segment_obj);
149
0
    return -ENOMEM;
150
0
  }
151
0
  json_object_object_add(segment_obj, "type", field);
152
153
  /* offset field */
154
0
  number = (uint64_t)hdr_v1->payloadOffset * SECTOR_SIZE;
155
156
0
  field = crypt_jobj_new_uint64(number);
157
0
  if (!field) {
158
0
    json_object_put(segment_obj);
159
0
    return -ENOMEM;
160
0
  }
161
0
  json_object_object_add(segment_obj, "offset", field);
162
163
  /* iv_tweak field */
164
0
  field = json_object_new_string("0");
165
0
  if (!field) {
166
0
    json_object_put(segment_obj);
167
0
    return -ENOMEM;
168
0
  }
169
0
  json_object_object_add(segment_obj, "iv_tweak", field);
170
171
  /* length field */
172
0
  field = json_object_new_string("dynamic");
173
0
  if (!field) {
174
0
    json_object_put(segment_obj);
175
0
    return -ENOMEM;
176
0
  }
177
0
  json_object_object_add(segment_obj, "size", field);
178
179
  /* cipher field */
180
0
  if (*hdr_v1->cipherMode != '\0') {
181
0
    if (snprintf(cipher, sizeof(cipher), "%s-%s", hdr_v1->cipherName, hdr_v1->cipherMode) < 0) {
182
0
      json_object_put(segment_obj);
183
0
      return -EINVAL;
184
0
    }
185
0
    c = cipher;
186
0
  } else
187
0
    c = hdr_v1->cipherName;
188
189
0
  field = json_object_new_string(c);
190
0
  if (!field) {
191
0
    json_object_put(segment_obj);
192
0
    return -ENOMEM;
193
0
  }
194
0
  json_object_object_add(segment_obj, "encryption", field);
195
196
  /* block field */
197
0
  field = json_object_new_int(SECTOR_SIZE);
198
0
  if (!field) {
199
0
    json_object_put(segment_obj);
200
0
    return -ENOMEM;
201
0
  }
202
0
  json_object_object_add(segment_obj, "sector_size", field);
203
204
0
  *segment_object = segment_obj;
205
0
  return 0;
206
0
}
207
208
static int json_luks1_segments(const struct luks_phdr *hdr_v1, json_object **segments_object)
209
0
{
210
0
  int r;
211
0
  json_object *segments_obj, *field;
212
213
0
  segments_obj = json_object_new_object();
214
0
  if (!segments_obj)
215
0
    return -ENOMEM;
216
217
0
  r = json_luks1_segment(hdr_v1, &field);
218
0
  if (r) {
219
0
    json_object_put(segments_obj);
220
0
    return r;
221
0
  }
222
0
  r = json_object_object_add_by_uint(segments_obj, 0, field);
223
0
  if (r) {
224
0
    json_object_put(field);
225
0
    json_object_put(segments_obj);
226
0
    return r;
227
0
  }
228
229
0
  *segments_object = segments_obj;
230
0
  return 0;
231
0
}
232
233
static int json_luks1_digest(const struct luks_phdr *hdr_v1, json_object **digest_object)
234
0
{
235
0
  char keyslot_str[16], *base64_str;
236
0
  int r, ks;
237
0
  size_t base64_len;
238
0
  json_object *digest_obj, *array, *field;
239
240
0
  digest_obj = json_object_new_object();
241
0
  if (!digest_obj)
242
0
    return -ENOMEM;
243
244
  /* type field */
245
0
  field = json_object_new_string("pbkdf2");
246
0
  if (!field) {
247
0
    json_object_put(digest_obj);
248
0
    return -ENOMEM;
249
0
  }
250
0
  json_object_object_add(digest_obj, "type", field);
251
252
  /* keyslots array */
253
0
  array = json_object_new_array();
254
0
  if (!array) {
255
0
    json_object_put(digest_obj);
256
0
    return -ENOMEM;
257
0
  }
258
0
  json_object_object_add(digest_obj, "keyslots", json_object_get(array));
259
260
0
  for (ks = 0; ks < LUKS_NUMKEYS; ks++) {
261
0
    if (hdr_v1->keyblock[ks].active != LUKS_KEY_ENABLED)
262
0
      continue;
263
0
    if (snprintf(keyslot_str, sizeof(keyslot_str), "%d", ks) < 0) {
264
0
      json_object_put(field);
265
0
      json_object_put(array);
266
0
      json_object_put(digest_obj);
267
0
      return -EINVAL;
268
0
    }
269
270
0
    field = json_object_new_string(keyslot_str);
271
0
    if (!field || json_object_array_add(array, field) < 0) {
272
0
      json_object_put(field);
273
0
      json_object_put(array);
274
0
      json_object_put(digest_obj);
275
0
      return -ENOMEM;
276
0
    }
277
0
  }
278
279
0
  json_object_put(array);
280
281
  /* segments array */
282
0
  array = json_object_new_array();
283
0
  if (!array) {
284
0
    json_object_put(digest_obj);
285
0
    return -ENOMEM;
286
0
  }
287
0
  json_object_object_add(digest_obj, "segments", json_object_get(array));
288
289
0
  field = json_object_new_string("0");
290
0
  if (!field || json_object_array_add(array, field) < 0) {
291
0
    json_object_put(field);
292
0
    json_object_put(array);
293
0
    json_object_put(digest_obj);
294
0
    return -ENOMEM;
295
0
  }
296
297
0
  json_object_put(array);
298
299
  /* hash field */
300
0
  field = json_object_new_string(hdr_v1->hashSpec);
301
0
  if (!field) {
302
0
    json_object_put(digest_obj);
303
0
    return -ENOMEM;
304
0
  }
305
0
  json_object_object_add(digest_obj, "hash", field);
306
307
  /* salt field */
308
0
  r = crypt_base64_encode(&base64_str, &base64_len, hdr_v1->mkDigestSalt, LUKS_SALTSIZE);
309
0
  if (r < 0) {
310
0
    json_object_put(digest_obj);
311
0
    return r;
312
0
  }
313
314
0
  field = json_object_new_string_len(base64_str, base64_len);
315
0
  free(base64_str);
316
0
  if (!field) {
317
0
    json_object_put(digest_obj);
318
0
    return -ENOMEM;
319
0
  }
320
0
  json_object_object_add(digest_obj, "salt", field);
321
322
  /* digest field */
323
0
  r = crypt_base64_encode(&base64_str, &base64_len, hdr_v1->mkDigest, LUKS_DIGESTSIZE);
324
0
  if (r < 0) {
325
0
    json_object_put(digest_obj);
326
0
    return r;
327
0
  }
328
329
0
  field = json_object_new_string_len(base64_str, base64_len);
330
0
  free(base64_str);
331
0
  if (!field) {
332
0
    json_object_put(digest_obj);
333
0
    return -ENOMEM;
334
0
  }
335
0
  json_object_object_add(digest_obj, "digest", field);
336
337
  /* iterations field */
338
0
  field = json_object_new_int64(hdr_v1->mkDigestIterations);
339
0
  if (!field) {
340
0
    json_object_put(digest_obj);
341
0
    return -ENOMEM;
342
0
  }
343
0
  json_object_object_add(digest_obj, "iterations", field);
344
345
0
  *digest_object = digest_obj;
346
0
  return 0;
347
0
}
348
349
static int json_luks1_digests(const struct luks_phdr *hdr_v1, json_object **digests_object)
350
0
{
351
0
  int r;
352
0
  json_object *digests_obj, *field;
353
354
0
  digests_obj = json_object_new_object();
355
0
  if (!digests_obj)
356
0
    return -ENOMEM;
357
358
0
  r = json_luks1_digest(hdr_v1, &field);
359
0
  if (r) {
360
0
    json_object_put(digests_obj);
361
0
    return r;
362
0
  }
363
0
  json_object_object_add(digests_obj, "0", field);
364
365
0
  *digests_object = digests_obj;
366
0
  return 0;
367
0
}
368
369
static int json_luks1_object(struct luks_phdr *hdr_v1, json_object **luks1_object, uint64_t keyslots_size)
370
0
{
371
0
  int r;
372
0
  json_object *luks1_obj, *field;
373
0
  uint64_t json_size;
374
375
0
  luks1_obj = json_object_new_object();
376
0
  if (!luks1_obj)
377
0
    return -ENOMEM;
378
379
  /* keyslots field */
380
0
  r = json_luks1_keyslots(hdr_v1, &field);
381
0
  if (r) {
382
0
    json_object_put(luks1_obj);
383
0
    return r;
384
0
  }
385
0
  json_object_object_add(luks1_obj, "keyslots", field);
386
387
  /* tokens field */
388
0
  field = json_object_new_object();
389
0
  if (!field) {
390
0
    json_object_put(luks1_obj);
391
0
    return -ENOMEM;
392
0
  }
393
0
  json_object_object_add(luks1_obj, "tokens", field);
394
395
  /* segments field */
396
0
  r = json_luks1_segments(hdr_v1, &field);
397
0
  if (r) {
398
0
    json_object_put(luks1_obj);
399
0
    return r;
400
0
  }
401
0
  json_object_object_add(luks1_obj, "segments", field);
402
403
  /* digests field */
404
0
  r = json_luks1_digests(hdr_v1, &field);
405
0
  if (r) {
406
0
    json_object_put(luks1_obj);
407
0
    return r;
408
0
  }
409
0
  json_object_object_add(luks1_obj, "digests", field);
410
411
  /* config field */
412
  /* anything else? */
413
0
  field = json_object_new_object();
414
0
  if (!field) {
415
0
    json_object_put(luks1_obj);
416
0
    return -ENOMEM;
417
0
  }
418
0
  json_object_object_add(luks1_obj, "config", field);
419
420
0
  json_size = LUKS2_HDR_16K_LEN - LUKS2_HDR_BIN_LEN;
421
0
  json_object_object_add(field, "json_size", crypt_jobj_new_uint64(json_size));
422
0
  keyslots_size -= (keyslots_size % 4096);
423
0
  json_object_object_add(field, "keyslots_size", crypt_jobj_new_uint64(keyslots_size));
424
425
0
  *luks1_object = luks1_obj;
426
0
  return 0;
427
0
}
428
429
static void move_keyslot_offset(json_object *jobj, int offset_add)
430
0
{
431
0
  json_object *jobj1, *jobj2, *jobj_area;
432
0
  uint64_t offset = 0;
433
434
0
  json_object_object_get_ex(jobj, "keyslots", &jobj1);
435
0
  json_object_object_foreach(jobj1, key, val) {
436
0
    UNUSED(key);
437
0
    json_object_object_get_ex(val, "area", &jobj_area);
438
0
    json_object_object_get_ex(jobj_area, "offset", &jobj2);
439
0
    offset = crypt_jobj_get_uint64(jobj2) + offset_add;
440
0
    json_object_object_add(jobj_area, "offset", crypt_jobj_new_uint64(offset));
441
0
  }
442
0
}
443
444
static int move_keyslot_areas(struct crypt_device *cd, off_t offset_from,
445
            off_t offset_to, size_t buf_size)
446
0
{
447
0
  int devfd, r = -EIO;
448
0
  struct device *device = crypt_metadata_device(cd);
449
0
  void *buf = NULL;
450
451
0
  log_dbg(cd, "Moving keyslot areas of size %zu from %jd to %jd.",
452
0
    buf_size, (intmax_t)offset_from, (intmax_t)offset_to);
453
454
0
  if (posix_memalign(&buf, crypt_getpagesize(), buf_size))
455
0
    return -ENOMEM;
456
457
0
  devfd = device_open(cd, device, O_RDWR);
458
0
  if (devfd < 0) {
459
0
    free(buf);
460
0
    return -EIO;
461
0
  }
462
463
  /* This can safely fail (for block devices). It only allocates space if it is possible. */
464
0
  if (posix_fallocate(devfd, offset_to, buf_size))
465
0
    log_dbg(cd, "Preallocation (fallocate) of new keyslot area not available.");
466
467
  /* Try to read *new* area to check that area is there (trimmed backup). */
468
0
  if (read_lseek_blockwise(devfd, device_block_size(cd, device),
469
0
         device_alignment(device), buf, buf_size,
470
0
         offset_to)!= (ssize_t)buf_size)
471
0
    goto out;
472
473
0
  if (read_lseek_blockwise(devfd, device_block_size(cd, device),
474
0
         device_alignment(device), buf, buf_size,
475
0
         offset_from)!= (ssize_t)buf_size)
476
0
    goto out;
477
478
0
  if (write_lseek_blockwise(devfd, device_block_size(cd, device),
479
0
          device_alignment(device), buf, buf_size,
480
0
          offset_to) != (ssize_t)buf_size)
481
0
    goto out;
482
483
0
  r = 0;
484
0
out:
485
0
  device_sync(cd, device);
486
0
  crypt_safe_memzero(buf, buf_size);
487
0
  free(buf);
488
489
0
  return r;
490
0
}
491
492
static int luks_header_in_use(struct crypt_device *cd)
493
0
{
494
0
  int r;
495
496
0
  r = lookup_dm_dev_by_uuid(cd, crypt_get_uuid(cd), crypt_get_type(cd));
497
0
  if (r < 0)
498
0
    log_err(cd, _("Cannot check status of device with uuid: %s."), crypt_get_uuid(cd));
499
500
0
  return r;
501
0
}
502
503
/* Check if there is a luksmeta area (foreign metadata created by the luksmeta package) */
504
static int luksmeta_header_present(struct crypt_device *cd, off_t luks1_size)
505
0
{
506
0
  int devfd, r = 0;
507
0
  static const uint8_t LM_MAGIC[] = { 'L', 'U', 'K', 'S', 'M', 'E', 'T', 'A' };
508
0
  struct device *device = crypt_metadata_device(cd);
509
0
  void *buf = NULL;
510
511
0
  if (posix_memalign(&buf, crypt_getpagesize(), sizeof(LM_MAGIC)))
512
0
    return -ENOMEM;
513
514
0
  devfd = device_open(cd, device, O_RDONLY);
515
0
  if (devfd < 0) {
516
0
    free(buf);
517
0
    return -EIO;
518
0
  }
519
520
  /* Note: we must not detect failure as problem here, header can be trimmed. */
521
0
  if (read_lseek_blockwise(devfd, device_block_size(cd, device), device_alignment(device),
522
0
    buf, sizeof(LM_MAGIC), luks1_size) == (ssize_t)sizeof(LM_MAGIC) &&
523
0
    !memcmp(LM_MAGIC, buf, sizeof(LM_MAGIC))) {
524
0
      log_err(cd, _("Unable to convert header with LUKSMETA additional metadata."));
525
0
      r = -EBUSY;
526
0
  }
527
528
0
  free(buf);
529
0
  return r;
530
0
}
531
532
/* Convert LUKS1 -> LUKS2 */
533
int LUKS2_luks1_to_luks2(struct crypt_device *cd, struct luks_phdr *hdr1, struct luks2_hdr *hdr2)
534
0
{
535
0
  int r;
536
0
  json_object *jobj = NULL;
537
0
  size_t buf_size, buf_offset, luks1_size, luks1_shift = 2 * LUKS2_HDR_16K_LEN - LUKS_ALIGN_KEYSLOTS;
538
0
  uint64_t required_size, max_size = crypt_get_data_offset(cd) * SECTOR_SIZE;
539
0
  char cipher_spec[MAX_CAPI_LEN];
540
541
  /* for detached headers max size == device size */
542
0
  if (!max_size && (r = device_size(crypt_metadata_device(cd), &max_size)))
543
0
    return r;
544
545
0
  luks1_size = LUKS_device_sectors(hdr1) << SECTOR_SHIFT;
546
0
  luks1_size = size_round_up(luks1_size, LUKS_ALIGN_KEYSLOTS);
547
0
  if (!luks1_size)
548
0
    return -EINVAL;
549
550
0
  if (LUKS_keyslots_offset(hdr1) != (LUKS_ALIGN_KEYSLOTS / SECTOR_SIZE)) {
551
0
    log_dbg(cd, "Unsupported keyslots material offset: %zu.", LUKS_keyslots_offset(hdr1));
552
0
    return -EINVAL;
553
0
  }
554
555
0
  if (crypt_check_cipher(cd, hdr1->keyBytes, hdr1->cipherName, hdr1->cipherMode)) {
556
0
    log_err(cd, _("Unable to use cipher specification %s-%s for LUKS2."),
557
0
      hdr1->cipherName, hdr1->cipherMode);
558
0
    return -EINVAL;
559
0
  }
560
561
0
  r = snprintf(cipher_spec, sizeof(cipher_spec), "%s-%s", hdr1->cipherName, hdr1->cipherMode);
562
0
  if (r < 0 || (size_t)r >= sizeof(cipher_spec))
563
0
    return -EINVAL;
564
0
  if (LUKS2_keyslot_cipher_incompatible(cd, cipher_spec)) {
565
0
    log_err(cd, _("Unable to use cipher specification %s-%s for LUKS2 keyslot."),
566
0
      hdr1->cipherName, hdr1->cipherMode);
567
0
    return -EINVAL;
568
0
  }
569
570
0
  if (luksmeta_header_present(cd, luks1_size))
571
0
    return -EINVAL;
572
573
0
  log_dbg(cd, "Max size: %" PRIu64 ", LUKS1 (full) header size %zu , required shift: %zu",
574
0
    max_size, luks1_size, luks1_shift);
575
576
0
  required_size = luks1_size + luks1_shift;
577
578
0
  if ((max_size < required_size) &&
579
0
      device_fallocate(crypt_metadata_device(cd), required_size)) {
580
0
    log_err(cd, _("Unable to move keyslot area. Not enough space."));
581
0
    return -EINVAL;
582
0
  }
583
584
0
  if (max_size < required_size)
585
0
    max_size = required_size;
586
587
  /* fix coverity false positive integer underflow */
588
0
  if (max_size < 2 * LUKS2_HDR_16K_LEN)
589
0
    return -EINVAL;
590
591
0
  r = json_luks1_object(hdr1, &jobj, max_size - 2 * LUKS2_HDR_16K_LEN);
592
0
  if (r < 0)
593
0
    return r;
594
595
0
  move_keyslot_offset(jobj, luks1_shift);
596
597
  /* Create and fill LUKS2 hdr */
598
0
  memset(hdr2, 0, sizeof(*hdr2));
599
0
  hdr2->hdr_size = LUKS2_HDR_16K_LEN;
600
0
  hdr2->seqid = 1;
601
0
  hdr2->version = 2;
602
0
  strncpy(hdr2->checksum_alg, "sha256", LUKS2_CHECKSUM_ALG_L);
603
0
  r = crypt_random_get(cd, (char*)hdr2->salt1, sizeof(hdr2->salt1), CRYPT_RND_SALT);
604
0
  if (r < 0) {
605
0
    log_dbg(cd, "Cannot generate header salt.");
606
0
    goto out;
607
0
  }
608
0
  r = crypt_random_get(cd, (char*)hdr2->salt2, sizeof(hdr2->salt2), CRYPT_RND_SALT);
609
0
  if (r < 0) {
610
0
    log_dbg(cd, "Cannot generate header salt.");
611
0
    goto out;
612
0
  }
613
0
  strncpy(hdr2->uuid, crypt_get_uuid(cd), LUKS2_UUID_L-1); /* UUID should be max 36 chars */
614
0
  hdr2->jobj = jobj;
615
616
  /*
617
   * It duplicates check in LUKS2_hdr_write() but we don't want to move
618
   * keyslot areas in case it would fail later
619
   */
620
0
  if (max_size < LUKS2_hdr_and_areas_size(hdr2)) {
621
0
    r = -EINVAL;
622
0
    goto out;
623
0
  }
624
625
  /* check future LUKS2 metadata before moving keyslots area */
626
0
  if (LUKS2_hdr_validate(cd, hdr2->jobj, hdr2->hdr_size - LUKS2_HDR_BIN_LEN)) {
627
0
    log_err(cd, _("Cannot convert to LUKS2 format - invalid metadata."));
628
0
    r = -EINVAL;
629
0
    goto out;
630
0
  }
631
632
0
  if ((r = luks_header_in_use(cd))) {
633
0
    if (r > 0)
634
0
      r = -EBUSY;
635
0
    goto out;
636
0
  }
637
638
  /* move keyslots 4k -> 32k offset */
639
0
  buf_offset = 2 * LUKS2_HDR_16K_LEN;
640
0
  buf_size   = luks1_size - LUKS_ALIGN_KEYSLOTS;
641
642
  /* check future LUKS2 keyslots area is at least as large as LUKS1 keyslots area */
643
0
  if (buf_size > LUKS2_keyslots_size(hdr2)) {
644
0
    log_err(cd, _("Unable to move keyslot area. LUKS2 keyslots area too small."));
645
0
    r = -EINVAL;
646
0
    goto out;
647
0
  }
648
649
0
  if ((r = move_keyslot_areas(cd, 8 * SECTOR_SIZE, buf_offset, buf_size)) < 0) {
650
0
    log_err(cd, _("Unable to move keyslot area."));
651
0
    goto out;
652
0
  }
653
654
  /* Write new LUKS2 JSON */
655
0
  r = LUKS2_hdr_write(cd, hdr2);
656
0
out:
657
0
  LUKS2_hdr_free(cd, hdr2);
658
659
0
  return r;
660
0
}
661
662
static int keyslot_LUKS1_compatible(struct crypt_device *cd, struct luks2_hdr *hdr,
663
            int keyslot, uint32_t key_size, const char *hash)
664
0
{
665
0
  json_object *jobj_keyslot, *jobj, *jobj_kdf, *jobj_af;
666
0
  uint64_t l2_offset, l2_length;
667
0
  size_t ks_key_size;
668
0
  const char *ks_cipher, *data_cipher;
669
670
0
  jobj_keyslot = LUKS2_get_keyslot_jobj(hdr, keyslot);
671
0
  if (!jobj_keyslot)
672
0
    return 1;
673
674
  /* Keyslot type */
675
0
  if (!json_object_object_get_ex(jobj_keyslot, "type", &jobj))
676
0
    return 0;
677
0
  if (strcmp(json_object_get_string(jobj), "luks2")) {
678
0
    log_dbg(cd, "Keyslot %d type %s is not compatible.",
679
0
      keyslot, json_object_get_string(jobj));
680
0
    return 0;
681
0
  }
682
683
  /* Keyslot uses PBKDF2, this implies memory and parallel is not used. */
684
0
  jobj = NULL;
685
0
  if (!json_object_object_get_ex(jobj_keyslot, "kdf", &jobj_kdf) ||
686
0
      !json_object_object_get_ex(jobj_kdf, "type", &jobj))
687
0
    return 0;
688
0
  if (strcmp(json_object_get_string(jobj), CRYPT_KDF_PBKDF2)) {
689
0
    log_dbg(cd, "Keyslot %d does not use PBKDF2.", keyslot);
690
0
    return 0;
691
0
  }
692
693
  /* Keyslot KDF hash is the same as the digest hash. */
694
0
  jobj = NULL;
695
0
  if (!json_object_object_get_ex(jobj_kdf, "hash", &jobj))
696
0
    return 0;
697
0
  if (strcmp(json_object_get_string(jobj), hash)) {
698
0
    log_dbg(cd, "Keyslot %d PBKDF uses different hash %s than digest hash %s.",
699
0
      keyslot, json_object_get_string(jobj), hash);
700
0
    return 0;
701
0
  }
702
703
  /* Keyslot AF use compatible striptes. */
704
0
  jobj = NULL;
705
0
  if (!json_object_object_get_ex(jobj_keyslot, "af", &jobj_af) ||
706
0
      !json_object_object_get_ex(jobj_af, "stripes", &jobj))
707
0
    return 0;
708
0
  if (json_object_get_int(jobj) != LUKS_STRIPES) {
709
0
    log_dbg(cd, "Keyslot %d AF uses incompatible stripes count.", keyslot);
710
0
    return 0;
711
0
  }
712
713
  /* Keyslot AF hash is the same as the digest hash. */
714
0
  jobj = NULL;
715
0
  if (!json_object_object_get_ex(jobj_af, "hash", &jobj))
716
0
    return 0;
717
0
  if (strcmp(json_object_get_string(jobj), hash)) {
718
0
    log_dbg(cd, "Keyslot %d AF uses different hash %s than digest hash %s.",
719
0
      keyslot, json_object_get_string(jobj), hash);
720
0
    return 0;
721
0
  }
722
723
0
  ks_cipher = LUKS2_get_keyslot_cipher(hdr, keyslot, &ks_key_size);
724
0
  data_cipher = LUKS2_get_cipher(hdr, CRYPT_DEFAULT_SEGMENT);
725
0
  if (!ks_cipher || !data_cipher || key_size != ks_key_size || strcmp(ks_cipher, data_cipher)) {
726
0
    log_dbg(cd, "Cipher in keyslot %d is different from volume key encryption.", keyslot);
727
0
    return 0;
728
0
  }
729
730
0
  if (LUKS2_keyslot_area(hdr, keyslot, &l2_offset, &l2_length))
731
0
    return 0;
732
733
0
  if (l2_length != (size_round_up(AF_split_sectors(key_size, LUKS_STRIPES) * SECTOR_SIZE, 4096))) {
734
0
    log_dbg(cd, "Area length in LUKS2 keyslot (%d) is not compatible with LUKS1", keyslot);
735
0
    return 0;
736
0
  }
737
738
0
  return 1;
739
0
}
740
741
/* Convert LUKS2 -> LUKS1 */
742
int LUKS2_luks2_to_luks1(struct crypt_device *cd, struct luks2_hdr *hdr2, struct luks_phdr *hdr1)
743
0
{
744
0
  size_t buf_size, buf_offset;
745
0
  char cipher[LUKS_CIPHERNAME_L], cipher_mode[LUKS_CIPHERMODE_L];
746
0
  char *digest, *digest_salt;
747
0
  const char *hash;
748
0
  size_t len;
749
0
  json_object *jobj_keyslot, *jobj_digest, *jobj_segment, *jobj_kdf, *jobj_area, *jobj1, *jobj2;
750
0
  uint32_t key_size;
751
0
  int i, r, last_active = 0;
752
0
  uint64_t offset, area_length;
753
0
  char *buf, luksMagic[] = LUKS_MAGIC;
754
0
  crypt_keyslot_info ki;
755
756
0
  jobj_digest  = LUKS2_get_digest_jobj(hdr2, 0);
757
0
  if (!jobj_digest)
758
0
    return -EINVAL;
759
760
0
  jobj_segment = LUKS2_get_segment_jobj(hdr2, CRYPT_DEFAULT_SEGMENT);
761
0
  if (!jobj_segment)
762
0
    return -EINVAL;
763
764
0
  if (json_segment_get_sector_size(jobj_segment) != SECTOR_SIZE) {
765
0
    log_err(cd, _("Cannot convert to LUKS1 format - default segment encryption sector size is not 512 bytes."));
766
0
    return -EINVAL;
767
0
  }
768
769
0
  json_object_object_get_ex(hdr2->jobj, "digests", &jobj1);
770
0
  if (!json_object_object_get_ex(jobj_digest, "type", &jobj2) ||
771
0
      strcmp(json_object_get_string(jobj2), "pbkdf2") ||
772
0
      json_object_object_length(jobj1) != 1) {
773
0
    log_err(cd, _("Cannot convert to LUKS1 format - key slot digests are not LUKS1 compatible."));
774
0
    return -EINVAL;
775
0
  }
776
0
  if (!json_object_object_get_ex(jobj_digest, "hash", &jobj2))
777
0
    return -EINVAL;
778
0
  hash = json_object_get_string(jobj2);
779
0
  if (crypt_hash_size(hash) < 0)
780
0
    return -EINVAL;
781
782
0
  r = crypt_parse_name_and_mode(LUKS2_get_cipher(hdr2, CRYPT_DEFAULT_SEGMENT), cipher, NULL, cipher_mode);
783
0
  if (r < 0)
784
0
    return r;
785
786
0
  if (crypt_cipher_wrapped_key(cipher, cipher_mode)) {
787
0
    log_err(cd, _("Cannot convert to LUKS1 format - device uses wrapped key cipher %s."), cipher);
788
0
    return -EINVAL;
789
0
  }
790
791
0
  if (json_segments_count(LUKS2_get_segments_jobj(hdr2)) != 1) {
792
0
    log_err(cd, _("Cannot convert to LUKS1 format - device uses more segments."));
793
0
    return -EINVAL;
794
0
  }
795
796
0
  r = LUKS2_tokens_count(hdr2);
797
0
  if (r < 0)
798
0
    return r;
799
0
  if (r > 0) {
800
0
    log_err(cd, _("Cannot convert to LUKS1 format - LUKS2 header contains %u token(s)."), r);
801
0
    return -EINVAL;
802
0
  }
803
804
0
  r = LUKS2_get_volume_key_size(hdr2, 0);
805
0
  if (r < 0) {
806
0
    log_err(cd, _("Cannot convert to LUKS1 format - there are no active keyslots."), r);
807
0
    return -EINVAL;
808
0
  }
809
0
  key_size = r;
810
811
0
  for (i = 0; i < LUKS2_KEYSLOTS_MAX; i++) {
812
0
    ki = LUKS2_keyslot_info(hdr2, i);
813
814
0
    if (ki == CRYPT_SLOT_INACTIVE)
815
0
      continue;
816
817
0
    if (ki == CRYPT_SLOT_INVALID) {
818
0
      log_err(cd, _("Cannot convert to LUKS1 format - keyslot %u is in invalid state."), i);
819
0
      return -EINVAL;
820
0
    }
821
822
0
    if (ki == CRYPT_SLOT_UNBOUND) {
823
0
      log_err(cd, _("Cannot convert to LUKS1 format - keyslot %u is unbound."), i);
824
0
      return -EINVAL;
825
0
    }
826
827
0
    if (i >= LUKS_NUMKEYS) {
828
0
      log_err(cd, _("Cannot convert to LUKS1 format - slot %u (over maximum slots) is still active."), i);
829
0
      return -EINVAL;
830
0
    }
831
832
0
    if (!keyslot_LUKS1_compatible(cd, hdr2, i, key_size, hash)) {
833
0
      log_err(cd, _("Cannot convert to LUKS1 format - keyslot %u is not LUKS1 compatible."), i);
834
0
      return -EINVAL;
835
0
    }
836
0
  }
837
838
0
  memset(hdr1, 0, sizeof(*hdr1));
839
840
0
  for (i = 0; i < LUKS_NUMKEYS; i++) {
841
0
    hdr1->keyblock[i].active = LUKS_KEY_DISABLED;
842
0
    hdr1->keyblock[i].stripes = LUKS_STRIPES;
843
844
0
    jobj_keyslot = LUKS2_get_keyslot_jobj(hdr2, i);
845
846
0
    if (jobj_keyslot) {
847
0
      if (!json_object_object_get_ex(jobj_keyslot, "area", &jobj_area))
848
0
        return -EINVAL;
849
0
      if (!json_object_object_get_ex(jobj_area, "offset", &jobj1))
850
0
        return -EINVAL;
851
0
      offset = crypt_jobj_get_uint64(jobj1);
852
0
    } else {
853
0
      if (LUKS2_find_area_gap(cd, hdr2, key_size, &offset, &area_length))
854
0
        return -EINVAL;
855
      /*
856
       * We have to create placeholder luks2 keyslots in place of all
857
       * inactive keyslots. Otherwise we would allocate all
858
       * inactive luks1 keyslots over same binary keyslot area.
859
       */
860
0
      if (placeholder_keyslot_alloc(cd, i, offset, area_length))
861
0
        return -EINVAL;
862
0
    }
863
864
0
    offset /= SECTOR_SIZE;
865
0
    if (offset > UINT32_MAX)
866
0
      return -EINVAL;
867
868
0
    hdr1->keyblock[i].keyMaterialOffset = offset;
869
0
    hdr1->keyblock[i].keyMaterialOffset -=
870
0
        ((2 * LUKS2_HDR_16K_LEN - LUKS_ALIGN_KEYSLOTS) / SECTOR_SIZE);
871
872
0
    if (!jobj_keyslot)
873
0
      continue;
874
875
0
    hdr1->keyblock[i].active = LUKS_KEY_ENABLED;
876
0
    last_active = i;
877
878
0
    if (!json_object_object_get_ex(jobj_keyslot, "kdf", &jobj_kdf))
879
0
      continue;
880
881
0
    if (!json_object_object_get_ex(jobj_kdf, "iterations", &jobj1))
882
0
      continue;
883
0
    hdr1->keyblock[i].passwordIterations = crypt_jobj_get_uint32(jobj1);
884
885
0
    if (!json_object_object_get_ex(jobj_kdf, "salt", &jobj1))
886
0
      continue;
887
888
0
    if (crypt_base64_decode(&buf, &len, json_object_get_string(jobj1),
889
0
          json_object_get_string_len(jobj1)))
890
0
      continue;
891
0
    if (len > 0 && len != LUKS_SALTSIZE) {
892
0
      free(buf);
893
0
      continue;
894
0
    }
895
0
    memcpy(hdr1->keyblock[i].passwordSalt, buf, LUKS_SALTSIZE);
896
0
    free(buf);
897
0
  }
898
899
0
  if (!jobj_keyslot) {
900
0
    jobj_keyslot = LUKS2_get_keyslot_jobj(hdr2, last_active);
901
0
    if (!jobj_keyslot)
902
0
      return -EINVAL;
903
0
  }
904
905
0
  if (!json_object_object_get_ex(jobj_keyslot, "area", &jobj_area))
906
0
    return -EINVAL;
907
0
  if (!json_object_object_get_ex(jobj_area, "encryption", &jobj1))
908
0
    return -EINVAL;
909
0
  r = crypt_parse_name_and_mode(json_object_get_string(jobj1), cipher, NULL, cipher_mode);
910
0
  if (r < 0)
911
0
    return r;
912
913
0
  strncpy(hdr1->cipherName, cipher, LUKS_CIPHERNAME_L - 1);
914
0
  hdr1->cipherName[LUKS_CIPHERNAME_L-1] = '\0';
915
0
  strncpy(hdr1->cipherMode, cipher_mode, LUKS_CIPHERMODE_L - 1);
916
0
  hdr1->cipherMode[LUKS_CIPHERMODE_L-1] = '\0';
917
918
0
  if (!json_object_object_get_ex(jobj_keyslot, "kdf", &jobj_kdf))
919
0
    return -EINVAL;
920
0
  if (!json_object_object_get_ex(jobj_kdf, "hash", &jobj1))
921
0
    return -EINVAL;
922
0
  strncpy(hdr1->hashSpec, json_object_get_string(jobj1), sizeof(hdr1->hashSpec) - 1);
923
924
0
  hdr1->keyBytes = key_size;
925
926
0
  if (!json_object_object_get_ex(jobj_digest, "iterations", &jobj1))
927
0
    return -EINVAL;
928
0
  hdr1->mkDigestIterations = crypt_jobj_get_uint32(jobj1);
929
930
0
  if (!json_object_object_get_ex(jobj_digest, "digest", &jobj1))
931
0
    return -EINVAL;
932
0
  r = crypt_base64_decode(&digest, &len, json_object_get_string(jobj1),
933
0
        json_object_get_string_len(jobj1));
934
0
  if (r < 0)
935
0
    return r;
936
  /* We can store full digest here, not only sha1 length */
937
0
  if (len < LUKS_DIGESTSIZE) {
938
0
    free(digest);
939
0
    return -EINVAL;
940
0
  }
941
0
  memcpy(hdr1->mkDigest, digest, LUKS_DIGESTSIZE);
942
0
  free(digest);
943
944
0
  if (!json_object_object_get_ex(jobj_digest, "salt", &jobj1))
945
0
    return -EINVAL;
946
0
  r = crypt_base64_decode(&digest_salt, &len, json_object_get_string(jobj1),
947
0
        json_object_get_string_len(jobj1));
948
0
  if (r < 0)
949
0
    return r;
950
0
  if (len != LUKS_SALTSIZE) {
951
0
    free(digest_salt);
952
0
    return -EINVAL;
953
0
  }
954
0
  memcpy(hdr1->mkDigestSalt, digest_salt, LUKS_SALTSIZE);
955
0
  free(digest_salt);
956
957
0
  if (!json_object_object_get_ex(jobj_segment, "offset", &jobj1))
958
0
    return -EINVAL;
959
0
  offset = crypt_jobj_get_uint64(jobj1) / SECTOR_SIZE;
960
0
  if (offset > UINT32_MAX)
961
0
    return -EINVAL;
962
0
  hdr1->payloadOffset = offset;
963
964
0
  strncpy(hdr1->uuid, hdr2->uuid, UUID_STRING_L); /* max 36 chars */
965
0
  hdr1->uuid[UUID_STRING_L-1] = '\0';
966
967
0
  memcpy(hdr1->magic, luksMagic, LUKS_MAGIC_L);
968
969
0
  hdr1->version = 1;
970
971
0
  r = luks_header_in_use(cd);
972
0
  if (r)
973
0
    return r > 0 ? -EBUSY : r;
974
975
  /* move keyslots 32k -> 4k offset */
976
0
  buf_offset = 2 * LUKS2_HDR_16K_LEN;
977
0
  buf_size   = LUKS2_keyslots_size(hdr2);
978
0
  r = move_keyslot_areas(cd, buf_offset, 8 * SECTOR_SIZE, buf_size);
979
0
  if (r < 0) {
980
0
    log_err(cd, _("Unable to move keyslot area."));
981
0
    return r;
982
0
  }
983
984
0
  crypt_wipe_device(cd, crypt_metadata_device(cd), CRYPT_WIPE_ZERO, 0,
985
0
        8 * SECTOR_SIZE, 8 * SECTOR_SIZE, NULL, NULL);
986
987
  /* Write new LUKS1 hdr */
988
0
  return LUKS_write_phdr(hdr1, cd);
989
0
}