[mirror_ubuntu-bionic-kernel.git] / include / linux / fscrypt_common.h

/*
 * fscrypt_common.h: common declarations for per-file encryption
 *
 * Copyright (C) 2015, Google, Inc.
 *
 * Written by Michael Halcrow, 2015.
 * Modified by Jaegeuk Kim, 2015.
 */

#ifndef _LINUX_FSCRYPT_COMMON_H
#define _LINUX_FSCRYPT_COMMON_H

#include <linux/key.h>
#include <linux/fs.h>
#include <linux/mm.h>
#include <linux/bio.h>
#include <linux/dcache.h>
#include <crypto/skcipher.h>
#include <uapi/linux/fs.h>

#define FS_CRYPTO_BLOCK_SIZE		16

struct fscrypt_info;

struct fscrypt_ctx {
	union {
		struct {
			struct page *bounce_page;	/* Ciphertext page */
			struct page *control_page;	/* Original page  */
		} w;
		struct {
			struct bio *bio;
			struct work_struct work;
		} r;
		struct list_head free_list;	/* Free list */
	};
	u8 flags;				/* Flags */
};

/**
 * For encrypted symlinks, the ciphertext length is stored at the beginning
 * of the string in little-endian format.
 */
struct fscrypt_symlink_data {
	__le16 len;
	char encrypted_path[1];
} __packed;

struct fscrypt_str {
	unsigned char *name;
	u32 len;
};

struct fscrypt_name {
	const struct qstr *usr_fname;
	struct fscrypt_str disk_name;
	u32 hash;
	u32 minor_hash;
	struct fscrypt_str crypto_buf;
};

#define FSTR_INIT(n, l)		{ .name = n, .len = l }
#define FSTR_TO_QSTR(f)		QSTR_INIT((f)->name, (f)->len)
#define fname_name(p)		((p)->disk_name.name)
#define fname_len(p)		((p)->disk_name.len)

/*
 * fscrypt superblock flags
 */
#define FS_CFLG_OWN_PAGES (1U << 1)

/*
 * crypto opertions for filesystems
 */
struct fscrypt_operations {
	unsigned int flags;
	const char *key_prefix;
	int (*get_context)(struct inode *, void *, size_t);
	int (*set_context)(struct inode *, const void *, size_t, void *);
	bool (*dummy_context)(struct inode *);
	bool (*is_encrypted)(struct inode *);
	bool (*empty_dir)(struct inode *);
	unsigned (*max_namelen)(struct inode *);
};

/* Maximum value for the third parameter of fscrypt_operations.set_context(). */
#define FSCRYPT_SET_CONTEXT_MAX_SIZE	28

static inline bool fscrypt_dummy_context_enabled(struct inode *inode)
{
	if (inode->i_sb->s_cop->dummy_context &&
				inode->i_sb->s_cop->dummy_context(inode))
		return true;
	return false;
}

static inline bool fscrypt_valid_enc_modes(u32 contents_mode,
					u32 filenames_mode)
{
	if (contents_mode == FS_ENCRYPTION_MODE_AES_128_CBC &&
	    filenames_mode == FS_ENCRYPTION_MODE_AES_128_CTS)
		return true;

	if (contents_mode == FS_ENCRYPTION_MODE_AES_256_XTS &&
	    filenames_mode == FS_ENCRYPTION_MODE_AES_256_CTS)
		return true;

	return false;
}

static inline bool fscrypt_is_dot_dotdot(const struct qstr *str)
{
	if (str->len == 1 && str->name[0] == '.')
		return true;

	if (str->len == 2 && str->name[0] == '.' && str->name[1] == '.')
		return true;

	return false;
}

static inline struct page *fscrypt_control_page(struct page *page)
{
#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
	return ((struct fscrypt_ctx *)page_private(page))->w.control_page;
#else
	WARN_ON_ONCE(1);
	return ERR_PTR(-EINVAL);
#endif
}

static inline int fscrypt_has_encryption_key(const struct inode *inode)
{
#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
	return (inode->i_crypt_info != NULL);
#else
	return 0;
#endif
}

