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 #define CRYPT_TCRYPT_LEGACY_MODES    (1 << 1)
 395
 396 struct crypt_params_tcrypt {
 397         const char *passphrase;
 398         size_t passphrase_size;
 399         const char **keyfiles;
 400         unsigned int keyfiles_count;
 401         const char *hash_name;     /**< hash function for PBKDF */
 402         const char *cipher[3];     /**< cipher chain */
 403         const char *mode;          /**< cipher block mode */
 404         size_t key_size;           /**< key size in bytes */
 405         uint32_t flags;            /**< CRYPT_TCRYPT* flags */
 406 };
 407
 408 /** @} */
 409
 410 /**
 411  * Create (format) new crypt device (and possible header on-disk) but not activates it.
 412  *
 413  * @pre @e cd contains initialized and not formatted device context (device type must @b not be set)
 414  *
 415  * @param cd crypt device handle
 416  * @param type type of device (optional params struct must be of this type)
 417  * @param cipher (e.g. "aes")
 418  * @param cipher_mode including IV specification (e.g. "xts-plain")
 419  * @param uuid requested UUID or @e NULL if it should be generated
 420  * @param volume_key pre-generated volume key or @e NULL if it should be generated (only for LUKS)
 421  * @param volume_key_size size of volume key in bytes.
 422  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 423  *
 424  * @returns @e 0 on success or negative errno value otherwise.
 425  *
 426  * @note Note that crypt_format does not enable any keyslot (in case of work with LUKS device),
 427  *      but it stores volume key internally and subsequent crypt_keyslot_add_* calls can be used.
 428  * @note For VERITY @link crypt_type @endlink, only uuid parameter is used, others paramaters
 429  *      are ignored and verity specific attributes are set through mandatory params option.
 430  */
 431 int crypt_format(struct crypt_device *cd,
 432         const char *type,
 433         const char *cipher,
 434         const char *cipher_mode,
 435         const char *uuid,
 436         const char *volume_key,
 437         size_t volume_key_size,
 438         void *params);
 439
 440 /**
 441  * Set new UUID for already existing device
 442  *
 443  * @param cd crypt device handle
 444  * @param uuid requested UUID or @e NULL if it should be generated
 445  *
 446  * @returns 0 on success or negative errno value otherwise.
 447  *
 448  * @note Currently, only LUKS device type are supported
 449  */
 450 int crypt_set_uuid(struct crypt_device *cd,
 451                    const char *uuid);
 452
 453 /**
 454  * Load crypt device parameters from on-disk header
 455  *
 456  * @param cd crypt device handle
 457  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 458  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 459  *
 460  * @returns 0 on success or negative errno value otherwise.
 461  *
 462  * @post In case LUKS header is read successfully but payload device is too small
 463  * error is returned and device type in context is set to @e NULL
 464  *
 465  * @note Note that in current version load works only for LUKS and VERITY device type.
 466  *
 467  */
 468 int crypt_load(struct crypt_device *cd,
 469                const char *requested_type,
 470                void *params);
 471
 472 /**
 473  * Try to repair crypt device on-disk header if invalid
 474  *
 475  * @param cd crypt device handle
 476  * @param requested_type @link crypt_type @endlink or @e NULL for all known
 477  * @param params crypt type specific parameters (see @link crypt_type @endlink)
 478  *
 479  * @returns 0 on success or negative errno value otherwise.
 480  *
 481  */
 482 int crypt_repair(struct crypt_device *cd,
 483                  const char *requested_type,
 484                  void *params);
 485
 486 /**
 487  * Resize crypt device
 488  *
 489  * @param cd - crypt device handle
 490  * @param name - name of device to resize
 491  * @param new_size - new device size in sectors or @e 0 to use all of the underlying device size
 492  *
 493  * @return @e 0 on success or negative errno value otherwise.
 494  */
 495 int crypt_resize(struct crypt_device *cd,
 496                  const char *name,
 497                  uint64_t new_size);
 498
 499 /**
 500  * Suspends crypt device.
 501  *
 502  * @param cd crypt device handle, can be @e NULL
 503  * @param name name of device to suspend
 504  *
 505  * @return 0 on success or negative errno value otherwise.
 506  *
 507  * @note Only LUKS device type is supported
 508  *
 509  */
 510 int crypt_suspend(struct crypt_device *cd,
 511                   const char *name);
 512
 513 /**
 514  * Resumes crypt device using passphrase.
 515  *
 516  *
 517  * @param cd crypt device handle
 518  * @param name name of device to resume
 519  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 520  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 521  * @param passphrase_size size of @e passphrase (binary data)
 522  *
 523  * @return unlocked key slot number or negative errno otherwise.
 524  *
 525  * @note Only LUKS device type is supported
 526  */
 527 int crypt_resume_by_passphrase(struct crypt_device *cd,
 528         const char *name,
 529         int keyslot,
 530         const char *passphrase,
 531         size_t passphrase_size);
 532
 533 /**
 534  * Resumes crypt device using key file.
 535  *
 536  * @param cd crypt device handle
 537  * @param name name of device to resume
 538  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 539  * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
 540  * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
 541  * @param keyfile_offset number of bytes to skip at start of keyfile
 542  *
 543  * @return unlocked key slot number or negative errno otherwise.
 544  */
 545 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
 546         const char *name,
 547         int keyslot,
 548         const char *keyfile,
 549         size_t keyfile_size,
 550         size_t keyfile_offset);
 551 /**
 552  * Backward compatible crypt_resume_by_keyfile_offset() (without offset).
 553  */
 554 int crypt_resume_by_keyfile(struct crypt_device *cd,
 555         const char *name,
 556         int keyslot,
 557         const char *keyfile,
 558         size_t keyfile_size);
 559
 560 /**
 561  * Releases crypt device context and used memory.
 562  *
 563  * @param cd crypt device handle
 564  */
 565 void crypt_free(struct crypt_device *cd);
 566
 567 /**
 568  * @defgroup keyslot "Cryptsetup LUKS keyslots"
 569  * @addtogroup keyslot
 570  * @{
 571  *
 572  */
 573
 574 /** iterate through all keyslots and find first one that fits */
 575 #define CRYPT_ANY_SLOT -1
 576
 577 /**
 578  * Add key slot using provided passphrase
 579  *
 580  * @pre @e cd contains initialized and formatted LUKS device context
 581  *
 582  * @param cd crypt device handle
 583  * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
 584  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 585  * @param passphrase_size size of passphrase (binary data)
 586  * @param new_passphrase passphrase for new keyslot, @e NULL for query
 587  * @param new_passphrase_size size of @e new_passphrase (binary data)
 588  *
 589  * @return allocated key slot number or negative errno otherwise.
 590  */
 591 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
 592         int keyslot,
 593         const char *passphrase,
 594         size_t passphrase_size,
 595         const char *new_passphrase,
 596         size_t new_passphrase_size);
 597
 598 /**
 599 * Add key slot using provided key file path
 600  *
 601  * @pre @e cd contains initialized and formatted LUKS device context
 602  *
 603  * @param cd crypt device handle
 604  * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
 605  * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
 606  * @param keyfile_size number of bytes to read from keyfile, @e 0 is unlimited
 607  * @param keyfile_offset number of bytes to skip at start of keyfile
 608  * @param new_keyfile keyfile for new keyslot, @e NULL for passphrase query
 609  * @param new_keyfile_size number of bytes to read from @e new_keyfile, @e 0 is unlimited
 610  * @param new_keyfile_offset number of bytes to skip at start of new_keyfile
 611  *
 612  * @return allocated key slot number or negative errno otherwise.
 613  *
 614  * @note Note that @e keyfile can be "-" for STDIN
 615  *
 616  */
 617 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
 618         int keyslot,
 619         const char *keyfile,
 620         size_t keyfile_size,
 621         size_t keyfile_offset,
 622         const char *new_keyfile,
 623         size_t new_keyfile_size,
 624         size_t new_keyfile_offset);
 625 /**
 626  * Backward compatible crypt_keyslot_add_by_keyfile_offset() (without offset).
 627  */
 628 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
 629         int keyslot,
 630         const char *keyfile,
 631         size_t keyfile_size,
 632         const char *new_keyfile,
 633         size_t new_keyfile_size);
 634
 635 /**
 636  * Add key slot using provided volume key
 637  *
 638  * @pre @e cd contains initialized and formatted LUKS device context
 639  *
 640  * @param cd crypt device handle
 641  * @param keyslot requested keyslot or CRYPT_ANY_SLOT
 642  * @param volume_key provided volume key or @e NULL if used after crypt_format
 643  * @param volume_key_size size of volume_key
 644  * @param passphrase passphrase for new keyslot, @e NULL for query
 645  * @param passphrase_size size of passphrase
 646  *
 647  * @return allocated key slot number or negative errno otherwise.
 648  *
 649  */
 650 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
 651         int keyslot,
 652         const char *volume_key,
 653         size_t volume_key_size,
 654         const char *passphrase,
 655         size_t passphrase_size);
 656
 657 /**
 658  * Destroy (and disable) key slot
 659  *
 660  * @pre @e cd contains initialized and formatted LUKS device context
 661  *
 662  * @param cd crypt device handle
 663  * @param keyslot requested key slot to destroy
 664  *
 665  * @return @e 0 on success or negative errno value otherwise.
 666  *
 667  * @note Note that there is no passphrase verification used.
 668  */
 669 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot);
 670
 671 /** @} */
 672
 673 /**
 674  * @defgroup aflags "Device runtime attributes"
 675  *
 676  * Activation flags
 677  *
 678  * @addtogroup aflags
 679  * @{
 680  *
 681  */
 682 /** device is read only */
 683 #define CRYPT_ACTIVATE_READONLY (1 << 0)
 684 /** only reported for device without uuid */
 685 #define CRYPT_ACTIVATE_NO_UUID  (1 << 1)
 686 /** activate even if cannot grant exclusive access (DANGEROUS) */
 687 #define CRYPT_ACTIVATE_SHARED   (1 << 2)
 688 /** enable discards aka TRIM */
 689 #define CRYPT_ACTIVATE_ALLOW_DISCARDS (1 << 3)
 690 /** skip global udev rules in activation ("private device"), input only */
 691 #define CRYPT_ACTIVATE_PRIVATE (1 << 4)
 692 /** corruption detected (verity), output only */
 693 #define CRYPT_ACTIVATE_CORRUPTED (1 << 5)
 694
 695 /**
 696  * Active device runtime attributes
 697  */
 698 struct crypt_active_device {
 699         uint64_t offset; /**< offset in sectors */
 700         uint64_t iv_offset; /**< IV initialization sector */
 701         uint64_t size; /**< active device size */
 702         uint32_t flags; /**< activation flags */
 703 };
 704
 705 /**
 706  * Receives runtime attributes of active crypt device
 707  *
 708  * @param cd crypt device handle (can be @e NULL)
 709  * @param name name of active device
 710  * @param cad preallocated active device attributes to fill
 711  *
 712  * @return @e 0 on success or negative errno value otherwise
 713  *
 714  */
 715 int crypt_get_active_device(struct crypt_device *cd,
 716                             const char *name,
 717                             struct crypt_active_device *cad);
 718
 719 /** @} */
 720
 721 /**
 722  * Activate device or check passphrase
 723  *
 724  * @param cd crypt device handle
 725  * @param name name of device to create, if @e NULL only check passphrase
 726  * @param keyslot requested keyslot to check or @e CRYPT_ANY_SLOT
 727  * @param passphrase passphrase used to unlock volume key, @e NULL for query
 728  * @param passphrase_size size of @e passphrase
 729  * @param flags activation flags
 730  *
 731  * @return unlocked key slot number or negative errno otherwise.
 732  */
 733 int crypt_activate_by_passphrase(struct crypt_device *cd,
 734         const char *name,
 735         int keyslot,
 736         const char *passphrase,
 737         size_t passphrase_size,
 738         uint32_t flags);
 739
 740 /**
 741  * Activate device or check using key file
 742  *
 743  * @param cd crypt device handle
 744  * @param name name of device to create, if @e NULL only check keyfile
 745  * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
 746  * @param keyfile key file used to unlock volume key
 747  * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
 748  * @param keyfile_offset number of bytes to skip at start of keyfile
 749  * @param flags activation flags
 750  *
 751  * @return unlocked key slot number or negative errno otherwise.
 752  */
 753 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
 754         const char *name,
 755         int keyslot,
 756         const char *keyfile,
 757         size_t keyfile_size,
 758         size_t keyfile_offset,
 759         uint32_t flags);
 760 /**
 761  * Backward compatible crypt_activate_by_keyfile_offset() (without offset).
 762  */
 763 int crypt_activate_by_keyfile(struct crypt_device *cd,
 764         const char *name,
 765         int keyslot,
 766         const char *keyfile,
 767         size_t keyfile_size,
 768         uint32_t flags);
 769
 770 /**
 771  * Activate device using provided volume key
 772  *
 773  *
 774  * @param cd crypt device handle
 775  * @param name name of device to create, if @e NULL only check volume key
 776  * @param volume_key provided volume key (or @e NULL to use internal)
 777  * @param volume_key_size size of volume_key
 778  * @param flags activation flags
 779  *
 780  * @return @e 0 on success or negative errno value otherwise.
 781  *
 782  * @note If @e NULL is used for volume_key, device has to be initialized
 783  *       by previous operation (like @ref crypt_format
 784  *       or @ref crypt_init_by_name)
 785  * @note For VERITY the volume key means root hash required for activation.
 786  *       Because kernel dm-verity is always read only, you have to provide
 787  *       CRYPT_ACTIVATE_READONLY flag always.
 788  */
 789 int crypt_activate_by_volume_key(struct crypt_device *cd,
 790         const char *name,
 791         const char *volume_key,
 792         size_t volume_key_size,
 793         uint32_t flags);
 794
 795 /**
 796  * Deactivate crypt device. This function tries to remove active device-mapper
 797  * mapping from kernel. Also, sensitive data like the volume key are removed from
 798  * memory
 799  *
 800  * @param cd crypt device handle, can be @e NULL
 801  * @param name name of device to deactivate
 802  *
 803  * @return @e 0 on success or negative errno value otherwise.
 804  *
 805  */
 806 int crypt_deactivate(struct crypt_device *cd, const char *name);
 807
 808 /**
 809  * Get volume key from of crypt device
 810  *
 811  * @param cd crypt device handle
 812  * @param keyslot use this keyslot or @e CRYPT_ANY_SLOT
 813  * @param volume_key buffer for volume key
 814  * @param volume_key_size on input, size of buffer @e volume_key,
 815  *        on output size of @e volume_key
 816  * @param passphrase passphrase used to unlock volume key
 817  * @param passphrase_size size of @e passphrase
 818  *
 819  * @return unlocked key slot number or negative errno otherwise.
 820  */
 821 int crypt_volume_key_get(struct crypt_device *cd,
 822         int keyslot,
 823         char *volume_key,
 824         size_t *volume_key_size,
 825         const char *passphrase,
 826         size_t passphrase_size);
 827
 828 /**
 829  * Verify that provided volume key is valid for crypt device
 830  *
 831  * @param cd crypt device handle
 832  * @param volume_key provided volume key
 833  * @param volume_key_size size of @e volume_key
 834  *
 835  * @return @e 0 on success or negative errno value otherwise.
 836  */
 837 int crypt_volume_key_verify(struct crypt_device *cd,
 838         const char *volume_key,
 839         size_t volume_key_size);
 840
 841 /**
 842  * @defgroup devstat "Crypt and Verity device status"
 843  * @addtogroup devstat
 844  * @{
 845  */
 846
 847 /**
 848  * Device status
 849  */
 850 typedef enum {
 851         CRYPT_INVALID, /**< device mapping is invalid in this context */
 852         CRYPT_INACTIVE, /**< no such mapped device */
 853         CRYPT_ACTIVE, /**< device is active */
 854         CRYPT_BUSY /**< device is active and has open count > 0 */
 855 } crypt_status_info;
 856
 857 /**
 858  * Get status info about device name
 859  *
 860  * @param cd crypt device handle, can be @e NULL
 861  * @param name crypt device name
 862  *
 863  * @return value defined by crypt_status_info.
 864  *
 865  */
 866 crypt_status_info crypt_status(struct crypt_device *cd, const char *name);
 867
 868 /**
 869  * Dump text-formatted information about crypt or verity device to log output
 870  *
 871  * @param cd crypt device handle
 872  *
 873  * @return @e 0 on success or negative errno value otherwise.
 874  */
 875 int crypt_dump(struct crypt_device *cd);
 876
 877 /**
 878  * Informational benchmark for ciphers
 879  *
 880  * @param cd crypt device handle
 881  * @param cipher (e.g. "aes")
 882  * @param cipher_mode (e.g. "xts"), IV generator is ignored
 883  * @param volume_key_size size of volume key in bytes
 884  * @param iv_size size of IV in bytes
 885  * @param buffer_size size of encryption buffer in bytes used in test
 886  * @param encryption_mbs measured encryption speed in MiB/s
 887  * @param decryption_mbs measured decryption speed in MiB/s
 888  *
 889  * @return @e 0 on success or negative errno value otherwise.
 890  */
 891 int crypt_benchmark(struct crypt_device *cd,
 892         const char *cipher,
 893         const char *cipher_mode,
 894         size_t volume_key_size,
 895         size_t iv_size,
 896         size_t buffer_size,
 897         double *encryption_mbs,
 898         double *decryption_mbs);
 899
 900 /**
 901  * Get cipher used in device
 902  *
 903  * @param cd crypt device handle
 904  *
 905  * @return used cipher, e.g. "aes" or @e NULL otherwise
 906  *
 907  */
 908 const char *crypt_get_cipher(struct crypt_device *cd);
 909
 910 /**
 911  * Get cipher mode used in device
 912  *
 913  * @param cd crypt device handle
 914  *
 915  * @return used cipher mode e.g. "xts-plain" or @e otherwise
 916  *
 917  */
 918 const char *crypt_get_cipher_mode(struct crypt_device *cd);
 919
 920 /**
 921  * Get device UUID
 922  *
 923  * @param cd crypt device handle
 924  *
 925  * @return device UUID or @e NULL if not set
 926  *
 927  */
 928 const char *crypt_get_uuid(struct crypt_device *cd);
 929
 930 /**
 931  * Get path to underlaying device
 932  *
 933  * @param cd crypt device handle
 934  *
 935  * @return path to underlaying device name
 936  *
 937  */
 938 const char *crypt_get_device_name(struct crypt_device *cd);
 939
 940 /**
 941  * Get device offset in sectors where real data starts on underlying device)
 942  *
 943  * @param cd crypt device handle
 944  *
 945  * @return device offset in sectors
 946  *
 947  */
 948 uint64_t crypt_get_data_offset(struct crypt_device *cd);
 949
 950 /**
 951  * Get IV offset in sectors (skip)
 952  *
 953  * @param cd crypt device handle
 954  *
 955  * @return IV offset
 956  *
 957  */
 958 uint64_t crypt_get_iv_offset(struct crypt_device *cd);
 959
 960 /**
 961  * Get size (in bytes) of volume key for crypt device
 962  *
 963  * @param cd crypt device handle
 964  *
 965  * @return volume key size
 966  *
 967  */
 968 int crypt_get_volume_key_size(struct crypt_device *cd);
 969
 970 /**
 971  * Get device parameters for VERITY device
 972  *
 973  * @param cd crypt device handle
 974  * @param vp verity device info
 975  *
 976  * @e 0 on success or negative errno value otherwise.
 977  *
 978  */
 979 int crypt_get_verity_info(struct crypt_device *cd,
 980         struct crypt_params_verity *vp);
 981 /** @} */
 982
 983 /**
 984  * @addtogroup keyslot
 985  * @{
 986  *
 987  */
 988
 989 /**
 990  * Crypt keyslot info
 991  */
 992 typedef enum {
 993         CRYPT_SLOT_INVALID, /**< invalid keyslot */
 994         CRYPT_SLOT_INACTIVE, /**< keyslot is inactive (free) */
 995         CRYPT_SLOT_ACTIVE, /**< keyslot is active (used) */
 996         CRYPT_SLOT_ACTIVE_LAST /**< keylost is active (used)
 997                                 *   and last used at the same time */
 998 } crypt_keyslot_info;
 999
