8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-03.txt XXX
26 <draft-riikonen-silc-commands-03.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 ................................. 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
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. Also note that
206 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
211 2.2 SILC Commands List
213 This section lists all SILC commands, however, it is expected that a
214 implementation and especially client implementation has many more
215 commands that has only local affect. These commands are official
216 SILC commands that has both client and server sides and cannot be
217 characterized as local commands.
219 List of all defined commands in SILC follows.
224 None. This is reserved command and MUST NOT be sent.
230 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
231 (3) [<Client ID>] (n) [...]
233 Whois command is used to query various information about specific
234 user. The user may be requested by their nickname and server name.
235 The query may find multiple matching users as there are no unique
236 nicknames in the SILC. The <count> option may be given to narrow
237 down the number of accepted results. If this is not defined there
238 are no limit of accepted results. The query may also be narrowed
239 down by defining the server name of the nickname. The <count> is
242 It is also possible to search the user by Client ID. If the
243 <Client ID> is provided server MUST use it as the search value
244 instead of the <nickname>. One of the arguments MUST be given.
245 It is also possible to define multiple Client ID's to search
246 multiple users sending only one WHOIS command. In this case the
247 Client ID's are appended as normal arguments.
249 To prevent miss-use of this command wildcards in the nickname
250 or in the server name are not permitted. It is not allowed
251 to request all users on some server. The WHOIS requests MUST
252 be based on specific nickname request.
254 The WHOIS request MUST be always sent to the router by server
255 so that all users are searched. However, the server still MUST
256 search its locally connected clients. The router MUST send
257 this command to the server which owns the requested client. That
258 server MUST reply to the command. Server MUST NOT send whois
259 replies to the client until it has received the reply from its
262 Reply messages to the command:
265 Arguments: (1) <Status Payload> (2) <Client ID>
266 (3) <nickname>[@<server>] (4) <username@host>
267 (5) <real name> (6) [<Channel Payload
269 (7) [<user mode>] (8) [<idle time>]
273 This command may reply with several command reply messages to
274 form a list of results. In this case the status payload will
275 include STATUS_LIST_START status in the first reply and
276 STATUS_LIST_END in the last reply to indicate the end of the
277 list. If there are only one reply the status is set to normal
280 The command replies include the Client ID of the nickname,
281 nickname and server name, user name and host name and user's real
282 name. Client SHOULD process these replies only after the last
283 reply has been received with the STATUS_LIST_END status. If the
284 <count> option were defined in the query there will be only
285 <count> many replies from the server.
287 The server may return the list of channel the client has joined.
288 In this case the list is list of Channel Payloads. The Mode Mask
289 in the Channel Payload (see [SILC2] and section 2.3.2.3 for the
290 Channel Payload) is the client's mode on the channel. The list
291 is encoded by adding the Channel Payloads one after the other.
293 The server may also send client's user mode, idle time, and the
294 fingerprint of the client's public key. The <fingerprint> is the
295 binary hash digest of the public key. The fingerprint MUST NOT
296 be sent if the server has not verified the proof of posession of
297 the corresponding private key. Server can do this during the
298 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
303 SILC_STATUS_LIST_START
305 SILC_STATUS_ERR_NO_SUCH_NICK
306 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
307 SILC_STATUS_ERR_WILDCARDS
308 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
309 SILC_STATUS_ERR_TOO_MANY_PARAMS
312 2 SILC_COMMAND_WHOWAS
315 Arguments: (1) <nickname>[@<server>] (2) [<count>]
317 Whowas. This command is used to query history information about
318 specific user. The user may be requested by their nickname and
319 server name. The query may find multiple matching users as there
320 are no unique nicknames in the SILC. The <count> option may be
321 given to narrow down the number of accepted results. If this
322 is not defined there are no limit of accepted results. The query
323 may also be narrowed down by defining the server name of the
324 nickname. The <count> is in string format.
326 To prevent miss-use of this command wildcards in the nickname
327 or in the server name are not permitted. The WHOWAS requests MUST
328 be based on specific nickname request.
330 The WHOWAS request MUST be always sent to the router by server
331 so that all users are searched. However, the server still must
332 search its locally connected clients.
334 Reply messages to the command:
337 Arguments: (1) <Status Payload> (2) <Client ID>
338 (3) <nickname>[@<server>] (4) <username@host>
341 This command may reply with several command reply messages to form
342 a list of results. In this case the status payload will include
343 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
344 the last reply to indicate the end of the list. If there are only
345 one reply the status is set to normal STATUS_OK.
347 The command replies with nickname and user name and host name.
348 Every server MUST keep history for some period of time of its
349 locally connected clients.
354 SILC_STATUS_LIST_START
356 SILC_STATUS_ERR_NO_SUCH_NICK
357 SILC_STATUS_ERR_WILDCARDS
358 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
359 SILC_STATUS_ERR_TOO_MANY_PARAMS
362 3 SILC_COMMAND_IDENTIFY
365 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
366 (3) [<channel name>] (4) [<count>]
367 (5) [<ID Payload>] (n) [...]
369 Identify command is used to query information about an entity by
370 the entity's name or ID. This command can be used to query
371 information about clients, server and channels.
373 The query may find multiple matching entities. The <count> option
374 may be given to narrow down the number of accepted results. If
375 this is not defined there are no limit of accepted results. The
376 <count> is in string format.
378 It is also possible to search the entity by its ID. If the
379 <ID Payload> is provided server must use it as the search value
380 instead of the entity's name. One of the arguments must be given.
381 It is also possible to define multiple ID Payloads to search
382 multiple entities sending only one IDENTIFY command. In this case
383 the ID Payloads are appended as normal arguments. The type of the
384 entity is defined by the type of the ID Payload.
386 To prevent miss-use of this command wildcards in the names are
387 not permitted. It is not allowed to request for example all users
390 Implementations may not want to give interface access to this
391 command as it is hardly a command that would be used by an end
392 user. However, it must be implemented as it is used with private
395 The IDENTIFY command MUST be always sent to the router by server
396 so that all users are searched. However, server MUST still search
397 its locally connected clients.
399 Reply messages to the command:
402 Arguments: (1) <Status Payload> (2) <ID Payload>
403 (3) [<entity's name>] (4) [<info>]
405 This command may reply with several command reply messages to form
406 a list of results. In this case the status payload will include
407 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
408 the last reply to indicate the end of the list. If there are only
409 one reply the status is set to normal STATUS_OK.
411 When querying clients the <entity's name> must include the client's
412 nickname in the following format: nickname[@server]. The
413 <info> must include the client's username and host in the following
414 format: username@host.
416 When querying servers the <entity's name> must include the server's
417 full name. The <info> may be omitted.
419 When querying channels the <entity's name> must include the
420 channel's name. The <info> may be omitted.
422 If the <count> option were defined in the query there will be only
423 <count> many replies from the server.
428 SILC_STATUS_LIST_START
430 SILC_STATUS_ERR_NO_SUCH_NICK
431 SILC_STATUS_ERR_NO_SUCH_SERVER
432 SILC_STATUS_ERR_NO_SUCH_CHANNEL
433 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
434 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
435 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
436 SILC_STATUS_ERR_WILDCARDS
437 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
438 SILC_STATUS_ERR_TOO_MANY_PARAMS
444 Arguments: (1) <nickname>
446 Set/change nickname. This command is used to set nickname for
447 user. Nickname MUST NOT include any spaces (` '), non-printable
448 characters, commas (`,') and any wildcard characters. Note that
449 nicknames in SILC are case-sensitive which must be taken into
450 account when searching clients by nickname.
452 When nickname is changed new Client ID is generated. Server MUST
453 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
454 channels (if any) the client is joined on. Then it MUST send
455 SILC_PACKET_REPLACE_ID to its primary route to replace the old
456 Client ID with the new one.
458 Reply messages to the command:
461 Arguments: (1) <Status Payload> (2) <New ID Payload>
463 This command is replied always with New ID Payload that is
464 generated by the server every time user changes their nickname.
465 Client receiving this payload MUST start using the received
466 Client ID as its current valid Client ID. The New ID Payload
467 is described in [SILC2].
472 SILC_STATUS_ERR_WILDCARDS
473 SILC_STATUS_ERR_NICKNAME_IN_USE
474 SILC_STATUS_ERR_BAD_NICKNAME
475 SILC_STATUS_ERR_NOT_REGISTERED
476 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
477 SILC_STATUS_ERR_TOO_MANY_PARAMS
483 Arguments: (1) [<Channel ID>]
485 The list command is used to list channels and their topics on the
486 current server. If the <Channel ID> parameter is used, only the
487 status of that channel is displayed. Secret channels are not
488 listed at all. Private channels are listed with status indicating
489 that the channel is private. Router MAY reply with all channels
492 Reply messages to the command:
495 Arguments: (1) <Status Payload> (2) <Channel ID>
496 (3) <channel> (4) [<topic>]
499 This command may reply with several command reply messages to form
500 a list of results. In this case the status payload will include
501 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
502 the last reply to indicate the end of the list. If there are only
503 one reply the status is set to normal STATUS_OK.
505 This command replies with Channel ID, name and the topic of the
506 channel. If the channel is private channel the <topic> SHOULD
507 include the "*private*" string.
512 SILC_STATUS_LIST_START
514 SILC_STATUS_ERR_WILDCARDS
515 SILC_STATUS_ERR_NOT_REGISTERED
516 SILC_STATUS_ERR_TOO_MANY_PARAMS
517 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
518 SILC_STATUS_ERR_NO_CHANNEL_ID
519 SILC_STATUS_ERR_NO_SUCH_SERVER
525 Arguments: (1) <Channel ID> (2) [<topic>]
527 This command is used to change or view the topic of a channel.
528 The topic for channel <Channel ID> is returned if there is no
529 <topic> given. If the <topic> parameter is present, the topic
530 for that channel will be changed, if the channel modes permit
533 After setting the topic the server MUST send the notify type
534 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
535 the channel which topic was changed.
537 Reply messages to the command:
540 Arguments: (1) <Status Payload> (2) <Channel ID>
543 The command may reply with the topic of the channel if it is
549 SILC_STATUS_ERR_NOT_ON_CHANNEL
550 SILC_STATUS_ERR_WILDCARDS
551 SILC_STATUS_ERR_NOT_REGISTERED
552 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
553 SILC_STATUS_ERR_NO_SUCH_CHANNEL
554 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
555 SILC_STATUS_ERR_NO_CHANNEL_ID
556 SILC_STATUS_ERR_BAD_CHANNEL_ID
557 SILC_STATUS_ERR_TOO_MANY_PARAMS
558 SILC_STATUS_ERR_NO_CHANNEL_PRIV
561 7 SILC_COMMAND_INVITE
564 Arguments: (1) <Channel ID> (2) [<Client ID>]
565 (3) [<adding client>] (4) [<removing client>]
567 This command is used to invite other clients to join to the
568 channel. The <Client ID> argument is the target client's ID that
569 is being invited. The <Channel ID> is the Channel ID of the
570 requested channel. The sender of this command MUST be on the
571 channel. The server MUST also send the notify type
572 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
573 client indicated by the <Client ID>.
575 The <adding client> and <removing client> can be used to add to
576 and remove from the invite list. The format of the <adding client>
577 and <removing client> is as follows:
579 [<nickname>[@<server>]!][<username>]@[<hostname>]
581 When adding to or removing from the invite list the server MUST
582 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
583 and MUST NOT send it to the client which was added to the list.
584 The client which executes this command MUST have at least channel
585 operator privileges to be able to add to or remove from the invite
586 list. The wildcards MAY be used with this command. If adding or
587 removing more than one client then the lists are an comma (`,')
590 Note that the <Client ID> provided MUST be resolved into correct
591 nickname and host name and add to the invite list before sending
594 When this command is given with only <Channel ID> argument then
595 the command merely returns the invite list of the channel. This
596 command MUST fail if the requested channel does not exist, the
597 requested <Client ID> is already on the channel or if the channel
598 is invite only channel and the caller of this command does not
599 have at least channel operator privileges.
601 Reply messages to the command:
604 Arguments: (1) <Status Payload> (2) <Channel ID>
607 This command replies with the invite list of the channel if it
613 SILC_STATUS_ERR_NOT_REGISTERED
614 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
615 SILC_STATUS_ERR_TOO_MANY_PARAMS
616 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
617 SILC_STATUS_ERR_NO_CLIENT_ID
618 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
619 SILC_STATUS_ERR_NO_CHANNEL_ID
620 SILC_STATUS_ERR_NOT_ON_CHANNEL
621 SILC_STATUS_ERR_USER_ON_CHANNEL
622 SILC_STATUS_ERR_NO_CHANNEL_PRIV
628 Arguments: (1) [<quit message>]
630 This command is used by client to end SILC session. The server
631 must close the connection to a client which sends this command.
632 if <quit message> is given it will be sent to other clients on
633 channel if the client is on channel when quitting.
635 Reply messages to the command:
637 This command does not reply anything.
643 Arguments: (1) <Client ID> (2) [<comment>]
645 This command is used by SILC operators to remove a client from
646 SILC network. The removing has temporary effects and client may
647 reconnect to SILC network. The <Client ID> is the client to be
648 removed from SILC. The <comment> argument may be provided to
649 give to the removed client some information why it was removed
652 When killing a client the router MUST first send notify type
653 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
654 The packet MUST NOT be sent to the killed client on the channels.
655 Then, the router MUST send the same notify type to its primary
656 router. Finally, the router MUST send the same notify type
657 directly to the client which was killed.
659 Reply messages to the command:
662 Arguments: (1) <Status Payload>
664 This command replies only with Status Payload.
669 SILC_STATUS_ERR_WILDCARDS
670 SILC_STATUS_ERR_NOT_REGISTERED
671 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
672 SILC_STATUS_ERR_TOO_MANY_PARAMS
673 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
674 SILC_STATUS_ERR_NO_CLIENT_ID
675 SILC_STATUS_ERR_NO_ROUTER_PRIV
681 Arguments: (1) [<server>] (2) [<Server ID>]
683 This command is used to fetch various information about a server.
684 If <server> argument is specified the command MUST be sent to
685 the requested server.
687 If the <Server ID> is specified the server information if fetched
688 by the provided Server ID. One of the arguments must always be
691 Reply messages to the command:
694 Arguments: (1) <Status Payload> (2) <Server ID>
695 (3) <server name> (4) <string>
697 This command replies with the Server ID of the server and a
698 string which tells the information about the server.
703 SILC_STATUS_ERR_WILDCARDS
704 SILC_STATUS_ERR_NOT_REGISTERED
705 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
706 SILC_STATUS_ERR_TOO_MANY_PARAMS
707 SILC_STATUS_ERR_NO_SUCH_SERVER
708 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
709 SILC_STATUS_ERR_NO_SERVER_ID
712 11 SILC_COMMAND_STATS
715 Arguments: (1) <Server ID>
717 This command is used to fetch various statistical information
718 from the server indicated by <Server ID>, which is the ID of
719 server where sender is connected to. Server receiving this
720 command MAY also send this further to its router for fetching
721 other cell and network wide statistics to accompany the reply.
723 Reply messages to the command:
726 Arguments: (1) <Status Payload> (2) <Server ID>
727 (3) [<statistics structure>]
729 This command replies with the Server ID of the server and
730 optional statistics structure which includes 32 bit MSB first
731 ordered integer values to represent various statistical
732 information. The structure is as follows:
734 starttime - time when server was started
735 uptime - uptime of the server
736 my clients - number of locally connected clients
737 my channels - number of locally created channels
738 my server ops - number of local server operators
739 my router ops - number of local router operators
740 cell clients - number of clients in local cell
741 cell channels - number of channels in local cell
742 cell servers - number of servers in local cell
743 clients - number of client in SILC network
744 channels - number of channels in SILC network
745 servers - number of servers in SILC network
746 routers - number of routers in SILC network
747 server ops - number of server operators in SILC network
748 router ops - number of router operators in SILC network
750 If some value is unknown it is set to zero (0) value. The
751 "starttime" is the start time of the server, and is seconds
752 since Epoch (POSIX.1). The "uptime" is time difference of
753 current time and "starttime" in the server, and is seconds
759 SILC_STATUS_ERR_NOT_REGISTERED
760 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
761 SILC_STATUS_ERR_TOO_MANY_PARAMS
762 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
763 SILC_STATUS_ERR_NO_SUCH_SERVER
764 SILC_STATUS_ERR_NO_SERVER_ID
770 Arguments: (1) <Server ID>
772 This command is used by client and server to test the communication
773 channel to its server if one suspects that the communication is not
774 working correctly. The <Server ID> is the ID of the server the
775 sender is connected to.
777 Reply messages to the command:
780 Arguments: (1) <Status Payload>
782 This command replies only with Status Payload. Server returns
783 SILC_STATUS_OK in Status Payload if pinging was successful.
790 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
791 SILC_STATUS_ERR_TOO_MANY_PARAMS
792 SILC_STATUS_ERR_NO_SERVER_ID
793 SILC_STATUS_ERR_NO_SUCH_SERVER
794 SILC_STATUS_ERR_NOT_REGISTERED
800 Arguments: (1) <username> (2) <authentication payload>
802 This command is used by normal client to obtain server operator
803 privileges on some server or router. Note that router operator
804 has router privileges that supersedes the server operator
805 privileges and this does not obtain those privileges. Client
806 MUST use SILCOPER command to obtain router level privileges.
808 The <username> is the username set in the server configurations
809 as operator. The <authentication payload> is the data that the
810 client is authenticated against. It may be passphrase prompted
811 for user on client's screen or it may be public key or certificate
812 authentication data (data signed with private key). The public
813 key that server will use to verify the signature found in the
814 payload should be verified. It is recommended that the public
815 key is saved locally in the server and server would not use
816 any public keys received during the SKE.
818 After changing the mode the server MUST send the notify type
819 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
821 Reply messages to the command:
824 Arguments: (1) <Status Payload>
826 This command replies only with Status Payload.
831 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
832 SILC_STATUS_ERR_TOO_MANY_PARAMS
833 SILC_STATUS_ERR_NOT_REGISTERED
834 SILC_STATUS_ERR_AUTH_FAILED
840 Arguments: (1) <channel> (2) <Client ID>
841 (3) [<passphrase>] (4) [<cipher>]
842 (5) [<hmac>] (6) [<founder auth>]
844 Join to channel/create new channel. This command is used to
845 join to a channel. If the channel does not exist the channel is
846 created. If server is normal server this command MUST be sent
847 to router which will create the channel. The channel MAY be
848 protected with passphrase. If this is the case the passphrase
849 MUST be sent along the join command.
851 The name of the <channel> MUST NOT include any spaces (` '),
852 non-printable characters, commas (`,') or any wildcard characters.
854 The second argument <Client ID> is the Client ID of the client
855 which is joining to the client. When client sends this command
856 to the server the <Client ID> MUST be the client's own ID.
858 Cipher to be used to secure the traffic on the channel MAY be
859 requested by sending the name of the requested <cipher>. This
860 is used only if the channel does not exist and is created. If
861 the channel already exists the cipher set previously for the
862 channel will be used to secure the traffic. The computed MACs
863 of the channel message are produced by the default HMAC or by
864 the <hmac> provided for the command.
866 The <founder auth> is Authentication Payload providing the
867 authentication for gaining founder privileges on the channel
868 when joining the channel. The client may provide this if it
869 knows that it is the founder of the channel and that the
870 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
871 MUST verify whether the client is able to gain the founder
872 privileges the same way as the client had given the
873 SILC_COMMAND_CUMODE command to gain founder privileges. The
874 client is still able to join the channel even if the founder
875 privileges could not be gained.
877 The server MUST check whether the user is allowed to join to
878 the requested channel. Various modes set to the channel affect
879 the ability of the user to join the channel. These conditions
882 o The user MUST be invited to the channel if the channel
883 is invite-only channel.
885 o The Client ID/nickname/username/host name MUST NOT match
888 o The correct passphrase MUST be provided if passphrase
889 is set to the channel.
891 o The user count limit, if set, MUST NOT be reached.
893 If the client provided correct <founder auth> payload it can
894 override these conditions, except the condition for the passphrase.
895 The correct passphrase MUST be provided even if <founder auth>
898 Reply messages to the command:
901 Arguments: (1) <Status Payload> (2) <channel>
902 (3) <Channel ID> (4) <Client ID>
903 (5) <channel mode mask> (6) <created>
904 (7) [<Channel Key Payload>] (8) [<ban list>]
905 (9) [<invite list>] (10) [<topic>]
906 (11) [<hmac>] (12) <list count>
907 (13) <Client ID list> (14) <client mode list>
909 This command replies with the channel name requested by the
910 client, channel ID of the channel and topic of the channel
911 if it exists. The <Client ID> is the Client ID which was joined
912 to the channel. It also replies with the channel mode mask
913 which tells all the modes set on the channel. If the
914 channel is created the mode mask is zero (0). If ban mask
915 and/or invite list is set they are sent as well.
917 The <list count>, <Client ID list> and <client mode list> are
918 the clients currently on the channel and their modes on the
919 channel. The <Client ID list> is formed by adding the ID Payloads
920 one after the other. The <client mode list> is formed by adding
921 32 bit MSB first order values one after the other.
923 Client receives the channel key in the reply message as well
924 inside <Channel Key Payload>.
929 SILC_STATUS_ERR_WILDCARDS
930 SILC_STATUS_ERR_NOT_REGISTERED
931 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
932 SILC_STATUS_ERR_TOO_MANY_PARAMS
933 SILC_STATUS_ERR_BAD_PASSWORD
934 SILC_STATUS_ERR_CHANNEL_IS_FULL
935 SILC_STATUS_ERR_NOT_INVITED
936 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
937 SILC_STATUS_ERR_BAD_CHANNEL
938 SILC_STATUS_ERR_USER_ON_CHANNEL
944 Arguments: (1) <server>
946 This command is used to query the Message of the Day of the server.
948 Reply messages to the command:
951 Arguments: (1) <Status Payload> (2) <Server ID>
954 This command replies with the motd message if it exists.
959 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
960 SILC_STATUS_ERR_TOO_MANY_PARAMS
961 SILC_STATUS_ERR_NOT_REGISTERED
962 SILC_STATUS_ERR_NO_SUCH_SERVER
965 16 SILC_COMMAND_UMODE
968 Arguments: (1) <Client ID> (2) <client mode mask>
970 This command is used by client to set/unset modes for itself.
971 However, there are some modes that the client MUST NOT set itself,
972 but they will be set by server. However, client MAY unset any
973 mode. Modes may be masked together ORing them thus having
974 several modes set. Client MUST keep its client mode mask
975 locally so that the mode setting/unsetting would work without
976 problems. Client may change only its own modes.
978 After changing the mode server MUST send the notify type
979 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
981 The following client modes are defined:
983 0x00000000 SILC_UMODE_NONE
985 No specific mode for client. This is the initial
986 setting when new client is created. The client is
987 normal client and is present in the network.
990 0x00000001 SILC_UMODE_SERVER_OPERATOR
992 Marks the user as server operator. Client MUST NOT
993 set this mode itself. Server sets this mode to the
994 client when client attains the server operator
995 privileges by SILC_COMMAND_OPER command. Client
996 MAY unset the mode itself.
999 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1001 Marks the user as router (SILC) operator. Client
1002 MUST NOT set this mode itself. Router sets this mode
1003 to the client when client attains the router operator
1004 privileges by SILC_COMMAND_SILCOPER command. Client
1005 MAY unset the mode itself.
1008 0x00000004 SILC_UMODE_GONE
1010 Marks that the user is not currently present in the
1011 SILC Network. Client MAY set and unset this mode.
1014 0x00000008 SILC_UMODE_INDISPOSED
1016 Marks that the user is currently indisposed and may
1017 not be able to receive any messages, and that user may
1018 not be present in the network. Client MAY set and
1022 0x00000010 SILC_UMODE_BUSY
1024 Marks that the user is currently busy and may not
1025 want to receive any messages, and that user may not
1026 be present in the network. Client MAY set and unset
1030 0x00000020 SILC_UMODE_PAGE
1032 User is not currently present or is unable to receive
1033 messages, and prefers to be paged in some mechanism
1034 if the user needs to be reached. Client MAY set and
1038 0x00000040 SILC_UMODE_HYPER
1040 Marks that the user is hyper active and is eager to
1041 receive and send messages. Client MAY set and unset
1045 0x00000080 SILC_UMODE_ROBOT
1047 Marks that the client is actually a robot program.
1048 Client MAY set and unset this mode.
1051 0x00000100 SILC_UMODE_ANONYMOUS
1053 Marks that the client is anonymous client. Server
1054 that specificly is designed for anonymous services
1055 can set and unset this mode. Client MUST NOT set or
1056 unset this mode itself. A client with this mode set
1057 would have the username and the hostname information
1058 scrambled by the server which set this mode.
1061 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1063 Marks that the client wishes to block private
1064 messages sent to the client, unless the Private
1065 Message Key flag is set in the SILC packet header.
1066 If this mode is set server MUST NOT deliver private
1067 messages to the client without the Private Message
1070 A separate service could provide additional filtering
1071 features for accepting private messages from certain
1072 sender. However, this document does not specify such
1075 The client MAY set and unset this mode.
1078 Reply messages to the command:
1081 Arguments: (1) <Status Payload> (2) <client mode mask>
1083 This command replies with the changed client mode mask that
1084 the client MUST to keep locally.
1090 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1091 SILC_STATUS_ERR_TOO_MANY_PARAMS
1092 SILC_STATUS_ERR_NOT_REGISTERED
1093 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1094 SILC_STATUS_ERR_BAD_CLIENT_ID
1095 SILC_STATUS_ERR_NOT_YOU
1096 SILC_STATUS_ERR_PERM_DENIED
1097 SILC_STATUS_ERR_UNKNOWN_MODE
1098 SILC_STATUS_ERR_NO_CLIENT_ID
1101 17 SILC_COMMAND_CMODE
1104 Arguments: (1) <Channel ID> (2) <channel mode mask>
1105 (3) [<user limit>] (4) [<passphrase>]
1106 (5) [<cipher>] (6) [<hmac>]
1107 (7) [<auth payload>]
1109 This command is used by client to set or change channel flags on
1110 a channel. Channel has several modes that set various properties
1111 of a channel. Modes may be masked together by ORing them thus
1112 having several modes set. The <Channel ID> is the ID of the
1113 target channel. The client changing channel mode MUST be on
1114 the same channel and poses sufficient privileges to be able to
1117 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1118 type MUST be distributed to the channel.
1120 The following channel modes are defined:
1122 0x00000000 SILC_CMODE_NONE
1124 No specific mode on channel. This is the default when
1125 channel is created. This means that channel is just plain
1129 0x00000001 SILC_CMODE_PRIVATE
1131 Channel is private channel. Private channels are shown
1132 in the channel list listed with SILC_COMMAND_LIST command
1133 with indication that the channel is private. Also,
1134 client on private channel will no be detected to be on
1135 the channel as the channel is not shown in the client's
1136 currently joined channel list. Channel founder and
1137 channel operator MAY set/unset this mode.
1139 Typical implementation would use [+|-]p on user interface
1140 to set/unset this mode.
1143 0x00000002 SILC_CMODE_SECRET
1145 Channel is secret channel. Secret channels are not shown
1146 in the list listed with SILC_COMMAND_LIST command. Secret
1147 channels can be considered to be invisible channels.
1148 Channel founder and channel operator MAY set/unset this
1151 Typical implementation would use [+|-]s on user interface
1152 to set/unset this mode.
1155 0x00000004 SILC_CMODE_PRIVKEY
1157 Channel uses private channel key to protect the traffic
1158 on the channel. When this mode is set the client will be
1159 responsible to set the key it wants to use to encrypt and
1160 decrypt the traffic on channel. Server generated channel
1161 keys are not used at all. This mode provides additional
1162 security as clients on channel may agree to use private
1163 channel key that even servers do not know. Naturally,
1164 this requires that every client on the channel knows
1165 the key before hand (it is considered to be pre-shared-
1166 key). The key material is RECOMMENDED to be processed
1167 as stated in the [SILC3] in the section Processing the
1170 As it is local setting it is possible to have several
1171 private channel keys on one channel. In this case several
1172 clients can talk on same channel but only those clients
1173 that share the key with the message sender will be able
1174 to hear the talking. Client SHOULD NOT display those
1175 message for the end user that it is not able to decrypt
1176 when this mode is set.
1178 Only channel founder MAY set/unset this mode. If this
1179 mode is unset the server will distribute new channel
1180 key to all clients on the channel which will be used
1183 Typical implementation would use [+|-]k on user interface
1184 to set/unset this mode.
1187 0x00000008 SILC_CMODE_INVITE
1189 Channel is invite only channel. Client may join to this
1190 channel only if it is invited to the channel. Channel
1191 founder and channel operator MAY set/unset this mode.
1193 Typical implementation would use [+|-]i on user interface
1194 to set/unset this mode.
1197 0x00000010 SILC_CMODE_TOPIC
1199 The topic of the channel may only be set by client that
1200 is channel founder or channel operator. Normal clients
1201 on channel will not be able to set topic when this mode
1202 is set. Channel founder and channel operator MAY set/
1205 Typical implementation would use [+|-]t on user interface
1206 to set/unset this mode.
1209 0x00000020 SILC_CMODE_ULIMIT
1211 User limit has been set to the channel. New clients
1212 may not join to the channel when the limit set is
1213 reached. Channel founder and channel operator MAY set/
1214 unset the limit. The <user limit> argument is the
1215 number of limited users.
1217 Typical implementation would use [+|-]l on user interface
1218 to set/unset this mode.
1221 0x00000040 SILC_CMODE_PASSPHRASE
1223 Passphrase has been set to the channel. Client may
1224 join to the channel only if it is able to provide the
1225 correct passphrase. Setting passphrases to channel
1226 is entirely safe as all commands are protected in the
1227 SILC network. Only channel founder MAY set/unset
1228 the passphrase. The <passphrase> argument is the
1231 Typical implementation would use [+|-]a on user interface
1232 to set/unset this mode.
1235 0x00000080 SILC_CMODE_CIPHER
1237 Sets specific cipher to be used to protect channel
1238 traffic. The <cipher> argument is the requested cipher.
1239 When set or unset the server must re-generate new
1240 channel key. Only channel founder MAY set the cipher of
1241 the channel. When unset the new key is generated using
1242 default cipher for the channel.
1244 Typical implementation would use [+|-]c on user interface
1245 to set/unset this mode.
1248 0x00000100 SILC_CMODE_HMAC
1250 Sets specific hmac to be used to compute the MACs of the
1251 channel message. The <hmac> argument is the requested hmac.
1252 Only channel founder may set the hmac of the channel.
1254 Typical implementation would use [+|-]h on user interface
1255 to set/unset this mode.
1258 0x00000200 SILC_CMODE_FOUNDER_AUTH
1260 Channel founder may set this mode to be able to regain
1261 channel founder rights even if the client leaves the
1262 channel. The <auth payload> is the Authentication Payload
1263 consisting of the authentication method and authentication
1264 data to be used in the authentication. The server MUST
1265 NOT accept NONE authentication method. Also, if the
1266 method is public key authentication the server MUST NOT
1267 save the authentication data from the payload as the
1268 data is different on all authentications. In this case the
1269 server only saves the authentication method. However,
1270 server MUST verify the sent authentication payload and
1271 set the mode only if the verification was successful.
1273 Note that this mode is effective only in the current server.
1274 The client MUST connect to the same server later to be able
1275 to regain the channel founder rights. The server MUST save
1276 the public key of the channel founder and use that to identify
1277 the client which is claiming the channel founder rights.
1278 The rights may be claimed by the SILC_CUMODE_FOUNDER
1279 channel user mode using SILC_COMMAND_CUMODE command. The
1280 set authentication data remains valid as long as the channel
1281 exists or until the founder unsets this mode.
1283 Typical implementation would use [+|-]f on user interface
1284 to set/unset this mode.
1287 0x00000400 SILC_CMODE_SILENCE_USERS
1289 Channel founder may set this mode to silence normal users
1290 on the channel. Users with operator privileges are not
1291 affected by this mode. Messages sent by normal users
1292 are dropped by servers when this mode is set. This mode
1293 can be used to moderate the channel. Only channel founder
1294 may set/unset this mode.
1297 0x00000800 SILC_CMODE_SILENCE_OPERS
1299 Channel founder may set this mode to silence operators
1300 on the channel. When used with SILC_CMODE_SILENCE_USERS
1301 mode this can be used to set the channel in state where only
1302 the founder of the channel may send messages to the channel.
1303 Messages sent by operators are dropped by servers when this
1304 mode is set. Only channel founder may set/unset this mode.
1307 To make the mode system work, client MUST keep the channel mode
1308 mask locally so that the mode setting and unsetting would work
1309 without problems. The client receives the initial channel mode
1310 mask when it joins to the channel. When the mode changes on
1311 channel the server MUST distribute the changed channel mode mask
1312 to all clients on the channel by sending the notify type
1313 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1314 to the server's primary router.
1316 Reply messages to the command:
1319 Arguments: (1) <Status Payload> (2) <Channel ID>
1320 (3) <channel mode mask>
1322 This command replies with the changed channel mode mask that
1323 client MUST keep locally.
1328 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1329 SILC_STATUS_ERR_TOO_MANY_PARAMS
1330 SILC_STATUS_ERR_NOT_REGISTERED
1331 SILC_STATUS_ERR_NOT_ON_CHANNEL
1332 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1333 SILC_STATUS_ERR_BAD_CHANNEL_ID
1334 SILC_STATUS_ERR_NO_CHANNEL_ID
1335 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1336 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1337 SILC_STATUS_ERR_UNKNOWN_MODE
1338 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1339 SILC_STATUS_ERR_AUTH_FAILED
1342 18 SILC_COMMAND_CUMODE
1345 Arguments: (1) <Channel ID> (2) <mode mask>
1346 (3) <Client ID> (4) [<auth payload>]
1348 This command is used by client to change channel user modes on
1349 channel. Users on channel may have some special modes and this
1350 command is used by channel operators to set or change these modes.
1351 The <Channel ID> is the ID of the target channel. The <mode mask>
1352 is OR'ed mask of modes. The <Client ID> is the target client.
1353 The client changing channel user modes MUST be on the same channel
1354 as the target client and poses sufficient privileges to be able to
1357 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1358 type is distributed to the channel.
1360 The following channel modes are defined:
1362 0x00000000 SILC_CUMODE_NONE
1364 No specific mode. This is the normal situation for client.
1365 Also, this is the mode set when removing all modes from
1369 0x00000001 SILC_CUMODE_FOUNDER
1371 The client is channel founder of the channel. Usually this
1372 mode is set only by the server when the channel was created.
1373 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1374 been set, the client can claim channel founder privileges
1375 by providing the <auth payload> that the server will use
1376 to authenticate the client. The public key that server will
1377 use to verify the <auth payload> must the same public key
1378 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1379 mode was set. The client MAY remove this mode at any time.
1382 0x00000002 SILC_CUMODE_OPERATOR
1384 Sets channel operator privileges on the channel for a
1385 client on the channel. Channel founder and channel operator
1386 MAY set/unset this mode. The client MAY remove this mode
1390 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1392 Marks that the client wishes not to receive any channel
1393 messages sent for the channel. Client MAY set and unset
1394 this mode to itself. Client MUST NOT set it to anyone else.
1395 When this mode is set server MUST NOT deliver channel
1396 messages to this client. Other packets such as channel
1397 key packets are still sent to the client.
1399 A separate service could provide additional filtering
1400 features for accepting channel messages from certain
1401 sender. However, this document does not specify such
1405 Reply messages to the command:
1408 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1409 (3) <Channel ID> (4) <Client ID>
1411 This command replies with the changed channel user mode mask that
1412 client MUST keep locally. The <Channel ID> is the specified
1413 channel. The <Client ID> is the target client.
1418 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1419 SILC_STATUS_ERR_TOO_MANY_PARAMS
1420 SILC_STATUS_ERR_NOT_REGISTERED
1421 SILC_STATUS_ERR_NOT_ON_CHANNEL
1422 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1423 SILC_STATUS_ERR_BAD_CHANNEL_ID
1424 SILC_STATUS_ERR_NO_CHANNEL_ID
1425 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1426 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1427 SILC_STATUS_ERR_UNKNOWN_MODE
1428 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1429 SILC_STATUS_ERR_AUTH_FAILED
1432 19 SILC_COMMAND_KICK
1435 Arguments: (1) <Channel ID> (2) <Client ID>
1438 This command is used by channel operators to remove a client from
1439 channel. The <channel> argument is the channel the client to be
1440 removed is on currently. Note that the "kicker" must be on the same
1441 channel. If <comment> is provided it will be sent to the removed
1444 After kicking the client the server MUST send the notify type
1445 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1446 The channel key MUST also be re-generated after kicking, unless
1447 the SILC_CMODE_PRIVKEY mode is set.
1449 Reply messages to the command:
1452 Arguments: (1) <Status Payload>
1454 This command replies only with Status Payload.
1459 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1460 SILC_STATUS_ERR_TOO_MANY_PARAMS
1461 SILC_STATUS_ERR_NOT_REGISTERED
1462 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1463 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1464 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1465 SILC_STATUS_ERR_NO_CLIENT_ID
1471 Arguments: (1) <Channel ID> (2) [<adding client>]
1472 (3) [<removing client>]
1474 This command is used to manage the ban list of the channel
1475 indicated by the <Channel ID>. A client that is banned from
1476 channel is no longer able to join the channel. The client which
1477 is executing this command MUST have at least channel operator
1478 privileges on the channel.
1480 The <adding client> and <removing client> are used to add to and
1481 remove from the ban list. The format of the <adding client> and
1482 the <removing client> is of following format:
1484 [<nickname>[@<server>]!][<username>]@[<hostname>]
1486 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1487 primary router after adding to or removing from the ban list.
1488 The wildcards MAY be used with this command. If adding or removing
1489 from than one clients then the lists are an comma (`,') separated.
1491 If this command is executed without the ban arguments the command
1492 merely replies with the current ban list.
1495 Reply messages to the command:
1498 Arguments: (1) <Status Payload> (2) <Channel ID>
1501 This command replies with the <Channel ID> of the channel and
1502 the current <ban list> of the channel if it exists.
1507 SILC_STATUS_ERR_NOT_REGISTERED
1508 SILC_STATUS_ERR_TOO_MANY_PARAMS
1509 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1510 SILC_STATUS_ERR_NO_CHANNEL_ID
1511 SILC_STATUS_ERR_NOT_ON_CHANNEL
1512 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1515 21 <deprecated command>
1518 22 <deprecated command>
1521 23 SILC_COMMAND_SILCOPER
1524 Arguments: (1) <username> (2) <authentication payload>
1526 This command is used by normal client to obtain router operator
1527 privileges (also known as SILC operator) on the router. Note
1528 that router operator has privileges that supersedes the server
1529 operator privileges.
1531 The <username> is the username set in the server configurations
1532 as operator. The <authentication payload> is the data that the
1533 client is authenticated against. It may be passphrase prompted
1534 for user on client's screen or it may be public key or certificate
1535 authentication data (data signed with private key). The public
1536 key that router will use to verify the signature found in the
1537 payload should be verified. It is recommended that the public
1538 key is saved locally in the router and router would not use
1539 any public keys received during the SKE.
1541 Difference between router operator and server operator is that
1542 router operator is able to handle cell level properties while
1543 server operator (even on router server) is able to handle only
1544 local properties, such as, local connections and normal server
1545 administration. The router operator is also able to use the
1546 SILC_COMMAND_KILL command.
1548 After changing the mode server MUST send the notify type
1549 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1551 Reply messages to the command:
1554 Arguments: (1) <Status Payload>
1556 This command replies only with Status Payload.
1561 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1562 SILC_STATUS_ERR_TOO_MANY_PARAMS
1563 SILC_STATUS_ERR_NOT_REGISTERED
1564 SILC_STATUS_ERR_AUTH_FAILED
1567 24 SILC_COMMAND_LEAVE
1570 Arguments: (1) <Channel ID>
1572 This command is used by client to leave a channel the client is
1575 When leaving channel the server MUST send the notify type
1576 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1577 The channel key MUST also be re-generated when leaving the channel
1578 and distribute it to all clients still currently on the channel.
1579 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1582 Reply messages to the command:
1585 Arguments: (1) <Status Payload> (2) <Channel ID>
1587 The <Channel ID> is the ID of left channel.
1592 SILC_STATUS_ERR_NOT_REGISTERED
1593 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1594 SILC_STATUS_ERR_TOO_MANY_PARAMS
1595 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1596 SILC_STATUS_ERR_BAD_CHANNEL_ID
1597 SILC_STATUS_ERR_NO_CHANNEL_ID
1600 25 SILC_COMMAND_USERS
1603 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1605 This command is used to list user names currently on the requested
1606 channel; either the argument <Channel ID> or the <channel name>.
1607 One of these arguments must be present. The server MUST resolve
1608 the user names and send a comma (`,') separated list of user names
1609 on the channel. Server or router MAY resolve the names by sending
1610 SILC_COMMAND_WHOIS or SILC_COMMAND_IDENTIFY commands.
1612 If the requested channel is a private or secret channel, this
1613 command MUST NOT send the list of users, as private and secret
1614 channels cannot be seen by outside. In this case the returned
1615 name list MAY include a indication that the server could not
1616 resolve the names of the users on the channel. Also, in this case
1617 Client ID's or client modes are not sent either.
1619 Reply messages to the command:
1622 Arguments: (1) <Status Payload> (2) <Channel ID>
1623 (3) <list count> (4) <Client ID list>
1624 (5) <client mode list>
1626 This command replies with the Channel ID of the requested channel
1627 Client ID list of the users on the channel and list of their modes.
1628 The Client ID list has Client ID's of all users in the list. The
1629 <Client ID list> is formed by adding Client ID's one after another.
1630 The <client mode list> is formed by adding client's user modes on
1631 the channel one after another (4 bytes (32 bits) each). The <list
1632 count> of length of 4 bytes (32 bits), tells the number of entries
1633 in the lists. Both lists MUST have equal number of entries.
1638 SILC_STATUS_ERR_NOT_REGISTERED
1639 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1640 SILC_STATUS_ERR_TOO_MANY_PARAMS
1641 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1642 SILC_STATUS_ERR_BAD_CHANNEL_ID
1643 SILC_STATUS_ERR_NO_CHANNEL_ID
1644 SILC_STATUS_ERR_NOT_ON_CHANNEL
1647 26 SILC_COMMAND_GETKEY
1650 Arguments: (1) <ID Payload>
1652 This command is used to fetch the public key of the client or
1653 server indicated by the <ID Payload>. The public key is fetched
1654 from the server where to the client is connected.
1656 Reply messages to the command:
1659 Arguments: (1) <Status Payload> (2) <ID Payload>
1660 (3) [<Public Key Payload>]
1662 This command replies with the client's or server's ID and with
1663 the <Public Key Payload>.
1668 SILC_STATUS_ERR_NOT_REGISTERED
1669 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1670 SILC_STATUS_ERR_TOO_MANY_PARAMS
1671 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1672 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1677 Currently undefined commands.
1682 These commands are reserved for private use and will not be defined
1686 255 SILC_COMMAND_MAX
1688 Reserved command. This must not be sent.
1693 2.3 SILC Command Status Types
1696 2.3.1 SILC Command Status Payload
1698 Command Status Payload is sent in command reply messages to indicate
1699 the status of the command. The payload is one of argument in the
1700 command thus this is the data area in Command Argument Payload described
1701 in [SILC2]. The payload is only 2 bytes of length. The following diagram
1702 represents the Command Status Payload (field is always in MSB order).
1708 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1709 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1711 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1715 Figure 6: SILC Command Status Payload
1719 o Status (1 byte) - Indicates the status message type,
1720 error, start of list, entry of list or end of list.
1722 o Error (1 byte) - Indicates the error if the Status
1723 field is some list status, which means there are list
1727 The values in Status and Error fields are set according
1728 the following rules:
1731 o If there is single reply and error has not occurred
1732 then Status field includes value SILC_STATUS_OK, and
1733 the Error field MUST be ignored (and set to zero
1736 o If there is single error, then Status field includes
1737 one of the error values, and the Error field MUST be
1738 ignored (and set to zero value).
1740 o If there will be multiple successful command replies
1741 then Status field includes SILC_STATUS_LIST_START,
1742 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1743 and Error field is set to SILC_STATUS_OK.
1745 o If there are multiple error replies then Status field
1746 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1747 or SILC_STATUS_LIST_END value, and the Error field
1748 includes the error value.
1751 This way it is possible to send single successful or
1752 single error reply, but also multiple successful and
1753 multiple error replies. Note that it is possible to
1754 send both list of successful replies and list of error
1755 replies at the same time, however in this case the
1756 list of error replies MUST be sent after the successful
1757 replies. This way the recipient may ignore the multiple
1758 errors if it wishes to do so.
1760 All Status messages are described in the next section.
1764 2.3.2 SILC Command Status List
1766 Command Status messages are returned in the command reply messages
1767 to indicate whether the command were executed without errors. If error
1768 has occurred the status indicates which error occurred. Status payload
1769 only sends numeric reply about the status. Receiver of the payload must
1770 convert the numeric values into human readable error messages. The
1771 list of status messages below has an example human readable error
1772 messages that client may display for the user.
1774 List of all defined command status messages following.
1777 Generic status messages:
1781 Ok status. Everything went Ok. The status payload maybe
1782 safely ignored in this case.
1784 1 SILC_STATUS_LIST_START
1786 Start of the list. There will be several command replies and
1787 this reply is the start of the list.
1789 2 SILC_STATUS_LIST_ITEM
1791 Item in the list. This is one of the item in the list but not the
1794 3 SILC_STATUS_LIST_END
1796 End of the list. There were several command replies and this
1797 reply is the last of the list. There won't be other replies
1798 belonging to this list after this one.
1802 Currently undefined and has been reserved for the future.
1805 Error status message:
1809 10 SILC_STATUS_ERR_NO_SUCH_NICK
1811 "No such nickname". Requested nickname does not exist.
1813 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1815 "No such channel". Requested channel name does not exist.
1817 12 SILC_STATUS_ERR_NO_SUCH_SERVER
1819 "No such server". Requested server name does not exist.
1821 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
1823 "Duplicate recipients. No message delivered". Message were
1824 tried to be sent to recipient which has several occurrences in
1827 14 SILC_STATUS_ERR_NO_RECIPIENT
1829 "No recipient given". Command required recipient which was
1832 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
1834 "Unknown command". Command sent to server is unknown by the
1837 16 SILC_STATUS_ERR_WILDCARDS
1839 "Wildcards cannot be used". Wildcards were provided but they
1842 17 SILC_STATUS_ERR_NO_CLIENT_ID
1844 "No Client ID given". Client ID were expected as command
1845 parameter but were not found.
1847 18 SILC_STATUS_ERR_NO_CHANNEL_ID
1849 "No Channel ID given". Channel ID were expected as command
1850 parameter but were not found.
1852 19 SILC_STATUS_ERR_NO_SERVER_ID
1854 "No Serve ID given". Server ID were expected as command
1855 parameter but were not found.
1857 20 SILC_STATUS_ERR_BAD_CLIENT_ID
1859 "Bad Client ID". Client ID provided were erroneous.
1861 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
1863 "Bad Channel ID". Channel ID provided were erroneous.
1865 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1867 "No such Client ID". Client ID provided does not exist.
1869 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1871 "No such Channel ID". Channel ID provided does not exist.
1873 24 SILC_STATUS_ERR_NICKNAME_IN_USE
1875 "Nickname already exists". Nickname created could not be
1876 registered because number of same nicknames were already set to
1877 maximum. This is not expected to happen in real life but is
1880 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
1882 "You are not on that channel". The command were specified for
1883 channel user is not currently on.
1885 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1887 "They are not on channel". The requested target client is not
1888 on requested channel.
1890 27 SILC_STATUS_ERR_USER_ON_CHANNEL
1892 "User already on channel". User were invited on channel they
1895 28 SILC_STATUS_ERR_NOT_REGISTERED
1897 "You have not registered". User executed command that requires
1898 the client to be registered on the server before it may be
1901 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1903 "Not enough parameters". Command requires more parameters
1906 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
1908 "Too many parameters". Too many parameters were provided
1911 31 SILC_STATUS_ERR_PERM_DENIED
1913 "Permission denied". Generic permission denied error status
1914 to indicate disallowed access.
1916 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
1918 "You are banned from this server". The client tried to register
1919 on server that has explicitly denied this host to connect.
1921 33 SILC_STATUS_ERR_BAD_PASSWORD
1923 "Cannot join channel. Incorrect password". Password provided for
1924 channel were not accepted.
1926 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
1928 "Cannot join channel. Channel is full". The channel is full
1929 and client cannot be joined to it.
1931 35 SILC_STATUS_ERR_NOT_INVITED
1933 "Cannot join channel. You have not been invited". The channel
1934 is invite only channel and client has not been invited.
1936 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1938 "Cannot join channel. You have been banned". The client has
1939 been banned from the channel.
1941 37 SILC_STATUS_ERR_UNKNOWN_MODE
1943 "Unknown mode". Mode provided by the client were unknown to
1946 38 SILC_STATUS_ERR_NOT_YOU
1948 "Cannot change mode for other users". User tried to change
1949 someone else's mode.
1951 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1953 "Permission denied. You are not channel operator". Command may
1954 be executed only by channel operator.
1956 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1958 "Permission denied. You are not channel founder". Command may
1959 be executed only by channel operator.
1961 41 SILC_STATUS_ERR_NO_SERVER_PRIV
1963 "Permission denied. You are not server operator". Command may
1964 be executed only by server operator.
1966 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
1968 "Permission denied. You are not SILC operator". Command may be
1969 executed only by router (SILC) operator.
1971 43 SILC_STATUS_ERR_BAD_NICKNAME
1973 "Bad nickname". Nickname requested contained illegal characters
1976 44 SILC_STATUS_ERR_BAD_CHANNEL
1978 "Bad channel name". Channel requested contained illegal characters
1981 45 SILC_STATUS_ERR_AUTH_FAILED
1983 "Authentication failed". The authentication data sent as
1984 argument were wrong and thus authentication failed.
1986 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
1988 "The algorithm was not supported." The server does not support the
1989 requested algorithm.
1991 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1993 "No such Server ID". Server ID provided does not exist.
1999 3 Security Considerations
2001 Security is central to the design of this protocol, and these security
2002 considerations permeate the specification. Common security considerations
2003 such as keeping private keys truly private and using adequate lengths for
2004 symmetric and asymmetric keys must be followed in order to maintain the
2005 security of this protocol.
2011 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2012 Protocol Specification", Internet Draft, April 2001.
2014 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2017 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2018 Protocols", Internet Draft, April 2001.
2020 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2023 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2026 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2029 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2032 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2035 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2038 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2041 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2044 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2045 Infrastructure, Certificate and CRL Profile", RFC 2459,
2048 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2049 John Wiley & Sons, New York, NY, 1996.
2051 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2054 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2055 RFC 2412, November 1998.
2057 [ISAKMP] Maughan D., et al, "Internet Security Association and
2058 Key Management Protocol (ISAKMP)", RFC 2408, November
2061 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2062 (IKE)", RFC 2409, November 1998.
2064 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2065 Authentication", RFC 2104, February 1997.
2067 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2068 Specifications, Version 2.0", RFC 2437, October 1998.
2070 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2071 Requirement Levels", BCP 14, RFC 2119, March 1997.
2073 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2074 10646", RFC 2279, January 1998.
2085 Snellmanninkatu 34 A 15
2089 EMail: priikone@iki.fi
2091 This Internet-Draft expires XXX