Added SILC Thread Queue API
[crypto.git] / doc / draft-riikonen-silc-commands-02.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 13 November 2001
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-commands-02.txt                     13 November 2001
20 Expires: 13 May 2002
21
22 .in 3
23
24 .ce 2
25 SILC Commands
26 <draft-riikonen-silc-commands-02.txt>
27
28 .ti 0
29 Status of this Memo
30
31 This document is an Internet-Draft and is in full conformance with   
32 all provisions of Section 10 of RFC 2026.  Internet-Drafts are   
33 working documents of the Internet Engineering Task Force (IETF), its   
34 areas, and its working groups.  Note that other groups may also   
35 distribute working documents as Internet-Drafts.   
36
37 Internet-Drafts are draft documents valid for a maximum of six months   
38 and may be updated, replaced, or obsoleted by other documents at any   
39 time.  It is inappropriate to use Internet-Drafts as reference   
40 material or to cite them other than as "work in progress."   
41
42 The list of current Internet-Drafts can be accessed at   
43 http://www.ietf.org/ietf/1id-abstracts.txt   
44
45 The list of Internet-Draft Shadow Directories can be accessed at   
46 http://www.ietf.org/shadow.html   
47
48 The distribution of this memo is unlimited.  
49
50
51 .ti 0
52 Abstract
53
54 This memo describes the commands used in the Secure Internet Live
55 Conferencing (SILC) protocol, specified in the Secure Internet Live
56 Conferencing, Protocol Specification Internet Draft [SILC1].  The
57 SILC Commands are very important part of the SILC protocol.  Usually
58 the commands are used by SILC clients to manage the SILC session, but
59 also SILC servers may use the commands.  This memo specifies detailed
60 command messages and command reply messages.
61
62
63
64
65
66
67
68
69 .ti 0
70 Table of Contents
71
72 .nf
73 1 Introduction ..................................................  2
74   1.1 Requirements Terminology ..................................  2
75 2 SILC Commands .................................................  2
76   2.1 SILC Commands Syntax ......................................  2
77   2.2 SILC Commands List ........................................  4
78   2.3 SILC Command Status Types ................................. 33
79       2.3.1 SILC Command Status Payload ......................... 33
80       2.3.2 SILC Command Status List ............................ 33
81 3 Security Considerations ....................................... 38
82 4 References .................................................... 38
83 5 Author's Address .............................................. 40
84
85
86 .ti 0
87 1. Introduction
88
89 This document describes the commands used in the Secure Internet Live
90 Conferencing (SILC) protocol, specified in the Secure Internet Live
91 Conferencing, Protocol Specification Internet Draft [SILC1].  This
92 document specifies detailed command messages and command reply messages.
93
94 Commands are very important part on SILC network especially for client
95 which uses commands to operate on the SILC network.  Commands are used
96 to set nickname, join to channel, change modes and many other things.
97
98 See the [SILC1] for the requirements and the restrictions for the usage
99 of the SILC commands.  The [SILC2] defines the command packet type and
100 the Command Payload which is actually used to deliver the commands and
101 command reply messages.
102
103
104 .ti 0
105 1.1 Requirements Terminology
106
107 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED, 
108 MAY, and OPTIONAL, when they appear in this document, are to be
109 interpreted as described in [RFC2119].
110
111
112 .ti 0
113 2 SILC Commands
114
115 .ti 0
116 2.1 SILC Commands Syntax
117
118 This section briefly describes the syntax of the command notions
119 in this document.  Every field in command is separated from each
120 other by whitespaces (` ') indicating that each field is independent
121 argument and each argument MUST have own Command Argument Payload.
122 The number of maximum arguments are defined with each command
123 separately.  The Command Argument Payload is described in [SILC2].
124
125 Every command defines specific number for each argument.  Currently,
126 they are defined in ascending order; first argument has number one 
127 (1), second has number two (2) and so on.  This number is set into the
128 Argument Type field in the Command Argument Payload.  This makes it
129 possible to send the arguments in free order as the number MUST be
130 used to identify the type of the argument.  This makes is it also
131 possible to have multiple optional arguments in commands and in
132 command replies.  The number of argument is marked in parentheses
133 before the actual argument.
134
135
136
137 .in 6
138 Example:  Arguments:  (1) <nickname> (2) <username@host>
139 .in 3
140    
141
142 Every command replies with Status Payload.  This payload tells the
143 sender of the command whether the command was completed successfully or
144 whether there was an error.  If error occurred the payload includes the
145 error type.  In the next section the Status Payload is not described 
146 as it is common to all commands and has been described here.  Commands 
147 MAY reply with other arguments as well.  These arguments are command 
148 specific and are described in the next section.
149
150 Example command:
151 .in 6
152
153 EXAMPLE_COMMAND
154
155 .in 8
156 Max Arguments:  3
157     Arguments:  (1) <nickname>[@<server>]  (2) <message>
158                 (3) [<count>]
159
160 The command has maximum of 3 arguments.  However, only first
161 and second arguments are mandatory.
162
163 First argument <nickname> is mandatory but may have optional
164 <nickname@server> format as well.  Second argument is mandatory
165 <message> argument.  Third argument is optional <count> argument.
166
167 The numbers in parentheses are the argument specific numbers
168 that specify the type of the argument in Command Argument Payload.
169 The receiver always knows that, say, argument number two (2) is
170 <message> argument, regardless of the ordering of the arguments in
171 the Command Payload.
172
173 Reply messages to the command:
174
175 Max Arguments:  4
176     Arguments:  (1) <Status Payload>  (2) [<channel list>]
177                 (3) <idle time>       (4) [<away message>]
178
179 This command may reply with maximum of 4 arguments.  However,
180 only the first and third arguments are mandatory.  The numbers
181 in the parentheses have the same meaning as in the upper
182 command sending specification.
183
184 Every command reply with <Status Payload>, it is mandatory 
185 argument for all command replies and for this reason it is not
186 described in the command reply descriptions.
187
188
189
190 Status messages:
191
192     SILC_STATUS_OK
193     SILC_STATUS_ERR_TOO_MANY_TARGETS
194     SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195     SILC_STATUS_ERR_NO_SUCH_NICK
196
197 Every command reply also defines set of status message that it
198 may return inside the <Status Payload>.  All status messages
199 are defined in the section 2.3 SILC Command Status Types.
200
201 .in 3
202 Every command that has some kind of ID as argument (for example
203 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
204 the type of the ID, length of the ID and the actual ID data.  This
205 way variable length ID's can be sent as arguments.
206
207
208 .ti 0
209 2.2 SILC Commands List
210
211 This section lists all SILC commands, however, it is expected that a
212 implementation and especially client implementation has many more
213 commands that has only local affect.  These commands are official
214 SILC commands that has both client and server sides and cannot be
215 characterized as local commands.
216
217 List of all defined commands in SILC follows.
218
219 .in 0
220    0    SILC_COMMAND_NONE
221
222         None.  This is reserved command and MUST NOT be sent.
223
224
225    1    SILC_COMMAND_WHOIS
226
227         Max Arguments:  3328
228             Arguments:  (1) [<nickname>[@<server>]]  (2) [<count>]
229                         (3) [<Client ID>]            (n) [...]
230
231         Whois command is used to query various information about specific
232         user.  The user may be requested by their nickname and server name.
233         The query may find multiple matching users as there are no unique
234         nicknames in the SILC.  The <count> option may be given to narrow
235         down the number of accepted results.  If this is not defined there
236         are no limit of accepted results.  The query may also be narrowed
237         down by defining the server name of the nickname.  The <count> is
238         int string format.
239
240         It is also possible to search the user by Client ID.  If the 
241         <Client ID> is provided server MUST use it as the search value
242         instead of the <nickname>.  One of the arguments MUST be given.
243         It is also possible to define multiple Client ID's to search
244         multiple users sending only one WHOIS command.  In this case the
245         Client ID's are appended as normal arguments.
246
247         To prevent miss-use of this command wildcards in the nickname
248         or in the server name are not permitted.  It is not allowed
249         to request all users on some server.  The WHOIS requests MUST 
250         be based on specific nickname request.
251
252         The WHOIS request MUST be always sent to the router by server
253         so that all users are searched.  However, the server still MUST
254         search its locally connected clients.  The router MUST send
255         this command to the server which owns the requested client.  That
256         server MUST reply to the command.  Server MUST NOT send whois
257         replies to the client until it has received the reply from its
258         router.
259
260         Reply messages to the command:
261
262         Max Arguments:  9
263             Arguments:  (1) <Status Payload>       (2) <Client ID> 
264                         (3) <nickname>[@<server>]  (4) <username@host> 
265                         (5) <real name>            (6) [<Channel Payload 
266                                                          list>] 
267                         (7) [<user mode>]          (8) [<idle time>]
268                         (9) [<fingerprint>]
269
270
271         This command may reply with several command reply messages to
272         form a list of results.  In this case the status payload will
273         include STATUS_LIST_START status in the first reply and
274         STATUS_LIST_END in the last reply to indicate the end of the
275         list.  If there are only one reply the status is set to normal
276         STATUS_OK.
277
278         The command replies include the Client ID of the nickname,
279         nickname and server name, user name and host name and user's real
280         name.  Client SHOULD process these replies only after the last
281         reply has been received with the STATUS_LIST_END status.  If the
282         <count> option were defined in the query there will be only
283         <count> many replies from the server.
284
285         The server may return the list of channel the client has joined.
286         In this case the list is list of Channel Payloads.  The Mode Mask
287         in the Channel Payload (see [SILC2] and section 2.3.2.3 for the
288         Channel Payload) is the client's mode on the channel.  The list
289         is encoded by adding the Channel Payloads one after the other.
290
291         The server may also send client's user mode, idle time, and the
292         fingerprint of the client's public key.  The <fingerprint> is the
293         binary hash digest of the public key.  The fingerprint MUST NOT
294         be sent if the server has not verified the proof of posession of
295         the corresponding private key.  Server can do this during the
296         SILC Key Exchange protocol.  The <fingerprint> is SHA1 digest.
297
298         Status messages:
299
300             SILC_STATUS_OK
301             SILC_STATUS_LIST_START
302             SILC_STATUS_LIST_END
303             SILC_STATUS_ERR_NO_SUCH_NICK
304             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
305             SILC_STATUS_ERR_WILDCARDS
306             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
307             SILC_STATUS_ERR_TOO_MANY_PARAMS
308
309
310    2    SILC_COMMAND_WHOWAS
311
312         Max Arguments:  2
313             Arguments:  (1) <nickname>[@<server>]  (2) [<count>]
314
315         Whowas.  This command is used to query history information about
316         specific user.  The user may be requested by their nickname and 
317         server name.  The query may find multiple matching users as there
318         are no unique nicknames in the SILC.  The <count> option may be
319         given to narrow down the number of accepted results.  If this
320         is not defined there are no limit of accepted results.  The query
321         may also be narrowed down by defining the server name of the 
322         nickname.  The <count> is in string format.
323
324         To prevent miss-use of this command wildcards in the nickname
325         or in the server name are not permitted.  The WHOWAS requests MUST 
326         be based on specific nickname request.
327
328         The WHOWAS request MUST be always sent to the router by server
329         so that all users are searched.  However, the server still must
330         search its locally connected clients.
331
332         Reply messages to the command:
333
334         Max Arguments:  5
335             Arguments:  (1) <Status Payload>        (2) <Client ID>
336                         (3) <nickname>[@<server>]   (4) <username@host>
337                         (5) [<real name>]
338
339         This command may reply with several command reply messages to form
340         a list of results.  In this case the status payload will include
341         STATUS_LIST_START status in the first reply and STATUS_LIST_END in 
342         the last reply to indicate the end of the list.  If there are only 
343         one reply the status is set to normal STATUS_OK.
344
345         The command replies with nickname and user name and host name.
346         Every server MUST keep history for some period of time of its
347         locally connected clients.
348
349         Status messages:
350
351             SILC_STATUS_OK
352             SILC_STATUS_LIST_START
353             SILC_STATUS_LIST_END
354             SILC_STATUS_ERR_NO_SUCH_NICK
355             SILC_STATUS_ERR_WILDCARDS
356             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
357             SILC_STATUS_ERR_TOO_MANY_PARAMS
358
359
360    3    SILC_COMMAND_IDENTIFY
361
362         Max Arguments:  3328
363             Arguments:  (1) [<nickname>[@<server>]]  (2) [<server name>]
364                         (3) [<channel name>]         (4) [<count>]
365                         (5) [<ID Payload>]           (n) [...]
366
367         Identify command is used to query information about an entity by
368         the entity's name or ID.  This command can be used to query
369         information about clients, server and channels.
370
371         The query may find multiple matching entities.  The <count> option
372         may be given to narrow down the number of accepted results.  If
373         this is not defined there are no limit of accepted results.  The
374         <count> is in string format.
375
376         It is also possible to search the entity by its ID.  If the
377         <ID Payload> is provided server must use it as the search value
378         instead of the entity's name.  One of the arguments must be given.
379         It is also possible to define multiple ID Payloads to search
380         multiple entities sending only one IDENTIFY command.  In this case
381         the ID Payloads are appended as normal arguments.  The type of the
382         entity is defined by the type of the ID Payload.
383
384         To prevent miss-use of this command wildcards in the names are
385         not permitted.  It is not allowed to request for example all users
386         on server.
387
388         Implementations may not want to give interface access to this
389         command as it is hardly a command that would be used by an end
390         user.  However, it must be implemented as it is used with private
391         message sending.
392
393         The IDENTIFY command MUST be always sent to the router by server
394         so that all users are searched.  However, server MUST still search
395         its locally connected clients.
396
397         Reply messages to the command:
398
399         Max Arguments:  4
400             Arguments:  (1) <Status Payload>   (2) <ID Payload>
401                         (3) [<entity's name>]  (4) [<info>]
402
403         This command may reply with several command reply messages to form
404         a list of results.  In this case the status payload will include
405         STATUS_LIST_START status in the first reply and STATUS_LIST_END in 
406         the last reply to indicate the end of the list.  If there are only 
407         one reply the status is set to normal STATUS_OK.
408
409         When querying clients the <entity's name> must include the client's
410         nickname in the following format: nickname[@server].  The
411         <info> must include the client's username and host in the following
412         format: username@host.
413
414         When querying servers the <entity's name> must include the server's
415         full name.  The <info> may be omitted.
416
417         When querying channels the <entity's name> must include the
418         channel's name.  The <info> may be omitted.
419
420         If the <count> option were defined in the query there will be only
421         <count> many replies from the server.
422
423         Status messages:
424
425             SILC_STATUS_OK
426             SILC_STATUS_LIST_START
427             SILC_STATUS_LIST_END
428             SILC_STATUS_ERR_NO_SUCH_NICK
429             SILC_STATUS_ERR_NO_SUCH_SERVER
430             SILC_STATUS_ERR_NO_SUCH_CHANNEL
431             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
432             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
433             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
434             SILC_STATUS_ERR_WILDCARDS
435             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
436             SILC_STATUS_ERR_TOO_MANY_PARAMS
437
438
439    4    SILC_COMMAND_NICK
440
441         Max Arguments:  1
442             Arguments:  (1) <nickname>
443
444         Set/change nickname.  This command is used to set nickname for
445         user.  Nickname MUST NOT include any spaces (` '), non-printable
446         characters, commas (`,') and any wildcard characters.  Note that
447         nicknames in SILC are case-sensitive which must be taken into
448         account when searching clients by nickname.
449
450         When nickname is changed new Client ID is generated.  Server MUST
451         distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
452         channels (if any) the client is joined on.  Then it MUST send
453         SILC_PACKET_REPLACE_ID to its primary route to replace the old
454         Client ID with the new one.
455
456         Reply messages to the command:
457
458         Max Arguments:  2
459             Arguments:  (1) <Status Payload>  (2) <New ID Payload>
460
461         This command is replied always with New ID Payload that is
462         generated by the server every time user changes their nickname.
463         Client receiving this payload MUST start using the received
464         Client ID as its current valid Client ID.  The New ID Payload
465         is described in [SILC2].
466
467         Status messages:
468
469             SILC_STATUS_OK
470             SILC_STATUS_ERR_WILDCARDS
471             SILC_STATUS_ERR_NICKNAME_IN_USE
472             SILC_STATUS_ERR_BAD_NICKNAME
473             SILC_STATUS_ERR_NOT_REGISTERED
474             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
475             SILC_STATUS_ERR_TOO_MANY_PARAMS
476
477
478    5    SILC_COMMAND_LIST
479
480         Max Arguments:  1
481             Arguments:  (1) [<Channel ID>]
482
483         The list command is used to list channels and their topics on the
484         current server.  If the <Channel ID> parameter is used, only the
485         status of that channel is displayed.  Secret channels are not
486         listed at all.  Private channels are listed with status indicating
487         that the channel is private.  Router MAY reply with all channels
488         it knows about.
489
490         Reply messages to the command:
491
492         Max Arguments:  5
493             Arguments:  (1) <Status Payload>  (2) <Channel ID>
494                         (3) <channel>         (4) [<topic>]
495                         (5) [<user count>]
496
497         This command may reply with several command reply messages to form
498         a list of results.  In this case the status payload will include
499         STATUS_LIST_START status in the first reply and STATUS_LIST_END in 
500         the last reply to indicate the end of the list.  If there are only 
501         one reply the status is set to normal STATUS_OK.
502
503         This command replies with Channel ID, name and the topic of the
504         channel.  If the channel is private channel the <topic> SHOULD
505         include the "*private*" string.
506
507         Status messages:
508
509             SILC_STATUS_OK
510             SILC_STATUS_LIST_START
511             SILC_STATUS_LIST_END
512             SILC_STATUS_ERR_WILDCARDS
513             SILC_STATUS_ERR_NOT_REGISTERED
514             SILC_STATUS_ERR_TOO_MANY_PARAMS
515             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
516             SILC_STATUS_ERR_NO_CHANNEL_ID
517             SILC_STATUS_ERR_NO_SUCH_SERVER
518
519
520    6    SILC_COMMAND_TOPIC
521
522         Max Arguments:  2
523             Arguments:  (1) <Channel ID>  (2) [<topic>]
524
525         This command is used to change or view the topic of a channel.
526         The topic for channel <Channel ID> is returned if there is no
527         <topic> given.  If the <topic> parameter is present, the topic
528         for that channel will be changed, if the channel modes permit
529         this action.
530
531         After setting the topic the server MUST send the notify type
532         SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
533         the channel which topic was changed.
534
535         Reply messages to the command:
536
537         Max Arguments:  2
538             Arguments:  (1) <Status Payload>  (2) <Channel ID> 
539                         (3) [<topic>]
540
541         The command may reply with the topic of the channel if it is
542         set.
543
544         Status messages:
545
546             SILC_STATUS_OK
547             SILC_STATUS_ERR_NOT_ON_CHANNEL
548             SILC_STATUS_ERR_WILDCARDS
549             SILC_STATUS_ERR_NOT_REGISTERED
550             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
551             SILC_STATUS_ERR_NO_SUCH_CHANNEL
552             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
553             SILC_STATUS_ERR_NO_CHANNEL_ID
554             SILC_STATUS_ERR_BAD_CHANNEL_ID
555             SILC_STATUS_ERR_TOO_MANY_PARAMS
556             SILC_STATUS_ERR_NO_CHANNEL_PRIV
557
558
559    7    SILC_COMMAND_INVITE
560
561         Max Arguments:  4
562             Arguments:  (1) <Channel ID>       (2) [<Client ID>]
563                         (3) [<adding client>]  (4) [<removing client>]
564
565         This command is used to invite other clients to join to the
566         channel.  The <Client ID> argument is the target client's ID that
567         is being invited.  The <Channel ID> is the Channel ID of the
568         requested channel.  The sender of this command MUST be on the
569         channel.  The server MUST also send the notify type
570         SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
571         client indicated by the <Client ID>.
572
573         The <adding client> and <removing client> can be used to add to
574         and remove from the invite list.  The format of the <adding client>
575         and <removing client> is as follows:
576
577             [<nickname>[@<server>]!][<username>]@[<hostname>]
578
579         When adding to or removing from the invite list the server MUST
580         send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
581         and MUST NOT send it to the client which was added to the list.
582         The client which executes this command MUST have at least channel
583         operator privileges to be able to add to or remove from the invite
584         list.  The wildcards MAY be used with this command.  If adding or
585         removing more than one client then the lists are an comma (`,')
586         separated.
587
588         Note that the <Client ID> provided MUST be resolved into correct
589         nickname and host name and add to the invite list before sending
590         the notify packet.
591         
592         When this command is given with only <Channel ID> argument then
593         the command merely returns the invite list of the channel.   This
594         command MUST fail if the requested channel does not exist, the
595         requested <Client ID> is already on the channel or if the channel
596         is invite only channel and the caller of this command does not
597         have at least channel operator privileges.
598
599         Reply messages to the command:
600
601         Max Arguments:  3
602             Arguments:  (1) <Status Payload>  (2) <Channel ID>
603                         (3) [<invite list>]
604
605         This command replies with the invite list of the channel if it
606         exists.  The <invite list> may be omitted if the list was not
607         altered.
608
609         Status messages:
610
611             SILC_STATUS_OK
612             SILC_STATUS_ERR_NOT_REGISTERED
613             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
614             SILC_STATUS_ERR_TOO_MANY_PARAMS
615             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
616             SILC_STATUS_ERR_NO_CLIENT_ID
617             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
618             SILC_STATUS_ERR_NO_CHANNEL_ID
619             SILC_STATUS_ERR_NOT_ON_CHANNEL
620             SILC_STATUS_ERR_USER_ON_CHANNEL
621             SILC_STATUS_ERR_NO_CHANNEL_PRIV
622
623
624    8    SILC_COMMAND_QUIT
625
626         Max Arguments:  1
627             Arguments:  (1) [<quit message>]
628
629         This command is used by client to end SILC session.  The server
630         must close the connection to a client which sends this command.
631         if <quit message> is given it will be sent to other clients on
632         channel if the client is on channel when quitting.
633
634         Reply messages to the command:
635
636         This command does not reply anything.
637
638
639     9   SILC_COMMAND_KILL
640
641         Max Arguments:  2
642             Arguments:  (1) <Client ID>  (2) [<comment>]
643
644         This command is used by SILC operators to remove a client from
645         SILC network.  The removing has temporary effects and client may
646         reconnect to SILC network.  The <Client ID> is the client to be
647         removed from SILC.  The <comment> argument may be provided to 
648         give to the removed client some information why it was removed
649         from the network.
650
651         When killing a client the router MUST first send notify type
652         SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
653         The packet MUST NOT be sent to the killed client on the channels.
654         Then, the router MUST send the same notify type to its primary
655         router.  Finally, the router MUST send the same notify type 
656         directly to the client which was killed.
657
658         Reply messages to the command:
659
660         Max Arguments:  1
661             Arguments:  (1) <Status Payload>
662
663         This command replies only with Status Payload.
664
665         Status messages:
666
667             SILC_STATUS_OK
668             SILC_STATUS_ERR_WILDCARDS
669             SILC_STATUS_ERR_NOT_REGISTERED
670             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
671             SILC_STATUS_ERR_TOO_MANY_PARAMS
672             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
673             SILC_STATUS_ERR_NO_CLIENT_ID
674             SILC_STATUS_ERR_NO_ROUTER_PRIV
675
676
677    10   SILC_COMMAND_INFO
678
679         Max Arguments:  2
680             Arguments:  (1) [<server>]  (2) [<Server ID>]
681
682         This command is used to fetch various information about a server.
683         If <server> argument is specified the command MUST be sent to
684         the requested server.
685
686         If the <Server ID> is specified the server information if fetched
687         by the provided Server ID.  One of the arguments must always be
688         present.
689
690         Reply messages to the command:
691
692         Max Arguments:  4
693             Arguments:  (1) <Status Payload>  (2) <Server ID>
694                         (3) <server name>     (4) <string>
695
696         This command replies with the Server ID of the server and a
697         string which tells the information about the server.
698
699         Status messages:
700
701             SILC_STATUS_OK
702             SILC_STATUS_ERR_WILDCARDS
703             SILC_STATUS_ERR_NOT_REGISTERED
704             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
705             SILC_STATUS_ERR_TOO_MANY_PARAMS
706             SILC_STATUS_ERR_NO_SUCH_SERVER
707             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
708             SILC_STATUS_ERR_NO_SERVER_ID
709
710
711    11   SILC_COMMAND_CONNECT
712
713         Max Arguments:  2
714             Arguments:  (1) <remote server/router>  (2) [<port>]
715
716         This command is used by operators to force a server to try to
717         establish a new connection to remote server or router.  The
718         Operator MUST specify the server/router to be connected by
719         setting <remote server> argument.  The port is 32 bit MSB value.
720
721         Reply messages to the command:
722
723         Max Arguments:  1
724             Arguments:  (1) <Status Payload>
725
726         This command replies only with Status Payload.
727
728
729
730         Status messages:
731
732             SILC_STATUS_OK
733             SILC_STATUS_ERR_WILDCARDS
734             SILC_STATUS_ERR_NOT_REGISTERED
735             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
736             SILC_STATUS_ERR_TOO_MANY_PARAMS
737             SILC_STATUS_ERR_NO_SERVER_PRIV
738             SILC_STATUS_ERR_NO_ROUTER_PRIV
739
740
741    12   SILC_COMMAND_PING
742
743         Max Arguments:  1
744             Arguments:  (1) <Server ID>
745
746         This command is used by client and server to test the communication
747         channel to its server if one suspects that the communication is not
748         working correctly.  The <Server ID> is the ID of the server the
749         sender is connected to.
750
751         Reply messages to the command:
752
753         Max Arguments:  1
754             Arguments:  (1) <Status Payload>
755
756         This command replies only with Status Payload.  Server returns
757         SILC_STATUS_OK in Status Payload if pinging was successful.
758
759
760
761         Status messages:
762
763             SILC_STATUS_OK
764             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
765             SILC_STATUS_ERR_TOO_MANY_PARAMS
766             SILC_STATUS_ERR_NO_SERVER_ID
767             SILC_STATUS_ERR_NO_SUCH_SERVER
768             SILC_STATUS_ERR_NOT_REGISTERED
769
770
771    13   SILC_COMMAND_OPER
772
773         Max Arguments:  2
774             Arguments:  (1) <username>  (2) <authentication payload>
775
776         This command is used by normal client to obtain server operator
777         privileges on some server or router.  Note that router operator
778         has router privileges that supersedes the server operator
779         privileges and this does not obtain those privileges.  Client
780         MUST use SILCOPER command to obtain router level privileges.
781
782         The <username> is the username set in the server configurations
783         as operator.  The <authentication payload> is the data that the
784         client is authenticated against.  It may be passphrase prompted
785         for user on client's screen or it may be public key or certificate
786         authentication data (data signed with private key).  The public
787         key that server will use to verify the signature found in the
788         payload should be verified.  It is recommended that the public
789         key is saved locally in the server and server would not use
790         any public keys received during the SKE.
791
792         After changing the mode the server MUST send the notify type
793         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
794
795         Reply messages to the command:
796
797         Max Arguments:  1
798             Arguments:  (1) <Status Payload>
799
800         This command replies only with Status Payload.
801
802         Status messages:
803
804             SILC_STATUS_OK
805             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
806             SILC_STATUS_ERR_TOO_MANY_PARAMS
807             SILC_STATUS_ERR_NOT_REGISTERED
808             SILC_STATUS_ERR_AUTH_FAILED
809
810
811    14   SILC_COMMAND_JOIN
812
813         Max Arguments:  5
814             Arguments:  (1) <channel>       (2) <Client ID>
815                         (3) [<passphrase>]  (4) [<cipher>]
816                         (5) [<hmac>]
817
818         Join to channel/create new channel.  This command is used to
819         join to a channel.  If the channel does not exist the channel is
820         created.  If server is normal server this command MUST be sent
821         to router which will create the channel.  The channel MAY be
822         protected with passphrase.  If this is the case the passphrase
823         MUST be sent along the join command.
824
825         The name of the <channel> MUST NOT include any spaces (` '),
826         non-printable characters, commas (`,') or any wildcard characters.
827
828         The second argument <Client ID> is the Client ID of the client
829         which is joining to the client.  When client sends this command
830         to the server the <Client ID> MUST be the client's own ID.
831
832         Cipher to be used to secure the traffic on the channel MAY be
833         requested by sending the name of the requested <cipher>.  This
834         is used only if the channel does not exist and is created.  If
835         the channel already exists the cipher set previously for the
836         channel will be used to secure the traffic.  The computed MACs
837         of the channel message are produced by the default HMAC or by
838         the <hmac> provided for the command.
839
840         The server MUST check whether the user is allowed to join to
841         the requested channel.  Various modes set to the channel affect
842         the ability of the user to join the channel.  These conditions
843         are:
844
845             o  The user MUST be invited to the channel if the channel
846                is invite-only channel.
847
848             o  The Client ID/nickname/username/host name MUST NOT match
849                any active bans.
850
851             o  The correct passphrase MUST be provided if passphrase 
852                is set to the channel.
853
854             o  The user count limit, if set, MUST NOT be reached.
855
856         Reply messages to the command:
857
858         Max Arguments:  14
859             Arguments:  (1) <Status Payload>        (2) <channel> 
860                         (3) <Channel ID>            (4) <Client ID>
861                         (5) <channel mode mask>     (6) <created>
862                         (7) [<Channel Key Payload>] (8) [<ban list>]
863                         (9) [<invite list>]         (10) [<topic>]
864                         (11) [<hmac>]               (12) <list count>
865                         (13) <Client ID list>       (14) <client mode list>
866
867         This command replies with the channel name requested by the
868         client, channel ID of the channel and topic of the channel
869         if it exists.  The <Client ID> is the Client ID which was joined
870         to the channel.  It also replies with the channel mode mask
871         which tells all the modes set on the channel.  If the
872         channel is created the mode mask is zero (0).  If ban mask
873         and/or invite list is set they are sent as well.
874
875         The <list count>, <Client ID list> and <client mode list> are
876         the clients currently on the channel and their modes on the
877         channel.  The <Client ID list> is formed by adding the ID Payloads
878         one after the other.  The <client mode list> is formed by adding
879         32 bit MSB first order values one after the other.
880
881         Client receives the channel key in the reply message as well
882         inside <Channel Key Payload>.
883
884         Status messages:
885
886             SILC_STATUS_OK
887             SILC_STATUS_ERR_WILDCARDS
888             SILC_STATUS_ERR_NOT_REGISTERED
889             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
890             SILC_STATUS_ERR_TOO_MANY_PARAMS
891             SILC_STATUS_ERR_BAD_PASSWORD
892             SILC_STATUS_ERR_CHANNEL_IS_FULL
893             SILC_STATUS_ERR_NOT_INVITED
894             SILC_STATUS_ERR_BANNED_FROM_CHANNEL
895             SILC_STATUS_ERR_BAD_CHANNEL
896             SILC_STATUS_ERR_USER_ON_CHANNEL
897
898
899    15   SILC_COMMAND_MOTD
900
901         Max Arguments:  1
902             Arguments:  (1) <server>
903
904         This command is used to query the Message of the Day of the server.
905
906         Reply messages to the command:
907
908         Max Arguments:  3
909             Arguments:  (1) <Status Payload>  (2) <Server ID>
910                         (3) [<motd>]
911
912         This command replies with the motd message if it exists.
913
914         Status messages:
915
916             SILC_STATUS_OK
917             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
918             SILC_STATUS_ERR_TOO_MANY_PARAMS
919             SILC_STATUS_ERR_NOT_REGISTERED
920             SILC_STATUS_ERR_NO_SUCH_SERVER
921
922
923    16   SILC_COMMAND_UMODE
924
925         Max Arguments:  2
926             Arguments:  (1) <Client ID>  (2) <client mode mask>
927
928         This command is used by client to set/unset modes for itself.
929         However, there are some modes that the client MUST NOT set itself,
930         but they will be set by server.  However, client MAY unset any
931         mode.  Modes may be masked together ORing them thus having
932         several modes set.  Client MUST keep its client mode mask
933         locally so that the mode setting/unsetting would work without
934         problems.  Client may change only its own modes.
935
936         After changing the mode server MUST send the notify type
937         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
938
939         The following client modes are defined:
940
941            0x0000    SILC_UMODE_NONE
942
943               No specific mode for client.  This is the initial
944               setting when new client is created.  The client is
945               normal client now.
946
947
948            0x0001    SILC_UMODE_SERVER_OPERATOR
949
950               Marks the user as server operator.  Client MUST NOT
951               set this mode itself.  Server sets this mode to the
952               client when client attains the server operator
953               privileges by SILC_COMMAND_OPER command.  Client
954               MAY unset the mode itself.
955
956
957            0x0002    SILC_UMODE_ROUTER_OPERATOR
958
959               Marks the user as router (SILC) operator.  Client
960               MUST NOT this mode itself.  Router sets this mode to
961               the client when client attains the router operator
962               privileges by SILC_COMMAND_SILCOPER command.  Client
963               MAY unset the mode itself.
964
965
966            0x0004    SILC_UMODE_GONE
967
968               Marks that the user is not currently present in the
969               SILC Network.  Client MAY set and unset this mode.
970
971         Reply messages to the command:
972
973         Max Arguments:  2
974             Arguments:  (1) <Status Payload>  (2) <client mode mask>
975
976         This command replies with the changed client mode mask that
977         the client MUST to keep locally.
978
979
980         Status messages:
981
982             SILC_STATUS_OK
983             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
984             SILC_STATUS_ERR_TOO_MANY_PARAMS
985             SILC_STATUS_ERR_NOT_REGISTERED
986             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
987             SILC_STATUS_ERR_BAD_CLIENT_ID
988             SILC_STATUS_ERR_NOT_YOU
989             SILC_STATUS_ERR_PERM_DENIED
990             SILC_STATUS_ERR_UNKNOWN_MODE
991             SILC_STATUS_ERR_NO_CLIENT_ID
992
993
994    17   SILC_COMMAND_CMODE
995
996         Max Arguments:  7
997             Arguments:  (1) <Channel ID>      (2) <channel mode mask>
998                         (3) [<user limit>]    (4) [<passphrase>]
999                         (5) [<cipher>]        (6) [<hmac>]
1000                         (7) [<auth payload>]
1001
1002         This command is used by client to set or change channel flags on
1003         a channel.  Channel has several modes that set various properties
1004         of a channel.  Modes may be masked together by ORing them thus
1005         having several modes set.  The <Channel ID> is the ID of the
1006         target channel.  The client changing channel mode MUST be on
1007         the same channel and poses sufficient privileges to be able to
1008         change the mode.
1009
1010         When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1011         type MUST be distributed to the channel.
1012
1013         The following channel modes are defined:
1014
1015            0x0000    SILC_CMODE_NONE
1016
1017               No specific mode on channel.  This is the default when
1018               channel is created.  This means that channel is just plain
1019               normal channel.
1020
1021
1022            0x0001    SILC_CMODE_PRIVATE
1023
1024               Channel is private channel.  Private channels are shown
1025               in the channel list listed with SILC_COMMAND_LIST command
1026               with indication that the channel is private.  Also,
1027               client on private channel will no be detected to be on
1028               the channel as the channel is not shown in the client's
1029               currently joined channel list.  Channel founder and 
1030               channel operator MAY set/unset this mode.
1031
1032               Typical implementation would use [+|-]p on user interface
1033               to set/unset this mode.
1034
1035
1036            0x0002    SILC_CMODE_SECRET
1037
1038               Channel is secret channel.  Secret channels are not shown
1039               in the list listed with SILC_COMMAND_LIST command.  Secret
1040               channels can be considered to be invisible channels.
1041               Channel founder and channel operator MAY set/unset this
1042               mode.
1043
1044               Typical implementation would use [+|-]s on user interface
1045               to set/unset this mode.
1046
1047
1048            0x0004    SILC_CMODE_PRIVKEY
1049
1050               Channel uses private channel key to protect the traffic
1051               on the channel.  When this mode is set the client will be
1052               responsible to set the key it wants to use to encrypt and
1053               decrypt the traffic on channel.  Server generated channel
1054               keys are not used at all.  This mode provides additional
1055               security as clients on channel may agree to use private
1056               channel key that even servers do not know.  Naturally,
1057               this requires that every client on the channel knows
1058               the key before hand (it is considered to be pre-shared-
1059               key).  The key material is RECOMMENDED to be processed
1060               as stated in the [SILC3] in the section Processing the
1061               Key Material.
1062
1063               As it is local setting it is possible to have several
1064               private channel keys on one channel.  In this case several
1065               clients can talk on same channel but only those clients
1066               that share the key with the message sender will be able
1067               to hear the talking.  Client SHOULD NOT display those
1068               message for the end user that it is not able to decrypt
1069               when this mode is set.
1070
1071               Only channel founder MAY set/unset this mode.  If this
1072               mode is unset the server will distribute new channel
1073               key to all clients on the channel which will be used
1074               thereafter.
1075
1076               Typical implementation would use [+|-]k on user interface
1077               to set/unset this mode.
1078
1079
1080            0x0008    SILC_CMODE_INVITE
1081
1082               Channel is invite only channel.  Client may join to this
1083               channel only if it is invited to the channel.  Channel
1084               founder and channel operator MAY set/unset this mode.
1085
1086               Typical implementation would use [+|-]i on user interface
1087               to set/unset this mode.
1088
1089
1090            0x0010    SILC_CMODE_TOPIC
1091
1092               The topic of the channel may only be set by client that
1093               is channel founder or channel operator.  Normal clients
1094               on channel will not be able to set topic when this mode
1095               is set.  Channel founder and channel operator MAY set/
1096               unset this mode.
1097
1098               Typical implementation would use [+|-]t on user interface
1099               to set/unset this mode.
1100
1101
1102            0x0020    SILC_CMODE_ULIMIT
1103
1104               User limit has been set to the channel.  New clients
1105               may not join to the channel when the limit set is
1106               reached.  Channel founder and channel operator MAY set/
1107               unset the limit.  The <user limit> argument is the
1108               number of limited users.
1109
1110               Typical implementation would use [+|-]l on user interface
1111               to set/unset this mode.
1112
1113
1114            0x0040    SILC_CMODE_PASSPHRASE
1115
1116               Passphrase has been set to the channel.  Client may
1117               join to the channel only if it is able to provide the
1118               correct passphrase.  Setting passphrases to channel
1119               is entirely safe as all commands are protected in the
1120               SILC network.  Only channel founder MAY set/unset
1121               the passphrase.  The <passphrase> argument is the
1122               set passphrase.
1123
1124               Typical implementation would use [+|-]a on user interface
1125               to set/unset this mode.
1126
1127
1128            0x0080    SILC_CMODE_CIPHER
1129
1130               Sets specific cipher to be used to protect channel
1131               traffic.  The <cipher> argument is the requested cipher.
1132               When set or unset the server must re-generate new
1133               channel key.  Only channel founder MAY set the cipher of 
1134               the channel.  When unset the new key is generated using
1135               default cipher for the channel.
1136
1137               Typical implementation would use [+|-]c on user interface
1138               to set/unset this mode.
1139
1140
1141            0x0100    SILC_CMODE_HMAC
1142
1143               Sets specific hmac to be used to compute the MACs of the
1144               channel message.  The <hmac> argument is the requested hmac.
1145               Only channel founder may set the hmac of the channel.
1146
1147               Typical implementation would use [+|-]h on user interface
1148               to set/unset this mode.
1149
1150
1151            0x0200    SILC_CMODE_FOUNDER_AUTH
1152
1153               Channel founder may set this mode to be able to regain
1154               channel founder rights even if the client leaves the 
1155               channel.  The <auth payload> is the Authentication Payload
1156               consisting of the authentication method and authentication
1157               data to be used in the authentication.  The server MUST
1158               NOT accept NONE authentication method.  Also, if the 
1159               method is public key authentication the server MUST NOT
1160               save the authentication data from the payload as the
1161               data is different on all authentications.  In this case the
1162               server only saves the authentication method.  However,
1163               server MUST verify the sent authentication payload and
1164               set the mode only if the verification was successful.
1165
1166               Note that this mode is effective only in the current server.
1167               The client MUST connect to the same server later to be able
1168               to regain the channel founder rights.  The server MUST save
1169               the public key of the channel founder and use that to identify
1170               the client which is claiming the channel founder rights.
1171               The rights may be claimed by the SILC_CUMODE_FOUNDER 
1172               channel user mode using SILC_COMMAND_CUMODE command.  The
1173               set authentication data remains valid as long as the channel
1174               exists or until the founder unsets this mode.
1175
1176               Typical implementation would use [+|-]f on user interface
1177               to set/unset this mode.
1178
1179         To make the mode system work, client MUST keep the channel mode
1180         mask locally so that the mode setting and unsetting would work
1181         without problems.  The client receives the initial channel mode
1182         mask when it joins to the channel.  When the mode changes on
1183         channel the server MUST distribute the changed channel mode mask
1184         to all clients on the channel by sending the notify type
1185         SILC_NOTIFY_TYPE_CMODE_CHANGE.  The notify type MUST also be sent
1186         to the server's primary router.
1187
1188         Reply messages to the command:
1189
1190         Max Arguments:  3
1191             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1192                         (3) <channel mode mask>
1193
1194         This command replies with the changed channel mode mask that
1195         client MUST keep locally.
1196
1197         Status messages:
1198
1199             SILC_STATUS_OK
1200             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1201             SILC_STATUS_ERR_TOO_MANY_PARAMS
1202             SILC_STATUS_ERR_NOT_REGISTERED
1203             SILC_STATUS_ERR_NOT_ON_CHANNEL
1204             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1205             SILC_STATUS_ERR_BAD_CHANNEL_ID
1206             SILC_STATUS_ERR_NO_CHANNEL_ID
1207             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1208             SILC_STATUS_ERR_UNKNOWN_MODE
1209             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1210             SILC_STATUS_ERR_AUTH_FAILED
1211
1212
1213    18   SILC_COMMAND_CUMODE
1214
1215         Max Arguments:  4
1216             Arguments:  (1) <Channel ID>    (2) <mode mask>
1217                         (3) <Client ID>     (4) [<auth payload>]
1218
1219         This command is used by client to change channel user modes on
1220         channel.  Users on channel may have some special modes and this
1221         command is used by channel operators to set or change these modes.
1222         The <Channel ID> is the ID of the target channel.  The <mode mask>
1223         is OR'ed mask of modes.  The <Client ID> is the target client.
1224         The client changing channel user modes MUST be on the same channel
1225         as the target client and poses sufficient privileges to be able to
1226         change the mode.
1227
1228         When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1229         type is distributed to the channel.
1230
1231         The following channel modes are defined:
1232
1233            0x0000    SILC_CUMODE_NONE
1234
1235               No specific mode.  This is the normal situation for client.
1236               Also, this is the mode set when removing all modes from
1237               the target client.
1238
1239
1240            0x0001    SILC_CUMODE_FOUNDER
1241
1242               The client is channel founder of the channel.  Usually this
1243               mode is set only by the server when the channel was created.
1244               However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1245               been set, the client can claim channel founder privileges
1246               by providing the <auth payload> that the server will use
1247               to authenticate the client.  The public key that server will
1248               use to verify the <auth payload> must the same public key
1249               that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1250               mode was set.  The client MAY remove this mode at any time.
1251
1252
1253            0x0002    SILC_CUMODE_OPERATOR
1254
1255               Sets channel operator privileges on the channel for a
1256               client on the channel.  Channel founder and channel operator
1257               MAY set/unset this mode.
1258
1259         Reply messages to the command:
1260
1261         Max Arguments:  4
1262             Arguments:  (1) <Status Payload>  (2) <channel user mode mask>
1263                         (3) <Channel ID>      (4) <Client ID>
1264
1265         This command replies with the changed channel user mode mask that
1266         client MUST keep locally. The <Channel ID> is the specified
1267         channel.  The <Client ID> is the target client.
1268
1269         Status messages:
1270
1271             SILC_STATUS_OK
1272             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1273             SILC_STATUS_ERR_TOO_MANY_PARAMS
1274             SILC_STATUS_ERR_NOT_REGISTERED
1275             SILC_STATUS_ERR_NOT_ON_CHANNEL
1276             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1277             SILC_STATUS_ERR_BAD_CHANNEL_ID
1278             SILC_STATUS_ERR_NO_CHANNEL_ID
1279             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1280             SILC_STATUS_ERR_UNKNOWN_MODE
1281             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1282             SILC_STATUS_ERR_AUTH_FAILED
1283
1284
1285    19   SILC_COMMAND_KICK
1286
1287         Max Arguments:  3
1288             Arguments:  (1) <Channel ID>  (2) <Client ID>  
1289                         (3) [<comment>]
1290
1291         This command is used by channel operators to remove a client from
1292         channel.  The <channel> argument is the channel the client to be
1293         removed is on currently.  Note that the "kicker" must be on the same
1294         channel.  If <comment> is provided it will be sent to the removed
1295         client.
1296
1297         After kicking the client the server MUST send the notify type
1298         SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1299         The channel key MUST also be re-generated after kicking, unless
1300         the SILC_CMODE_PRIVKEY mode is set.
1301
1302         Reply messages to the command:
1303
1304         Max Arguments:  1
1305             Arguments:  (1) <Status Payload>
1306
1307         This command replies only with Status Payload.
1308
1309         Status messages:
1310
1311             SILC_STATUS_OK
1312             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1313             SILC_STATUS_ERR_TOO_MANY_PARAMS
1314             SILC_STATUS_ERR_NOT_REGISTERED
1315             SILC_STATUS_ERR_NO_SUCH_CHANNEL
1316             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1317             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1318             SILC_STATUS_ERR_NO_CLIENT_ID
1319
1320
1321    20   SILC_COMMAND_BAN
1322
1323         Max Arguments:  3
1324             Arguments:  (1) <Channel ID>         (2) [<adding client>]
1325                         (3) [<removing client>]
1326
1327         This command is used to manage the ban list of the channel
1328         indicated by the <Channel ID>.  A client that is banned from
1329         channel is no longer able to join the channel.  The client which
1330         is executing this command MUST have at least channel operator
1331         privileges on the channel.
1332
1333         The <adding client> and <removing client> are used to add to and
1334         remove from the ban list.  The format of the <adding client> and
1335         the <removing client> is of following format:
1336
1337             [<nickname>[@<server>]!][<username>]@[<hostname>]
1338
1339         The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1340         primary router after adding to or removing from the ban list.
1341         The wildcards MAY be used with this command.  If adding or removing
1342         from than one clients then the lists are an comma (`,') separated.
1343
1344         If this command is executed without the ban arguments the command
1345         merely replies with the current ban list.
1346
1347
1348         Reply messages to the command:
1349
1350         Max Arguments:  3
1351             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1352                         (3) [<ban list>]
1353
1354         This command replies with the <Channel ID> of the channel and
1355         the current <ban list> of the channel if it exists.
1356
1357         Status messages:
1358
1359             SILC_STATUS_OK
1360             SILC_STATUS_ERR_NOT_REGISTERED
1361             SILC_STATUS_ERR_TOO_MANY_PARAMS
1362             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1363             SILC_STATUS_ERR_NO_CHANNEL_ID
1364             SILC_STATUS_ERR_NOT_ON_CHANNEL
1365             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1366
1367
1368    21   SILC_COMMAND_CLOSE
1369
1370         Max Arguments:  2
1371             Arguments:  (1) <remote server/router>  (2) [<port>]
1372
1373         This command is used only by operator to close connection to a
1374         remote site.
1375
1376         Reply messages to the command:
1377
1378         Max Arguments:  1
1379             Arguments:  (1) <Status Payload>
1380
1381         This command replies only with Status Payload.
1382
1383         Status messages:
1384
1385             SILC_STATUS_OK
1386             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1387             SILC_STATUS_ERR_TOO_MANY_PARAMS
1388             SILC_STATUS_ERR_NOT_REGISTERED
1389             SILC_STATUS_ERR_NO_SUCH_SERVER
1390             SILC_STATUS_ERR_NO_SERVER_PRIV
1391             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1392
1393
1394    22   SILC_COMMAND_SHUTDOWN
1395
1396         Max Arguments:  0
1397             Arguments:  None
1398
1399         This command is used only by operator to shutdown the server.
1400         All connections to the server will be closed and the server is
1401         shutdown.
1402
1403         Reply messages to the command:
1404
1405         Max Arguments:  1
1406             Arguments:  (1) <Status Payload>
1407
1408         This command replies only with Status Payload.
1409
1410         Status messages:
1411
1412             SILC_STATUS_OK
1413             SILC_STATUS_ERR_NOT_REGISTERED
1414             SILC_STATUS_ERR_NO_SERVER_PRIV
1415
1416
1417    23   SILC_COMMAND_SILCOPER
1418
1419         Max Arguments:  2
1420             Arguments:  (1) <username>  (2) <authentication payload>
1421
1422         This command is used by normal client to obtain router operator
1423         privileges (also known as SILC operator) on the router.  Note
1424         that router operator has privileges that supersedes the server
1425         operator privileges.
1426
1427         The <username> is the username set in the server configurations
1428         as operator.  The <authentication payload> is the data that the
1429         client is authenticated against.  It may be passphrase prompted
1430         for user on client's screen or it may be public key or certificate
1431         authentication data (data signed with private key).  The public
1432         key that router will use to verify the signature found in the
1433         payload should be verified.  It is recommended that the public
1434         key is saved locally in the router and router would not use
1435         any public keys received during the SKE.
1436
1437         Difference between router operator and server operator is that
1438         router operator is able to handle cell level properties while
1439         server operator (even on router server) is able to handle only
1440         local properties, such as, local connections and normal server
1441         administration.  The router operator is also able to use the
1442         SILC_COMMAND_KILL command.
1443
1444         After changing the mode server MUST send the notify type
1445         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1446
1447         Reply messages to the command:
1448
1449         Max Arguments:  1
1450             Arguments:  (1) <Status Payload>
1451
1452         This command replies only with Status Payload.
1453
1454         Status messages:
1455
1456             SILC_STATUS_OK
1457             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1458             SILC_STATUS_ERR_TOO_MANY_PARAMS
1459             SILC_STATUS_ERR_NOT_REGISTERED
1460             SILC_STATUS_ERR_AUTH_FAILED
1461
1462
1463    24   SILC_COMMAND_LEAVE
1464
1465         Max Arguments:  1
1466             Arguments:  (1) <Channel ID>
1467
1468         This command is used by client to leave a channel the client is
1469         joined to. 
1470
1471         When leaving channel the server MUST send the notify type
1472         SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1473         The channel key MUST also be re-generated when leaving the channel
1474         and distribute it to all clients still currently on the channel.
1475         The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1476         is set.
1477
1478         Reply messages to the command:
1479
1480         Max Arguments:  1
1481             Arguments:  (1) <Status Payload>
1482
1483         This command replies only with Status Payload.
1484
1485         Status messages:
1486
1487             SILC_STATUS_OK
1488             SILC_STATUS_ERR_NOT_REGISTERED
1489             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1490             SILC_STATUS_ERR_TOO_MANY_PARAMS
1491             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1492             SILC_STATUS_ERR_BAD_CHANNEL_ID
1493             SILC_STATUS_ERR_NO_CHANNEL_ID
1494
1495
1496    25   SILC_COMMAND_USERS
1497
1498         Max Arguments:  2
1499             Arguments:  (1) [<Channel ID>]  (2) [<channel name>]
1500
1501         This command is used to list user names currently on the requested
1502         channel; either the argument <Channel ID> or the <channel name>. 
1503         One of these arguments must be present.  The server MUST resolve
1504         the user names and send a comma (`,') separated list of user names
1505         on the channel.  Server or router MAY resolve the names by sending
1506         SILC_COMMAND_WHOIS or SILC_COMMAND_IDENTIFY commands.
1507
1508         If the requested channel is a private or secret channel, this
1509         command MUST NOT send the list of users, as private and secret
1510         channels cannot be seen by outside.  In this case the returned
1511         name list MAY include a indication that the server could not 
1512         resolve the names of the users on the channel.  Also, in this case
1513         Client ID's or client modes are not sent either.
1514
1515         Reply messages to the command:
1516
1517         Max Arguments:  5
1518             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1519                         (3) <list count>      (4) <Client ID list>
1520                         (5) <client mode list>
1521
1522         This command replies with the Channel ID of the requested channel
1523         Client ID list of the users on the channel and list of their modes.
1524         The Client ID list has Client ID's of all users in the list.  The 
1525         <Client ID list> is formed by adding Client ID's one after another.
1526         The <client mode list> is formed by adding client's user modes on
1527         the channel one after another (4 bytes (32 bits) each).  The <list 
1528         count> of length of 4 bytes (32 bits), tells the number of entries
1529         in the lists.  Both lists MUST have equal number of entries.
1530
1531         Status messages:
1532
1533             SILC_STATUS_OK
1534             SILC_STATUS_ERR_NOT_REGISTERED
1535             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1536             SILC_STATUS_ERR_TOO_MANY_PARAMS
1537             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1538             SILC_STATUS_ERR_BAD_CHANNEL_ID
1539             SILC_STATUS_ERR_NO_CHANNEL_ID
1540             SILC_STATUS_ERR_NOT_ON_CHANNEL
1541
1542
1543    26   SILC_COMMAND_GETKEY
1544
1545         Max Arguments:  1
1546             Arguments:  (1) <ID Payload>
1547
1548         This command is used to fetch the public key of the client or
1549         server indicated by the <ID Payload>.  The public key is fetched
1550         from the server where to the client is connected.
1551
1552         Reply messages to the command:
1553
1554         Max Arguments:  3
1555             Arguments:  (1) <Status Payload>      (2) <ID Payload>
1556                         (3) [<Public Key Payload>]
1557
1558         This command replies with the client's or server's ID and with
1559         the <Public Key Payload>.
1560
1561         Status messages:
1562
1563             SILC_STATUS_OK
1564             SILC_STATUS_ERR_NOT_REGISTERED
1565             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1566             SILC_STATUS_ERR_TOO_MANY_PARAMS
1567             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1568             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1569
1570
1571    27 - 199
1572
1573         Currently undefined commands.
1574
1575
1576    200 - 254
1577
1578         These commands are reserved for private use and will not be defined
1579         in this document.
1580
1581
1582    255  SILC_COMMAND_MAX   
1583
1584         Reserved command.  This must not be sent.
1585 .in 3
1586
1587
1588 .ti 0
1589 2.3 SILC Command Status Types
1590
1591 .ti 0
1592 2.3.1 SILC Command Status Payload
1593
1594 Command Status Payload is sent in command reply messages to indicate
1595 the status of the command.  The payload is one of argument in the
1596 command thus this is the data area in Command Argument Payload described
1597 in [SILC2].  The payload is only 2 bytes of length.  The following diagram
1598 represents the Command Status Payload (field is always in MSB order).
1599
1600
1601 .in 21
1602 .nf
1603                      1
1604  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1605 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1606 |        Status Message         |
1607 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1608 .in 3
1609
1610 .ce
1611 Figure 6:  SILC Command Status Payload
1612
1613
1614 .in 6
1615 o Status Message (2 bytes) - Indicates the status message.
1616   All Status messages are described in the next section.
1617 .in 3
1618
1619
1620 .ti 0
1621 2.3.2 SILC Command Status List
1622
1623 Command Status messages are returned in the command reply messages
1624 to indicate whether the command were executed without errors.  If error
1625 has occurred the status indicates which error occurred.  Status payload
1626 only sends numeric reply about the status.  Receiver of the payload must
1627 convert the numeric values into human readable error messages.  The
1628 list of status messages below has an example human readable error
1629 messages that client may display for the user.
1630
1631 List of all defined command status messages following.
1632
1633 .in 0
1634    Generic status messages:
1635
1636    0    SILC_STATUS_OK
1637
1638         Ok status.  Everything went Ok.  The status payload maybe
1639         safely ignored in this case.
1640
1641    1    SILC_STATUS_LIST_START
1642
1643         Start of the list.  There will be several command replies and
1644         this reply is the start of the list.
1645
1646    2    SILC_STATUS_LIST_ITEM
1647
1648         Item in the list.  This is one of the item in the list but not the
1649         first or last one.
1650
1651    3    SILC_STATUS_LIST_END
1652
1653         End of the list.  There were several command replies and this
1654         reply is the last of the list.  There won't be other replies
1655         belonging to this list after this one.
1656
1657    4 - 9
1658
1659         Currently undefined and has been reserved for the future.
1660
1661
1662    Error status message:
1663
1664
1665
1666    10   SILC_STATUS_ERR_NO_SUCH_NICK
1667
1668         "No such nickname".  Requested nickname does not exist.
1669
1670    11   SILC_STATUS_ERR_NO_SUCH_CHANNEL
1671
1672         "No such channel".  Requested channel name does not exist.
1673
1674    12   SILC_STATUS_ERR_NO_SUCH_SERVER
1675
1676         "No such server".  Requested server name does not exist.
1677
1678    13   SILC_STATUS_ERR_TOO_MANY_TARGETS
1679
1680         "Duplicate recipients. No message delivered".  Message were
1681         tried to be sent to recipient which has several occurrences in 
1682         the recipient list.
1683
1684    14   SILC_STATUS_ERR_NO_RECIPIENT
1685
1686         "No recipient given".  Command required recipient which was
1687         not provided.
1688
1689    15   SILC_STATUS_ERR_UNKNOWN_COMMAND
1690
1691         "Unknown command".  Command sent to server is unknown by the
1692         server.
1693
1694    16   SILC_STATUS_ERR_WILDCARDS
1695
1696         "Wildcards cannot be used".  Wildcards were provided but they
1697         weren't permitted.
1698
1699    17   SILC_STATUS_ERR_NO_CLIENT_ID
1700
1701         "No Client ID given".  Client ID were expected as command
1702         parameter but were not found.
1703
1704    18   SILC_STATUS_ERR_NO_CHANNEL_ID
1705
1706         "No Channel ID given".  Channel ID were expected as command
1707         parameter but were not found.
1708
1709    19   SILC_STATUS_ERR_NO_SERVER_ID
1710
1711         "No Serve ID given".  Server ID were expected as command
1712         parameter but were not found.
1713
1714    20   SILC_STATUS_ERR_BAD_CLIENT_ID
1715
1716         "Bad Client ID".  Client ID provided were erroneous.
1717
1718    21   SILC_STATUS_ERR_BAD_CHANNEL_ID
1719
1720         "Bad Channel ID".  Channel ID provided were erroneous.
1721
1722    22   SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1723
1724         "No such Client ID".  Client ID provided does not exist.
1725
1726    23   SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1727
1728         "No such Channel ID".  Channel ID provided does not exist.
1729
1730    24   SILC_STATUS_ERR_NICKNAME_IN_USE
1731
1732         "Nickname already exists".  Nickname created could not be 
1733         registered because number of same nicknames were already set to
1734         maximum.  This is not expected to happen in real life but is
1735         possible to occur.
1736
1737    25   SILC_STATUS_ERR_NOT_ON_CHANNEL
1738
1739         "You are not on that channel".  The command were specified for
1740         channel user is not currently on.
1741
1742    26   SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1743
1744         "They are not on channel".  The requested target client is not
1745         on requested channel.
1746
1747    27   SILC_STATUS_ERR_USER_ON_CHANNEL
1748
1749         "User already on channel".  User were invited on channel they
1750         already are on.
1751
1752    28   SILC_STATUS_ERR_NOT_REGISTERED
1753
1754         "You have not registered".  User executed command that requires
1755         the client to be registered on the server before it may be
1756         executed.
1757
1758    29   SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1759
1760         "Not enough parameters".  Command requires more parameters
1761         than provided.
1762
1763    30   SILC_STATUS_ERR_TOO_MANY_PARAMS
1764
1765         "Too many parameters".  Too many parameters were provided
1766         for the command.
1767
1768    31   SILC_STATUS_ERR_PERM_DENIED
1769
1770         "Permission denied".  Generic permission denied error status
1771         to indicate disallowed access.
1772
1773    32   SILC_STATUS_ERR_BANNED_FROM_SERVER
1774
1775         "You are banned from this server".  The client tried to register
1776         on server that has explicitly denied this host to connect.
1777
1778    33   SILC_STATUS_ERR_BAD_PASSWORD
1779
1780         "Cannot join channel. Incorrect password".  Password provided for 
1781         channel were not accepted.
1782
1783    34   SILC_STATUS_ERR_CHANNEL_IS_FULL
1784
1785         "Cannot join channel. Channel is full".  The channel is full
1786         and client cannot be joined to it.
1787
1788    35   SILC_STATUS_ERR_NOT_INVITED
1789
1790         "Cannot join channel. You have not been invited".  The channel
1791         is invite only channel and client has not been invited.
1792
1793    36   SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1794
1795         "Cannot join channel. You have been banned".  The client has
1796         been banned from the channel.
1797
1798    37   SILC_STATUS_ERR_UNKNOWN_MODE
1799
1800         "Unknown mode".  Mode provided by the client were unknown to
1801         the server.
1802
1803    38   SILC_STATUS_ERR_NOT_YOU
1804
1805         "Cannot change mode for other users".  User tried to change
1806         someone else's mode.
1807
1808    39   SILC_STATUS_ERR_NO_CHANNEL_PRIV
1809
1810         "Permission denied. You are not channel operator".  Command may 
1811         be executed only by channel operator.
1812
1813    40   SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1814
1815         "Permission denied. You are not channel founder".  Command may 
1816         be executed only by channel operator.
1817
1818    41   SILC_STATUS_ERR_NO_SERVER_PRIV
1819
1820         "Permission denied. You are not server operator".  Command may
1821         be executed only by server operator.
1822
1823    42   SILC_STATUS_ERR_NO_ROUTER_PRIV
1824
1825         "Permission denied. You are not SILC operator".  Command may be
1826         executed only by router (SILC) operator.
1827
1828    43   SILC_STATUS_ERR_BAD_NICKNAME
1829
1830         "Bad nickname".  Nickname requested contained illegal characters
1831         or were malformed.
1832
1833    44   SILC_STATUS_ERR_BAD_CHANNEL
1834
1835         "Bad channel name".  Channel requested contained illegal characters
1836         or were malformed.
1837
1838    45   SILC_STATUS_ERR_AUTH_FAILED
1839
1840         "Authentication failed".  The authentication data sent as 
1841         argument were wrong and thus authentication failed.
1842
1843    46   SILC_STATUS_ERR_UNKOWN_ALGORITHM
1844
1845         "The algorithm was not supported."  The server does not support the
1846         requested algorithm.
1847
1848    47   SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1849
1850         "No such Server ID".  Server ID provided does not exist.
1851
1852 .in 3
1853
1854
1855 .ti 0
1856 3 Security Considerations
1857
1858 Security is central to the design of this protocol, and these security
1859 considerations permeate the specification.  Common security considerations
1860 such as keeping private keys truly private and using adequate lengths for
1861 symmetric and asymmetric keys must be followed in order to maintain the
1862 security of this protocol.
1863
1864
1865 .ti 0
1866 4 References
1867
1868 [SILC1]      Riikonen, P., "Secure Internet Live Conferencing (SILC),
1869              Protocol Specification", Internet Draft, April 2001.
1870
1871 [SILC2]      Riikonen, P., "SILC Packet Protocol", Internet Draft,
1872              April 2001.
1873
1874 [SILC3]      Riikonen, P., "SILC Key Exchange and Authentication 
1875              Protocols", Internet Draft, April 2001.
1876
1877 [IRC]        Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
1878              RFC 1459, May 1993.
1879
1880 [IRC-ARCH]   Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
1881              April 2000.
1882
1883 [IRC-CHAN]   Kalt, C., "Internet Relay Chat: Channel Management", RFC
1884              2811, April 2000.
1885
1886 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
1887              2812, April 2000.
1888
1889 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
1890              2813, April 2000.
1891
1892 [SSH-TRANS]  Ylonen, T., et al, "SSH Transport Layer Protocol", 
1893              Internet Draft.
1894
1895 [PGP]        Callas, J., et al, "OpenPGP Message Format", RFC 2440,
1896              November 1998.
1897
1898 [SPKI]       Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
1899              September 1999.
1900
1901 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key 
1902              Infrastructure, Certificate and CRL Profile", RFC 2459,
1903              January 1999.
1904
1905 [Schneier]   Schneier, B., "Applied Cryptography Second Edition",
1906              John Wiley & Sons, New York, NY, 1996.
1907
1908 [Menezes]    Menezes, A., et al, "Handbook of Applied Cryptography",
1909              CRC Press 1997.
1910
1911 [OAKLEY]     Orman, H., "The OAKLEY Key Determination Protocol",
1912              RFC 2412, November 1998.
1913
1914 [ISAKMP]     Maughan D., et al, "Internet Security Association and
1915              Key Management Protocol (ISAKMP)", RFC 2408, November
1916              1998.
1917
1918 [IKE]        Harkins D., and Carrel D., "The Internet Key Exchange
1919              (IKE)", RFC 2409, November 1998.
1920
1921 [HMAC]       Krawczyk, H., "HMAC: Keyed-Hashing for Message
1922              Authentication", RFC 2104, February 1997.
1923
1924 [PKCS1]      Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
1925              Specifications, Version 2.0", RFC 2437, October 1998.
1926
1927 [RFC2119]    Bradner, S., "Key Words for use in RFCs to Indicate
1928              Requirement Levels", BCP 14, RFC 2119, March 1997.
1929
1930
1931
1932
1933
1934
1935
1936
1937 .ti 0
1938 5 Author's Address
1939
1940 .nf
1941 Pekka Riikonen
1942 Snellmanninkatu 34 A 15
1943 70100 Kuopio
1944 Finland
1945
1946 EMail: priikone@silcnet.org
1947
1948 This Internet-Draft expires 13 May 2002
1949