1
0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-01-09 09:27:59 +00:00
Go to file
Simon Tatham 96ec2c2500 Get rid of lots of implicit pointer types.
All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
describe structure types themselves rather than pointers to them. The
same goes for the codebase-wide trait types Socket and Plug, and the
supporting types SockAddr and Pinger.

All those things that were typedefed as pointers are older types; the
newer ones have the explicit * at the point of use, because that's
what I now seem to be preferring. But whichever one of those is
better, inconsistently using a mixture of the two styles is worse, so
let's make everything consistent.

A few types are still implicitly pointers, such as Bignum and some of
the GSSAPI types; generally this is either because they have to be
void *, or because they're typedefed differently on different
platforms and aren't always pointers at all. Can't be helped. But I've
got rid of the main ones, at least.
2018-10-04 19:10:23 +01:00
charset Fix a collection of type / format string mismatches. 2017-06-20 07:05:39 +01:00
contrib Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
doc Add option whether to include header when logging. 2018-09-26 12:13:01 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
windows Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
.gitignore Remove Makefile.bor. 2017-09-13 19:26:28 +01:00
agentf.c Fix spurious EOF in agent forwarding! 2018-09-24 14:44:29 +01:00
aqsync.c Build outgoing SSH agent requests in a strbuf. 2018-05-25 14:36:16 +01:00
be_all_s.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_all.c Turn Backend into a sensible classoid. 2018-09-19 22:10:58 +01:00
be_misc.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +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
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
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
CHECKLST.txt Rework the release checklist for current practice. 2017-07-03 07:45:40 +01:00
cmdgen.c Put an optional IdempotentCallback in bufchains. 2018-09-24 18:50:25 +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 Fix shortcut clash in Windows builds. 2018-09-26 23:38:56 +01:00
configure.ac Enable -Wpointer-arith in the autoconf build. 2018-05-26 13:37:46 +01:00
cproxy.c Turn SSH-2 MACs into a classoid. 2018-09-19 23:08:07 +01:00
defs.h Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
dialog.c Giant const-correctness patch of doom! 2015-05-15 12:47:44 +01:00
dialog.h Expose the structure tag 'dlgparam'. 2018-09-19 23:08:07 +01:00
errsock.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
fuzzterm.c Clean up a 'void *' in a unix.h typedef. 2018-09-19 23:08:07 +01:00
import.c Turn SSH-2 ciphers into a classoid. 2018-09-19 23:08:07 +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
LATEST.VER Update version number for 0.70 release. 2017-07-04 20:29:54 +01:00
ldisc.c Rework special-commands system to add an integer argument. 2018-09-24 09:43:39 +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 Copyright holders update after GSS kex. 2018-04-26 07:21:29 +01:00
licence.pl Autogenerate licence text in doc subdir from LICENCE. 2015-12-22 13:33:42 +00:00
logging.c Flush log file after asynchronous askappend. 2018-10-01 21:03:34 +01:00
marshal.c Make put_padding() have a consistent argument order. 2018-06-13 19:42:19 +01:00
marshal.h Turn SSH-2 MACs into a classoid. 2018-09-19 23:08:07 +01:00
minibidi.c Fix a collection of type / format string mismatches. 2017-06-20 07:05:39 +01:00
misc.c Put an optional IdempotentCallback in bufchains. 2018-09-24 18:50:25 +01:00
misc.h Put an optional IdempotentCallback in bufchains. 2018-09-24 18:50:25 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01: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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
pageant.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
pageant.h Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
portfwd.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
pproxy.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
proxy.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
proxy.h Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
pscp.c pscp: remove a relic of GUI feedback mode. 2018-10-02 18:34:38 +01:00
psftp.c Rework special-commands system to add an integer argument. 2018-09-24 09:43:39 +01:00
psftp.h Log when -restrict-acl is in use. 2017-02-11 00:44:00 +00:00
putty.h Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
README Remove Makefile.bor. 2017-09-13 19:26:28 +01:00
Recipe Move most of ssh.c out into separate source files. 2018-09-24 19:45:22 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
sercfg.c Expose the structure tag 'dlgparam'. 2018-09-19 23:08:07 +01:00
sessprep.c Factor out common pre-session-launch preparation. 2017-12-03 14:54:49 +00:00
settings.c Add option whether to include header when logging. 2018-09-26 12:13:01 +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
ssh1bpp.c Fix use-after-free on a network error. 2018-09-28 11:26:26 +01:00
ssh1censor.c Move binary packet protocols and censoring out of ssh.c. 2018-06-09 14:41:30 +01:00
ssh1connection.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
ssh1login.c Fix mishandling of user abort during SSH-1 auth. 2018-09-25 08:58:46 +01:00
ssh2bpp-bare.c Fix use-after-free on a network error. 2018-09-28 11:26:26 +01:00
ssh2bpp.c Fix use-after-free on a network error. 2018-09-28 11:26:26 +01:00
ssh2censor.c Move binary packet protocols and censoring out of ssh.c. 2018-06-09 14:41:30 +01:00
ssh2connection.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
ssh2transport.c Fix accidental termination of wait-for-rekey loop. 2018-09-25 17:12:22 +01:00
ssh2userauth.c Move most of ssh.c out into separate source files. 2018-09-24 19:45:22 +01:00
ssh.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
ssh.h Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
sshaes.c Remove duplicate typedef of AESContext. 2018-09-20 23:46:45 +01:00
ssharcf.c Turn SSH-2 ciphers into a classoid. 2018-09-19 23:08:07 +01:00
sshbcrypt.c Replace all uses of SHA*_Bytes / MD5Update. 2018-05-25 14:36:16 +01:00
sshblowf.c Turn SSH-2 ciphers into a classoid. 2018-09-19 23:08:07 +01:00
sshblowf.h Turn SSH-2 ciphers into a classoid. 2018-09-19 23:08:07 +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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
sshccp.c Turn SSH-2 MACs into a classoid. 2018-09-19 23:08:07 +01:00
sshchan.h Move the zombiechan implementation into sshcommon.c. 2018-09-19 23:08:28 +01:00
sshcommon.c Move most of ssh.c out into separate source files. 2018-09-24 19:45:22 +01:00
sshcr.h Tweak crWaitUntil macros for greater robustness. 2018-09-24 18:50:25 +01:00
sshcrc.c Fix a 64-bit-cleanness error in sshcrc's generator. 2016-01-26 22:09:01 +00:00
sshcrcda.c Expose the structure tag 'crcda_ctx'. 2018-09-19 23:08:07 +01:00
sshdes.c Fix copy-paste error in sshdes.c. 2018-09-20 17:51:42 +01:00
sshdh.c Expose the 'dh_ctx' struct tag used for Diffie-Hellman. 2018-09-19 23:08:07 +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 Turn SSH hashes into a classoid. 2018-09-19 23:08:07 +01:00
sshecdsag.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshgss.h Move most of ssh.c out into separate source files. 2018-09-24 19:45:22 +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
sshmac.c Turn SSH-2 MACs into a classoid. 2018-09-19 23:08:07 +01:00
sshmd5.c Clean up a couple of consts and char pointers. 2018-09-19 23:08:07 +01:00
sshnogss.c Post-release destabilisation! Completely remove the struct type 2011-07-14 18:52:21 +00:00
sshppl.h Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01: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 Turn SSH hashes into a classoid. 2018-09-19 23:08:07 +01:00
sshrsag.c Reorganise ssh_keyalg and use it as a vtable. 2018-06-03 15:15:51 +01:00
sshsh256.c Turn SSH hashes into a classoid. 2018-09-19 23:08:07 +01:00
sshsh512.c Turn SSH hashes into a classoid. 2018-09-19 23:08:07 +01:00
sshsha.c Clean up a couple of consts and char pointers. 2018-09-19 23:08:07 +01:00
sshshare.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
sshverstring.c Fix use-after-free on a network error. 2018-09-28 11:26:26 +01:00
sshzlib.c Make ssh_compress into a pair of linked classoids. 2018-09-19 23:08:07 +01:00
storage.h Invent structure tags for the storage.h abstractions. 2018-09-19 23:08:07 +01:00
telnet.c Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00
terminal.c Rework handling of untrusted terminal data. 2018-09-19 23:08:28 +01:00
terminal.h Introduce a typedef for frontend handles. 2018-09-19 22:10:58 +01:00
testback.c Rework special-commands system to add an integer argument. 2018-09-24 09:43:39 +01:00
testbn.c Put an optional IdempotentCallback in bufchains. 2018-09-24 18:50:25 +01: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 tree234.c: new search234() system. 2018-09-19 23:08:28 +01:00
tree234.h tree234.c: new search234() system. 2018-09-19 23:08:28 +01: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 Get rid of lots of implicit pointer types. 2018-10-04 19:10:23 +01:00

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.