opengate/conf/opengatesrv.conf.sample

   1 <?xml version="1.0"?>\r
   2 <Opengate version="1.4.5">\r
   3 \r
   4 <!-- ################################################# \r
   5 #    ####### NEED TO MODIFY FOLLOWING PARAMETERS #####  -->\r
   6 \r
   7         <!-- opengate gateway server hostname(FQDN or IP address) -->\r
   8 \r
   9         <OpengateServerName>opengate.og.saga-u.ac.jp</OpengateServerName>\r
  10 \r
  11         <!-- Authentication server -->\r
  12         <!-- The AuthServer format is documented at the end of this file -->\r
  13 \r
  14         <AuthServer>\r
  15                 <Address>192.168.0.2</Address>\r
  16                 <Protocol>pop3s</Protocol>\r
  17         </AuthServer>\r
  18 \r
  19 <!-- ########################################################## \r
  20 #    #### usually, need not to modify following parameters #### -->\r
  21 \r
  22 <!-- ###################################################\r
  23 #       if you want to switch parameters with userID or extraID\r
  24 #       (entered by user as [userID@extraID] in auth page),\r
  25 #       see the information of ExtraSet at the end of this file.\r
  26 #    ###################################################  --> \r
  27 \r
  28         <!-- Set 0 to write only open/close and error messages to syslog -->\r
  29         <!-- Set 1 to write some information adding to 0 -->\r
  30         <!-- Set 2 to write many information to syslog -->\r
  31         <Debug>1</Debug>\r
  32 \r
  33         <!-- client usage watch mode in default('Java', 'Http', or 'Time') -->\r
  34         <WatchMode>Http</WatchMode>\r
  35         \r
  36         <!-- Syslog (local0, local1, .., local7)-->\r
  37         <Syslog>\r
  38                 <Enable>1</Enable>\r
  39                 <Facility>local1</Facility>\r
  40         </Syslog>\r
  41 \r
  42         <!-- Allowable duration for users to use network(seconds) -->\r
  43         <!-- If no connection with java/http, network is closed after this. -->\r
  44         <Duration>\r
  45                 <Default>1200</Default>\r
  46                 <Max>10800</Max>\r
  47         </Duration>\r
  48         \r
  49         <!-- Client Live Check (seconds) -->\r
  50         <!-- In JAVA connection, send HELLO and get reply. -->\r
  51         <!-- In HTTP connection, existance of HELLO request. -->\r
  52         <!-- In no connection, check mac address mismatch and no packet. -->\r
  53         <ActiveCheck>\r
  54                 <Interval>600</Interval>\r
  55                 <NoPacketInterval>5400</NoPacketInterval>\r
  56         </ActiveCheck>\r
  57 \r
  58         <!-- Watch client with Http Keep-Alive -->\r
  59         <HttpWatch>\r
  60                 <!-- HTTP 'HELLO' request interval(sec) to Keep-Alive -->\r
  61                 <!--  must be smaller than keep-alive time of browsers -->\r
  62                 <HelloInterval>50</HelloInterval>\r
  63 \r
  64                 <!-- HTTP_USER_AGENT ignoring http watch mode -->\r
  65                 <!-- defined by "POSIX Extended Regular Expression" -->\r
  66                 <SkipAgentPattern>Safari/4</SkipAgentPattern>\r
  67         </HttpWatch>\r
  68 \r
  69         <!-- Watch client with Java Applet -->\r
  70         <JavaWatch>\r
  71                 <!-- HTTP_USER_AGENT ignoring java watch mode -->\r
  72                 <!-- defined by "POSIX Extended Regular Expression" -->\r
  73                 <SkipAgentPattern></SkipAgentPattern>\r
  74         </JavaWatch>\r
  75 \r
  76         <!-- IPFW rule number range used by opengate -->\r
  77         <IpfwRule>\r
  78                 <Min>10000</Min>\r
  79                 <Max>40000</Max>\r
  80                 <Interval>2</Interval>\r
  81         </IpfwRule>\r
  82 \r
  83         <!-- IP6FW rule number range used by opengate -->\r
  84         <Ip6fwRule>\r
  85                 <Min>10000</Min>\r
  86                 <Max>40000</Max>\r
  87                 <Interval>2</Interval>\r
  88         </Ip6fwRule>\r
  89         \r
  90         <!-- Port number range used by opengate -->\r
  91         <ListenPort>\r
  92                 <Min>30000</Min>\r
  93                 <Max>60000</Max>\r
  94         </ListenPort>\r
  95         \r
  96         <!-- Available HTML languages (first lang is used as default) -->\r
  97         <HtmlLangs>en ja</HtmlLangs>\r
  98 \r
  99         <!-- Path to Apache Contents -->\r
 100         <DocumentRoot>/usr/local/www/data</DocumentRoot>\r
 101         <CgiDir>/cgi-bin</CgiDir>\r
 102         <OpengateDir>/opengate</OpengateDir>\r
 103 \r
 104         <!-- HTML Documents (in each language dir)-->\r
 105         <DenyDoc>deny.html</DenyDoc>\r
 106         <DenyDocSsl>deny-ssl.html</DenyDocSsl>\r
 107         <AcceptDocHttp>accept-http.html</AcceptDocHttp>\r
 108         <AcceptDocJava>accept-java.html</AcceptDocJava>\r
 109         <AcceptDocTime>accept-time.html</AcceptDocTime>\r
 110         <AcceptDoc2>accept2.html</AcceptDoc2>\r
 111         <AuthDoc>index.html</AuthDoc>\r
 112         <AuthDocSsl>index-ssl.html</AuthDocSsl>\r
 113         <FwdDoc>topindex.html</FwdDoc>\r
 114         <RetryDoc>retry.html</RetryDoc>\r
 115         <HttpKeepDoc>httpkeep.html</HttpKeepDoc>\r
 116 \r
 117         <!-- CGI programs -->\r
 118         <AuthCgi>opengateauth.cgi</AuthCgi>\r
 119         <FwdCgi>opengatefwd.cgi</FwdCgi>\r
 120         <MainCgi>opengatesrv.cgi</MainCgi>\r
 121 \r
 122         <!-- Java Script (in opengate dir) -->\r
 123         <HttpKeepJS>httpkeep.js</HttpKeepJS>\r
 124 \r
 125         <!-- URL used to retry -->\r
 126         <ExternalUrl>http://www.google.com/</ExternalUrl>\r
 127 \r
 128         <!-- Url to start browsing after authentication -->\r
 129         <!-- if type=0, use acceptdoc2. if type=1, use below url -->\r
 130         <StartPage>\r
 131                 <Type>0</Type>\r
 132                 <Url>http://www.yahoo.com/</Url>\r
 133         </StartPage>\r
 134 \r
 135         <!-- Related command path -->\r
 136         <ArpPath>/usr/sbin/arp</ArpPath>\r
 137         <NdpPath>/usr/sbin/ndp</NdpPath>\r
 138         <IpfwPath>/sbin/ipfw</IpfwPath>\r
 139         <Ip6fwPath>/sbin/ip6fw</Ip6fwPath>\r
 140         <PsPath>/bin/ps</PsPath>\r
 141 \r
 142         <!-- Ipfw is opened via perl script(1) or direct from C(0) -->\r
 143         <IpfwScript>\r
 144                 <Enable>0</Enable>\r
 145                 <Path>/etc/opengate/ipfwctrl.pl</Path>\r
 146         </IpfwScript>\r
 147 \r
 148         <!-- Ip6fw is opened via perl script(1) or direct from C(0) -->\r
 149         <Ip6fwScript>\r
 150                 <Enable>0</Enable>\r
 151                 <Path>/etc/opengate/ipfwctrl.pl</Path>\r
 152         </Ip6fwScript>\r
 153 \r
 154         <!-- Lock file for exclusive exec to prevent overlapped rule number -->\r
 155         <LockFile>/tmp/opengate.lock</LockFile>\r
 156 \r
 157         <!-- Separate char between userID and extraID [userID@extraID] -->\r
 158         <UserIdSeparator>@</UserIdSeparator>\r
 159 \r
 160 <!-- ########################################################## \r
 161 #     #### ExtraSet overwritten on default settings ####\r
 162 #\r
 163 #       If you want to switch parameter values\r
 164 #       by userID and extraID entered as [userID@extraID],\r
 165 #       set following.                            \r
 166 #\r
 167 #       If entered as [userID], above default parameters are used.\r
 168 #       If entered as [iserID@extraID] and matched set exists,\r
 169 #       the paremeters in the set is overwriten on the above default.\r
 170 #       The first matched extra set is used.\r
 171 #     \r
 172 #       Examples:\r
 173 #       First ExtraSet is used when user entered as [anyuser@guest],\r
 174 #       where "anyuser" is every userID.\r
 175 #       Second ExtraSet is used when [anyuser@admin].\r
 176 #       Third ExtraSet is used when [user1] or [user2].\r
 177 #       \r
 178 #       UserIdPattern is the "POSIX Extended Regular Expression".\r
 179 #       Matching is insensitive to upper/lower case.\r
 180 #\r
 181 #       Word "default" is set to extraID, when extraID is not entered.\r
 182 #     #######################################################  \r
 183 -->\r
 184 \r
 185 <!--\r
 186 #       <ExtraSet ExtraId="guest">\r
 187 #               <AuthServer>\r
 188 #                       <Address>192.168.0.1</Address>\r
 189 #                       <Protocol>pop3s</Protocol>\r
 190 #               </AuthServer>\r
 191 #               <Duration>\r
 192 #                       <Default>1200</Default>\r
 193 #                       <Max>1200</Max>\r
 194 #               </Duration>\r
 195 #       </ExtraSet>\r
 196 -->\r
 197 <!--\r
 198 #       <ExtraSet ExtraId="admin">\r
 199 #               <AuthServer>\r
 200 #                       <Protocol>pam</Protocol>\r
 201 #               </AuthServer>\r
 202 #       </ExtraSet>\r
 203 -->\r
 204 <!--\r
 205 #       <ExtraSet ExtraId="default" UserIdPattern="^user1$|^user2$">    \r
 206 #               <Syslog>\r
 207 #                       <Enable>1</Enable>\r
 208 #                       <Facility>local2</Facility>\r
 209 #               </Syslog>\r
 210 #       </ExtraSet>\r
 211 -->\r
 212 </Opengate> \r
 213 \r
 214 \r
 215 \r
 216 <!--    ###################################################\r
 217 #       ######Documentation about AuthServer setting ######\r
 218 #       \r
 219 #       ########### Format ############# \r
 220 #        where {a|b}: a or b , [ x ]: x is optional, -x-: x is value\r
 221 #       \r
 222 #       #### TYPE 1 (POP or FTP) ####\r
 223 #       <AuthServer>\r
 224 #               <Protocol>{pop3|pop3s|ftp|ftpse|ftpsi}</Protocol>\r
 225 #               <Address>{-hostname-|-ip_address-}</Address>\r
 226 #               [ <Port>-portno-</Port> ]\r
 227 #       </AuthServer>\r
 228 #       #   AuthOK, if request by <Protocol> is accepted by <Address>.\r
 229 #       #   Address is FQDN or IP address       \r
 230 #       #   If <Port> is not defined, port number in /etc/services is used.\r
 231 #       #   pop3s is SSLed pop3\r
 232 #       #   ftpse is SSLed ftp run in Explicit mode. \r
 233 #       #   ftpsi is SSLed ftp run in Implicit mode.\r
 234 #\r
 235 #       #### TYPE 2 (PAM) ####\r
 236 #       <AuthServer>\r
 237 #               <Protocol>pam</Protocol>\r
 238 #               [ <ServiceName>-servicename_in_pam_conf-</ServiceName> ]\r
 239 #       </AuthServer>\r
 240 #       #   Auth by PAM\r
 241 #       #   If not define <ServiceName>, "opengate" is used in "pam.conf".\r
 242 #\r
 243 #       #### TYPE 3 (RADIUS) ####\r
 244 #       <AuthServer>\r
 245 #               <Protocol>radius</Protocol>\r
 246 #               [ <ConfFile>-path_to_radius_conf-</ConfFile> ]\r
 247 #       </AuthServer>\r
 248 #       #   Auth by RADIUS\r
 249 #       #   If not define <ConfigFile>, "/etc/radius.conf" is used.\r
 250 #       \r
 251 #       #### TYPE 4 (ACCEPT or DENY) ####\r
 252 #       <AuthServer>\r
 253 #               <Protocol>{accept|deny}</Protocol>\r
 254 #       </AuthServer>\r
 255 #       #   The user is accepted or denied without inquiry.\r
 256 #       #   This setting is prepared for debugging.\r
 257 #       \r
 258 #       ############# Examples ##############\r
 259 #       <AuthServer>\r
 260 #               <Address>pop.saga-u.ac.jp</Address>\r
 261 #               <Protocol>pop3s</Protocol>\r
 262 #               <Port>10000</Port>\r
 263 #       </AuthServer>\r
 264 #\r
 265 #       <AuthServer>\r
 266 #               <Address>192.168.0.1</Address>\r
 267 #               <Protocol>ftpsi</Protocol>\r
 268 #       </AuthServer>\r
 269 #\r
 270 #       <AuthServer>\r
 271 #               <Protocol>radius</Protocol>\r
 272 #       </AuthServer>\r
 273 #\r
 274 #       <AuthServer>\r
 275 #               <Protocol>pam</Protocol>\r
 276 #       </AuthServer>\r
 277 #       ######################################  \r
 278 -->\r