2 * Copyright (c) 2004 Apple Inc.
3 * Copyright (c) 2005 SPARTA, Inc.
6 * This code was developed in part by Robert N. M. Watson, Senior Principal
7 * Scientist, SPARTA, Inc.
9 * Redistribution and use in source and binary forms, with or without
10 * modification, are permitted provided that the following conditions
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 * 2. Redistributions in binary form must reproduce the above copyright
15 * notice, this list of conditions and the following disclaimer in the
16 * documentation and/or other materials provided with the distribution.
17 * 3. Neither the name of Apple Computer, Inc. ("Apple") nor the names of
18 * its contributors may be used to endorse or promote products derived
19 * from this software without specific prior written permission.
21 * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND
22 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
23 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
24 * ARE DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR
25 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
26 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
27 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
28 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
29 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
30 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
31 * POSSIBILITY OF SUCH DAMAGE.
33 * $P4: //depot/projects/trustedbsd/openbsm/libbsm/bsm_audit.c#31 $
36 #include <sys/types.h>
38 #include <config/config.h>
39 #ifdef HAVE_FULL_QUEUE_H
40 #include <sys/queue.h>
42 #include <compat/queue.h>
45 #include <bsm/audit_internal.h>
46 #include <bsm/libbsm.h>
48 #include <netinet/in.h>
55 /* array of used descriptors */
56 static au_record_t *open_desc_table[MAX_AUDIT_RECORDS];
58 /* The current number of active record descriptors */
59 static int audit_rec_count = 0;
62 * Records that can be recycled are maintained in the list given below. The
63 * maximum number of elements that can be present in this list is bounded by
64 * MAX_AUDIT_RECORDS. Memory allocated for these records are never freed.
66 static LIST_HEAD(, au_record) audit_free_q;
68 static pthread_mutex_t mutex = PTHREAD_MUTEX_INITIALIZER;
71 * This call frees a token_t and its internal data.
74 au_free_token(token_t *tok)
85 * This call reserves memory for the audit record. Memory must be guaranteed
86 * before any auditable event can be generated. The au_record_t structure
87 * maintains a reference to the memory allocated above and also the list of
88 * tokens associated with this record. Descriptors are recyled once the
89 * records are added to the audit trail following au_close().
94 au_record_t *rec = NULL;
96 pthread_mutex_lock(&mutex);
98 if (audit_rec_count == 0)
99 LIST_INIT(&audit_free_q);
102 * Find an unused descriptor, remove it from the free list, mark as
105 if (!LIST_EMPTY(&audit_free_q)) {
106 rec = LIST_FIRST(&audit_free_q);
108 LIST_REMOVE(rec, au_rec_q);
111 pthread_mutex_unlock(&mutex);
115 * Create a new au_record_t if no descriptors are available.
117 rec = malloc (sizeof(au_record_t));
121 rec->data = malloc (MAX_AUDIT_RECORD_SIZE * sizeof(u_char));
122 if (rec->data == NULL) {
128 pthread_mutex_lock(&mutex);
130 if (audit_rec_count == MAX_AUDIT_RECORDS) {
131 pthread_mutex_unlock(&mutex);
135 /* XXX We need to increase size of MAX_AUDIT_RECORDS */
139 rec->desc = audit_rec_count;
140 open_desc_table[audit_rec_count] = rec;
143 pthread_mutex_unlock(&mutex);
147 memset(rec->data, 0, MAX_AUDIT_RECORD_SIZE);
149 TAILQ_INIT(&rec->token_q);
157 * Store the token with the record descriptor.
159 * Don't permit writing more to the buffer than would let the trailer be
163 au_write(int d, token_t *tok)
169 return (-1); /* Invalid Token */
172 /* Write the token to the record descriptor */
173 rec = open_desc_table[d];
174 if ((rec == NULL) || (rec->used == 0)) {
176 return (-1); /* Invalid descriptor */
179 if (rec->len + tok->len + AUDIT_TRAILER_SIZE > MAX_AUDIT_RECORD_SIZE) {
184 /* Add the token to the tail */
186 * XXX Not locking here -- we should not be writing to
187 * XXX the same descriptor from different threads
189 TAILQ_INSERT_TAIL(&rec->token_q, tok, tokens);
191 rec->len += tok->len; /* grow record length by token size bytes */
193 /* Token should not be available after this call */
195 return (0); /* Success */
199 * Assemble an audit record out of its tokens, including allocating header and
200 * trailer tokens. Does not free the token chain, which must be done by the
201 * caller if desirable.
203 * XXX: Assumes there is sufficient space for the header and trailer.
206 au_assemble(au_record_t *rec, short event)
208 token_t *header, *tok, *trailer;
209 size_t tot_rec_size, hdrsize;
211 struct in6_addr *aptr;
213 struct auditinfo_addr aia;
216 #ifdef HAVE_AUDIT_SYSCALLS
218 * Grab the size of the address family stored in the kernel's audit
221 aia.ai_termid.at_type = AU_IPv4;
222 aia.ai_termid.at_addr[0] = INADDR_ANY;
223 if (auditon(A_GETKAUDIT, &aia, sizeof(aia)) < 0) {
226 #endif /* HAVE_AUDIT_SYSCALLS */
227 tot_rec_size = rec->len + AUDIT_HEADER_SIZE +
229 header = au_to_header(tot_rec_size, event, 0);
230 #ifdef HAVE_AUDIT_SYSCALLS
232 if (gettimeofday(&tm, NULL) < 0)
234 switch (aia.ai_termid.at_type) {
236 hdrsize = (aia.ai_termid.at_addr[0] == INADDR_ANY) ?
237 AUDIT_HEADER_SIZE : AUDIT_HEADER_EX_SIZE(&aia);
240 aptr = (struct in6_addr *)&aia.ai_termid.at_addr[0];
242 (IN6_IS_ADDR_UNSPECIFIED(aptr)) ?
243 AUDIT_HEADER_SIZE : AUDIT_HEADER_EX_SIZE(&aia);
246 tot_rec_size = rec->len + hdrsize + AUDIT_TRAILER_SIZE;
248 * A header size greater then AUDIT_HEADER_SIZE means
249 * that we are using an extended header.
251 if (hdrsize > AUDIT_HEADER_SIZE)
252 header = au_to_header32_ex_tm(tot_rec_size, event,
255 header = au_to_header(tot_rec_size, event, 0);
257 #endif /* HAVE_AUDIT_SYSCALLS */
261 trailer = au_to_trailer(tot_rec_size);
262 if (trailer == NULL) {
264 au_free_token(header);
269 TAILQ_INSERT_HEAD(&rec->token_q, header, tokens);
270 TAILQ_INSERT_TAIL(&rec->token_q, trailer, tokens);
272 rec->len = tot_rec_size;
275 TAILQ_FOREACH(tok, &rec->token_q, tokens) {
276 memcpy(dptr, tok->t_data, tok->len);
284 * Given a record that is no longer of interest, tear it down and convert to a
288 au_teardown(au_record_t *rec)
292 /* Free the token list */
293 while ((tok = TAILQ_FIRST(&rec->token_q)) != NULL) {
294 TAILQ_REMOVE(&rec->token_q, tok, tokens);
302 pthread_mutex_lock(&mutex);
304 /* Add the record to the freelist tail */
305 LIST_INSERT_HEAD(&audit_free_q, rec, au_rec_q);
307 pthread_mutex_unlock(&mutex);
310 #ifdef HAVE_AUDIT_SYSCALLS
312 * Add the header token, identify any missing tokens. Write out the tokens to
313 * the record memory and finally, call audit.
316 au_close(int d, int keep, short event)
322 rec = open_desc_table[d];
323 if ((rec == NULL) || (rec->used == 0)) {
325 return (-1); /* Invalid descriptor */
328 if (keep == AU_TO_NO_WRITE) {
333 tot_rec_size = rec->len + MAX_AUDIT_HEADER_SIZE + AUDIT_TRAILER_SIZE;
335 if (tot_rec_size > MAX_AUDIT_RECORD_SIZE) {
337 * XXXRW: Since au_write() is supposed to prevent this, spew
340 fprintf(stderr, "au_close failed");
346 if (au_assemble(rec, event) < 0) {
348 * XXXRW: This is also not supposed to happen, but might if we
349 * are unable to allocate header and trailer memory.
355 /* Call the kernel interface to audit */
356 retval = audit(rec->data, rec->len);
363 #endif /* HAVE_AUDIT_SYSCALLS */
366 * au_close(), except onto an in-memory buffer. Buffer size as an argument,
367 * record size returned via same argument on success.
370 au_close_buffer(int d, short event, u_char *buffer, size_t *buflen)
376 rec = open_desc_table[d];
377 if ((rec == NULL) || (rec->used == 0)) {
383 tot_rec_size = rec->len + MAX_AUDIT_HEADER_SIZE + AUDIT_TRAILER_SIZE;
384 if ((tot_rec_size > MAX_AUDIT_RECORD_SIZE) ||
385 (tot_rec_size > *buflen)) {
387 * XXXRW: See au_close() comment.
389 fprintf(stderr, "au_close_buffer failed %zd", tot_rec_size);
395 if (au_assemble(rec, event) < 0) {
396 /* XXXRW: See au_close() comment. */
401 memcpy(buffer, rec->data, rec->len);
410 * au_close_token() returns the byte format of a token_t. This won't
411 * generally be used by applications, but is quite useful for writing test
412 * tools. Will free the token on either success or failure.
415 au_close_token(token_t *tok, u_char *buffer, size_t *buflen)
418 if (tok->len > *buflen) {
424 memcpy(buffer, tok->t_data, tok->len);