ecryptfs_kernel.h 24 KB

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