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         int rc;
  37
  38         /* Get enc context xattr directly instead of going through the VFS,
  39          * as there is no xattr handler for "encryption.".
  40          */
  41         rc = ll_xattr_list(inode, LL_XATTR_NAME_ENCRYPTION_CONTEXT,
  42                            XATTR_ENCRYPTION_T, ctx, len, OBD_MD_FLXATTR);
  43
  44         /* used as encryption unit size */
  45         if (S_ISREG(inode->i_mode))
  46                 inode->i_blkbits = LUSTRE_ENCRYPTION_BLOCKBITS;
  47         return rc;
  48 }
  49
  50 int ll_set_encflags(struct inode *inode, void *encctx, __u32 encctxlen,
  51                     bool preload)
  52 {
  53         unsigned int ext_flags;
  54         int rc = 0;
  55
  56         /* used as encryption unit size */
  57         if (S_ISREG(inode->i_mode))
  58                 inode->i_blkbits = LUSTRE_ENCRYPTION_BLOCKBITS;
  59         ext_flags = ll_inode_to_ext_flags(inode->i_flags) | LUSTRE_ENCRYPT_FL;
  60         ll_update_inode_flags(inode, ext_flags);
  61
  62         if (encctx && encctxlen)
  63                 rc = ll_xattr_cache_insert(inode,
  64                                            LL_XATTR_NAME_ENCRYPTION_CONTEXT,
  65                                            encctx, encctxlen);
  66         if (rc)
  67                 return rc;
  68
  69         return preload ? llcrypt_get_encryption_info(inode) : 0;
  70 }
  71
  72 /* ll_set_context has 2 distinct behaviors, depending on the value of inode
  73  * parameter:
  74  * - inode is NULL:
  75  *   passed fs_data is a struct md_op_data *. We need to store enc ctx in
  76  *   op_data, so that it will be sent along to the server with the request that
  77  *   the caller is preparing, thus saving a setxattr request.
  78  * - inode is not NULL:
  79  *   normal case, letting proceed with setxattr operation.
  80  *   This use case should only be used when explicitly setting a new encryption
  81  *   policy on an existing, empty directory.
  82  */
  83 static int ll_set_context(struct inode *inode, const void *ctx, size_t len,
  84                           void *fs_data)
  85 {
  86         struct ptlrpc_request *req = NULL;
  87         struct ll_sb_info *sbi;
  88         int rc;
  89
  90         if (inode == NULL) {
  91                 struct md_op_data *op_data = (struct md_op_data *)fs_data;
  92
  93                 if (!op_data)
  94                         return -EINVAL;
  95
  96                 OBD_ALLOC(op_data->op_file_encctx, len);
  97                 if (op_data->op_file_encctx == NULL)
  98                         return -ENOMEM;
  99                 op_data->op_file_encctx_size = len;
 100                 memcpy(op_data->op_file_encctx, ctx, len);
 101                 return 0;
 102         }
 103
 104         /* Encrypting the root directory is not allowed */
 105         if (is_root_inode(inode))
 106                 return -EPERM;
 107
 108         sbi = ll_i2sbi(inode);
 109         /* Send setxattr request to lower layers directly instead of going
 110          * through the VFS, as there is no xattr handler for "encryption.".
 111          */
 112         rc = md_setxattr(sbi->ll_md_exp, ll_inode2fid(inode),
 113                          OBD_MD_FLXATTR, LL_XATTR_NAME_ENCRYPTION_CONTEXT,
 114                          ctx, len, XATTR_CREATE, ll_i2suppgid(inode), &req);
 115         if (rc)
 116                 return rc;
 117         ptlrpc_req_finished(req);
 118
 119         return ll_set_encflags(inode, (void *)ctx, len, false);
 120 }
 121
 122 /**
 123  * ll_file_open_encrypt() - overlay to llcrypt_file_open
 124  * @inode: the inode being opened
 125  * @filp: the struct file being set up
 126  *
 127  * This overlay function is necessary to handle encrypted file open without
 128  * the key. We allow this access pattern to applications that know what they
 129  * are doing, by using the specific flag O_FILE_ENC.
 130  * This flag is only compatible with O_DIRECT IOs, to make sure ciphertext
 131  * data is wiped from page cache once IOs are finished.
 132  */
 133 int ll_file_open_encrypt(struct inode *inode, struct file *filp)
 134 {
 135         int rc;
 136
 137         rc = llcrypt_file_open(inode, filp);
 138         if (likely(rc != -ENOKEY))
 139                 return rc;
 140
 141         if (rc == -ENOKEY &&
 142             (filp->f_flags & O_FILE_ENC) == O_FILE_ENC &&
 143             filp->f_flags & O_DIRECT)
 144                 /* allow file open with O_FILE_ENC flag when we have O_DIRECT */
 145                 rc = 0;
 146
 147         return rc;
 148 }
 149
 150 void llcrypt_free_ctx(void *encctx, __u32 size)
 151 {
 152         if (encctx)
 153                 OBD_FREE(encctx, size);
 154 }
 155
 156 #ifdef HAVE_FSCRYPT_DUMMY_CONTEXT_ENABLED
 157 bool ll_sb_has_test_dummy_encryption(struct super_block *sb)
 158 {
 159         struct ll_sb_info *sbi = s2lsi(sb)->lsi_llsbi;
 160
 161         return sbi ?
 162                unlikely(test_bit(LL_SBI_TEST_DUMMY_ENCRYPTION, sbi->ll_flags)) :
 163                false;
 164 }
 165
 166 static bool ll_dummy_context(struct inode *inode)
 167 {
 168         return ll_sb_has_test_dummy_encryption(inode->i_sb);
 169 }
 170 #else
 171 static const union llcrypt_context *
 172 ll_get_dummy_context(struct super_block *sb)
 173 {
 174         struct lustre_sb_info *lsi = s2lsi(sb);
 175
 176         return lsi ? lsi->lsi_dummy_enc_ctx.ctx : NULL;
 177 }
 178
 179 bool ll_sb_has_test_dummy_encryption(struct super_block *sb)
 180 {
 181         return ll_get_dummy_context(sb) != NULL;
 182 }
 183 #endif
 184
 185 bool ll_sbi_has_encrypt(struct ll_sb_info *sbi)
 186 {
 187         return test_bit(LL_SBI_ENCRYPT, sbi->ll_flags);
 188 }
 189
 190 void ll_sbi_set_encrypt(struct ll_sb_info *sbi, bool set)
 191 {
 192         if (set) {
 193                 set_bit(LL_SBI_ENCRYPT, sbi->ll_flags);
 194         } else {
 195                 clear_bit(LL_SBI_ENCRYPT, sbi->ll_flags);
 196                 clear_bit(LL_SBI_TEST_DUMMY_ENCRYPTION, sbi->ll_flags);
 197         }
 198 }
 199
 200 static bool ll_empty_dir(struct inode *inode)
 201 {
 202         /* used by llcrypt_ioctl_set_policy(), because a policy can only be set
 203          * on an empty dir.
 204          */
 205         /* Here we choose to return true, meaning we always call .set_context.
 206          * Then we rely on server side, with mdd_fix_attr() that calls
 207          * mdd_dir_is_empty() when setting encryption flag on directory.
 208          */
 209         return true;
 210 }
 211
 212 /**
 213  * ll_setup_filename() - overlay to llcrypt_setup_filename
 214  * @dir: the directory that will be searched
 215  * @iname: the user-provided filename being searched for
 216  * @lookup: 1 if we're allowed to proceed without the key because it's
 217  *      ->lookup() or we're finding the dir_entry for deletion; 0 if we cannot
 218  *      proceed without the key because we're going to create the dir_entry.
 219  * @fname: the filename information to be filled in
 220  * @fid: fid retrieved from user-provided filename
 221  *
 222  * This overlay function is necessary to properly encode @fname after
 223  * encryption, as it will be sent over the wire.
 224  * This overlay function is also necessary to handle the case of operations
 225  * carried out without the key. Normally llcrypt makes use of digested names in
 226  * that case. Having a digested name works for local file systems that can call
 227  * llcrypt_match_name(), but Lustre server side is not aware of encryption.
 228  * So for keyless @lookup operations on long names, for Lustre we choose to
 229  * present to users the encoded struct ll_digest_filename, instead of a digested
 230  * name. FID and name hash can then easily be extracted and put into the
 231  * requests sent to servers.
 232  */
 233 int ll_setup_filename(struct inode *dir, const struct qstr *iname,
 234                       int lookup, struct llcrypt_name *fname,
 235                       struct lu_fid *fid)
 236 {
 237         int digested = 0;
 238         struct qstr dname;
 239         int rc;
 240
 241         if (fid && IS_ENCRYPTED(dir) && !llcrypt_has_encryption_key(dir) &&
 242             iname->name[0] == '_')
 243                 digested = 1;
 244
 245         dname.name = iname->name + digested;
 246         dname.len = iname->len - digested;
 247
 248         if (fid) {
 249                 fid->f_seq = 0;
 250                 fid->f_oid = 0;
 251                 fid->f_ver = 0;
 252         }
 253         rc = llcrypt_setup_filename(dir, &dname, lookup, fname);
 254         if (rc == -ENOENT && lookup) {
 255                 if (((is_root_inode(dir) &&
 256                      iname->len == strlen(dot_fscrypt_name) &&
 257                      strncmp(iname->name, dot_fscrypt_name, iname->len) == 0) ||
 258                      (!llcrypt_has_encryption_key(dir) &&
 259                       unlikely(filename_is_volatile(iname->name,
 260                                                     iname->len, NULL))))) {
 261                         /* In case of subdir mount of an encrypted directory,
 262                          * we allow lookup of /.fscrypt directory.
 263                          */
 264                         /* For purpose of migration or mirroring without enc key
 265                          * we allow lookup of volatile file without enc context.
 266                          */
 267                         memset(fname, 0, sizeof(struct llcrypt_name));
 268                         fname->disk_name.name = (unsigned char *)iname->name;
 269                         fname->disk_name.len = iname->len;
 270                         rc = 0;
 271                 } else if (!llcrypt_has_encryption_key(dir)) {
 272                         rc = -ENOKEY;
 273                 }
 274         }
 275         if (rc)
 276                 return rc;
 277
 278         if (digested) {
 279                 /* Without the key, for long names user should have struct
 280                  * ll_digest_filename representation of the dentry instead of
 281                  * the name. So make sure it is valid, return fid and put
 282                  * excerpt of cipher text name in disk_name.
 283                  */
 284                 struct ll_digest_filename *digest;
 285
 286                 if (fname->crypto_buf.len < sizeof(struct ll_digest_filename)) {
 287                         rc = -EINVAL;
 288                         goto out_free;
 289                 }
 290                 digest = (struct ll_digest_filename *)fname->disk_name.name;
 291                 *fid = digest->ldf_fid;
 292                 if (!fid_is_sane(fid)) {
 293                         rc = -EINVAL;
 294                         goto out_free;
 295                 }
 296                 fname->disk_name.name = digest->ldf_excerpt;
 297                 fname->disk_name.len = sizeof(digest->ldf_excerpt);
 298         }
 299         if (IS_ENCRYPTED(dir) &&
 300             !name_is_dot_or_dotdot(fname->disk_name.name,
 301                                    fname->disk_name.len)) {
 302                 int presented_len = critical_chars(fname->disk_name.name,
 303                                                    fname->disk_name.len);
 304                 char *buf;
 305
 306                 buf = kmalloc(presented_len + 1, GFP_NOFS);
 307                 if (!buf) {
 308                         rc = -ENOMEM;
 309                         goto out_free;
 310                 }
 311
 312                 if (presented_len == fname->disk_name.len)
 313                         memcpy(buf, fname->disk_name.name, presented_len);
 314                 else
 315                         critical_encode(fname->disk_name.name,
 316                                         fname->disk_name.len, buf);
 317                 buf[presented_len] = '\0';
 318                 kfree(fname->crypto_buf.name);
 319                 fname->crypto_buf.name = buf;
 320                 fname->crypto_buf.len = presented_len;
 321                 fname->disk_name.name = fname->crypto_buf.name;
 322                 fname->disk_name.len = fname->crypto_buf.len;
 323         }
 324
 325         return rc;
 326
 327 out_free:
 328         llcrypt_free_filename(fname);
 329         return rc;
 330 }
 331
 332 /**
 333  * ll_fname_disk_to_usr() - overlay to llcrypt_fname_disk_to_usr
 334  * @inode: the inode to convert name
 335  * @hash: major hash for inode
 336  * @minor_hash: minor hash for inode
 337  * @iname: the user-provided filename needing conversion
 338  * @oname: the filename information to be filled in
 339  * @fid: the user-provided fid for filename
 340  *
 341  * The caller must have allocated sufficient memory for the @oname string.
 342  *
 343  * This overlay function is necessary to properly decode @iname before
 344  * decryption, as it comes from the wire.
 345  * This overlay function is also necessary to handle the case of operations
 346  * carried out without the key. Normally llcrypt makes use of digested names in
 347  * that case. Having a digested name works for local file systems that can call
 348  * llcrypt_match_name(), but Lustre server side is not aware of encryption.
 349  * So for keyless @lookup operations on long names, for Lustre we choose to
 350  * present to users the encoded struct ll_digest_filename, instead of a digested
 351  * name. FID and name hash can then easily be extracted and put into the
 352  * requests sent to servers.
 353  */
 354 int ll_fname_disk_to_usr(struct inode *inode,
 355                          u32 hash, u32 minor_hash,
 356                          struct llcrypt_str *iname, struct llcrypt_str *oname,
 357                          struct lu_fid *fid)
 358 {
 359         struct llcrypt_str lltr = LLTR_INIT(iname->name, iname->len);
 360         struct ll_digest_filename digest;
 361         int digested = 0;
 362         char *buf = NULL;
 363         int rc;
 364
 365         if (IS_ENCRYPTED(inode)) {
 366                 if (!name_is_dot_or_dotdot(lltr.name, lltr.len) &&
 367                     strnchr(lltr.name, lltr.len, '=')) {
 368                         /* Only proceed to critical decode if
 369                          * iname contains espace char '='.
 370                          */
 371                         int len = lltr.len;
 372
 373                         buf = kmalloc(len, GFP_NOFS);
 374                         if (!buf)
 375                                 return -ENOMEM;
 376
 377                         len = critical_decode(lltr.name, len, buf);
 378                         lltr.name = buf;
 379                         lltr.len = len;
 380                 }
 381                 if (lltr.len > LL_CRYPTO_BLOCK_SIZE * 2 &&
 382                     !llcrypt_has_encryption_key(inode) &&
 383                     llcrypt_policy_has_filename_enc(inode)) {
 384                         digested = 1;
 385                         /* Without the key for long names, set the dentry name
 386                          * to the representing struct ll_digest_filename. It
 387                          * will be encoded by llcrypt for display, and will
 388                          * enable further lookup requests.
 389                          */
 390                         if (!fid)
 391                                 return -EINVAL;
 392                         digest.ldf_fid = *fid;
 393                         memcpy(digest.ldf_excerpt,
 394                                LLCRYPT_EXTRACT_DIGEST(lltr.name, lltr.len),
 395                                sizeof(digest.ldf_excerpt));
 396
 397                         lltr.name = (char *)&digest;
 398                         lltr.len = sizeof(digest);
 399
 400                         oname->name[0] = '_';
 401                         oname->name = oname->name + 1;
 402                         oname->len--;
 403                 }
 404         }
 405
 406         rc = llcrypt_fname_disk_to_usr(inode, hash, minor_hash, &lltr, oname);
 407
 408         kfree(buf);
 409         oname->name = oname->name - digested;
 410         oname->len = oname->len + digested;
 411
 412         return rc;
 413 }
 414
 415 /* Copied from llcrypt_d_revalidate, as it is not exported */
 416 /*
 417  * Validate dentries in encrypted directories to make sure we aren't potentially
 418  * caching stale dentries after a key has been added.
 419  */
 420 int ll_revalidate_d_crypto(struct dentry *dentry, unsigned int flags)
 421 {
 422         struct dentry *dir;
 423         int err;
 424         int valid;
 425
 426         /*
 427          * Plaintext names are always valid, since llcrypt doesn't support
 428          * reverting to ciphertext names without evicting the directory's inode
 429          * -- which implies eviction of the dentries in the directory.
 430          */
 431         if (!llcrypt_is_nokey_name(dentry))
 432                 return 1;
 433
 434         /*
 435          * Ciphertext name; valid if the directory's key is still unavailable.
 436          *
 437          * Although llcrypt forbids rename() on ciphertext names, we still must
 438          * use dget_parent() here rather than use ->d_parent directly.  That's
 439          * because a corrupted fs image may contain directory hard links, which
 440          * the VFS handles by moving the directory's dentry tree in the dcache
 441          * each time ->lookup() finds the directory and it already has a dentry
 442          * elsewhere.  Thus ->d_parent can be changing, and we must safely grab
 443          * a reference to some ->d_parent to prevent it from being freed.
 444          */
 445
 446         if (flags & LOOKUP_RCU)
 447                 return -ECHILD;
 448
 449         dir = dget_parent(dentry);
 450         err = llcrypt_get_encryption_info(d_inode(dir));
 451         valid = !llcrypt_has_encryption_key(d_inode(dir));
 452         dput(dir);
 453
 454         if (err < 0)
 455                 return err;
 456
 457         return valid;
 458 }
 459
 460 const struct llcrypt_operations lustre_cryptops = {
 461         .key_prefix             = "lustre:",
 462         .get_context            = ll_get_context,
 463         .set_context            = ll_set_context,
 464 #ifdef HAVE_FSCRYPT_DUMMY_CONTEXT_ENABLED
 465         .dummy_context          = ll_dummy_context,
 466 #else
 467         .get_dummy_context      = ll_get_dummy_context,
 468 #endif
 469         .empty_dir              = ll_empty_dir,
 470         .max_namelen            = NAME_MAX,
 471 };
 472 #else /* !HAVE_LUSTRE_CRYPTO */
 473 int ll_set_encflags(struct inode *inode, void *encctx, __u32 encctxlen,
 474                     bool preload)
 475 {
 476         return 0;
 477 }
 478
 479 int ll_file_open_encrypt(struct inode *inode, struct file *filp)
 480 {
 481         return llcrypt_file_open(inode, filp);
 482 }
 483
 484 void llcrypt_free_ctx(void *encctx, __u32 size)
 485 {
 486 }
 487
 488 bool ll_sb_has_test_dummy_encryption(struct super_block *sb)
 489 {
 490         return false;
 491 }
 492
 493 bool ll_sbi_has_encrypt(struct ll_sb_info *sbi)
 494 {
 495         return false;
 496 }
 497
 498 void ll_sbi_set_encrypt(struct ll_sb_info *sbi, bool set)
 499 {
 500 }
 501
 502 int ll_setup_filename(struct inode *dir, const struct qstr *iname,
 503                       int lookup, struct llcrypt_name *fname,
 504                       struct lu_fid *fid)
 505 {
 506         if (fid) {
 507                 fid->f_seq = 0;
 508                 fid->f_oid = 0;
 509                 fid->f_ver = 0;
 510         }
 511
 512         return llcrypt_setup_filename(dir, iname, lookup, fname);
 513 }
 514
 515 int ll_fname_disk_to_usr(struct inode *inode,
 516                          u32 hash, u32 minor_hash,
 517                          struct llcrypt_str *iname, struct llcrypt_str *oname,
 518                          struct lu_fid *fid)
 519 {
 520         return llcrypt_fname_disk_to_usr(inode, hash, minor_hash, iname, oname);
 521 }
 522
 523 int ll_revalidate_d_crypto(struct dentry *dentry, unsigned int flags)
 524 {
 525         return 1;
 526 }
 527 #endif
 528