[PATCH] AUDIT: kerneldoc for kernel/audit*.c
[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/types.h>
46 #include <asm/atomic.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_rate_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;
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         gfp_t                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 static void audit_panic(const char *message)
146 {
147         switch (audit_failure)
148         {
149         case AUDIT_FAIL_SILENT:
150                 break;
151         case AUDIT_FAIL_PRINTK:
152                 printk(KERN_ERR "audit: %s\n", message);
153                 break;
154         case AUDIT_FAIL_PANIC:
155                 panic("audit: %s\n", message);
156                 break;
157         }
158 }
159
160 static inline int audit_rate_check(void)
161 {
162         static unsigned long    last_check = 0;
163         static int              messages   = 0;
164         static DEFINE_SPINLOCK(lock);
165         unsigned long           flags;
166         unsigned long           now;
167         unsigned long           elapsed;
168         int                     retval     = 0;
169
170         if (!audit_rate_limit) return 1;
171
172         spin_lock_irqsave(&lock, flags);
173         if (++messages < audit_rate_limit) {
174                 retval = 1;
175         } else {
176                 now     = jiffies;
177                 elapsed = now - last_check;
178                 if (elapsed > HZ) {
179                         last_check = now;
180                         messages   = 0;
181                         retval     = 1;
182                 }
183         }
184         spin_unlock_irqrestore(&lock, flags);
185
186         return retval;
187 }
188
189 /**
190  * audit_log_lost - conditionally log lost audit message event
191  * @message: the message stating reason for lost audit message
192  *
193  * Emit at least 1 message per second, even if audit_rate_check is
194  * throttling.
195  * Always increment the lost messages counter.
196 */
197 void audit_log_lost(const char *message)
198 {
199         static unsigned long    last_msg = 0;
200         static DEFINE_SPINLOCK(lock);
201         unsigned long           flags;
202         unsigned long           now;
203         int                     print;
204
205         atomic_inc(&audit_lost);
206
207         print = (audit_failure == AUDIT_FAIL_PANIC || !audit_rate_limit);
208
209         if (!print) {
210                 spin_lock_irqsave(&lock, flags);
211                 now = jiffies;
212                 if (now - last_msg > HZ) {
213                         print = 1;
214                         last_msg = now;
215                 }
216                 spin_unlock_irqrestore(&lock, flags);
217         }
218
219         if (print) {
220                 printk(KERN_WARNING
221                        "audit: audit_lost=%d audit_rate_limit=%d audit_backlog_limit=%d\n",
222                        atomic_read(&audit_lost),
223                        audit_rate_limit,
224                        audit_backlog_limit);
225                 audit_panic(message);
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 static 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                                 try_to_freeze();
301                                 schedule();
302                         }
303
304                         __set_current_state(TASK_RUNNING);
305                         remove_wait_queue(&kauditd_wait, &wait);
306                 }
307         }
308 }
309
310 /**
311  * audit_send_reply - send an audit reply message via netlink
312  * @pid: process id to send reply to
313  * @seq: sequence number
314  * @type: audit message type
315  * @done: done (last) flag
316  * @multi: multi-part message flag
317  * @payload: payload data
318  * @size: payload size
319  *
320  * Allocates an skb, builds the netlink message, and sends it to the pid.
321  * No failure notifications.
322  */
323 void audit_send_reply(int pid, int seq, int type, int done, int multi,
324                       void *payload, int size)
325 {
326         struct sk_buff  *skb;
327         struct nlmsghdr *nlh;
328         int             len = NLMSG_SPACE(size);
329         void            *data;
330         int             flags = multi ? NLM_F_MULTI : 0;
331         int             t     = done  ? NLMSG_DONE  : type;
332
333         skb = alloc_skb(len, GFP_KERNEL);
334         if (!skb)
335                 return;
336
337         nlh              = NLMSG_PUT(skb, pid, seq, t, size);
338         nlh->nlmsg_flags = flags;
339         data             = NLMSG_DATA(nlh);
340         memcpy(data, payload, size);
341
342         /* Ignore failure. It'll only happen if the sender goes away,
343            because our timeout is set to infinite. */
344         netlink_unicast(audit_sock, skb, pid, 0);
345         return;
346
347 nlmsg_failure:                  /* Used by NLMSG_PUT */
348         if (skb)
349                 kfree_skb(skb);
350 }
351
352 /*
353  * Check for appropriate CAP_AUDIT_ capabilities on incoming audit
354  * control messages.
355  */
356 static int audit_netlink_ok(kernel_cap_t eff_cap, u16 msg_type)
357 {
358         int err = 0;
359
360         switch (msg_type) {
361         case AUDIT_GET:
362         case AUDIT_LIST:
363         case AUDIT_SET:
364         case AUDIT_ADD:
365         case AUDIT_DEL:
366         case AUDIT_SIGNAL_INFO:
367                 if (!cap_raised(eff_cap, CAP_AUDIT_CONTROL))
368                         err = -EPERM;
369                 break;
370         case AUDIT_USER:
371         case AUDIT_FIRST_USER_MSG...AUDIT_LAST_USER_MSG:
372                 if (!cap_raised(eff_cap, CAP_AUDIT_WRITE))
373                         err = -EPERM;
374                 break;
375         default:  /* bad msg */
376                 err = -EINVAL;
377         }
378
379         return err;
380 }
381
382 static int audit_receive_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
383 {
384         u32                     uid, pid, seq;
385         void                    *data;
386         struct audit_status     *status_get, status_set;
387         int                     err;
388         struct audit_buffer     *ab;
389         u16                     msg_type = nlh->nlmsg_type;
390         uid_t                   loginuid; /* loginuid of sender */
391         struct audit_sig_info   sig_data;
392
393         err = audit_netlink_ok(NETLINK_CB(skb).eff_cap, msg_type);
394         if (err)
395                 return err;
396
397         /* As soon as there's any sign of userspace auditd,
398          * start kauditd to talk to it */
399         if (!kauditd_task)
400                 kauditd_task = kthread_run(kauditd_thread, NULL, "kauditd");
401         if (IS_ERR(kauditd_task)) {
402                 err = PTR_ERR(kauditd_task);
403                 kauditd_task = NULL;
404                 return err;
405         }
406
407         pid  = NETLINK_CREDS(skb)->pid;
408         uid  = NETLINK_CREDS(skb)->uid;
409         loginuid = NETLINK_CB(skb).loginuid;
410         seq  = nlh->nlmsg_seq;
411         data = NLMSG_DATA(nlh);
412
413         switch (msg_type) {
414         case AUDIT_GET:
415                 status_set.enabled       = audit_enabled;
416                 status_set.failure       = audit_failure;
417                 status_set.pid           = audit_pid;
418                 status_set.rate_limit    = audit_rate_limit;
419                 status_set.backlog_limit = audit_backlog_limit;
420                 status_set.lost          = atomic_read(&audit_lost);
421                 status_set.backlog       = skb_queue_len(&audit_skb_queue);
422                 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_GET, 0, 0,
423                                  &status_set, sizeof(status_set));
424                 break;
425         case AUDIT_SET:
426                 if (nlh->nlmsg_len < sizeof(struct audit_status))
427                         return -EINVAL;
428                 status_get   = (struct audit_status *)data;
429                 if (status_get->mask & AUDIT_STATUS_ENABLED) {
430                         err = audit_set_enabled(status_get->enabled, loginuid);
431                         if (err < 0) return err;
432                 }
433                 if (status_get->mask & AUDIT_STATUS_FAILURE) {
434                         err = audit_set_failure(status_get->failure, loginuid);
435                         if (err < 0) return err;
436                 }
437                 if (status_get->mask & AUDIT_STATUS_PID) {
438                         int old   = audit_pid;
439                         audit_pid = status_get->pid;
440                         audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
441                                 "audit_pid=%d old=%d by auid=%u",
442                                   audit_pid, old, loginuid);
443                 }
444                 if (status_get->mask & AUDIT_STATUS_RATE_LIMIT)
445                         audit_set_rate_limit(status_get->rate_limit, loginuid);
446                 if (status_get->mask & AUDIT_STATUS_BACKLOG_LIMIT)
447                         audit_set_backlog_limit(status_get->backlog_limit,
448                                                         loginuid);
449                 break;
450         case AUDIT_USER:
451         case AUDIT_FIRST_USER_MSG...AUDIT_LAST_USER_MSG:
452                 if (!audit_enabled && msg_type != AUDIT_USER_AVC)
453                         return 0;
454
455                 err = audit_filter_user(&NETLINK_CB(skb), msg_type);
456                 if (err == 1) {
457                         err = 0;
458                         ab = audit_log_start(NULL, GFP_KERNEL, msg_type);
459                         if (ab) {
460                                 audit_log_format(ab,
461                                                  "user pid=%d uid=%u auid=%u msg='%.1024s'",
462                                                  pid, uid, loginuid, (char *)data);
463                                 audit_set_pid(ab, pid);
464                                 audit_log_end(ab);
465                         }
466                 }
467                 break;
468         case AUDIT_ADD:
469         case AUDIT_DEL:
470                 if (nlh->nlmsg_len < sizeof(struct audit_rule))
471                         return -EINVAL;
472                 /* fallthrough */
473         case AUDIT_LIST:
474                 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
475                                            uid, seq, data, loginuid);
476                 break;
477         case AUDIT_SIGNAL_INFO:
478                 sig_data.uid = audit_sig_uid;
479                 sig_data.pid = audit_sig_pid;
480                 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_SIGNAL_INFO, 
481                                 0, 0, &sig_data, sizeof(sig_data));
482                 break;
483         default:
484                 err = -EINVAL;
485                 break;
486         }
487
488         return err < 0 ? err : 0;
489 }
490
491 /*
492  * Get message from skb (based on rtnetlink_rcv_skb).  Each message is
493  * processed by audit_receive_msg.  Malformed skbs with wrong length are
494  * discarded silently.
495  */
496 static void audit_receive_skb(struct sk_buff *skb)
497 {
498         int             err;
499         struct nlmsghdr *nlh;
500         u32             rlen;
501
502         while (skb->len >= NLMSG_SPACE(0)) {
503                 nlh = (struct nlmsghdr *)skb->data;
504                 if (nlh->nlmsg_len < sizeof(*nlh) || skb->len < nlh->nlmsg_len)
505                         return;
506                 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
507                 if (rlen > skb->len)
508                         rlen = skb->len;
509                 if ((err = audit_receive_msg(skb, nlh))) {
510                         netlink_ack(skb, nlh, err);
511                 } else if (nlh->nlmsg_flags & NLM_F_ACK)
512                         netlink_ack(skb, nlh, 0);
513                 skb_pull(skb, rlen);
514         }
515 }
516
517 /* Receive messages from netlink socket. */
518 static void audit_receive(struct sock *sk, int length)
519 {
520         struct sk_buff  *skb;
521         unsigned int qlen;
522
523         down(&audit_netlink_sem);
524
525         for (qlen = skb_queue_len(&sk->sk_receive_queue); qlen; qlen--) {
526                 skb = skb_dequeue(&sk->sk_receive_queue);
527                 audit_receive_skb(skb);
528                 kfree_skb(skb);
529         }
530         up(&audit_netlink_sem);
531 }
532
533
534 /* Initialize audit support at boot time. */
535 static int __init audit_init(void)
536 {
537         printk(KERN_INFO "audit: initializing netlink socket (%s)\n",
538                audit_default ? "enabled" : "disabled");
539         audit_sock = netlink_kernel_create(NETLINK_AUDIT, 0, audit_receive,
540                                            THIS_MODULE);
541         if (!audit_sock)
542                 audit_panic("cannot initialize netlink socket");
543
544         audit_sock->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
545         skb_queue_head_init(&audit_skb_queue);
546         audit_initialized = 1;
547         audit_enabled = audit_default;
548         audit_log(NULL, GFP_KERNEL, AUDIT_KERNEL, "initialized");
549         return 0;
550 }
551 __initcall(audit_init);
552
553 /* Process kernel command-line parameter at boot time.  audit=0 or audit=1. */
554 static int __init audit_enable(char *str)
555 {
556         audit_default = !!simple_strtol(str, NULL, 0);
557         printk(KERN_INFO "audit: %s%s\n",
558                audit_default ? "enabled" : "disabled",
559                audit_initialized ? "" : " (after initialization)");
560         if (audit_initialized)
561                 audit_enabled = audit_default;
562         return 0;
563 }
564
565 __setup("audit=", audit_enable);
566
567 static void audit_buffer_free(struct audit_buffer *ab)
568 {
569         unsigned long flags;
570
571         if (!ab)
572                 return;
573
574         if (ab->skb)
575                 kfree_skb(ab->skb);
576
577         spin_lock_irqsave(&audit_freelist_lock, flags);
578         if (++audit_freelist_count > AUDIT_MAXFREE)
579                 kfree(ab);
580         else
581                 list_add(&ab->list, &audit_freelist);
582         spin_unlock_irqrestore(&audit_freelist_lock, flags);
583 }
584
585 static struct audit_buffer * audit_buffer_alloc(struct audit_context *ctx,
586                                                 gfp_t gfp_mask, int type)
587 {
588         unsigned long flags;
589         struct audit_buffer *ab = NULL;
590         struct nlmsghdr *nlh;
591
592         spin_lock_irqsave(&audit_freelist_lock, flags);
593         if (!list_empty(&audit_freelist)) {
594                 ab = list_entry(audit_freelist.next,
595                                 struct audit_buffer, list);
596                 list_del(&ab->list);
597                 --audit_freelist_count;
598         }
599         spin_unlock_irqrestore(&audit_freelist_lock, flags);
600
601         if (!ab) {
602                 ab = kmalloc(sizeof(*ab), gfp_mask);
603                 if (!ab)
604                         goto err;
605         }
606
607         ab->skb = alloc_skb(AUDIT_BUFSIZ, gfp_mask);
608         if (!ab->skb)
609                 goto err;
610
611         ab->ctx = ctx;
612         ab->gfp_mask = gfp_mask;
613         nlh = (struct nlmsghdr *)skb_put(ab->skb, NLMSG_SPACE(0));
614         nlh->nlmsg_type = type;
615         nlh->nlmsg_flags = 0;
616         nlh->nlmsg_pid = 0;
617         nlh->nlmsg_seq = 0;
618         return ab;
619 err:
620         audit_buffer_free(ab);
621         return NULL;
622 }
623
624 /**
625  * audit_serial - compute a serial number for the audit record
626  *
627  * Compute a serial number for the audit record.  Audit records are
628  * written to user-space as soon as they are generated, so a complete
629  * audit record may be written in several pieces.  The timestamp of the
630  * record and this serial number are used by the user-space tools to
631  * determine which pieces belong to the same audit record.  The
632  * (timestamp,serial) tuple is unique for each syscall and is live from
633  * syscall entry to syscall exit.
634  *
635  * NOTE: Another possibility is to store the formatted records off the
636  * audit context (for those records that have a context), and emit them
637  * all at syscall exit.  However, this could delay the reporting of
638  * significant errors until syscall exit (or never, if the system
639  * halts).
640  */
641 unsigned int audit_serial(void)
642 {
643         static spinlock_t serial_lock = SPIN_LOCK_UNLOCKED;
644         static unsigned int serial = 0;
645
646         unsigned long flags;
647         unsigned int ret;
648
649         spin_lock_irqsave(&serial_lock, flags);
650         do {
651                 ret = ++serial;
652         } while (unlikely(!ret));
653         spin_unlock_irqrestore(&serial_lock, flags);
654
655         return ret;
656 }
657
658 static inline void audit_get_stamp(struct audit_context *ctx, 
659                                    struct timespec *t, unsigned int *serial)
660 {
661         if (ctx)
662                 auditsc_get_stamp(ctx, t, serial);
663         else {
664                 *t = CURRENT_TIME;
665                 *serial = audit_serial();
666         }
667 }
668
669 /* Obtain an audit buffer.  This routine does locking to obtain the
670  * audit buffer, but then no locking is required for calls to
671  * audit_log_*format.  If the tsk is a task that is currently in a
672  * syscall, then the syscall is marked as auditable and an audit record
673  * will be written at syscall exit.  If there is no associated task, tsk
674  * should be NULL. */
675
676 /**
677  * audit_log_start - obtain an audit buffer
678  * @ctx: audit_context (may be NULL)
679  * @gfp_mask: type of allocation
680  * @type: audit message type
681  *
682  * Returns audit_buffer pointer on success or NULL on error.
683  *
684  * Obtain an audit buffer.  This routine does locking to obtain the
685  * audit buffer, but then no locking is required for calls to
686  * audit_log_*format.  If the task (ctx) is a task that is currently in a
687  * syscall, then the syscall is marked as auditable and an audit record
688  * will be written at syscall exit.  If there is no associated task, then
689  * task context (ctx) should be NULL.
690  */
691 struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask,
692                                      int type)
693 {
694         struct audit_buffer     *ab     = NULL;
695         struct timespec         t;
696         unsigned int            serial;
697         int reserve;
698         unsigned long timeout_start = jiffies;
699
700         if (!audit_initialized)
701                 return NULL;
702
703         if (gfp_mask & __GFP_WAIT)
704                 reserve = 0;
705         else
706                 reserve = 5; /* Allow atomic callers to go up to five 
707                                 entries over the normal backlog limit */
708
709         while (audit_backlog_limit
710                && skb_queue_len(&audit_skb_queue) > audit_backlog_limit + reserve) {
711                 if (gfp_mask & __GFP_WAIT && audit_backlog_wait_time
712                     && time_before(jiffies, timeout_start + audit_backlog_wait_time)) {
713
714                         /* Wait for auditd to drain the queue a little */
715                         DECLARE_WAITQUEUE(wait, current);
716                         set_current_state(TASK_INTERRUPTIBLE);
717                         add_wait_queue(&audit_backlog_wait, &wait);
718
719                         if (audit_backlog_limit &&
720                             skb_queue_len(&audit_skb_queue) > audit_backlog_limit)
721                                 schedule_timeout(timeout_start + audit_backlog_wait_time - jiffies);
722
723                         __set_current_state(TASK_RUNNING);
724                         remove_wait_queue(&audit_backlog_wait, &wait);
725                         continue;
726                 }
727                 if (audit_rate_check())
728                         printk(KERN_WARNING
729                                "audit: audit_backlog=%d > "
730                                "audit_backlog_limit=%d\n",
731                                skb_queue_len(&audit_skb_queue),
732                                audit_backlog_limit);
733                 audit_log_lost("backlog limit exceeded");
734                 audit_backlog_wait_time = audit_backlog_wait_overflow;
735                 wake_up(&audit_backlog_wait);
736                 return NULL;
737         }
738
739         ab = audit_buffer_alloc(ctx, gfp_mask, type);
740         if (!ab) {
741                 audit_log_lost("out of memory in audit_log_start");
742                 return NULL;
743         }
744
745         audit_get_stamp(ab->ctx, &t, &serial);
746
747         audit_log_format(ab, "audit(%lu.%03lu:%u): ",
748                          t.tv_sec, t.tv_nsec/1000000, serial);
749         return ab;
750 }
751
752 /**
753  * audit_expand - expand skb in the audit buffer
754  * @ab: audit_buffer
755  * @extra: space to add at tail of the skb
756  *
757  * Returns 0 (no space) on failed expansion, or available space if
758  * successful.
759  */
760 static inline int audit_expand(struct audit_buffer *ab, int extra)
761 {
762         struct sk_buff *skb = ab->skb;
763         int ret = pskb_expand_head(skb, skb_headroom(skb), extra,
764                                    ab->gfp_mask);
765         if (ret < 0) {
766                 audit_log_lost("out of memory in audit_expand");
767                 return 0;
768         }
769         return skb_tailroom(skb);
770 }
771
772 /*
773  * Format an audit message into the audit buffer.  If there isn't enough
774  * room in the audit buffer, more room will be allocated and vsnprint
775  * will be called a second time.  Currently, we assume that a printk
776  * can't format message larger than 1024 bytes, so we don't either.
777  */
778 static void audit_log_vformat(struct audit_buffer *ab, const char *fmt,
779                               va_list args)
780 {
781         int len, avail;
782         struct sk_buff *skb;
783         va_list args2;
784
785         if (!ab)
786                 return;
787
788         BUG_ON(!ab->skb);
789         skb = ab->skb;
790         avail = skb_tailroom(skb);
791         if (avail == 0) {
792                 avail = audit_expand(ab, AUDIT_BUFSIZ);
793                 if (!avail)
794                         goto out;
795         }
796         va_copy(args2, args);
797         len = vsnprintf(skb->tail, avail, fmt, args);
798         if (len >= avail) {
799                 /* The printk buffer is 1024 bytes long, so if we get
800                  * here and AUDIT_BUFSIZ is at least 1024, then we can
801                  * log everything that printk could have logged. */
802                 avail = audit_expand(ab,
803                         max_t(unsigned, AUDIT_BUFSIZ, 1+len-avail));
804                 if (!avail)
805                         goto out;
806                 len = vsnprintf(skb->tail, avail, fmt, args2);
807         }
808         if (len > 0)
809                 skb_put(skb, len);
810 out:
811         return;
812 }
813
814 /**
815  * audit_log_format - format a message into the audit buffer.
816  * @ab: audit_buffer
817  * @fmt: format string
818  * @...: optional parameters matching @fmt string
819  *
820  * All the work is done in audit_log_vformat.
821  */
822 void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
823 {
824         va_list args;
825
826         if (!ab)
827                 return;
828         va_start(args, fmt);
829         audit_log_vformat(ab, fmt, args);
830         va_end(args);
831 }
832
833 /**
834  * audit_log_hex - convert a buffer to hex and append it to the audit skb
835  * @ab: the audit_buffer
836  * @buf: buffer to convert to hex
837  * @len: length of @buf to be converted
838  *
839  * No return value; failure to expand is silently ignored.
840  *
841  * This function will take the passed buf and convert it into a string of
842  * ascii hex digits. The new string is placed onto the skb.
843  */
844 void audit_log_hex(struct audit_buffer *ab, const unsigned char *buf,
845                 size_t len)
846 {
847         int i, avail, new_len;
848         unsigned char *ptr;
849         struct sk_buff *skb;
850         static const unsigned char *hex = "0123456789ABCDEF";
851
852         BUG_ON(!ab->skb);
853         skb = ab->skb;
854         avail = skb_tailroom(skb);
855         new_len = len<<1;
856         if (new_len >= avail) {
857                 /* Round the buffer request up to the next multiple */
858                 new_len = AUDIT_BUFSIZ*(((new_len-avail)/AUDIT_BUFSIZ) + 1);
859                 avail = audit_expand(ab, new_len);
860                 if (!avail)
861                         return;
862         }
863
864         ptr = skb->tail;
865         for (i=0; i<len; i++) {
866                 *ptr++ = hex[(buf[i] & 0xF0)>>4]; /* Upper nibble */
867                 *ptr++ = hex[buf[i] & 0x0F];      /* Lower nibble */
868         }
869         *ptr = 0;
870         skb_put(skb, len << 1); /* new string is twice the old string */
871 }
872
873 /**
874  * audit_log_unstrustedstring - log a string that may contain random characters
875  * @ab: audit_buffer
876  * @string: string to be logged
877  *
878  * This code will escape a string that is passed to it if the string
879  * contains a control character, unprintable character, double quote mark,
880  * or a space. Unescaped strings will start and end with a double quote mark.
881  * Strings that are escaped are printed in hex (2 digits per char).
882  */
883 void audit_log_untrustedstring(struct audit_buffer *ab, const char *string)
884 {
885         const unsigned char *p = string;
886
887         while (*p) {
888                 if (*p == '"' || *p < 0x21 || *p > 0x7f) {
889                         audit_log_hex(ab, string, strlen(string));
890                         return;
891                 }
892                 p++;
893         }
894         audit_log_format(ab, "\"%s\"", string);
895 }
896
897 /* This is a helper-function to print the escaped d_path */
898 void audit_log_d_path(struct audit_buffer *ab, const char *prefix,
899                       struct dentry *dentry, struct vfsmount *vfsmnt)
900 {
901         char *p, *path;
902
903         if (prefix)
904                 audit_log_format(ab, " %s", prefix);
905
906         /* We will allow 11 spaces for ' (deleted)' to be appended */
907         path = kmalloc(PATH_MAX+11, ab->gfp_mask);
908         if (!path) {
909                 audit_log_format(ab, "<no memory>");
910                 return;
911         }
912         p = d_path(dentry, vfsmnt, path, PATH_MAX+11);
913         if (IS_ERR(p)) { /* Should never happen since we send PATH_MAX */
914                 /* FIXME: can we save some information here? */
915                 audit_log_format(ab, "<too long>");
916         } else 
917                 audit_log_untrustedstring(ab, p);
918         kfree(path);
919 }
920
921 /**
922  * audit_log_end - end one audit record
923  * @ab: the audit_buffer
924  *
925  * The netlink_* functions cannot be called inside an irq context, so
926  * the audit buffer is placed on a queue and a tasklet is scheduled to
927  * remove them from the queue outside the irq context.  May be called in
928  * any context.
929  */
930 void audit_log_end(struct audit_buffer *ab)
931 {
932         if (!ab)
933                 return;
934         if (!audit_rate_check()) {
935                 audit_log_lost("rate limit exceeded");
936         } else {
937                 if (audit_pid) {
938                         struct nlmsghdr *nlh = (struct nlmsghdr *)ab->skb->data;
939                         nlh->nlmsg_len = ab->skb->len - NLMSG_SPACE(0);
940                         skb_queue_tail(&audit_skb_queue, ab->skb);
941                         ab->skb = NULL;
942                         wake_up_interruptible(&kauditd_wait);
943                 } else {
944                         printk(KERN_NOTICE "%s\n", ab->skb->data + NLMSG_SPACE(0));
945                 }
946         }
947         audit_buffer_free(ab);
948 }
949
950 /**
951  * audit_log - Log an audit record
952  * @ctx: audit context
953  * @gfp_mask: type of allocation
954  * @type: audit message type
955  * @fmt: format string to use
956  * @...: variable parameters matching the format string
957  *
958  * This is a convenience function that calls audit_log_start,
959  * audit_log_vformat, and audit_log_end.  It may be called
960  * in any context.
961  */
962 void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type, 
963                const char *fmt, ...)
964 {
965         struct audit_buffer *ab;
966         va_list args;
967
968         ab = audit_log_start(ctx, gfp_mask, type);
969         if (ab) {
970                 va_start(args, fmt);
971                 audit_log_vformat(ab, fmt, args);
972                 va_end(args);
973                 audit_log_end(ab);
974         }
975 }