1000 /**
1001  * Get information about particular key slot
1002  *
1003  *
1004  * @param cd crypt device handle
1005  * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
1006  *
1007  * @return value defined by crypt_keyslot_info
1008  *
1009  */
1010 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot);
1011 /** @} */
1012
1013 /**
1014  * Get number of keyslots supported for device type.
1015  *
1016  * @param type crypt device type
1017  *
1018  * @return slot count or negative errno otherwise if device
1019  * doesn't not support keyslots.
1020  */
1021 int crypt_keyslot_max(const char *type);
1022
1023 /**
1024  * Get keyslot area pointers (relative to metadata device)
1025  *
1026  * @param cd crypt device handle
1027  * @param keyslot keyslot number
1028  * @param offset offset on metadata device (in bytes)
1029  * @param length length of keyslot area (in bytes)
1030  *
1031  * @return @e 0 on success or negative errno value otherwise.
1032  *
1033  */
1034 int crypt_keyslot_area(struct crypt_device *cd,
1035         int keyslot,
1036         uint64_t *offset,
1037         uint64_t *length);
1038
1039 /**
1040  * Backup header and keyslots to file
1041  *
1042  * @param cd crypt device handle
1043  * @param requested_type @link crypt_type @endlink or @e NULL for all known
1044  * @param backup_file file to backup header to
1045  *
1046  * @return @e 0 on success or negative errno value otherwise.
1047  *
1048  */
1049 int crypt_header_backup(struct crypt_device *cd,
1050         const char *requested_type,
1051         const char *backup_file);
1052
1053 /**
1054  * Restore header and keyslots from backup file
1055  *
1056  *
1057  * @param cd crypt device handle
1058  * @param requested_type @link crypt_type @endlink or @e NULL for all known
1059  * @param backup_file file to restore header from
1060  *
1061  * @return @e 0 on success or negative errno value otherwise.
1062  *
1063  */
1064 int crypt_header_restore(struct crypt_device *cd,
1065         const char *requested_type,
1066         const char *backup_file);
1067
1068 /**
1069  * Receives last reported error
1070  *
1071  * @param cd crypt device handle
1072  * @param buf buffef for message
1073  * @param size size of buffer
1074  *
1075  * @note Note that this is old API function using global context.
1076  * All error messages are reported also through log callback.
1077  */
1078 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size);
1079
1080 /**
1081  * Receives last reported error, DEPRECATED
1082  *
1083  * @param buf buffef for message
1084  * @param size size of buffer
1085  *
1086  * @note Note that this is old API function using global context.
1087  * All error messages are reported also through log callback.
1088  */
1089 void crypt_get_error(char *buf, size_t size);
1090
1091 /**
1092  * Get directory where mapped crypt devices are created
1093  *
1094  * @return the directory path
1095  */
1096 const char *crypt_get_dir(void);
1097
1098 /**
1099  * @defgroup dbg "Library debug level"
1100  *
1101  * Set library debug level
1102  *
1103  * @addtogroup dbg
1104  * @{
1105  */
1106
1107 /** Debug all */
1108 #define CRYPT_DEBUG_ALL  -1
1109 /** Debug none */
1110 #define CRYPT_DEBUG_NONE  0
1111
1112 /**
1113  * Set the debug level for library
1114  *
1115  * @param level debug level
1116  *
1117  */
1118 void crypt_set_debug_level(int level);
1119
1120 /** @} */
1121
1122 #ifdef __cplusplus
1123 }
1124 #endif
1125 #endif /* _LIBCRYPTSETUP_H */