BSM event auditing file format

Summary

Document information

Author(s):	Joachim Metz <joachim.metz@gmail.com>
Abstract:	BSM event auditing file format
Classification:	Public
Keywords:	BSM, OpenBSM

License

Copyright (C) 2016-2021, Joachim Metz <joachim.metz@gmail.com>.
Permission is granted to copy, distribute and/or modify this document under the
terms of the GNU Free Documentation License, Version 1.3 or any later version
published by the Free Software Foundation; with no Invariant Sections, no
Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included
in the section entitled "GNU Free Documentation License".

Revision history

Version	Author	Date	Comments
0.0.1	J.B. Metz	December 2016	Initial version.
0.0.2	J.B. Metz	June 2018	Additional changes.
0.0.3	J.B. Metz	August 2018	Additional information about AUT_GROUPS and AUT_NEWGROUPS.
0.0.4	J.B. Metz	July 2021	Changes to formatting.

1. Overview

TODO: complete documentation

One or more audit events
Header token (AUT_HEADER32, AUT_HEADER32_EX, AUT_HEADER64, AUT_HEADER64_EX)
Zero or more content tokens
Trailer token (AUT_TRAILER)

Characteristics	Description
Byte order	big-endian
Date and time values
Character strings

1.1. Token

Offset	Size	Value	Description
0	1		Token type See section: Token types
1	…		Token data

1.2. Token types

Value	Identifier	Description
0x00	AUT_INVALID

0x11	AU_FILE_TOKEN AUT_OTHER_FILE AUT_OTHER_FILE32	Control token type
0x12	AUT_OHEADER	Control token type
0x13	AU_HEADER_32_TOKEN AUT_TRAILER
0x14	AU_HEADER_32_TOKEN AUT_HEADER AUT_HEADER32
0x15	AU_HEADER_EX_32_TOKEN AUT_HEADER32_EX

0x21	AU_DATA_TOKEN AU_ARB_TOKEN AUT_DATA
0x22	AU_IPC_TOKEN AUT_IPC
0x23	AU_PATH_TOKEN AUT_PATH
0x24	AU_SUBJECT_32_TOKEN AUT_SUBJECT AUT_SUBJECT32
0x25	AUT_XATPATH
0x26	AU_PROCESS_32_TOKEN AUT_PROCESS AUT_PROCESS32
0x27	AU_RETURN_32_TOKEN AUT_RETURN AUT_RETURN32
0x28	AU_TEXT_TOKEN AUT_TEXT
0x29	AU_OPAQUE_TOKEN AUT_OPAQUE
0x2a	AU_IN_ADDR_TOKEN AUT_IN_ADDR
0x2b	AU_IP_TOKEN AUT_IP
0x2c	AU_IPORT_TOKEN AUT_IPORT
0x2d	AU_ARG32_TOKEN AUT_ARG AUT_ARG32
0x2e	AU_SOCK_TOKEN AUT_SOCKET
0x2f	AU_SEQ_TOKEN AUT_SEQ
0x30	AUT_ACL	Modifier token type
0x31	AU_ATTR_TOKEN AUT_ATTR
0x32	AU_IPCPERM_TOKEN AUT_IPC_PERM
0x33	AUT_LABEL	Modifier token type
0x34	AUT_GROUPS	Modifier token type
0x35	AUT_ILABEL AUT_ACE	Modifier token type
0x36	AUT_SLABEL	Modifier token type
0x37	AUT_CLEAR	Modifier token type
0x38	AUT_PRIV	Modifier token type
0x39	AUT_UPRIV	Modifier token type
0x3a	AUT_LIAISON	Modifier token type
0x3b	AU_NEWGROUP_TOKENS AUT_NEWGROUPS
0x3c	AU_EXEC_ARG_TOKEN AUT_EXEC_ARGS
0x3d	AU_EXEC_ENV_TOKEN AUT_EXEC_ENV
0x3e	AU_ATTR32_TOKEN AUT_ATTR32
0x3f	AUT_UNAUTH
0x40	AUT_XATOM
0x41	AUT_XOBJ
0x42	AUT_XPROTO
0x43	AUT_XSELECT
0x44	AUT_XCOLORMAP
0x45	AUT_XCURSOR
0x46	AUT_XFONT
0x47	AUT_XGC
0x48	AUT_XPIXMAP
0x49	AUT_XPROPERTY
0x4a	AUT_XWINDOW
0x4b	AUT_XCLIENT

0x51	AUT_CMD	Command token type
0x52	AUT_EXIT	Command token type

0x60	AUT_ZONENAME

