mirror of git://git.tartarus.org/simon/putty.git, used for client testing
Перейти к файлу
Simon Tatham 6a8b9d3813 Replace enum+union of local channel types with a vtable.
There's now an interface called 'Channel', which handles the local
side of an SSH connection-layer channel, in terms of knowing where to
send incoming channel data to, whether to close the channel, etc.

Channel and the previous 'struct ssh_channel' mutually refer. The
latter contains all the SSH-specific parts, and as much of the common
logic as possible: in particular, Channel doesn't have to know
anything about SSH packet formats, or which SSH protocol version is in
use, or deal with all the fiddly stuff about window sizes - with the
exception that x11fwd.c's implementation of it does have to be able to
ask for a small fixed initial window size for the bodgy system that
distinguishes upstream from downstream X forwardings.

I've taken the opportunity to move the code implementing the detailed
behaviour of agent forwarding out of ssh.c, now that all of it is on
the far side of a uniform interface. (This also means that if I later
implement agent forwarding directly to a Unix socket as an
alternative, it'll be a matter of changing just the one call to
agentf_new() that makes the Channel to plug into a forwarding.)
2018-09-19 23:08:04 +01:00
charset Fix a collection of type / format string mismatches. 2017-06-20 07:05:39 +01:00
contrib gdb.py: add a 'memdump' command. 2018-06-09 14:20:33 +01:00
doc GPG key rollover. 2018-08-25 14:38:47 +01:00
icons Make an OS X icon for pterm as well as PuTTY. 2016-03-23 22:02:46 +00:00
testdata Support ESC[38;2;R;G;Bm for 24-bit true colour. 2017-09-30 18:19:44 +01:00
unix Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
windows Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
.gitignore Remove Makefile.bor. 2017-09-13 19:26:28 +01:00
Buildscr Fix platform field in Windows on Arm installers. 2018-08-21 07:17:06 +01:00
Buildscr.cv Rename Makefile.cyg to Makefile.mgw. 2016-04-10 15:10:45 +01:00
CHECKLST.txt Rework the release checklist for current practice. 2017-07-03 07:45:40 +01:00
LATEST.VER Update version number for 0.70 release. 2017-07-04 20:29:54 +01:00
LICENCE Copyright holders update after GSS kex. 2018-04-26 07:21:29 +01:00
README Remove Makefile.bor. 2017-09-13 19:26:28 +01:00
Recipe Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
agentf.c Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
aqsync.c Build outgoing SSH agent requests in a strbuf. 2018-05-25 14:36:16 +01:00
be_all.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_all_s.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_misc.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
be_none.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_nos_s.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_nossh.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_ssh.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
callback.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
cgtest.c cmdgen: rescue test suite from bit rot. 2016-03-30 08:34:14 +01:00
cmdgen.c Make 'LogContext' a typedef visible throughout the code. 2018-09-19 22:10:57 +01:00
cmdline.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
conf.c Rewrite conf deserialisation using BinarySource. 2018-06-02 17:52:48 +01:00
config.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
configure.ac Enable -Wpointer-arith in the autoconf build. 2018-05-26 13:37:46 +01:00
cproxy.c Modernise the Socket/Plug vtable system. 2018-05-27 15:28:54 +01:00
defs.h Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
dialog.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
dialog.h Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
errsock.c Modernise the Socket/Plug vtable system. 2018-05-27 15:28:54 +01:00
fuzzterm.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
import.c New BinarySink function 'put_padding'. 2018-06-09 14:20:33 +01:00
int64.c Further correction: on reflection, after examining all the call 2008-09-16 22:56:08 +00:00
int64.h Introduce a centralised unmarshaller, 'BinarySource'. 2018-06-02 17:37:22 +01:00
ldisc.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
ldisc.h Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
ldiscucs.c Expose the Ldisc structure tag throughout the code. 2018-09-19 22:10:57 +01:00
licence.pl Autogenerate licence text in doc subdir from LICENCE. 2015-12-22 13:33:42 +00:00
logging.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
marshal.c Make put_padding() have a consistent argument order. 2018-06-13 19:42:19 +01:00
marshal.h Make put_padding() have a consistent argument order. 2018-06-13 19:42:19 +01:00
minibidi.c Fix a collection of type / format string mismatches. 2017-06-20 07:05:39 +01:00
misc.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
misc.h Further void * / const fixes. 2018-06-09 14:20:33 +01:00
miscucs.c New centralised helper function dup_mb_to_wc(). 2015-07-27 20:06:02 +01:00
mkauto.sh Move the Unix configure script up to the top level. 2014-02-22 18:01:32 +00:00
mkfiles.pl Makefile.clangcl: permit building for Windows on Arm. 2018-05-31 18:50:15 +01:00
mksrcarc.sh New script to generate OS X icon files. 2015-09-06 10:12:15 +01:00
mkunxarc.sh Turn mkunxarc.sh back into an ordinary sh script. 2014-10-01 20:52:16 +00:00
network.h Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
nocmdline.c Remove unused params from cmdline_get_passwd_input. 2018-05-18 07:22:56 +01:00
nocproxy.c Modernise the Socket/Plug vtable system. 2018-05-27 15:28:54 +01:00
nogss.c Rewrite gprefs() in settings.c so that its input mapping includes 2011-06-25 17:37:31 +00:00
noprint.c A few small changes to make the PuTTY source base more usable as a 2005-12-09 20:04:19 +00:00
noshare.c Fix the prototype of the stub function in noshare.c. 2014-04-22 17:53:50 +00:00
noterm.c Make calling term_nopaste() a cross-platform feature. 2013-08-17 16:06:40 +00:00
notiming.c Two related changes to timing code: 2012-09-18 21:42:48 +00:00
nullplug.c Merge duplicate implementations of the trivial Plug. 2018-05-27 15:45:00 +01:00
pageant.c winpgnt.c: handle arbitrarily large file mappings. 2018-07-09 20:17:13 +01:00
pageant.h Raise AGENT_MAX_MSGLEN to 256Kb. 2018-07-09 20:17:13 +01:00
pgssapi.c Fix a missing } in a GSSAPI-related comment. 2018-04-26 07:11:09 +01:00
pgssapi.h Support GSS key exchange, for Kerberos 5 only. 2018-04-26 07:21:16 +01:00
pinger.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
portfwd.c Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
pproxy.c Fix signature of platform_new_connection. 2015-08-15 13:54:55 +01:00
proxy.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
proxy.h Modernise the Socket/Plug vtable system. 2018-05-27 15:28:54 +01:00
pscp.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
psftp.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
psftp.h Log when -restrict-acl is in use. 2017-02-11 00:44:00 +00:00
putty.h Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
puttymem.h New memory management macro 'snew_plus'. 2018-06-06 07:22:06 +01:00
puttyps.h Delete the old 'macosx' directory completely. 2016-03-25 09:06:03 +00:00
raw.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
release.pl Add a --no-ftp mode to the release.pl download checks. 2017-07-08 09:27:57 +01:00
resource.h Initial checkin: beta 0.43 1999-01-08 13:02:13 +00:00
rlogin.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
sercfg.c Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
sessprep.c Factor out common pre-session-launch preparation. 2017-12-03 14:54:49 +00:00
settings.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
sftp.c Replace sftp_pkt_get* with BinarySource. 2018-06-02 17:43:54 +01:00
sftp.h Replace sftp_pkt_get* with BinarySource. 2018-06-02 17:43:54 +01:00
sign.sh GPG key rollover. 2018-08-25 14:38:47 +01:00
ssh.c Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
ssh.h Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
ssh1bpp.c Move password-packet padding into the BPP module. 2018-07-10 21:27:43 +01:00
ssh1censor.c Move binary packet protocols and censoring out of ssh.c. 2018-06-09 14:41:30 +01:00
ssh2bpp-bare.c Reinstate calls to ssh_free_pktout! 2018-07-09 20:59:36 +01:00
ssh2bpp.c Move password-packet padding into the BPP module. 2018-07-10 21:27:43 +01:00
ssh2censor.c Move binary packet protocols and censoring out of ssh.c. 2018-06-09 14:41:30 +01:00
sshaes.c Add a missing const 2018-05-26 15:26:34 +01:00
ssharcf.c Make lots of generic data parameters into 'void *'. 2018-05-26 09:22:43 +01:00
sshbcrypt.c Replace all uses of SHA*_Bytes / MD5Update. 2018-05-25 14:36:16 +01:00
sshblowf.c Make lots of generic data parameters into 'void *'. 2018-05-26 09:22:43 +01:00
sshblowf.h Make lots of generic data parameters into 'void *'. 2018-05-26 09:22:43 +01:00
sshbn.c Remove obsolete functions. 2018-06-02 18:24:12 +01:00
sshbn.h Add a case to sshbn.h for 64-bit Visual Studio. 2015-12-16 14:21:09 +00:00
sshbpp.h Make 'LogContext' a typedef visible throughout the code. 2018-09-19 22:10:57 +01:00
sshccp.c Further void * / const fixes. 2018-06-09 14:20:33 +01:00
sshchan.h Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00
sshcr.h Move some ssh.c declarations into header files. 2018-06-09 14:41:30 +01:00
sshcrc.c Fix a 64-bit-cleanness error in sshcrc's generator. 2016-01-26 22:09:01 +00:00
sshcrcda.c Unify GET_32BIT()/PUT_32BIT() et al from numerous source files into misc.h. 2005-04-12 20:04:56 +00:00
sshdes.c Make lots of generic data parameters into 'void *'. 2018-05-26 09:22:43 +01:00
sshdh.c Remove obsolete functions. 2018-06-02 18:24:12 +01:00
sshdss.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshdssg.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshecc.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshecdsag.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshgss.h Centralise definition of GSSAPI check interval. 2018-05-01 19:02:59 +01:00
sshgssc.c Support GSS key exchange, for Kerberos 5 only. 2018-04-26 07:21:16 +01:00
sshgssc.h Support GSS key exchange, for Kerberos 5 only. 2018-04-26 07:21:16 +01:00
sshmd5.c Further void * / const fixes. 2018-06-09 14:20:33 +01:00
sshnogss.c Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
sshprime.c Generate keys more carefully, so that when the user asks for an n-bit 2012-03-04 00:24:49 +00:00
sshpubk.c New BinarySink function 'put_padding'. 2018-06-09 14:20:33 +01:00
sshrand.c In random_add_noise, put the hashed noise into the pool, not the raw noise 2016-12-29 11:18:03 +00:00
sshrsa.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshrsag.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshsh256.c Further void * / const fixes. 2018-06-09 14:20:33 +01:00
sshsh512.c Make ssh_hash and ssh_mac expose a BinarySink. 2018-05-25 14:36:16 +01:00
sshsha.c Further void * / const fixes. 2018-06-09 14:20:33 +01:00
sshshare.c Make share_got_pkt_from_server take a const pointer. 2018-06-06 07:23:28 +01:00
sshzlib.c Move password-packet padding into the BPP module. 2018-07-10 21:27:43 +01:00
storage.h Turn 'Filename' into a dynamically allocated type with no arbitrary 2011-10-02 11:01:57 +00:00
telnet.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
terminal.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
terminal.h Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
testback.c Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
testbn.c Unix buildinfo: stop saying 'GTK' in pure CLI utilities. 2017-02-22 22:10:05 +00:00
time.c Comment explaining location in top-level directory. 2005-02-07 15:23:45 +00:00
timing.c Fix a potential time-wraparound issue in pinger.c. 2016-04-02 07:51:24 +01:00
tree234.c Another format-string fix. 2017-06-20 19:02:13 +01:00
tree234.h Run entire source base through GNU indent to tidy up the varying 2001-05-06 14:35:20 +00:00
version.c Show the git commit hash in local dev builds too. 2017-01-21 14:57:31 +00:00
version.h Show the git commit hash in local dev builds too. 2017-01-21 14:57:31 +00:00
wcwidth.c Update wcwidth.c with Unicode 9.0.0 data 2017-07-01 23:25:49 +01:00
wildcard.c Add a missing null pointer check in wc_unescape, to bring it in line 2013-07-14 10:46:17 +00:00
x11fwd.c Replace enum+union of local channel types with a vtable. 2018-09-19 23:08:04 +01:00

