xref: /freebsd/contrib/openbsm/bin/auditd/auditd.h (revision d8a0fe102c0cfdfcd5b818f850eff09d8536c9bc)
1 /*-
2  * Copyright (c) 2005-2009 Apple Inc.
3  * All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * 1.  Redistributions of source code must retain the above copyright
10  *     notice, this list of conditions and the following disclaimer.
11  * 2.  Redistributions in binary form must reproduce the above copyright
12  *     notice, this list of conditions and the following disclaimer in the
13  *     documentation and/or other materials provided with the distribution.
14  * 3.  Neither the name of Apple Inc. ("Apple") nor the names of
15  *     its contributors may be used to endorse or promote products derived
16  *     from this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
19  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
22  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
25  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
27  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28  */
29 
30 #ifndef _AUDITD_H_
31 #define	_AUDITD_H_
32 
33 #include <sys/types.h>
34 #include <sys/queue.h>
35 #include <syslog.h>
36 
37 #define	MAX_DIR_SIZE	255
38 #define	AUDITD_NAME	"auditd"
39 
40 /*
41  * If defined, then the audit daemon will attempt to chown newly created logs
42  * to this group.  Otherwise, they will be the default for the user running
43  * auditd, likely the audit group.
44  */
45 #define	AUDIT_REVIEW_GROUP	"audit"
46 
47 #define	HARDLIM_ALL_WARN	"allhard"
48 #define	SOFTLIM_ALL_WARN	"allsoft"
49 #define	AUDITOFF_WARN		"auditoff"
50 #define	CLOSEFILE_WARN		"closefile"
51 #define	EBUSY_WARN		"ebusy"
52 #define	GETACDIR_WARN		"getacdir"
53 #define	HARDLIM_WARN		"hard"
54 #define	NOSTART_WARN		"nostart"
55 #define	POSTSIGTERM_WARN	"postsigterm"
56 #define	SOFTLIM_WARN		"soft"
57 #define	TMPFILE_WARN		"tmpfile"
58 #define	EXPIRED_WARN		"expired"
59 
60 #define	AUDITWARN_SCRIPT	"/etc/security/audit_warn"
61 #define	AUDITD_PIDFILE		"/var/run/auditd.pid"
62 
63 #define	AUD_STATE_INIT		-1
64 #define	AUD_STATE_DISABLED	 0
65 #define	AUD_STATE_ENABLED	 1
66 
67 int	audit_warn_allhard(void);
68 int	audit_warn_allsoft(void);
69 int	audit_warn_auditoff(void);
70 int	audit_warn_closefile(char *filename);
71 int	audit_warn_ebusy(void);
72 int	audit_warn_getacdir(char *filename);
73 int	audit_warn_hard(char *filename);
74 int	audit_warn_nostart(void);
75 int	audit_warn_postsigterm(void);
76 int	audit_warn_soft(char *filename);
77 int	audit_warn_tmpfile(void);
78 int	audit_warn_expired(char *filename);
79 
80 void	auditd_openlog(int debug, gid_t gid);
81 void	auditd_log_err(const char *fmt, ...);
82 void	auditd_log_debug(const char *fmt, ...);
83 void	auditd_log_info(const char *fmt, ...);
84 void	auditd_log_notice(const char *fmt, ...);
85 
86 void	auditd_set_state(int state);
87 int	auditd_get_state(void);
88 
89 int	auditd_open_trigger(int launchd_flag);
90 int	auditd_close_trigger(void);
91 void	auditd_handle_trigger(int trigger);
92 
93 void	auditd_wait_for_events(void);
94 void	auditd_relay_signal(int signal);
95 void	auditd_terminate(void);
96 int	auditd_config_controls(void);
97 void	auditd_reap_children(void);
98 
99 
100 #endif /* !_AUDITD_H_ */
101