Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
tjh.dev
kernel
os
linux
1/*
2 * fscrypt_supp.h
3 *
4 * This is included by filesystems configured with encryption support.
5 */
6
7#ifndef _LINUX_FSCRYPT_SUPP_H
8#define _LINUX_FSCRYPT_SUPP_H
9
10#include <linux/fscrypt_common.h>
11
12/* crypto.c */
13extern struct kmem_cache *fscrypt_info_cachep;
14extern struct fscrypt_ctx *fscrypt_get_ctx(const struct inode *, gfp_t);
15extern void fscrypt_release_ctx(struct fscrypt_ctx *);
16extern struct page *fscrypt_encrypt_page(const struct inode *, struct page *,
17 unsigned int, unsigned int,
18 u64, gfp_t);
19extern int fscrypt_decrypt_page(const struct inode *, struct page *, unsigned int,
20 unsigned int, u64);
21extern void fscrypt_restore_control_page(struct page *);
22
23extern const struct dentry_operations fscrypt_d_ops;
24
25static inline void fscrypt_set_d_op(struct dentry *dentry)
26{
27 d_set_d_op(dentry, &fscrypt_d_ops);
28}
29
30static inline void fscrypt_set_encrypted_dentry(struct dentry *dentry)
31{
32 spin_lock(&dentry->d_lock);
33 dentry->d_flags |= DCACHE_ENCRYPTED_WITH_KEY;
34 spin_unlock(&dentry->d_lock);
35}
36
37/* policy.c */
38extern int fscrypt_ioctl_set_policy(struct file *, const void __user *);
39extern int fscrypt_ioctl_get_policy(struct file *, void __user *);
40extern int fscrypt_has_permitted_context(struct inode *, struct inode *);
41extern int fscrypt_inherit_context(struct inode *, struct inode *,
42 void *, bool);
43/* keyinfo.c */
44extern int fscrypt_get_encryption_info(struct inode *);
45extern void fscrypt_put_encryption_info(struct inode *, struct fscrypt_info *);
46
47/* fname.c */
48extern int fscrypt_setup_filename(struct inode *, const struct qstr *,
49 int lookup, struct fscrypt_name *);
50extern void fscrypt_free_filename(struct fscrypt_name *);
51extern u32 fscrypt_fname_encrypted_size(const struct inode *, u32);
52extern int fscrypt_fname_alloc_buffer(const struct inode *, u32,
53 struct fscrypt_str *);
54extern void fscrypt_fname_free_buffer(struct fscrypt_str *);
55extern int fscrypt_fname_disk_to_usr(struct inode *, u32, u32,
56 const struct fscrypt_str *, struct fscrypt_str *);
57extern int fscrypt_fname_usr_to_disk(struct inode *, const struct qstr *,
58 struct fscrypt_str *);
59
60#define FSCRYPT_FNAME_MAX_UNDIGESTED_SIZE 32
61
62/* Extracts the second-to-last ciphertext block; see explanation below */
63#define FSCRYPT_FNAME_DIGEST(name, len) \
64 ((name) + round_down((len) - FS_CRYPTO_BLOCK_SIZE - 1, \
65 FS_CRYPTO_BLOCK_SIZE))
66
67#define FSCRYPT_FNAME_DIGEST_SIZE FS_CRYPTO_BLOCK_SIZE
68
69/**
70 * fscrypt_digested_name - alternate identifier for an on-disk filename
71 *
72 * When userspace lists an encrypted directory without access to the key,
73 * filenames whose ciphertext is longer than FSCRYPT_FNAME_MAX_UNDIGESTED_SIZE
74 * bytes are shown in this abbreviated form (base64-encoded) rather than as the
75 * full ciphertext (base64-encoded). This is necessary to allow supporting
76 * filenames up to NAME_MAX bytes, since base64 encoding expands the length.
77 *
78 * To make it possible for filesystems to still find the correct directory entry
79 * despite not knowing the full on-disk name, we encode any filesystem-specific
80 * 'hash' and/or 'minor_hash' which the filesystem may need for its lookups,
81 * followed by the second-to-last ciphertext block of the filename. Due to the
82 * use of the CBC-CTS encryption mode, the second-to-last ciphertext block
83 * depends on the full plaintext. (Note that ciphertext stealing causes the
84 * last two blocks to appear "flipped".) This makes accidental collisions very
85 * unlikely: just a 1 in 2^128 chance for two filenames to collide even if they
86 * share the same filesystem-specific hashes.
87 *
88 * However, this scheme isn't immune to intentional collisions, which can be
89 * created by anyone able to create arbitrary plaintext filenames and view them
90 * without the key. Making the "digest" be a real cryptographic hash like
91 * SHA-256 over the full ciphertext would prevent this, although it would be
92 * less efficient and harder to implement, especially since the filesystem would
93 * need to calculate it for each directory entry examined during a search.
94 */
95struct fscrypt_digested_name {
96 u32 hash;
97 u32 minor_hash;
98 u8 digest[FSCRYPT_FNAME_DIGEST_SIZE];
99};
100
101/**
102 * fscrypt_match_name() - test whether the given name matches a directory entry
103 * @fname: the name being searched for
104 * @de_name: the name from the directory entry
105 * @de_name_len: the length of @de_name in bytes
106 *
107 * Normally @fname->disk_name will be set, and in that case we simply compare
108 * that to the name stored in the directory entry. The only exception is that
109 * if we don't have the key for an encrypted directory and a filename in it is
110 * very long, then we won't have the full disk_name and we'll instead need to
111 * match against the fscrypt_digested_name.
112 *
113 * Return: %true if the name matches, otherwise %false.
114 */
115static inline bool fscrypt_match_name(const struct fscrypt_name *fname,
116 const u8 *de_name, u32 de_name_len)
117{
118 if (unlikely(!fname->disk_name.name)) {
119 const struct fscrypt_digested_name *n =
120 (const void *)fname->crypto_buf.name;
121 if (WARN_ON_ONCE(fname->usr_fname->name[0] != '_'))
122 return false;
123 if (de_name_len <= FSCRYPT_FNAME_MAX_UNDIGESTED_SIZE)
124 return false;
125 return !memcmp(FSCRYPT_FNAME_DIGEST(de_name, de_name_len),
126 n->digest, FSCRYPT_FNAME_DIGEST_SIZE);
127 }
128
129 if (de_name_len != fname->disk_name.len)
130 return false;
131 return !memcmp(de_name, fname->disk_name.name, fname->disk_name.len);
132}
133
134/* bio.c */
135extern void fscrypt_decrypt_bio_pages(struct fscrypt_ctx *, struct bio *);
136extern void fscrypt_pullback_bio_page(struct page **, bool);
137extern int fscrypt_zeroout_range(const struct inode *, pgoff_t, sector_t,
138 unsigned int);
139
140#endif /* _LINUX_FSCRYPT_SUPP_H */