Add utils_crypt file and test for supported modes presentation.
[platform/upstream/cryptsetup.git] / 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
16 #define SECTOR_SHIFT            9
17 #define SECTOR_SIZE             (1 << SECTOR_SHIFT)
18 #define DEFAULT_DISK_ALIGNMENT  1048576 /* 1MiB */
19 #define DEFAULT_MEM_ALIGNMENT   4096
20
21 #define MAX_TTY_PASSWORD_LEN    512
22
23 /* private struct crypt_options flags */
24
25 #define CRYPT_FLAG_FREE_DEVICE  (1 << 24)
26 #define CRYPT_FLAG_FREE_CIPHER  (1 << 25)
27
28 #define CRYPT_FLAG_PRIVATE_MASK ((unsigned int)-1 << 24)
29
30 #define at_least(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
31
32 struct hash_type {
33         char            *name;
34         void            *private;
35         int             (*fn)(void *data, int size, char *key,
36                               int sizep, const char *passphrase);
37 };
38
39 struct hash_backend {
40         const char              *name;
41         struct hash_type *      (*get_hashes)(void);
42         void                    (*free_hashes)(struct hash_type *hashes);
43 };
44
45 struct device_infos {
46         uint64_t        size;
47         int             readonly;
48 };
49
50 struct volume_key {
51         size_t keylength;
52         char key[];
53 };
54 struct volume_key *crypt_alloc_volume_key(unsigned keylength, const char *key);
55 struct volume_key *crypt_generate_volume_key(unsigned keylength);
56 void crypt_free_volume_key(struct volume_key *mk);
57
58 struct crypt_device;
59 int crypt_confirm(struct crypt_device *cd, const char *msg);
60
61 void set_error_va(const char *fmt, va_list va);
62 void set_error(const char *fmt, ...);
63 const char *get_error(void);
64 void *safe_alloc(size_t size);
65 void safe_free(void *data);
66 void *safe_realloc(void *data, size_t size);
67 char *safe_strdup(const char *s);
68 void set_debug_level(int level);
69
70 int init_crypto(struct crypt_device *ctx);
71 struct hash_backend *get_hash_backend(const char *name);
72 void put_hash_backend(struct hash_backend *backend);
73 int hash(const char *backend_name, const char *hash_name,
74          char *result, size_t size,
75          const char *passphrase, size_t sizep);
76
77 /* Device mapper backend */
78 const char *dm_get_dir(void);
79 int dm_init(struct crypt_device *context, int check_kernel);
80 void dm_exit(void);
81 int dm_remove_device(const char *name, int force, uint64_t size);
82 int dm_status_device(const char *name);
83 int dm_query_device(const char *name,
84                     char **device,
85                     uint64_t *size,
86                     uint64_t *skip,
87                     uint64_t *offset,
88                     char **cipher,
89                     int *key_size,
90                     char **key,
91                     int *read_only,
92                     int *suspended,
93                     char **uuid);
94 int dm_create_device(const char *name, const char *device, const char *cipher,
95                      const char *type, const char *uuid,
96                      uint64_t size, uint64_t skip, uint64_t offset,
97                      size_t key_size, const char *key,
98                      int read_only, int reload);
99 int dm_suspend_and_wipe_key(const char *name);
100 int dm_resume_and_reinstate_key(const char *name,
101                                 size_t key_size,
102                                 const char *key);
103
104 int sector_size_for_device(const char *device);
105 ssize_t write_blockwise(int fd, const void *buf, size_t count);
106 ssize_t read_blockwise(int fd, void *_buf, size_t count);
107 ssize_t write_lseek_blockwise(int fd, const char *buf, size_t count, off_t offset);
108 int device_ready(struct crypt_device *cd, const char *device, int mode);
109 int get_device_infos(const char *device, struct device_infos *infos, struct crypt_device *cd);
110 int wipe_device_header(const char *device, int sectors);
111
112 void get_key(char *prompt, char **key, unsigned int *passLen, int key_size,
113              const char *key_file, int timeout, int how2verify,
114              struct crypt_device *cd);
115
116 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
117 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
118 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
119 #define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
120 #define log_err(c, x...) do { \
121         logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x); \
122         set_error(x); } while(0)
123
124 int crypt_get_debug_level(void);
125 void debug_processes_using_device(const char *name);
126
127 int crypt_memlock_inc(struct crypt_device *ctx);
128 int crypt_memlock_dec(struct crypt_device *ctx);
129
130 void get_topology_alignment(const char *device,
131                             unsigned long *required_alignment, /* bytes */
132                             unsigned long *alignment_offset,   /* bytes */
133                             unsigned long default_alignment);
134
135 #endif /* INTERNAL_H */