0x70	AUT_HOST
0x71	AU_ARG64_TOKEN AUT_ARG64
0x72	AU_RETURN_64_TOKEN AUT_RETURN64
0x73	AU_ATTR64_TOKEN AUT_ATTR64
0x74	AU_HEADER_64_TOKEN AUT_HEADER64
0x75	AU_SUBJECT_64_TOKEN AUT_SUBJECT64
0x76	AUT_SERVER64
0x77	AU_PROCESS_64_TOKEN AUT_PROCESS64
0x78	AUT_OTHER_FILE64
0x79	AU_HEADER_EX_64_TOKEN AUT_HEADER64_EX	Extended network address token type
0x7a	AU_SUBJECT_32_EX_TOKEN AUT_SUBJECT32_EX	Extended network address token type
0x7b	AU_PROCESS_32_EX_TOKEN AUT_PROCESS32_EX	Extended network address token type
0x7c	AU_SUBJECT_64_EX_TOKEN AUT_SUBJECT64_EX	Extended network address token type
0x7d	AU_PROCESS_64_EX_TOKEN AUT_PROCESS64_EX	Extended network address token type
0x7e	AU_IN_ADDR_EX_TOKEN AUT_IN_ADDR_EX	Extended network address token type
0x7f	AU_SOCK_EX32_TOKEN AUT_SOCKET_EX	Extended network address token type
Not defined by BSM
0x80	AU_SOCK_INET_32_TOKEN AUT_SOCKINET32
0x81	AU_SOCK_INET_128_TOKEN AUT_SOCKINET128
0x82	AU_SOCK_UNIX_TOKEN AUT_SOCKUNIX

/*
 * Data token types
#define AUT_SERVER              ((char)0x25)
#define AUT_SERVER32            AUT_SERVER
 */

1.3. AUT_OTHER_FILE32 token

Offset	Size	Value	Description
0	1	0x11	Token type See section: Token types
1	4		Timestamp Contains a POSIX timestamp in seconds
5	4		Number of microseconds
9	2		Filename size
11	…		Filename Contain a string with an end-of-string character

1.4. AUT_OHEADER token

Offset	Size	Value	Description
0	1	0x2d	Token type See section: Token types
1	…		Unknown

1.5. AUT_TRAILER token

Offset	Size	Value	Description
0	1	0x13	Token type See section: Token types
1	2	0xb105	Signature
3	4		Record size Data size of the event record

1.6. AUT_HEADER32 token

Offset	Size	Value	Description
0	1	0x14	Token type See section: Token types
1	4		Record size Data size of the event record
5	1		Format version See section: Format versions
6	2		Event type See section: Event types
8	2		Modifier
10	4		Timestamp Contains a POSIX timestamp in seconds
14	4		Number of microseconds

1.7. AUT_HEADER32_EX token

Offset	Size	Value	Description
0	1	0x15	Token type See section: Token types
1	4		Record size Data size of the event record
5	1		Format version See section: Format versions
6	2		Event type See section: Event types
8	2		Modifier
10	4	4 or 16	Net type See section: Net types
If net type == AU_IPv4 (4)
14	4		IPv4 address Contains a packed IPv4 address
If net type == AU_IPv6 (16)
14	16		IPv6 address Contains a packed IPv6 address
Common
…	4		Timestamp Contains a POSIX timestamp in seconds
…	4		Number of microseconds

1.8. AUT_DATA token

Offset	Size	Value	Description
0	1	0x21	Token type See section: Token types
1	1		Data format (unit_print) See section: Data formats
2	1		Element data type (unit_type) See section: Data types
3	1		Number of elements (unit_count)

1.9. AUT_IPC token

Offset	Size	Value	Description
0	1	0x22	Token type See section: Token types
1	1		IPC object type See section: IPC object types
2	4		IPC object identifier

1.10. AUT_PATH token

Offset	Size	Value	Description
0	1	0x23	Token type See section: Token types
1	2		Path size
3	…		Path Contain a string with an end-of-string character

1.11. AUT_SUBJECT32 token

Offset	Size	Value	Description
0	1	0x24	Token type See section: Token types
1	4		Audit user identifier (UID) Contains a signed integer, where -1 respresents TODO
5	4		Effective user identifier (UID) Contains a signed integer
9	4		Effective group identifier (GID) Contains a signed integer
13	4		Real user identifier (UID) Contains a signed integer
17	4		Real group identifier (GID) Contains a signed integer
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	4		Terminal port
33	4		IPv4 address Contains a packed IPv4 address

1.12. AUT_XATPATH token

Offset	Size	Value	Description
0	1	0x25	Token type See section: Token types
1	…		Unknown

1.13. AUT_PROCESS32 token

Offset	Size	Value	Description
0	1	0x26	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	4		Terminal port
33	4		IPv4 address Contains a packed IPv4 address

Note	The AUT_PROCESS32 and AUT_SUBJECT32 token data are similar.

1.14. AUT_RETURN32 token

Offset	Size	Value	Description
0	1	0x27	Token type See section: Token types
1	1		Unknown (Status?)
2	4		Return value Contains a signed integer

1.15. AUT_TEXT token

Offset	Size	Value	Description
0	1	0x28	Token type See section: Token types
1	2		Text size
3	…		Text Contain a string with an end-of-string character

1.16. AUT_OPAQUE token

Offset	Size	Value	Description
0	1	0x29	Token type See section: Token types
1	2		Data size
3	…		Data

1.17. AUT_IN_ADDR token

