Updates.
[silc.git] / doc / draft-riikonen-silc-spec-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-spec-01.txt                         6 October 2000
20 Expires: 6 Jun 2001
21
22 .in 3
23
24 .ce 3
25 Secure Internet Live Conferencing (SILC),
26 Protocol Specification
27 <draft-riikonen-silc-spec-01.txt>
28
29 .ti 0
30 Status of this Memo
31
32 This document is an Internet-Draft and is in full conformance with   
33 all provisions of Section 10 of RFC 2026.  Internet-Drafts are   
34 working documents of the Internet Engineering Task Force (IETF), its   
35 areas, and its working groups.  Note that other groups may also   
36 distribute working documents as Internet-Drafts.   
37
38 Internet-Drafts are draft documents valid for a maximum of six months   
39 and may be updated, replaced, or obsoleted by other documents at any   
40 time.  It is inappropriate to use Internet-Drafts as reference   
41 material or to cite them other than as "work in progress."   
42
43 The list of current Internet-Drafts can be accessed at   
44 http://www.ietf.org/ietf/1id-abstracts.txt   
45
46 The list of Internet-Draft Shadow Directories can be accessed at   
47 http://www.ietf.org/shadow.html   
48
49 The distribution of this memo is unlimited.  
50
51
52 .ti 0
53 Abstract
54
55 This memo describes a Secure Internet Live Conferencing (SILC)
56 protocol which provides secure conferencing services over insecure
57 network channel.  SILC is IRC [IRC] like protocol, however, it is 
58 not equivalent to IRC and does not support IRC.  Strong cryptographic
59 methods are used to protect SILC packets inside SILC network.  Two
60 other Internet Drafts relates very closely to this memo;  SILC Packet
61 Protocol [SILC2] and SILC Key Exchange and Authentication Protocols
62 [SILC3].
63
64
65
66
67
68
69
70
71 .ti 0
72 Table of Contents
73
74 .nf
75 1 Introduction ..................................................  3
76 2 SILC Concepts .................................................  3
77   2.1 SILC Network Topology .....................................  4
78   2.2 Communication Inside a Cell ...............................  5
79   2.3 Communication in the Network ..............................  6
80   2.4 Channel Communication .....................................  7
81   2.5 Router Connections ........................................  7
82 3 SILC Specification ............................................  8
83   3.1 Client ....................................................  8
84       3.1.1 Client ID ...........................................  9
85   3.2 Server .................................................... 10
86       3.2.1 Server's Local ID List .............................. 10
87       3.2.2 Server ID ........................................... 11 
88       3.2.3 SILC Server Ports ................................... 11
89   3.3 Router .................................................... 12
90       3.3.1 Router's Local ID List .............................. 12
91       3.3.2 Router's Global ID List ............................. 13
92       3.3.3 Router's Server ID .................................. 13
93   3.4 Channels .................................................. 14
94       3.4.1 Channel ID .......................................... 15
95   3.5 Operators ................................................. 15
96   3.6 SILC Commands ............................................. 15
97   3.7 SILC Packets .............................................. 16
98   3.8 Packet Encryption ......................................... 16
99       3.8.1 Determination of the Source and the Destination ..... 17
100       3.8.2 Client To Client .................................... 17
101       3.8.3 Client To Channel ................................... 19
102       3.8.4 Server To Server .................................... 19
103   3.9 Key Exchange And Authentication ........................... 20
104   3.10 Algorithms ............................................... 20
105       3.10.1 Ciphers ............................................ 20
106       3.10.2 Public Key Algorithms .............................. 21
107       3.10.3 MAC Algorithms ..................................... 21
108       3.10.4 Compression Algorithms ............................. 22
109   3.11 SILC Public Key .......................................... 22
110   3.12 SILC Version Detection ................................... 24
111 4 SILC Procedures ............................................... 25
112   4.1 Creating Client Connection ................................ 25
113   4.2 Creating Server Connection ................................ 26
114   4.3 Joining to a Channel ...................................... 27
115   4.4 Channel Key Generation .................................... 28
116   4.5 Private Message Sending and Reception ..................... 29
117   4.6 Private Message Key Generation ............................ 29
118   4.7 Channel Message Sending and Reception ..................... 30
119   4.8 Session Key Regeneration .................................. 30
120   4.9 Command Sending and Reception ............................. 30
121 5 SILC Commands ................................................. 31
122   5.1 SILC Commands Syntax ...................................... 31
123   5.2 SILC Commands List ........................................ 33
124   5.3 SILC Command Status Types ................................. 56
125       5.3.1 SILC Command Status Payload ......................... 56
126       5.3.2 SILC Command Status List ............................ 57
127 6 Security Considerations ....................................... 61
128 7 References .................................................... 61
129 8 Author's Address .............................................. 62
130
131
132 .ti 0
133 List of Figures
134
135 .nf
136 Figure 1:  SILC Network Topology
137 Figure 2:  Communication Inside cell
138 Figure 3:  Communication Between Cells
139 Figure 4:  Router Connections
140 Figure 5:  SILC Public Key
141 Figure 6:  SILC Command Status Payload
142
143
144 .ti 0
145 1. Introduction
146
147 This document describes a Secure Internet Live Conferencing (SILC)
148 protocol which provides secure conferencing services over insecure
149 network channel.  SILC is IRC [IRC] like protocol, however, it is 
150 not equivalent to IRC and does not support IRC.
151
152 Strong cryptographic methods are used to protect SILC packets inside
153 SILC network.  Two other Internet Drafts relates very closely to this
154 memo; SILC Packet Protocol [SILC2] and SILC Key Exchange and
155 Authentication Protocols [SILC3].
156
157 The protocol uses extensively packets as conferencing protocol 
158 requires message and command sending.  The SILC Packet Protocol is
159 described in [SILC2] and should be read to fully comprehend this
160 document and protocol.  [SILC2] also describes the packet encryption
161 and decryption in detail.
162
163 The security of SILC protocol and for any security protocol for that
164 matter is based on strong and secure key exchange protocol.  The SILC
165 Key Exchange protocol is described in [SILC3] along with connection
166 authentication protocol and should be read to fully comprehend this
167 document and protocol.
168
169 The SILC protocol has been developed to work on TCP/IP network
170 protocol, although it could be made to work on other network protocols
171 with only minor changes.  However, it is recommended that TCP/IP
172 protocol is used under SILC protocol.  Typical implementation would
173 be made in client-server model.
174
175
176 .ti 0
177 2. SILC Concepts
178
179 This section describes various SILC protocol concepts that forms the 
180 actual protocol, and in the end, the actual SILC network.  The mission
181 of the protocol is to deliver messages from clients to other clients 
182 through routers and servers in secure manner.  The messages may also 
183 be delivered from one client to many clients forming a group, also 
184 known as a channel.
185
186 This section does not focus to security issues, instead basic network 
187 concepts are introduced to make the topology of the SILC network 
188 clear.
189
190
191 .ti 0
192 2.1 SILC Network Topology
193
194 SILC network is a cellular network as opposed to tree style network 
195 topology.  The rationale for this is to have servers that can perform 
196 specific kind of tasks what other servers cannot perform.  This leads 
197 to two kinds of servers; normal SILC servers and SILC routers.
198
199 A difference between normal server and router server is that routers 
200 knows everything about everything in the network.  They also do the 
201 actual routing of the messages to the correct receiver.  Normal servers 
202 knows only about local information and nothing about global information.
203 This makes the network faster as there are less servers that needs to 
204 keep global information up to date at all time.
205
206 This, on the other hand, leads to cellular like network, where routers 
207 are in the center of the cell and servers are connected to the router.
208
209 Following diagram represents SILC network topology.
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227 .in 8
228 .nf
229   ---- ---- ----         ---- ---- ----
230  | S8 | S5 | S4 |       | S7 | S5 | S6 |
231  ----- ---- -----       ----- ---- -----
232 | S7 | S/R1 | S2 | --- | S8 | S/R2 | S4 |
233  ---- ------ ----       ---- ------ ----
234  | S6 | S3 | S1 |       | S1 | S3 | S2 |         ---- ----
235   ---- ---- ----         ---- ---- ----         | S3 | S1 |
236      Cell 1.   \\             Cell 2.  | \\____  ----- -----
237                 |                     |        | S4 | S/R4 |
238     ---- ---- ----         ---- ---- ----       ---- ------
239    | S7 | S4 | S2 |       | S1 | S3 | S2 |      | S2 | S5 |
240    ----- ---- -----       ----- ---- -----       ---- ----
241   | S6 | S/R3 | S1 | --- | S4 | S/R5 | S5 | ____/ Cell 4.
242    ---- ------ ----       ---- ------ ----
243    | S8 | S5 | S3 |       | S6 | S7 | S8 |     ... etc ...
244     ---- ---- ----         ---- ---- ----
245        Cell 3.                Cell 5.
246 .in 3
247
248 .ce
249 Figure 1:  SILC Network Topology
250
251
252 A cell is formed when a server or servers connect to one router.  In
253 SILC network normal server cannot directly connect to other normal
254 server.  Normal server may only connect to SILC router which then
255 routes the messages to the other servers in the cell.  Router servers
256 on the other hand may connect to other routers to form the actual SILC 
257 network, as seen in above figure.  However, router is also normal SILC 
258 server; clients may connect to it the same way as to normal SILC 
259 servers.  Normal server also cannot have active connections to more 
260 than one router.  Normal server cannot be connected to two different 
261 cells.  Router servers, on the other hand, may have as many router to 
262 router connections as needed.
263
264 There are many issues in this network topology that needs to be careful
265 about.  Issues like the size of the cells, the number of the routers in 
266 the SILC network and the capacity requirements of the routers.  These
267 issues should be discussed in the Internet Community and additional
268 documents on the issue will be written.
269
270
271 .ti 0
272 2.2 Communication Inside a Cell
273
274 It is always guaranteed that inside a cell message is delivered to the 
275 recipient with at most two server hops.  Client who is connected to
276 server in the cell and is talking on channel to other client connected 
277 to other server in the same cell, will have its messages delivered from 
278 its local server first to the router of the cell, and from the router 
279 to the other server in the cell.
280
281 Following diagram represents this scenario:
282
283
284 .in 25
285 .nf
286 1 --- S1     S4 --- 5
287          S/R
288  2 -- S2     S3
289      /        |
290     4         3
291 .in 3
292
293
294 .ce
295 Figure 2:  Communication Inside cell
296
297
298 Example:  Client 1. connected to Server 1. message sent to
299           Client 4. connected to Server 2. travels from Server 1.
300           first to Router which routes the message to Server 2.
301           which then sends it to the Client 4.  All the other
302           servers in the cell will not see the routed message.
303
304
305 If client is connected directly to the router, as router is also normal 
306 SILC server, the messages inside the cell are always delivered only with 
307 one server hop.  If clients communicating with each other are connected 
308 to the same server, no router interaction is needed.  This is the optimal
309 situation of message delivery in the SILC network.
310
311
312 .ti 0
313 2.3 Communication in the Network
314
315 If the message is destined to server that does not belong to local cell 
316 the message is routed to the router server to which the destination 
317 server belongs, if the local router is connected to destination router.
318 If there is no direct connection to the destination router, the local
319 router routes the message to its primary route.  Following diagram
320 represents message sending between cells.
321
322
323 .in 16
324 .nf
325 1 --- S1     S4 --- 5            S2 --- 1
326          S/R - - - - - - - - S/R
327  2 -- S2     S3           S1
328      /        |             \\
329     4         3              2
330
331    Cell 1.               Cell 2.
332 .in 3
333
334
335 .ce
336 Figure 3:  Communication Between Cells
337
338
339 Example:  Client 5. connected to Server 4. in Cell 1. message sent
340           to Client 2. connected to Server 1. in Cell 2. travels
341           from Server 4. to Router which routes the message to
342           Router in Cell 2, which then routes the message to 
343           Server 1.  All the other servers and routers in the
344           network will not see the routed message.
345
346
347 The optimal case of message delivery from client point of view is
348 when clients are connected directly to the routers and the messages
349 are delivered from one router to the other router.
350
351
352 .ti 0 
353 2.4 Channel Communication
354
355 Messages may be sent to group of clients as well.  Sending messages to
356 many clients works the same way as sending messages point to point, from
357 message delivery point of view.  Security issues are another matter
358 which are not discussed in this section.
359
360 Router server handles the message routing to multiple recipients.  If 
361 any recipient is not in the same cell as the sender the messages are 
362 routed further.
363
364 Server distributes the channel message to its local clients who are 
365 joined to the channel.  Also, router distributes the message to its 
366 local clients on the channel.
367
368
369 .ti 0
370 2.5 Router Connections
371
372 Router connections play very important role in making the SILC like
373 network topology to work.  For example, sending broadcast packets in
374 SILC network require special connections between routers; routers must
375 be connected in specific way.
376
377 Every router has their primary route which is a connection to another
378 router in the network.  Unless there is only two routers in the network
379 must not routers use each other as their primary routes.  The router
380 connections in the network must form a circular.
381
382 Example with three routers in the network:
383
384
385
386
387
388
389
390 .in 16
391 .nf
392     S/R1 - > - > - > - > - > - > - S/R2
393      \\                               /
394       ^                             v
395        \\ - < -  < - S/R3 - < - < - /
396 .in 3
397
398
399 .ce
400 Figure 4:  Router Connections
401
402
403 Example:  Network with three routers.  Router 1. uses Router 2. as its
404           primary router.  Router 2. uses Router 3. as its primary router,
405           and Router 3. uses Router 1. as its primary router.  There may
406           be other direct connections between the routers but they must
407           not be used as primary routes.
408
409 The above example is applicable to any amount of routers in the network
410 except for two routers.  If there are only two routers in the network both
411 routers must be able to handle situation where they use each other as their
412 primary routes.
413
414 The issue of router connections are very important especially with SILC
415 broadcast packets.  Usually all router wide information in the network is
416 distributed by SILC broadcast packets.
417
418
419 .ti 0
420 3. SILC Specification
421
422 This section describes the SILC protocol.  However, [SILC2] and
423 [SILC3] describes other important protocols that are part of this SILC
424 specification and must be read.
425
426
427 .ti 0
428 3.1 Client
429
430 A client is a piece of software connecting to SILC server.  SILC client 
431 cannot be SILC server.  Purpose of clients is to provide the user 
432 interface of the SILC services for end user.  Clients are distinguished
433 from other clients by unique Client ID.  Client ID is a 128 bit ID that
434 is used in the communication in the SILC network.  The client ID is 
435 based on the nickname selected by the user.  User uses logical nicknames
436 in communication which are then mapped to the corresponding Client ID.
437 Client ID's are low level identifications and must not be seen by the
438 end user.
439
440 Clients provide other information about the end user as well. Information
441 such as the nickname of the user, username and the hostname of the end 
442 user and user's real name.  See section 3.2 Server for information of 
443 the requirements of keeping this information.
444
445 The nickname selected by the user is not unique in the SILC network.
446 There can be 2^8 same nicknames for one IP address. As for comparison to
447 IRC [IRC] where nicknames are unique this is a fundamental difference
448 between SILC and IRC.  This causes the server names to be used along
449 with the nicknames to identify specific users when sending messages.
450 This feature of SILC makes IRC style nickname-wars obsolete as no one
451 owns their nickname; there can always be someone else with the same
452 nickname.  Another difference is that there are no limit of the length
453 of the nickname in the SILC.
454
455
456 .ti 0
457 3.1.1 Client ID
458
459 Client ID is used to identify users in the SILC network.  The Client ID
460 is unique to the extent that there can be 2^128 different Client ID's.
461 Collisions are not expected to happen.  The Client ID is defined as 
462 follows.
463
464 .in 6
465 128 bit Client ID based on IPv4 addresses:
466
467 32 bit  ServerID IP address (bits 1-32)
468  8 bit  Random number
469 88 bit  Truncated MD5 hash value of the nickname
470
471 o Server ID IP address - Indicates the server where this
472   client is coming from.  The IP address hence equals the
473   server IP address where to the client has connected.
474
475 o Random number - Random number to further randomize the
476   Client ID.  This makes it possible to have 2^8 same
477   nicknames from the same server IP address.
478
479 o MD5 hash - MD5 hash value of the nickname is truncated
480   taking 88 bits from the start of the hash value.  This
481   hash value is used to search the user's Client ID from
482   the ID lists.
483
484 .in 3
485 Collisions could occur when more than 2^8 clients using same nickname
486 from the same server IP address is connected to the SILC network.  
487 Server must be able to handle this situation by refusing to accept 
488 anymore of that nickname.
489
490 Another possible collision may happen with the truncated hash value of
491 the nickname.  It could be possible to have same truncated hash value for
492 two different nicknames.  However, this is not expected to happen nor
493 cause any problems if it would occur.  Nicknames are usually logical and
494 it is unlikely to have two distinct logical nicknames produce same
495 truncated hash value.
496
497
498 .ti 0
499 3.2 Server
500
501 Servers are the most important parts of the SILC network.  They form the
502 basis of the SILC, providing a point to which clients may connect to.
503 There are two kinds of servers in SILC; normal servers and router servers.
504 This section focus on the normal server and router server is described
505 in the section 3.3 Router.
506
507 Normal servers may not directly connect to other normal server.  Normal
508 servers may only directly connect to router server.  If the message sent
509 by the client is destined outside the local server it is always sent to
510 the router server for further routing.  Server may only have one active
511 connection to router on same port.  Normal server may not connect to other
512 cell's router except in situations where its cell's router is unavailable.
513
514 Servers and routers in the SILC network are considered to be trusted.
515 With out a doubt, servers that are set to work on ports above 1023 are
516 not considered to be trusted.  Also, the service provider acts important
517 role in the server's trustworthy.
518
519
520 .ti 0
521 3.2.1 Server's Local ID List
522
523 Normal server keeps various information about the clients and their end
524 users connected to it.  Every normal server must keep list of all locally
525 connected clients, Client ID's, nicknames, usernames and hostnames and
526 user's real name.  Normal servers only keeps local information and it
527 does not keep any global information.  Hence, normal servers knows only
528 about their locally connected clients.  This makes servers efficient as
529 they don't have to worry about global clients.  Server is also responsible
530 of creating the Client ID's for their clients.
531
532 Normal server also keeps information about locally created channels and
533 their Channel ID's.
534
535
536 Hence, local list for normal server includes:
537
538 .in 6
539 server list        - Router connection
540    o Server name
541    o Server IP address
542    o Server ID
543    o Sending key
544    o Receiving key
545    o Public key
546
547
548
549
550 client list        - All clients in server
551    o Nickname
552    o Username@host
553    o Real name
554    o Client ID
555    o Sending key
556    o Receiving key
557
558 channel list       - All channels in server
559    o Channel name
560    o Channel ID
561    o Client ID's on channel
562    o Client ID modes on channel
563    o Channel key
564 .in 3
565
566
567
568 .ti 0
569 3.2.2 Server ID
570
571 Servers are distinguished from other servers by unique 64 bit Server ID.
572 The Server ID is used in the SILC to route messages to correct servers.
573 Server ID's also provide information for Client ID's, see section 3.1.1
574 Client ID.  Server ID is defined as follows.
575
576 .in 6
577 64 bit Server ID based on IPv4 addresses:
578
579 32 bit  IP address of the server
580 16 bit  Port
581 16 bit  Random number
582
583 o IP address of the server - This is the real IP address of
584   the server.
585
586 o Port - This is the port the server is bound to.
587
588 o Random number - This is used to further randomize the Server ID.
589
590 .in 3
591 Collisions are not expected to happen in any conditions.  The Server ID
592 is always created by the server itself and server is responsible of
593 distributing it to the router.
594
595
596 .ti 0
597 3.2.3 SILC Server Ports
598
599 Following ports has been assigned by IANA for the SILC protocol:
600
601 .in 10
602 silc            706/tcp    SILC
603 silc            706/udp    SILC
604 .in 3
605
606 If there are needs to create new SILC networks in the future the port
607 numbers must be officially assigned by the IANA.
608
609 Server on network above privileged ports (>1023) should not be trusted
610 as they could have been set up by untrusted party.
611
612
613 .ti 0
614 3.3 Router
615
616 Router server in SILC network is responsible for keeping the cell together
617 and routing messages to other servers and to other routers.  Router server
618 is also a normal server thus clients may connect to it as it would be
619 just normal SILC server.
620
621 However, router servers has a lot of important tasks that normal servers
622 do not have.  Router server knows everything about everything in the SILC.
623 They know all clients currently on SILC, all servers and routers and all
624 channels in SILC.  Routers are the only servers in SILC that care about
625 global information and keeping them up to date at all time.  And, this
626 is what they must do.
627
628
629 .ti 0
630 3.3.1 Router's Local ID List
631
632 Router server as well must keep local list of connected clients and
633 locally created channels.  However, this list is extended to include all
634 the informations of the entire cell, not just the server itself as for
635 normal servers.
636
637 However, on router this list is a lot smaller since routers do not keep
638 information about user's nickname, username and hostname and real name
639 since these are not needed by the router.  Router keeps only information
640 that it needs.
641
642
643 Hence, local list for router includes:
644
645 .in 6
646 server list        - All servers in the cell
647    o Server name
648    o Server ID
649    o Router's Server ID
650    o Sending key
651    o Receiving key
652
653 client list        - All clients in the cell
654    o Client ID
655
656
657 channel list       - All channels in the cell
658    o Channel ID
659    o Client ID's on channel
660    o Client ID modes on channel
661    o Channel key
662 .in 3
663
664
665 Note that locally connected clients and other information include all the
666 same information as defined in section section 3.2.1 Server's Local ID
667 List.
668
669
670 .ti 0
671 3.3.2 Router's Global ID List
672
673 Router server must also keep global list.  Normal servers do not have
674 global list as they know only about local information.  Global list
675 includes all the clients on SILC, their Client ID's, all created channels
676 and their Channel ID's and all servers and routers on SILC and their
677 Server ID's.  That is said, global list is for global information and the
678 list must not include the local information already on the router's local
679 list.
680
681 Note that the global list does not include information like nicknames,
682 usernames and hostnames or user's real names.  Router does not keep
683 these informations as they are not needed by the router.  This 
684 information is available from the client's server which maybe queried
685 when needed.
686
687 Hence, global list includes:
688
689 .in 6
690 server list        - All servers in SILC
691    o Server name
692    o Server ID
693    o Router's Server ID
694
695
696 client list        - All clients in SILC
697    o Client ID
698
699 channel list       - All channels in SILC
700    o Channel ID
701    o Client ID's on channel
702    o Client ID modes on channel
703 .in 3
704
705
706 .ti 0
707 3.3.3 Router's Server ID
708
709 Router's Server ID's are equivalent to normal Server ID's.  As routers
710 are normal servers as well same types of ID's applies for routers as well.
711 Thus, see section 3.2.2 Server ID.  Server ID's for routers are always
712 created by the remote router where the router is connected to.
713
714
715 .ti 0
716 3.4 Channels
717
718 A channel is a named group of one or more clients which will all receive
719 messages addressed to that channel.  The channel is created when first
720 client requests JOIN command to the channel, and the channel ceases to
721 exist when the last client has left it.  When channel exists, any client
722 can reference it using the name of the channel.
723
724 Channel names are unique although the real uniqueness comes from 64 bit
725 Channel ID that unifies each channel.  However, channel names are still
726 unique and no two global channels with same name may exist.  Channel name
727 is a string which begins with `#' character.  There is no limit on the
728 length of the channel name.  Channel names may not contain any spaces
729 (`  '), any non-printable ASCII characters, commas (`,') and wildcard
730 characters.
731
732 Channels can have operators that can administrate the channel and
733 operate all of its modes.  Following operators on channel exist on SILC
734 network.
735
736 .in 6
737 o Channel founder - When channel is created the joining client becomes
738   channel founder.  Channel founder is channel operator with some more
739   privileges.  Basically, channel founder can fully operate the channel
740   and all of its modes.  The privileges are limited only to the particular
741   channel.  There can be only one channel founder per channel.  Channel
742   founder supersedes channel operator's privileges.
743
744   Channel founder privileges cannot be removed by any other operator on
745   channel.  When channel founder leaves the channel there is no channel
746   founder on the channel.  Channel founder also cannot be removed by
747   force from the channel.
748
749 o Channel operator - When client joins to channel that has not existed
750   previously it will become automatically channel operator (and channel
751   founder discussed above).  Channel operator is able administrate the
752   channel, set some modes on channel, remove a badly behaving client from
753   the channel and promote other clients to become channel operator.
754   The privileges are limited only to the particular channel.
755
756   Normal channel user may be promoted (opped) to channel operator
757   gaining channel operator privileges.  Channel founder or other channel
758   operator may also demote (deop) channel operator to normal channel
759   user.
760 .in 3
761
762
763 .ti 0
764 3.4.1 Channel ID
765
766 Channels are distinguished from other channels by unique Channel ID.
767 The Channel ID is a 64 bit ID and collisions are not expected to happen
768 in any conditions.  Channel names are just for logical use of channels.
769 The Channel ID is created by the server where the channel is created.
770 The Channel ID is defined as follows.
771
772 .in 6
773 64 bit Channel ID based on IPv4 addresses:
774
775 32 bit  Router's Server ID IP address (bits 1-32)
776 16 bit  Router's Server ID port (bits 33-48)
777 16 bit  Random number
778
779 o Router's Server ID IP address - Indicates the IP address of 
780   the router of the cell where this channel is created.  This is 
781   taken from the router's Server ID.  This way SILC router knows 
782   where this channel resides in the SILC network.
783
784 o Router's Server ID port - Indicates the port of the channel on 
785   the server.  This is taken from the router's Server ID.
786
787 o Random number - To further randomize the Channel ID.  This makes
788   sure that there are no collisions.  This also means that
789   in a cell there can be 2^16 channels.
790 .in 3
791
792
793 .ti 0
794 3.5 Operators
795
796 Operators are normal users with extra privileges to their server or
797 router.  Usually these people are SILC server and router administrators
798 that take care of their own server and clients on them.  The purpose of
799 operators is to administrate the SILC server or router.  However, even
800 an operator with highest privileges is not able to enter invite-only
801 channel, to gain access to the contents of a encrypted and authenticated
802 packets traveling in the SILC network or to gain channel operator
803 privileges on public channels without being promoted.  They have the
804 same privileges as everyone else except they are able to administrate
805 their server or router.
806
807
808 .ti 0
809 3.6 SILC Commands
810
811 Commands are very important part on SILC network especially for client
812 which uses commands to operate on the SILC network.  Commands are used
813 to set nickname, join to channel, change modes and many other things.
814
815 Client usually sends the commands and server replies by sending a reply
816 packet to the command.  Server may also send commands usually to serve
817 the original client's request.  However, server may not send command
818 to client and there are some commands that server must not send.  Server
819 is also able to send the forwarded command packets.  For example, 
820 SILC_COMMAND_JOIN is always forwarded packet.  See [SILC2] for more
821 about packet forwarding.
822
823 Note that the command reply is usually sent only after client has sent
824 the command request but server is allowed to send command reply packet
825 to client even if client has not requested the command.  Client may,
826 however, choose ignore the command reply, but should not.
827
828 It is expected that some of the commands may be miss-used by clients
829 resulting various problems on the server side.  Every implementation
830 should assure that commands may not be executed more than once, say,
831 in two (2) seconds.  This should be sufficient to prevent the miss-use
832 of commands.
833
834 SILC commands are described in section 5 SILC Commands.
835
836
837 .ti 0
838 3.7 SILC Packets
839
840 Packets are naturally the most important part of the protocol and the
841 packets are what actually makes the protocol.  Packets in SILC network
842 are always encrypted using, usually, the shared secret session key
843 or some other key, for example, channel key, when encrypting channel
844 messages.  The SILC Packet Protocol is a wide protocol and is described
845 in [SILC2].  This document does not define or describe details of
846 SILC packets.
847
848
849
850 .ti 0
851 3.8 Packet Encryption
852
853 All packets passed in SILC network must be encrypted.  This section
854 defines how packets must be encrypted in the SILC network.  The detailed
855 description of the actual encryption process of the packets are
856 described in [SILC2].
857
858 Client and its server shares secret symmetric session key which is
859 established by the SILC Key Exchange Protocol, described in [SILC3]. 
860 Every packet sent from client to server, with exception of packets for
861 channels, are encrypted with this session key.
862
863 Channels has their own key that are shared by every client on the channel.
864 However, the channel keys are cell specific thus one cell does not know
865 the channel key of the other cell, even if that key is for same channel.
866 Channel key is also known by the routers and all servers that has clients
867 on the channel.  However, channels may have channel private keys that
868 are entirely local setting for client.  All clients on the channel must
869 know the channel private key before hand to be able to talk on the
870 channel.  In this case, no server or router knows the key for channel.
871
872 Server shares secret symmetric session key with router which is
873 established by the SILC Key Exchange Protocol.  Every packet passed from
874 server to router, with exception of packets for channels, are encrypted
875 with the shared session key.  Same way, router server shares secret
876 symmetric key with its primary route.  However, every packet passed
877 from router to other router, including packets for channels, are
878 encrypted with the shared session key.  Every router connection has
879 their own session keys.
880
881
882 .ti 0
883 3.8.1 Determination of the Source and the Destination
884
885 The source and the destination of the packet needs to be determined
886 to be able to route the packets to correct receiver.  This information
887 is available in the SILC Packet Header which is included in all packets
888 sent in SILC network.  The SILC Packet Header is described in [SILC2].
889
890 The header is always encrypted with the session key who is next receiver
891 of the packet along the route.  The receiver of the packet, for example
892 a router along the route, is able to determine the sender and the
893 destination of the packet by decrypting the SILC Packet Header and
894 checking the ID's attached to the header.  The ID's in the header will
895 tell to where the packet needs to be sent and where it is coming from.
896
897 The header in the packet does not change during the routing of the
898 packet.  The original sender, for example client, assembles the packet
899 and the packet header and server or router between the sender and the
900 receiver must not change the packet header.
901
902 Note that the packet and the packet header may be encrypted with
903 different keys.  For example, packets to channels are encrypted with
904 the channel key, however, the header is encrypted with the session key
905 as described above.  However, the header and the packet may be encrypted
906 with same key.  This is case, for example, with command packets.
907
908
909 .ti 0
910 3.8.2 Client To Client
911
912 Process of message delivery and encryption from client to another
913 client is as follows.
914
915 Example:  Private message from client to another client on different
916           servers.  Clients do not share private message delivery
917           keys; normal session keys are used.
918
919 o Client 1. sends encrypted packet to its server.  The packet is
920   encrypted with the session key shared between client and its
921   server.
922
923 o Server determines the destination of the packet and decrypts
924   the packet.  Server encrypts the packet with session key shared
925   between the server and its router, and sends the packet to the
926   router.
927
928 o Router determines the destination of the packet and decrypts
929   the packet.  Router encrypts the packet with session key 
930   shared between the router and the destination server, and sends
931   the packet to the server.
932
933 o Server determines the client to which the packet is destined
934   to and decrypts the packet.  Server encrypts the packet with
935   session key shared between the server and the destination client,
936   and sends the packet to the client.
937
938 o Client 2. decrypts the packet.
939
940
941 Example:  Private message from client to another client on different
942           servers.  Clients has established secret shared private
943           message delivery key with each other and that is used in 
944           the message encryption.
945
946 o Client 1. sends encrypted packet to its server.  The packet is
947   encrypted with the private message delivery key shared between
948   clients.
949
950 o Server determines the destination of the packet and sends the 
951   packet to the router.
952
953 o Router determines the destination of the packet and sends the
954   packet to the server.
955
956 o Server determines the client to which the packet is destined
957   to and sends the packet to the client.
958
959 o Client 2. decrypts the packet with the secret shared key.
960
961
962 If clients share secret key with each other the private message
963 delivery is much simpler since servers and routers between the
964 clients do not need to decrypt and re-encrypt the packet.
965
966 The process for clients on same server is much simpler as there are
967 no need to send the packet to the router.  The process for clients 
968 on different cells is same as above except that the packet is routed 
969 outside the cell.  The router of the destination cell routes the 
970 packet to the destination same way as described above.
971
972
973 .ti 0
974 3.8.3 Client To Channel
975
976 Process of message delivery from client on channel to all the clients
977 on the channel.
978
979 Example:  Channel of four users; two on same server, other two on
980           different cells.  Client sends message to the channel.
981
982 o Client 1. encrypts the packet with channel key and sends the
983   packet to its server.
984
985 o Server determines local clients on the channel and sends the
986   packet to the Client on the same server.  Server then sends
987   the packet to its router for further routing.
988
989 o Router determines local clients on the channel, if found
990   sends packet to the local clients.  Router determines global
991   clients on the channel and sends the packet to its primary
992   router or fastest route.
993
994 o (Other router(s) do the same thing and sends the packet to
995    the server(s))
996
997 o Server determines local clients on the channel and sends the
998   packet to the client.
999
1000 o All clients receiving the packet decrypts the packet.
1001
1002
1003 .ti 0
1004 3.8.4 Server To Server
1005
1006 Server to server packet delivery and encryption is described in above
1007 examples. Router to router packet delivery is analogous to server to
1008 server.  However, some packets, such as channel packets, are processed
1009 differently.  These cases are described later in this document and
1010 more in detail in [SILC2].
1011
1012
1013 .ti 0
1014 3.9 Key Exchange And Authentication
1015
1016 Key exchange is done always when for example client connects to server
1017 but also when server and router and router and router connects to each
1018 other.  The purpose of key exchange protocol is to provide secure key
1019 material to be used in the communication.  The key material is used to
1020 derive various security parameters used to secure SILC packets.  The
1021 SILC Key Exchange protocol is described in detail in [SILC3].
1022
1023 Authentication is done after key exchange protocol has been successfully
1024 completed.  The purpose of authentication is to authenticate for example
1025 client connecting to the server.  However, Usually clients are accepted
1026 to connect to server without explicit authentication.  Servers are
1027 required use authentication protocol when connecting.  The authentication
1028 may be based on passphrase (pre-shared-secret) or public key.  The
1029 connection authentication protocol is described in detail in [SILC3].
1030
1031
1032 .ti 0
1033 3.10 Algorithms
1034
1035 This section defines all the allowed algorithms that can be used in
1036 the SILC protocol.  This includes mandatory cipher, mandatory public
1037 key algorithm and MAC algorithms.
1038
1039
1040 .ti 0
1041 3.10.1 Ciphers
1042
1043 Cipher is the encryption algorithm that is used to protect the data
1044 in the SILC packets.  See [SILC2] of the actual encryption process and
1045 definition of how it must be done.  SILC has a mandatory algorithm that
1046 must be supported in order to be compliant with this protocol.
1047
1048 Following ciphers are defined in SILC protocol:
1049
1050 .in 6
1051 aes-cbc         AES in CBC mode       (mandatory)
1052 twofish-cbc     Twofish in CBC mode   (optional)
1053 blowfish-cbc    Blowfish in CBC mode  (optional)
1054 rc6-cbc         RC6 in CBC mode       (optional)
1055 rc5-cbc         RC5 in CBC mode       (optional)
1056 mars-cbc        Mars in CBC mode      (optional)
1057 none            No encryption         (optional)
1058 .in 3
1059
1060
1061 All algorithms must use minimum of 128 bit key, by default.  Several
1062 algorithms, however, supports longer keys and it is recommended to use
1063 longer keys if they are available.
1064
1065 Algorithm none does not perform any encryption process at all and 
1066 thus is not recommended to be used.  It is recommended that no client
1067 or server implementation would accept none algorithms except in special
1068 debugging mode.
1069
1070 Additional ciphers may be defined to be used in SILC by using the
1071 same name format as above.
1072
1073
1074 .ti 0
1075 3.10.2 Public Key Algorithms
1076
1077 Public keys are used in SILC to authenticate entities in SILC network
1078 and to perform other tasks related to public key cryptography.  The 
1079 public keys are also used in the SILC Key Exchange protocol [SILC3].
1080
1081 Following public key algorithms are defined in SILC protocol:
1082
1083 .in 6
1084 rsa        RSA  (mandatory)
1085 dss        DSS  (optional)
1086 .in 3
1087
1088 Both of the algorithms are described in [Scheneir] and [Menezes].
1089
1090 Additional public key algorithms may be defined to be used in SILC.
1091
1092
1093 .ti 0
1094 3.10.3 MAC Algorithms
1095
1096 Data integrity is protected by computing a message authentication code
1097 (MAC) of the packet data.  See [SILC2] for details how to compute the
1098 MAC.
1099
1100 Following MAC algorithms are defined in SILC protocol:
1101
1102 .in 6
1103 hmac-sha1        HMAC-SHA1, length = 20  (mandatory)
1104 hmac-md5         HMAC-MD5, length = 16   (optional)
1105 none             No MAC                  (optional)
1106 .in 3
1107
1108 The none MAC is not recommended to be used as the packet is not
1109 authenticated when MAC is not computed.  It is recommended that no
1110 client or server would accept none MAC except in special debugging
1111 mode.
1112
1113 The HMAC algorithm is described in [HMAC] and hash algorithms that
1114 are used as part of the HMACs are described in [Scheneir] and in
1115 [Menezes]
1116
1117 Additional MAC algorithms may be defined to be used in SILC.
1118
1119
1120 .ti 0
1121 3.10.4 Compression Algorithms
1122
1123 SILC protocol supports compression that may be applied to unencrypted
1124 data.  It is recommended to use compression on slow links as it may
1125 significantly speed up the data transmission.  By default, SILC does not
1126 use compression which is the mode that must be supported by all SILC
1127 implementations.
1128
1129 Following compression algorithms are defined:
1130
1131 .in 6
1132 none        No compression               (mandatory)
1133 zlib        GNU ZLIB (LZ77) compression  (optional)
1134 .in 3
1135
1136 Additional compression algorithms may be defined to be used in SILC.
1137
1138
1139 .ti 0
1140 3.11 SILC Public Key
1141
1142 This section defines the type and format of the SILC public key.  All
1143 implementations must support this public key type.  See [SILC3] for
1144 other optional public key and certificate types allowed in SILC
1145 protocol.  Public keys in SILC may be used to authenticate entities
1146 and to perform other tasks related to public key cryptography.
1147
1148 The format of the SILC Public Key is as follows:
1149
1150
1151 .in 5
1152 .nf
1153                      1                   2                   3
1154  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
1155 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1156 |                        Public Key Length                      |
1157 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1158 |     Algorithm Name Length     |                               |
1159 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1160 |                                                               |
1161 ~                         Algorithm Name                        ~
1162 |                                                               |
1163 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1164 |       Identifier Length       |                               |
1165 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+                               +
1166 |                                                               |
1167 ~                           Identifier                          ~
1168 |                                                               |
1169 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1170 |                                                               |
1171 ~                           Public Data                         ~
1172 |                                                               |
1173 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1174 .in 3
1175
1176 .ce
1177 Figure 5:  SILC Public Key
1178
1179
1180 .in 6
1181 o Public Key Length (4 bytes) - Indicates the full length
1182   of the public key, not including this field.
1183
1184 o Algorithm Name Length (2 bytes) - Indicates the length
1185   of the Algorithm Length field, not including this field.
1186
1187 o Algorithm name (variable length) - Indicates the name
1188   of the public key algorithm that the key is.  See the
1189   section 3.10.2 Public Key Algorithms for defined names.
1190
1191 o Identifier Length (2 bytes) - Indicates the length of
1192   the Identifier field, not including this field.
1193
1194 o Identifier (variable length) - Indicates the identifier
1195   of the public key.  This data can be used to identify
1196   the owner of the key.  The identifier is of following
1197   format:
1198
1199      UN   User name
1200      HN   Host name or IP address
1201      RN   Real name
1202      E    EMail address
1203      O    Organization
1204      C    Country
1205
1206
1207   Examples of an identifier:
1208
1209     `UN=priikone, HN=poseidon.pspt.fi, E=priikone@poseidon.pspt.fi'
1210
1211     `UN=sam, HN=dummy.fi, RN=Sammy Sam, O=Company XYZ, C=Finland'
1212
1213   At least user name (UN) and host name (HN) must be provided as
1214   identifier.  The fields are separated by commas (`,').  If
1215   comma is in the identifier string it must be written as `\\,',
1216   for example, `O=Company XYZ\\, Inc.'.
1217
1218 o Public Data (variable length) - Includes the actual
1219   public data of the public key.
1220
1221   The format of this field for RSA algorithm is
1222   as follows:
1223
1224      4 bytes            Length of e
1225      variable length    e
1226      4 bytes            Length of n
1227      variable length    n
1228
1229
1230   The format of this field for DSS algorithm is
1231   as follows:
1232
1233      4 bytes            Length of p
1234      variable length    p
1235      4 bytes            Length of q
1236      variable length    q
1237      4 bytes            Length of g
1238      variable length    g
1239      4 bytes            Length of y
1240      variable length    y
1241
1242   The variable length fields are multiple precession
1243   integers encoded as strings in both examples.
1244
1245   Other algorithms must define their own type of this
1246   field if they are used.
1247 .in 3
1248
1249 All fields in the public key are in MSB (most significant byte first)
1250 order.
1251
1252
1253 .ti 0
1254 3.12 SILC Version Detection
1255
1256 The version detection of both client and server is performed at the
1257 connection phase while executing the SILC Key Exchange protocol.  The
1258 version identifier is exchanged between initiator and responder.  The
1259 version identifier is of following format:
1260
1261 .in 6
1262 SILC-<protocol version>-<software version>
1263 .in 3
1264
1265 The version strings are of following format:
1266
1267 .in 6
1268 protocol version = <major>.<minor>
1269 software version = <major>[.<minor>[.<build>]]
1270 .in 3
1271
1272 Protocol version may provide both major and minor version.  Currently
1273 implementations must set the protocol version and accept the protocol
1274 version as SILC-1.0-<sotware version>. 
1275
1276 Software version may provide major, minor and build version.  The
1277 software version may be freely set and accepted.
1278
1279
1280 Thus, the version string could be, for example:
1281
1282 .in 6
1283 SILC-1.0-1.2
1284 .in 3
1285
1286
1287 .ti 0
1288 4 SILC Procedures
1289
1290 This section describes various SILC procedures such as how the 
1291 connections are created and registered, how channels are created and
1292 so on.  The section describes the procedures only generally as details
1293 are described in [SILC2] and [SILC3].
1294
1295
1296 .ti 0
1297 4.1 Creating Client Connection
1298
1299 This section describes the procedure when client connects to SILC server.
1300 When client connects to server the server must perform IP address lookup
1301 and reverse IP address lookup to assure that the origin host really is
1302 who it claims to be.  Client, host, connecting to server must have 
1303 both valid IP address and fully qualified domain name (FQDN).
1304
1305 After that client and server performs SILC Key Exchange protocol which
1306 will provide the key material used later in the communication.  The
1307 key exchange protocol must be completed successfully before the connection
1308 registration may continue.  The SILC Key Exchange protocol is described
1309 in [SILC3].
1310
1311 Typical server implementation would keep a list of connections that it
1312 allows to connect to the server.  The implementation would check, for
1313 example, the connecting client's IP address from the connection list
1314 before the SILC Key Exchange protocol has been started.  Reason for
1315 this is that if the host is not allowed to connect to the server there
1316 is no reason to perform a key exchange protocol.
1317
1318 After successful key exchange protocol the client and server performs
1319 connection authentication protocol.  The purpose of the protocol is to
1320 authenticate the client connecting to the server.  Flexible
1321 implementation could also accept the client to connect to the server
1322 without explicit authentication.  However, if authentication is
1323 desired for a specific client it may be based on passphrase or
1324 public key authentication.  If authentication fails the connection
1325 must be terminated.  The connection authentication protocol is described
1326 in [SILC3].
1327
1328 After successful key exchange and authentication protocol the client
1329 registers itself by sending SILC_PACKET_NEW_CLIENT packet to the
1330 server.  This packet includes various information about the client
1331 that the server uses to create the client.  Server creates the client
1332 and sends SILC_PACKET_NEW_ID to the client which includes the created
1333 Client ID that the client must start using after that.  After that
1334 all SILC packets from the client must have the Client ID as the
1335 Source ID in the SILC Packet Header, described in [SILC2].
1336
1337 Client must also get the server's Server ID that is to be used as
1338 Destination ID in the SILC Packet Header when communicating with
1339 the server (for example when sending commands to the server).  The
1340 ID may be resolved in two ways.  Client can take the ID from an
1341 previously received packet from server that must include the ID,
1342 or to send SILC_COMMAND_INFO command and receive the Server ID as
1343 command reply.
1344
1345 Server may choose not to use the information received in the
1346 SILC_PACKET_NEW_CLIENT packet.  For example, if public key or 
1347 certificate were used in the authentication, server may use those
1348 informations rather than what it received from client.  This is suitable
1349 way to get the true information about client if it is available.
1350
1351 The nickname of client is initially set to the username sent in the
1352 SILC_PACKET_NEW_CLIENT packet.  User should set the nickname to more
1353 suitable by sending SILC_COMMAND_NICK command.  However, this is not
1354 required as part of registration process.
1355
1356 Server must also distribute the information about newly registered
1357 client to its router (or if the server is router, to all routers in
1358 the SILC network).  More information about this in [SILC2].
1359
1360
1361 .ti 0
1362 4.2 Creating Server Connection
1363
1364 This section descibres the procedure when server connects to its
1365 router (or when router connects to other router, the cases are
1366 equivalent).  The procedure is very much alike when client connects
1367 to the server thus it is not repeated here.
1368
1369 One difference is that server must perform connection authentication
1370 protocol with proper authentication.  Proper authentication is based
1371 on passphrase or public key authentication.
1372
1373 After server and router has successfully performed the key exchange
1374 and connection authentication protocol, the server register itself
1375 to the router by sending SILC_PACKET_NEW_SERVER packet.  This packet
1376 includes the server's Server ID that it has created by itself and
1377 other relevant information about the server.
1378
1379 After router has received the SILC_PACKET_NEW_SERVER packet it
1380 distributes the information about newly registered server to all routers
1381 in the SILC network.  More information about this in [SILC2].
1382
1383 As client needed to resolve the destination ID this must be done by the
1384 server that connected to the router, as well.  The way to resolve it is
1385 to get the ID from previously received packet.  Server must also start
1386 using its own Server ID as Source ID in SILC Packet Header and the
1387 router's Server ID as Destination when communicating with the router.
1388
1389 If the server has already connected clients and locally created
1390 channels the server must distribute these informations to the router.
1391 The distribution is done by sending packet SILC_PACKET_NEW_CHANNEL.
1392 See [SILC2] for more information on this.
1393
1394
1395 .ti 0
1396 4.3 Joining to a Channel
1397
1398 This section describes the procedure when client joins to a channel.
1399 Client may join to channel by sending command SILC_COMMAND_JOIN to the
1400 server.  If the receiver receiving join command is normal server the
1401 server must check its local list whether this channel already exists
1402 locally.  This would indicate that some client connected to the server
1403 has already joined to the channel.  If this is case the client is
1404 joined to the client, new channel key is created and information about
1405 newly joined channel is sent to the router.  The new channel key is
1406 also distributed to the router and to all clients on the channel.
1407
1408 If the channel does not exist in the local list the command must be
1409 forwarded to the router which will then perform the actual joining
1410 procedure.  When server receives the reply to the command from the
1411 router it must be distributed to the client who sent the command
1412 originally.  Server will also receive the channel key from the server
1413 that it must distribute to the client who originally requested the
1414 join command.  The server must also save the channel key.
1415
1416 If the receiver of the join command is router it must first check its
1417 local list whether anyone in the cell has already joined to the channel.
1418 If this is the case the client is joined to the channel and reply is
1419 sent to the client.  If the command was sent by server the command reply
1420 is sent to the server who sent it.  Then the router must also create
1421 new channel key and distribute it to all clients on the channel and
1422 all servers that has clients on the channel.
1423
1424 If the channel does not exist on the router's local list it must
1425 check the global list whether the channel exists at all.  If it does
1426 the client is joined to the channel as described previously.  If
1427 the channel does not exist the channel is created and the client
1428 is joined to the channel.  The channel key is also created and
1429 distributed as previously described.  The client joining to the created
1430 channel is made automatically channel founder and both channel founder
1431 and channel operator privileges is set for the client.
1432
1433 When the router joins the client to the channel it must send 
1434 information about newly joined client to all routers in the SILC 
1435 network.  Also, if the channel was created in the process, information
1436 about newly created channel must also be distributed to all routers.
1437 The distribution of newly created channel is done by sending packet
1438 SILC_PACKET_NEW_CHANNEL.
1439
1440 It is important to note that new channel key is created always when
1441 new client joins to channel, whether the channel has existed previously
1442 or not.  This way the new client on the channel is not able to decrypt
1443 any of the old traffic on the channel.  Client who receives the reply to
1444 the join command must start using the received Channel ID in the channel
1445 message communication thereafter.  Client also receives the key for the
1446 channel in the command reply.
1447
1448 If client wants to know the other clients currently on the channel
1449 the client must send SILC_COMMAND_USERS command to receive a list of
1450 channel users.  Server implementation, however, may send command reply
1451 packet to SILC_COMMAND_USERS command after client has joined to the
1452 channel even if the client has not sent the command.  Server should also
1453 send SILC_NOTIFY_TYPE_JOIN to all clients on the channel about a new
1454 client on the channel.
1455
1456
1457 .ti 0
1458 4.4 Channel Key Generation
1459
1460 Channel keys are created by router who creates the channel by taking
1461 enough randomness from cryptographically strong random number generator.
1462 The key is generated always when channel is created, when new client
1463 joins a channel and after the key has expired.  Key could expire for
1464 example in an hour.
1465
1466 The key must also be re-generated whenever some client leaves a channel.
1467 In this case the key is created from scratch by taking enough randomness
1468 from the random number generator.  After that the key is distributed to
1469 all clients on the channel.  However, channel keys are cell specific thus
1470 the key is created only on the cell where the client, who left the
1471 channel, exists.  While the server or router is creating the new channel
1472 key, no other client may join to the channel.  Messages that are sent
1473 while creating the new key are still processed with the old key.  After
1474 server has sent the SILC_PACKET_CHANNEL_KEY packet must client start
1475 using the new key.  If server creates the new key the server must also
1476 send the new key to its router.  See [SILC2] on more information about
1477 how channel messages must be encrypted and decrypted when router is
1478 processing them.
1479
1480
1481 .ti 0
1482 4.5 Private Message Sending and Reception
1483
1484 Private messages are sent point to point.  Client explicitly destines
1485 a private message to specific client that is delivered to only to that
1486 client.  No other client may receive the private message.  The receiver
1487 of the private message is destined in the SILC Packet Header as any
1488 other packet as well.
1489
1490 If the sender of a private message does not know the receiver's Client
1491 ID, it must resolve it from server.  There are two ways to resolve the
1492 client ID from server; it is recommended that client implementations
1493 send SILC_COMMAND_IDENTIFY command to receive the Client ID.  Client
1494 may also send SILC_COMMAND_WHOIS command to receive the Client ID.
1495 If the sender has received earlier a private message from the receiver
1496 it should have cached the Client ID from the SILC Packet Header.
1497
1498 Receiver of a private message should not explicitly trust the nickname
1499 that it receives in the Private Message Payload, described in [SILC2].
1500 Implementations could resolve the nickname from server, as described
1501 previously, and compare the received Client ID and the SILC Packet
1502 Header's Client ID.  The nickname in the payload is merely provided
1503 to be displayed for end user.
1504
1505 See [SILC2] for description of private message encryption and decryption
1506 process.
1507
1508
1509 .ti 0
1510 4.6 Private Message Key Generation
1511
1512 Private message may be protected by key generated by client.  The key
1513 may be generated and sent to the other client by sending packet
1514 SILC_PACKET_PRIVATE_MESSAGE_KEY which travels through the network
1515 and is secured by session keys.  After that the private message key
1516 is used in the private message communication between those clients.
1517 See more information about how this works technically in [SILC2].
1518
1519 Other choice is to entirely use keys that are not sent through
1520 the SILC network at all.  This significantly adds security.  This key
1521 would be pre-shared-key that is known by both of the clients.  Both
1522 agree about using the key and starts sending packets that indicate
1523 that the private message is secured using private message key.  This
1524 is the technical aspect mentioned previously that is described
1525 in [SILC2].
1526
1527 If the private message keys are not set to be used, which is the
1528 case by default in SILC, the private messages are secured by using
1529 normal session keys established by SILC Key Exchange protocol.
1530
1531
1532
1533
1534 .ti 0
1535 4.7 Channel Message Sending and Reception
1536
1537 Channel messages are delivered to group of users.  The group forms a
1538 channel and all clients on the channel receives messages sent to the
1539 channel.
1540
1541 Channel messages are destined to channel by specifying the Channel ID
1542 as Destination ID in the SILC Packet Header.  The server must then
1543 distribute the message to all clients on the channel by sending the
1544 channel message destined explicitly to a client on the channel.
1545
1546 See [SILC2] for description of channel message encryption and decryption
1547 process.
1548
1549
1550 .ti 0
1551 4.8 Session Key Regeneration
1552
1553 Session keys should be regenerated periodically, say, once in an hour.
1554 The re-key process is started by sending SILC_PACKET_REKEY packet to
1555 other end, to indicate that re-key must be performed.
1556
1557 If perfect forward secrecy (PFS) flag was selected in the SILC Key
1558 Exchange protocol [SILC3] the re-key must cause new key exchange with
1559 SKE protocol.  In this case the protocol is secured with the old key
1560 and the protocol results to new key material.  See [SILC3] for more
1561 information.  After the SILC_PACKET_REKEY packet is sent the sender
1562 will perform the SKE protocol.
1563
1564 If PFS flag was not set, which is the default case, then re-key is done
1565 without executing SKE protocol.  In this case, the new key is created by
1566 hashing the old key with hash function selected earlier in the SKE
1567 protocol.  If the digest length of the hash function is too short for the
1568 key, then the key is distributed as described in section Processing the
1569 Key Material in [SILC3].  After both parties has regenerated the session
1570 key, both send SILC_PACKET_REKEY_DONE packet to each other.  These packets
1571 are still secured with the old key.  After these packets, following
1572 packets must be protected with the new key.
1573
1574
1575 .ti 0
1576 4.9 Command Sending and Reception
1577
1578 Client usually sends the commands in the SILC network.  In this case
1579 the client simply sends the command packet to server and the server
1580 processes it and replies with command reply packet.
1581
1582 However, if the server is not able to process the command, it is sent 
1583 to the server's router.  This is case for example with commands such
1584 as, SILC_COMMAND_JOIN and SILC_COMMAND_WHOIS commands.  However, there
1585 are other commands as well.  For example, if client sends the WHOIS
1586 command requesting specific information about some client the server must
1587 send the WHOIS command to router so that all clients in SILC network
1588 are searched.  The router, on the other hand, sends the WHOIS command
1589 further to receive the exact information about the requested client.
1590 The WHOIS command travels all the way to the server who owns the client
1591 and it replies with command reply packet.  Finally, the server who
1592 sent the command receives the command reply and it must be able to
1593 determine which client sent the original command.  The server then
1594 sends command reply to the client.  Implementations should have some
1595 kind of cache to handle, for example, WHOIS information.  Servers
1596 and routers along the route could all cache the information for faster
1597 referencing in the future.
1598
1599 The commands sent by server may be sent hop by hop until someone is able
1600 to process the command.  However, it is preferred to destine the command
1601 as precisely as it is possible.  In this case, other routers en route
1602 must route the command packet by checking the true sender and true
1603 destination of the packet.  However, servers and routers must not route
1604 command reply packets to clients coming from other server.  Client
1605 must not accept command reply packet originated from anyone else but
1606 from its own server.
1607
1608
1609 .ti 0
1610 5 SILC Commands
1611
1612 .ti 0
1613 5.1 SILC Commands Syntax
1614
1615 This section briefly describes the syntax of the command notions
1616 in this document.  Every field in command is separated from each
1617 other by whitespaces (` ') indicating that each field is independent
1618 argument and each argument must have own Command Argument Payload.
1619 The number of maximum arguments are defined with each command
1620 separately.  The Command Argument Payload is described in [SILC2].
1621
1622 Every command defines specific number for each argument.  Currently,
1623 they are defined in ascending order; first argument has number one 
1624 (1), second has number two (2) and so on.  This number is set into the
1625 Argument Type field in the Command Argument Payload.  This makes it
1626 possible to send the arguments in free order as the number must be
1627 used to identify the type of the argument.  This makes is it also
1628 possible to have multiple optional arguments in commands and in
1629 command replies.  The number of argument is marked in parentheses
1630 before the actual argument.
1631
1632
1633
1634 .in 6
1635 Example:  Arguments:  (1) <nickname> (2) <username@host>
1636 .in 3
1637    
1638
1639 Every command replies with Status Payload.  This payload tells the
1640 sender of the command whether the command was completed successfully or
1641 whether there was an error.  If error occured the payload includes the
1642 error type.  In the next section the Status Payload is not described 
1643 as it is common to all commands and has been described here.  Commands 
1644 may reply with other arguments as well.  These arguments are command 
1645 specific and are described in the next section.
1646
1647 Example command:
1648 .in 6
1649
1650 EXAMPLE_COMMAND
1651
1652 .in 8
1653 Max Arguments:  3
1654     Arguments:  (1) <nickname>[@<server>]  (2) <message>
1655                 (3) [<count>]
1656
1657 The command has maximum of 3 arguments.  However, only first
1658 and second arguments are mandatory.
1659
1660 First argument <nickname> is mandatory but may have optional
1661 <nickname@server> format as well.  Second argument is mandatory
1662 <message> argument.  Third argument is optional <count> argument.
1663
1664 The numbers in parentheses are the argument specific numbers
1665 that specify the type of the argument in Command Argument Payload.
1666 The receiver always knows that, say, argument number two (2) is
1667 <message> argument, regardless of the ordering of the arguments in
1668 the Command Payload.
1669
1670 Reply messages to the command:
1671
1672 Max Arguments:  4
1673     Arguments:  (1) <Status Payload>  (2) [<channel list>]
1674                 (3) <idle time>       (4) [<away message>]
1675
1676 This command may reply with maximum of 4 arguments.  However,
1677 only the first and third arguments are mandatory.  The numbers
1678 in the parentheses have the same meaning as in the upper
1679 command sending specification.
1680
1681 Every command reply with <Status Payload>, it is mandatory 
1682 argument for all command replies and for this reason it is not
1683 described in the command reply descriptions.
1684
1685
1686
1687 Status messages:
1688
1689     SILC_STATUS_OK
1690     SILC_STATUS_ERR_TOO_MANY_TARGETS
1691     SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1692     SILC_STATUS_ERR_NO_SUCH_NICK
1693
1694 Every command reply also defines set of status message that it
1695 may return inside the <Status Payload>.  All status messages
1696 are defined in the section 5.3 SILC Command Status Types.
1697
1698 .in 3
1699 Every command that has some kind of ID as argument (for example
1700 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
1701 the type of the ID, length of the ID and the actual ID data.  This
1702 way variable length ID's can be sent as arguments.
1703
1704
1705 .ti 0
1706 5.2 SILC Commands List
1707
1708 This section lists all SILC commands, however, it is expected that a
1709 implementation and especially client implementation has many more
1710 commands that has only local affect.  These commands are official
1711 SILC commands that has both client and server sides and cannot be
1712 characterized as local commands.
1713
1714 List of all defined commands in SILC follows.
1715
1716 .in 0
1717    0    SILC_COMMAND_NONE
1718
1719         None.  This is reserved command and must not be sent.
1720
1721
1722    1    SILC_COMMAND_WHOIS
1723
1724         Max Arguments:  3328
1725             Arguments:  (1) [<nickname>[@<server>]]  (2) [<count>]
1726                         (3) [<Client ID>]            (n) [...]
1727
1728         Whois command is used to query various information about specific
1729         user.  The user maybe requested by their nickname and server name.
1730         The query may find multiple matching users as there are no unique
1731         nicknames in the SILC.  The <count> option maybe given to narrow
1732         down the number of accepted results.  If this is not defined there
1733         are no limit of accepted results.  The query may also be narrowed
1734         down by defining the server name of the nickname.
1735
1736         It is also possible to search the user by Client ID.  If <Client ID>
1737         is provided server must use it as the search value instead of
1738         the <nickname>.  One of the arguments must be given.  It is also
1739         possible to define multiple Client ID's to search multiple users
1740         sending only one WHOIS command.  In this case the Client ID's are
1741         appended as normal arguments.  The server replies in this case
1742         with only one reply message for all requested users.
1743
1744         To prevent miss-use of this service wildcards in the nickname
1745         or in the servername are not permitted.  It is not allowed
1746         to request all users on some server.  The WHOIS requests must 
1747         be based on specific nickname request.
1748
1749         The WHOIS request must be always forwarded to router by server
1750         so that all users are searched.  However, the server still must
1751         search its locally connected clients.  The router must send
1752         this command to the server who owns the requested client.  That
1753         server must reply to the command.  Server should not send whois
1754         replies to the client until it has received the reply from its
1755         router.
1756
1757         Reply messages to the command:
1758
1759         Max Arguments:  7
1760             Arguments:  (1) <Status Payload>       (2) <Client ID> 
1761                         (3) <nickname>[@<server>]  (4) <username@host> 
1762                         (5) <real name>            (6) [<channel list>] 
1763                         (7) [<idle time>]
1764
1765         This command may reply with several command reply messages to
1766         form a list of results.  In this case the status payload will
1767         include STATUS_LIST_START status in the first reply and
1768         STATUS_LIST_END in the last reply to indicate the end of the
1769         list.  If there are only one reply the status is set to normal
1770         STATUS_OK.
1771
1772         The command replies include the Client ID of the nickname,
1773         nickname and servername, username and hostname and users real
1774         name.  Client should process these replies only after the last
1775         reply has been received with the STATUS_LIST_END status.  If the
1776         <count> option were defined in the query there will be only
1777         <count> many replies from the server.
1778
1779         Status messages:
1780
1781             SILC_STATUS_OK
1782             SILC_STATUS_LIST_START
1783             SILC_STATUS_LIST_END
1784             SILC_STATUS_ERR_NO_SUCH_NICK
1785             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1786             SILC_STATUS_ERR_WILDCARDS
1787             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1788             SILC_STATUS_ERR_TOO_MANY_PARAMS
1789
1790
1791
1792
1793    2    SILC_COMMAND_WHOWAS
1794
1795         Max Arguments:  2
1796             Arguments:  (1) <nickname>[@<server>]  (2) [<count>]
1797
1798         Whowas.  This command is used to query history information about
1799         specific user.  The user maybe requested by their nickname and 
1800         server name.  The query may find multiple matching users as there
1801         are no unique nicknames in the SILC.  The <count> option maybe
1802         given to narrow down the number of accepted results.  If this
1803         is not defined there are no limit of accepted results.  The query
1804         may also be narrowed down by defining the server name of the 
1805         nickname.
1806
1807         To prevent miss-use of this service wildcards in the nickname
1808         or in the servername are not permitted.  The WHOWAS requests must 
1809         be based on specific nickname request.
1810
1811         The WHOWAS request must be always forwarded to router by server
1812         so that all users are searched.  However, the server still must
1813         search its locally connected clients.
1814
1815         Reply messages to the command:
1816
1817         Max Arguments:  3
1818             Arguments:  (1) <Status Payload>  (2) <nickname>[@<server>]
1819                         (3) <username@host>
1820
1821         This command may reply with several command reply messages to form
1822         a list of results.  In this case the status payload will include
1823         STATUS_LIST_START status in the first reply and STATUS_LIST_END in 
1824         the last reply to indicate the end of the list.  If there are only 
1825         one reply the status is set to normal STATUS_OK.
1826
1827         The command replies with nickname and username and hostname.
1828         Every server must keep history for some period of time of its
1829         locally connected clients.
1830
1831         Status messages:
1832
1833             SILC_STATUS_OK
1834             SILC_STATUS_LIST_START
1835             SILC_STATUS_LIST_END
1836             SILC_STATUS_ERR_NO_SUCH_NICK
1837             SILC_STATUS_ERR_WILDCARDS
1838             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1839             SILC_STATUS_ERR_TOO_MANY_PARAMS
1840
1841
1842    3    SILC_COMMAND_IDENTIFY
1843
1844         Max Arguments:  3328
1845             Arguments:  (1) [<nickname>[@<server>]]  (2) [<count>]
1846                         (3) [<Client ID>]            (n) [...]
1847
1848         Identify.  Identify command is almost analogous to WHOIS command,
1849         except that it does not return as much information.  Only relevant
1850         information such as Client ID is returned.  This is usually used
1851         to get the Client ID of a client used in the communication with
1852         the client.
1853
1854         The query may find multiple matching users as there are no unique 
1855         nicknames in the SILC.  The <count> option maybe given to narrow 
1856         down the number of accepted results.  If this is not defined there 
1857         are no limit of accepted results.  The query may also be narrowed 
1858         down by defining the server name of the nickname.
1859
1860         It is also possible to search the user by Client ID.  If <Client ID>
1861         is provided server must use it as the search value instead of
1862         the <nickname>.  One of the arguments must be given.  It is also
1863         possible to define multiple Client ID's to search multiple users
1864         sending only one IDENTIFY command.  In this case the Client ID's are
1865         appended as normal arguments.  The server replies in this case
1866         with only one reply message for all requested users.
1867
1868         To prevent miss-use of this service wildcards in the nickname
1869         or in the servername are not permitted.  It is not allowed
1870         to request all users on some server.  The IDENTIFY requests must 
1871         be based on specific nickname request.
1872
1873         Implementations may not want to give interface access to this
1874         command as it is hardly a command that would be used by an end user.
1875         However, it must be implemented as it is used with private message
1876         sending.
1877
1878         The IDENTIFY must be always forwarded to router by server so that
1879         all users are searched.  However, server must still search its
1880         locally connected clients.
1881
1882         Reply messages to the command:
1883
1884         Max Arguments:  4
1885             Arguments:  (1) <Status Payload>         (2) <Client ID>
1886                         (3) [<nickname>[@<server>]]  (4) [<username@host>]
1887
1888         This command may reply with several command reply messages to form
1889         a list of results.  In this case the status payload will include
1890         STATUS_LIST_START status in the first reply and STATUS_LIST_END in 
1891         the last reply to indicate the end of the list.  If there are only 
1892         one reply the status is set to normal STATUS_OK.
1893
1894         The command replies with Client ID of the nickname and if more
1895         information is available it may reply with nickname and username
1896         and hostname.  If the <count> option were defined in the query
1897         there will be only <count> many replies from the server.
1898
1899         Status messages:
1900
1901             SILC_STATUS_OK
1902             SILC_STATUS_LIST_START
1903             SILC_STATUS_LIST_END
1904             SILC_STATUS_ERR_NO_SUCH_NICK
1905             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1906             SILC_STATUS_ERR_WILDCARDS
1907             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1908             SILC_STATUS_ERR_TOO_MANY_PARAMS
1909
1910
1911    4    SILC_COMMAND_NICK
1912
1913         Max Arguments:  1
1914             Arguments:  (1) <nickname>
1915
1916         Set/change nickname.  This command is used to set nickname for
1917         user.  There is no limit of the length of the nickname in SILC.
1918         Nickname must not include any spaces (` '), non-printable
1919         characters, commas (`,') and any wildcard characters.  Note:
1920         nicknames in SILC are case-sensitive which must be taken into
1921         account when searching clients by nickname.
1922
1923         When nickname is changed new Client ID is generated.  Server must
1924         distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
1925         channels (if any) the client is joined on.  Then it must send
1926         SILC_PACKET_REPLACE_ID to its primary route to replace the old
1927         Client ID with the new one.
1928
1929         Reply messages to the command:
1930
1931         Max Arguments:  2
1932             Arguments:  (1) <Status Payload>  (2) <New ID Payload>
1933
1934         This command is replied always with New ID Payload that is
1935         generated by the server every time user changes their nickname.
1936         Client receiving this payload must start using the received
1937         Client ID as its current valid Client ID.  The New ID Payload
1938         is described in [SILC2].
1939
1940         Status messages:
1941
1942             SILC_STATUS_OK
1943             SILC_STATUS_ERR_WILDCARDS
1944             SILC_STATUS_ERR_NICKNAME_IN_USE
1945             SILC_STATUS_ERR_BAD_NICKNAME
1946             SILC_STATUS_ERR_NOT_REGISTERED
1947             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1948             SILC_STATUS_ERR_TOO_MANY_PARAMS
1949
1950
1951    5    SILC_COMMAND_LIST
1952
1953         Max Arguments:  2
1954             Arguments:  (1) [<Channel ID>] [<server>]
1955
1956         The list command is used to list channels and their topics on
1957         current server.  If the <Channel ID> parameter is used, only the
1958         status of that channel is displayed.  Secret channels are not
1959         listed at all.  Private channels are listed with status indicating
1960         that the channel is private.
1961
1962         If the <server> argument is specified the specified server's
1963         channels are listed.  In this case the command must be sent to
1964         the server who owns the channel that was requested.
1965
1966         Reply messages to the command:
1967
1968         Max Arguments:  4
1969             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1970                         (3) <channel>         (4) <topic>
1971
1972         This command may reply with several command reply messages to form
1973         a list of results.  In this case the status payload will include
1974         STATUS_LIST_START status in the first reply and STATUS_LIST_END in 
1975         the last reply to indicate the end of the list.  If there are only 
1976         one reply the status is set to normal STATUS_OK.
1977
1978         This command replies with Channel ID, name and the topic of the
1979         channel.  If the channel is private channel the <topic> includes
1980         "*private*" string.
1981
1982         Status messages:
1983
1984             SILC_STATUS_OK
1985             SILC_STATUS_LIST_START
1986             SILC_STATUS_LIST_END
1987             SILC_STATUS_ERR_WILDCARDS
1988             SILC_STATUS_ERR_NOT_REGISTERED
1989             SILC_STATUS_ERR_TOO_MANY_PARAMS
1990             SILC_STATUS_ERR_NO_SUCH_CHANNEL
1991             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1992             SILC_STATUS_ERR_NO_SUCH_SERVER
1993
1994
1995    6    SILC_COMMAND_TOPIC
1996
1997         Max Arguments:  2
1998             Arguments:  (1) <Channel ID>  (2) [<topic>]]
1999
2000         This command is used to change or view the topic of a channel.
2001         The topic for channel <Channel ID> is returned if there is no
2002         <topic> given.  If the <topic> parameter is present, the topic
2003         for that channel will be changed, if the channel modes permit
2004         this action.
2005
2006         Reply messages to the command:
2007
2008         Max Arguments:  2
2009             Arguments:  (1) <Status Payload>  (2) <Channel ID> 
2010                         (3) [<topic>]
2011
2012         The command may reply with the topic of the channel if it is
2013         set.
2014
2015         Status messages:
2016
2017             SILC_STATUS_OK
2018             SILC_STATUS_ERR_NOT_ON_CHANNEL
2019             SILC_STATUS_ERR_WILDCARDS
2020             SILC_STATUS_ERR_NOT_REGISTERED
2021             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2022             SILC_STATUS_ERR_NO_SUCH_CHANNEL
2023             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2024             SILC_STATUS_ERR_NO_CHANNEL_ID
2025             SILC_STATUS_ERR_BAD_CHANNEL_ID
2026             SILC_STATUS_ERR_TOO_MANY_PARAMS
2027             SILC_STATUS_ERR_NO_CHANNEL_PRIV
2028
2029
2030    7    SILC_COMMAND_INVITE
2031
2032         Max Arguments:  2
2033             Arguments:  (1) <Client ID>  (2) <Channel ID>
2034
2035         This command is used to invite other clients to join to the
2036         channel.  The <Client ID> argument is the target client's ID that
2037         is being invited.  The <Channel ID> is the Channel ID of the
2038         requested channel.  The sender of this command must be on the
2039         channel.  This command must fail if the requested channel does
2040         not exist, the requested client is already on the channel or if
2041         the channel is invite only channel and the caller of this command
2042         does not have at least channel operator privileges.
2043
2044         Reply messages to the command:
2045
2046         Max Arguments:  2
2047             Arguments:  (1) <Status Payload>
2048
2049         This command replies only with Status Payload.
2050
2051         Status messages:
2052
2053             SILC_STATUS_OK
2054             SILC_STATUS_ERR_NOT_REGISTERED
2055             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2056             SILC_STATUS_ERR_TOO_MANY_PARAMS
2057             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2058             SILC_STATUS_ERR_NO_CLIENT_ID
2059             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2060             SILC_STATUS_ERR_NO_CHANNEL_ID
2061             SILC_STATUS_ERR_NOT_ON_CHANNEL
2062             SILC_STATUS_ERR_USER_ON_CHANNEL
2063
2064
2065    8    SILC_COMMAND_QUIT
2066
2067         Max Arguments:  1
2068             Arguments:  (1) [<quit message>]
2069
2070         This command is used by client to end SILC session.  The server
2071         must close the connection to a client which sends this command.
2072         if <quit message> is given it will be sent to other clients on
2073         channel if the client is on channel when quitting.
2074
2075         Reply messages to the command:
2076
2077         This command does not reply anything.
2078
2079
2080     9   SILC_COMMAND_KILL
2081
2082         Max Arguments:  2
2083             Arguments:  (1) <Client ID>  (2) [<comment>]
2084
2085         This command is used by SILC operators to remove a client from
2086         SILC network.  The removing has temporary effects and client may
2087         reconnect to SILC network.  The <Client ID> is the client to be
2088         removed from SILC.  The <comment> argument may be provided to 
2089         give to the removed client some information why it was removed
2090         from the network.
2091
2092         Reply messages to the command:
2093
2094         Max Arguments:  1
2095             Arguments:  (1) <Status Payload>
2096
2097         This command replies only with Status Payload.
2098
2099         Status messages:
2100
2101             SILC_STATUS_OK
2102             SILC_STATUS_ERR_WILDCARDS
2103             SILC_STATUS_ERR_NOT_REGISTERED
2104             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2105             SILC_STATUS_ERR_TOO_MANY_PARAMS
2106             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2107             SILC_STATUS_ERR_NO_CLIENT_ID
2108
2109
2110    10   SILC_COMMAND_INFO
2111
2112         Max Arguments:  1
2113             Arguments:  (1) [<server>]
2114
2115         This command is used to fetch various information about a server.
2116         If <server> argument is specified the command must be sent to
2117         the requested server.
2118
2119         Reply messages to the command:
2120
2121         Max Arguments:  3
2122             Arguments:  (1) <Status Payload>  (2) <Server ID>
2123                         (3) <string>
2124
2125         This command replies with the Server ID of the server and a
2126         string which tells the information about the server.
2127
2128         Status messages:
2129
2130             SILC_STATUS_OK
2131             SILC_STATUS_ERR_WILDCARDS
2132             SILC_STATUS_ERR_NOT_REGISTERED
2133             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2134             SILC_STATUS_ERR_TOO_MANY_PARAMS
2135             SILC_STATUS_ERR_NO_SUCH_SERVER
2136
2137
2138    11   SILC_COMMAND_CONNECT
2139
2140         Max Arguments:  2
2141             Arguments:  (1) <Server ID>  
2142                         (2) [<remote server/router>[ <port>]]
2143
2144         This command is used by operators to force a server to try to
2145         establish a new connection to another router (if the connecting
2146         server is normal server) or server (if the connecting server is
2147         router server).  Operator may specify the server/router to be
2148         connected by setting <remote server> argument.  The separator
2149         between <remote server address> and <port> is whitespace (` ').
2150
2151         Reply messages to the command:
2152
2153         Max Arguments:  1
2154             Arguments:  (1) <Status Payload>
2155
2156         This command replies only with Status Payload.
2157
2158
2159
2160         Status messages:
2161
2162             SILC_STATUS_OK
2163             SILC_STATUS_ERR_WILDCARDS
2164             SILC_STATUS_ERR_NOT_REGISTERED
2165             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2166             SILC_STATUS_ERR_TOO_MANY_PARAMS
2167             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2168             SILC_STATUS_ERR_NO_SERVER_PRIV
2169             SILC_STATUS_ERR_NO_ROUTER_PRIV
2170
2171
2172    12   SILC_COMMAND_PING
2173
2174         Max Arguments:  1
2175             Arguments:  (1) <Server ID>
2176
2177         This command is used by client and server to test the communication
2178         channel to its server if one suspects that the communication is not
2179         working correctly.  The <Server ID> is the ID of the server the
2180         sender is connected to.
2181
2182         Reply messages to the command:
2183
2184         Max Arguments:  1
2185             Arguments:  (1) <Status Payload>
2186
2187         This command replies only with Status Payload.  Server returns
2188         SILC_STATUS_OK in Status Payload if pinging was successful.
2189
2190
2191
2192         Status messages:
2193
2194             SILC_STATUS_OK
2195             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2196             SILC_STATUS_ERR_TOO_MANY_PARAMS
2197             SILC_STATUS_ERR_NO_SERVER_ID
2198             SILC_STATUS_ERR_NO_SUCH_SERVER
2199             SILC_STATUS_ERR_NOT_REGISTERED
2200
2201
2202    13   SILC_COMMAND_OPER
2203
2204         Max Arguments:  2
2205             Arguments:  (1) <username>  (2) <authentication data>
2206
2207         This command is used by normal client to obtain server operator
2208         privileges on some server or router.  Note that router operator
2209         has router privileges that supersedes the server operator
2210         privileges and this does not obtain those privileges.  Client
2211         must use SILCOPER command to obtain router level privileges.
2212
2213         The <username> is the username set in the server configurations
2214         as operator.  The <authentication data> is the data that the
2215         client is authenticated against.  It may be passphrase prompted
2216         for user on client's screen or it may be public key
2217         authentication data (data signed with private key), or 
2218         certificate.
2219
2220         Reply messages to the command:
2221
2222         Max Arguments:  1
2223             Arguments:  (1) <Status Payload>
2224
2225         This command replies only with Status Payload.
2226
2227         Status messages:
2228
2229             SILC_STATUS_OK
2230             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2231             SILC_STATUS_ERR_TOO_MANY_PARAMS
2232             SILC_STATUS_ERR_NOT_REGISTERED
2233             SILC_STATUS_ERR_BAD_PASSWORD
2234             SILC_STATUS_ERR_AUTH_FAILED
2235
2236
2237    14   SILC_COMMAND_JOIN
2238
2239         Max Arguments:  4
2240             Arguments:  (1) <channel>       (2) <Client ID>
2241                         (3) [<passphrase>]  (4) [<cipher>]
2242
2243         Join to channel/create new channel.  This command is used to
2244         join to a channel.  If the channel does not exist the channel is
2245         created.  If server is normal server this command must be forwarded
2246         to router who will create the channel.  The channel may be protected
2247         with passphrase.  If this is the case the passphrase must be sent
2248         along the join command.
2249
2250         The name of the <channel> must not include any spaces (` '),
2251         non-printable characters, commas (`,') or any wildcard characters.
2252
2253         The second argument <Client ID> is the Client ID of the client who
2254         is joining to the client.  When client sends this command to the
2255         server the <Client ID> must be the client's own ID.
2256
2257         Cipher to be used to secure the traffic on the channel may be
2258         requested by sending the name of the requested <cipher>.  This
2259         is used only if the channel does not exist and is created.  If
2260         the channel already exists the cipher set previously for the
2261         channel will be used to secure the traffic.
2262
2263         The server must check whether the user is allowed to join to
2264         the requested channel.  Various modes set to the channel affect
2265         the ability of the user to join the channel.  These conditions
2266         are:
2267
2268             o  The user must be invited to the channel if the channel
2269                is invite-only channel.
2270
2271             o  The Client ID/nickname/username/hostname must not match
2272                any active bans.
2273
2274             o  The correct passphrase must be provided if passphrase 
2275                is set to the channel.
2276
2277             o  The user count limit, if set, must not be reached.
2278
2279         Reply messages to the command:
2280
2281         Max Arguments:  9
2282             Arguments:  (1) <Status Payload>  (2) <channel> 
2283                         (3) <Channel ID>      (4) <channel mode mask>
2284                         (5) <created>         (6) <Channel Key Payload>
2285                         (7) [<ban mask>]      (8) [<invite list>]
2286                         (9) [<topic>]
2287
2288         This command replies with the channel name requested by the
2289         client, channel ID of the channel and topic of the channel
2290         if it exists.  It also replies with the channel mode mask
2291         which tells all the modes set on the channel.  If the
2292         channel is created the mode mask is zero (0).  If ban mask
2293         and/or invite list is set they are sent as well.
2294
2295         Client receives the channel key in the reply message as well
2296         inside <Channel Key Payload>.
2297
2298         Status messages:
2299
2300             SILC_STATUS_OK
2301             SILC_STATUS_ERR_WILDCARDS
2302             SILC_STATUS_ERR_NOT_REGISTERED
2303             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2304             SILC_STATUS_ERR_TOO_MANY_PARAMS
2305             SILC_STATUS_ERR_BAD_PASSWORD
2306             SILC_STATUS_ERR_CHANNEL_IS_FULL
2307             SILC_STATUS_ERR_NOT_INVITED
2308             SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2309             SILC_STATUS_ERR_BAD_CHANNEL
2310             SILC_STATUS_ERR_USER_ON_CHANNEL
2311
2312
2313    15   SILC_COMMAND_MOTD
2314
2315         Max Arguments:  1
2316             Arguments:  (1) <server>
2317
2318         This command is used to query the Message of the Day of the server.
2319
2320         Reply messages to the command:
2321
2322         Max Arguments:  2
2323             Arguments:  (1) <Status Payload>  (2) [<motd>]
2324
2325         This command replies with the motd message if it exists.
2326
2327         Status messages:
2328
2329             SILC_STATUS_OK
2330             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2331             SILC_STATUS_ERR_TOO_MANY_PARAMS
2332             SILC_STATUS_ERR_NOT_REGISTERED
2333             SILC_STATUS_ERR_NO_SUCH_SERVER
2334
2335
2336    16   SILC_COMMAND_UMODE
2337
2338         Max Arguments:  2
2339             Arguments:  (1) <Client ID>  (2) <client mode mask>
2340
2341         This command is used by client to set/unset modes for itself.
2342         However, there are some modes that the client may not set itself,
2343         but they will be set by server.  However, client may unset any
2344         mode.  Modes may be masked together ORing them thus having
2345         several modes set.  Client must keep its client mode mask
2346         locally so that the mode setting/unsetting would work without
2347         problems.  Client may change only its own modes.
2348
2349         Following client modes are defined:
2350
2351            0x0000    SILC_UMODE_NONE
2352
2353               No specific mode for client.  This is the initial
2354               setting when new client is created.  The client is
2355               normal client now.
2356
2357
2358            0x0001    SILC_UMODE_SERVER_OPERATOR
2359
2360               Marks the user as server operator.  Client cannot
2361               set this mode itself.  Server sets this mode to the
2362               client when client attains the server operator
2363               privileges by SILC_COMMAND_OPER command.  Client
2364               may unset the mode itself.
2365
2366
2367            0x0002    SILC_UMODE_ROUTER_OPERATOR
2368
2369               Marks the user as router (SILC) operator.  Client
2370               cannot this mode itself.  Router sets this mode to
2371               the client when client attains the router operator
2372               privileges by SILC_COMMAND_SILCOPER command.  Client
2373               may unset the mode itself.
2374
2375         Reply messages to the command:
2376
2377         Max Arguments:  2
2378             Arguments:  (1) <Status Payload>  (2) <client mode mask>
2379
2380         This command replies with the changed client mode mask that
2381         the client is required to keep locally.
2382
2383
2384         Status messages:
2385
2386             SILC_STATUS_OK
2387             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2388             SILC_STATUS_ERR_TOO_MANY_PARAMS
2389             SILC_STATUS_ERR_NOT_REGISTERED
2390             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2391             SILC_STATUS_ERR_BAD_CLIENT_ID
2392             SILC_STATUS_ERR_NOT_YOU
2393             SILC_STATUS_ERR_UNKNOWN_MODE
2394             SILC_STATUS_ERR_NO_RECIPIENT
2395             SILC_STATUS_ERR_NO_CLIENT_ID
2396
2397
2398    17   SILC_COMMAND_CMODE
2399
2400         Max Arguments:  7
2401             Arguments:  (1) <Channel ID>    (2) <channel mode mask>
2402                         (3) [<user limit>]  (4) [<passphrase>]
2403                         (5) [<ban mask>]    (6) [<invite list>]
2404                         (7) [<cipher>[:<key len>]]
2405
2406         This command is used by client to set or change channel flags on
2407         a channel.  Channel has several modes that set various properties
2408         of a channel.  Modes may be masked together by ORing them thus
2409         having several modes set.  The <Channel ID> is the ID of the
2410         target channel.  The client changing channel mode must be on
2411         the same channel and poses sufficient privileges to be able to
2412         change the mode.
2413
2414         When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
2415         type is distributed to the channel.
2416
2417         Following channel modes are defined:
2418
2419            0x0000    SILC_CMODE_NONE
2420
2421               No specific mode on channel.  This is the default when
2422               channel is created.  This means that channel is just plain
2423               normal channel.
2424
2425
2426            0x0001    SILC_CMODE_PRIVATE
2427
2428               Channel is private channel.  Private channels are shown
2429               in the channel list listed with SILC_COMMAND_LIST command
2430               with indication that the channel is private.  Also,
2431               client on private channel will no be detected to be on
2432               the channel as the channel is not shown in the client's
2433               currently joined channel list.  Channel founder and 
2434               channel operator may set/unset this mode.
2435
2436               Typical implementation would use [+|-]p on user interface
2437               to set/unset this mode.
2438
2439
2440            0x0002    SILC_CMODE_SECRET
2441
2442               Channel is secret channel.  Secret channels are not shown
2443               in the list listed with SILC_COMMAND_LIST command.  Secret
2444               channels can be considered to be invisible channels.
2445               Channel founder and channel operator may set/unset this
2446               mode.
2447
2448               Typical implementation would use [+|-]s on user interface
2449               to set/unset this mode.
2450
2451
2452            0x0004    SILC_CMODE_PRIVKEY
2453
2454               Channel uses private channel key to protect the traffic
2455               on the channel.  When this mode is set the client will be
2456               responsible to set the key it wants to use to encrypt and
2457               decrypt the traffic on channel.  Server generated channel
2458               keys are not used at all.  This mode provides additional
2459               security as clients on channel may agree to use private
2460               channel key that even servers do not know.  Naturally,
2461               this requires that every client on the channel knows
2462               the key before hand (it is considered to be pre-shared-
2463               key).  This specification does not define how the private
2464               channel key is set as it is entirely local setting on
2465               client end.
2466
2467               As it is local setting it is possible to have several
2468               private channel keys on one channel.  In this case several
2469               clients can talk on same channel but only those clients
2470               that share the key with the message sender will be able
2471               to hear the talking.  Client should not display those
2472               message for the end user that it is not able to decrypt
2473               when this mode is set.
2474
2475               Only channel founder may set/unset this mode.  If this
2476               mode is unset the server will distribute new channel
2477               key to all clients on the channel which will be used
2478               thereafter.
2479
2480               Typical implementation would use [+|-]k on user interface
2481               to set/unset this mode.
2482
2483
2484            0x0008    SILC_CMODE_INVITE
2485
2486               Channel is invite only channel.  Client may join to this
2487               channel only if it is invited to the channel.  Channel
2488               founder and channel operator may set/unset this mode.
2489
2490               Typical implementation would use [+|-]i on user interface
2491               to set/unset this mode.
2492
2493
2494            0x0010    SILC_CMODE_TOPIC
2495
2496               The topic of the channel may only be set by client that
2497               is channel founder or channel operator.  Normal clients
2498               on channel will not be able to set topic when this mode
2499               is set.  Channel founder and channel operator may set/
2500               unset this mode.
2501
2502               Typical implementation would use [+|-]t on user interface
2503               to set/unset this mode.
2504
2505
2506            0x0020    SILC_CMODE_ULIMIT
2507
2508               User limit has been set to the channel.  New clients
2509               may not join to the channel when the limit set is
2510               reached.  Channel founder and channel operator may set/
2511               unset the limit.  The <user limit> argument is the
2512               number of limited users.
2513
2514               Typical implementation would use [+|-]l on user interface
2515               to set/unset this mode.
2516
2517
2518            0x0040    SILC_CMODE_PASSPHRASE
2519
2520               Passphrase has been set to the channel.  Client may
2521               join to the channel only if it is able to provide the
2522               correct passphrase.  Setting passphrases to channel
2523               is entirely safe as all commands are protected in the
2524               SILC network.  Only channel founder may set/unset
2525               the passphrase.  The <passphrase> argument is the
2526               set passphrase.
2527
2528               Typical implementation would use [+|-]a on user interface
2529               to set/unset this mode.
2530
2531
2532            0x0080    SILC_CMODE_BAN
2533
2534               Ban mask has been set to the channel.  The ban mask
2535               may be used to ban specific clients to join the channel.
2536               The <ban mask> argument is the set ban mask.  When
2537               unsetting a ban mask the mask must be provided as
2538               argument.  Channel founder and channel operator may
2539               set/unset this mode.  Channel founder may not be
2540               added to the ban list.  <ban mask> is comma (`,') separated
2541               list of banned clients in following format:
2542
2543                 [<nickname>!][<username>]@[<hostname>]
2544
2545               Wildcards maybe used when banning clients.
2546
2547               Typical implementation would use [+|-]b on user interface
2548               to set/unset this mode.
2549
2550
2551            0x0100    SILC_CMODE_INVITE_LIST
2552
2553               Invite list has been set to the channel.  The invite list
2554               can be used to mark the clients that is able to join
2555               channel without being invited when the channel is set to
2556               be invite-only channel.  The <invite list> argument is the
2557               set invite mask.  When unsetting entry from the invite list
2558               the entry must be provided as argument.  Channel founder and
2559               channel operator may set/unset this mode.  The <invite list>
2560               is command (`,') separated list of invited clients in following
2561               format:
2562
2563                 [<nickname>!][<username>]@[<hostname>]
2564
2565               Wildcards maybe used when setting the invite list.
2566
2567               Typical implementation would use [+|-]I on user interface
2568               to set/unset this mode.
2569
2570         
2571            0x0200    SILC_CMODE_CIPHER
2572
2573               Sets specific cipher to be used to protect channel
2574               traffic.  The <cipher> argument is the requested cipher.
2575               When set or unset the server must re-generate new
2576               channel key.  If <key len> argument is specified with
2577               <cipher> argument the new key is generated of <key len>
2578               length in bits.  Only channel founder may set the cipher of 
2579               the channel.  When unset the new key is generated using
2580               default cipher for the channel.
2581
2582               Typical implementation would use [+|-]c on user interface
2583               to set/unset this mode.
2584
2585
2586         To make the mode system work, client must keep the channel mode
2587         mask locally so that the mode setting and unsetting would work
2588         without problems.  The client receives the initial channel mode
2589         mask when it joins to the channel.  When the mode changes on
2590         channel the server distributes the changed channel mode mask to
2591         all clients on the channel by sending SILC_COMMAND_CMODE command
2592         reply packet.
2593
2594
2595         Reply messages to the command:
2596
2597         Max Arguments:  2
2598             Arguments:  (1) <Status Payload>  (2) <channel mode mask>
2599
2600         This command replies with the changed channel mode mask that
2601         client is required to keep locally.
2602
2603         Status messages:
2604
2605             SILC_STATUS_OK
2606             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2607             SILC_STATUS_ERR_TOO_MANY_PARAMS
2608             SILC_STATUS_ERR_NOT_REGISTERED
2609             SILC_STATUS_ERR_NOT_ON_CHANNEL
2610             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2611             SILC_STATUS_ERR_BAD_CHANNEL_ID
2612             SILC_STATUS_ERR_NO_CHANNEL_ID
2613             SILC_STATUS_ERR_NO_CHANNEL_PRIV
2614             SILC_STATUS_ERR_UNKNOWN_MODE
2615             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2616
2617
2618    19   SILC_COMMAND_CUMODE
2619
2620         Max Arguments:  3
2621             Arguments:  (1) <Channel ID>  (2) <mode mask>
2622                         (3) <Client ID>
2623
2624         This command is used by client to change channel user modes on
2625         channel.  Users on channel may have some special modes and this
2626         command is used by channel operators to set or change these modes.
2627         The <Channel ID> is the ID of the target channel.  The <mode mask>
2628         is OR'ed mask of modes.  The <Client ID> is the target client.
2629         The client changing channel user modes must be on the same channel
2630         as the target client and poses sufficient privileges to be able to
2631         change the mode.
2632
2633         When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
2634         type is distributed to the channel.
2635
2636         Following channel modes are defined:
2637
2638            0x0000    SILC_CUMODE_NONE
2639
2640               No specific mode.  This is the normal situation for client.
2641               Also, this is the mode set when removing all modes from client.
2642
2643
2644            0x0001    SILC_CUMODE_FOUNDER
2645
2646               The client is channel founder of the channel.  This mode
2647               cannot be set by other client, it is set by the server when
2648               the channel was founded (created).  The mode is provided 
2649               because client may remove the founder rights from itself.
2650
2651
2652            0x0002    SILC_CUMODE_OPERATOR
2653
2654               Sets channel operator privileges on the channel for a
2655               client on the channel.  Channel founder and channel operator
2656               may set/unset (promote/demote) this mode.
2657
2658
2659         Reply messages to the command:
2660
2661         Max Arguments:  3
2662             Arguments:  (1) <Status Payload>  (2) <channel user mode mask>
2663                         (3) <Client ID>
2664
2665         This command replies with the changed channel user mode mask that
2666         client is required to keep locally.  The <Client ID> is the target
2667         client.
2668
2669         Status messages:
2670
2671             SILC_STATUS_OK
2672             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2673             SILC_STATUS_ERR_TOO_MANY_PARAMS
2674             SILC_STATUS_ERR_NOT_REGISTERED
2675             SILC_STATUS_ERR_NOT_ON_CHANNEL
2676             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2677             SILC_STATUS_ERR_BAD_CHANNEL_ID
2678             SILC_STATUS_ERR_NO_CHANNEL_ID
2679             SILC_STATUS_ERR_NO_CHANNEL_PRIV
2680             SILC_STATUS_ERR_UNKNOWN_MODE
2681             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2682
2683
2684    19   SILC_COMMAND_KICK
2685
2686         Max Arguments:  3
2687             Arguments:  (1) <channel>  (2) <Client ID>  
2688                         (3) [<comment>]
2689
2690         This command is used by channel operators to remove a client from
2691         channel.  The <channel> argument is the channel the client to be
2692         removed is on currently.  Note that the "kicker" must be on the same
2693         channel.  If <comment> is provided it will be sent to the removed
2694         client.
2695
2696         Reply messages to the command:
2697
2698         Max Arguments:  1
2699             Arguments:  (1) <Status Payload>
2700
2701         This command replies only with Status Payload.
2702
2703         Status messages:
2704
2705             SILC_STATUS_OK
2706             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2707             SILC_STATUS_ERR_TOO_MANY_PARAMS
2708             SILC_STATUS_ERR_NOT_REGISTERED
2709             SILC_STATUS_ERR_NO_SUCH_CHANNEL
2710             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2711             SILC_STATUS_ERR_NO_CHANNEL_PRIV
2712             SILC_STATUS_ERR_NO_CLIENT_ID
2713
2714
2715    20   SILC_COMMAND_RESTART
2716
2717         Max Arguments:  0
2718             Arguments:  None
2719
2720         This command may only be used by server operator to force a
2721         server to restart itself.
2722
2723         Reply messages to the command:
2724
2725         Max Arguments:  1
2726             Arguments:  (1) <Status Payload>
2727
2728         This command replies only with Status Payload.
2729
2730         Status messages:
2731
2732             SILC_STATUS_OK
2733             SILC_STATUS_ERR_NOT_REGISTERED
2734             SILC_STATUS_ERR_NO_SERVER_PRIV
2735
2736
2737
2738
2739
2740    21   SILC_COMMAND_CLOSE
2741
2742         Max Arguments:  1
2743             Arguments:  (1) <Server ID>
2744
2745         This command is used only by operator to close connection to a
2746         remote site.  The <Server ID> argument is the ID of the remote
2747         site and must be valid.
2748
2749         Reply messages to the command:
2750
2751         Max Arguments:  1
2752             Arguments:  (1) <Status Payload>
2753
2754         This command replies only with Status Payload.
2755
2756         Status messages:
2757
2758             SILC_STATUS_OK
2759             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2760             SILC_STATUS_ERR_TOO_MANY_PARAMS
2761             SILC_STATUS_ERR_NOT_REGISTERED
2762             SILC_STATUS_ERR_NO_SUCH_SERVER
2763             SILC_STATUS_ERR_NO_SERVER_PRIV
2764             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2765
2766
2767    22   SILC_COMMAND_DIE
2768
2769         Max Arguments:  0
2770             Arguments:  None
2771
2772         This command is used only by operator to shutdown the server.
2773         All connections to the server will be closed and the server is
2774         shutdown.
2775
2776         Reply messages to the command:
2777
2778
2779
2780         Max Arguments:  1
2781             Arguments:  (1) <Status Payload>
2782
2783         This command replies only with Status Payload.
2784
2785         Status messages:
2786
2787             SILC_STATUS_OK
2788             SILC_STATUS_ERR_NOT_REGISTERED
2789             SILC_STATUS_ERR_NO_SERVER_PRIV
2790
2791
2792    23   SILC_COMMAND_SILCOPER
2793
2794         Max Arguments:  2
2795             Arguments:  (1) <username>  (2) <authentication data>
2796
2797         This command is used by normal client to obtain router operator
2798         privileges (also known as SILC operator) on some router.  Note
2799         that router operator has router privileges that supersedes the
2800         server operator privileges.
2801
2802         The <username> is the username set in the server configurations
2803         as operator.  The <authentication data> is the data that the
2804         client is authenticated against.  It may be passphrase prompted
2805         for user on client's screen or it may be public key
2806         authentication data (data signed with private key), or 
2807         certificate.
2808
2809         Difference between router operator and server operator is that
2810         router operator is able to handle cell level properties while
2811         server operator (even on router server) is able to handle only
2812         local properties, such as, local connections and normal server
2813         administration.
2814
2815         Reply messages to the command:
2816
2817         Max Arguments:  1
2818             Arguments:  (1) <Status Payload>
2819
2820         This command replies only with Status Payload.
2821
2822         Status messages:
2823
2824             SILC_STATUS_OK
2825             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2826             SILC_STATUS_ERR_TOO_MANY_PARAMS
2827             SILC_STATUS_ERR_NOT_REGISTERED
2828             SILC_STATUS_ERR_BAD_PASSWORD
2829             SILC_STATUS_ERR_AUTH_FAILED
2830
2831
2832    24   SILC_COMMAND_LEAVE
2833
2834         Max Arguments:  1
2835             Arguments:  (1) <Channel ID>
2836
2837         This command is used by client to leave a channel the client is
2838         joined to.  After a client has leaved the channel the server
2839         must create new key for the channel and distribute to all clients
2840         still currently on the channel.
2841
2842         Reply messages to the command:
2843
2844         Max Arguments:  1
2845             Arguments:  (1) <Status Payload>
2846
2847         This command replies only with Status Payload.
2848
2849         Status messages:
2850
2851             SILC_STATUS_OK
2852             SILC_STATUS_ERR_NOT_REGISTERED
2853             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2854             SILC_STATUS_ERR_TOO_MANY_PARAMS
2855             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2856             SILC_STATUS_ERR_BAD_CHANNEL_ID
2857             SILC_STATUS_ERR_NO_CHANNEL_ID
2858
2859
2860    25   SILC_COMMAND_USERS
2861
2862         Max Arguments:  1
2863             Arguments:  (1) <Channel ID>
2864
2865         This command is used to list user names currently on the requested
2866         channel; argument <Channel ID>.  The server must resolve the
2867         user names and send a comma (`,') separated list of user names
2868         on the channel.  Server or router may resolve the names by sending
2869         SILC_COMMAND_WHOIS commands.
2870
2871         If the requested channel is a private or secret channel, this
2872         command must not send the list of users, as private and secret
2873         channels cannot be seen by outside.  In this case the returned
2874         name list may include a indication that the server could not 
2875         resolve the names of the users on the channel.  Also, in this case
2876         Client ID's or client modes are not sent either.
2877
2878         Reply messages to the command:
2879
2880         Max Arguments:  5
2881             Arguments:  (1) <Status Payload>  (2) <Channel ID>
2882                         (3) <list count>      (4) <Client ID list>
2883                         (5) <client mode list>
2884
2885         This command replies with the Channel ID of the requested channel
2886         Client ID list of the users on the channel and list of their modes.
2887         The Client ID list has Client ID's of all users in the list.  The 
2888         <Client ID list> is formed by adding Client ID's one after another.
2889         The <client mode list> is formed by adding client's user modes on
2890         the channel one after another (4 bytes (32 bits) each).  The <list 
2891         count> of length of 4 bytes (32 bits), tells the number of entries
2892         in the lists.  Both lists must have equal number of entries.
2893
2894         Status messages:
2895
2896             SILC_STATUS_OK
2897             SILC_STATUS_ERR_NOT_REGISTERED
2898             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2899             SILC_STATUS_ERR_TOO_MANY_PARAMS
2900             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2901             SILC_STATUS_ERR_BAD_CHANNEL_ID
2902             SILC_STATUS_ERR_NO_CHANNEL_ID
2903             SILC_STATUS_ERR_NOT_ON_CHANNEL
2904
2905
2906    26 - 199
2907
2908         Currently undefined commands.
2909
2910
2911    200 - 254
2912
2913         These commands are reserved for private use and will not be defined
2914         in this document.
2915
2916
2917    255  SILC_COMMAND_MAX   
2918
2919         Reserved command.  This must not be sent.
2920 .in 3
2921
2922
2923 .ti 0
2924 5.3 SILC Command Status Types
2925
2926 .ti 0
2927 5.3.1 SILC Command Status Payload
2928
2929 Command Status Payload is sent in command reply messages to indicate
2930 the status of the command.  The payload is one of argument in the
2931 command thus this is the data area in Command Argument Payload described
2932 in [SILC2].  The payload is only 2 bytes of length.  Following diagram
2933 represents the Command Status Payload (field is always in MSB order).
2934
2935
2936
2937
2938
2939 .in 21
2940 .nf
2941                      1
2942  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
2943 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2944 |        Status Message         |
2945 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2946 .in 3
2947
2948 .ce
2949 Figure 6:  SILC Command Status Payload
2950
2951
2952 .in 6
2953 o Status Message (2 bytes) - Indicates the status message.
2954   All Status messages are described in the next section.
2955 .in 3
2956
2957
2958 .ti 0
2959 5.3.2 SILC Command Status List
2960
2961 Command Status messages are returned in the command reply messages
2962 to indicate whether the command were executed without errors.  If error
2963 has occured the status tells which error occured.  Status payload only
2964 sends numeric reply about the status.  Receiver of the payload must
2965 convert the numeric values into human readable error messages.  The
2966 list of status messages below has an example human readable error
2967 messages that client may display for the user.
2968
2969 List of all defined command status messages following.
2970
2971 .in 0
2972    Generic status messages:
2973
2974    0    SILC_STATUS_OK
2975
2976         Ok status.  Everything went Ok.  The status payload maybe
2977         safely ignored in this case.
2978
2979    1    SILC_STATUS_LIST_START
2980
2981         Start of the list.  There will be several command replies and
2982         this reply is the start of the list.
2983
2984    2    SILC_STATUS_LIST_ITEM
2985
2986         Item in the list.  This is one of the item in the list but not the
2987         first or last one.
2988
2989    3    SILC_STATUS_LIST_END
2990
2991         End of the list.  There were several command replies and this
2992         reply is the last of the list.  There won't be other replies
2993         belonging to this list after this one.
2994
2995    4 - 9
2996
2997         Currently undefined and has been reserved for the future.
2998
2999
3000    Error status message:
3001
3002    10   SILC_STATUS_ERR_NO_SUCH_NICK
3003
3004         "No such nickname".  Requested nickname does not exist.
3005
3006    11   SILC_STATUS_ERR_NO_SUCH_CHANNEL
3007
3008         "No such channel".  Requested channel name does not exist.
3009
3010    12   SILC_STATUS_ERR_NO_SUCH_SERVER
3011
3012         "No such server".  Requested server name does not exist.
3013
3014    13   SILC_STATUS_ERR_TOO_MANY_TARGETS
3015
3016         "Duplicate recipients. No message delivered".  Message were
3017         tried to be sent to recipient which has several occurrences in 
3018         the recipient list.
3019
3020    14   SILC_STATUS_ERR_NO_RECIPIENT
3021
3022         "No recipient given".  Command required recipient which was
3023         not provided.
3024
3025    15   SILC_STATUS_ERR_UNKNOWN_COMMAND
3026
3027         "Unknown command".  Command sent to server is unknown by the
3028         server.
3029
3030    16   SILC_STATUS_ERR_WILDCARDS
3031
3032         "Wildcards cannot be used".  Wildcards were provided but they
3033         weren't permitted.
3034
3035    17   SILC_STATUS_ERR_NO_CLIENT_ID
3036
3037         "No Client ID given".  Client ID were expected as command
3038         parameter but were not found.
3039
3040    18   SILC_STATUS_ERR_NO_CHANNEL_ID
3041
3042         "No Channel ID given".  Channel ID were expected as command
3043         parameter but were not found.
3044
3045    19   SILC_STATUS_ERR_NO_SERVER_ID
3046
3047         "No Serve ID given".  Server ID were expected as command
3048         parameter but were not found.
3049
3050    20   SILC_STATUS_ERR_BAD_CLIENT_ID
3051
3052         "Bad Client ID".  Client ID provided were erroneous.
3053
3054    21   SILC_STATUS_ERR_BAD_CHANNEL_ID
3055
3056         "Bad Channel ID".  Channel ID provided were erroneous.
3057
3058    22   SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
3059
3060         "No such Client ID".  Client ID provided does not exist.
3061
3062    23   SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
3063
3064         "No such Channel ID".  Channel ID provided does not exist.
3065
3066    24   SILC_STATUS_ERR_NICKNAME_IN_USE
3067
3068         "Nickname already exists".  Nickname created could not be 
3069         registered because number of same nicknames were already set to
3070         maximum.  This is not expected to happen in real life but is
3071         possible to occur.
3072
3073    25   SILC_STATUS_ERR_NOT_ON_CHANNEL
3074
3075         "You are not on that channel".  The command were specified for
3076         channel user is not currently on.
3077
3078    26   SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
3079
3080         "They are not on channel".  The requested target client is not
3081         on requested channel.
3082
3083    27   SILC_STATUS_ERR_USER_ON_CHANNEL
3084
3085         "User already on channel".  User were invited on channel they
3086         already are on.
3087
3088    28   SILC_STATUS_ERR_NOT_REGISTERED
3089
3090         "You have not registered".  User executed command that requires
3091         the client to be registered on the server before it may be
3092         executed.
3093
3094    29   SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
3095
3096         "Not enough parameters".  Command requires more parameters
3097         than provided.
3098
3099    30   SILC_STATUS_ERR_TOO_MANY_PARAMS
3100
3101         "Too many parameters".  Too many parameters were provided
3102         for the command.
3103
3104    31   SILC_STATUS_ERR_PERM_DENIED
3105
3106         "Your host is not among the privileged".  The client tried to
3107         register on server that does not allow this host to connect.
3108
3109    32   SILC_STATUS_ERR_BANNED_FROM_SERVER
3110
3111         "You are banned from this server".  The client tried to register
3112         on server that has explicitly denied this host to connect.
3113
3114    33   SILC_STATUS_ERR_BAD_PASSWORD
3115
3116         "Cannot join channel. Incorrect password".  Password provided for 
3117         channel were not accepted.
3118
3119    34   SILC_STATUS_ERR_CHANNEL_IS_FULL
3120
3121         "Cannot join channel. Channel is full".  The channel is full
3122         and client cannot be joined to it.
3123
3124    35   SILC_STATUS_ERR_NOT_INVITED
3125
3126         "Cannot join channel. You have not been invited".  The channel
3127         is invite only channel and client has not been invited.
3128
3129    36   SILC_STATUS_ERR_BANNED_FROM_CHANNEL
3130
3131         "Cannot join channel. You have been banned".  The client has
3132         been banned from the channel.
3133
3134    37   SILC_STATUS_ERR_UNKNOWN_MODE
3135
3136         "Unknown mode".  Mode provided by the client were unknown to
3137         the server.
3138
3139    38   SILC_STATUS_ERR_NOT_YOU
3140
3141         "Cannot change mode for other users".  User tried to change
3142         someone else's mode.
3143
3144    39   SILC_STATUS_ERR_NO_CHANNEL_PRIV
3145
3146         "Permission denied. You are not channel operator".  Command may 
3147         be executed only by channel operator.
3148
3149    40   SILC_STATUS_ERR_NO_SERVER_PRIV
3150
3151         "Permission denied. You are not server operator".  Command may
3152         be executed only by server operator.
3153
3154    41   SILC_STATUS_ERR_NO_ROUTER_PRIV
3155
3156         "Permission denied. You are not SILC operator".  Command may be
3157         executed only by router (SILC) operator.
3158
3159    42   SILC_STATUS_ERR_BAD_NICKNAME
3160
3161         "Bad nickname".  Nickname requested contained illegal characters
3162         or were malformed.
3163
3164    43   SILC_STATUS_ERR_BAD_CHANNEL
3165
3166         "Bad channel name".  Channel requested contained illegal characters
3167         or were malformed.
3168
3169    44   SILC_STATUS_ERR_AUTH_FAILED
3170
3171         "Authentication failed".  The authentication data sent as 
3172         argument were wrong and thus authentication failed.
3173 .in 3
3174
3175
3176 .ti 0
3177 6 Security Considerations
3178
3179 Security is central to the design of this protocol, and these security
3180 considerations permeate the specification.  Common security considerations
3181 such as keeping private keys truly private and using adequate lengths for
3182 symmetric and asymmetric keys must be followed in order to maintain the
3183 security of this protocol.
3184
3185
3186 .ti 0
3187 7 References
3188
3189 [SILC2]      Riikonen, P., "SILC Packet Protocol", Internet Draft,
3190              June 2000.
3191
3192 [SILC3]      Riikonen, P., "SILC Key Exchange and Authentication 
3193              Protocols", Internet Draft, June 2000.
3194
3195 [IRC]        Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
3196              RFC 1459, May 1993.
3197
3198 [SSH-TRANS]  Ylonen, T., et al, "SSH Transport Layer Protocol", 
3199              Internet Draft.
3200
3201 [PGP]        Callas, J., et al, "OpenPGP Message Format", RFC 2440,
3202              November 1998.
3203
3204 [SPKI]       Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
3205              September 1999.
3206
3207 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key 
3208              Infrastructure, Certificate and CRL Profile", RFC 2459,
3209              January 1999.
3210
3211 [Schneier]   Schneier, B., "Applied Cryptography Second Edition",
3212              John Wiley & Sons, New York, NY, 1996.
3213
3214 [Menezes]    Menezes, A., et al, "Handbook of Applied Cryptography",
3215              CRC Press 1997.
3216
3217 [OAKLEY]     Orman, H., "The OAKLEY Key Determination Protocol",
3218              RFC 2412, November 1998.
3219
3220 [ISAKMP]     Maughan D., et al, "Internet Security Association and
3221              Key Management Protocol (ISAKMP)", RFC 2408, November
3222              1998.
3223
3224 [IKE]        Harkins D., and Carrel D., "The Internet Key Exchange
3225              (IKE)", RFC 2409, November 1998.
3226
3227 [HMAC]       Krawczyk, H., "HMAC: Keyed-Hashing for Message
3228              Authentication", RFC 2104, February 1997.
3229
3230
3231
3232 .ti 0
3233 8 Author's Address
3234
3235 .nf
3236 Pekka Riikonen
3237 Kasarmikatu 11 A4
3238 70110 Kuopio
3239 Finland
3240
3241 EMail: priikone@poseidon.pspt.fi
3242
3243 This Internet-Draft expires 6 Jun 2001