libcfs/include/uapi/linux/llcrypt.h

   1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   2 /*
   3  * llcrypt user API
   4  *
   5  * These ioctls can be used on filesystems that support llcrypt.  See the
   6  * "User API" section of Documentation/filesystems/llcrypt.rst.
   7  */
   8 /*
   9  * Linux commit 219d54332a09
  10  * tags/v5.4
  11  */
  12 #ifndef _UAPI_LINUX_LLCRYPT_H
  13 #define _UAPI_LINUX_LLCRYPT_H
  14
  15 #include <linux/types.h>
  16
  17 /* Encryption policy flags */
  18 #define LLCRYPT_POLICY_FLAGS_PAD_4              0x00
  19 #define LLCRYPT_POLICY_FLAGS_PAD_8              0x01
  20 #define LLCRYPT_POLICY_FLAGS_PAD_16             0x02
  21 #define LLCRYPT_POLICY_FLAGS_PAD_32             0x03
  22 #define LLCRYPT_POLICY_FLAGS_PAD_MASK           0x03
  23 #define LLCRYPT_POLICY_FLAG_DIRECT_KEY          0x04
  24 #define LLCRYPT_POLICY_FLAGS_VALID              0x07
  25
  26 /* Encryption algorithms */
  27 #define LLCRYPT_MODE_NULL                       0
  28 #define LLCRYPT_MODE_AES_256_XTS                1
  29 #define LLCRYPT_MODE_AES_256_CTS                4
  30 #define LLCRYPT_MODE_AES_128_CBC                5
  31 #define LLCRYPT_MODE_AES_128_CTS                6
  32 #define LLCRYPT_MODE_ADIANTUM                   9
  33 #define __LLCRYPT_MODE_MAX                      9
  34
  35 /*
  36  * Legacy policy version; ad-hoc KDF and no key verification.
  37  * For new encrypted directories, use llcrypt_policy_v2 instead.
  38  *
  39  * Careful: the .version field for this is actually 0, not 1.
  40  */
  41 #define LLCRYPT_POLICY_V1               0
  42 #define LLCRYPT_KEY_DESCRIPTOR_SIZE     8
  43 struct llcrypt_policy_v1 {
  44         __u8 version;
  45         __u8 contents_encryption_mode;
  46         __u8 filenames_encryption_mode;
  47         __u8 flags;
  48         __u8 master_key_descriptor[LLCRYPT_KEY_DESCRIPTOR_SIZE];
  49 };
  50 #define llcrypt_policy  llcrypt_policy_v1
  51
  52 /*
  53  * Process-subscribed "logon" key description prefix and payload format.
  54  * Deprecated; prefer LL_IOC_ADD_ENCRYPTION_KEY instead.
  55  */
  56 #define LLCRYPT_KEY_DESC_PREFIX         "fscrypt:"
  57 #define LLCRYPT_KEY_DESC_PREFIX_SIZE    8
  58 #define LLCRYPT_MAX_KEY_SIZE            64
  59 struct llcrypt_key {
  60         __u32 mode;
  61         __u8 raw[LLCRYPT_MAX_KEY_SIZE];
  62         __u32 size;
  63 };
  64
  65 /*
  66  * New policy version with HKDF and key verification (recommended).
  67  */
  68 #define LLCRYPT_POLICY_V2               2
  69 #define LLCRYPT_KEY_IDENTIFIER_SIZE     16
  70 struct llcrypt_policy_v2 {
  71         __u8 version;
  72         __u8 contents_encryption_mode;
  73         __u8 filenames_encryption_mode;
  74         __u8 flags;
  75         __u8 __reserved[4];
  76         __u8 master_key_identifier[LLCRYPT_KEY_IDENTIFIER_SIZE];
  77 };
  78
  79 /* Struct passed to LL_IOC_GET_ENCRYPTION_POLICY_EX */
  80 struct llcrypt_get_policy_ex_arg {
  81         __u64 policy_size; /* input/output */
  82         union {
  83                 __u8 version;
  84                 struct llcrypt_policy_v1 v1;
  85                 struct llcrypt_policy_v2 v2;
  86         } policy; /* output */
  87 };
  88
  89 /*
  90  * v1 policy keys are specified by an arbitrary 8-byte key "descriptor",
  91  * matching llcrypt_policy_v1::master_key_descriptor.
  92  */
  93 #define LLCRYPT_KEY_SPEC_TYPE_DESCRIPTOR        1
  94
  95 /*
  96  * v2 policy keys are specified by a 16-byte key "identifier" which the kernel
  97  * calculates as a cryptographic hash of the key itself,
  98  * matching llcrypt_policy_v2::master_key_identifier.
  99  */
 100 #define LLCRYPT_KEY_SPEC_TYPE_IDENTIFIER        2
 101
 102 /*
 103  * Specifies a key, either for v1 or v2 policies.  This doesn't contain the
 104  * actual key itself; this is just the "name" of the key.
 105  */
 106 struct llcrypt_key_specifier {
 107         __u32 type;     /* one of LLCRYPT_KEY_SPEC_TYPE_* */
 108         __u32 __reserved;
 109         union {
 110                 __u8 __reserved[32]; /* reserve some extra space */
 111                 __u8 descriptor[LLCRYPT_KEY_DESCRIPTOR_SIZE];
 112                 __u8 identifier[LLCRYPT_KEY_IDENTIFIER_SIZE];
 113         } u;
 114 };
 115
 116 /* Struct passed to LL_IOC_ADD_ENCRYPTION_KEY */
 117 struct llcrypt_add_key_arg {
 118         struct llcrypt_key_specifier key_spec;
 119         __u32 raw_size;
 120         __u32 __reserved[9];
 121         __u8 raw[];
 122 };
 123
 124 /* Struct passed to LL_IOC_REMOVE_ENCRYPTION_KEY */
 125 struct llcrypt_remove_key_arg {
 126         struct llcrypt_key_specifier key_spec;
 127 #define LLCRYPT_KEY_REMOVAL_STATUS_FLAG_FILES_BUSY      0x00000001
 128 #define LLCRYPT_KEY_REMOVAL_STATUS_FLAG_OTHER_USERS     0x00000002
 129         __u32 removal_status_flags;     /* output */
 130         __u32 __reserved[5];
 131 };
 132
 133 /* Struct passed to LL_IOC_GET_ENCRYPTION_KEY_STATUS */
 134 struct llcrypt_get_key_status_arg {
 135         /* input */
 136         struct llcrypt_key_specifier key_spec;
 137         __u32 __reserved[6];
 138
 139         /* output */
 140 #define LLCRYPT_KEY_STATUS_ABSENT               1
 141 #define LLCRYPT_KEY_STATUS_PRESENT              2
 142 #define LLCRYPT_KEY_STATUS_INCOMPLETELY_REMOVED 3
 143         __u32 status;
 144 #define LLCRYPT_KEY_STATUS_FLAG_ADDED_BY_SELF   0x00000001
 145         __u32 status_flags;
 146         __u32 user_count;
 147         __u32 __out_reserved[13];
 148 };
 149
 150 #define LL_IOC_SET_ENCRYPTION_POLICY            _IOR('f', 19, struct llcrypt_policy)
 151 #define LL_IOC_GET_ENCRYPTION_PWSALT            _IOW('f', 20, __u8[16])
 152 #define LL_IOC_GET_ENCRYPTION_POLICY            _IOW('f', 21, struct llcrypt_policy)
 153 #define LL_IOC_GET_ENCRYPTION_POLICY_EX         _IOWR('f', 22, __u8[9]) /* size + version */
 154 #define LL_IOC_ADD_ENCRYPTION_KEY               _IOWR('f', 23, struct llcrypt_add_key_arg)
 155 #define LL_IOC_REMOVE_ENCRYPTION_KEY            _IOWR('f', 24, struct llcrypt_remove_key_arg)
 156 #define LL_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS  _IOWR('f', 25, struct llcrypt_remove_key_arg)
 157 #define LL_IOC_GET_ENCRYPTION_KEY_STATUS        _IOWR('f', 26, struct llcrypt_get_key_status_arg)
 158
 159 /**********************************************************************/
 160
 161 /* old names; don't add anything new here! */
 162 #ifndef __KERNEL__
 163 #define LL_KEY_DESCRIPTOR_SIZE          LLCRYPT_KEY_DESCRIPTOR_SIZE
 164 #define LL_POLICY_FLAGS_PAD_4           LLCRYPT_POLICY_FLAGS_PAD_4
 165 #define LL_POLICY_FLAGS_PAD_8           LLCRYPT_POLICY_FLAGS_PAD_8
 166 #define LL_POLICY_FLAGS_PAD_16          LLCRYPT_POLICY_FLAGS_PAD_16
 167 #define LL_POLICY_FLAGS_PAD_32          LLCRYPT_POLICY_FLAGS_PAD_32
 168 #define LL_POLICY_FLAGS_PAD_MASK        LLCRYPT_POLICY_FLAGS_PAD_MASK
 169 #define LL_POLICY_FLAG_DIRECT_KEY       LLCRYPT_POLICY_FLAG_DIRECT_KEY
 170 #define LL_POLICY_FLAGS_VALID           LLCRYPT_POLICY_FLAGS_VALID
 171 #define LL_ENCRYPTION_MODE_INVALID      0       /* never used */
 172 #define LL_ENCRYPTION_MODE_AES_256_XTS  LLCRYPT_MODE_AES_256_XTS
 173 #define LL_ENCRYPTION_MODE_AES_256_GCM  2       /* never used */
 174 #define LL_ENCRYPTION_MODE_AES_256_CBC  3       /* never used */
 175 #define LL_ENCRYPTION_MODE_AES_256_CTS  LLCRYPT_MODE_AES_256_CTS
 176 #define LL_ENCRYPTION_MODE_AES_128_CBC  LLCRYPT_MODE_AES_128_CBC
 177 #define LL_ENCRYPTION_MODE_AES_128_CTS  LLCRYPT_MODE_AES_128_CTS
 178 #define LL_ENCRYPTION_MODE_SPECK128_256_XTS     7       /* removed */
 179 #define LL_ENCRYPTION_MODE_SPECK128_256_CTS     8       /* removed */
 180 #define LL_ENCRYPTION_MODE_ADIANTUM     LLCRYPT_MODE_ADIANTUM
 181 #define LL_KEY_DESC_PREFIX              LLCRYPT_KEY_DESC_PREFIX
 182 #define LL_KEY_DESC_PREFIX_SIZE         LLCRYPT_KEY_DESC_PREFIX_SIZE
 183 #define LL_MAX_KEY_SIZE                 LLCRYPT_MAX_KEY_SIZE
 184 #endif /* !__KERNEL__ */
 185
 186 #endif /* _UAPI_LINUX_LLCRYPT_H */