lib/libcryptsetup.h

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