Merge commit 'origin/silc.1.1.branch'
[silc.git] / doc / draft-riikonen-silc-pp-00.nroff
1 .pl 10.0i
2 .po 0
3 .ll 7.2i
4 .lt 7.2i
5 .nr LL 7.2i
6 .nr LT 7.2i
7 .ds LF Riikonen
8 .ds RF FORMFEED[Page %]
9 .ds CF
10 .ds LH Internet Draft
11 .ds RH 13 September 2000
12 .ds CH
13 .na
14 .hy 0
15 .in 0
16 .nf
17 Network Working Group                                      P. Riikonen
18 Internet-Draft
19 draft-riikonen-silc-pp-00.txt                        13 September 2000
20 Expires: 13 May 2001
21
22 .in 3
23
24 .ce 2
25 SILC Packet Protocol
26 <draft-riikonen-silc-pp-00.txt>
27
28 .ti 0
29 Status of this Memo
30
31 This document is an Internet-Draft and is in full conformance with   
32 all provisions of Section 10 of RFC 2026.  Internet-Drafts are   
33 working documents of the Internet Engineering Task Force (IETF), its   
34 areas, and its working groups.  Note that other groups may also   
35 distribute working documents as Internet-Drafts.   
36
37 Internet-Drafts are draft documents valid for a maximum of six months   
38 and may be updated, replaced, or obsoleted by other documents at any   
39 time.  It is inappropriate to use Internet-Drafts as reference   
40 material or to cite them other than as "work in progress."   
41
42 The list of current Internet-Drafts can be accessed at   
43 http://www.ietf.org/ietf/1id-abstracts.txt   
44
45 The list of Internet-Draft Shadow Directories can be accessed at   
46 http://www.ietf.org/shadow.html   
47
48 The distribution of this memo is unlimited.  
49
50
51 .ti 0
52 Abstract
53
54 This memo describes a Packet Protocol used in the Secure Internet Live
55 Conferencing (SILC) protocol specified in the Secure Internet Live
56 Conferencing, Protocol Specification Internet Draft [SILC1].  This
57 protocol describes the packet types and packet payloads which defines
58 the contents of the packets.  The protocol provides secure binary packet
59 protocol that assures that the contents of the packets are secured and
60 authenticated.
61
62
63
64
65
66
67
68
69
70 .ti 0
71 Table of Contents
72
73 .nf
74 1 Introduction ..................................................  3
75 2 SILC Packet Protocol ..........................................  4
76   2.1 SILC Packet ...............................................  4
77   2.2 SILC Packet Header ........................................  5
78   2.3 SILC Packet Types .........................................  7
79       2.3.1 SILC Packet Payloads ................................ 15
80       2.3.2 Disconnect Payload .................................. 15
81       2.3.3 Success Payload ..................................... 16
82       2.3.4 Failure Payload ..................................... 16
83       2.3.5 Reject Payload ...................................... 17
84       2.3.6 Notify Payload ...................................... 17
85       2.3.7 Error Payload ....................................... 18
86       2.3.8 Channel Message Payload ............................. 19
87       2.3.9 Channel Key Payload ................................. 20
88       2.3.10 Private Message Payload ............................ 23
89       2.3.11 Private Message Key Payload ........................ 24
90       2.3.12 Command Payload .................................... 25
91              2.3.12.1 Command Argument Payload .................. 25
92       2.3.13 Command Reply Payload .............................. 26
93       2.3.14 Connection Auth Request Payload .................... 27
94       2.3.15 New ID Payload ..................................... 28
95       2.3.16 New ID List Payload ................................ 29
96       2.3.17 New Client Payload ................................. 29
97       2.3.18 New Server Payload ................................. 31
98       2.3.19 New Channel Payload ................................ 31
99       2.3.20 New Channel User Payload ........................... 32
100       2.3.21 New Channel List Payload ........................... 33
101       2.3.22 New Channel User List Payload ...................... 34
102       2.3.23 Replace ID Payload ................................. 34
103       2.3.24 Remove ID Payload .................................. 35
104   2.4 SILC ID Types ............................................. 36
105   2.5 Packet Encryption And Decryption .......................... 37
106       2.5.1 Normal Packet Encryption And Decryption ............. 37
107       2.5.2 Channel Message Encryption And Decryption ........... 37
108       2.5.3 Private Message Encryption And Decryption ........... 38
109   2.6 Packet MAC Generation ..................................... 39
110   2.7 Packet Padding Generation ................................. 39
111   2.8 Packet Compression ........................................ 40
112   2.9 Packet Sending ............................................ 40
113   2.10 Packet Reception ......................................... 41
114   2.11 Packet Routing ........................................... 42
115   2.12 Packet Forwarding ........................................
116   2.13 Packet Broadcasting ...................................... 41
117   2.14 Packet Tunneling ......................................... 42
118 3 Security Considerations ....................................... 43
119 4 References .................................................... 43
120 5 Author's Address .............................................. 44
121
122 .ti 0
123 List of Figures
124
125 .nf
126 Figure 1:   Typical SILC Packet
127 Figure 2:   SILC Packet Header
128 Figure 3:   Disconnect Payload
129 Figure 4:   Success Payload
130 Figure 5:   Failure Payload
131 Figure 6:   Reject Payload
132 Figure 7:   Notify Payload
133 Figure 8:   Error Payload
134 Figure 9:   Channel Message Payload
135 Figure 10:  Channel Key Payload
136 Figure 11:  Private Message Payload
137 Figure 12:  Private Message Key Payload
138 Figure 13:  Command Payload
139 Figure 14:  Command Argument Payload
140 Figure 15:  Connection Auth Request Payload
141 Figure 16:  New ID Payload
142 Figure 17:  New Client Payload
143 Figure 18:  New Server Payload
144 Figure 19:  New Channel Payload
145 Figure 20:  New Channel User Payload
146 Figure 21:  Replace ID Payload
147 Figure 22:  Remove ID Payload
148 Figure 23:  Remove Channel User Payload
149
150
151 .ti 0
152 1. Introduction
153
154 This document describes a Packet Protocol used in the Secure Internet
155 Live Conferencing (SILC) protocol specified in the Secure Internet Live
156 Conferencing, Protocol Specification Internet Draft [SILC1].  This
157 protocol describes the packet types and packet payloads which defines
158 the contents of the packets.  The protocol provides secure binary packet
159 protocol that assures that the contents of the packets are secured and
160 authenticated.
161
162 The basis of SILC protocol relies in the SILC packets and it is with
163 out a doubt the most important part of the protocol.  It is also probably
164 the most complicated part of the protocol.  Packets are used all the
165 time in the SILC network to send messages, commands and other information.
166 All packets in SILC network are always encrypted and their integrity
167 is assured by computed MACs.  The protocol defines several packet types
168 and packet payloads.  Each packet type usually has a specific packet
169 payload that actually defines the contents of the packet.  Each packet
170 also includes a default SILC Packet Header that provides sufficient
171 information about the origin of the packet and destination of the
172 packet.
173
174
175 .ti 0
176 2 SILC Packet Protocol
177
178 .ti 0
179 2.1 SILC Packet
180
181 SILC packets deliver messages from sender to receiver securely by
182 encrypting important fields of the packet.  The packet consists of
183 default SILC Packet Header, Padding, Packet Payload data, and, packet 
184 MAC.
185
186 The following diagram illustrates typical SILC packet.
187
188
189 .in 5
190 .nf
191  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
192 |   n bytes   | 1 - n bytes |      n bytes       |  n bytes       
193 | SILC Header |   Padding   |    Data Payload    |    MAC    
194  - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
195 .in 3
196
197 .ce
198 Figure 1:  Typical SILC Packet
199
200
201 SILC Header is always the first part of the packet and its purpose
202 is to provide information about the packet.  It provides for example
203 the packet type, origin of the packet and the destination of the packet.
204 The header is variable in length and first two (2) bytes of the
205 header (thus first two bytes of the packet) are not encrypted.  The
206 first two (2) bytes are the length of the packet which is not encrypted.
207 See following section for description of SILC Packet header.  Packets
208 without SILC header or with malformed SILC header must be dropped.
209
210 Padding follows the packet header.  The purpose of the padding is to
211 make the packet multiple by eight (8) or by the block size of the
212 cipher used in the encryption, which ever is larger.  The maximum
213 length of padding is currently 16 bytes.  The padding is always
214 encrypted.
215
216 Data payload area follows padding and it is the actual data of the
217 packet.  The packet data is the packet payloads defined in this
218 protocol.  The data payload area is always encrypted.
219
220 The last part of SILC packet is the packet MAC that assures the
221 integrity of the packet.  The MAC is always computed from the packet
222 before the encryption is applied to the packet.  If compression is used
223 in the packet the MAC is computed after the compression has been
224 applied.  The compression, on the other hand, is always applied before
225 encryption.
226
227 All fields in all packet payloads are always in MSB (most significant
228 byte first) order.
229
230
231 .ti 0
232 2.2 SILC Packet Header
233
234 The default SILC packet header is applied to all SILC packets and it is
235 variable in length.  The purpose of SILC Packet header is to provide
236 detailed information about the packet.  The receiver of the packet uses
237 the packet header to parse the packet and gain other relevant parameters
238 of the packet.
239
240 Following diagram represents the default SILC header format.
241 (*) indicates that this field is never encrypted.  Other fields are
242 always encrypted.
243
244
245 .in 5
246 .nf
247                       1                   2                   3
248  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
249 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
250 |        Payload Length *       |     Flags     |  Packet Type  |
251 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
252 |        Source ID Length       |     Destination ID Length     |
253 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
254 |  Src ID Type  |                                               |
255 +-+-+-+-+-+-+-+-+                                               +
256 |                                                               |
257 ~                           Source ID                           ~
258 |                                                               |
259 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
260 |  Dst ID Type  |                                               |
261 +-+-+-+-+-+-+-+-+                                               +
262 |                                                               |
263 ~                         Destination ID                        ~
264 |                                                               |
265 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
266 .in 3
267
268 .ce
269 Figure 2:  SILC Packet Header
270
271
272 .in 6
273 o Payload Length (2 bytes) - Is the length of the packet
274   not including the padding of the packet.  This field must
275   not be encrypted but must always be authenticated.
276
277 o Flags (1 byte) - Indicates flags to be used in packet
278   processing.  Several flags may be set by ORing the flags
279   together.
280
281   Following flags are reserved for this field:
282
283
284
285
286      No flags                  0x00
287
288        In this case the field is ignored.
289
290
291      Private Message Key       0x01
292
293        Indicates that the packet must include private
294        message that is encrypted using private key set by
295        client.  Servers does not know anything about this
296        key and this causes that the private message is
297        not handled by the server at all, it is just
298        passed along.  See section 2.5.3 Private Message
299        Encryption And Decryption for more information.
300
301
302      Forwarded                 0x02
303   
304        Marks the packet to be forwarded.  Some specific
305        packet types may be forwarded.  Receiver of packet
306        with this flag set must not forward the packet any
307        further.  See section 2.12 Packet Forwarding for
308        desribtion of packet forwarding.
309
310
311      Broadcast                 0x04
312
313        Marks the packet to be broadcasted.  Client cannot
314        send broadcast packet and normal server cannot send
315        broadcast packet.  Only router server may send broadcast
316        packet.  The router receiving of packet with this flag 
317        set must send (broadcast) the packet to its primary
318        route.  If router has several router connections the
319        packet may be sent only to the primary route.  See
320        section 2.13 Packet Broadcasting for description of 
321        packet broadcasting.
322
323
324      Tunneled                  0x08
325
326        Marks that the packet is tunneled.  Tunneling means
327        that extra SILC Packet Header has been applied to the
328        original packet.  The outer header has this flag
329        set.  See section 2.14 Packet Tunneling for more
330        information.
331 .in 3
332
333
334
335 o Packet Type (1 byte) - Is the type of the packet. Receiver 
336   uses this field to parse the packet.  See section 2.3
337   SILC Packets for list of defined packet types.
338
339 o Source ID Length (2 bytes) - Indicates the length of the
340   Source ID field in the header, not including this or any
341   other fields.
342
343
344
345 o Destination ID Length (2 bytes) - Indicates the length of the
346   Destination ID field in the header, not including this or
347   any other fields.
348
349 o Src ID Type (1 byte) - Indicates the type of ID in the
350   Source ID field.  See section 2.4 SILC ID Types for
351   defined ID types.
352
353 o Source ID (variable length) - The actual source ID that
354   indicates who is the original sender of the packet.
355
356 o Dst ID Type (1 byte) - Indicates the type of ID in the
357   Destination ID field.  See section 2.4 SILC ID Types for
358   defined ID types.
359
360 o Destination ID (variable length) - The actual source ID that
361   indicates who is the end receiver of the packet.
362
363
364 .ti 0
365 2.3 SILC Packet Types
366
367 SILC packet types defines the contents of the packet and it is used by
368 the receiver to parse the packet.  The packet type is 8 bits, as a one
369 byte, in length.  The range for the packet types are from 0 - 255,
370 where 0 is never sent and 255 is currently reserved for future
371 extensions and must not be defined to any other purpose.  Every SILC
372 specification compliant implementation should support all of these packet
373 types.
374
375 The below list of the SILC Packet types includes reference to the packet
376 payload as well.  Packet payloads are the actual packet, that is, the data
377 that the packet consists of.  Each packet type defines packet payload 
378 which usually may only be sent with the specific packet type.
379
380 Most of the packets are packets that must be destined directly to entity
381 that is connected to the sender.  It is not allowed, for example, for
382 router to send disconnect packet to client that is not directly connected
383 to the router.  However, there are some special packet types that may
384 be destined to some entity that the sender has not direct connection
385 with.  These packets are for example private message packets, channel
386 message packets, command packets and some other packets that may be
387 broadcasted in the SILC network.  If the packet is allowed to be sent to
388 indirectly connected entity it is mentioned separately in the packet
389 description (unless it is obvious as in private and channel message
390 packets).  Other packets must not be sent or accepted, if sent, to
391 indirectly connected entities.
392
393 List of SILC Packet types are defined as follows.
394
395 .in 1
396      0    SILC_PACKET_NONE
397
398           This type is reserved and it is never sent.         
399
400
401      1    SILC_PACKET_DISCONNECT
402
403           This packet is sent to disconnect the remote end.  Reason of
404           the disconnection is sent inside the packet payload.  Client
405           usually does not send this packet.
406
407           Payload of the packet:  See section 2.3.2 Disconnect Payload
408
409
410      2    SILC_PACKET_SUCCESS
411
412           This packet is sent upon successful execution of some protocol.
413           The status of the success is sent in the packet.
414
415           Payload of the packet:  See section 2.3.3 Success Payload
416
417
418      3    SILC_PACKET_FAILURE
419
420           This packet is sent upon failure of some protocol.  The status
421           of the failure is sent in the packet.
422
423           Payload of the packet:  See section 2.3.4 Failure Payload
424
425
426      4    SILC_PACKET_REJECT
427
428           This packet may be sent upon rejection of some protocol.
429           The status of the rejection is sent in the packet.
430
431           Payload of the packet:  See section 2.3.5 Reject Payload
432
433
434      5    SILC_PACKET_NOTIFY
435
436           This packet is used to send notify message, usually from
437           server to client, although it may be sent from server to another
438           server as well.  Client never sends this packet.  Server may
439           send this packet to channel as well when the packet is 
440           distributed to all clients on the channel.  Receiver of this 
441           packet may ignore the packet if it chooses so.  However, it 
442           should not be ignored.
443
444           Payload of the packet:  See section 2.3.6 Notify Payload.
445
446
447      6    SILC_PACKET_ERROR
448
449           This packet is sent when an error occurs.  Server may
450           send this packet.  Client never sends this packet.  The
451           client may entirely ignore the packet, however, server is
452           most likely to take action anyway.  This packet may be sent
453           to entity that is indirectly connected to the sender.
454
455           Payload of the packet:  See section 2.3.7 Error Payload.
456
457
458      7    SILC_PACKET_CHANNEL_MESSAGE
459
460           This packet is used to send messages to channels.  The packet
461           includes Channel ID of the channel and the actual message to
462           the channel.  Messages sent to the channel are always protected
463           by channel specific keys.  Channel Keys are distributed by
464           SILC_PACKET_CHANNEL_KEY packet.
465
466           When client sends this packet the destination ID in the SILC 
467           header must be the Channel ID of the channel the message is 
468           destined to.  If server sends this packet to a client the 
469           destination ID in the SILC header must be the Client ID of 
470           the client receiving the packet.
471
472           If server sends this packet to router or if router sends this
473           packet to server or another router the destination ID in the
474           SILC header must be the Channel ID of the channel.  Server
475           (including router) distributes this packet only to its local
476           clients who are joined to the channel.  Servers and routers
477           also determines who are on the channel and when this packet
478           needs to be sent, as described in section Client To Client
479           in [SILC1].
480
481           Payload of the packet:  See section 2.3.8 Channel Message 
482                                   Payload
483
484
485      8    SILC_PACKET_CHANNEL_KEY
486
487           This packet is used to distribute new key for particular
488           channel.  Each channel has their own independent keys that
489           is used to protect the traffic on the channel.  Only server
490           may send this packet.  This packet may be sent to entity
491           that is indirectly connected to the sender.
492
493           Payload of the packet:  See section 2.3.9 Channel Key Payload
494
495
496      9    SILC_PACKET_PRIVATE_MESSAGE
497
498           This packet is used to send private messages from client
499           to another client.  By default, private messages are protected
500           by session keys established by normal key exchange protocol.
501           However, it is possible to use specific key to protect private
502           messages.  SILC_PACKET_PRIVATE_MESSAGE_KEY packet is used to 
503           agree the key with the remote client.  Pre-shared key may be 
504           used as well if both of the client knows it, however, it needs 
505           to be agreed outside SILC.  See more of this in [SILC1].
506
507           Payload of the packet:  See section 2.3.10 Private Message
508                                   Payload
509
510
511      10   SILC_PACKET_PRIVATE_MESSAGE_KEY
512
513           This packet is used to agree about a key to be used to protect
514           the private messages between two clients.  If this is not sent
515           the normal session key is used to protect the private messages
516           inside SILC network.  Agreeing to use specific key to protect
517           private messages adds security, as no server between the two
518           clients will be able to decrypt the private message.  However,
519           servers inside SILC network are considered to be trusted, thus
520           using normal session key to protect private messages does not
521           degree security.  Whether to agree to use specific keys by
522           default or to use normal session keys by default, is 
523           implementation specific issue.  See more of this in [SILC1].
524
525           Payload of the packet:  See section 2.3.11 Private Message
526                                   Key Payload
527
528
529      11   SILC_PACKET_COMMAND
530
531           This packet is used to send commands from client to server.
532           Server may send this packet to other servers as well.  All
533           commands are listed in their own section SILC Command Types
534           in [SILC1].  The contents of this packet is command specific.
535           This packet may be sent to entity that is indirectly connected
536           to the sender.
537
538           Payload of the packet:  See section 2.3.12 Command Payload
539
540
541      12   SILC_PACKET_COMMAND_REPLY
542
543           This packet is send as reply to the SILC_PACKET_COMMAND packet.
544           The contents of this packet is command specific.  This packet
545           maybe sent to entity that is indirectly connected to the sender.
546
547           Payload of the packet:  See section 2.3.13 Command Reply 
548                                   Payload and section 2.3.12 Command
549                                   Payload
550
551
552      13   SILC_PACKET_KEY_EXCHANGE
553
554           This packet is used to start SILC Key Exchange Protocol, 
555           described in detail in [SILC3].
556
557           Payload of the packet:  Payload of this packet is described
558                                   in the section SILC Key Exchange
559                                   Protocol and its sub sections in
560                                   [SILC3].
561
562
563      14   SILC_PACKET_KEY_EXCHANGE_1
564
565           This packet is used as part of the SILC Key Exchange Protocol.
566
567           Payload of the packet:  Payload of this packet is described
568                                   in the section SILC Key Exchange
569                                   Protocol and its sub sections in
570                                   [SILC3].
571
572
573      15   SILC_PACKET_KEY_EXCHANGE_2
574
575           This packet is used as part of the SILC Key Exchange Protocol.
576
577           Payload of the packet:  Payload of this packet is described
578                                   in the section SILC Key Exchange
579                                   Protocol and its sub sections in
580                                   [SILC3].
581
582
583      16   SILC_PACKET_CONNECTION_AUTH_REQUEST
584
585           This packet is used to request the authentication method to
586           be used in the SILC Connection Authentication Protocol.  If 
587           initiator of the protocol does not know the mandatory 
588           authentication method this packet is used to determine it.
589
590           The party receiving this payload must respond with the same
591           packet including the mandatory authentication method.
592
593           Payload of the packet:  See section 2.3.14 Connection Auth
594                                   Request Payload
595
596
597      17   SILC_PACKET_CONNECTION_AUTH
598
599           This packet is used to start and perform the SILC Connection
600           Authentication Protocol.  This protocol is used to authenticate
601           the connecting party.  The protocol is described in detail in
602           [SILC3].
603
604           Payload of the packet:  Payload of this packet is described
605                                   in the section SILC Authentication
606                                   Protocol and it sub sections in [SILC].
607
608
609      18   SILC_PACKET_NEW_ID
610
611           This packet is used to distribute new ID's from server to
612           router and from router to all routers in the SILC network.
613           This is used when for example new client is registered to
614           SILC network.  The newly created ID's of these operations are
615           distributed by this packet.  Only server may send this packet,
616           however, client must be able to receive this packet.
617
618           Payload of the packet:  See section 2.3.15 New ID Payload
619
620
621      19   SILC_PACKET_NEW_ID_LIST
622
623           This packet is used to distribute list of new ID's from
624           server to routers.  This is equivalent to previous packet
625           type except that it may include several ID's.  Client must
626           not send this packet.
627
628           Payload of the packet:  See section 2.3.16 New ID List 
629                                   Payload
630
631
632      20   SILC_PACKET_NEW_CLIENT
633
634           This packet is used by client to register itself to the
635           SILC network.  This is sent after key exchange and 
636           authentication protocols has been completed.  Client sends
637           various information about itself in this packet.
638
639           Payload of the packet:  See section 2.3.17 New Client Payload
640
641
642      21   SILC_PACKET_NEW_SERVER
643
644           This packet is used by server to register itself to the
645           SILC network.  This is sent after key exchange and 
646           authentication protocols has been completed.  Server sends
647           this to the router it connected to, or, if router was
648           connecting, to the connected router.  Server sends
649           its Server ID and other information in this packet.
650           Client must not send or receive this packet.
651
652           Payload of the packet:  See section 2.3.18 New Server Payload
653
654
655      22   SILC_PACKET_NEW_CHANNEL
656
657           This packet is used to notify routers about newly created
658           channel.  Channels are always created by the router and it must
659           notify other routers about the created channel.  Router sends
660           this packet to its primary route.  Client must not send this
661           packet.  This packet maybe sent to entity that is indirectly
662           connected to the sender.
663
664           Payload of the packet:  See section 2.3.19 New Channel Payload
665
666
667      23   SILC_PACKET_NEW_CHANNEL_USER
668
669           This packet is used to notify routers about new user on channel.
670           The packet is sent after user has joined to the channel.  Server
671           may send this packet to its router and router may send this to
672           its primary router.  Client must not send this packet.  This
673           packet maybe sent to entity that is indirectly connected to the
674           sender.
675
676           Payload of the packet:  See section 2.3.20 New Channel User
677                                   Payload
678
679
680      24   SILC_PACKET_NEW_CHANNEL_LIST
681
682           This packet is used to distribute list of created channels
683           from server to routers.  This is equivalent to the packet
684           SILC_PACKET_NEW_CHANNEL except that it may include several
685           payloads. Client must not send this packet.
686
687           Payload of the packet:  See section 2.3.21 New Channel List
688                                   Payload
689
690
691      25   SILC_PACKET_NEW_CHANNEL_USER_LIST
692
693           This packet is used to distribute list of users on specific
694           channel from server to routers.  This is equivalent to the
695           packet SILC_PACKET_NEW_CHANNEL_USER except that it may
696           include several payloads.  Client must not send this packet.
697
698           Payload of the packet:  See section 2.3.22 New Channel User
699                                   List Payload
700
701
702      26   SILC_PACKET_REPLACE_ID
703
704           This packet is used to replace old ID with new ID sent in
705           the packet payload.  For example, when client changes its
706           nickname new ID is created and this packet can be used to
707           distribute the new ID and the old ID is removed when it is
708           send in the packet.  Client cannot send or receive this
709           packet.  This packet maybe sent to entity that is indirectly
710           connected to the sender.
711
712           Payload of the packet:  See section 2.3.23 Replace ID Payload
713
714
715      27   SILC_PACKET_REMOVE_ID
716
717           This packet is used to removed ID.  For example, when client
718           exits SILC network its ID is removed.  Client must not send
719           this packet.  This packet maybe sent to entity that is
720           indirectly connected to the sender.
721
722           Payload of the packet:  See section 2.3.24 Remove ID Payload
723
724
725      28   SILC_PACKET_REMOVE_CHANNEL_USER
726
727           This packet is used to remove user from a channel.  This is
728           used by router to notify other routers in the network that a
729           client has leaved a channel.  This packet maybe sent to entity
730           that is indirectly connected to the sender.
731
732           Payload of the packet:  See section 2.3.25 Remove Channel User
733                                   Payload
734
735
736      29   SILC_PACKET_REKEY
737
738           This packet is used to indicate that re-key must be performed
739           for session keys.  See section Session Key Regeneration in
740           [SILC1] for more information.  This packet does not have
741           a payload.
742
743
744      30   SILC_PACKET_REKEY_DONE
745
746           This packet is used to indicate that re-key is performed and
747           new keys must be used hereafter.  This is sent only if re-key
748           was done without PFS option.  If PFS is set, this is not sent
749           as SILC Key Exchange protocol is executed.  This packet does
750           not have a payload.
751
752
753      31 - 254
754
755          Currently undefined commands.
756
757
758      255 SILC_PACKET_MAX
759
760          This type is reserved for future extensions and currently it 
761          is not sent.
762 .in 3
763
764
765 .ti 0
766 2.3.1 SILC Packet Payloads
767
768 All payloads resides in the main data area of the SILC packet.  However
769 all payloads must be at the start of the data area after the default
770 SILC packet header and padding.  All fields in the packet payload are
771 always encrypted, as, they reside in the data area of the packet which
772 is always encrypted.
773
774 Payloads described in this section are common payloads that must be
775 accepted anytime during SILC session.  Most of the payloads may only
776 be sent with specific packet type which is defined in the description
777 of the payload.
778
779 There are a lot of other payloads in the SILC as well.  However, they
780 are not common in the sense that they could be sent at any time. 
781 These payloads are not described in this section.  These are payloads
782 such as SILC Key Exchange payloads and so on.  These are described
783 in [SILC1] and [SILC3].
784
785
786 .ti 0
787 2.3.2 Disconnect Payload
788
789 Disconnect payload is sent upon disconnection.  The payload is simple;
790 reason of disconnection is sent to the disconnected party.
791
792 The payload may only be sent with SILC_PACKET_DISCONNECT packet.  It
793 must not be sent in any other packet type.  Following diagram represents
794 the Disconnect Payload.
795
796
797 .in 5
798 .nf
799                      1                   2                   3
800  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
801 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
802 |                                                               |
803 ~                      Disconnect Message                       ~
804 |                                                               |
805 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
806 .in 3
807
808 .ce
809 Figure 3:  Disconnect Payload
810
811
812
813
814 .in 6
815 o Disconnect Message (variable length) - Human readable
816   reason of the disconnection.
817 .in 3
818
819
820 .ti 0
821 2.3.3 Success Payload
822
823 Success payload is sent when some protocol execution is successfully
824 completed.  The payload is simple; indication of the success is sent.
825 This maybe any data, including binary or human readable data.
826
827 .in 5
828 .nf
829                      1                   2                   3
830  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
831 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
832 |                                                               |
833 ~                      Success Indication                       ~
834 |                                                               |
835 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
836 .in 3
837
838 .ce
839 Figure 4:  Success Payload
840
841
842 .in 6
843 o Success Indication (variable length) - Indication of
844   the success.  This maybe for example some flag that
845   indicates the protocol and the success status or human
846   readable success message.  The true length of this
847   payload is available by calculating it from the SILC
848   Packet Header.
849 .in 3
850
851
852 .ti 0
853 2.3.4 Failure Payload
854
855 This is opposite of Success Payload.  Indication of failure of
856 some protocol is sent in the payload.
857
858
859 .in 5
860 .nf
861                      1                   2                   3
862  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
863 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
864 |                                                               |
865 ~                      Failure Indication                       ~
866 |                                                               |
867 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
868 .in 3
869
870 .ce
871 Figure 5:  Failure Payload
872
873
874 .in 6
875 o Failure Indication (variable length) - Indication of
876   the failure.  This maybe for example some flag that
877   indicates the protocol and the failure status or human
878   readable failure message.  The true length of this
879   payload is available by calculating it from the SILC
880   Packet Header.
881 .in 3
882
883
884 .ti 0
885 2.3.5 Reject Payload
886
887 This payload is sent when some protocol is rejected to be executed.
888 Other operations may send this as well that was rejected.  The
889 indication of the rejection is sent in the payload.  The indication
890 may be binary or human readable data.
891
892
893 .in 5
894 .nf
895                      1                   2                   3
896  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
897 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
898 |                                                               |
899 ~                       Reject Indication                       ~
900 |                                                               |
901 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
902 .in 3
903
904 .ce
905 Figure 6:  Reject Payload
906
907
908 .in 6
909 o Reject Indication (variable length) - Indication of
910   the rejection.  This maybe for example some flag that
911   indicates the protocol and the rejection status or human
912   readable rejection message.  The true length of this
913   payload is available by calculating it from the SILC
914   Packet Header.
915 .in 3
916
917
918
919
920
921 .ti 0
922 2.3.6 Notify Payload
923
924 Notify payload is used to send notify messages.  The payload is usually
925 sent from server to client, however, server may send it to another
926 server as well.  Client must not send this payload.  The receiver of
927 this payload may totally ignore the contents of the payload, however,
928 notify message should be noted and possibly logged.
929
930 The payload may only be sent with SILC_PACKET_NOTIFY packet.  It must
931 not be sent in any other packet type.  Following diagram represents the
932 Notify Payload.
933
934 .in 5
935 .nf
936                      1                   2                   3
937  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
938 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
939 |          Notify Type          |                               |
940 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
941 |                                                               |
942 ~                        Notify Message                         ~
943 |                                                               |
944 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
945 .in 3
946
947 .ce
948 Figure 7:  Notify Payload
949
950
951 .in 6
952 o Notify Type (2 bytes) - Indicates the type of the notify
953   message.
954
955 o Notify Message (variable length) - Human readable notify
956   message.
957 .in 3
958
959
960 .ti 0
961 2.3.7 Error Payload
962
963 Error payload is sent upon error.  Error may occur in various
964 conditions when server sends this packet.  Client may not send this
965 payload but must be able to accept it.  However, client may
966 totally ignore the contents of the packet as server is going to
967 take action on the error anyway.  However, it is recommended
968 that the client takes error packet seriously.
969
970
971 .in 5
972 .nf
973                      1                   2                   3
974  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
975 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
976 |                                                               |
977 ~                         Error Message                         ~
978 |                                                               |
979 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
980 .in 3
981
982 .ce
983 Figure 8:  Error Payload
984
985
986 .in 6
987 o Error Message (variable length) - Human readable error
988   message.
989 .in 3
990
991
992 .ti 0
993 2.3.8 Channel Message Payload
994
995 Channel messages are the most common messages sent in the SILC.
996 Channel Message Payload is used to send message to channels.  These
997 messages can only be sent if client has joined to some channel.
998 Even though this packet is the most common in SILC it is still
999 special packet.  Some special handling on sending and reception
1000 of channel message is required.
1001
1002 Padding must be applied into this payload since the payload is
1003 encrypted separately from other parts of the packet with the
1004 channel specific key.  Hence the requirement of the padding.  
1005 The padding should be random data.  The packet must be made
1006 multiple by eight (8) or by the block size of the cipher, which
1007 ever is larger.
1008
1009 The SILC header in this packet is encrypted with the session key
1010 of the next receiver of the packet.  Nothing else is encrypted
1011 with that key.  Thus, the actual packet and padding to be
1012 encrypted with the session key is SILC Header plus padding to it
1013 to make it multiple by eight (8) or multiple by the block size
1014 of the cipher, which ever is larger.
1015
1016 Receiver of the the channel message packet is able to determine
1017 the channel the message is destined to by checking the destination
1018 ID from the SILC Packet header which tells the destination channel.
1019 The original sender of the packet is also determined by checking
1020 the source ID from the header which tells the client who sent
1021 the message.
1022
1023 The payload may only be sent with SILC_PACKET_CHANNEL_MESSAGE packet.
1024 It  must not be sent in any other packet type.  Following diagram 
1025 represents the Channel Message Payload.
1026
1027 (*) indicates that the field is not encrypted.
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050 .in 5
1051 .nf
1052                      1                   2                   3
1053  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1054 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1055 |        Nickname Length        |                               |
1056 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1057 |                                                               |
1058 ~                           Nickname                            ~
1059 |                                                               |
1060 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1061 |         Message Length        |                               |
1062 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1063 |                                                               |
1064 ~                         Message Data                          ~
1065 |                                                               |
1066 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1067 |        Padding Length         |                               |
1068 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1069 |                                                               |
1070 ~                            Padding                            ~
1071 |                                                               |
1072 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1073 |                                                               |
1074 ~                       Initial Vector *                        ~
1075 |                                                               |
1076 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1077 .in 3
1078
1079 .ce
1080 Figure 9:  Channel Message Payload
1081
1082
1083 .in 6
1084 o Nickname Length (2 bytes) - Indicates the length of the
1085   Nickname field, not including any other field.
1086
1087 o Nickname (variable length) - Nickname of the sender of the 
1088   channel message.  This should not be trusted as a definite 
1089   sender of the channel message.  The SILC Packet Header in 
1090   the packet indicates the true sender of the packet and 
1091   client should verify that the nickname sent here belongs 
1092   to the Client ID in the SILC Packet Header.  This nickname 
1093   is merely provided to be displayed by the client.
1094
1095   If server is sending this packet this field is not included
1096   and zero (0) length must be set to the Nickname Length field.
1097
1098 o Message Length (2 bytes) - Indicates the length of the
1099   the Message Data field in the payload, not including any 
1100   other field.
1101
1102
1103 o Message Data (variable length) - The actual message to
1104   the channel.
1105
1106 o Padding Length (2 bytes) - Indicates the length of the
1107   Padding field in the payload, not including any other
1108   field.
1109
1110 o Padding (variable length) - The padding that must be
1111   applied because this payload is encrypted separately from
1112   other parts of the packet.
1113
1114 o Initial Vector (variable length) - The initial vector
1115   that has been used in packet encryption.  It needs to be
1116   used in the packet decryption as well.  What this field
1117   includes is implementation issue.  However, it is 
1118   recommended that it would be random data or, perhaps,
1119   a timestamp.  It is not recommended to use zero (0) as
1120   initial vector.  This field is not encrypted.  This field
1121   is not included into the padding calculation.  Length
1122   of this field equals the cipher's block size.  This field
1123   is, however, authenticated.
1124 .in 3
1125
1126
1127 .ti 0
1128 2.3.9 Channel Key Payload
1129
1130 All traffic in channels are protected by channel specific keys.
1131 Channel Key Payload is used to distribute channel keys to all
1132 clients on the particular channel.  Channel keys are sent when
1133 the channel is created, when new user joins to the channel and
1134 whenever a user leaves a channel.  Server creates the new
1135 channel key and distributes it to the clients by encrypting this
1136 payload with the session key shared between the server and
1137 the client.  After that, client starts using the key received
1138 in this payload to protect the traffic on the channel.
1139
1140 Channel keys are cell specific thus every router in cell have
1141 to create a channel key and distribute it if any client in the
1142 cell has joined to a channel.  Channel traffic between cell's
1143 are not encrypted using channel keys, they are encrypted using
1144 normal session keys between two routers.  Inside a cell, all
1145 channel traffic is encrypted with the specified channel key.
1146 Channel key should expire peridiocally, say, in one hour, in
1147 which case new channel key is created and distributed.
1148
1149 The payload may only be sent with SILC_PACKET_CHANNEL_KEY packet.
1150 It must not be sent in any other packet type.  Following diagram 
1151 represents the Channel Key Payload.
1152
1153
1154 .in 5
1155 .nf
1156                      1                   2                   3
1157  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1158 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1159 |       Channel ID Length       |                               |
1160 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1161 |                                                               |
1162 ~                          Channel ID                           ~
1163 |                                                               |
1164 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1165 |      Cipher Name Length       |                               |
1166 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1167 |                                                               |
1168 ~                         Cipher Name                           ~
1169 |                                                               |
1170 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1171 |      Channel Key Length       |                               |
1172 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1173 |                                                               |
1174 ~                         Channel Key                           ~
1175 |                                                               |
1176 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1177 .in 3
1178
1179 .ce
1180 Figure 10:  Channel Key Payload
1181
1182
1183
1184 .in 6
1185 o Channel ID Length (2 bytes) - Indicates the length of the
1186   Channel ID field in the payload, not including any other
1187   field.
1188
1189 o Channel ID (variable length) - The Channel ID of the
1190   channel this key is meant for.
1191
1192 o Cipher Name Length (2 bytes) - Indicates the length of the
1193   Cipher name field in the payload, not including any other
1194   field.
1195
1196 o Cipher Name (variable length) - Name of the cipher used
1197   in the protection of channel traffic.  This name is
1198   initially decided by the creator of the channel but it
1199   may change during the life time of the channel as well.
1200
1201 o Channel Key Length (2 bytes) - Indicates the length of the
1202   Channel Key field in the payload, not including any other
1203   field.
1204
1205 o Channel Key (variable length) - The actual channel key
1206   material.  This key is used as such as key material for
1207   encryption function.
1208 .in 3
1209
1210
1211 .ti 0
1212 2.3.10 Private Message Payload
1213
1214 Private Message Payload is used to send private message between
1215 two clients (or users for that matter).  The messages are sent only
1216 to the specified user and no other user inside SILC network is
1217 able to see the message.  The message is protected by the session 
1218 key established by the SILC Key Exchange Protocol.  However,
1219 it is also possible to agree to use specific keys to protect
1220 just the private messages.  See section 2.3.11 Private Message
1221 Key Payload for detailed description of how to agree to use
1222 specific key.
1223
1224 If normal session key is used to protect the message, every
1225 server between the sender client and the receiving client needs
1226 to decrypt the packet and always re-encrypt it with the session
1227 key of the next receiver of the packet.  See section Client
1228 To Client in [SILC1].
1229
1230 When specific key is used to protect the message, servers between 
1231 the sender and the receiver needs not to decrypt/re-encrypt the 
1232 packet.  Section 4.8.2 Client To Client in [SILC1] gives example of
1233 this scheme as well.
1234
1235 The payload may only be sent with SILC_PACKET_PRIVATE_MESSAGE 
1236 packet.  It must not be sent in any other packet type.  Following 
1237 diagram represents the Private Message Payload.
1238
1239
1240 .in 5
1241 .nf
1242                      1                   2                   3
1243  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1244 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1245 |        Nickname Length        |                               |
1246 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1247 |                                                               |
1248 ~                            Nickname                           ~
1249 |                                                               |
1250 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1251 |                                                               |
1252 ~                          Message Data                         ~
1253 |                                                               |
1254 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1255 .in 3
1256
1257 .ce
1258 Figure 11:  Private Message Payload
1259
1260
1261 .in 6
1262 o Nickname Length (2 bytes) - Indicates the length of the
1263   Nickname field, not including any other field.
1264
1265 o Nickname (variable length) - Nickname of the sender of the 
1266   private message.  This should not be trusted as a definite 
1267   sender of the private message.  The SILC Packet Header in 
1268   the packet indicates the true sender of the packet and 
1269   client should verify that the nickname sent here belongs 
1270   to the Client ID in the SILC Packet Header.  This nickname 
1271   is merely provided to be displayed by the client.
1272
1273 o Message Data (variable length) - The actual message to
1274   the client.  Rest of the packet is reserved for the message
1275   data.
1276 .in 3
1277
1278
1279 .ti 0
1280 2.3.11 Private Message Key Payload
1281
1282 This payload is used to send key from client to another client that
1283 is going to be used to protect the private messages between these
1284 two clients.  If this payload is not sent normal session key 
1285 established by the SILC Key Exchange Protocol is used to protect
1286 the private messages.
1287
1288 This payload may only be sent by client to another client.  Server
1289 must not send this payload at any time.  After sending this payload
1290 the sender of private messages must set the Private Message Key
1291 flag into SILC Packet Header.
1292
1293 The payload may only be sent with SILC_PACKET_PRIVATE_MESSAGE_KEY 
1294 packet.  It must not be sent in any other packet type.  Following 
1295 diagram represents the Private Message Key Payload.
1296
1297
1298 .in 5
1299 .nf
1300                      1                   2                   3
1301  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1302 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1303 |  Private Message Key Length   |                               |
1304 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1305 |                                                               |
1306 ~                      Private Message Key                      ~
1307 |                                                               |
1308 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1309 .in 3
1310
1311 .ce
1312 Figure 12:  Private Message Key Payload
1313
1314
1315
1316
1317 .in 6
1318 o Private Message Key Length (2 bytes) - Indicates the length 
1319   of the Private Message Key field in the payload, not including 
1320   any other field.
1321
1322 o Private Message Key (variable length) - The actual private
1323   message key material.  This key is used as such as key material 
1324   for encryption function.
1325 .in 3
1326
1327
1328 .ti 0
1329 2.3.12 Command Payload
1330
1331 Command Payload is used to send SILC commands from client to server.
1332 Also server may send commands to other servers.  Following diagram
1333 represents the Command Payload.
1334
1335
1336 .in 5
1337 .nf
1338                      1                   2                   3
1339  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1340 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1341 |         Payload Length        | SILC Command  | Arguments Num |
1342 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1343 |        Command Unifier        |
1344 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1345 .in 3
1346
1347 .ce
1348 Figure 13:  Command Payload
1349
1350
1351 .in 6
1352 o Payload Length (2 bytes) - Length of the entire command 
1353   payload including any command argument payloads associated 
1354   with this payload.
1355
1356 o SILC Command (1 byte) - SILC Command identifier.  This must 
1357   be set to non-zero value.  If zero (0) value is found in this 
1358   field the packet must be discarded.
1359
1360 o Arguments Num (1 byte) - Indicates the number of arguments
1361   associated with the command.  If there are no arguments this
1362   field is set to zero (0).  The arguments must follow the 
1363   command payload.
1364
1365 o Command Unifier (2 bytes) - Unifies this command at the
1366   sender's end.  The entity who replies to this command must
1367   set the value found from this field into the Command Payload
1368   used to send the reply to the sender.  This way the sender
1369   can identify which command reply belongs to which originally
1370   sent command.  What this field includes is implementation
1371   issue but it is recommended that wrapping counter value is
1372   used in the field.
1373 .in 3
1374
1375 See [SILC1] for detailed description of different SILC commands,
1376 their arguments and their reply messages.
1377
1378
1379 .ti 0
1380 2.3.12.1 Command Argument Payload
1381
1382 Command Argument Payload is used to set arguments for SILC commands.
1383 Number of arguments associated with a command are indicated by the
1384 Command Payload in the Arguments Num field.  Command argument 
1385 payloads may only be used with a command payload and they must 
1386 always reside right after the command payload.  Incorrect amount of
1387 argument payloads must cause rejection of the packet.  Following 
1388 diagram represents the Command Argument Payload.
1389
1390
1391 .in 5
1392 .nf
1393                      1                   2                   3
1394  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1395 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1396 |  Argument Num | Argument Type |         Payload Length        |
1397 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1398 |                                                               |
1399 ~                        Argument Data                          ~
1400 |                                                               |
1401 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1402 .in 3
1403
1404 .ce
1405 Figure 14:  Command Argument Payload
1406
1407
1408 .in 6
1409 o Argument Num (1 byte) - Indicates the number of this argument.
1410   For first argument this is set to 1, for second argument this
1411   is set to 2, and so forth.  If incorrect value is found 
1412   in this field the packet must be discarded.  Value is 
1413   incorrect if it is zero (0) or, for example, a third argument
1414   does not include value 3.
1415
1416 o Argument Type (1 byte) - Indicates the type of the argument.  
1417   Every command specify a number for each argument that maybe 
1418   associated with the command.  By using this number the receiver 
1419   of the packet knows what type of argument this is.  The numbers 
1420   are command specific and has been defined in section SILC
1421   Commands in [SILC1].  This field makes it possible to send
1422   arguments in free order as this field is used to identify
1423   the specific type of the argument.
1424
1425 o Payload Length (2 bytes) - Length of the argument payload data 
1426   area not including the length of any other fields in the 
1427   payload.
1428
1429 o Argument Data (variable length) - Argument data.
1430 .in 3
1431
1432
1433 .ti 0
1434 2.3.13 Command Reply Payload
1435
1436 Command Reply Payload is used to send replies to the commands.  The
1437 Command Reply Payload is identical to the Command Payload thus see the
1438 upper sections for Command Payload and for Command Argument Payload
1439 specifications.  Command Reply message uses the Command Argument Payload
1440 as well.
1441
1442 The entity who sends the reply packet must set the Command Unifier
1443 field in the reply packet's Command Payload to the value it received
1444 in the original command packet.
1445
1446 See SILC Commands in [SILC1] for detailed description of different
1447 SILC commands, their arguments and their reply messages.
1448
1449
1450 .ti 0
1451 2.3.14 Connection Auth Request Payload
1452
1453 Client may send this payload to server to request the authentication
1454 method that must be used in authentication protocol.  If client knows 
1455 this information beforehand this payload is not necessary to be sent.
1456 Server performing authentication with another server may also send
1457 this payload to request the authentication method.  If the connecting
1458 server already knows this information this payload is not necessary
1459 to be sent.
1460
1461 Server receiving this request must reply with same payload sending
1462 the mandatory authentication method.  Algorithms that may be required
1463 to be used by the authentication method are the ones already 
1464 established by the SILC Key Exchange protocol.  See section Key
1465 Exchange Start Payload in [SILC3] for detailed information.
1466
1467 The payload may only be sent with SILC_PACKET_CONNECTION_AUTH_REQUEST
1468 packet.  It must not be sent in any other packet type.  Following 
1469 diagram represents the Connection Auth Request Payload.
1470
1471
1472 .in 5
1473 .nf
1474                      1                   2                   3
1475  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1476 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1477 |        Connection Type        |     Authentication Method     |
1478 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1479 .in 3
1480
1481 .ce
1482 Figure 15:  Connection Auth Request Payload
1483
1484
1485 .in 6
1486 o Connection Type (2 bytes) - Indicates the type of the ID.
1487   Following connection types are defined:
1488
1489      1    Client connection
1490      2    Server connection
1491      3    Router connection
1492
1493   If any other type is found in this field the packet must be
1494   discarded and the authentication must be failed.
1495
1496 o Authentication Method (2 bytes) - Indicates the authentication
1497   method to be used in the authentication protocol.  Following
1498   authentication methods are defined:
1499
1500
1501
1502      0    NONE        (mandatory)
1503      1    password    (mandatory)
1504      2    public key  (mandatory)
1505
1506   If any other type is found in this field the packet must be
1507   discarded and the authentication must be failed.  If this
1508   payload is sent as request to receive the mandatory 
1509   authentication method this field must be set to zero (0),
1510   indicating that receiver should send the mandatory 
1511   authentication method.  The receiver sending this payload
1512   to the requesting party, may also set this field to zero (0) 
1513   to indicate that authentication is not required.  In this
1514   case authentication protocol still must be started but
1515   server is most likely to respond with SILC_PACKET_SUCCESS
1516   immediately.
1517 .in 3
1518
1519
1520 .ti 0
1521 2.3.15 New ID Payload
1522
1523 New ID Payload is a multipurpose payload.  It is used to send newly 
1524 created ID's from clients and servers.  When client connects to server
1525 and registers itself to the server by sending SILC_PACKET_NEW_CLIENT
1526 packet, server replies with this packet by sending the created ID for
1527 the client.  Server always creates the ID for the client.
1528
1529 This payload is also used when server tells its router that new client
1530 has registered to the SILC network.  In this case the server sends
1531 the Client ID of the client to the router.  Similiary when router
1532 distributes information to other routers about the client in the SILC
1533 network this payload is used.  
1534
1535 Also, when server connects to router, router uses this payload to inform
1536 other routers about new server in the SILC network.  However, every 
1537 server (or router) creates their own ID's thus the ID distributed by 
1538 this payload is not created by the distributor in this case.  Servers
1539 create their own ID's.  Server registers itself to the network by sending
1540 SILC_PACKET_NEW_SERVER to the router it connected to.  The case is same
1541 when router connects to another router.
1542
1543 Hence, this payload is very important and used every time when some
1544 new entity is registered to the SILC network.  Client never sends this
1545 payload.  Both client and server (and router) may receive this payload.
1546
1547 The payload may only be sent with SILC_PACKET_NEW_ID packet.  It must
1548 not be sent in any other packet type.  Following diagram represents the
1549 New ID Payload.
1550
1551
1552 .in 5
1553 .nf
1554                      1                   2                   3
1555  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1556 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1557 |             ID Type           |           ID Length           |
1558 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1559 |                                                               |
1560 ~                           ID Data                             ~
1561 |                                                               |
1562 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1563 .in 3
1564
1565 .ce
1566 Figure 16:  New ID Payload
1567
1568
1569 .in 6
1570 o ID Type (2 bytes) - Indicates the type of the ID.  See 
1571   section 2.4 SILC ID Types for list of defined ID types.
1572
1573 o ID Length (2 bytes) - Length of the ID Data area not 
1574   including the length of any other fields in the payload.
1575
1576 o ID Data (variable length) - The actual ID data.
1577 .in 3
1578
1579
1580
1581 .ti 0
1582 2.3.16 New ID List Payload
1583
1584 New ID List Payload is used to distribute list of ID's usually from 
1585 server to router but also from router to other routers in the network.
1586 This payload is used, for example, when server is connected to router
1587 and the server wants to distribute all of its locally connected clients
1588 and locally created channels to the router.  It is convenient in this
1589 case to use this payload instead of sending all the information one
1590 by one using New ID Payload.
1591
1592 There is no specific payload for this packet type.  The packet type
1593 uses same payload as described in previous section.  To form a list
1594 several payloads is put in the packet each after each.  The payload
1595 is variable in length but can be calculated by calculating the ID
1596 Type field, Length field and the ID Data fields together.  This forms
1597 one New ID Payload in the list.
1598
1599 The list of payloads may only be sent with SILC_PACKET_NEW_ID_LIST
1600 packet.  They must not be sent in any other packet type.
1601
1602
1603 .ti 0
1604 2.3.17 New Client Payload
1605
1606 When client is connected to the server, keys has been exchanged and
1607 connection has been authenticated client must register itself to the 
1608 server.  Clients first packet after key exchange and authentication 
1609 protocols must be SILC_PACKET_NEW_CLIENT.  This payload tells server all
1610 the relevant information about the connected user.  Server creates a new
1611 client ID for the client when received this payload and sends it to the
1612 client in New ID Payload.
1613
1614 This payload sends username and real name of the user on the remote host
1615 which is connected to the SILC server with SILC client.  The server 
1616 creates the client ID according the information sent in this payload.
1617 The nickname of the user becomes the username sent in this payload.
1618 However, client should call NICK command after sending this payload to
1619 set the real nickname of the user which is then used to create new 
1620 client ID.
1621
1622 The payload may only be sent with SILC_PACKET_NEW_CLIENT packet.  It
1623 must not be sent in any other packet type.  Following diagram represents
1624 the New Client Payload.
1625
1626
1627 .in 5
1628 .nf
1629                      1                   2                   3
1630  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1631 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1632 |        Username Length        |                               |
1633 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1634 |                                                               |
1635 ~                           Username                            ~
1636 |                                                               |
1637 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1638 |       Real Name Length        |                               |
1639 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1640 |                                                               |
1641 ~                           Real Name                           ~
1642 |                                                               |
1643 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1644 .in 3
1645
1646 .ce
1647 Figure 17:  New Client Payload
1648
1649
1650 .in 6
1651 o Username Length (2 bytes) - Length of the username.
1652
1653 o Username (variable length) - The username of the user on
1654   the host where connecting to the SILC server.
1655
1656 o Real Name Length (2 bytes) - Length of the Real Name.
1657
1658 o Real Name (variable length) - The real name of the user
1659   on the host where connecting to the SILC server.
1660 .in 3
1661
1662
1663 .ti 0
1664 2.3.18 New Server Payload
1665
1666 This payload is sent by server when it has completed successfully both
1667 key exchange and connection authentication protocols.  The server
1668 uses this payload to register itself to the SILC network.  The
1669 first packet after these key exchange and authentication protocols
1670 is SILC_PACKET_NEW_SERVER packet.  The payload includes the Server ID
1671 of the server that it has created by itself.  It also includes a
1672 name of the server that is associated to the Server ID.
1673
1674 The payload may only be sent with SILC_PACKET_NEW_SERVER packet.  It
1675 must not be sent in any other packet type.  Following diagram represents
1676 the New Server Payload.
1677
1678
1679 .in 5
1680 .nf
1681                      1                   2                   3
1682  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1683 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1684 |       Server ID Length        |                               |
1685 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1686 |                                                               |
1687 ~                        Server ID Data                         ~
1688 |                                                               |
1689 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1690 |     Server Name Length        |                               |
1691 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1692 |                                                               |
1693 ~                          Server Name                          ~
1694 |                                                               |
1695 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1696 .in 3
1697
1698 .ce
1699 Figure 18:  New Server Payload
1700
1701
1702 .in 6
1703 o Server ID Length (2 bytes) - Length of the ID Data area not 
1704   including the length of any other fields in the payload.
1705
1706 o Server ID Data (variable length) - The actual Server ID
1707    data.
1708
1709 o Server Name Length (2 bytes) - Length of the server name.
1710
1711 o Server Name (variable length) - The server name.
1712 .in 3
1713
1714
1715 .ti 0
1716 2.3.19 New Channel Payload
1717
1718 Information about newly created channel is broadcasted to all routers
1719 in the SILC network by sending this packet payload.  Channels are
1720 created by router of the cell.  Server never creates channels unless
1721 it is a standalone server and it does not have router connection,
1722 in this case server acts as router.  Normal server forwards JOIN command
1723 to the router (after it has received JOIN command from client) which
1724 then processes the command and creates the channel.  Client never sends
1725 this packet.
1726
1727 The payload may only be sent with SILC_PACKET_NEW_CHANNEL packet.
1728 It must not be sent in any other packet type.  Following diagram
1729 represents the New Channel Payload.
1730
1731
1732 .in 5
1733 .nf
1734                      1                   2                   3
1735  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1736 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1737 |      Channel Name Length      |                               |
1738 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1739 |                                                               |
1740 ~                         Channel Name                          ~
1741 |                                                               |
1742 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1743 |       Channel ID Length       |                               |
1744 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1745 |                                                               |
1746 ~                          Channel ID                           ~
1747 |                                                               |
1748 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1749 .in 3
1750
1751 .ce
1752 Figure 19:  New Channel Payload
1753
1754
1755
1756 .in 6
1757 o Channel Name Length (2 bytes) - Length of the channel name.
1758
1759 o Channel Name (variable length) - The name of the created
1760   channel.
1761
1762 o Channel ID Length (2 bytes) - Length of the Channel ID.
1763
1764 o Channel ID (variable length) - The created Channel ID.
1765 .in 3
1766
1767
1768 .ti 0
1769 2.3.20 New Channel User Payload
1770
1771 When client (user) joins to a channel, server must notify routers
1772 about the new user on the channel.  Normal server sends this packet
1773 payload to its router which then broadcasts the packet further.
1774 Router sends this packet always to its primary router.  Client must
1775 not send this packet payload.  The mode of the user is NONE after 
1776 user has joined to the channel.
1777
1778 The payload may only be sent with SILC_PACKET_NEW_CHANNEL_USER 
1779 packet.  It must not be sent in any other packet type.  Following 
1780 diagram represents the New Channel User Payload.
1781
1782
1783 .in 5
1784 .nf
1785                      1                   2                   3
1786  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1787 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1788 |       Channel ID Length       |                               |
1789 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1790 |                                                               |
1791 ~                          Channel ID                           ~
1792 |                                                               |
1793 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1794 |       Client ID Length        |                               |
1795 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1796 |                                                               |
1797 ~                           Client ID                           ~
1798 |                                                               |
1799 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1800 .in 3
1801
1802 .ce
1803 Figure 20:  New Channel User Payload
1804
1805
1806 .in 6
1807 o Channel ID Length (2 bytes) - Length of the Channel ID.
1808
1809 o Channel ID (variable length) - The Channel ID of the channel
1810   to which the client has joined.
1811
1812 o Client ID Length (2 bytes) - Length of the Client ID.
1813
1814 o Client ID (variable length) - The Client ID of the client
1815   who has joined the channel.
1816 .in 3
1817
1818
1819 .ti 0
1820 2.3.21 New Channel List Payload
1821
1822 This payload is used to distribute list of new channels from server
1823 to routers.  It might convenient to send list of new channels when
1824 existing server connects to router, instead of sending them one
1825 by one.
1826
1827 There is no specific payload for this packet type.  The packet type
1828 uses same payload as described in 2.3.19 New Channel Payload.  To form
1829 a list several payloads is put in the packet each after each.  The
1830 payload is variable in length but can be calculated by calculating
1831 the length of the fields together.  This forms one New Channel Payload
1832 in the list.
1833
1834 The list of payloads may only be sent with SILC_PACKET_NEW_CHANNEL_LIST
1835 packet.  They must not be sent in any other packet type.
1836
1837
1838 .ti 0
1839 2.3.22 New Channel User List Payload
1840
1841 This payload is used to distribute list of channel users on specific
1842 channel from server to routers.  It might convenient to send list of
1843 channel users when existing server connects to router, instead of
1844 sending them one by one.
1845
1846 There is no specific payload for this packet type.  The packet type
1847 uses same payload as described in 2.3.20 New Channel User Payload.
1848 To form a list several payloads is put in the packet each after each.
1849 The payload is variable in length but can be calculated by calculating
1850 the length of the fields together.  This forms one New Channel User
1851 Payload in the list.
1852
1853 The list of payloads may only be sent with packet
1854 SILC_PACKET_NEW_CHANNEL_USER_LIST. They must not be sent in any other
1855 packet type.
1856
1857
1858 .ti 0
1859 2.3.23 Replace ID Payload
1860
1861 This payload is used to replace old ID with new ID sent in the payload.
1862 When ID changes for some entity and the new ID is wanted to replace the
1863 old one this payload must be used.  Client cannot send or receive this
1864 payload.  Normal server and router server may send and receive this
1865 payload.  After this packet has been sent the old ID must not be used
1866 anymore.
1867
1868 The payload may only be sent with SILC_PACKET_REPLACE_ID packet.  It must
1869 not be sent in any other packet type.  Following diagram represents the 
1870 Replace Payload Payload.
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880 .in 5
1881 .nf
1882                      1                   2                   3
1883  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1884 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1885 |          Old ID Type          |         Old ID Length         |
1886 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1887 |                                                               |
1888 ~                         Old ID Data                           ~
1889 |                                                               |
1890 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1891 |          New ID Type          |         New ID Length         |
1892 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1893 |                                                               |
1894 ~                         New ID Data                           ~
1895 |                                                               |
1896 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1897 .in 3
1898
1899 .ce
1900 Figure 21:  Replace ID Payload
1901
1902
1903 .in 6
1904 o Old ID Type (2 bytes) - Indicates the type of the old ID.  See 
1905   section 2.4 SILC ID Types for list of defined ID types.
1906
1907 o Old ID Length (2 bytes) - Length of the old ID Data area not 
1908   including the length of any other fields in the payload.
1909
1910 o Old ID Data (variable length) - The actual old ID data.
1911
1912 o New ID Type (2 bytes) - Indicates the type of the new ID.  See 
1913   section 2.4 SILC ID Types for list of defined ID types.
1914
1915 o New ID Length (2 bytes) - Length of the new ID Data area not 
1916   including the length of any other fields in the payload.
1917
1918 o New ID Data (variable length) - The actual new ID data.
1919 .in 3
1920
1921
1922 .ti 0
1923 2.3.24 Remove ID Payload
1924
1925 Remove ID payload is used to remove ID from SILC network.  This is used
1926 for example when client exits SILC network.  The server must in this
1927 case send this payload to notify that this ID is not valid anymore.
1928 After this has been send the old ID must not be used anymore.  Client
1929 must not send this payload.
1930
1931 The payload may only be sent with SILC_PACKET_REMOVE_ID packet.  It must
1932 not be sent in any other packet type.  Following diagram represents the 
1933 Remove Payload Payload.
1934
1935
1936 .in 5
1937 .nf
1938                      1                   2                   3
1939  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1940 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1941 |            ID Type            |           ID Length           |
1942 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1943 |                                                               |
1944 ~                            ID Data                            ~
1945 |                                                               |
1946 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1947 .in 3
1948
1949 .ce
1950 Figure 22:  Remove ID Payload
1951
1952
1953 .in 6
1954 o ID Type (2 bytes) - Indicates the type of the ID to be
1955   removed.  See section 2.4 SILC ID Types for list of defined
1956   ID types.
1957
1958 o ID Length (2 bytes) - Length of the ID Data area not including
1959   the length of any other fields in the payload.
1960
1961 o ID Data (variable length) - The actual ID data to be removed.
1962 .in 3
1963
1964
1965 .ti 0
1966 2.3.25 Remove Channel User Payload
1967
1968 Remove Channel User payload is used to remove a user from a channel network
1969 wide.  This is used by routers to notify other routers that a user has
1970 leaved a channel.  As routers keep information about users on channels a
1971 user leaving channel must be removed from all routers.  Normal server may
1972 send this payload as well.  Client must not send this payload.
1973
1974 The payload may only be sent with SILC_PACKET_REMOVE_CHANNEL USER packet.
1975 It must not be sent in any other packet type.  Following diagram
1976 represents the Remove Payload Payload.
1977
1978
1979 .in 5
1980 .nf
1981                      1                   2                   3
1982  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
1983 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1984 |      Client ID Length         |                               |
1985 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1986 |                                                               |
1987 ~                        Client ID Data                         ~
1988 |                                                               |
1989 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1990 |      Channel ID Length        |                               |
1991 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1992 |                                                               |
1993 ~                        Channel ID Data                        ~
1994 |                                                               |
1995 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1996 .in 3
1997
1998 .ce
1999 Figure 23:  Remove Channel User Payload
2000
2001
2002 .in 6
2003 o Client ID Length (2 bytes) - Length of the Client ID Data area
2004   not including the length of any other fields in the payload.
2005
2006 o Client ID Data (variable length) - The Client ID of the user
2007   that has left the channel.
2008
2009 o Channel ID Length (2 bytes) - Length of the Channel ID Data area
2010   not including the length of any other fields in the payload.
2011
2012 o Channel ID Data (variable length) - The Channel ID of the channel
2013   the user has left.
2014 .in 3
2015
2016
2017 .ti 0
2018 2.4 SILC ID Types
2019
2020 ID's are extensively used in the SILC network to associate different
2021 entities.  Following ID's has been defined to be used in the SILC
2022 network.
2023
2024 .in 6
2025 0    No ID
2026
2027    When ever specific ID cannot be used this is used.
2028
2029 1    Server ID
2030
2031    Server ID to associate servers.  See the format of
2032    this ID in [SILC1].
2033
2034 2    Client ID
2035
2036    Client ID to associate clients.  See the format of
2037    this ID in [SILC1].
2038
2039 3    Channel ID
2040
2041    Channel ID to associate channels.  See the format of
2042    this ID in [SILC1].
2043 .in 3
2044
2045
2046 .ti 0
2047 2.5 Packet Encryption And Decryption
2048
2049 SILC packets are encrypted almost entirely.  Only small part of SILC
2050 header is not encrypted as described in section 5.2 SILC Packet Header.
2051 The SILC Packet header is the first part of a packet to be encrypted
2052 and it is always encrypted with the key of the next receiver of the
2053 packet.  The data payload area of the packet is always entirely 
2054 encrypted and it is usually encrypted with the next receiver's key.
2055 However, there are some special packet types and packet payloads
2056 that require special encryption process.  These special cases are
2057 described in the next sections.  First is described the normal packet
2058 encryption process.
2059
2060
2061 .ti 0
2062 2.5.1 Normal Packet Encryption And Decryption
2063
2064 Normal SILC packets are encrypted with the session key of the next
2065 receiver of the packet.  The entire SILC Packet header and the packet
2066 data payload is is also encrypted with the same key.  Padding of the
2067 packet is also encrypted always with the session key, also in special
2068 cases.  Computed MAC of the packet must not be encrypted.
2069
2070 Decryption process in these cases are straightforward.  The receiver
2071 of the packet must first decrypt the SILC Packet header, or some parts
2072 of it, usually first 16 bytes of it.  Then the receiver checks the
2073 packet type from the decrypted part of the header and can determine
2074 how the rest of the packet must be decrypted.  If the packet type is
2075 any of the special cases described in following sections the packet
2076 decryption is special.  If the packet type is not among those special
2077 packet types rest of the packet may be decrypted with the same key.
2078
2079 Also, note that two bytes of the SILC Packet header are not encrypted
2080 thus it must be noticed in the decryption process by starting the
2081 decryption from the second byte of the header.  This sets some rules
2082 to padding generation as well, see the section 2.7 Packet Padding
2083 Generation.
2084
2085 With out a doubt, this sort of decryption processing causes some
2086 overhead to packet decryption, but never the less, is required.
2087
2088
2089 .ti 0
2090 2.5.2 Channel Message Encryption And Decryption
2091
2092 Channel Messages (Channel Message Payload) are always encrypted with
2093 the channel specific key.  However, the SILC Packet header is not 
2094 encrypted with that key.  As in normal case, the header is encrypted
2095 with the key of the next receiver of the packet, who ever that might
2096 be.  Note that in this case the encrypted data area is not touched
2097 at all; it must not be re-encrypted with the session key.
2098
2099 Receiver of a channel message, who ever that is, is required to decrypt
2100 the SILC Packet header to be able to even recognize the packet to be as
2101 channel message.  This is same procedure as for normal SILC packets.
2102 As the receiver founds the packet to be channel message, rest of the
2103 packet processing is special.  Rest of the SILC Packet header is
2104 decrypted with the same session key along with the padding of the
2105 packet.  After that the packet is protected with the channel specific
2106 key and hence can be decrypted only if the receiver is the client on
2107 the channel.  See section 2.7 Packet Padding Generation for more
2108 information about padding on special packets.
2109
2110 If the receiver of the channel message is router who is routing the
2111 message to another router then it must decrypt the Channel Message
2112 payload.  Between routers (that is, between cells) channel messages
2113 are protected with session keys shared between the routers.  This
2114 causes another special packet processing for channel messages.  If
2115 the channel message is received from another router then the entire
2116 packet, including Channel Message payload, is encrypted with the
2117 session key shared between the routers.  In this case the packet
2118 decryption process is as with normal SILC packets.  Hence, if the
2119 router is sending channel message to another router the Channel
2120 Message payload must have been decrypted and must be re-encrypted
2121 with the session key shared between the another router.  In this
2122 case the packet encryption is as with any normal SILC packet.
2123
2124 It must be noted that this is only when the channel messages are sent
2125 from router to another router.  In all other cases the channel
2126 message encryption and decryption is as described above.  This
2127 different processing of channel messages with router to router
2128 connection is because channel keys are cell specific.  All cells has
2129 their own channel keys thus the channel message traveling from one
2130 cell to another must be protected as it would be any normal SILC
2131 packet.
2132
2133
2134 .ti 0
2135 2.5.3 Private Message Encryption And Decryption
2136
2137 By default, private message in SILC are protected by session keys.
2138 In this case the private message encryption and decryption process is
2139 equivalent to normal packet encryption and decryption.
2140
2141 However, private messages can be protected with private message key
2142 which causes the packet to be special packet.  The procedure in this
2143 case is very much alike to channel packets.  The actual private message
2144 is encrypted with the private message key and other parts of the
2145 packet is encrypted with the session key.  See 2.7 Packet Padding
2146 Generation for more information about padding on special packets.
2147
2148 The difference from channel message processing is that server or router
2149 en route never decrypts the actual private message, as it does not
2150 have the key to do that.  Thus, when sending packets between router
2151 the processing is same as in any other case as well; the packet's header
2152 and padding is protected by the session key and the data area is not
2153 touched.
2154
2155 The true receiver of the private message, client, that is, is able
2156 to decrypt the private message as it shares the key with the sender
2157 of the message.
2158
2159
2160 .ti 0
2161 2.6 Packet MAC Generation
2162
2163 Data integrity of a packet is protected by including a message
2164 authentication code (MAC) at the end of the packet.  The MAC is computed
2165 from shared secret MAC key, that is established by the SILC Key Exchange
2166 protocol, and from the original contents of the packet.  The MAC is
2167 always computed before the packet is encrypted, although after it is
2168 compressed if compression is used.
2169
2170 The MAC is computed from entire packet.  Every bit of data in the packet,
2171 including SILC Packet Header is used in the MAC computing.  This way
2172 the entire packet becomes authenticated.
2173
2174 If the packet is special packet MAC is computed from the entire packet
2175 but part of the packet may be encrypted before the MAC is computed.
2176 This is case, for example, with channel messages where the message data
2177 is encrypted with key that server may not now.  In this case the MAC
2178 has been computed from the encrypted data.
2179
2180 See [SILC1] for defined and allowed MAC algorithms.
2181
2182
2183 .ti 0
2184 2.7 Packet Padding Generation
2185
2186 Padding is needed in the packet because the packet is encrypted.  It
2187 must always be multiple by eight (8) or multiple by the size of the
2188 cipher's block size, which ever is larger.  The padding is always
2189 encrypted.
2190
2191 For normal packets the padding is added after the SILC Packet Header
2192 and between the Data Payload area.  The padding for normal packets
2193 are calculated as follows:
2194
2195 .in 6
2196 padding length = 16 - ((packet length - 2) % 16)
2197 .in 3
2198
2199 The 16 is the maximum padding allowed in SILC packet.  Two (2) is 
2200 subtracted from the true length of the packet because two (2) bytes
2201 is not encrypted in SILC Packet Header, see section 2.2 SILC Packet
2202 Header.  Those two bytes that are not encrypted must not be calculated
2203 to the padding length.
2204
2205 For special packets the padding calculation may be different as special
2206 packets may be encrypted differently.  In these cases the encrypted
2207 data area must already be multiple by the block size thus in this case
2208 the padding is calculated only for SILC Packet Header, not for any
2209 other area of the packet.  The same algorithm works in this case as
2210 well, except that the `packet length' is now the SILC Packet Header
2211 length.  In this case, as well, two (2) is subtracted from the
2212 length.
2213
2214 The padding must be random data, preferably, generated by 
2215 cryptographically strong random number generator.
2216
2217
2218 .ti 0
2219 2.8 Packet Compression
2220
2221 SILC Packets may be compressed.  In this case the data payload area
2222 is compressed and all other areas of the packet must remain as they
2223 are.  After compression is performed for the data area, the length
2224 field of Packet Header must be set to the compressed length of the
2225 data.
2226
2227 The compression must always be applied before encryption.  When
2228 the packet is received and decrypted the data area must be decompressed.
2229 Note that the true sender of the packet must apply the compression and
2230 the true receiver of the packet must apply the decompression.  Any
2231 server or router en route must not decompress the packet.
2232
2233
2234 .ti 0
2235 2.9 Packet Sending
2236
2237 The sender of the packet must assemble the SILC Packet Header with
2238 correct values.  It must set the Source ID of the header as its own
2239 ID, unless it is forwarding the packet.  It must also set the Destination
2240 ID of the header to the true destination.  If the destination is client
2241 it will be Client ID, if it is server it will be Server ID and if it is
2242 channel it will be Channel ID.
2243
2244 If the sender wants to compress the packet it must apply the
2245 compression now.  Sender must also compute the padding as described
2246 in above sections.  Then sender must compute the MAC of the packet.
2247
2248 Then sender encrypts the packet as has been described in above
2249 sections according whether the packet is normal packet or special
2250 packet.  The computed MAC must not be encrypted.
2251
2252
2253 .ti 0
2254 2.10 Packet Reception
2255
2256 On packet reception the receiver must check that all fields in the
2257 SILC Packet Header are valid sain.  It must check the flags of the
2258 header and act accordingly.  It must also check the MAC of the packet
2259 and if it is to be failed the packet must be discarded.  Also if the
2260 header of the packet includes any bad fields the packet must be
2261 discarded.
2262
2263 See above sections on the decryption process of the received packet.
2264  
2265 The receiver must also check that the ID's in the header are valid
2266 ID's.  Unsupported ID types or malformed ID's must cause packet
2267 rejection.  The padding on the reception is always ignored.
2268
2269 The receiver must also check the packet type and start parsing the
2270 packet according to the type.  However, note the above sections on
2271 special packet types and their parsing.
2272
2273
2274 .ti 0
2275 2.11 Packet Routing
2276
2277 Routers are the primary entities in the SILC network that takes care
2278 of packet routing.  However, normal servers routes packets as well, for
2279 example, when they are routing channel message to the local clients.
2280 Routing is quite simple as every packet tells the true origin and the
2281 true destination of the packet.
2282
2283 It is still recommended for routers that has several routing connections
2284 to create route cache for those destinations that has faster route than
2285 the router's primary route.  This information is available for the router
2286 when other router connects to the router.  The connecting party then
2287 sends all of its locally connected clients, server and channels.  These
2288 informations helps to create the route cache.  Also, when new channels
2289 are created to a cell its information is broadcasted to all routers
2290 in the network.  Channel ID's are based on router's ID thus it is easy
2291 to create route cache based on these informations.  If faster route for
2292 destination does not exist in router's route cache the packet must be
2293 routed to the primary route (default route).
2294
2295 For server who receives a packet to be routed to its locally connected
2296 client the server must check whether the particular packet type is
2297 allowed to be routed to the client.  Not all packets may be sent by
2298 some odd entity to client that is indirectly connected to the sender.
2299 See section 2.3 SILC Packet Types and paragraph about indirectly connected
2300 entities and sending packets to them.  The section mentions the packets
2301 that may be sent to indirectly connected entities.  It is clear that some
2302 server cannot send, for example, disconnect packet to client that is not
2303 directly connected to the server.
2304
2305
2306 .ti 0
2307 2.12 Packet Forwarding
2308
2309 Currently SILC command packets may be forwarded from one entity to another.
2310 Any other packet currently cannot be forwarded but support for more packet
2311 types may be added if needed.  Forwarding is usually used by server to
2312 forward some command request coming from client to the router as the server
2313 may be incapable to handle the request.  Forwarding may be only one hop
2314 long; the receiver of the packet with Forwarded flag set in the SILC   
2315 Packet header must not forward the packet any further.
2316
2317 The normal scenario is that client sends JOIN command to the server which
2318 is not able to create the channel as there are no local clients on the
2319 channel.  Channels are created always by the router of the cell thus the
2320 packet must be forwarded to the router.  The server forwards the original
2321 packet coming from client to the router after it has set the Forwarded
2322 flag to the SILC Packet header.
2323
2324 Router receiving the packet knows that the packet has to be processed
2325 specially by checking the flags and the Forwarded flag in the SILC Packet
2326 header.  After router has joined the client to the channel (and perhaps
2327 created a new channel) it sends normal command reply packet to the
2328 client.  However, as the router doesn't have direct connection to the
2329 client the packet is sent through the server.  Server detects that 
2330 the command reply packet is destined to the client and sends it to
2331 the client.
2332
2333
2334 .ti 0
2335 2.13 Packet Broadcasting
2336
2337 SILC packets may be broadcasted in SILC network.  However, only router
2338 server may send or receive broadcast packets.  Client and normal server
2339 must not send broadcast packets and they must ignore broadcast packets
2340 if they receive them.  Broadcast packets are sent by setting Broadcast
2341 flag to the SILC packet header.
2342
2343 Broadcasting packets means that the packet is sent to all routers in
2344 the SILC network, except to the router that sent the packet.  The router
2345 receiving broadcast packet must send the packet to its primary route.
2346 The fact that SILC routers may have several router connections may
2347 cause problems, such as race conditions inside the SILC network, if
2348 care is not taken when broadcasting packets.  Router must not send
2349 the broadcast packet to any other route except to its primary route.
2350
2351 If the primary route of the router is the original sender of the packet
2352 the packet must not be sent to the primary route.  This may happen
2353 if router has several router connections and some other router uses
2354 the router as its primary route.
2355
2356 Routers use broadcast packets to broadcast for example information
2357 about newly registered clients, servers, channels etc. so that all the
2358 routers may keep these informations up to date.
2359
2360
2361 .ti 0
2362 2.14 Packet Tunneling
2363
2364 Tunneling is a feature that is available in SILC protocol.  Tunneling
2365 means that extra SILC Packet Header is applied to the original packet
2366 and thus hiding the original packet entirely.  There can be some
2367 interesting applications using tunneling, such as, using ID's based on
2368 private network IP addresses inside in the tunneled packet.  This can
2369 open many interesting features relating to connecting to private network
2370 from the Internet with SILC and many more.  However, this feature is
2371 optional currently in SILC as there does not exist thorough analysis of
2372 this feature.  It is with out a doubt that there will be many more
2373 applications that has not yet been discovered.  Thus, it is left
2374 to Internet Community to investigate the use of tunneling in SILC
2375 protocol.  This document is updated according those investigations
2376 and additional documents on the issue may be written.
2377
2378
2379 .ti 0
2380 3 Security Considerations
2381
2382 Security is central to the design of this protocol, and these security
2383 considerations permeate the specification.
2384
2385
2386 .ti 0
2387 4 References
2388
2389 [SILC1]      Riikonen, P., "Secure Internet Live Conferencing (SILC),
2390              Protocol Specification", Internet Draft, June 2000.
2391
2392 [SILC3]      Riikonen, P., "SILC Key Exchange and Authentication 
2393              Protocols", Internet Draft, June 2000.
2394
2395 [IRC]        Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2396              RFC 1459, May 1993.
2397
2398 [SSH-TRANS]  Ylonen, T., et al, "SSH Transport Layer Protocol", 
2399              Internet Draft.
2400
2401 [PGP]        Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2402              November 1998.
2403
2404 [SPKI]       Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2405              September 1999.
2406
2407 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key 
2408              Infrastructure, Certificate and CRL Profile", RFC 2459,
2409              January 1999.
2410
2411 [Schneier]   Schneier, B., "Applied Cryptography Second Edition",
2412              John Wiley & Sons, New York, NY, 1996.
2413
2414 [Menezes]    Menezes, A., et al, "Handbook of Applied Cryptography",
2415              CRC Press 1997.
2416
2417 [OAKLEY]     Orman, H., "The OAKLEY Key Determination Protocol",
2418              RFC 2412, November 1998.
2419
2420 [ISAKMP]     Maughan D., et al, "Internet Security Association and
2421              Key Management Protocol (ISAKMP)", RFC 2408, November
2422              1998.
2423
2424 [IKE]        Harkins D., and Carrel D., "The Internet Key Exhange
2425              (IKE)", RFC 2409, November 1998.
2426
2427 [HMAC]       Krawczyk, H., "HMAC: Keyed-Hashing for Message
2428              Authentication", RFC 2104, February 1997.
2429
2430
2431 .ti 0
2432 5 Author's Address
2433
2434 .nf
2435 Pekka Riikonen
2436 Kasarmikatu 11 A4
2437 70110 Kuopio
2438 Finland
2439
2440 EMail: priikone@poseidon.pspt.fi
2441
2442 This Internet-Draft expires 13 May 2001