README

   1                    Clarkway: An SSL tunnelling application
   2                    =======================================
   3
   4 Please see the `Author' section at the end of this file for licensing and
   5 warranty information.
   6
   7 About
   8 =====
   9
  10 clw, short for Clarkway, is a simple SSL tunnel written in ruby(1).  Its main
  11 purpose is to make hosts inside a local area network available to the outside
  12 world, thereby bypassing firewalls.
  13
  14 Usually, forwarding of a virtual private network (VPN, openvpn(8)) is a
  15 smarter way to achieve that, but sometimes, it can be a security risk to make
  16 your computer a part of a network which is potentially far away.  At this
  17 point, Clarkway comes in handy: It has a very strict distinction between
  18 source and target of the connection.  While an attacker on the ``target'' host
  19 can connect to the ``source'' host when a VPN exists between them, Clarkway
  20 operates unidirectionally.  If the target host is properly secured and
  21 bidirectionality is important to you, a VPN is almost certainly the right
  22 choice.  Else, Clarkway might be for you.
  23
  24 Prerequisites
  25 =============
  26
  27 Make sure that Ruby is installed.  Only version 1.8 has been tested; please
  28 report if Clarkway does or does not work with newer versions.  Additionally,
  29 the following libraries are needed:
  30
  31     * OpenSSL for Ruby.  This provides the cryptographical features.
  32     * YAML.  Yaml Ain't Markup Language is used for configuration.  It should
  33       be part of most standard Ruby installations.
  34
  35 Installation
  36 ============
  37
  38     $ sudo make install
  39
  40 Or, if you do not use sudo:
  41
  42     $ su -c 'make install'
  43
  44 If you want to change the installation target, use the following switches:
  45
  46       -----------------------------------------------------------------
  47       Option/Default              Description
  48       -----------------------------------------------------------------
  49       PREFIX=/usr/local           Base installation target.
  50       BINDIR=/usr/local/bin       Put the clw executable here.
  51       LIBDIR=/usr/local/share/clarkway
  52                                   Put the clw library files here.
  53       MANDIR=/usr/local/man/man1  Put the manual file here.
  54       DESTDIR=                    Install into the given subdirectory.
  55                                   Useful for distributors.
  56       -----------------------------------------------------------------
  57
  58 Documentation
  59 =============
  60
  61 The documentation to Clarkway is maintained as a manual page.  Type `man clw'
  62 after installation or `man doc/clw.1' in the source directory to read it.
  63
  64 Author
  65 ======
  66
  67 Clarkway is Copyright (C) 2007 Michael Schutte <m.schutte.jr@gmail.com>.
  68
  69 This program is free software; you can redistribute it and/or modify it under
  70 the terms of the GNU General Public License as published by the Free Software
  71 Foundation; either version 2 of the license, or (at your option) any later
  72 version.
  73
  74 This program is distributed in the hope that it will be useful, but WITHOUT
  75 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
  76 FOR A PARTICULAR PURPOSE.  See the COPYING file for details.
  77
  78 vim:tw=78: