[mirror_ubuntu-hirsute-kernel.git] / include / uapi / linux / fscrypt.h

/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
/*
 * fscrypt user API
 *
 * These ioctls can be used on filesystems that support fscrypt.  See the
 * "User API" section of Documentation/filesystems/fscrypt.rst.
 */
#ifndef _UAPI_LINUX_FSCRYPT_H
#define _UAPI_LINUX_FSCRYPT_H

#include <linux/ioctl.h>
#include <linux/types.h>

/* Encryption policy flags */
#define FSCRYPT_POLICY_FLAGS_PAD_4		0x00
#define FSCRYPT_POLICY_FLAGS_PAD_8		0x01
#define FSCRYPT_POLICY_FLAGS_PAD_16		0x02
#define FSCRYPT_POLICY_FLAGS_PAD_32		0x03
#define FSCRYPT_POLICY_FLAGS_PAD_MASK		0x03
#define FSCRYPT_POLICY_FLAG_DIRECT_KEY		0x04
#define FSCRYPT_POLICY_FLAG_IV_INO_LBLK_64	0x08
#define FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32	0x10

/* Encryption algorithms */
#define FSCRYPT_MODE_AES_256_XTS		1
#define FSCRYPT_MODE_AES_256_CTS		4
#define FSCRYPT_MODE_AES_128_CBC		5
#define FSCRYPT_MODE_AES_128_CTS		6
#define FSCRYPT_MODE_ADIANTUM			9
/* If adding a mode number > 9, update FSCRYPT_MODE_MAX in fscrypt_private.h */

/*
 * Legacy policy version; ad-hoc KDF and no key verification.
 * For new encrypted directories, use fscrypt_policy_v2 instead.
 *
 * Careful: the .version field for this is actually 0, not 1.
 */
#define FSCRYPT_POLICY_V1		0
#define FSCRYPT_KEY_DESCRIPTOR_SIZE	8
struct fscrypt_policy_v1 {
	__u8 version;
	__u8 contents_encryption_mode;
	__u8 filenames_encryption_mode;
	__u8 flags;
	__u8 master_key_descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE];
};

/*
 * Process-subscribed "logon" key description prefix and payload format.
 * Deprecated; prefer FS_IOC_ADD_ENCRYPTION_KEY instead.
 */
#define FSCRYPT_KEY_DESC_PREFIX		"fscrypt:"
#define FSCRYPT_KEY_DESC_PREFIX_SIZE	8
#define FSCRYPT_MAX_KEY_SIZE		64
struct fscrypt_key {
	__u32 mode;
	__u8 raw[FSCRYPT_MAX_KEY_SIZE];
	__u32 size;
};

/*
 * New policy version with HKDF and key verification (recommended).
 */
#define FSCRYPT_POLICY_V2		2
#define FSCRYPT_KEY_IDENTIFIER_SIZE	16
struct fscrypt_policy_v2 {
	__u8 version;
	__u8 contents_encryption_mode;
	__u8 filenames_encryption_mode;
	__u8 flags;
	__u8 __reserved[4];
	__u8 master_key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
};

/* Struct passed to FS_IOC_GET_ENCRYPTION_POLICY_EX */
struct fscrypt_get_policy_ex_arg {
	__u64 policy_size; /* input/output */
	union {
		__u8 version;
		struct fscrypt_policy_v1 v1;
		struct fscrypt_policy_v2 v2;
	} policy; /* output */
};

/*
 * v1 policy keys are specified by an arbitrary 8-byte key "descriptor",
 * matching fscrypt_policy_v1::master_key_descriptor.
 */
#define FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR	1

/*
 * v2 policy keys are specified by a 16-byte key "identifier" which the kernel
 * calculates as a cryptographic hash of the key itself,
 * matching fscrypt_policy_v2::master_key_identifier.
 */
#define FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER	2

/*
 * Specifies a key, either for v1 or v2 policies.  This doesn't contain the
 * actual key itself; this is just the "name" of the key.
 */
struct fscrypt_key_specifier {
	__u32 type;	/* one of FSCRYPT_KEY_SPEC_TYPE_* */
	__u32 __reserved;
	union {
		__u8 __reserved[32]; /* reserve some extra space */
		__u8 descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE];
		__u8 identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
	} u;
};

/*
 * Payload of Linux keyring key of type "fscrypt-provisioning", referenced by
 * fscrypt_add_key_arg::key_id as an alternative to fscrypt_add_key_arg::raw.
 */
struct fscrypt_provisioning_key_payload {
	__u32 type;
	__u32 __reserved;
	__u8 raw[];
};

/* Struct passed to FS_IOC_ADD_ENCRYPTION_KEY */
struct fscrypt_add_key_arg {
	struct fscrypt_key_specifier key_spec;
	__u32 raw_size;
	__u32 key_id;
	__u32 __reserved[8];
	__u8 raw[];
};

/* Struct passed to FS_IOC_REMOVE_ENCRYPTION_KEY */
struct fscrypt_remove_key_arg {
	struct fscrypt_key_specifier key_spec;
#define FSCRYPT_KEY_REMOVAL_STATUS_FLAG_FILES_BUSY	0x00000001
#define FSCRYPT_KEY_REMOVAL_STATUS_FLAG_OTHER_USERS	0x00000002
	__u32 removal_status_flags;	/* output */
	__u32 __reserved[5];
};

/* Struct passed to FS_IOC_GET_ENCRYPTION_KEY_STATUS */
struct fscrypt_get_key_status_arg {
	/* input */
	struct fscrypt_key_specifier key_spec;
	__u32 __reserved[6];

	/* output */
#define FSCRYPT_KEY_STATUS_ABSENT		1
#define FSCRYPT_KEY_STATUS_PRESENT		2
#define FSCRYPT_KEY_STATUS_INCOMPLETELY_REMOVED	3
	__u32 status;
#define FSCRYPT_KEY_STATUS_FLAG_ADDED_BY_SELF   0x00000001
	__u32 status_flags;
	__u32 user_count;
	__u32 __out_reserved[13];
};

#define FS_IOC_SET_ENCRYPTION_POLICY		_IOR('f', 19, struct fscrypt_policy_v1)
#define FS_IOC_GET_ENCRYPTION_PWSALT		_IOW('f', 20, __u8[16])
#define FS_IOC_GET_ENCRYPTION_POLICY		_IOW('f', 21, struct fscrypt_policy_v1)
#define FS_IOC_GET_ENCRYPTION_POLICY_EX		_IOWR('f', 22, __u8[9]) /* size + version */
#define FS_IOC_ADD_ENCRYPTION_KEY		_IOWR('f', 23, struct fscrypt_add_key_arg)
#define FS_IOC_REMOVE_ENCRYPTION_KEY		_IOWR('f', 24, struct fscrypt_remove_key_arg)
#define FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS	_IOWR('f', 25, struct fscrypt_remove_key_arg)
#define FS_IOC_GET_ENCRYPTION_KEY_STATUS	_IOWR('f', 26, struct fscrypt_get_key_status_arg)
#define FS_IOC_GET_ENCRYPTION_NONCE		_IOR('f', 27, __u8[16])

/**********************************************************************/

/* old names; don't add anything new here! */
#ifndef __KERNEL__
#define fscrypt_policy			fscrypt_policy_v1
#define FS_KEY_DESCRIPTOR_SIZE		FSCRYPT_KEY_DESCRIPTOR_SIZE
#define FS_POLICY_FLAGS_PAD_4		FSCRYPT_POLICY_FLAGS_PAD_4
#define FS_POLICY_FLAGS_PAD_8		FSCRYPT_POLICY_FLAGS_PAD_8
#define FS_POLICY_FLAGS_PAD_16		FSCRYPT_POLICY_FLAGS_PAD_16
#define FS_POLICY_FLAGS_PAD_32		FSCRYPT_POLICY_FLAGS_PAD_32
#define FS_POLICY_FLAGS_PAD_MASK	FSCRYPT_POLICY_FLAGS_PAD_MASK
#define FS_POLICY_FLAG_DIRECT_KEY	FSCRYPT_POLICY_FLAG_DIRECT_KEY
#define FS_POLICY_FLAGS_VALID		0x07	/* contains old flags only */
#define FS_ENCRYPTION_MODE_INVALID	0	/* never used */
#define FS_ENCRYPTION_MODE_AES_256_XTS	FSCRYPT_MODE_AES_256_XTS
#define FS_ENCRYPTION_MODE_AES_256_GCM	2	/* never used */
#define FS_ENCRYPTION_MODE_AES_256_CBC	3	/* never used */
#define FS_ENCRYPTION_MODE_AES_256_CTS	FSCRYPT_MODE_AES_256_CTS
#define FS_ENCRYPTION_MODE_AES_128_CBC	FSCRYPT_MODE_AES_128_CBC
#define FS_ENCRYPTION_MODE_AES_128_CTS	FSCRYPT_MODE_AES_128_CTS
#define FS_ENCRYPTION_MODE_SPECK128_256_XTS	7	/* removed */
#define FS_ENCRYPTION_MODE_SPECK128_256_CTS	8	/* removed */
#define FS_ENCRYPTION_MODE_ADIANTUM	FSCRYPT_MODE_ADIANTUM
#define FS_KEY_DESC_PREFIX		FSCRYPT_KEY_DESC_PREFIX
#define FS_KEY_DESC_PREFIX_SIZE		FSCRYPT_KEY_DESC_PREFIX_SIZE
#define FS_MAX_KEY_SIZE			FSCRYPT_MAX_KEY_SIZE
#endif /* !__KERNEL__ */

