lustre/llite/crypto.c

   1 /*
   2  * GPL HEADER START
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 2 only,
   8  * as published by the Free Software Foundation.
   9  *
  10  * This program is distributed in the hope that it will be useful, but
  11  * WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * General Public License version 2 for more details (a copy is included
  14  * in the LICENSE file that accompanied this code).
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * version 2 along with this program; If not, see
  18  * http://www.gnu.org/licenses/gpl-2.0.html
  19  *
  20  * GPL HEADER END
  21  */
  22 /*
  23  * Copyright (c) 2019, 2020, Whamcloud.
  24  */
  25 /*
  26  * This file is part of Lustre, http://www.lustre.org/
  27  */
  28
  29 #include "llite_internal.h"
  30
  31 #ifdef HAVE_LUSTRE_CRYPTO
  32 #include <libcfs/libcfs_crypto.h>
  33
  34 static int ll_get_context(struct inode *inode, void *ctx, size_t len)
  35 {
  36         struct dentry *dentry = d_find_any_alias(inode);
  37         struct lu_env *env;
  38         __u16 refcheck;
  39         int rc;
  40
  41         env = cl_env_get(&refcheck);
  42         if (IS_ERR(env))
  43                 return PTR_ERR(env);
  44
  45         /* Set lcc_getencctx=1 to allow this thread to read
  46          * LL_XATTR_NAME_ENCRYPTION_CONTEXT xattr, as requested by llcrypt.
  47          */
  48         ll_cl_add(inode, env, NULL, LCC_RW);
  49         ll_env_info(env)->lti_io_ctx.lcc_getencctx = 1;
  50
  51         rc = ll_vfs_getxattr(dentry, inode, LL_XATTR_NAME_ENCRYPTION_CONTEXT,
  52                              ctx, len);
  53
  54         ll_cl_remove(inode, env);
  55         cl_env_put(env, &refcheck);
  56
  57         if (dentry)
  58                 dput(dentry);
  59
  60         /* used as encryption unit size */
  61         if (S_ISREG(inode->i_mode))
  62                 inode->i_blkbits = LUSTRE_ENCRYPTION_BLOCKBITS;
  63         return rc;
  64 }
  65
  66 int ll_set_encflags(struct inode *inode, void *encctx, __u32 encctxlen,
  67                     bool preload)
  68 {
  69         unsigned int ext_flags;
  70         int rc = 0;
  71
  72         /* used as encryption unit size */
  73         if (S_ISREG(inode->i_mode))
  74                 inode->i_blkbits = LUSTRE_ENCRYPTION_BLOCKBITS;
  75         ext_flags = ll_inode_to_ext_flags(inode->i_flags) | LUSTRE_ENCRYPT_FL;
  76         ll_update_inode_flags(inode, ext_flags);
  77
  78         if (encctx && encctxlen)
  79                 rc = ll_xattr_cache_insert(inode,
  80                                            LL_XATTR_NAME_ENCRYPTION_CONTEXT,
  81                                            encctx, encctxlen);
  82         if (rc)
  83                 return rc;
  84
  85         return preload ? llcrypt_get_encryption_info(inode) : 0;
  86 }
  87
  88 /* ll_set_context has 2 distinct behaviors, depending on the value of inode
  89  * parameter:
  90  * - inode is NULL:
  91  *   passed fs_data is a struct md_op_data *. We need to store enc ctx in
  92  *   op_data, so that it will be sent along to the server with the request that
  93  *   the caller is preparing, thus saving a setxattr request.
  94  * - inode is not NULL:
  95  *   normal case in which passed fs_data is a struct dentry *, letting proceed
  96  *   with setxattr operation.
  97  *   This use case should only be used when explicitly setting a new encryption
  98  *   policy on an existing, empty directory.
  99  */
 100 static int ll_set_context(struct inode *inode, const void *ctx, size_t len,
 101                           void *fs_data)
 102 {
 103         struct dentry *dentry;
 104         int rc;
 105
 106         if (inode == NULL) {
 107                 struct md_op_data *op_data = (struct md_op_data *)fs_data;
 108
 109                 if (!op_data)
 110                         return -EINVAL;
 111
 112                 OBD_ALLOC(op_data->op_file_encctx, len);
 113                 if (op_data->op_file_encctx == NULL)
 114                         return -ENOMEM;
 115                 op_data->op_file_encctx_size = len;
 116                 memcpy(op_data->op_file_encctx, ctx, len);
 117                 return 0;
 118         }
 119
 120         /* Encrypting the root directory is not allowed */
 121         if (is_root_inode(inode))
 122                 return -EPERM;
 123
 124         dentry = (struct dentry *)fs_data;
 125         set_bit(LLIF_SET_ENC_CTX, &ll_i2info(inode)->lli_flags);
 126         rc = ll_vfs_setxattr(dentry, inode, LL_XATTR_NAME_ENCRYPTION_CONTEXT,
 127                              ctx, len, XATTR_CREATE);
 128         if (rc)
 129                 return rc;
 130
 131         return ll_set_encflags(inode, (void *)ctx, len, false);
 132 }
 133
 134 void llcrypt_free_ctx(void *encctx, __u32 size)
 135 {
 136         if (encctx)
 137                 OBD_FREE(encctx, size);
 138 }
 139
 140 bool ll_sbi_has_test_dummy_encryption(struct ll_sb_info *sbi)
 141 {
 142         return unlikely(sbi->ll_flags & LL_SBI_TEST_DUMMY_ENCRYPTION);
 143 }
 144
 145 static bool ll_dummy_context(struct inode *inode)
 146 {
 147         struct ll_sb_info *sbi = ll_i2sbi(inode);
 148
 149         return sbi ? ll_sbi_has_test_dummy_encryption(sbi) : false;
 150 }
 151
 152 bool ll_sbi_has_encrypt(struct ll_sb_info *sbi)
 153 {
 154         return sbi->ll_flags & LL_SBI_ENCRYPT;
 155 }
 156
 157 void ll_sbi_set_encrypt(struct ll_sb_info *sbi, bool set)
 158 {
 159         if (set)
 160                 sbi->ll_flags |= LL_SBI_ENCRYPT;
 161         else
 162                 sbi->ll_flags &=
 163                         ~(LL_SBI_ENCRYPT | LL_SBI_TEST_DUMMY_ENCRYPTION);
 164 }
 165
 166 static bool ll_empty_dir(struct inode *inode)
 167 {
 168         /* used by llcrypt_ioctl_set_policy(), because a policy can only be set
 169          * on an empty dir.
 170          */
 171         /* Here we choose to return true, meaning we always call .set_context.
 172          * Then we rely on server side, with mdd_fix_attr() that calls
 173          * mdd_dir_is_empty() when setting encryption flag on directory.
 174          */
 175         return true;
 176 }
 177
 178 /**
 179  * ll_setup_filename() - overlay to llcrypt_setup_filename
 180  * @dir: the directory that will be searched
 181  * @iname: the user-provided filename being searched for
 182  * @lookup: 1 if we're allowed to proceed without the key because it's
 183  *      ->lookup() or we're finding the dir_entry for deletion; 0 if we cannot
 184  *      proceed without the key because we're going to create the dir_entry.
 185  * @fname: the filename information to be filled in
 186  * @fid: fid retrieved from user-provided filename
 187  *
 188  * This overlay function is necessary to properly encode @fname after
 189  * encryption, as it will be sent over the wire.
 190  * This overlay function is also necessary to handle the case of operations
 191  * carried out without the key. Normally llcrypt makes use of digested names in
 192  * that case. Having a digested name works for local file systems that can call
 193  * llcrypt_match_name(), but Lustre server side is not aware of encryption.
 194  * So for keyless @lookup operations on long names, for Lustre we choose to
 195  * present to users the encoded struct ll_digest_filename, instead of a digested
 196  * name. FID and name hash can then easily be extracted and put into the
 197  * requests sent to servers.
 198  */
 199 int ll_setup_filename(struct inode *dir, const struct qstr *iname,
 200                       int lookup, struct llcrypt_name *fname,
 201                       struct lu_fid *fid)
 202 {
 203         int digested = 0;
 204         struct qstr dname;
 205         int rc;
 206
 207         if (fid && IS_ENCRYPTED(dir) && !llcrypt_has_encryption_key(dir) &&
 208             iname->name[0] == '_')
 209                 digested = 1;
 210
 211         dname.name = iname->name + digested;
 212         dname.len = iname->len - digested;
 213
 214         if (fid) {
 215                 fid->f_seq = 0;
 216                 fid->f_oid = 0;
 217                 fid->f_ver = 0;
 218         }
 219         rc = llcrypt_setup_filename(dir, &dname, lookup, fname);
 220         if (rc)
 221                 return rc;
 222
 223         if (digested) {
 224                 /* Without the key, for long names user should have struct
 225                  * ll_digest_filename representation of the dentry instead of
 226                  * the name. So make sure it is valid, return fid and put
 227                  * excerpt of cipher text name in disk_name.
 228                  */
 229                 struct ll_digest_filename *digest;
 230
 231                 if (fname->crypto_buf.len < sizeof(struct ll_digest_filename)) {
 232                         rc = -EINVAL;
 233                         goto out_free;
 234                 }
 235                 digest = (struct ll_digest_filename *)fname->crypto_buf.name;
 236                 *fid = digest->ldf_fid;
 237                 if (!fid_is_sane(fid)) {
 238                         rc = -EINVAL;
 239                         goto out_free;
 240                 }
 241                 fname->disk_name.name = digest->ldf_excerpt;
 242                 fname->disk_name.len = LLCRYPT_FNAME_DIGEST_SIZE;
 243         }
 244         if (IS_ENCRYPTED(dir) &&
 245             !name_is_dot_or_dotdot(fname->disk_name.name,
 246                                    fname->disk_name.len)) {
 247                 int presented_len = critical_chars(fname->disk_name.name,
 248                                                    fname->disk_name.len);
 249                 char *buf;
 250
 251                 buf = kmalloc(presented_len + 1, GFP_NOFS);
 252                 if (!buf) {
 253                         rc = -ENOMEM;
 254                         goto out_free;
 255                 }
 256
 257                 if (presented_len == fname->disk_name.len)
 258                         memcpy(buf, fname->disk_name.name, presented_len);
 259                 else
 260                         critical_encode(fname->disk_name.name,
 261                                         fname->disk_name.len, buf);
 262                 buf[presented_len] = '\0';
 263                 kfree(fname->crypto_buf.name);
 264                 fname->crypto_buf.name = buf;
 265                 fname->crypto_buf.len = presented_len;
 266                 fname->disk_name.name = fname->crypto_buf.name;
 267                 fname->disk_name.len = fname->crypto_buf.len;
 268         }
 269
 270         return rc;
 271
 272 out_free:
 273         llcrypt_free_filename(fname);
 274         return rc;
 275 }
 276
 277 /**
 278  * ll_fname_disk_to_usr() - overlay to llcrypt_fname_disk_to_usr
 279  * @inode: the inode to convert name
 280  * @hash: major hash for inode
 281  * @minor_hash: minor hash for inode
 282  * @iname: the user-provided filename needing conversion
 283  * @oname: the filename information to be filled in
 284  * @fid: the user-provided fid for filename
 285  *
 286  * The caller must have allocated sufficient memory for the @oname string.
 287  *
 288  * This overlay function is necessary to properly decode @iname before
 289  * decryption, as it comes from the wire.
 290  * This overlay function is also necessary to handle the case of operations
 291  * carried out without the key. Normally llcrypt makes use of digested names in
 292  * that case. Having a digested name works for local file systems that can call
 293  * llcrypt_match_name(), but Lustre server side is not aware of encryption.
 294  * So for keyless @lookup operations on long names, for Lustre we choose to
 295  * present to users the encoded struct ll_digest_filename, instead of a digested
 296  * name. FID and name hash can then easily be extracted and put into the
 297  * requests sent to servers.
 298  */
 299 int ll_fname_disk_to_usr(struct inode *inode,
 300                          u32 hash, u32 minor_hash,
 301                          struct llcrypt_str *iname, struct llcrypt_str *oname,
 302                          struct lu_fid *fid)
 303 {
 304         struct llcrypt_str lltr = LLTR_INIT(iname->name, iname->len);
 305         struct ll_digest_filename digest;
 306         int digested = 0;
 307         char *buf = NULL;
 308         int rc;
 309
 310         if (IS_ENCRYPTED(inode)) {
 311                 if (!name_is_dot_or_dotdot(lltr.name, lltr.len) &&
 312                     strnchr(lltr.name, lltr.len, '=')) {
 313                         /* Only proceed to critical decode if
 314                          * iname contains espace char '='.
 315                          */
 316                         int len = lltr.len;
 317
 318                         buf = kmalloc(len, GFP_NOFS);
 319                         if (!buf)
 320                                 return -ENOMEM;
 321
 322                         len = critical_decode(lltr.name, len, buf);
 323                         lltr.name = buf;
 324                         lltr.len = len;
 325                 }
 326                 if (lltr.len > LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE &&
 327                     !llcrypt_has_encryption_key(inode) &&
 328                     likely(llcrypt_policy_has_filename_enc(inode))) {
 329                         digested = 1;
 330                         /* Without the key for long names, set the dentry name
 331                          * to the representing struct ll_digest_filename. It
 332                          * will be encoded by llcrypt for display, and will
 333                          * enable further lookup requests.
 334                          */
 335                         if (!fid)
 336                                 return -EINVAL;
 337                         digest.ldf_fid = *fid;
 338                         memcpy(digest.ldf_excerpt,
 339                                LLCRYPT_FNAME_DIGEST(lltr.name, lltr.len),
 340                                LLCRYPT_FNAME_DIGEST_SIZE);
 341
 342                         lltr.name = (char *)&digest;
 343                         lltr.len = sizeof(digest);
 344
 345                         oname->name[0] = '_';
 346                         oname->name = oname->name + 1;
 347                         oname->len--;
 348                 }
 349         }
 350
 351         rc = llcrypt_fname_disk_to_usr(inode, hash, minor_hash, &lltr, oname);
 352
 353         kfree(buf);
 354         oname->name = oname->name - digested;
 355         oname->len = oname->len + digested;
 356
 357         return rc;
 358 }
 359
 360 /* Copied from llcrypt_d_revalidate, as it is not exported */
 361 /*
 362  * Validate dentries in encrypted directories to make sure we aren't potentially
 363  * caching stale dentries after a key has been added.
 364  */
 365 int ll_revalidate_d_crypto(struct dentry *dentry, unsigned int flags)
 366 {
 367         struct dentry *dir;
 368         int err;
 369         int valid;
 370
 371         /*
 372          * Plaintext names are always valid, since llcrypt doesn't support
 373          * reverting to ciphertext names without evicting the directory's inode
 374          * -- which implies eviction of the dentries in the directory.
 375          */
 376         if (!(dentry->d_flags & DCACHE_ENCRYPTED_NAME))
 377                 return 1;
 378
 379         /*
 380          * Ciphertext name; valid if the directory's key is still unavailable.
 381          *
 382          * Although llcrypt forbids rename() on ciphertext names, we still must
 383          * use dget_parent() here rather than use ->d_parent directly.  That's
 384          * because a corrupted fs image may contain directory hard links, which
 385          * the VFS handles by moving the directory's dentry tree in the dcache
 386          * each time ->lookup() finds the directory and it already has a dentry
 387          * elsewhere.  Thus ->d_parent can be changing, and we must safely grab
 388          * a reference to some ->d_parent to prevent it from being freed.
 389          */
 390
 391         if (flags & LOOKUP_RCU)
 392                 return -ECHILD;
 393
 394         dir = dget_parent(dentry);
 395         err = llcrypt_get_encryption_info(d_inode(dir));
 396         valid = !llcrypt_has_encryption_key(d_inode(dir));
 397         dput(dir);
 398
 399         if (err < 0)
 400                 return err;
 401
 402         return valid;
 403 }
 404
 405 const struct llcrypt_operations lustre_cryptops = {
 406         .key_prefix             = "lustre:",
 407         .get_context            = ll_get_context,
 408         .set_context            = ll_set_context,
 409         .dummy_context          = ll_dummy_context,
 410         .empty_dir              = ll_empty_dir,
 411         .max_namelen            = NAME_MAX,
 412 };
 413 #else /* !HAVE_LUSTRE_CRYPTO */
 414 int ll_set_encflags(struct inode *inode, void *encctx, __u32 encctxlen,
 415                     bool preload)
 416 {
 417         return 0;
 418 }
 419
 420 void llcrypt_free_ctx(void *encctx, __u32 size)
 421 {
 422 }
 423
 424 bool ll_sbi_has_test_dummy_encryption(struct ll_sb_info *sbi)
 425 {
 426         return false;
 427 }
 428
 429 bool ll_sbi_has_encrypt(struct ll_sb_info *sbi)
 430 {
 431         return false;
 432 }
 433
 434 void ll_sbi_set_encrypt(struct ll_sb_info *sbi, bool set)
 435 {
 436 }
 437
 438 int ll_setup_filename(struct inode *dir, const struct qstr *iname,
 439                       int lookup, struct llcrypt_name *fname,
 440                       struct lu_fid *fid)
 441 {
 442         if (fid) {
 443                 fid->f_seq = 0;
 444                 fid->f_oid = 0;
 445                 fid->f_ver = 0;
 446         }
 447
 448         return llcrypt_setup_filename(dir, iname, lookup, fname);
 449 }
 450
 451 int ll_fname_disk_to_usr(struct inode *inode,
 452                          u32 hash, u32 minor_hash,
 453                          struct llcrypt_str *iname, struct llcrypt_str *oname,
 454                          struct lu_fid *fid)
 455 {
 456         return llcrypt_fname_disk_to_usr(inode, hash, minor_hash, iname, oname);
 457 }
 458
 459 int ll_revalidate_d_crypto(struct dentry *dentry, unsigned int flags)
 460 {
 461         return 1;
 462 }
 463 #endif
 464