1.\"-
2.\" Copyright (c) 2005-2006 Robert N. M. Watson
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.\" 1. Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\" notice, this list of conditions and the following disclaimer in the
12.\" documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_event.3#4 $
27.\"
28.Dd April 19, 2005
29.Dt AU_EVENT 3
30.Os
31.Sh NAME
32.Nm free_au_event_ent ,
33.Nm setauevent ,
34.Nm endauevent ,
35.Nm getauevent ,
36.Nm getauevent_r ,
37.Nm getauevnam ,
38.Nm getauevnam_r ,
39.Nm getauevnum ,
40.Nm getauevnum_r ,
41.Nm getauevnonam ,
42.Nm getauevnonam_r ,
43.Nd "Look up information from the audit_event database"
44.Sh LIBRARY
45.Lb libbsm
46.Sh SYNOPSIS
47.In libbsm.h
48.Ft void
49.Fn setauevent "void"
50.Ft void
51.Fn endauevent "void"
52.Ft "struct au_event_ent *"
53.Fn getauevent "void"
54.Ft "struct au_event_ent *"
55.Fn getauevent_r "struct au_event_ent *e"
56.Ft "struct au_event_ent *"
57.Fn getauevnam "char *name"
58.Ft "struct au_event_ent *"
59.Fn getauevnam_r "struct au_event_ent *e" "char *name"
60.Ft "struct au_event_ent *"
61.Fn getauevnum "au_event_t event_number"
62.Ft "struct au_event_ent *"
63.Fn getauevnum_r "struct au_event_ent *e" "au_event_t event_number"
64.Ft "au_event_t *"
65.Fn getauevnonam "char *event_name"
66.Ft "au_event_t *"
67.Fn getauevnonam_r "au_event_t *ev" "char *event_name"
68.Sh DESCRIPTION
69These interfaces may be used to look up information from the
70.Xr audit_event 5
71database, which describes audit events.
72Entries in the database are described by
73.Vt struct au_event_ent
74entries, which are returned by calls to
75.Fn getauevent ,
76.Fn getauevnam ,
77or
78.Fn getauevnum .
79It is also possible look up an event number via a call to
80.Nm getauevnonam .
81.Pp
82.Fn setauevent
83resets the database access session for
84.Xr audit_event 5 ,
85so that the next call to
86.Fn getauevent
87will start with the first entry in the database.
88.Pp
89.Fn endauevent
90closes the
91.Xr audit_event 5
92database session.
93.Pp
94.Fn getauevent
95returns a reference to the next entry in the
96.Xr audit_event 5
97database.
98.Pp
99.Fn getauevnam
100returns a reference to the entry in the
101.Xr audit_event 5
102database with a name of
103.Va name .
104.Pp
105.Fn getauevnum
106returns a reference to the entry in the
107.Xr audit_event 5
108database with an event number of
109.Va event_number .
110.Pp
111.Fn getauevnonam
112returns a reference to an audit event number using the
113.Xr audit_event 5
114database.
115.Sh RETURN VALUES
116Functions
117.Fn getauevent ,
118.Fn getauevent_r ,
119.Fn getauevnam ,
120.Fn getauevnam_r ,
121.Fn getauevnum ,
122.Fn getauevnum_r ,
123and
124.Fn getauevnuam
125will return a reference to a
126.Ft struct au_event_ent
127or
128.Ft au_event_t
129on success, or
130.Dv NULL on failure, with
131.Va errno
132set to provide further error information.
133.Sh SEE ALSO
134.Xr libbsm 3 ,
135.Xr audit_event 5
136.Sh AUTHORS
137This software was created by Robert Watson, Wayne Salamon, and Suresh
138Krishnaswamy for McAfee Research, the security research division of McAfee,
139Inc., under contract to Apple Computer, Inc.
140.Pp
141The Basic Security Module (BSM) interface to audit records and audit event
142stream format were defined by Sun Microsystems.
143.Sh HISTORY
144The OpenBSM implementation was created by McAfee Research, the security
145division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
146It was subsequently adopted by the TrustedBSD Project as the foundation for
147the OpenBSM distribution.
148.Sh BUGS
149.Va errno
150is not always properly set following a failure.
151.Pp
152These routines are thread-safe, but not re-entrant, so simultaneous or
153interleaved use of these functions will affect the iterator.
2.\" Copyright (c) 2005-2006 Robert N. M. Watson
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.\" 1. Redistributions of source code must retain the above copyright
9.\" notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\" notice, this list of conditions and the following disclaimer in the
12.\" documentation and/or other materials provided with the distribution.
13.\"
14.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24.\" SUCH DAMAGE.
25.\"
26.\" $P4: //depot/projects/trustedbsd/openbsm/libbsm/au_event.3#4 $
27.\"
28.Dd April 19, 2005
29.Dt AU_EVENT 3
30.Os
31.Sh NAME
32.Nm free_au_event_ent ,
33.Nm setauevent ,
34.Nm endauevent ,
35.Nm getauevent ,
36.Nm getauevent_r ,
37.Nm getauevnam ,
38.Nm getauevnam_r ,
39.Nm getauevnum ,
40.Nm getauevnum_r ,
41.Nm getauevnonam ,
42.Nm getauevnonam_r ,
43.Nd "Look up information from the audit_event database"
44.Sh LIBRARY
45.Lb libbsm
46.Sh SYNOPSIS
47.In libbsm.h
48.Ft void
49.Fn setauevent "void"
50.Ft void
51.Fn endauevent "void"
52.Ft "struct au_event_ent *"
53.Fn getauevent "void"
54.Ft "struct au_event_ent *"
55.Fn getauevent_r "struct au_event_ent *e"
56.Ft "struct au_event_ent *"
57.Fn getauevnam "char *name"
58.Ft "struct au_event_ent *"
59.Fn getauevnam_r "struct au_event_ent *e" "char *name"
60.Ft "struct au_event_ent *"
61.Fn getauevnum "au_event_t event_number"
62.Ft "struct au_event_ent *"
63.Fn getauevnum_r "struct au_event_ent *e" "au_event_t event_number"
64.Ft "au_event_t *"
65.Fn getauevnonam "char *event_name"
66.Ft "au_event_t *"
67.Fn getauevnonam_r "au_event_t *ev" "char *event_name"
68.Sh DESCRIPTION
69These interfaces may be used to look up information from the
70.Xr audit_event 5
71database, which describes audit events.
72Entries in the database are described by
73.Vt struct au_event_ent
74entries, which are returned by calls to
75.Fn getauevent ,
76.Fn getauevnam ,
77or
78.Fn getauevnum .
79It is also possible look up an event number via a call to
80.Nm getauevnonam .
81.Pp
82.Fn setauevent
83resets the database access session for
84.Xr audit_event 5 ,
85so that the next call to
86.Fn getauevent
87will start with the first entry in the database.
88.Pp
89.Fn endauevent
90closes the
91.Xr audit_event 5
92database session.
93.Pp
94.Fn getauevent
95returns a reference to the next entry in the
96.Xr audit_event 5
97database.
98.Pp
99.Fn getauevnam
100returns a reference to the entry in the
101.Xr audit_event 5
102database with a name of
103.Va name .
104.Pp
105.Fn getauevnum
106returns a reference to the entry in the
107.Xr audit_event 5
108database with an event number of
109.Va event_number .
110.Pp
111.Fn getauevnonam
112returns a reference to an audit event number using the
113.Xr audit_event 5
114database.
115.Sh RETURN VALUES
116Functions
117.Fn getauevent ,
118.Fn getauevent_r ,
119.Fn getauevnam ,
120.Fn getauevnam_r ,
121.Fn getauevnum ,
122.Fn getauevnum_r ,
123and
124.Fn getauevnuam
125will return a reference to a
126.Ft struct au_event_ent
127or
128.Ft au_event_t
129on success, or
130.Dv NULL on failure, with
131.Va errno
132set to provide further error information.
133.Sh SEE ALSO
134.Xr libbsm 3 ,
135.Xr audit_event 5
136.Sh AUTHORS
137This software was created by Robert Watson, Wayne Salamon, and Suresh
138Krishnaswamy for McAfee Research, the security research division of McAfee,
139Inc., under contract to Apple Computer, Inc.
140.Pp
141The Basic Security Module (BSM) interface to audit records and audit event
142stream format were defined by Sun Microsystems.
143.Sh HISTORY
144The OpenBSM implementation was created by McAfee Research, the security
145division of McAfee Inc., under contract to Apple Computer, Inc., in 2004.
146It was subsequently adopted by the TrustedBSD Project as the foundation for
147the OpenBSM distribution.
148.Sh BUGS
149.Va errno
150is not always properly set following a failure.
151.Pp
152These routines are thread-safe, but not re-entrant, so simultaneous or
153interleaved use of these functions will affect the iterator.