2 * libcryptsetup - cryptsetup library internal
4 * Copyright (C) 2004, Jana Saout <jana@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
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 * as published by the Free Software Foundation; either version 2
12 * of the License, or (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
34 #include "utils_crypt.h"
35 #include "utils_loop.h"
37 #include "utils_fips.h"
38 #include "crypto_backend.h"
40 #include "libcryptsetup.h"
42 /* to silent gcc -Wcast-qual for const cast */
43 #define CONST_CAST(x) (x)(uintptr_t)
45 #define SECTOR_SHIFT 9
46 #define SECTOR_SIZE (1 << SECTOR_SHIFT)
47 #define DEFAULT_DISK_ALIGNMENT 1048576 /* 1MiB */
48 #define DEFAULT_MEM_ALIGNMENT 4096
49 #define MAX_ERROR_LENGTH 512
51 #define at_least(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
60 struct volume_key *crypt_alloc_volume_key(unsigned keylength, const char *key);
61 struct volume_key *crypt_generate_volume_key(struct crypt_device *cd, unsigned keylength);
62 void crypt_free_volume_key(struct volume_key *vk);
66 int device_alloc(struct device **device, const char *path);
67 void device_free(struct device *device);
68 const char *device_path(const struct device *device);
69 const char *device_block_path(const struct device *device);
70 void device_topology_alignment(struct device *device,
71 unsigned long *required_alignment, /* bytes */
72 unsigned long *alignment_offset, /* bytes */
73 unsigned long default_alignment);
74 int device_block_size(struct device *device);
75 int device_read_ahead(struct device *device, uint32_t *read_ahead);
76 int device_size(struct device *device, uint64_t *size);
77 int device_open(struct device *device, int flags);
79 enum devcheck { DEV_OK = 0, DEV_EXCL = 1, DEV_SHARED = 2 };
80 int device_block_adjust(struct crypt_device *cd,
81 struct device *device,
82 enum devcheck device_check,
83 uint64_t device_offset,
86 size_t size_round_up(size_t size, unsigned int block);
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_dev_is_rotational(int major, int minor);
96 int crypt_dev_is_partition(const char *dev_path);
97 char *crypt_get_partition_device(const char *dev_path, uint64_t offset, uint64_t size);
98 char *crypt_get_base_device(const char *dev_path);
99 uint64_t crypt_dev_partition_offset(const char *dev_path);
101 ssize_t write_blockwise(int fd, int bsize, void *buf, size_t count);
102 ssize_t read_blockwise(int fd, int bsize, void *_buf, size_t count);
103 ssize_t write_lseek_blockwise(int fd, int bsize, char *buf, size_t count, off_t offset);
105 unsigned crypt_getpagesize(void);
106 int init_crypto(struct crypt_device *ctx);
108 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...) __attribute__ ((format (printf, 5, 6)));
109 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
110 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
111 #define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
112 #define log_err(c, x...) logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x)
114 int crypt_get_debug_level(void);
116 int crypt_memlock_inc(struct crypt_device *ctx);
117 int crypt_memlock_dec(struct crypt_device *ctx);
119 int crypt_random_init(struct crypt_device *ctx);
120 int crypt_random_get(struct crypt_device *ctx, char *buf, size_t len, int quality);
121 void crypt_random_exit(void);
122 int crypt_random_default_key_rng(void);
124 int crypt_plain_hash(struct crypt_device *ctx,
125 const char *hash_name,
126 char *key, size_t key_size,
127 const char *passphrase, size_t passphrase_size);
128 int PLAIN_activate(struct crypt_device *cd,
130 struct volume_key *vk,
135 * Different methods used to erase sensitive data concerning
136 * either encrypted payload area or master key inside keyslot
140 CRYPT_WIPE_ZERO, /**< overwrite area using zero blocks */
141 CRYPT_WIPE_DISK, /**< erase disk (using Gutmann method if it is rotational disk)*/
142 CRYPT_WIPE_SSD, /**< erase solid state disk (random write) */
143 CRYPT_WIPE_RANDOM /**< overwrite area using some up to now unspecified
144 * random algorithm */
147 int crypt_wipe(struct device *device,
150 crypt_wipe_type type,
153 #endif /* INTERNAL_H */