README 3.43 KB
Newer Older
Niels Möller's avatar
Niels Möller committed
1
LSH - a GNU implementation of the Secure Shell protocols.
Niels Möller's avatar
Niels Möller committed
2 3


4 5
COPYRIGHT

Niels Möller's avatar
Niels Möller committed
6 7 8 9
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation. See the file COPYING for details.

10 11 12

INSTALLATION

Niels Möller's avatar
Niels Möller committed
13
If you have downloaded a release, you should be able to compile it
Niels Möller's avatar
Niels Möller committed
14 15 16 17
with

   ./configure
   make
18
   make install
Niels Möller's avatar
Niels Möller committed
19

20 21 22 23 24 25
You need GNU make. Some shells have had bugs preventing them from
executing the configure script; if you experience problems, try
running

  bash configure

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53
If you want to hack lsh, you need some more tools:

 * autoconf (version 2.59 or later is recommended),

 * automake (version 1.8.2 or later),

 * bash,

 * gcc,

 * gperf (at least version 2.7)

 * a scheme implementation. The currently supported schemes are guile
   and scsh (at least version 0.6).

All but scsh can be found at your local GNU mirror site. scsh,
Olin Shiver's Scheme Shell, can be downloaded from <URL:
http://www.scsh.net>. If you use guile, you also need the slib
library, which is usually distributed separately. It's also available
at the GNU mirrors.

Optional programs that are needed to get the most out
of the lsh testsuite:

 * tcputils, available at ftp://ftp.lysator.liu.se/pub/unix/tcputils.

 * tsocks (plus the supplied patch misc/tsocks-forcelocal.patch). It
   can be downloaded from http://tsocks.sourceforge.net/.
54 55 56 57 58 59 60 61

If you have checked out lsh from CVS, things are a little more
complicated. Run the ./.bootstrap script, which will run aclocal,
autoconf, autoheader and automake for you. This creates the configure
script and several Makefile.in. Now run ./configure, to create
Makefile. Next run make bootstap. This will create various
automatically generated files. Then you are ready to run make, to
build the programs.
Niels Möller's avatar
Niels Möller committed
62

J.H.M. Dassen's avatar
J.H.M. Dassen committed
63 64 65

NEEDED LIBRARIES

66
GMP (version 3.1 or better) can be found at ftp.gnu.org, or some of
Niels Möller's avatar
Niels Möller committed
67
its mirrors.
68

69 70
ZLIB can be found at http://www.zlib.org. Older versions zlib have a
known security problems, so make sure you get the latest one.
J.H.M. Dassen's avatar
J.H.M. Dassen committed
71

72
liboop (version 0.8 or better) can be found at http://liboop.ofb.net.
Niels Möller's avatar
Niels Möller committed
73

74 75 76

GETTING STARTED

Niels Möller's avatar
Niels Möller committed
77 78 79 80 81 82 83 84
After install, the first thing you need to do is creating a seed-file
for the randomness generator. Use

  lsh-make-seed

to create a personal seed file. If you want to run the lshd server,
you also need to run

Niels Möller's avatar
Niels Möller committed
85
  lsh-make-seed --server
Niels Möller's avatar
Niels Möller committed
86 87 88

as root.

89 90
Some examples...

91
Create a new RSA key pair, and save it in ~/.lsh/identity and
92
~/.lsh/identity.pub: 
93

94
  lsh-keygen | lsh-writekey
95

96 97
To create a key for the server, using the server's seed-file and
storing the result as /etc/lsh_host_key and /etc/lsh_host_key.pub, run
98

99
  lsh-keygen --server | lsh-writekey --server
100 101 102 103 104

Start an lshd server in the background, on the default port, using the
key at /etc/lsh_host_key, created above:

  lshd --daemonic
105 106 107 108

Connect to an lshd server running on port 4711 on HOST, and attempt to
log in as USER:

109
  lsh -p 4711 -l USER HOST
110 111 112 113


MORE INFORMATION

114 115 116
For more information on using LSH, read the LSH manual, doc/lsh.info
or doc/lsh.html.

117
For an introduction to the inner workings of LSH, see the file
118
doc/HACKING.
Niels Möller's avatar
Niels Möller committed
119 120 121 122 123 124 125

Several people have contributed to LSH, see the AUTHORS file for
details.

If you are interested in lsh, you may want to subscribe to the
psst-list. Subscription address is psst-request@net.lut.ac.uk.

Niels Möller's avatar
Niels Möller committed
126
LSH releases are available at
127 128
<http://www.lysator.liu.se/~nisse/archive/> and
<ftp://ftp.lysator.liu.se/pub/security/lsh>.
Niels Möller's avatar
Niels Möller committed
129

Niels Möller's avatar
Niels Möller committed
130
Happy hacking,
Niels Möller's avatar
Niels Möller committed
131
/Niels Möller <nisse@lysator.liu.se>