8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-01.txt 22 July 2001
20 Expires: 22 January 2002
26 <draft-riikonen-silc-commands-01.txt>
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.
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."
42 The list of current Internet-Drafts can be accessed at
43 http://www.ietf.org/ietf/1id-abstracts.txt
45 The list of Internet-Draft Shadow Directories can be accessed at
46 http://www.ietf.org/shadow.html
48 The distribution of this memo is unlimited.
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.
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 ................................. 32
79 2.3.1 SILC Command Status Payload ......................... 32
80 2.3.2 SILC Command Status List ............................ 32
81 3 Security Considerations ....................................... 37
82 4 References .................................................... 38
83 5 Author's Address .............................................. 39
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.
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.
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.
105 1.1 Requirements Terminology
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].
116 2.1 SILC Commands Syntax
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].
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.
138 Example: Arguments: (1) <nickname> (2) <username@host>
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.
157 Arguments: (1) <nickname>[@<server>] (2) <message>
160 The command has maximum of 3 arguments. However, only first
161 and second arguments are mandatory.
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.
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
173 Reply messages to the command:
176 Arguments: (1) <Status Payload> (2) [<channel list>]
177 (3) <idle time> (4) [<away message>]
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.
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.
193 SILC_STATUS_ERR_TOO_MANY_TARGETS
194 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195 SILC_STATUS_ERR_NO_SUCH_NICK
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.
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.
209 2.2 SILC Commands List
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.
217 List of all defined commands in SILC follows.
222 None. This is reserved command and MUST NOT be sent.
228 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
229 (3) [<Client ID>] (n) [...]
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
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.
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.
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
260 Reply messages to the command:
263 Arguments: (1) <Status Payload> (2) <Client ID>
264 (3) <nickname>[@<server>] (4) <username@host>
265 (5) <real name> (6) [<Channel Payload
267 (7) [<user mode>] (8) [<idle time>]
270 This command may reply with several command reply messages to
271 form a list of results. In this case the status payload will
272 include STATUS_LIST_START status in the first reply and
273 STATUS_LIST_END in the last reply to indicate the end of the
274 list. If there are only one reply the status is set to normal
277 The command replies include the Client ID of the nickname,
278 nickname and server name, user name and host name and user's real
279 name. Client SHOULD process these replies only after the last
280 reply has been received with the STATUS_LIST_END status. If the
281 <count> option were defined in the query there will be only
282 <count> many replies from the server.
284 The server MAY return the list of channel the client has joined.
285 In this case the list is list of Channel Payloads. The Mode Mask
286 in the Channel Payload (see [SILC2] and section 2.3.2.3 for the
287 Channel Payload) is the client's mode on the channel. The list
288 is encoded by adding the Channel Payloads one after the other.
293 SILC_STATUS_LIST_START
295 SILC_STATUS_ERR_NO_SUCH_NICK
296 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
297 SILC_STATUS_ERR_WILDCARDS
298 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
299 SILC_STATUS_ERR_TOO_MANY_PARAMS
302 2 SILC_COMMAND_WHOWAS
305 Arguments: (1) <nickname>[@<server>] (2) [<count>]
307 Whowas. This command is used to query history information about
308 specific user. The user may be requested by their nickname and
309 server name. The query may find multiple matching users as there
310 are no unique nicknames in the SILC. The <count> option may be
311 given to narrow down the number of accepted results. If this
312 is not defined there are no limit of accepted results. The query
313 may also be narrowed down by defining the server name of the
314 nickname. The <count> is in string format.
316 To prevent miss-use of this command wildcards in the nickname
317 or in the server name are not permitted. The WHOWAS requests MUST
318 be based on specific nickname request.
320 The WHOWAS request MUST be always sent to the router by server
321 so that all users are searched. However, the server still must
322 search its locally connected clients.
324 Reply messages to the command:
327 Arguments: (1) <Status Payload> (2) <Client ID>
328 (3) <nickname>[@<server>] (4) <username@host>
331 This command may reply with several command reply messages to form
332 a list of results. In this case the status payload will include
333 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
334 the last reply to indicate the end of the list. If there are only
335 one reply the status is set to normal STATUS_OK.
337 The command replies with nickname and user name and host name.
338 Every server MUST keep history for some period of time of its
339 locally connected clients.
344 SILC_STATUS_LIST_START
346 SILC_STATUS_ERR_NO_SUCH_NICK
347 SILC_STATUS_ERR_WILDCARDS
348 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
349 SILC_STATUS_ERR_TOO_MANY_PARAMS
352 3 SILC_COMMAND_IDENTIFY
355 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
356 (3) [<channel name>] (4) [<count>]
357 (5) [<ID Payload>] (n) [...]
359 Identify command is used to query information about an entity by
360 the entity's name or ID. This command can be used to query
361 information about clients, server and channels.
363 The query may find multiple matching entities. The <count> option
364 may be given to narrow down the number of accepted results. If
365 this is not defined there are no limit of accepted results. The
366 <count> is in string format.
368 It is also possible to search the entity by its ID. If the
369 <ID Payload> is provided server must use it as the search value
370 instead of the entity's name. One of the arguments must be given.
371 It is also possible to define multiple ID Payloads to search
372 multiple entities sending only one IDENTIFY command. In this case
373 the ID Payloads are appended as normal arguments. The type of the
374 entity is defined by the type of the ID Payload.
376 To prevent miss-use of this command wildcards in the names are
377 not permitted. It is not allowed to request for example all users
380 Implementations may not want to give interface access to this
381 command as it is hardly a command that would be used by an end
382 user. However, it must be implemented as it is used with private
385 The IDENTIFY command MUST be always sent to the router by server
386 so that all users are searched. However, server MUST still search
387 its locally connected clients.
389 Reply messages to the command:
392 Arguments: (1) <Status Payload> (2) <Client ID>
393 (3) [<entity's name>] (4) [<info>]
395 This command may reply with several command reply messages to form
396 a list of results. In this case the status payload will include
397 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
398 the last reply to indicate the end of the list. If there are only
399 one reply the status is set to normal STATUS_OK.
401 When querying clients the <entity's name> must include the client's
402 nickname in the following format: nickname>[@server]. The
403 <info> must include the client's username and host in the following
404 format: username@host.
406 When querying servers the <entity's name> must include the server's
407 full name. The <info> may be omitted.
409 When querying channels the <entity's name> must include the
410 channel's name. The <info> may be omitted.
412 If the <count> option were defined in the query there will be only
413 <count> many replies from the server.
418 SILC_STATUS_LIST_START
420 SILC_STATUS_ERR_NO_SUCH_NICK
421 SILC_STATUS_ERR_NO_SUCH_SERVER
422 SILC_STATUS_ERR_NO_SUCH_CHANNEL
423 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
424 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
425 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
426 SILC_STATUS_ERR_WILDCARDS
427 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
428 SILC_STATUS_ERR_TOO_MANY_PARAMS
434 Arguments: (1) <nickname>
436 Set/change nickname. This command is used to set nickname for
437 user. Nickname MUST NOT include any spaces (` '), non-printable
438 characters, commas (`,') and any wildcard characters. Note that
439 nicknames in SILC are case-sensitive which must be taken into
440 account when searching clients by nickname.
442 When nickname is changed new Client ID is generated. Server MUST
443 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
444 channels (if any) the client is joined on. Then it MUST send
445 SILC_PACKET_REPLACE_ID to its primary route to replace the old
446 Client ID with the new one.
448 Reply messages to the command:
451 Arguments: (1) <Status Payload> (2) <New ID Payload>
453 This command is replied always with New ID Payload that is
454 generated by the server every time user changes their nickname.
455 Client receiving this payload MUST start using the received
456 Client ID as its current valid Client ID. The New ID Payload
457 is described in [SILC2].
462 SILC_STATUS_ERR_WILDCARDS
463 SILC_STATUS_ERR_NICKNAME_IN_USE
464 SILC_STATUS_ERR_BAD_NICKNAME
465 SILC_STATUS_ERR_NOT_REGISTERED
466 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
467 SILC_STATUS_ERR_TOO_MANY_PARAMS
473 Arguments: (1) [<Channel ID>]
475 The list command is used to list channels and their topics on the
476 current server. If the <Channel ID> parameter is used, only the
477 status of that channel is displayed. Secret channels are not
478 listed at all. Private channels are listed with status indicating
479 that the channel is private. Router MAY reply with all channels
482 Reply messages to the command:
485 Arguments: (1) <Status Payload> (2) <Channel ID>
486 (3) <channel> (4) [<topic>]
489 This command may reply with several command reply messages to form
490 a list of results. In this case the status payload will include
491 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
492 the last reply to indicate the end of the list. If there are only
493 one reply the status is set to normal STATUS_OK.
495 This command replies with Channel ID, name and the topic of the
496 channel. If the channel is private channel the <topic> SHOULD
497 include the "*private*" string.
502 SILC_STATUS_LIST_START
504 SILC_STATUS_ERR_WILDCARDS
505 SILC_STATUS_ERR_NOT_REGISTERED
506 SILC_STATUS_ERR_TOO_MANY_PARAMS
507 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
508 SILC_STATUS_ERR_NO_CHANNEL_ID
509 SILC_STATUS_ERR_NO_SUCH_SERVER
515 Arguments: (1) <Channel ID> (2) [<topic>]
517 This command is used to change or view the topic of a channel.
518 The topic for channel <Channel ID> is returned if there is no
519 <topic> given. If the <topic> parameter is present, the topic
520 for that channel will be changed, if the channel modes permit
523 After setting the topic the server MUST send the notify type
524 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
525 the channel which topic was changed.
527 Reply messages to the command:
530 Arguments: (1) <Status Payload> (2) <Channel ID>
533 The command may reply with the topic of the channel if it is
539 SILC_STATUS_ERR_NOT_ON_CHANNEL
540 SILC_STATUS_ERR_WILDCARDS
541 SILC_STATUS_ERR_NOT_REGISTERED
542 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
543 SILC_STATUS_ERR_NO_SUCH_CHANNEL
544 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
545 SILC_STATUS_ERR_NO_CHANNEL_ID
546 SILC_STATUS_ERR_BAD_CHANNEL_ID
547 SILC_STATUS_ERR_TOO_MANY_PARAMS
548 SILC_STATUS_ERR_NO_CHANNEL_PRIV
551 7 SILC_COMMAND_INVITE
554 Arguments: (1) <Channel ID> (2) [<Client ID>]
555 (3) [<adding client>] (4) [<removing client>]
557 This command is used to invite other clients to join to the
558 channel. The <Client ID> argument is the target client's ID that
559 is being invited. The <Channel ID> is the Channel ID of the
560 requested channel. The sender of this command MUST be on the
561 channel. The server MUST also send the notify type
562 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
563 client indicated by the <Client ID>.
565 The <adding client> and <removing client> can be used to add to
566 and remove from the invite list. The format of the <adding client>
567 and <removing client> is as follows:
569 [<nickname>[@<server>]!][<username>]@[<hostname>]
571 When adding to or removing from the invite list the server MUST
572 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
573 and MUST NOT send it to the client which was added to the list.
574 The client which executes this command MUST have at least channel
575 operator privileges to be able to add to or remove from the invite
576 list. The wildcards MAY be used with this command. If adding or
577 removing more than one client then the lists are an comma (`,')
580 Note that the <Client ID> provided MUST be resolved into correct
581 nickname and host name and add to the invite list before sending
584 When this command is given with only <Channel ID> argument then
585 the command merely returns the invite list of the channel. This
586 command MUST fail if the requested channel does not exist, the
587 requested <Client ID> is already on the channel or if the channel
588 is invite only channel and the caller of this command does not
589 have at least channel operator privileges.
591 Reply messages to the command:
594 Arguments: (1) <Status Payload> (2) <Channel ID>
597 This command replies with the invite list of the channel if it
598 exists. The <invite list> may be omitted if the list was not
604 SILC_STATUS_ERR_NOT_REGISTERED
605 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
606 SILC_STATUS_ERR_TOO_MANY_PARAMS
607 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
608 SILC_STATUS_ERR_NO_CLIENT_ID
609 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
610 SILC_STATUS_ERR_NO_CHANNEL_ID
611 SILC_STATUS_ERR_NOT_ON_CHANNEL
612 SILC_STATUS_ERR_USER_ON_CHANNEL
613 SILC_STATUS_ERR_NO_CHANNEL_PRIV
619 Arguments: (1) [<quit message>]
621 This command is used by client to end SILC session. The server
622 must close the connection to a client which sends this command.
623 if <quit message> is given it will be sent to other clients on
624 channel if the client is on channel when quitting.
626 Reply messages to the command:
628 This command does not reply anything.
634 Arguments: (1) <Client ID> (2) [<comment>]
636 This command is used by SILC operators to remove a client from
637 SILC network. The removing has temporary effects and client may
638 reconnect to SILC network. The <Client ID> is the client to be
639 removed from SILC. The <comment> argument may be provided to
640 give to the removed client some information why it was removed
643 When killing a client the router MUST first send notify type
644 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
645 The packet MUST NOT be sent to the killed client on the channels.
646 Then, the router MUST send the same notify type to its primary
647 router. Finally, the router MUST send the same notify type
648 directly to the client which was killed.
650 Reply messages to the command:
653 Arguments: (1) <Status Payload>
655 This command replies only with Status Payload.
660 SILC_STATUS_ERR_WILDCARDS
661 SILC_STATUS_ERR_NOT_REGISTERED
662 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
663 SILC_STATUS_ERR_TOO_MANY_PARAMS
664 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
665 SILC_STATUS_ERR_NO_CLIENT_ID
666 SILC_STATUS_ERR_NO_ROUTER_PRIV
672 Arguments: (1) [<server>] (2) [<Server ID>]
674 This command is used to fetch various information about a server.
675 If <server> argument is specified the command MUST be sent to
676 the requested server.
678 If the <Server ID> is specified the server information if fetched
679 by the provided Server ID. One of the arguments must always be
682 Reply messages to the command:
685 Arguments: (1) <Status Payload> (2) <Server ID>
686 (3) <server name> (4) <string>
688 This command replies with the Server ID of the server and a
689 string which tells the information about the server.
694 SILC_STATUS_ERR_WILDCARDS
695 SILC_STATUS_ERR_NOT_REGISTERED
696 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
697 SILC_STATUS_ERR_TOO_MANY_PARAMS
698 SILC_STATUS_ERR_NO_SUCH_SERVER
699 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
700 SILC_STATUS_ERR_NO_SERVER_ID
703 11 SILC_COMMAND_CONNECT
706 Arguments: (1) <remote server/router> (2) [<port>]
708 This command is used by operators to force a server to try to
709 establish a new connection to remote server or router. The
710 Operator MUST specify the server/router to be connected by
711 setting <remote server> argument. The port is 32 bit MSB value.
713 Reply messages to the command:
716 Arguments: (1) <Status Payload>
718 This command replies only with Status Payload.
725 SILC_STATUS_ERR_WILDCARDS
726 SILC_STATUS_ERR_NOT_REGISTERED
727 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
728 SILC_STATUS_ERR_TOO_MANY_PARAMS
729 SILC_STATUS_ERR_NO_SERVER_PRIV
730 SILC_STATUS_ERR_NO_ROUTER_PRIV
736 Arguments: (1) <Server ID>
738 This command is used by client and server to test the communication
739 channel to its server if one suspects that the communication is not
740 working correctly. The <Server ID> is the ID of the server the
741 sender is connected to.
743 Reply messages to the command:
746 Arguments: (1) <Status Payload>
748 This command replies only with Status Payload. Server returns
749 SILC_STATUS_OK in Status Payload if pinging was successful.
756 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
757 SILC_STATUS_ERR_TOO_MANY_PARAMS
758 SILC_STATUS_ERR_NO_SERVER_ID
759 SILC_STATUS_ERR_NO_SUCH_SERVER
760 SILC_STATUS_ERR_NOT_REGISTERED
766 Arguments: (1) <username> (2) <authentication payload>
768 This command is used by normal client to obtain server operator
769 privileges on some server or router. Note that router operator
770 has router privileges that supersedes the server operator
771 privileges and this does not obtain those privileges. Client
772 MUST use SILCOPER command to obtain router level privileges.
774 The <username> is the username set in the server configurations
775 as operator. The <authentication payload> is the data that the
776 client is authenticated against. It may be passphrase prompted
777 for user on client's screen or it may be public key or certificate
778 authentication data (data signed with private key). The public
779 key that server will use to verify the signature found in the
780 payload should be verified. It is recommended that the public
781 key is saved locally in the server and server would not use
782 any public keys received during the SKE.
784 After changing the mode the server MUST send the notify type
785 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
787 Reply messages to the command:
790 Arguments: (1) <Status Payload>
792 This command replies only with Status Payload.
797 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
798 SILC_STATUS_ERR_TOO_MANY_PARAMS
799 SILC_STATUS_ERR_NOT_REGISTERED
800 SILC_STATUS_ERR_AUTH_FAILED
806 Arguments: (1) <channel> (2) <Client ID>
807 (3) [<passphrase>] (4) [<cipher>]
810 Join to channel/create new channel. This command is used to
811 join to a channel. If the channel does not exist the channel is
812 created. If server is normal server this command MUST be sent
813 to router which will create the channel. The channel MAY be
814 protected with passphrase. If this is the case the passphrase
815 MUST be sent along the join command.
817 The name of the <channel> MUST NOT include any spaces (` '),
818 non-printable characters, commas (`,') or any wildcard characters.
820 The second argument <Client ID> is the Client ID of the client
821 which is joining to the client. When client sends this command
822 to the server the <Client ID> MUST be the client's own ID.
824 Cipher to be used to secure the traffic on the channel MAY be
825 requested by sending the name of the requested <cipher>. This
826 is used only if the channel does not exist and is created. If
827 the channel already exists the cipher set previously for the
828 channel will be used to secure the traffic. The computed MACs
829 of the channel message are produced by the default HMAC or by
830 the <hmac> provided for the command.
832 The server MUST check whether the user is allowed to join to
833 the requested channel. Various modes set to the channel affect
834 the ability of the user to join the channel. These conditions
837 o The user MUST be invited to the channel if the channel
838 is invite-only channel.
840 o The Client ID/nickname/username/host name MUST NOT match
843 o The correct passphrase MUST be provided if passphrase
844 is set to the channel.
846 o The user count limit, if set, MUST NOT be reached.
848 Reply messages to the command:
851 Arguments: (1) <Status Payload> (2) <channel>
852 (3) <Channel ID> (4) <Client ID>
853 (5) <channel mode mask> (6) <created>
854 (7) [<Channel Key Payload>] (8) [<ban list>]
855 (9) [<invite list>] (10) [<topic>]
856 (11) [<hmac>] (12) <list count>
857 (13) <Client ID list> (14) <client mode list>
859 This command replies with the channel name requested by the
860 client, channel ID of the channel and topic of the channel
861 if it exists. The <Client ID> is the Client ID which was joined
862 to the channel. It also replies with the channel mode mask
863 which tells all the modes set on the channel. If the
864 channel is created the mode mask is zero (0). If ban mask
865 and/or invite list is set they are sent as well.
867 The <list count>, <Client ID list> and <client mode list> are
868 the clients currently on the channel and their modes on the
869 channel. The <Client ID list> is formed by adding the ID Payloads
870 one after the other. The <client mode list> is formed by adding
871 32 bit MSB first order values one after the other.
873 Client receives the channel key in the reply message as well
874 inside <Channel Key Payload>.
879 SILC_STATUS_ERR_WILDCARDS
880 SILC_STATUS_ERR_NOT_REGISTERED
881 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
882 SILC_STATUS_ERR_TOO_MANY_PARAMS
883 SILC_STATUS_ERR_BAD_PASSWORD
884 SILC_STATUS_ERR_CHANNEL_IS_FULL
885 SILC_STATUS_ERR_NOT_INVITED
886 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
887 SILC_STATUS_ERR_BAD_CHANNEL
888 SILC_STATUS_ERR_USER_ON_CHANNEL
894 Arguments: (1) <server>
896 This command is used to query the Message of the Day of the server.
898 Reply messages to the command:
901 Arguments: (1) <Status Payload> (2) <Server ID>
904 This command replies with the motd message if it exists.
909 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
910 SILC_STATUS_ERR_TOO_MANY_PARAMS
911 SILC_STATUS_ERR_NOT_REGISTERED
912 SILC_STATUS_ERR_NO_SUCH_SERVER
915 16 SILC_COMMAND_UMODE
918 Arguments: (1) <Client ID> (2) <client mode mask>
920 This command is used by client to set/unset modes for itself.
921 However, there are some modes that the client MUST NOT set itself,
922 but they will be set by server. However, client MAY unset any
923 mode. Modes may be masked together ORing them thus having
924 several modes set. Client MUST keep its client mode mask
925 locally so that the mode setting/unsetting would work without
926 problems. Client may change only its own modes.
928 After changing the mode server MUST send the notify type
929 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
931 The following client modes are defined:
933 0x0000 SILC_UMODE_NONE
935 No specific mode for client. This is the initial
936 setting when new client is created. The client is
940 0x0001 SILC_UMODE_SERVER_OPERATOR
942 Marks the user as server operator. Client MUST NOT
943 set this mode itself. Server sets this mode to the
944 client when client attains the server operator
945 privileges by SILC_COMMAND_OPER command. Client
946 MAY unset the mode itself.
949 0x0002 SILC_UMODE_ROUTER_OPERATOR
951 Marks the user as router (SILC) operator. Client
952 MUST NOT this mode itself. Router sets this mode to
953 the client when client attains the router operator
954 privileges by SILC_COMMAND_SILCOPER command. Client
955 MAY unset the mode itself.
958 0x0004 SILC_UMODE_GONE
960 Marks that the user is not currently present in the
961 SILC Network. Client MAY set and unset this mode.
963 Reply messages to the command:
966 Arguments: (1) <Status Payload> (2) <client mode mask>
968 This command replies with the changed client mode mask that
969 the client MUST to keep locally.
975 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
976 SILC_STATUS_ERR_TOO_MANY_PARAMS
977 SILC_STATUS_ERR_NOT_REGISTERED
978 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
979 SILC_STATUS_ERR_BAD_CLIENT_ID
980 SILC_STATUS_ERR_NOT_YOU
981 SILC_STATUS_ERR_PERM_DENIED
982 SILC_STATUS_ERR_UNKNOWN_MODE
983 SILC_STATUS_ERR_NO_CLIENT_ID
986 17 SILC_COMMAND_CMODE
989 Arguments: (1) <Channel ID> (2) <channel mode mask>
990 (3) [<user limit>] (4) [<passphrase>]
991 (5) [<cipher>] (6) [<hmac>]
994 This command is used by client to set or change channel flags on
995 a channel. Channel has several modes that set various properties
996 of a channel. Modes may be masked together by ORing them thus
997 having several modes set. The <Channel ID> is the ID of the
998 target channel. The client changing channel mode MUST be on
999 the same channel and poses sufficient privileges to be able to
1002 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1003 type MUST be distributed to the channel.
1005 The following channel modes are defined:
1007 0x0000 SILC_CMODE_NONE
1009 No specific mode on channel. This is the default when
1010 channel is created. This means that channel is just plain
1014 0x0001 SILC_CMODE_PRIVATE
1016 Channel is private channel. Private channels are shown
1017 in the channel list listed with SILC_COMMAND_LIST command
1018 with indication that the channel is private. Also,
1019 client on private channel will no be detected to be on
1020 the channel as the channel is not shown in the client's
1021 currently joined channel list. Channel founder and
1022 channel operator MAY set/unset this mode.
1024 Typical implementation would use [+|-]p on user interface
1025 to set/unset this mode.
1028 0x0002 SILC_CMODE_SECRET
1030 Channel is secret channel. Secret channels are not shown
1031 in the list listed with SILC_COMMAND_LIST command. Secret
1032 channels can be considered to be invisible channels.
1033 Channel founder and channel operator MAY set/unset this
1036 Typical implementation would use [+|-]s on user interface
1037 to set/unset this mode.
1040 0x0004 SILC_CMODE_PRIVKEY
1042 Channel uses private channel key to protect the traffic
1043 on the channel. When this mode is set the client will be
1044 responsible to set the key it wants to use to encrypt and
1045 decrypt the traffic on channel. Server generated channel
1046 keys are not used at all. This mode provides additional
1047 security as clients on channel may agree to use private
1048 channel key that even servers do not know. Naturally,
1049 this requires that every client on the channel knows
1050 the key before hand (it is considered to be pre-shared-
1051 key). The key material is RECOMMENDED to be processed
1052 as stated in the [SILC3] in the section Processing the
1055 As it is local setting it is possible to have several
1056 private channel keys on one channel. In this case several
1057 clients can talk on same channel but only those clients
1058 that share the key with the message sender will be able
1059 to hear the talking. Client SHOULD NOT display those
1060 message for the end user that it is not able to decrypt
1061 when this mode is set.
1063 Only channel founder MAY set/unset this mode. If this
1064 mode is unset the server will distribute new channel
1065 key to all clients on the channel which will be used
1068 Typical implementation would use [+|-]k on user interface
1069 to set/unset this mode.
1072 0x0008 SILC_CMODE_INVITE
1074 Channel is invite only channel. Client may join to this
1075 channel only if it is invited to the channel. Channel
1076 founder and channel operator MAY set/unset this mode.
1078 Typical implementation would use [+|-]i on user interface
1079 to set/unset this mode.
1082 0x0010 SILC_CMODE_TOPIC
1084 The topic of the channel may only be set by client that
1085 is channel founder or channel operator. Normal clients
1086 on channel will not be able to set topic when this mode
1087 is set. Channel founder and channel operator MAY set/
1090 Typical implementation would use [+|-]t on user interface
1091 to set/unset this mode.
1094 0x0020 SILC_CMODE_ULIMIT
1096 User limit has been set to the channel. New clients
1097 may not join to the channel when the limit set is
1098 reached. Channel founder and channel operator MAY set/
1099 unset the limit. The <user limit> argument is the
1100 number of limited users.
1102 Typical implementation would use [+|-]l on user interface
1103 to set/unset this mode.
1106 0x0040 SILC_CMODE_PASSPHRASE
1108 Passphrase has been set to the channel. Client may
1109 join to the channel only if it is able to provide the
1110 correct passphrase. Setting passphrases to channel
1111 is entirely safe as all commands are protected in the
1112 SILC network. Only channel founder MAY set/unset
1113 the passphrase. The <passphrase> argument is the
1116 Typical implementation would use [+|-]a on user interface
1117 to set/unset this mode.
1120 0x0080 SILC_CMODE_CIPHER
1122 Sets specific cipher to be used to protect channel
1123 traffic. The <cipher> argument is the requested cipher.
1124 When set or unset the server must re-generate new
1125 channel key. Only channel founder MAY set the cipher of
1126 the channel. When unset the new key is generated using
1127 default cipher for the channel.
1129 Typical implementation would use [+|-]c on user interface
1130 to set/unset this mode.
1133 0x0100 SILC_CMODE_HMAC
1135 Sets specific hmac to be used to compute the MACs of the
1136 channel message. The <hmac> argument is the requested hmac.
1137 Only channel founder may set the hmac of the channel.
1139 Typical implementation would use [+|-]h on user interface
1140 to set/unset this mode.
1143 0x0200 SILC_CMODE_FOUNDER_AUTH
1145 Channel founder may set this mode to be able to regain
1146 channel founder rights even if the client leaves the
1147 channel. The <auth payload> is the Authentication Payload
1148 consisting of the authentication method and authentication
1149 data to be used in the authentication. The server MUST
1150 NOT accept NONE authentication method. Also, if the
1151 method is public key authentication the server MUST NOT
1152 save the authentication data from the payload as the
1153 data is different on all authentications. In this case the
1154 server only saves the authentication method. However,
1155 server MUST verify the sent authentication payload and
1156 set the mode only if the verification was successful.
1158 Note that this mode is effective only in the current server.
1159 The client MUST connect to the same server later to be able
1160 to regain the channel founder rights. The server MUST save
1161 the public key of the channel founder and use that to identify
1162 the client which is claiming the channel founder rights.
1163 The rights may be claimed by the SILC_CUMODE_FOUNDER
1164 channel user mode using SILC_COMMAND_CUMODE command. The
1165 set authentication data remains valid as long as the channel
1166 exists or until the founder unsets this mode.
1168 Typical implementation would use [+|-]f on user interface
1169 to set/unset this mode.
1171 To make the mode system work, client MUST keep the channel mode
1172 mask locally so that the mode setting and unsetting would work
1173 without problems. The client receives the initial channel mode
1174 mask when it joins to the channel. When the mode changes on
1175 channel the server MUST distribute the changed channel mode mask
1176 to all clients on the channel by sending the notify type
1177 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1178 to the server's primary router.
1180 Reply messages to the command:
1183 Arguments: (1) <Status Payload> (2) <Channel ID>
1184 (3) <channel mode mask>
1186 This command replies with the changed channel mode mask that
1187 client MUST keep locally.
1192 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1193 SILC_STATUS_ERR_TOO_MANY_PARAMS
1194 SILC_STATUS_ERR_NOT_REGISTERED
1195 SILC_STATUS_ERR_NOT_ON_CHANNEL
1196 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1197 SILC_STATUS_ERR_BAD_CHANNEL_ID
1198 SILC_STATUS_ERR_NO_CHANNEL_ID
1199 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1200 SILC_STATUS_ERR_UNKNOWN_MODE
1201 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1202 SILC_STATUS_ERR_AUTH_FAILED
1205 18 SILC_COMMAND_CUMODE
1208 Arguments: (1) <Channel ID> (2) <mode mask>
1209 (3) <Client ID> (4) [<auth payload>]
1211 This command is used by client to change channel user modes on
1212 channel. Users on channel may have some special modes and this
1213 command is used by channel operators to set or change these modes.
1214 The <Channel ID> is the ID of the target channel. The <mode mask>
1215 is OR'ed mask of modes. The <Client ID> is the target client.
1216 The client changing channel user modes MUST be on the same channel
1217 as the target client and poses sufficient privileges to be able to
1220 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1221 type is distributed to the channel.
1223 The following channel modes are defined:
1225 0x0000 SILC_CUMODE_NONE
1227 No specific mode. This is the normal situation for client.
1228 Also, this is the mode set when removing all modes from
1232 0x0001 SILC_CUMODE_FOUNDER
1234 The client is channel founder of the channel. Usually this
1235 mode is set only by the server when the channel was created.
1236 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1237 been set, the client can claim channel founder privileges
1238 by providing the <auth payload> that the server will use
1239 to authenticate the client. The public key that server will
1240 use to verify the <auth payload> must the same public key
1241 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1242 mode was set. The client MAY remove this mode at any time.
1245 0x0002 SILC_CUMODE_OPERATOR
1247 Sets channel operator privileges on the channel for a
1248 client on the channel. Channel founder and channel operator
1249 MAY set/unset this mode.
1251 Reply messages to the command:
1254 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1255 (3) <Channel ID> (4) <Client ID>
1257 This command replies with the changed channel user mode mask that
1258 client MUST keep locally. The <Channel ID> is the specified
1259 channel. The <Client ID> is the target client.
1264 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1265 SILC_STATUS_ERR_TOO_MANY_PARAMS
1266 SILC_STATUS_ERR_NOT_REGISTERED
1267 SILC_STATUS_ERR_NOT_ON_CHANNEL
1268 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1269 SILC_STATUS_ERR_BAD_CHANNEL_ID
1270 SILC_STATUS_ERR_NO_CHANNEL_ID
1271 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1272 SILC_STATUS_ERR_UNKNOWN_MODE
1273 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1274 SILC_STATUS_ERR_AUTH_FAILED
1277 19 SILC_COMMAND_KICK
1280 Arguments: (1) <Channel ID> (2) <Client ID>
1283 This command is used by channel operators to remove a client from
1284 channel. The <channel> argument is the channel the client to be
1285 removed is on currently. Note that the "kicker" must be on the same
1286 channel. If <comment> is provided it will be sent to the removed
1289 After kicking the client the server MUST send the notify type
1290 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1291 The channel key MUST also be re-generated after kicking, unless
1292 the SILC_CMODE_PRIVKEY mode is set.
1294 Reply messages to the command:
1297 Arguments: (1) <Status Payload>
1299 This command replies only with Status Payload.
1304 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1305 SILC_STATUS_ERR_TOO_MANY_PARAMS
1306 SILC_STATUS_ERR_NOT_REGISTERED
1307 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1308 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1309 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1310 SILC_STATUS_ERR_NO_CLIENT_ID
1316 Arguments: (1) <Channel ID> (2) [<adding client>]
1317 (3) [<removing client>]
1319 This command is used to manage the ban list of the channel
1320 indicated by the <Channel ID>. A client that is banned from
1321 channel is no longer able to join the channel. The client which
1322 is executing this command MUST have at least channel operator
1323 privileges on the channel.
1325 The <adding client> and <removing client> are used to add to and
1326 remove from the ban list. The format of the <adding client> and
1327 the <removing client> is of following format:
1329 [<nickname>[@<server>]!][<username>]@[<hostname>]
1331 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1332 primary router after adding to or removing from the ban list.
1333 The wildcards MAY be used with this command. If adding or removing
1334 from than one clients then the lists are an comma (`,') separated.
1336 If this command is executed without the ban arguments the command
1337 merely replies with the current ban list.
1340 Reply messages to the command:
1343 Arguments: (1) <Status Payload> (2) <Channel ID>
1346 This command replies with the <Channel ID> of the channel and
1347 the current <ban list> of the channel if it exists.
1352 SILC_STATUS_ERR_NOT_REGISTERED
1353 SILC_STATUS_ERR_TOO_MANY_PARAMS
1354 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1355 SILC_STATUS_ERR_NO_CHANNEL_ID
1356 SILC_STATUS_ERR_NOT_ON_CHANNEL
1357 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1360 21 SILC_COMMAND_CLOSE
1363 Arguments: (1) <remote server/router> (2) [<port>]
1365 This command is used only by operator to close connection to a
1368 Reply messages to the command:
1371 Arguments: (1) <Status Payload>
1373 This command replies only with Status Payload.
1378 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1379 SILC_STATUS_ERR_TOO_MANY_PARAMS
1380 SILC_STATUS_ERR_NOT_REGISTERED
1381 SILC_STATUS_ERR_NO_SUCH_SERVER
1382 SILC_STATUS_ERR_NO_SERVER_PRIV
1383 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1386 22 SILC_COMMAND_SHUTDOWN
1391 This command is used only by operator to shutdown the server.
1392 All connections to the server will be closed and the server is
1395 Reply messages to the command:
1398 Arguments: (1) <Status Payload>
1400 This command replies only with Status Payload.
1405 SILC_STATUS_ERR_NOT_REGISTERED
1406 SILC_STATUS_ERR_NO_SERVER_PRIV
1409 23 SILC_COMMAND_SILCOPER
1412 Arguments: (1) <username> (2) <authentication payload>
1414 This command is used by normal client to obtain router operator
1415 privileges (also known as SILC operator) on the router. Note
1416 that router operator has privileges that supersedes the server
1417 operator privileges.
1419 The <username> is the username set in the server configurations
1420 as operator. The <authentication payload> is the data that the
1421 client is authenticated against. It may be passphrase prompted
1422 for user on client's screen or it may be public key or certificate
1423 authentication data (data signed with private key). The public
1424 key that router will use to verify the signature found in the
1425 payload should be verified. It is recommended that the public
1426 key is saved locally in the router and router would not use
1427 any public keys received during the SKE.
1429 Difference between router operator and server operator is that
1430 router operator is able to handle cell level properties while
1431 server operator (even on router server) is able to handle only
1432 local properties, such as, local connections and normal server
1433 administration. The router operator is also able to use the
1434 SILC_COMMAND_KILL command.
1436 After changing the mode server MUST send the notify type
1437 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1439 Reply messages to the command:
1442 Arguments: (1) <Status Payload>
1444 This command replies only with Status Payload.
1449 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1450 SILC_STATUS_ERR_TOO_MANY_PARAMS
1451 SILC_STATUS_ERR_NOT_REGISTERED
1452 SILC_STATUS_ERR_AUTH_FAILED
1455 24 SILC_COMMAND_LEAVE
1458 Arguments: (1) <Channel ID>
1460 This command is used by client to leave a channel the client is
1463 When leaving channel the server MUST send the notify type
1464 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1465 The channel key MUST also be re-generated when leaving the channel
1466 and distribute it to all clients still currently on the channel.
1467 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1470 Reply messages to the command:
1473 Arguments: (1) <Status Payload>
1475 This command replies only with Status Payload.
1480 SILC_STATUS_ERR_NOT_REGISTERED
1481 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1482 SILC_STATUS_ERR_TOO_MANY_PARAMS
1483 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1484 SILC_STATUS_ERR_BAD_CHANNEL_ID
1485 SILC_STATUS_ERR_NO_CHANNEL_ID
1488 25 SILC_COMMAND_USERS
1491 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1493 This command is used to list user names currently on the requested
1494 channel; either the argument <Channel ID> or the <channel name>.
1495 One of these arguments must be present. The server MUST resolve
1496 the user names and send a comma (`,') separated list of user names
1497 on the channel. Server or router MAY resolve the names by sending
1498 SILC_COMMAND_WHOIS or SILC_COMMAND_IDENTIFY commands.
1500 If the requested channel is a private or secret channel, this
1501 command MUST NOT send the list of users, as private and secret
1502 channels cannot be seen by outside. In this case the returned
1503 name list MAY include a indication that the server could not
1504 resolve the names of the users on the channel. Also, in this case
1505 Client ID's or client modes are not sent either.
1507 Reply messages to the command:
1510 Arguments: (1) <Status Payload> (2) <Channel ID>
1511 (3) <list count> (4) <Client ID list>
1512 (5) <client mode list>
1514 This command replies with the Channel ID of the requested channel
1515 Client ID list of the users on the channel and list of their modes.
1516 The Client ID list has Client ID's of all users in the list. The
1517 <Client ID list> is formed by adding Client ID's one after another.
1518 The <client mode list> is formed by adding client's user modes on
1519 the channel one after another (4 bytes (32 bits) each). The <list
1520 count> of length of 4 bytes (32 bits), tells the number of entries
1521 in the lists. Both lists MUST have equal number of entries.
1526 SILC_STATUS_ERR_NOT_REGISTERED
1527 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1528 SILC_STATUS_ERR_TOO_MANY_PARAMS
1529 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1530 SILC_STATUS_ERR_BAD_CHANNEL_ID
1531 SILC_STATUS_ERR_NO_CHANNEL_ID
1532 SILC_STATUS_ERR_NOT_ON_CHANNEL
1535 26 SILC_COMMAND_GETKEY
1538 Arguments: (1) <ID Payload>
1540 This command is used to fetch the public key of the client or
1541 server indicated by the <ID Payload>. The public key is fetched
1542 from the server where to the client is connected.
1544 Reply messages to the command:
1547 Arguments: (1) <Status Payload> (2) <ID Payload>
1548 (3) <Public Key Payload>
1550 This command replies with the client's or server's ID and with
1551 the <Public Key Payload>.
1556 SILC_STATUS_ERR_NOT_REGISTERED
1557 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1558 SILC_STATUS_ERR_TOO_MANY_PARAMS
1559 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1560 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1565 Currently undefined commands.
1570 These commands are reserved for private use and will not be defined
1574 255 SILC_COMMAND_MAX
1576 Reserved command. This must not be sent.
1581 2.3 SILC Command Status Types
1584 2.3.1 SILC Command Status Payload
1586 Command Status Payload is sent in command reply messages to indicate
1587 the status of the command. The payload is one of argument in the
1588 command thus this is the data area in Command Argument Payload described
1589 in [SILC2]. The payload is only 2 bytes of length. The following diagram
1590 represents the Command Status Payload (field is always in MSB order).
1596 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1597 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1599 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1603 Figure 6: SILC Command Status Payload
1607 o Status Message (2 bytes) - Indicates the status message.
1608 All Status messages are described in the next section.
1613 2.3.2 SILC Command Status List
1615 Command Status messages are returned in the command reply messages
1616 to indicate whether the command were executed without errors. If error
1617 has occurred the status indicates which error occurred. Status payload
1618 only sends numeric reply about the status. Receiver of the payload must
1619 convert the numeric values into human readable error messages. The
1620 list of status messages below has an example human readable error
1621 messages that client may display for the user.
1623 List of all defined command status messages following.
1626 Generic status messages:
1630 Ok status. Everything went Ok. The status payload maybe
1631 safely ignored in this case.
1633 1 SILC_STATUS_LIST_START
1635 Start of the list. There will be several command replies and
1636 this reply is the start of the list.
1638 2 SILC_STATUS_LIST_ITEM
1640 Item in the list. This is one of the item in the list but not the
1643 3 SILC_STATUS_LIST_END
1645 End of the list. There were several command replies and this
1646 reply is the last of the list. There won't be other replies
1647 belonging to this list after this one.
1651 Currently undefined and has been reserved for the future.
1654 Error status message:
1658 10 SILC_STATUS_ERR_NO_SUCH_NICK
1660 "No such nickname". Requested nickname does not exist.
1662 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1664 "No such channel". Requested channel name does not exist.
1666 12 SILC_STATUS_ERR_NO_SUCH_SERVER
1668 "No such server". Requested server name does not exist.
1670 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
1672 "Duplicate recipients. No message delivered". Message were
1673 tried to be sent to recipient which has several occurrences in
1676 14 SILC_STATUS_ERR_NO_RECIPIENT
1678 "No recipient given". Command required recipient which was
1681 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
1683 "Unknown command". Command sent to server is unknown by the
1686 16 SILC_STATUS_ERR_WILDCARDS
1688 "Wildcards cannot be used". Wildcards were provided but they
1691 17 SILC_STATUS_ERR_NO_CLIENT_ID
1693 "No Client ID given". Client ID were expected as command
1694 parameter but were not found.
1696 18 SILC_STATUS_ERR_NO_CHANNEL_ID
1698 "No Channel ID given". Channel ID were expected as command
1699 parameter but were not found.
1701 19 SILC_STATUS_ERR_NO_SERVER_ID
1703 "No Serve ID given". Server ID were expected as command
1704 parameter but were not found.
1706 20 SILC_STATUS_ERR_BAD_CLIENT_ID
1708 "Bad Client ID". Client ID provided were erroneous.
1710 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
1712 "Bad Channel ID". Channel ID provided were erroneous.
1714 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1716 "No such Client ID". Client ID provided does not exist.
1718 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1720 "No such Channel ID". Channel ID provided does not exist.
1722 24 SILC_STATUS_ERR_NICKNAME_IN_USE
1724 "Nickname already exists". Nickname created could not be
1725 registered because number of same nicknames were already set to
1726 maximum. This is not expected to happen in real life but is
1729 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
1731 "You are not on that channel". The command were specified for
1732 channel user is not currently on.
1734 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1736 "They are not on channel". The requested target client is not
1737 on requested channel.
1739 27 SILC_STATUS_ERR_USER_ON_CHANNEL
1741 "User already on channel". User were invited on channel they
1744 28 SILC_STATUS_ERR_NOT_REGISTERED
1746 "You have not registered". User executed command that requires
1747 the client to be registered on the server before it may be
1750 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1752 "Not enough parameters". Command requires more parameters
1755 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
1757 "Too many parameters". Too many parameters were provided
1760 31 SILC_STATUS_ERR_PERM_DENIED
1762 "Permission denied". Generic permission denied error status
1763 to indicate disallowed access.
1765 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
1767 "You are banned from this server". The client tried to register
1768 on server that has explicitly denied this host to connect.
1770 33 SILC_STATUS_ERR_BAD_PASSWORD
1772 "Cannot join channel. Incorrect password". Password provided for
1773 channel were not accepted.
1775 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
1777 "Cannot join channel. Channel is full". The channel is full
1778 and client cannot be joined to it.
1780 35 SILC_STATUS_ERR_NOT_INVITED
1782 "Cannot join channel. You have not been invited". The channel
1783 is invite only channel and client has not been invited.
1785 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1787 "Cannot join channel. You have been banned". The client has
1788 been banned from the channel.
1790 37 SILC_STATUS_ERR_UNKNOWN_MODE
1792 "Unknown mode". Mode provided by the client were unknown to
1795 38 SILC_STATUS_ERR_NOT_YOU
1797 "Cannot change mode for other users". User tried to change
1798 someone else's mode.
1800 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1802 "Permission denied. You are not channel operator". Command may
1803 be executed only by channel operator.
1805 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1807 "Permission denied. You are not channel founder". Command may
1808 be executed only by channel operator.
1810 41 SILC_STATUS_ERR_NO_SERVER_PRIV
1812 "Permission denied. You are not server operator". Command may
1813 be executed only by server operator.
1815 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
1817 "Permission denied. You are not SILC operator". Command may be
1818 executed only by router (SILC) operator.
1820 43 SILC_STATUS_ERR_BAD_NICKNAME
1822 "Bad nickname". Nickname requested contained illegal characters
1825 44 SILC_STATUS_ERR_BAD_CHANNEL
1827 "Bad channel name". Channel requested contained illegal characters
1830 45 SILC_STATUS_ERR_AUTH_FAILED
1832 "Authentication failed". The authentication data sent as
1833 argument were wrong and thus authentication failed.
1835 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
1837 "The algorithm was not supported." The server does not support the
1838 requested algorithm.
1840 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1842 "No such Server ID". Server ID provided does not exist.
1848 3 Security Considerations
1850 Security is central to the design of this protocol, and these security
1851 considerations permeate the specification. Common security considerations
1852 such as keeping private keys truly private and using adequate lengths for
1853 symmetric and asymmetric keys must be followed in order to maintain the
1854 security of this protocol.
1860 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
1861 Protocol Specification", Internet Draft, April 2001.
1863 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
1866 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
1867 Protocols", Internet Draft, April 2001.
1869 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
1872 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
1875 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
1878 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
1881 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
1884 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
1887 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
1890 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
1893 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
1894 Infrastructure, Certificate and CRL Profile", RFC 2459,
1897 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
1898 John Wiley & Sons, New York, NY, 1996.
1900 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
1903 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
1904 RFC 2412, November 1998.
1906 [ISAKMP] Maughan D., et al, "Internet Security Association and
1907 Key Management Protocol (ISAKMP)", RFC 2408, November
1910 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
1911 (IKE)", RFC 2409, November 1998.
1913 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
1914 Authentication", RFC 2104, February 1997.
1916 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
1917 Specifications, Version 2.0", RFC 2437, October 1998.
1919 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
1920 Requirement Levels", BCP 14, RFC 2119, March 1997.
1928 Snellmanninkatu 34 A 15
1932 EMail: priikone@silcnet.org
1934 This Internet-Draft expires 25 October 2001