internal.h 4.69 KB
Newer Older
Milan Broz's avatar
Milan Broz committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * libcryptsetup - cryptsetup library internal
 *
 * Copyright (C) 2004, Christophe Saout <christophe@saout.de>
 * Copyright (C) 2004-2007, Clemens Fruhwirth <clemens@endorphin.org>
 * Copyright (C) 2009-2012, Red Hat, Inc. All rights reserved.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * version 2 as published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

22 23 24 25 26 27 28 29 30 31
#ifndef INTERNAL_H
#define INTERNAL_H

#ifdef HAVE_CONFIG_H
#	include "config.h"
#endif

#include <stdint.h>
#include <stdarg.h>
#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

39 40 41
/* to silent gcc -Wcast-qual for const cast */
#define CONST_CAST(x) (x)(uintptr_t)

42 43
#define SECTOR_SHIFT		9
#define SECTOR_SIZE		(1 << SECTOR_SHIFT)
44 45
#define DEFAULT_DISK_ALIGNMENT	1048576 /* 1MiB */
#define DEFAULT_MEM_ALIGNMENT	4096
46
#define MAX_ERROR_LENGTH	512
47

48
#define at_least(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
49

50 51
struct crypt_device;

52 53 54 55
struct volume_key {
	size_t keylength;
	char key[];
};
56

57
struct volume_key *crypt_alloc_volume_key(unsigned keylength, const char *key);
58 59
struct volume_key *crypt_generate_volume_key(struct crypt_device *cd, unsigned keylength);
void crypt_free_volume_key(struct volume_key *vk);
60

61
int crypt_confirm(struct crypt_device *cd, const char *msg);
62

63
char *crypt_lookup_dev(const char *dev_id);
64
int crypt_sysfs_check_crypt_segment(const char *device, uint64_t offset, uint64_t size);
65
int crypt_sysfs_get_rotational(int major, int minor, int *rotational);
66

67
int sector_size_for_device(const char *device);
68
int device_read_ahead(const char *dev, uint32_t *read_ahead);
69
ssize_t write_blockwise(int fd, void *buf, size_t count);
70
ssize_t read_blockwise(int fd, void *_buf, size_t count);
71
ssize_t write_lseek_blockwise(int fd, char *buf, size_t count, off_t offset);
72
int device_ready(struct crypt_device *cd, const char *device, int mode);
73
int device_size(const char *device, uint64_t *size);
74 75

enum devcheck { DEV_OK = 0, DEV_EXCL = 1, DEV_SHARED = 2 };
76 77
int device_check_and_adjust(struct crypt_device *cd,
			    const char *device,
78
			    enum devcheck device_check,
79 80
			    uint64_t *size,
			    uint64_t *offset,
81
			    uint32_t *flags);
82

83 84 85
void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
#define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
#define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
86
#define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
Milan Broz's avatar
Milan Broz committed
87
#define log_err(c, x...) logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x)
88

89 90 91
int crypt_get_debug_level(void);
void debug_processes_using_device(const char *name);

92 93
int crypt_memlock_inc(struct crypt_device *ctx);
int crypt_memlock_dec(struct crypt_device *ctx);
94

95 96 97 98 99
void get_topology_alignment(const char *device,
			    unsigned long *required_alignment, /* bytes */
			    unsigned long *alignment_offset,   /* bytes */
			    unsigned long default_alignment);

100
enum { CRYPT_RND_NORMAL = 0, CRYPT_RND_KEY = 1, CRYPT_RND_SALT = 2 };
101 102 103 104 105
int crypt_random_init(struct crypt_device *ctx);
int crypt_random_get(struct crypt_device *ctx, char *buf, size_t len, int quality);
void crypt_random_exit(void);
int crypt_random_default_key_rng(void);

106 107 108 109
int crypt_plain_hash(struct crypt_device *ctx,
		     const char *hash_name,
		     char *key, size_t key_size,
		     const char *passphrase, size_t passphrase_size);
110 111 112 113 114
int PLAIN_activate(struct crypt_device *cd,
		     const char *name,
		     struct volume_key *vk,
		     uint64_t size,
		     uint32_t flags);
115

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
/**
 * Different methods used to erase sensitive data concerning
 * either encrypted payload area or master key inside keyslot
 * area
 */
typedef enum {
	CRYPT_WIPE_ZERO, /**< overwrite area using zero blocks */
	CRYPT_WIPE_DISK, /**< erase disk (using Gutmann method if it is rotational disk)*/
	CRYPT_WIPE_SSD, /**< erase solid state disk (random write) */
	CRYPT_WIPE_RANDOM /**< overwrite area using some up to now unspecified
			    * random algorithm */
} crypt_wipe_type;

int crypt_wipe(const char *device,
	       uint64_t offset,
	       uint64_t sectors,
	       crypt_wipe_type type,
	       int flags);

135
#endif /* INTERNAL_H */