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 (encrypted payload area device) if LUKS header is separated
 230  *
 231  * @param cd crypt device handle
 232  * @param device path to device
 233  *
 234  * @pre context is of LUKS type
 235  * @pre unlike @ref crypt_init, in this function param @e device
 236  *      has to be block device (at least 512B large)
 237  */
 238 int crypt_set_data_device(struct crypt_device *cd, const char *device);
 239
 240 /**
 241  * @defgroup rng "Cryptsetup RNG"
 242  *
 243  * @addtogroup rng
 244  * @{
 245  *
 246  */
 247
 248 /** CRYPT_RNG_URANDOM - use /dev/urandom */
 249 #define CRYPT_RNG_URANDOM 0
 250 /** CRYPT_RNG_RANDOM  - use /dev/random (waits if no entropy in system) */
 251 #define CRYPT_RNG_RANDOM  1
 252
 253 /**
 254  * Set which RNG (random number generator) is used for generating long term key
 255  *
 256  * @param cd crypt device handle
 257  * @param rng_type kernel random number generator to use
 258  *
 259  */
 260 void crypt_set_rng_type(struct crypt_device *cd, int rng_type);
 261
 262 /**
 263  * Get which RNG (random number generator) is used for generating long term key
 264  *
 265  * @param cd crypt device handle
 266  * @return RNG type on success or negative errno value otherwise.
 267  *
 268  */
 269 int crypt_get_rng_type(struct crypt_device *cd);
 270
 271 /** @} */
 272
 273 /**
 274  * Helper to lock/unlock memory to avoid swap sensitive data to disk
 275  *
 276  * @param cd crypt device handle, can be @e NULL
 277  * @param lock 0 to unlock otherwise lock memory
 278  *
 279  * @returns Value indicating whether the memory is locked (function can be called multiple times).
 280  *
 281  * @note Only root can do this.
 282  * @note It locks/unlocks all process memory, not only crypt context.
 283  */
 284 int crypt_memory_lock(struct crypt_device *cd, int lock);
 285
 286 /**
 287  * @defgroup crypt_type "Cryptsetup on-disk format types"
 288  *
 289  * Set of functions, \#defines and structs related
 290  * to on-disk format types
 291  */
 292
 293 /**
 294  * @addtogroup crypt_type
 295  * @{
 296  */
 297
 298 /** plain crypt device, no on-disk header */
 299 #define CRYPT_PLAIN "PLAIN"
 300 /** LUKS version 1 header on-disk */
 301 #define CRYPT_LUKS1 "LUKS1"
 302 /** loop-AES compatibility mode */
 303 #define CRYPT_LOOPAES "LOOPAES"
 304 /** dm-verity mode */
 305 #define CRYPT_VERITY "VERITY"
 306
 307 /**
 308  * Get device type
 309  *
 310  * @param cd crypt device handle
 311  * @return string according to device type or @e NULL if not known.
 312  */
 313 const char *crypt_get_type(struct crypt_device *cd);
 314
 315 /**
 316  *
 317  * Structure used as parameter for PLAIN device type
 318  *
 319  * @see crypt_format
 320  */
 321 struct crypt_params_plain {
 322         const char *hash; /**< password hash function */
 323         uint64_t offset; /**< offset in sectors */
 324         uint64_t skip; /**< IV offset / initialization sector */
 325         uint64_t size; /**< size of mapped device or @e 0 for autodetection */
 326 };
 327
 328 /**
 329  * Structure used as parameter for LUKS device type
 330  *
 331  * @see crypt_format, crypt_load
 332  *
 333  * @note during crypt_format @e data_device attribute determines
 334  *       if the LUKS header is separated from encrypted payload device
 335  *
 336  */
 337 struct crypt_params_luks1 {
 338         const char *hash; /**< hash used in LUKS header */
 339         size_t data_alignment; /**< data alignment in sectors, data offset is multiple of this */
 340         const char *data_device; /**< detached encrypted data device or @e NULL */
 341 };
 342
 343 /**
 344  *
 345  * Structure used as parameter for loop-AES device type
 346  *
 347  * @see crypt_format
 348  *
 349  */
 350 struct crypt_params_loopaes {
 351         const char *hash; /**< key hash function */
 352         uint64_t offset;  /**< offset in sectors */
 353         uint64_t skip;    /**< IV offset / initialization sector */
 354 };
 355
 356 /**
 357  *
 358  * Structure used as parameter for dm-verity device type
 359  *
 360  * @see crypt_format, crypt_load
 361  *
 362  */
 363 /** No on-disk header (only hashes) */
 364 #define CRYPT_VERITY_NO_HEADER   (1 << 0)
 365 /** Verity hash in userspace before activation */
 366 #define CRYPT_VERITY_CHECK_HASH  (1 << 1)
 367 /** Create hash - format hash device */
 368 #define CRYPT_VERITY_CREATE_HASH (1 << 2)
 369
 370 struct crypt_params_verity {
 371         const char *hash_name;     /**< hash function */
 372         const char *data_device;   /**< data_device (CRYPT_VERITY_CREATE_HASH) */
 373         const char *hash_device;   /**< hash_device (output only) */
 374         const char *salt;          /**< salt */
 375         uint32_t salt_size;        /**< salt size (in bytes) */
 376         uint32_t hash_type;        /**< in-kernel hashing type */
 377         uint32_t data_block_size;  /**< data block size (in bytes) */
 378         uint32_t hash_block_size;  /**< hash block size (in bytes) */
 379         uint64_t data_size;        /**< data area size (in data blocks) */
 380         uint64_t hash_area_offset; /**< hash/header offset (in bytes) */
 381         uint32_t flags;            /**< CRYPT_VERITY* flags */
 382 };
 383
 384 /** @} */
 385
 386 /**
 387  * Create (format) new crypt device (and possible header on-disk) but not activates it.
 388  *
 389  * @pre @e cd contains initialized and not formatted device context (device type must @b not be set)
 390  *
 391  * @param cd crypt device handle
 392  * @param type type of device (optional params struct must be of this type)
 393  * @param cipher (e.g. "aes")
 394  * @param cipher_mode including IV specification (e.g. "xts-plain")
 395  * @param uuid requested UUID or @e NULL if it should be generated
 396  * @param volume_key pre-generated volume key or @e NULL if it should be generated (only for LUKS)
 397  * @param volume_key_size size of volume key in bytes.
 398  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 399  *
 400  * @returns @e 0 on success or negative errno value otherwise.
 401  *
 402  * @note Note that crypt_format does not enable any keyslot (in case of work with LUKS device), but it stores volume key internally
 403  *       and subsequent crypt_keyslot_add_* calls can be used.
 404  */
 405 int crypt_format(struct crypt_device *cd,
 406         const char *type,
 407         const char *cipher,
 408         const char *cipher_mode,
 409         const char *uuid,
 410         const char *volume_key,
 411         size_t volume_key_size,
 412         void *params);
 413
 414 /**
 415  * Set new UUID for already existing device
 416  *
 417  * @param cd crypt device handle
 418  * @param uuid requested UUID or @e NULL if it should be generated
 419  *
 420  * @returns 0 on success or negative errno value otherwise.
 421  *
 422  * @note Currently, only LUKS device type are supported
 423  */
 424 int crypt_set_uuid(struct crypt_device *cd,
 425                    const char *uuid);
 426
 427 /**
 428  * Load crypt device parameters from on-disk header
 429  *
 430  * @param cd crypt device handle
 431  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 432  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 433  *
 434  * @returns 0 on success or negative errno value otherwise.
 435  *
 436  * @post In case LUKS header is read successfully but payload device is too small
 437  * error is returned and device type in context is set to @e NULL
 438  *
 439  * @note Note that in current version load works only for LUKS device type
 440  *
 441  */
 442 int crypt_load(struct crypt_device *cd,
 443                const char *requested_type,
 444                void *params);
 445
 446 /**
 447  * Try to repair crypt device on-disk header if invalid
 448  *
 449  * @param cd crypt device handle
 450  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 451  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 452  *
 453  * @returns 0 on success or negative errno value otherwise.
 454  *
 455  */
 456 int crypt_repair(struct crypt_device *cd,
 457                  const char *requested_type,
 458                  void *params);
 459
 460 /**
 461  * Resize crypt device
 462  *
 463  * @param cd - crypt device handle
 464  * @param name - name of device to resize
 465  * @param new_size - new device size in sectors or @e 0 to use all of the underlying device size
 466  *
 467  * @return @e 0 on success or negative errno value otherwise.
 468  */
 469 int crypt_resize(struct crypt_device *cd,
 470                  const char *name,
 471                  uint64_t new_size);
 472
 473 /**
 474  * Suspends crypt device.
 475  *
 476  * @param cd crypt device handle, can be @e NULL
 477  * @param name name of device to suspend
 478  *
 479  * @return 0 on success or negative errno value otherwise.
 480  *
 481  * @note Only LUKS device type is supported
 482  *
 483  */
 484 int crypt_suspend(struct crypt_device *cd,
 485                   const char *name);
 486
 487 /**
 488  * Resumes crypt device using passphrase.
 489  *
 490  *
 491  * @param cd crypt device handle
 492  * @param name name of device to resume
 493  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 494  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 495  * @param passphrase_size size of @e passphrase (binary data)
 496  *
 497  * @return unlocked key slot number or negative errno otherwise.
 498  *
 499  * @note Only LUKS device type is supported
 500  */
 501 int crypt_resume_by_passphrase(struct crypt_device *cd,
 502         const char *name,
 503         int keyslot,
 504         const char *passphrase,
 505         size_t passphrase_size);
 506
 507 /**
 508  * Resumes crypt device using key file.
 509  *
 510  * @param cd crypt device handle
 511  * @param name name of device to resume
 512  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 513  * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
 514  * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
 515  * @param keyfile_offset number of bytes to skip at start of keyfile
 516  *
 517  * @return unlocked key slot number or negative errno otherwise.
 518  */
 519 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
 520         const char *name,
 521         int keyslot,
 522         const char *keyfile,
 523         size_t keyfile_size,
 524         size_t keyfile_offset);
 525 /**
 526  * Backward compatible crypt_resume_by_keyfile_offset() (without offset).
 527  */
 528 int crypt_resume_by_keyfile(struct crypt_device *cd,
 529         const char *name,
 530         int keyslot,
 531         const char *keyfile,
 532         size_t keyfile_size);
 533
 534 /**
 535  * Releases crypt device context and used memory.
 536  *
 537  * @param cd crypt device handle
 538  */
 539 void crypt_free(struct crypt_device *cd);
 540
 541 /**
 542  * @defgroup keyslot "Cryptsetup LUKS keyslots"
 543  * @addtogroup keyslot
 544  * @{
 545  *
 546  */
 547
 548 /** iterate through all keyslots and find first one that fits */
 549 #define CRYPT_ANY_SLOT -1
 550
 551 /**
 552  * Add key slot using provided passphrase
 553  *
 554  * @pre @e cd contains initialized and formatted LUKS device context
 555  *
 556  * @param cd crypt device handle
 557  * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
 558  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 559  * @param passphrase_size size of passphrase (binary data)
 560  * @param new_passphrase passphrase for new keyslot, @e NULL for query
 561  * @param new_passphrase_size size of @e new_passphrase (binary data)
 562  *
 563  * @return allocated key slot number or negative errno otherwise.
 564  */
 565 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
 566         int keyslot,
 567         const char *passphrase,
 568         size_t passphrase_size,
 569         const char *new_passphrase,
 570         size_t new_passphrase_size);
 571
 572 /**
 573  * Get number of keyslots supported for device type.
 574  *
 575  * @param type crypt device type
 576  *
 577  * @return slot count or negative errno otherwise if device
 578  * doesn't not support keyslots.
 579  */
 580 int crypt_keyslot_max(const char *type);
 581
 582 /**
 583 * Add key slot using provided key file path
 584  *
 585  * @pre @e cd contains initialized and formatted LUKS device context
 586  *
 587  * @param cd crypt device handle
 588  * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
 589  * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
 590  * @param keyfile_size number of bytes to read from keyfile, @e 0 is unlimited
 591  * @param keyfile_offset number of bytes to skip at start of keyfile
 592  * @param new_keyfile keyfile for new keyslot, @e NULL for passphrase query
 593  * @param new_keyfile_size number of bytes to read from @e new_keyfile, @e 0 is unlimited
 594  * @param new_keyfile_offset number of bytes to skip at start of new_keyfile
 595  *
 596  * @return allocated key slot number or negative errno otherwise.
 597  *
 598  * @note Note that @e keyfile can be "-" for STDIN
 599  *
 600  */
 601 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
 602         int keyslot,
 603         const char *keyfile,
 604         size_t keyfile_size,
 605         size_t keyfile_offset,
 606         const char *new_keyfile,
 607         size_t new_keyfile_size,
 608         size_t new_keyfile_offset);
 609 /**
 610  * Backward compatible crypt_keyslot_add_by_keyfile_offset() (without offset).
 611  */
 612 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
 613         int keyslot,
 614         const char *keyfile,
 615         size_t keyfile_size,
 616         const char *new_keyfile,
 617         size_t new_keyfile_size);
 618
 619 /**
 620  * Add key slot using provided volume key
 621  *
 622  * @pre @e cd contains initialized and formatted LUKS device context
 623  *
 624  * @param cd crypt device handle
 625  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 626  * @param volume_key provided volume key or @e NULL if used after crypt_format
 627  * @param volume_key_size size of volume_key
 628  * @param passphrase passphrase for new keyslot, @e NULL for query
 629  * @param passphrase_size size of passphrase
 630  *
 631  * @return allocated key slot number or negative errno otherwise.
 632  *
 633  */
 634 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
 635         int keyslot,
 636         const char *volume_key,
 637         size_t volume_key_size,
 638         const char *passphrase,
 639         size_t passphrase_size);
 640
 641 /**
 642  * Destroy (and disable) key slot
 643  *
 644  * @pre @e cd contains initialized and formatted LUKS device context
 645  *
 646  * @param cd crypt device handle
 647  * @param keyslot requested key slot to destroy
 648  *
 649  * @return @e 0 on success or negative errno value otherwise.
 650  *
 651  * @note Note that there is no passphrase verification used.
 652  */
 653 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot);
 654
 655 /** @} */
 656
 657 /**
 658  * @defgroup aflags "Device runtime attributes"
 659  *
 660  * Activation flags
 661  *
 662  * @addtogroup aflags
 663  * @{
 664  *
 665  */
 666 /** device is read only */
 667 #define CRYPT_ACTIVATE_READONLY (1 << 0)
 668 /** only reported for device without uuid */
 669 #define CRYPT_ACTIVATE_NO_UUID  (1 << 1)
 670 /** activate even if cannot grant exclusive access (DANGEROUS) */
 671 #define CRYPT_ACTIVATE_SHARED   (1 << 2)
 672 /** enable discards aka TRIM */
 673 #define CRYPT_ACTIVATE_ALLOW_DISCARDS (1 << 3)
 674 /** skip global udev rules in activation ("private device"), input only */
 675 #define CRYPT_ACTIVATE_PRIVATE (1 << 4)
 676 /** corruption detected (verity), output only */
 677 #define CRYPT_ACTIVATE_CORRUPTED (1 << 5)
 678
 679 /**
 680  * Active device runtime attributes
 681  */
 682 struct crypt_active_device {
 683         uint64_t offset; /**< offset in sectors */
 684         uint64_t iv_offset; /**< IV initialization sector */
 685         uint64_t size; /**< active device size */
 686         uint32_t flags; /**< activation flags */
 687 };
 688
 689 /**
 690  * Receives runtime attributes of active crypt device
 691  *
 692  * @param cd crypt device handle (can be @e NULL)
 693  * @param name name of active device
 694  * @param cad preallocated active device attributes to fill
 695  *
 696  * @return @e 0 on success or negative errno value otherwise
 697  *
 698  */
 699 int crypt_get_active_device(struct crypt_device *cd,
 700                             const char *name,
 701                             struct crypt_active_device *cad);
 702
 703 /** @} */
 704
 705 /**
 706  * Activate device or check passphrase
 707  *
 708  * @param cd crypt device handle
 709  * @param name name of device to create, if @e NULL only check passphrase
 710  * @param keyslot requested keyslot to check or @e CRYPT_ANY_SLOT
 711  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 712  * @param passphrase_size size of @e passphrase
 713  * @param flags activation flags
 714  *
 715  * @return unlocked key slot number or negative errno otherwise.
 716  */
 717 int crypt_activate_by_passphrase(struct crypt_device *cd,
 718         const char *name,
 719         int keyslot,
 720         const char *passphrase,
 721         size_t passphrase_size,
 722         uint32_t flags);
 723
 724 /**
 725  * Activate device or check using key file
 726  *
 727  * @param cd crypt device handle
 728  * @param name name of device to create, if @e NULL only check keyfile
 729  * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
 730  * @param keyfile key file used to unlock volume key
 731  * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
 732  * @param keyfile_offset number of bytes to skip at start of keyfile
 733  * @param flags activation flags
 734  *
 735  * @return unlocked key slot number or negative errno otherwise.
 736  */
 737 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
 738         const char *name,
 739         int keyslot,
 740         const char *keyfile,
 741         size_t keyfile_size,
 742         size_t keyfile_offset,
 743         uint32_t flags);
 744 /**
 745  * Backward compatible crypt_activate_by_keyfile_offset() (without offset).
 746  */
 747 int crypt_activate_by_keyfile(struct crypt_device *cd,
 748         const char *name,
 749         int keyslot,
 750         const char *keyfile,
 751         size_t keyfile_size,
 752         uint32_t flags);
 753
 754 /**
 755  * Activate device using provided volume key
 756  *
 757  *
 758  * @param cd crypt device handle
 759  * @param name name of device to create, if @e NULL only check volume key
 760  * @param volume_key provided volume key (or @e NULL to use internal)
 761  * @param volume_key_size size of volume_key
 762  * @param flags activation flags
 763  *
 764  * @return @e 0 on success or negative errno value otherwise.
 765  *
 766  * @note If @e NULL is used for volume_key, device has to be initialized
 767  *       by previous operation (like @ref crypt_format
 768  *       or @ref crypt_init_by_name)
 769  */
 770 int crypt_activate_by_volume_key(struct crypt_device *cd,
 771         const char *name,
 772         const char *volume_key,
 773         size_t volume_key_size,
 774         uint32_t flags);
 775
 776 /**
 777  * Deactivate crypt device. This function tries to remove active device-mapper
 778  * mapping from kernel. Also, sensitive data like the volume key are removed from
 779  * memory
 780  *
 781  * @param cd crypt device handle, can be @e NULL
 782  * @param name name of device to deactivate
 783  *
 784  * @return @e 0 on success or negative errno value otherwise.
 785  *
 786  */
 787 int crypt_deactivate(struct crypt_device *cd, const char *name);
 788
 789 /**
 790  * Get volume key from of crypt device
 791  *
 792  * @param cd crypt device handle
 793  * @param keyslot use this keyslot or @e CRYPT_ANY_SLOT
 794  * @param volume_key buffer for volume key
 795  * @param volume_key_size on input, size of buffer @e volume_key,
 796  *        on output size of @e volume_key
 797  * @param passphrase passphrase used to unlock volume key
 798  * @param passphrase_size size of @e passphrase
 799  *
 800  * @return unlocked key slot number or negative errno otherwise.
 801  */
 802 int crypt_volume_key_get(struct crypt_device *cd,
 803         int keyslot,
 804         char *volume_key,
 805         size_t *volume_key_size,
 806         const char *passphrase,
 807         size_t passphrase_size);
 808
 809 /**
 810  * Verify that provided volume key is valid for crypt device
 811  *
 812  * @param cd crypt device handle
 813  * @param volume_key provided volume key
 814  * @param volume_key_size size of @e volume_key
 815  *
 816  * @return @e 0 on success or negative errno value otherwise.
 817  */
 818 int crypt_volume_key_verify(struct crypt_device *cd,
 819         const char *volume_key,
 820         size_t volume_key_size);
 821
 822
 823 /*
 824  * @defgroup devstat "dmcrypt device status"
 825  * @addtogroup devstat
 826  * @{
 827  */
 828
 829 /**
 830  * Device status
 831  */
 832 typedef enum {
 833         CRYPT_INVALID, /**< device mapping is invalid in this context */
 834         CRYPT_INACTIVE, /**< no such mapped device */
 835         CRYPT_ACTIVE, /**< device is active */
 836         CRYPT_BUSY /**< device is active and has open count > 0 */
 837 } crypt_status_info;
 838
 839 /**
 840  * Get status info about device name
 841  *
 842  * @param cd crypt device handle, can be @e NULL
 843  * @param name crypt device name
 844  *
 845  * @return value defined by crypt_status_info.
 846  *
 847  */
 848 crypt_status_info crypt_status(struct crypt_device *cd, const char *name);
 849
 850 /**
 851  * Dump text-formatted information about crypt device to log output
 852  *
 853  * @param cd crypt device handle
 854  *
 855  * @return @e 0 on success or negative errno value otherwise.
 856  */
 857 int crypt_dump(struct crypt_device *cd);
 858
 859 /**
 860  * Get cipher used in device
 861  *
 862  * @param cd crypt device handle
 863  *
 864  * @return used cipher, e.g. "aes" or @e NULL otherwise
 865  *
 866  */
 867 const char *crypt_get_cipher(struct crypt_device *cd);
 868
 869 /**
 870  * Get cipher mode used in device
 871  *
 872  * @param cd crypt device handle
 873  *
 874  * @return used cipher mode e.g. "xts-plain" or @e otherwise
 875  *
 876  */
 877 const char *crypt_get_cipher_mode(struct crypt_device *cd);
 878
 879 /**
 880  * Get device UUID
 881  *
 882  * @param cd crypt device handle
 883  *
 884  * @return device UUID or @e NULL if not set
 885  *
 886  */
 887 const char *crypt_get_uuid(struct crypt_device *cd);
 888
 889 /**
 890  * Get path to underlaying device
 891  *
 892  * @param cd crypt device handle
 893  *
 894  * @return path to underlaying device name
 895  *
 896  */
 897 const char *crypt_get_device_name(struct crypt_device *cd);
 898
 899 /**
 900  * Get device offset in sectors where real data starts on underlying device)
 901  *
 902  * @param cd crypt device handle
 903  *
 904  * @return device offset in sectors
 905  *
 906  */
 907 uint64_t crypt_get_data_offset(struct crypt_device *cd);
 908
 909 /**
 910  * Get IV offset in sectors (skip)
 911  *
 912  * @param cd crypt device handle
 913  *
 914  * @return IV offset
 915  *
 916  */
 917 uint64_t crypt_get_iv_offset(struct crypt_device *cd);
 918
 919 /**
 920  * Get size (in bytes) of volume key for crypt device
 921  *
 922  * @param cd crypt device handle
 923  *
 924  * @return volume key size
 925  *
 926  */
 927 int crypt_get_volume_key_size(struct crypt_device *cd);
 928
 929 /**
 930  * Get device paramaters for CRYPT_VERITY device
 931  *
 932  * @param cd crypt device handle
 933  * @param vp verity device info
 934  *
 935  * @e 0 on success or negative errno value otherwise.
 936  *
 937  */
 938 int crypt_get_verity_info(struct crypt_device *cd,
 939         struct crypt_params_verity *vp);
 940
 941 /**
 942  * @addtogroup keyslot
 943  * @{
 944  *
 945  */
 946
 947 /**
 948  * Crypt keyslot info
 949  */
 950 typedef enum {
 951         CRYPT_SLOT_INVALID, /**< invalid keyslot */
 952         CRYPT_SLOT_INACTIVE, /**< keyslot is inactive (free) */
 953         CRYPT_SLOT_ACTIVE, /**< keyslot is active (used) */
 954         CRYPT_SLOT_ACTIVE_LAST /**< keylost is active (used)
 955                                 *   and last used at the same time */
 956 } crypt_keyslot_info;
 957
 958 /**
 959  * Get information about particular key slot
 960  *
 961  *
 962  * @param cd crypt device handle
 963  * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
 964  *
 965  * @return value defined by crypt_keyslot_info
 966  *
 967  */
 968 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot);
 969 /** @} */
 970
 971 /**
 972  * Backup header and keyslots to file
 973  *
 974  * @param cd crypt device handle
 975  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 976  * @param backup_file file to backup header to
 977  *
 978  * @return @e 0 on success or negative errno value otherwise.
 979  *
 980  */
 981 int crypt_header_backup(struct crypt_device *cd,
 982         const char *requested_type,
 983         const char *backup_file);
 984
 985 /**
 986  * Restore header and keyslots from backup file
 987  *
 988  *
 989  * @param cd crypt device handle
 990  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 991  * @param backup_file file to restore header from
 992  *
 993  * @return @e 0 on success or negative errno value otherwise.
 994  *
 995  */
 996 int crypt_header_restore(struct crypt_device *cd,
 997         const char *requested_type,
 998         const char *backup_file);
 999
