accudoc - semi-automated system auditing
make audit.txt $EDITOR audit.txt make audit.html audit.pdf
accudoc is a small shell script that attempts to extract information about the host's hardware and software configuration. It generates a simple report in reStructured Text format, which can subsequently be converted to PDF (via LaTeX) or HTML using the python-docutils package.
When accudoc cannot deduce data, it prints a placeholder in angle brackets (<>). Before converting to HTML or PDF you should go through the report and fill in these data manually.
The latest stable release is available at http://www.cyber.com.au/product/accudoc/
Use darcs get http://www.cyber.com.au/product/accudoc/ to check out the development branch. Use darcs send --to=twb@cyber.com.au to submit patches.
- data.sh
- contains functions that extract and print information.
- rst-writer.sh
- contains functions that format streams into reStructured Text format.
- accudoc.sh
- loads the data and rst-writer libraries and prints a report in reStructured Text format to standard output.
- http://docutils.sourceforge.net
- Documentation and translation utilities for the reStructured Text format.
- http://www.cyber.com.au/users/mikem/accudoc.html
- Previous version of accudoc.
A couple of data occur multiple times in the document (e.g. data_documentor_company). At present it is incumbent upon the documentor to ensure all instances match. A better solution would be to allow some or all data to be supplied on the command line, which would also streamline documenting multiple audits.
Support for esoteric systems such as OpenWRT/mipsel is sub-optimal.
Generating the services tables is too slow.
ypwhich stalls for a long time when NIS is not in use.
Automated tables are annoyingly hard to do in reST, because they need to be aligned. Therefore they are currently faked with literal (preformatted) blocks, which is sub-optimal.
The "LSB Compliance" field is far too long for LSB-2 and -3 compliant systems.
For fake domains, the whois table is sometimes hundreds of pages long with false positives.
Copyright (C) 2006 Trent Buck Copyright (C) 2002 Mike MacCana
This file is part of accudoc.
accudoc is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
accudoc is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with accudoc; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Trent Buck <twb@cyber.com.au>
Send bug reports or comments to the above address.