[PATCH] Exclude messages by message type
[GitHub/mt8127/android_kernel_alcatel_ttab.git] / kernel / audit.c
CommitLineData
85c8721f 1/* audit.c -- Auditing support
1da177e4
LT
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 *
85c8721f 41 * Example user-space utilities: http://people.redhat.com/sgrubb/audit/
1da177e4
LT
42 */
43
44#include <linux/init.h>
1da177e4 45#include <asm/types.h>
715b49ef 46#include <asm/atomic.h>
1da177e4
LT
47#include <linux/mm.h>
48#include <linux/module.h>
b7d11258
DW
49#include <linux/err.h>
50#include <linux/kthread.h>
1da177e4
LT
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.) */
60static int audit_initialized;
61
62/* No syscall auditing will take place unless audit_enabled != 0. */
63int audit_enabled;
64
65/* Default state when kernel boots without any parameters. */
66static int audit_default;
67
68/* If auditing cannot proceed, audit_failure selects what happens. */
69static 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. */
c2f0c7c3 73int audit_pid;
1da177e4 74
b0dd25a8 75/* If audit_rate_limit is non-zero, limit the rate of sending audit records
1da177e4
LT
76 * to that number per second. This prevents DoS attacks, but results in
77 * audit records being dropped. */
78static int audit_rate_limit;
79
80/* Number of outstanding audit_buffers allowed. */
81static int audit_backlog_limit = 64;
ac4cec44
DW
82static int audit_backlog_wait_time = 60 * HZ;
83static int audit_backlog_wait_overflow = 0;
1da177e4 84
c2f0c7c3
SG
85/* The identity of the user shutting down the audit system. */
86uid_t audit_sig_uid = -1;
87pid_t audit_sig_pid = -1;
88
1da177e4
LT
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*/
96static atomic_t audit_lost = ATOMIC_INIT(0);
97
98/* The netlink socket. */
99static struct sock *audit_sock;
100
b7d11258 101/* The audit_freelist is a list of pre-allocated audit buffers (if more
1da177e4
LT
102 * than AUDIT_MAXFREE are in use, the audit buffer is freed instead of
103 * being placed on the freelist). */
1da177e4 104static DEFINE_SPINLOCK(audit_freelist_lock);
b0dd25a8 105static int audit_freelist_count;
1da177e4
LT
106static LIST_HEAD(audit_freelist);
107
b7d11258
DW
108static struct sk_buff_head audit_skb_queue;
109static struct task_struct *kauditd_task;
110static DECLARE_WAIT_QUEUE_HEAD(kauditd_wait);
9ad9ad38 111static DECLARE_WAIT_QUEUE_HEAD(audit_backlog_wait);
1da177e4
LT
112
113/* The netlink socket is only to be read by 1 CPU, which lets us assume
23f32d18 114 * that list additions and deletions never happen simultaneously in
1da177e4 115 * auditsc.c */
f6a789d1 116DECLARE_MUTEX(audit_netlink_sem);
1da177e4
LT
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. */
132struct audit_buffer {
133 struct list_head list;
8fc6115c 134 struct sk_buff *skb; /* formatted skb ready to send */
1da177e4 135 struct audit_context *ctx; /* NULL or associated context */
9796fdd8 136 gfp_t gfp_mask;
1da177e4
LT
137};
138
c0404993
SG
139static 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
1da177e4
LT
145static 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
160static 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
b0dd25a8
RD
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*/
1da177e4
LT
197void 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
b7d11258 221 "audit: audit_lost=%d audit_rate_limit=%d audit_backlog_limit=%d\n",
1da177e4 222 atomic_read(&audit_lost),
1da177e4
LT
223 audit_rate_limit,
224 audit_backlog_limit);
225 audit_panic(message);
226 }
1da177e4
LT
227}
228
c94c257c 229static int audit_set_rate_limit(int limit, uid_t loginuid)
1da177e4
LT
230{
231 int old = audit_rate_limit;
232 audit_rate_limit = limit;
9ad9ad38 233 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
bccf6ae0 234 "audit_rate_limit=%d old=%d by auid=%u",
c94c257c 235 audit_rate_limit, old, loginuid);
1da177e4
LT
236 return old;
237}
238
c94c257c 239static int audit_set_backlog_limit(int limit, uid_t loginuid)
1da177e4
LT
240{
241 int old = audit_backlog_limit;
242 audit_backlog_limit = limit;
9ad9ad38 243 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
bccf6ae0 244 "audit_backlog_limit=%d old=%d by auid=%u",
c94c257c 245 audit_backlog_limit, old, loginuid);
1da177e4
LT
246 return old;
247}
248
c94c257c 249static int audit_set_enabled(int state, uid_t loginuid)
1da177e4
LT
250{
251 int old = audit_enabled;
252 if (state != 0 && state != 1)
253 return -EINVAL;
254 audit_enabled = state;
9ad9ad38 255 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
bccf6ae0 256 "audit_enabled=%d old=%d by auid=%u",
c0404993 257 audit_enabled, old, loginuid);
1da177e4
LT
258 return old;
259}
260
c94c257c 261static int audit_set_failure(int state, uid_t loginuid)
1da177e4
LT
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;
9ad9ad38 269 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
bccf6ae0 270 "audit_failure=%d old=%d by auid=%u",
c0404993 271 audit_failure, old, loginuid);
1da177e4
LT
272 return old;
273}
274
97a41e26 275static int kauditd_thread(void *dummy)
b7d11258
DW
276{
277 struct sk_buff *skb;
278
279 while (1) {
280 skb = skb_dequeue(&audit_skb_queue);
9ad9ad38 281 wake_up(&audit_backlog_wait);
b7d11258
DW
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 {
e1b09eba 291 printk(KERN_NOTICE "%s\n", skb->data + NLMSG_SPACE(0));
b7d11258
DW
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
7a4ae749
PO
299 if (!skb_queue_len(&audit_skb_queue)) {
300 try_to_freeze();
b7d11258 301 schedule();
7a4ae749 302 }
b7d11258
DW
303
304 __set_current_state(TASK_RUNNING);
305 remove_wait_queue(&kauditd_wait, &wait);
306 }
307 }
308}
309
b0dd25a8
RD
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 */
1da177e4
LT
323void 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)
b7d11258 335 return;
1da177e4 336
b7d11258 337 nlh = NLMSG_PUT(skb, pid, seq, t, size);
1da177e4
LT
338 nlh->nlmsg_flags = flags;
339 data = NLMSG_DATA(nlh);
340 memcpy(data, payload, size);
b7d11258
DW
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);
1da177e4
LT
345 return;
346
347nlmsg_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 */
356static 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:
c2f0c7c3 366 case AUDIT_SIGNAL_INFO:
1da177e4
LT
367 if (!cap_raised(eff_cap, CAP_AUDIT_CONTROL))
368 err = -EPERM;
369 break;
05474106 370 case AUDIT_USER:
209aba03 371 case AUDIT_FIRST_USER_MSG...AUDIT_LAST_USER_MSG:
90d526c0 372 case AUDIT_FIRST_USER_MSG2...AUDIT_LAST_USER_MSG2:
1da177e4
LT
373 if (!cap_raised(eff_cap, CAP_AUDIT_WRITE))
374 err = -EPERM;
375 break;
376 default: /* bad msg */
377 err = -EINVAL;
378 }
379
380 return err;
381}
382
383static int audit_receive_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
384{
385 u32 uid, pid, seq;
386 void *data;
387 struct audit_status *status_get, status_set;
388 int err;
c0404993 389 struct audit_buffer *ab;
1da177e4 390 u16 msg_type = nlh->nlmsg_type;
c94c257c 391 uid_t loginuid; /* loginuid of sender */
c2f0c7c3 392 struct audit_sig_info sig_data;
1da177e4
LT
393
394 err = audit_netlink_ok(NETLINK_CB(skb).eff_cap, msg_type);
395 if (err)
396 return err;
397
b0dd25a8
RD
398 /* As soon as there's any sign of userspace auditd,
399 * start kauditd to talk to it */
b7d11258
DW
400 if (!kauditd_task)
401 kauditd_task = kthread_run(kauditd_thread, NULL, "kauditd");
402 if (IS_ERR(kauditd_task)) {
403 err = PTR_ERR(kauditd_task);
404 kauditd_task = NULL;
405 return err;
406 }
407
1da177e4
LT
408 pid = NETLINK_CREDS(skb)->pid;
409 uid = NETLINK_CREDS(skb)->uid;
c94c257c 410 loginuid = NETLINK_CB(skb).loginuid;
1da177e4
LT
411 seq = nlh->nlmsg_seq;
412 data = NLMSG_DATA(nlh);
413
414 switch (msg_type) {
415 case AUDIT_GET:
416 status_set.enabled = audit_enabled;
417 status_set.failure = audit_failure;
418 status_set.pid = audit_pid;
419 status_set.rate_limit = audit_rate_limit;
420 status_set.backlog_limit = audit_backlog_limit;
421 status_set.lost = atomic_read(&audit_lost);
b7d11258 422 status_set.backlog = skb_queue_len(&audit_skb_queue);
1da177e4
LT
423 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_GET, 0, 0,
424 &status_set, sizeof(status_set));
425 break;
426 case AUDIT_SET:
427 if (nlh->nlmsg_len < sizeof(struct audit_status))
428 return -EINVAL;
429 status_get = (struct audit_status *)data;
430 if (status_get->mask & AUDIT_STATUS_ENABLED) {
c94c257c 431 err = audit_set_enabled(status_get->enabled, loginuid);
1da177e4
LT
432 if (err < 0) return err;
433 }
434 if (status_get->mask & AUDIT_STATUS_FAILURE) {
c94c257c 435 err = audit_set_failure(status_get->failure, loginuid);
1da177e4
LT
436 if (err < 0) return err;
437 }
438 if (status_get->mask & AUDIT_STATUS_PID) {
439 int old = audit_pid;
440 audit_pid = status_get->pid;
9ad9ad38 441 audit_log(NULL, GFP_KERNEL, AUDIT_CONFIG_CHANGE,
bccf6ae0 442 "audit_pid=%d old=%d by auid=%u",
c94c257c 443 audit_pid, old, loginuid);
1da177e4
LT
444 }
445 if (status_get->mask & AUDIT_STATUS_RATE_LIMIT)
c94c257c 446 audit_set_rate_limit(status_get->rate_limit, loginuid);
1da177e4 447 if (status_get->mask & AUDIT_STATUS_BACKLOG_LIMIT)
c94c257c
SH
448 audit_set_backlog_limit(status_get->backlog_limit,
449 loginuid);
1da177e4 450 break;
05474106 451 case AUDIT_USER:
209aba03 452 case AUDIT_FIRST_USER_MSG...AUDIT_LAST_USER_MSG:
90d526c0 453 case AUDIT_FIRST_USER_MSG2...AUDIT_LAST_USER_MSG2:
4a4cd633
DW
454 if (!audit_enabled && msg_type != AUDIT_USER_AVC)
455 return 0;
456
5bb289b5 457 err = audit_filter_user(&NETLINK_CB(skb), msg_type);
4a4cd633
DW
458 if (err == 1) {
459 err = 0;
9ad9ad38 460 ab = audit_log_start(NULL, GFP_KERNEL, msg_type);
4a4cd633
DW
461 if (ab) {
462 audit_log_format(ab,
463 "user pid=%d uid=%u auid=%u msg='%.1024s'",
464 pid, uid, loginuid, (char *)data);
465 audit_set_pid(ab, pid);
466 audit_log_end(ab);
467 }
0f45aa18 468 }
1da177e4
LT
469 break;
470 case AUDIT_ADD:
471 case AUDIT_DEL:
472 if (nlh->nlmsg_len < sizeof(struct audit_rule))
473 return -EINVAL;
474 /* fallthrough */
475 case AUDIT_LIST:
1da177e4 476 err = audit_receive_filter(nlh->nlmsg_type, NETLINK_CB(skb).pid,
c94c257c 477 uid, seq, data, loginuid);
1da177e4 478 break;
c2f0c7c3
SG
479 case AUDIT_SIGNAL_INFO:
480 sig_data.uid = audit_sig_uid;
481 sig_data.pid = audit_sig_pid;
482 audit_send_reply(NETLINK_CB(skb).pid, seq, AUDIT_SIGNAL_INFO,
483 0, 0, &sig_data, sizeof(sig_data));
484 break;
1da177e4
LT
485 default:
486 err = -EINVAL;
487 break;
488 }
489
490 return err < 0 ? err : 0;
491}
492
b0dd25a8
RD
493/*
494 * Get message from skb (based on rtnetlink_rcv_skb). Each message is
1da177e4 495 * processed by audit_receive_msg. Malformed skbs with wrong length are
b0dd25a8
RD
496 * discarded silently.
497 */
2a0a6ebe 498static void audit_receive_skb(struct sk_buff *skb)
1da177e4
LT
499{
500 int err;
501 struct nlmsghdr *nlh;
502 u32 rlen;
503
504 while (skb->len >= NLMSG_SPACE(0)) {
505 nlh = (struct nlmsghdr *)skb->data;
506 if (nlh->nlmsg_len < sizeof(*nlh) || skb->len < nlh->nlmsg_len)
2a0a6ebe 507 return;
1da177e4
LT
508 rlen = NLMSG_ALIGN(nlh->nlmsg_len);
509 if (rlen > skb->len)
510 rlen = skb->len;
511 if ((err = audit_receive_msg(skb, nlh))) {
512 netlink_ack(skb, nlh, err);
513 } else if (nlh->nlmsg_flags & NLM_F_ACK)
514 netlink_ack(skb, nlh, 0);
515 skb_pull(skb, rlen);
516 }
1da177e4
LT
517}
518
519/* Receive messages from netlink socket. */
520static void audit_receive(struct sock *sk, int length)
521{
522 struct sk_buff *skb;
2a0a6ebe 523 unsigned int qlen;
1da177e4 524
2a0a6ebe 525 down(&audit_netlink_sem);
1da177e4 526
2a0a6ebe
HX
527 for (qlen = skb_queue_len(&sk->sk_receive_queue); qlen; qlen--) {
528 skb = skb_dequeue(&sk->sk_receive_queue);
529 audit_receive_skb(skb);
530 kfree_skb(skb);
1da177e4
LT
531 }
532 up(&audit_netlink_sem);
533}
534
1da177e4
LT
535
536/* Initialize audit support at boot time. */
537static int __init audit_init(void)
538{
539 printk(KERN_INFO "audit: initializing netlink socket (%s)\n",
540 audit_default ? "enabled" : "disabled");
06628607 541 audit_sock = netlink_kernel_create(NETLINK_AUDIT, 0, audit_receive,
4fdb3bb7 542 THIS_MODULE);
1da177e4
LT
543 if (!audit_sock)
544 audit_panic("cannot initialize netlink socket");
545
b7d11258
DW
546 audit_sock->sk_sndtimeo = MAX_SCHEDULE_TIMEOUT;
547 skb_queue_head_init(&audit_skb_queue);
1da177e4
LT
548 audit_initialized = 1;
549 audit_enabled = audit_default;
9ad9ad38 550 audit_log(NULL, GFP_KERNEL, AUDIT_KERNEL, "initialized");
1da177e4
LT
551 return 0;
552}
1da177e4
LT
553__initcall(audit_init);
554
555/* Process kernel command-line parameter at boot time. audit=0 or audit=1. */
556static int __init audit_enable(char *str)
557{
558 audit_default = !!simple_strtol(str, NULL, 0);
559 printk(KERN_INFO "audit: %s%s\n",
560 audit_default ? "enabled" : "disabled",
561 audit_initialized ? "" : " (after initialization)");
562 if (audit_initialized)
563 audit_enabled = audit_default;
564 return 0;
565}
566
567__setup("audit=", audit_enable);
568
16e1904e
CW
569static void audit_buffer_free(struct audit_buffer *ab)
570{
571 unsigned long flags;
572
8fc6115c
CW
573 if (!ab)
574 return;
575
5ac52f33
CW
576 if (ab->skb)
577 kfree_skb(ab->skb);
b7d11258 578
16e1904e
CW
579 spin_lock_irqsave(&audit_freelist_lock, flags);
580 if (++audit_freelist_count > AUDIT_MAXFREE)
581 kfree(ab);
582 else
583 list_add(&ab->list, &audit_freelist);
584 spin_unlock_irqrestore(&audit_freelist_lock, flags);
585}
586
c0404993 587static struct audit_buffer * audit_buffer_alloc(struct audit_context *ctx,
dd0fc66f 588 gfp_t gfp_mask, int type)
16e1904e
CW
589{
590 unsigned long flags;
591 struct audit_buffer *ab = NULL;
c0404993 592 struct nlmsghdr *nlh;
16e1904e
CW
593
594 spin_lock_irqsave(&audit_freelist_lock, flags);
595 if (!list_empty(&audit_freelist)) {
596 ab = list_entry(audit_freelist.next,
597 struct audit_buffer, list);
598 list_del(&ab->list);
599 --audit_freelist_count;
600 }
601 spin_unlock_irqrestore(&audit_freelist_lock, flags);
602
603 if (!ab) {
4332bdd3 604 ab = kmalloc(sizeof(*ab), gfp_mask);
16e1904e 605 if (!ab)
8fc6115c 606 goto err;
16e1904e 607 }
8fc6115c 608
4332bdd3 609 ab->skb = alloc_skb(AUDIT_BUFSIZ, gfp_mask);
5ac52f33 610 if (!ab->skb)
8fc6115c
CW
611 goto err;
612
b7d11258 613 ab->ctx = ctx;
9ad9ad38 614 ab->gfp_mask = gfp_mask;
c0404993
SG
615 nlh = (struct nlmsghdr *)skb_put(ab->skb, NLMSG_SPACE(0));
616 nlh->nlmsg_type = type;
617 nlh->nlmsg_flags = 0;
618 nlh->nlmsg_pid = 0;
619 nlh->nlmsg_seq = 0;
16e1904e 620 return ab;
8fc6115c
CW
621err:
622 audit_buffer_free(ab);
623 return NULL;
16e1904e 624}
1da177e4 625
b0dd25a8
RD
626/**
627 * audit_serial - compute a serial number for the audit record
628 *
629 * Compute a serial number for the audit record. Audit records are
bfb4496e
DW
630 * written to user-space as soon as they are generated, so a complete
631 * audit record may be written in several pieces. The timestamp of the
632 * record and this serial number are used by the user-space tools to
633 * determine which pieces belong to the same audit record. The
634 * (timestamp,serial) tuple is unique for each syscall and is live from
635 * syscall entry to syscall exit.
636 *
bfb4496e
DW
637 * NOTE: Another possibility is to store the formatted records off the
638 * audit context (for those records that have a context), and emit them
639 * all at syscall exit. However, this could delay the reporting of
640 * significant errors until syscall exit (or never, if the system
b0dd25a8
RD
641 * halts).
642 */
bfb4496e
DW
643unsigned int audit_serial(void)
644{
d5b454f2
DW
645 static spinlock_t serial_lock = SPIN_LOCK_UNLOCKED;
646 static unsigned int serial = 0;
647
648 unsigned long flags;
649 unsigned int ret;
bfb4496e 650
d5b454f2 651 spin_lock_irqsave(&serial_lock, flags);
bfb4496e 652 do {
ce625a80
DW
653 ret = ++serial;
654 } while (unlikely(!ret));
d5b454f2 655 spin_unlock_irqrestore(&serial_lock, flags);
bfb4496e 656
d5b454f2 657 return ret;
bfb4496e
DW
658}
659
660static inline void audit_get_stamp(struct audit_context *ctx,
661 struct timespec *t, unsigned int *serial)
662{
663 if (ctx)
664 auditsc_get_stamp(ctx, t, serial);
665 else {
666 *t = CURRENT_TIME;
667 *serial = audit_serial();
668 }
669}
670
1da177e4
LT
671/* Obtain an audit buffer. This routine does locking to obtain the
672 * audit buffer, but then no locking is required for calls to
673 * audit_log_*format. If the tsk is a task that is currently in a
674 * syscall, then the syscall is marked as auditable and an audit record
675 * will be written at syscall exit. If there is no associated task, tsk
676 * should be NULL. */
9ad9ad38 677
b0dd25a8
RD
678/**
679 * audit_log_start - obtain an audit buffer
680 * @ctx: audit_context (may be NULL)
681 * @gfp_mask: type of allocation
682 * @type: audit message type
683 *
684 * Returns audit_buffer pointer on success or NULL on error.
685 *
686 * Obtain an audit buffer. This routine does locking to obtain the
687 * audit buffer, but then no locking is required for calls to
688 * audit_log_*format. If the task (ctx) is a task that is currently in a
689 * syscall, then the syscall is marked as auditable and an audit record
690 * will be written at syscall exit. If there is no associated task, then
691 * task context (ctx) should be NULL.
692 */
9796fdd8 693struct audit_buffer *audit_log_start(struct audit_context *ctx, gfp_t gfp_mask,
9ad9ad38 694 int type)
1da177e4
LT
695{
696 struct audit_buffer *ab = NULL;
1da177e4 697 struct timespec t;
d812ddbb 698 unsigned int serial;
9ad9ad38 699 int reserve;
ac4cec44 700 unsigned long timeout_start = jiffies;
1da177e4
LT
701
702 if (!audit_initialized)
703 return NULL;
704
c8edc80c
DK
705 if (unlikely(audit_filter_type(type)))
706 return NULL;
707
9ad9ad38
DW
708 if (gfp_mask & __GFP_WAIT)
709 reserve = 0;
710 else
711 reserve = 5; /* Allow atomic callers to go up to five
712 entries over the normal backlog limit */
713
714 while (audit_backlog_limit
715 && skb_queue_len(&audit_skb_queue) > audit_backlog_limit + reserve) {
ac4cec44
DW
716 if (gfp_mask & __GFP_WAIT && audit_backlog_wait_time
717 && time_before(jiffies, timeout_start + audit_backlog_wait_time)) {
718
9ad9ad38
DW
719 /* Wait for auditd to drain the queue a little */
720 DECLARE_WAITQUEUE(wait, current);
721 set_current_state(TASK_INTERRUPTIBLE);
722 add_wait_queue(&audit_backlog_wait, &wait);
723
724 if (audit_backlog_limit &&
725 skb_queue_len(&audit_skb_queue) > audit_backlog_limit)
ac4cec44 726 schedule_timeout(timeout_start + audit_backlog_wait_time - jiffies);
9ad9ad38
DW
727
728 __set_current_state(TASK_RUNNING);
729 remove_wait_queue(&audit_backlog_wait, &wait);
ac4cec44 730 continue;
9ad9ad38 731 }
fb19b4c6
DW
732 if (audit_rate_check())
733 printk(KERN_WARNING
734 "audit: audit_backlog=%d > "
735 "audit_backlog_limit=%d\n",
736 skb_queue_len(&audit_skb_queue),
737 audit_backlog_limit);
738 audit_log_lost("backlog limit exceeded");
ac4cec44
DW
739 audit_backlog_wait_time = audit_backlog_wait_overflow;
740 wake_up(&audit_backlog_wait);
fb19b4c6
DW
741 return NULL;
742 }
743
9ad9ad38 744 ab = audit_buffer_alloc(ctx, gfp_mask, type);
1da177e4
LT
745 if (!ab) {
746 audit_log_lost("out of memory in audit_log_start");
747 return NULL;
748 }
749
bfb4496e 750 audit_get_stamp(ab->ctx, &t, &serial);
197c69c6 751
1da177e4
LT
752 audit_log_format(ab, "audit(%lu.%03lu:%u): ",
753 t.tv_sec, t.tv_nsec/1000000, serial);
754 return ab;
755}
756
8fc6115c 757/**
5ac52f33 758 * audit_expand - expand skb in the audit buffer
8fc6115c 759 * @ab: audit_buffer
b0dd25a8 760 * @extra: space to add at tail of the skb
8fc6115c
CW
761 *
762 * Returns 0 (no space) on failed expansion, or available space if
763 * successful.
764 */
e3b926b4 765static inline int audit_expand(struct audit_buffer *ab, int extra)
8fc6115c 766{
5ac52f33 767 struct sk_buff *skb = ab->skb;
e3b926b4 768 int ret = pskb_expand_head(skb, skb_headroom(skb), extra,
9ad9ad38 769 ab->gfp_mask);
5ac52f33
CW
770 if (ret < 0) {
771 audit_log_lost("out of memory in audit_expand");
8fc6115c 772 return 0;
5ac52f33
CW
773 }
774 return skb_tailroom(skb);
8fc6115c 775}
1da177e4 776
b0dd25a8
RD
777/*
778 * Format an audit message into the audit buffer. If there isn't enough
1da177e4
LT
779 * room in the audit buffer, more room will be allocated and vsnprint
780 * will be called a second time. Currently, we assume that a printk
b0dd25a8
RD
781 * can't format message larger than 1024 bytes, so we don't either.
782 */
1da177e4
LT
783static void audit_log_vformat(struct audit_buffer *ab, const char *fmt,
784 va_list args)
785{
786 int len, avail;
5ac52f33 787 struct sk_buff *skb;
eecb0a73 788 va_list args2;
1da177e4
LT
789
790 if (!ab)
791 return;
792
5ac52f33
CW
793 BUG_ON(!ab->skb);
794 skb = ab->skb;
795 avail = skb_tailroom(skb);
796 if (avail == 0) {
e3b926b4 797 avail = audit_expand(ab, AUDIT_BUFSIZ);
8fc6115c
CW
798 if (!avail)
799 goto out;
1da177e4 800 }
eecb0a73 801 va_copy(args2, args);
5ac52f33 802 len = vsnprintf(skb->tail, avail, fmt, args);
1da177e4
LT
803 if (len >= avail) {
804 /* The printk buffer is 1024 bytes long, so if we get
805 * here and AUDIT_BUFSIZ is at least 1024, then we can
806 * log everything that printk could have logged. */
b0dd25a8
RD
807 avail = audit_expand(ab,
808 max_t(unsigned, AUDIT_BUFSIZ, 1+len-avail));
8fc6115c
CW
809 if (!avail)
810 goto out;
eecb0a73 811 len = vsnprintf(skb->tail, avail, fmt, args2);
1da177e4 812 }
168b7173
SG
813 if (len > 0)
814 skb_put(skb, len);
8fc6115c
CW
815out:
816 return;
1da177e4
LT
817}
818
b0dd25a8
RD
819/**
820 * audit_log_format - format a message into the audit buffer.
821 * @ab: audit_buffer
822 * @fmt: format string
823 * @...: optional parameters matching @fmt string
824 *
825 * All the work is done in audit_log_vformat.
826 */
1da177e4
LT
827void audit_log_format(struct audit_buffer *ab, const char *fmt, ...)
828{
829 va_list args;
830
831 if (!ab)
832 return;
833 va_start(args, fmt);
834 audit_log_vformat(ab, fmt, args);
835 va_end(args);
836}
837
b0dd25a8
RD
838/**
839 * audit_log_hex - convert a buffer to hex and append it to the audit skb
840 * @ab: the audit_buffer
841 * @buf: buffer to convert to hex
842 * @len: length of @buf to be converted
843 *
844 * No return value; failure to expand is silently ignored.
845 *
846 * This function will take the passed buf and convert it into a string of
847 * ascii hex digits. The new string is placed onto the skb.
848 */
849void audit_log_hex(struct audit_buffer *ab, const unsigned char *buf,
168b7173 850 size_t len)
83c7d091 851{
168b7173
SG
852 int i, avail, new_len;
853 unsigned char *ptr;
854 struct sk_buff *skb;
855 static const unsigned char *hex = "0123456789ABCDEF";
856
857 BUG_ON(!ab->skb);
858 skb = ab->skb;
859 avail = skb_tailroom(skb);
860 new_len = len<<1;
861 if (new_len >= avail) {
862 /* Round the buffer request up to the next multiple */
863 new_len = AUDIT_BUFSIZ*(((new_len-avail)/AUDIT_BUFSIZ) + 1);
864 avail = audit_expand(ab, new_len);
865 if (!avail)
866 return;
867 }
83c7d091 868
168b7173
SG
869 ptr = skb->tail;
870 for (i=0; i<len; i++) {
871 *ptr++ = hex[(buf[i] & 0xF0)>>4]; /* Upper nibble */
872 *ptr++ = hex[buf[i] & 0x0F]; /* Lower nibble */
873 }
874 *ptr = 0;
875 skb_put(skb, len << 1); /* new string is twice the old string */
83c7d091
DW
876}
877
b0dd25a8
RD
878/**
879 * audit_log_unstrustedstring - log a string that may contain random characters
880 * @ab: audit_buffer
881 * @string: string to be logged
882 *
883 * This code will escape a string that is passed to it if the string
884 * contains a control character, unprintable character, double quote mark,
168b7173 885 * or a space. Unescaped strings will start and end with a double quote mark.
b0dd25a8
RD
886 * Strings that are escaped are printed in hex (2 digits per char).
887 */
83c7d091
DW
888void audit_log_untrustedstring(struct audit_buffer *ab, const char *string)
889{
81b7854d 890 const unsigned char *p = string;
83c7d091
DW
891
892 while (*p) {
168b7173 893 if (*p == '"' || *p < 0x21 || *p > 0x7f) {
83c7d091
DW
894 audit_log_hex(ab, string, strlen(string));
895 return;
896 }
897 p++;
898 }
899 audit_log_format(ab, "\"%s\"", string);
900}
901
168b7173 902/* This is a helper-function to print the escaped d_path */
1da177e4
LT
903void audit_log_d_path(struct audit_buffer *ab, const char *prefix,
904 struct dentry *dentry, struct vfsmount *vfsmnt)
905{
168b7173 906 char *p, *path;
1da177e4 907
8fc6115c
CW
908 if (prefix)
909 audit_log_format(ab, " %s", prefix);
1da177e4 910
168b7173 911 /* We will allow 11 spaces for ' (deleted)' to be appended */
9ad9ad38 912 path = kmalloc(PATH_MAX+11, ab->gfp_mask);
168b7173
SG
913 if (!path) {
914 audit_log_format(ab, "<no memory>");
915 return;
1da177e4 916 }
168b7173
SG
917 p = d_path(dentry, vfsmnt, path, PATH_MAX+11);
918 if (IS_ERR(p)) { /* Should never happen since we send PATH_MAX */
919 /* FIXME: can we save some information here? */
920 audit_log_format(ab, "<too long>");
921 } else
922 audit_log_untrustedstring(ab, p);
923 kfree(path);
1da177e4
LT
924}
925
b0dd25a8
RD
926/**
927 * audit_log_end - end one audit record
928 * @ab: the audit_buffer
929 *
930 * The netlink_* functions cannot be called inside an irq context, so
931 * the audit buffer is placed on a queue and a tasklet is scheduled to
1da177e4 932 * remove them from the queue outside the irq context. May be called in
b0dd25a8
RD
933 * any context.
934 */
b7d11258 935void audit_log_end(struct audit_buffer *ab)
1da177e4 936{
1da177e4
LT
937 if (!ab)
938 return;
939 if (!audit_rate_check()) {
940 audit_log_lost("rate limit exceeded");
941 } else {
b7d11258
DW
942 if (audit_pid) {
943 struct nlmsghdr *nlh = (struct nlmsghdr *)ab->skb->data;
944 nlh->nlmsg_len = ab->skb->len - NLMSG_SPACE(0);
945 skb_queue_tail(&audit_skb_queue, ab->skb);
946 ab->skb = NULL;
947 wake_up_interruptible(&kauditd_wait);
948 } else {
e1b09eba 949 printk(KERN_NOTICE "%s\n", ab->skb->data + NLMSG_SPACE(0));
b7d11258 950 }
1da177e4 951 }
16e1904e 952 audit_buffer_free(ab);
1da177e4
LT
953}
954
b0dd25a8
RD
955/**
956 * audit_log - Log an audit record
957 * @ctx: audit context
958 * @gfp_mask: type of allocation
959 * @type: audit message type
960 * @fmt: format string to use
961 * @...: variable parameters matching the format string
962 *
963 * This is a convenience function that calls audit_log_start,
964 * audit_log_vformat, and audit_log_end. It may be called
965 * in any context.
966 */
9796fdd8 967void audit_log(struct audit_context *ctx, gfp_t gfp_mask, int type,
9ad9ad38 968 const char *fmt, ...)
1da177e4
LT
969{
970 struct audit_buffer *ab;
971 va_list args;
972
9ad9ad38 973 ab = audit_log_start(ctx, gfp_mask, type);
1da177e4
LT
974 if (ab) {
975 va_start(args, fmt);
976 audit_log_vformat(ab, fmt, args);
977 va_end(args);
978 audit_log_end(ab);
979 }
980}