README

This is the README for the source archive of PuTTY, a free Windows
and Unix Telnet and SSH client.

If you want to rebuild PuTTY from source, we provide a variety of
Makefiles and equivalents. (If you have fetched the source from
Git, you'll have to generate the Makefiles yourself -- see
below.)

There are various compile-time directives that you can use to
disable or modify certain features; it may be necessary to do this
in some environments. They are documented in `Recipe', and in
comments in many of the generated Makefiles.

For building on Windows:

 - windows/Makefile.vc is for command-line builds on MS Visual C++
   systems. Change into the `windows' subdirectory and type `nmake
   -f Makefile.vc' to build all the PuTTY binaries.

   As of 2017, we successfully compile PuTTY with both Visual Studio
   7 (2003) and Visual Studio 14 (2015), so our guess is that it will
   probably build with versions in between those as well.

   (The binaries from Visual Studio 14 are only compatible with
   Windows XP and up. Binaries from Visual Studio 7 ought to work
   with anything from Windows 95 onward.)

 - Inside the windows/MSVC subdirectory are MS Visual Studio project
   files for doing GUI-based builds of the various PuTTY utilities.
   These have been tested on Visual Studio 7 and 10.

   You should be able to build each PuTTY utility by loading the
   corresponding .dsp file in Visual Studio. For example,
   MSVC/putty/putty.dsp builds PuTTY itself, MSVC/plink/plink.dsp
   builds Plink, and so on.

 - windows/Makefile.mgw is for MinGW / Cygwin installations. Type
   `make -f Makefile.mgw' while in the `windows' subdirectory to
   build all the PuTTY binaries.

   MinGW and friends can lag behind other toolchains in their support
   for the Windows API. Compile-time levers are provided to exclude
   some features; the defaults are set appropriately for the
   'mingw-w64' cross-compiler provided with Ubuntu 14.04. If you are
   using an older toolchain, you may need to exclude more features;
   alternatively, you may find that upgrading to a recent version of
   the 'w32api' package helps.

 - windows/Makefile.lcc is for lcc-win32. Type `make -f
   Makefile.lcc' while in the `windows' subdirectory. (You will
   probably need to specify COMPAT=-DNO_MULTIMON.)

 - Inside the windows/DEVCPP subdirectory are Dev-C++ project
   files for doing GUI-based builds of the various PuTTY utilities.

