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