Add --keyfile-offset and --new-keyfile-offset to cryptsetup.
[platform/upstream/cryptsetup.git] / lib / setup.c
1 /*
2  * libcryptsetup - cryptsetup library
3  *
4  * Copyright (C) 2004, Christophe Saout <christophe@saout.de>
5  * Copyright (C) 2004-2007, Clemens Fruhwirth <clemens@endorphin.org>
6  * Copyright (C) 2009-2011, Red Hat, Inc. All rights reserved.
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * version 2 as published by the Free Software Foundation.
11  *
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.
16  *
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.
20  */
21
22 #include <string.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <stdarg.h>
26 #include <fcntl.h>
27 #include <errno.h>
28
29 #include "libcryptsetup.h"
30 #include "luks.h"
31 #include "loopaes.h"
32 #include "internal.h"
33 #include "crypto_backend.h"
34
35 struct crypt_device {
36         char *type;
37
38         char *device;
39         char *metadata_device;
40
41         char *backing_file;
42         int loop_fd;
43         struct volume_key *volume_key;
44         uint64_t timeout;
45         uint64_t iteration_time;
46         int tries;
47         int password_verify;
48         int rng_type;
49
50         /* used in CRYPT_LUKS1 */
51         struct luks_phdr hdr;
52         uint64_t PBKDF2_per_sec;
53
54         /* used in CRYPT_PLAIN */
55         struct crypt_params_plain plain_hdr;
56         char *plain_cipher;
57         char *plain_cipher_mode;
58         char *plain_uuid;
59         unsigned int plain_key_size;
60
61         /* used in CRYPT_LOOPAES */
62         struct crypt_params_loopaes loopaes_hdr;
63         char *loopaes_cipher;
64         char *loopaes_cipher_mode;
65         char *loopaes_uuid;
66         unsigned int loopaes_key_size;
67
68         /* callbacks definitions */
69         void (*log)(int level, const char *msg, void *usrptr);
70         void *log_usrptr;
71         int (*confirm)(const char *msg, void *usrptr);
72         void *confirm_usrptr;
73         int (*password)(const char *msg, char *buf, size_t length, void *usrptr);
74         void *password_usrptr;
75
76         /* last error message */
77         char error[MAX_ERROR_LENGTH];
78 };
79
80 /* Global error */
81 /* FIXME: not thread safe, remove this later */
82 static char global_error[MAX_ERROR_LENGTH] = {0};
83
84 /* Log helper */
85 static void (*_default_log)(int level, const char *msg, void *usrptr) = NULL;
86 static int _debug_level = 0;
87
88 void crypt_set_debug_level(int level)
89 {
90         _debug_level = level;
91 }
92
93 int crypt_get_debug_level(void)
94 {
95         return _debug_level;
96 }
97
98 static void crypt_set_error(struct crypt_device *cd, const char *error)
99 {
100         size_t size = strlen(error);
101
102         /* Set global error, ugly hack... */
103         strncpy(global_error, error, MAX_ERROR_LENGTH - 2);
104         if (size < MAX_ERROR_LENGTH && global_error[size - 1] == '\n')
105                 global_error[size - 1] = '\0';
106
107         /* Set error string per context */
108         if (cd) {
109                 strncpy(cd->error, error, MAX_ERROR_LENGTH - 2);
110                 if (size < MAX_ERROR_LENGTH && cd->error[size - 1] == '\n')
111                         cd->error[size - 1] = '\0';
112         }
113 }
114
115 void crypt_log(struct crypt_device *cd, int level, const char *msg)
116 {
117         if (cd && cd->log)
118                 cd->log(level, msg, cd->log_usrptr);
119         else if (_default_log)
120                 _default_log(level, msg, NULL);
121
122         if (level == CRYPT_LOG_ERROR)
123                 crypt_set_error(cd, msg);
124 }
125
126 __attribute__((format(printf, 5, 6)))
127 void logger(struct crypt_device *cd, int level, const char *file,
128             int line, const char *format, ...)
129 {
130         va_list argp;
131         char *target = NULL;
132
133         va_start(argp, format);
134
135         if (vasprintf(&target, format, argp) > 0 ) {
136                 if (level >= 0) {
137                         crypt_log(cd, level, target);
138 #ifdef CRYPT_DEBUG
139                 } else if (_debug_level)
140                         printf("# %s:%d %s\n", file ?: "?", line, target);
141 #else
142                 } else if (_debug_level)
143                         printf("# %s\n", target);
144 #endif
145         }
146
147         va_end(argp);
148         free(target);
149 }
150
151 static const char *mdata_device(struct crypt_device *cd)
152 {
153         return cd->metadata_device ?: cd->device;
154 }
155
156 static int init_crypto(struct crypt_device *ctx)
157 {
158         int r;
159
160         r = crypt_random_init(ctx);
161         if (r < 0) {
162                 log_err(ctx, _("Cannot initialize crypto RNG backend.\n"));
163                 return r;
164         }
165
166         r = crypt_backend_init(ctx);
167         if (r < 0)
168                 log_err(ctx, _("Cannot initialize crypto backend.\n"));
169
170         return r;
171 }
172
173 static int process_key(struct crypt_device *cd, const char *hash_name,
174                        size_t key_size, const char *pass, size_t passLen,
175                        struct volume_key **vk)
176 {
177         int r;
178
179         if (!key_size)
180                 return -EINVAL;
181
182         *vk = crypt_alloc_volume_key(key_size, NULL);
183         if (!*vk)
184                 return -ENOMEM;
185
186         if (hash_name) {
187                 r = crypt_plain_hash(cd, hash_name, (*vk)->key, key_size, pass, passLen);
188                 if (r < 0) {
189                         if (r == -ENOENT)
190                                 log_err(cd, _("Hash algorithm %s not supported.\n"),
191                                         hash_name);
192                         else
193                                 log_err(cd, _("Key processing error (using hash %s).\n"),
194                                         hash_name);
195                         crypt_free_volume_key(*vk);
196                         *vk = NULL;
197                         return -EINVAL;
198                 }
199         } else if (passLen > key_size) {
200                 memcpy((*vk)->key, pass, key_size);
201         } else {
202                 memcpy((*vk)->key, pass, passLen);
203         }
204
205         return 0;
206 }
207
208 static int isPLAIN(const char *type)
209 {
210         return (type && !strcmp(CRYPT_PLAIN, type));
211 }
212
213 static int isLUKS(const char *type)
214 {
215         return (type && !strcmp(CRYPT_LUKS1, type));
216 }
217
218 static int isLOOPAES(const char *type)
219 {
220         return (type && !strcmp(CRYPT_LOOPAES, type));
221 }
222
223 /* keyslot helpers */
224 static int keyslot_verify_or_find_empty(struct crypt_device *cd, int *keyslot)
225 {
226         if (*keyslot == CRYPT_ANY_SLOT) {
227                 *keyslot = LUKS_keyslot_find_empty(&cd->hdr);
228                 if (*keyslot < 0) {
229                         log_err(cd, _("All key slots full.\n"));
230                         return -EINVAL;
231                 }
232         }
233
234         switch (LUKS_keyslot_info(&cd->hdr, *keyslot)) {
235                 case CRYPT_SLOT_INVALID:
236                         log_err(cd, _("Key slot %d is invalid, please select between 0 and %d.\n"),
237                                 *keyslot, LUKS_NUMKEYS - 1);
238                         return -EINVAL;
239                 case CRYPT_SLOT_INACTIVE:
240                         break;
241                 default:
242                         log_err(cd, _("Key slot %d is full, please select another one.\n"),
243                                 *keyslot);
244                         return -EINVAL;
245         }
246
247         return 0;
248 }
249
250 /*
251  * compares UUIDs returned by device-mapper (striped by cryptsetup) and uuid in header
252  */
253 static int crypt_uuid_cmp(const char *dm_uuid, const char *hdr_uuid)
254 {
255         int i, j;
256         char *str;
257
258         if (!dm_uuid || !hdr_uuid)
259                 return -EINVAL;
260
261         str = strchr(dm_uuid, '-');
262         if (!str)
263                 return -EINVAL;
264
265         for (i = 0, j = 1; hdr_uuid[i]; i++) {
266                 if (hdr_uuid[i] == '-')
267                         continue;
268
269                 if (!str[j] || str[j] == '-')
270                         return -EINVAL;
271
272                 if (str[j] != hdr_uuid[i])
273                         return -EINVAL;
274                 j++;
275         }
276
277         return 0;
278 }
279
280 int PLAIN_activate(struct crypt_device *cd,
281                      const char *name,
282                      struct volume_key *vk,
283                      uint64_t size,
284                      uint32_t flags)
285 {
286         int r;
287         char *dm_cipher = NULL;
288         struct crypt_dm_active_device dmd = {
289                 .device = crypt_get_device_name(cd),
290                 .cipher = NULL,
291                 .uuid   = crypt_get_uuid(cd),
292                 .vk    = vk,
293                 .offset = crypt_get_data_offset(cd),
294                 .iv_offset = crypt_get_iv_offset(cd),
295                 .size   = size,
296                 .flags  = flags
297         };
298
299         r = device_check_and_adjust(cd, dmd.device,
300                                     (dmd.flags & CRYPT_ACTIVATE_SHARED) ? DEV_SHARED : DEV_EXCL,
301                                     &dmd.size, &dmd.offset, &flags);
302         if (r)
303                 return r;
304
305         if (crypt_get_cipher_mode(cd))
306                 r = asprintf(&dm_cipher, "%s-%s", crypt_get_cipher(cd), crypt_get_cipher_mode(cd));
307         else
308                 r = asprintf(&dm_cipher, "%s", crypt_get_cipher(cd));
309         if (r < 0)
310                 return -ENOMEM;
311
312         dmd.cipher = dm_cipher;
313         log_dbg("Trying to activate PLAIN device %s using cipher %s.", name, dmd.cipher);
314
315         r = dm_create_device(name, CRYPT_PLAIN, &dmd, 0);
316
317         // FIXME
318         if (!cd->plain_uuid && dm_query_device(name, DM_ACTIVE_UUID, &dmd) >= 0)
319                 cd->plain_uuid = CONST_CAST(char*)dmd.uuid;
320
321         free(dm_cipher);
322         return r;
323 }
324
325 int crypt_confirm(struct crypt_device *cd, const char *msg)
326 {
327         if (!cd || !cd->confirm)
328                 return 1;
329         else
330                 return cd->confirm(msg, cd->confirm_usrptr);
331 }
332
333 static int key_from_terminal(struct crypt_device *cd, char *msg, char **key,
334                               size_t *key_len, int force_verify)
335 {
336         char *prompt = NULL;
337         int r;
338
339         *key = NULL;
340         if(!msg && asprintf(&prompt, _("Enter passphrase for %s: "),
341                             cd->backing_file ?: crypt_get_device_name(cd)) < 0)
342                 return -ENOMEM;
343
344         if (!msg)
345                 msg = prompt;
346
347         if (cd->password) {
348                 *key = crypt_safe_alloc(DEFAULT_PASSPHRASE_SIZE_MAX);
349                 if (!*key) {
350                         r = -ENOMEM;
351                         goto out;
352                 }
353                 r = cd->password(msg, *key, DEFAULT_PASSPHRASE_SIZE_MAX,
354                                  cd->password_usrptr);
355                 if (r < 0) {
356                         crypt_safe_free(*key);
357                         *key = NULL;
358                 } else
359                         *key_len = r;
360         } else
361                 r = crypt_get_key(msg, key, key_len, 0, 0, NULL, cd->timeout,
362                                   (force_verify || cd->password_verify), cd);
363 out:
364         free(prompt);
365         return (r < 0) ? r: 0;
366 }
367
368 static int volume_key_by_terminal_passphrase(struct crypt_device *cd, int keyslot,
369                                              struct volume_key **vk)
370 {
371         char *passphrase_read = NULL;
372         size_t passphrase_size_read;
373         int r = -EINVAL, eperm = 0, tries = cd->tries;
374
375         *vk = NULL;
376         do {
377                 crypt_free_volume_key(*vk);
378                 *vk = NULL;
379
380                 r = key_from_terminal(cd, NULL, &passphrase_read,
381                                       &passphrase_size_read, 0);
382                 /* Continue if it is just passphrase verify mismatch */
383                 if (r == -EPERM)
384                         continue;
385                 if(r < 0)
386                         goto out;
387
388                 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase_read,
389                                            passphrase_size_read, &cd->hdr, vk, cd);
390                 if (r == -EPERM)
391                         eperm = 1;
392                 crypt_safe_free(passphrase_read);
393                 passphrase_read = NULL;
394         } while (r == -EPERM && (--tries > 0));
395 out:
396         if (r < 0) {
397                 crypt_free_volume_key(*vk);
398                 *vk = NULL;
399
400                 /* Report wrong passphrase if at least one try failed */
401                 if (eperm && r == -EPIPE)
402                         r = -EPERM;
403         }
404
405         crypt_safe_free(passphrase_read);
406         return r;
407 }
408
409 static int key_from_file(struct crypt_device *cd, char *msg,
410                           char **key, size_t *key_len,
411                           const char *key_file, size_t key_offset,
412                           size_t key_size)
413 {
414         return crypt_get_key(msg, key, key_len, key_offset, key_size, key_file,
415                              cd->timeout, 0, cd);
416 }
417
418 void crypt_set_log_callback(struct crypt_device *cd,
419         void (*log)(int level, const char *msg, void *usrptr),
420         void *usrptr)
421 {
422         if (!cd)
423                 _default_log = log;
424         else {
425                 cd->log = log;
426                 cd->log_usrptr = usrptr;
427         }
428 }
429
430 void crypt_set_confirm_callback(struct crypt_device *cd,
431         int (*confirm)(const char *msg, void *usrptr),
432         void *usrptr)
433 {
434         cd->confirm = confirm;
435         cd->confirm_usrptr = usrptr;
436 }
437
438 void crypt_set_password_callback(struct crypt_device *cd,
439         int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
440         void *usrptr)
441 {
442         cd->password = password;
443         cd->password_usrptr = usrptr;
444 }
445
446 static void _get_error(char *error, char *buf, size_t size)
447 {
448         if (!buf || size < 1)
449                 error[0] = '\0';
450         else if (*error) {
451                 strncpy(buf, error, size - 1);
452                 buf[size - 1] = '\0';
453                 error[0] = '\0';
454         } else
455                 buf[0] = '\0';
456 }
457
458 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size)
459 {
460         if (cd)
461                 return _get_error(cd->error, buf, size);
462 }
463
464 /* Deprecated global error interface */
465 void crypt_get_error(char *buf, size_t size)
466 {
467         return _get_error(global_error, buf, size);
468 }
469
470 const char *crypt_get_dir(void)
471 {
472         return dm_get_dir();
473 }
474
475 int crypt_init(struct crypt_device **cd, const char *device)
476 {
477         struct crypt_device *h = NULL;
478         int r, readonly = 0;
479
480         if (!cd)
481                 return -EINVAL;
482
483         log_dbg("Allocating crypt device %s context.", device);
484
485         if (!(h = malloc(sizeof(struct crypt_device))))
486                 return -ENOMEM;
487
488         memset(h, 0, sizeof(*h));
489         h->loop_fd = -1;
490
491         if (device) {
492                 r = device_ready(NULL, device, O_RDONLY);
493                 if (r == -ENOTBLK) {
494                         h->device = crypt_loop_get_device();
495                         log_dbg("Not a block device, %s%s.",
496                                 h->device ? "using free loop device " :
497                                          "no free loop device found",
498                                 h->device ?: "");
499                         if (!h->device) {
500                                 log_err(NULL, _("Cannot find a free loopback device.\n"));
501                                 r = -ENOSYS;
502                                 goto bad;
503                         }
504
505                         /* Keep the loop open, dettached on last close. */
506                         h->loop_fd = crypt_loop_attach(h->device, device, 0, 1, &readonly);
507                         if (h->loop_fd == -1) {
508                                 log_err(NULL, _("Attaching loopback device failed "
509                                         "(loop device with autoclear flag is required).\n"));
510                                 r = -EINVAL;
511                                 goto bad;
512                         }
513
514                         h->backing_file = crypt_loop_backing_file(h->device);
515                         r = device_ready(NULL, h->device, O_RDONLY);
516                 }
517                 if (r < 0) {
518                         r = -ENOTBLK;
519                         goto bad;
520                 }
521         }
522
523         if (!h->device && device && !(h->device = strdup(device))) {
524                 r = -ENOMEM;
525                 goto bad;
526         }
527
528         if (dm_init(h, 1) < 0) {
529                 r = -ENOSYS;
530                 goto bad;
531         }
532
533         h->iteration_time = 1000;
534         h->password_verify = 0;
535         h->tries = 3;
536         h->rng_type = crypt_random_default_key_rng();
537         *cd = h;
538         return 0;
539 bad:
540
541         if (h) {
542                 if (h->loop_fd != -1)
543                         close(h->loop_fd);
544                 free(h->device);
545                 free(h->backing_file);
546         }
547         free(h);
548         return r;
549 }
550
551 static int crypt_check_data_device_size(struct crypt_device *cd)
552 {
553         int r;
554         uint64_t size, size_min;
555
556         /* Check data device size, require at least one sector */
557         size_min = crypt_get_data_offset(cd) << SECTOR_SHIFT ?: SECTOR_SIZE;
558
559         r = device_size(crypt_get_device_name(cd), &size);
560         if (r < 0)
561                 return r;
562
563         if (size < size_min) {
564                 log_err(cd, _("LUKS header detected but device %s is too small.\n"),
565                         crypt_get_device_name(cd));
566                 return -EINVAL;
567         }
568
569         return r;
570 }
571
572 int crypt_set_data_device(struct crypt_device *cd, const char *device)
573 {
574         char *data_device;
575         int r;
576
577         log_dbg("Setting ciphertext data device to %s.", device ?: "(none)");
578
579         if (!isLUKS(cd->type)) {
580                 log_err(cd, _("This operation is not supported for this device type.\n"));
581                 return  -EINVAL;
582         }
583
584         /* metadata device must be set */
585         if (!cd->device)
586                 return -EINVAL;
587
588         r = device_ready(NULL, device, O_RDONLY);
589         if (r < 0)
590                 return r;
591
592         if (!(data_device = strdup(device)))
593                 return -ENOMEM;
594
595         if (!cd->metadata_device)
596                 cd->metadata_device = cd->device;
597         else
598                 free(cd->device);
599
600         cd->device = data_device;
601
602         return crypt_check_data_device_size(cd);
603 }
604
605 static int _crypt_load_luks1(struct crypt_device *cd, int require_header)
606 {
607         struct luks_phdr hdr;
608         int r;
609
610         r = init_crypto(cd);
611         if (r < 0)
612                 return r;
613
614         r = LUKS_read_phdr(mdata_device(cd), &hdr, require_header, cd);
615         if (r < 0)
616                 return r;
617
618         if (!cd->type && !(cd->type = strdup(CRYPT_LUKS1)))
619                 return -ENOMEM;
620
621         memcpy(&cd->hdr, &hdr, sizeof(hdr));
622
623         return r;
624 }
625
626 int crypt_init_by_name_and_header(struct crypt_device **cd,
627                                   const char *name,
628                                   const char *header_device)
629 {
630         crypt_status_info ci;
631         struct crypt_dm_active_device dmd;
632         char cipher[MAX_CIPHER_LEN], cipher_mode[MAX_CIPHER_LEN];
633         int key_nums, r;
634
635
636         log_dbg("Allocating crypt device context by device %s.", name);
637
638         ci = crypt_status(NULL, name);
639         if (ci == CRYPT_INVALID)
640                 return -ENODEV;
641
642         if (ci < CRYPT_ACTIVE) {
643                 log_err(NULL, _("Device %s is not active.\n"), name);
644                 return -ENODEV;
645         }
646
647         r = dm_query_device(name, DM_ACTIVE_DEVICE | DM_ACTIVE_CIPHER |
648                                   DM_ACTIVE_UUID | DM_ACTIVE_KEYSIZE, &dmd);
649         if (r < 0)
650                 goto out;
651
652         *cd = NULL;
653
654         if (header_device) {
655                 r = crypt_init(cd, header_device);
656         } else {
657                 r = crypt_init(cd, dmd.device);
658
659                 /* Underlying device disappeared but mapping still active */
660                 if (!dmd.device || r == -ENOTBLK)
661                         log_verbose(NULL, _("Underlying device for crypt device %s disappeared.\n"),
662                                     name);
663
664                 /* Underlying device is not readable but crypt mapping exists */
665                 if (r == -ENOTBLK) {
666                         free(CONST_CAST(void*)dmd.device);
667                         dmd.device = NULL;
668                         r = crypt_init(cd, NULL);
669                 }
670         }
671
672         if (r < 0)
673                 goto out;
674
675         if (dmd.uuid) {
676                 if (!strncmp(CRYPT_PLAIN, dmd.uuid, sizeof(CRYPT_PLAIN)-1))
677                         (*cd)->type = strdup(CRYPT_PLAIN);
678                 else if (!strncmp(CRYPT_LOOPAES, dmd.uuid, sizeof(CRYPT_LOOPAES)-1))
679                         (*cd)->type = strdup(CRYPT_LOOPAES);
680                 else if (!strncmp(CRYPT_LUKS1, dmd.uuid, sizeof(CRYPT_LUKS1)-1))
681                         (*cd)->type = strdup(CRYPT_LUKS1);
682                 else
683                         log_dbg("Unknown UUID set, some parameters are not set.");
684         } else
685                 log_dbg("Active device has no UUID set, some parameters are not set.");
686
687         if (header_device) {
688                 r = crypt_set_data_device(*cd, dmd.device);
689                 if (r < 0)
690                         goto out;
691         }
692
693         /* Try to initialise basic parameters from active device */
694
695         if (!(*cd)->backing_file && dmd.device && crypt_loop_device(dmd.device) &&
696             !((*cd)->backing_file = crypt_loop_backing_file(dmd.device))) {
697                 r = -ENOMEM;
698                 goto out;
699         }
700
701         if (isPLAIN((*cd)->type)) {
702                 (*cd)->plain_uuid = strdup(dmd.uuid);
703                 (*cd)->plain_hdr.hash = NULL; /* no way to get this */
704                 (*cd)->plain_hdr.offset = dmd.offset;
705                 (*cd)->plain_hdr.skip = dmd.iv_offset;
706                 (*cd)->plain_key_size = dmd.vk->keylength;
707
708                 r = crypt_parse_name_and_mode(dmd.cipher, cipher, NULL, cipher_mode);
709                 if (!r) {
710                         (*cd)->plain_cipher = strdup(cipher);
711                         (*cd)->plain_cipher_mode = strdup(cipher_mode);
712                 }
713         } else if (isLOOPAES((*cd)->type)) {
714                 (*cd)->loopaes_uuid = strdup(dmd.uuid);
715                 (*cd)->loopaes_hdr.offset = dmd.offset;
716
717                 r = crypt_parse_name_and_mode(dmd.cipher, cipher,
718                                               &key_nums, cipher_mode);
719                 if (!r) {
720                         (*cd)->loopaes_cipher = strdup(cipher);
721                         (*cd)->loopaes_cipher_mode = strdup(cipher_mode);
722                         /* version 3 uses last key for IV */
723                         if (dmd.vk->keylength % key_nums)
724                                 key_nums++;
725                         (*cd)->loopaes_key_size = dmd.vk->keylength / key_nums;
726                 }
727         } else if (isLUKS((*cd)->type)) {
728                 if (mdata_device(*cd)) {
729                         r = _crypt_load_luks1(*cd, 0);
730                         if (r < 0) {
731                                 log_dbg("LUKS device header does not match active device.");
732                                 free((*cd)->type);
733                                 (*cd)->type = NULL;
734                                 r = 0;
735                                 goto out;
736                         }
737                         /* checks whether UUIDs match each other */
738                         r = crypt_uuid_cmp(dmd.uuid, (*cd)->hdr.uuid);
739                         if (r < 0) {
740                                 log_dbg("LUKS device header uuid: %s mismatches DM returned uuid %s",
741                                         (*cd)->hdr.uuid, dmd.uuid);
742                                 free((*cd)->type);
743                                 (*cd)->type = NULL;
744                                 r = 0;
745                                 goto out;
746                         }
747                 }
748         }
749
750 out:
751         if (r < 0) {
752                 crypt_free(*cd);
753                 *cd = NULL;
754         }
755         crypt_free_volume_key(dmd.vk);
756         free(CONST_CAST(void*)dmd.device);
757         free(CONST_CAST(void*)dmd.cipher);
758         free(CONST_CAST(void*)dmd.uuid);
759         return r;
760 }
761
762 int crypt_init_by_name(struct crypt_device **cd, const char *name)
763 {
764         return crypt_init_by_name_and_header(cd, name, NULL);
765 }
766
767 static int _crypt_format_plain(struct crypt_device *cd,
768                                const char *cipher,
769                                const char *cipher_mode,
770                                const char *uuid,
771                                size_t volume_key_size,
772                                struct crypt_params_plain *params)
773 {
774         if (!cipher || !cipher_mode) {
775                 log_err(cd, _("Invalid plain crypt parameters.\n"));
776                 return -EINVAL;
777         }
778
779         if (volume_key_size > 1024) {
780                 log_err(cd, _("Invalid key size.\n"));
781                 return -EINVAL;
782         }
783
784         cd->plain_key_size = volume_key_size;
785         cd->volume_key = crypt_alloc_volume_key(volume_key_size, NULL);
786         if (!cd->volume_key)
787                 return -ENOMEM;
788
789         cd->plain_cipher = strdup(cipher);
790         cd->plain_cipher_mode = strdup(cipher_mode);
791
792         if (uuid)
793                 cd->plain_uuid = strdup(uuid);
794
795         if (params && params->hash)
796                 cd->plain_hdr.hash = strdup(params->hash);
797
798         cd->plain_hdr.offset = params ? params->offset : 0;
799         cd->plain_hdr.skip = params ? params->skip : 0;
800         cd->plain_hdr.size = params ? params->size : 0;
801
802         if (!cd->plain_cipher || !cd->plain_cipher_mode)
803                 return -ENOMEM;
804
805         return 0;
806 }
807
808 static int _crypt_format_luks1(struct crypt_device *cd,
809                                const char *cipher,
810                                const char *cipher_mode,
811                                const char *uuid,
812                                const char *volume_key,
813                                size_t volume_key_size,
814                                struct crypt_params_luks1 *params)
815 {
816         int r;
817         unsigned long required_alignment = DEFAULT_DISK_ALIGNMENT;
818         unsigned long alignment_offset = 0;
819
820         if (!mdata_device(cd)) {
821                 log_err(cd, _("Can't format LUKS without device.\n"));
822                 return -EINVAL;
823         }
824
825         if (volume_key)
826                 cd->volume_key = crypt_alloc_volume_key(volume_key_size,
827                                                       volume_key);
828         else
829                 cd->volume_key = crypt_generate_volume_key(cd, volume_key_size);
830
831         if(!cd->volume_key)
832                 return -ENOMEM;
833
834         if (params && params->data_device) {
835                 cd->metadata_device = cd->device;
836                 if (!(cd->device = strdup(params->data_device)))
837                         return -ENOMEM;
838                 required_alignment = params->data_alignment * SECTOR_SIZE;
839         } else if (params && params->data_alignment) {
840                 required_alignment = params->data_alignment * SECTOR_SIZE;
841         } else
842                 get_topology_alignment(cd->device, &required_alignment,
843                                        &alignment_offset, DEFAULT_DISK_ALIGNMENT);
844
845         r = LUKS_generate_phdr(&cd->hdr, cd->volume_key, cipher, cipher_mode,
846                                (params && params->hash) ? params->hash : "sha1",
847                                uuid, LUKS_STRIPES,
848                                required_alignment / SECTOR_SIZE,
849                                alignment_offset / SECTOR_SIZE,
850                                cd->iteration_time, &cd->PBKDF2_per_sec,
851                                cd->metadata_device, cd);
852         if(r < 0)
853                 return r;
854
855         /* Wipe first 8 sectors - fs magic numbers etc. */
856         r = crypt_wipe(mdata_device(cd), 0, 8 * SECTOR_SIZE, CRYPT_WIPE_ZERO, 1);
857         if(r < 0) {
858                 if (r == -EBUSY)
859                         log_err(cd, _("Cannot format device %s which is still in use.\n"),
860                                 mdata_device(cd));
861                 else
862                         log_err(cd, _("Cannot wipe header on device %s.\n"),
863                                 mdata_device(cd));
864
865                 return r;
866         }
867
868         r = LUKS_write_phdr(mdata_device(cd), &cd->hdr, cd);
869
870         return r;
871 }
872
873 static int _crypt_format_loopaes(struct crypt_device *cd,
874                                  const char *cipher,
875                                  const char *uuid,
876                                  size_t volume_key_size,
877                                  struct crypt_params_loopaes *params)
878 {
879         if (!mdata_device(cd)) {
880                 log_err(cd, _("Can't format LOOPAES without device.\n"));
881                 return -EINVAL;
882         }
883
884         if (volume_key_size > 1024) {
885                 log_err(cd, _("Invalid key size.\n"));
886                 return -EINVAL;
887         }
888
889         cd->loopaes_key_size = volume_key_size;
890
891         cd->loopaes_cipher = strdup(cipher ?: DEFAULT_LOOPAES_CIPHER);
892
893         if (uuid)
894                 cd->loopaes_uuid = strdup(uuid);
895
896         if (params && params->hash)
897                 cd->loopaes_hdr.hash = strdup(params->hash);
898
899         cd->loopaes_hdr.offset = params ? params->offset : 0;
900         cd->loopaes_hdr.skip = params ? params->skip : 0;
901
902         return 0;
903 }
904
905 int crypt_format(struct crypt_device *cd,
906         const char *type,
907         const char *cipher,
908         const char *cipher_mode,
909         const char *uuid,
910         const char *volume_key,
911         size_t volume_key_size,
912         void *params)
913 {
914         int r;
915
916         if (!type)
917                 return -EINVAL;
918
919         if (cd->type) {
920                 log_dbg("Context already formatted as %s.", cd->type);
921                 return -EINVAL;
922         }
923
924         log_dbg("Formatting device %s as type %s.", mdata_device(cd) ?: "(none)", type);
925
926         r = init_crypto(cd);
927         if (r < 0)
928                 return r;
929
930         if (isPLAIN(type))
931                 r = _crypt_format_plain(cd, cipher, cipher_mode,
932                                         uuid, volume_key_size, params);
933         else if (isLUKS(type))
934                 r = _crypt_format_luks1(cd, cipher, cipher_mode,
935                                         uuid, volume_key, volume_key_size, params);
936         else if (isLOOPAES(type))
937                 r = _crypt_format_loopaes(cd, cipher, uuid, volume_key_size, params);
938         else {
939                 /* FIXME: allow plugins here? */
940                 log_err(cd, _("Unknown crypt device type %s requested.\n"), type);
941                 r = -EINVAL;
942         }
943
944         if (!r && !(cd->type = strdup(type)))
945                 r = -ENOMEM;
946
947         if (r < 0) {
948                 crypt_free_volume_key(cd->volume_key);
949                 cd->volume_key = NULL;
950         }
951
952         return r;
953 }
954
955 int crypt_load(struct crypt_device *cd,
956                const char *requested_type,
957                void *params __attribute__((unused)))
958 {
959         int r;
960
961         log_dbg("Trying to load %s crypt type from device %s.",
962                 requested_type ?: "any", mdata_device(cd) ?: "(none)");
963
964         if (!mdata_device(cd))
965                 return -EINVAL;
966
967         if (requested_type && !isLUKS(requested_type))
968                 return -EINVAL;
969
970         if (cd->type && !isLUKS(cd->type)) {
971                 log_dbg("Context is already initialised to type %s", cd->type);
972                 return -EINVAL;
973         }
974
975         r = _crypt_load_luks1(cd, 1);
976         if (r < 0)
977                 return r;
978
979         /* cd->type and header must be set in context */
980         r = crypt_check_data_device_size(cd);
981         if (r < 0) {
982                 free(cd->type);
983                 cd->type = NULL;
984         }
985
986         return r;
987 }
988
989 int crypt_resize(struct crypt_device *cd, const char *name, uint64_t new_size)
990 {
991         struct crypt_dm_active_device dmd;
992         int r;
993
994         /* Device context type must be initialised */
995         if (!cd->type || !crypt_get_uuid(cd))
996                 return -EINVAL;
997
998         log_dbg("Resizing device %s to %" PRIu64 " sectors.", name, new_size);
999
1000         r = dm_query_device(name, DM_ACTIVE_DEVICE | DM_ACTIVE_CIPHER |
1001                                   DM_ACTIVE_UUID | DM_ACTIVE_KEYSIZE |
1002                                   DM_ACTIVE_KEY, &dmd);
1003         if (r < 0) {
1004                 log_err(NULL, _("Device %s is not active.\n"), name);
1005                 goto out;
1006         }
1007
1008         if (!dmd.uuid) {
1009                 r = -EINVAL;
1010                 goto out;
1011         }
1012
1013         r = device_check_and_adjust(cd, dmd.device, DEV_OK, &new_size, &dmd.offset, &dmd.flags);
1014         if (r)
1015                 goto out;
1016
1017         if (new_size == dmd.size) {
1018                 log_dbg("Device has already requested size %" PRIu64
1019                         " sectors.", dmd.size);
1020                 r = 0;
1021         } else {
1022                 dmd.size = new_size;
1023                 r = dm_create_device(name, cd->type, &dmd, 1);
1024         }
1025 out:
1026         crypt_free_volume_key(dmd.vk);
1027         free(CONST_CAST(void*)dmd.cipher);
1028         free(CONST_CAST(void*)dmd.device);
1029         free(CONST_CAST(void*)dmd.uuid);
1030
1031         return r;
1032 }
1033
1034 int crypt_set_uuid(struct crypt_device *cd, const char *uuid)
1035 {
1036         if (!isLUKS(cd->type)) {
1037                 log_err(cd, _("This operation is not supported for this device type.\n"));
1038                 return  -EINVAL;
1039         }
1040
1041         if (uuid && !strncmp(uuid, cd->hdr.uuid, sizeof(cd->hdr.uuid))) {
1042                 log_dbg("UUID is the same as requested (%s) for device %s.",
1043                         uuid, mdata_device(cd));
1044                 return 0;
1045         }
1046
1047         if (uuid)
1048                 log_dbg("Requested new UUID change to %s for %s.", uuid, mdata_device(cd));
1049         else
1050                 log_dbg("Requested new UUID refresh for %s.", mdata_device(cd));
1051
1052         if (!crypt_confirm(cd, _("Do you really want to change UUID of device?")))
1053                 return -EPERM;
1054
1055         return LUKS_hdr_uuid_set(mdata_device(cd), &cd->hdr, uuid, cd);
1056 }
1057
1058 int crypt_header_backup(struct crypt_device *cd,
1059                         const char *requested_type,
1060                         const char *backup_file)
1061 {
1062         int r;
1063
1064         if ((requested_type && !isLUKS(requested_type)) || !backup_file)
1065                 return -EINVAL;
1066
1067         r = init_crypto(cd);
1068         if (r < 0)
1069                 return r;
1070
1071         log_dbg("Requested header backup of device %s (%s) to "
1072                 "file %s.", mdata_device(cd), requested_type, backup_file);
1073
1074         return LUKS_hdr_backup(backup_file, mdata_device(cd), &cd->hdr, cd);
1075 }
1076
1077 int crypt_header_restore(struct crypt_device *cd,
1078                          const char *requested_type,
1079                          const char *backup_file)
1080 {
1081         int r;
1082
1083         if (requested_type && !isLUKS(requested_type))
1084                 return -EINVAL;
1085
1086         /* Some hash functions need initialized gcrypt library */
1087         r = init_crypto(cd);
1088         if (r < 0)
1089                 return r;
1090
1091         log_dbg("Requested header restore to device %s (%s) from "
1092                 "file %s.", mdata_device(cd), requested_type, backup_file);
1093
1094         return LUKS_hdr_restore(backup_file, mdata_device(cd), &cd->hdr, cd);
1095 }
1096
1097 void crypt_free(struct crypt_device *cd)
1098 {
1099         if (cd) {
1100                 log_dbg("Releasing crypt device %s context.", mdata_device(cd));
1101
1102                 if (cd->loop_fd != -1)
1103                         close(cd->loop_fd);
1104
1105                 dm_exit();
1106                 crypt_free_volume_key(cd->volume_key);
1107
1108                 free(cd->device);
1109                 free(cd->metadata_device);
1110                 free(cd->backing_file);
1111                 free(cd->type);
1112
1113                 /* used in plain device only */
1114                 free(CONST_CAST(void*)cd->plain_hdr.hash);
1115                 free(cd->plain_cipher);
1116                 free(cd->plain_cipher_mode);
1117                 free(cd->plain_uuid);
1118
1119                 /* used in loop-AES device only */
1120                 free(CONST_CAST(void*)cd->loopaes_hdr.hash);
1121                 free(cd->loopaes_cipher);
1122                 free(cd->loopaes_uuid);
1123
1124                 free(cd);
1125         }
1126 }
1127
1128 int crypt_suspend(struct crypt_device *cd,
1129                   const char *name)
1130 {
1131         crypt_status_info ci;
1132         int r;
1133
1134         log_dbg("Suspending volume %s.", name);
1135
1136         if (!isLUKS(cd->type)) {
1137                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1138                 r = -EINVAL;
1139                 goto out;
1140         }
1141
1142         ci = crypt_status(NULL, name);
1143         if (ci < CRYPT_ACTIVE) {
1144                 log_err(cd, _("Volume %s is not active.\n"), name);
1145                 return -EINVAL;
1146         }
1147
1148         if (!cd && dm_init(NULL, 1) < 0)
1149                 return -ENOSYS;
1150
1151         r = dm_status_suspended(name);
1152         if (r < 0)
1153                 goto out;
1154
1155         if (r) {
1156                 log_err(cd, _("Volume %s is already suspended.\n"), name);
1157                 r = -EINVAL;
1158                 goto out;
1159         }
1160
1161         r = dm_suspend_and_wipe_key(name);
1162         if (r == -ENOTSUP)
1163                 log_err(cd, "Suspend is not supported for device %s.\n", name);
1164         else if (r)
1165                 log_err(cd, "Error during suspending device %s.\n", name);
1166 out:
1167         if (!cd)
1168                 dm_exit();
1169         return r;
1170 }
1171
1172 int crypt_resume_by_passphrase(struct crypt_device *cd,
1173                                const char *name,
1174                                int keyslot,
1175                                const char *passphrase,
1176                                size_t passphrase_size)
1177 {
1178         struct volume_key *vk = NULL;
1179         int r;
1180
1181         log_dbg("Resuming volume %s.", name);
1182
1183         if (!isLUKS(cd->type)) {
1184                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1185                 r = -EINVAL;
1186                 goto out;
1187         }
1188
1189         r = dm_status_suspended(name);
1190         if (r < 0)
1191                 return r;
1192
1193         if (!r) {
1194                 log_err(cd, _("Volume %s is not suspended.\n"), name);
1195                 return -EINVAL;
1196         }
1197
1198         if (passphrase) {
1199                 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase,
1200                                            passphrase_size, &cd->hdr, &vk, cd);
1201         } else
1202                 r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1203
1204         if (r >= 0) {
1205                 keyslot = r;
1206                 r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1207                 if (r == -ENOTSUP)
1208                         log_err(cd, "Resume is not supported for device %s.\n", name);
1209                 else if (r)
1210                         log_err(cd, "Error during resuming device %s.\n", name);
1211         } else
1212                 r = keyslot;
1213 out:
1214         crypt_free_volume_key(vk);
1215         return r < 0 ? r : keyslot;
1216 }
1217
1218 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
1219                                    const char *name,
1220                                    int keyslot,
1221                                    const char *keyfile,
1222                                    size_t keyfile_size,
1223                                    size_t keyfile_offset)
1224 {
1225         struct volume_key *vk = NULL;
1226         char *passphrase_read = NULL;
1227         size_t passphrase_size_read;
1228         int r;
1229
1230         log_dbg("Resuming volume %s.", name);
1231
1232         if (!isLUKS(cd->type)) {
1233                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1234                 r = -EINVAL;
1235                 goto out;
1236         }
1237
1238         r = dm_status_suspended(name);
1239         if (r < 0)
1240                 return r;
1241
1242         if (!r) {
1243                 log_err(cd, _("Volume %s is not suspended.\n"), name);
1244                 return -EINVAL;
1245         }
1246
1247         if (!keyfile)
1248                 return -EINVAL;
1249
1250         r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1251                           &passphrase_size_read, keyfile, keyfile_offset,
1252                           keyfile_size);
1253         if (r < 0)
1254                 goto out;
1255
1256         r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase_read,
1257                                    passphrase_size_read, &cd->hdr, &vk, cd);
1258         if (r < 0)
1259                 goto out;
1260
1261         keyslot = r;
1262         r = dm_resume_and_reinstate_key(name, vk->keylength, vk->key);
1263         if (r)
1264                 log_err(cd, "Error during resuming device %s.\n", name);
1265 out:
1266         crypt_safe_free(passphrase_read);
1267         crypt_free_volume_key(vk);
1268         return r < 0 ? r : keyslot;
1269 }
1270
1271 int crypt_resume_by_keyfile(struct crypt_device *cd,
1272                             const char *name,
1273                             int keyslot,
1274                             const char *keyfile,
1275                             size_t keyfile_size)
1276 {
1277         return crypt_resume_by_keyfile_offset(cd, name, keyslot,
1278                                               keyfile, keyfile_size, 0);
1279 }
1280
1281 // slot manipulation
1282 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
1283         int keyslot, // -1 any
1284         const char *passphrase, // NULL -> terminal
1285         size_t passphrase_size,
1286         const char *new_passphrase, // NULL -> terminal
1287         size_t new_passphrase_size)
1288 {
1289         struct volume_key *vk = NULL;
1290         char *password = NULL, *new_password = NULL;
1291         size_t passwordLen, new_passwordLen;
1292         int r;
1293
1294         log_dbg("Adding new keyslot, existing passphrase %sprovided,"
1295                 "new passphrase %sprovided.",
1296                 passphrase ? "" : "not ", new_passphrase  ? "" : "not ");
1297
1298         if (!isLUKS(cd->type)) {
1299                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1300                 return -EINVAL;
1301         }
1302
1303         r = keyslot_verify_or_find_empty(cd, &keyslot);
1304         if (r)
1305                 return r;
1306
1307         if (!LUKS_keyslot_active_count(&cd->hdr)) {
1308                 /* No slots used, try to use pre-generated key in header */
1309                 if (cd->volume_key) {
1310                         vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1311                         r = vk ? 0 : -ENOMEM;
1312                 } else {
1313                         log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1314                         return -EINVAL;
1315                 }
1316         } else if (passphrase) {
1317                 /* Passphrase provided, use it to unlock existing keyslot */
1318                 r = LUKS_open_key_with_hdr(mdata_device(cd), CRYPT_ANY_SLOT, passphrase,
1319                                            passphrase_size, &cd->hdr, &vk, cd);
1320         } else {
1321                 /* Passphrase not provided, ask first and use it to unlock existing keyslot */
1322                 r = key_from_terminal(cd, _("Enter any passphrase: "),
1323                                       &password, &passwordLen, 0);
1324                 if (r < 0)
1325                         goto out;
1326
1327                 r = LUKS_open_key_with_hdr(mdata_device(cd), CRYPT_ANY_SLOT, password,
1328                                            passwordLen, &cd->hdr, &vk, cd);
1329                 crypt_safe_free(password);
1330         }
1331
1332         if(r < 0)
1333                 goto out;
1334
1335         if (new_passphrase) {
1336                 new_password = CONST_CAST(char*)new_passphrase;
1337                 new_passwordLen = new_passphrase_size;
1338         } else {
1339                 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1340                                       &new_password, &new_passwordLen, 1);
1341                 if(r < 0)
1342                         goto out;
1343         }
1344
1345         r = LUKS_set_key(mdata_device(cd), keyslot, new_password, new_passwordLen,
1346                          &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1347         if(r < 0) goto out;
1348
1349         r = 0;
1350 out:
1351         if (!new_passphrase)
1352                 crypt_safe_free(new_password);
1353         crypt_free_volume_key(vk);
1354         return r ?: keyslot;
1355 }
1356
1357 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
1358         int keyslot,
1359         const char *keyfile,
1360         size_t keyfile_size,
1361         size_t keyfile_offset,
1362         const char *new_keyfile,
1363         size_t new_keyfile_size,
1364         size_t new_keyfile_offset)
1365 {
1366         struct volume_key *vk = NULL;
1367         char *password = NULL; size_t passwordLen;
1368         char *new_password = NULL; size_t new_passwordLen;
1369         int r;
1370
1371         log_dbg("Adding new keyslot, existing keyfile %s, new keyfile %s.",
1372                 keyfile ?: "[none]", new_keyfile ?: "[none]");
1373
1374         if (!isLUKS(cd->type)) {
1375                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1376                 return -EINVAL;
1377         }
1378
1379         r = keyslot_verify_or_find_empty(cd, &keyslot);
1380         if (r)
1381                 return r;
1382
1383         if (!LUKS_keyslot_active_count(&cd->hdr)) {
1384                 /* No slots used, try to use pre-generated key in header */
1385                 if (cd->volume_key) {
1386                         vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1387                         r = vk ? 0 : -ENOMEM;
1388                 } else {
1389                         log_err(cd, _("Cannot add key slot, all slots disabled and no volume key provided.\n"));
1390                         return -EINVAL;
1391                 }
1392         } else {
1393                 /* Read password from file of (if NULL) from terminal */
1394                 if (keyfile)
1395                         r = key_from_file(cd, _("Enter any passphrase: "),
1396                                           &password, &passwordLen,
1397                                           keyfile, keyfile_offset, keyfile_size);
1398                 else
1399                         r = key_from_terminal(cd, _("Enter any passphrase: "),
1400                                               &password, &passwordLen, 0);
1401                 if (r < 0)
1402                         goto out;
1403
1404                 r = LUKS_open_key_with_hdr(mdata_device(cd), CRYPT_ANY_SLOT, password, passwordLen,
1405                                            &cd->hdr, &vk, cd);
1406         }
1407
1408         if(r < 0)
1409                 goto out;
1410
1411         if (new_keyfile)
1412                 r = key_from_file(cd, _("Enter new passphrase for key slot: "),
1413                                   &new_password, &new_passwordLen, new_keyfile,
1414                                   new_keyfile_offset, new_keyfile_size);
1415         else
1416                 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1417                                       &new_password, &new_passwordLen, 1);
1418         if (r < 0)
1419                 goto out;
1420
1421         r = LUKS_set_key(mdata_device(cd), keyslot, new_password, new_passwordLen,
1422                          &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1423 out:
1424         crypt_safe_free(password);
1425         crypt_safe_free(new_password);
1426         crypt_free_volume_key(vk);
1427         return r < 0 ? r : keyslot;
1428 }
1429
1430 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
1431         int keyslot,
1432         const char *keyfile,
1433         size_t keyfile_size,
1434         const char *new_keyfile,
1435         size_t new_keyfile_size)
1436 {
1437         return crypt_keyslot_add_by_keyfile_offset(cd, keyslot,
1438                                 keyfile, keyfile_size, 0,
1439                                 new_keyfile, new_keyfile_size, 0);
1440 }
1441
1442 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
1443         int keyslot,
1444         const char *volume_key,
1445         size_t volume_key_size,
1446         const char *passphrase,
1447         size_t passphrase_size)
1448 {
1449         struct volume_key *vk = NULL;
1450         int r = -EINVAL;
1451         char *new_password = NULL; size_t new_passwordLen;
1452
1453         log_dbg("Adding new keyslot %d using volume key.", keyslot);
1454
1455         if (!isLUKS(cd->type)) {
1456                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1457                 return -EINVAL;
1458         }
1459
1460         if (volume_key)
1461                 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1462         else if (cd->volume_key)
1463                 vk = crypt_alloc_volume_key(cd->volume_key->keylength, cd->volume_key->key);
1464
1465         if (!vk)
1466                 return -ENOMEM;
1467
1468         r = LUKS_verify_volume_key(&cd->hdr, vk);
1469         if (r < 0) {
1470                 log_err(cd, _("Volume key does not match the volume.\n"));
1471                 goto out;
1472         }
1473
1474         r = keyslot_verify_or_find_empty(cd, &keyslot);
1475         if (r)
1476                 goto out;
1477
1478         if (!passphrase) {
1479                 r = key_from_terminal(cd, _("Enter new passphrase for key slot: "),
1480                                       &new_password, &new_passwordLen, 1);
1481                 if (r < 0)
1482                         goto out;
1483                 passphrase = new_password;
1484                 passphrase_size = new_passwordLen;
1485         }
1486
1487         r = LUKS_set_key(mdata_device(cd), keyslot, passphrase, passphrase_size,
1488                          &cd->hdr, vk, cd->iteration_time, &cd->PBKDF2_per_sec, cd);
1489 out:
1490         crypt_safe_free(new_password);
1491         crypt_free_volume_key(vk);
1492         return (r < 0) ? r : keyslot;
1493 }
1494
1495 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot)
1496 {
1497         crypt_keyslot_info ki;
1498
1499         log_dbg("Destroying keyslot %d.", keyslot);
1500
1501         if (!isLUKS(cd->type)) {
1502                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1503                 return -EINVAL;
1504         }
1505
1506         ki = crypt_keyslot_status(cd, keyslot);
1507         if (ki == CRYPT_SLOT_INVALID) {
1508                 log_err(cd, _("Key slot %d is invalid.\n"), keyslot);
1509                 return -EINVAL;
1510         }
1511
1512         if (ki == CRYPT_SLOT_INACTIVE) {
1513                 log_err(cd, _("Key slot %d is not used.\n"), keyslot);
1514                 return -EINVAL;
1515         }
1516
1517         return LUKS_del_key(mdata_device(cd), keyslot, &cd->hdr, cd);
1518 }
1519
1520 // activation/deactivation of device mapping
1521 int crypt_activate_by_passphrase(struct crypt_device *cd,
1522         const char *name,
1523         int keyslot,
1524         const char *passphrase,
1525         size_t passphrase_size,
1526         uint32_t flags)
1527 {
1528         crypt_status_info ci;
1529         struct volume_key *vk = NULL;
1530         char *read_passphrase = NULL;
1531         size_t passphraseLen = 0;
1532         int r;
1533
1534         log_dbg("%s volume %s [keyslot %d] using %spassphrase.",
1535                 name ? "Activating" : "Checking", name ?: "",
1536                 keyslot, passphrase ? "" : "[none] ");
1537
1538         if (name) {
1539                 ci = crypt_status(NULL, name);
1540                 if (ci == CRYPT_INVALID)
1541                         return -EINVAL;
1542                 else if (ci >= CRYPT_ACTIVE) {
1543                         log_err(cd, _("Device %s already exists.\n"), name);
1544                         return -EEXIST;
1545                 }
1546         }
1547
1548         /* plain, use hashed passphrase */
1549         if (isPLAIN(cd->type)) {
1550                 if (!name)
1551                         return -EINVAL;
1552
1553                 if (!passphrase) {
1554                         r = key_from_terminal(cd, NULL, &read_passphrase,
1555                                               &passphraseLen, 0);
1556                         if (r < 0)
1557                                 goto out;
1558                         passphrase = read_passphrase;
1559                         passphrase_size = passphraseLen;
1560                 }
1561
1562                 r = process_key(cd, cd->plain_hdr.hash,
1563                                 cd->plain_key_size,
1564                                 passphrase, passphrase_size, &vk);
1565                 if (r < 0)
1566                         goto out;
1567
1568                 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1569                 keyslot = 0;
1570         } else if (isLUKS(cd->type)) {
1571                 /* provided passphrase, do not retry */
1572                 if (passphrase) {
1573                         r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase,
1574                                                    passphrase_size, &cd->hdr, &vk, cd);
1575                 } else
1576                         r = volume_key_by_terminal_passphrase(cd, keyslot, &vk);
1577
1578                 if (r >= 0) {
1579                         keyslot = r;
1580                         if (name)
1581                                 r = LUKS1_activate(cd, name, vk, flags);
1582                 }
1583         } else
1584                 r = -EINVAL;
1585 out:
1586         crypt_safe_free(read_passphrase);
1587         crypt_free_volume_key(vk);
1588
1589         return r < 0  ? r : keyslot;
1590 }
1591
1592 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
1593         const char *name,
1594         int keyslot,
1595         const char *keyfile,
1596         size_t keyfile_size,
1597         size_t keyfile_offset,
1598         uint32_t flags)
1599 {
1600         crypt_status_info ci;
1601         struct volume_key *vk = NULL;
1602         char *passphrase_read = NULL;
1603         size_t passphrase_size_read;
1604         unsigned int key_count = 0;
1605         int r;
1606
1607         log_dbg("Activating volume %s [keyslot %d] using keyfile %s.",
1608                 name ?: "", keyslot, keyfile ?: "[none]");
1609
1610         if (name) {
1611                 ci = crypt_status(NULL, name);
1612                 if (ci == CRYPT_INVALID)
1613                         return -EINVAL;
1614                 else if (ci >= CRYPT_ACTIVE) {
1615                         log_err(cd, _("Device %s already exists.\n"), name);
1616                         return -EEXIST;
1617                 }
1618         }
1619
1620         if (!keyfile)
1621                 return -EINVAL;
1622
1623         if (isPLAIN(cd->type)) {
1624                 if (!name)
1625                         return -EINVAL;
1626
1627                 r = key_from_file(cd, _("Enter passphrase: "),
1628                                   &passphrase_read, &passphrase_size_read,
1629                                   keyfile, keyfile_offset, keyfile_size);
1630                 if (r < 0)
1631                         goto out;
1632
1633                 r = process_key(cd, cd->plain_hdr.hash,
1634                                 cd->plain_key_size,
1635                                 passphrase_read, passphrase_size_read, &vk);
1636                 if (r < 0)
1637                         goto out;
1638
1639                 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1640         } else if (isLUKS(cd->type)) {
1641                 r = key_from_file(cd, _("Enter passphrase: "), &passphrase_read,
1642                           &passphrase_size_read, keyfile, keyfile_offset, keyfile_size);
1643                 if (r < 0)
1644                         goto out;
1645                 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase_read,
1646                                            passphrase_size_read, &cd->hdr, &vk, cd);
1647                 if (r < 0)
1648                         goto out;
1649                 keyslot = r;
1650
1651                 if (name) {
1652                         r = LUKS1_activate(cd, name, vk, flags);
1653                         if (r < 0)
1654                                 goto out;
1655                 }
1656                 r = keyslot;
1657         } else if (isLOOPAES(cd->type)) {
1658                 r = key_from_file(cd, NULL, &passphrase_read, &passphrase_size_read,
1659                                   keyfile, keyfile_offset, keyfile_size);
1660                 if (r < 0)
1661                         goto out;
1662                 r = LOOPAES_parse_keyfile(cd, &vk, cd->loopaes_hdr.hash, &key_count,
1663                                           passphrase_read, passphrase_size_read);
1664                 if (r < 0)
1665                         goto out;
1666                 if (name)
1667                         r = LOOPAES_activate(cd, name, cd->loopaes_cipher,
1668                                              key_count, vk, flags);
1669         } else
1670                 r = -EINVAL;
1671
1672 out:
1673         crypt_safe_free(passphrase_read);
1674         crypt_free_volume_key(vk);
1675
1676         return r;
1677 }
1678
1679 int crypt_activate_by_keyfile(struct crypt_device *cd,
1680         const char *name,
1681         int keyslot,
1682         const char *keyfile,
1683         size_t keyfile_size,
1684         uint32_t flags)
1685 {
1686         return crypt_activate_by_keyfile_offset(cd, name, keyslot, keyfile,
1687                                                 keyfile_size, 0, flags);
1688 }
1689
1690 int crypt_activate_by_volume_key(struct crypt_device *cd,
1691         const char *name,
1692         const char *volume_key,
1693         size_t volume_key_size,
1694         uint32_t flags)
1695 {
1696         crypt_status_info ci;
1697         struct volume_key *vk = NULL;
1698         int r = -EINVAL;
1699
1700         log_dbg("Activating volume %s by volume key.", name);
1701
1702         if (name) {
1703                 ci = crypt_status(NULL, name);
1704                 if (ci == CRYPT_INVALID)
1705                         return -EINVAL;
1706                 else if (ci >= CRYPT_ACTIVE) {
1707                         log_err(cd, _("Device %s already exists.\n"), name);
1708                         return -EEXIST;
1709                 }
1710         }
1711
1712         /* use key directly, no hash */
1713         if (isPLAIN(cd->type)) {
1714                 if (!name)
1715                         return -EINVAL;
1716
1717                 if (!volume_key || !volume_key_size || volume_key_size != cd->plain_key_size) {
1718                         log_err(cd, _("Incorrect volume key specified for plain device.\n"));
1719                         return -EINVAL;
1720                 }
1721
1722                 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1723                 if (!vk)
1724                         return -ENOMEM;
1725
1726                 r = PLAIN_activate(cd, name, vk, cd->plain_hdr.size, flags);
1727         } else if (isLUKS(cd->type)) {
1728                 /* If key is not provided, try to use internal key */
1729                 if (!volume_key) {
1730                         if (!cd->volume_key) {
1731                                 log_err(cd, _("Volume key does not match the volume.\n"));
1732                                 return -EINVAL;
1733                         }
1734                         volume_key_size = cd->volume_key->keylength;
1735                         volume_key = cd->volume_key->key;
1736                 }
1737
1738                 vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1739                 if (!vk)
1740                         return -ENOMEM;
1741                 r = LUKS_verify_volume_key(&cd->hdr, vk);
1742
1743                 if (r == -EPERM)
1744                         log_err(cd, _("Volume key does not match the volume.\n"));
1745
1746                 if (!r && name)
1747                         r = LUKS1_activate(cd, name, vk, flags);
1748         } else
1749                 log_err(cd, _("Device type is not properly initialised.\n"));
1750
1751         crypt_free_volume_key(vk);
1752
1753         return r;
1754 }
1755
1756 int crypt_deactivate(struct crypt_device *cd, const char *name)
1757 {
1758         int r;
1759
1760         if (!name)
1761                 return -EINVAL;
1762
1763         log_dbg("Deactivating volume %s.", name);
1764
1765         if (!cd && dm_init(NULL, 1) < 0)
1766                 return -ENOSYS;
1767
1768         switch (crypt_status(cd, name)) {
1769                 case CRYPT_ACTIVE:
1770                         r = dm_remove_device(name, 0, 0);
1771                         break;
1772                 case CRYPT_BUSY:
1773                         log_err(cd, _("Device %s is busy.\n"), name);
1774                         r = -EBUSY;
1775                         break;
1776                 case CRYPT_INACTIVE:
1777                         log_err(cd, _("Device %s is not active.\n"), name);
1778                         r = -ENODEV;
1779                         break;
1780                 default:
1781                         log_err(cd, _("Invalid device %s.\n"), name);
1782                         r = -EINVAL;
1783         }
1784
1785         if (!cd)
1786                 dm_exit();
1787
1788         return r;
1789 }
1790
1791 int crypt_volume_key_get(struct crypt_device *cd,
1792         int keyslot,
1793         char *volume_key,
1794         size_t *volume_key_size,
1795         const char *passphrase,
1796         size_t passphrase_size)
1797 {
1798         struct volume_key *vk = NULL;
1799         unsigned key_len;
1800         int r = -EINVAL;
1801
1802         key_len = crypt_get_volume_key_size(cd);
1803         if (key_len > *volume_key_size) {
1804                 log_err(cd, _("Volume key buffer too small.\n"));
1805                 return -ENOMEM;
1806         }
1807
1808         if (isPLAIN(cd->type) && cd->plain_hdr.hash) {
1809                 r = process_key(cd, cd->plain_hdr.hash, key_len,
1810                                 passphrase, passphrase_size, &vk);
1811                 if (r < 0)
1812                         log_err(cd, _("Cannot retrieve volume key for plain device.\n"));
1813         } else if (isLUKS(cd->type)) {
1814                 r = LUKS_open_key_with_hdr(mdata_device(cd), keyslot, passphrase,
1815                                         passphrase_size, &cd->hdr, &vk, cd);
1816
1817         } else
1818                 log_err(cd, _("This operation is not supported for %s crypt device.\n"), cd->type ?: "(none)");
1819
1820         if (r >= 0) {
1821                 memcpy(volume_key, vk->key, vk->keylength);
1822                 *volume_key_size = vk->keylength;
1823         }
1824
1825         crypt_free_volume_key(vk);
1826         return r;
1827 }
1828
1829 int crypt_volume_key_verify(struct crypt_device *cd,
1830         const char *volume_key,
1831         size_t volume_key_size)
1832 {
1833         struct volume_key *vk;
1834         int r;
1835
1836         if (!isLUKS(cd->type)) {
1837                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1838                 return -EINVAL;
1839         }
1840
1841         vk = crypt_alloc_volume_key(volume_key_size, volume_key);
1842         if (!vk)
1843                 return -ENOMEM;
1844
1845         r = LUKS_verify_volume_key(&cd->hdr, vk);
1846
1847         if (r == -EPERM)
1848                 log_err(cd, _("Volume key does not match the volume.\n"));
1849
1850         crypt_free_volume_key(vk);
1851
1852         return r;
1853 }
1854
1855 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec)
1856 {
1857         log_dbg("Timeout set to %" PRIu64 " miliseconds.", timeout_sec);
1858         cd->timeout = timeout_sec;
1859 }
1860
1861 void crypt_set_password_retry(struct crypt_device *cd, int tries)
1862 {
1863         log_dbg("Password retry count set to %d.", tries);
1864         cd->tries = tries;
1865 }
1866
1867 void crypt_set_iteration_time(struct crypt_device *cd, uint64_t iteration_time_ms)
1868 {
1869         log_dbg("Iteration time set to %" PRIu64 " miliseconds.", iteration_time_ms);
1870         cd->iteration_time = iteration_time_ms;
1871 }
1872 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms)
1873 {
1874         crypt_set_iteration_time(cd, iteration_time_ms);
1875 }
1876
1877 void crypt_set_password_verify(struct crypt_device *cd, int password_verify)
1878 {
1879         log_dbg("Password verification %s.", password_verify ? "enabled" : "disabled");
1880         cd->password_verify = password_verify ? 1 : 0;
1881 }
1882
1883 void crypt_set_rng_type(struct crypt_device *cd, int rng_type)
1884 {
1885         switch (rng_type) {
1886         case CRYPT_RNG_URANDOM:
1887         case CRYPT_RNG_RANDOM:
1888                 log_dbg("RNG set to %d (%s).", rng_type, rng_type ? "random" : "urandom");
1889                 cd->rng_type = rng_type;
1890         }
1891 }
1892
1893 int crypt_get_rng_type(struct crypt_device *cd)
1894 {
1895         if (!cd)
1896                 return -EINVAL;
1897
1898         return cd->rng_type;
1899 }
1900
1901 int crypt_memory_lock(struct crypt_device *cd, int lock)
1902 {
1903         return lock ? crypt_memlock_inc(cd) : crypt_memlock_dec(cd);
1904 }
1905
1906 // reporting
1907 crypt_status_info crypt_status(struct crypt_device *cd, const char *name)
1908 {
1909         int r;
1910
1911         if (!cd && dm_init(NULL, 1) < 0)
1912                 return CRYPT_INVALID;
1913
1914         r = dm_status_device(name);
1915
1916         if (!cd)
1917                 dm_exit();
1918
1919         if (r < 0 && r != -ENODEV)
1920                 return CRYPT_INVALID;
1921
1922         if (r == 0)
1923                 return CRYPT_ACTIVE;
1924
1925         if (r > 0)
1926                 return CRYPT_BUSY;
1927
1928         return CRYPT_INACTIVE;
1929 }
1930
1931 static void hexprintICB(struct crypt_device *cd, char *d, int n)
1932 {
1933         int i;
1934         for(i = 0; i < n; i++)
1935                 log_std(cd, "%02hhx ", (char)d[i]);
1936 }
1937
1938 int crypt_dump(struct crypt_device *cd)
1939 {
1940         int i;
1941         if (!isLUKS(cd->type)) { //FIXME
1942                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
1943                 return -EINVAL;
1944         }
1945
1946         log_std(cd, "LUKS header information for %s\n\n", mdata_device(cd));
1947         log_std(cd, "Version:       \t%d\n", cd->hdr.version);
1948         log_std(cd, "Cipher name:   \t%s\n", cd->hdr.cipherName);
1949         log_std(cd, "Cipher mode:   \t%s\n", cd->hdr.cipherMode);
1950         log_std(cd, "Hash spec:     \t%s\n", cd->hdr.hashSpec);
1951         log_std(cd, "Payload offset:\t%d\n", cd->hdr.payloadOffset);
1952         log_std(cd, "MK bits:       \t%d\n", cd->hdr.keyBytes * 8);
1953         log_std(cd, "MK digest:     \t");
1954         hexprintICB(cd, cd->hdr.mkDigest, LUKS_DIGESTSIZE);
1955         log_std(cd, "\n");
1956         log_std(cd, "MK salt:       \t");
1957         hexprintICB(cd, cd->hdr.mkDigestSalt, LUKS_SALTSIZE/2);
1958         log_std(cd, "\n               \t");
1959         hexprintICB(cd, cd->hdr.mkDigestSalt+LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1960         log_std(cd, "\n");
1961         log_std(cd, "MK iterations: \t%d\n", cd->hdr.mkDigestIterations);
1962         log_std(cd, "UUID:          \t%s\n\n", cd->hdr.uuid);
1963         for(i = 0; i < LUKS_NUMKEYS; i++) {
1964                 if(cd->hdr.keyblock[i].active == LUKS_KEY_ENABLED) {
1965                         log_std(cd, "Key Slot %d: ENABLED\n",i);
1966                         log_std(cd, "\tIterations:         \t%d\n",
1967                                 cd->hdr.keyblock[i].passwordIterations);
1968                         log_std(cd, "\tSalt:               \t");
1969                         hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt,
1970                                     LUKS_SALTSIZE/2);
1971                         log_std(cd, "\n\t                      \t");
1972                         hexprintICB(cd, cd->hdr.keyblock[i].passwordSalt +
1973                                     LUKS_SALTSIZE/2, LUKS_SALTSIZE/2);
1974                         log_std(cd, "\n");
1975
1976                         log_std(cd, "\tKey material offset:\t%d\n",
1977                                 cd->hdr.keyblock[i].keyMaterialOffset);
1978                         log_std(cd, "\tAF stripes:            \t%d\n",
1979                                 cd->hdr.keyblock[i].stripes);
1980                 }
1981                 else 
1982                         log_std(cd, "Key Slot %d: DISABLED\n", i);
1983         }
1984
1985         return 0;
1986 }
1987
1988 const char *crypt_get_cipher(struct crypt_device *cd)
1989 {
1990         if (isPLAIN(cd->type))
1991                 return cd->plain_cipher;
1992
1993         if (isLUKS(cd->type))
1994                 return cd->hdr.cipherName;
1995
1996         if (isLOOPAES(cd->type))
1997                 return cd->loopaes_cipher;
1998
1999         return NULL;
2000 }
2001
2002 const char *crypt_get_cipher_mode(struct crypt_device *cd)
2003 {
2004         if (isPLAIN(cd->type))
2005                 return cd->plain_cipher_mode;
2006
2007         if (isLUKS(cd->type))
2008                 return cd->hdr.cipherMode;
2009
2010         if (isLOOPAES(cd->type))
2011                 return cd->loopaes_cipher_mode;
2012
2013         return NULL;
2014 }
2015
2016 const char *crypt_get_uuid(struct crypt_device *cd)
2017 {
2018         if (isLUKS(cd->type))
2019                 return cd->hdr.uuid;
2020
2021         if (isPLAIN(cd->type))
2022                 return cd->plain_uuid;
2023
2024         if (isLOOPAES(cd->type))
2025                 return cd->loopaes_uuid;
2026
2027         return NULL;
2028 }
2029
2030 const char *crypt_get_device_name(struct crypt_device *cd)
2031 {
2032         return cd->device;
2033 }
2034
2035
2036 int crypt_get_volume_key_size(struct crypt_device *cd)
2037 {
2038         if (isPLAIN(cd->type))
2039                 return cd->plain_key_size;
2040
2041         if (isLUKS(cd->type))
2042                 return cd->hdr.keyBytes;
2043
2044         if (isLOOPAES(cd->type))
2045                 return cd->loopaes_key_size;
2046
2047         return 0;
2048 }
2049
2050 uint64_t crypt_get_data_offset(struct crypt_device *cd)
2051 {
2052         if (isPLAIN(cd->type))
2053                 return cd->plain_hdr.offset;
2054
2055         if (isLUKS(cd->type))
2056                 return cd->hdr.payloadOffset;
2057
2058         if (isLOOPAES(cd->type))
2059                 return cd->loopaes_hdr.offset;
2060
2061         return 0;
2062 }
2063
2064 uint64_t crypt_get_iv_offset(struct crypt_device *cd)
2065 {
2066         if (isPLAIN(cd->type))
2067                 return cd->plain_hdr.skip;
2068
2069         if (isLUKS(cd->type))
2070                 return 0;
2071
2072         if (isLOOPAES(cd->type))
2073                 return cd->loopaes_hdr.skip;
2074
2075         return 0;
2076 }
2077
2078 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot)
2079 {
2080         if (!isLUKS(cd->type)) {
2081                 log_err(cd, _("This operation is supported only for LUKS device.\n"));
2082                 return CRYPT_SLOT_INVALID;
2083         }
2084
2085         return LUKS_keyslot_info(&cd->hdr, keyslot);
2086 }
2087
2088 int crypt_keyslot_max(const char *type)
2089 {
2090         if (type && isLUKS(type))
2091                 return LUKS_NUMKEYS;
2092
2093         return -EINVAL;
2094 }
2095
2096 const char *crypt_get_type(struct crypt_device *cd)
2097 {
2098         return cd->type;
2099 }
2100
2101 int crypt_get_active_device(struct crypt_device *cd __attribute__((unused)),
2102                             const char *name,
2103                             struct crypt_active_device *cad)
2104 {
2105         struct crypt_dm_active_device dmd;
2106         int r;
2107
2108         r = dm_query_device(name, 0, &dmd);
2109         if (r < 0)
2110                 return r;
2111
2112         cad->offset     = dmd.offset;
2113         cad->iv_offset  = dmd.iv_offset;
2114         cad->size       = dmd.size;
2115         cad->flags      = dmd.flags;
2116
2117         return 0;
2118 }