ecryptfs_kernel.h 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778
  1. /**
  2. * eCryptfs: Linux filesystem encryption layer
  3. * Kernel declarations.
  4. *
  5. * Copyright (C) 1997-2003 Erez Zadok
  6. * Copyright (C) 2001-2003 Stony Brook University
  7. * Copyright (C) 2004-2008 International Business Machines Corp.
  8. * Author(s): Michael A. Halcrow <mahalcro@us.ibm.com>
  9. * Trevor S. Highland <trevor.highland@gmail.com>
  10. * Tyler Hicks <tyhicks@ou.edu>
  11. *
  12. * This program is free software; you can redistribute it and/or
  13. * modify it under the terms of the GNU General Public License as
  14. * published by the Free Software Foundation; either version 2 of the
  15. * License, or (at your option) any later version.
  16. *
  17. * This program is distributed in the hope that it will be useful, but
  18. * WITHOUT ANY WARRANTY; without even the implied warranty of
  19. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
  20. * General Public License for more details.
  21. *
  22. * You should have received a copy of the GNU General Public License
  23. * along with this program; if not, write to the Free Software
  24. * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  25. * 02111-1307, USA.
  26. */
  27. #ifndef ECRYPTFS_KERNEL_H
  28. #define ECRYPTFS_KERNEL_H
  29. #include <keys/user-type.h>
  30. #if defined(CONFIG_ENCRYPTED_KEYS) || defined(CONFIG_ENCRYPTED_KEYS_MODULE)
  31. #include <keys/encrypted-type.h>
  32. #endif
  33. #include <linux/fs.h>
  34. #include <linux/fs_stack.h>
  35. #include <linux/namei.h>
  36. #include <linux/scatterlist.h>
  37. #include <linux/hash.h>
  38. #include <linux/nsproxy.h>
  39. #include <linux/backing-dev.h>
  40. #include <linux/ecryptfs.h>
  41. #ifdef CONFIG_WTL_ENCRYPTION_FILTER
  42. #define ENC_NAME_FILTER_MAX_INSTANCE 5
  43. #define ENC_NAME_FILTER_MAX_LEN (256*5)
  44. #define ENC_EXT_FILTER_MAX_INSTANCE 60
  45. #define ENC_EXT_FILTER_MAX_LEN 16
  46. #endif
  47. #define ECRYPTFS_DEFAULT_IV_BYTES 16
  48. #define ECRYPTFS_DEFAULT_EXTENT_SIZE 4096
  49. #define ECRYPTFS_MINIMUM_HEADER_EXTENT_SIZE 8192
  50. #define ECRYPTFS_DEFAULT_MSG_CTX_ELEMS 32
  51. #define ECRYPTFS_DEFAULT_SEND_TIMEOUT HZ
  52. #define ECRYPTFS_MAX_MSG_CTX_TTL (HZ*3)
  53. #define ECRYPTFS_DEFAULT_NUM_USERS 4
  54. #define ECRYPTFS_MAX_NUM_USERS 32768
  55. #define ECRYPTFS_XATTR_NAME "user.ecryptfs"
  56. void ecryptfs_dump_auth_tok(struct ecryptfs_auth_tok *auth_tok);
  57. extern void ecryptfs_to_hex(char *dst, char *src, size_t src_size);
  58. extern void ecryptfs_from_hex(char *dst, char *src, int dst_size);
  59. struct ecryptfs_key_record {
  60. unsigned char type;
  61. size_t enc_key_size;
  62. unsigned char sig[ECRYPTFS_SIG_SIZE];
  63. unsigned char enc_key[ECRYPTFS_MAX_ENCRYPTED_KEY_BYTES];
  64. };
  65. struct ecryptfs_auth_tok_list {
  66. struct ecryptfs_auth_tok *auth_tok;
  67. struct list_head list;
  68. };
  69. struct ecryptfs_crypt_stat;
  70. struct ecryptfs_mount_crypt_stat;
  71. struct ecryptfs_page_crypt_context {
  72. struct page *page;
  73. #define ECRYPTFS_PREPARE_COMMIT_MODE 0
  74. #define ECRYPTFS_WRITEPAGE_MODE 1
  75. unsigned int mode;
  76. union {
  77. struct file *lower_file;
  78. struct writeback_control *wbc;
  79. } param;
  80. };
  81. #if defined(CONFIG_ENCRYPTED_KEYS) || defined(CONFIG_ENCRYPTED_KEYS_MODULE)
  82. static inline struct ecryptfs_auth_tok *
  83. ecryptfs_get_encrypted_key_payload_data(struct key *key)
  84. {
  85. if (key->type == &key_type_encrypted)
  86. return (struct ecryptfs_auth_tok *)
  87. (&((struct encrypted_key_payload *)key->payload.data)->payload_data);
  88. else
  89. return NULL;
  90. }
  91. static inline struct key *ecryptfs_get_encrypted_key(char *sig)
  92. {
  93. return request_key(&key_type_encrypted, sig, NULL);
  94. }
  95. #else
  96. static inline struct ecryptfs_auth_tok *
  97. ecryptfs_get_encrypted_key_payload_data(struct key *key)
  98. {
  99. return NULL;
  100. }
  101. static inline struct key *ecryptfs_get_encrypted_key(char *sig)
  102. {
  103. return ERR_PTR(-ENOKEY);
  104. }
  105. #endif /* CONFIG_ENCRYPTED_KEYS */
  106. static inline struct ecryptfs_auth_tok *
  107. ecryptfs_get_key_payload_data(struct key *key)
  108. {
  109. struct ecryptfs_auth_tok *auth_tok;
  110. auth_tok = ecryptfs_get_encrypted_key_payload_data(key);
  111. if (!auth_tok)
  112. return (struct ecryptfs_auth_tok *)
  113. (((struct user_key_payload *)key->payload.data)->data);
  114. else
  115. return auth_tok;
  116. }
  117. #if defined(CONFIG_CRYPTO_FIPS) && !defined(CONFIG_FORCE_DISABLE_FIPS)
  118. #define ECRYPTFS_MAX_CIPHER_MODE_SIZE 3
  119. #define ECRYPTFS_AES_CBC_MODE "cbc"
  120. #define ECRYPTFS_AES_ECB_MODE "ecb"
  121. #endif
  122. #define ECRYPTFS_MAX_KEYSET_SIZE 1024
  123. #define ECRYPTFS_MAX_CIPHER_NAME_SIZE 32
  124. #define ECRYPTFS_MAX_NUM_ENC_KEYS 64
  125. #define ECRYPTFS_MAX_IV_BYTES 16 /* 128 bits */
  126. #define ECRYPTFS_SALT_BYTES 2
  127. #define MAGIC_ECRYPTFS_MARKER 0x3c81b7f5
  128. #define MAGIC_ECRYPTFS_MARKER_SIZE_BYTES 8 /* 4*2 */
  129. #define ECRYPTFS_FILE_SIZE_BYTES (sizeof(u64))
  130. #define ECRYPTFS_SIZE_AND_MARKER_BYTES (ECRYPTFS_FILE_SIZE_BYTES \
  131. + MAGIC_ECRYPTFS_MARKER_SIZE_BYTES)
  132. #define ECRYPTFS_DEFAULT_CIPHER "aes"
  133. #define ECRYPTFS_DEFAULT_KEY_BYTES 32
  134. #define ECRYPTFS_DEFAULT_HASH "md5"
  135. #define ECRYPTFS_SHA256_HASH "sha256"
  136. #define ECRYPTFS_TAG_70_DIGEST ECRYPTFS_DEFAULT_HASH
  137. #define ECRYPTFS_TAG_1_PACKET_TYPE 0x01
  138. #define ECRYPTFS_TAG_3_PACKET_TYPE 0x8C
  139. #define ECRYPTFS_DEK_PACKET_TYPE 0xD0 /* dek ecryptfs packet block */
  140. #define ECRYPTFS_TAG_11_PACKET_TYPE 0xED
  141. #define ECRYPTFS_TAG_64_PACKET_TYPE 0x40
  142. #define ECRYPTFS_TAG_65_PACKET_TYPE 0x41
  143. #define ECRYPTFS_TAG_66_PACKET_TYPE 0x42
  144. #define ECRYPTFS_TAG_67_PACKET_TYPE 0x43
  145. #define ECRYPTFS_TAG_70_PACKET_TYPE 0x46 /* FNEK-encrypted filename
  146. * as dentry name */
  147. #define ECRYPTFS_TAG_71_PACKET_TYPE 0x47 /* FNEK-encrypted filename in
  148. * metadata */
  149. #define ECRYPTFS_TAG_72_PACKET_TYPE 0x48 /* FEK-encrypted filename as
  150. * dentry name */
  151. #define ECRYPTFS_TAG_73_PACKET_TYPE 0x49 /* FEK-encrypted filename as
  152. * metadata */
  153. #define ECRYPTFS_MIN_PKT_LEN_SIZE 1 /* Min size to specify packet length */
  154. #define ECRYPTFS_MAX_PKT_LEN_SIZE 2 /* Pass at least this many bytes to
  155. * ecryptfs_parse_packet_length() and
  156. * ecryptfs_write_packet_length()
  157. */
  158. /* Constraint: ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES >=
  159. * ECRYPTFS_MAX_IV_BYTES */
  160. #define ECRYPTFS_FILENAME_MIN_RANDOM_PREPEND_BYTES 16
  161. #define ECRYPTFS_NON_NULL 0x42 /* A reasonable substitute for NULL */
  162. #define MD5_DIGEST_SIZE 16
  163. #define SHA256_HASH_SIZE 32
  164. #define ECRYPTFS_TAG_70_DIGEST_SIZE MD5_DIGEST_SIZE
  165. #define ECRYPTFS_TAG_70_MIN_METADATA_SIZE (1 + ECRYPTFS_MIN_PKT_LEN_SIZE \
  166. + ECRYPTFS_SIG_SIZE + 1 + 1)
  167. #define ECRYPTFS_TAG_70_MAX_METADATA_SIZE (1 + ECRYPTFS_MAX_PKT_LEN_SIZE \
  168. + ECRYPTFS_SIG_SIZE + 1 + 1)
  169. #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FEK_ENCRYPTED."
  170. #define ECRYPTFS_FEK_ENCRYPTED_FILENAME_PREFIX_SIZE 23
  171. //#define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "ECRYPTFS_FNEK_ENCRYPTED."
  172. //#define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 24
  173. #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX "EN."
  174. #define ECRYPTFS_FNEK_ENCRYPTED_FILENAME_PREFIX_SIZE 3
  175. #define ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN (18 + 1 + 4 + 1 + 32)
  176. struct ecryptfs_key_sig {
  177. struct list_head crypt_stat_list;
  178. char keysig[ECRYPTFS_SIG_SIZE_HEX + 1];
  179. };
  180. struct ecryptfs_filename {
  181. struct list_head crypt_stat_list;
  182. #define ECRYPTFS_FILENAME_CONTAINS_DECRYPTED 0x00000001
  183. u32 flags;
  184. u32 seq_no;
  185. char *filename;
  186. char *encrypted_filename;
  187. size_t filename_size;
  188. size_t encrypted_filename_size;
  189. char fnek_sig[ECRYPTFS_SIG_SIZE_HEX];
  190. char dentry_name[ECRYPTFS_ENCRYPTED_DENTRY_NAME_LEN + 1];
  191. };
  192. /**
  193. * This is the primary struct associated with each encrypted file.
  194. *
  195. * TODO: cache align/pack?
  196. */
  197. struct ecryptfs_crypt_stat {
  198. #define ECRYPTFS_STRUCT_INITIALIZED 0x00000001
  199. #define ECRYPTFS_POLICY_APPLIED 0x00000002
  200. #define ECRYPTFS_ENCRYPTED 0x00000004
  201. #define ECRYPTFS_SECURITY_WARNING 0x00000008
  202. #define ECRYPTFS_ENABLE_HMAC 0x00000010
  203. #define ECRYPTFS_ENCRYPT_IV_PAGES 0x00000020
  204. #define ECRYPTFS_KEY_VALID 0x00000040
  205. #define ECRYPTFS_METADATA_IN_XATTR 0x00000080
  206. #define ECRYPTFS_VIEW_AS_ENCRYPTED 0x00000100
  207. #define ECRYPTFS_KEY_SET 0x00000200
  208. #define ECRYPTFS_ENCRYPT_FILENAMES 0x00000400
  209. #define ECRYPTFS_ENCFN_USE_MOUNT_FNEK 0x00000800
  210. #define ECRYPTFS_ENCFN_USE_FEK 0x00001000
  211. #define ECRYPTFS_UNLINK_SIGS 0x00002000
  212. #define ECRYPTFS_I_SIZE_INITIALIZED 0x00004000
  213. #ifdef CONFIG_WTL_ENCRYPTION_FILTER
  214. #define ECRYPTFS_ENCRYPTED_OTHER_DEVICE 0x00008000
  215. #endif
  216. u32 flags;
  217. unsigned int file_version;
  218. size_t iv_bytes;
  219. size_t metadata_size;
  220. size_t extent_size; /* Data extent size; default is 4096 */
  221. size_t key_size;
  222. size_t extent_shift;
  223. unsigned int extent_mask;
  224. struct ecryptfs_mount_crypt_stat *mount_crypt_stat;
  225. struct crypto_blkcipher *tfm;
  226. struct crypto_hash *hash_tfm; /* Crypto context for generating
  227. * the initialization vectors */
  228. unsigned char cipher[ECRYPTFS_MAX_CIPHER_NAME_SIZE];
  229. unsigned char key[ECRYPTFS_MAX_KEY_BYTES];
  230. unsigned char root_iv[ECRYPTFS_MAX_IV_BYTES];
  231. struct list_head keysig_list;
  232. struct mutex keysig_list_mutex;
  233. struct mutex cs_tfm_mutex;
  234. struct mutex cs_hash_tfm_mutex;
  235. struct mutex cs_mutex;
  236. };
  237. /* inode private data. */
  238. struct ecryptfs_inode_info {
  239. struct inode vfs_inode;
  240. struct inode *wii_inode;
  241. struct mutex lower_file_mutex;
  242. atomic_t lower_file_count;
  243. struct file *lower_file;
  244. struct ecryptfs_crypt_stat crypt_stat;
  245. };
  246. /* dentry private data. Each dentry must keep track of a lower
  247. * vfsmount too. */
  248. struct ecryptfs_dentry_info {
  249. struct path lower_path;
  250. struct ecryptfs_crypt_stat *crypt_stat;
  251. };
  252. /**
  253. * ecryptfs_global_auth_tok - A key used to encrypt all new files under the mountpoint
  254. * @flags: Status flags
  255. * @mount_crypt_stat_list: These auth_toks hang off the mount-wide
  256. * cryptographic context. Every time a new
  257. * inode comes into existence, eCryptfs copies
  258. * the auth_toks on that list to the set of
  259. * auth_toks on the inode's crypt_stat
  260. * @global_auth_tok_key: The key from the user's keyring for the sig
  261. * @global_auth_tok: The key contents
  262. * @sig: The key identifier
  263. *
  264. * ecryptfs_global_auth_tok structs refer to authentication token keys
  265. * in the user keyring that apply to newly created files. A list of
  266. * these objects hangs off of the mount_crypt_stat struct for any
  267. * given eCryptfs mount. This struct maintains a reference to both the
  268. * key contents and the key itself so that the key can be put on
  269. * unmount.
  270. */
  271. struct ecryptfs_global_auth_tok {
  272. #define ECRYPTFS_AUTH_TOK_INVALID 0x00000001
  273. #define ECRYPTFS_AUTH_TOK_FNEK 0x00000002
  274. u32 flags;
  275. struct list_head mount_crypt_stat_list;
  276. struct key *global_auth_tok_key;
  277. unsigned char sig[ECRYPTFS_SIG_SIZE_HEX + 1];
  278. };
  279. /**
  280. * ecryptfs_key_tfm - Persistent key tfm
  281. * @key_tfm: crypto API handle to the key
  282. * @key_size: Key size in bytes
  283. * @key_tfm_mutex: Mutex to ensure only one operation in eCryptfs is
  284. * using the persistent TFM at any point in time
  285. * @key_tfm_list: Handle to hang this off the module-wide TFM list
  286. * @cipher_name: String name for the cipher for this TFM
  287. *
  288. * Typically, eCryptfs will use the same ciphers repeatedly throughout
  289. * the course of its operations. In order to avoid unnecessarily
  290. * destroying and initializing the same cipher repeatedly, eCryptfs
  291. * keeps a list of crypto API contexts around to use when needed.
  292. */
  293. struct ecryptfs_key_tfm {
  294. struct crypto_blkcipher *key_tfm;
  295. size_t key_size;
  296. struct mutex key_tfm_mutex;
  297. struct list_head key_tfm_list;
  298. unsigned char cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
  299. #if defined(CONFIG_CRYPTO_FIPS) && !defined(CONFIG_FORCE_DISABLE_FIPS)
  300. unsigned char cipher_mode[ECRYPTFS_MAX_CIPHER_MODE_SIZE + 1];
  301. #endif
  302. };
  303. extern struct mutex key_tfm_list_mutex;
  304. /**
  305. * This struct is to enable a mount-wide passphrase/salt combo. This
  306. * is more or less a stopgap to provide similar functionality to other
  307. * crypto filesystems like EncFS or CFS until full policy support is
  308. * implemented in eCryptfs.
  309. */
  310. struct ecryptfs_mount_crypt_stat {
  311. /* Pointers to memory we do not own, do not free these */
  312. #define ECRYPTFS_PLAINTEXT_PASSTHROUGH_ENABLED 0x00000001
  313. #define ECRYPTFS_XATTR_METADATA_ENABLED 0x00000002
  314. #define ECRYPTFS_ENCRYPTED_VIEW_ENABLED 0x00000004
  315. #define ECRYPTFS_MOUNT_CRYPT_STAT_INITIALIZED 0x00000008
  316. #define ECRYPTFS_GLOBAL_ENCRYPT_FILENAMES 0x00000010
  317. #define ECRYPTFS_GLOBAL_ENCFN_USE_MOUNT_FNEK 0x00000020
  318. #define ECRYPTFS_GLOBAL_ENCFN_USE_FEK 0x00000040
  319. #define ECRYPTFS_GLOBAL_MOUNT_AUTH_TOK_ONLY 0x00000080
  320. #ifdef CONFIG_WTL_ENCRYPTION_FILTER
  321. #define ECRYPTFS_ENABLE_FILTERING 0x00000100
  322. #define ECRYPTFS_ENABLE_NEW_PASSTHROUGH 0x00000200
  323. #endif
  324. #if defined(CONFIG_CRYPTO_FIPS) && !defined(CONFIG_FORCE_DISABLE_FIPS)
  325. #define ECRYPTFS_ENABLE_CC 0x00000400
  326. #endif
  327. u32 flags;
  328. struct list_head global_auth_tok_list;
  329. struct mutex global_auth_tok_list_mutex;
  330. size_t global_default_cipher_key_size;
  331. size_t global_default_fn_cipher_key_bytes;
  332. unsigned char global_default_cipher_name[ECRYPTFS_MAX_CIPHER_NAME_SIZE
  333. + 1];
  334. unsigned char global_default_fn_cipher_name[
  335. ECRYPTFS_MAX_CIPHER_NAME_SIZE + 1];
  336. char global_default_fnek_sig[ECRYPTFS_SIG_SIZE_HEX + 1];
  337. #ifdef CONFIG_WTL_ENCRYPTION_FILTER
  338. int max_name_filter_len;
  339. char enc_filter_name[ENC_NAME_FILTER_MAX_INSTANCE]
  340. [ENC_NAME_FILTER_MAX_LEN + 1];
  341. char enc_filter_ext[ENC_EXT_FILTER_MAX_INSTANCE]
  342. [ENC_EXT_FILTER_MAX_LEN + 1];
  343. #endif
  344. };
  345. /* superblock private data. */
  346. struct ecryptfs_sb_info {
  347. struct super_block *wsi_sb;
  348. struct ecryptfs_mount_crypt_stat mount_crypt_stat;
  349. struct backing_dev_info bdi;
  350. };
  351. /* file private data. */
  352. struct ecryptfs_file_info {
  353. struct file *wfi_file;
  354. struct ecryptfs_crypt_stat *crypt_stat;
  355. };
  356. /* auth_tok <=> encrypted_session_key mappings */
  357. struct ecryptfs_auth_tok_list_item {
  358. unsigned char encrypted_session_key[ECRYPTFS_MAX_KEY_BYTES];
  359. struct list_head list;
  360. struct ecryptfs_auth_tok auth_tok;
  361. };
  362. struct ecryptfs_message {
  363. /* Can never be greater than ecryptfs_message_buf_len */
  364. /* Used to find the parent msg_ctx */
  365. /* Inherits from msg_ctx->index */
  366. u32 index;
  367. u32 data_len;
  368. u8 data[];
  369. };
  370. struct ecryptfs_msg_ctx {
  371. #define ECRYPTFS_MSG_CTX_STATE_FREE 0x01
  372. #define ECRYPTFS_MSG_CTX_STATE_PENDING 0x02
  373. #define ECRYPTFS_MSG_CTX_STATE_DONE 0x03
  374. #define ECRYPTFS_MSG_CTX_STATE_NO_REPLY 0x04
  375. u8 state;
  376. #define ECRYPTFS_MSG_HELO 100
  377. #define ECRYPTFS_MSG_QUIT 101
  378. #define ECRYPTFS_MSG_REQUEST 102
  379. #define ECRYPTFS_MSG_RESPONSE 103
  380. u8 type;
  381. u32 index;
  382. /* Counter converts to a sequence number. Each message sent
  383. * out for which we expect a response has an associated
  384. * sequence number. The response must have the same sequence
  385. * number as the counter for the msg_stc for the message to be
  386. * valid. */
  387. u32 counter;
  388. size_t msg_size;
  389. struct ecryptfs_message *msg;
  390. struct task_struct *task;
  391. struct list_head node;
  392. struct list_head daemon_out_list;
  393. struct mutex mux;
  394. };
  395. struct ecryptfs_daemon;
  396. struct ecryptfs_daemon {
  397. #define ECRYPTFS_DAEMON_IN_READ 0x00000001
  398. #define ECRYPTFS_DAEMON_IN_POLL 0x00000002
  399. #define ECRYPTFS_DAEMON_ZOMBIE 0x00000004
  400. #define ECRYPTFS_DAEMON_MISCDEV_OPEN 0x00000008
  401. u32 flags;
  402. u32 num_queued_msg_ctx;
  403. struct pid *pid;
  404. uid_t euid;
  405. struct user_namespace *user_ns;
  406. struct task_struct *task;
  407. struct mutex mux;
  408. struct list_head msg_ctx_out_queue;
  409. wait_queue_head_t wait;
  410. struct hlist_node euid_chain;
  411. };
  412. extern struct mutex ecryptfs_daemon_hash_mux;
  413. static inline size_t
  414. ecryptfs_lower_header_size(struct ecryptfs_crypt_stat *crypt_stat)
  415. {
  416. if (crypt_stat->flags & ECRYPTFS_METADATA_IN_XATTR)
  417. return 0;
  418. return crypt_stat->metadata_size;
  419. }
  420. static inline struct ecryptfs_file_info *
  421. ecryptfs_file_to_private(struct file *file)
  422. {
  423. return file->private_data;
  424. }
  425. static inline void
  426. ecryptfs_set_file_private(struct file *file,
  427. struct ecryptfs_file_info *file_info)
  428. {
  429. file->private_data = file_info;
  430. }
  431. static inline struct file *ecryptfs_file_to_lower(struct file *file)
  432. {
  433. return ((struct ecryptfs_file_info *)file->private_data)->wfi_file;
  434. }
  435. static inline void
  436. ecryptfs_set_file_lower(struct file *file, struct file *lower_file)
  437. {
  438. ((struct ecryptfs_file_info *)file->private_data)->wfi_file =
  439. lower_file;
  440. }
  441. static inline struct ecryptfs_inode_info *
  442. ecryptfs_inode_to_private(struct inode *inode)
  443. {
  444. return container_of(inode, struct ecryptfs_inode_info, vfs_inode);
  445. }
  446. static inline struct inode *ecryptfs_inode_to_lower(struct inode *inode)
  447. {
  448. return ecryptfs_inode_to_private(inode)->wii_inode;
  449. }
  450. static inline void
  451. ecryptfs_set_inode_lower(struct inode *inode, struct inode *lower_inode)
  452. {
  453. ecryptfs_inode_to_private(inode)->wii_inode = lower_inode;
  454. }
  455. static inline struct ecryptfs_sb_info *
  456. ecryptfs_superblock_to_private(struct super_block *sb)
  457. {
  458. return (struct ecryptfs_sb_info *)sb->s_fs_info;
  459. }
  460. static inline void
  461. ecryptfs_set_superblock_private(struct super_block *sb,
  462. struct ecryptfs_sb_info *sb_info)
  463. {
  464. sb->s_fs_info = sb_info;
  465. }
  466. static inline struct super_block *
  467. ecryptfs_superblock_to_lower(struct super_block *sb)
  468. {
  469. return ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb;
  470. }
  471. static inline void
  472. ecryptfs_set_superblock_lower(struct super_block *sb,
  473. struct super_block *lower_sb)
  474. {
  475. ((struct ecryptfs_sb_info *)sb->s_fs_info)->wsi_sb = lower_sb;
  476. }
  477. static inline struct ecryptfs_dentry_info *
  478. ecryptfs_dentry_to_private(struct dentry *dentry)
  479. {
  480. return (struct ecryptfs_dentry_info *)dentry->d_fsdata;
  481. }
  482. static inline void
  483. ecryptfs_set_dentry_private(struct dentry *dentry,
  484. struct ecryptfs_dentry_info *dentry_info)
  485. {
  486. dentry->d_fsdata = dentry_info;
  487. }
  488. static inline struct dentry *
  489. ecryptfs_dentry_to_lower(struct dentry *dentry)
  490. {
  491. return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry;
  492. }
  493. static inline void
  494. ecryptfs_set_dentry_lower(struct dentry *dentry, struct dentry *lower_dentry)
  495. {
  496. ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.dentry =
  497. lower_dentry;
  498. }
  499. static inline struct vfsmount *
  500. ecryptfs_dentry_to_lower_mnt(struct dentry *dentry)
  501. {
  502. return ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt;
  503. }
  504. static inline void
  505. ecryptfs_set_dentry_lower_mnt(struct dentry *dentry, struct vfsmount *lower_mnt)
  506. {
  507. ((struct ecryptfs_dentry_info *)dentry->d_fsdata)->lower_path.mnt =
  508. lower_mnt;
  509. }
  510. #define ecryptfs_printk(type, fmt, arg...) \
  511. __ecryptfs_printk(type "%s: " fmt, __func__, ## arg);
  512. __printf(1, 2)
  513. void __ecryptfs_printk(const char *fmt, ...);
  514. extern const struct file_operations ecryptfs_main_fops;
  515. extern const struct file_operations ecryptfs_dir_fops;
  516. extern const struct inode_operations ecryptfs_main_iops;
  517. extern const struct inode_operations ecryptfs_dir_iops;
  518. extern const struct inode_operations ecryptfs_symlink_iops;
  519. extern const struct super_operations ecryptfs_sops;
  520. extern const struct dentry_operations ecryptfs_dops;
  521. extern const struct address_space_operations ecryptfs_aops;
  522. extern int ecryptfs_verbosity;
  523. extern unsigned int ecryptfs_message_buf_len;
  524. extern signed long ecryptfs_message_wait_timeout;
  525. extern unsigned int ecryptfs_number_of_users;
  526. extern struct kmem_cache *ecryptfs_auth_tok_list_item_cache;
  527. extern struct kmem_cache *ecryptfs_file_info_cache;
  528. extern struct kmem_cache *ecryptfs_dentry_info_cache;
  529. extern struct kmem_cache *ecryptfs_inode_info_cache;
  530. extern struct kmem_cache *ecryptfs_sb_info_cache;
  531. extern struct kmem_cache *ecryptfs_header_cache;
  532. extern struct kmem_cache *ecryptfs_xattr_cache;
  533. extern struct kmem_cache *ecryptfs_key_record_cache;
  534. extern struct kmem_cache *ecryptfs_key_sig_cache;
  535. extern struct kmem_cache *ecryptfs_global_auth_tok_cache;
  536. extern struct kmem_cache *ecryptfs_key_tfm_cache;
  537. extern struct kmem_cache *ecryptfs_open_req_cache;
  538. struct ecryptfs_open_req {
  539. #define ECRYPTFS_REQ_PROCESSED 0x00000001
  540. #define ECRYPTFS_REQ_DROPPED 0x00000002
  541. #define ECRYPTFS_REQ_ZOMBIE 0x00000004
  542. u32 flags;
  543. struct file **lower_file;
  544. struct dentry *lower_dentry;
  545. struct vfsmount *lower_mnt;
  546. wait_queue_head_t wait;
  547. struct mutex mux;
  548. struct list_head kthread_ctl_list;
  549. };
  550. struct inode *ecryptfs_get_inode(struct inode *lower_inode,
  551. struct super_block *sb);
  552. void ecryptfs_i_size_init(const char *page_virt, struct inode *inode);
  553. int ecryptfs_initialize_file(struct dentry *ecryptfs_dentry,
  554. struct inode *ecryptfs_inode);
  555. int ecryptfs_decode_and_decrypt_filename(char **decrypted_name,
  556. size_t *decrypted_name_size,
  557. struct dentry *ecryptfs_dentry,
  558. const char *name, size_t name_size);
  559. int ecryptfs_fill_zeros(struct file *file, loff_t new_length);
  560. int ecryptfs_encrypt_and_encode_filename(
  561. char **encoded_name,
  562. size_t *encoded_name_size,
  563. struct ecryptfs_crypt_stat *crypt_stat,
  564. struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
  565. const char *name, size_t name_size);
  566. struct dentry *ecryptfs_lower_dentry(struct dentry *this_dentry);
  567. void ecryptfs_dump_hex(char *data, int bytes);
  568. int virt_to_scatterlist(const void *addr, int size, struct scatterlist *sg,
  569. int sg_size);
  570. int ecryptfs_compute_root_iv(struct ecryptfs_crypt_stat *crypt_stat);
  571. void ecryptfs_rotate_iv(unsigned char *iv);
  572. void ecryptfs_init_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
  573. void ecryptfs_destroy_crypt_stat(struct ecryptfs_crypt_stat *crypt_stat);
  574. void ecryptfs_destroy_mount_crypt_stat(
  575. struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
  576. int ecryptfs_init_crypt_ctx(struct ecryptfs_crypt_stat *crypt_stat);
  577. int ecryptfs_write_inode_size_to_metadata(struct inode *ecryptfs_inode);
  578. int ecryptfs_encrypt_page(struct page *page);
  579. int ecryptfs_decrypt_page(struct page *page);
  580. int ecryptfs_write_metadata(struct dentry *ecryptfs_dentry,
  581. struct inode *ecryptfs_inode);
  582. int ecryptfs_read_metadata(struct dentry *ecryptfs_dentry);
  583. int ecryptfs_new_file_context(struct inode *ecryptfs_inode);
  584. void ecryptfs_write_crypt_stat_flags(char *page_virt,
  585. struct ecryptfs_crypt_stat *crypt_stat,
  586. size_t *written);
  587. int ecryptfs_read_and_validate_header_region(struct inode *inode);
  588. int ecryptfs_read_and_validate_xattr_region(struct dentry *dentry,
  589. struct inode *inode);
  590. u8 ecryptfs_code_for_cipher_string(char *cipher_name, size_t key_bytes);
  591. int ecryptfs_cipher_code_to_string(char *str, u8 cipher_code);
  592. void ecryptfs_set_default_sizes(struct ecryptfs_crypt_stat *crypt_stat);
  593. int ecryptfs_generate_key_packet_set(char *dest_base,
  594. struct ecryptfs_crypt_stat *crypt_stat,
  595. struct dentry *ecryptfs_dentry,
  596. size_t *len, size_t max);
  597. int
  598. ecryptfs_parse_packet_set(struct ecryptfs_crypt_stat *crypt_stat,
  599. unsigned char *src, struct dentry *ecryptfs_dentry);
  600. int ecryptfs_truncate(struct dentry *dentry, loff_t new_length);
  601. ssize_t
  602. ecryptfs_getxattr_lower(struct dentry *lower_dentry, const char *name,
  603. void *value, size_t size);
  604. int
  605. ecryptfs_setxattr(struct dentry *dentry, const char *name, const void *value,
  606. size_t size, int flags);
  607. int ecryptfs_read_xattr_region(char *page_virt, struct inode *ecryptfs_inode);
  608. int ecryptfs_process_helo(uid_t euid, struct user_namespace *user_ns,
  609. struct pid *pid);
  610. int ecryptfs_process_quit(uid_t euid, struct user_namespace *user_ns,
  611. struct pid *pid);
  612. int ecryptfs_process_response(struct ecryptfs_message *msg, uid_t euid,
  613. struct user_namespace *user_ns, struct pid *pid,
  614. u32 seq);
  615. int ecryptfs_send_message(char *data, int data_len,
  616. struct ecryptfs_msg_ctx **msg_ctx);
  617. int ecryptfs_wait_for_response(struct ecryptfs_msg_ctx *msg_ctx,
  618. struct ecryptfs_message **emsg);
  619. int ecryptfs_init_messaging(void);
  620. void ecryptfs_release_messaging(void);
  621. void
  622. ecryptfs_write_header_metadata(char *virt,
  623. struct ecryptfs_crypt_stat *crypt_stat,
  624. size_t *written);
  625. int ecryptfs_add_keysig(struct ecryptfs_crypt_stat *crypt_stat, char *sig);
  626. int
  627. ecryptfs_add_global_auth_tok(struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
  628. char *sig, u32 global_auth_tok_flags);
  629. int ecryptfs_get_global_auth_tok_for_sig(
  630. struct ecryptfs_global_auth_tok **global_auth_tok,
  631. struct ecryptfs_mount_crypt_stat *mount_crypt_stat, char *sig);
  632. #if defined(CONFIG_CRYPTO_FIPS) && !defined(CONFIG_FORCE_DISABLE_FIPS)
  633. int
  634. ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
  635. size_t key_size, u32 mount_flags);
  636. #else
  637. int
  638. ecryptfs_add_new_key_tfm(struct ecryptfs_key_tfm **key_tfm, char *cipher_name,
  639. size_t key_size);
  640. #endif
  641. int ecryptfs_init_crypto(void);
  642. int ecryptfs_destroy_crypto(void);
  643. #if defined(CONFIG_CRYPTO_FIPS) && !defined(CONFIG_FORCE_DISABLE_FIPS)
  644. int ecryptfs_tfm_exists(char *cipher_name, char *cipher_mode, struct ecryptfs_key_tfm **key_tfm);
  645. int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
  646. struct mutex **tfm_mutex,
  647. char *cipher_name,
  648. u32 mount_flags);
  649. #else
  650. int ecryptfs_tfm_exists(char *cipher_name, struct ecryptfs_key_tfm **key_tfm);
  651. int ecryptfs_get_tfm_and_mutex_for_cipher_name(struct crypto_blkcipher **tfm,
  652. struct mutex **tfm_mutex,
  653. char *cipher_name);
  654. #endif
  655. int ecryptfs_keyring_auth_tok_for_sig(struct key **auth_tok_key,
  656. struct ecryptfs_auth_tok **auth_tok,
  657. char *sig);
  658. int ecryptfs_write_lower(struct inode *ecryptfs_inode, char *data,
  659. loff_t offset, size_t size);
  660. int ecryptfs_write_lower_page_segment(struct inode *ecryptfs_inode,
  661. struct page *page_for_lower,
  662. size_t offset_in_page, size_t size);
  663. int ecryptfs_write(struct inode *inode, char *data, loff_t offset, size_t size);
  664. int ecryptfs_read_lower(char *data, loff_t offset, size_t size,
  665. struct inode *ecryptfs_inode);
  666. int ecryptfs_read_lower_page_segment(struct page *page_for_ecryptfs,
  667. pgoff_t page_index,
  668. size_t offset_in_page, size_t size,
  669. struct inode *ecryptfs_inode);
  670. struct page *ecryptfs_get_locked_page(struct inode *inode, loff_t index);
  671. int ecryptfs_exorcise_daemon(struct ecryptfs_daemon *daemon);
  672. int ecryptfs_find_daemon_by_euid(struct ecryptfs_daemon **daemon, uid_t euid,
  673. struct user_namespace *user_ns);
  674. int ecryptfs_parse_packet_length(unsigned char *data, size_t *size,
  675. size_t *length_size);
  676. int ecryptfs_write_packet_length(char *dest, size_t size,
  677. size_t *packet_size_length);
  678. int ecryptfs_init_ecryptfs_miscdev(void);
  679. void ecryptfs_destroy_ecryptfs_miscdev(void);
  680. int ecryptfs_send_miscdev(char *data, size_t data_size,
  681. struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
  682. u16 msg_flags, struct ecryptfs_daemon *daemon);
  683. void ecryptfs_msg_ctx_alloc_to_free(struct ecryptfs_msg_ctx *msg_ctx);
  684. int
  685. ecryptfs_spawn_daemon(struct ecryptfs_daemon **daemon, uid_t euid,
  686. struct user_namespace *user_ns, struct pid *pid);
  687. int ecryptfs_init_kthread(void);
  688. void ecryptfs_destroy_kthread(void);
  689. int ecryptfs_privileged_open(struct file **lower_file,
  690. struct dentry *lower_dentry,
  691. struct vfsmount *lower_mnt,
  692. const struct cred *cred);
  693. int ecryptfs_get_lower_file(struct dentry *dentry, struct inode *inode);
  694. void ecryptfs_put_lower_file(struct inode *inode);
  695. int
  696. ecryptfs_write_tag_70_packet(char *dest, size_t *remaining_bytes,
  697. size_t *packet_size,
  698. struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
  699. char *filename, size_t filename_size);
  700. int
  701. ecryptfs_parse_tag_70_packet(char **filename, size_t *filename_size,
  702. size_t *packet_size,
  703. struct ecryptfs_mount_crypt_stat *mount_crypt_stat,
  704. char *data, size_t max_packet_size);
  705. int ecryptfs_set_f_namelen(long *namelen, long lower_namelen,
  706. struct ecryptfs_mount_crypt_stat *mount_crypt_stat);
  707. int ecryptfs_derive_iv(char *iv, struct ecryptfs_crypt_stat *crypt_stat,
  708. loff_t offset);
  709. #ifdef CONFIG_WTL_ENCRYPTION_FILTER
  710. extern int is_file_name_match(struct ecryptfs_mount_crypt_stat *mcs,
  711. struct dentry *fp_dentry);
  712. extern int is_file_ext_match(struct ecryptfs_mount_crypt_stat *mcs,
  713. char *str);
  714. #endif
  715. #endif /* #ifndef ECRYPTFS_KERNEL_H */