The PuTTY team actively use Makefile.vc (with VC7/10) and Makefile.mgw
(with mingw32), so we'll probably notice problems with those
toolchains fairly quickly. Please report any problems with the other
toolchains mentioned above.

For building on Unix:

 - unix/configure is for Unix and GTK. If you don't have GTK, you
   should still be able to build the command-line utilities (PSCP,
   PSFTP, Plink, PuTTYgen) using this script. To use it, change into
   the `unix' subdirectory, run `./configure' and then `make'. Or you
   can do the same in the top-level directory (we provide a little
   wrapper that invokes configure one level down), which is more like
   a normal Unix source archive but doesn't do so well at keeping the
   per-platform stuff in each platform's subdirectory; it's up to you.

 - unix/Makefile.gtk and unix/Makefile.ux are for non-autoconfigured
   builds. These makefiles expect you to change into the `unix'
   subdirectory, then run `make -f Makefile.gtk' or `make -f
   Makefile.ux' respectively. Makefile.gtk builds all the programs but
   relies on Gtk, whereas Makefile.ux builds only the command-line
   utilities and has no Gtk dependence.

 - For the graphical utilities, any of Gtk+-1.2, Gtk+-2.0, and Gtk+-3.0
   should be supported. If you have more than one installed, you can
   manually specify which one you want by giving the option
   '--with-gtk=N' to the configure script where N is 1, 2, or 3.
   (The default is the newest available, of course.) In the absence
   of any Gtk version, the configure script will automatically
   construct a Makefile which builds only the command-line utilities;
   you can manually create this condition by giving configure the
   option '--without-gtk'.

 - pterm would like to be setuid or setgid, as appropriate, to permit
   it to write records of user logins to /var/run/utmp and
   /var/log/wtmp. (Of course it will not use this privilege for
   anything else, and in particular it will drop all privileges before
   starting up complex subsystems like GTK.) By default the makefile
   will not attempt to add privileges to the pterm executable at 'make
   install' time, but you can ask it to do so by running configure
   with the option '--enable-setuid=USER' or '--enable-setgid=GROUP'.

 - The Unix Makefiles have an `install' target. Note that by default
   it tries to install `man' pages; if you have fetched the source via
   Git then you will need to have built these using Halibut
   first - see below.

 - It's also possible to build the Windows version of PuTTY to run
   on Unix by using Winelib.  To do this, change to the `windows'
   directory and run `make -f Makefile.mgw CC=winegcc RC=wrc'.

