updates
[silc.git] / doc / draft-riikonen-silc-spec-01.nroff
index be7c1cc772c947ca38da6865574c6519c04dc532..1bdd54e2a276935c06e3e920a330cda976ef3a64 100644 (file)
@@ -8,7 +8,7 @@
 .ds RF FORMFEED[Page %]
 .ds CF
 .ds LH Internet Draft
-.ds RH 13 September 2000
+.ds RH 6 October 2000
 .ds CH
 .na
 .hy 0
@@ -16,8 +16,8 @@
 .nf
 Network Working Group                                      P. Riikonen
 Internet-Draft
-draft-riikonen-silc-spec-01.txt                      13 September 2000
-Expires: 13 May 2001
+draft-riikonen-silc-spec-01.txt                         6 October 2000
+Expires: 6 Jun 2001
 
 .in 3
 
@@ -78,54 +78,55 @@ Table of Contents
   2.2 Communication Inside a Cell ...............................  5
   2.3 Communication in the Network ..............................  6
   2.4 Channel Communication .....................................  7
-3 SILC Specification ............................................  7
-  3.1 Client ....................................................  7
-      3.1.1 Client ID ...........................................  8
-  3.2 Server ....................................................  9
-      3.2.1 Server's Local ID List ..............................  9
-      3.2.2 Server ID ........................................... 10
+  2.5 Router Connections ........................................  7
+3 SILC Specification ............................................  8
+  3.1 Client ....................................................  8
+      3.1.1 Client ID ...........................................  9
+  3.2 Server .................................................... 10
+      3.2.1 Server's Local ID List .............................. 10
+      3.2.2 Server ID ........................................... 11 
       3.2.3 SILC Server Ports ................................... 11
-  3.3 Router .................................................... 11
-      3.3.1 Router's Local ID List .............................. 11
-      3.3.2 Router's Global ID List ............................. 12
+  3.3 Router .................................................... 12
+      3.3.1 Router's Local ID List .............................. 12
+      3.3.2 Router's Global ID List ............................. 13
       3.3.3 Router's Server ID .................................. 13
-  3.4 Channels .................................................. 13
-      3.4.1 Channel ID .......................................... 14
-  3.5 Operators ................................................. 14
+  3.4 Channels .................................................. 14
+      3.4.1 Channel ID .......................................... 15
+  3.5 Operators ................................................. 15
   3.6 SILC Commands ............................................. 15
-  3.7 SILC Packets .............................................. 15
+  3.7 SILC Packets .............................................. 16
   3.8 Packet Encryption ......................................... 16
-      3.8.1 Determination of the Source and the Destination ..... 16
+      3.8.1 Determination of the Source and the Destination ..... 17
       3.8.2 Client To Client .................................... 17
-      3.8.3 Client To Channel ................................... 18
+      3.8.3 Client To Channel ................................... 19
       3.8.4 Server To Server .................................... 19
-  3.9 Key Exchange And Authentication ........................... 19
-  3.10 Algorithms ............................................... 19
-      3.10.1 Ciphers ............................................ 19
-      3.10.2 Public Key Algorithms .............................. 20
-      3.10.3 MAC Algorithms ..................................... 20
-      3.10.4 Compression Algorithms ............................. 21
-  3.11 SILC Public Key .......................................... 21
+  3.9 Key Exchange And Authentication ........................... 20
+  3.10 Algorithms ............................................... 20
+      3.10.1 Ciphers ............................................ 20
+      3.10.2 Public Key Algorithms .............................. 21
+      3.10.3 MAC Algorithms ..................................... 21
+      3.10.4 Compression Algorithms ............................. 22
+  3.11 SILC Public Key .......................................... 22
   3.12 SILC Version Detection ................................... 24
