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  *
   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 #ifndef _UTILS_DM_H
  23 #define _UTILS_DM_H
  24
  25 /* device-mapper library helpers */
  26 #include <inttypes.h>
  27
  28 struct crypt_device;
  29 struct volume_key;
  30 struct crypt_params_verity;
  31
  32 /* Device mapper backend - kernel support flags */
  33 #define DM_KEY_WIPE_SUPPORTED (1 << 0)  /* key wipe message */
  34 #define DM_LMK_SUPPORTED      (1 << 1)  /* lmk mode */
  35 #define DM_SECURE_SUPPORTED   (1 << 2)  /* wipe (secure) buffer flag */
  36 #define DM_PLAIN64_SUPPORTED  (1 << 3)  /* plain64 IV */
  37 #define DM_DISCARDS_SUPPORTED (1 << 4)  /* discards/TRIM option is supported */
  38 #define DM_VERITY_SUPPORTED   (1 << 5)  /* dm-verity target supported */
  39 uint32_t dm_flags(void);
  40
  41 #define DM_ACTIVE_DEVICE        (1 << 0)
  42 #define DM_ACTIVE_UUID          (1 << 1)
  43
  44 #define DM_ACTIVE_CRYPT_CIPHER  (1 << 2)
  45 #define DM_ACTIVE_CRYPT_KEYSIZE (1 << 3)
  46 #define DM_ACTIVE_CRYPT_KEY     (1 << 4)
  47
  48 #define DM_ACTIVE_VERITY_ROOT_HASH      (1 << 5)
  49 #define DM_ACTIVE_VERITY_HASH_DEVICE    (1 << 6)
  50 #define DM_ACTIVE_VERITY_PARAMS         (1 << 7)
  51
  52 struct crypt_dm_active_device {
  53         enum { DM_CRYPT = 0, DM_VERITY } target;
  54         uint64_t size;          /* active device size */
  55         uint32_t flags;         /* activation flags */
  56         const char *uuid;
  57         const char *data_device;
  58         union {
  59         struct {
  60                 const char *cipher;
  61
  62                 /* Active key for device */
  63                 struct volume_key *vk;
  64
  65                 /* struct crypt_active_device */
  66                 uint64_t offset;        /* offset in sectors */
  67                 uint64_t iv_offset;     /* IV initilisation sector */
  68         } crypt;
  69         struct {
  70                 const char *hash_device;
  71
  72                 const char *root_hash;
  73                 uint32_t root_hash_size;
  74
  75                 uint64_t hash_offset;   /* hash offset in blocks (not header) */
  76                 struct crypt_params_verity *vp;
  77         } verity;
  78         } u;
  79 };
  80
  81 const char *dm_get_dir(void);
  82 int dm_init(struct crypt_device *context, int check_kernel);
  83 void dm_exit(void);
  84 int dm_remove_device(const char *name, int force, uint64_t size);
  85 int dm_status_device(const char *name);
  86 int dm_status_suspended(const char *name);
  87 int dm_status_verity_ok(const char *name);
  88 int dm_query_device(const char *name, uint32_t get_flags,
  89                     struct crypt_dm_active_device *dmd);
  90 int dm_create_device(const char *name,
  91                       const char *type,
  92                       struct crypt_dm_active_device *dmd,
  93                       int reload);
  94 int dm_suspend_and_wipe_key(const char *name);
  95 int dm_resume_and_reinstate_key(const char *name,
  96                                 size_t key_size,
  97                                 const char *key);
  98 char *dm_device_path(const char *prefix, int major, int minor);
  99 int dm_is_dm_device(int major, int minor);
 100 int dm_is_dm_kernel_name(const char *name);
 101 int dm_check_segment(const char *name, uint64_t offset, uint64_t size);
 102
 103 #endif /* _UTILS_DM_H */