Offset	Size	Value	Description
0	1	0x2a	Token type See section: Token types
1	4		IPv4 address Contains a packed IPv4 address

1.18. AUT_IP token

Offset	Size	Value	Description
0	1	0x2b	Token type See section: Token types
IP packet header
1	12		Unknown (struct ip)
13	4		Source IPv4 address Contains a packed IPv4 address
17	4		Destination IPv4 address Contains a packed IPv4 address

struct ip {
	u_char	ip_v:4,			/* version */
		ip_hl:4;		/* header length */
	u_char	ip_tos;			/* type of service */
	short	ip_len;			/* total length */
	u_short	ip_id;			/* identification */
	short	ip_off;			/* fragment offset field */
#define	IP_DF 0x4000			/* dont fragment flag */
#define	IP_MF 0x2000			/* more fragments flag */
	u_char	ip_ttl;			/* time to live */
	u_char	ip_p;			/* protocol */
	u_short	ip_sum;			/* checksum */
	struct	in_addr ip_src,ip_dst;	/* source and dest address */
};

1.19. AUT_IPORT token

Offset	Size	Value	Description
0	1	0x2c	Token type See section: Token types
1	2		Port number

1.20. AUT_ARG32 token

Offset	Size	Value	Description
0	1	0x2d	Token type See section: Token types
1	1		Argument index
2	4		Argument name
6	2		Argument value size
8	…		Argument value Contains a string with an end-of-string character

1.21. AUT_SOCKET token

Offset	Size	Value	Description
0	1	0x2e	Token type See section: Token types
1	…		Unknown

token_t *au_to_socket(struct socket *so);
https://github.com/apple/darwin-xnu/blob/master/bsd/sys/socketvar.h#L151

1.22. AUT_SEQ token

Offset	Size	Value	Description
0	1	0x2f	Token type See section: Token types
1	4		Sequence number (audit count)

1.23. AUT_ACL token

Offset	Size	Value	Description
0	1	0x30	Token type See section: Token types
1	…		Unknown

1.24. AUT_ATTR token

Offset	Size	Value	Description
0	1	0x31	Token type See section: Token types
1	…		Unknown

1.25. AUT_IPC_PERM token

Offset	Size	Value	Description
0	1	0x32	Token type See section: Token types
1	4		User identifier (UID)
5	4		Group identifier (GID)
9	4		Creator user identifier (UID)
13	4		Creator group identifier (GID)
17	2		Unknown (padding?)
19	2		Access mode
21	2		Unknown (padding?)
23	2		Slot sequence number
25	2		Unknown (padding?)
27	2		Key

1.26. AUT_LABEL token

Offset	Size	Value	Description
0	1	0x33	Token type See section: Token types
1	…		Unknown

1.27. AUT_GROUPS token

Offset	Size	Value	Description
0	1	0x33	Token type See section: Token types
1	4		Number of groups
5	number of groups x 4		Array of group identifiers

1.28. AUT_ACE token

Offset	Size	Value	Description
0	1	0x35	Token type See section: Token types
1	…		Unknown

1.29. AUT_PRIV token

Offset	Size	Value	Description
0	1	0x38	Token type See section: Token types
1	…		Unknown

1.30. AUT_UPRIV token

Offset	Size	Value	Description
0	1	0x39	Token type See section: Token types
1	…		Unknown

1.31. AUT_LIAISON token

Offset	Size	Value	Description
0	1	0x3a	Token type See section: Token types
1	…		Unknown

1.32. AUT_NEWGROUPS token

Offset	Size	Value	Description
0	1	0x3b	Token type See section: Token types
1	4		Number of groups
5	number of groups x 4		Array of group identifiers

1.33. AUT_EXEC_ARGS token

Offset	Size	Value	Description
0	1	0x3c	Token type See section: Token types
1	4		Number of arguments
5	…		Array of argument strings Contains strings with an end-of-string character

1.34. AUT_EXEC_ENV token

Offset	Size	Value	Description
0	1	0x3d	Token type See section: Token types
1	4		Number of environment variables
5	…		Array of environment variable strings Contains strings with an end-of-string character

1.35. AUT_ATTR32 token

Offset	Size	Value	Description
0	1	0x3e	Token type See section: Token types
1	2		Unknown (padding?)
3	2		File mode
5	4		User identifier (UID)
9	4		Group identifier (GID)
13	4		File system identifier
17	8		File identifier (HFS catalog node identifier)
25	4		Device

1.36. AUT_UNAUTH token

Offset	Size	Value	Description
0	1	0x3f	Token type See section: Token types
1	…		Unknown

1.37. AUT_XATOM token

Offset	Size	Value	Description
0	1	0x40	Token type See section: Token types
1	…		Unknown

1.38. AUT_XOBJ token

Offset	Size	Value	Description
0	1	0x41	Token type See section: Token types
1	…		Unknown

1.39. AUT_XPROTO token

Offset	Size	Value	Description
0	1	0x42	Token type See section: Token types
1	…		Unknown

1.40. AUT_XSELECT token

