opengate/README

   1 This archive contains OPENGATE sources & documentations
   2
   3 Copyright (C) 1999-2007 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 support page: http://www.cc.saga-u.ac.jp/opengate/index-e.html
  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   httpkeep.js           JavaScript code for http keep-alive
  56   md5.js                JavaScript code for MD5 hash
  57   favicon.ico           favorite icon
  58
  59   en/ & ja/             HTML files for each language
  60     accept-java.html    Accept message page for java mode
  61     accept-http.html    Accept message page for http mode
  62     accept-time.html    Accept message page for timeout mode
  63     accept2.html        Second accept message page(for start browsing)
  64     deny.html           Deny message page
  65     deny-ssl.html       Deny message page(in SSL)
  66     retry.html          Retry message page
  67     httpkeep.html       Page for HTTP Keep-Alive
  68     index-ssl.html      Authentication request page(in SSL)
  69     index.html          Authentication request page
  70     topindex.html       Top page displayed at firewall forward
  71                         Keywords in files are replaced by CGI
  72
  73 opengatesrv/    Opengate server program source files
  74   Makefile              make file
  75   auth-ftps.c           Authentication by FTPS
  76   auth-pam.c            Authentication by PAM
  77   auth-pop3s.c          Authentication by POP3S
  78   auth-rad.c            Authentication by RADIUS
  79   auth-ldap.c           Authentication by LDAP/LDAPS
  80   comm-arp.c            Communication with ARP
  81   comm-ndp.c            Communication with NDP
  82   comm-auth.c           Communication with authentication systems
  83   comm-cgi.c            Communication with Web server via CGI
  84   comm-ipfw.c           Communication with IPFW
  85   comm-ip6fw.c          Communication with IP6FW
  86   comm-userdb.c         Communication with user database
  87   ctrl-firewall.c       Control firewalls
  88   ctrl-alarms.c         Control named alarms
  89   error.c               Error routines
  90   get-mac.c             Get MAC address from arp or ndp
  91   get-param.c           Get parameters from config file
  92   htmltemplate.c        Html keyword replace routines
  93   addr-convert.c        IP address encode and decode routines
  94   opengatesrv.h         Common header file
  95   main.c                Main CGI
  96   opengateauth.c        Authentication CGI
  97   opengatefwd.c         Forward CGI
  98   test-comm-auth.c      Test program to debug comm-auth.c
  99   test-comm-ipfw.c      Test program to debug comm-ipfw.c
 100   test-comm-client.c    Test program to debug comm-client.c
 101   test-console.sh       Test script  to debug cgi on console
 102   test-get-param.c      Test program to debug get-param.c
 103   test-cgi.c            Test program to debug cgi function
 104   utilities.c           Utilities
 105   signal.c              Functions of TCP/IP (By W. Richard Stevens)
 106   sock_ntop_host.c      Functions of TCP/IP (By W. Richard Stevens)
 107   tcp_connect.c         Functions of TCP/IP (By W. Richard Stevens)
 108   watch-client.c        Watching the client
 109   wrapper.c             Functions of TCP/IP (By W. Richard Stevens)
 110
 111 tools/          Related tools
 112   mrtg/                 tool for MRTG display
 113   rulechk/              clean up tool for abnormal process termination
 114
 115 ezxml/          XML parser (Copyright Aaron Voisine)
 116