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