This archive contains OpengateM sources & documentations

Copyright (C) 2011 Opengate Project Team
      Written by Yoshiaki Watanabe

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., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.

Email:
 watanaby@users.osdn.jp
 otani@cc.saga-u.ac.jp
support page: 
 http://www.cc.saga-u.ac.jp/opengate/opengatem/index.html.en
 http://opengatem.osdn.jp/index.html.en
 
-----------------------------------------------------
install documentation is in doc
-----------------------------------------------------

Content of this archive

README		This file
conf		Configuration files
doc		Documentations
ezxml		Library by other author
html		HTML files for management systems
mdsrc		C sources of daemon 'opengatemd'
mngsrc		C sources of management systems
phpsrc		PHP sources
rc.d		Sample script for rc.d
sqlscript	Scripts to access SQL
---------------------------
conf
  ipfwctrlmd.pl.sample      sample perl script for ipfw control
  opengatemd.conf.sample    sample conf file for opengatem daemon program
  opengatemmng.conf.sample  sample conf file for opengatem management programs
  rc.firewall.sample        sample firewall script
  warningmail.sample        sample mail for expiration warning (japanese)
  warningmail.sample.en     sample mail for expiration warning (english)

html
  editstring.js             Javascript for editting fields in updating page
  index.html.var            top var file for document root
  macchk.js                 JavaScript for UI in mac checking page
  showlog.js                Javascript for showing log in updating page
  en
    macauth.html            template of page for authentication request
    macchk.html             template of page for checking mac address
    macdeny.html            template of page for showing deny message
    macfwd.html             template of page for forwarding to auth
    macreg.html             template of page for mac registration
    macreturn.html          template of page for error return
    macupdate.html          template of page for mac updating page
    warning.php             PHP script to show message at jumping from opengate to opengatem
  ja
    same as en

mdsrc
  error.c                   control syslog output
  getparam.c                get parameter value from conf file
  ipfw.c                    control firewall
  macdbcache.c              control cache of mac address table in MySQL
  Makefile                  make file
  managementdb.c            control management DB (MySQL) 
  opengatemd.c              main routine of opengatem daemon
  opengatemd.h              header file
  packetcache.c             control cache of captured packet
  pcap.c                    control of PCAP library
  session.c                 control the session for using devices
  ttlcheck.c                check TTL(time to live) of packet
  udpserv.c                 control UDP server for update reporting
  util.c                    misc utilities
  watchlistcache.c          control cache of watchlist table in MySQL (specific reporting is needed)
  workdb.c                  control work DB (SQLite)

mngsrc
  alarms.c                  control of signal alarms
  auth-ftps.c               control authenticaion with FTPS 
  auth-ldap.c               control authenticaion with LDAP 
  auth-pam.c                control authenticaion with PAM 
  auth-pop3s.c              control authenticaion with POP3S 
  auth-rad.c                control authenticaion with RADIUS 
  auth.c                    entry routine for authenticaion 
  cgi.c                     control CGI
  error.c                   control syslog output
  getmac.c                  get mac address from arp
  getparam.c                get parameter values from conf file
  ipfw.c                    control firewall
  Makefile                  make file
  managementdb.c            control management DB (MySQL)
  messages.c                manage messages in english and japanese
  opengatemchk.c            main routine for CGI of mac check page
  opengatemfwd.c            main routine for CGI of forwarding page
  opengatemmail.c           main routine to send warning mail
  opengatemmng.h            header file for management programs
  opengatemown.c            main routine for CGI of own-control page (register/update by oneself)
  opengatemreg.c            main routine for CGI of registration page
  opengatemup.c             main routine for CGI of updating page
  proc.c                    coltrol of child process used in mac check page
  queue.c                   control address queue
  udpcli.c                  UDP client to send update info to daemon
  util.c                    misc utilities
  workdb.c                  control work DB (SQLite)
  ** caution: though same name exist in mdsrc and mngsrc, do not merge these files. These are independent.
phpsrc
  sendreportmail.php        script to send report at detecting a packet for the device in watchlist. co-opetare with syslog
  showlog.php               page for showing use log
  showtable.php             page for showing content of tables in MySQL
  updatemactable.php        page for editing mac address table
  updatevendortable.php     script to insert vendor list into vendor table in MySQL

sqlscript
 createtablescript         script to creat tables in MySQL at initialization
 insertmacscript           script to insert mac address into mac table in MySQL
 updatescript1             sample script for management of mac address table 
 updatescript2             sample script for management of mac address table 
 updatescript3             sample script for management of mac address table 
 updatescript4             sample script for management of mac address table 

