lib/internal.h

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