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 SELinux.
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 <asm/atomic.h>
48 #include <linux/module.h>
49 #include <linux/err.h>
50 #include <linux/kthread.h>
52 #include <linux/audit.h>
55 #include <net/netlink.h>
56 #include <linux/skbuff.h>
57 #include <linux/netlink.h>
58 #include <linux/selinux.h>
59 #include <linux/inotify.h>
60 #include <linux/freezer.h>
61 #include <linux/tty.h>
65 /* No auditing will take place until audit_initialized != 0.
66 * (Initialization happens after skb_init is called.) */
67 static int audit_initialized;
71 #define AUDIT_LOCKED 2
73 int audit_ever_enabled;
75 /* Default state when kernel boots without any parameters. */
76 static int audit_default;
78 /* If auditing cannot proceed, audit_failure selects what happens. */
79 static int audit_failure = AUDIT_FAIL_PRINTK;
81 /* If audit records are to be written to the netlink socket, audit_pid
82 * contains the (non-zero) pid. */
85 /* If audit_rate_limit is non-zero, limit the rate of sending audit records
86 * to that number per second. This prevents DoS attacks, but results in
87 * audit records being dropped. */
88 static int audit_rate_limit;
90 /* Number of outstanding audit_buffers allowed. */
91 static int audit_backlog_limit = 64;
92 static int audit_backlog_wait_time = 60 * HZ;
93 static int audit_backlog_wait_overflow = 0;
95 /* The identity of the user shutting down the audit system. */
96 uid_t audit_sig_uid = -1;
97 pid_t audit_sig_pid = -1;
98 u32 audit_sig_sid = 0;
100 /* Records can be lost in several ways:
101 0) [suppressed in audit_alloc]
102 1) out of memory in audit_log_start [kmalloc of struct audit_buffer]
103 2) out of memory in audit_log_move [alloc_skb]
104 3) suppressed due to audit_rate_limit
105 4) suppressed due to audit_backlog_limit
107 static atomic_t audit_lost = ATOMIC_INIT(0);
109 /* The netlink socket. */
110 static struct sock *audit_sock;
112 /* Inotify handle. */
113 struct inotify_handle *audit_ih;
115 /* Hash for inode-based rules */
116 struct list_head audit_inode_hash[AUDIT_INODE_BUCKETS];
118 /* The audit_freelist is a list of pre-allocated audit buffers (if more
119 * than AUDIT_MAXFREE are in use, the audit buffer is freed instead of
120 * being placed on the freelist). */
121 static DEFINE_SPINLOCK(audit_freelist_lock);
122 static int audit_freelist_count;
123 static LIST_HEAD(audit_freelist);
125 static struct sk_buff_head audit_skb_queue;
126 static struct task_struct *kauditd_task;
127 static DECLARE_WAIT_QUEUE_HEAD(kauditd_wait);
128 static DECLARE_WAIT_QUEUE_HEAD(audit_backlog_wait);
130 /* Serialize requests from userspace. */
131 static DEFINE_MUTEX(audit_cmd_mutex);
133 /* AUDIT_BUFSIZ is the size of the temporary buffer used for formatting
134 * audit records. Since printk uses a 1024 byte buffer, this buffer
135 * should be at least that large. */
136 #define AUDIT_BUFSIZ 1024
138 /* AUDIT_MAXFREE is the number of empty audit_buffers we keep on the
139 * audit_freelist. Doing so eliminates many kmalloc/kfree calls. */
140 #define AUDIT_MAXFREE (2*NR_CPUS)
142 /* The audit_buffer is used when formatting an audit record. The caller
143 * locks briefly to get the record off the freelist or to allocate the
144 * buffer, and locks briefly to send the buffer to the netlink layer or
145 * to place it on a transmit queue. Multiple audit_buffers can be in
146 * use simultaneously. */
147 struct audit_buffer {
148 struct list_head list;
149 struct sk_buff *skb; /* formatted skb ready to send */
150 struct audit_context *ctx; /* NULL or associated context */
154 static void audit_set_pid(struct audit_buffer *ab, pid_t pid)
157 struct nlmsghdr *nlh = nlmsg_hdr(ab->skb);
158 nlh->nlmsg_pid = pid;
162 void audit_panic(const char *message)
164 switch (audit_failure)
166 case AUDIT_FAIL_SILENT:
168 case AUDIT_FAIL_PRINTK:
169 if (printk_ratelimit())
170 printk(KERN_ERR "audit: %s\n", message);
172 case AUDIT_FAIL_PANIC:
173 /* test audit_pid since printk is always losey, why bother? */
175 panic("audit: %s\n", message);
180 static inline int audit_rate_check(void)
182 static unsigned long last_check = 0;
183 static int messages = 0;
184 static DEFINE_SPINLOCK(lock);
187 unsigned long elapsed;
190 if (!audit_rate_limit) return 1;
192 spin_lock_irqsave(&lock, flags);
193 if (++messages < audit_rate_limit) {
197 elapsed = now - last_check;
204 spin_unlock_irqrestore(&lock, flags);
210 * audit_log_lost - conditionally log lost audit message event
211 * @message: the message stating reason for lost audit message
213 * Emit at least 1 message per second, even if audit_rate_check is
215 * Always increment the lost messages counter.
217 void audit_log_lost(const char *message)
219 static unsigned long last_msg = 0;
220 static DEFINE_SPINLOCK(lock);
225 atomic_inc(&audit_lost);
227 print = (audit_failure == AUDIT_FAIL_PANIC || !audit_rate_limit);
230 spin_lock_irqsave(&lock, flags);
232 if (now - last_msg > HZ) {
236 spin_unlock_irqrestore(&lock, flags);
240 if (printk_ratelimit())
242 "audit: audit_lost=%d audit_rate_limit=%d "
243 "audit_backlog_limit=%d\n",
244 atomic_read(&audit_lost),
246 audit_backlog_limit);
247 audit_panic(message);
251 static int audit_log_config_change(char *function_name, int new, int old,
252 uid_t loginuid, u32 sid, int allow_changes)
254 struct audit_buffer *ab;
257 ab = audit_log_start(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE);
258 audit_log_format(ab, "%s=%d old=%d by auid=%u", function_name, new,
264 rc = selinux_sid_to_string(sid, &ctx, &len);
266 audit_log_format(ab, " sid=%u", sid);
267 allow_changes = 0; /* Something weird, deny request */
269 audit_log_format(ab, " subj=%s", ctx);
273 audit_log_format(ab, " res=%d", allow_changes);
278 static int audit_do_config_change(char *function_name, int *to_change,
279 int new, uid_t loginuid, u32 sid)
281 int allow_changes, rc = 0, old = *to_change;
283 /* check if we are locked */
284 if (audit_enabled == AUDIT_LOCKED)
289 if (audit_enabled != AUDIT_OFF) {
290 rc = audit_log_config_change(function_name, new, old,
291 loginuid, sid, allow_changes);
296 /* If we are allowed, make the change */
297 if (allow_changes == 1)
299 /* Not allowed, update reason */
305 static int audit_set_rate_limit(int limit, uid_t loginuid, u32 sid)
307 return audit_do_config_change("audit_rate_limit", &audit_rate_limit,
308 limit, loginuid, sid);
311 static int audit_set_backlog_limit(int limit, uid_t loginuid, u32 sid)
313 return audit_do_config_change("audit_backlog_limit", &audit_backlog_limit,
314 limit, loginuid, sid);
317 static int audit_set_enabled(int state, uid_t loginuid, u32 sid)
320 if (state < AUDIT_OFF || state > AUDIT_LOCKED)
323 rc = audit_do_config_change("audit_enabled", &audit_enabled, state,
327 audit_ever_enabled |= !!state;
332 static int audit_set_failure(int state, uid_t loginuid, u32 sid)
334 if (state != AUDIT_FAIL_SILENT
335 && state != AUDIT_FAIL_PRINTK
336 && state != AUDIT_FAIL_PANIC)
339 return audit_do_config_change("audit_failure", &audit_failure, state,
343 static int kauditd_thread(void *dummy)
348 while (!kthread_should_stop()) {
349 skb = skb_dequeue(&audit_skb_queue);
350 wake_up(&audit_backlog_wait);
353 int err = netlink_unicast(audit_sock, skb, audit_pid, 0);
355 BUG_ON(err != -ECONNREFUSED); /* Shoudn't happen */
356 printk(KERN_ERR "audit: *NO* daemon at audit_pid=%d\n", audit_pid);
357 audit_log_lost("auditd dissapeared\n");
361 if (printk_ratelimit())
362 printk(KERN_NOTICE "%s\n", skb->data +
365 audit_log_lost("printk limit exceeded\n");
369 DECLARE_WAITQUEUE(wait, current);
370 set_current_state(TASK_INTERRUPTIBLE);
371 add_wait_queue(&kauditd_wait, &wait);
373 if (!skb_queue_len(&audit_skb_queue)) {
378 __set_current_state(TASK_RUNNING);
379 remove_wait_queue(&kauditd_wait, &wait);
385 static int audit_prepare_user_tty(pid_t pid, uid_t loginuid)
387 struct task_struct *tsk;
390 read_lock(&tasklist_lock);
391 tsk = find_task_by_pid(pid);
397 spin_lock_irq(&tsk->sighand->siglock);
398 if (!tsk->signal->audit_tty)
400 spin_unlock_irq(&tsk->sighand->siglock);
404 tty_audit_push_task(tsk, loginuid);
406 read_unlock(&tasklist_lock);
410 int audit_send_list(void *_dest)
412 struct audit_netlink_list *dest = _dest;
416 /* wait for parent to finish and send an ACK */
417 mutex_lock(&audit_cmd_mutex);
418 mutex_unlock(&audit_cmd_mutex);
420 while ((skb = __skb_dequeue(&dest->q)) != NULL)
421 netlink_unicast(audit_sock, skb, pid, 0);
428 #ifdef CONFIG_AUDIT_TREE
429 static int prune_tree_thread(void *unused)
431 mutex_lock(&audit_cmd_mutex);
433 mutex_unlock(&audit_cmd_mutex);
437 void audit_schedule_prune(void)
439 kthread_run(prune_tree_thread, NULL, "audit_prune_tree");
443 struct sk_buff *audit_make_reply(int pid, int seq, int type, int done,
444 int multi, void *payload, int size)
447 struct nlmsghdr *nlh;
448 int len = NLMSG_SPACE(size);
450 int flags = multi ? NLM_F_MULTI : 0;
451 int t = done ? NLMSG_DONE : type;
453 skb = alloc_skb(len, GFP_KERNEL);
457 nlh = NLMSG_PUT(skb, pid, seq, t, size);
458 nlh->nlmsg_flags = flags;
459 data = NLMSG_DATA(nlh);
460 memcpy(data, payload, size);
463 nlmsg_failure: /* Used by NLMSG_PUT */
470 * audit_send_reply - send an audit reply message via netlink
471 * @pid: process id to send reply to
472 * @seq: sequence number
473 * @type: audit message type
474 * @done: done (last) flag
475 * @multi: multi-part message flag
476 * @payload: payload data
477 * @size: payload size
479 * Allocates an skb, builds the netlink message, and sends it to the pid.
480 * No failure notifications.
482 void audit_send_reply(int pid, int seq, int type, int done, int multi,
483 void *payload, int size)
486 skb = audit_make_reply(pid, seq, type, done, multi, payload, size);
489 /* Ignore failure. It'll only happen if the sender goes away,
490 because our timeout is set to infinite. */
491 netlink_unicast(audit_sock, skb, pid, 0);
496 * Check for appropriate CAP_AUDIT_ capabilities on incoming audit
499 static int audit_netlink_ok(struct sk_buff *skb, u16 msg_type)
506 case AUDIT_LIST_RULES:
512 case AUDIT_SIGNAL_INFO:
516 case AUDIT_MAKE_EQUIV:
517 if (security_netlink_recv(skb, CAP_AUDIT_CONTROL))
521 case AUDIT_FIRST_USER_MSG ... AUDIT_LAST_USER_MSG:
522 case AUDIT_FIRST_USER_MSG2 ... AUDIT_LAST_USER_MSG2:
523 if (security_netlink_recv(skb, CAP_AUDIT_WRITE))
526 default: /* bad msg */
533 static int audit_log_common_recv_msg(struct audit_buffer **ab, u16 msg_type,
534 u32 pid, u32 uid, uid_t auid, u32 sid)
540 if (!audit_enabled) {
545 *ab = audit_log_start(NULL, GFP_KERNEL, msg_type);
546 audit_log_format(*ab, "user pid=%d uid=%u auid=%u",
549 rc = selinux_sid_to_string(sid, &ctx, &len);
551 audit_log_format(*ab, " ssid=%u", sid);
553 audit_log_format(*ab, " subj=%s", ctx);
560 static int audit_receive_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
562 u32 uid, pid, seq, sid;
564 struct audit_status *status_get, status_set;
566 struct audit_buffer *ab;
567 u16 msg_type = nlh->nlmsg_type;
568 uid_t loginuid; /* loginuid of sender */
569 struct audit_sig_info *sig_data;
573 err = audit_netlink_ok(skb, msg_type);
577 /* As soon as there's any sign of userspace auditd,
578 * start kauditd to talk to it */
580 kauditd_task = kthread_run(kauditd_thread, NULL, "kauditd");
581 if (IS_ERR(kauditd_task)) {
582 err = PTR_ERR(kauditd_task);
587 pid = NETLINK_CREDS(skb)->pid;
588 uid = NETLINK_CREDS(skb)->uid;
589 loginuid = NETLINK_CB(skb).loginuid;
590 sid = NETLINK_CB(skb).sid;
591 seq = nlh->nlmsg_seq;
592 data = NLMSG_DATA(nlh);
596 status_set.enabled = audit_enabled;
597 status_set.failure = audit_failure;
598 status_set.pid = audit_pid;
599 status_set.rate_limit = audit_rate_limit;
600 status_set.backlog_limit = audit_backlog_limit;
601 status_set.lost = atomic_read(&audit_lost);
602 status_set.backlog = skb_queue_len(&audit_skb_queue);
603 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_GET, 0, 0,
604 &status_set, sizeof(status_set));
607 if (nlh->nlmsg_len < sizeof(struct audit_status))
609 status_get = (struct audit_status *)data;
610 if (status_get->mask & AUDIT_STATUS_ENABLED) {
611 err = audit_set_enabled(status_get->enabled,
613 if (err < 0) return err;
615 if (status_get->mask & AUDIT_STATUS_FAILURE) {
616 err = audit_set_failure(status_get->failure,
618 if (err < 0) return err;
620 if (status_get->mask & AUDIT_STATUS_PID) {
621 int new_pid = status_get->pid;
623 if (audit_enabled != AUDIT_OFF)
624 audit_log_config_change("audit_pid", new_pid,
630 if (status_get->mask & AUDIT_STATUS_RATE_LIMIT)
631 err = audit_set_rate_limit(status_get->rate_limit,
633 if (status_get->mask & AUDIT_STATUS_BACKLOG_LIMIT)
634 err = audit_set_backlog_limit(status_get->backlog_limit,
638 case AUDIT_FIRST_USER_MSG ... AUDIT_LAST_USER_MSG:
639 case AUDIT_FIRST_USER_MSG2 ... AUDIT_LAST_USER_MSG2:
640 if (!audit_enabled && msg_type != AUDIT_USER_AVC)
643 err = audit_filter_user(&NETLINK_CB(skb), msg_type);
646 if (msg_type == AUDIT_USER_TTY) {
647 err = audit_prepare_user_tty(pid, loginuid);
651 audit_log_common_recv_msg(&ab, msg_type, pid, uid,
654 if (msg_type != AUDIT_USER_TTY)
655 audit_log_format(ab, " msg='%.1024s'",
660 audit_log_format(ab, " msg=");
661 size = nlmsg_len(nlh);
662 audit_log_n_untrustedstring(ab, size,
665 audit_set_pid(ab, pid);
671 if (nlmsg_len(nlh) < sizeof(struct audit_rule))
673 if (audit_enabled == AUDIT_LOCKED) {
674 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE, pid,
677 audit_log_format(ab, " audit_enabled=%d res=0",
684 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
685 uid, seq, data, nlmsg_len(nlh),
690 if (nlmsg_len(nlh) < sizeof(struct audit_rule_data))
692 if (audit_enabled == AUDIT_LOCKED) {
693 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE, pid,
696 audit_log_format(ab, " audit_enabled=%d res=0",
702 case AUDIT_LIST_RULES:
703 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
704 uid, seq, data, nlmsg_len(nlh),
710 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE, pid,
713 audit_log_format(ab, " op=trim res=1");
716 case AUDIT_MAKE_EQUIV: {
719 size_t len = nlmsg_len(nlh);
723 if (len < 2 * sizeof(u32))
725 memcpy(sizes, bufp, 2 * sizeof(u32));
726 bufp += 2 * sizeof(u32);
727 len -= 2 * sizeof(u32);
728 old = audit_unpack_string(&bufp, &len, sizes[0]);
733 new = audit_unpack_string(&bufp, &len, sizes[1]);
739 /* OK, here comes... */
740 err = audit_tag_tree(old, new);
742 audit_log_common_recv_msg(&ab, AUDIT_CONFIG_CHANGE, pid,
745 audit_log_format(ab, " op=make_equiv old=");
746 audit_log_untrustedstring(ab, old);
747 audit_log_format(ab, " new=");
748 audit_log_untrustedstring(ab, new);
749 audit_log_format(ab, " res=%d", !err);
755 case AUDIT_SIGNAL_INFO:
756 err = selinux_sid_to_string(audit_sig_sid, &ctx, &len);
759 sig_data = kmalloc(sizeof(*sig_data) + len, GFP_KERNEL);
764 sig_data->uid = audit_sig_uid;
765 sig_data->pid = audit_sig_pid;
766 memcpy(sig_data->ctx, ctx, len);
768 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_SIGNAL_INFO,
769 0, 0, sig_data, sizeof(*sig_data) + len);
772 case AUDIT_TTY_GET: {
773 struct audit_tty_status s;
774 struct task_struct *tsk;
776 read_lock(&tasklist_lock);
777 tsk = find_task_by_pid(pid);
781 spin_lock_irq(&tsk->sighand->siglock);
782 s.enabled = tsk->signal->audit_tty != 0;
783 spin_unlock_irq(&tsk->sighand->siglock);
785 read_unlock(&tasklist_lock);
786 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_TTY_GET, 0, 0,
790 case AUDIT_TTY_SET: {
791 struct audit_tty_status *s;
792 struct task_struct *tsk;
794 if (nlh->nlmsg_len < sizeof(struct audit_tty_status))
797 if (s->enabled != 0 && s->enabled != 1)
799 read_lock(&tasklist_lock);
800 tsk = find_task_by_pid(pid);
804 spin_lock_irq(&tsk->sighand->siglock);
805 tsk->signal->audit_tty = s->enabled != 0;
806 spin_unlock_irq(&tsk->sighand->siglock);
808 read_unlock(&tasklist_lock);
816 return err < 0 ? err : 0;
820 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
821 * processed by audit_receive_msg. Malformed skbs with wrong length are
822 * discarded silently.
824 static void audit_receive_skb(struct sk_buff *skb)
827 struct nlmsghdr *nlh;
830 while (skb->len >= NLMSG_SPACE(0)) {
831 nlh = nlmsg_hdr(skb);
832 if (nlh->nlmsg_len < sizeof(*nlh) || skb->len < nlh->nlmsg_len)
834 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
837 if ((err = audit_receive_msg(skb, nlh))) {
838 netlink_ack(skb, nlh, err);
839 } else if (nlh->nlmsg_flags & NLM_F_ACK)
840 netlink_ack(skb, nlh, 0);
845 /* Receive messages from netlink socket. */
846 static void audit_receive(struct sk_buff *skb)
848 mutex_lock(&audit_cmd_mutex);
849 audit_receive_skb(skb);
850 mutex_unlock(&audit_cmd_mutex);
853 #ifdef CONFIG_AUDITSYSCALL
854 static const struct inotify_operations audit_inotify_ops = {
855 .handle_event = audit_handle_ievent,
856 .destroy_watch = audit_free_parent,
860 /* Initialize audit support at boot time. */
861 static int __init audit_init(void)
865 printk(KERN_INFO "audit: initializing netlink socket (%s)\n",
866 audit_default ? "enabled" : "disabled");
867 audit_sock = netlink_kernel_create(&init_net, NETLINK_AUDIT, 0,
868 audit_receive, NULL, THIS_MODULE);
870 audit_panic("cannot initialize netlink socket");
872 audit_sock->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
874 skb_queue_head_init(&audit_skb_queue);
875 audit_initialized = 1;
876 audit_enabled = audit_default;
877 audit_ever_enabled |= !!audit_default;
879 /* Register the callback with selinux. This callback will be invoked
880 * when a new policy is loaded. */
881 selinux_audit_set_callback(&selinux_audit_rule_update);
883 audit_log(NULL, GFP_KERNEL, AUDIT_KERNEL, "initialized");
885 #ifdef CONFIG_AUDITSYSCALL
886 audit_ih = inotify_init(&audit_inotify_ops);
887 if (IS_ERR(audit_ih))
888 audit_panic("cannot initialize inotify handle");
891 for (i = 0; i < AUDIT_INODE_BUCKETS; i++)
892 INIT_LIST_HEAD(&audit_inode_hash[i]);
896 __initcall(audit_init);
898 /* Process kernel command-line parameter at boot time. audit=0 or audit=1. */
899 static int __init audit_enable(char *str)
901 audit_default = !!simple_strtol(str, NULL, 0);
902 printk(KERN_INFO "audit: %s%s\n",
903 audit_default ? "enabled" : "disabled",
904 audit_initialized ? "" : " (after initialization)");
905 if (audit_initialized) {
906 audit_enabled = audit_default;
907 audit_ever_enabled |= !!audit_default;
912 __setup("audit=", audit_enable);
914 static void audit_buffer_free(struct audit_buffer *ab)
924 spin_lock_irqsave(&audit_freelist_lock, flags);
925 if (audit_freelist_count > AUDIT_MAXFREE)
928 audit_freelist_count++;
929 list_add(&ab->list, &audit_freelist);
931 spin_unlock_irqrestore(&audit_freelist_lock, flags);
934 static struct audit_buffer * audit_buffer_alloc(struct audit_context *ctx,
935 gfp_t gfp_mask, int type)
938 struct audit_buffer *ab = NULL;
939 struct nlmsghdr *nlh;
941 spin_lock_irqsave(&audit_freelist_lock, flags);
942 if (!list_empty(&audit_freelist)) {
943 ab = list_entry(audit_freelist.next,
944 struct audit_buffer, list);
946 --audit_freelist_count;
948 spin_unlock_irqrestore(&audit_freelist_lock, flags);
951 ab = kmalloc(sizeof(*ab), gfp_mask);
956 ab->skb = alloc_skb(AUDIT_BUFSIZ, gfp_mask);
961 ab->gfp_mask = gfp_mask;
962 nlh = (struct nlmsghdr *)skb_put(ab->skb, NLMSG_SPACE(0));
963 nlh->nlmsg_type = type;
964 nlh->nlmsg_flags = 0;
969 audit_buffer_free(ab);
974 * audit_serial - compute a serial number for the audit record
976 * Compute a serial number for the audit record. Audit records are
977 * written to user-space as soon as they are generated, so a complete
978 * audit record may be written in several pieces. The timestamp of the
979 * record and this serial number are used by the user-space tools to
980 * determine which pieces belong to the same audit record. The
981 * (timestamp,serial) tuple is unique for each syscall and is live from
982 * syscall entry to syscall exit.
984 * NOTE: Another possibility is to store the formatted records off the
985 * audit context (for those records that have a context), and emit them
986 * all at syscall exit. However, this could delay the reporting of
987 * significant errors until syscall exit (or never, if the system
990 unsigned int audit_serial(void)
992 static DEFINE_SPINLOCK(serial_lock);
993 static unsigned int serial = 0;
998 spin_lock_irqsave(&serial_lock, flags);
1001 } while (unlikely(!ret));
1002 spin_unlock_irqrestore(&serial_lock, flags);
1007 static inline void audit_get_stamp(struct audit_context *ctx,
1008 struct timespec *t, unsigned int *serial)
1011 auditsc_get_stamp(ctx, t, serial);
1014 *serial = audit_serial();
1018 /* Obtain an audit buffer. This routine does locking to obtain the
1019 * audit buffer, but then no locking is required for calls to
1020 * audit_log_*format. If the tsk is a task that is currently in a
1021 * syscall, then the syscall is marked as auditable and an audit record
1022 * will be written at syscall exit. If there is no associated task, tsk
1023 * should be NULL. */
1026 * audit_log_start - obtain an audit buffer
1027 * @ctx: audit_context (may be NULL)
1028 * @gfp_mask: type of allocation
1029 * @type: audit message type
1031 * Returns audit_buffer pointer on success or NULL on error.
1033 * Obtain an audit buffer. This routine does locking to obtain the
1034 * audit buffer, but then no locking is required for calls to
1035 * audit_log_*format. If the task (ctx) is a task that is currently in a
1036 * syscall, then the syscall is marked as auditable and an audit record
1037 * will be written at syscall exit. If there is no associated task, then
1038 * task context (ctx) should be NULL.
1040 struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask,
1043 struct audit_buffer *ab = NULL;
1045 unsigned int uninitialized_var(serial);
1047 unsigned long timeout_start = jiffies;
1049 if (!audit_initialized)
1052 if (unlikely(audit_filter_type(type)))
1055 if (gfp_mask & __GFP_WAIT)
1058 reserve = 5; /* Allow atomic callers to go up to five
1059 entries over the normal backlog limit */
1061 while (audit_backlog_limit
1062 && skb_queue_len(&audit_skb_queue) > audit_backlog_limit + reserve) {
1063 if (gfp_mask & __GFP_WAIT && audit_backlog_wait_time
1064 && time_before(jiffies, timeout_start + audit_backlog_wait_time)) {
1066 /* Wait for auditd to drain the queue a little */
1067 DECLARE_WAITQUEUE(wait, current);
1068 set_current_state(TASK_INTERRUPTIBLE);
1069 add_wait_queue(&audit_backlog_wait, &wait);
1071 if (audit_backlog_limit &&
1072 skb_queue_len(&audit_skb_queue) > audit_backlog_limit)
1073 schedule_timeout(timeout_start + audit_backlog_wait_time - jiffies);
1075 __set_current_state(TASK_RUNNING);
1076 remove_wait_queue(&audit_backlog_wait, &wait);
1079 if (audit_rate_check() && printk_ratelimit())
1081 "audit: audit_backlog=%d > "
1082 "audit_backlog_limit=%d\n",
1083 skb_queue_len(&audit_skb_queue),
1084 audit_backlog_limit);
1085 audit_log_lost("backlog limit exceeded");
1086 audit_backlog_wait_time = audit_backlog_wait_overflow;
1087 wake_up(&audit_backlog_wait);
1091 ab = audit_buffer_alloc(ctx, gfp_mask, type);
1093 audit_log_lost("out of memory in audit_log_start");
1097 audit_get_stamp(ab->ctx, &t, &serial);
1099 audit_log_format(ab, "audit(%lu.%03lu:%u): ",
1100 t.tv_sec, t.tv_nsec/1000000, serial);
1105 * audit_expand - expand skb in the audit buffer
1107 * @extra: space to add at tail of the skb
1109 * Returns 0 (no space) on failed expansion, or available space if
1112 static inline int audit_expand(struct audit_buffer *ab, int extra)
1114 struct sk_buff *skb = ab->skb;
1115 int oldtail = skb_tailroom(skb);
1116 int ret = pskb_expand_head(skb, 0, extra, ab->gfp_mask);
1117 int newtail = skb_tailroom(skb);
1120 audit_log_lost("out of memory in audit_expand");
1124 skb->truesize += newtail - oldtail;
1129 * Format an audit message into the audit buffer. If there isn't enough
1130 * room in the audit buffer, more room will be allocated and vsnprint
1131 * will be called a second time. Currently, we assume that a printk
1132 * can't format message larger than 1024 bytes, so we don't either.
1134 static void audit_log_vformat(struct audit_buffer *ab, const char *fmt,
1138 struct sk_buff *skb;
1146 avail = skb_tailroom(skb);
1148 avail = audit_expand(ab, AUDIT_BUFSIZ);
1152 va_copy(args2, args);
1153 len = vsnprintf(skb_tail_pointer(skb), avail, fmt, args);
1155 /* The printk buffer is 1024 bytes long, so if we get
1156 * here and AUDIT_BUFSIZ is at least 1024, then we can
1157 * log everything that printk could have logged. */
1158 avail = audit_expand(ab,
1159 max_t(unsigned, AUDIT_BUFSIZ, 1+len-avail));
1162 len = vsnprintf(skb_tail_pointer(skb), avail, fmt, args2);
1172 * audit_log_format - format a message into the audit buffer.
1174 * @fmt: format string
1175 * @...: optional parameters matching @fmt string
1177 * All the work is done in audit_log_vformat.
1179 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
1185 va_start(args, fmt);
1186 audit_log_vformat(ab, fmt, args);
1191 * audit_log_hex - convert a buffer to hex and append it to the audit skb
1192 * @ab: the audit_buffer
1193 * @buf: buffer to convert to hex
1194 * @len: length of @buf to be converted
1196 * No return value; failure to expand is silently ignored.
1198 * This function will take the passed buf and convert it into a string of
1199 * ascii hex digits. The new string is placed onto the skb.
1201 void audit_log_hex(struct audit_buffer *ab, const unsigned char *buf,
1204 int i, avail, new_len;
1206 struct sk_buff *skb;
1207 static const unsigned char *hex = "0123456789ABCDEF";
1214 avail = skb_tailroom(skb);
1216 if (new_len >= avail) {
1217 /* Round the buffer request up to the next multiple */
1218 new_len = AUDIT_BUFSIZ*(((new_len-avail)/AUDIT_BUFSIZ) + 1);
1219 avail = audit_expand(ab, new_len);
1224 ptr = skb_tail_pointer(skb);
1225 for (i=0; i<len; i++) {
1226 *ptr++ = hex[(buf[i] & 0xF0)>>4]; /* Upper nibble */
1227 *ptr++ = hex[buf[i] & 0x0F]; /* Lower nibble */
1230 skb_put(skb, len << 1); /* new string is twice the old string */
1234 * Format a string of no more than slen characters into the audit buffer,
1235 * enclosed in quote marks.
1237 static void audit_log_n_string(struct audit_buffer *ab, size_t slen,
1242 struct sk_buff *skb;
1249 avail = skb_tailroom(skb);
1250 new_len = slen + 3; /* enclosing quotes + null terminator */
1251 if (new_len > avail) {
1252 avail = audit_expand(ab, new_len);
1256 ptr = skb_tail_pointer(skb);
1258 memcpy(ptr, string, slen);
1262 skb_put(skb, slen + 2); /* don't include null terminator */
1266 * audit_string_contains_control - does a string need to be logged in hex
1267 * @string - string to be checked
1268 * @len - max length of the string to check
1270 int audit_string_contains_control(const char *string, size_t len)
1272 const unsigned char *p;
1273 for (p = string; p < (const unsigned char *)string + len && *p; p++) {
1274 if (*p == '"' || *p < 0x21 || *p > 0x7f)
1281 * audit_log_n_untrustedstring - log a string that may contain random characters
1283 * @len: lenth of string (not including trailing null)
1284 * @string: string to be logged
1286 * This code will escape a string that is passed to it if the string
1287 * contains a control character, unprintable character, double quote mark,
1288 * or a space. Unescaped strings will start and end with a double quote mark.
1289 * Strings that are escaped are printed in hex (2 digits per char).
1291 * The caller specifies the number of characters in the string to log, which may
1292 * or may not be the entire string.
1294 void audit_log_n_untrustedstring(struct audit_buffer *ab, size_t len,
1297 if (audit_string_contains_control(string, len))
1298 audit_log_hex(ab, string, len);
1300 audit_log_n_string(ab, len, string);
1304 * audit_log_untrustedstring - log a string that may contain random characters
1306 * @string: string to be logged
1308 * Same as audit_log_n_untrustedstring(), except that strlen is used to
1309 * determine string length.
1311 void audit_log_untrustedstring(struct audit_buffer *ab, const char *string)
1313 audit_log_n_untrustedstring(ab, strlen(string), string);
1316 /* This is a helper-function to print the escaped d_path */
1317 void audit_log_d_path(struct audit_buffer *ab, const char *prefix,
1323 audit_log_format(ab, " %s", prefix);
1325 /* We will allow 11 spaces for ' (deleted)' to be appended */
1326 pathname = kmalloc(PATH_MAX+11, ab->gfp_mask);
1328 audit_log_format(ab, "<no memory>");
1331 p = d_path(path, pathname, PATH_MAX+11);
1332 if (IS_ERR(p)) { /* Should never happen since we send PATH_MAX */
1333 /* FIXME: can we save some information here? */
1334 audit_log_format(ab, "<too long>");
1336 audit_log_untrustedstring(ab, p);
1341 * audit_log_end - end one audit record
1342 * @ab: the audit_buffer
1344 * The netlink_* functions cannot be called inside an irq context, so
1345 * the audit buffer is placed on a queue and a tasklet is scheduled to
1346 * remove them from the queue outside the irq context. May be called in
1349 void audit_log_end(struct audit_buffer *ab)
1353 if (!audit_rate_check()) {
1354 audit_log_lost("rate limit exceeded");
1356 struct nlmsghdr *nlh = nlmsg_hdr(ab->skb);
1358 nlh->nlmsg_len = ab->skb->len - NLMSG_SPACE(0);
1359 skb_queue_tail(&audit_skb_queue, ab->skb);
1361 wake_up_interruptible(&kauditd_wait);
1362 } else if (nlh->nlmsg_type != AUDIT_EOE) {
1363 if (printk_ratelimit()) {
1364 printk(KERN_NOTICE "type=%d %s\n",
1366 ab->skb->data + NLMSG_SPACE(0));
1368 audit_log_lost("printk limit exceeded\n");
1371 audit_buffer_free(ab);
1375 * audit_log - Log an audit record
1376 * @ctx: audit context
1377 * @gfp_mask: type of allocation
1378 * @type: audit message type
1379 * @fmt: format string to use
1380 * @...: variable parameters matching the format string
1382 * This is a convenience function that calls audit_log_start,
1383 * audit_log_vformat, and audit_log_end. It may be called
1386 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
1387 const char *fmt, ...)
1389 struct audit_buffer *ab;
1392 ab = audit_log_start(ctx, gfp_mask, type);
1394 va_start(args, fmt);
1395 audit_log_vformat(ab, fmt, args);
1401 EXPORT_SYMBOL(audit_log_start);
1402 EXPORT_SYMBOL(audit_log_end);
1403 EXPORT_SYMBOL(audit_log_format);
1404 EXPORT_SYMBOL(audit_log);