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