Commit graph

34 commits

Author SHA1 Message Date
Daniel Gerzo
205c80b5b0 - remove warnings and specific info about 6.x
- add a missing word

Reviewed by:	rwatson
2009-12-10 10:21:16 +00:00
Christian Brueffer
cfc8e11d69 Whitespace changes for the previous commit, translators can ignore this. 2008-01-22 11:07:11 +00:00
Christian Brueffer
8fd91f4022 Adjust version information where needed. 2008-01-22 11:05:36 +00:00
Robert Watson
0bd49d9eaf Update handbook Audit chapter to reflect status in 6.3 and later, and to
mention that an XML output mode is now available for praudit(8).
2007-11-28 11:55:25 +00:00
Chin-San Huang
d6a038c5a5 - Fix a missing tag.
Reported by: paefchen via #bsddocs
2007-08-23 05:12:26 +00:00
Tom Rhodes
190ea57b20 Remove duplicate word.
Found by:	ds
2007-08-22 21:29:38 +00:00
Marc Fonvieille
adc8e4d736 - Some SGML fixes (use of the right attribute for directories);
- Add missing application, command, username, etc. tags;
- Add some manual page entities;
- For the audit_class content I changed some tags and used the
  description fields used in /etc/security/audit_class to make this
  part easier to read and closer to what the user will find on his
  machine;
- Contraction removal;
- Add missing words and fix typos and punctuation.
2007-07-07 10:52:56 +00:00
Marc Fonvieille
5bc7c8daea Add missing closing tag. 2007-05-20 18:59:20 +00:00
Marc Fonvieille
53b47f0187 - Use of trademark entities;
- Tag an inline command-line;
- Use of user/group/filename tags where needed;
- Use of application tags for a deamon as done in the rest of the
  book.
2007-05-14 20:49:35 +00:00
Maxim Konovalov
7eeeac9192 o Fin an incorrect crontab entry example.
PR:		docs/105440
Submitted by:	Steve Wills
2006-11-13 14:19:12 +00:00
Robert Watson
91d477e93a Move "Delegating Audit Review Rights" section to after the review and
reduction sections.  This is the section that introduces the notion of
the audit group.  That way it appears before the section on audit
pipes, which references the audit group.

Obtained from:	TrustedBSD Project
2006-10-06 09:09:36 +00:00
Robert Watson
a22da1856f Mention the audit_control.5 filesz option in the section on log rotation,
pointing at the section on configuration files.

Obtained from:	TrustedBSD Project
2006-10-05 12:14:46 +00:00
Robert Watson
0e33fe1799 Fix miswording.
Reported by:	mal content <artifact dot one at googlemail dot com>
2006-10-02 13:44:03 +00:00
Robert Watson
b6389e9431 Update audit handbook chapter:
- Clean up a few more phrasing nits.
- Extend sections on audit_control to document filesz and policy entries,
  and to specifically mention argv, envv, and cnt policy flags.

This brings the audit documentation up-to-date for OpenBSM 1.0 alpha 12.

Obtained from:	TrustedBSD Project
2006-10-02 07:50:22 +00:00
Robert Watson
591d899439 Clarify experimental software warning -- it's not just considered
experimental, it is experimental.  Expand on what this means (not all
events that should be audited are).

Rename Key Terms section to match similar naming convention in MAC
chapter.

Obtained from:	TrustedBSD Project
2006-09-25 22:51:26 +00:00
Robert Watson
48459b7047 Further adjustments to handbook audit chapter:
- Further clarify nature of composition of audit_control flags and
  audit_user.

- Add missing </para> before auditpipe configuration example.

- Mark up usernames as <literal>.

Obtained from:	TrustedBSD Project
2006-09-25 22:36:03 +00:00
Robert Watson
d3aeb13515 Break out Viewing vs. Reduction of audit trail sections.
Expand the viewing section to include a sample audit record from a trail,
along with a description of what the record says.

Obtained from:	TrustedBSD Project
2006-09-25 17:33:53 +00:00
Robert Watson
fabcbaca97 Add a subsection to the Audit handbook chapter on compressing audit trails
following audit trail termination.

Obtained from:	TrustedBSD Project
2006-09-25 14:50:54 +00:00
Robert Watson
48a0d60e07 Document that praudit(1) can be run on auditpipe(4) devices, allowing the
administrator to track the live event stream without worrying about trail
files being rotated, etc.

Obtained from:	TrustedBSD Project
2006-09-25 13:20:33 +00:00
Robert Watson
5ec137126b Update the audit handbook chapter in a number of ways to reflect recent
changes and improvements:

- Rephrase synposis now that we've merged audit support to 6.x.  Resort to
  push all warnings to the end so that it reads more clearly.  Add
  reviewing and reducing the audit trail to list of things learned, since it
  is covered.

- Simplify class definition, as some of this content can appear in new
  definitions for selection expression, preselection, and reduction.  The
  selection expression definition replaces the existing prefix definition,
  and "selection expression" is now used consistently throughout the
  document to refer to the previously unnamed matching strings.

- Since audit support is part of the base system, remove comments about
  checking for configuration files, they will be present.  Add note about
  starting auditd with the rc.d script once the new kernel is loaded.

- When describing audit_event file, mention that that is where the class
  mappings live.

- Since audit_warn will shortly learn to notify of rotation events, mention
  that.

