lib/utils_dm.h

   1 /*
   2  * libdevmapper - device-mapper backend for cryptsetup
   3  *
   4  * Copyright (C) 2004, Christophe Saout <christophe@saout.de>
   5  * Copyright (C) 2004-2007, Clemens Fruhwirth <clemens@endorphin.org>
   6  * Copyright (C) 2009-2012, Red Hat, Inc. All rights reserved.
   7  * Copyright (C) 2009-2012, Milan Broz
   8  *
   9  * This program is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU General Public License
  11  * as published by the Free Software Foundation; either version 2
  12  * of the License, or (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with this program; if not, write to the Free Software
  21  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  22  */
  23
  24 #ifndef _UTILS_DM_H
  25 #define _UTILS_DM_H
  26
  27 /* device-mapper library helpers */
  28 #include <inttypes.h>
  29
  30 struct crypt_device;
  31 struct volume_key;
  32 struct crypt_params_verity;
  33 struct device;
  34
  35 /* Device mapper backend - kernel support flags */
  36 #define DM_KEY_WIPE_SUPPORTED (1 << 0)  /* key wipe message */
  37 #define DM_LMK_SUPPORTED      (1 << 1)  /* lmk mode */
  38 #define DM_SECURE_SUPPORTED   (1 << 2)  /* wipe (secure) buffer flag */
  39 #define DM_PLAIN64_SUPPORTED  (1 << 3)  /* plain64 IV */
  40 #define DM_DISCARDS_SUPPORTED (1 << 4)  /* discards/TRIM option is supported */
  41 #define DM_VERITY_SUPPORTED   (1 << 5)  /* dm-verity target supported */
  42 uint32_t dm_flags(void);
  43
  44 #define DM_ACTIVE_DEVICE        (1 << 0)
  45 #define DM_ACTIVE_UUID          (1 << 1)
  46
  47 #define DM_ACTIVE_CRYPT_CIPHER  (1 << 2)
  48 #define DM_ACTIVE_CRYPT_KEYSIZE (1 << 3)
  49 #define DM_ACTIVE_CRYPT_KEY     (1 << 4)
  50
  51 #define DM_ACTIVE_VERITY_ROOT_HASH      (1 << 5)
  52 #define DM_ACTIVE_VERITY_HASH_DEVICE    (1 << 6)
  53 #define DM_ACTIVE_VERITY_PARAMS         (1 << 7)
  54
  55 struct crypt_dm_active_device {
  56         enum { DM_CRYPT = 0, DM_VERITY } target;
  57         uint64_t size;          /* active device size */
  58         uint32_t flags;         /* activation flags */
  59         const char *uuid;
  60         struct device *data_device;
  61         union {
  62         struct {
  63                 const char *cipher;
  64
  65                 /* Active key for device */
  66                 struct volume_key *vk;
  67
  68                 /* struct crypt_active_device */
  69                 uint64_t offset;        /* offset in sectors */
  70                 uint64_t iv_offset;     /* IV initilisation sector */
  71         } crypt;
  72         struct {
  73                 struct device *hash_device;
  74
  75                 const char *root_hash;
  76                 uint32_t root_hash_size;
  77
  78                 uint64_t hash_offset;   /* hash offset in blocks (not header) */
  79                 struct crypt_params_verity *vp;
  80         } verity;
  81         } u;
  82 };
  83
  84 void dm_backend_init(void);
  85 void dm_backend_exit(void);
  86
  87 int dm_remove_device(struct crypt_device *cd, const char *name,
  88                      int force, uint64_t size);
  89 int dm_status_device(struct crypt_device *cd, const char *name);
  90 int dm_status_suspended(struct crypt_device *cd, const char *name);
  91 int dm_status_verity_ok(struct crypt_device *cd, const char *name);
  92 int dm_query_device(struct crypt_device *cd, const char *name,
  93                     uint32_t get_flags, struct crypt_dm_active_device *dmd);
  94 int dm_create_device(struct crypt_device *cd, const char *name,
  95                      const char *type, struct crypt_dm_active_device *dmd,
  96                      int reload);
  97 int dm_suspend_and_wipe_key(struct crypt_device *cd, const char *name);
  98 int dm_resume_and_reinstate_key(struct crypt_device *cd, const char *name,
  99                                 size_t key_size, const char *key);
 100
 101 const char *dm_get_dir(void);
 102
 103 #endif /* _UTILS_DM_H */