-4 SILC Procedures ............................................... 24
-  4.1 Creating Client Connection ................................ 24
-  4.2 Creating Server Connection ................................ 25
-  4.3 Joining to a Channel ...................................... 26
-  4.4 Channel Key Generation .................................... 27
-  4.5 Private Message Sending and Reception ..................... 27
-  4.6 Private Message Key Generation ............................ 28
-  4.7 Channel Message Sending and Reception ..................... 29
-  4.8 Session Key Regeneration .................................. 29
-  4.9 Command Sending and Reception ............................. 29
-5 SILC Commands ................................................. 30
-  5.1 SILC Commands Syntax ...................................... 30
-  5.2 SILC Commands List ........................................ 32
-  5.3 SILC Command Status Types ................................. 53
-      5.3.1 SILC Command Status Payload ......................... 53
-      5.3.2 SILC Command Status List ............................ 54
-6 Security Considerations ....................................... 59
-7 References .................................................... 59
-8 Author's Address .............................................. 60
+4 SILC Procedures ............................................... 25
+  4.1 Creating Client Connection ................................ 25
+  4.2 Creating Server Connection ................................ 26
+  4.3 Joining to a Channel ...................................... 27
+  4.4 Channel Key Generation .................................... 28
+  4.5 Private Message Sending and Reception ..................... 29
+  4.6 Private Message Key Generation ............................ 29
+  4.7 Channel Message Sending and Reception ..................... 30
+  4.8 Session Key Regeneration .................................. 30
+  4.9 Command Sending and Reception ............................. 30
+5 SILC Commands ................................................. 31
+  5.1 SILC Commands Syntax ...................................... 31
+  5.2 SILC Commands List ........................................ 33
+  5.3 SILC Command Status Types ................................. 56
+      5.3.1 SILC Command Status Payload ......................... 56
+      5.3.2 SILC Command Status List ............................ 57
+6 Security Considerations ....................................... 61
+7 References .................................................... 61
+8 Author's Address .............................................. 62
 
 
 .ti 0
@@ -135,8 +136,9 @@ List of Figures
 Figure 1:  SILC Network Topology
 Figure 2:  Communication Inside cell
 Figure 3:  Communication Between Cells
-Figure 4:  SILC Public Key
-Figure 5:  SILC Command Status Payload
+Figure 4:  Router Connections
+Figure 5:  SILC Public Key
+Figure 6:  SILC Command Status Payload
 
 
 .ti 0
@@ -202,7 +204,7 @@ This makes the network faster as there are less servers that needs to
 keep global information up to date at all time.
 
 This, on the other hand, leads to cellular like network, where routers 
-are in the centrum on the cell and servers are connected to the router.
+are in the center of the cell and servers are connected to the router.
 
 Following diagram represents SILC network topology.
 
@@ -274,8 +276,9 @@ recipient with at most two server hops.  Client who is connected to
 server in the cell and is talking on channel to other client connected 
 to other server in the same cell, will have its messages delivered from 
 its local server first to the router of the cell, and from the router 
-to the other server in the cell.  Following diagram represents this 
-scenario.
+to the other server in the cell.
+
+Following diagram represents this scenario:
 
 
 .in 25
@@ -363,6 +366,56 @@ joined to the channel.  Also, router distributes the message to its
 local clients on the channel.
 
 
+.ti 0
+2.5 Router Connections
+
+Router connections play very important role in making the SILC like
+network topology to work.  For example, sending broadcast packets in
+SILC network require special connections between routers; routers must
+be connected in specific way.
+
+Every router has their primary route which is a connection to another
+router in the network.  Unless there is only two routers in the network
+must not routers use each other as their primary routes.  The router
+connections in the network must form a circular.
+
+Example with three routers in the network:
+
+
+
+
+
+
+
+.in 16
+.nf
+    S/R1 - > - > - > - > - > - > - S/R2
+     \\                               /
+      v                             v
+       \\ - < -  < - S/R3 - < - < - /
+.in 3
+
+
+.ce
+Figure 4:  Router Connections
+
+
+Example:  Network with three routers.  Router 1. uses Router 2. as its
+          primary router.  Router 2. uses Router 3. as its primary router,
+          and Router 3. uses Router 1. as its primary router.  There may
+          be other direct connections between the routers but they must
+          not be used as primary routes.
+
+The above example is applicable to any amount of routers in the network
+except for two routers.  If there are only two routers in the network both
+routers must be able to handle situation where they use each other as their
+primary routes.
+
+The issue of router connections are very important especially with SILC
+broadcast packets.  Usually all router wide information in the network is
+distributed by SILC broadcast packets.
+
+
 .ti 0
 3. SILC Specification
 
@@ -448,7 +501,7 @@ truncated hash value.
 Servers are the most important parts of the SILC network.  They form the
 basis of the SILC, providing a point to which clients may connect to.
 There are two kinds of servers in SILC; normal servers and router servers.
-This section focuses on the normal server and router server is described
+This section focus on the normal server and router server is described
 in the section 3.3 Router.
 
 Normal servers may not directly connect to other normal server.  Normal