All of the Makefiles are generated automatically from the file
`Recipe' by the Perl script `mkfiles.pl' (except for the Unix one,
which is generated by the `configure' script; mkfiles.pl only
generates the input to automake). Additions and corrections to Recipe,
mkfiles.pl and/or configure.ac are much more useful than additions and
corrections to the actual Makefiles, Makefile.am or Makefile.in.

The Unix `configure' script and its various requirements are generated
by the shell script `mkauto.sh', which requires GNU Autoconf, GNU
Automake, and Gtk; if you've got the source from Git rather
than using one of our source snapshots, you'll need to run this
yourself. The input file to Automake is generated by mkfiles.pl along
with all the rest of the makefiles, so you will need to run mkfiles.pl
and then mkauto.sh.

Documentation (in various formats including Windows Help and Unix
`man' pages) is built from the Halibut (`.but') files in the `doc'
subdirectory using `doc/Makefile'. If you aren't using one of our
source snapshots, you'll need to do this yourself. Halibut can be
found at <https://www.chiark.greenend.org.uk/~sgtatham/halibut/>.

The PuTTY home web site is

    https://www.chiark.greenend.org.uk/~sgtatham/putty/

If you want to send bug reports or feature requests, please read the
Feedback section of the web site before doing so. Sending one-line
reports saying `it doesn't work' will waste your time as much as
ours.

See the file LICENCE for the licence conditions.