Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
3325bea5 TT |
2 | /* |
3 | * fscrypt_private.h | |
4 | * | |
5 | * Copyright (C) 2015, Google, Inc. | |
6 | * | |
3ec4f2a6 EB |
7 | * Originally written by Michael Halcrow, Ildar Muslukhov, and Uday Savagaonkar. |
8 | * Heavily modified since then. | |
3325bea5 TT |
9 | */ |
10 | ||
11 | #ifndef _FSCRYPT_PRIVATE_H | |
12 | #define _FSCRYPT_PRIVATE_H | |
13 | ||
734f0d24 | 14 | #include <linux/fscrypt.h> |
aa408f83 | 15 | #include <linux/siphash.h> |
b7e7cf7a | 16 | #include <crypto/hash.h> |
5fee3609 | 17 | #include <linux/blk-crypto.h> |
3325bea5 | 18 | |
22d94f49 EB |
19 | #define CONST_STRLEN(str) (sizeof(str) - 1) |
20 | ||
1d6217a4 | 21 | #define FSCRYPT_FILE_NONCE_SIZE 16 |
cc4e0df0 | 22 | |
b7e072f9 EB |
23 | /* |
24 | * Minimum size of an fscrypt master key. Note: a longer key will be required | |
25 | * if ciphers with a 256-bit security strength are used. This is just the | |
26 | * absolute minimum, which applies when only 128-bit encryption is used. | |
27 | */ | |
1d6217a4 | 28 | #define FSCRYPT_MIN_KEY_SIZE 16 |
22d94f49 | 29 | |
5dae460c EB |
30 | #define FSCRYPT_CONTEXT_V1 1 |
31 | #define FSCRYPT_CONTEXT_V2 2 | |
32 | ||
3ceb6543 | 33 | /* Keep this in sync with include/uapi/linux/fscrypt.h */ |
6b2a51ff | 34 | #define FSCRYPT_MODE_MAX FSCRYPT_MODE_AES_256_HCTR2 |
3ceb6543 | 35 | |
5dae460c EB |
36 | struct fscrypt_context_v1 { |
37 | u8 version; /* FSCRYPT_CONTEXT_V1 */ | |
cc4e0df0 TT |
38 | u8 contents_encryption_mode; |
39 | u8 filenames_encryption_mode; | |
40 | u8 flags; | |
3b6df59b | 41 | u8 master_key_descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE]; |
1d6217a4 | 42 | u8 nonce[FSCRYPT_FILE_NONCE_SIZE]; |
5dae460c | 43 | }; |
cc4e0df0 | 44 | |
5dae460c EB |
45 | struct fscrypt_context_v2 { |
46 | u8 version; /* FSCRYPT_CONTEXT_V2 */ | |
47 | u8 contents_encryption_mode; | |
48 | u8 filenames_encryption_mode; | |
49 | u8 flags; | |
5b118884 EB |
50 | u8 log2_data_unit_size; |
51 | u8 __reserved[3]; | |
5dae460c | 52 | u8 master_key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE]; |
1d6217a4 | 53 | u8 nonce[FSCRYPT_FILE_NONCE_SIZE]; |
5dae460c EB |
54 | }; |
55 | ||
d2fe9754 | 56 | /* |
5dae460c EB |
57 | * fscrypt_context - the encryption context of an inode |
58 | * | |
59 | * This is the on-disk equivalent of an fscrypt_policy, stored alongside each | |
60 | * encrypted file usually in a hidden extended attribute. It contains the | |
61 | * fields from the fscrypt_policy, in order to identify the encryption algorithm | |
62 | * and key with which the file is encrypted. It also contains a nonce that was | |
63 | * randomly generated by fscrypt itself; this is used as KDF input or as a tweak | |
64 | * to cause different files to be encrypted differently. | |
65 | */ | |
66 | union fscrypt_context { | |
67 | u8 version; | |
68 | struct fscrypt_context_v1 v1; | |
69 | struct fscrypt_context_v2 v2; | |
70 | }; | |
71 | ||
72 | /* | |
73 | * Return the size expected for the given fscrypt_context based on its version | |
74 | * number, or 0 if the context version is unrecognized. | |
75 | */ | |
76 | static inline int fscrypt_context_size(const union fscrypt_context *ctx) | |
77 | { | |
78 | switch (ctx->version) { | |
79 | case FSCRYPT_CONTEXT_V1: | |
80 | BUILD_BUG_ON(sizeof(ctx->v1) != 28); | |
81 | return sizeof(ctx->v1); | |
82 | case FSCRYPT_CONTEXT_V2: | |
83 | BUILD_BUG_ON(sizeof(ctx->v2) != 40); | |
84 | return sizeof(ctx->v2); | |
85 | } | |
86 | return 0; | |
87 | } | |
88 | ||
e98ad464 EB |
89 | /* Check whether an fscrypt_context has a recognized version number and size */ |
90 | static inline bool fscrypt_context_is_valid(const union fscrypt_context *ctx, | |
91 | int ctx_size) | |
92 | { | |
93 | return ctx_size >= 1 && ctx_size == fscrypt_context_size(ctx); | |
94 | } | |
95 | ||
96 | /* Retrieve the context's nonce, assuming the context was already validated */ | |
97 | static inline const u8 *fscrypt_context_nonce(const union fscrypt_context *ctx) | |
98 | { | |
99 | switch (ctx->version) { | |
100 | case FSCRYPT_CONTEXT_V1: | |
101 | return ctx->v1.nonce; | |
102 | case FSCRYPT_CONTEXT_V2: | |
103 | return ctx->v2.nonce; | |
104 | } | |
41b2ad80 | 105 | WARN_ON_ONCE(1); |
e98ad464 EB |
106 | return NULL; |
107 | } | |
108 | ||
5dae460c EB |
109 | union fscrypt_policy { |
110 | u8 version; | |
111 | struct fscrypt_policy_v1 v1; | |
112 | struct fscrypt_policy_v2 v2; | |
113 | }; | |
114 | ||
115 | /* | |
116 | * Return the size expected for the given fscrypt_policy based on its version | |
117 | * number, or 0 if the policy version is unrecognized. | |
118 | */ | |
119 | static inline int fscrypt_policy_size(const union fscrypt_policy *policy) | |
120 | { | |
121 | switch (policy->version) { | |
122 | case FSCRYPT_POLICY_V1: | |
123 | return sizeof(policy->v1); | |
124 | case FSCRYPT_POLICY_V2: | |
125 | return sizeof(policy->v2); | |
126 | } | |
127 | return 0; | |
128 | } | |
129 | ||
130 | /* Return the contents encryption mode of a valid encryption policy */ | |
131 | static inline u8 | |
132 | fscrypt_policy_contents_mode(const union fscrypt_policy *policy) | |
133 | { | |
134 | switch (policy->version) { | |
135 | case FSCRYPT_POLICY_V1: | |
136 | return policy->v1.contents_encryption_mode; | |
137 | case FSCRYPT_POLICY_V2: | |
138 | return policy->v2.contents_encryption_mode; | |
139 | } | |
140 | BUG(); | |
141 | } | |
142 | ||
143 | /* Return the filenames encryption mode of a valid encryption policy */ | |
144 | static inline u8 | |
145 | fscrypt_policy_fnames_mode(const union fscrypt_policy *policy) | |
146 | { | |
147 | switch (policy->version) { | |
148 | case FSCRYPT_POLICY_V1: | |
149 | return policy->v1.filenames_encryption_mode; | |
150 | case FSCRYPT_POLICY_V2: | |
151 | return policy->v2.filenames_encryption_mode; | |
152 | } | |
153 | BUG(); | |
154 | } | |
155 | ||
156 | /* Return the flags (FSCRYPT_POLICY_FLAG*) of a valid encryption policy */ | |
157 | static inline u8 | |
158 | fscrypt_policy_flags(const union fscrypt_policy *policy) | |
159 | { | |
160 | switch (policy->version) { | |
161 | case FSCRYPT_POLICY_V1: | |
162 | return policy->v1.flags; | |
163 | case FSCRYPT_POLICY_V2: | |
164 | return policy->v2.flags; | |
165 | } | |
166 | BUG(); | |
167 | } | |
168 | ||
5b118884 EB |
169 | static inline int |
170 | fscrypt_policy_v2_du_bits(const struct fscrypt_policy_v2 *policy, | |
171 | const struct inode *inode) | |
172 | { | |
173 | return policy->log2_data_unit_size ?: inode->i_blkbits; | |
174 | } | |
175 | ||
176 | static inline int | |
177 | fscrypt_policy_du_bits(const union fscrypt_policy *policy, | |
178 | const struct inode *inode) | |
179 | { | |
180 | switch (policy->version) { | |
181 | case FSCRYPT_POLICY_V1: | |
182 | return inode->i_blkbits; | |
183 | case FSCRYPT_POLICY_V2: | |
184 | return fscrypt_policy_v2_du_bits(&policy->v2, inode); | |
185 | } | |
186 | BUG(); | |
187 | } | |
188 | ||
d2fe9754 | 189 | /* |
0eaab5b1 EB |
190 | * For encrypted symlinks, the ciphertext length is stored at the beginning |
191 | * of the string in little-endian format. | |
192 | */ | |
193 | struct fscrypt_symlink_data { | |
194 | __le16 len; | |
d617ef03 | 195 | char encrypted_path[]; |
0eaab5b1 EB |
196 | } __packed; |
197 | ||
5fee3609 ST |
198 | /** |
199 | * struct fscrypt_prepared_key - a key prepared for actual encryption/decryption | |
200 | * @tfm: crypto API transform object | |
201 | * @blk_key: key for blk-crypto | |
202 | * | |
203 | * Normally only one of the fields will be non-NULL. | |
204 | */ | |
205 | struct fscrypt_prepared_key { | |
206 | struct crypto_skcipher *tfm; | |
207 | #ifdef CONFIG_FS_ENCRYPTION_INLINE_CRYPT | |
22e9947a | 208 | struct blk_crypto_key *blk_key; |
5fee3609 ST |
209 | #endif |
210 | }; | |
211 | ||
cc4e0df0 | 212 | /* |
3e7807d5 | 213 | * fscrypt_inode_info - the "encryption key" for an inode |
8094c3ce EB |
214 | * |
215 | * When an encrypted file's key is made available, an instance of this struct is | |
216 | * allocated and stored in ->i_crypt_info. Once created, it remains until the | |
217 | * inode is evicted. | |
cc4e0df0 | 218 | */ |
3e7807d5 | 219 | struct fscrypt_inode_info { |
8094c3ce | 220 | |
5fee3609 ST |
221 | /* The key in a form prepared for actual encryption/decryption */ |
222 | struct fscrypt_prepared_key ci_enc_key; | |
8094c3ce | 223 | |
3e7807d5 | 224 | /* True if ci_enc_key should be freed when this struct is freed */ |
b103fb76 EB |
225 | bool ci_owns_key; |
226 | ||
5fee3609 ST |
227 | #ifdef CONFIG_FS_ENCRYPTION_INLINE_CRYPT |
228 | /* | |
229 | * True if this inode will use inline encryption (blk-crypto) instead of | |
230 | * the traditional filesystem-layer encryption. | |
231 | */ | |
232 | bool ci_inlinecrypt; | |
233 | #endif | |
234 | ||
5b118884 EB |
235 | /* |
236 | * log2 of the data unit size (granularity of contents encryption) of | |
237 | * this file. This is computable from ci_policy and ci_inode but is | |
238 | * cached here for efficiency. Only used for regular files. | |
239 | */ | |
240 | u8 ci_data_unit_bits; | |
241 | ||
242 | /* Cached value: log2 of number of data units per FS block */ | |
243 | u8 ci_data_units_per_block_bits; | |
244 | ||
8094c3ce | 245 | /* |
5dae460c EB |
246 | * Encryption mode used for this inode. It corresponds to either the |
247 | * contents or filenames encryption mode, depending on the inode type. | |
8094c3ce EB |
248 | */ |
249 | struct fscrypt_mode *ci_mode; | |
250 | ||
59dc6a8e EB |
251 | /* Back-pointer to the inode */ |
252 | struct inode *ci_inode; | |
253 | ||
b1c0ec35 EB |
254 | /* |
255 | * The master key with which this inode was unlocked (decrypted). This | |
256 | * will be NULL if the master key was found in a process-subscribed | |
257 | * keyring rather than in the filesystem-level keyring. | |
258 | */ | |
d7e7b9af | 259 | struct fscrypt_master_key *ci_master_key; |
b1c0ec35 EB |
260 | |
261 | /* | |
262 | * Link in list of inodes that were unlocked with the master key. | |
263 | * Only used when ->ci_master_key is set. | |
264 | */ | |
265 | struct list_head ci_master_key_link; | |
266 | ||
8094c3ce | 267 | /* |
a828daab | 268 | * If non-NULL, then encryption is done using the master key directly |
5fee3609 | 269 | * and ci_enc_key will equal ci_direct_key->dk_key. |
8094c3ce | 270 | */ |
a828daab | 271 | struct fscrypt_direct_key *ci_direct_key; |
8094c3ce | 272 | |
aa408f83 DR |
273 | /* |
274 | * This inode's hash key for filenames. This is a 128-bit SipHash-2-4 | |
275 | * key. This is only set for directories that use a keyed dirhash over | |
276 | * the plaintext filenames -- currently just casefolded directories. | |
277 | */ | |
278 | siphash_key_t ci_dirhash_key; | |
279 | bool ci_dirhash_key_initialized; | |
280 | ||
5dae460c EB |
281 | /* The encryption policy used by this inode */ |
282 | union fscrypt_policy ci_policy; | |
283 | ||
284 | /* This inode's nonce, copied from the fscrypt_context */ | |
1d6217a4 | 285 | u8 ci_nonce[FSCRYPT_FILE_NONCE_SIZE]; |
e3b1078b EB |
286 | |
287 | /* Hashed inode number. Only set for IV_INO_LBLK_32 */ | |
288 | u32 ci_hashed_ino; | |
cc4e0df0 TT |
289 | }; |
290 | ||
58ae7468 RW |
291 | typedef enum { |
292 | FS_DECRYPT = 0, | |
293 | FS_ENCRYPT, | |
294 | } fscrypt_direction_t; | |
295 | ||
b98701df | 296 | /* crypto.c */ |
3e7807d5 | 297 | extern struct kmem_cache *fscrypt_inode_info_cachep; |
83e57e47 | 298 | int fscrypt_initialize(struct super_block *sb); |
3e7807d5 | 299 | int fscrypt_crypt_data_unit(const struct fscrypt_inode_info *ci, |
5b118884 EB |
300 | fscrypt_direction_t rw, u64 index, |
301 | struct page *src_page, struct page *dest_page, | |
302 | unsigned int len, unsigned int offs, | |
303 | gfp_t gfp_flags); | |
60700902 EB |
304 | struct page *fscrypt_alloc_bounce_page(gfp_t gfp_flags); |
305 | ||
306 | void __printf(3, 4) __cold | |
886da8b3 | 307 | fscrypt_msg(const struct inode *inode, const char *level, const char *fmt, ...); |
544d08fd | 308 | |
886da8b3 EB |
309 | #define fscrypt_warn(inode, fmt, ...) \ |
310 | fscrypt_msg((inode), KERN_WARNING, fmt, ##__VA_ARGS__) | |
311 | #define fscrypt_err(inode, fmt, ...) \ | |
312 | fscrypt_msg((inode), KERN_ERR, fmt, ##__VA_ARGS__) | |
544d08fd | 313 | |
8094c3ce EB |
314 | #define FSCRYPT_MAX_IV_SIZE 32 |
315 | ||
316 | union fscrypt_iv { | |
317 | struct { | |
5b118884 EB |
318 | /* zero-based index of data unit within the file */ |
319 | __le64 index; | |
8094c3ce EB |
320 | |
321 | /* per-file nonce; only set in DIRECT_KEY mode */ | |
1d6217a4 | 322 | u8 nonce[FSCRYPT_FILE_NONCE_SIZE]; |
8094c3ce EB |
323 | }; |
324 | u8 raw[FSCRYPT_MAX_IV_SIZE]; | |
5fee3609 | 325 | __le64 dun[FSCRYPT_MAX_IV_SIZE / sizeof(__le64)]; |
8094c3ce EB |
326 | }; |
327 | ||
5b118884 | 328 | void fscrypt_generate_iv(union fscrypt_iv *iv, u64 index, |
3e7807d5 | 329 | const struct fscrypt_inode_info *ci); |
8094c3ce | 330 | |
f0904e8b | 331 | /* |
5b118884 EB |
332 | * Return the number of bits used by the maximum file data unit index that is |
333 | * possible on the given filesystem, using the given log2 data unit size. | |
f0904e8b EB |
334 | */ |
335 | static inline int | |
5b118884 | 336 | fscrypt_max_file_dun_bits(const struct super_block *sb, int du_bits) |
f0904e8b | 337 | { |
5b118884 | 338 | return fls64(sb->s_maxbytes - 1) - du_bits; |
f0904e8b EB |
339 | } |
340 | ||
76e81d6d | 341 | /* fname.c */ |
d3e94fdc JL |
342 | bool __fscrypt_fname_encrypted_size(const union fscrypt_policy *policy, |
343 | u32 orig_len, u32 max_len, | |
344 | u32 *encrypted_len_ret); | |
76e81d6d | 345 | |
c1144c9b | 346 | /* hkdf.c */ |
c1144c9b EB |
347 | struct fscrypt_hkdf { |
348 | struct crypto_shash *hmac_tfm; | |
349 | }; | |
350 | ||
60700902 EB |
351 | int fscrypt_init_hkdf(struct fscrypt_hkdf *hkdf, const u8 *master_key, |
352 | unsigned int master_key_size); | |
c1144c9b | 353 | |
5dae460c EB |
354 | /* |
355 | * The list of contexts in which fscrypt uses HKDF. These values are used as | |
356 | * the first byte of the HKDF application-specific info string to guarantee that | |
357 | * info strings are never repeated between contexts. This ensures that all HKDF | |
358 | * outputs are unique and cryptographically isolated, i.e. knowledge of one | |
359 | * output doesn't reveal another. | |
360 | */ | |
e455de31 EB |
361 | #define HKDF_CONTEXT_KEY_IDENTIFIER 1 /* info=<empty> */ |
362 | #define HKDF_CONTEXT_PER_FILE_ENC_KEY 2 /* info=file_nonce */ | |
363 | #define HKDF_CONTEXT_DIRECT_KEY 3 /* info=mode_num */ | |
364 | #define HKDF_CONTEXT_IV_INO_LBLK_64_KEY 4 /* info=mode_num||fs_uuid */ | |
365 | #define HKDF_CONTEXT_DIRHASH_KEY 5 /* info=file_nonce */ | |
366 | #define HKDF_CONTEXT_IV_INO_LBLK_32_KEY 6 /* info=mode_num||fs_uuid */ | |
367 | #define HKDF_CONTEXT_INODE_HASH_KEY 7 /* info=<empty> */ | |
5dae460c | 368 | |
60700902 EB |
369 | int fscrypt_hkdf_expand(const struct fscrypt_hkdf *hkdf, u8 context, |
370 | const u8 *info, unsigned int infolen, | |
371 | u8 *okm, unsigned int okmlen); | |
c1144c9b | 372 | |
60700902 | 373 | void fscrypt_destroy_hkdf(struct fscrypt_hkdf *hkdf); |
c1144c9b | 374 | |
5fee3609 ST |
375 | /* inline_crypt.c */ |
376 | #ifdef CONFIG_FS_ENCRYPTION_INLINE_CRYPT | |
3e7807d5 | 377 | int fscrypt_select_encryption_impl(struct fscrypt_inode_info *ci); |
5fee3609 ST |
378 | |
379 | static inline bool | |
3e7807d5 | 380 | fscrypt_using_inline_encryption(const struct fscrypt_inode_info *ci) |
5fee3609 ST |
381 | { |
382 | return ci->ci_inlinecrypt; | |
383 | } | |
384 | ||
385 | int fscrypt_prepare_inline_crypt_key(struct fscrypt_prepared_key *prep_key, | |
386 | const u8 *raw_key, | |
3e7807d5 | 387 | const struct fscrypt_inode_info *ci); |
5fee3609 | 388 | |
22e9947a EB |
389 | void fscrypt_destroy_inline_crypt_key(struct super_block *sb, |
390 | struct fscrypt_prepared_key *prep_key); | |
5fee3609 ST |
391 | |
392 | /* | |
393 | * Check whether the crypto transform or blk-crypto key has been allocated in | |
394 | * @prep_key, depending on which encryption implementation the file will use. | |
395 | */ | |
396 | static inline bool | |
397 | fscrypt_is_key_prepared(struct fscrypt_prepared_key *prep_key, | |
3e7807d5 | 398 | const struct fscrypt_inode_info *ci) |
5fee3609 ST |
399 | { |
400 | /* | |
97c6327f EB |
401 | * The two smp_load_acquire()'s here pair with the smp_store_release()'s |
402 | * in fscrypt_prepare_inline_crypt_key() and fscrypt_prepare_key(). | |
403 | * I.e., in some cases (namely, if this prep_key is a per-mode | |
404 | * encryption key) another task can publish blk_key or tfm concurrently, | |
405 | * executing a RELEASE barrier. We need to use smp_load_acquire() here | |
406 | * to safely ACQUIRE the memory the other task published. | |
5fee3609 ST |
407 | */ |
408 | if (fscrypt_using_inline_encryption(ci)) | |
97c6327f EB |
409 | return smp_load_acquire(&prep_key->blk_key) != NULL; |
410 | return smp_load_acquire(&prep_key->tfm) != NULL; | |
5fee3609 ST |
411 | } |
412 | ||
413 | #else /* CONFIG_FS_ENCRYPTION_INLINE_CRYPT */ | |
414 | ||
3e7807d5 | 415 | static inline int fscrypt_select_encryption_impl(struct fscrypt_inode_info *ci) |
5fee3609 ST |
416 | { |
417 | return 0; | |
418 | } | |
419 | ||
420 | static inline bool | |
3e7807d5 | 421 | fscrypt_using_inline_encryption(const struct fscrypt_inode_info *ci) |
5fee3609 ST |
422 | { |
423 | return false; | |
424 | } | |
425 | ||
426 | static inline int | |
427 | fscrypt_prepare_inline_crypt_key(struct fscrypt_prepared_key *prep_key, | |
428 | const u8 *raw_key, | |
3e7807d5 | 429 | const struct fscrypt_inode_info *ci) |
5fee3609 | 430 | { |
41b2ad80 | 431 | WARN_ON_ONCE(1); |
5fee3609 ST |
432 | return -EOPNOTSUPP; |
433 | } | |
434 | ||
435 | static inline void | |
22e9947a EB |
436 | fscrypt_destroy_inline_crypt_key(struct super_block *sb, |
437 | struct fscrypt_prepared_key *prep_key) | |
5fee3609 ST |
438 | { |
439 | } | |
440 | ||
441 | static inline bool | |
442 | fscrypt_is_key_prepared(struct fscrypt_prepared_key *prep_key, | |
3e7807d5 | 443 | const struct fscrypt_inode_info *ci) |
5fee3609 | 444 | { |
97c6327f | 445 | return smp_load_acquire(&prep_key->tfm) != NULL; |
5fee3609 ST |
446 | } |
447 | #endif /* !CONFIG_FS_ENCRYPTION_INLINE_CRYPT */ | |
448 | ||
22d94f49 EB |
449 | /* keyring.c */ |
450 | ||
451 | /* | |
452 | * fscrypt_master_key_secret - secret key material of an in-use master key | |
453 | */ | |
454 | struct fscrypt_master_key_secret { | |
455 | ||
5dae460c EB |
456 | /* |
457 | * For v2 policy keys: HKDF context keyed by this master key. | |
458 | * For v1 policy keys: not set (hkdf.hmac_tfm == NULL). | |
459 | */ | |
460 | struct fscrypt_hkdf hkdf; | |
461 | ||
b7e072f9 EB |
462 | /* |
463 | * Size of the raw key in bytes. This remains set even if ->raw was | |
464 | * zeroized due to no longer being needed. I.e. we still remember the | |
465 | * size of the key even if we don't need to remember the key itself. | |
466 | */ | |
22d94f49 EB |
467 | u32 size; |
468 | ||
5dae460c | 469 | /* For v1 policy keys: the raw key. Wiped for v2 policy keys. */ |
22d94f49 EB |
470 | u8 raw[FSCRYPT_MAX_KEY_SIZE]; |
471 | ||
472 | } __randomize_layout; | |
473 | ||
474 | /* | |
475 | * fscrypt_master_key - an in-use master key | |
476 | * | |
477 | * This represents a master encryption key which has been added to the | |
15baf554 EB |
478 | * filesystem. There are three high-level states that a key can be in: |
479 | * | |
480 | * FSCRYPT_KEY_STATUS_PRESENT | |
481 | * Key is fully usable; it can be used to unlock inodes that are encrypted | |
482 | * with it (this includes being able to create new inodes). ->mk_present | |
483 | * indicates whether the key is in this state. ->mk_secret exists, the key | |
484 | * is in the keyring, and ->mk_active_refs > 0 due to ->mk_present. | |
485 | * | |
486 | * FSCRYPT_KEY_STATUS_INCOMPLETELY_REMOVED | |
487 | * Removal of this key has been initiated, but some inodes that were | |
488 | * unlocked with it are still in-use. Like ABSENT, ->mk_secret is wiped, | |
489 | * and the key can no longer be used to unlock inodes. Unlike ABSENT, the | |
490 | * key is still in the keyring; ->mk_decrypted_inodes is nonempty; and | |
491 | * ->mk_active_refs > 0, being equal to the size of ->mk_decrypted_inodes. | |
492 | * | |
493 | * This state transitions to ABSENT if ->mk_decrypted_inodes becomes empty, | |
494 | * or to PRESENT if FS_IOC_ADD_ENCRYPTION_KEY is called again for this key. | |
495 | * | |
496 | * FSCRYPT_KEY_STATUS_ABSENT | |
497 | * Key is fully removed. The key is no longer in the keyring, | |
498 | * ->mk_decrypted_inodes is empty, ->mk_active_refs == 0, ->mk_secret is | |
499 | * wiped, and the key can no longer be used to unlock inodes. | |
22d94f49 EB |
500 | */ |
501 | struct fscrypt_master_key { | |
502 | ||
d7e7b9af | 503 | /* |
02aef422 | 504 | * Link in ->s_master_keys->key_hashtable. |
d7e7b9af EB |
505 | * Only valid if ->mk_active_refs > 0. |
506 | */ | |
507 | struct hlist_node mk_node; | |
508 | ||
15baf554 | 509 | /* Semaphore that protects ->mk_secret, ->mk_users, and ->mk_present */ |
d7e7b9af EB |
510 | struct rw_semaphore mk_sem; |
511 | ||
512 | /* | |
513 | * Active and structural reference counts. An active ref guarantees | |
514 | * that the struct continues to exist, continues to be in the keyring | |
02aef422 | 515 | * ->s_master_keys, and that any embedded subkeys (e.g. |
d7e7b9af EB |
516 | * ->mk_direct_keys) that have been prepared continue to exist. |
517 | * A structural ref only guarantees that the struct continues to exist. | |
518 | * | |
15baf554 EB |
519 | * There is one active ref associated with ->mk_present being true, and |
520 | * one active ref for each inode in ->mk_decrypted_inodes. | |
d7e7b9af EB |
521 | * |
522 | * There is one structural ref associated with the active refcount being | |
523 | * nonzero. Finding a key in the keyring also takes a structural ref, | |
524 | * which is then held temporarily while the key is operated on. | |
525 | */ | |
526 | refcount_t mk_active_refs; | |
527 | refcount_t mk_struct_refs; | |
528 | ||
529 | struct rcu_head mk_rcu_head; | |
530 | ||
b1c0ec35 | 531 | /* |
15baf554 EB |
532 | * The secret key material. Wiped as soon as it is no longer needed; |
533 | * for details, see the fscrypt_master_key struct comment. | |
b1c0ec35 | 534 | * |
15baf554 | 535 | * Locking: protected by ->mk_sem. |
b1c0ec35 | 536 | */ |
22d94f49 EB |
537 | struct fscrypt_master_key_secret mk_secret; |
538 | ||
5dae460c EB |
539 | /* |
540 | * For v1 policy keys: an arbitrary key descriptor which was assigned by | |
541 | * userspace (->descriptor). | |
542 | * | |
543 | * For v2 policy keys: a cryptographic hash of this key (->identifier). | |
544 | */ | |
22d94f49 EB |
545 | struct fscrypt_key_specifier mk_spec; |
546 | ||
23c688b5 EB |
547 | /* |
548 | * Keyring which contains a key of type 'key_type_fscrypt_user' for each | |
549 | * user who has added this key. Normally each key will be added by just | |
550 | * one user, but it's possible that multiple users share a key, and in | |
551 | * that case we need to keep track of those users so that one user can't | |
552 | * remove the key before the others want it removed too. | |
553 | * | |
554 | * This is NULL for v1 policy keys; those can only be added by root. | |
555 | * | |
d7e7b9af EB |
556 | * Locking: protected by ->mk_sem. (We don't just rely on the keyrings |
557 | * subsystem semaphore ->mk_users->sem, as we need support for atomic | |
15baf554 | 558 | * search+insert along with proper synchronization with other fields.) |
23c688b5 EB |
559 | */ |
560 | struct key *mk_users; | |
561 | ||
b1c0ec35 EB |
562 | /* |
563 | * List of inodes that were unlocked using this key. This allows the | |
564 | * inodes to be evicted efficiently if the key is removed. | |
565 | */ | |
566 | struct list_head mk_decrypted_inodes; | |
567 | spinlock_t mk_decrypted_inodes_lock; | |
568 | ||
b103fb76 | 569 | /* |
e3b1078b EB |
570 | * Per-mode encryption keys for the various types of encryption policies |
571 | * that use them. Allocated and derived on-demand. | |
b103fb76 | 572 | */ |
3ceb6543 EB |
573 | struct fscrypt_prepared_key mk_direct_keys[FSCRYPT_MODE_MAX + 1]; |
574 | struct fscrypt_prepared_key mk_iv_ino_lblk_64_keys[FSCRYPT_MODE_MAX + 1]; | |
575 | struct fscrypt_prepared_key mk_iv_ino_lblk_32_keys[FSCRYPT_MODE_MAX + 1]; | |
e3b1078b EB |
576 | |
577 | /* Hash key for inode numbers. Initialized only when needed. */ | |
578 | siphash_key_t mk_ino_hash_key; | |
579 | bool mk_ino_hash_key_initialized; | |
5dae460c | 580 | |
b1c0ec35 | 581 | /* |
15baf554 EB |
582 | * Whether this key is in the "present" state, i.e. fully usable. For |
583 | * details, see the fscrypt_master_key struct comment. | |
584 | * | |
585 | * Locking: protected by ->mk_sem, but can be read locklessly using | |
586 | * READ_ONCE(). Writers must use WRITE_ONCE() when concurrent readers | |
587 | * are possible. | |
b1c0ec35 | 588 | */ |
15baf554 EB |
589 | bool mk_present; |
590 | ||
591 | } __randomize_layout; | |
b1c0ec35 | 592 | |
22d94f49 EB |
593 | static inline const char *master_key_spec_type( |
594 | const struct fscrypt_key_specifier *spec) | |
595 | { | |
596 | switch (spec->type) { | |
597 | case FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR: | |
598 | return "descriptor"; | |
5dae460c EB |
599 | case FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER: |
600 | return "identifier"; | |
22d94f49 EB |
601 | } |
602 | return "[unknown]"; | |
603 | } | |
604 | ||
605 | static inline int master_key_spec_len(const struct fscrypt_key_specifier *spec) | |
606 | { | |
607 | switch (spec->type) { | |
608 | case FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR: | |
609 | return FSCRYPT_KEY_DESCRIPTOR_SIZE; | |
5dae460c EB |
610 | case FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER: |
611 | return FSCRYPT_KEY_IDENTIFIER_SIZE; | |
22d94f49 EB |
612 | } |
613 | return 0; | |
614 | } | |
615 | ||
d7e7b9af EB |
616 | void fscrypt_put_master_key(struct fscrypt_master_key *mk); |
617 | ||
02aef422 EB |
618 | void fscrypt_put_master_key_activeref(struct super_block *sb, |
619 | struct fscrypt_master_key *mk); | |
d7e7b9af EB |
620 | |
621 | struct fscrypt_master_key * | |
22d94f49 EB |
622 | fscrypt_find_master_key(struct super_block *sb, |
623 | const struct fscrypt_key_specifier *mk_spec); | |
624 | ||
218d921b EB |
625 | int fscrypt_get_test_dummy_key_identifier( |
626 | u8 key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE]); | |
cdeb21da | 627 | |
097d7c1f EB |
628 | int fscrypt_add_test_dummy_key(struct super_block *sb, |
629 | struct fscrypt_key_specifier *key_spec); | |
630 | ||
60700902 EB |
631 | int fscrypt_verify_key_added(struct super_block *sb, |
632 | const u8 identifier[FSCRYPT_KEY_IDENTIFIER_SIZE]); | |
5ab7189a | 633 | |
60700902 | 634 | int __init fscrypt_init_keyring(void); |
22d94f49 | 635 | |
feed8258 | 636 | /* keysetup.c */ |
8094c3ce EB |
637 | |
638 | struct fscrypt_mode { | |
639 | const char *friendly_name; | |
640 | const char *cipher_str; | |
7f595d6a EB |
641 | int keysize; /* key size in bytes */ |
642 | int security_strength; /* security strength in bytes */ | |
643 | int ivsize; /* IV size in bytes */ | |
a7a5bc5f EB |
644 | int logged_cryptoapi_impl; |
645 | int logged_blk_crypto_native; | |
646 | int logged_blk_crypto_fallback; | |
5fee3609 | 647 | enum blk_crypto_mode_num blk_crypto_mode; |
8094c3ce EB |
648 | }; |
649 | ||
85af90e5 | 650 | extern struct fscrypt_mode fscrypt_modes[]; |
3ec4f2a6 | 651 | |
5fee3609 | 652 | int fscrypt_prepare_key(struct fscrypt_prepared_key *prep_key, |
3e7807d5 | 653 | const u8 *raw_key, const struct fscrypt_inode_info *ci); |
5fee3609 | 654 | |
22e9947a EB |
655 | void fscrypt_destroy_prepared_key(struct super_block *sb, |
656 | struct fscrypt_prepared_key *prep_key); | |
0109ce76 | 657 | |
3e7807d5 JB |
658 | int fscrypt_set_per_file_enc_key(struct fscrypt_inode_info *ci, |
659 | const u8 *raw_key); | |
0109ce76 | 660 | |
3e7807d5 | 661 | int fscrypt_derive_dirhash_key(struct fscrypt_inode_info *ci, |
60700902 | 662 | const struct fscrypt_master_key *mk); |
aa408f83 | 663 | |
3e7807d5 | 664 | void fscrypt_hash_inode_number(struct fscrypt_inode_info *ci, |
a992b20c EB |
665 | const struct fscrypt_master_key *mk); |
666 | ||
a14d0b67 | 667 | int fscrypt_get_encryption_info(struct inode *inode, bool allow_unsupported); |
5b421f08 | 668 | |
de3cdc6e EB |
669 | /** |
670 | * fscrypt_require_key() - require an inode's encryption key | |
671 | * @inode: the inode we need the key for | |
672 | * | |
673 | * If the inode is encrypted, set up its encryption key if not already done. | |
674 | * Then require that the key be present and return -ENOKEY otherwise. | |
675 | * | |
676 | * No locks are needed, and the key will live as long as the struct inode --- so | |
677 | * it won't go away from under you. | |
678 | * | |
679 | * Return: 0 on success, -ENOKEY if the key is missing, or another -errno code | |
680 | * if a problem occurred while setting up the encryption key. | |
681 | */ | |
682 | static inline int fscrypt_require_key(struct inode *inode) | |
683 | { | |
684 | if (IS_ENCRYPTED(inode)) { | |
a14d0b67 | 685 | int err = fscrypt_get_encryption_info(inode, false); |
de3cdc6e EB |
686 | |
687 | if (err) | |
688 | return err; | |
689 | if (!fscrypt_has_encryption_key(inode)) | |
690 | return -ENOKEY; | |
691 | } | |
692 | return 0; | |
693 | } | |
694 | ||
0109ce76 EB |
695 | /* keysetup_v1.c */ |
696 | ||
60700902 | 697 | void fscrypt_put_direct_key(struct fscrypt_direct_key *dk); |
0109ce76 | 698 | |
3e7807d5 | 699 | int fscrypt_setup_v1_file_key(struct fscrypt_inode_info *ci, |
60700902 EB |
700 | const u8 *raw_master_key); |
701 | ||
3e7807d5 JB |
702 | int fscrypt_setup_v1_file_key_via_subscribed_keyrings( |
703 | struct fscrypt_inode_info *ci); | |
0109ce76 | 704 | |
5dae460c EB |
705 | /* policy.c */ |
706 | ||
60700902 EB |
707 | bool fscrypt_policies_equal(const union fscrypt_policy *policy1, |
708 | const union fscrypt_policy *policy2); | |
bfb9700b EB |
709 | int fscrypt_policy_to_key_spec(const union fscrypt_policy *policy, |
710 | struct fscrypt_key_specifier *key_spec); | |
60e463f0 | 711 | const union fscrypt_policy *fscrypt_get_dummy_policy(struct super_block *sb); |
60700902 EB |
712 | bool fscrypt_supported_policy(const union fscrypt_policy *policy_u, |
713 | const struct inode *inode); | |
714 | int fscrypt_policy_from_context(union fscrypt_policy *policy_u, | |
715 | const union fscrypt_context *ctx_u, | |
716 | int ctx_size); | |
ac4acb1f | 717 | const union fscrypt_policy *fscrypt_policy_to_inherit(struct inode *dir); |
0109ce76 | 718 | |
3325bea5 | 719 | #endif /* _FSCRYPT_PRIVATE_H */ |