fs/crypto/fscrypt_private.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 /*
   3  * fscrypt_private.h
   4  *
   5  * Copyright (C) 2015, Google, Inc.
   6  *
   7  * Originally written by Michael Halcrow, Ildar Muslukhov, and Uday Savagaonkar.
   8  * Heavily modified since then.
   9  */
  10
  11 #ifndef _FSCRYPT_PRIVATE_H
  12 #define _FSCRYPT_PRIVATE_H
  13
  14 #include <linux/fscrypt.h>
  15 #include <linux/siphash.h>
  16 #include <crypto/hash.h>
  17
  18 #define CONST_STRLEN(str)       (sizeof(str) - 1)
  19
  20 #define FS_KEY_DERIVATION_NONCE_SIZE    16
  21
  22 #define FSCRYPT_MIN_KEY_SIZE            16
  23
  24 #define FSCRYPT_CONTEXT_V1      1
  25 #define FSCRYPT_CONTEXT_V2      2
  26
  27 struct fscrypt_context_v1 {
  28         u8 version; /* FSCRYPT_CONTEXT_V1 */
  29         u8 contents_encryption_mode;
  30         u8 filenames_encryption_mode;
  31         u8 flags;
  32         u8 master_key_descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE];
  33         u8 nonce[FS_KEY_DERIVATION_NONCE_SIZE];
  34 };
  35
  36 struct fscrypt_context_v2 {
  37         u8 version; /* FSCRYPT_CONTEXT_V2 */
  38         u8 contents_encryption_mode;
  39         u8 filenames_encryption_mode;
  40         u8 flags;
  41         u8 __reserved[4];
  42         u8 master_key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
  43         u8 nonce[FS_KEY_DERIVATION_NONCE_SIZE];
  44 };
  45
  46 /**
  47  * fscrypt_context - the encryption context of an inode
  48  *
  49  * This is the on-disk equivalent of an fscrypt_policy, stored alongside each
  50  * encrypted file usually in a hidden extended attribute.  It contains the
  51  * fields from the fscrypt_policy, in order to identify the encryption algorithm
  52  * and key with which the file is encrypted.  It also contains a nonce that was
  53  * randomly generated by fscrypt itself; this is used as KDF input or as a tweak
  54  * to cause different files to be encrypted differently.
  55  */
  56 union fscrypt_context {
  57         u8 version;
  58         struct fscrypt_context_v1 v1;
  59         struct fscrypt_context_v2 v2;
  60 };
  61
  62 /*
  63  * Return the size expected for the given fscrypt_context based on its version
  64  * number, or 0 if the context version is unrecognized.
  65  */
  66 static inline int fscrypt_context_size(const union fscrypt_context *ctx)
  67 {
  68         switch (ctx->version) {
  69         case FSCRYPT_CONTEXT_V1:
  70                 BUILD_BUG_ON(sizeof(ctx->v1) != 28);
  71                 return sizeof(ctx->v1);
  72         case FSCRYPT_CONTEXT_V2:
  73                 BUILD_BUG_ON(sizeof(ctx->v2) != 40);
  74                 return sizeof(ctx->v2);
  75         }
  76         return 0;
  77 }
  78
  79 /* Check whether an fscrypt_context has a recognized version number and size */
  80 static inline bool fscrypt_context_is_valid(const union fscrypt_context *ctx,
  81                                             int ctx_size)
  82 {
  83         return ctx_size >= 1 && ctx_size == fscrypt_context_size(ctx);
  84 }
  85
  86 /* Retrieve the context's nonce, assuming the context was already validated */
  87 static inline const u8 *fscrypt_context_nonce(const union fscrypt_context *ctx)
  88 {
  89         switch (ctx->version) {
  90         case FSCRYPT_CONTEXT_V1:
  91                 return ctx->v1.nonce;
  92         case FSCRYPT_CONTEXT_V2:
  93                 return ctx->v2.nonce;
  94         }
  95         WARN_ON(1);
  96         return NULL;
  97 }
  98
  99 #undef fscrypt_policy
 100 union fscrypt_policy {
 101         u8 version;
 102         struct fscrypt_policy_v1 v1;
 103         struct fscrypt_policy_v2 v2;
 104 };
 105
 106 /*
 107  * Return the size expected for the given fscrypt_policy based on its version
 108  * number, or 0 if the policy version is unrecognized.
 109  */
 110 static inline int fscrypt_policy_size(const union fscrypt_policy *policy)
 111 {
 112         switch (policy->version) {
 113         case FSCRYPT_POLICY_V1:
 114                 return sizeof(policy->v1);
 115         case FSCRYPT_POLICY_V2:
 116                 return sizeof(policy->v2);
 117         }
 118         return 0;
 119 }
 120
 121 /* Return the contents encryption mode of a valid encryption policy */
 122 static inline u8
 123 fscrypt_policy_contents_mode(const union fscrypt_policy *policy)
 124 {
 125         switch (policy->version) {
 126         case FSCRYPT_POLICY_V1:
 127                 return policy->v1.contents_encryption_mode;
 128         case FSCRYPT_POLICY_V2:
 129                 return policy->v2.contents_encryption_mode;
 130         }
 131         BUG();
 132 }
 133
 134 /* Return the filenames encryption mode of a valid encryption policy */
 135 static inline u8
 136 fscrypt_policy_fnames_mode(const union fscrypt_policy *policy)
 137 {
 138         switch (policy->version) {
 139         case FSCRYPT_POLICY_V1:
 140                 return policy->v1.filenames_encryption_mode;
 141         case FSCRYPT_POLICY_V2:
 142                 return policy->v2.filenames_encryption_mode;
 143         }
 144         BUG();
 145 }
 146
 147 /* Return the flags (FSCRYPT_POLICY_FLAG*) of a valid encryption policy */
 148 static inline u8
 149 fscrypt_policy_flags(const union fscrypt_policy *policy)
 150 {
 151         switch (policy->version) {
 152         case FSCRYPT_POLICY_V1:
 153                 return policy->v1.flags;
 154         case FSCRYPT_POLICY_V2:
 155                 return policy->v2.flags;
 156         }
 157         BUG();
 158 }
 159
 160 /**
 161  * For encrypted symlinks, the ciphertext length is stored at the beginning
 162  * of the string in little-endian format.
 163  */
 164 struct fscrypt_symlink_data {
 165         __le16 len;
 166         char encrypted_path[1];
 167 } __packed;
 168
 169 /*
 170  * fscrypt_info - the "encryption key" for an inode
 171  *
 172  * When an encrypted file's key is made available, an instance of this struct is
 173  * allocated and stored in ->i_crypt_info.  Once created, it remains until the
 174  * inode is evicted.
 175  */
 176 struct fscrypt_info {
 177
 178         /* The actual crypto transform used for encryption and decryption */
 179         struct crypto_skcipher *ci_ctfm;
 180
 181         /* True if the key should be freed when this fscrypt_info is freed */
 182         bool ci_owns_key;
 183
 184         /*
 185          * Encryption mode used for this inode.  It corresponds to either the
 186          * contents or filenames encryption mode, depending on the inode type.
 187          */
 188         struct fscrypt_mode *ci_mode;
 189
 190         /* Back-pointer to the inode */
 191         struct inode *ci_inode;
 192
 193         /*
 194          * The master key with which this inode was unlocked (decrypted).  This
 195          * will be NULL if the master key was found in a process-subscribed
 196          * keyring rather than in the filesystem-level keyring.
 197          */
 198         struct key *ci_master_key;
 199
 200         /*
 201          * Link in list of inodes that were unlocked with the master key.
 202          * Only used when ->ci_master_key is set.
 203          */
 204         struct list_head ci_master_key_link;
 205
 206         /*
 207          * If non-NULL, then encryption is done using the master key directly
 208          * and ci_ctfm will equal ci_direct_key->dk_ctfm.
 209          */
 210         struct fscrypt_direct_key *ci_direct_key;
 211
 212         /*
 213          * This inode's hash key for filenames.  This is a 128-bit SipHash-2-4
 214          * key.  This is only set for directories that use a keyed dirhash over
 215          * the plaintext filenames -- currently just casefolded directories.
 216          */
 217         siphash_key_t ci_dirhash_key;
 218         bool ci_dirhash_key_initialized;
 219
 220         /* The encryption policy used by this inode */
 221         union fscrypt_policy ci_policy;
 222
 223         /* This inode's nonce, copied from the fscrypt_context */
 224         u8 ci_nonce[FS_KEY_DERIVATION_NONCE_SIZE];
 225 };
 226
 227 typedef enum {
 228         FS_DECRYPT = 0,
 229         FS_ENCRYPT,
 230 } fscrypt_direction_t;
 231
 232 /* crypto.c */
 233 extern struct kmem_cache *fscrypt_info_cachep;
 234 extern int fscrypt_initialize(unsigned int cop_flags);
 235 extern int fscrypt_crypt_block(const struct inode *inode,
 236                                fscrypt_direction_t rw, u64 lblk_num,
 237                                struct page *src_page, struct page *dest_page,
 238                                unsigned int len, unsigned int offs,
 239                                gfp_t gfp_flags);
 240 extern struct page *fscrypt_alloc_bounce_page(gfp_t gfp_flags);
 241
 242 extern void __printf(3, 4) __cold
 243 fscrypt_msg(const struct inode *inode, const char *level, const char *fmt, ...);
 244
 245 #define fscrypt_warn(inode, fmt, ...)           \
 246         fscrypt_msg((inode), KERN_WARNING, fmt, ##__VA_ARGS__)
 247 #define fscrypt_err(inode, fmt, ...)            \
 248         fscrypt_msg((inode), KERN_ERR, fmt, ##__VA_ARGS__)
 249
 250 #define FSCRYPT_MAX_IV_SIZE     32
 251
 252 union fscrypt_iv {
 253         struct {
 254                 /* logical block number within the file */
 255                 __le64 lblk_num;
 256
 257                 /* per-file nonce; only set in DIRECT_KEY mode */
 258                 u8 nonce[FS_KEY_DERIVATION_NONCE_SIZE];
 259         };
 260         u8 raw[FSCRYPT_MAX_IV_SIZE];
 261 };
 262
 263 void fscrypt_generate_iv(union fscrypt_iv *iv, u64 lblk_num,
 264                          const struct fscrypt_info *ci);
 265
 266 /* fname.c */
 267 extern int fscrypt_fname_encrypt(const struct inode *inode,
 268                                  const struct qstr *iname,
 269                                  u8 *out, unsigned int olen);
 270 extern bool fscrypt_fname_encrypted_size(const struct inode *inode,
 271                                          u32 orig_len, u32 max_len,
 272                                          u32 *encrypted_len_ret);
 273 extern const struct dentry_operations fscrypt_d_ops;
 274
 275 /* hkdf.c */
 276
 277 struct fscrypt_hkdf {
 278         struct crypto_shash *hmac_tfm;
 279 };
 280
 281 extern int fscrypt_init_hkdf(struct fscrypt_hkdf *hkdf, const u8 *master_key,
 282                              unsigned int master_key_size);
 283
 284 /*
 285  * The list of contexts in which fscrypt uses HKDF.  These values are used as
 286  * the first byte of the HKDF application-specific info string to guarantee that
 287  * info strings are never repeated between contexts.  This ensures that all HKDF
 288  * outputs are unique and cryptographically isolated, i.e. knowledge of one
 289  * output doesn't reveal another.
 290  */
 291 #define HKDF_CONTEXT_KEY_IDENTIFIER     1
 292 #define HKDF_CONTEXT_PER_FILE_ENC_KEY   2
 293 #define HKDF_CONTEXT_DIRECT_KEY         3
 294 #define HKDF_CONTEXT_IV_INO_LBLK_64_KEY 4
 295 #define HKDF_CONTEXT_DIRHASH_KEY        5
 296
 297 extern int fscrypt_hkdf_expand(const struct fscrypt_hkdf *hkdf, u8 context,
 298                                const u8 *info, unsigned int infolen,
 299                                u8 *okm, unsigned int okmlen);
 300
 301 extern void fscrypt_destroy_hkdf(struct fscrypt_hkdf *hkdf);
 302
 303 /* keyring.c */
 304
 305 /*
 306  * fscrypt_master_key_secret - secret key material of an in-use master key
 307  */
 308 struct fscrypt_master_key_secret {
 309
 310         /*
 311          * For v2 policy keys: HKDF context keyed by this master key.
 312          * For v1 policy keys: not set (hkdf.hmac_tfm == NULL).
 313          */
 314         struct fscrypt_hkdf     hkdf;
 315
 316         /* Size of the raw key in bytes.  Set even if ->raw isn't set. */
 317         u32                     size;
 318
 319         /* For v1 policy keys: the raw key.  Wiped for v2 policy keys. */
 320         u8                      raw[FSCRYPT_MAX_KEY_SIZE];
 321
 322 } __randomize_layout;
 323
 324 /*
 325  * fscrypt_master_key - an in-use master key
 326  *
 327  * This represents a master encryption key which has been added to the
 328  * filesystem and can be used to "unlock" the encrypted files which were
 329  * encrypted with it.
 330  */
 331 struct fscrypt_master_key {
 332
 333         /*
 334          * The secret key material.  After FS_IOC_REMOVE_ENCRYPTION_KEY is
 335          * executed, this is wiped and no new inodes can be unlocked with this
 336          * key; however, there may still be inodes in ->mk_decrypted_inodes
 337          * which could not be evicted.  As long as some inodes still remain,
 338          * FS_IOC_REMOVE_ENCRYPTION_KEY can be retried, or
 339          * FS_IOC_ADD_ENCRYPTION_KEY can add the secret again.
 340          *
 341          * Locking: protected by key->sem (outer) and mk_secret_sem (inner).
 342          * The reason for two locks is that key->sem also protects modifying
 343          * mk_users, which ranks it above the semaphore for the keyring key
 344          * type, which is in turn above page faults (via keyring_read).  But
 345          * sometimes filesystems call fscrypt_get_encryption_info() from within
 346          * a transaction, which ranks it below page faults.  So we need a
 347          * separate lock which protects mk_secret but not also mk_users.
 348          */
 349         struct fscrypt_master_key_secret        mk_secret;
 350         struct rw_semaphore                     mk_secret_sem;
 351
 352         /*
 353          * For v1 policy keys: an arbitrary key descriptor which was assigned by
 354          * userspace (->descriptor).
 355          *
 356          * For v2 policy keys: a cryptographic hash of this key (->identifier).
 357          */
 358         struct fscrypt_key_specifier            mk_spec;
 359
 360         /*
 361          * Keyring which contains a key of type 'key_type_fscrypt_user' for each
 362          * user who has added this key.  Normally each key will be added by just
 363          * one user, but it's possible that multiple users share a key, and in
 364          * that case we need to keep track of those users so that one user can't
 365          * remove the key before the others want it removed too.
 366          *
 367          * This is NULL for v1 policy keys; those can only be added by root.
 368          *
 369          * Locking: in addition to this keyrings own semaphore, this is
 370          * protected by the master key's key->sem, so we can do atomic
 371          * search+insert.  It can also be searched without taking any locks, but
 372          * in that case the returned key may have already been removed.
 373          */
 374         struct key              *mk_users;
 375
 376         /*
 377          * Length of ->mk_decrypted_inodes, plus one if mk_secret is present.
 378          * Once this goes to 0, the master key is removed from ->s_master_keys.
 379          * The 'struct fscrypt_master_key' will continue to live as long as the
 380          * 'struct key' whose payload it is, but we won't let this reference
 381          * count rise again.
 382          */
 383         refcount_t              mk_refcount;
 384
 385         /*
 386          * List of inodes that were unlocked using this key.  This allows the
 387          * inodes to be evicted efficiently if the key is removed.
 388          */
 389         struct list_head        mk_decrypted_inodes;
 390         spinlock_t              mk_decrypted_inodes_lock;
 391
 392         /* Crypto API transforms for DIRECT_KEY policies, allocated on-demand */
 393         struct crypto_skcipher  *mk_direct_tfms[__FSCRYPT_MODE_MAX + 1];
 394
 395         /*
 396          * Crypto API transforms for filesystem-layer implementation of
 397          * IV_INO_LBLK_64 policies, allocated on-demand.
 398          */
 399         struct crypto_skcipher  *mk_iv_ino_lblk_64_tfms[__FSCRYPT_MODE_MAX + 1];
 400
 401 } __randomize_layout;
 402
 403 static inline bool
 404 is_master_key_secret_present(const struct fscrypt_master_key_secret *secret)
 405 {
 406         /*
 407          * The READ_ONCE() is only necessary for fscrypt_drop_inode() and
 408          * fscrypt_key_describe().  These run in atomic context, so they can't
 409          * take ->mk_secret_sem and thus 'secret' can change concurrently which
 410          * would be a data race.  But they only need to know whether the secret
 411          * *was* present at the time of check, so READ_ONCE() suffices.
 412          */
 413         return READ_ONCE(secret->size) != 0;
 414 }
 415
 416 static inline const char *master_key_spec_type(
 417                                 const struct fscrypt_key_specifier *spec)
 418 {
 419         switch (spec->type) {
 420         case FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR:
 421                 return "descriptor";
 422         case FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER:
 423                 return "identifier";
 424         }
 425         return "[unknown]";
 426 }
 427
 428 static inline int master_key_spec_len(const struct fscrypt_key_specifier *spec)
 429 {
 430         switch (spec->type) {
 431         case FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR:
 432                 return FSCRYPT_KEY_DESCRIPTOR_SIZE;
 433         case FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER:
 434                 return FSCRYPT_KEY_IDENTIFIER_SIZE;
 435         }
 436         return 0;
 437 }
 438
 439 extern struct key *
 440 fscrypt_find_master_key(struct super_block *sb,
 441                         const struct fscrypt_key_specifier *mk_spec);
 442
 443 extern int fscrypt_verify_key_added(struct super_block *sb,
 444                                     const u8 identifier[FSCRYPT_KEY_IDENTIFIER_SIZE]);
 445
 446 extern int __init fscrypt_init_keyring(void);
 447
 448 /* keysetup.c */
 449
 450 struct fscrypt_mode {
 451         const char *friendly_name;
 452         const char *cipher_str;
 453         int keysize;
 454         int ivsize;
 455         int logged_impl_name;
 456 };
 457
 458 extern struct fscrypt_mode fscrypt_modes[];
 459
 460 extern struct crypto_skcipher *
 461 fscrypt_allocate_skcipher(struct fscrypt_mode *mode, const u8 *raw_key,
 462                           const struct inode *inode);
 463
 464 extern int fscrypt_set_per_file_enc_key(struct fscrypt_info *ci,
 465                                         const u8 *raw_key);
 466
 467 extern int fscrypt_derive_dirhash_key(struct fscrypt_info *ci,
 468                                       const struct fscrypt_master_key *mk);
 469
 470 /* keysetup_v1.c */
 471
 472 extern void fscrypt_put_direct_key(struct fscrypt_direct_key *dk);
 473
 474 extern int fscrypt_setup_v1_file_key(struct fscrypt_info *ci,
 475                                      const u8 *raw_master_key);
 476
 477 extern int fscrypt_setup_v1_file_key_via_subscribed_keyrings(
 478                                         struct fscrypt_info *ci);
 479 /* policy.c */
 480
 481 extern bool fscrypt_policies_equal(const union fscrypt_policy *policy1,
 482                                    const union fscrypt_policy *policy2);
 483 extern bool fscrypt_supported_policy(const union fscrypt_policy *policy_u,
 484                                      const struct inode *inode);
 485 extern int fscrypt_policy_from_context(union fscrypt_policy *policy_u,
 486                                        const union fscrypt_context *ctx_u,
 487                                        int ctx_size);
 488
 489 #endif /* _FSCRYPT_PRIVATE_H */