This directory contains the sources and documentation for Dopen, a RADIUS 
log file analyer. This document describes version 1.05 of the scripts.

See the following files and directories for further information.

        COPYING - Copying conditions
        CREDITS - authorship information
        INSTALL - How to make it work.
        README  - This file.

FOREWORD:
=========

This script was written on a Sun sparc10, with Solaris2.5.1 as the operating
system, using perl 5.003.  We take no responsibility for it's behaviour on 
other operating systems, or if you use a version older than 5.003.

It has been tested and known to be working on the following systems:

Sun 670mp with Solaris 2.4

If you have any others to add to this list feel free to email me 
<marius@randomc.com> with the specs and I'll add em to the list.

Installation:
=============

   1)

      a) If you have gzcat:

	gzcat dopen.tar.gz | tar -tvf -

      b) If you don't have gzcat but have gzip:

	gzip -d dopen.tar.gz | tar -tvf -

   2) At the top of the dopen file are some variables that will need 
      redefining if you are using the -R or -M options ( rotation, and
      mail results, respectively ).

      a) Change the system administrator's mail address if you wish to 
	 receive results via mail instead of writing to a file.

         $sysadmin	= '';

	 Change the mailer as well.  You may be using pmail, smail or
	 other variants.  Currently it is :

	 $MAILER	= '/usr/lib/sendmail';

	 NB: If you leave the address as is, and specify the -M option,
	 the program will exit with an error explaining that you haven't 
	 changed the mail address.  Similarly if you don't specify, or
	 specify incorrectly, the $MAILER var, the script will exit
	 without mailing you.

      b) Change the paths at the top of the dopen file, this will point
	 to where the rotate.pl script, and this, lies.

      c) The '$DbmDir' variable specifies where the dbm files will rest.
	 Basically it's a temporary directory since the dbm's will be
	 erased when the script exits.

      d) The '$DataDir' variable specifies where your portmaster detail
	 files are located. VERY IMPORTANT !!

      e) The '$TmpDir' variable specifies where the output of this script
	 will be put ( unless of course you want it mailed ).


   3) What to expect.  Well, this is what the portmaster detail file
      looks like, and what the script will be parsing.


      <Day> <Month> <day of month> <hr:min:secs> <year>
       Acct-Session-Id          = "string"
    (*)User-Name                = "string"
       Client-Id                = some Ip address
       Client-Port-Id           = 25
       NAS-Port-Type            = Async
    (*)Acct-Status-Type         = Stop|Start
    (*)Acct-Session-Time        = amt of seconds
       Acct-Authentic           = RADIUS
    (*)Acct-Input-Octets        = amt of octets
    (*)Acct-Output-Octets       = amt of octets
    (*)Acct-Terminate-Cause     = why ?
    (*)User-Service-Type        = integer
       Framed-Protocol          = string ( ie PPP, SLIP, ISDN )
       Framed-Address           = IP address
       Acct-Delay-Time          = integer

      The lines marked with '*' are what the script will be looking for.
      If you want any other options included, communicate with us and
      we'll see what we can do.


   4) Read this file, dopen.README, and it will begin to explain some of the
      options available from the command line. 

      There are 'x' options :

      -u <username>		// Search for specific username.
      -d <detail_file>		// Specify a detail file to read from.
      -o []			// Search for octet size, can only be
				// used with the -u <> option.
      -t []			// Search for termination cause.
      -r			// After dopen has exited, run the rotation
				// perl script to rotate all the logs.
      -m			// Mail the results

