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;
70 * 1 - auditing enabled
71 * 2 - auditing enabled and configuration is locked/unchangeable. */
74 /* Default state when kernel boots without any parameters. */
75 static int audit_default;
77 /* If auditing cannot proceed, audit_failure selects what happens. */
78 static int audit_failure = AUDIT_FAIL_PRINTK;
80 /* If audit records are to be written to the netlink socket, audit_pid
81 * contains the (non-zero) pid. */
84 /* If audit_rate_limit is non-zero, limit the rate of sending audit records
85 * to that number per second. This prevents DoS attacks, but results in
86 * audit records being dropped. */
87 static int audit_rate_limit;
89 /* Number of outstanding audit_buffers allowed. */
90 static int audit_backlog_limit = 64;
91 static int audit_backlog_wait_time = 60 * HZ;
92 static int audit_backlog_wait_overflow = 0;
94 /* The identity of the user shutting down the audit system. */
95 uid_t audit_sig_uid = -1;
96 pid_t audit_sig_pid = -1;
97 u32 audit_sig_sid = 0;
99 /* Records can be lost in several ways:
100 0) [suppressed in audit_alloc]
101 1) out of memory in audit_log_start [kmalloc of struct audit_buffer]
102 2) out of memory in audit_log_move [alloc_skb]
103 3) suppressed due to audit_rate_limit
104 4) suppressed due to audit_backlog_limit
106 static atomic_t audit_lost = ATOMIC_INIT(0);
108 /* The netlink socket. */
109 static struct sock *audit_sock;
111 /* Inotify handle. */
112 struct inotify_handle *audit_ih;
114 /* Hash for inode-based rules */
115 struct list_head audit_inode_hash[AUDIT_INODE_BUCKETS];
117 /* The audit_freelist is a list of pre-allocated audit buffers (if more
118 * than AUDIT_MAXFREE are in use, the audit buffer is freed instead of
119 * being placed on the freelist). */
120 static DEFINE_SPINLOCK(audit_freelist_lock);
121 static int audit_freelist_count;
122 static LIST_HEAD(audit_freelist);
124 static struct sk_buff_head audit_skb_queue;
125 static struct task_struct *kauditd_task;
126 static DECLARE_WAIT_QUEUE_HEAD(kauditd_wait);
127 static DECLARE_WAIT_QUEUE_HEAD(audit_backlog_wait);
129 /* Serialize requests from userspace. */
130 static DEFINE_MUTEX(audit_cmd_mutex);
132 /* AUDIT_BUFSIZ is the size of the temporary buffer used for formatting
133 * audit records. Since printk uses a 1024 byte buffer, this buffer
134 * should be at least that large. */
135 #define AUDIT_BUFSIZ 1024
137 /* AUDIT_MAXFREE is the number of empty audit_buffers we keep on the
138 * audit_freelist. Doing so eliminates many kmalloc/kfree calls. */
139 #define AUDIT_MAXFREE (2*NR_CPUS)
141 /* The audit_buffer is used when formatting an audit record. The caller
142 * locks briefly to get the record off the freelist or to allocate the
143 * buffer, and locks briefly to send the buffer to the netlink layer or
144 * to place it on a transmit queue. Multiple audit_buffers can be in
145 * use simultaneously. */
146 struct audit_buffer {
147 struct list_head list;
148 struct sk_buff *skb; /* formatted skb ready to send */
149 struct audit_context *ctx; /* NULL or associated context */
153 static void audit_set_pid(struct audit_buffer *ab, pid_t pid)
155 struct nlmsghdr *nlh = nlmsg_hdr(ab->skb);
156 nlh->nlmsg_pid = pid;
159 void audit_panic(const char *message)
161 switch (audit_failure)
163 case AUDIT_FAIL_SILENT:
165 case AUDIT_FAIL_PRINTK:
166 printk(KERN_ERR "audit: %s\n", message);
168 case AUDIT_FAIL_PANIC:
169 panic("audit: %s\n", message);
174 static inline int audit_rate_check(void)
176 static unsigned long last_check = 0;
177 static int messages = 0;
178 static DEFINE_SPINLOCK(lock);
181 unsigned long elapsed;
184 if (!audit_rate_limit) return 1;
186 spin_lock_irqsave(&lock, flags);
187 if (++messages < audit_rate_limit) {
191 elapsed = now - last_check;
198 spin_unlock_irqrestore(&lock, flags);
204 * audit_log_lost - conditionally log lost audit message event
205 * @message: the message stating reason for lost audit message
207 * Emit at least 1 message per second, even if audit_rate_check is
209 * Always increment the lost messages counter.
211 void audit_log_lost(const char *message)
213 static unsigned long last_msg = 0;
214 static DEFINE_SPINLOCK(lock);
219 atomic_inc(&audit_lost);
221 print = (audit_failure == AUDIT_FAIL_PANIC || !audit_rate_limit);
224 spin_lock_irqsave(&lock, flags);
226 if (now - last_msg > HZ) {
230 spin_unlock_irqrestore(&lock, flags);
235 "audit: audit_lost=%d audit_rate_limit=%d audit_backlog_limit=%d\n",
236 atomic_read(&audit_lost),
238 audit_backlog_limit);
239 audit_panic(message);
243 static int audit_set_rate_limit(int limit, uid_t loginuid, u32 sid)
245 int res, rc = 0, old = audit_rate_limit;
247 /* check if we are locked */
248 if (audit_enabled == 2)
256 if ((rc = selinux_sid_to_string(sid, &ctx, &len)) == 0) {
257 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
258 "audit_rate_limit=%d old=%d by auid=%u"
260 limit, old, loginuid, ctx, res);
263 res = 0; /* Something weird, deny request */
265 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
266 "audit_rate_limit=%d old=%d by auid=%u res=%d",
267 limit, old, loginuid, res);
269 /* If we are allowed, make the change */
271 audit_rate_limit = limit;
272 /* Not allowed, update reason */
278 static int audit_set_backlog_limit(int limit, uid_t loginuid, u32 sid)
280 int res, rc = 0, old = audit_backlog_limit;
282 /* check if we are locked */
283 if (audit_enabled == 2)
291 if ((rc = selinux_sid_to_string(sid, &ctx, &len)) == 0) {
292 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
293 "audit_backlog_limit=%d old=%d by auid=%u"
295 limit, old, loginuid, ctx, res);
298 res = 0; /* Something weird, deny request */
300 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
301 "audit_backlog_limit=%d old=%d by auid=%u res=%d",
302 limit, old, loginuid, res);
304 /* If we are allowed, make the change */
306 audit_backlog_limit = limit;
307 /* Not allowed, update reason */
313 static int audit_set_enabled(int state, uid_t loginuid, u32 sid)
315 int res, rc = 0, old = audit_enabled;
317 if (state < 0 || state > 2)
320 /* check if we are locked */
321 if (audit_enabled == 2)
329 if ((rc = selinux_sid_to_string(sid, &ctx, &len)) == 0) {
330 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
331 "audit_enabled=%d old=%d by auid=%u"
333 state, old, loginuid, ctx, res);
336 res = 0; /* Something weird, deny request */
338 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
339 "audit_enabled=%d old=%d by auid=%u res=%d",
340 state, old, loginuid, res);
342 /* If we are allowed, make the change */
344 audit_enabled = state;
345 /* Not allowed, update reason */
351 static int audit_set_failure(int state, uid_t loginuid, u32 sid)
353 int res, rc = 0, old = audit_failure;
355 if (state != AUDIT_FAIL_SILENT
356 && state != AUDIT_FAIL_PRINTK
357 && state != AUDIT_FAIL_PANIC)
360 /* check if we are locked */
361 if (audit_enabled == 2)
369 if ((rc = selinux_sid_to_string(sid, &ctx, &len)) == 0) {
370 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
371 "audit_failure=%d old=%d by auid=%u"
373 state, old, loginuid, ctx, res);
376 res = 0; /* Something weird, deny request */
378 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
379 "audit_failure=%d old=%d by auid=%u res=%d",
380 state, old, loginuid, res);
382 /* If we are allowed, make the change */
384 audit_failure = state;
385 /* Not allowed, update reason */
391 static int kauditd_thread(void *dummy)
396 while (!kthread_should_stop()) {
397 skb = skb_dequeue(&audit_skb_queue);
398 wake_up(&audit_backlog_wait);
401 int err = netlink_unicast(audit_sock, skb, audit_pid, 0);
403 BUG_ON(err != -ECONNREFUSED); /* Shoudn't happen */
404 printk(KERN_ERR "audit: *NO* daemon at audit_pid=%d\n", audit_pid);
408 printk(KERN_NOTICE "%s\n", skb->data + NLMSG_SPACE(0));
412 DECLARE_WAITQUEUE(wait, current);
413 set_current_state(TASK_INTERRUPTIBLE);
414 add_wait_queue(&kauditd_wait, &wait);
416 if (!skb_queue_len(&audit_skb_queue)) {
421 __set_current_state(TASK_RUNNING);
422 remove_wait_queue(&kauditd_wait, &wait);
428 static int audit_prepare_user_tty(pid_t pid, uid_t loginuid)
430 struct task_struct *tsk;
433 read_lock(&tasklist_lock);
434 tsk = find_task_by_pid(pid);
440 spin_lock_irq(&tsk->sighand->siglock);
441 if (!tsk->signal->audit_tty)
443 spin_unlock_irq(&tsk->sighand->siglock);
447 tty_audit_push_task(tsk, loginuid);
449 read_unlock(&tasklist_lock);
453 int audit_send_list(void *_dest)
455 struct audit_netlink_list *dest = _dest;
459 /* wait for parent to finish and send an ACK */
460 mutex_lock(&audit_cmd_mutex);
461 mutex_unlock(&audit_cmd_mutex);
463 while ((skb = __skb_dequeue(&dest->q)) != NULL)
464 netlink_unicast(audit_sock, skb, pid, 0);
471 struct sk_buff *audit_make_reply(int pid, int seq, int type, int done,
472 int multi, void *payload, int size)
475 struct nlmsghdr *nlh;
476 int len = NLMSG_SPACE(size);
478 int flags = multi ? NLM_F_MULTI : 0;
479 int t = done ? NLMSG_DONE : type;
481 skb = alloc_skb(len, GFP_KERNEL);
485 nlh = NLMSG_PUT(skb, pid, seq, t, size);
486 nlh->nlmsg_flags = flags;
487 data = NLMSG_DATA(nlh);
488 memcpy(data, payload, size);
491 nlmsg_failure: /* Used by NLMSG_PUT */
498 * audit_send_reply - send an audit reply message via netlink
499 * @pid: process id to send reply to
500 * @seq: sequence number
501 * @type: audit message type
502 * @done: done (last) flag
503 * @multi: multi-part message flag
504 * @payload: payload data
505 * @size: payload size
507 * Allocates an skb, builds the netlink message, and sends it to the pid.
508 * No failure notifications.
510 void audit_send_reply(int pid, int seq, int type, int done, int multi,
511 void *payload, int size)
514 skb = audit_make_reply(pid, seq, type, done, multi, payload, size);
517 /* Ignore failure. It'll only happen if the sender goes away,
518 because our timeout is set to infinite. */
519 netlink_unicast(audit_sock, skb, pid, 0);
524 * Check for appropriate CAP_AUDIT_ capabilities on incoming audit
527 static int audit_netlink_ok(struct sk_buff *skb, u16 msg_type)
534 case AUDIT_LIST_RULES:
540 case AUDIT_SIGNAL_INFO:
543 if (security_netlink_recv(skb, CAP_AUDIT_CONTROL))
547 case AUDIT_FIRST_USER_MSG ... AUDIT_LAST_USER_MSG:
548 case AUDIT_FIRST_USER_MSG2 ... AUDIT_LAST_USER_MSG2:
549 if (security_netlink_recv(skb, CAP_AUDIT_WRITE))
552 default: /* bad msg */
559 static int audit_receive_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
561 u32 uid, pid, seq, sid;
563 struct audit_status *status_get, status_set;
565 struct audit_buffer *ab;
566 u16 msg_type = nlh->nlmsg_type;
567 uid_t loginuid; /* loginuid of sender */
568 struct audit_sig_info *sig_data;
572 err = audit_netlink_ok(skb, msg_type);
576 /* As soon as there's any sign of userspace auditd,
577 * start kauditd to talk to it */
579 kauditd_task = kthread_run(kauditd_thread, NULL, "kauditd");
580 if (IS_ERR(kauditd_task)) {
581 err = PTR_ERR(kauditd_task);
586 pid = NETLINK_CREDS(skb)->pid;
587 uid = NETLINK_CREDS(skb)->uid;
588 loginuid = NETLINK_CB(skb).loginuid;
589 sid = NETLINK_CB(skb).sid;
590 seq = nlh->nlmsg_seq;
591 data = NLMSG_DATA(nlh);
595 status_set.enabled = audit_enabled;
596 status_set.failure = audit_failure;
597 status_set.pid = audit_pid;
598 status_set.rate_limit = audit_rate_limit;
599 status_set.backlog_limit = audit_backlog_limit;
600 status_set.lost = atomic_read(&audit_lost);
601 status_set.backlog = skb_queue_len(&audit_skb_queue);
602 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_GET, 0, 0,
603 &status_set, sizeof(status_set));
606 if (nlh->nlmsg_len < sizeof(struct audit_status))
608 status_get = (struct audit_status *)data;
609 if (status_get->mask & AUDIT_STATUS_ENABLED) {
610 err = audit_set_enabled(status_get->enabled,
612 if (err < 0) return err;
614 if (status_get->mask & AUDIT_STATUS_FAILURE) {
615 err = audit_set_failure(status_get->failure,
617 if (err < 0) return err;
619 if (status_get->mask & AUDIT_STATUS_PID) {
622 if ((err = selinux_sid_to_string(
626 audit_log(NULL, GFP_KERNEL,
628 "audit_pid=%d old=%d by auid=%u subj=%s",
629 status_get->pid, old,
633 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
634 "audit_pid=%d old=%d by auid=%u",
635 status_get->pid, old, loginuid);
636 audit_pid = status_get->pid;
638 if (status_get->mask & AUDIT_STATUS_RATE_LIMIT)
639 err = audit_set_rate_limit(status_get->rate_limit,
641 if (status_get->mask & AUDIT_STATUS_BACKLOG_LIMIT)
642 err = audit_set_backlog_limit(status_get->backlog_limit,
646 case AUDIT_FIRST_USER_MSG ... AUDIT_LAST_USER_MSG:
647 case AUDIT_FIRST_USER_MSG2 ... AUDIT_LAST_USER_MSG2:
648 if (!audit_enabled && msg_type != AUDIT_USER_AVC)
651 err = audit_filter_user(&NETLINK_CB(skb), msg_type);
654 if (msg_type == AUDIT_USER_TTY) {
655 err = audit_prepare_user_tty(pid, loginuid);
659 ab = audit_log_start(NULL, GFP_KERNEL, msg_type);
662 "user pid=%d uid=%u auid=%u",
665 if (selinux_sid_to_string(
669 /* Maybe call audit_panic? */
675 if (msg_type != AUDIT_USER_TTY)
676 audit_log_format(ab, " msg='%.1024s'",
681 audit_log_format(ab, " msg=");
682 size = nlmsg_len(nlh);
683 audit_log_n_untrustedstring(ab, size,
686 audit_set_pid(ab, pid);
693 if (nlmsg_len(nlh) < sizeof(struct audit_rule))
695 if (audit_enabled == 2) {
696 ab = audit_log_start(NULL, GFP_KERNEL,
697 AUDIT_CONFIG_CHANGE);
700 "pid=%d uid=%u auid=%u",
703 if (selinux_sid_to_string(
707 /* Maybe call audit_panic? */
713 audit_log_format(ab, " audit_enabled=%d res=0",
721 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
722 uid, seq, data, nlmsg_len(nlh),
727 if (nlmsg_len(nlh) < sizeof(struct audit_rule_data))
729 if (audit_enabled == 2) {
730 ab = audit_log_start(NULL, GFP_KERNEL,
731 AUDIT_CONFIG_CHANGE);
734 "pid=%d uid=%u auid=%u",
737 if (selinux_sid_to_string(
741 /* Maybe call audit_panic? */
747 audit_log_format(ab, " audit_enabled=%d res=0",
754 case AUDIT_LIST_RULES:
755 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
756 uid, seq, data, nlmsg_len(nlh),
759 case AUDIT_SIGNAL_INFO:
760 err = selinux_sid_to_string(audit_sig_sid, &ctx, &len);
763 sig_data = kmalloc(sizeof(*sig_data) + len, GFP_KERNEL);
768 sig_data->uid = audit_sig_uid;
769 sig_data->pid = audit_sig_pid;
770 memcpy(sig_data->ctx, ctx, len);
772 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_SIGNAL_INFO,
773 0, 0, sig_data, sizeof(*sig_data) + len);
776 case AUDIT_TTY_GET: {
777 struct audit_tty_status s;
778 struct task_struct *tsk;
780 read_lock(&tasklist_lock);
781 tsk = find_task_by_pid(pid);
785 spin_lock_irq(&tsk->sighand->siglock);
786 s.enabled = tsk->signal->audit_tty != 0;
787 spin_unlock_irq(&tsk->sighand->siglock);
789 read_unlock(&tasklist_lock);
790 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_TTY_GET, 0, 0,
794 case AUDIT_TTY_SET: {
795 struct audit_tty_status *s;
796 struct task_struct *tsk;
798 if (nlh->nlmsg_len < sizeof(struct audit_tty_status))
801 if (s->enabled != 0 && s->enabled != 1)
803 read_lock(&tasklist_lock);
804 tsk = find_task_by_pid(pid);
808 spin_lock_irq(&tsk->sighand->siglock);
809 tsk->signal->audit_tty = s->enabled != 0;
810 spin_unlock_irq(&tsk->sighand->siglock);
812 read_unlock(&tasklist_lock);
820 return err < 0 ? err : 0;
824 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
825 * processed by audit_receive_msg. Malformed skbs with wrong length are
826 * discarded silently.
828 static void audit_receive_skb(struct sk_buff *skb)
831 struct nlmsghdr *nlh;
834 while (skb->len >= NLMSG_SPACE(0)) {
835 nlh = nlmsg_hdr(skb);
836 if (nlh->nlmsg_len < sizeof(*nlh) || skb->len < nlh->nlmsg_len)
838 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
841 if ((err = audit_receive_msg(skb, nlh))) {
842 netlink_ack(skb, nlh, err);
843 } else if (nlh->nlmsg_flags & NLM_F_ACK)
844 netlink_ack(skb, nlh, 0);
849 /* Receive messages from netlink socket. */
850 static void audit_receive(struct sk_buff *skb)
852 mutex_lock(&audit_cmd_mutex);
853 audit_receive_skb(skb);
854 mutex_unlock(&audit_cmd_mutex);
857 #ifdef CONFIG_AUDITSYSCALL
858 static const struct inotify_operations audit_inotify_ops = {
859 .handle_event = audit_handle_ievent,
860 .destroy_watch = audit_free_parent,
864 /* Initialize audit support at boot time. */
865 static int __init audit_init(void)
869 printk(KERN_INFO "audit: initializing netlink socket (%s)\n",
870 audit_default ? "enabled" : "disabled");
871 audit_sock = netlink_kernel_create(&init_net, NETLINK_AUDIT, 0,
872 audit_receive, NULL, THIS_MODULE);
874 audit_panic("cannot initialize netlink socket");
876 audit_sock->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
878 skb_queue_head_init(&audit_skb_queue);
879 audit_initialized = 1;
880 audit_enabled = audit_default;
882 /* Register the callback with selinux. This callback will be invoked
883 * when a new policy is loaded. */
884 selinux_audit_set_callback(&selinux_audit_rule_update);
886 audit_log(NULL, GFP_KERNEL, AUDIT_KERNEL, "initialized");
888 #ifdef CONFIG_AUDITSYSCALL
889 audit_ih = inotify_init(&audit_inotify_ops);
890 if (IS_ERR(audit_ih))
891 audit_panic("cannot initialize inotify handle");
894 for (i = 0; i < AUDIT_INODE_BUCKETS; i++)
895 INIT_LIST_HEAD(&audit_inode_hash[i]);
899 __initcall(audit_init);
901 /* Process kernel command-line parameter at boot time. audit=0 or audit=1. */
902 static int __init audit_enable(char *str)
904 audit_default = !!simple_strtol(str, NULL, 0);
905 printk(KERN_INFO "audit: %s%s\n",
906 audit_default ? "enabled" : "disabled",
907 audit_initialized ? "" : " (after initialization)");
908 if (audit_initialized)
909 audit_enabled = audit_default;
913 __setup("audit=", audit_enable);
915 static void audit_buffer_free(struct audit_buffer *ab)
925 spin_lock_irqsave(&audit_freelist_lock, flags);
926 if (audit_freelist_count > AUDIT_MAXFREE)
929 audit_freelist_count++;
930 list_add(&ab->list, &audit_freelist);
932 spin_unlock_irqrestore(&audit_freelist_lock, flags);
935 static struct audit_buffer * audit_buffer_alloc(struct audit_context *ctx,
936 gfp_t gfp_mask, int type)
939 struct audit_buffer *ab = NULL;
940 struct nlmsghdr *nlh;
942 spin_lock_irqsave(&audit_freelist_lock, flags);
943 if (!list_empty(&audit_freelist)) {
944 ab = list_entry(audit_freelist.next,
945 struct audit_buffer, list);
947 --audit_freelist_count;
949 spin_unlock_irqrestore(&audit_freelist_lock, flags);
952 ab = kmalloc(sizeof(*ab), gfp_mask);
957 ab->skb = alloc_skb(AUDIT_BUFSIZ, gfp_mask);
962 ab->gfp_mask = gfp_mask;
963 nlh = (struct nlmsghdr *)skb_put(ab->skb, NLMSG_SPACE(0));
964 nlh->nlmsg_type = type;
965 nlh->nlmsg_flags = 0;
970 audit_buffer_free(ab);
975 * audit_serial - compute a serial number for the audit record
977 * Compute a serial number for the audit record. Audit records are
978 * written to user-space as soon as they are generated, so a complete
979 * audit record may be written in several pieces. The timestamp of the
980 * record and this serial number are used by the user-space tools to
981 * determine which pieces belong to the same audit record. The
982 * (timestamp,serial) tuple is unique for each syscall and is live from
983 * syscall entry to syscall exit.
985 * NOTE: Another possibility is to store the formatted records off the
986 * audit context (for those records that have a context), and emit them
987 * all at syscall exit. However, this could delay the reporting of
988 * significant errors until syscall exit (or never, if the system
991 unsigned int audit_serial(void)
993 static DEFINE_SPINLOCK(serial_lock);
994 static unsigned int serial = 0;
999 spin_lock_irqsave(&serial_lock, flags);
1002 } while (unlikely(!ret));
1003 spin_unlock_irqrestore(&serial_lock, flags);
1008 static inline void audit_get_stamp(struct audit_context *ctx,
1009 struct timespec *t, unsigned int *serial)
1012 auditsc_get_stamp(ctx, t, serial);
1015 *serial = audit_serial();
1019 /* Obtain an audit buffer. This routine does locking to obtain the
1020 * audit buffer, but then no locking is required for calls to
1021 * audit_log_*format. If the tsk is a task that is currently in a
1022 * syscall, then the syscall is marked as auditable and an audit record
1023 * will be written at syscall exit. If there is no associated task, tsk
1024 * should be NULL. */
1027 * audit_log_start - obtain an audit buffer
1028 * @ctx: audit_context (may be NULL)
1029 * @gfp_mask: type of allocation
1030 * @type: audit message type
1032 * Returns audit_buffer pointer on success or NULL on error.
1034 * Obtain an audit buffer. This routine does locking to obtain the
1035 * audit buffer, but then no locking is required for calls to
1036 * audit_log_*format. If the task (ctx) is a task that is currently in a
1037 * syscall, then the syscall is marked as auditable and an audit record
1038 * will be written at syscall exit. If there is no associated task, then
1039 * task context (ctx) should be NULL.
1041 struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask,
1044 struct audit_buffer *ab = NULL;
1046 unsigned int serial;
1048 unsigned long timeout_start = jiffies;
1050 if (!audit_initialized)
1053 if (unlikely(audit_filter_type(type)))
1056 if (gfp_mask & __GFP_WAIT)
1059 reserve = 5; /* Allow atomic callers to go up to five
1060 entries over the normal backlog limit */
1062 while (audit_backlog_limit
1063 && skb_queue_len(&audit_skb_queue) > audit_backlog_limit + reserve) {
1064 if (gfp_mask & __GFP_WAIT && audit_backlog_wait_time
1065 && time_before(jiffies, timeout_start + audit_backlog_wait_time)) {
1067 /* Wait for auditd to drain the queue a little */
1068 DECLARE_WAITQUEUE(wait, current);
1069 set_current_state(TASK_INTERRUPTIBLE);
1070 add_wait_queue(&audit_backlog_wait, &wait);
1072 if (audit_backlog_limit &&
1073 skb_queue_len(&audit_skb_queue) > audit_backlog_limit)
1074 schedule_timeout(timeout_start + audit_backlog_wait_time - jiffies);
1076 __set_current_state(TASK_RUNNING);
1077 remove_wait_queue(&audit_backlog_wait, &wait);
1080 if (audit_rate_check())
1082 "audit: audit_backlog=%d > "
1083 "audit_backlog_limit=%d\n",
1084 skb_queue_len(&audit_skb_queue),
1085 audit_backlog_limit);
1086 audit_log_lost("backlog limit exceeded");
1087 audit_backlog_wait_time = audit_backlog_wait_overflow;
1088 wake_up(&audit_backlog_wait);
1092 ab = audit_buffer_alloc(ctx, gfp_mask, type);
1094 audit_log_lost("out of memory in audit_log_start");
1098 audit_get_stamp(ab->ctx, &t, &serial);
1100 audit_log_format(ab, "audit(%lu.%03lu:%u): ",
1101 t.tv_sec, t.tv_nsec/1000000, serial);
1106 * audit_expand - expand skb in the audit buffer
1108 * @extra: space to add at tail of the skb
1110 * Returns 0 (no space) on failed expansion, or available space if
1113 static inline int audit_expand(struct audit_buffer *ab, int extra)
1115 struct sk_buff *skb = ab->skb;
1116 int ret = pskb_expand_head(skb, skb_headroom(skb), extra,
1119 audit_log_lost("out of memory in audit_expand");
1122 return skb_tailroom(skb);
1126 * Format an audit message into the audit buffer. If there isn't enough
1127 * room in the audit buffer, more room will be allocated and vsnprint
1128 * will be called a second time. Currently, we assume that a printk
1129 * can't format message larger than 1024 bytes, so we don't either.
1131 static void audit_log_vformat(struct audit_buffer *ab, const char *fmt,
1135 struct sk_buff *skb;
1143 avail = skb_tailroom(skb);
1145 avail = audit_expand(ab, AUDIT_BUFSIZ);
1149 va_copy(args2, args);
1150 len = vsnprintf(skb_tail_pointer(skb), avail, fmt, args);
1152 /* The printk buffer is 1024 bytes long, so if we get
1153 * here and AUDIT_BUFSIZ is at least 1024, then we can
1154 * log everything that printk could have logged. */
1155 avail = audit_expand(ab,
1156 max_t(unsigned, AUDIT_BUFSIZ, 1+len-avail));
1159 len = vsnprintf(skb_tail_pointer(skb), avail, fmt, args2);
1168 * audit_log_format - format a message into the audit buffer.
1170 * @fmt: format string
1171 * @...: optional parameters matching @fmt string
1173 * All the work is done in audit_log_vformat.
1175 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
1181 va_start(args, fmt);
1182 audit_log_vformat(ab, fmt, args);
1187 * audit_log_hex - convert a buffer to hex and append it to the audit skb
1188 * @ab: the audit_buffer
1189 * @buf: buffer to convert to hex
1190 * @len: length of @buf to be converted
1192 * No return value; failure to expand is silently ignored.
1194 * This function will take the passed buf and convert it into a string of
1195 * ascii hex digits. The new string is placed onto the skb.
1197 void audit_log_hex(struct audit_buffer *ab, const unsigned char *buf,
1200 int i, avail, new_len;
1202 struct sk_buff *skb;
1203 static const unsigned char *hex = "0123456789ABCDEF";
1210 avail = skb_tailroom(skb);
1212 if (new_len >= avail) {
1213 /* Round the buffer request up to the next multiple */
1214 new_len = AUDIT_BUFSIZ*(((new_len-avail)/AUDIT_BUFSIZ) + 1);
1215 avail = audit_expand(ab, new_len);
1220 ptr = skb_tail_pointer(skb);
1221 for (i=0; i<len; i++) {
1222 *ptr++ = hex[(buf[i] & 0xF0)>>4]; /* Upper nibble */
1223 *ptr++ = hex[buf[i] & 0x0F]; /* Lower nibble */
1226 skb_put(skb, len << 1); /* new string is twice the old string */
1230 * Format a string of no more than slen characters into the audit buffer,
1231 * enclosed in quote marks.
1233 static void audit_log_n_string(struct audit_buffer *ab, size_t slen,
1238 struct sk_buff *skb;
1245 avail = skb_tailroom(skb);
1246 new_len = slen + 3; /* enclosing quotes + null terminator */
1247 if (new_len > avail) {
1248 avail = audit_expand(ab, new_len);
1252 ptr = skb_tail_pointer(skb);
1254 memcpy(ptr, string, slen);
1258 skb_put(skb, slen + 2); /* don't include null terminator */
1262 * audit_log_n_untrustedstring - log a string that may contain random characters
1264 * @len: lenth of string (not including trailing null)
1265 * @string: string to be logged
1267 * This code will escape a string that is passed to it if the string
1268 * contains a control character, unprintable character, double quote mark,
1269 * or a space. Unescaped strings will start and end with a double quote mark.
1270 * Strings that are escaped are printed in hex (2 digits per char).
1272 * The caller specifies the number of characters in the string to log, which may
1273 * or may not be the entire string.
1275 const char *audit_log_n_untrustedstring(struct audit_buffer *ab, size_t len,
1278 const unsigned char *p;
1280 for (p = string; p < (const unsigned char *)string + len && *p; p++) {
1281 if (*p == '"' || *p < 0x21 || *p > 0x7f) {
1282 audit_log_hex(ab, string, len);
1283 return string + len + 1;
1286 audit_log_n_string(ab, len, string);
1291 * audit_log_untrustedstring - log a string that may contain random characters
1293 * @string: string to be logged
1295 * Same as audit_log_n_untrustedstring(), except that strlen is used to
1296 * determine string length.
1298 const char *audit_log_untrustedstring(struct audit_buffer *ab, const char *string)
1300 return audit_log_n_untrustedstring(ab, strlen(string), string);
1303 /* This is a helper-function to print the escaped d_path */
1304 void audit_log_d_path(struct audit_buffer *ab, const char *prefix,
1305 struct dentry *dentry, struct vfsmount *vfsmnt)
1310 audit_log_format(ab, " %s", prefix);
1312 /* We will allow 11 spaces for ' (deleted)' to be appended */
1313 path = kmalloc(PATH_MAX+11, ab->gfp_mask);
1315 audit_log_format(ab, "<no memory>");
1318 p = d_path(dentry, vfsmnt, path, PATH_MAX+11);
1319 if (IS_ERR(p)) { /* Should never happen since we send PATH_MAX */
1320 /* FIXME: can we save some information here? */
1321 audit_log_format(ab, "<too long>");
1323 audit_log_untrustedstring(ab, p);
1328 * audit_log_end - end one audit record
1329 * @ab: the audit_buffer
1331 * The netlink_* functions cannot be called inside an irq context, so
1332 * the audit buffer is placed on a queue and a tasklet is scheduled to
1333 * remove them from the queue outside the irq context. May be called in
1336 void audit_log_end(struct audit_buffer *ab)
1340 if (!audit_rate_check()) {
1341 audit_log_lost("rate limit exceeded");
1344 struct nlmsghdr *nlh = nlmsg_hdr(ab->skb);
1345 nlh->nlmsg_len = ab->skb->len - NLMSG_SPACE(0);
1346 skb_queue_tail(&audit_skb_queue, ab->skb);
1348 wake_up_interruptible(&kauditd_wait);
1350 printk(KERN_NOTICE "%s\n", ab->skb->data + NLMSG_SPACE(0));
1353 audit_buffer_free(ab);
1357 * audit_log - Log an audit record
1358 * @ctx: audit context
1359 * @gfp_mask: type of allocation
1360 * @type: audit message type
1361 * @fmt: format string to use
1362 * @...: variable parameters matching the format string
1364 * This is a convenience function that calls audit_log_start,
1365 * audit_log_vformat, and audit_log_end. It may be called
1368 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
1369 const char *fmt, ...)
1371 struct audit_buffer *ab;
1374 ab = audit_log_start(ctx, gfp_mask, type);
1376 va_start(args, fmt);
1377 audit_log_vformat(ab, fmt, args);
1383 EXPORT_SYMBOL(audit_log_start);
1384 EXPORT_SYMBOL(audit_log_end);
1385 EXPORT_SYMBOL(audit_log_format);
1386 EXPORT_SYMBOL(audit_log);