[linux.git] / fs / ext4 / crypto_policy.c

/*
 * linux/fs/ext4/crypto_policy.c
 *
 * Copyright (C) 2015, Google, Inc.
 *
 * This contains encryption policy functions for ext4
 *
 * Written by Michael Halcrow, 2015.
 */

#include <linux/random.h>
#include <linux/string.h>
#include <linux/types.h>

#include "ext4.h"
#include "xattr.h"

static int ext4_inode_has_encryption_context(struct inode *inode)
{
	int res = ext4_xattr_get(inode, EXT4_XATTR_INDEX_ENCRYPTION,
				 EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, NULL, 0);
	return (res > 0);
}

/*
 * check whether the policy is consistent with the encryption context
 * for the inode
 */
static int ext4_is_encryption_context_consistent_with_policy(
	struct inode *inode, const struct ext4_encryption_policy *policy)
{
	struct ext4_encryption_context ctx;
	int res = ext4_xattr_get(inode, EXT4_XATTR_INDEX_ENCRYPTION,
				 EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, &ctx,
				 sizeof(ctx));
	if (res != sizeof(ctx))
		return 0;
	return (memcmp(ctx.master_key_descriptor, policy->master_key_descriptor,
			EXT4_KEY_DESCRIPTOR_SIZE) == 0 &&
		(ctx.flags ==
		 policy->flags) &&
		(ctx.contents_encryption_mode ==
		 policy->contents_encryption_mode) &&
		(ctx.filenames_encryption_mode ==
		 policy->filenames_encryption_mode));
}

static int ext4_create_encryption_context_from_policy(
	struct inode *inode, const struct ext4_encryption_policy *policy)
{
	struct ext4_encryption_context ctx;
	int res = 0;

	res = ext4_convert_inline_data(inode);
	if (res)
		return res;

	ctx.format = EXT4_ENCRYPTION_CONTEXT_FORMAT_V1;
	memcpy(ctx.master_key_descriptor, policy->master_key_descriptor,
	       EXT4_KEY_DESCRIPTOR_SIZE);
	if (!ext4_valid_contents_enc_mode(policy->contents_encryption_mode)) {
		printk(KERN_WARNING
		       "%s: Invalid contents encryption mode %d\n", __func__,
			policy->contents_encryption_mode);
		return -EINVAL;
	}
	if (!ext4_valid_filenames_enc_mode(policy->filenames_encryption_mode)) {
		printk(KERN_WARNING
		       "%s: Invalid filenames encryption mode %d\n", __func__,
			policy->filenames_encryption_mode);
		return -EINVAL;
	}
	if (policy->flags & ~EXT4_POLICY_FLAGS_VALID)
		return -EINVAL;
	ctx.contents_encryption_mode = policy->contents_encryption_mode;
	ctx.filenames_encryption_mode = policy->filenames_encryption_mode;
	ctx.flags = policy->flags;
	BUILD_BUG_ON(sizeof(ctx.nonce) != EXT4_KEY_DERIVATION_NONCE_SIZE);
	get_random_bytes(ctx.nonce, EXT4_KEY_DERIVATION_NONCE_SIZE);

	res = ext4_xattr_set(inode, EXT4_XATTR_INDEX_ENCRYPTION,
			     EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, &ctx,
			     sizeof(ctx), 0);
	if (!res)
		ext4_set_inode_flag(inode, EXT4_INODE_ENCRYPT);
	return res;
}

int ext4_process_policy(const struct ext4_encryption_policy *policy,
			struct inode *inode)
{
	if (policy->version != 0)
		return -EINVAL;

	if (!ext4_inode_has_encryption_context(inode)) {
		if (!S_ISDIR(inode->i_mode))
			return -EINVAL;
		if (!ext4_empty_dir(inode))
			return -ENOTEMPTY;
		return ext4_create_encryption_context_from_policy(inode,
								  policy);
	}

	if (ext4_is_encryption_context_consistent_with_policy(inode, policy))
		return 0;

	printk(KERN_WARNING "%s: Policy inconsistent with encryption context\n",
	       __func__);
	return -EINVAL;
}

int ext4_get_policy(struct inode *inode, struct ext4_encryption_policy *policy)
{
	struct ext4_encryption_context ctx;

	int res = ext4_xattr_get(inode, EXT4_XATTR_INDEX_ENCRYPTION,
				 EXT4_XATTR_NAME_ENCRYPTION_CONTEXT,
				 &ctx, sizeof(ctx));
	if (res != sizeof(ctx))
		return -ENOENT;
	if (ctx.format != EXT4_ENCRYPTION_CONTEXT_FORMAT_V1)
		return -EINVAL;
	policy->version = 0;
	policy->contents_encryption_mode = ctx.contents_encryption_mode;
	policy->filenames_encryption_mode = ctx.filenames_encryption_mode;
	policy->flags = ctx.flags;
	memcpy(&policy->master_key_descriptor, ctx.master_key_descriptor,
	       EXT4_KEY_DESCRIPTOR_SIZE);
	return 0;
}

