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