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