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
38 struct crypt_device; /* crypt device handle */
41 * Initialize crypt device handle and check if provided device exists.
43 * @param cd Returns pointer to crypt device handle
44 * @param device Path to the backing device.
45 * If @e device is not a block device but a path to some file,
46 * the function will try to create a loopdevice and attach
47 * the file to the loopdevice with AUTOCLEAR flag set.
48 * If @e device is @e NULL function it will initialize dm backend only.
50 * @return @e 0 on success or negative errno value otherwise.
52 * @note Note that logging is not initialized here, possible messages uses
53 * default log function.
55 int crypt_init(struct crypt_device **cd, const char *device);
58 * Initialize crypt device handle from provided active device name,
59 * and, optionally, from separate metadata (header) device
60 * and check if provided device exists.
62 * @return @e 0 on success or negative errno value otherwise.
64 * @param cd returns crypt device handle for active device
65 * @param name name of active crypt device
66 * @param header_device optional device containing on-disk header
67 * (@e NULL if it the same as underlying device on there is no on-disk header)
69 * @post In case @e device points to active LUKS device but header load fails,
70 * context device type is set to @e NULL and @e 0 is returned as if it were successful.
71 * Context with @e NULL device type can only be deactivated by crypt_deactivate
73 * @note @link crypt_init_by_name @endlink is equivalent to calling
74 * crypt_init_by_name_and_header(cd, name, NULL);
76 int crypt_init_by_name_and_header(struct crypt_device **cd,
78 const char *header_device);
81 * This is equivalent to call
82 * @ref crypt_init_by_name_and_header "crypt_init_by_name_and_header(cd, name, NULL)"
84 * @sa crypt_init_by_name_and_header
86 int crypt_init_by_name(struct crypt_device **cd, const char *name);
89 * @defgroup loglevel "Cryptsetup logging"
91 * Set of functions and defines used in cryptsetup for
97 * @addtogroup loglevel
101 /** normal log level */
102 #define CRYPT_LOG_NORMAL 0
103 /** error log level */
104 #define CRYPT_LOG_ERROR 1
105 /** verbose log level */
106 #define CRYPT_LOG_VERBOSE 2
107 /** debug log level - always on stdout */
108 #define CRYPT_LOG_DEBUG -1
113 * @param cd crypt device handle (can be @e NULL to set default log function)
114 * @param log user defined log function reference
115 * @param usrptr provided identification in callback
116 * @param level log level below (debug messages can uses other levels)
117 * @param msg log message
119 void crypt_set_log_callback(struct crypt_device *cd,
120 void (*log)(int level, const char *msg, void *usrptr),
124 * Defines log function or use the default one otherwise.
126 * @see crypt_set_log_callback
128 * @param cd crypt device handle
129 * @param level log level
130 * @param msg log message
132 void crypt_log(struct crypt_device *cd, int level, const char *msg);
136 * Set confirmation callback (yes/no)
138 * If code need confirmation (like resetting uuid or restoring LUKS header from file)
139 * this function is called. If not defined, everything is confirmed.
141 * Callback function @e confirm should return @e 0 if operation is declined,
142 * other values mean accepted.
144 * @param cd crypt device handle
145 * @param confirm user defined confirm callback reference
146 * @param usrptr provided identification in callback
147 * @param msg Message for user to confirm
149 * @note Current version of cryptsetup API requires confirmation only when UUID is being changed
151 void crypt_set_confirm_callback(struct crypt_device *cd,
152 int (*confirm)(const char *msg, void *usrptr),
156 * Set password query callback.
158 * If code need @e _interactive_ query for password, this callback is called.
159 * If not defined, compiled-in default is called (uses terminal input).
161 * Callback should return length of password in buffer
162 * or negative errno value in case of error.
164 * @param cd crypt device handle
165 * @param password user defined password callback reference
166 * @param usrptr provided identification in callback
167 * @param msg Message for user
168 * @param buf buffer for password
169 * @param length size of buffer
171 * @note Note that if this function is defined, verify option is ignored
172 * (caller which provided callback is responsible for password verification)
173 * @note Only zero terminated passwords can be entered this way, for complex
174 * use API functions directly.
175 * @note Maximal length of password is limited to @e length @e - @e 1 (minimal 511 chars)
177 * @see Callback function is used in these call provided, that certain conditions are met:
178 * @li crypt_keyslot_add_by_passphrase
179 * @li crypt_activate_by_passphrase
180 * @li crypt_resume_by_passphrase
181 * @li crypt_resume_by_keyfile
182 * @li crypt_keyslot_add_by_keyfile
183 * @li crypt_keyslot_add_by_volume_key
186 void crypt_set_password_callback(struct crypt_device *cd,
187 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
191 * Set timeout for interactive password entry using default
194 * @param cd crypt device handle
195 * @param timeout_sec timeout in seconds
197 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec);
200 * Set number of retries in case password input has been incorrect
202 * @param cd crypt device handle
203 * @param tries the number
205 void crypt_set_password_retry(struct crypt_device *cd, int tries);
208 * Set how long should cryptsetup iterate in PBKDF2 function.
209 * Default value heads towards the iterations which takes around 1 second
211 * @param cd crypt device handle
212 * @param iteration_time_ms the time in ms
214 void crypt_set_iteration_time(struct crypt_device *cd, uint64_t iteration_time_ms);
216 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms);
219 * Set whether passphrase will be verified on input
220 * (user has to input same passphrase twice)
222 * @param cd crypt device handle
223 * @param password_verify @e 0 = false, @e !0 true
225 void crypt_set_password_verify(struct crypt_device *cd, int password_verify);
228 * Set data device (encrypted payload area device) if LUKS header is separated
230 * @param cd crypt device handle
231 * @param device path to device
233 * @pre context is of LUKS type
234 * @pre unlike @ref crypt_init, in this function param @e device
235 * has to be block device (at least 512B large)
237 int crypt_set_data_device(struct crypt_device *cd, const char *device);
240 * @defgroup rng "Cryptsetup RNG"
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
253 * Set which RNG (random number generator) is used for generating long term key
255 * @param cd crypt device handle
256 * @param rng_type kernel random number generator to use
259 void crypt_set_rng_type(struct crypt_device *cd, int rng_type);
262 * Get which RNG (random number generator) is used for generating long term key
264 * @param cd crypt device handle
265 * @return RNG type on success or negative errno value otherwise.
268 int crypt_get_rng_type(struct crypt_device *cd);
273 * Helper to lock/unlock memory to avoid swap sensitive data to disk
275 * @param cd crypt device handle, can be @e NULL
276 * @param lock 0 to unlock otherwise lock memory
278 * @returns Value indicating whether the memory is locked (function can be called multiple times).
280 * @note Only root can do this.
281 * @note It locks/unlocks all process memory, not only crypt context.
283 int crypt_memory_lock(struct crypt_device *cd, int lock);
286 * @defgroup crypt_type "Cryptsetup on-disk format types"
288 * Set of functions, \#defines and structs related
289 * to on-disk format types
293 * @addtogroup crypt_type
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"
307 * @param cd crypt device handle
308 * @return string according to device type or @e NULL if not known.
310 const char *crypt_get_type(struct crypt_device *cd);
314 * Structure used as parameter for PLAIN device type
318 struct crypt_params_plain {
319 const char *hash; /**< password hash function */
320 uint64_t offset; /**< offset in sectors */
321 uint64_t skip; /**< IV offset / initialization sector */
322 uint64_t size; /**< size of mapped device or @e 0 for autodetection */
326 * Structure used as parameter for LUKS device type
328 * @see crypt_format, crypt_load
330 * @note during crypt_format @e data_device attribute determines
331 * if the LUKS header is separated from encrypted payload device
334 struct crypt_params_luks1 {
335 const char *hash; /**< hash used in LUKS header */
336 size_t data_alignment; /**< data alignment in sectors, data offset is multiple of this */
337 const char *data_device; /**< detached encrypted data device or @e NULL */
342 * Structure used as parameter for loop-AES device type
347 struct crypt_params_loopaes {
348 const char *hash; /**< key hash function */
349 uint64_t offset; /**< offset in sectors */
350 uint64_t skip; /**< IV offset / initialization sector */
356 * Create (format) new crypt device (and possible header on-disk) but not activates it.
358 * @pre @e cd contains initialized and not formatted device context (device type must @b not be set)
360 * @param cd crypt device handle
361 * @param type type of device (optional params struct must be of this type)
362 * @param cipher (e.g. "aes")
363 * @param cipher_mode including IV specification (e.g. "xts-plain")
364 * @param uuid requested UUID or @e NULL if it should be generated
365 * @param volume_key pre-generated volume key or @e NULL if it should be generated (only for LUKS)
366 * @param volume_key_size size of volume key in bytes.
367 * @param params crypt type specific parameters (see @link crypt_type @endlink)
369 * @returns @e 0 on success or negative errno value otherwise.
371 * @note Note that crypt_format does not enable any keyslot (in case of work with LUKS device), but it stores volume key internally
372 * and subsequent crypt_keyslot_add_* calls can be used.
374 int crypt_format(struct crypt_device *cd,
377 const char *cipher_mode,
379 const char *volume_key,
380 size_t volume_key_size,
384 * Set new UUID for already existing device
386 * @param cd crypt device handle
387 * @param uuid requested UUID or @e NULL if it should be generated
389 * @returns 0 on success or negative errno value otherwise.
391 * @note Currently, only LUKS device type are supported
393 int crypt_set_uuid(struct crypt_device *cd,
397 * Load crypt device parameters from on-disk header
399 * @param cd crypt device handle
400 * @param requested_type @link crypt_type @endlink or @e NULL for all known
401 * @param params crypt type specific parameters (see @link crypt_type @endlink)
403 * @returns 0 on success or negative errno value otherwise.
405 * @post In case LUKS header is read successfully but payload device is too small
406 * error is returned and device type in context is set to @e NULL
408 * @note Note that in current version load works only for LUKS device type
411 int crypt_load(struct crypt_device *cd,
412 const char *requested_type,
416 * Try to repair crypt device on-disk header if invalid
418 * @param cd crypt device handle
419 * @param requested_type @link crypt_type @endlink or @e NULL for all known
420 * @param params crypt type specific parameters (see @link crypt_type @endlink)
422 * @returns 0 on success or negative errno value otherwise.
425 int crypt_repair(struct crypt_device *cd,
426 const char *requested_type,
430 * Resize crypt device
432 * @param cd - crypt device handle
433 * @param name - name of device to resize
434 * @param new_size - new device size in sectors or @e 0 to use all of the underlying device size
436 * @return @e 0 on success or negative errno value otherwise.
438 int crypt_resize(struct crypt_device *cd,
443 * Suspends crypt device.
445 * @param cd crypt device handle, can be @e NULL
446 * @param name name of device to suspend
448 * @return 0 on success or negative errno value otherwise.
450 * @note Only LUKS device type is supported
453 int crypt_suspend(struct crypt_device *cd,
457 * Resumes crypt device using passphrase.
460 * @param cd crypt device handle
461 * @param name name of device to resume
462 * @param keyslot requested keyslot or CRYPT_ANY_SLOT
463 * @param passphrase passphrase used to unlock volume key, @e NULL for query
464 * @param passphrase_size size of @e passphrase (binary data)
466 * @return unlocked key slot number or negative errno otherwise.
468 * @note Only LUKS device type is supported
470 int crypt_resume_by_passphrase(struct crypt_device *cd,
473 const char *passphrase,
474 size_t passphrase_size);
477 * Resumes crypt device using key file.
479 * @param cd crypt device handle
480 * @param name name of device to resume
481 * @param keyslot requested keyslot or CRYPT_ANY_SLOT
482 * @param keyfile key file used to unlock volume key, @e NULL for passphrase query
483 * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
484 * @param keyfile_offset number of bytes to skip at start of keyfile
486 * @return unlocked key slot number or negative errno otherwise.
488 int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
493 size_t keyfile_offset);
495 * Backward compatible crypt_resume_by_keyfile_offset() (without offset).
497 int crypt_resume_by_keyfile(struct crypt_device *cd,
501 size_t keyfile_size);
504 * Releases crypt device context and used memory.
506 * @param cd crypt device handle
508 void crypt_free(struct crypt_device *cd);
511 * @defgroup keyslot "Cryptsetup LUKS keyslots"
512 * @addtogroup keyslot
517 /** iterate through all keyslots and find first one that fits */
518 #define CRYPT_ANY_SLOT -1
521 * Add key slot using provided passphrase
523 * @pre @e cd contains initialized and formatted LUKS device context
525 * @param cd crypt device handle
526 * @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
527 * @param passphrase passphrase used to unlock volume key, @e NULL for query
528 * @param passphrase_size size of passphrase (binary data)
529 * @param new_passphrase passphrase for new keyslot, @e NULL for query
530 * @param new_passphrase_size size of @e new_passphrase (binary data)
532 * @return allocated key slot number or negative errno otherwise.
534 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
536 const char *passphrase,
537 size_t passphrase_size,
538 const char *new_passphrase,
539 size_t new_passphrase_size);
542 * Get number of keyslots supported for device type.
544 * @param type crypt device type
546 * @return slot count or negative errno otherwise if device
547 * doesn't not support keyslots.
549 int crypt_keyslot_max(const char *type);
552 * Add key slot using provided key file path
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 keyfile key file used to unlock volume key, @e NULL for passphrase query
559 * @param keyfile_size number of bytes to read from keyfile, @e 0 is unlimited
560 * @param keyfile_offset number of bytes to skip at start of keyfile
561 * @param new_keyfile keyfile for new keyslot, @e NULL for passphrase query
562 * @param new_keyfile_size number of bytes to read from @e new_keyfile, @e 0 is unlimited
563 * @param new_keyfile_offset number of bytes to skip at start of new_keyfile
565 * @return allocated key slot number or negative errno otherwise.
567 * @note Note that @e keyfile can be "-" for STDIN
570 int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
574 size_t keyfile_offset,
575 const char *new_keyfile,
576 size_t new_keyfile_size,
577 size_t new_keyfile_offset);
579 * Backward compatible crypt_keyslot_add_by_keyfile_offset() (without offset).
581 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
585 const char *new_keyfile,
586 size_t new_keyfile_size);
589 * Add key slot using provided volume key
591 * @pre @e cd contains initialized and formatted LUKS device context
593 * @param cd crypt device handle
594 * @param keyslot requested keyslot or CRYPT_ANY_SLOT
595 * @param volume_key provided volume key or @e NULL if used after crypt_format
596 * @param volume_key_size size of volume_key
597 * @param passphrase passphrase for new keyslot, @e NULL for query
598 * @param passphrase_size size of passphrase
600 * @return allocated key slot number or negative errno otherwise.
603 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
605 const char *volume_key,
606 size_t volume_key_size,
607 const char *passphrase,
608 size_t passphrase_size);
611 * Destroy (and disable) key slot
613 * @pre @e cd contains initialized and formatted LUKS device context
615 * @param cd crypt device handle
616 * @param keyslot requested key slot to destroy
618 * @return @e 0 on success or negative errno value otherwise.
620 * @note Note that there is no passphrase verification used.
622 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot);
627 * @defgroup aflags "Device runtime attributes"
635 /** device is read only */
636 #define CRYPT_ACTIVATE_READONLY (1 << 0)
637 /** only reported for device without uuid */
638 #define CRYPT_ACTIVATE_NO_UUID (1 << 1)
639 /** activate more non-overlapping mapping to the same device */
640 #define CRYPT_ACTIVATE_SHARED (1 << 2)
641 /** enable discards aka TRIM */
642 #define CRYPT_ACTIVATE_ALLOW_DISCARDS (1 << 3)
645 * Active device runtime attributes
647 struct crypt_active_device {
648 uint64_t offset; /**< offset in sectors */
649 uint64_t iv_offset; /**< IV initialization sector */
650 uint64_t size; /**< active device size */
651 uint32_t flags; /**< activation flags */
655 * Receives runtime attributes of active crypt device
657 * @param cd crypt device handle (can be @e NULL)
658 * @param name name of active device
659 * @param cad preallocated active device attributes to fill
661 * @return @e 0 on success or negative errno value otherwise
664 int crypt_get_active_device(struct crypt_device *cd,
666 struct crypt_active_device *cad);
671 * Activate device or check passphrase
673 * @param cd crypt device handle
674 * @param name name of device to create, if @e NULL only check passphrase
675 * @param keyslot requested keyslot to check or @e CRYPT_ANY_SLOT
676 * @param passphrase passphrase used to unlock volume key, @e NULL for query
677 * @param passphrase_size size of @e passphrase
678 * @param flags activation flags
680 * @return unlocked key slot number or negative errno otherwise.
682 int crypt_activate_by_passphrase(struct crypt_device *cd,
685 const char *passphrase,
686 size_t passphrase_size,
690 * Activate device or check using key file
692 * @param cd crypt device handle
693 * @param name name of device to create, if @e NULL only check keyfile
694 * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
695 * @param keyfile key file used to unlock volume key
696 * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
697 * @param keyfile_offset number of bytes to skip at start of keyfile
698 * @param flags activation flags
700 * @return unlocked key slot number or negative errno otherwise.
702 int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
707 size_t keyfile_offset,
710 * Backward compatible crypt_activate_by_keyfile_offset() (without offset).
712 int crypt_activate_by_keyfile(struct crypt_device *cd,
720 * Activate device using provided volume key
723 * @param cd crypt device handle
724 * @param name name of device to create, if @e NULL only check volume key
725 * @param volume_key provided volume key (or @e NULL to use internal)
726 * @param volume_key_size size of volume_key
727 * @param flags activation flags
729 * @return @e 0 on success or negative errno value otherwise.
731 * @note If @e NULL is used for volume_key, device has to be initialized
732 * by previous operation (like @ref crypt_format
733 * or @ref crypt_init_by_name)
735 int crypt_activate_by_volume_key(struct crypt_device *cd,
737 const char *volume_key,
738 size_t volume_key_size,
742 * Deactivate crypt device. This function tries to remove active device-mapper
743 * mapping from kernel. Also, sensitive data like the volume key are removed from
746 * @param cd crypt device handle, can be @e NULL
747 * @param name name of device to deactivate
749 * @return @e 0 on success or negative errno value otherwise.
752 int crypt_deactivate(struct crypt_device *cd, const char *name);
755 * Get volume key from of crypt device
757 * @param cd crypt device handle
758 * @param keyslot use this keyslot or @e CRYPT_ANY_SLOT
759 * @param volume_key buffer for volume key
760 * @param volume_key_size on input, size of buffer @e volume_key,
761 * on output size of @e volume_key
762 * @param passphrase passphrase used to unlock volume key
763 * @param passphrase_size size of @e passphrase
765 * @return unlocked key slot number or negative errno otherwise.
767 int crypt_volume_key_get(struct crypt_device *cd,
770 size_t *volume_key_size,
771 const char *passphrase,
772 size_t passphrase_size);
775 * Verify that provided volume key is valid for crypt device
777 * @param cd crypt device handle
778 * @param volume_key provided volume key
779 * @param volume_key_size size of @e volume_key
781 * @return @e 0 on success or negative errno value otherwise.
783 int crypt_volume_key_verify(struct crypt_device *cd,
784 const char *volume_key,
785 size_t volume_key_size);
789 * @defgroup devstat "dmcrypt device status"
790 * @addtogroup devstat
798 CRYPT_INVALID, /**< device mapping is invalid in this context */
799 CRYPT_INACTIVE, /**< no such mapped device */
800 CRYPT_ACTIVE, /**< device is active */
801 CRYPT_BUSY /**< device is active and has open count > 0 */
805 * Get status info about device name
807 * @param cd crypt device handle, can be @e NULL
808 * @param name crypt device name
810 * @return value defined by crypt_status_info.
813 crypt_status_info crypt_status(struct crypt_device *cd, const char *name);
816 * Dump text-formatted information about crypt device to log output
818 * @param cd crypt device handle
820 * @return @e 0 on success or negative errno value otherwise.
822 int crypt_dump(struct crypt_device *cd);
825 * Get cipher used in device
827 * @param cd crypt device handle
829 * @return used cipher, e.g. "aes" or @e NULL otherwise
832 const char *crypt_get_cipher(struct crypt_device *cd);
835 * Get cipher mode used in device
837 * @param cd crypt device handle
839 * @return used cipher mode e.g. "xts-plain" or @e otherwise
842 const char *crypt_get_cipher_mode(struct crypt_device *cd);
847 * @param cd crypt device handle
849 * @return device UUID or @e NULL if not set
852 const char *crypt_get_uuid(struct crypt_device *cd);
855 * Get path to underlaying device
857 * @param cd crypt device handle
859 * @return path to underlaying device name
862 const char *crypt_get_device_name(struct crypt_device *cd);
865 * Get device offset in sectors where real data starts on underlying device)
867 * @param cd crypt device handle
869 * @return device offset in sectors
872 uint64_t crypt_get_data_offset(struct crypt_device *cd);
875 * Get IV offset in sectors (skip)
877 * @param cd crypt device handle
882 uint64_t crypt_get_iv_offset(struct crypt_device *cd);
885 * Get size (in bytes) of volume key for crypt device
887 * @param cd crypt device handle
889 * @return volume key size
892 int crypt_get_volume_key_size(struct crypt_device *cd);
895 * @addtogroup keyslot
904 CRYPT_SLOT_INVALID, /**< invalid keyslot */
905 CRYPT_SLOT_INACTIVE, /**< keyslot is inactive (free) */
906 CRYPT_SLOT_ACTIVE, /**< keyslot is active (used) */
907 CRYPT_SLOT_ACTIVE_LAST /**< keylost is active (used)
908 * and last used at the same time */
909 } crypt_keyslot_info;
912 * Get information about particular key slot
915 * @param cd crypt device handle
916 * @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
918 * @return value defined by crypt_keyslot_info
921 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot);
925 * Backup header and keyslots to file
927 * @param cd crypt device handle
928 * @param requested_type @link crypt_type @endlink or @e NULL for all known
929 * @param backup_file file to backup header to
931 * @return @e 0 on success or negative errno value otherwise.
934 int crypt_header_backup(struct crypt_device *cd,
935 const char *requested_type,
936 const char *backup_file);
939 * Restore header and keyslots from backup file
942 * @param cd crypt device handle
943 * @param requested_type @link crypt_type @endlink or @e NULL for all known
944 * @param backup_file file to restore header from
946 * @return @e 0 on success or negative errno value otherwise.
949 int crypt_header_restore(struct crypt_device *cd,
950 const char *requested_type,
951 const char *backup_file);
954 * Receives last reported error
956 * @param cd crypt device handle
957 * @param buf buffef for message
958 * @param size size of buffer
960 * @note Note that this is old API function using global context.
961 * All error messages are reported also through log callback.
963 void crypt_last_error(struct crypt_device *cd, char *buf, size_t size);
966 * Receives last reported error, DEPRECATED
968 * @param buf buffef for message
969 * @param size size of buffer
971 * @note Note that this is old API function using global context.
972 * All error messages are reported also through log callback.
974 void crypt_get_error(char *buf, size_t size);
977 * Get directory where mapped crypt devices are created
979 * @return the directory path
981 const char *crypt_get_dir(void);
984 * @defgroup dbg "Library debug level"
986 * Set library debug level
993 #define CRYPT_DEBUG_ALL -1
995 #define CRYPT_DEBUG_NONE 0
998 * Set the debug level for library
1000 * @param level debug level
1003 void crypt_set_debug_level(int level);
1010 #endif /* _LIBCRYPTSETUP_H */