audit.h

Auditing (logging) events.

This header file provides functionality needed to use Megistos logging facilities. The system logs a variety of information:

• Date,
• Time,
• BBS channel (or daemon/service name, where a channel isn't available),
• Message flags, giving the type and severity of the log entry,
• Entry summary (typically a canned string), and
• Detailed entry text.

The default log file set up by the BBS library is the Audit Trail (Major users should be at home with the name). The API defined here allows you to switch to other files.

In addition to the API, this include file predefines most of the entries that are most widely used by the standard modules.

Original banner, legalese and change history follow.

 *****************************************************************************
 **                                                                         **
 **  FILE:     audit.h                                                      **
 **  AUTHORS:  Alexios                                                      **
 **  REVISION: A, August 94 (originally)                                    **
 **  PURPOSE:  Audit trail features                                         **
 **  NOTES:                                                                 **
 **  LEGALESE:                                                              **
 **                                                                         **
 **  This program 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.                                        **
 **                                                                         **
 **  This program 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    this program;  if   not, write  to  the   Free Software  **
 **  Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.              **
 **                                                                         **
 *****************************************************************************


 *
 * $Id: audit.h,v 1.3 2001/04/22 14:49:04 alexios Exp $
 *
 * $Log: audit.h,v $
 * Revision 1.3  2001/04/22 14:49:04  alexios
 * Merged in leftover 0.99.2 changes and additional bug fixes.
 *
 * Revision 0.10  1999/07/28 23:09:07  alexios
 * Added audit entry for downloading bulletins.
 *
 * Revision 0.9  1999/07/18 21:13:24  alexios
 * Added new entries to distinguish reasons why users hang up
 * or are kicked out.
 *
 * Revision 0.8  1998/08/14 11:23:21  alexios
 * Removed sysop hangup logging from security logs. Added
 * audit entry for relogons.
 *
 * Revision 0.7  1997/11/06 20:03:39  alexios
 * Added GPL legalese to the top of this file.
 *
 * Revision 0.6  1997/11/06 16:49:10  alexios
 * One change of flags for AUT_SIGNUP.
 *
 * Revision 0.5  1997/11/05 10:52:05  alexios
 * Radical changes. Audit entries are now flagged by type and
 * severity (created a set of flags to take care of that, as
 * well as macros to take care of setting and clearing flags).
 * audit() now needs the message's flag as well. To simplify
 * things, a new macro has been generated to specify all three
 * audit arguments (AUT_, AUS_, AUD_) in one fell swoop. Added
 * AUT_ definitions for all entries already in this file. Finally,
 * added two entries that appear when logerror() or fatal()
 * are called, so as to attract the Sysop's attention when
 * something goes wrong with some user.
 *
 * Revision 0.4  1997/09/14 13:47:56  alexios
 * Added an audit entry for finished events (EVEND).
 *
 * Revision 0.3  1997/09/12 12:45:25  alexios
 * A couplpe of new audit entries added here.
 *
 * Revision 0.2  1997/08/30 12:54:20  alexios
 * Updated contents of DISCON entry.
 *
 * Revision 0.1  1997/08/26 15:48:53  alexios
 * First registered revision. Adequate.
 *
 *
 *

Audit entry flags

Audit entry types and severity levels.

audit

The main auditing function.

AUDIT

AUDIT convenience macro.

audit_setfile

Set the audit file.

audit_resetfile

Revert to the previous audit file.

Author:

Alexios

Alphabetic index