#endif /* _UAPI_LINUX_FSCRYPT_H */
Commit	Line	Data
7af0ab0d EB	1	/* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
	2	/*
	3	* fscrypt user API
	4	*
	5	* These ioctls can be used on filesystems that support fscrypt. See the
	6	* "User API" section of Documentation/filesystems/fscrypt.rst.
	7	*/
	8	#ifndef _UAPI_LINUX_FSCRYPT_H
	9	#define _UAPI_LINUX_FSCRYPT_H
	10
e933adde	11	#include <linux/ioctl.h>
7af0ab0d EB	12	#include <linux/types.h>
7af0ab0d EB	13
7af0ab0d	14	/* Encryption policy flags */
2336d0de EB	15	#define FSCRYPT_POLICY_FLAGS_PAD_4 0x00
	16	#define FSCRYPT_POLICY_FLAGS_PAD_8 0x01
	17	#define FSCRYPT_POLICY_FLAGS_PAD_16 0x02
	18	#define FSCRYPT_POLICY_FLAGS_PAD_32 0x03
	19	#define FSCRYPT_POLICY_FLAGS_PAD_MASK 0x03
5dae460c	20	#define FSCRYPT_POLICY_FLAG_DIRECT_KEY 0x04
b103fb76	21	#define FSCRYPT_POLICY_FLAG_IV_INO_LBLK_64 0x08
e3b1078b	22	#define FSCRYPT_POLICY_FLAG_IV_INO_LBLK_32 0x10
7af0ab0d EB	23
7af0ab0d EB	24	/* Encryption algorithms */
2336d0de EB	25	#define FSCRYPT_MODE_AES_256_XTS 1
	26	#define FSCRYPT_MODE_AES_256_CTS 4
	27	#define FSCRYPT_MODE_AES_128_CBC 5
	28	#define FSCRYPT_MODE_AES_128_CTS 6
	29	#define FSCRYPT_MODE_ADIANTUM 9
3ceb6543	30	/* If adding a mode number > 9, update FSCRYPT_MODE_MAX in fscrypt_private.h */
7af0ab0d	31
5dae460c EB	32	/*
	33	* Legacy policy version; ad-hoc KDF and no key verification.
	34	* For new encrypted directories, use fscrypt_policy_v2 instead.
	35	*
	36	* Careful: the .version field for this is actually 0, not 1.
	37	*/
	38	#define FSCRYPT_POLICY_V1 0
	39	#define FSCRYPT_KEY_DESCRIPTOR_SIZE 8
	40	struct fscrypt_policy_v1 {
7af0ab0d EB	41	__u8 version;
	42	__u8 contents_encryption_mode;
	43	__u8 filenames_encryption_mode;
	44	__u8 flags;
2336d0de	45	__u8 master_key_descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE];
7af0ab0d EB	46	};
7af0ab0d EB	47
22d94f49 EB	48	/*
	49	* Process-subscribed "logon" key description prefix and payload format.
	50	* Deprecated; prefer FS_IOC_ADD_ENCRYPTION_KEY instead.
	51	*/
