pod/zebedee/original/ftpgw.tcl.pod

   1 =head1 NAME
   2
   3 ftpgw.tcl --- an FTP gateway script to allow tunnelling
   4
   5 =head1 SYNOPSIS
   6
   7 =over 4
   8
   9 B<ftpgw.tcl> [B<-p> <port-range>] [B<-v>] [I<listen-port> [I<ftpd-host> [I<ftpd-port>]]]
  10
  11 =back
  12
  13 =head1 DESCRIPTION
  14
  15 This program is a simple FTP gateway that intercepts PORT commands and
  16 passive-mode responses so that it can set up handlers for the data
  17 streams associated with them. It then rewites these control lines so
  18 that traffic to an FTP server apparently comes from the gateway process.
  19 Similarly a client sees a remote port that it can access for passive
  20 mode transfers. This allows the FTP control (but not data) channel to
  21 be tunnelled and encrypted.
  22
  23 By default the program listens on port 2121 and will redirect traffic
  24 to a local FTP server on port 21. These values can be overridden on the
  25 command line. The B<-v> option turns on verbose logging to stderr.
  26
  27 If the B<-p> option is specified then the argument is a range of port
  28 numbers in the form I<xxx>-I<yyy>. All passive-mode data ports will be in
  29 the range I<xxx> to I<yyy> and the response lines will be re-written to
  30 redirect a client to the corresponding port on 127.0.0.1 (localhost).
  31 This means that passive-mode data connections can be tunnelled in
  32 addition to the control connection.
  33
  34 For examples of how to use this program see the documentation for B<Zebedee>.
  35
  36 =head1 COPYRIGHT
  37
  38 Copyright (c) 2000 by Neil Winton. All Rights Reserved.
  39
  40 This program is free software; you can redistribute it and/or modify
  41 it under the terms of the GNU General Public License as published by
  42 the Free Software Foundation; either version 2 of the License, or
  43 (at your option) any later version.
  44
  45 This program is distributed in the hope that it will be useful,
  46 but WITHOUT ANY WARRANTY; without even the implied warranty of
  47 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  48 GNU General Public License for more details.
  49
  50 You should have received a copy of the GNU General Public License
  51 along with this program; if not, write to the Free Software
  52 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
  53 USA.