1 #ifndef _LIBCRYPTSETUP_H
2 #define _LIBCRYPTSETUP_H
9 struct crypt_device; /* crypt device handle */
12 * Initialise crypt device handle and check if provided device exists.
14 * Returns 0 on success or negative errno value otherwise.
16 * @cd - returns pointer to crypt device handle
17 * @device - path to device
19 * Note that logging is not initialized here, possible messages uses
20 * default log function.
22 int crypt_init(struct crypt_device **cd, const char *device);
25 * Initialise crypt device handle from provided active device name
26 * and check if provided device exists.
28 * Returns 0 on success or negative errno value otherwise.
30 * @cd - crypt device handle
31 * @name - name of active crypt device
33 int crypt_init_by_name(struct crypt_device **cd, const char *name);
38 * @cd - crypt device handle (can be NULL to set default log function)
39 * @usrptr - provided identification in callback
40 * @level - log level below (debug messages can uses other levels)
43 #define CRYPT_LOG_NORMAL 0
44 #define CRYPT_LOG_ERROR 1
45 #define CRYPT_LOG_VERBOSE 2
46 #define CRYPT_LOG_DEBUG -1 /* always on stdout */
47 void crypt_set_log_callback(struct crypt_device *cd,
48 void (*log)(int level, const char *msg, void *usrptr),
52 * Log message through log function.
54 * @cd - crypt device handle
58 void crypt_log(struct crypt_device *cd, int level, const char *msg);
61 * Set confirmation callback (yes/no)
63 * If code need confirmation (like deleting last key slot) this function
64 * is called. If not defined, everything is confirmed.
66 * Calback should return 0 if operation is declined, other values mean accepted.
68 * @cd - crypt device handle
69 * @usrptr - provided identification in callback
70 * @msg - Message for user to confirm
72 void crypt_set_confirm_callback(struct crypt_device *cd,
73 int (*confirm)(const char *msg, void *usrptr),
77 * Set password query callback.
79 * If code need _interactive_ query for password, this callback is called.
80 * If not defined, compiled-in default is called (uses terminal input).
82 * @cd - crypt device handle
83 * @usrptr - provided identification in callback
84 * @msg - Message for user
85 * @buf - buffer for password
86 * @length - size of buffer
88 * - Note that if this function is defined, verify option is ignored
89 * (caller whch provided callback is responsible fo password verification)
90 * - Only zero terminated passwords can be enteted this way, for complex
91 * use API functions directly.
92 * - Maximal length of password is limited to @length-1 (minimal 511 chars)
94 void crypt_set_password_callback(struct crypt_device *cd,
95 int (*password)(const char *msg, char *buf, size_t length, void *usrptr),
99 * Various crypt device parameters
101 * @cd - crypt device handle
102 * @timeout - timeout in secons for password entry if compiled-in function used
103 * @password_retry - number of tries for password if not verified
104 * @iteration_time - iteration time for LUKS header in miliseconds
105 * @password_verify - for compiled-in password query always verify passwords twice
107 void crypt_set_timeout(struct crypt_device *cd, uint64_t timeout_sec);
108 void crypt_set_password_retry(struct crypt_device *cd, int tries);
109 void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms);
110 void crypt_set_password_verify(struct crypt_device *cd, int password_verify);
113 * Set which RNG (random number generator) is used for generating long term key
114 * @cd - crypt device handle
115 * @rng_type - kernel random number generator to use
117 * CRYPT_RNG_URANDOM - use /dev/urandom
118 * CRYPT_RNG_RANDOM - use /dev/random (waits if no entropy in system)
120 #define CRYPT_RNG_URANDOM 0
121 #define CRYPT_RNG_RANDOM 1
122 void crypt_set_rng_type(struct crypt_device *cd, int rng_type);
125 * Get which RNG (random number generator) is used for generating long term key
127 * Returns RNG type on success or negative errno value otherwise.
129 * @cd - crypt device handle
131 int crypt_get_rng_type(struct crypt_device *cd);
134 * Helper to lock/unlock memory to avoid swap sensitive data to disk
136 * @cd - crypt device handle, can be NULL
137 * @lock - 0 to unloct otherwise lock memory
139 * Return value indicates that memory is locked (function can be called multiple times).
140 * Only root can do this. Note it locks/unlocks all process memory, not only crypt context.
142 int crypt_memory_lock(struct crypt_device *cd, int lock);
144 #define CRYPT_PLAIN "PLAIN" /* regular crypt device, no on-disk header */
145 #define CRYPT_LUKS1 "LUKS1" /* LUKS version 1 header on-disk */
150 * @cd - crypt device handle
152 * Return string according to device type or NULL if not known.
154 const char *crypt_get_type(struct crypt_device *cd);
156 struct crypt_params_plain {
157 const char *hash; /* password hash function */
158 uint64_t offset; /* offset in sectors */
159 uint64_t skip; /* IV initilisation sector */
162 struct crypt_params_luks1 {
163 const char *hash; /* hash used in LUKS header */
164 size_t data_alignment; /* in sectors, data offset is multiple of this */
168 * Create (format) new crypt device (and possible header on-disk) but not activates it.
170 * Returns 0 on success or negative errno value otherwise.
172 * @cd - crypt device handle
173 * @type - type of device (optional params struct must be of this type)
174 * @cipher - (e.g. "aes")
175 * @cipher_mode - including IV specification (e.g. "xts-plain")
176 * @uuid - requested UUID or NULL if it should be generated
177 * @volume_key - pre-generated volume key or NULL if it should be generated (only for LUKS)
178 * @volume_key_size - size of volume key in bytes.
179 * @params - crypt type specific parameters
181 * Note that crypt_format do not enable any keyslot, but it stores volume key internally
182 * and subsequent crypt_keyslot_add_* calls can be used.
183 * (It is the only situation when crypt_keyslot_add_* do not require active key slots.)
185 int crypt_format(struct crypt_device *cd,
188 const char *cipher_mode,
190 const char *volume_key,
191 size_t volume_key_size,
195 * Set new UUID for already existing device (if format supports it)
197 * Returns 0 on success or negative errno value otherwise.
199 * @cd - crypt device handle
200 * @uuid - requested UUID or NULL if it should be generated
202 int crypt_set_uuid(struct crypt_device *cd,
206 * Load crypt device parameters from on-disk header
208 * Returns 0 on success or negative errno value otherwise.
210 * @cd - crypt device handle
211 * @requested_type - use NULL for all known
212 * @params - crypt type specific parameters
214 int crypt_load(struct crypt_device *cd,
215 const char *requested_type,
219 * Resize crypt device
221 * Returns 0 on success or negative errno value otherwise.
223 * @cd - crypt device handle
224 * @name - name of device to resize
225 * @new_size - new device size in sectors or 0 to use underlying device size
227 int crypt_resize(struct crypt_device *cd,
232 * Suspends crypt device.
234 * Returns 0 on success or negative errno value otherwise.
236 * @cd - crypt device handle, can be NULL
237 * @name - name of device to suspend
239 int crypt_suspend(struct crypt_device *cd,
243 * Resumes crypt device using passphrase.
245 * Returns unlocked key slot number or negative errno otherwise.
247 * @cd - crypt device handle
248 * @name - name of device to resume
249 * @keyslot - requested keyslot or CRYPT_ANY_SLOT
250 * @passphrase - passphrase used to unlock volume key, NULL for query
251 * @passphrase_size - size of @passphrase (binary data)
253 int crypt_resume_by_passphrase(struct crypt_device *cd,
256 const char *passphrase,
257 size_t passphrase_size);
260 * Resumes crypt device using key file.
262 * Returns unlocked key slot number or negative errno otherwise.
264 * @cd - crypt device handle
265 * @name - name of device to resume
266 * @keyslot - requested keyslot or CRYPT_ANY_SLOT
267 * @keyfile - key file used to unlock volume key, NULL for passphrase query
268 * @keyfile_size - number of bytes to read from @keyfile, 0 is unlimited
270 int crypt_resume_by_keyfile(struct crypt_device *cd,
274 size_t keyfile_size);
277 * Releases crypt device context and used memory.
279 * @cd - crypt device handle
281 void crypt_free(struct crypt_device *cd);
284 * Add key slot using provided passphrase
286 * Returns allocated key slot number or negative errno otherwise.
288 * @cd - crypt device handle
289 * @keyslot - requested keyslot or CRYPT_ANY_SLOT
290 * @passphrase - passphrase used to unlock volume key, NULL for query
291 * @passphrase_size - size of @passphrase (binary data)
292 * @new_passphrase - passphrase for new keyslot, NULL for query
293 * @new_passphrase_size - size of @new_passphrase (binary data)
295 #define CRYPT_ANY_SLOT -1
296 int crypt_keyslot_add_by_passphrase(struct crypt_device *cd,
298 const char *passphrase,
299 size_t passphrase_size,
300 const char *new_passphrase,
301 size_t new_passphrase_size);
304 * Get number of keyslots supported for device type.
306 * Returns slot count or negative errno otherwise if device
307 * doesn't not support keyslots.
309 * @type - crypt device type
311 int crypt_keyslot_max(const char *type);
314 * Add key slot using provided key file path
316 * Returns allocated key slot number or negative errno otherwise.
318 * @cd - crypt device handle
319 * @keyslot - requested keyslot or CRYPT_ANY_SLOT
320 * @keyfile - key file used to unlock volume key, NULL for passphrase query
321 * @keyfile_size - number of bytes to read from @keyfile, 0 is unlimited
322 * @new_keyfile - keyfile for new keyslot, NULL for passphrase query
323 * @new_keyfile_size - number of bytes to read from @new_keyfile, 0 is unlimited
325 * Note that @keyfile can be "-" for STDIN
327 int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
331 const char *new_keyfile,
332 size_t new_keyfile_size);
335 * Add key slot using provided volume key
337 * Returns allocated key slot number or negative errno otherwise.
339 * @cd - crypt device handle
340 * @keyslot - requested keyslot or CRYPT_ANY_SLOT
341 * @volume_key - provided volume key or NULL if used after crypt_format
342 * @volume_key_size - size of @volume_key
343 * @passphrase - passphrase for new keyslot, NULL for query
344 * @passphrase_size - size of @passphrase
346 int crypt_keyslot_add_by_volume_key(struct crypt_device *cd,
348 const char *volume_key,
349 size_t volume_key_size,
350 const char *passphrase,
351 size_t passphrase_size);
354 * Destroy (and disable) key slot
356 * Returns 0 on success or negative errno value otherwise.
358 * @cd - crypt device handle
359 * @keyslot - requested key slot to destroy
361 * Note that there is no passphrase verification used.
363 int crypt_keyslot_destroy(struct crypt_device *cd, int keyslot);
368 #define CRYPT_ACTIVATE_READONLY (1 << 0)
369 #define CRYPT_ACTIVATE_NO_UUID (1 << 1)
372 * Active device runtime attributes
374 struct crypt_active_device {
375 uint64_t offset; /* offset in sectors */
376 uint64_t iv_offset; /* IV initilisation sector */
377 uint64_t size; /* active device size */
378 uint32_t flags; /* activation flags */
382 * Receives runtime attributes of active crypt device
384 * Returns 0 on success or negative errno value otherwise.
386 * @cd - crypt device handle
387 * @name - name of active device
388 * @cad - preallocated active device attributes to fill
390 * Note that this is old API function using global context.
391 * All error messages are reported also through log callback.
393 int crypt_get_active_device(struct crypt_device *cd,
395 struct crypt_active_device *cad);
398 * Activate device or check passphrase
400 * Returns unlocked key slot number or negative errno otherwise.
402 * @cd - crypt device handle
403 * @name - name of device to create, if NULL only check passphrase
404 * @keyslot - requested keyslot to check or CRYPT_ANY_SLOT
405 * @passphrase - passphrase used to unlock volume key, NULL for query
406 * @passphrase_size - size of @passphrase
407 * @flags - activation flags
409 int crypt_activate_by_passphrase(struct crypt_device *cd,
412 const char *passphrase,
413 size_t passphrase_size,
417 * Activate device or check using key file
419 * Returns unlocked key slot number or negative errno otherwise.
421 * @cd - crypt device handle
422 * @name - name of device to create, if NULL only check keyfile
423 * @keyslot - requested keyslot to check or CRYPT_ANY_SLOT
424 * @keyfile - key file used to unlock volume key
425 * @keyfile_size - number of bytes to read from @keyfile, 0 is unlimited
426 * @flags - activation flags
428 int crypt_activate_by_keyfile(struct crypt_device *cd,
436 * Activate device using provided volume key
438 * Returns 0 on success or negative errno value otherwise.
440 * @cd - crypt device handle
441 * @name - name of device to create, if NULL only check volume key
442 * @volume_key - provided volume key (or NULL to use internal)
443 * @volume_key_size - size of @volume_key
444 * @flags - activation flags
446 * If NULL is used for volume_key, device has to be initialized
447 * by previous operation (like crypt_format() or crypt_init_by_name())
449 int crypt_activate_by_volume_key(struct crypt_device *cd,
451 const char *volume_key,
452 size_t volume_key_size,
456 * Deactivate crypt device
458 * @cd - crypt device handle, can be NULL
459 * @name - name of device to deactivate
461 int crypt_deactivate(struct crypt_device *cd, const char *name);
464 * Get volume key from of crypt device
466 * Returns unlocked key slot number or negative errno otherwise.
468 * @cd - crypt device handle
469 * @keyslot - use this keyslot or CRYPT_ANY_SLOT
470 * @volume_key - buffer for volume key
471 * @volume_key_size - on input, size of buffer @volume_key,
472 * on output size of @volume_key
473 * @passphrase - passphrase used to unlock volume key, NULL for query
474 * @passphrase_size - size of @passphrase
476 int crypt_volume_key_get(struct crypt_device *cd,
479 size_t *volume_key_size,
480 const char *passphrase,
481 size_t passphrase_size);
484 * Verify that provided volume key is valid for crypt device
486 * Returns 0 on success or negative errno value otherwise.
488 * @cd - crypt device handle
489 * @volume_key - provided volume key
490 * @volume_key_size - size of @volume_key
492 int crypt_volume_key_verify(struct crypt_device *cd,
493 const char *volume_key,
494 size_t volume_key_size);
497 * Get status info about device name
499 * Returns value defined by crypt_status_info.
501 * @cd - crypt device handle, can be NULL
502 * @name -crypt device name
504 * CRYPT_INACTIVE - no such mapped device
505 * CRYPT_ACTIVE - device is active
506 * CRYPT_BUSY - device is active and has open count > 0
514 crypt_status_info crypt_status(struct crypt_device *cd, const char *name);
517 * Dump text-formatted information about crypt device to log output
519 * Returns 0 on success or negative errno value otherwise.
521 * @cd - crypt device handle
523 int crypt_dump(struct crypt_device *cd);
526 * Various crypt device info functions
528 * @cd - crypt device handle
530 * cipher - used cipher, e.g. "aes" or NULL otherwise
531 * cipher_mode - used cipher mode including IV, e.g. "xts-plain" or NULL otherwise
532 * uuid - device UUID or NULL if not set
533 * device_name - underlying device name or NULL if not yet set
534 * data_offset - device offset in sectors where real data starts on underlying device)
535 * volume_key_size - size (in bytes) of volume key for crypt device
537 const char *crypt_get_cipher(struct crypt_device *cd);
538 const char *crypt_get_cipher_mode(struct crypt_device *cd);
539 const char *crypt_get_uuid(struct crypt_device *cd);
540 const char *crypt_get_device_name(struct crypt_device *cd);
541 uint64_t crypt_get_data_offset(struct crypt_device *cd);
542 int crypt_get_volume_key_size(struct crypt_device *cd);
545 * Get information about particular key slot
547 * Returns value defined by crypt_keyslot_info.
549 * @cd - crypt device handle
550 * @keyslot - requested keyslot to check or CRYPT_ANY_SLOT
556 CRYPT_SLOT_ACTIVE_LAST
557 } crypt_keyslot_info;
558 crypt_keyslot_info crypt_keyslot_status(struct crypt_device *cd, int keyslot);
561 * Backup header and keyslots to file
563 * Returns 0 on success or negative errno value otherwise.
565 * @cd - crypt device handle
566 * @requested_type - type of header to backup
567 * @backup_file - file to backup header to
569 int crypt_header_backup(struct crypt_device *cd,
570 const char *requested_type,
571 const char *backup_file);
574 * Restore header and keyslots from backup file
576 * Returns 0 on success or negative errno value otherwise.
578 * @cd - crypt device handle
579 * @requested_type - type of header to restore
580 * @backup_file - file to restore header from
582 int crypt_header_restore(struct crypt_device *cd,
583 const char *requested_type,
584 const char *backup_file);
587 * Receives last reported error
589 * @buf - buffef for message
590 * @size - size of buffer
592 * Note that this is old API function using global context.
593 * All error messages are reported also through log callback.
595 void crypt_get_error(char *buf, size_t size);
598 * Get directory where mapped crypt devices are created
600 const char *crypt_get_dir(void);
603 * Set library debug level
605 #define CRYPT_DEBUG_ALL -1
606 #define CRYPT_DEBUG_NONE 0
607 void crypt_set_debug_level(int level);
610 * OLD DEPRECATED API **********************************
612 * Provided only for backward compatibility.
615 struct interface_callbacks {
616 int (*yesDialog)(char *msg);
617 void (*log)(int level, char *msg);
620 #define CRYPT_FLAG_VERIFY (1 << 0)
621 #define CRYPT_FLAG_READONLY (1 << 1)
622 #define CRYPT_FLAG_VERIFY_IF_POSSIBLE (1 << 2)
623 #define CRYPT_FLAG_VERIFY_ON_DELKEY (1 << 3)
624 #define CRYPT_FLAG_NON_EXCLUSIVE_ACCESS (1 << 4)
626 struct crypt_options {
633 const char *passphrase;
635 const char *key_file;
636 const char *new_key_file;
645 uint64_t iteration_time;
648 uint64_t align_payload;
651 struct interface_callbacks *icb;
654 int crypt_create_device(struct crypt_options *options);
655 int crypt_update_device(struct crypt_options *options);
656 int crypt_resize_device(struct crypt_options *options);
657 int crypt_query_device(struct crypt_options *options);
658 int crypt_remove_device(struct crypt_options *options);
659 int crypt_luksFormat(struct crypt_options *options);
660 int crypt_luksOpen(struct crypt_options *options);
661 int crypt_luksKillSlot(struct crypt_options *options);
662 int crypt_luksRemoveKey(struct crypt_options *options);
663 int crypt_luksAddKey(struct crypt_options *options);
664 int crypt_luksUUID(struct crypt_options *options);
665 int crypt_isLuks(struct crypt_options *options);
666 int crypt_luksDump(struct crypt_options *options);
668 void crypt_put_options(struct crypt_options *options);
673 #endif /* _LIBCRYPTSETUP_H */