2336d0de	52	#define FSCRYPT_KEY_DESC_PREFIX "fscrypt:"
22d94f49 EB	53	#define FSCRYPT_KEY_DESC_PREFIX_SIZE 8
22d94f49 EB	54	#define FSCRYPT_MAX_KEY_SIZE 64
7af0ab0d EB	55	struct fscrypt_key {
7af0ab0d EB	56	__u32 mode;
2336d0de	57	__u8 raw[FSCRYPT_MAX_KEY_SIZE];
7af0ab0d EB	58	__u32 size;
7af0ab0d EB	59	};
22d94f49 EB	60
22d94f49 EB	61	/*
5dae460c EB	62	* New policy version with HKDF and key verification (recommended).
	63	*/
	64	#define FSCRYPT_POLICY_V2 2
	65	#define FSCRYPT_KEY_IDENTIFIER_SIZE 16
	66	struct fscrypt_policy_v2 {
	67	__u8 version;
	68	__u8 contents_encryption_mode;
	69	__u8 filenames_encryption_mode;
	70	__u8 flags;
	71	__u8 __reserved[4];
	72	__u8 master_key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
	73	};
	74
	75	/* Struct passed to FS_IOC_GET_ENCRYPTION_POLICY_EX */
	76	struct fscrypt_get_policy_ex_arg {
	77	__u64 policy_size; /* input/output */
	78	union {
	79	__u8 version;
	80	struct fscrypt_policy_v1 v1;
	81	struct fscrypt_policy_v2 v2;
	82	} policy; /* output */
	83	};
	84
	85	/*
	86	* v1 policy keys are specified by an arbitrary 8-byte key "descriptor",
	87	* matching fscrypt_policy_v1::master_key_descriptor.
22d94f49 EB	88	*/
	89	#define FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR 1
	90
	91	/*
5dae460c EB	92	* v2 policy keys are specified by a 16-byte key "identifier" which the kernel
	93	* calculates as a cryptographic hash of the key itself,
	94	* matching fscrypt_policy_v2::master_key_identifier.
	95	*/
	96	#define FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER 2
	97
	98	/*
	99	* Specifies a key, either for v1 or v2 policies. This doesn't contain the
	100	* actual key itself; this is just the "name" of the key.
22d94f49 EB	101	*/
	102	struct fscrypt_key_specifier {
	103	__u32 type; /* one of FSCRYPT_KEY_SPEC_TYPE_* */
	104	__u32 __reserved;
	105	union {
	106	__u8 __reserved[32]; /* reserve some extra space */
	107	__u8 descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE];
5dae460c	108	__u8 identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
22d94f49 EB	109	} u;
	110	};
	111
93edd392 EB	112	/*
	113	* Payload of Linux keyring key of type "fscrypt-provisioning", referenced by
	114	* fscrypt_add_key_arg::key_id as an alternative to fscrypt_add_key_arg::raw.
	115	*/
	116	struct fscrypt_provisioning_key_payload {
	117	__u32 type;
	118	__u32 __reserved;
	119	__u8 raw[];
	120	};
	121
22d94f49 EB	122	/* Struct passed to FS_IOC_ADD_ENCRYPTION_KEY */
	123	struct fscrypt_add_key_arg {
	124	struct fscrypt_key_specifier key_spec;
	125	__u32 raw_size;
93edd392 EB	126	__u32 key_id;
93edd392 EB	127	__u32 __reserved[8];
22d94f49 EB	128	__u8 raw[];
	129	};
	130
b1c0ec35 EB	131	/* Struct passed to FS_IOC_REMOVE_ENCRYPTION_KEY */
	132	struct fscrypt_remove_key_arg {
	133	struct fscrypt_key_specifier key_spec;
	134	#define FSCRYPT_KEY_REMOVAL_STATUS_FLAG_FILES_BUSY 0x00000001
23c688b5	135	#define FSCRYPT_KEY_REMOVAL_STATUS_FLAG_OTHER_USERS 0x00000002
b1c0ec35 EB	136	__u32 removal_status_flags; /* output */
	137	__u32 __reserved[5];
	138	};
	139