Offset	Size	Value	Description
0	1	0x43	Token type See section: Token types
1	…		Unknown

1.41. AUT_XCOLORMAP token

Offset	Size	Value	Description
0	1	0x44	Token type See section: Token types
1	…		Unknown

1.42. AUT_XCURSOR token

Offset	Size	Value	Description
0	1	0x45	Token type See section: Token types
1	…		Unknown

1.43. AUT_XFONT token

Offset	Size	Value	Description
0	1	0x46	Token type See section: Token types
1	…		Unknown

1.44. AUT_XGC token

Offset	Size	Value	Description
0	1	0x47	Token type See section: Token types
1	…		Unknown

1.45. AUT_XPIXMAP token

Offset	Size	Value	Description
0	1	0x48	Token type See section: Token types
1	…		Unknown

1.46. AUT_XPROPERTY token

Offset	Size	Value	Description
0	1	0x49	Token type See section: Token types
1	…		Unknown

1.47. AUT_XWINDOW token

Offset	Size	Value	Description
0	1	0x4a	Token type See section: Token types
1	…		Unknown

1.48. AUT_XCLIENT token

Offset	Size	Value	Description
0	1	0x4b	Token type See section: Token types
1	…		Unknown

1.49. AUT_CMD token

Offset	Size	Value	Description
0	1	0x51	Token type See section: Token types
1	…		Unknown

1.50. AUT_EXIT token

Offset	Size	Value	Description
0	1	0x72	Token type See section: Token types
1	4		Error (status)
5	4		Return value Contains a signed integer

TODO error related to BSM_ERRORS

1.51. AUT_ZONENAME token

Offset	Size	Value	Description
0	1	0x60	Token type See section: Token types
1	2		Time zone name size
3	…		Time zone name

1.52. AUT_HOST token

Offset	Size	Value	Description
0	1	0x70	Token type See section: Token types
1	…		Unknown

1.53. AUT_ARG64 token

Offset	Size	Value	Description
0	1	0x71	Token type See section: Token types
1	1		Argument index
2	8		Argument name
10	2		Argument value size
12	…		Argument value Contains a string with an end-of-string character

1.54. AUT_RETURN64 token

Offset	Size	Value	Description
0	1	0x72	Token type See section: Token types
1	1		Unknown (Status?)
2	8		Return value Contains a signed integer

1.55. AUT_ATTR64 token

Offset	Size	Value	Description
0	1	0x73	Token type See section: Token types
1	2		Unknown (padding?)
3	2		File mode
5	4		User identifier (UID)
9	4		Group identifier (GID)
13	4		File system identifier
17	8		File identifier
25	8		Device

1.56. AUT_HEADER64 token

Offset	Size	Value	Description
0	1	0x74	Token type See section: Token types
1	4		Size
5	1		Format version See section: Format versions
6	2		Event type See section: Event types
8	2		Modifier
10	8		Timestamp Contains a POSIX timestamp in seconds
18	8		Number of microseconds

1.57. AUT_SUBJECT64 token

Offset	Size	Value	Description
0	1	0x75	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	8		Terminal port
37	4		IPv4 address Contains a packed IPv4 address

1.58. AUT_PROCESS64 token

Offset	Size	Value	Description
0	1	0x77	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	8		Terminal port
37	4		IPv4 address Contains a packed IPv4 address

Note	The AUT_PROCESS64 and AUT_SUBJECT64 token data are similar.

1.59. AUT_OTHER_FILE64 token

Offset	Size	Value	Description
0	1	0x78	Token type See section: Token types
1	…		Unknown

1.60. AUT_HEADER64_EX token

Offset	Size	Value	Description
0	1	0x79	Token type See section: Token types
1	4		Record size Data size of the event record
5	1		Format version See section: Format versions
6	2		Event type See section: Event types
8	2		Modifier
10	4	4 or 16	Net type See section: Net types
If net type == AU_IPv4 (4)
14	4		IPv4 address Contains a packed IPv4 address
If net type == AU_IPv6 (16)
14	16		IPv6 address Contains a packed IPv6 address
Common
…	8		Timestamp Contains a POSIX timestamp in seconds
…	8		Number of microseconds

1.61. AUT_SUBJECT32_EX token

Offset	Size	Value	Description
0	1	0x7a	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	4		Terminal port (at_port)
33	4	4 or 16	Net type (at_type) See section: Net types
If net type == AU_IPv4 (4)
37	4		IPv4 address (at_addr) Contains a packed IPv4 address
If net type == AU_IPv6 (16)
37	16		IPv6 address Contains a packed IPv6 address

1.62. AUT_PROCESS32_EX token

Offset	Size	Value	Description
0	1	0x7b	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	4		Terminal port (at_port)
33	4	4 or 16	Net type (at_type) See section: Net types
If net type == AU_IPv4 (4)
37	4		IPv4 address (at_addr) Contains a packed IPv4 address
If net type == AU_IPv6 (16)
37	16		IPv6 address Contains a packed IPv6 address

Note	The AUT_PROCESS32_EX and AUT_SUBJECT32_EX token data are similar.

