ecryptfs_kernel.h 24 KB

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