Change License from GPLv2 only to GPLv2+ ("or any later").
[platform/upstream/cryptsetup.git] / lib / internal.h
index 770fc9f..821c115 100644 (file)
@@ -1,3 +1,26 @@
+/*
+ * libcryptsetup - cryptsetup library internal
+ *
+ * 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.
+ * Copyright (C) 2009-2012, Milan Broz
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation; either version 2
+ * of the License, or (at your option) any later version.
+ *
+ * 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.
+ */
+
 #ifndef INTERNAL_H
 #define INTERNAL_H
 
 #include <inttypes.h>
 
 #include "nls.h"
+#include "bitops.h"
 #include "utils_crypt.h"
+#include "utils_loop.h"
+#include "utils_dm.h"
+#include "utils_fips.h"
+#include "crypto_backend.h"
+
+#include "libcryptsetup.h"
+
+/* to silent gcc -Wcast-qual for const cast */
+#define CONST_CAST(x) (x)(uintptr_t)
 
 #define SECTOR_SHIFT           9
 #define SECTOR_SIZE            (1 << SECTOR_SHIFT)
 #define DEFAULT_DISK_ALIGNMENT 1048576 /* 1MiB */
 #define DEFAULT_MEM_ALIGNMENT  4096
-
-/* private struct crypt_options flags */
-
-#define        CRYPT_FLAG_FREE_DEVICE  (1 << 24)
-#define        CRYPT_FLAG_FREE_CIPHER  (1 << 25)
-
-#define CRYPT_FLAG_PRIVATE_MASK ((unsigned int)-1 << 24)
+#define MAX_ERROR_LENGTH       512
 
 #define at_least(a, b) ({ __typeof__(a) __at_least = (a); (__at_least >= (b))?__at_least:(b); })
 
 struct crypt_device;
 
-struct hash_type {
-       char            *name;
-       void            *private;
-       int             (*fn)(void *data, int size, char *key,
-                             int sizep, const char *passphrase);
-};
-
-struct hash_backend {
-       const char              *name;
-       struct hash_type *      (*get_hashes)(void);
-       void                    (*free_hashes)(struct hash_type *hashes);
-};
-
 struct volume_key {
        size_t keylength;
        char key[];
@@ -51,80 +65,88 @@ struct volume_key *crypt_alloc_volume_key(unsigned keylength, const char *key);
 struct volume_key *crypt_generate_volume_key(struct crypt_device *cd, unsigned keylength);
 void crypt_free_volume_key(struct volume_key *vk);
 
+/* Device backend */
+struct device;
+int device_alloc(struct device **device, const char *path);
+void device_free(struct device *device);
+const char *device_path(const struct device *device);
+const char *device_block_path(const struct device *device);
+void device_topology_alignment(struct device *device,
+                           unsigned long *required_alignment, /* bytes */
+                           unsigned long *alignment_offset,   /* bytes */
+                           unsigned long default_alignment);
+int device_block_size(struct device *device);
+int device_read_ahead(struct device *device, uint32_t *read_ahead);
+int device_size(struct device *device, uint64_t *size);
+
+enum devcheck { DEV_OK = 0, DEV_EXCL = 1, DEV_SHARED = 2 };
+int device_block_adjust(struct crypt_device *cd,
+                       struct device *device,
+                       enum devcheck device_check,
+                       uint64_t device_offset,
+                       uint64_t *size,
+                       uint32_t *flags);
+size_t size_round_up(size_t size, unsigned int block);
+
+/* Receive backend devices from context helpers */
+struct device *crypt_metadata_device(struct crypt_device *cd);
+struct device *crypt_data_device(struct crypt_device *cd);
+
 int crypt_confirm(struct crypt_device *cd, const char *msg);
 
-void set_error_va(const char *fmt, va_list va);
-void set_error(const char *fmt, ...);
-const char *get_error(void);
+char *crypt_lookup_dev(const char *dev_id);
+int crypt_sysfs_get_rotational(int major, int minor, int *rotational);
+
+ssize_t write_blockwise(int fd, int bsize, void *buf, size_t count);
+ssize_t read_blockwise(int fd, int bsize, void *_buf, size_t count);
+ssize_t write_lseek_blockwise(int fd, int bsize, char *buf, size_t count, off_t offset);
 
+unsigned crypt_getpagesize(void);
 int init_crypto(struct crypt_device *ctx);
-struct hash_backend *get_hash_backend(const char *name);
-void put_hash_backend(struct hash_backend *backend);
-int hash(const char *backend_name, const char *hash_name,
-         char *result, size_t size,
-         const char *passphrase, size_t sizep);
-
-/* Device mapper backend */
-const char *dm_get_dir(void);
-int dm_init(struct crypt_device *context, int check_kernel);
-void dm_exit(void);
-int dm_remove_device(const char *name, int force, uint64_t size);
-int dm_status_device(const char *name);
-int dm_query_device(const char *name,
-                   char **device,
-                   uint64_t *size,
-                   uint64_t *skip,
-                   uint64_t *offset,
-                   char **cipher,
-                   int *key_size,
-                   char **key,
-                   int *read_only,
-                   int *suspended,
-                   char **uuid);
-int dm_create_device(const char *name, const char *device, const char *cipher,
-                    const char *type, const char *uuid,
-                    uint64_t size, uint64_t skip, uint64_t offset,
-                    size_t key_size, const char *key,
-                    int read_only, int reload);
-int dm_suspend_and_wipe_key(const char *name);
-int dm_resume_and_reinstate_key(const char *name,
-                               size_t key_size,
-                               const char *key);
-
-int sector_size_for_device(const char *device);
-ssize_t write_blockwise(int fd, const void *buf, size_t count);
-ssize_t read_blockwise(int fd, void *_buf, size_t count);
-ssize_t write_lseek_blockwise(int fd, const char *buf, size_t count, off_t offset);
-int device_ready(struct crypt_device *cd, const char *device, int mode);
-int get_device_infos(const char *device,
-                    int open_exclusive,
-                    int *readonly,
-                    uint64_t *size);
-int wipe_device_header(const char *device, int sectors);
 
 void logger(struct crypt_device *cd, int class, const char *file, int line, const char *format, ...);
 #define log_dbg(x...) logger(NULL, CRYPT_LOG_DEBUG, __FILE__, __LINE__, x)
 #define log_std(c, x...) logger(c, CRYPT_LOG_NORMAL, __FILE__, __LINE__, x)
 #define log_verbose(c, x...) logger(c, CRYPT_LOG_VERBOSE, __FILE__, __LINE__, x)
-#define log_err(c, x...) do { \
-       logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x); \
-       set_error(x); } while(0)
+#define log_err(c, x...) logger(c, CRYPT_LOG_ERROR, __FILE__, __LINE__, x)
 
 int crypt_get_debug_level(void);