1.63. AUT_SUBJECT64_EX token

Offset	Size	Value	Description
0	1	0x7c	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	8		Terminal port (at_port)
37	4	4 or 16	Net type (at_type) See section: Net types
If net type == AU_IPv4 (4)
41	4		IPv4 address (at_addr) Contains a packed IPv4 address
If net type == AU_IPv6 (16)
41	16		IPv6 address Contains a packed IPv6 address

1.64. AUT_PROCESS64_EX token

Offset	Size	Value	Description
0	1	0x7d	Token type See section: Token types
1	4		Audit user identifier (UID)
5	4		Effective user identifier (UID)
9	4		Effective group identifier (GID)
13	4		Real user identifier (UID)
17	4		Real group identifier (GID)
21	4		Process identifier (PID)
25	4		Audit session identifier (ASID)
29	8		Terminal port (at_port)
37	4	4 or 16	Net type (at_type) See section: Net types
If net type == AU_IPv4 (4)
41	4		IPv4 address (at_addr) Contains a packed IPv4 address
If net type == AU_IPv6 (16)
41	16		IPv6 address Contains a packed IPv6 address

Note	The AUT_PROCESS64_EX and AUT_SUBJECT64_EX token data are similar.

1.65. AUT_IN_ADDR_EX token

Offset	Size	Value	Description
0	1	0x7e	Token type See section: Token types
1	4		Net type See section: Net types
5	16		IP address Contains a packed IPv4 or IPv6 address

1.66. AUT_SOCKET_EX token

Offset	Size	Value	Description
0	1	0x7f	Token type See section: Token types
1	2		Socket domain (Address family)
3	2		Socket type
If socket domain == AF_INET (2)
5	2	4	Net type (at_type) See section: Net types
7	2		Local port
9	4		Local IPv4 address Contains a packed IPv4 address
13	2		Remote port
15	4		Remote IPv4 address Contains a packed IPv4 address
If socket domain == AF_INET6 (10)
5	2	16	Net type (at_type) See section: Net types
7	2		Local port
9	16		Local IPv6 address Contains a packed IPv6 address
25	2		Remote port
27	16		Remote IPv6 address Contains a packed IPv6 address

1.67. AUT_SOCKINET32 token

Offset	Size	Value	Description
0	1	0x80	Token type See section: Token types
1	2		Socket family
3	2		Local port
5	4		Local IPv4 address Contains a packed IPv4 address

1.68. AUT_SOCKINET128 token

Offset	Size	Value	Description
0	1	0x81	Token type See section: Token types
1	2		Socket family
3	2		Local port number
5	16		Local IPv6 address Contains a packed IPv6 address

1.69. AUT_SOCKUNIX token

Offset	Size	Value	Description
0	1	0x82	Token type See section: Token types
1	2		Socket family
3	…		Socket path Contains a string with an end-of-string character The maximum path string size is 105 bytes

1.70. Format versions

Value	Identifier	Description
1	AUDIT_HEADER_VERSION_OLDDARWIN	Old Darwin
2	AUDIT_HEADER_VERSION_SOLARIS	Solaris
3	AUDIT_HEADER_VERSION_TSOL25
4	AUDIT_HEADER_VERSION_TSOL

10	AUDIT_HEADER_VERSION_OPENBSM10	OpenBSM 1.0
11	AUDIT_HEADER_VERSION_OPENBSM11	OpenBSM 1.1

1.71. Data types

Value	Identifier	Description
0	AUR_BYTE AUR_CHAR	Data type element is 1 byte in size
1	AUR_SHORT	Data type element is 2 bytes in size
2	AUR_INT AUR_INT32	Data type element is 4 bytes in size
3	AUR_LONG AUR_INT64	Data type element is 8 bytes in size

1.72. Data formats

Value	Identifier	Description
0	AUP_BINARY	Data is formatted as binary
1	AUP_OCTAL	Data is formatted as an octal integer
2	AUP_DECIMAL	Data is formatted as a decimal integer
3	AUP_HEX	Data is formatted as an hexadecimal integer
4	AUP_STRING	Data is formatted as a string

1.73. Event types

/etc/security/audit_event

1.74. IPC object types

1.75. Socket types

#define	BSM_SOCK_DGRAM		1
#define	BSM_SOCK_STREAM		2
#define	BSM_SOCK_RAW		4
#define	BSM_SOCK_RDM		5
#define	BSM_SOCK_SEQPACKET	6

#define	BSM_SOCK_UNKNOWN	500

1.76. Net types

Value	Identifier	Description
4	AU_IPv4	IPv4
16	AU_IPv6	IPv6

Appendix A: References

[OPENBSM]

Title:	OpenBSM project
URL:	https://github.com/openbsm/openbsm

Title:	Apple BSM audit record
URL:	https://opensource.apple.com/source/xnu/xnu-517.9.5/bsd/bsm/audit_record.h

