src/starter/README

   1
   2 IPsec Starter -- Version 0.2        [Contributed by Arkoon Network Security]
   3 ============================        [                http://www.arkoon.net/]
   4
   5 IPsec Starter is aimed to replace all the scripts which are used to
   6 start and stop strongSwan and to do that in a quicker and a smarter way.
   7
   8 IPsec Starter can also reload the configuration file (kill --HUP or periodicaly)
   9 and apply the changes.
  10
  11 Usage:
  12   starter [--debug] [--auto_update <x seconds>]
  13     --debug:       enable debugging output
  14     --no_fork:     all msg (including pluto) are sent to the console
  15     --auto_update: reload the config file (like kill -HUP) every x seconds
  16                    and determine any configuration changes
  17
  18 FEATURES
  19 --------
  20
  21 o Load modules of the native Linux 2.6 IPsec stack
  22
  23 o Launch and monitor pluto
  24
  25 o Add, initiate, route and del connections
  26
  27 o Attach and detach interfaces according to config file
  28
  29 o kill -HUP can be used to reload the config file. New connections will be
  30   added, old ones will be removed and modified ones will be reloaded.
  31   Interfaces/Klips/Pluto will be reloaded if necessary.
  32
  33 o Full support of the %defaultroute wildcard parameter.
  34
  35 o save own pid in /var/run/starter
  36
  37 o Upon reloading, dynamic DNS addr will be resolved and reloaded. Use
  38   --auto_update to periodicaly check dynamic DNS changes.
  39
  40 o kill -USR1 can be used to reload all connections (delete then add and
  41   route/initiate)
  42
  43 o /var/run/dynip/xxxx can be used to use a virtual interface name in
  44   ipsec.conf. By example, when adsl can be ppp0, ppp1, ... :
  45     ipsec.conf:             interfaces="ipsec0=adsl"
  46   And use /etc/ppp/ip-up to create /var/run/dynip/adsl
  47     /var/run/dynip/adsl:    IP_PHYS=ppp0
  48
  49 o %auto can be used to automaticaly name the connections
  50
  51 o kill -TERM can be used to stop FS. pluto will be stopped.
  52
  53 o Can be used to start strongSwan and load lots of connections in a few
  54   seconds.
  55
  56 TODO
  57 ----
  58
  59 o handle wildcards in include lines -- use glob() fct
  60     ex: include /etc/ipsec.*.conf
  61
  62 o handle duplicates keywords and sections
  63
  64 o 'also' keyword not supported
  65
  66 o manually keyed connections
  67
  68 o IPv6
  69
  70 o Documentation
  71
  72
  73 CHANGES
  74 -------
  75
  76 o Version 0.1 -- 2002.01.14 -- First public release
  77
  78 o Version 0.2 -- 2002.09.04 -- Various enhancements
  79                                FreeS/WAN 1.98b, x509 0.9.14, algo 0.8.0
  80
  81 o Version 0.2d -- 2004.01.13 -- Adaptions for Openswan 1.0.0
  82                                 by Stephan Scholz <sscholz@astaro.com>
  83
  84 o Version 0.2e -- 2004.10.14 -- Added support for change of interface address
  85                                 by Stephan Scholz <sscholz@astaro.com>
  86
  87 o Version 0.2s -- 2005-12-02 -- Ported to strongSwan
  88                                 by Stephan Scholz <sscholz@astaro.com>
  89
  90 o Version 0.2x -- 2006-01-02 -- Added missing strongSwan keywords
  91                                 Full support of the native Linux 2.6 IPsec stack
  92                                 Full support of %defaultroute
  93                                 Improved parsing of keywords using perfect hash
  94                                 function generated by gperf.
  95                                 by Andreas Steffen <andreas.steffen@hsr.ch>
  96
  97 THANKS
  98 ------
  99
 100 o Nathan Angelacos - include fix
 101