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