xref: /openbsd-src/share/man/man5/changelist.5 (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1.\"	$OpenBSD: changelist.5,v 1.4 2007/09/06 07:01:34 jmc Exp $
2.\"
3.\" Copyright (c) 2003 Jason McIntyre <jmc@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: September 6 2007 $
18.Dt CHANGELIST 5
19.Os
20.Sh NAME
21.Nm changelist
22.Nd list of backup files
23.Sh SYNOPSIS
24.Nm /etc/changelist
25.Sh DESCRIPTION
26The
27.Pa /etc/changelist
28file is a simple text file containing the names of files to be backed up
29and checked for modification by the system security script,
30.Xr security 8 .
31It is checked daily by the
32.Pa /etc/daily
33script.
34See
35.Xr daily 8
36for further details.
37.Pp
38Each line of the file contains the name of a file,
39specified by its absolute pathname,
40one per line.
41By default, configuration files in
42.Pa /etc ,
43.Pa /root ,
44and
45.Pa /var
46are added during system install.
47Administrators may add additional files at their discretion.
48.Pp
49Backup files are held in the directory
50.Pa /var/backups .
51A backup of the current version of a file is kept in this directory, marked
52.Qq current .
53When the file is altered, the old version is marked as
54.Qq backup
55and the new version becomes
56.Qq current .
57.Pp
58For example,
59the system shell database,
60.Pa /etc/shells ,
61is held as
62.Pa /var/backups/etc_shells.current .
63When this file is modified, it is renamed to
64.Pa /var/backups/etc_shells.backup
65and the new version becomes
66.Pa /var/backups/etc_shells.current .
67Thereafter, these files are rotated.
68.Pp
69Diffs are mailed to the root administrator, in unified
70.Xr diff 1
71format, via
72.Xr daily 8 ,
73in the following format:
74.Bd -unfilled -offset indent
75=====
76/etc/shells diffs (-OLD  +NEW)
77=====
78.Ed
79.Pp
80Files in
81.Pa /etc/changelist
82beginning with a
83.Sq +
84character
85.Pq generally non-text files
86are stored as
87.Xr md5 1
88checksums.
89Results are mailed in the following format:
90.Bd -unfilled -offset indent
91======
92/etc/ssh/ssh_host_key MD5 checksums
93======
94OLD:
95NEW:
96.Ed
97.Pp
98Lines beginning with the comment character
99.Pq Sq # ,
100blank lines,
101and non-existent files are all silently ignored.
102.\" .Sh ENVIRONMENT
103.Sh FILES
104.Bl -tag -width /etc/changelist -compact
105.It Pa /etc/changelist
106Default changelist.
107.It Pa /etc/daily
108Maintenance script which runs
109.Xr security 8 .
110.It Pa /etc/security
111Shell script which reads
112.Pa /etc/changelist .
113.It /var/backups/
114Directory containing file backups.
115.El
116.Sh SEE ALSO
117.Xr diff 1 ,
118.Xr md5 1 ,
119.Xr daily 8 ,
120.Xr security 8
121.Sh HISTORY
122The
123.Nm
124manual page first appeared in
125.Ox 3.5 .
126.Sh CAVEATS
127Anyone with the privileges to alter system configuration files
128could also alter the backup files in
129.Pa /var/backups .
130It is important that this directory be owned by root:wheel
131and have permissions 0700 set.
132.Pp
133Removal of the
134.Pa /etc/changelist
135file itself could cause confusion.
136.Pp
137.Nm
138cannot warn about files being added to the system, although
139.Xr security 8
140will pick up on any files listed in
141.Pa /etc/changelist
142being added or deleted.
143.Pp
144If you hose your system configuration files,
145you just might be able to find the information you need in
146.Pa /var/backups .
147This is not a CAVEAT, but we had to let you know somehow!
148