==============================================================================
README for pop-gw 0.1                                               1997-07-19
==============================================================================

Copyright 1997 by Eberhard Mattes <mattes@azu.informatik.uni-stuttgart.de>
Donated to the public domain.  No warranty.


Introduction
------------

pop-gw is an add-on for the TIS Firewall Toolkit 2.0; it enables
selected external users to access an internal POP server.


Warning
-------

pop-gw requires clear text passwords, APOP is not yet supported.


Installation
------------

1. After installing the TIS Firewall Toolkit, unpack cmd-gw.tar.gz into
   the main directory of the TIS Firewall Toolkit:

        cd /sources/fwtk
        gunzip </dist/cmd-gw.tar.gz | tar xzf -

2. If your `make' tool requires `.include' instead of `include', replace
   `include' with `.include' in pop-gw/Makefile and libem/Makefile.  (This
   can also be done by running `fixmake' of the TIS Firewall Toolkit.)

3. Compile the libraries and the program:

        cd libem
        make
        cd ../pop-gw
        make

4. Copy pop-gw to the target directory:

        cp pop-gw /usr/local/etc

   (see the definition of DEST in Makefile.config for the target
   directory.)


Configuration
-------------

pop-gw is -- like the TIS FWTK programs -- configured by rules in
netperm-table.  It reads all rules using the pop-gw and * keywords.
pop-gw understands the following attributes:

  groupid <GROUP>

     Run with group ID <GROUP>.

     Example:
          pop-gw: groupid nogroup

  hosts <HOST-PATTERN>...

     Specify access permissions.

     Example:
          pop-gw: permit-hosts 199.99.99.*
          pop-gw: deny-hosts 199.99.99.1

  server <HOST>

     Forward to the POP server on <HOST>.  <HOST> can be an IP address
     or a hostname.  This attribute is mandatory.

     Example:
          pop-gw: server pop.internal.foo.bar

  user <USER> ...

     Enable access for POP user-id <USER>.  It is not yet possible to
     configure per-host user-ids.

     Example:
          pop-gw: user janet jim joe

  userid <USER>

     Run with user ID <USER>.

     Example:
          pop-gw: userid nouser


Running pop-gw
--------------

pop-gw can be run either from inetd:

        pop-gw

or as daemon:

        pop-gw -daemon <PORT>

<PORT> is the port number.


Using pop-gw
------------

In the mail client, configure the host running pop-gw as POP server.


Future plans
------------

- add per-host configuration of users:

        pop-gw: permit-hosts 199.99.99.2 -user janet jim
        pop-gw: permit-hosts 199.99.99.1 -user joe

- support APOP

==============================================================================
                                THE END
==============================================================================
