1 /* audit.c -- Auditing support
2 * Gateway between the kernel (e.g., selinux) and the user-space audit daemon.
3 * System-call specific features have moved to auditsc.c
5 * Copyright 2003-2007 Red Hat Inc., Durham, North Carolina.
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * Written by Rickard E. (Rik) Faith <faith@redhat.com>
24 * Goals: 1) Integrate fully with Security Modules.
25 * 2) Minimal run-time overhead:
26 * a) Minimal when syscall auditing is disabled (audit_enable=0).
27 * b) Small when syscall auditing is enabled and no audit record
28 * is generated (defer as much work as possible to record
30 * i) context is allocated,
31 * ii) names from getname are stored without a copy, and
32 * iii) inode information stored from path_lookup.
33 * 3) Ability to disable syscall auditing at boot time (audit=0).
34 * 4) Usable by other parts of the kernel (if audit_log* is called,
35 * then a syscall record will be generated automatically for the
37 * 5) Netlink interface to user-space.
38 * 6) Support low-overhead kernel-based filtering to minimize the
39 * information that must be passed to user-space.
41 * Example user-space utilities: http://people.redhat.com/sgrubb/audit/
44 #include <linux/init.h>
45 #include <asm/types.h>
46 #include <linux/atomic.h>
48 #include <linux/export.h>
49 #include <linux/slab.h>
50 #include <linux/err.h>
51 #include <linux/kthread.h>
52 #include <linux/kernel.h>
53 #include <linux/syscalls.h>
55 #include <linux/audit.h>
58 #include <net/netlink.h>
59 #include <linux/skbuff.h>
60 #ifdef CONFIG_SECURITY
61 #include <linux/security.h>
63 #include <net/netlink.h>
64 #include <linux/freezer.h>
65 #include <linux/tty.h>
66 #include <linux/pid_namespace.h>
70 /* No auditing will take place until audit_initialized == AUDIT_INITIALIZED.
71 * (Initialization happens after skb_init is called.) */
72 #define AUDIT_DISABLED -1
73 #define AUDIT_UNINITIALIZED 0
74 #define AUDIT_INITIALIZED 1
75 static int audit_initialized;
79 #define AUDIT_LOCKED 2
81 int audit_ever_enabled;
83 EXPORT_SYMBOL_GPL(audit_enabled);
85 /* Default state when kernel boots without any parameters. */
86 static int audit_default;
88 /* If auditing cannot proceed, audit_failure selects what happens. */
89 static int audit_failure = AUDIT_FAIL_PRINTK;
92 * If audit records are to be written to the netlink socket, audit_pid
93 * contains the pid of the auditd process and audit_nlk_portid contains
94 * the portid to use to send netlink messages to that process.
97 static int audit_nlk_portid;
99 /* If audit_rate_limit is non-zero, limit the rate of sending audit records
100 * to that number per second. This prevents DoS attacks, but results in
101 * audit records being dropped. */
102 static int audit_rate_limit;
104 /* Number of outstanding audit_buffers allowed. */
105 static int audit_backlog_limit = 64;
106 #define AUDIT_BACKLOG_WAIT_TIME (60 * HZ)
107 static int audit_backlog_wait_time = AUDIT_BACKLOG_WAIT_TIME;
108 static int audit_backlog_wait_overflow = 0;
110 /* The identity of the user shutting down the audit system. */
111 kuid_t audit_sig_uid = INVALID_UID;
112 pid_t audit_sig_pid = -1;
113 u32 audit_sig_sid = 0;
115 /* Records can be lost in several ways:
116 0) [suppressed in audit_alloc]
117 1) out of memory in audit_log_start [kmalloc of struct audit_buffer]
118 2) out of memory in audit_log_move [alloc_skb]
119 3) suppressed due to audit_rate_limit
120 4) suppressed due to audit_backlog_limit
122 static atomic_t audit_lost = ATOMIC_INIT(0);
124 /* The netlink socket. */
125 static struct sock *audit_sock;
127 /* Hash for inode-based rules */
128 struct list_head audit_inode_hash[AUDIT_INODE_BUCKETS];
130 /* The audit_freelist is a list of pre-allocated audit buffers (if more
131 * than AUDIT_MAXFREE are in use, the audit buffer is freed instead of
132 * being placed on the freelist). */
133 static DEFINE_SPINLOCK(audit_freelist_lock);
134 static int audit_freelist_count;
135 static LIST_HEAD(audit_freelist);
137 static struct sk_buff_head audit_skb_queue;
138 /* queue of skbs to send to auditd when/if it comes back */
139 static struct sk_buff_head audit_skb_hold_queue;
140 static struct task_struct *kauditd_task;
141 static DECLARE_WAIT_QUEUE_HEAD(kauditd_wait);
142 static DECLARE_WAIT_QUEUE_HEAD(audit_backlog_wait);
144 /* Serialize requests from userspace. */
145 DEFINE_MUTEX(audit_cmd_mutex);
147 /* AUDIT_BUFSIZ is the size of the temporary buffer used for formatting
148 * audit records. Since printk uses a 1024 byte buffer, this buffer
149 * should be at least that large. */
150 #define AUDIT_BUFSIZ 1024
152 /* AUDIT_MAXFREE is the number of empty audit_buffers we keep on the
153 * audit_freelist. Doing so eliminates many kmalloc/kfree calls. */
154 #define AUDIT_MAXFREE (2*NR_CPUS)
156 /* The audit_buffer is used when formatting an audit record. The caller
157 * locks briefly to get the record off the freelist or to allocate the
158 * buffer, and locks briefly to send the buffer to the netlink layer or
159 * to place it on a transmit queue. Multiple audit_buffers can be in
160 * use simultaneously. */
161 struct audit_buffer {
162 struct list_head list;
163 struct sk_buff *skb; /* formatted skb ready to send */
164 struct audit_context *ctx; /* NULL or associated context */
173 static void audit_set_pid(struct audit_buffer *ab, pid_t pid)
176 struct nlmsghdr *nlh = nlmsg_hdr(ab->skb);
177 nlh->nlmsg_pid = pid;
181 void audit_panic(const char *message)
183 switch (audit_failure)
185 case AUDIT_FAIL_SILENT:
187 case AUDIT_FAIL_PRINTK:
188 if (printk_ratelimit())
189 printk(KERN_ERR "audit: %s\n", message);
191 case AUDIT_FAIL_PANIC:
192 /* test audit_pid since printk is always losey, why bother? */
194 panic("audit: %s\n", message);
199 static inline int audit_rate_check(void)
201 static unsigned long last_check = 0;
202 static int messages = 0;
203 static DEFINE_SPINLOCK(lock);
206 unsigned long elapsed;
209 if (!audit_rate_limit) return 1;
211 spin_lock_irqsave(&lock, flags);
212 if (++messages < audit_rate_limit) {
216 elapsed = now - last_check;
223 spin_unlock_irqrestore(&lock, flags);
229 * audit_log_lost - conditionally log lost audit message event
230 * @message: the message stating reason for lost audit message
232 * Emit at least 1 message per second, even if audit_rate_check is
234 * Always increment the lost messages counter.
236 void audit_log_lost(const char *message)
238 static unsigned long last_msg = 0;
239 static DEFINE_SPINLOCK(lock);
244 atomic_inc(&audit_lost);
246 print = (audit_failure == AUDIT_FAIL_PANIC || !audit_rate_limit);
249 spin_lock_irqsave(&lock, flags);
251 if (now - last_msg > HZ) {
255 spin_unlock_irqrestore(&lock, flags);
259 if (printk_ratelimit())
261 "audit: audit_lost=%d audit_rate_limit=%d "
262 "audit_backlog_limit=%d\n",
263 atomic_read(&audit_lost),
265 audit_backlog_limit);
266 audit_panic(message);
270 static int audit_log_config_change(char *function_name, int new, int old,
273 struct audit_buffer *ab;
276 ab = audit_log_start(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE);
279 audit_log_format(ab, "%s=%d old=%d", function_name, new, old);
280 audit_log_session_info(ab);
281 rc = audit_log_task_context(ab);
283 allow_changes = 0; /* Something weird, deny request */
284 audit_log_format(ab, " res=%d", allow_changes);
289 static int audit_do_config_change(char *function_name, int *to_change, int new)
291 int allow_changes, rc = 0, old = *to_change;
293 /* check if we are locked */
294 if (audit_enabled == AUDIT_LOCKED)
299 if (audit_enabled != AUDIT_OFF) {
300 rc = audit_log_config_change(function_name, new, old, allow_changes);
305 /* If we are allowed, make the change */
306 if (allow_changes == 1)
308 /* Not allowed, update reason */
314 static int audit_set_rate_limit(int limit)
316 return audit_do_config_change("audit_rate_limit", &audit_rate_limit, limit);
319 static int audit_set_backlog_limit(int limit)
321 return audit_do_config_change("audit_backlog_limit", &audit_backlog_limit, limit);
324 static int audit_set_enabled(int state)
327 if (state < AUDIT_OFF || state > AUDIT_LOCKED)
330 rc = audit_do_config_change("audit_enabled", &audit_enabled, state);
332 audit_ever_enabled |= !!state;
337 static int audit_set_failure(int state)
339 if (state != AUDIT_FAIL_SILENT
340 && state != AUDIT_FAIL_PRINTK
341 && state != AUDIT_FAIL_PANIC)
344 return audit_do_config_change("audit_failure", &audit_failure, state);
348 * Queue skbs to be sent to auditd when/if it comes back. These skbs should
349 * already have been sent via prink/syslog and so if these messages are dropped
350 * it is not a huge concern since we already passed the audit_log_lost()
351 * notification and stuff. This is just nice to get audit messages during
352 * boot before auditd is running or messages generated while auditd is stopped.
353 * This only holds messages is audit_default is set, aka booting with audit=1
354 * or building your kernel that way.
356 static void audit_hold_skb(struct sk_buff *skb)
359 skb_queue_len(&audit_skb_hold_queue) < audit_backlog_limit)
360 skb_queue_tail(&audit_skb_hold_queue, skb);
366 * For one reason or another this nlh isn't getting delivered to the userspace
367 * audit daemon, just send it to printk.
369 static void audit_printk_skb(struct sk_buff *skb)
371 struct nlmsghdr *nlh = nlmsg_hdr(skb);
372 char *data = nlmsg_data(nlh);
374 if (nlh->nlmsg_type != AUDIT_EOE) {
375 if (printk_ratelimit())
376 printk(KERN_NOTICE "type=%d %s\n", nlh->nlmsg_type, data);
378 audit_log_lost("printk limit exceeded\n");
384 static void kauditd_send_skb(struct sk_buff *skb)
387 /* take a reference in case we can't send it and we want to hold it */
389 err = netlink_unicast(audit_sock, skb, audit_nlk_portid, 0);
391 BUG_ON(err != -ECONNREFUSED); /* Shouldn't happen */
392 printk(KERN_ERR "audit: *NO* daemon at audit_pid=%d\n", audit_pid);
393 audit_log_lost("auditd disappeared\n");
395 /* we might get lucky and get this in the next auditd */
398 /* drop the extra reference if sent ok */
403 * flush_hold_queue - empty the hold queue if auditd appears
405 * If auditd just started, drain the queue of messages already
406 * sent to syslog/printk. Remember loss here is ok. We already
407 * called audit_log_lost() if it didn't go out normally. so the
408 * race between the skb_dequeue and the next check for audit_pid
411 * If you ever find kauditd to be too slow we can get a perf win
412 * by doing our own locking and keeping better track if there
413 * are messages in this queue. I don't see the need now, but
414 * in 5 years when I want to play with this again I'll see this
415 * note and still have no friggin idea what i'm thinking today.
417 static void flush_hold_queue(void)
421 if (!audit_default || !audit_pid)
424 skb = skb_dequeue(&audit_skb_hold_queue);
428 while (skb && audit_pid) {
429 kauditd_send_skb(skb);
430 skb = skb_dequeue(&audit_skb_hold_queue);
434 * if auditd just disappeared but we
435 * dequeued an skb we need to drop ref
441 static int kauditd_thread(void *dummy)
444 while (!kthread_should_stop()) {
446 DECLARE_WAITQUEUE(wait, current);
450 skb = skb_dequeue(&audit_skb_queue);
451 wake_up(&audit_backlog_wait);
454 kauditd_send_skb(skb);
456 audit_printk_skb(skb);
459 set_current_state(TASK_INTERRUPTIBLE);
460 add_wait_queue(&kauditd_wait, &wait);
462 if (!skb_queue_len(&audit_skb_queue)) {
467 __set_current_state(TASK_RUNNING);
468 remove_wait_queue(&kauditd_wait, &wait);
473 int audit_send_list(void *_dest)
475 struct audit_netlink_list *dest = _dest;
479 /* wait for parent to finish and send an ACK */
480 mutex_lock(&audit_cmd_mutex);
481 mutex_unlock(&audit_cmd_mutex);
483 while ((skb = __skb_dequeue(&dest->q)) != NULL)
484 netlink_unicast(audit_sock, skb, pid, 0);
491 struct sk_buff *audit_make_reply(int pid, int seq, int type, int done,
492 int multi, const void *payload, int size)
495 struct nlmsghdr *nlh;
497 int flags = multi ? NLM_F_MULTI : 0;
498 int t = done ? NLMSG_DONE : type;
500 skb = nlmsg_new(size, GFP_KERNEL);
504 nlh = nlmsg_put(skb, pid, seq, t, size, flags);
507 data = nlmsg_data(nlh);
508 memcpy(data, payload, size);
516 static int audit_send_reply_thread(void *arg)
518 struct audit_reply *reply = (struct audit_reply *)arg;
520 mutex_lock(&audit_cmd_mutex);
521 mutex_unlock(&audit_cmd_mutex);
523 /* Ignore failure. It'll only happen if the sender goes away,
524 because our timeout is set to infinite. */
525 netlink_unicast(audit_sock, reply->skb, reply->pid, 0);
530 * audit_send_reply - send an audit reply message via netlink
531 * @pid: process id to send reply to
532 * @seq: sequence number
533 * @type: audit message type
534 * @done: done (last) flag
535 * @multi: multi-part message flag
536 * @payload: payload data
537 * @size: payload size
539 * Allocates an skb, builds the netlink message, and sends it to the pid.
540 * No failure notifications.
542 static void audit_send_reply(int pid, int seq, int type, int done, int multi,
543 const void *payload, int size)
546 struct task_struct *tsk;
547 struct audit_reply *reply = kmalloc(sizeof(struct audit_reply),
553 skb = audit_make_reply(pid, seq, type, done, multi, payload, size);
560 tsk = kthread_run(audit_send_reply_thread, reply, "audit_send_reply");
569 * Check for appropriate CAP_AUDIT_ capabilities on incoming audit
572 static int audit_netlink_ok(struct sk_buff *skb, u16 msg_type)
576 /* Only support the initial namespaces for now. */
577 if ((current_user_ns() != &init_user_ns) ||
578 (task_active_pid_ns(current) != &init_pid_ns))
588 case AUDIT_LIST_RULES:
591 case AUDIT_SIGNAL_INFO:
595 case AUDIT_MAKE_EQUIV:
596 if (!netlink_capable(skb, CAP_AUDIT_CONTROL))
600 case AUDIT_FIRST_USER_MSG ... AUDIT_LAST_USER_MSG:
601 case AUDIT_FIRST_USER_MSG2 ... AUDIT_LAST_USER_MSG2:
602 if (!netlink_capable(skb, CAP_AUDIT_WRITE))
605 default: /* bad msg */
612 static int audit_log_common_recv_msg(struct audit_buffer **ab, u16 msg_type)
615 uid_t uid = from_kuid(&init_user_ns, current_uid());
617 if (!audit_enabled && msg_type != AUDIT_USER_AVC) {
622 *ab = audit_log_start(NULL, GFP_KERNEL, msg_type);
625 audit_log_format(*ab, "pid=%d uid=%u", task_tgid_vnr(current), uid);
626 audit_log_session_info(*ab);
627 audit_log_task_context(*ab);
632 static int audit_receive_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
636 struct audit_status *status_get, status_set;
638 struct audit_buffer *ab;
639 u16 msg_type = nlh->nlmsg_type;
640 struct audit_sig_info *sig_data;
644 err = audit_netlink_ok(skb, msg_type);
648 /* As soon as there's any sign of userspace auditd,
649 * start kauditd to talk to it */
651 kauditd_task = kthread_run(kauditd_thread, NULL, "kauditd");
652 if (IS_ERR(kauditd_task)) {
653 err = PTR_ERR(kauditd_task);
658 seq = nlh->nlmsg_seq;
659 data = nlmsg_data(nlh);
664 status_set.enabled = audit_enabled;
665 status_set.failure = audit_failure;
666 status_set.pid = audit_pid;
667 status_set.rate_limit = audit_rate_limit;
668 status_set.backlog_limit = audit_backlog_limit;
669 status_set.lost = atomic_read(&audit_lost);
670 status_set.backlog = skb_queue_len(&audit_skb_queue);
671 audit_send_reply(NETLINK_CB(skb).portid, seq, AUDIT_GET, 0, 0,
672 &status_set, sizeof(status_set));
675 if (nlmsg_len(nlh) < sizeof(struct audit_status))
677 status_get = (struct audit_status *)data;
678 if (status_get->mask & AUDIT_STATUS_ENABLED) {
679 err = audit_set_enabled(status_get->enabled);
683 if (status_get->mask & AUDIT_STATUS_FAILURE) {
684 err = audit_set_failure(status_get->failure);
688 if (status_get->mask & AUDIT_STATUS_PID) {
689 int new_pid = status_get->pid;
691 if (audit_enabled != AUDIT_OFF)
692 audit_log_config_change("audit_pid", new_pid, audit_pid, 1);
694 audit_nlk_portid = NETLINK_CB(skb).portid;
696 if (status_get->mask & AUDIT_STATUS_RATE_LIMIT) {
697 err = audit_set_rate_limit(status_get->rate_limit);
701 if (status_get->mask & AUDIT_STATUS_BACKLOG_LIMIT)
702 err = audit_set_backlog_limit(status_get->backlog_limit);
705 case AUDIT_FIRST_USER_MSG ... AUDIT_LAST_USER_MSG:
706 case AUDIT_FIRST_USER_MSG2 ... AUDIT_LAST_USER_MSG2:
707 if (!audit_enabled && msg_type != AUDIT_USER_AVC)
710 err = audit_filter_user(msg_type);
713 if (msg_type == AUDIT_USER_TTY) {
714 err = tty_audit_push_current();
718 audit_log_common_recv_msg(&ab, msg_type);
719 if (msg_type != AUDIT_USER_TTY)
720 audit_log_format(ab, " msg='%.1024s'",
725 audit_log_format(ab, " data=");
726 size = nlmsg_len(nlh);
728 ((unsigned char *)data)[size - 1] == '\0')
730 audit_log_n_untrustedstring(ab, data, size);
732 audit_set_pid(ab, NETLINK_CB(skb).portid);
738 if (nlmsg_len(nlh) < sizeof(struct audit_rule_data))
740 if (audit_enabled == AUDIT_LOCKED) {
741 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE);
742 audit_log_format(ab, " audit_enabled=%d res=0", audit_enabled);
747 case AUDIT_LIST_RULES:
748 err = audit_receive_filter(msg_type, NETLINK_CB(skb).portid,
749 seq, data, nlmsg_len(nlh));
753 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE);
754 audit_log_format(ab, " op=trim res=1");
757 case AUDIT_MAKE_EQUIV: {
760 size_t msglen = nlmsg_len(nlh);
764 if (msglen < 2 * sizeof(u32))
766 memcpy(sizes, bufp, 2 * sizeof(u32));
767 bufp += 2 * sizeof(u32);
768 msglen -= 2 * sizeof(u32);
769 old = audit_unpack_string(&bufp, &msglen, sizes[0]);
774 new = audit_unpack_string(&bufp, &msglen, sizes[1]);
780 /* OK, here comes... */
781 err = audit_tag_tree(old, new);
783 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE);
785 audit_log_format(ab, " op=make_equiv old=");
786 audit_log_untrustedstring(ab, old);
787 audit_log_format(ab, " new=");
788 audit_log_untrustedstring(ab, new);
789 audit_log_format(ab, " res=%d", !err);
795 case AUDIT_SIGNAL_INFO:
798 err = security_secid_to_secctx(audit_sig_sid, &ctx, &len);
802 sig_data = kmalloc(sizeof(*sig_data) + len, GFP_KERNEL);
805 security_release_secctx(ctx, len);
808 sig_data->uid = from_kuid(&init_user_ns, audit_sig_uid);
809 sig_data->pid = audit_sig_pid;
811 memcpy(sig_data->ctx, ctx, len);
812 security_release_secctx(ctx, len);
814 audit_send_reply(NETLINK_CB(skb).portid, seq, AUDIT_SIGNAL_INFO,
815 0, 0, sig_data, sizeof(*sig_data) + len);
818 case AUDIT_TTY_GET: {
819 struct audit_tty_status s;
820 struct task_struct *tsk = current;
822 spin_lock(&tsk->sighand->siglock);
823 s.enabled = tsk->signal->audit_tty != 0;
824 s.log_passwd = tsk->signal->audit_tty_log_passwd;
825 spin_unlock(&tsk->sighand->siglock);
827 audit_send_reply(NETLINK_CB(skb).portid, seq,
828 AUDIT_TTY_GET, 0, 0, &s, sizeof(s));
831 case AUDIT_TTY_SET: {
832 struct audit_tty_status s;
833 struct task_struct *tsk = current;
835 memset(&s, 0, sizeof(s));
836 /* guard against past and future API changes */
837 memcpy(&s, data, min_t(size_t, sizeof(s), nlmsg_len(nlh)));
838 if ((s.enabled != 0 && s.enabled != 1) ||
839 (s.log_passwd != 0 && s.log_passwd != 1))
842 spin_lock(&tsk->sighand->siglock);
843 tsk->signal->audit_tty = s.enabled;
844 tsk->signal->audit_tty_log_passwd = s.log_passwd;
845 spin_unlock(&tsk->sighand->siglock);
853 return err < 0 ? err : 0;
857 * Get message from skb. Each message is processed by audit_receive_msg.
858 * Malformed skbs with wrong length are discarded silently.
860 static void audit_receive_skb(struct sk_buff *skb)
862 struct nlmsghdr *nlh;
864 * len MUST be signed for nlmsg_next to be able to dec it below 0
865 * if the nlmsg_len was not aligned
870 nlh = nlmsg_hdr(skb);
873 while (nlmsg_ok(nlh, len)) {
874 err = audit_receive_msg(skb, nlh);
875 /* if err or if this message says it wants a response */
876 if (err || (nlh->nlmsg_flags & NLM_F_ACK))
877 netlink_ack(skb, nlh, err);
879 nlh = nlmsg_next(nlh, &len);
883 /* Receive messages from netlink socket. */
884 static void audit_receive(struct sk_buff *skb)
886 mutex_lock(&audit_cmd_mutex);
887 audit_receive_skb(skb);
888 mutex_unlock(&audit_cmd_mutex);
891 /* Initialize audit support at boot time. */
892 static int __init audit_init(void)
895 struct netlink_kernel_cfg cfg = {
896 .input = audit_receive,
899 if (audit_initialized == AUDIT_DISABLED)
902 printk(KERN_INFO "audit: initializing netlink socket (%s)\n",
903 audit_default ? "enabled" : "disabled");
904 audit_sock = netlink_kernel_create(&init_net, NETLINK_AUDIT, &cfg);
906 audit_panic("cannot initialize netlink socket");
908 audit_sock->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
910 skb_queue_head_init(&audit_skb_queue);
911 skb_queue_head_init(&audit_skb_hold_queue);
912 audit_initialized = AUDIT_INITIALIZED;
913 audit_enabled = audit_default;
914 audit_ever_enabled |= !!audit_default;
916 audit_log(NULL, GFP_KERNEL, AUDIT_KERNEL, "initialized");
918 for (i = 0; i < AUDIT_INODE_BUCKETS; i++)
919 INIT_LIST_HEAD(&audit_inode_hash[i]);
923 __initcall(audit_init);
925 /* Process kernel command-line parameter at boot time. audit=0 or audit=1. */
926 static int __init audit_enable(char *str)
928 audit_default = !!simple_strtol(str, NULL, 0);
930 audit_initialized = AUDIT_DISABLED;
932 printk(KERN_INFO "audit: %s", audit_default ? "enabled" : "disabled");
934 if (audit_initialized == AUDIT_INITIALIZED) {
935 audit_enabled = audit_default;
936 audit_ever_enabled |= !!audit_default;
937 } else if (audit_initialized == AUDIT_UNINITIALIZED) {
938 printk(" (after initialization)");
940 printk(" (until reboot)");
947 __setup("audit=", audit_enable);
949 static void audit_buffer_free(struct audit_buffer *ab)
959 spin_lock_irqsave(&audit_freelist_lock, flags);
960 if (audit_freelist_count > AUDIT_MAXFREE)
963 audit_freelist_count++;
964 list_add(&ab->list, &audit_freelist);
966 spin_unlock_irqrestore(&audit_freelist_lock, flags);
969 static struct audit_buffer * audit_buffer_alloc(struct audit_context *ctx,
970 gfp_t gfp_mask, int type)
973 struct audit_buffer *ab = NULL;
974 struct nlmsghdr *nlh;
976 spin_lock_irqsave(&audit_freelist_lock, flags);
977 if (!list_empty(&audit_freelist)) {
978 ab = list_entry(audit_freelist.next,
979 struct audit_buffer, list);
981 --audit_freelist_count;
983 spin_unlock_irqrestore(&audit_freelist_lock, flags);
986 ab = kmalloc(sizeof(*ab), gfp_mask);
992 ab->gfp_mask = gfp_mask;
994 ab->skb = nlmsg_new(AUDIT_BUFSIZ, gfp_mask);
998 nlh = nlmsg_put(ab->skb, 0, 0, type, 0, 0);
1008 audit_buffer_free(ab);
1013 * audit_serial - compute a serial number for the audit record
1015 * Compute a serial number for the audit record. Audit records are
1016 * written to user-space as soon as they are generated, so a complete
1017 * audit record may be written in several pieces. The timestamp of the
1018 * record and this serial number are used by the user-space tools to
1019 * determine which pieces belong to the same audit record. The
1020 * (timestamp,serial) tuple is unique for each syscall and is live from
1021 * syscall entry to syscall exit.
1023 * NOTE: Another possibility is to store the formatted records off the
1024 * audit context (for those records that have a context), and emit them
1025 * all at syscall exit. However, this could delay the reporting of
1026 * significant errors until syscall exit (or never, if the system
1029 unsigned int audit_serial(void)
1031 static DEFINE_SPINLOCK(serial_lock);
1032 static unsigned int serial = 0;
1034 unsigned long flags;
1037 spin_lock_irqsave(&serial_lock, flags);
1040 } while (unlikely(!ret));
1041 spin_unlock_irqrestore(&serial_lock, flags);
1046 static inline void audit_get_stamp(struct audit_context *ctx,
1047 struct timespec *t, unsigned int *serial)
1049 if (!ctx || !auditsc_get_stamp(ctx, t, serial)) {
1051 *serial = audit_serial();
1056 * Wait for auditd to drain the queue a little
1058 static void wait_for_auditd(unsigned long sleep_time)
1060 DECLARE_WAITQUEUE(wait, current);
1061 set_current_state(TASK_UNINTERRUPTIBLE);
1062 add_wait_queue(&audit_backlog_wait, &wait);
1064 if (audit_backlog_limit &&
1065 skb_queue_len(&audit_skb_queue) > audit_backlog_limit)
1066 schedule_timeout(sleep_time);
1068 __set_current_state(TASK_RUNNING);
1069 remove_wait_queue(&audit_backlog_wait, &wait);
1072 /* Obtain an audit buffer. This routine does locking to obtain the
1073 * audit buffer, but then no locking is required for calls to
1074 * audit_log_*format. If the tsk is a task that is currently in a
1075 * syscall, then the syscall is marked as auditable and an audit record
1076 * will be written at syscall exit. If there is no associated task, tsk
1077 * should be NULL. */
1080 * audit_log_start - obtain an audit buffer
1081 * @ctx: audit_context (may be NULL)
1082 * @gfp_mask: type of allocation
1083 * @type: audit message type
1085 * Returns audit_buffer pointer on success or NULL on error.
1087 * Obtain an audit buffer. This routine does locking to obtain the
1088 * audit buffer, but then no locking is required for calls to
1089 * audit_log_*format. If the task (ctx) is a task that is currently in a
1090 * syscall, then the syscall is marked as auditable and an audit record
1091 * will be written at syscall exit. If there is no associated task, then
1092 * task context (ctx) should be NULL.
1094 struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask,
1097 struct audit_buffer *ab = NULL;
1099 unsigned int uninitialized_var(serial);
1101 unsigned long timeout_start = jiffies;
1103 if (audit_initialized != AUDIT_INITIALIZED)
1106 if (unlikely(audit_filter_type(type)))
1109 if (gfp_mask & __GFP_WAIT)
1112 reserve = 5; /* Allow atomic callers to go up to five
1113 entries over the normal backlog limit */
1115 while (audit_backlog_limit
1116 && skb_queue_len(&audit_skb_queue) > audit_backlog_limit + reserve) {
1117 if (gfp_mask & __GFP_WAIT && audit_backlog_wait_time) {
1118 unsigned long sleep_time;
1120 sleep_time = timeout_start + audit_backlog_wait_time -
1122 if ((long)sleep_time > 0) {
1123 wait_for_auditd(sleep_time);
1127 if (audit_rate_check() && printk_ratelimit())
1129 "audit: audit_backlog=%d > "
1130 "audit_backlog_limit=%d\n",
1131 skb_queue_len(&audit_skb_queue),
1132 audit_backlog_limit);
1133 audit_log_lost("backlog limit exceeded");
1134 audit_backlog_wait_time = audit_backlog_wait_overflow;
1135 wake_up(&audit_backlog_wait);
1139 audit_backlog_wait_time = AUDIT_BACKLOG_WAIT_TIME;
1141 ab = audit_buffer_alloc(ctx, gfp_mask, type);
1143 audit_log_lost("out of memory in audit_log_start");
1147 audit_get_stamp(ab->ctx, &t, &serial);
1149 audit_log_format(ab, "audit(%lu.%03lu:%u): ",
1150 t.tv_sec, t.tv_nsec/1000000, serial);
1155 * audit_expand - expand skb in the audit buffer
1157 * @extra: space to add at tail of the skb
1159 * Returns 0 (no space) on failed expansion, or available space if
1162 static inline int audit_expand(struct audit_buffer *ab, int extra)
1164 struct sk_buff *skb = ab->skb;
1165 int oldtail = skb_tailroom(skb);
1166 int ret = pskb_expand_head(skb, 0, extra, ab->gfp_mask);
1167 int newtail = skb_tailroom(skb);
1170 audit_log_lost("out of memory in audit_expand");
1174 skb->truesize += newtail - oldtail;
1179 * Format an audit message into the audit buffer. If there isn't enough
1180 * room in the audit buffer, more room will be allocated and vsnprint
1181 * will be called a second time. Currently, we assume that a printk
1182 * can't format message larger than 1024 bytes, so we don't either.
1184 static void audit_log_vformat(struct audit_buffer *ab, const char *fmt,
1188 struct sk_buff *skb;
1196 avail = skb_tailroom(skb);
1198 avail = audit_expand(ab, AUDIT_BUFSIZ);
1202 va_copy(args2, args);
1203 len = vsnprintf(skb_tail_pointer(skb), avail, fmt, args);
1205 /* The printk buffer is 1024 bytes long, so if we get
1206 * here and AUDIT_BUFSIZ is at least 1024, then we can
1207 * log everything that printk could have logged. */
1208 avail = audit_expand(ab,
1209 max_t(unsigned, AUDIT_BUFSIZ, 1+len-avail));
1212 len = vsnprintf(skb_tail_pointer(skb), avail, fmt, args2);
1223 * audit_log_format - format a message into the audit buffer.
1225 * @fmt: format string
1226 * @...: optional parameters matching @fmt string
1228 * All the work is done in audit_log_vformat.
1230 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
1236 va_start(args, fmt);
1237 audit_log_vformat(ab, fmt, args);
1242 * audit_log_hex - convert a buffer to hex and append it to the audit skb
1243 * @ab: the audit_buffer
1244 * @buf: buffer to convert to hex
1245 * @len: length of @buf to be converted
1247 * No return value; failure to expand is silently ignored.
1249 * This function will take the passed buf and convert it into a string of
1250 * ascii hex digits. The new string is placed onto the skb.
1252 void audit_log_n_hex(struct audit_buffer *ab, const unsigned char *buf,
1255 int i, avail, new_len;
1257 struct sk_buff *skb;
1258 static const unsigned char *hex = "0123456789ABCDEF";
1265 avail = skb_tailroom(skb);
1267 if (new_len >= avail) {
1268 /* Round the buffer request up to the next multiple */
1269 new_len = AUDIT_BUFSIZ*(((new_len-avail)/AUDIT_BUFSIZ) + 1);
1270 avail = audit_expand(ab, new_len);
1275 ptr = skb_tail_pointer(skb);
1276 for (i=0; i<len; i++) {
1277 *ptr++ = hex[(buf[i] & 0xF0)>>4]; /* Upper nibble */
1278 *ptr++ = hex[buf[i] & 0x0F]; /* Lower nibble */
1281 skb_put(skb, len << 1); /* new string is twice the old string */
1285 * Format a string of no more than slen characters into the audit buffer,
1286 * enclosed in quote marks.
1288 void audit_log_n_string(struct audit_buffer *ab, const char *string,
1293 struct sk_buff *skb;
1300 avail = skb_tailroom(skb);
1301 new_len = slen + 3; /* enclosing quotes + null terminator */
1302 if (new_len > avail) {
1303 avail = audit_expand(ab, new_len);
1307 ptr = skb_tail_pointer(skb);
1309 memcpy(ptr, string, slen);
1313 skb_put(skb, slen + 2); /* don't include null terminator */
1317 * audit_string_contains_control - does a string need to be logged in hex
1318 * @string: string to be checked
1319 * @len: max length of the string to check
1321 int audit_string_contains_control(const char *string, size_t len)
1323 const unsigned char *p;
1324 for (p = string; p < (const unsigned char *)string + len; p++) {
1325 if (*p == '"' || *p < 0x21 || *p > 0x7e)
1332 * audit_log_n_untrustedstring - log a string that may contain random characters
1334 * @len: length of string (not including trailing null)
1335 * @string: string to be logged
1337 * This code will escape a string that is passed to it if the string
1338 * contains a control character, unprintable character, double quote mark,
1339 * or a space. Unescaped strings will start and end with a double quote mark.
1340 * Strings that are escaped are printed in hex (2 digits per char).
1342 * The caller specifies the number of characters in the string to log, which may
1343 * or may not be the entire string.
1345 void audit_log_n_untrustedstring(struct audit_buffer *ab, const char *string,
1348 if (audit_string_contains_control(string, len))
1349 audit_log_n_hex(ab, string, len);
1351 audit_log_n_string(ab, string, len);
1355 * audit_log_untrustedstring - log a string that may contain random characters
1357 * @string: string to be logged
1359 * Same as audit_log_n_untrustedstring(), except that strlen is used to
1360 * determine string length.
1362 void audit_log_untrustedstring(struct audit_buffer *ab, const char *string)
1364 audit_log_n_untrustedstring(ab, string, strlen(string));
1367 /* This is a helper-function to print the escaped d_path */
1368 void audit_log_d_path(struct audit_buffer *ab, const char *prefix,
1369 const struct path *path)
1374 audit_log_format(ab, "%s", prefix);
1376 /* We will allow 11 spaces for ' (deleted)' to be appended */
1377 pathname = kmalloc(PATH_MAX+11, ab->gfp_mask);
1379 audit_log_string(ab, "<no_memory>");
1382 p = d_path(path, pathname, PATH_MAX+11);
1383 if (IS_ERR(p)) { /* Should never happen since we send PATH_MAX */
1384 /* FIXME: can we save some information here? */
1385 audit_log_string(ab, "<too_long>");
1387 audit_log_untrustedstring(ab, p);
1391 void audit_log_session_info(struct audit_buffer *ab)
1393 u32 sessionid = audit_get_sessionid(current);
1394 uid_t auid = from_kuid(&init_user_ns, audit_get_loginuid(current));
1396 audit_log_format(ab, " auid=%u ses=%u\n", auid, sessionid);
1399 void audit_log_key(struct audit_buffer *ab, char *key)
1401 audit_log_format(ab, " key=");
1403 audit_log_untrustedstring(ab, key);
1405 audit_log_format(ab, "(null)");
1408 void audit_log_cap(struct audit_buffer *ab, char *prefix, kernel_cap_t *cap)
1412 audit_log_format(ab, " %s=", prefix);
1413 CAP_FOR_EACH_U32(i) {
1414 audit_log_format(ab, "%08x",
1415 cap->cap[CAP_LAST_U32 - i]);
1419 void audit_log_fcaps(struct audit_buffer *ab, struct audit_names *name)
1421 kernel_cap_t *perm = &name->fcap.permitted;
1422 kernel_cap_t *inh = &name->fcap.inheritable;
1425 if (!cap_isclear(*perm)) {
1426 audit_log_cap(ab, "cap_fp", perm);
1429 if (!cap_isclear(*inh)) {
1430 audit_log_cap(ab, "cap_fi", inh);
1435 audit_log_format(ab, " cap_fe=%d cap_fver=%x",
1436 name->fcap.fE, name->fcap_ver);
1439 static inline int audit_copy_fcaps(struct audit_names *name,
1440 const struct dentry *dentry)
1442 struct cpu_vfs_cap_data caps;
1448 rc = get_vfs_caps_from_disk(dentry, &caps);
1452 name->fcap.permitted = caps.permitted;
1453 name->fcap.inheritable = caps.inheritable;
1454 name->fcap.fE = !!(caps.magic_etc & VFS_CAP_FLAGS_EFFECTIVE);
1455 name->fcap_ver = (caps.magic_etc & VFS_CAP_REVISION_MASK) >>
1456 VFS_CAP_REVISION_SHIFT;
1461 /* Copy inode data into an audit_names. */
1462 void audit_copy_inode(struct audit_names *name, const struct dentry *dentry,
1463 const struct inode *inode)
1465 name->ino = inode->i_ino;
1466 name->dev = inode->i_sb->s_dev;
1467 name->mode = inode->i_mode;
1468 name->uid = inode->i_uid;
1469 name->gid = inode->i_gid;
1470 name->rdev = inode->i_rdev;
1471 security_inode_getsecid(inode, &name->osid);
1472 audit_copy_fcaps(name, dentry);
1476 * audit_log_name - produce AUDIT_PATH record from struct audit_names
1477 * @context: audit_context for the task
1478 * @n: audit_names structure with reportable details
1479 * @path: optional path to report instead of audit_names->name
1480 * @record_num: record number to report when handling a list of names
1481 * @call_panic: optional pointer to int that will be updated if secid fails
1483 void audit_log_name(struct audit_context *context, struct audit_names *n,
1484 struct path *path, int record_num, int *call_panic)
1486 struct audit_buffer *ab;
1487 ab = audit_log_start(context, GFP_KERNEL, AUDIT_PATH);
1491 audit_log_format(ab, "item=%d", record_num);
1494 audit_log_d_path(ab, " name=", path);
1496 switch (n->name_len) {
1497 case AUDIT_NAME_FULL:
1498 /* log the full path */
1499 audit_log_format(ab, " name=");
1500 audit_log_untrustedstring(ab, n->name->name);
1503 /* name was specified as a relative path and the
1504 * directory component is the cwd */
1505 audit_log_d_path(ab, " name=", &context->pwd);
1508 /* log the name's directory component */
1509 audit_log_format(ab, " name=");
1510 audit_log_n_untrustedstring(ab, n->name->name,
1514 audit_log_format(ab, " name=(null)");
1516 if (n->ino != (unsigned long)-1) {
1517 audit_log_format(ab, " inode=%lu"
1518 " dev=%02x:%02x mode=%#ho"
1519 " ouid=%u ogid=%u rdev=%02x:%02x",
1524 from_kuid(&init_user_ns, n->uid),
1525 from_kgid(&init_user_ns, n->gid),
1532 if (security_secid_to_secctx(
1533 n->osid, &ctx, &len)) {
1534 audit_log_format(ab, " osid=%u", n->osid);
1538 audit_log_format(ab, " obj=%s", ctx);
1539 security_release_secctx(ctx, len);
1543 /* log the audit_names record type */
1544 audit_log_format(ab, " nametype=");
1546 case AUDIT_TYPE_NORMAL:
1547 audit_log_format(ab, "NORMAL");
1549 case AUDIT_TYPE_PARENT:
1550 audit_log_format(ab, "PARENT");
1552 case AUDIT_TYPE_CHILD_DELETE:
1553 audit_log_format(ab, "DELETE");
1555 case AUDIT_TYPE_CHILD_CREATE:
1556 audit_log_format(ab, "CREATE");
1559 audit_log_format(ab, "UNKNOWN");
1563 audit_log_fcaps(ab, n);
1567 int audit_log_task_context(struct audit_buffer *ab)
1574 security_task_getsecid(current, &sid);
1578 error = security_secid_to_secctx(sid, &ctx, &len);
1580 if (error != -EINVAL)
1585 audit_log_format(ab, " subj=%s", ctx);
1586 security_release_secctx(ctx, len);
1590 audit_panic("error in audit_log_task_context");
1593 EXPORT_SYMBOL(audit_log_task_context);
1595 void audit_log_task_info(struct audit_buffer *ab, struct task_struct *tsk)
1597 const struct cred *cred;
1598 char name[sizeof(tsk->comm)];
1599 struct mm_struct *mm = tsk->mm;
1605 /* tsk == current */
1606 cred = current_cred();
1608 spin_lock_irq(&tsk->sighand->siglock);
1609 if (tsk->signal && tsk->signal->tty && tsk->signal->tty->name)
1610 tty = tsk->signal->tty->name;
1613 spin_unlock_irq(&tsk->sighand->siglock);
1615 audit_log_format(ab,
1616 " ppid=%ld pid=%d auid=%u uid=%u gid=%u"
1617 " euid=%u suid=%u fsuid=%u"
1618 " egid=%u sgid=%u fsgid=%u ses=%u tty=%s",
1621 from_kuid(&init_user_ns, audit_get_loginuid(tsk)),
1622 from_kuid(&init_user_ns, cred->uid),
1623 from_kgid(&init_user_ns, cred->gid),
1624 from_kuid(&init_user_ns, cred->euid),
1625 from_kuid(&init_user_ns, cred->suid),
1626 from_kuid(&init_user_ns, cred->fsuid),
1627 from_kgid(&init_user_ns, cred->egid),
1628 from_kgid(&init_user_ns, cred->sgid),
1629 from_kgid(&init_user_ns, cred->fsgid),
1630 audit_get_sessionid(tsk), tty);
1632 get_task_comm(name, tsk);
1633 audit_log_format(ab, " comm=");
1634 audit_log_untrustedstring(ab, name);
1637 down_read(&mm->mmap_sem);
1639 audit_log_d_path(ab, " exe=", &mm->exe_file->f_path);
1640 up_read(&mm->mmap_sem);
1642 audit_log_task_context(ab);
1644 EXPORT_SYMBOL(audit_log_task_info);
1647 * audit_log_link_denied - report a link restriction denial
1648 * @operation: specific link opreation
1649 * @link: the path that triggered the restriction
1651 void audit_log_link_denied(const char *operation, struct path *link)
1653 struct audit_buffer *ab;
1654 struct audit_names *name;
1656 name = kzalloc(sizeof(*name), GFP_NOFS);
1660 /* Generate AUDIT_ANOM_LINK with subject, operation, outcome. */
1661 ab = audit_log_start(current->audit_context, GFP_KERNEL,
1665 audit_log_format(ab, "op=%s", operation);
1666 audit_log_task_info(ab, current);
1667 audit_log_format(ab, " res=0");
1670 /* Generate AUDIT_PATH record with object. */
1671 name->type = AUDIT_TYPE_NORMAL;
1672 audit_copy_inode(name, link->dentry, link->dentry->d_inode);
1673 audit_log_name(current->audit_context, name, link, 0, NULL);
1679 * audit_log_end - end one audit record
1680 * @ab: the audit_buffer
1682 * The netlink_* functions cannot be called inside an irq context, so
1683 * the audit buffer is placed on a queue and a tasklet is scheduled to
1684 * remove them from the queue outside the irq context. May be called in
1687 void audit_log_end(struct audit_buffer *ab)
1691 if (!audit_rate_check()) {
1692 audit_log_lost("rate limit exceeded");
1694 struct nlmsghdr *nlh = nlmsg_hdr(ab->skb);
1695 nlh->nlmsg_len = ab->skb->len - NLMSG_HDRLEN;
1698 skb_queue_tail(&audit_skb_queue, ab->skb);
1699 wake_up_interruptible(&kauditd_wait);
1701 audit_printk_skb(ab->skb);
1705 audit_buffer_free(ab);
1709 * audit_log - Log an audit record
1710 * @ctx: audit context
1711 * @gfp_mask: type of allocation
1712 * @type: audit message type
1713 * @fmt: format string to use
1714 * @...: variable parameters matching the format string
1716 * This is a convenience function that calls audit_log_start,
1717 * audit_log_vformat, and audit_log_end. It may be called
1720 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
1721 const char *fmt, ...)
1723 struct audit_buffer *ab;
1726 ab = audit_log_start(ctx, gfp_mask, type);
1728 va_start(args, fmt);
1729 audit_log_vformat(ab, fmt, args);
1735 #ifdef CONFIG_SECURITY
1737 * audit_log_secctx - Converts and logs SELinux context
1739 * @secid: security number
1741 * This is a helper function that calls security_secid_to_secctx to convert
1742 * secid to secctx and then adds the (converted) SELinux context to the audit
1743 * log by calling audit_log_format, thus also preventing leak of internal secid
1744 * to userspace. If secid cannot be converted audit_panic is called.
1746 void audit_log_secctx(struct audit_buffer *ab, u32 secid)
1751 if (security_secid_to_secctx(secid, &secctx, &len)) {
1752 audit_panic("Cannot convert secid to context");
1754 audit_log_format(ab, " obj=%s", secctx);
1755 security_release_secctx(secctx, len);
1758 EXPORT_SYMBOL(audit_log_secctx);
1761 EXPORT_SYMBOL(audit_log_start);
1762 EXPORT_SYMBOL(audit_log_end);
1763 EXPORT_SYMBOL(audit_log_format);
1764 EXPORT_SYMBOL(audit_log);