2 * eCryptfs: Linux filesystem encryption layer
4 * Copyright (C) 2008 International Business Machines Corp.
5 * Author(s): Michael A. Halcrow <mhalcrow@us.ibm.com>
7 * This program is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU General Public License version
9 * 2 as published by the Free Software Foundation.
11 * This program is distributed in the hope that it will be useful, but
12 * WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
23 #include <linux/hash.h>
24 #include <linux/random.h>
25 #include <linux/miscdevice.h>
26 #include <linux/poll.h>
27 #include <linux/wait.h>
28 #include <linux/module.h>
29 #include "ecryptfs_kernel.h"
31 static atomic_t ecryptfs_num_miscdev_opens;
34 * ecryptfs_miscdev_poll
35 * @file: dev file (ignored)
36 * @pt: dev poll table (ignored)
38 * Returns the poll mask
41 ecryptfs_miscdev_poll(struct file *file, poll_table *pt)
43 struct ecryptfs_daemon *daemon;
44 unsigned int mask = 0;
47 mutex_lock(&ecryptfs_daemon_hash_mux);
48 /* TODO: Just use file->private_data? */
49 rc = ecryptfs_find_daemon_by_euid(&daemon, current->euid,
50 current->nsproxy->user_ns);
51 BUG_ON(rc || !daemon);
52 mutex_lock(&daemon->mux);
53 mutex_unlock(&ecryptfs_daemon_hash_mux);
54 if (daemon->flags & ECRYPTFS_DAEMON_ZOMBIE) {
55 printk(KERN_WARNING "%s: Attempt to poll on zombified "
56 "daemon\n", __func__);
57 goto out_unlock_daemon;
59 if (daemon->flags & ECRYPTFS_DAEMON_IN_READ)
60 goto out_unlock_daemon;
61 if (daemon->flags & ECRYPTFS_DAEMON_IN_POLL)
62 goto out_unlock_daemon;
63 daemon->flags |= ECRYPTFS_DAEMON_IN_POLL;
64 mutex_unlock(&daemon->mux);
65 poll_wait(file, &daemon->wait, pt);
66 mutex_lock(&daemon->mux);
67 if (!list_empty(&daemon->msg_ctx_out_queue))
68 mask |= POLLIN | POLLRDNORM;
70 daemon->flags &= ~ECRYPTFS_DAEMON_IN_POLL;
71 mutex_unlock(&daemon->mux);
76 * ecryptfs_miscdev_open
77 * @inode: inode of miscdev handle (ignored)
78 * @file: file for miscdev handle (ignored)
80 * Returns zero on success; non-zero otherwise
83 ecryptfs_miscdev_open(struct inode *inode, struct file *file)
85 struct ecryptfs_daemon *daemon = NULL;
88 mutex_lock(&ecryptfs_daemon_hash_mux);
89 rc = try_module_get(THIS_MODULE);
92 printk(KERN_ERR "%s: Error attempting to increment module use "
93 "count; rc = [%d]\n", __func__, rc);
94 goto out_unlock_daemon_list;
96 rc = ecryptfs_find_daemon_by_euid(&daemon, current->euid,
97 current->nsproxy->user_ns);
99 rc = ecryptfs_spawn_daemon(&daemon, current->euid,
100 current->nsproxy->user_ns,
103 printk(KERN_ERR "%s: Error attempting to spawn daemon; "
104 "rc = [%d]\n", __func__, rc);
105 goto out_module_put_unlock_daemon_list;
108 mutex_lock(&daemon->mux);
109 if (daemon->pid != task_pid(current)) {
111 printk(KERN_ERR "%s: pid [0x%p] has registered with euid [%d], "
112 "but pid [0x%p] has attempted to open the handle "
113 "instead\n", __func__, daemon->pid, daemon->euid,
115 goto out_unlock_daemon;
117 if (daemon->flags & ECRYPTFS_DAEMON_MISCDEV_OPEN) {
119 printk(KERN_ERR "%s: Miscellaneous device handle may only be "
120 "opened once per daemon; pid [0x%p] already has this "
121 "handle open\n", __func__, daemon->pid);
122 goto out_unlock_daemon;
124 daemon->flags |= ECRYPTFS_DAEMON_MISCDEV_OPEN;
125 atomic_inc(&ecryptfs_num_miscdev_opens);
127 mutex_unlock(&daemon->mux);
128 out_module_put_unlock_daemon_list:
130 module_put(THIS_MODULE);
131 out_unlock_daemon_list:
132 mutex_unlock(&ecryptfs_daemon_hash_mux);
137 * ecryptfs_miscdev_release
138 * @inode: inode of fs/ecryptfs/euid handle (ignored)
139 * @file: file for fs/ecryptfs/euid handle (ignored)
141 * This keeps the daemon registered until the daemon sends another
142 * ioctl to fs/ecryptfs/ctl or until the kernel module unregisters.
144 * Returns zero on success; non-zero otherwise
147 ecryptfs_miscdev_release(struct inode *inode, struct file *file)
149 struct ecryptfs_daemon *daemon = NULL;
152 mutex_lock(&ecryptfs_daemon_hash_mux);
153 rc = ecryptfs_find_daemon_by_euid(&daemon, current->euid,
154 current->nsproxy->user_ns);
155 BUG_ON(rc || !daemon);
156 mutex_lock(&daemon->mux);
157 BUG_ON(daemon->pid != task_pid(current));
158 BUG_ON(!(daemon->flags & ECRYPTFS_DAEMON_MISCDEV_OPEN));
159 daemon->flags &= ~ECRYPTFS_DAEMON_MISCDEV_OPEN;
160 atomic_dec(&ecryptfs_num_miscdev_opens);
161 mutex_unlock(&daemon->mux);
162 rc = ecryptfs_exorcise_daemon(daemon);
164 printk(KERN_CRIT "%s: Fatal error whilst attempting to "
165 "shut down daemon; rc = [%d]. Please report this "
166 "bug.\n", __func__, rc);
169 module_put(THIS_MODULE);
170 mutex_unlock(&ecryptfs_daemon_hash_mux);
175 * ecryptfs_send_miscdev
176 * @data: Data to send to daemon; may be NULL
177 * @data_size: Amount of data to send to daemon
178 * @msg_ctx: Message context, which is used to handle the reply. If
179 * this is NULL, then we do not expect a reply.
180 * @msg_type: Type of message
181 * @msg_flags: Flags for message
182 * @daemon: eCryptfs daemon object
184 * Add msg_ctx to queue and then, if it exists, notify the blocked
185 * miscdevess about the data being available. Must be called with
186 * ecryptfs_daemon_hash_mux held.
188 * Returns zero on success; non-zero otherwise
190 int ecryptfs_send_miscdev(char *data, size_t data_size,
191 struct ecryptfs_msg_ctx *msg_ctx, u8 msg_type,
192 u16 msg_flags, struct ecryptfs_daemon *daemon)
196 mutex_lock(&msg_ctx->mux);
198 msg_ctx->msg = kmalloc((sizeof(*msg_ctx->msg) + data_size),
202 printk(KERN_ERR "%s: Out of memory whilst attempting "
203 "to kmalloc(%Zd, GFP_KERNEL)\n", __func__,
204 (sizeof(*msg_ctx->msg) + data_size));
209 msg_ctx->msg->index = msg_ctx->index;
210 msg_ctx->msg->data_len = data_size;
211 msg_ctx->type = msg_type;
213 memcpy(msg_ctx->msg->data, data, data_size);
214 msg_ctx->msg_size = (sizeof(*msg_ctx->msg) + data_size);
216 msg_ctx->msg_size = 0;
217 mutex_lock(&daemon->mux);
218 list_add_tail(&msg_ctx->daemon_out_list, &daemon->msg_ctx_out_queue);
219 daemon->num_queued_msg_ctx++;
220 wake_up_interruptible(&daemon->wait);
221 mutex_unlock(&daemon->mux);
223 mutex_unlock(&msg_ctx->mux);
228 * ecryptfs_miscdev_read - format and send message from queue
229 * @file: fs/ecryptfs/euid miscdevfs handle (ignored)
230 * @buf: User buffer into which to copy the next message on the daemon queue
231 * @count: Amount of space available in @buf
232 * @ppos: Offset in file (ignored)
234 * Pulls the most recent message from the daemon queue, formats it for
235 * being sent via a miscdevfs handle, and copies it into @buf
237 * Returns the number of bytes copied into the user buffer
240 ecryptfs_miscdev_read(struct file *file, char __user *buf, size_t count,
243 struct ecryptfs_daemon *daemon;
244 struct ecryptfs_msg_ctx *msg_ctx;
245 size_t packet_length_size;
246 char packet_length[3];
251 mutex_lock(&ecryptfs_daemon_hash_mux);
252 /* TODO: Just use file->private_data? */
253 rc = ecryptfs_find_daemon_by_euid(&daemon, current->euid,
254 current->nsproxy->user_ns);
255 BUG_ON(rc || !daemon);
256 mutex_lock(&daemon->mux);
257 if (daemon->flags & ECRYPTFS_DAEMON_ZOMBIE) {
259 mutex_unlock(&ecryptfs_daemon_hash_mux);
260 printk(KERN_WARNING "%s: Attempt to read from zombified "
261 "daemon\n", __func__);
262 goto out_unlock_daemon;
264 if (daemon->flags & ECRYPTFS_DAEMON_IN_READ) {
266 mutex_unlock(&ecryptfs_daemon_hash_mux);
267 goto out_unlock_daemon;
269 /* This daemon will not go away so long as this flag is set */
270 daemon->flags |= ECRYPTFS_DAEMON_IN_READ;
271 mutex_unlock(&ecryptfs_daemon_hash_mux);
273 if (list_empty(&daemon->msg_ctx_out_queue)) {
274 mutex_unlock(&daemon->mux);
275 rc = wait_event_interruptible(
276 daemon->wait, !list_empty(&daemon->msg_ctx_out_queue));
277 mutex_lock(&daemon->mux);
280 goto out_unlock_daemon;
283 if (daemon->flags & ECRYPTFS_DAEMON_ZOMBIE) {
285 goto out_unlock_daemon;
287 if (list_empty(&daemon->msg_ctx_out_queue)) {
288 /* Something else jumped in since the
289 * wait_event_interruptable() and removed the
290 * message from the queue; try again */
293 BUG_ON(current->euid != daemon->euid);
294 BUG_ON(current->nsproxy->user_ns != daemon->user_ns);
295 BUG_ON(task_pid(current) != daemon->pid);
296 msg_ctx = list_first_entry(&daemon->msg_ctx_out_queue,
297 struct ecryptfs_msg_ctx, daemon_out_list);
299 mutex_lock(&msg_ctx->mux);
301 rc = ecryptfs_write_packet_length(packet_length,
303 &packet_length_size);
306 printk(KERN_WARNING "%s: Error writing packet length; "
307 "rc = [%d]\n", __func__, rc);
308 goto out_unlock_msg_ctx;
311 packet_length_size = 0;
312 msg_ctx->msg_size = 0;
314 /* miscdevfs packet format:
316 * Octets 1-4: network byte order msg_ctx->counter
317 * Octets 5-N0: Size of struct ecryptfs_message to follow
318 * Octets N0-N1: struct ecryptfs_message (including data)
320 * Octets 5-N1 not written if the packet type does not
321 * include a message */
322 total_length = (1 + 4 + packet_length_size + msg_ctx->msg_size);
323 if (count < total_length) {
325 printk(KERN_WARNING "%s: Only given user buffer of "
326 "size [%Zd], but we need [%Zd] to read the "
327 "pending message\n", __func__, count, total_length);
328 goto out_unlock_msg_ctx;
331 if (put_user(msg_ctx->type, buf))
332 goto out_unlock_msg_ctx;
333 if (put_user(cpu_to_be32(msg_ctx->counter), (__be32 __user *)(buf + 1)))
334 goto out_unlock_msg_ctx;
337 if (copy_to_user(&buf[i], packet_length, packet_length_size))
338 goto out_unlock_msg_ctx;
339 i += packet_length_size;
340 if (copy_to_user(&buf[i], msg_ctx->msg, msg_ctx->msg_size))
341 goto out_unlock_msg_ctx;
342 i += msg_ctx->msg_size;
345 list_del(&msg_ctx->daemon_out_list);
348 /* We do not expect a reply from the userspace daemon for any
349 * message type other than ECRYPTFS_MSG_REQUEST */
350 if (msg_ctx->type != ECRYPTFS_MSG_REQUEST)
351 ecryptfs_msg_ctx_alloc_to_free(msg_ctx);
353 mutex_unlock(&msg_ctx->mux);
355 daemon->flags &= ~ECRYPTFS_DAEMON_IN_READ;
356 mutex_unlock(&daemon->mux);
361 * ecryptfs_miscdev_helo
362 * @euid: effective user id of miscdevess sending helo packet
363 * @user_ns: The namespace in which @euid applies
364 * @pid: miscdevess id of miscdevess sending helo packet
366 * Returns zero on success; non-zero otherwise
368 static int ecryptfs_miscdev_helo(uid_t euid, struct user_namespace *user_ns,
373 rc = ecryptfs_process_helo(ECRYPTFS_TRANSPORT_MISCDEV, euid, user_ns,
376 printk(KERN_WARNING "Error processing HELO; rc = [%d]\n", rc);
381 * ecryptfs_miscdev_quit
382 * @euid: effective user id of miscdevess sending quit packet
383 * @user_ns: The namespace in which @euid applies
384 * @pid: miscdevess id of miscdevess sending quit packet
386 * Returns zero on success; non-zero otherwise
388 static int ecryptfs_miscdev_quit(uid_t euid, struct user_namespace *user_ns,
393 rc = ecryptfs_process_quit(euid, user_ns, pid);
396 "Error processing QUIT message; rc = [%d]\n", rc);
401 * ecryptfs_miscdev_response - miscdevess response to message previously sent to daemon
402 * @data: Bytes comprising struct ecryptfs_message
403 * @data_size: sizeof(struct ecryptfs_message) + data len
404 * @euid: Effective user id of miscdevess sending the miscdev response
405 * @user_ns: The namespace in which @euid applies
406 * @pid: Miscdevess id of miscdevess sending the miscdev response
407 * @seq: Sequence number for miscdev response packet
409 * Returns zero on success; non-zero otherwise
411 static int ecryptfs_miscdev_response(char *data, size_t data_size,
412 uid_t euid, struct user_namespace *user_ns,
413 struct pid *pid, u32 seq)
415 struct ecryptfs_message *msg = (struct ecryptfs_message *)data;
418 if ((sizeof(*msg) + msg->data_len) != data_size) {
419 printk(KERN_WARNING "%s: (sizeof(*msg) + msg->data_len) = "
420 "[%Zd]; data_size = [%Zd]. Invalid packet.\n", __func__,
421 (sizeof(*msg) + msg->data_len), data_size);
425 rc = ecryptfs_process_response(msg, euid, user_ns, pid, seq);
428 "Error processing response message; rc = [%d]\n", rc);
434 * ecryptfs_miscdev_write - handle write to daemon miscdev handle
435 * @file: File for misc dev handle (ignored)
436 * @buf: Buffer containing user data
437 * @count: Amount of data in @buf
438 * @ppos: Pointer to offset in file (ignored)
440 * miscdevfs packet format:
442 * Octets 1-4: network byte order msg_ctx->counter (0's for non-response)
443 * Octets 5-N0: Size of struct ecryptfs_message to follow
444 * Octets N0-N1: struct ecryptfs_message (including data)
446 * Returns the number of bytes read from @buf
449 ecryptfs_miscdev_write(struct file *file, const char __user *buf,
450 size_t count, loff_t *ppos)
454 size_t packet_size, packet_size_length, i;
461 data = kmalloc(count, GFP_KERNEL);
463 printk(KERN_ERR "%s: Out of memory whilst attempting to "
464 "kmalloc([%Zd], GFP_KERNEL)\n", __func__, count);
467 rc = copy_from_user(data, buf, count);
469 printk(KERN_ERR "%s: copy_from_user returned error [%d]\n",
476 case ECRYPTFS_MSG_RESPONSE:
477 if (count < (1 + 4 + 1 + sizeof(struct ecryptfs_message))) {
478 printk(KERN_WARNING "%s: Minimum acceptable packet "
479 "size is [%Zd], but amount of data written is "
480 "only [%Zd]. Discarding response packet.\n",
482 (1 + 4 + 1 + sizeof(struct ecryptfs_message)),
486 memcpy(&counter_nbo, &data[i], 4);
487 seq = be32_to_cpu(counter_nbo);
489 rc = ecryptfs_parse_packet_length(&data[i], &packet_size,
490 &packet_size_length);
492 printk(KERN_WARNING "%s: Error parsing packet length; "
493 "rc = [%d]\n", __func__, rc);
496 i += packet_size_length;
497 if ((1 + 4 + packet_size_length + packet_size) != count) {
498 printk(KERN_WARNING "%s: (1 + packet_size_length([%Zd])"
499 " + packet_size([%Zd]))([%Zd]) != "
500 "count([%Zd]). Invalid packet format.\n",
501 __func__, packet_size_length, packet_size,
502 (1 + packet_size_length + packet_size), count);
505 rc = ecryptfs_miscdev_response(&data[i], packet_size,
507 current->nsproxy->user_ns,
508 task_pid(current), seq);
510 printk(KERN_WARNING "%s: Failed to deliver miscdev "
511 "response to requesting operation; rc = [%d]\n",
514 case ECRYPTFS_MSG_HELO:
515 rc = ecryptfs_miscdev_helo(current->euid,
516 current->nsproxy->user_ns,
519 printk(KERN_ERR "%s: Error attempting to process "
520 "helo from pid [0x%p]; rc = [%d]\n", __func__,
521 task_pid(current), rc);
525 case ECRYPTFS_MSG_QUIT:
526 rc = ecryptfs_miscdev_quit(current->euid,
527 current->nsproxy->user_ns,
530 printk(KERN_ERR "%s: Error attempting to process "
531 "quit from pid [0x%p]; rc = [%d]\n", __func__,
532 task_pid(current), rc);
537 ecryptfs_printk(KERN_WARNING, "Dropping miscdev "
538 "message of unrecognized type [%d]\n",
549 static const struct file_operations ecryptfs_miscdev_fops = {
550 .open = ecryptfs_miscdev_open,
551 .poll = ecryptfs_miscdev_poll,
552 .read = ecryptfs_miscdev_read,
553 .write = ecryptfs_miscdev_write,
554 .release = ecryptfs_miscdev_release,
557 static struct miscdevice ecryptfs_miscdev = {
558 .minor = MISC_DYNAMIC_MINOR,
560 .fops = &ecryptfs_miscdev_fops
564 * ecryptfs_init_ecryptfs_miscdev
566 * Messages sent to the userspace daemon from the kernel are placed on
567 * a queue associated with the daemon. The next read against the
568 * miscdev handle by that daemon will return the oldest message placed
569 * on the message queue for the daemon.
571 * Returns zero on success; non-zero otherwise
573 int ecryptfs_init_ecryptfs_miscdev(void)
577 atomic_set(&ecryptfs_num_miscdev_opens, 0);
578 rc = misc_register(&ecryptfs_miscdev);
580 printk(KERN_ERR "%s: Failed to register miscellaneous device "
581 "for communications with userspace daemons; rc = [%d]\n",
587 * ecryptfs_destroy_ecryptfs_miscdev
589 * All of the daemons must be exorcised prior to calling this
592 void ecryptfs_destroy_ecryptfs_miscdev(void)
594 BUG_ON(atomic_read(&ecryptfs_num_miscdev_opens) != 0);
595 misc_deregister(&ecryptfs_miscdev);