2 * libcryptsetup - cryptsetup library
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.
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.
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.
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.
23 * @file libcryptsetup.h
24 * @brief Public cryptsetup API
26 * For more verbose examples of LUKS related use cases,
27 * please read @ref index "examples".
30 #ifndef _LIBCRYPTSETUP_H
31 #define _LIBCRYPTSETUP_H
39 struct crypt_device; /* crypt device handle */
42 * Initialize crypt device handle and check if provided device exists.
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.
51 * @return @e 0 on success or negative errno value otherwise.
53 * @note Note that logging is not initialized here, possible messages uses
54 * default log function.
56 int crypt_init(struct crypt_device **cd, const char *device);
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.
63 * @return @e 0 on success or negative errno value otherwise.
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)
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
74 * @note @link crypt_init_by_name @endlink is equivalent to calling
75 * crypt_init_by_name_and_header(cd, name, NULL);
77 int crypt_init_by_name_and_header(struct crypt_device **cd,
79 const char *header_device);
82 * This is equivalent to call
83 * @ref crypt_init_by_name_and_header "crypt_init_by_name_and_header(cd, name, NULL)"
85 * @sa crypt_init_by_name_and_header
87 int crypt_init_by_name(struct crypt_device **cd, const char *name);
90 * @defgroup loglevel "Cryptsetup logging"
92 * Set of functions and defines used in cryptsetup for
98 * @addtogroup loglevel
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
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
120 void crypt_set_log_callback(struct crypt_device *cd,
121 void (*log)(int level, const char *msg, void *usrptr),
125 * Defines log function or use the default one otherwise.
127 * @see crypt_set_log_callback
129 * @param cd crypt device handle
130 * @param level log level
131 * @param msg log message
133 void crypt_log(struct crypt_device *cd, int level, const char *msg);
137 * Set confirmation callback (yes/no)
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.
142 * Callback function @e confirm should return @e 0 if operation is declined,
143 * other values mean accepted.
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
150 * @note Current version of cryptsetup API requires confirmation only when UUID is being changed
152 void crypt_set_confirm_callback(struct crypt_device *cd,
153 int (*confirm)(const char *msg, void *usrptr),
157 * Set password query callback.
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).
162 * Callback should return length of password in buffer
163 * or negative errno value in case of error.
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
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)
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
187 void crypt_set_password_callback(struct crypt_device *cd,
188 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
192 * Set timeout for interactive password entry using default
195 * @param cd crypt device handle
196 * @param timeout_sec timeout in seconds
198 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec);
201 * Set number of retries in case password input has been incorrect
203 * @param cd crypt device handle
204 * @param tries the number
206 void crypt_set_password_retry(struct crypt_device *cd, int tries);
209 * Set how long should cryptsetup iterate in PBKDF2 function.
210 * Default value heads towards the iterations which takes around 1 second
212 * @param cd crypt device handle
213 * @param iteration_time_ms the time in ms
215 void crypt_set_iteration_time(struct crypt_device *cd, uint64_t iteration_time_ms);
217 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms);
220 * Set whether passphrase will be verified on input
221 * (user has to input same passphrase twice)
223 * @param cd crypt device handle
224 * @param password_verify @e 0 = false, @e !0 true
226 void crypt_set_password_verify(struct crypt_device *cd, int password_verify);
229 * Set data device (encrypted payload area device) if LUKS header is separated
231 * @param cd crypt device handle
232 * @param device path to device
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)
238 int crypt_set_data_device(struct crypt_device *cd, const char *device);
241 * @defgroup rng "Cryptsetup RNG"
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
254 * Set which RNG (random number generator) is used for generating long term key
256 * @param cd crypt device handle
257 * @param rng_type kernel random number generator to use
260 void crypt_set_rng_type(struct crypt_device *cd, int rng_type);
263 * Get which RNG (random number generator) is used for generating long term key
265 * @param cd crypt device handle
266 * @return RNG type on success or negative errno value otherwise.
269 int crypt_get_rng_type(struct crypt_device *cd);
274 * Helper to lock/unlock memory to avoid swap sensitive data to disk
276 * @param cd crypt device handle, can be @e NULL
277 * @param lock 0 to unlock otherwise lock memory
279 * @returns Value indicating whether the memory is locked (function can be called multiple times).
281 * @note Only root can do this.
282 * @note It locks/unlocks all process memory, not only crypt context.
284 int crypt_memory_lock(struct crypt_device *cd, int lock);
287 * @defgroup crypt_type "Cryptsetup on-disk format types"
289 * Set of functions, \#defines and structs related
290 * to on-disk format types
294 * @addtogroup crypt_type
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"
310 * @param cd crypt device handle
311 * @return string according to device type or @e NULL if not known.
313 const char *crypt_get_type(struct crypt_device *cd);
317 * Structure used as parameter for PLAIN device type
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 */
329 * Structure used as parameter for LUKS device type
331 * @see crypt_format, crypt_load
333 * @note during crypt_format @e data_device attribute determines
334 * if the LUKS header is separated from encrypted payload device
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 */
345 * Structure used as parameter for loop-AES device type
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 */
358 * Structure used as parameter for dm-verity device type
360 * @see crypt_format, crypt_load
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)
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 */
387 * Create (format) new crypt device (and possible header on-disk) but not activates it.
389 * @pre @e cd contains initialized and not formatted device context (device type must @b not be set)
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)
400 * @returns @e 0 on success or negative errno value otherwise.
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.
405 int crypt_format(struct crypt_device *cd,
408 const char *cipher_mode,
410 const char *volume_key,
411 size_t volume_key_size,
415 * Set new UUID for already existing device
417 * @param cd crypt device handle
418 * @param uuid requested UUID or @e NULL if it should be generated
420 * @returns 0 on success or negative errno value otherwise.
422 * @note Currently, only LUKS device type are supported
424 int crypt_set_uuid(struct crypt_device *cd,
428 * Load crypt device parameters from on-disk header
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)
434 * @returns 0 on success or negative errno value otherwise.
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
439 * @note Note that in current version load works only for LUKS device type
442 int crypt_load(struct crypt_device *cd,
443 const char *requested_type,
447 * Try to repair crypt device on-disk header if invalid
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)
453 * @returns 0 on success or negative errno value otherwise.
456 int crypt_repair(struct crypt_device *cd,
457 const char *requested_type,
461 * Resize crypt device
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
467 * @return @e 0 on success or negative errno value otherwise.
469 int crypt_resize(struct crypt_device *cd,
474 * Suspends crypt device.
476 * @param cd crypt device handle, can be @e NULL
477 * @param name name of device to suspend
479 * @return 0 on success or negative errno value otherwise.
481 * @note Only LUKS device type is supported
484 int crypt_suspend(struct crypt_device *cd,
488 * Resumes crypt device using passphrase.
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)
497 * @return unlocked key slot number or negative errno otherwise.
499 * @note Only LUKS device type is supported
501 int crypt_resume_by_passphrase(struct crypt_device *cd,
504 const char *passphrase,
505 size_t passphrase_size);
508 * Resumes crypt device using key file.
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
517 * @return unlocked key slot number or negative errno otherwise.
519 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
524 size_t keyfile_offset);
526 * Backward compatible crypt_resume_by_keyfile_offset() (without offset).
528 int crypt_resume_by_keyfile(struct crypt_device *cd,
532 size_t keyfile_size);
535 * Releases crypt device context and used memory.
537 * @param cd crypt device handle
539 void crypt_free(struct crypt_device *cd);
542 * @defgroup keyslot "Cryptsetup LUKS keyslots"
543 * @addtogroup keyslot
548 /** iterate through all keyslots and find first one that fits */
549 #define CRYPT_ANY_SLOT -1
552 * Add key slot using provided passphrase
554 * @pre @e cd contains initialized and formatted LUKS device context
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)
563 * @return allocated key slot number or negative errno otherwise.
565 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
567 const char *passphrase,
568 size_t passphrase_size,
569 const char *new_passphrase,
570 size_t new_passphrase_size);
573 * Get number of keyslots supported for device type.
575 * @param type crypt device type
577 * @return slot count or negative errno otherwise if device
578 * doesn't not support keyslots.
580 int crypt_keyslot_max(const char *type);
583 * Add key slot using provided key file path
585 * @pre @e cd contains initialized and formatted LUKS device context
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
596 * @return allocated key slot number or negative errno otherwise.
598 * @note Note that @e keyfile can be "-" for STDIN
601 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
605 size_t keyfile_offset,
606 const char *new_keyfile,
607 size_t new_keyfile_size,
608 size_t new_keyfile_offset);
610 * Backward compatible crypt_keyslot_add_by_keyfile_offset() (without offset).
612 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
616 const char *new_keyfile,
617 size_t new_keyfile_size);
620 * Add key slot using provided volume key
622 * @pre @e cd contains initialized and formatted LUKS device context
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
631 * @return allocated key slot number or negative errno otherwise.
634 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
636 const char *volume_key,
637 size_t volume_key_size,
638 const char *passphrase,
639 size_t passphrase_size);
642 * Destroy (and disable) key slot
644 * @pre @e cd contains initialized and formatted LUKS device context
646 * @param cd crypt device handle
647 * @param keyslot requested key slot to destroy
649 * @return @e 0 on success or negative errno value otherwise.
651 * @note Note that there is no passphrase verification used.
653 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot);
658 * @defgroup aflags "Device runtime attributes"
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)
680 * Active device runtime attributes
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 */
690 * Receives runtime attributes of active crypt device
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
696 * @return @e 0 on success or negative errno value otherwise
699 int crypt_get_active_device(struct crypt_device *cd,
701 struct crypt_active_device *cad);
706 * Activate device or check passphrase
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
715 * @return unlocked key slot number or negative errno otherwise.
717 int crypt_activate_by_passphrase(struct crypt_device *cd,
720 const char *passphrase,
721 size_t passphrase_size,
725 * Activate device or check using key file
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
735 * @return unlocked key slot number or negative errno otherwise.
737 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
742 size_t keyfile_offset,
745 * Backward compatible crypt_activate_by_keyfile_offset() (without offset).
747 int crypt_activate_by_keyfile(struct crypt_device *cd,
755 * Activate device using provided volume key
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
764 * @return @e 0 on success or negative errno value otherwise.
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)
770 int crypt_activate_by_volume_key(struct crypt_device *cd,
772 const char *volume_key,
773 size_t volume_key_size,
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
781 * @param cd crypt device handle, can be @e NULL
782 * @param name name of device to deactivate
784 * @return @e 0 on success or negative errno value otherwise.
787 int crypt_deactivate(struct crypt_device *cd, const char *name);
790 * Get volume key from of crypt device
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
800 * @return unlocked key slot number or negative errno otherwise.
802 int crypt_volume_key_get(struct crypt_device *cd,
805 size_t *volume_key_size,
806 const char *passphrase,
807 size_t passphrase_size);
810 * Verify that provided volume key is valid for crypt device
812 * @param cd crypt device handle
813 * @param volume_key provided volume key
814 * @param volume_key_size size of @e volume_key
816 * @return @e 0 on success or negative errno value otherwise.
818 int crypt_volume_key_verify(struct crypt_device *cd,
819 const char *volume_key,
820 size_t volume_key_size);
824 * @defgroup devstat "dmcrypt device status"
825 * @addtogroup devstat
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 */
840 * Get status info about device name
842 * @param cd crypt device handle, can be @e NULL
843 * @param name crypt device name
845 * @return value defined by crypt_status_info.
848 crypt_status_info crypt_status(struct crypt_device *cd, const char *name);
851 * Dump text-formatted information about crypt device to log output
853 * @param cd crypt device handle
855 * @return @e 0 on success or negative errno value otherwise.
857 int crypt_dump(struct crypt_device *cd);
860 * Get cipher used in device
862 * @param cd crypt device handle
864 * @return used cipher, e.g. "aes" or @e NULL otherwise
867 const char *crypt_get_cipher(struct crypt_device *cd);
870 * Get cipher mode used in device
872 * @param cd crypt device handle
874 * @return used cipher mode e.g. "xts-plain" or @e otherwise
877 const char *crypt_get_cipher_mode(struct crypt_device *cd);
882 * @param cd crypt device handle
884 * @return device UUID or @e NULL if not set
887 const char *crypt_get_uuid(struct crypt_device *cd);
890 * Get path to underlaying device
892 * @param cd crypt device handle
894 * @return path to underlaying device name
897 const char *crypt_get_device_name(struct crypt_device *cd);
900 * Get device offset in sectors where real data starts on underlying device)
902 * @param cd crypt device handle
904 * @return device offset in sectors
907 uint64_t crypt_get_data_offset(struct crypt_device *cd);
910 * Get IV offset in sectors (skip)
912 * @param cd crypt device handle
917 uint64_t crypt_get_iv_offset(struct crypt_device *cd);
920 * Get size (in bytes) of volume key for crypt device
922 * @param cd crypt device handle
924 * @return volume key size
927 int crypt_get_volume_key_size(struct crypt_device *cd);
930 * Get device paramaters for CRYPT_VERITY device
932 * @param cd crypt device handle
933 * @param vp verity device info
935 * @e 0 on success or negative errno value otherwise.
938 int crypt_get_verity_info(struct crypt_device *cd,
939 struct crypt_params_verity *vp);
942 * @addtogroup keyslot
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;
959 * Get information about particular key slot
962 * @param cd crypt device handle
963 * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
965 * @return value defined by crypt_keyslot_info
968 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot);
972 * Backup header and keyslots to file
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
978 * @return @e 0 on success or negative errno value otherwise.
981 int crypt_header_backup(struct crypt_device *cd,
982 const char *requested_type,
983 const char *backup_file);
986 * Restore header and keyslots from backup file
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
993 * @return @e 0 on success or negative errno value otherwise.
996 int crypt_header_restore(struct crypt_device *cd,
997 const char *requested_type,
998 const char *backup_file);
1001 * Receives last reported error
1003 * @param cd crypt device handle
1004 * @param buf buffef for message
1005 * @param size size of buffer
1007 * @note Note that this is old API function using global context.
1008 * All error messages are reported also through log callback.
1010 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size);
1013 * Receives last reported error, DEPRECATED
1015 * @param buf buffef for message
1016 * @param size size of buffer
1018 * @note Note that this is old API function using global context.
1019 * All error messages are reported also through log callback.
1021 void crypt_get_error(char *buf, size_t size);
1024 * Get directory where mapped crypt devices are created
1026 * @return the directory path
1028 const char *crypt_get_dir(void);
1031 * @defgroup dbg "Library debug level"
1033 * Set library debug level
1040 #define CRYPT_DEBUG_ALL -1
1042 #define CRYPT_DEBUG_NONE 0
1045 * Set the debug level for library
1047 * @param level debug level
1050 void crypt_set_debug_level(int level);
1057 #endif /* _LIBCRYPTSETUP_H */