Title:	OpenBSM audit record
URL:	http://web.mit.edu/freebsd/head/contrib/openbsm/sys/bsm/audit_internal.h http://web.mit.edu/freebsd/head/contrib/openbsm/sys/bsm/audit_record.h

Title:	BSD audit record
URL:	https://github.com/clemensg/xnu/blob/master/bsd/security/audit/audit_bsm_token.c

Appendix B: GNU Free Documentation License

Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

0. PREAMBLE

The purpose of this License is to make a manual, textbook, or other functional and useful document "free" in the sense of freedom: to assure everyone the effective freedom to copy and redistribute it, with or without modifying it, either commercially or noncommercially. Secondarily, this License preserves for the author and publisher a way to get credit for their work, while not being considered responsible for modifications made by others.

This License is a kind of "copyleft", which means that derivative works of the document must themselves be free in the same sense. It complements the GNU General Public License, which is a copyleft license designed for free software.

We have designed this License in order to use it for manuals for free software, because free software needs free documentation: a free program should come with manuals providing the same freedoms that the software does. But this License is not limited to software manuals; it can be used for any textual work, regardless of subject matter or whether it is published as a printed book. We recommend this License principally for works whose purpose is instruction or reference.

1. APPLICABILITY AND DEFINITIONS

This License applies to any manual or other work, in any medium, that contains a notice placed by the copyright holder saying it can be distributed under the terms of this License. Such a notice grants a world-wide, royalty-free license, unlimited in duration, to use that work under the conditions stated herein. The "Document", below, refers to any such manual or work. Any member of the public is a licensee, and is addressed as "you". You accept the license if you copy, modify or distribute the work in a way requiring permission under copyright law.

A "Modified Version" of the Document means any work containing the Document or a portion of it, either copied verbatim, or with modifications and/or translated into another language.

A "Secondary Section" is a named appendix or a front-matter section of the Document that deals exclusively with the relationship of the publishers or authors of the Document to the Document’s overall subject (or to related matters) and contains nothing that could fall directly within that overall subject. (Thus, if the Document is in part a textbook of mathematics, a Secondary Section may not explain any mathematics.) The relationship could be a matter of historical connection with the subject or with related matters, or of legal, commercial, philosophical, ethical or political position regarding them.

The "Invariant Sections" are certain Secondary Sections whose titles are designated, as being those of Invariant Sections, in the notice that says that the Document is released under this License. If a section does not fit the above definition of Secondary then it is not allowed to be designated as Invariant. The Document may contain zero Invariant Sections. If the Document does not identify any Invariant Sections then there are none.

The "Cover Texts" are certain short passages of text that are listed, as Front-Cover Texts or Back-Cover Texts, in the notice that says that the Document is released under this License. A Front-Cover Text may be at most 5 words, and a Back-Cover Text may be at most 25 words.

A "Transparent" copy of the Document means a machine-readable copy, represented in a format whose specification is available to the general public, that is suitable for revising the document straightforwardly with generic text editors or (for images composed of pixels) generic paint programs or (for drawings) some widely available drawing editor, and that is suitable for input to text formatters or for automatic translation to a variety of formats suitable for input to text formatters. A copy made in an otherwise Transparent file format whose markup, or absence of markup, has been arranged to thwart or discourage subsequent modification by readers is not Transparent. An image format is not Transparent if used for any substantial amount of text. A copy that is not "Transparent" is called "Opaque".

Examples of suitable formats for Transparent copies include plain ASCII without markup, Texinfo input format, LaTeX input format, SGML or XML using a publicly available DTD, and standard-conforming simple HTML, PostScript or PDF designed for human modification. Examples of transparent image formats include PNG, XCF and JPG. Opaque formats include proprietary formats that can be read and edited only by proprietary word processors, SGML or XML for which the DTD and/or processing tools are not generally available, and the machine-generated HTML, PostScript or PDF produced by some word processors for output purposes only.

The "Title Page" means, for a printed book, the title page itself, plus such following pages as are needed to hold, legibly, the material this License requires to appear in the title page. For works in formats which do not have any title page as such, "Title Page" means the text near the most prominent appearance of the work’s title, preceding the beginning of the body of the text.

The "publisher" means any person or entity that distributes copies of the Document to the public.

A section "Entitled XYZ" means a named subunit of the Document whose title either is precisely XYZ or contains XYZ in parentheses following text that translates XYZ in another language. (Here XYZ stands for a specific section name mentioned below, such as "Acknowledgements", "Dedications", "Endorsements", or "History".) To "Preserve the Title" of such a section when you modify the Document means that it remains a section "Entitled XYZ" according to this definition.

The Document may include Warranty Disclaimers next to the notice which states that this License applies to the Document. These Warranty Disclaimers are considered to be included by reference in this License, but only as regards disclaiming warranties: any other implication that these Warranty Disclaimers may have is void and has no effect on the meaning of this License.

2. VERBATIM COPYING

You may copy and distribute the Document in any medium, either commercially or noncommercially, provided that this License, the copyright notices, and the license notice saying this License applies to the Document are reproduced in all copies, and that you add no other conditions whatsoever to those of this License. You may not use technical measures to obstruct or control the reading or further copying of the copies you make or distribute. However, you may accept compensation in exchange for copies. If you distribute a large enough number of copies you must also follow the conditions in section 3.

