Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/mRemoteNG/PuTTYNG.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2022-10-28Update version number for 0.78 release.Simon Tatham
2022-10-22Document subdomain matching of cert expr wildcards.Jacob Nevins
In the manual, in comments, and in a new test.
2022-10-22Docs: fix trivial typo from 6472f7fc77.Jacob Nevins
2022-10-21Docs: tweak certified-host-key warning responses.Jacob Nevins
Mainly to try to clarify that if you're sat at this warning dialog/ prompt, no response you make to it will cause a new CA to be trusted for signing arbitrary host keys.
2022-10-21Docs: cross-reference host-key warning sections.Jacob Nevins
The 'certified host key' variant of the host key warning always comes with a scary 'POTENTIAL SECURITY BREACH!' message. So the error message section with the scary title that should acknowledge that variant, and the section about that variant should mention the scary warning.
2022-10-21Docs: note "wrong host key" warning is stronger.Jacob Nevins
To try to prime readers learning the often-seen "unknown host key" warning to recognise the rarer and scarier "wrong host key" warning, if they see it.
2022-10-21Rename NTRU Prime / Curve25519 kex in UI.Jacob Nevins
The previous name, which included '(quantum-resistant)', was too long to be completely seen in the Windows config dialog's kex list (which is narrower than the Gtk one, due to the Up/Down buttons). No point including that explanation if people can't actually read it, so we'll have to rely on docs to explain it. (I did try squashing the rest of the name to "SNTRUP/X25519 hybrid", but that wasn't enough.) As some sort of compensation, index it more thoroughly in the docs, and while I'm there, tweak the indexing of other key exchange algorithms too.
2022-10-21Docs: update Pageant key list description.Jacob Nevins
GUI Pageant stopped using SSH identifiers for key types in fea08bb244, but the docs were still referring to them. As part of this, ensure that the term "NIST" is thoroughly cross-referenced and indexed, since it now appears so prominently in Pageant. (While I'm there, reword the "it's OK that elliptic-curve keys are smaller than RSA ones" note, as I kept tripping over the old wording.)
2022-10-21Docs: MD5 is forced for SSH-1 key fingerprints.Jacob Nevins
2022-10-21Docs: prime generation defaults are usually fine.Jacob Nevins
2022-10-21Docs: note warning about <2048-bit RSA/DSA keys.Jacob Nevins
2022-10-21Docs: PuTTYgen: fix gratuitous exclusion of PSFTP.Jacob Nevins
2022-10-21Docs: add index alias for "ECDSA".Jacob Nevins
2022-10-21cmdgen: Fix docs and usage messages.Jacob Nevins
Some new cert-related stuff wasn't documented in the usage message and/or man page; and the longer-standing "-E fptype" was entirely omitted from the usage message.
2022-10-21Document Windows PuTTYgen "-t ed25519" / "ed448".Jacob Nevins
2022-10-19Fix installing man pages from our tarballs.Jacob Nevins
As of the cyclic-dependency fix in b01173c6b7, building from our tarball using the instructions in its README (using the source tree as build tree), in the absence of Halibut, would lead to the pre-built man pages not being installed. (Also, a load of "Could not build man page" complaints at cmake generation time, which is how I actually noticed.)
2022-09-14New FAQ entry about the Microsoft Store.Jacob Nevins
2022-09-12Standardise RFC URLs in docs and comments.Jacob Nevins
(Plus one internet-draft URL.)
2022-09-12docs: Stop recommending DH gex over fixed groups.Jacob Nevins
With the new larger fixed-group methods, it's less clearly always the right answer. (Really it seems more sensible to use ECDH over any of the integer DH, these days.) Also, reword other kex descriptions a bit.
2022-09-10docs: Mention NTRU-Prime/Curve25519 kex.Jacob Nevins
2022-09-10docs: Document the new ECDH/DH kex methods.Jacob Nevins
And provide more detail on what kex methods actually involve, notably the hashes.
2022-09-10docs: GSS kex preferences aren't configurable.Jacob Nevins
2022-09-10docs: Reference GSSAPI pane from GSSAPI-kex.Jacob Nevins
2022-09-01Fix cyclic dependency in docs build.Simon Tatham
If Halibut is not available to build the docs, but on the other hand pre-built man pages already exist (e.g. because you unpacked a source zip file with them already provided), then docs/CMakeLists.txt creates a set of build rules that copy the pre-built man pages from the source directory to the build directory. However, if the source and build directories are the _same_, this creates a set of cyclic dependencies, i.e. files which depend directly on themselves. Some build tools (in particular 'ninja') will report this as an error. In that situation, the simple fix is to leave off the build rules completely: if the man pages are already where the build will want them to end up, there need not be any build rule to do anything about them.
2022-09-01New feature: k-i authentication helper plugins.Simon Tatham
In recent months I've had two requests from different people to build support into PuTTY for automatically handling complicated third-party auth protocols layered on top of keyboard-interactive - the kind of thing where you're asked to enter some auth response, and you have to refer to some external source like a web server to find out what the right response _is_, which is a pain to do by hand, so you'd prefer it to be automated in the SSH client. That seems like a reasonable thing for an end user to want, but I didn't think it was a good idea to build support for specific protocols of that kind directly into PuTTY, where there would no doubt be an ever-lengthening list, and maintenance needed on all of them. So instead, in collaboration with one of my correspondents, I've designed and implemented a protocol to be spoken between PuTTY and a plugin running as a subprocess. The plugin can opt to handle the keyboard-interactive authentication loop on behalf of the user, in which case PuTTY passes on all the INFO_REQUEST packets to it, and lets it make up responses. It can also ask questions of the user if necessary. The protocol spec is provided in a documentation appendix. The entire configuration for the end user consists of providing a full command line to use as the subprocess. In the contrib directory I've provided an example plugin written in Python. It gives a set of fixed responses suitable for getting through Uppity's made-up k-i system, because that was a reasonable thing I already had lying around to test against. But it also provides example code that someone else could pick up and insert their own live response-provider into the middle of, assuming they were happy with it being in Python.
2022-08-30New bug workaround: KEXINIT filtering.Simon Tatham
We've occasionally had reports of SSH servers disconnecting as soon as they receive PuTTY's KEXINIT. I think all such reports have involved the kind of simple ROM-based SSH server software you find in small embedded devices. I've never been able to prove it, but I've always suspected that one possible cause of this is simply that PuTTY's KEXINIT is _too long_, either in number of algorithms listed or in total length (especially given all the ones that end in @very.long.domain.name suffixes). If I'm right about either of those being the cause, then it's just become even more likely to happen, because of all the extra Diffie-Hellman groups and GSSAPI algorithms we just threw into our already-long list in the previous few commits. A workaround I've had in mind for ages is to wait for the server's KEXINIT, and then filter our own down to just the algorithms the server also mentioned. Then our KEXINIT is no longer than that of the server, and hence, presumably fits in whatever buffer it has. So I've implemented that workaround, in anticipation of it being needed in the near future. (Well ... it's not _quite_ true that our KEXINIT is at most the same length as the server. In fact I had to leave in one KEXINIT item that won't match anything in the server's list, namely "ext-info-c" which gates access to SHA-2 based RSA. So if we turn out to support absolutely everything on all the server's lists, then our KEXINIT would be a few bytes longer than the server's, even with this workaround. But that would only cause trouble if the server's outgoing KEXINIT was skating very close to whatever buffer size it has for the incoming one, and I'm guessing that's not very likely.) ((Another possible cause of this kind of disconnection would be a server that simply objects to seeing any KEXINIT string it doesn't know how to speak. But _surely_ no such server would have survived initial testing against any full-featured client at all!))
2022-08-19Docs: acknowledge AES-GCM.Jacob Nevins
2022-08-07Documentation for OpenSSH certificates.Simon Tatham
Also I've filled in the help contexts in all the new GUI controls.
2022-05-27Update Unix build instructions in FAQ.Jacob Nevins
(Bit late, but never mind.)
2022-05-27Merge tag '0.77'Simon Tatham
2022-05-25We're unlikely to spend donations on Windows XP.Jacob Nevins
2022-05-25FAQ: cross-reference command-line docs.Jacob Nevins
2022-05-25Tweak the "PSCP filenames with spaces" FAQ.Jacob Nevins
These days it's overwhelmingly likely that SFTP will be in use, so deal with that case first.
2022-05-25Acknowledge existence of Windows 11.Jacob Nevins
(PuTTY has been seen running on it.)
2022-05-25Remove reference to Bugtraq.Jacob Nevins
(Rather showing our age...)
2022-05-24Update version number for 0.77 release.Simon Tatham
2022-05-20Merge docs and icon fixes from 'pre-0.77'.Jacob Nevins
2022-05-20Indexing for Windows Pageant command-line options.Jacob Nevins
2022-05-20Document Windows PuTTYgen's -E option.Jacob Nevins
This was missed in 11aa9ab8f3.
2022-04-29Update proxy docs to reflect recent changes.Jacob Nevins
For new UI in 2a26ebd0d5, and new features added in 6f7c52dcce.
2022-04-29Merge proxy docs tweaks from 'pre-0.77'.Jacob Nevins
2022-04-29Tweaks to proxy documentation.Jacob Nevins
2022-02-22Merge GSSAPI/DNS docs addition from 'pre-0.77'.Simon Tatham
2022-02-22Add a docs note about DNS performed by GSSAPI.Simon Tatham
I recently noticed a mysterious delay at connection startup while using an SSH jump host, and investigated it in case it was a bug in the new jump host code that ought to be fixed before 0.77 goes out. strace showed that at the time of the delay PuTTY was doing a DNS lookup for the destination host, which was hanging due to the authoritative DNS server in question not being reachable. But that was odd, because I'd configured it to leave DNS lookup to the proxy, anticipating exactly that problem. But on closer investigation, the _proxy_ code was doing exactly what I'd told it. The DNS lookup was coming from somewhere else: namely, an (unsuccessful) attempt to set up a GSSAPI context. The GSSAPI library had called gethostbyname, completely separately from PuTTY's own use of DNS. Simple workaround for me: turn off GSSAPI, which doesn't work for that particular SSH connection anyway, and there's no point spending 30 seconds faffing just to find that out. But also, if that puzzled me, it's worth documenting!
2022-02-05Windows Pageant: option to open an AF_UNIX socket.Simon Tatham
There's now a command-line option to make Pageant open an AF_UNIX socket at a pathname of your choice. This allows it to act as an SSH agent for any client program willing to use a WinSock AF_UNIX socket. In particular, this allows WSL 1 processes to talk directly to Windows Pageant without needing any intermediate process, because the AF_UNIX sockets in the WSL 1 world interoperate with WinSock's ones. (However, not WSL 2, which isn't very surprising.)
2022-01-27Update usage messages embedded in docs.Jacob Nevins
For changes in 44ee7b9e76.
2022-01-26Pageant docs: improve the new OpenSSH section.Simon Tatham
I tried setting this up on a different Windows machine today and had some slightly different experiences. I found that in at least some situations the command 'Include c:\...\pageant.conf' will cause OpenSSH to emit a log message saying it's trying to open the file '~/.ssh/c:\...\pageant.conf', which it then doesn't find. But 'Include pageant.conf' works, because that's interpreted relative to the .ssh directory that it's already found. (I don't know why this happened on one Windows machine and not another, since I only have a sample size of two. But an obvious guess would be a bug fix in the Windows OpenSSH port, present in the version on one of the machines I tried, and not in the other. Certainly that failure mode looks to me like 'apply Unix instead of Windows rules to decide what's an absolute pathname'.) Also, clarified that all of this only works with the version of OpenSSH that's available as a Windows optional feature, and not with the MSYS-based one that ships with Windows git.
2022-01-22Windows PuTTYgen docs: remove redundant text.Simon Tatham
When I was writing the documentation for the new command-line options, I wondered why there was an existing section for the corresponding GUI setting for each option I'd added except strong primes. Now I've found it: strong primes are discussed in the same section as prime- generation methods. So I can replace the second explanation with a cross-reference.
2022-01-22Remove the prohibition on // comments.Simon Tatham
Those were forbidden so that we could still compile on pre-C99 C compilers. But now we expect C99 everywhere (or at least most of it, excluding the parts that MSVC never implemented and C11 made optional), so // comments aren't forbidden any more. Most of the comments in this code base are still old-style, but that's now a matter of stylistic consistency rather than hard requirement.
2022-01-22Update source file names in comments and docs.Simon Tatham
Correcting a source file name in the docs just now reminded me that I've seen a lot of outdated source file names elsewhere in the code, due to all the reorganisation since we moved to cmake. Here's a giant pass of trying to make them all accurate again.