1
2 Description
3 -----------
4
5 hsftp is an ftp emulator that provides the look-and-feel of
6 an ftp session, but uses ssh to transport commands and data.
7
8 hsftp is written in C, and is known to compile with gcc under Linux.
9 No additional libraries are required.
10 No dedicated daemon (in addition to the sshd daemon) is required to run
11 on the server side.
12
13 Caveats
14 -------
15
16 hsftp executes UNIX commands on the remote host, and thus will fail on
17 non-unix remote hosts.
18
19 If you need a password, hsftp will ask for it. The password is encrypted
20 by ssh before transmission. hsftp will cache the password internally, so
21 you do not need to type it in again during a session. However, if hsftp
22 is not set SUID root, the password might get paged out to
23 your swap partition during prolonged inactivity.
24
25 IF YOU FEAR THAT THERE MAY BE SECURITY HOLES IN HSFTP
26 use the 'configure' option '--with-drop-root', which will cause
27 hsftp to drop root privileges irrevocably immediately on startup,
28 after locking the memory for the password.
29 Note that on some systems, this may cause other security
30 problems with the allocated pseudoterminal.
31
32 For RSA authentication, you may use ssh-agent, if you don't want to
33 set hsftp SUID root.
34
35 For speed, hsftp doesn't check whether a 'cd' on the remote host
36 is valid (i.e. whether the remote directory exists.)
37 get/put is always recursive. Already existing files are always overwritten.
38
39 Installation
40 ------------
41
42 Issue the commands:
43
44 ./configure
45 make
46 make install
47
48 To change the install directory (default: /usr/local/bin), to
49 /myinstall/directory/bin, use:
50
51 ./configure --prefix=/myinstall/directory
52
53
54 'readline' support: if you have the GNU readline library installed,
55 which allows command line editing and command history, i.e. more comfort,
56 then use the option:
57
58 ./configure --with-readline[=arg]
59 make
60 make install
61
62 ('arg' is the directory containing the readline library; usually this
63 is not required).
64
65
66 OpenSSH support: to use hsftp with OpenSSH, you need the
67 configure argument '--with-openssh'.
68
69 For a list of supported configuration options, type:
70
71 ./configure --help
72
73
74 Security
75 --------
76
77 If you need a password for ssh, you will be asked for it by hsftp.
78 The password will be kept in memory. It may be paged out to your
79 swap partition, if you leave the program idle for some time.
80
81 To avoid this, and enable hsftp to protect the password against swapping,
82 it is neccessary to give SUID root permissions to hsftp. The install
83 procedure will NOT do that, as it is not required for hsftp to work.
84 If you want it, you should do it by hand:
85 su root; chown root hsftp; chmod u+s hsftp
86
87 Please note that giving SUID root permissions to any executable is always
88 a security risk, as the respective program might have accidential
89 security holes.
90 While some care has been taken to avoid security holes in hsftp, I do not
91 guarantee that the program is free from them.
92
93 IF YOU FEAR THAT THERE MAY BE SECURITY HOLES IN HSFTP
94 use the 'configure' option '--with-drop-root', which will cause
95 hsftp to drop root privileges irrevocably immediately on startup,
96 after locking the memory for the password.
97 Note that on some systems, this may cause other security
98 problems with the allocated pseudoterminal.
99
100 For RSA authentication, you may use ssh-agent, if you don't want to
101 set hsftp SUID root.
102
103
104 Portability
105 -----------
106
107 This program has been developed on Linux. It is known to compile on a variety
108 of other UNIX flavours (at least Linux, FreeBSD, Solaris, AIX, and HP-UX),
109 but may not work on all. In particular, it may fail on HP-UX.
110
111 Fixes for portability are welcome for inclusion.
112
113
114 License
115 -------
116
117 Copyright (c) 2000 Rainer Wichmann <rwichmann@la-samhna.de>.
118 Distributed under the terms of the GNU General Public License.
119
120
121
122 Contains parts from the rxvt 'command.c' source file, which includes
123 the following copyright statement:
124
125/*--------------------------------*-C-*---------------------------------*
126 * File: command.c
127 *----------------------------------------------------------------------*
128 * $Id: command.c,v 1.85.2.25 2000/01/04 11:20:02 mason Exp $
129 *
130 * All portions of code are copyright by their respective author/s.
131 * Copyright (C) 1992 John Bovey, University of Kent at Canterbury <jdb@ukc.ac.uk>
132 * - original version
133 * Copyright (C) 1994 Robert Nation <nation@rocket.sanders.lockheed.com>
134 * - extensive modifications
135 * Copyright (C) 1995 Garrett D'Amore <garrett@netcom.com>
136 * - vt100 printing
137 * Copyright (C) 1995 Steven Hirsch <hirsch@emba.uvm.edu>
138 * - X11 mouse report mode and support for
139 * DEC "private mode" save/restore functions.
140 * Copyright (C) 1995 Jakub Jelinek <jj@gnu.ai.mit.edu>
141 * - key-related changes to handle Shift+function
142 * keys properly.
143 * Copyright (C) 1997 MJ Olesen <olesen@me.queensu.ca>
144 * - extensive modifications
145 * Copyright (C) 1997 Raul Garcia Garcia <rgg@tid.es>
146 * - modification and cleanups for Solaris 2.x
147 * and Linux 1.2.x
148 * Copyright (C) 1997,1998 Oezguer Kesim <kesim@math.fu-berlin.de>
149 * Copyright (C) 1998 Geoff Wing <gcw@pobox.com>
150 * Copyright (C) 1998 Alfredo K. Kojima <kojima@windowmaker.org>
151 *
152 * This program is free software; you can redistribute it and/or modify
153 * it under the terms of the GNU General Public License as published by
154 * the Free Software Foundation; either version 2 of the License, or
155 * (at your option) any later version.
156 *
157 * This program is distributed in the hope that it will be useful,
158 * but WITHOUT ANY WARRANTY; without even the implied warranty of
159 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
160 * GNU General Public License for more details.
161 *
162 * You should have received a copy of the GNU General Public License
163 * along with this program; if not, write to the Free Software
164 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
165 *----------------------------------------------------------------------*/
166
167
168
169
170 Contains the 'dirz' subroutine from trustfile.c, wich has the following
171 license statement:
172
173/*
174 * Author information:
175 * Matt Bishop
176 * Department of Computer Science
177 * University of California at Davis
178 * Davis, CA 95616-8562
179 * phone (916) 752-8060
180 * email bishop@cs.ucdavis.edu
181 *
182 * This code is placed in the public domain. I do ask that
183 * you keep my name associated with it, that you not represent
184 * it as written by you, and that you preserve these comments.
185 * This software is provided "as is" and without any guarantees
186 * of any sort.
187 */
188