xref: /freebsd/contrib/openbsm/man/audit.log.5 (revision bb97b41819ea5a5e5315006cdad6902bfa2b7eb6)
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/man/audit.log.5#10 $
27.\"
28.Dd May 1, 2005
29.Dt AUDIT.LOG 5
30.Os
31.Sh NAME
32.Nm audit
33.Nd "Basic Security Module (BSM) File Format"
34.Sh DESCRIPTION
35The
36.Nm
37file format is based on Sun's Basic Security Module (BSM) file format, a
38token-based record stream to represent system audit data.
39This file format is both flexible and extensible, able to describe a broad
40range of data types, and easily extended to describe new data types in a
41moderately backward and forward compatible way.
42.Pp
43BSM token streams typically begin and end with a
44.Dv file
45token, which provides time stamp and file name information for the stream;
46when processing a BSM token stream from a stream as opposed to a single file
47source, file tokens may be seen at any point between ordinary records
48identifying when particular parts of the stream begin and end.
49All other tokens will appear in the context of a complete BSM audit record,
50which begins with a
51.Dv header
52token, and ends with a
53.Dv trailer
54token, which describe the audit record.
55Between these two tokens will appear a variety of data tokens, such as
56process information, file path names, IPC object information, MAC labels,
57socket information, and so on.
58.Pp
59The BSM file format defines specific token orders for each record event type;
60however, some variation may occur depending on the operating system in use,
61what system options, such as mandatory access control, are present.
62.Pp
63This manual page documents the common token types and their binary format, and
64is intended for reference purposes only.
65It is recommended that application programmers use the
66.Xr libbsm 3
67interface to read and write tokens, rather than parsing or constructing
68records by hand.
69.Ss File Token
70The
71.Dv file
72token is used at the beginning and end of an audit log file to indicate
73when the audit log begins and ends.
74It includes a pathname so that, if concatenated together, original file
75boundaries are still observable, and gaps in the audit log can be identified.
76A
77.Dv file
78token can be created using
79.Xr au_to_file 3 .
80.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
81.It Sy "Field" Ta Sy Bytes Ta Sy Description
82.It Li "Token ID" Ta "1 byte" Ta "Token ID"
83.It Li "Seconds" Ta "4 bytes" Ta "File time stamp"
84.It Li "Microseconds" Ta "4 bytes" Ta "File time stamp"
85.It Li "File name lengh" Ta "2 bytes" Ta "File name of audit trail"
86.It Li "File pathname" Ta "N bytes + 1 nul" Ta "File name of audit trail"
87.El
88.Ss Header Token
89The
90.Dv header
91token is used to mark the beginning of a complete audit record, and includes
92the length of the total record in bytes, a version number for the record
93layout, the event type and subtype, and the time at which the event occurred.
94A 32-bit
95.Dv header
96token can be created using
97.Xr au_to_header32 3 ;
98a 64-bit
99.Dv header
100token can be created using
101.Xr au_to_header64 3 .
102.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
103.It Sy "Field" Ta Sy Bytes Ta Sy Description
104.It Li "Token ID" Ta "1 byte" Ta "Token ID"
105.It Li "Record Byte Count" Ta "4 bytes" Ta "Number of bytes in record"
106.It Li "Version Number" Ta "2 bytes" Ta "Record version number"
107.It Li "Event Type" Ta "2 bytes" Ta "Event type"
108.It Li "Event Modifier" Ta "2 bytes" Ta "Event sub-type"
109.It Li "Seconds" Ta "4/8 bytes" Ta "Record time stamp (32/64-bits)"
110.It Li "Nanoseconds" Ta "4/8 byets" Ta "Record time stamp (32/64-bits)"
111.El
112.Ss Expanded Header Token
113The
114.Dv expanded header
115token is an expanded version of the
116.Dv header
117token, with the addition of a machine IPv4 or IPv6 address.
118A 32-bit extended
119.Dv header
120token can be created using
121.Xr au_to_header32_ex 3 ;
122a 64-bit extended
123.Dv header
124token can be created using
125.Xr au_to_header64_ex 3 .
126.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
127.It Sy "Field" Ta Sy Bytes Ta Sy Description
128.It Li "Token ID" Ta "1 byte" Ta "Token ID"
129.It Li "Record Byte Count" Ta "4 bytes" Ta "Number of bytes in record"
130.It Li "Version Number" Ta "2 bytes" Ta "Record version number"
131.It Li "Event Type" Ta "2 bytes" Ta "Event type"
132.It Li "Event Modifier" Ta "2 bytes" Ta "Event sub-type"
133.It Li "Address Type/Length" Ta "1 byte" Ta "Host address type and length"
134.It Li "Machine Address" Ta "4/16 bytes" Ta "IPv4 or IPv6 address"
135.It Li "Seconds" Ta "4/8 bytes" Ta "Record time stamp (32/64-bits)"
136.It Li "Nanoseconds" Ta "4/8 byets" Ta "Record time stamp (32/64-bits)"
137.El
138.Ss Trailer Token
139The
140.Dv trailer
141terminates a BSM audit record, and contains a magic number,
142.Dv TRAILER_PAD_MAGIC
143and length that can be used to validate that the record was read properly.
144A
145.Dv trailer
146token can be created using
147.Xr au_to_trailer 3 .
148.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
149.It Sy "Field" Ta Sy Bytes Ta Sy Description
150.It Li "Token ID" Ta "1 byte" Ta "Token ID"
151.It Li "Trailer Magic" Ta "2 bytes" Ta "Trailer magic number"
152.It Li "Record Byte Count" Ta "4 bytes" Ta "Number of bytes in record"
153.El
154.Ss Arbitrary Data Token
155The
156.Dv arbitrary data
157token contains a byte stream of opaque (untyped) data.
158The size of the data is calculated as the size of each unit of data
159multipled by the number of units of data.
160A
161.Dv How to print
162field is present to specify how to print the data, but interpretation of
163that field is not currently defined.
164An
165.Dv arbitrary data
166token can be created using
167.Xr au_to_data 3 .
168.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
169.It Sy "Field" Ta Sy Bytes Ta Sy Description
170.It Li "Token ID" Ta "1 byte" Ta "Token ID"
171.It Li "How to Print" Ta "1 byte" Ta "User-defined printing information"
172.It Li "Basic Unit" Ta "1 byte" Ta "Size of a unit in bytes"
173.It Li "Unit Count" Ta "1 byte" Ta "Number of units of data present"
174.It Li "Data Items" Ta "Variable" Ta "User data"
175.El
176.Ss in_addr Token
177The
178.Dv in_addr
179token holds a network byte order IPv4 or IPv6 address.
180An
181.Dv in_addr
182token can be created using
183.Xr au_to_in_addr 3
184for an IPv4 address, or
185.Xr au_to_in_addr_ex 3
186for an IPv6 address.
187.Pp
188See the BUGS section for information on the storage of this token.
189.Pp
190.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
191.It Sy "Field" Ta Sy Bytes Ta Sy Description
192.It Li "Token ID" Ta "1 byte" Ta "Token ID"
193.It Li "IP Address Type" Ta "1 byte" Ta "Type of address"
194.It Li "IP Address" Ta "4/16 bytes" Ta "IPv4 or IPv6 address"
195.El
196.Ss Expanded in_addr Token
197The
198.Dv expanded in_addr
199token ...
200.Pp
201See the BUGS section for information on the storage of this token.
202.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
203.It Sy "Field" Ta Sy Bytes Ta Sy Description
204.It Li "Token ID" Ta "1 byte" Ta "Token ID"
205.It XXXX
206.El
207.Ss ip Token
208The
209.Dv ip
210token contains an IP packet header in network byte order.
211An
212.Dv ip
213token can be created using
214.Xr au_to_ip 3 .
215.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
216.It Sy "Field" Ta Sy Bytes Ta Sy Description
217.It Li "Token ID" Ta "1 byte" Ta "Token ID"
218.It Li "Version and IHL" Ta "1 byte" Ta "Version and IP header length"
219.It Li "Type of Service" Ta "1 byte" Ta "IP TOS field"
220.It Li "Length" Ta "2 bytes" Ta "IP packet length in network byte order"
221.It Li "ID" Ta "2 bytes" Ta "IP header ID for reassembly"
222.It Li "Offset" Ta "2 bytes" Ta "IP fragment offset and flags, network byte order"
223.It Li "TTL" Ta "1 byte" Ta "IP Time-to-Live"
224.It Li "Protocol" Ta "1 byte" Ta "IP protocol number"
225.It Li "Checksum" Ta "2 bytes" Ta "IP header checksum, network byte order"
226.It Li "Source Address" Ta "4 bytes" Ta "IPv4 source address"
227.It Li "Destination Address" Ta "4 bytes" Ta "IPv4 destination address"
228.El
229.Ss Expanded ip Token
230The
231.Dv expanded ip
232token ...
233.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
234.It Sy "Field" Ta Sy Bytes Ta Sy Description
235.It Li "Token ID" Ta "1 byte" Ta "Token ID"
236.It XXXX
237.El
238.Ss iport Token
239The
240.Dv iport
241token stores an IP port number in network byte order.
242An
243.Dv iport
244token can be created using
245.Xr au_to_iport 3 .
246.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
247.It Sy "Field" Ta Sy Bytes Ta Sy Description
248.It Li "Token ID" Ta "1 byte" Ta "Token ID"
249.It Li "Port Number" Ta "2 bytes" Ta "Port number in network byte order"
250.El
251.Ss Path Token
252The
253.Dv path
254token contains a pathname.
255A
256.Dv path
257token can be created using
258.Xr au_to_path 3 .
259.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
260.It Sy "Field" Ta Sy Bytes Ta Sy Description
261.It Li "Token ID" Ta "1 byte" Ta "Token ID"
262.It Li "Path Length" Ta "2 bytes" Ta "Length of path in bytes"
263.It Li "Path" Ta "N bytes + 1 nul" Ta "Path name"
264.El
265.Ss path_attr Token
266The
267.Dv path_attr
268token contains a set of nul-terminated path names.
269The
270.Xr libbsm 3
271API cannot currently create a
272.Dv path_attr
273token.
274.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
275.It Sy "Field" Ta Sy Bytes Ta Sy Description
276.It Li "Token ID" Ta "1 byte" Ta "Token ID"
277.It Li "Count" Ta "2 bytes" Ta "Number of nul-terminated string(s) in token"
278.It Li "Path" Ta "Variable" Ta "count nul-terminated string(s)"
279.El
280.Ss Process Token
281The
282.Dv process
283token contains a description of the security properties of a process
284involved as the target of an auditable event, such as the destination for
285signal delivery.
286It should not be confused with the
287.Dv subject
288token, which describes the subject performing an auditable event.
289This includes both the traditional
290.Ux
291security properties, such as user IDs and group IDs, but also audit
292information such as the audit user ID and session.
293A
294.Dv process
295token can be created using
296.Xr au_to_process32 3
297or
298.Xr au_to_process64 3 .
299.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
300.It Sy "Field" Ta Sy Bytes Ta Sy Description
301.It Li "Token ID" Ta "1 byte" Ta "Token ID"
302.It Li "Audit ID" Ta "4 bytes" Ta "Audit user ID"
303.It Li "Effective User ID" Ta "4 bytes" Ta "Effective user ID"
304.It Li "Effective Group ID "Ta "4 bytes" Ta "Effective group ID"
305.It Li "Real User ID" Ta "4 bytes" Ta "Real user ID"
306.It Li "Real Group ID" Ta "4 bytes" Ta "Real group ID"
307.It Li "Process ID" Ta "4 bytes" Ta "Process ID"
308.It Li "Session ID" Ta "4 bytes" Ta "Audit session ID"
309.It Li "Terminal Port ID" Ta "4/8 bytes" Ta "Terminal port ID (32/64-bits)"
310.It Li "Terminal Machine Address" Ta "4 bytes" Ta "IP address of machine"
311.El
312.Ss Expanded Process Token
313The
314.Dv expanded process
315token contains the contents of the
316.Dv process
317token, with the addition of a machine address type and variable length
318address storage capable of containing IPv6 addresses.
319An
320.Dv expanded process
321token can be created using
322.Xr au_to_process32_ex 3
323or
324.Xr au_to_process64_ex 3 .
325.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
326.It Sy "Field" Ta Sy Bytes Ta Sy Description
327.It Li "Token ID" Ta "1 byte" Ta "Token ID"
328.It Li "Audit ID" Ta "4 bytes" Ta "Audit user ID"
329.It Li "Effective User ID" Ta "4 bytes" Ta "Effective user ID"
330.It Li "Effective Group ID "Ta "4 bytes" Ta "Effective group ID"
331.It Li "Real User ID" Ta "4 bytes" Ta "Real user ID"
332.It Li "Real Group ID" Ta "4 bytes" Ta "Real group ID"
333.It Li "Process ID" Ta "4 bytes" Ta "Process ID"
334.It Li "Session ID" Ta "4 bytes" Ta "Audit session ID"
335.It Li "Terminal Port ID" Ta "4/8 bytes" Ta "Terminal port ID (32/64-bits)"
336.It Li "Terminal Address Type/Length" Ta "1 byte" "Length of machine address"
337.It Li "Terminal Machine Address" Ta "4 bytes" Ta "IPv4 or IPv6 address of machine"
338.El
339.Ss Return Token
340The
341.Dv return
342token contains a system call or library function return condition, including
343return value and error number associated with the global variable
344.Er errno .
345A
346.Dv return
347token can be created using
348.Xr au_to_return32 3
349or
350.Xr au_to_return64 3 .
351.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
352.It Sy "Field" Ta Sy Bytes Ta Sy Description
353.It Li "Token ID" Ta "1 byte" Ta "Token ID"
354.It Li "Error Number" Ta "1 byte" Ta "Errno value, or 0 if undefined"
355.It Li "Return Value" Ta "4/8 bytes" Ta "Return value (32/64-bits)"
356.El
357.Ss Subject Token
358The
359.Dv subject
360token contains information on the subject performing the operation described
361by an audit record, and includes similar information to that found in the
362.Dv process
363and
364.Dv expanded process
365tokens.
366However, those tokens are used where the process being described is the
367target of the operation, not the authorizing party.
368A
369.Dv subject
370token can be created using
371.Xr au_to_subject32 3
372and
373.Xr au_to_subject64 3 .
374.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
375.It Sy "Field" Ta Sy Bytes Ta Sy Description
376.It Li "Token ID" Ta "1 byte" Ta "Token ID"
377.It Li "Audit ID" Ta "4 bytes" Ta "Audit user ID"
378.It Li "Effective User ID" Ta "4 bytes" Ta "Effective user ID"
379.It Li "Effective Group ID "Ta "4 bytes" Ta "Effective group ID"
380.It Li "Real User ID" Ta "4 bytes" Ta "Real user ID"
381.It Li "Real Group ID" Ta "4 bytes" Ta "Real group ID"
382.It Li "Process ID" Ta "4 bytes" Ta "Process ID"
383.It Li "Session ID" Ta "4 bytes" Ta "Audit session ID"
384.It Li "Terminal Port ID" Ta "4/8 bytes" Ta "Terminal port ID (32/64-bits)"
385.It Li "Terminal Machine Address" Ta "4 bytes" Ta "IP address of machine"
386.El
387.Ss Expanded Subject Token
388The
389.Dv expanded subject
390token consists of the same elements as the
391.Dv subject
392token, with the addition of type/length and variable size machine address
393information in the terminal ID.
394An
395.Dv expanded subject
396token can be created using
397.Xr au_to_subject32_ex 3
398or
399.Xr au_to_subject64_ex 3 .
400.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
401.It Sy "Field" Ta Sy Bytes Ta Sy Description
402.It Li "Token ID" Ta "1 byte" Ta "Token ID"
403.It Li "Audit ID" Ta "4 bytes" Ta "Audit user ID"
404.It Li "Effective User ID" Ta "4 bytes" Ta "Effective user ID"
405.It Li "Effective Group ID "Ta "4 bytes" Ta "Effective group ID"
406.It Li "Real User ID" Ta "4 bytes" Ta "Real user ID"
407.It Li "Real Group ID" Ta "4 bytes" Ta "Real group ID"
408.It Li "Process ID" Ta "4 bytes" Ta "Process ID"
409.It Li "Session ID" Ta "4 bytes" Ta "Audit session ID"
410.It Li "Terminal Port ID" Ta "4/8 bytes" Ta "Terminal port ID (32/64-bits)"
411.It Li "Terminal Address Type/Length" Ta "1 byte" "Length of machine address"
412.It Li "Terminal Machine Address" Ta "4 bytes" Ta "IPv4 or IPv6 address of machine"
413.El
414.Ss System V IPC Token
415The
416.Dv System V IPC
417token ...
418.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
419.It Sy "Field" Ta Sy Bytes Ta Sy Description
420.It Li "Token ID" Ta "1 byte" Ta "Token ID"
421.It Li "Object ID type" Ta "1 byte" Ta "Object ID"
422.It Li "Object ID" Ta "4 bytes" Ta "Object ID"
423.El
424.Ss Text Token
425The
426.Dv text
427token contains a single nul-terminated text string.
428A
429.Dv text
430token may be created using
431.Xr au_to_text 3 .
432.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
433.It Sy "Field" Ta Sy Bytes Ta Sy Description
434.It Li "Token ID" Ta "1 byte" Ta "Token ID"
435.It Li "Text Length" Ta "2 bytes" Ta "Length of text string including nul"
436.It Li "Text" Ta "N bytes + 1 nul" Ta "Text string including nul"
437.El
438.Ss Attribute Token
439The
440.Dv attribute
441token describes the attributes of a file associated with the audit event.
442As files may be identified by 0, 1, or many path names, a path name is not
443included with the attribute block for a file; optional
444.Dv path
445tokens may also be present in an audit record indicating which path, if any,
446was used to reach the object.
447An
448.Dv attribute
449token can be created using
450.Xr au_to_attr32 3
451or
452.Xr au_to_attr64 3 .
453.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
454.It Sy "Field" Ta Sy Bytes Ta Sy Description
455.It Li "Token ID" Ta "1 byte" Ta "Token ID"
456.It Li "File Access Mode" Ta "1 byte" Ta "mode_t associated with file"
457.It Li "Owner User ID" Ta "4 bytes" Ta "uid_t associated with file"
458.It Li "Owner Group ID" Ta "4 bytes" Ta "gid_t associated with file"
459.It Li "File System ID" Ta "4 bytes" Ta "fsid_t associated with file"
460.It Li "File System Node ID" Ta "8 bytes" Ta "ino_t associated with file"
461.It Li "Device" Ta "4/8 bytes" Ta "Device major/minor number (32/64-bit)"
462.El
463.Ss Groups Token
464The
465.Dv groups
466token contains a list of group IDs associated with the audit event.
467A
468.Dv groups
469token can be created using
470.Xr au_to_groups 3 .
471.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
472.It Sy "Field" Ta Sy Bytes Ta Sy Description
473.It Li "Token ID" Ta "1 byte" Ta "Token ID"
474.It Li "Number of Groups" Ta "2 bytes" Ta "Number of groups in token"
475.It Li "Group List" Ta "N * 4 bytes" Ta "List of N group IDs"
476.El
477.Ss System V IPC Permission Token
478The
479.Dv System V IPC permission
480token ...
481.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
482.It Sy "Field" Ta Sy Bytes Ta Sy Description
483.It Li "Token ID" Ta "1 byte" Ta "Token ID"
484.It Li XXXXX
485.El
486.Ss Arg Token
487The
488.Dv arg
489token ...
490.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
491.It Sy "Field" Ta Sy Bytes Ta Sy Description
492.It Li "Token ID" Ta "1 byte" Ta "Token ID"
493.It Li XXXXX
494.El
495.Ss exec_args Token
496The
497.Dv exec_args
498token ...
499.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
500.It Sy "Field" Ta Sy Bytes Ta Sy Description
501.It Li "Token ID" Ta "1 byte" Ta "Token ID"
502.It Li XXXXX
503.El
504.Ss exec_env Token
505The
506.Dv exec_env
507token ...
508.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
509.It Sy "Field" Ta Sy Bytes Ta Sy Description
510.It Li "Token ID" Ta "1 byte" Ta "Token ID"
511.It Li XXXXX
512.El
513.Ss Exit Token
514The
515.Dv exit
516token contains process exit/return code information.
517An
518.Dv exit
519token can be created using
520.Xr au_to_exit 3 .
521.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
522.It Sy "Field" Ta Sy Bytes Ta Sy Description
523.It Li "Token ID" Ta "1 byte" Ta "Token ID"
524.It Li "Status" Ta "4 bytes" Ta "Process status on exit"
525.It Li "Return Value" ta "4 bytes" Ta "Process return value on exit"
526.El
527.Ss Socket Token
528The
529.Dv socket
530token ...
531.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
532.It Sy "Field" Ta Sy Bytes Ta Sy Description
533.It Li "Token ID" Ta "1 byte" Ta "Token ID"
534.It Li XXXXX
535.El
536.Ss Expanded Socket Token
537The
538.Dv expanded socket
539token ...
540.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
541.It Sy "Field" Ta Sy Bytes Ta Sy Description
542.It Li "Token ID" Ta "1 byte" Ta "Token ID"
543.It Li XXXXX
544.El
545.Ss Seq Token
546The
547.Dv seq
548token contains a unique and monotonically increasing audit event sequence ID.
549Due to the limited range of 32 bits, serial number arithmetic and caution
550should be used when comparing sequence numbers.
551.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
552.It Sy "Field" Ta Sy Bytes Ta Sy Description
553.It Li "Token ID" Ta "1 byte" Ta "Token ID"
554.It Li "Sequence Number" Ta "4 bytes" Ta "Audit event sequence number"
555.El
556.Ss privilege Token
557The
558.Dv privilege
559token ...
560.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
561.It Sy "Field" Ta Sy Bytes Ta Sy Description
562.It Li "Token ID" Ta "1 byte" Ta "Token ID"
563.It Li XXXXX
564.El
565.Ss Use-of-auth Token
566The
567.Dv use-of-auth
568token ...
569.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
570.It Sy "Field" Ta Sy Bytes Ta Sy Description
571.It Li "Token ID" Ta "1 byte" Ta "Token ID"
572.It Li XXXXX
573.El
574.Ss Command Token
575The
576.Dv command
577token ...
578.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
579.It Sy "Field" Ta Sy Bytes Ta Sy Description
580.It Li "Token ID" Ta "1 byte" Ta "Token ID"
581.It Li XXXXX
582.El
583.Ss ACL Token
584The
585.Dv ACL
586token ...
587.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
588.It Sy "Field" Ta Sy Bytes Ta Sy Description
589.It Li "Token ID" Ta "1 byte" Ta "Token ID"
590.It Li XXXXX
591.El
592.Ss Zonename Token
593The
594.Dv zonename
595token ...
596.Bl -column -offset ind ".Sy Field Name Width XX" ".Sy XX Bytes XXXX" ".Sy Description"
597.It Sy "Field" Ta Sy Bytes Ta Sy Description
598.It Li "Token ID" Ta "1 byte" Ta "Token ID"
599.It Li XXXXX
600.El
601.Sh SEE ALSO
602.Xr libbsm 3 ,
603.Xr audit 8
604.Sh AUTHORS
605The Basic Security Module (BSM) interface to audit records and audit event
606stream format were defined by Sun Microsystems.
607.Pp
608This manual page was written by
609.An Robert Watson Aq rwatson@FreeBSD.org .
610.Sh HISTORY
611The OpenBSM implementation was created by McAfee Research, the security
612division of McAfee Inc., under contract to Apple Computer Inc. in 2004.
613It was subsequently adopted by the TrustedBSD Project as the foundation for
614the OpenBSM distribution.
615.Sh BUGS
616The
617.Dv How to print
618field in the
619.Dv arbitrary data
620token has undefined values.
621.Pp
622The
623.Dv in_addr
624and
625.Dv in_addr_ex
626token layout documented here appears to be in conflict with the
627.Xr libbsm 3
628implementations of
629.Xr au_to_in_addr 3
630and
631.Xr au_to_in_addr_ex 3 .
632