int ext4_is_child_context_consistent_with_parent(struct inode *parent,
						 struct inode *child)
{
	struct ext4_crypt_info *parent_ci, *child_ci;
	int res;

	if ((parent == NULL) || (child == NULL)) {
		pr_err("parent %p child %p\n", parent, child);
		BUG_ON(1);
	}
	/* no restrictions if the parent directory is not encrypted */
	if (!ext4_encrypted_inode(parent))
		return 1;
	/* if the child directory is not encrypted, this is always a problem */
	if (!ext4_encrypted_inode(child))
		return 0;
	res = ext4_get_encryption_info(parent);
	if (res)
		return 0;
	res = ext4_get_encryption_info(child);
	if (res)
		return 0;
	parent_ci = EXT4_I(parent)->i_crypt_info;
	child_ci = EXT4_I(child)->i_crypt_info;
	if (!parent_ci && !child_ci)
		return 1;
	if (!parent_ci || !child_ci)
		return 0;

	return (memcmp(parent_ci->ci_master_key,
		       child_ci->ci_master_key,
		       EXT4_KEY_DESCRIPTOR_SIZE) == 0 &&
		(parent_ci->ci_data_mode == child_ci->ci_data_mode) &&
		(parent_ci->ci_filename_mode == child_ci->ci_filename_mode) &&
		(parent_ci->ci_flags == child_ci->ci_flags));
}

/**
 * ext4_inherit_context() - Sets a child context from its parent
 * @parent: Parent inode from which the context is inherited.
 * @child:  Child inode that inherits the context from @parent.
 *
 * Return: Zero on success, non-zero otherwise
 */