@@ -480,12 +533,6 @@ Normal server also keeps information about locally created channels and
 their Channel ID's.
 
 
-
-
-
-
-
-
 Hence, local list for normal server includes:
 
 .in 6
@@ -497,6 +544,9 @@ server list        - Router connection
    o Receiving key
    o Public key
 
+
+
+
 client list        - All clients in server
    o Nickname
    o Username@host
@@ -533,13 +583,13 @@ Client ID.  Server ID is defined as follows.
 o IP address of the server - This is the real IP address of
   the server.
 
-o Port - This is the port the server is binded to.
+o Port - This is the port the server is bound to.
 
 o Random number - This is used to further randomize the Server ID.
 
 .in 3
 Collisions are not expected to happen in any conditions.  The Server ID
-is always created by the server itself and server is resposible of
+is always created by the server itself and server is responsible of
 distributing it to the router.
 
 
@@ -590,9 +640,6 @@ since these are not needed by the router.  Router keeps only information
 that it needs.
 
 
-
-
-
 Hence, local list for router includes:
 
 .in 6
@@ -606,6 +653,7 @@ server list        - All servers in the cell
 client list        - All clients in the cell
    o Client ID
 
+
 channel list       - All channels in the cell
    o Channel ID
    o Client ID's on channel
@@ -670,7 +718,7 @@ created by the remote router where the router is connected to.
 A channel is a named group of one or more clients which will all receive
 messages addressed to that channel.  The channel is created when first
 client requests JOIN command to the channel, and the channel ceases to
-exist when the last client leaves it.  When channel exists, any client
+exist when the last client has left it.  When channel exists, any client
 can reference it using the name of the channel.
 
 Channel names are unique although the real uniqueness comes from 64 bit
@@ -803,7 +851,6 @@ SILC packets.
 
 
 
-
 .ti 0
 3.8 Packet Encryption
 
@@ -1002,16 +1049,12 @@ in the SILC packets.  See [SILC2] of the actual encryption process and
 definition of how it must be done.  SILC has a mandatory algorithm that
 must be supported in order to be compliant with this protocol.
 
-
-
-
-
-
 Following ciphers are defined in SILC protocol:
 
 .in 6
-blowfish-cbc    Blowfish in CBC mode  (mandatory)
+aes-cbc         AES in CBC mode       (mandatory)
 twofish-cbc     Twofish in CBC mode   (optional)
+blowfish-cbc    Blowfish in CBC mode  (optional)
 rc6-cbc         RC6 in CBC mode       (optional)
 rc5-cbc         RC5 in CBC mode       (optional)
 mars-cbc        Mars in CBC mode      (optional)
@@ -1058,10 +1101,6 @@ Data integrity is protected by computing a message authentication code
 (MAC) of the packet data.  See [SILC2] for details how to compute the
 MAC.
 
-
-
-
-
 Following MAC algorithms are defined in SILC protocol:
 
 .in 6
@@ -1113,11 +1152,6 @@ and to perform other tasks related to public key cryptography.
 The format of the SILC Public Key is as follows:
 
 
-
-
-
-
-
 .in 5
 .nf
                      1                   2                   3
@@ -1144,7 +1178,7 @@ The format of the SILC Public Key is as follows:
 .in 3
 
 .ce
-Figure 4:  SILC Public Key
+Figure 5:  SILC Public Key
 
 
 .in 6
@@ -1225,7 +1259,7 @@ order.
 
 The version detection of both client and server is performed at the
 connection phase while executing the SILC Key Exchange protocol.  The
-version identifier is exchanged between intiator and responder.  The
+version identifier is exchanged between initiator and responder.  The
 version identifier is of following format:
 
 .in 6
@@ -1246,6 +1280,7 @@ version as SILC-1.0-<sotware version>.
 Software version may provide major, minor and build version.  The
 software version may be freely set and accepted.
 
+
 Thus, the version string could be, for example:
 
 .in 6
@@ -1265,7 +1300,7 @@ are described in [SILC2] and [SILC3].
 .ti 0
 4.1 Creating Client Connection
 
-This section descibres the procedure when client connects to SILC server.
+This section describes the procedure when client connects to SILC server.
 When client connects to server the server must perform IP address lookup
 and reverse IP address lookup to assure that the origin host really is
 who it claims to be.  Client, host, connecting to server must have 
