README

dialup_admin is a web based administration interface for the freeradius radius server.
It is written in PHP4 (although the files have an extension of php for historical reasons).
It is modular and right now it assumes that user information is stored in an ldap server
or an sql database and accounting in an sql server.

Extra documentation from Stadler Karel (<Karel.Stadler@psi.ch>):
http://kstadler.ch/index.php?topgroupid=1&subgroupid=14&groupid=11

There is also a nice HOWTO in the doc folder


INSTALLATION:

Put dialup_admin in /usr/local/dialupadmin
Create a link from your htdocs directory to /usr/local/dialupadmin/htdocs
Edit /usr/local/dialupadmin/conf/* files to match your needs


There are also a few more things included:

* sql/badusers.sql: It will create a table named badusers which can be used to hold the
  history for badusers (date,action)
* sql/userinfo.sql: It will create a table named userinfo which contains personal information
  for users stored in the sql database. This can be used if a sql database is used to store user profiles
  (not ldap).
* bin/log_badlogins: It will constantly check the radiusd.log file and add all login-incorrect,
  invalid-user, outside of allowed login time  and multiple-login cases to the radacct table with
  acctstarttime=acctstoptime, acctsessiontime=0 and acctterminatecause containing the reason.
  If the failing module sent back a module message then it will also appear in the terminate cause.
  You will need to setup the $mysql and $tmpfile variables to suite your mysql installation and needs.
  Perl module Date::Manip is needed by the script.
* bin/clean_radacct: It will delete all entries in the radacct table with a starttime > 1 day and
  stoptime = 0. It will not do an harm even if it deletes valid entries since radiusd will fall
  back to insert if update fails.
* bin/truncate_radacct: It will delete sessions from the radacct table which are older than a configurable
  number of days
* bin/tot_stats: Update the totacct table with aggregated daily accounting information for each user.
  We keep a row per user for each day.
* bin/monthly_tot_stats: Log in the mtotacct table aggregated accounting information for each user spaning
  in one month period. If the current month has not ended it will log information up to the current month day




The structure of the tree is:

conf:: Contains various configuration files.
conf::admin.conf=>
	The main configuration file. The directives used should be easily
	understood
conf::config.php=>
	Just a helper php4 for reading the admin.conf file.
conf::default.vals=>
	Contains the default values for check and reply items. If you also use the users
	file except for the ldap/sql databases fill in the default values you have inserted
	for the users.Else comment them out.
conf::sql.attrs=>
	Contains inmformation about the sql attributes. This is used by the accounting
	report generator (accounting.php).
conf::user_edit.attrs=>
	Contains the attributes that user_edit.php will show. Just uncomment those
	which you want to be displayed.
conf::extra.ldap-attrmap=>
	Contains a few items not included in ldap.attrmap which are used only by dialup_admin
	Things like User-Password and Dialup-Lock-Msg. Use none for attributes that are not known
	by the radius or ldap server.
conf::sql.attrmap=>
	Contains the Attribute map for the sql database. Use none for attributes that are not known by
	the radius server.
conf::auth.request=>
	Contains value pairs sent in the test packets which are sent from the test user/server pages.

htdocs:: Contains the basic php files
htdocs::index.html=>
	The main index file. Just contains the frames tags
htdocs::content.html=>
	Change this file to include the greeting of your choise
htdocs::buttons.php=>
	This will open the corresponding buttons html file in the html/buttons folder
htdocs::style.css=>
	CSS style file. Change it to match your preferences
htdocs:: user_state.php =>
	It can be used by outside pages to get a quick
	overview of the status of a user. It will return the following fields
	separated by new lines:
	account_status(active or inactive),lock message,weekly limit,daily limit,
	weekly used,weekly connections,daily used,daily connections,
	active sessions number,active sessions time
htdocs:: user_finger.php =>
	It will finger the nas(es) and show the logged in users. If an argument server is passed then
	it will only show users for the specific access server.
	If an argument usage_summary is passed then it will only show a line like:
	"Online: <num> Free: <num>" which can be used by other pages
htdocs::failed_logins.php =>
	It will show all the failed logins as logged in the radacct table by the log_badlogins script

html:: Contains the html code for a few pages 
html::user_admin.html.php =>
	html code for the user_admin page
html::stats.html.php =>
	html code for the stats page
html::user_toolbar.html.php =>
	the user toolbar (show,edit,accounting...) which appears in almost all pages
html::group_toolbar.html.php =>
	the toolbar shown in the group manipulation pages
html::/buttons
	contains a folder default which contains a buttons.html.php file. When a user is connecting
	with http authentication we first try to open the file in the folder <username>. If that fails
	we open the file in the default folder. That way each admin can have a different view of the buttons
	bar (for example see different finger pages).

lib::	Contains the library items
lib::ldap=>
	The ldap files
lib::lang=>
	Allow for multiple languages to be supported
lib::crypt=>
	Allow for multiple encryption schemes (for user passwords)
lib::sql=>
	Contains the sql library files. There is also a directory drivers
	which contains functions for various sql databases (mysql and
	postgresql for the time being).

The rest: The rest are the php4 files. Normally, you should not need to change anything in them.