d321e251d32b4afa067b512492b5796d456b67d1
[linux-2.6.git] / kernel / audit.c
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
4  *
5  * Copyright 2003-2004 Red Hat Inc., Durham, North Carolina.
6  * All Rights Reserved.
7  *
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.
12  *
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.
17  *
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
21  *
22  * Written by Rickard E. (Rik) Faith <faith@redhat.com>
23  *
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
29  *              generation time):
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
36  *           current syscall).
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.
40  *
41  * Example user-space utilities: http://people.redhat.com/sgrubb/audit/
42  */
43
44 #include <linux/init.h>
45 #include <asm/atomic.h>
46 #include <asm/types.h>
47 #include <linux/mm.h>
48 #include <linux/module.h>
49 #include <linux/err.h>
50 #include <linux/kthread.h>
51
52 #include <linux/audit.h>
53
54 #include <net/sock.h>
55 #include <linux/skbuff.h>
56 #include <linux/netlink.h>
57
58 /* No auditing will take place until audit_initialized != 0.
59  * (Initialization happens after skb_init is called.) */
60 static int      audit_initialized;
61
62 /* No syscall auditing will take place unless audit_enabled != 0. */
63 int             audit_enabled;
64
65 /* Default state when kernel boots without any parameters. */
66 static int      audit_default;
67
68 /* If auditing cannot proceed, audit_failure selects what happens. */
69 static int      audit_failure = AUDIT_FAIL_PRINTK;
70
71 /* If audit records are to be written to the netlink socket, audit_pid
72  * contains the (non-zero) pid. */
73 int             audit_pid;
74
75 /* If audit_limit is non-zero, limit the rate of sending audit records
76  * to that number per second.  This prevents DoS attacks, but results in
77  * audit records being dropped. */
78 static int      audit_rate_limit;
79
80 /* Number of outstanding audit_buffers allowed. */
81 static int      audit_backlog_limit = 64;
82 static int      audit_backlog_wait_time = 60 * HZ;
83 static int      audit_backlog_wait_overflow = 0;
84
85 /* The identity of the user shutting down the audit system. */
86 uid_t           audit_sig_uid = -1;
87 pid_t           audit_sig_pid = -1;
88
89 /* Records can be lost in several ways:
90    0) [suppressed in audit_alloc]
91    1) out of memory in audit_log_start [kmalloc of struct audit_buffer]
92    2) out of memory in audit_log_move [alloc_skb]
93    3) suppressed due to audit_rate_limit
94    4) suppressed due to audit_backlog_limit
95 */
96 static atomic_t    audit_lost = ATOMIC_INIT(0);
97
98 /* The netlink socket. */
99 static struct sock *audit_sock;
100
101 /* The audit_freelist is a list of pre-allocated audit buffers (if more
102  * than AUDIT_MAXFREE are in use, the audit buffer is freed instead of
103  * being placed on the freelist). */
104 static DEFINE_SPINLOCK(audit_freelist_lock);
105 static int         audit_freelist_count = 0;
106 static LIST_HEAD(audit_freelist);
107
108 static struct sk_buff_head audit_skb_queue;
109 static struct task_struct *kauditd_task;
110 static DECLARE_WAIT_QUEUE_HEAD(kauditd_wait);
111 static DECLARE_WAIT_QUEUE_HEAD(audit_backlog_wait);
112
113 /* The netlink socket is only to be read by 1 CPU, which lets us assume
114  * that list additions and deletions never happen simultaneously in
115  * auditsc.c */
116 DECLARE_MUTEX(audit_netlink_sem);
117
118 /* AUDIT_BUFSIZ is the size of the temporary buffer used for formatting
119  * audit records.  Since printk uses a 1024 byte buffer, this buffer
120  * should be at least that large. */
121 #define AUDIT_BUFSIZ 1024
122
123 /* AUDIT_MAXFREE is the number of empty audit_buffers we keep on the
124  * audit_freelist.  Doing so eliminates many kmalloc/kfree calls. */
125 #define AUDIT_MAXFREE  (2*NR_CPUS)
126
127 /* The audit_buffer is used when formatting an audit record.  The caller
128  * locks briefly to get the record off the freelist or to allocate the
129  * buffer, and locks briefly to send the buffer to the netlink layer or
130  * to place it on a transmit queue.  Multiple audit_buffers can be in
131  * use simultaneously. */
132 struct audit_buffer {
133         struct list_head     list;
134         struct sk_buff       *skb;      /* formatted skb ready to send */
135         struct audit_context *ctx;      /* NULL or associated context */
136         int                  gfp_mask;
137 };
138
139 static void audit_set_pid(struct audit_buffer *ab, pid_t pid)
140 {
141         struct nlmsghdr *nlh = (struct nlmsghdr *)ab->skb->data;
142         nlh->nlmsg_pid = pid;
143 }
144
145 struct audit_entry {
146         struct list_head  list;
147         struct audit_rule rule;
148 };
149
150 static void audit_panic(const char *message)
151 {
152         switch (audit_failure)
153         {
154         case AUDIT_FAIL_SILENT:
155                 break;
156         case AUDIT_FAIL_PRINTK:
157                 printk(KERN_ERR "audit: %s\n", message);
158                 break;
159         case AUDIT_FAIL_PANIC:
160                 panic("audit: %s\n", message);
161                 break;
162         }
163 }
164
165 static inline int audit_rate_check(void)
166 {
167         static unsigned long    last_check = 0;
168         static int              messages   = 0;
169         static DEFINE_SPINLOCK(lock);
170         unsigned long           flags;
171         unsigned long           now;
172         unsigned long           elapsed;
173         int                     retval     = 0;
174
175         if (!audit_rate_limit) return 1;
176
177         spin_lock_irqsave(&lock, flags);
178         if (++messages < audit_rate_limit) {
179                 retval = 1;
180         } else {
181                 now     = jiffies;
182                 elapsed = now - last_check;
183                 if (elapsed > HZ) {
184                         last_check = now;
185                         messages   = 0;
186                         retval     = 1;
187                 }
188         }
189         spin_unlock_irqrestore(&lock, flags);
190
191         return retval;
192 }
193
194 /* Emit at least 1 message per second, even if audit_rate_check is
195  * throttling. */
196 void audit_log_lost(const char *message)
197 {
198         static unsigned long    last_msg = 0;
199         static DEFINE_SPINLOCK(lock);
200         unsigned long           flags;
201         unsigned long           now;
202         int                     print;
203
204         atomic_inc(&audit_lost);
205
206         print = (audit_failure == AUDIT_FAIL_PANIC || !audit_rate_limit);
207
208         if (!print) {
209                 spin_lock_irqsave(&lock, flags);
210                 now = jiffies;
211                 if (now - last_msg > HZ) {
212                         print = 1;
213                         last_msg = now;
214                 }
215                 spin_unlock_irqrestore(&lock, flags);
216         }
217
218         if (print) {
219                 printk(KERN_WARNING
220                        "audit: audit_lost=%d audit_rate_limit=%d audit_backlog_limit=%d\n",
221                        atomic_read(&audit_lost),
222                        audit_rate_limit,
223                        audit_backlog_limit);
224                 audit_panic(message);
225         }
226
227 }
228
229 static int audit_set_rate_limit(int limit, uid_t loginuid)
230 {
231         int old          = audit_rate_limit;
232         audit_rate_limit = limit;
233         audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE, 
234                         "audit_rate_limit=%d old=%d by auid=%u",
235                         audit_rate_limit, old, loginuid);
236         return old;
237 }
238
239 static int audit_set_backlog_limit(int limit, uid_t loginuid)
240 {
241         int old          = audit_backlog_limit;
242         audit_backlog_limit = limit;
243         audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
244                         "audit_backlog_limit=%d old=%d by auid=%u",
245                         audit_backlog_limit, old, loginuid);
246         return old;
247 }
248
249 static int audit_set_enabled(int state, uid_t loginuid)
250 {
251         int old          = audit_enabled;
252         if (state != 0 && state != 1)
253                 return -EINVAL;
254         audit_enabled = state;
255         audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
256                         "audit_enabled=%d old=%d by auid=%u",
257                         audit_enabled, old, loginuid);
258         return old;
259 }
260
261 static int audit_set_failure(int state, uid_t loginuid)
262 {
263         int old          = audit_failure;
264         if (state != AUDIT_FAIL_SILENT
265             && state != AUDIT_FAIL_PRINTK
266             && state != AUDIT_FAIL_PANIC)
267                 return -EINVAL;
268         audit_failure = state;
269         audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
270                         "audit_failure=%d old=%d by auid=%u",
271                         audit_failure, old, loginuid);
272         return old;
273 }
274
275 int kauditd_thread(void *dummy)
276 {
277         struct sk_buff *skb;
278
279         while (1) {
280                 skb = skb_dequeue(&audit_skb_queue);
281                 wake_up(&audit_backlog_wait);
282                 if (skb) {
283                         if (audit_pid) {
284                                 int err = netlink_unicast(audit_sock, skb, audit_pid, 0);
285                                 if (err < 0) {
286                                         BUG_ON(err != -ECONNREFUSED); /* Shoudn't happen */
287                                         printk(KERN_ERR "audit: *NO* daemon at audit_pid=%d\n", audit_pid);
288                                         audit_pid = 0;
289                                 }
290                         } else {
291                                 printk(KERN_NOTICE "%s\n", skb->data + NLMSG_SPACE(0));
292                                 kfree_skb(skb);
293                         }
294                 } else {
295                         DECLARE_WAITQUEUE(wait, current);
296                         set_current_state(TASK_INTERRUPTIBLE);
297                         add_wait_queue(&kauditd_wait, &wait);
298
299                         if (!skb_queue_len(&audit_skb_queue))
300                                 schedule();
301
302                         __set_current_state(TASK_RUNNING);
303                         remove_wait_queue(&kauditd_wait, &wait);
304                 }
305         }
306 }
307
308 void audit_send_reply(int pid, int seq, int type, int done, int multi,
309                       void *payload, int size)
310 {
311         struct sk_buff  *skb;
312         struct nlmsghdr *nlh;
313         int             len = NLMSG_SPACE(size);
314         void            *data;
315         int             flags = multi ? NLM_F_MULTI : 0;
316         int             t     = done  ? NLMSG_DONE  : type;
317
318         skb = alloc_skb(len, GFP_KERNEL);
319         if (!skb)
320                 return;
321
322         nlh              = NLMSG_PUT(skb, pid, seq, t, size);
323         nlh->nlmsg_flags = flags;
324         data             = NLMSG_DATA(nlh);
325         memcpy(data, payload, size);
326
327         /* Ignore failure. It'll only happen if the sender goes away,
328            because our timeout is set to infinite. */
329         netlink_unicast(audit_sock, skb, pid, 0);
330         return;
331
332 nlmsg_failure:                  /* Used by NLMSG_PUT */
333         if (skb)
334                 kfree_skb(skb);
335 }
336
337 /*
338  * Check for appropriate CAP_AUDIT_ capabilities on incoming audit
339  * control messages.
340  */
341 static int audit_netlink_ok(kernel_cap_t eff_cap, u16 msg_type)
342 {
343         int err = 0;
344
345         switch (msg_type) {
346         case AUDIT_GET:
347         case AUDIT_LIST:
348         case AUDIT_SET:
349         case AUDIT_ADD:
350         case AUDIT_DEL:
351         case AUDIT_SIGNAL_INFO:
352                 if (!cap_raised(eff_cap, CAP_AUDIT_CONTROL))
353                         err = -EPERM;
354                 break;
355         case AUDIT_USER:
356         case AUDIT_FIRST_USER_MSG...AUDIT_LAST_USER_MSG:
357                 if (!cap_raised(eff_cap, CAP_AUDIT_WRITE))
358                         err = -EPERM;
359                 break;
360         default:  /* bad msg */
361                 err = -EINVAL;
362         }
363
364         return err;
365 }
366
367 static int audit_receive_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
368 {
369         u32                     uid, pid, seq;
370         void                    *data;
371         struct audit_status     *status_get, status_set;
372         int                     err;
373         struct audit_buffer     *ab;
374         u16                     msg_type = nlh->nlmsg_type;
375         uid_t                   loginuid; /* loginuid of sender */
376         struct audit_sig_info   sig_data;
377
378         err = audit_netlink_ok(NETLINK_CB(skb).eff_cap, msg_type);
379         if (err)
380                 return err;
381
382         /* As soon as there's any sign of userspace auditd, start kauditd to talk to it */
383         if (!kauditd_task)
384                 kauditd_task = kthread_run(kauditd_thread, NULL, "kauditd");
385         if (IS_ERR(kauditd_task)) {
386                 err = PTR_ERR(kauditd_task);
387                 kauditd_task = NULL;
388                 return err;
389         }
390
391         pid  = NETLINK_CREDS(skb)->pid;
392         uid  = NETLINK_CREDS(skb)->uid;
393         loginuid = NETLINK_CB(skb).loginuid;
394         seq  = nlh->nlmsg_seq;
395         data = NLMSG_DATA(nlh);
396
397         switch (msg_type) {
398         case AUDIT_GET:
399                 status_set.enabled       = audit_enabled;
400                 status_set.failure       = audit_failure;
401                 status_set.pid           = audit_pid;
402                 status_set.rate_limit    = audit_rate_limit;
403                 status_set.backlog_limit = audit_backlog_limit;
404                 status_set.lost          = atomic_read(&audit_lost);
405                 status_set.backlog       = skb_queue_len(&audit_skb_queue);
406                 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_GET, 0, 0,
407                                  &status_set, sizeof(status_set));
408                 break;
409         case AUDIT_SET:
410                 if (nlh->nlmsg_len < sizeof(struct audit_status))
411                         return -EINVAL;
412                 status_get   = (struct audit_status *)data;
413                 if (status_get->mask & AUDIT_STATUS_ENABLED) {
414                         err = audit_set_enabled(status_get->enabled, loginuid);
415                         if (err < 0) return err;
416                 }
417                 if (status_get->mask & AUDIT_STATUS_FAILURE) {
418                         err = audit_set_failure(status_get->failure, loginuid);
419                         if (err < 0) return err;
420                 }
421                 if (status_get->mask & AUDIT_STATUS_PID) {
422                         int old   = audit_pid;
423                         audit_pid = status_get->pid;
424                         audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
425                                 "audit_pid=%d old=%d by auid=%u",
426                                   audit_pid, old, loginuid);
427                 }
428                 if (status_get->mask & AUDIT_STATUS_RATE_LIMIT)
429                         audit_set_rate_limit(status_get->rate_limit, loginuid);
430                 if (status_get->mask & AUDIT_STATUS_BACKLOG_LIMIT)
431                         audit_set_backlog_limit(status_get->backlog_limit,
432                                                         loginuid);
433                 break;
434         case AUDIT_USER:
435         case AUDIT_FIRST_USER_MSG...AUDIT_LAST_USER_MSG:
436                 if (!audit_enabled && msg_type != AUDIT_USER_AVC)
437                         return 0;
438
439                 err = audit_filter_user(&NETLINK_CB(skb), msg_type);
440                 if (err == 1) {
441                         err = 0;
442                         ab = audit_log_start(NULL, GFP_KERNEL, msg_type);
443                         if (ab) {
444                                 audit_log_format(ab,
445                                                  "user pid=%d uid=%u auid=%u msg='%.1024s'",
446                                                  pid, uid, loginuid, (char *)data);
447                                 audit_set_pid(ab, pid);
448                                 audit_log_end(ab);
449                         }
450                 }
451                 break;
452         case AUDIT_ADD:
453         case AUDIT_DEL:
454                 if (nlh->nlmsg_len < sizeof(struct audit_rule))
455                         return -EINVAL;
456                 /* fallthrough */
457         case AUDIT_LIST:
458                 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
459                                            uid, seq, data, loginuid);
460                 break;
461         case AUDIT_SIGNAL_INFO:
462                 sig_data.uid = audit_sig_uid;
463                 sig_data.pid = audit_sig_pid;
464                 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_SIGNAL_INFO, 
465                                 0, 0, &sig_data, sizeof(sig_data));
466                 break;
467         default:
468                 err = -EINVAL;
469                 break;
470         }
471
472         return err < 0 ? err : 0;
473 }
474
475 /* Get message from skb (based on rtnetlink_rcv_skb).  Each message is
476  * processed by audit_receive_msg.  Malformed skbs with wrong length are
477  * discarded silently.  */
478 static void audit_receive_skb(struct sk_buff *skb)
479 {
480         int             err;
481         struct nlmsghdr *nlh;
482         u32             rlen;
483
484         while (skb->len >= NLMSG_SPACE(0)) {
485                 nlh = (struct nlmsghdr *)skb->data;
486                 if (nlh->nlmsg_len < sizeof(*nlh) || skb->len < nlh->nlmsg_len)
487                         return;
488                 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
489                 if (rlen > skb->len)
490                         rlen = skb->len;
491                 if ((err = audit_receive_msg(skb, nlh))) {
492                         netlink_ack(skb, nlh, err);
493                 } else if (nlh->nlmsg_flags & NLM_F_ACK)
494                         netlink_ack(skb, nlh, 0);
495                 skb_pull(skb, rlen);
496         }
497 }
498
499 /* Receive messages from netlink socket. */
500 static void audit_receive(struct sock *sk, int length)
501 {
502         struct sk_buff  *skb;
503         unsigned int qlen;
504
505         down(&audit_netlink_sem);
506
507         for (qlen = skb_queue_len(&sk->sk_receive_queue); qlen; qlen--) {
508                 skb = skb_dequeue(&sk->sk_receive_queue);
509                 audit_receive_skb(skb);
510                 kfree_skb(skb);
511         }
512         up(&audit_netlink_sem);
513 }
514
515
516 /* Initialize audit support at boot time. */
517 static int __init audit_init(void)
518 {
519         printk(KERN_INFO "audit: initializing netlink socket (%s)\n",
520                audit_default ? "enabled" : "disabled");
521         audit_sock = netlink_kernel_create(NETLINK_AUDIT, audit_receive);
522         if (!audit_sock)
523                 audit_panic("cannot initialize netlink socket");
524
525         audit_sock->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
526         skb_queue_head_init(&audit_skb_queue);
527         audit_initialized = 1;
528         audit_enabled = audit_default;
529         audit_log(NULL, GFP_KERNEL, AUDIT_KERNEL, "initialized");
530         return 0;
531 }
532 __initcall(audit_init);
533
534 /* Process kernel command-line parameter at boot time.  audit=0 or audit=1. */
535 static int __init audit_enable(char *str)
536 {
537         audit_default = !!simple_strtol(str, NULL, 0);
538         printk(KERN_INFO "audit: %s%s\n",
539                audit_default ? "enabled" : "disabled",
540                audit_initialized ? "" : " (after initialization)");
541         if (audit_initialized)
542                 audit_enabled = audit_default;
543         return 0;
544 }
545
546 __setup("audit=", audit_enable);
547
548 static void audit_buffer_free(struct audit_buffer *ab)
549 {
550         unsigned long flags;
551
552         if (!ab)
553                 return;
554
555         if (ab->skb)
556                 kfree_skb(ab->skb);
557
558         spin_lock_irqsave(&audit_freelist_lock, flags);
559         if (++audit_freelist_count > AUDIT_MAXFREE)
560                 kfree(ab);
561         else
562                 list_add(&ab->list, &audit_freelist);
563         spin_unlock_irqrestore(&audit_freelist_lock, flags);
564 }
565
566 static struct audit_buffer * audit_buffer_alloc(struct audit_context *ctx,
567                                                 unsigned int __nocast gfp_mask, int type)
568 {
569         unsigned long flags;
570         struct audit_buffer *ab = NULL;
571         struct nlmsghdr *nlh;
572
573         spin_lock_irqsave(&audit_freelist_lock, flags);
574         if (!list_empty(&audit_freelist)) {
575                 ab = list_entry(audit_freelist.next,
576                                 struct audit_buffer, list);
577                 list_del(&ab->list);
578                 --audit_freelist_count;
579         }
580         spin_unlock_irqrestore(&audit_freelist_lock, flags);
581
582         if (!ab) {
583                 ab = kmalloc(sizeof(*ab), gfp_mask);
584                 if (!ab)
585                         goto err;
586         }
587
588         ab->skb = alloc_skb(AUDIT_BUFSIZ, gfp_mask);
589         if (!ab->skb)
590                 goto err;
591
592         ab->ctx = ctx;
593         ab->gfp_mask = gfp_mask;
594         nlh = (struct nlmsghdr *)skb_put(ab->skb, NLMSG_SPACE(0));
595         nlh->nlmsg_type = type;
596         nlh->nlmsg_flags = 0;
597         nlh->nlmsg_pid = 0;
598         nlh->nlmsg_seq = 0;
599         return ab;
600 err:
601         audit_buffer_free(ab);
602         return NULL;
603 }
604
605 /* Compute a serial number for the audit record.  Audit records are
606  * written to user-space as soon as they are generated, so a complete
607  * audit record may be written in several pieces.  The timestamp of the
608  * record and this serial number are used by the user-space tools to
609  * determine which pieces belong to the same audit record.  The
610  * (timestamp,serial) tuple is unique for each syscall and is live from
611  * syscall entry to syscall exit.
612  *
613  * NOTE: Another possibility is to store the formatted records off the
614  * audit context (for those records that have a context), and emit them
615  * all at syscall exit.  However, this could delay the reporting of
616  * significant errors until syscall exit (or never, if the system
617  * halts). */
618
619 unsigned int audit_serial(void)
620 {
621         static spinlock_t serial_lock = SPIN_LOCK_UNLOCKED;
622         static unsigned int serial = 0;
623
624         unsigned long flags;
625         unsigned int ret;
626
627         spin_lock_irqsave(&serial_lock, flags);
628         do {
629                 ret = ++serial;
630         } while (unlikely(!ret));
631         spin_unlock_irqrestore(&serial_lock, flags);
632
633         return ret;
634 }
635
636 static inline void audit_get_stamp(struct audit_context *ctx, 
637                                    struct timespec *t, unsigned int *serial)
638 {
639         if (ctx)
640                 auditsc_get_stamp(ctx, t, serial);
641         else {
642                 *t = CURRENT_TIME;
643                 *serial = audit_serial();
644         }
645 }
646
647 /* Obtain an audit buffer.  This routine does locking to obtain the
648  * audit buffer, but then no locking is required for calls to
649  * audit_log_*format.  If the tsk is a task that is currently in a
650  * syscall, then the syscall is marked as auditable and an audit record
651  * will be written at syscall exit.  If there is no associated task, tsk
652  * should be NULL. */
653
654 struct audit_buffer *audit_log_start(struct audit_context *ctx, int gfp_mask,
655                                      int type)
656 {
657         struct audit_buffer     *ab     = NULL;
658         struct timespec         t;
659         unsigned int            serial;
660         int reserve;
661         unsigned long timeout_start = jiffies;
662
663         if (!audit_initialized)
664                 return NULL;
665
666         if (gfp_mask & __GFP_WAIT)
667                 reserve = 0;
668         else
669                 reserve = 5; /* Allow atomic callers to go up to five 
670                                 entries over the normal backlog limit */
671
672         while (audit_backlog_limit
673                && skb_queue_len(&audit_skb_queue) > audit_backlog_limit + reserve) {
674                 if (gfp_mask & __GFP_WAIT && audit_backlog_wait_time
675                     && time_before(jiffies, timeout_start + audit_backlog_wait_time)) {
676
677                         /* Wait for auditd to drain the queue a little */
678                         DECLARE_WAITQUEUE(wait, current);
679                         set_current_state(TASK_INTERRUPTIBLE);
680                         add_wait_queue(&audit_backlog_wait, &wait);
681
682                         if (audit_backlog_limit &&
683                             skb_queue_len(&audit_skb_queue) > audit_backlog_limit)
684                                 schedule_timeout(timeout_start + audit_backlog_wait_time - jiffies);
685
686                         __set_current_state(TASK_RUNNING);
687                         remove_wait_queue(&audit_backlog_wait, &wait);
688                         continue;
689                 }
690                 if (audit_rate_check())
691                         printk(KERN_WARNING
692                                "audit: audit_backlog=%d > "
693                                "audit_backlog_limit=%d\n",
694                                skb_queue_len(&audit_skb_queue),
695                                audit_backlog_limit);
696                 audit_log_lost("backlog limit exceeded");
697                 audit_backlog_wait_time = audit_backlog_wait_overflow;
698                 wake_up(&audit_backlog_wait);
699                 return NULL;
700         }
701
702         ab = audit_buffer_alloc(ctx, gfp_mask, type);
703         if (!ab) {
704                 audit_log_lost("out of memory in audit_log_start");
705                 return NULL;
706         }
707
708         audit_get_stamp(ab->ctx, &t, &serial);
709
710         audit_log_format(ab, "audit(%lu.%03lu:%u): ",
711                          t.tv_sec, t.tv_nsec/1000000, serial);
712         return ab;
713 }
714
715 /**
716  * audit_expand - expand skb in the audit buffer
717  * @ab: audit_buffer
718  *
719  * Returns 0 (no space) on failed expansion, or available space if
720  * successful.
721  */
722 static inline int audit_expand(struct audit_buffer *ab, int extra)
723 {
724         struct sk_buff *skb = ab->skb;
725         int ret = pskb_expand_head(skb, skb_headroom(skb), extra,
726                                    ab->gfp_mask);
727         if (ret < 0) {
728                 audit_log_lost("out of memory in audit_expand");
729                 return 0;
730         }
731         return skb_tailroom(skb);
732 }
733
734 /* Format an audit message into the audit buffer.  If there isn't enough
735  * room in the audit buffer, more room will be allocated and vsnprint
736  * will be called a second time.  Currently, we assume that a printk
737  * can't format message larger than 1024 bytes, so we don't either. */
738 static void audit_log_vformat(struct audit_buffer *ab, const char *fmt,
739                               va_list args)
740 {
741         int len, avail;
742         struct sk_buff *skb;
743         va_list args2;
744
745         if (!ab)
746                 return;
747
748         BUG_ON(!ab->skb);
749         skb = ab->skb;
750         avail = skb_tailroom(skb);
751         if (avail == 0) {
752                 avail = audit_expand(ab, AUDIT_BUFSIZ);
753                 if (!avail)
754                         goto out;
755         }
756         va_copy(args2, args);
757         len = vsnprintf(skb->tail, avail, fmt, args);
758         if (len >= avail) {
759                 /* The printk buffer is 1024 bytes long, so if we get
760                  * here and AUDIT_BUFSIZ is at least 1024, then we can
761                  * log everything that printk could have logged. */
762                 avail = audit_expand(ab, max_t(unsigned, AUDIT_BUFSIZ, 1+len-avail));
763                 if (!avail)
764                         goto out;
765                 len = vsnprintf(skb->tail, avail, fmt, args2);
766         }
767         if (len > 0)
768                 skb_put(skb, len);
769 out:
770         return;
771 }
772
773 /* Format a message into the audit buffer.  All the work is done in
774  * audit_log_vformat. */
775 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
776 {
777         va_list args;
778
779         if (!ab)
780                 return;
781         va_start(args, fmt);
782         audit_log_vformat(ab, fmt, args);
783         va_end(args);
784 }
785
786 /* This function will take the passed buf and convert it into a string of
787  * ascii hex digits. The new string is placed onto the skb. */
788 void audit_log_hex(struct audit_buffer *ab, const unsigned char *buf, 
789                 size_t len)
790 {
791         int i, avail, new_len;
792         unsigned char *ptr;
793         struct sk_buff *skb;
794         static const unsigned char *hex = "0123456789ABCDEF";
795
796         BUG_ON(!ab->skb);
797         skb = ab->skb;
798         avail = skb_tailroom(skb);
799         new_len = len<<1;
800         if (new_len >= avail) {
801                 /* Round the buffer request up to the next multiple */
802                 new_len = AUDIT_BUFSIZ*(((new_len-avail)/AUDIT_BUFSIZ) + 1);
803                 avail = audit_expand(ab, new_len);
804                 if (!avail)
805                         return;
806         }
807
808         ptr = skb->tail;
809         for (i=0; i<len; i++) {
810                 *ptr++ = hex[(buf[i] & 0xF0)>>4]; /* Upper nibble */
811                 *ptr++ = hex[buf[i] & 0x0F];      /* Lower nibble */
812         }
813         *ptr = 0;
814         skb_put(skb, len << 1); /* new string is twice the old string */
815 }
816
817 /* This code will escape a string that is passed to it if the string
818  * contains a control character, unprintable character, double quote mark, 
819  * or a space. Unescaped strings will start and end with a double quote mark.
820  * Strings that are escaped are printed in hex (2 digits per char). */
821 void audit_log_untrustedstring(struct audit_buffer *ab, const char *string)
822 {
823         const unsigned char *p = string;
824
825         while (*p) {
826                 if (*p == '"' || *p < 0x21 || *p > 0x7f) {
827                         audit_log_hex(ab, string, strlen(string));
828                         return;
829                 }
830                 p++;
831         }
832         audit_log_format(ab, "\"%s\"", string);
833 }
834
835 /* This is a helper-function to print the escaped d_path */
836 void audit_log_d_path(struct audit_buffer *ab, const char *prefix,
837                       struct dentry *dentry, struct vfsmount *vfsmnt)
838 {
839         char *p, *path;
840
841         if (prefix)
842                 audit_log_format(ab, " %s", prefix);
843
844         /* We will allow 11 spaces for ' (deleted)' to be appended */
845         path = kmalloc(PATH_MAX+11, ab->gfp_mask);
846         if (!path) {
847                 audit_log_format(ab, "<no memory>");
848                 return;
849         }
850         p = d_path(dentry, vfsmnt, path, PATH_MAX+11);
851         if (IS_ERR(p)) { /* Should never happen since we send PATH_MAX */
852                 /* FIXME: can we save some information here? */
853                 audit_log_format(ab, "<too long>");
854         } else 
855                 audit_log_untrustedstring(ab, p);
856         kfree(path);
857 }
858
859 /* The netlink_* functions cannot be called inside an irq context, so
860  * the audit buffer is places on a queue and a tasklet is scheduled to
861  * remove them from the queue outside the irq context.  May be called in
862  * any context. */
863 void audit_log_end(struct audit_buffer *ab)
864 {
865         if (!ab)
866                 return;
867         if (!audit_rate_check()) {
868                 audit_log_lost("rate limit exceeded");
869         } else {
870                 if (audit_pid) {
871                         struct nlmsghdr *nlh = (struct nlmsghdr *)ab->skb->data;
872                         nlh->nlmsg_len = ab->skb->len - NLMSG_SPACE(0);
873                         skb_queue_tail(&audit_skb_queue, ab->skb);
874                         ab->skb = NULL;
875                         wake_up_interruptible(&kauditd_wait);
876                 } else {
877                         printk(KERN_NOTICE "%s\n", ab->skb->data + NLMSG_SPACE(0));
878                 }
879         }
880         audit_buffer_free(ab);
881 }
882
883 /* Log an audit record.  This is a convenience function that calls
884  * audit_log_start, audit_log_vformat, and audit_log_end.  It may be
885  * called in any context. */
886 void audit_log(struct audit_context *ctx, int gfp_mask, int type, 
887                const char *fmt, ...)
888 {
889         struct audit_buffer *ab;
890         va_list args;
891
892         ab = audit_log_start(ctx, gfp_mask, type);
893         if (ab) {
894                 va_start(args, fmt);
895                 audit_log_vformat(ab, fmt, args);
896                 va_end(args);
897                 audit_log_end(ab);
898         }
899 }