@@ -1375,7 +1410,7 @@ newly joined channel is sent to the router.  The new channel key is
 also distributed to the router and to all clients on the channel.
 
 If the channel does not exist in the local list the command must be
-fowarded to the router which will then perform the actual joining
+forwarded to the router which will then perform the actual joining
 procedure.  When server receives the reply to the command from the
 router it must be distributed to the client who sent the command
 originally.  Server will also receive the channel key from the server
@@ -1436,7 +1471,7 @@ The key must also be re-generated whenever some client leaves a channel.
 In this case the key is created from scratch by taking enough randomness
 from the random number generator.  After that the key is distributed to
 all clients on the channel.  However, channel keys are cell specific thus
-the key is created only on the cell where the client, who leaved the
+the key is created only on the cell where the client, who left the
 channel, exists.  While the server or router is creating the new channel
 key, no other client may join to the channel.  Messages that are sent
 while creating the new key are still processed with the old key.  After
@@ -1458,7 +1493,7 @@ other packet as well.
 
 If the sender of a private message does not know the receiver's Client
 ID, it must resolve it from server.  There are two ways to resolve the
-client ID from server; it is recommended that client ipmlementations
+client ID from server; it is recommended that client implementations
 send SILC_COMMAND_IDENTIFY command to receive the Client ID.  Client
 may also send SILC_COMMAND_WHOIS command to receive the Client ID.
 If the sender has received earlier a private message from the receiver
@@ -1471,7 +1506,7 @@ previously, and compare the received Client ID and the SILC Packet
 Header's Client ID.  The nickname in the payload is merely provided
 to be displayed for end user.
 
-See [SILC2] for describtion of private message encryption and decryption
+See [SILC2] for description of private message encryption and decryption
 process.
 
 
@@ -1512,14 +1547,14 @@ as Destination ID in the SILC Packet Header.  The server must then
 distribute the message to all clients on the channel by sending the
 channel message destined explicitly to a client on the channel.
 
-See [SILC2] for describtion of channel message encryption and decryption
+See [SILC2] for description of channel message encryption and decryption
 process.
 
 
 .ti 0
 4.8 Session Key Regeneration
 
-Session keys should be regenerated peridiocally, say, once in an hour.
+Session keys should be regenerated periodically, say, once in an hour.
 The re-key process is started by sending SILC_PACKET_REKEY packet to
 other end, to indicate that re-key must be performed.
 
@@ -1608,7 +1643,7 @@ Example:  Arguments:  (1) <nickname> (2) <username@host>
    
 
 Every command replies with Status Payload.  This payload tells the
-sender of the command whether the command was completed succefully or
+sender of the command whether the command was completed successfully or
 whether there was an error.  If error occured the payload includes the
 error type.  In the next section the Status Payload is not described 
 as it is common to all commands and has been described here.  Commands 
@@ -1635,7 +1670,7 @@ First argument <nickname> is mandatory but may have optional
 The numbers in parentheses are the argument specific numbers
 that specify the type of the argument in Command Argument Payload.
 The receiver always knows that, say, argument number two (2) is
-<message> argument, regardles of the ordering of the arguments in
+<message> argument, regardless of the ordering of the arguments in
 the Command Payload.
 
 Reply messages to the command:
@@ -1735,7 +1770,7 @@ List of all defined commands in SILC follows.
         STATUS_OK.
 
         The command replies include the Client ID of the nickname,
-        nickname and servername, username and hostnamea and users real
+        nickname and servername, username and hostname and users real
         name.  Client should process these replies only after the last
         reply has been received with the STATUS_LIST_END status.  If the
         <count> option were defined in the query there will be only
@@ -1752,6 +1787,8 @@ List of all defined commands in SILC follows.
             SILC_STATUS_ERR_TOO_MANY_PARAMS
 
 
+
+
    2    SILC_COMMAND_WHOWAS
 
         Max Arguments:  2
@@ -1894,6 +1931,10 @@ List of all defined commands in SILC follows.
             SILC_STATUS_ERR_TOO_MANY_PARAMS
 
 
+
+
+
+
    5    SILC_COMMAND_LIST
 
         Max Arguments:  2
@@ -1941,7 +1982,7 @@ List of all defined commands in SILC follows.
    6    SILC_COMMAND_TOPIC
 
         Max Arguments:  2
-            Arguments:  (1) <Channel ID>  (2) [<server>]]
+            Arguments:  (1) <Channel ID>  (2) [<topic>]]
 
         This command is used to change or view the topic of a channel.
         The topic for channel <Channel ID> is returned if there is no
