+/*
+ * libcryptsetup - cryptsetup library
+ *
+ * Copyright (C) 2004, Christophe Saout <christophe@saout.de>
+ * Copyright (C) 2004-2007, Clemens Fruhwirth <clemens@endorphin.org>
+ * Copyright (C) 2009-2012, Red Hat, Inc. All rights reserved.
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * version 2 as published by the Free Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
/**
* @file libcryptsetup.h
* @brief Public cryptsetup API
*
* For more verbose examples of LUKS related use cases,
- * please read @ref index "examples" @endref.
+ * please read @ref index "examples".
*/
#ifndef _LIBCRYPTSETUP_H
extern "C" {
#endif
+#include <stddef.h>
#include <stdint.h>
struct crypt_device; /* crypt device handle */
int crypt_init_by_name(struct crypt_device **cd, const char *name);
/**
- * @defgroup loglevel "Cryptsetup logging API"
+ * @defgroup loglevel "Cryptsetup logging"
*
* Set of functions and defines used in cryptsetup for
* logging purposes
* or negative errno value in case of error.
*
* @param cd crypt device handle
+ * @param password user defined password callback reference
* @param usrptr provided identification in callback
* @param msg Message for user
* @param buf buffer for password
void crypt_set_password_retry(struct crypt_device *cd, int tries);
/**
- * Set how long should cryptsetup iterate in PBKDF2 pseudorandom function.
+ * Set how long should cryptsetup iterate in PBKDF2 function.
* Default value heads towards the iterations which takes around 1 second
*
* @param cd crypt device handle
* @param iteration_time_ms the time in ms
*/
+void crypt_set_iteration_time(struct crypt_device *cd, uint64_t iteration_time_ms);
+/* Don't ask :-) */
void crypt_set_iterarion_time(struct crypt_device *cd, uint64_t iteration_time_ms);
/**
* @param device path to device
*
* @pre context is of LUKS type
- * @pre unlike @ref crypt_init @endref, in this function param @e device
+ * @pre unlike @ref crypt_init, in this function param @e device
* has to be block device (at least 512B large)
*/
int crypt_set_data_device(struct crypt_device *cd, const char *device);
/**
- * @defgroup rng "Cryptsetup (pseudo)random API"
+ * @defgroup rng "Cryptsetup RNG"
*
* @addtogroup rng
* @{
* @{
*/
-/** regular crypt device, no on-disk header */
+/** plain crypt device, no on-disk header */
#define CRYPT_PLAIN "PLAIN"
/** LUKS version 1 header on-disk */
#define CRYPT_LUKS1 "LUKS1"
/** loop-AES compatibility mode */
#define CRYPT_LOOPAES "LOOPAES"
+/** dm-verity mode */
+#define CRYPT_VERITY "VERITY"
/**
* Get device type
uint64_t skip; /**< IV offset / initialization sector */
};
+/**
+ *
+ * Structure used as parameter for dm-verity device type
+ *
+ * @see crypt_format, crypt_load
+ *
+ */
+/** No on-disk header (only hashes) */
+#define CRYPT_VERITY_NO_HEADER (1 << 0)
+/** Verity hash in userspace before activation */
+#define CRYPT_VERITY_CHECK_HASH (1 << 1)
+/** Create hash - format hash device */
+#define CRYPT_VERITY_CREATE_HASH (1 << 2)
+
+struct crypt_params_verity {
+ const char *hash_name; /**< hash function */
+ const char *data_device; /**< data_device (CRYPT_VERITY_CREATE_HASH) */
+ const char *salt; /**< salt */
+ uint64_t salt_size; /**< salt size (in bytes) */
+ uint32_t data_block_size; /**< data block size (in bytes) */
+ uint32_t hash_block_size; /**< hash block size (in bytes) */
+ uint64_t data_size; /**< data area size (in data blocks) */
+ uint64_t hash_area_offset; /**< hash/header offset (in bytes) */
+ uint32_t version; /**< in-kernel hash version */
+ uint32_t flags; /**< CRYPT_VERITY* flags */
+};
+
/** @} */
/**
* Load crypt device parameters from on-disk header
*
* @param cd crypt device handle
- * @param requested_type - use @e NULL for all known
+ * @param requested_type @link crypt_type @endlink or @e NULL for all known
* @param params crypt type specific parameters (see @link crypt_type @endlink)
*
* @returns 0 on success or negative errno value otherwise.
void *params);
/**
+ * Try to repair crypt device on-disk header if invalid
+ *
+ * @param cd crypt device handle
+ * @param requested_type @link crypt_type @endlink or @e NULL for all known
+ * @param params crypt type specific parameters (see @link crypt_type @endlink)
+ *
+ * @returns 0 on success or negative errno value otherwise.
+ *
+ */
+int crypt_repair(struct crypt_device *cd,
+ const char *requested_type,
+ void *params);
+
+/**
* Resize crypt device
*
* @param cd - crypt device handle
* @note Only LUKS device type is supported
*/
int crypt_resume_by_passphrase(struct crypt_device *cd,
- const char *name,
- int keyslot,
- const char *passphrase,
- size_t passphrase_size);
+ const char *name,
+ int keyslot,
+ const char *passphrase,
+ size_t passphrase_size);
/**
* Resumes crypt device using key file.
* @param name name of device to resume
* @param keyslot requested keyslot or CRYPT_ANY_SLOT
* @param keyfile key file used to unlock volume key, @e NULL for passphrase query
- * @param keyfile_size number of bytes to read from @keyfile, 0 is unlimited
+ * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
+ * @param keyfile_offset number of bytes to skip at start of keyfile
*
* @return unlocked key slot number or negative errno otherwise.
*/
+int crypt_resume_by_keyfile_offset(struct crypt_device *cd,
+ const char *name,
+ int keyslot,
+ const char *keyfile,
+ size_t keyfile_size,
+ size_t keyfile_offset);
+/**
+ * Backward compatible crypt_resume_by_keyfile_offset() (without offset).
+ */
int crypt_resume_by_keyfile(struct crypt_device *cd,
- const char *name,
- int keyslot,
- const char *keyfile,
- size_t keyfile_size);
+ const char *name,
+ int keyslot,
+ const char *keyfile,
+ size_t keyfile_size);
/**
* Releases crypt device context and used memory.
void crypt_free(struct crypt_device *cd);
/**
- * @defgroup keyslot "Cryptsetup LUKS keyslots API"
+ * @defgroup keyslot "Cryptsetup LUKS keyslots"
* @addtogroup keyslot
* @{
*
* @param cd crypt device handle
* @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
* @param passphrase passphrase used to unlock volume key, @e NULL for query
- * @param passphrase_size size of @passphrase (binary data)
+ * @param passphrase_size size of passphrase (binary data)
* @param new_passphrase passphrase for new keyslot, @e NULL for query
* @param new_passphrase_size size of @e new_passphrase (binary data)
*
* @param cd crypt device handle
* @param keyslot requested keyslot or @e CRYPT_ANY_SLOT
* @param keyfile key file used to unlock volume key, @e NULL for passphrase query
- * @param keyfile_size number of bytes to read from @keyfile, @e 0 is unlimited
+ * @param keyfile_size number of bytes to read from keyfile, @e 0 is unlimited
+ * @param keyfile_offset number of bytes to skip at start of keyfile
* @param new_keyfile keyfile for new keyslot, @e NULL for passphrase query
* @param new_keyfile_size number of bytes to read from @e new_keyfile, @e 0 is unlimited
+ * @param new_keyfile_offset number of bytes to skip at start of new_keyfile
*
* @return allocated key slot number or negative errno otherwise.
*
* @note Note that @e keyfile can be "-" for STDIN
*
*/
+int crypt_keyslot_add_by_keyfile_offset(struct crypt_device *cd,
+ int keyslot,
+ const char *keyfile,
+ size_t keyfile_size,
+ size_t keyfile_offset,
+ const char *new_keyfile,
+ size_t new_keyfile_size,
+ size_t new_keyfile_offset);
+/**
+ * Backward compatible crypt_keyslot_add_by_keyfile_offset() (without offset).
+ */
int crypt_keyslot_add_by_keyfile(struct crypt_device *cd,
int keyslot,
const char *keyfile,
* @param cd crypt device handle
* @param keyslot requested keyslot or CRYPT_ANY_SLOT
* @param volume_key provided volume key or @e NULL if used after crypt_format
- * @param volume_key_size size of @volume_key
+ * @param volume_key_size size of volume_key
* @param passphrase passphrase for new keyslot, @e NULL for query
- * @param passphrase_size size of @passphrase
+ * @param passphrase_size size of passphrase
*
* @return allocated key slot number or negative errno otherwise.
*
*/
/** device is read only */
#define CRYPT_ACTIVATE_READONLY (1 << 0)
-/** ignored */
+/** only reported for device without uuid */
#define CRYPT_ACTIVATE_NO_UUID (1 << 1)
-/** ??? */
+/** activate even if cannot grant exclusive access (DANGEROUS) */
#define CRYPT_ACTIVATE_SHARED (1 << 2)
/** enable discards aka TRIM */
#define CRYPT_ACTIVATE_ALLOW_DISCARDS (1 << 3)
+/** skip global udev rules in activation ("private device"), input only */
+#define CRYPT_ACTIVATE_PRIVATE (1 << 4)
/**
* Active device runtime attributes
* @param name name of device to create, if @e NULL only check keyfile
* @param keyslot requested keyslot to check or CRYPT_ANY_SLOT
* @param keyfile key file used to unlock volume key
- * @param keyfile_size number of bytes to read from @keyfile, 0 is unlimited
+ * @param keyfile_size number of bytes to read from keyfile, 0 is unlimited
+ * @param keyfile_offset number of bytes to skip at start of keyfile
* @param flags activation flags
*
* @return unlocked key slot number or negative errno otherwise.
*/
+int crypt_activate_by_keyfile_offset(struct crypt_device *cd,
+ const char *name,
+ int keyslot,
+ const char *keyfile,
+ size_t keyfile_size,
+ size_t keyfile_offset,
+ uint32_t flags);
+/**
+ * Backward compatible crypt_activate_by_keyfile_offset() (without offset).
+ */
int crypt_activate_by_keyfile(struct crypt_device *cd,
const char *name,
int keyslot,
* @param cd crypt device handle
* @param name name of device to create, if @e NULL only check volume key
* @param volume_key provided volume key (or @e NULL to use internal)
- * @param volume_key_size size of @volume_key
+ * @param volume_key_size size of volume_key
* @param flags activation flags
*
* @return @e 0 on success or negative errno value otherwise.
*
* @note If @e NULL is used for volume_key, device has to be initialized
- * by previous operation (like @ref crypt_format @endref
- * or @ref crypt_init_by_name @endref)
+ * by previous operation (like @ref crypt_format
+ * or @ref crypt_init_by_name)
*/
int crypt_activate_by_volume_key(struct crypt_device *cd,
const char *name,
* @{
*/
+/**
+ * Device status
+ */
typedef enum {
CRYPT_INVALID, /**< device mapping is invalid in this context */
CRYPT_INACTIVE, /**< no such mapped device */
* @{
*
*/
+
+/**
+ * Crypt keyslot info
+ */
typedef enum {
CRYPT_SLOT_INVALID, /**< invalid keyslot */
CRYPT_SLOT_INACTIVE, /**< keyslot is inactive (free) */
* Backup header and keyslots to file
*
* @param cd crypt device handle
- * @param requested_type type of header to backup
+ * @param requested_type @link crypt_type @endlink or @e NULL for all known
* @param backup_file file to backup header to
*
* @return @e 0 on success or negative errno value otherwise.
*
*
* @param cd crypt device handle
- * @param requested_type type of header to restore
+ * @param requested_type @link crypt_type @endlink or @e NULL for all known
* @param backup_file file to restore header from
*
* @return @e 0 on success or negative errno value otherwise.
/**
* Receives last reported error
*
+ * @param cd crypt device handle
+ * @param buf buffef for message
+ * @param size size of buffer
+ *
+ * @note Note that this is old API function using global context.
+ * All error messages are reported also through log callback.
+ */
+void crypt_last_error(struct crypt_device *cd, char *buf, size_t size);
+
+/**
+ * Receives last reported error, DEPRECATED
+ *
* @param buf buffef for message
* @param size size of buffer
*
projects / platform / upstream / cryptsetup.git / blobdiff