#endif	/* _LINUX_FSCRYPT_COMMON_H */
Commit	Line	Data
46f47e48 EB	1	/*
	2	* fscrypt_common.h: common declarations for per-file encryption
	3	*
	4	* Copyright (C) 2015, Google, Inc.
	5	*
	6	* Written by Michael Halcrow, 2015.
	7	* Modified by Jaegeuk Kim, 2015.
	8	*/
	9
	10	#ifndef _LINUX_FSCRYPT_COMMON_H
	11	#define _LINUX_FSCRYPT_COMMON_H
	12
	13	#include <linux/key.h>
	14	#include <linux/fs.h>
	15	#include <linux/mm.h>
	16	#include <linux/bio.h>
	17	#include <linux/dcache.h>
	18	#include <crypto/skcipher.h>
	19	#include <uapi/linux/fs.h>
	20
	21	#define FS_CRYPTO_BLOCK_SIZE 16
	22
	23	struct fscrypt_info;
	24
	25	struct fscrypt_ctx {
	26	union {
	27	struct {
	28	struct page bounce_page; / Ciphertext page */
	29	struct page control_page; / Original page */
	30	} w;
	31	struct {
	32	struct bio *bio;
	33	struct work_struct work;
	34	} r;
	35	struct list_head free_list; /* Free list */
	36	};
	37	u8 flags; /* Flags */
	38	};
	39
	40	/**
	41	* For encrypted symlinks, the ciphertext length is stored at the beginning
	42	* of the string in little-endian format.
	43	*/
	44	struct fscrypt_symlink_data {
	45	__le16 len;
	46	char encrypted_path[1];
	47	} __packed;
	48
46f47e48 EB	49	struct fscrypt_str {
	50	unsigned char *name;
	51	u32 len;
	52	};
	53
	54	struct fscrypt_name {
	55	const struct qstr *usr_fname;
	56	struct fscrypt_str disk_name;
	57	u32 hash;
	58	u32 minor_hash;
	59	struct fscrypt_str crypto_buf;
	60	};
	61
	62	#define FSTR_INIT(n, l) { .name = n, .len = l }
	63	#define FSTR_TO_QSTR(f) QSTR_INIT((f)->name, (f)->len)
	64	#define fname_name(p) ((p)->disk_name.name)
	65	#define fname_len(p) ((p)->disk_name.len)
	66
	67	/*
	68	* fscrypt superblock flags
	69	*/
	70	#define FS_CFLG_OWN_PAGES (1U << 1)
	71
	72	/*
	73	* crypto opertions for filesystems
	74	*/
	75	struct fscrypt_operations {
	76	unsigned int flags;
	77	const char *key_prefix;
	78	int (get_context)(struct inode , void *, size_t);
46f47e48	79	int (set_context)(struct inode , const void , size_t, void );
c250b7dd	80	bool (dummy_context)(struct inode );
46f47e48 EB	81	bool (is_encrypted)(struct inode );
	82	bool (empty_dir)(struct inode );
	83	unsigned (max_namelen)(struct inode );
	84	};
	85
af65207c TE	86	/* Maximum value for the third parameter of fscrypt_operations.set_context(). */
	87	#define FSCRYPT_SET_CONTEXT_MAX_SIZE 28
	88
46f47e48 EB	89	static inline bool fscrypt_dummy_context_enabled(struct inode *inode)
	90	{
	91	if (inode->i_sb->s_cop->dummy_context &&
	92	inode->i_sb->s_cop->dummy_context(inode))
	93	return true;
	94	return false;
	95	}
	96
b7e7cf7a DW	97	static inline bool fscrypt_valid_enc_modes(u32 contents_mode,
b7e7cf7a DW	98	u32 filenames_mode)
46f47e48	99	{
b7e7cf7a DW	100	if (contents_mode == FS_ENCRYPTION_MODE_AES_128_CBC &&
	101	filenames_mode == FS_ENCRYPTION_MODE_AES_128_CTS)
	102	return true;
46f47e48	103
b7e7cf7a DW	104	if (contents_mode == FS_ENCRYPTION_MODE_AES_256_XTS &&
	105	filenames_mode == FS_ENCRYPTION_MODE_AES_256_CTS)
	106	return true;
	107
	108	return false;
46f47e48 EB	109	}
	110
	111	static inline bool fscrypt_is_dot_dotdot(const struct qstr *str)
	112	{
	113	if (str->len == 1 && str->name[0] == '.')
	114	return true;
	115
	116	if (str->len == 2 && str->name[0] == '.' && str->name[1] == '.')
	117	return true;
	118
	119	return false;
	120	}
	121
	122	static inline struct page fscrypt_control_page(struct page page)
	123	{
	124	#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
	125	return ((struct fscrypt_ctx *)page_private(page))->w.control_page;
	126	#else
	127	WARN_ON_ONCE(1);
	128	return ERR_PTR(-EINVAL);
	129	#endif
	130	}
	131
	132	static inline int fscrypt_has_encryption_key(const struct inode *inode)
	133	{
	134	#if IS_ENABLED(CONFIG_FS_ENCRYPTION)
	135	return (inode->i_crypt_info != NULL);
	136	#else
	137	return 0;
	138	#endif
	139	}
	140
	141	#endif /* _LINUX_FSCRYPT_COMMON_H */