5a7e2992 EB	140	/* Struct passed to FS_IOC_GET_ENCRYPTION_KEY_STATUS */
	141	struct fscrypt_get_key_status_arg {
	142	/* input */
	143	struct fscrypt_key_specifier key_spec;
	144	__u32 __reserved[6];
	145
	146	/* output */
	147	#define FSCRYPT_KEY_STATUS_ABSENT 1
	148	#define FSCRYPT_KEY_STATUS_PRESENT 2
	149	#define FSCRYPT_KEY_STATUS_INCOMPLETELY_REMOVED 3
	150	__u32 status;
23c688b5 EB	151	#define FSCRYPT_KEY_STATUS_FLAG_ADDED_BY_SELF 0x00000001
	152	__u32 status_flags;
	153	__u32 user_count;
	154	__u32 __out_reserved[13];
5a7e2992 EB	155	};
5a7e2992 EB	156
c7f0207b	157	#define FS_IOC_SET_ENCRYPTION_POLICY _IOR('f', 19, struct fscrypt_policy_v1)
22d94f49	158	#define FS_IOC_GET_ENCRYPTION_PWSALT _IOW('f', 20, __u8[16])
c7f0207b	159	#define FS_IOC_GET_ENCRYPTION_POLICY _IOW('f', 21, struct fscrypt_policy_v1)
5dae460c	160	#define FS_IOC_GET_ENCRYPTION_POLICY_EX _IOWR('f', 22, __u8[9]) /* size + version */
22d94f49	161	#define FS_IOC_ADD_ENCRYPTION_KEY _IOWR('f', 23, struct fscrypt_add_key_arg)
b1c0ec35	162	#define FS_IOC_REMOVE_ENCRYPTION_KEY _IOWR('f', 24, struct fscrypt_remove_key_arg)
78a1b96b	163	#define FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS _IOWR('f', 25, struct fscrypt_remove_key_arg)
5a7e2992	164	#define FS_IOC_GET_ENCRYPTION_KEY_STATUS _IOWR('f', 26, struct fscrypt_get_key_status_arg)
e98ad464	165	#define FS_IOC_GET_ENCRYPTION_NONCE _IOR('f', 27, __u8[16])
22d94f49	166
2336d0de EB	167	/**********************************************************************/
	168
	169	/* old names; don't add anything new here! */
3b6df59b	170	#ifndef __KERNEL__
c7f0207b	171	#define fscrypt_policy fscrypt_policy_v1
2336d0de EB	172	#define FS_KEY_DESCRIPTOR_SIZE FSCRYPT_KEY_DESCRIPTOR_SIZE
	173	#define FS_POLICY_FLAGS_PAD_4 FSCRYPT_POLICY_FLAGS_PAD_4
	174	#define FS_POLICY_FLAGS_PAD_8 FSCRYPT_POLICY_FLAGS_PAD_8
	175	#define FS_POLICY_FLAGS_PAD_16 FSCRYPT_POLICY_FLAGS_PAD_16
	176	#define FS_POLICY_FLAGS_PAD_32 FSCRYPT_POLICY_FLAGS_PAD_32
	177	#define FS_POLICY_FLAGS_PAD_MASK FSCRYPT_POLICY_FLAGS_PAD_MASK
	178	#define FS_POLICY_FLAG_DIRECT_KEY FSCRYPT_POLICY_FLAG_DIRECT_KEY
3ceb6543	179	#define FS_POLICY_FLAGS_VALID 0x07 /* contains old flags only */
2336d0de EB	180	#define FS_ENCRYPTION_MODE_INVALID 0 /* never used */
	181	#define FS_ENCRYPTION_MODE_AES_256_XTS FSCRYPT_MODE_AES_256_XTS
	182	#define FS_ENCRYPTION_MODE_AES_256_GCM 2 /* never used */
	183	#define FS_ENCRYPTION_MODE_AES_256_CBC 3 /* never used */
	184	#define FS_ENCRYPTION_MODE_AES_256_CTS FSCRYPT_MODE_AES_256_CTS
	185	#define FS_ENCRYPTION_MODE_AES_128_CBC FSCRYPT_MODE_AES_128_CBC
	186	#define FS_ENCRYPTION_MODE_AES_128_CTS FSCRYPT_MODE_AES_128_CTS
	187	#define FS_ENCRYPTION_MODE_SPECK128_256_XTS 7 /* removed */
	188	#define FS_ENCRYPTION_MODE_SPECK128_256_CTS 8 /* removed */
	189	#define FS_ENCRYPTION_MODE_ADIANTUM FSCRYPT_MODE_ADIANTUM
	190	#define FS_KEY_DESC_PREFIX FSCRYPT_KEY_DESC_PREFIX
	191	#define FS_KEY_DESC_PREFIX_SIZE FSCRYPT_KEY_DESC_PREFIX_SIZE
	192	#define FS_MAX_KEY_SIZE FSCRYPT_MAX_KEY_SIZE
3b6df59b	193	#endif /* !__KERNEL__ */
7af0ab0d EB	194
7af0ab0d EB	195	#endif /* _UAPI_LINUX_FSCRYPT_H */