opengate/README

   1 This archive contains OPENGATE sources & documentations
   2
   3 Copyright (C) 1999-2006 Opengate Project Team
   4       Written by Yoshiaki Watanabe
   5       Modfied by Katsuhiko Eguchi
   6
   7 This program is free software; you can redistribute it and/or
   8 modify it under the terms of the GNU General Public License
   9 as published by the Free Software Foundation; either version 2
  10 of the License, or (at your option) any later version.
  11
  12 This program is distributed in the hope that it will be useful,
  13 but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 GNU General Public License for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  20
  21 Email: watanaby@is.saga-u.ac.jp
  22
  23
  24 -----------------------------------------------------
  25 install documentation is in doc
  26 -----------------------------------------------------
  27
  28 Content of this archive
  29
  30 README          This file
  31
  32 conf/           Configuration files
  33   rc.firewall.sample    Script of sample IPv4 firewall configuration
  34   rc.firewall6.sample   Script of initail IPv6 firewall configuration
  35   ipfwctl.pl.sample     Perl script executed by opengate(not use in default)
  36   opengatesrv.conf.sample       Sample file for Opengate configuration
  37
  38 doc/            Documentation files
  39   Changes.html          Change log
  40   GPL.txt               GNU General Public License
  41   progflow.html         Program flow
  42   protocol.txt          Protocol between related applications
  43
  44   en/ & ja/ documentation for each language
  45    install.html         Instruction for installation
  46    qa.html              Questions and answers(not up to date)
  47    errcheck.html        Error checking list(not up to date)
  48
  49 javahtml/       Client Java Applet and HTML files
  50   Opengate.class        Java Applet main executable file
  51   Opengate.jar          Java Applet archive file
  52   Opengate.java         Java Applet source file
  53   OpengateClient.class  Java Applet sub executable file
  54   index.html.var        Document selector placed in DocumentRoot
  55
  56   en/ & ja/             HTML files for each language
  57     accept-java.html    Accept message page for java mode
  58     accept-http.html    Accept message page for http mode
  59     accept-time.html    Accept message page for timeout mode
  60     accept2.html        Second accept message page(for start browsing)
  61     deny.html           Deny message page
  62     deny-ssl.html       Deny message page(in SSL)
  63     retry.html          Retry message page
  64     httpkeep.html       Page for HTTP Keep-Alive
  65     index-ssl.html      Authentication request page(in SSL)
  66     index.html          Authentication request page
  67     topindex.html       Top page displayed at firewall forward
  68                         Keywords in files are replaced by CGI
  69
  70 opengatesrv/    Opengate server program source files
  71   Makefile              make file
  72   auth-ftps.c           Authentication by FTPS
  73   auth-pam.c            Authentication by PAM
  74   auth-pop3s.c          Authentication by POP3S
  75   auth-rad.c            Authentication by RADIUS
  76   comm-arp.c            Communication with ARP
  77   comm-ndp.c            Communication with NDP
  78   comm-auth.c           Communication with authentication systems
  79   comm-cgi.c            Communication with Web server via CGI
  80   comm-ipfw.c           Communication with IPFW
  81   comm-ip6fw.c          Communication with IP6FW
  82   comm-userdb.c         Communication with user database
  83   ctrl-firewall.c       Control firewalls
  84   ctrl-alarms.c         Control named alarms
  85   error.c               Error routines
  86   get-mac.c             Get MAC address from arp or ndp
  87   get-param.c           Get parameters from config file
  88   htmltemplate.c        Html keyword replace routines
  89   addr-convert.c        IP address encode and decode routines
  90   opengatesrv.h         Common header file
  91   main.c                Main CGI
  92   opengateauth.c        Authentication CGI
  93   opengatefwd.c         Forward CGI
  94   test-comm-auth.c      Test program to debug comm-auth.c
  95   test-comm-ipfw.c      Test program to debug comm-ipfw.c
  96   test-comm-client.c    Test program to debug comm-client.c
  97   test-console.sh       Test script  to debug cgi on console
  98   test-get-param.c      Test program to debug get-param.c
  99   test-cgi.c            Test program to debug cgi function
 100   utilities.c           Utilities
 101   signal.c              Functions of TCP/IP (By W. Richard Stevens)
 102   sock_ntop_host.c      Functions of TCP/IP (By W. Richard Stevens)
 103   tcp_connect.c         Functions of TCP/IP (By W. Richard Stevens)
 104   watch-client.c        Watching the client
 105   wrapper.c             Functions of TCP/IP (By W. Richard Stevens)
 106
 107 tools/          Related tools
 108   mrtg/                 tool for MRTG display
 109   rulechk/              clean up tool for abnormal process termination
 110
 111 ezxml/          XML parser (Copyright Aaron Voisine)
 112