Now that PuTTY is actually using names "@putty.projects.tartarus.org", it

seems like a good idea to document them.

git-svn-id: svn://svn.tartarus.org/sgt/putty@7747 cda61777-01e9-0310-a592-d414129be87e

diff --git a/doc/Makefile b/doc/Makefile
index 36e3672..89b4be9 100644 (file)
--- a/doc/Makefile
+++ b/doc/Makefile
@@ -35,7 +35,7 @@ VERSIONIDS=vids
 endif
 
 CHAPTERS := $(SITE) blurb intro gs using config pscp psftp plink pubkey
-CHAPTERS += pageant errors faq feedback licence udp pgpkeys
+CHAPTERS += pageant errors faq feedback licence udp pgpkeys sshnames
 CHAPTERS += index $(VERSIONIDS)
 
 INPUTS = $(patsubst %,%.but,$(CHAPTERS))

diff --git a/doc/sshnames.but b/doc/sshnames.but
new file mode 100644 (file)
index 0000000..97acc7b
--- /dev/null
+++ b/doc/sshnames.but
@@ -0,0 +1,77 @@
+\define{versionidsshnames} \versionid $Id$
+
+\A{sshnames} SSH-2 names specified for PuTTY
+
+There are various parts of the SSH-2 protocol where things are specified
+using a textual name.  Names ending in \cw{@putty.projects.tartarus.org}
+are reserved for allocation by the PuTTY team.  Allocated names are
+documented here.
+
+\H{sshnames-global} Connection protocol global request name
+
+This name can be sent in a \cw{SSH_MSG_GLOBAL_REQUEST} message.
+
+\dt \cw{simple@putty.projects.tartarus.org}
+
+\dd This is sent by a client to announce that it will not have more that
+one channel open at a time in the current connection.  The intention
+is that the server, knowing this, can set the window on that one
+channel to something very large, and leave flow control to TCP.  The
+format of the request is:
+
+\lcont{
+
+\c byte      SSH_MSG_GLOBAL_REQUEST
+\c uint32    recipient channel
+\c string    "simple@putty.projects.tartarus.org"
+\c boolean   want reply
+
+}
+
+\H{sshnames-channel} Connection protocol channel request name
+
+This name can be sent in a \cw{SSH_MSG_CHANNEL_REQUEST} message.
+
+\dt \cw{winadj@putty.project.tartarus.org}
+
+\dd PuTTY sends this request along with some
+\cw{SSH_MSG_CHANNEL_WINDOW_ADJUST} messages as part of its window-size
+tuning.  It can be sent on any type of channel.  Servers MUST treat it
+as an unrecognised request and respond with
+\cw{SSH_MSG_CHANNEL_FAILURE}.
+
+\H{sshnames-kex} Key exchange method names
+
+\dt \cw{rsa-sha1-draft-00@putty.projects.tartarus.org}
+
+\dt \cw{rsa-sha256-draft-00@putty.projects.tartarus.org}
+
+\dt \cw{rsa1024-sha1-draft-01@putty.projects.tartarus.org}
+
+\dt \cw{rsa1024-sha256-draft-01@putty.projects.tartarus.org}
+
+\dt \cw{rsa2048-sha256-draft-01@putty.projects.tartarus.org}
+
+\dt \cw{rsa1024-sha1-draft-02@putty.projects.tartarus.org}
+
+\dt \cw{rsa2048-sha512-draft-02@putty.projects.tartarus.org}
+
+\dt \cw{rsa1024-sha1-draft-03@putty.projects.tartarus.org}
+
+\dt \cw{rsa2048-sha256-draft-03@putty.projects.tartarus.org}
+
+\dt \cw{rsa1024-sha1-draft-04@putty.projects.tartarus.org}
+
+\dt \cw{rsa2048-sha256-draft-04@putty.projects.tartarus.org}
+
+\dd These appeared in various drafts of what eventually became RFC\_4432.
+They have been superseded by \cw{rsa1024-sha1} and \cw{rsa2048-sha256}.
+
+\H{sshnames-encrypt} Encryption algorithm names
+
+\dt \cw{arcfour128-draft-00@putty.projects.tartarus.org}
+
+\dt \cw{arcfour256-draft-00@putty.projects.tartarus.org}
+
+\dd These were used in drafts of what eventually became RFC\_4345.
+They have been superseded by \cw{arcfour128} and \cw{arcfour256}.