• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /*
2  * Copyright (c) 2022 Huawei Device Co., Ltd.
3  * Licensed under the Apache License, Version 2.0 (the "License");
4  * you may not use this file except in compliance with the License.
5  * You may obtain a copy of the License at
6  *
7  * http://www.apache.org/licenses/LICENSE-2.0
8  *
9  * Unless required by applicable law or agreed to in writing, software
10  * distributed under the License is distributed on an "AS IS" BASIS,
11  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12  * See the License for the specific language governing permissions and
13  * limitations under the License.
14  */
15 #ifndef STORAGE_DAEMON_CRYPTO_FSCRYPT_UAPI_H
16 #define STORAGE_DAEMON_CRYPTO_FSCRYPT_UAPI_H
17 
18 #include <linux/fs.h>
19 
20 // adapt to old kernel uapi defines
21 #define FSCRYPT_KEY_DESCRIPTOR_SIZE FS_KEY_DESCRIPTOR_SIZE
22 #define FSCRYPT_POLICY_FLAGS_PAD_4 FS_POLICY_FLAGS_PAD_4
23 #define FSCRYPT_POLICY_FLAGS_PAD_8 FS_POLICY_FLAGS_PAD_8
24 #define FSCRYPT_POLICY_FLAGS_PAD_16 FS_POLICY_FLAGS_PAD_16
25 #define FSCRYPT_POLICY_FLAGS_PAD_32 FS_POLICY_FLAGS_PAD_32
26 #define FSCRYPT_POLICY_FLAGS_PAD_MASK FS_POLICY_FLAGS_PAD_MASK
27 #define FSCRYPT_POLICY_FLAG_DIRECT_KEY FS_POLICY_FLAG_DIRECT_KEY
28 
29 #define FSCRYPT_MODE_AES_256_XTS FS_ENCRYPTION_MODE_AES_256_XTS
30 #define FSCRYPT_MODE_AES_256_CTS FS_ENCRYPTION_MODE_AES_256_CTS
31 #define FSCRYPT_MODE_AES_128_CBC FS_ENCRYPTION_MODE_AES_128_CBC
32 #define FSCRYPT_MODE_AES_128_CTS FS_ENCRYPTION_MODE_AES_128_CTS
33 #define FSCRYPT_MODE_ADIANTUM FS_ENCRYPTION_MODE_ADIANTUM
34 
35 #define FSCRYPT_KEY_DESC_PREFIX FS_KEY_DESC_PREFIX
36 #define FSCRYPT_KEY_DESC_PREFIX_SIZE FS_KEY_DESC_PREFIX_SIZE
37 #define FSCRYPT_MAX_KEY_SIZE FS_MAX_KEY_SIZE
38 
39 #define FS_IOC_GET_ENCRYPTION_POLICY_EX _IOWR('f', 22, __u8[9])
40 #define FS_IOC_ADD_ENCRYPTION_KEY _IOWR('f', 23, struct fscrypt_add_key_arg)
41 #define FS_IOC_REMOVE_ENCRYPTION_KEY _IOWR('f', 24, struct fscrypt_remove_key_arg)
42 #define FS_IOC_REMOVE_ENCRYPTION_KEY_ALL_USERS _IOWR('f', 25, struct fscrypt_remove_key_arg)
43 #define FS_IOC_GET_ENCRYPTION_KEY_STATUS _IOWR('f', 26, struct fscrypt_get_key_status_arg)
44 
45 #define FSCRYPT_POLICY_V1 0
46 #define fscrypt_policy_v1 fscrypt_policy
47 
48 #define FSCRYPT_POLICY_V2 2
49 #define FSCRYPT_KEY_IDENTIFIER_SIZE 16
50 struct fscrypt_policy_v2 {
51     __u8 version;
52     __u8 contents_encryption_mode;
53     __u8 filenames_encryption_mode;
54     __u8 flags;
55     __u8 __reserved[4];
56     __u8 master_key_identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
57 };
58 
59 struct fscrypt_get_policy_ex_arg {
60     __u64 policy_size;
61     union {
62         __u8 version;
63         struct fscrypt_policy_v1 v1;
64         struct fscrypt_policy_v2 v2;
65     } policy;
66 };
67 
68 struct fscrypt_key_specifier {
69 #define FSCRYPT_KEY_SPEC_TYPE_DESCRIPTOR 1
70 #define FSCRYPT_KEY_SPEC_TYPE_IDENTIFIER 2
71     __u32 type;
72     __u32 __reserved;
73     union {
74         __u8 __reserved[32];
75         __u8 descriptor[FSCRYPT_KEY_DESCRIPTOR_SIZE];
76         __u8 identifier[FSCRYPT_KEY_IDENTIFIER_SIZE];
77     } u;
78 };
79 
80 struct fscrypt_add_key_arg {
81     struct fscrypt_key_specifier key_spec;
82     __u32 raw_size;
83     __u32 __reserved[9];
84     __u8 raw[];
85 };
86 
87 struct fscrypt_remove_key_arg {
88     struct fscrypt_key_specifier key_spec;
89 #define FSCRYPT_KEY_REMOVAL_STATUS_FLAG_FILES_BUSY 0x00000001
90 #define FSCRYPT_KEY_REMOVAL_STATUS_FLAG_OTHER_USERS 0x00000002
91     __u32 removal_status_flags;
92     __u32 __reserved[5];
93 };
94 
95 struct fscrypt_get_key_status_arg {
96     struct fscrypt_key_specifier key_spec;
97     __u32 __reserved[6];
98 #define FSCRYPT_KEY_STATUS_ABSENT 1
99 #define FSCRYPT_KEY_STATUS_PRESENT 2
100 #define FSCRYPT_KEY_STATUS_INCOMPLETELY_REMOVED 3
101     __u32 status;
102 #define FSCRYPT_KEY_STATUS_FLAG_ADDED_BY_SELF 0x00000001
103     __u32 status_flags;
104     __u32 user_count;
105     __u32 __out_reserved[13];
106 };
107 
108 #endif // STORAGE_DAEMON_CRYPTO_FSCRYPT_UAPI_H