@@ -2053,8 +2094,6 @@ List of all defined commands in SILC follows.
 
 
 
-
-
    10   SILC_COMMAND_INFO
 
         Max Arguments:  1
@@ -2091,7 +2130,7 @@ List of all defined commands in SILC follows.
 
         This command is used by operators to force a server to try to
         establish a new connection to another router (if the connecting
-        server is normal server) or server (if the conneceting server is
+        server is normal server) or server (if the connecting server is
         router server).  Operator may specify the server/router to be
         connected by setting <remote server> argument.  The separator
         between <remote server address> and <port> is whitespace (` ').
@@ -2135,6 +2174,8 @@ List of all defined commands in SILC follows.
         This command replies only with Status Payload.  Server returns
         SILC_STATUS_OK in Status Payload if pinging was successful.
 
+
+
         Status messages:
 
             SILC_STATUS_OK
@@ -2180,6 +2221,9 @@ List of all defined commands in SILC follows.
             SILC_STATUS_ERR_AUTH_FAILED
 
 
+
+
+
    14   SILC_COMMAND_JOIN
 
         Max Arguments:  3
@@ -2367,7 +2411,7 @@ List of all defined commands in SILC follows.
 
               Channel is private channel.  Private channels are shown
               in the channel list listed with SILC_COMMAND_LIST command
-              with indicatioin that the channel is private.  Also,
+              with indication that the channel is private.  Also,
               client on private channel will no be detected to be on
               the channel as the channel is not shown in the client's
               currently joined channel list.  Channel founder and 
@@ -2604,8 +2648,6 @@ List of all defined commands in SILC follows.
 
         This command replies only with Status Payload.
 
-
-
         Status messages:
 
             SILC_STATUS_OK
@@ -2613,6 +2655,9 @@ List of all defined commands in SILC follows.
             SILC_STATUS_ERR_NO_SERVER_PRIV
 
 
+
+
+
    20   SILC_COMMAND_CLOSE
 
         Max Arguments:  1
@@ -2629,8 +2674,6 @@ List of all defined commands in SILC follows.
 
         This command replies only with Status Payload.
 
-
-
         Status messages:
 
             SILC_STATUS_OK
@@ -2778,12 +2821,18 @@ List of all defined commands in SILC follows.
             SILC_STATUS_ERR_NOT_ON_CHANNEL
 
 
-   25 - 254
+   25 - 199
 
         Currently undefined commands.
 
 
-   255  SILC_COMMAND_MAX
+   200 - 254
+
+        These commands are reserved for private use and will not be defined
+        in this document.
+
+
+   255  SILC_COMMAND_MAX   
 
         Reserved command.  This must not be sent.
 .in 3
@@ -2802,6 +2851,9 @@ in [SILC2].  The payload is only 2 bytes of length.  Following diagram
 represents the Command Status Payload (field is always in MSB order).
 
 
+
+
+
 .in 21
 .nf
                      1
@@ -2812,7 +2864,7 @@ represents the Command Status Payload (field is always in MSB order).
 .in 3
 
 .ce
-Figure 5:  SILC Command Status Payload
+Figure 6:  SILC Command Status Payload
 
 
 .in 6
@@ -2851,7 +2903,7 @@ List of all defined command status messages following.
 
         End of the list.  There were several command replies and this
         reply is the last of the list.  There won't be other replies
-        beloning to this list after this one.
+        belonging to this list after this one.
 
    3 - 9
 
@@ -3039,9 +3091,6 @@ Security is central to the design of this protocol, and these security
 considerations permeate the specification.
 
 
-
-
-
 .ti 0
 7 References
 
@@ -3080,7 +3129,7 @@ considerations permeate the specification.
              Key Management Protocol (ISAKMP)", RFC 2408, November
              1998.
 
-[IKE]        Harkins D., and Carrel D., "The Internet Key Exhange
+[IKE]        Harkins D., and Carrel D., "The Internet Key Exchange
              (IKE)", RFC 2409, November 1998.
 
 [HMAC]       Krawczyk, H., "HMAC: Keyed-Hashing for Message
@@ -3099,4 +3148,4 @@ Finland
 
 EMail: priikone@poseidon.pspt.fi
 
-This Internet-Draft expires 13 May 2001 
+This Internet-Draft expires 6 Jun 2001