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