You may also lend copies, under the same conditions stated above, and you may publicly display copies.

3. COPYING IN QUANTITY

If you publish printed copies (or copies in media that commonly have printed covers) of the Document, numbering more than 100, and the Document’s license notice requires Cover Texts, you must enclose the copies in covers that carry, clearly and legibly, all these Cover Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on the back cover. Both covers must also clearly and legibly identify you as the publisher of these copies. The front cover must present the full title with all words of the title equally prominent and visible. You may add other material on the covers in addition. Copying with changes limited to the covers, as long as they preserve the title of the Document and satisfy these conditions, can be treated as verbatim copying in other respects.

If the required texts for either cover are too voluminous to fit legibly, you should put the first ones listed (as many as fit reasonably) on the actual cover, and continue the rest onto adjacent pages.

If you publish or distribute Opaque copies of the Document numbering more than 100, you must either include a machine-readable Transparent copy along with each Opaque copy, or state in or with each Opaque copy a computer-network location from which the general network-using public has access to download using public-standard network protocols a complete Transparent copy of the Document, free of added material. If you use the latter option, you must take reasonably prudent steps, when you begin distribution of Opaque copies in quantity, to ensure that this Transparent copy will remain thus accessible at the stated location until at least one year after the last time you distribute an Opaque copy (directly or through your agents or retailers) of that edition to the public.

It is requested, but not required, that you contact the authors of the Document well before redistributing any large number of copies, to give them a chance to provide you with an updated version of the Document.

4. MODIFICATIONS

You may copy and distribute a Modified Version of the Document under the conditions of sections 2 and 3 above, provided that you release the Modified Version under precisely this License, with the Modified Version filling the role of the Document, thus licensing distribution and modification of the Modified Version to whoever possesses a copy of it. In addition, you must do these things in the Modified Version:

Use in the Title Page (and on the covers, if any) a title distinct from that of the Document, and from those of previous versions (which should, if there were any, be listed in the History section of the Document). You may use the same title as a previous version if the original publisher of that version gives permission.
List on the Title Page, as authors, one or more persons or entities responsible for authorship of the modifications in the Modified Version, together with at least five of the principal authors of the Document (all of its principal authors, if it has fewer than five), unless they release you from this requirement.
State on the Title page the name of the publisher of the Modified Version, as the publisher.
Preserve all the copyright notices of the Document.
Add an appropriate copyright notice for your modifications adjacent to the other copyright notices.
Include, immediately after the copyright notices, a license notice giving the public permission to use the Modified Version under the terms of this License, in the form shown in the Addendum below.
Preserve in that license notice the full lists of Invariant Sections and required Cover Texts given in the Document’s license notice.
Include an unaltered copy of this License.
Preserve the section Entitled "History", Preserve its Title, and add to it an item stating at least the title, year, new authors, and publisher of the Modified Version as given on the Title Page. If there is no section Entitled "History" in the Document, create one stating the title, year, authors, and publisher of the Document as given on its Title Page, then add an item describing the Modified Version as stated in the previous sentence.
Preserve the network location, if any, given in the Document for public access to a Transparent copy of the Document, and likewise the network locations given in the Document for previous versions it was based on. These may be placed in the "History" section. You may omit a network location for a work that was published at least four years before the Document itself, or if the original publisher of the version it refers to gives permission.
For any section Entitled "Acknowledgements" or "Dedications", Preserve the Title of the section, and preserve in the section all the substance and tone of each of the contributor acknowledgements and/or dedications given therein.
Preserve all the Invariant Sections of the Document, unaltered in their text and in their titles. Section numbers or the equivalent are not considered part of the section titles.
Delete any section Entitled "Endorsements". Such a section may not be included in the Modified Version.
Do not retitle any existing section to be Entitled "Endorsements" or to conflict in title with any Invariant Section.
Preserve any Warranty Disclaimers.

If the Modified Version includes new front-matter sections or appendices that qualify as Secondary Sections and contain no material copied from the Document, you may at your option designate some or all of these sections as invariant. To do this, add their titles to the list of Invariant Sections in the Modified Version’s license notice. These titles must be distinct from any other section titles.

You may add a section Entitled "Endorsements", provided it contains nothing but endorsements of your Modified Version by various parties—for example, statements of peer review or that the text has been approved by an organization as the authoritative definition of a standard.

You may add a passage of up to five words as a Front-Cover Text, and a passage of up to 25 words as a Back-Cover Text, to the end of the list of Cover Texts in the Modified Version. Only one passage of Front-Cover Text and one of Back-Cover Text may be added by (or through arrangements made by) any one entity. If the Document already includes a cover text for the same cover, previously added by you or by arrangement made by the same entity you are acting on behalf of, you may not add another; but you may replace the old one, on explicit permission from the previous publisher that added the old one.

