2 * libcryptsetup - cryptsetup library internal
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.
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.
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.
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.
36 #include "utils_crypt.h"
37 #include "utils_loop.h"
39 #include "utils_fips.h"
40 #include "crypto_backend.h"
42 #include "libcryptsetup.h"
44 /* to silent gcc -Wcast-qual for const cast */
45 #define CONST_CAST(x) (x)(uintptr_t)
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
53 #define at_least(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
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);
68 int device_alloc(struct device **device, const char *path);
69 void device_free(struct device *device);
70 const char *device_path(const struct device *device);
71 const char *device_block_path(const struct device *device);
72 void device_topology_alignment(struct device *device,
73 unsigned long *required_alignment, /* bytes */
74 unsigned long *alignment_offset, /* bytes */
75 unsigned long default_alignment);
76 int device_block_size(struct device *device);
77 int device_read_ahead(struct device *device, uint32_t *read_ahead);
78 int device_size(struct device *device, uint64_t *size);
80 enum devcheck { DEV_OK = 0, DEV_EXCL = 1, DEV_SHARED = 2 };
81 int device_block_adjust(struct crypt_device *cd,
82 struct device *device,
83 enum devcheck device_check,
84 uint64_t device_offset,
88 /* Receive backend devices from context helpers */
89 struct device *crypt_metadata_device(struct crypt_device *cd);
90 struct device *crypt_data_device(struct crypt_device *cd);
92 int crypt_confirm(struct crypt_device *cd, const char *msg);
94 char *crypt_lookup_dev(const char *dev_id);
95 int crypt_sysfs_get_rotational(int major, int minor, int *rotational);
97 ssize_t write_blockwise(int fd, int bsize, void *buf, size_t count);
98 ssize_t read_blockwise(int fd, int bsize, void *_buf, size_t count);
99 ssize_t write_lseek_blockwise(int fd, int bsize, char *buf, size_t count, off_t offset);
101 unsigned crypt_getpagesize(void);
104 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
105 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
106 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
107 #define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
108 #define log_err(c, x...) logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x)
110 int crypt_get_debug_level(void);
112 int crypt_memlock_inc(struct crypt_device *ctx);
113 int crypt_memlock_dec(struct crypt_device *ctx);
115 int crypt_random_init(struct crypt_device *ctx);
116 int crypt_random_get(struct crypt_device *ctx, char *buf, size_t len, int quality);
117 void crypt_random_exit(void);
118 int crypt_random_default_key_rng(void);
120 int crypt_plain_hash(struct crypt_device *ctx,
121 const char *hash_name,
122 char *key, size_t key_size,
123 const char *passphrase, size_t passphrase_size);
124 int PLAIN_activate(struct crypt_device *cd,
126 struct volume_key *vk,
131 * Different methods used to erase sensitive data concerning
132 * either encrypted payload area or master key inside keyslot
136 CRYPT_WIPE_ZERO, /**< overwrite area using zero blocks */
137 CRYPT_WIPE_DISK, /**< erase disk (using Gutmann method if it is rotational disk)*/
138 CRYPT_WIPE_SSD, /**< erase solid state disk (random write) */
139 CRYPT_WIPE_RANDOM /**< overwrite area using some up to now unspecified
140 * random algorithm */
143 int crypt_wipe(struct device *device,
146 crypt_wipe_type type,
149 #endif /* INTERNAL_H */