1000 /**
1001  * Receives last reported error
1002  *
1003  * @param cd crypt device handle
1004  * @param buf buffef for message
1005  * @param size size of buffer
1006  *
1007  * @note Note that this is old API function using global context.
1008  * All error messages are reported also through log callback.
1009  */
1010 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size);
1011
1012 /**
1013  * Receives last reported error, DEPRECATED
1014  *
1015  * @param buf buffef for message
1016  * @param size size of buffer
1017  *
1018  * @note Note that this is old API function using global context.
1019  * All error messages are reported also through log callback.
1020  */
1021 void crypt_get_error(char *buf, size_t size);
1022
1023 /**
1024  * Get directory where mapped crypt devices are created
1025  *
1026  * @return the directory path
1027  */
1028 const char *crypt_get_dir(void);
1029
1030 /**
1031  * @defgroup dbg "Library debug level"
1032  *
1033  * Set library debug level
1034  *
1035  * @addtogroup dbg
1036  * @{
1037  */
1038
1039 /** Debug all */
1040 #define CRYPT_DEBUG_ALL  -1
1041 /** Debug none */
1042 #define CRYPT_DEBUG_NONE  0
1043
1044 /**
1045  * Set the debug level for library
1046  *
1047  * @param level debug level
1048  *
1049  */
1050 void crypt_set_debug_level(int level);
1051
1052 /** @} */
1053
1054 #ifdef __cplusplus
1055 }
1056 #endif
1057 #endif /* _LIBCRYPTSETUP_H */