int ext4_inherit_context(struct inode *parent, struct inode *child)
{
	struct ext4_encryption_context ctx;
	struct ext4_crypt_info *ci;
	int res;

	res = ext4_get_encryption_info(parent);
	if (res < 0)
		return res;
	ci = EXT4_I(parent)->i_crypt_info;
	if (ci == NULL)
		return -ENOKEY;

	ctx.format = EXT4_ENCRYPTION_CONTEXT_FORMAT_V1;
	if (DUMMY_ENCRYPTION_ENABLED(EXT4_SB(parent->i_sb))) {
		ctx.contents_encryption_mode = EXT4_ENCRYPTION_MODE_AES_256_XTS;
		ctx.filenames_encryption_mode =
			EXT4_ENCRYPTION_MODE_AES_256_CTS;
		ctx.flags = 0;
		memset(ctx.master_key_descriptor, 0x42,
		       EXT4_KEY_DESCRIPTOR_SIZE);
		res = 0;
	} else {
		ctx.contents_encryption_mode = ci->ci_data_mode;
		ctx.filenames_encryption_mode = ci->ci_filename_mode;
		ctx.flags = ci->ci_flags;
		memcpy(ctx.master_key_descriptor, ci->ci_master_key,
		       EXT4_KEY_DESCRIPTOR_SIZE);
	}
	get_random_bytes(ctx.nonce, EXT4_KEY_DERIVATION_NONCE_SIZE);
	res = ext4_xattr_set(child, EXT4_XATTR_INDEX_ENCRYPTION,
			     EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, &ctx,
			     sizeof(ctx), 0);
	if (!res) {
		ext4_set_inode_flag(child, EXT4_INODE_ENCRYPT);
		ext4_clear_inode_state(child, EXT4_STATE_MAY_INLINE_DATA);
		res = ext4_get_encryption_info(child);
	}
	return res;
}
Commit	Line	Data
9bd8212f MH	1	/*
	2	* linux/fs/ext4/crypto_policy.c
	3	*
	4	* Copyright (C) 2015, Google, Inc.
	5	*
	6	* This contains encryption policy functions for ext4
	7	*
	8	* Written by Michael Halcrow, 2015.
	9	*/
	10
	11	#include <linux/random.h>
	12	#include <linux/string.h>
	13	#include <linux/types.h>
	14
	15	#include "ext4.h"
	16	#include "xattr.h"
	17
	18	static int ext4_inode_has_encryption_context(struct inode *inode)
	19	{
	20	int res = ext4_xattr_get(inode, EXT4_XATTR_INDEX_ENCRYPTION,
	21	EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, NULL, 0);
	22	return (res > 0);
	23	}
	24
	25	/*
	26	* check whether the policy is consistent with the encryption context
	27	* for the inode
	28	*/
	29	static int ext4_is_encryption_context_consistent_with_policy(
	30	struct inode inode, const struct ext4_encryption_policy policy)
	31	{
	32	struct ext4_encryption_context ctx;
	33	int res = ext4_xattr_get(inode, EXT4_XATTR_INDEX_ENCRYPTION,
	34	EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, &ctx,
	35	sizeof(ctx));
	36	if (res != sizeof(ctx))
	37	return 0;
	38	return (memcmp(ctx.master_key_descriptor, policy->master_key_descriptor,
	39	EXT4_KEY_DESCRIPTOR_SIZE) == 0 &&
a44cd7a0 TT	40	(ctx.flags ==
a44cd7a0 TT	41	policy->flags) &&
9bd8212f MH	42	(ctx.contents_encryption_mode ==
	43	policy->contents_encryption_mode) &&
	44	(ctx.filenames_encryption_mode ==
	45	policy->filenames_encryption_mode));
	46	}
	47
	48	static int ext4_create_encryption_context_from_policy(
	49	struct inode inode, const struct ext4_encryption_policy policy)
	50	{
	51	struct ext4_encryption_context ctx;
	52	int res = 0;
	53
f5aed2c2 TT	54	res = ext4_convert_inline_data(inode);
	55	if (res)
	56	return res;
	57
9bd8212f MH	58	ctx.format = EXT4_ENCRYPTION_CONTEXT_FORMAT_V1;
	59	memcpy(ctx.master_key_descriptor, policy->master_key_descriptor,
	60	EXT4_KEY_DESCRIPTOR_SIZE);
b30ab0e0 MH	61	if (!ext4_valid_contents_enc_mode(policy->contents_encryption_mode)) {
	62	printk(KERN_WARNING
	63	"%s: Invalid contents encryption mode %d\n", __func__,
	64	policy->contents_encryption_mode);
a44cd7a0	65	return -EINVAL;
b30ab0e0	66	}
d5d0e8c7 MH	67	if (!ext4_valid_filenames_enc_mode(policy->filenames_encryption_mode)) {
	68	printk(KERN_WARNING
	69	"%s: Invalid filenames encryption mode %d\n", __func__,
	70	policy->filenames_encryption_mode);
a44cd7a0	71	return -EINVAL;
d5d0e8c7	72	}
a44cd7a0 TT	73	if (policy->flags & ~EXT4_POLICY_FLAGS_VALID)
a44cd7a0 TT	74	return -EINVAL;
9bd8212f MH	75	ctx.contents_encryption_mode = policy->contents_encryption_mode;
9bd8212f MH	76	ctx.filenames_encryption_mode = policy->filenames_encryption_mode;
a44cd7a0	77	ctx.flags = policy->flags;
9bd8212f MH	78	BUILD_BUG_ON(sizeof(ctx.nonce) != EXT4_KEY_DERIVATION_NONCE_SIZE);
	79	get_random_bytes(ctx.nonce, EXT4_KEY_DERIVATION_NONCE_SIZE);
	80
	81	res = ext4_xattr_set(inode, EXT4_XATTR_INDEX_ENCRYPTION,
	82	EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, &ctx,
	83	sizeof(ctx), 0);
	84	if (!res)
	85	ext4_set_inode_flag(inode, EXT4_INODE_ENCRYPT);
	86	return res;
	87	}
	88
	89	int ext4_process_policy(const struct ext4_encryption_policy *policy,
	90	struct inode *inode)
	91	{
	92	if (policy->version != 0)
	93	return -EINVAL;
	94
	95	if (!ext4_inode_has_encryption_context(inode)) {
d87f6d78 TT	96	if (!S_ISDIR(inode->i_mode))
d87f6d78 TT	97	return -EINVAL;
9bd8212f MH	98	if (!ext4_empty_dir(inode))
	99	return -ENOTEMPTY;
	100	return ext4_create_encryption_context_from_policy(inode,
	101	policy);
	102	}
	103
	104	if (ext4_is_encryption_context_consistent_with_policy(inode, policy))
	105	return 0;
	106
	107	printk(KERN_WARNING "%s: Policy inconsistent with encryption context\n",
	108	__func__);
	109	return -EINVAL;
	110	}
	111
	112	int ext4_get_policy(struct inode inode, struct ext4_encryption_policy policy)
	113	{
	114	struct ext4_encryption_context ctx;
	115
	116	int res = ext4_xattr_get(inode, EXT4_XATTR_INDEX_ENCRYPTION,
	117	EXT4_XATTR_NAME_ENCRYPTION_CONTEXT,
	118	&ctx, sizeof(ctx));
	119	if (res != sizeof(ctx))
	120	return -ENOENT;
	121	if (ctx.format != EXT4_ENCRYPTION_CONTEXT_FORMAT_V1)
	122	return -EINVAL;
	123	policy->version = 0;
	124	policy->contents_encryption_mode = ctx.contents_encryption_mode;
	125	policy->filenames_encryption_mode = ctx.filenames_encryption_mode;
a44cd7a0	126	policy->flags = ctx.flags;
9bd8212f MH	127	memcpy(&policy->master_key_descriptor, ctx.master_key_descriptor,
	128	EXT4_KEY_DESCRIPTOR_SIZE);
	129	return 0;
	130	}
	131
	132	int ext4_is_child_context_consistent_with_parent(struct inode *parent,
	133	struct inode *child)
	134	{
b7236e21	135	struct ext4_crypt_info parent_ci, child_ci;
9bd8212f MH	136	int res;
	137
	138	if ((parent == NULL) \|\| (child == NULL)) {
	139	pr_err("parent %p child %p\n", parent, child);
	140	BUG_ON(1);
	141	}
	142	/* no restrictions if the parent directory is not encrypted */
	143	if (!ext4_encrypted_inode(parent))
	144	return 1;
9bd8212f MH	145	/* if the child directory is not encrypted, this is always a problem */
	146	if (!ext4_encrypted_inode(child))
	147	return 0;
b7236e21 TT	148	res = ext4_get_encryption_info(parent);
	149	if (res)
	150	return 0;
	151	res = ext4_get_encryption_info(child);
	152	if (res)
	153	return 0;
	154	parent_ci = EXT4_I(parent)->i_crypt_info;
	155	child_ci = EXT4_I(child)->i_crypt_info;
	156	if (!parent_ci && !child_ci)
	157	return 1;
	158	if (!parent_ci \|\| !child_ci)
9bd8212f	159	return 0;
b7236e21 TT	160
	161	return (memcmp(parent_ci->ci_master_key,
	162	child_ci->ci_master_key,
9bd8212f	163	EXT4_KEY_DESCRIPTOR_SIZE) == 0 &&
b7236e21 TT	164	(parent_ci->ci_data_mode == child_ci->ci_data_mode) &&
	165	(parent_ci->ci_filename_mode == child_ci->ci_filename_mode) &&
	166	(parent_ci->ci_flags == child_ci->ci_flags));
9bd8212f MH	167	}
	168
	169	/**
	170	* ext4_inherit_context() - Sets a child context from its parent
	171	* @parent: Parent inode from which the context is inherited.
	172	* @child: Child inode that inherits the context from @parent.
	173	*
	174	* Return: Zero on success, non-zero otherwise
	175	*/
	176	int ext4_inherit_context(struct inode parent, struct inode child)
	177	{
	178	struct ext4_encryption_context ctx;
b7236e21 TT	179	struct ext4_crypt_info *ci;
	180	int res;
	181
	182	res = ext4_get_encryption_info(parent);
	183	if (res < 0)
	184	return res;
	185	ci = EXT4_I(parent)->i_crypt_info;
abdd438b TT	186	if (ci == NULL)
abdd438b TT	187	return -ENOKEY;
9bd8212f	188
b7236e21 TT	189	ctx.format = EXT4_ENCRYPTION_CONTEXT_FORMAT_V1;
	190	if (DUMMY_ENCRYPTION_ENABLED(EXT4_SB(parent->i_sb))) {
	191	ctx.contents_encryption_mode = EXT4_ENCRYPTION_MODE_AES_256_XTS;
	192	ctx.filenames_encryption_mode =
	193	EXT4_ENCRYPTION_MODE_AES_256_CTS;
	194	ctx.flags = 0;
	195	memset(ctx.master_key_descriptor, 0x42,
	196	EXT4_KEY_DESCRIPTOR_SIZE);
	197	res = 0;
	198	} else {
	199	ctx.contents_encryption_mode = ci->ci_data_mode;
	200	ctx.filenames_encryption_mode = ci->ci_filename_mode;
	201	ctx.flags = ci->ci_flags;
	202	memcpy(ctx.master_key_descriptor, ci->ci_master_key,
	203	EXT4_KEY_DESCRIPTOR_SIZE);
6ddb2447	204	}
9bd8212f MH	205	get_random_bytes(ctx.nonce, EXT4_KEY_DERIVATION_NONCE_SIZE);
	206	res = ext4_xattr_set(child, EXT4_XATTR_INDEX_ENCRYPTION,
	207	EXT4_XATTR_NAME_ENCRYPTION_CONTEXT, &ctx,
	208	sizeof(ctx), 0);
f5aed2c2	209	if (!res) {
9bd8212f	210	ext4_set_inode_flag(child, EXT4_INODE_ENCRYPT);
f5aed2c2	211	ext4_clear_inode_state(child, EXT4_STATE_MAY_INLINE_DATA);
55557029	212	res = ext4_get_encryption_info(child);
f5aed2c2	213	}
9bd8212f MH	214	return res;
9bd8212f MH	215	}