- Rename "Audit File Syntax" section to "Event Selection Expressions",
  since that's what the section talks about, and these expressions are used
  in more than one file.  Correct an error in the prefix list, which was
  also present in the man page (and will be fixed in the next OpenBSM
  import).  Include an example in this section.

- Don't go into selection expression details in the audit_control section,
  as that's now earlier int he document.

- Talk in more detail about audit_user fields.  I had to check the source to
  make sure I understood this first!

- Don't mention a special audit user, it's not a configuration we currently
  want to encourage.  The audit group now fills this role.

- Create a new sect2 section on viewing and reducing trails from the
  existing sect1 introduction for administering the audit subsystem, as it's
  a sufficiently detailed and independent set of text that it makes sense.
  Clarify some points regarding what you might use auditreduce for.  Use
  -u instead of -e to match the user in the example.

- Consistently say "audit trail file" instead of "audit log file", except
  when introducing the trail concept in the glossary.

- Clarify notion of the audit group some more.

- A number of rephrasings and simplifications.

- Add myself as an author.

Some new features from OpenBSM 1.0a12 are not yet described here, such as
the filesz and policy entries in audit_control, and once that is merged, I
will further update the document, which should clean up the trail rotation
section.

Obtained from:	TrustedBSD Project
2006-09-24 11:50:56 +00:00
Robert Watson
b283cabad5 Don't mention POSIX.1e in the introduction to the audit section; our
implementation has nothing to do with POSIX.1e's audit specification.
2006-08-27 02:23:42 +00:00
Robert Watson
4ebd6190b5 Various re-wordings and some minor additions:
- Don't say "by default" regarding paths in /etc/security: they are not
  configurable.

- Note that the 'ip' event class covers more than just System V IPC.

- Clarify the differences between the audit_control and audit_user files
  in the configuration files introduction.

- Slightly reword audit log rotiation introduction.

- Add a section on the 'audit' group, and how this can be used to delegate
  audit review rights.

Obtained from:	TrustedBSD Project
2006-02-12 02:14:39 +00:00
Giorgos Keramidas
3c253219b1 Add dash in 'self-inflicted'. 2006-02-06 12:11:22 +00:00
Simon L. B. Nielsen
4de76ea57b Don't use trademark entity when referring to "Sun" the company. It
should only be used when using "Sun" as part of a product name.
2006-02-05 16:08:25 +00:00
Robert Watson
1dfde2754f Remove extra 'the'. 2006-02-05 13:31:28 +00:00
Robert Watson
8dd4529f79 Re-wrap after content ends.
Suggested by:	brueffer
2006-02-04 21:08:50 +00:00
Robert Watson
43b8eb7340 Some edits of the audit handbook chapter:
Rename section "Security Event Auditing" from "Kernel Event Auditing" --
while most of our events are currently generated by the kernel, the intent
is that it will be whole system auditing.

More carefully distinguish our implementation being based on Sun's
published API and file format, and not their implementation.

Clarify a few more things audit can be used for, including post-mortem
analysis and intrusion detection.

Mention Mac OS X compatibility in addition to Darwin.

Sort glossary slightly differently -- events before classes, since classes
are defined in terms of events.  Tweak definition and examples.  Mention
non-attributable vs attributable here.

Mention that classes allow administrators to specify auditing requirements
at a high level.

Describe contents of a record.

Define 'trail'.

Since audit is now part of the base system, remove directions for
installing files, etc, since complete installs should have them, and if
they don't, the user should seek support.

Mention that audit trails are happiest on a file system of their own.

Update example flags option in audit_control -- add information on the
new default, but keep the current example because the new default doesn't
reflect the scope of possible expressions, whereas the earlier example
did.

Rephrase paragraph on avoiding directly manipulating logs in order to
explain that this is because the kernel/daemon own the log until it is
terminated.

Correct example: auditreduce just reduces, not prints, so |praudit is
needed or the user will experience the power of raw BSM's effects on
his or her terminal.

Much suggested by:	brueffer
Reviewed by:		brueffer
2006-02-04 20:54:08 +00:00
Christian Brueffer
210f051c04 Remove stale comment. 2006-02-04 07:57:25 +00:00
Christian Brueffer
ce2b9149f8 Various fixes and cleanups. Adaption of the preface to mention
that audit is only a part of CURRENT at the moment.

The 'tf' audit class removed on rwatson's advice.
2006-02-03 20:23:54 +00:00
Xin LI
0aee5437b7 Gramma fix.
Pointed out by:	ceri
2005-08-13 10:45:01 +00:00
Xin LI
3e999b00f1 - cron(8) would read the /etc/crontab once it was changed, so mention
this.
 - Add a missing </para>
2005-08-13 10:26:04 +00:00
Xin LI
6b6905c079 The filename should not contain a tailing dot, so move it outside
<filename> tag.
2005-08-12 10:08:26 +00:00
Murray Stokely
8213454821 Correct typos.
Found by:	make spellcheck
2005-08-06 13:53:20 +00:00
Tom Rhodes
9e1457cbcb Bring in two new chapters:
Audit - not hooked up to the build, but provided for when the audit framework
becomes available in the base system.

GEOM - Incomplete, only covers striping and mirroring since that is all I
have tested.  Incomplete is better than nothing in my opinion.  This one is
hooked up to the build.
2005-08-06 03:22:18 +00:00