-void debug_processes_using_device(const char *name);
 
 int crypt_memlock_inc(struct crypt_device *ctx);
 int crypt_memlock_dec(struct crypt_device *ctx);
 
-void get_topology_alignment(const char *device,
-                           unsigned long *required_alignment, /* bytes */
-                           unsigned long *alignment_offset,   /* bytes */
-                           unsigned long default_alignment);
-
-enum { CRYPT_RND_NORMAL = 0, CRYPT_RND_KEY = 1 };
 int crypt_random_init(struct crypt_device *ctx);
 int crypt_random_get(struct crypt_device *ctx, char *buf, size_t len, int quality);
 void crypt_random_exit(void);
 int crypt_random_default_key_rng(void);
 
+int crypt_plain_hash(struct crypt_device *ctx,
+                    const char *hash_name,
+                    char *key, size_t key_size,
+                    const char *passphrase, size_t passphrase_size);
+int PLAIN_activate(struct crypt_device *cd,
+                    const char *name,
+                    struct volume_key *vk,
+                    uint64_t size,
+                    uint32_t flags);
+
+/**
+ * Different methods used to erase sensitive data concerning
+ * either encrypted payload area or master key inside keyslot
+ * area
+ */
+typedef enum {
+       CRYPT_WIPE_ZERO, /**< overwrite area using zero blocks */
+       CRYPT_WIPE_DISK, /**< erase disk (using Gutmann method if it is rotational disk)*/
+       CRYPT_WIPE_SSD, /**< erase solid state disk (random write) */
+       CRYPT_WIPE_RANDOM /**< overwrite area using some up to now unspecified
+                           * random algorithm */
+} crypt_wipe_type;
+
+int crypt_wipe(struct device *device,
+              uint64_t offset,
+              uint64_t sectors,
+              crypt_wipe_type type,
+              int flags);
+
 #endif /* INTERNAL_H */