lib/internal.h

   1 /*
   2  * libcryptsetup - cryptsetup library internal
   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 INTERNAL_H
  25 #define INTERNAL_H
  26
  27 #ifdef HAVE_CONFIG_H
  28 #       include "config.h"
  29 #endif
  30
  31 #include <stdint.h>
  32 #include <stdarg.h>
  33 #include <unistd.h>
  34 #include <inttypes.h>
  35
  36 #include "nls.h"
  37 #include "bitops.h"
  38 #include "utils_crypt.h"
  39 #include "utils_loop.h"
  40 #include "utils_dm.h"
  41 #include "utils_fips.h"
  42 #include "crypto_backend.h"
  43
  44 #include "libcryptsetup.h"
  45
  46 /* to silent gcc -Wcast-qual for const cast */
  47 #define CONST_CAST(x) (x)(uintptr_t)
  48
  49 #define SECTOR_SHIFT            9
  50 #define SECTOR_SIZE             (1 << SECTOR_SHIFT)
  51 #define DEFAULT_DISK_ALIGNMENT  1048576 /* 1MiB */
  52 #define DEFAULT_MEM_ALIGNMENT   4096
  53 #define MAX_ERROR_LENGTH        512
  54
  55 #define at_least(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
  56
  57 struct crypt_device;
  58
  59 struct volume_key {
  60         size_t keylength;
  61         char key[];
  62 };
  63
  64 struct volume_key *crypt_alloc_volume_key(unsigned keylength, const char *key);
  65 struct volume_key *crypt_generate_volume_key(struct crypt_device *cd, unsigned keylength);
  66 void crypt_free_volume_key(struct volume_key *vk);
  67
  68 /* Device backend */
  69 struct device;
  70 int device_alloc(struct device **device, const char *path);
  71 void device_free(struct device *device);
  72 const char *device_path(const struct device *device);
  73 const char *device_block_path(const struct device *device);
  74 void device_topology_alignment(struct device *device,
  75                             unsigned long *required_alignment, /* bytes */
  76                             unsigned long *alignment_offset,   /* bytes */
  77                             unsigned long default_alignment);
  78 int device_block_size(struct device *device);
  79 int device_read_ahead(struct device *device, uint32_t *read_ahead);
  80 int device_size(struct device *device, uint64_t *size);
  81 int device_open(struct device *device, int flags);
  82
  83 enum devcheck { DEV_OK = 0, DEV_EXCL = 1, DEV_SHARED = 2 };
  84 int device_block_adjust(struct crypt_device *cd,
  85                         struct device *device,
  86                         enum devcheck device_check,
  87                         uint64_t device_offset,
  88                         uint64_t *size,
  89                         uint32_t *flags);
  90 size_t size_round_up(size_t size, unsigned int block);
  91
  92 /* Receive backend devices from context helpers */
  93 struct device *crypt_metadata_device(struct crypt_device *cd);
  94 struct device *crypt_data_device(struct crypt_device *cd);
  95
  96 int crypt_confirm(struct crypt_device *cd, const char *msg);
  97
  98 char *crypt_lookup_dev(const char *dev_id);
  99 int crypt_sysfs_get_rotational(int major, int minor, int *rotational);
 100
 101 ssize_t write_blockwise(int fd, int bsize, void *buf, size_t count);
 102 ssize_t read_blockwise(int fd, int bsize, void *_buf, size_t count);
 103 ssize_t write_lseek_blockwise(int fd, int bsize, char *buf, size_t count, off_t offset);
 104
 105 unsigned crypt_getpagesize(void);
 106 int init_crypto(struct crypt_device *ctx);
 107
 108 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
 109 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
 110 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
 111 #define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
 112 #define log_err(c, x...) logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x)
 113
 114 int crypt_get_debug_level(void);
 115
 116 int crypt_memlock_inc(struct crypt_device *ctx);
 117 int crypt_memlock_dec(struct crypt_device *ctx);
 118
 119 int crypt_random_init(struct crypt_device *ctx);
 120 int crypt_random_get(struct crypt_device *ctx, char *buf, size_t len, int quality);
 121 void crypt_random_exit(void);
 122 int crypt_random_default_key_rng(void);
 123
 124 int crypt_plain_hash(struct crypt_device *ctx,
 125                      const char *hash_name,
 126                      char *key, size_t key_size,
 127                      const char *passphrase, size_t passphrase_size);
 128 int PLAIN_activate(struct crypt_device *cd,
 129                      const char *name,
 130                      struct volume_key *vk,
 131                      uint64_t size,
 132                      uint32_t flags);
 133
 134 /**
 135  * Different methods used to erase sensitive data concerning
 136  * either encrypted payload area or master key inside keyslot
 137  * area
 138  */
 139 typedef enum {
 140         CRYPT_WIPE_ZERO, /**< overwrite area using zero blocks */
 141         CRYPT_WIPE_DISK, /**< erase disk (using Gutmann method if it is rotational disk)*/
 142         CRYPT_WIPE_SSD, /**< erase solid state disk (random write) */
 143         CRYPT_WIPE_RANDOM /**< overwrite area using some up to now unspecified
 144                             * random algorithm */
 145 } crypt_wipe_type;
 146
 147 int crypt_wipe(struct device *device,
 148                uint64_t offset,
 149                uint64_t sectors,
 150                crypt_wipe_type type,
 151                int flags);
 152
 153 #endif /* INTERNAL_H */