The author(s) and publisher(s) of the Document do not by this License give permission to use their names for publicity for or to assert or imply endorsement of any Modified Version.

5. COMBINING DOCUMENTS

You may combine the Document with other documents released under this License, under the terms defined in section 4 above for modified versions, provided that you include in the combination all of the Invariant Sections of all of the original documents, unmodified, and list them all as Invariant Sections of your combined work in its license notice, and that you preserve all their Warranty Disclaimers.

The combined work need only contain one copy of this License, and multiple identical Invariant Sections may be replaced with a single copy. If there are multiple Invariant Sections with the same name but different contents, make the title of each such section unique by adding at the end of it, in parentheses, the name of the original author or publisher of that section if known, or else a unique number. Make the same adjustment to the section titles in the list of Invariant Sections in the license notice of the combined work.

In the combination, you must combine any sections Entitled "History" in the various original documents, forming one section Entitled "History"; likewise combine any sections Entitled "Acknowledgements", and any sections Entitled "Dedications". You must delete all sections Entitled "Endorsements".

6. COLLECTIONS OF DOCUMENTS

You may make a collection consisting of the Document and other documents released under this License, and replace the individual copies of this License in the various documents with a single copy that is included in the collection, provided that you follow the rules of this License for verbatim copying of each of the documents in all other respects.

You may extract a single document from such a collection, and distribute it individually under this License, provided you insert a copy of this License into the extracted document, and follow this License in all other respects regarding verbatim copying of that document.

7. AGGREGATION WITH INDEPENDENT WORKS

A compilation of the Document or its derivatives with other separate and independent documents or works, in or on a volume of a storage or distribution medium, is called an "aggregate" if the copyright resulting from the compilation is not used to limit the legal rights of the compilation’s users beyond what the individual works permit. When the Document is included in an aggregate, this License does not apply to the other works in the aggregate which are not themselves derivative works of the Document.

If the Cover Text requirement of section 3 is applicable to these copies of the Document, then if the Document is less than one half of the entire aggregate, the Document’s Cover Texts may be placed on covers that bracket the Document within the aggregate, or the electronic equivalent of covers if the Document is in electronic form. Otherwise they must appear on printed covers that bracket the whole aggregate.

8. TRANSLATION

Translation is considered a kind of modification, so you may distribute translations of the Document under the terms of section 4. Replacing Invariant Sections with translations requires special permission from their copyright holders, but you may include translations of some or all Invariant Sections in addition to the original versions of these Invariant Sections. You may include a translation of this License, and all the license notices in the Document, and any Warranty Disclaimers, provided that you also include the original English version of this License and the original versions of those notices and disclaimers. In case of a disagreement between the translation and the original version of this License or a notice or disclaimer, the original version will prevail.

If a section in the Document is Entitled "Acknowledgements", "Dedications", or "History", the requirement (section 4) to Preserve its Title (section 1) will typically require changing the actual title.

9. TERMINATION

You may not copy, modify, sublicense, or distribute the Document except as expressly provided under this License. Any attempt otherwise to copy, modify, sublicense, or distribute it is void, and will automatically terminate your rights under this License.

However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation.

Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice.

Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, receipt of a copy of some or all of the same material does not give you any rights to use it.

10. FUTURE REVISIONS OF THIS LICENSE

The Free Software Foundation may publish new, revised versions of the GNU Free Documentation License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. See http://www.gnu.org/copyleft/.

Each version of the License is given a distinguishing version number. If the Document specifies that a particular numbered version of this License "or any later version" applies to it, you have the option of following the terms and conditions either of that specified version or of any later version that has been published (not as a draft) by the Free Software Foundation. If the Document does not specify a version number of this License, you may choose any version ever published (not as a draft) by the Free Software Foundation. If the Document specifies that a proxy can decide which future versions of this License can be used, that proxy’s public statement of acceptance of a version permanently authorizes you to choose that version for the Document.

11. RELICENSING

"Massive Multiauthor Collaboration Site" (or "MMC Site") means any World Wide Web server that publishes copyrightable works and also provides prominent facilities for anybody to edit those works. A public wiki that anybody can edit is an example of such a server. A "Massive Multiauthor Collaboration" (or "MMC") contained in the site means any set of copyrightable works thus published on the MMC site.

"CC-BY-SA" means the Creative Commons Attribution-Share Alike 3.0 license published by Creative Commons Corporation, a not-for-profit corporation with a principal place of business in San Francisco, California, as well as future copyleft versions of that license published by that same organization.

"Incorporate" means to publish or republish a Document, in whole or in part, as part of another Document.

An MMC is "eligible for relicensing" if it is licensed under this License, and if all works that were first published under this License somewhere other than this MMC, and subsequently incorporated in whole or in part into the MMC, (1) had no cover texts or invariant sections, and (2) were thus incorporated prior to November 1, 2008.

The operator of an MMC Site may republish an MMC contained in the site under CC-BY-SA on the same site at any time before August 1, 2009, provided the MMC is eligible for relicensing.

Files

Basic Security Module (BSM) event auditing file format.asciidoc

Latest commit

History