1 /* SPDX-License-Identifier: GPL-2.0 */
3 * llcrypt.h: declarations for per-file encryption
5 * Filesystems that implement per-file encryption must include this header
8 * Copyright (C) 2015, Google, Inc.
10 * Written by Michael Halcrow, 2015.
11 * Modified by Jaegeuk Kim, 2015.
14 * Linux commit 219d54332a09
17 #ifndef _LINUX_LLCRYPT_H
18 #define _LINUX_LLCRYPT_H
20 #ifndef DCACHE_ENCRYPTED_NAME
21 #define DCACHE_ENCRYPTED_NAME 0x02000000
26 #include <linux/slab.h>
27 #include <lustre_disk.h>
28 #include <uapi/linux/llcrypt.h>
30 #define LL_CRYPTO_BLOCK_SIZE 16
41 const struct qstr *usr_fname;
42 struct llcrypt_str disk_name;
45 struct llcrypt_str crypto_buf;
46 bool is_ciphertext_name;
49 #define LLTR_INIT(n, l) { .name = n, .len = l }
50 #define LLTR_TO_QSTR(f) QSTR_INIT((f)->name, (f)->len)
51 #define lname_name(p) ((p)->disk_name.name)
52 #define lname_len(p) ((p)->disk_name.len)
54 /* Maximum value for the third parameter of llcrypt_operations.set_context(). */
55 #define LLCRYPT_SET_CONTEXT_MAX_SIZE 40
57 #ifdef CONFIG_LL_ENCRYPTION
59 * llcrypt superblock flags
61 #define LL_CFLG_OWN_PAGES (1U << 1)
64 * crypto operations for filesystems
66 struct llcrypt_operations {
68 const char *key_prefix;
69 int (*get_context)(struct inode *, void *, size_t);
70 int (*set_context)(struct inode *, const void *, size_t, void *);
71 bool (*dummy_context)(struct inode *);
72 bool (*empty_dir)(struct inode *);
73 unsigned int max_namelen;
81 struct work_struct work;
83 struct list_head free_list; /* Free list */
88 extern bool llcrypt_has_encryption_key(const struct inode *inode);
90 static inline bool llcrypt_dummy_context_enabled(struct inode *inode)
92 struct lustre_sb_info *lsi = s2lsi(inode->i_sb);
97 return lsi->lsi_cop->dummy_context &&
98 lsi->lsi_cop->dummy_context(inode);
102 * When d_splice_alias() moves a directory's encrypted alias to its decrypted
103 * alias as a result of the encryption key being added, DCACHE_ENCRYPTED_NAME
104 * must be cleared. Note that we don't have to support arbitrary moves of this
105 * flag because llcrypt doesn't allow encrypted aliases to be the source or
106 * target of a rename().
108 static inline void llcrypt_handle_d_move(struct dentry *dentry)
110 dentry->d_flags &= ~DCACHE_ENCRYPTED_NAME;
114 extern int __init llcrypt_init(void);
115 extern void __exit llcrypt_exit(void);
116 extern void llcrypt_enqueue_decrypt_work(struct work_struct *);
117 extern struct llcrypt_ctx *llcrypt_get_ctx(gfp_t);
118 extern void llcrypt_release_ctx(struct llcrypt_ctx *);
120 extern struct page *llcrypt_encrypt_pagecache_blocks(struct page *page,
124 extern int llcrypt_encrypt_block_inplace(const struct inode *inode,
125 struct page *page, unsigned int len,
126 unsigned int offs, u64 lblk_num,
129 extern int llcrypt_decrypt_pagecache_blocks(struct page *page, unsigned int len,
131 extern int llcrypt_decrypt_block_inplace(const struct inode *inode,
132 struct page *page, unsigned int len,
133 unsigned int offs, u64 lblk_num);
135 static inline bool llcrypt_is_bounce_page(struct page *page)
137 return page->mapping == NULL;
140 static inline struct page *llcrypt_pagecache_page(struct page *bounce_page)
142 return (struct page *)page_private(bounce_page);
145 extern void llcrypt_free_bounce_page(struct page *bounce_page);
148 extern int llcrypt_ioctl_set_policy(struct file *, const void __user *);
149 extern int llcrypt_ioctl_get_policy(struct file *, void __user *);
150 extern int llcrypt_ioctl_get_policy_ex(struct file *, void __user *);
151 extern int llcrypt_has_permitted_context(struct inode *, struct inode *);
152 extern int llcrypt_inherit_context(struct inode *, struct inode *,
155 extern void llcrypt_sb_free(struct super_block *sb);
156 extern int llcrypt_ioctl_add_key(struct file *filp, void __user *arg);
157 extern int llcrypt_ioctl_remove_key(struct file *filp, void __user *arg);
158 extern int llcrypt_ioctl_remove_key_all_users(struct file *filp,
160 extern int llcrypt_ioctl_get_key_status(struct file *filp, void __user *arg);
163 extern int llcrypt_get_encryption_info(struct inode *);
164 extern void llcrypt_put_encryption_info(struct inode *);
165 extern void llcrypt_free_inode(struct inode *);
166 extern int llcrypt_drop_inode(struct inode *inode);
169 extern int llcrypt_setup_filename(struct inode *, const struct qstr *,
170 int lookup, struct llcrypt_name *);
172 static inline void llcrypt_free_filename(struct llcrypt_name *fname)
174 kfree(fname->crypto_buf.name);
177 extern int llcrypt_fname_alloc_buffer(const struct inode *, u32,
178 struct llcrypt_str *);
179 extern void llcrypt_fname_free_buffer(struct llcrypt_str *);
180 extern int llcrypt_fname_disk_to_usr(struct inode *, u32, u32,
181 const struct llcrypt_str *, struct llcrypt_str *);
183 #define LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE 32
185 /* Extracts the second-to-last ciphertext block; see explanation below */
186 #define LLCRYPT_FNAME_DIGEST(name, len) \
187 ((name) + round_down((len) - LL_CRYPTO_BLOCK_SIZE - 1, \
188 LL_CRYPTO_BLOCK_SIZE))
190 #define LLCRYPT_FNAME_DIGEST_SIZE LL_CRYPTO_BLOCK_SIZE
193 * llcrypt_digested_name - alternate identifier for an on-disk filename
195 * When userspace lists an encrypted directory without access to the key,
196 * filenames whose ciphertext is longer than LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE
197 * bytes are shown in this abbreviated form (base64-encoded) rather than as the
198 * full ciphertext (base64-encoded). This is necessary to allow supporting
199 * filenames up to NAME_MAX bytes, since base64 encoding expands the length.
201 * To make it possible for filesystems to still find the correct directory entry
202 * despite not knowing the full on-disk name, we encode any filesystem-specific
203 * 'hash' and/or 'minor_hash' which the filesystem may need for its lookups,
204 * followed by the second-to-last ciphertext block of the filename. Due to the
205 * use of the CBC-CTS encryption mode, the second-to-last ciphertext block
206 * depends on the full plaintext. (Note that ciphertext stealing causes the
207 * last two blocks to appear "flipped".) This makes accidental collisions very
208 * unlikely: just a 1 in 2^128 chance for two filenames to collide even if they
209 * share the same filesystem-specific hashes.
211 * However, this scheme isn't immune to intentional collisions, which can be
212 * created by anyone able to create arbitrary plaintext filenames and view them
213 * without the key. Making the "digest" be a real cryptographic hash like
214 * SHA-256 over the full ciphertext would prevent this, although it would be
215 * less efficient and harder to implement, especially since the filesystem would
216 * need to calculate it for each directory entry examined during a search.
218 struct llcrypt_digested_name {
221 u8 digest[LLCRYPT_FNAME_DIGEST_SIZE];
225 * llcrypt_match_name() - test whether the given name matches a directory entry
226 * @fname: the name being searched for
227 * @de_name: the name from the directory entry
228 * @de_name_len: the length of @de_name in bytes
230 * Normally @fname->disk_name will be set, and in that case we simply compare
231 * that to the name stored in the directory entry. The only exception is that
232 * if we don't have the key for an encrypted directory and a filename in it is
233 * very long, then we won't have the full disk_name and we'll instead need to
234 * match against the llcrypt_digested_name.
236 * Return: %true if the name matches, otherwise %false.
238 static inline bool llcrypt_match_name(const struct llcrypt_name *fname,
239 const u8 *de_name, u32 de_name_len)
241 if (unlikely(!fname->disk_name.name)) {
242 const struct llcrypt_digested_name *n =
243 (const void *)fname->crypto_buf.name;
244 if (WARN_ON_ONCE(fname->usr_fname->name[0] != '_'))
246 if (de_name_len <= LLCRYPT_FNAME_MAX_UNDIGESTED_SIZE)
248 return !memcmp(LLCRYPT_FNAME_DIGEST(de_name, de_name_len),
249 n->digest, LLCRYPT_FNAME_DIGEST_SIZE);
252 if (de_name_len != fname->disk_name.len)
254 return !memcmp(de_name, fname->disk_name.name, fname->disk_name.len);
258 extern void llcrypt_decrypt_bio(struct bio *);
259 extern void llcrypt_enqueue_decrypt_bio(struct llcrypt_ctx *ctx,
261 extern int llcrypt_zeroout_range(const struct inode *, pgoff_t, sector_t,
265 extern int llcrypt_file_open(struct inode *inode, struct file *filp);
266 extern int __llcrypt_prepare_link(struct inode *inode, struct inode *dir,
267 struct dentry *dentry);
268 extern int __llcrypt_prepare_rename(struct inode *old_dir,
269 struct dentry *old_dentry,
270 struct inode *new_dir,
271 struct dentry *new_dentry,
273 extern int __llcrypt_prepare_lookup(struct inode *dir, struct dentry *dentry,
274 struct llcrypt_name *fname);
275 extern int __llcrypt_prepare_symlink(struct inode *dir, unsigned int len,
276 unsigned int max_len,
277 struct llcrypt_str *disk_link);
278 extern int __llcrypt_encrypt_symlink(struct inode *inode, const char *target,
280 struct llcrypt_str *disk_link);
281 extern const char *llcrypt_get_symlink(struct inode *inode, const void *caddr,
282 unsigned int max_size,
283 struct delayed_call *done);
284 static inline void llcrypt_set_ops(struct super_block *sb,
285 const struct llcrypt_operations *lsi_cop)
287 struct lustre_sb_info *lsi = s2lsi(sb);
290 lsi->lsi_cop = lsi_cop;
292 #else /* !CONFIG_LL_ENCRYPTION */
294 struct llcrypt_operations;
295 #define llcrypt_init() 0
296 #define llcrypt_exit() {}
299 #define IS_ENCRYPTED(x) 0
301 static inline bool llcrypt_has_encryption_key(const struct inode *inode)
306 static inline bool llcrypt_dummy_context_enabled(struct inode *inode)
311 static inline void llcrypt_handle_d_move(struct dentry *dentry)
316 static inline void llcrypt_enqueue_decrypt_work(struct work_struct *work)
320 static inline struct llcrypt_ctx *llcrypt_get_ctx(gfp_t gfp_flags)
322 return ERR_PTR(-EOPNOTSUPP);
325 static inline void llcrypt_release_ctx(struct llcrypt_ctx *ctx)
330 static inline struct page *llcrypt_encrypt_pagecache_blocks(struct page *page,
335 return ERR_PTR(-EOPNOTSUPP);
338 static inline int llcrypt_encrypt_block_inplace(const struct inode *inode,
341 unsigned int offs, u64 lblk_num,
347 static inline int llcrypt_decrypt_pagecache_blocks(struct page *page,
354 static inline int llcrypt_decrypt_block_inplace(const struct inode *inode,
357 unsigned int offs, u64 lblk_num)
362 static inline bool llcrypt_is_bounce_page(struct page *page)
367 static inline struct page *llcrypt_pagecache_page(struct page *bounce_page)
370 return ERR_PTR(-EINVAL);
373 static inline void llcrypt_free_bounce_page(struct page *bounce_page)
378 static inline int llcrypt_ioctl_set_policy(struct file *filp,
379 const void __user *arg)
384 static inline int llcrypt_ioctl_get_policy(struct file *filp, void __user *arg)
389 static inline int llcrypt_ioctl_get_policy_ex(struct file *filp,
395 static inline int llcrypt_has_permitted_context(struct inode *parent,
401 static inline int llcrypt_inherit_context(struct inode *parent,
403 void *fs_data, bool preload)
409 static inline void llcrypt_sb_free(struct super_block *sb)
413 static inline int llcrypt_ioctl_add_key(struct file *filp, void __user *arg)
418 static inline int llcrypt_ioctl_remove_key(struct file *filp, void __user *arg)
423 static inline int llcrypt_ioctl_remove_key_all_users(struct file *filp,
429 static inline int llcrypt_ioctl_get_key_status(struct file *filp,
436 static inline int llcrypt_get_encryption_info(struct inode *inode)
441 static inline void llcrypt_put_encryption_info(struct inode *inode)
446 static inline void llcrypt_free_inode(struct inode *inode)
450 static inline int llcrypt_drop_inode(struct inode *inode)
456 static inline int llcrypt_setup_filename(struct inode *dir,
457 const struct qstr *iname,
458 int lookup, struct llcrypt_name *fname)
460 if (IS_ENCRYPTED(dir))
463 memset(fname, 0, sizeof(*fname));
464 fname->usr_fname = iname;
465 fname->disk_name.name = (unsigned char *)iname->name;
466 fname->disk_name.len = iname->len;
470 static inline void llcrypt_free_filename(struct llcrypt_name *fname)
475 static inline int llcrypt_fname_alloc_buffer(const struct inode *inode,
476 u32 max_encrypted_len,
477 struct llcrypt_str *crypto_str)
482 static inline void llcrypt_fname_free_buffer(struct llcrypt_str *crypto_str)
487 static inline int llcrypt_fname_disk_to_usr(struct inode *inode,
488 u32 hash, u32 minor_hash,
489 const struct llcrypt_str *iname,
490 struct llcrypt_str *oname)
495 static inline bool llcrypt_match_name(const struct llcrypt_name *fname,
496 const u8 *de_name, u32 de_name_len)
498 /* Encryption support disabled; use standard comparison */
499 if (de_name_len != fname->disk_name.len)
501 return !memcmp(de_name, fname->disk_name.name, fname->disk_name.len);
505 static inline void llcrypt_decrypt_bio(struct bio *bio)
509 static inline void llcrypt_enqueue_decrypt_bio(struct llcrypt_ctx *ctx,
514 static inline int llcrypt_zeroout_range(const struct inode *inode, pgoff_t lblk,
515 sector_t pblk, unsigned int len)
522 static inline int llcrypt_file_open(struct inode *inode, struct file *filp)
524 if (IS_ENCRYPTED(inode))
529 static inline int __llcrypt_prepare_link(struct inode *inode, struct inode *dir,
530 struct dentry *dentry)
535 static inline int __llcrypt_prepare_rename(struct inode *old_dir,
536 struct dentry *old_dentry,
537 struct inode *new_dir,
538 struct dentry *new_dentry,
544 static inline int __llcrypt_prepare_lookup(struct inode *dir,
545 struct dentry *dentry,
546 struct llcrypt_name *fname)
551 static inline int __llcrypt_prepare_symlink(struct inode *dir,
553 unsigned int max_len,
554 struct llcrypt_str *disk_link)
560 static inline int __llcrypt_encrypt_symlink(struct inode *inode,
563 struct llcrypt_str *disk_link)
568 #define llcrypt_get_symlink(inode, caddr, max_size, done) ERR_PTR(-EOPNOTSUPP)
570 static inline void llcrypt_set_ops(struct super_block *sb,
571 const struct llcrypt_operations *lsi_cop)
575 #endif /* !CONFIG_LL_ENCRYPTION */
578 * llcrypt_require_key - require an inode's encryption key
579 * @inode: the inode we need the key for
581 * If the inode is encrypted, set up its encryption key if not already done.
582 * Then require that the key be present and return -ENOKEY otherwise.
584 * No locks are needed, and the key will live as long as the struct inode --- so
585 * it won't go away from under you.
587 * Return: 0 on success, -ENOKEY if the key is missing, or another -errno code
588 * if a problem occurred while setting up the encryption key.
590 static inline int llcrypt_require_key(struct inode *inode)
592 if (IS_ENCRYPTED(inode)) {
593 int err = llcrypt_get_encryption_info(inode);
597 if (!llcrypt_has_encryption_key(inode))
604 * llcrypt_prepare_link - prepare to link an inode into a possibly-encrypted directory
605 * @old_dentry: an existing dentry for the inode being linked
606 * @dir: the target directory
607 * @dentry: negative dentry for the target filename
609 * A new link can only be added to an encrypted directory if the directory's
610 * encryption key is available --- since otherwise we'd have no way to encrypt
611 * the filename. Therefore, we first set up the directory's encryption key (if
612 * not already done) and return an error if it's unavailable.
614 * We also verify that the link will not violate the constraint that all files
615 * in an encrypted directory tree use the same encryption policy.
617 * Return: 0 on success, -ENOKEY if the directory's encryption key is missing,
618 * -EXDEV if the link would result in an inconsistent encryption policy, or
619 * another -errno code.
621 static inline int llcrypt_prepare_link(struct dentry *old_dentry,
623 struct dentry *dentry)
625 if (IS_ENCRYPTED(dir))
626 return __llcrypt_prepare_link(d_inode(old_dentry), dir, dentry);
631 * llcrypt_prepare_rename - prepare for a rename between possibly-encrypted directories
632 * @old_dir: source directory
633 * @old_dentry: dentry for source file
634 * @new_dir: target directory
635 * @new_dentry: dentry for target location (may be negative unless exchanging)
636 * @flags: rename flags (we care at least about %RENAME_EXCHANGE)
638 * Prepare for ->rename() where the source and/or target directories may be
639 * encrypted. A new link can only be added to an encrypted directory if the
640 * directory's encryption key is available --- since otherwise we'd have no way
641 * to encrypt the filename. A rename to an existing name, on the other hand,
642 * *is* cryptographically possible without the key. However, we take the more
643 * conservative approach and just forbid all no-key renames.
645 * We also verify that the rename will not violate the constraint that all files
646 * in an encrypted directory tree use the same encryption policy.
648 * Return: 0 on success, -ENOKEY if an encryption key is missing, -EXDEV if the
649 * rename would cause inconsistent encryption policies, or another -errno code.
651 static inline int llcrypt_prepare_rename(struct inode *old_dir,
652 struct dentry *old_dentry,
653 struct inode *new_dir,
654 struct dentry *new_dentry,
657 if (IS_ENCRYPTED(old_dir) || IS_ENCRYPTED(new_dir))
658 return __llcrypt_prepare_rename(old_dir, old_dentry,
659 new_dir, new_dentry, flags);
664 * llcrypt_prepare_lookup - prepare to lookup a name in a possibly-encrypted directory
665 * @dir: directory being searched
666 * @dentry: filename being looked up
667 * @fname: (output) the name to use to search the on-disk directory
669 * Prepare for ->lookup() in a directory which may be encrypted by determining
670 * the name that will actually be used to search the directory on-disk. Lookups
671 * can be done with or without the directory's encryption key; without the key,
672 * filenames are presented in encrypted form. Therefore, we'll try to set up
673 * the directory's encryption key, but even without it the lookup can continue.
675 * This also installs a custom ->d_revalidate() method which will invalidate the
676 * dentry if it was created without the key and the key is later added.
678 * Return: 0 on success; -ENOENT if key is unavailable but the filename isn't a
679 * correctly formed encoded ciphertext name, so a negative dentry should be
680 * created; or another -errno code.
682 static inline int llcrypt_prepare_lookup(struct inode *dir,
683 struct dentry *dentry,
684 struct llcrypt_name *fname)
686 if (IS_ENCRYPTED(dir))
687 return __llcrypt_prepare_lookup(dir, dentry, fname);
689 memset(fname, 0, sizeof(*fname));
690 fname->usr_fname = &dentry->d_name;
691 fname->disk_name.name = (unsigned char *)dentry->d_name.name;
692 fname->disk_name.len = dentry->d_name.len;
697 * llcrypt_prepare_setattr - prepare to change a possibly-encrypted inode's attributes
698 * @dentry: dentry through which the inode is being changed
699 * @attr: attributes to change
701 * Prepare for ->setattr() on a possibly-encrypted inode. On an encrypted file,
702 * most attribute changes are allowed even without the encryption key. However,
703 * without the encryption key we do have to forbid truncates. This is needed
704 * because the size being truncated to may not be a multiple of the filesystem
705 * block size, and in that case we'd have to decrypt the final block, zero the
706 * portion past i_size, and re-encrypt it. (We *could* allow truncating to a
707 * filesystem block boundary, but it's simpler to just forbid all truncates ---
708 * and we already forbid all other contents modifications without the key.)
710 * Return: 0 on success, -ENOKEY if the key is missing, or another -errno code
711 * if a problem occurred while setting up the encryption key.
713 static inline int llcrypt_prepare_setattr(struct dentry *dentry,
716 if (attr->ia_valid & ATTR_SIZE)
717 return llcrypt_require_key(d_inode(dentry));
722 * llcrypt_prepare_symlink - prepare to create a possibly-encrypted symlink
723 * @dir: directory in which the symlink is being created
724 * @target: plaintext symlink target
725 * @len: length of @target excluding null terminator
726 * @max_len: space the filesystem has available to store the symlink target
727 * @disk_link: (out) the on-disk symlink target being prepared
729 * This function computes the size the symlink target will require on-disk,
730 * stores it in @disk_link->len, and validates it against @max_len. An
731 * encrypted symlink may be longer than the original.
733 * Additionally, @disk_link->name is set to @target if the symlink will be
734 * unencrypted, but left NULL if the symlink will be encrypted. For encrypted
735 * symlinks, the filesystem must call llcrypt_encrypt_symlink() to create the
736 * on-disk target later. (The reason for the two-step process is that some
737 * filesystems need to know the size of the symlink target before creating the
738 * inode, e.g. to determine whether it will be a "fast" or "slow" symlink.)
740 * Return: 0 on success, -ENAMETOOLONG if the symlink target is too long,
741 * -ENOKEY if the encryption key is missing, or another -errno code if a problem
742 * occurred while setting up the encryption key.
744 static inline int llcrypt_prepare_symlink(struct inode *dir,
747 unsigned int max_len,
748 struct llcrypt_str *disk_link)
750 if (IS_ENCRYPTED(dir) || llcrypt_dummy_context_enabled(dir))
751 return __llcrypt_prepare_symlink(dir, len, max_len, disk_link);
753 disk_link->name = (unsigned char *)target;
754 disk_link->len = len + 1;
755 if (disk_link->len > max_len)
756 return -ENAMETOOLONG;
761 * llcrypt_encrypt_symlink - encrypt the symlink target if needed
762 * @inode: symlink inode
763 * @target: plaintext symlink target
764 * @len: length of @target excluding null terminator
765 * @disk_link: (in/out) the on-disk symlink target being prepared
767 * If the symlink target needs to be encrypted, then this function encrypts it
768 * into @disk_link->name. llcrypt_prepare_symlink() must have been called
769 * previously to compute @disk_link->len. If the filesystem did not allocate a
770 * buffer for @disk_link->name after calling llcrypt_prepare_link(), then one
771 * will be kmalloc()'ed and the filesystem will be responsible for freeing it.
773 * Return: 0 on success, -errno on failure
775 static inline int llcrypt_encrypt_symlink(struct inode *inode,
778 struct llcrypt_str *disk_link)
780 if (IS_ENCRYPTED(inode))
781 return __llcrypt_encrypt_symlink(inode, target, len, disk_link);
785 /* If *pagep is a bounce page, free it and set *pagep to the pagecache page */
786 static inline void llcrypt_finalize_bounce_page(struct page **pagep)
788 struct page *page = *pagep;
790 if (llcrypt_is_bounce_page(page)) {
791 *pagep = llcrypt_pagecache_page(page);
792 llcrypt_free_bounce_page(page);
796 #endif /* _LINUX_LLCRYPT_H */