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