lib/libcryptsetup.h

   1 /*
   2  * libcryptsetup - cryptsetup library
   3  *
   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.
   7  *
   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.
  11  *
  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.
  16  *
  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.
  20  */
  21
  22 /**
  23  * @file libcryptsetup.h
  24  * @brief Public cryptsetup API
  25  *
  26  * For more verbose examples of LUKS related use cases,
  27  * please read @ref index "examples".
  28  */
  29
  30 #ifndef _LIBCRYPTSETUP_H
  31 #define _LIBCRYPTSETUP_H
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 #include <stddef.h>
  37 #include <stdint.h>
  38
  39 struct crypt_device; /* crypt device handle */
  40
  41 /**
  42  * Initialize crypt device handle and check if provided device exists.
  43  *
  44  * @param cd Returns pointer to crypt device handle
  45  * @param device Path to the backing device.
  46  *        If @e device is not a block device but a path to some file,
  47  *        the function will try to create a loopdevice and attach
  48  *        the file to the loopdevice with AUTOCLEAR flag set.
  49  *        If @e device is @e NULL function it will initialize dm backend only.
  50  *
  51  * @return @e 0 on success or negative errno value otherwise.
  52  *
  53  * @note Note that logging is not initialized here, possible messages uses
  54  *       default log function.
  55  */
  56 int crypt_init(struct crypt_device **cd, const char *device);
  57
  58 /**
  59  * Initialize crypt device handle from provided active device name,
  60  * and, optionally, from separate metadata (header) device
  61  * and check if provided device exists.
  62  *
  63  * @return @e 0 on success or negative errno value otherwise.
  64  *
  65  * @param cd returns crypt device handle for active device
  66  * @param name name of active crypt device
  67  * @param header_device optional device containing on-disk header
  68  *        (@e NULL if it the same as underlying device on there is no on-disk header)
  69  *
  70  * @post In case @e device points to active LUKS device but header load fails,
  71  * context device type is set to @e NULL and @e 0 is returned as if it were successful.
  72  * Context with @e NULL device type can only be deactivated by crypt_deactivate
  73  *
  74  * @note @link crypt_init_by_name @endlink is equivalent to calling
  75  *       crypt_init_by_name_and_header(cd, name, NULL);
  76  */
  77 int crypt_init_by_name_and_header(struct crypt_device **cd,
  78                                   const char *name,
  79                                   const char *header_device);
  80
  81 /**
  82  * This is equivalent to call
  83  * @ref crypt_init_by_name_and_header "crypt_init_by_name_and_header(cd, name, NULL)"
  84  *
  85  * @sa crypt_init_by_name_and_header
  86  */
  87 int crypt_init_by_name(struct crypt_device **cd, const char *name);
  88
  89 /**
  90  * @defgroup loglevel "Cryptsetup logging"
  91  *
  92  * Set of functions and defines used in cryptsetup for
  93  * logging purposes
  94  *
  95  */
  96
  97 /**
  98  * @addtogroup loglevel
  99  * @{
 100  */
 101
 102 /** normal log level */
 103 #define CRYPT_LOG_NORMAL 0
 104 /** error log level */
 105 #define CRYPT_LOG_ERROR  1
 106 /** verbose log level */
 107 #define CRYPT_LOG_VERBOSE  2
 108 /** debug log level - always on stdout */
 109 #define CRYPT_LOG_DEBUG -1
 110
 111 /**
 112  * Set log function.
 113  *
 114  * @param cd crypt device handle (can be @e NULL to set default log function)
 115  * @param log user defined log function reference
 116  * @param usrptr provided identification in callback
 117  * @param level log level below (debug messages can uses other levels)
 118  * @param msg log message
 119  */
 120 void crypt_set_log_callback(struct crypt_device *cd,
 121         void (*log)(int level, const char *msg, void *usrptr),
 122         void *usrptr);
 123
 124 /**
 125  * Defines log function or use the default one otherwise.
 126  *
 127  * @see crypt_set_log_callback
 128  *
 129  * @param cd crypt device handle
 130  * @param level log level
 131  * @param msg log message
 132  */
 133 void crypt_log(struct crypt_device *cd, int level, const char *msg);
 134 /** @} */
 135
 136 /**
 137  * Set confirmation callback (yes/no)
 138  *
 139  * If code need confirmation (like resetting uuid or restoring LUKS header from file)
 140  * this function is called. If not defined, everything is confirmed.
 141  *
 142  * Callback function @e confirm should return @e 0 if operation is declined,
 143  * other values mean accepted.
 144  *
 145  * @param cd crypt device handle
 146  * @param confirm user defined confirm callback reference
 147  * @param usrptr provided identification in callback
 148  * @param msg Message for user to confirm
 149  *
 150  * @note Current version of cryptsetup API requires confirmation only when UUID is being changed
 151  */
 152 void crypt_set_confirm_callback(struct crypt_device *cd,
 153         int (*confirm)(const char *msg, void *usrptr),
 154         void *usrptr);
 155
 156 /**
 157  * Set password query callback.
 158  *
 159  * If code need @e _interactive_ query for password, this callback is called.
 160  * If not defined, compiled-in default is called (uses terminal input).
 161  *
 162  * Callback should return length of password in buffer
 163  * or negative errno value in case of error.
 164  *
 165  * @param cd crypt device handle
 166  * @param password user defined password callback reference
 167  * @param usrptr provided identification in callback
 168  * @param msg Message for user
 169  * @param buf buffer for password
 170  * @param length size of buffer
 171  *
 172  * @note Note that if this function is defined, verify option is ignored
 173  *   (caller which provided callback is responsible for password verification)
 174  * @note Only zero terminated passwords can be entered this way, for complex
 175  *   use API functions directly.
 176  * @note Maximal length of password is limited to @e length @e - @e 1 (minimal 511 chars)
 177  *
 178  * @see Callback function is used in these call provided, that certain conditions are met:
 179  * @li crypt_keyslot_add_by_passphrase
 180  * @li crypt_activate_by_passphrase
 181  * @li crypt_resume_by_passphrase
 182  * @li crypt_resume_by_keyfile
 183  * @li crypt_keyslot_add_by_keyfile
 184  * @li crypt_keyslot_add_by_volume_key
 185  *
 186  */
 187 void crypt_set_password_callback(struct crypt_device *cd,
 188         int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
 189         void *usrptr);
 190
 191 /**
 192  * Set timeout for interactive password entry using default
 193  * password callback
 194  *
 195  * @param cd crypt device handle
 196  * @param timeout_sec timeout in seconds
 197  */
 198 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec);
 199
 200 /**
 201  * Set number of retries in case password input has been incorrect
 202  *
 203  * @param cd crypt device handle
 204  * @param tries the number
 205  */
 206 void crypt_set_password_retry(struct crypt_device *cd, int tries);
 207
 208 /**
 209  * Set how long should cryptsetup iterate in PBKDF2 function.
 210  * Default value heads towards the iterations which takes around 1 second
 211  *
 212  * @param cd crypt device handle
 213  * @param iteration_time_ms the time in ms
 214  */
 215 void crypt_set_iteration_time(struct crypt_device *cd, uint64_t iteration_time_ms);
 216 /* Don't ask :-) */
 217 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms);
 218
 219 /**
 220  * Set whether passphrase will be verified on input
 221  * (user has to input same passphrase twice)
 222  *
 223  * @param cd crypt device handle
 224  * @param password_verify @e 0 = false, @e !0 true
 225  */
 226 void crypt_set_password_verify(struct crypt_device *cd, int password_verify);
 227
 228 /**
 229  * Set data device
 230  * For LUKS it is encrypted data device when LUKS header is separated.
 231  * For VERITY it is data device when hash device is separated.
 232  *
 233  * @param cd crypt device handle
 234  * @param device path to device
 235  *
 236  */
 237 int crypt_set_data_device(struct crypt_device *cd, const char *device);
 238
 239 /**
 240  * @defgroup rng "Cryptsetup RNG"
 241  *
 242  * @addtogroup rng
 243  * @{
 244  *
 245  */
 246
 247 /** CRYPT_RNG_URANDOM - use /dev/urandom */
 248 #define CRYPT_RNG_URANDOM 0
 249 /** CRYPT_RNG_RANDOM  - use /dev/random (waits if no entropy in system) */
 250 #define CRYPT_RNG_RANDOM  1
 251
 252 /**
 253  * Set which RNG (random number generator) is used for generating long term key
 254  *
 255  * @param cd crypt device handle
 256  * @param rng_type kernel random number generator to use
 257  *
 258  */
 259 void crypt_set_rng_type(struct crypt_device *cd, int rng_type);
 260
 261 /**
 262  * Get which RNG (random number generator) is used for generating long term key
 263  *
 264  * @param cd crypt device handle
 265  * @return RNG type on success or negative errno value otherwise.
 266  *
 267  */
 268 int crypt_get_rng_type(struct crypt_device *cd);
 269
 270 /** @} */
 271
 272 /**
 273  * Helper to lock/unlock memory to avoid swap sensitive data to disk
 274  *
 275  * @param cd crypt device handle, can be @e NULL
 276  * @param lock 0 to unlock otherwise lock memory
 277  *
 278  * @returns Value indicating whether the memory is locked (function can be called multiple times).
 279  *
 280  * @note Only root can do this.
 281  * @note It locks/unlocks all process memory, not only crypt context.
 282  */
 283 int crypt_memory_lock(struct crypt_device *cd, int lock);
 284
 285 /**
 286  * @defgroup crypt_type "Cryptsetup on-disk format types"
 287  *
 288  * Set of functions, \#defines and structs related
 289  * to on-disk format types
 290  */
 291
 292 /**
 293  * @addtogroup crypt_type
 294  * @{
 295  */
 296
 297 /** plain crypt device, no on-disk header */
 298 #define CRYPT_PLAIN "PLAIN"
 299 /** LUKS version 1 header on-disk */
 300 #define CRYPT_LUKS1 "LUKS1"
 301 /** loop-AES compatibility mode */
 302 #define CRYPT_LOOPAES "LOOPAES"
 303 /** dm-verity mode */
 304 #define CRYPT_VERITY "VERITY"
 305 /** TCRYPT mode */
 306 #define CRYPT_TCRYPT "TCRYPT"
 307
 308 /**
 309  * Get device type
 310  *
 311  * @param cd crypt device handle
 312  * @return string according to device type or @e NULL if not known.
 313  */
 314 const char *crypt_get_type(struct crypt_device *cd);
 315
 316 /**
 317  *
 318  * Structure used as parameter for PLAIN device type
 319  *
 320  * @see crypt_format
 321  */
 322 struct crypt_params_plain {
 323         const char *hash; /**< password hash function */
 324         uint64_t offset; /**< offset in sectors */
 325         uint64_t skip; /**< IV offset / initialization sector */
 326         uint64_t size; /**< size of mapped device or @e 0 for autodetection */
 327 };
 328
 329 /**
 330  * Structure used as parameter for LUKS device type
 331  *
 332  * @see crypt_format, crypt_load
 333  *
 334  * @note during crypt_format @e data_device attribute determines
 335  *       if the LUKS header is separated from encrypted payload device
 336  *
 337  */
 338 struct crypt_params_luks1 {
 339         const char *hash; /**< hash used in LUKS header */
 340         size_t data_alignment; /**< data alignment in sectors, data offset is multiple of this */
 341         const char *data_device; /**< detached encrypted data device or @e NULL */
 342 };
 343
 344 /**
 345  *
 346  * Structure used as parameter for loop-AES device type
 347  *
 348  * @see crypt_format
 349  *
 350  */
 351 struct crypt_params_loopaes {
 352         const char *hash; /**< key hash function */
 353         uint64_t offset;  /**< offset in sectors */
 354         uint64_t skip;    /**< IV offset / initialization sector */
 355 };
 356
 357 /**
 358  *
 359  * Structure used as parameter for dm-verity device type
 360  *
 361  * @see crypt_format, crypt_load
 362  *
 363  */
 364 /** No on-disk header (only hashes) */
 365 #define CRYPT_VERITY_NO_HEADER   (1 << 0)
 366 /** Verity hash in userspace before activation */
 367 #define CRYPT_VERITY_CHECK_HASH  (1 << 1)
 368 /** Create hash - format hash device */
 369 #define CRYPT_VERITY_CREATE_HASH (1 << 2)
 370
 371 struct crypt_params_verity {
 372         const char *hash_name;     /**< hash function */
 373         const char *data_device;   /**< data_device (CRYPT_VERITY_CREATE_HASH) */
 374         const char *hash_device;   /**< hash_device (output only) */
 375         const char *salt;          /**< salt */
 376         uint32_t salt_size;        /**< salt size (in bytes) */
 377         uint32_t hash_type;        /**< in-kernel hashing type */
 378         uint32_t data_block_size;  /**< data block size (in bytes) */
 379         uint32_t hash_block_size;  /**< hash block size (in bytes) */
 380         uint64_t data_size;        /**< data area size (in data blocks) */
 381         uint64_t hash_area_offset; /**< hash/header offset (in bytes) */
 382         uint32_t flags;            /**< CRYPT_VERITY* flags */
 383 };
 384
 385 /**
 386  *
 387  * Structure used as parameter for TCRYPT device type
 388  *
 389  * @see crypt_format
 390  *
 391  */
 392 /** Try to load hidden header (describing hidden device) */
 393 #define CRYPT_TCRYPT_HIDDEN_HEADER   (1 << 0)
 394
 395 struct crypt_params_tcrypt {
 396         const char *passphrase;
 397         size_t passphrase_size;
 398         const char *hash_name;     /**< hash function for PBKDF */
 399         const char *cipher[3];     /**< cipher chain */
 400         const char *mode;          /**< cipher block mode */
 401         size_t key_size;           /**< key size in bytes */
 402         uint32_t flags;            /**< CRYPT_TCRYPT* flags */
 403 };
 404
 405 /** @} */
 406
 407 /**
 408  * Create (format) new crypt device (and possible header on-disk) but not activates it.
 409  *
 410  * @pre @e cd contains initialized and not formatted device context (device type must @b not be set)
 411  *
 412  * @param cd crypt device handle
 413  * @param type type of device (optional params struct must be of this type)
 414  * @param cipher (e.g. "aes")
 415  * @param cipher_mode including IV specification (e.g. "xts-plain")
 416  * @param uuid requested UUID or @e NULL if it should be generated
 417  * @param volume_key pre-generated volume key or @e NULL if it should be generated (only for LUKS)
 418  * @param volume_key_size size of volume key in bytes.
 419  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 420  *
 421  * @returns @e 0 on success or negative errno value otherwise.
 422  *
 423  * @note Note that crypt_format does not enable any keyslot (in case of work with LUKS device),
 424  *      but it stores volume key internally and subsequent crypt_keyslot_add_* calls can be used.
 425  * @note For VERITY @link crypt_type @endlink, only uuid parameter is used, others paramaters
 426  *      are ignored and verity specific attributes are set through mandatory params option.
 427  */
 428 int crypt_format(struct crypt_device *cd,
 429         const char *type,
 430         const char *cipher,
 431         const char *cipher_mode,
 432         const char *uuid,
 433         const char *volume_key,
 434         size_t volume_key_size,
 435         void *params);
 436
 437 /**
 438  * Set new UUID for already existing device
 439  *
 440  * @param cd crypt device handle
 441  * @param uuid requested UUID or @e NULL if it should be generated
 442  *
 443  * @returns 0 on success or negative errno value otherwise.
 444  *
 445  * @note Currently, only LUKS device type are supported
 446  */
 447 int crypt_set_uuid(struct crypt_device *cd,
 448                    const char *uuid);
 449
 450 /**
 451  * Load crypt device parameters from on-disk header
 452  *
 453  * @param cd crypt device handle
 454  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 455  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 456  *
 457  * @returns 0 on success or negative errno value otherwise.
 458  *
 459  * @post In case LUKS header is read successfully but payload device is too small
 460  * error is returned and device type in context is set to @e NULL
 461  *
 462  * @note Note that in current version load works only for LUKS and VERITY device type.
 463  *
 464  */
 465 int crypt_load(struct crypt_device *cd,
 466                const char *requested_type,
 467                void *params);
 468
 469 /**
 470  * Try to repair crypt device on-disk header if invalid
 471  *
 472  * @param cd crypt device handle
 473  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 474  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 475  *
 476  * @returns 0 on success or negative errno value otherwise.
 477  *
 478  */
 479 int crypt_repair(struct crypt_device *cd,
 480                  const char *requested_type,
 481                  void *params);
 482
 483 /**
 484  * Resize crypt device
 485  *
 486  * @param cd - crypt device handle
 487  * @param name - name of device to resize
 488  * @param new_size - new device size in sectors or @e 0 to use all of the underlying device size
 489  *
 490  * @return @e 0 on success or negative errno value otherwise.
 491  */
 492 int crypt_resize(struct crypt_device *cd,
 493                  const char *name,
 494                  uint64_t new_size);
 495
 496 /**
 497  * Suspends crypt device.
 498  *
 499  * @param cd crypt device handle, can be @e NULL
 500  * @param name name of device to suspend
 501  *
 502  * @return 0 on success or negative errno value otherwise.
 503  *
 504  * @note Only LUKS device type is supported
 505  *
 506  */
 507 int crypt_suspend(struct crypt_device *cd,
 508                   const char *name);
 509
 510 /**
 511  * Resumes crypt device using passphrase.
 512  *
 513  *
 514  * @param cd crypt device handle
 515  * @param name name of device to resume
 516  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 517  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 518  * @param passphrase_size size of @e passphrase (binary data)
 519  *
 520  * @return unlocked key slot number or negative errno otherwise.
 521  *
 522  * @note Only LUKS device type is supported
 523  */
 524 int crypt_resume_by_passphrase(struct crypt_device *cd,
 525         const char *name,
 526         int keyslot,
 527         const char *passphrase,
 528         size_t passphrase_size);
 529
 530 /**
 531  * Resumes crypt device using key file.
 532  *
 533  * @param cd crypt device handle
 534  * @param name name of device to resume
 535  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 536  * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
 537  * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
 538  * @param keyfile_offset number of bytes to skip at start of keyfile
 539  *
 540  * @return unlocked key slot number or negative errno otherwise.
 541  */
 542 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
 543         const char *name,
 544         int keyslot,
 545         const char *keyfile,
 546         size_t keyfile_size,
 547         size_t keyfile_offset);
 548 /**
 549  * Backward compatible crypt_resume_by_keyfile_offset() (without offset).
 550  */
 551 int crypt_resume_by_keyfile(struct crypt_device *cd,
 552         const char *name,
 553         int keyslot,
 554         const char *keyfile,
 555         size_t keyfile_size);
 556
 557 /**
 558  * Releases crypt device context and used memory.
 559  *
 560  * @param cd crypt device handle
 561  */
 562 void crypt_free(struct crypt_device *cd);
 563
 564 /**
 565  * @defgroup keyslot "Cryptsetup LUKS keyslots"
 566  * @addtogroup keyslot
 567  * @{
 568  *
 569  */
 570
 571 /** iterate through all keyslots and find first one that fits */
 572 #define CRYPT_ANY_SLOT -1
 573
 574 /**
 575  * Add key slot using provided passphrase
 576  *
 577  * @pre @e cd contains initialized and formatted LUKS device context
 578  *
 579  * @param cd crypt device handle
 580  * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
 581  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 582  * @param passphrase_size size of passphrase (binary data)
 583  * @param new_passphrase passphrase for new keyslot, @e NULL for query
 584  * @param new_passphrase_size size of @e new_passphrase (binary data)
 585  *
 586  * @return allocated key slot number or negative errno otherwise.
 587  */
 588 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
 589         int keyslot,
 590         const char *passphrase,
 591         size_t passphrase_size,
 592         const char *new_passphrase,
 593         size_t new_passphrase_size);
 594
 595 /**
 596 * Add key slot using provided key file path
 597  *
 598  * @pre @e cd contains initialized and formatted LUKS device context
 599  *
 600  * @param cd crypt device handle
 601  * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
 602  * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
 603  * @param keyfile_size number of bytes to read from keyfile, @e 0 is unlimited
 604  * @param keyfile_offset number of bytes to skip at start of keyfile
 605  * @param new_keyfile keyfile for new keyslot, @e NULL for passphrase query
 606  * @param new_keyfile_size number of bytes to read from @e new_keyfile, @e 0 is unlimited
 607  * @param new_keyfile_offset number of bytes to skip at start of new_keyfile
 608  *
 609  * @return allocated key slot number or negative errno otherwise.
 610  *
 611  * @note Note that @e keyfile can be "-" for STDIN
 612  *
 613  */
 614 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
 615         int keyslot,
 616         const char *keyfile,
 617         size_t keyfile_size,
 618         size_t keyfile_offset,
 619         const char *new_keyfile,
 620         size_t new_keyfile_size,
 621         size_t new_keyfile_offset);
 622 /**
 623  * Backward compatible crypt_keyslot_add_by_keyfile_offset() (without offset).
 624  */
 625 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
 626         int keyslot,
 627         const char *keyfile,
 628         size_t keyfile_size,
 629         const char *new_keyfile,
 630         size_t new_keyfile_size);
 631
 632 /**
 633  * Add key slot using provided volume key
 634  *
 635  * @pre @e cd contains initialized and formatted LUKS device context
 636  *
 637  * @param cd crypt device handle
 638  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 639  * @param volume_key provided volume key or @e NULL if used after crypt_format
 640  * @param volume_key_size size of volume_key
 641  * @param passphrase passphrase for new keyslot, @e NULL for query
 642  * @param passphrase_size size of passphrase
 643  *
 644  * @return allocated key slot number or negative errno otherwise.
 645  *
 646  */
 647 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
 648         int keyslot,
 649         const char *volume_key,
 650         size_t volume_key_size,
 651         const char *passphrase,
 652         size_t passphrase_size);
 653
 654 /**
 655  * Destroy (and disable) key slot
 656  *
 657  * @pre @e cd contains initialized and formatted LUKS device context
 658  *
 659  * @param cd crypt device handle
 660  * @param keyslot requested key slot to destroy
 661  *
 662  * @return @e 0 on success or negative errno value otherwise.
 663  *
 664  * @note Note that there is no passphrase verification used.
 665  */
 666 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot);
 667
 668 /** @} */
 669
 670 /**
 671  * @defgroup aflags "Device runtime attributes"
 672  *
 673  * Activation flags
 674  *
 675  * @addtogroup aflags
 676  * @{
 677  *
 678  */
 679 /** device is read only */
 680 #define CRYPT_ACTIVATE_READONLY (1 << 0)
 681 /** only reported for device without uuid */
 682 #define CRYPT_ACTIVATE_NO_UUID  (1 << 1)
 683 /** activate even if cannot grant exclusive access (DANGEROUS) */
 684 #define CRYPT_ACTIVATE_SHARED   (1 << 2)
 685 /** enable discards aka TRIM */
 686 #define CRYPT_ACTIVATE_ALLOW_DISCARDS (1 << 3)
 687 /** skip global udev rules in activation ("private device"), input only */
 688 #define CRYPT_ACTIVATE_PRIVATE (1 << 4)
 689 /** corruption detected (verity), output only */
 690 #define CRYPT_ACTIVATE_CORRUPTED (1 << 5)
 691
 692 /**
 693  * Active device runtime attributes
 694  */
 695 struct crypt_active_device {
 696         uint64_t offset; /**< offset in sectors */
 697         uint64_t iv_offset; /**< IV initialization sector */
 698         uint64_t size; /**< active device size */
 699         uint32_t flags; /**< activation flags */
 700 };
 701
 702 /**
 703  * Receives runtime attributes of active crypt device
 704  *
 705  * @param cd crypt device handle (can be @e NULL)
 706  * @param name name of active device
 707  * @param cad preallocated active device attributes to fill
 708  *
 709  * @return @e 0 on success or negative errno value otherwise
 710  *
 711  */
 712 int crypt_get_active_device(struct crypt_device *cd,
 713                             const char *name,
 714                             struct crypt_active_device *cad);
 715
 716 /** @} */
 717
 718 /**
 719  * Activate device or check passphrase
 720  *
 721  * @param cd crypt device handle
 722  * @param name name of device to create, if @e NULL only check passphrase
 723  * @param keyslot requested keyslot to check or @e CRYPT_ANY_SLOT
 724  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 725  * @param passphrase_size size of @e passphrase
 726  * @param flags activation flags
 727  *
 728  * @return unlocked key slot number or negative errno otherwise.
 729  */
 730 int crypt_activate_by_passphrase(struct crypt_device *cd,
 731         const char *name,
 732         int keyslot,
 733         const char *passphrase,
 734         size_t passphrase_size,
 735         uint32_t flags);
 736
 737 /**
 738  * Activate device or check using key file
 739  *
 740  * @param cd crypt device handle
 741  * @param name name of device to create, if @e NULL only check keyfile
 742  * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
 743  * @param keyfile key file used to unlock volume key
 744  * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
 745  * @param keyfile_offset number of bytes to skip at start of keyfile
 746  * @param flags activation flags
 747  *
 748  * @return unlocked key slot number or negative errno otherwise.
 749  */
 750 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
 751         const char *name,
 752         int keyslot,
 753         const char *keyfile,
 754         size_t keyfile_size,
 755         size_t keyfile_offset,
 756         uint32_t flags);
 757 /**
 758  * Backward compatible crypt_activate_by_keyfile_offset() (without offset).
 759  */
 760 int crypt_activate_by_keyfile(struct crypt_device *cd,
 761         const char *name,
 762         int keyslot,
 763         const char *keyfile,
 764         size_t keyfile_size,
 765         uint32_t flags);
 766
 767 /**
 768  * Activate device using provided volume key
 769  *
 770  *
 771  * @param cd crypt device handle
 772  * @param name name of device to create, if @e NULL only check volume key
 773  * @param volume_key provided volume key (or @e NULL to use internal)
 774  * @param volume_key_size size of volume_key
 775  * @param flags activation flags
 776  *
 777  * @return @e 0 on success or negative errno value otherwise.
 778  *
 779  * @note If @e NULL is used for volume_key, device has to be initialized
 780  *       by previous operation (like @ref crypt_format
 781  *       or @ref crypt_init_by_name)
 782  * @note For VERITY the volume key means root hash required for activation.
 783  *       Because kernel dm-verity is always read only, you have to provide
 784  *       CRYPT_ACTIVATE_READONLY flag always.
 785  */
 786 int crypt_activate_by_volume_key(struct crypt_device *cd,
 787         const char *name,
 788         const char *volume_key,
 789         size_t volume_key_size,
 790         uint32_t flags);
 791
 792 /**
 793  * Deactivate crypt device. This function tries to remove active device-mapper
 794  * mapping from kernel. Also, sensitive data like the volume key are removed from
 795  * memory
 796  *
 797  * @param cd crypt device handle, can be @e NULL
 798  * @param name name of device to deactivate
 799  *
 800  * @return @e 0 on success or negative errno value otherwise.
 801  *
 802  */
 803 int crypt_deactivate(struct crypt_device *cd, const char *name);
 804
 805 /**
 806  * Get volume key from of crypt device
 807  *
 808  * @param cd crypt device handle
 809  * @param keyslot use this keyslot or @e CRYPT_ANY_SLOT
 810  * @param volume_key buffer for volume key
 811  * @param volume_key_size on input, size of buffer @e volume_key,
 812  *        on output size of @e volume_key
 813  * @param passphrase passphrase used to unlock volume key
 814  * @param passphrase_size size of @e passphrase
 815  *
 816  * @return unlocked key slot number or negative errno otherwise.
 817  */
 818 int crypt_volume_key_get(struct crypt_device *cd,
 819         int keyslot,
 820         char *volume_key,
 821         size_t *volume_key_size,
 822         const char *passphrase,
 823         size_t passphrase_size);
 824
 825 /**
 826  * Verify that provided volume key is valid for crypt device
 827  *
 828  * @param cd crypt device handle
 829  * @param volume_key provided volume key
 830  * @param volume_key_size size of @e volume_key
 831  *
 832  * @return @e 0 on success or negative errno value otherwise.
 833  */
 834 int crypt_volume_key_verify(struct crypt_device *cd,
 835         const char *volume_key,
 836         size_t volume_key_size);
 837
 838 /**
 839  * @defgroup devstat "Crypt and Verity device status"
 840  * @addtogroup devstat
 841  * @{
 842  */
 843
 844 /**
 845  * Device status
 846  */
 847 typedef enum {
 848         CRYPT_INVALID, /**< device mapping is invalid in this context */
 849         CRYPT_INACTIVE, /**< no such mapped device */
 850         CRYPT_ACTIVE, /**< device is active */
 851         CRYPT_BUSY /**< device is active and has open count > 0 */
 852 } crypt_status_info;
 853
 854 /**
 855  * Get status info about device name
 856  *
 857  * @param cd crypt device handle, can be @e NULL
 858  * @param name crypt device name
 859  *
 860  * @return value defined by crypt_status_info.
 861  *
 862  */
 863 crypt_status_info crypt_status(struct crypt_device *cd, const char *name);
 864
 865 /**
 866  * Dump text-formatted information about crypt or verity device to log output
 867  *
 868  * @param cd crypt device handle
 869  *
 870  * @return @e 0 on success or negative errno value otherwise.
 871  */
 872 int crypt_dump(struct crypt_device *cd);
 873
 874 /**
 875  * Informational benchmark for ciphers
 876  *
 877  * @param cd crypt device handle
 878  * @param cipher (e.g. "aes")
 879  * @param cipher_mode (e.g. "xts"), IV generator is ignored
 880  * @param volume_key_size size of volume key in bytes
 881  * @param iv_size size of IV in bytes
 882  * @param buffer_size size of encryption buffer in bytes used in test
 883  * @param encryption_mbs measured encryption speed in MiB/s
 884  * @param decryption_mbs measured decryption speed in MiB/s
 885  *
 886  * @return @e 0 on success or negative errno value otherwise.
 887  */
 888 int crypt_benchmark(struct crypt_device *cd,
 889         const char *cipher,
 890         const char *cipher_mode,
 891         size_t volume_key_size,
 892         size_t iv_size,
 893         size_t buffer_size,
 894         double *encryption_mbs,
 895         double *decryption_mbs);
 896
 897 /**
 898  * Get cipher used in device
 899  *
 900  * @param cd crypt device handle
 901  *
 902  * @return used cipher, e.g. "aes" or @e NULL otherwise
 903  *
 904  */
 905 const char *crypt_get_cipher(struct crypt_device *cd);
 906
 907 /**
 908  * Get cipher mode used in device
 909  *
 910  * @param cd crypt device handle
 911  *
 912  * @return used cipher mode e.g. "xts-plain" or @e otherwise
 913  *
 914  */
 915 const char *crypt_get_cipher_mode(struct crypt_device *cd);
 916
 917 /**
 918  * Get device UUID
 919  *
 920  * @param cd crypt device handle
 921  *
 922  * @return device UUID or @e NULL if not set
 923  *
 924  */
 925 const char *crypt_get_uuid(struct crypt_device *cd);
 926
 927 /**
 928  * Get path to underlaying device
 929  *
 930  * @param cd crypt device handle
 931  *
 932  * @return path to underlaying device name
 933  *
 934  */
 935 const char *crypt_get_device_name(struct crypt_device *cd);
 936
 937 /**
 938  * Get device offset in sectors where real data starts on underlying device)
 939  *
 940  * @param cd crypt device handle
 941  *
 942  * @return device offset in sectors
 943  *
 944  */
 945 uint64_t crypt_get_data_offset(struct crypt_device *cd);
 946
 947 /**
 948  * Get IV offset in sectors (skip)
 949  *
 950  * @param cd crypt device handle
 951  *
 952  * @return IV offset
 953  *
 954  */
 955 uint64_t crypt_get_iv_offset(struct crypt_device *cd);
 956
 957 /**
 958  * Get size (in bytes) of volume key for crypt device
 959  *
 960  * @param cd crypt device handle
 961  *
 962  * @return volume key size
 963  *
 964  */
 965 int crypt_get_volume_key_size(struct crypt_device *cd);
 966
 967 /**
 968  * Get device parameters for VERITY device
 969  *
 970  * @param cd crypt device handle
 971  * @param vp verity device info
 972  *
 973  * @e 0 on success or negative errno value otherwise.
 974  *
 975  */
 976 int crypt_get_verity_info(struct crypt_device *cd,
 977         struct crypt_params_verity *vp);
 978 /** @} */
 979
 980 /**
 981  * @addtogroup keyslot
 982  * @{
 983  *
 984  */
 985
 986 /**
 987  * Crypt keyslot info
 988  */
 989 typedef enum {
 990         CRYPT_SLOT_INVALID, /**< invalid keyslot */
 991         CRYPT_SLOT_INACTIVE, /**< keyslot is inactive (free) */
 992         CRYPT_SLOT_ACTIVE, /**< keyslot is active (used) */
 993         CRYPT_SLOT_ACTIVE_LAST /**< keylost is active (used)
 994                                 *   and last used at the same time */
 995 } crypt_keyslot_info;
 996
 997 /**
 998  * Get information about particular key slot
 999  *
1000  *
1001  * @param cd crypt device handle
1002  * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
1003  *
1004  * @return value defined by crypt_keyslot_info
1005  *
1006  */
1007 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot);
1008 /** @} */
1009
1010 /**
1011  * Get number of keyslots supported for device type.
1012  *
1013  * @param type crypt device type
1014  *
1015  * @return slot count or negative errno otherwise if device
1016  * doesn't not support keyslots.
1017  */
1018 int crypt_keyslot_max(const char *type);
1019
1020 /**
1021  * Get keyslot area pointers (relative to metadata device)
1022  *
1023  * @param cd crypt device handle
1024  * @param keyslot keyslot number
1025  * @param offset offset on metadata device (in bytes)
1026  * @param length length of keyslot area (in bytes)
1027  *
1028  * @return @e 0 on success or negative errno value otherwise.
1029  *
1030  */
1031 int crypt_keyslot_area(struct crypt_device *cd,
1032         int keyslot,
1033         uint64_t *offset,
1034         uint64_t *length);
1035
1036 /**
1037  * Backup header and keyslots to file
1038  *
1039  * @param cd crypt device handle
1040  * @param requested_type @link crypt_type @endlink or @e NULL for all known
1041  * @param backup_file file to backup header to
1042  *
1043  * @return @e 0 on success or negative errno value otherwise.
1044  *
1045  */
1046 int crypt_header_backup(struct crypt_device *cd,
1047         const char *requested_type,
1048         const char *backup_file);
1049
1050 /**
1051  * Restore header and keyslots from backup file
1052  *
1053  *
1054  * @param cd crypt device handle
1055  * @param requested_type @link crypt_type @endlink or @e NULL for all known
1056  * @param backup_file file to restore header from
1057  *
1058  * @return @e 0 on success or negative errno value otherwise.
1059  *
1060  */
1061 int crypt_header_restore(struct crypt_device *cd,
1062         const char *requested_type,
1063         const char *backup_file);
1064
1065 /**
1066  * Receives last reported error
1067  *
1068  * @param cd crypt device handle
1069  * @param buf buffef for message
1070  * @param size size of buffer
1071  *
1072  * @note Note that this is old API function using global context.
1073  * All error messages are reported also through log callback.
1074  */
1075 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size);
1076
1077 /**
1078  * Receives last reported error, DEPRECATED
1079  *
1080  * @param buf buffef for message
1081  * @param size size of buffer
1082  *
1083  * @note Note that this is old API function using global context.
1084  * All error messages are reported also through log callback.
1085  */
1086 void crypt_get_error(char *buf, size_t size);
1087
1088 /**
1089  * Get directory where mapped crypt devices are created
1090  *
1091  * @return the directory path
1092  */
1093 const char *crypt_get_dir(void);
1094
1095 /**
1096  * @defgroup dbg "Library debug level"
1097  *
1098  * Set library debug level
1099  *
1100  * @addtogroup dbg
1101  * @{
1102  */
1103
1104 /** Debug all */
1105 #define CRYPT_DEBUG_ALL  -1
1106 /** Debug none */
1107 #define CRYPT_DEBUG_NONE  0
1108
1109 /**
1110  * Set the debug level for library
1111  *
1112  * @param level debug level
1113  *
1114  */
1115 void crypt_set_debug_level(int level);
1116
1117 /** @} */
1118
1119 #ifdef __cplusplus
1120 }
1121 #endif
1122 #endif /* _LIBCRYPTSETUP_H */