src/cryptsetup.h

   1 /*
   2  * cryptsetup - setup cryptographic volumes for dm-crypt
   3  *
   4  * Copyright (C) 2004 Jana Saout <jana@saout.de>
   5  * Copyright (C) 2004-2007 Clemens Fruhwirth <clemens@endorphin.org>
   6  * Copyright (C) 2009-2023 Red Hat, Inc. All rights reserved.
   7  * Copyright (C) 2009-2023 Milan Broz
   8  *
   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.
  13  *
  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.
  18  *
  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.
  22  */
  23
  24 #ifndef CRYPTSETUP_H
  25 #define CRYPTSETUP_H
  26
  27 #include <stdbool.h>
  28 #include <string.h>
  29 #include <stdlib.h>
  30 #include <stdarg.h>
  31 #include <stdio.h>
  32 #include <stdint.h>
  33 #include <errno.h>
  34 #include <unistd.h>
  35 #include <inttypes.h>
  36 #include <limits.h>
  37 #include <ctype.h>
  38 #include <fcntl.h>
  39 #include <popt.h>
  40 #include <sys/stat.h>
  41 #include <sys/time.h>
  42
  43 #include "lib/nls.h"
  44 #include "lib/bitops.h"
  45 #include "lib/utils_crypt.h"
  46 #include "lib/utils_loop.h"
  47 #include "lib/utils_io.h"
  48 #include "lib/utils_blkid.h"
  49 #include "lib/libcryptsetup_macros.h"
  50
  51 #include "libcryptsetup.h"
  52
  53 #define DEFAULT_CIPHER(type)    (DEFAULT_##type##_CIPHER "-" DEFAULT_##type##_MODE)
  54
  55 #define DEFAULT_WIPE_BLOCK      1048576 /* 1 MiB */
  56 #define MAX_ACTIONS 16
  57
  58 /* Common tools */
  59 void tool_log(int level, const char *msg, void *usrptr __attribute__((unused)));
  60 void quiet_log(int level, const char *msg, void *usrptr);
  61
  62 int yesDialog(const char *msg, void *usrptr);
  63 int noDialog(const char *msg, void *usrptr);
  64 void show_status(int errcode);
  65 const char *uuid_or_device(const char *spec);
  66 __attribute__ ((noreturn)) \
  67 void usage(poptContext popt_context, int exitcode, const char *error, const char *more);
  68 void dbg_version_and_cmd(int argc, const char **argv);
  69 int translate_errno(int r);
  70
  71 typedef enum { CREATED, UNLOCKED, REMOVED  } crypt_object_op;
  72 void tools_keyslot_msg(int keyslot, crypt_object_op op);
  73 void tools_token_msg(int token, crypt_object_op op);
  74 void tools_token_error_msg(int error, const char *type, int token, bool pin_provided);
  75 void tools_package_version(const char *name, bool use_pwlibs);
  76
  77 extern volatile int quit;
  78 void set_int_block(int block);
  79 void set_int_handler(int block);
  80 void check_signal(int *r);
  81 int tools_signals_blocked(void);
  82
  83 int tools_get_key(const char *prompt,
  84                   char **key, size_t *key_size,
  85                   uint64_t keyfile_offset, size_t keyfile_size_max,
  86                   const char *key_file,
  87                   int timeout, int verify, int pwquality,
  88                   struct crypt_device *cd);
  89 void tools_passphrase_msg(int r);
  90 int tools_is_stdin(const char *key_file);
  91 int tools_string_to_size(const char *s, uint64_t *size);
  92
  93 struct tools_progress_params {
  94         uint32_t frequency;
  95         struct timeval start_time;
  96         struct timeval end_time;
  97         uint64_t start_offset;
  98         bool batch_mode;
  99         bool json_output;
 100         const char *interrupt_message;
 101         const char *device;
 102 };
 103
 104 int tools_progress(uint64_t size, uint64_t offset, void *usrptr);
 105 const char *tools_get_device_name(const char *device, char **r_backing_file);
 106
 107 int tools_read_vk(const char *file, char **key, int keysize);
 108 int tools_write_mk(const char *file, const char *key, int keysize);
 109
 110 int tools_read_json_file(const char *file, char **json, size_t *json_size, bool batch_mode);
 111 int tools_write_json_file(const char *file, const char *json);
 112
 113 typedef enum {
 114         PRB_FILTER_NONE = 0,
 115         PRB_FILTER_LUKS,
 116         PRB_ONLY_LUKS
 117 } tools_probe_filter_info;
 118
 119 int tools_detect_signatures(const char *device, tools_probe_filter_info filter, size_t *count, bool batch_mode);
 120 int tools_wipe_all_signatures(const char *path, bool exclusive, bool only_luks);
 121 int tools_superblock_block_size(const char *device, char *sb_name,
 122                                 size_t sb_name_len, unsigned *r_block_size);
 123 bool tools_blkid_supported(void);
 124
 125 int tools_lookup_crypt_device(struct crypt_device *cd, const char *type,
 126                 const char *data_device_path, char **r_name);
 127
 128
 129 /* each utility is required to implement it */
 130 void tools_cleanup(void);
 131
 132 /* Log */
 133 #define log_dbg(x...) crypt_logf(NULL, CRYPT_LOG_DEBUG, x)
 134 #define log_std(x...) crypt_logf(NULL, CRYPT_LOG_NORMAL, x)
 135 #define log_verbose(x...) crypt_logf(NULL, CRYPT_LOG_VERBOSE, x)
 136 #define log_err(x...) crypt_logf(NULL, CRYPT_LOG_ERROR, x)
 137
 138 typedef enum {
 139         CRYPT_ARG_BOOL = 0,
 140         CRYPT_ARG_STRING,
 141         CRYPT_ARG_INT32,
 142         CRYPT_ARG_UINT32,
 143         CRYPT_ARG_INT64,
 144         CRYPT_ARG_UINT64,
 145         CRYPT_ARG_ALIAS
 146 } crypt_arg_type_info;
 147
 148 struct tools_arg {
 149         const char *name;
 150         bool set;
 151         crypt_arg_type_info type;
 152         union {
 153                 char *str_value;
 154                 uint64_t u64_value;
 155                 uint32_t u32_value;
 156                 int32_t i32_value;
 157                 int64_t i64_value;
 158                 union {
 159                         unsigned id;
 160                         struct tools_arg *ptr;
 161                 } o;
 162         } u;
 163         const char *actions_array[MAX_ACTIONS];
 164 };
 165
 166 void tools_parse_arg_value(poptContext popt_context, crypt_arg_type_info type, struct tools_arg *arg, const char *popt_arg, int popt_val, bool(*needs_size_conv_fn)(unsigned arg_id));
 167
 168 void tools_args_free(struct tools_arg *args, size_t args_count);
 169
 170 void tools_check_args(const char *action, const struct tools_arg *args, size_t args_size, poptContext popt_context);
 171
 172 struct tools_log_params {
 173         bool verbose;
 174         bool debug;
 175 };
 176
 177 #endif /* CRYPTSETUP_H */