]> andersk Git - openssh.git/blobdiff - PROTOCOL
- (tim) [configure.ac] Define BROKEN_GETADDRINFO on SVR5 systems. The native
[openssh.git] / PROTOCOL
index 08b16dc167955d2555aa2d53302d26b42fbc7367..9b74b94754fdc19d08e84c8876e6d8eb3fec3cad 100644 (file)
--- a/PROTOCOL
+++ b/PROTOCOL
@@ -6,8 +6,11 @@ filexfer protocol described in:
 
 http://www.openssh.com/txt/draft-ietf-secsh-filexfer-02.txt
 
-Features from newer versions of the draft are not supported, unless
-explicitly implemented as extensions described below.
+Newer versions of the draft will not be supported, though some features
+are individually implemented as extensions described below.
+
+The protocol used by OpenSSH's ssh-agent is described in the file
+PROTOCOL.agent
 
 1. transport: Protocol 2 MAC algorithm "umac-64@openssh.com"
 
@@ -43,9 +46,9 @@ processes of the condition, e.g. by closing the corresponding file
 descriptor.
 
 OpenSSH implements a channel extension message to perform this
-signalling: "eow@openssh.com" (End Of Write). This message is sent by an
-endpoint when the local output of a channel is closed or experiences a
-write error. The message is formatted as follows:
+signalling: "eow@openssh.com" (End Of Write). This message is sent by
+an endpoint when the local output of a session channel is closed or
+experiences a write error. The message is formatted as follows:
 
        byte            SSH_MSG_CHANNEL_REQUEST
        uint32          recipient channel
@@ -61,6 +64,12 @@ remain open after a "eow@openssh.com" has been sent and more data may
 still be sent in the other direction. This message does not consume
 window space and may be sent even if no window space is available.
 
+NB. due to certain broken SSH implementations aborting upon receipt
+of this message (in contravention of RFC4254 section 5.4), this
+message is only sent to OpenSSH peers (identified by banner).
+Other SSH implementations may be whitelisted to receive this message
+upon request.
+
 4. connection: disallow additional sessions extension
    "no-more-sessions@openssh.com"
 
@@ -84,11 +93,16 @@ connection.
 Note that this is not a general defence against compromised clients
 (that is impossible), but it thwarts a simple attack.
 
+NB. due to certain broken SSH implementations aborting upon receipt
+of this message, the no-more-sessions request is only sent to OpenSSH
+servers (identified by banner). Other SSH implementations may be
+whitelisted to receive this message upon request.
+
 5. connection: Tunnel forward extension "tun@openssh.com"
 
-OpenSSH supports layer 2 and layer 3 tunneling via the "tun@openssh.com"
+OpenSSH supports layer 2 and layer 3 tunnelling via the "tun@openssh.com"
 channel type. This channel type supports forwarding of network packets
-with datagram boundaries entact between endpoints equipped with 
+with datagram boundaries intact between endpoints equipped with 
 interfaces like the BSD tun(4) device. Tunnel forwarding channels are
 requested by the client with the following packet:
 
@@ -107,10 +121,10 @@ layer 2 frames or layer 3 packets. It may take one of the following values:
        SSH_TUNMODE_ETHERNET     2              /* layer 2 frames */
 
 The "tunnel unit number" specifies the remote interface number, or may
-be zero to allow the server to automatically chose an interface. A server
-that is not willing to open a client-specified unit should refuse the
-request with a SSH_MSG_CHANNEL_OPEN_FAILURE error. On successful open,
-the server should reply with SSH_MSG_CHANNEL_OPEN_SUCCESS.
+be 0x7fffffff to allow the server to automatically chose an interface. A
+server that is not willing to open a client-specified unit should refuse
+the request with a SSH_MSG_CHANNEL_OPEN_FAILURE error. On successful
+open, the server should reply with SSH_MSG_CHANNEL_OPEN_SUCCESS.
 
 Once established the client and server may exchange packet or frames
 over the tunnel channel by encapsulating them in SSH protocol strings
@@ -137,18 +151,18 @@ It may be one of:
 The "packet data" field consists of the IPv4/IPv6 datagram itself
 without any link layer header.
 
-The contents of the "data" field for layer 3 packets is:
+The contents of the "data" field for layer 2 packets is:
 
        uint32                  packet length
        byte[packet length]     frame
 
-The "frame" field contains an IEEE 802.3 ethernet frame, including
+The "frame" field contains an IEEE 802.3 Ethernet frame, including
 header.
 
 6. sftp: Reversal of arguments to SSH_FXP_SYMLINK
 
 When OpenSSH's sftp-server was implemented, the order of the arguments
-to the SSH_FXP_SYMLINK method was inadvertendly reversed. Unfortunately,
+to the SSH_FXP_SYMLINK method was inadvertently reversed. Unfortunately,
 the reversal was not noticed until the server was widely deployed. Since
 fixing this to follow the specification would cause incompatibility, the
 current order was retained. For correct operation, clients should send
@@ -177,7 +191,7 @@ Each extension reports its integer version number as an ASCII encoded
 string, e.g. "1". The version will be incremented if the extension is
 ever changed in an incompatible way. The server MAY advertise the same
 extension with multiple versions (though this is unlikely). Clients MUST
-check the version number before attemping to use the extension.
+check the version number before attempting to use the extension.
 
 8. sftp: Extension request "posix-rename@openssh.com"
 
@@ -207,7 +221,7 @@ pathname, and is formatted as follows:
        string          "statvfs@openssh.com"
        string          path
 
-The "fstatvfs@openssh.com" operates on an open filehandle:
+The "fstatvfs@openssh.com" operates on an open file handle:
 
        uint32          id
        string          "fstatvfs@openssh.com"
@@ -234,7 +248,7 @@ The values of the f_flag bitmask are as follows:
        #define SSH_FXE_STATVFS_ST_RDONLY       0x1     /* read-only */
        #define SSH_FXE_STATVFS_ST_NOSUID       0x2     /* no setuid */
 
-This extension is advertised in the SSH_FXP_VERSION hello with version
-"2".
+Both the "statvfs@openssh.com" and "fstatvfs@openssh.com" extensions are
+advertised in the SSH_FXP_VERSION hello with version "2".
 
-$OpenBSD: PROTOCOL,v 1.7 2008/06/12 05:15:41 djm Exp $
+$OpenBSD: PROTOCOL,v 1.14 2010/01/09 00:57:10 djm Exp $
This page took 0.590864 seconds and 4 git commands to generate.