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