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) [<Requested Attributes>] (4) [<Client ID>]
234 Whois command is used to query various information about specific
235 user. The user may be requested by their nickname and server name.
236 The query may find multiple matching users as there are no unique
237 nicknames in the SILC. The <count> option may be given to narrow
238 down the number of accepted results. If this is not defined there
239 are no limit of accepted results. The query may also be narrowed
240 down by defining the server name of the nickname. The <count> is
241 32 bit MSB first order integer.
243 It is also possible to search the user by Client ID. If the
244 <Client ID> is provided server MUST use it as the search value
245 instead of the <nickname>. One of the arguments MUST be given.
246 It is also possible to define multiple Client ID's to search
247 multiple users sending only one WHOIS command. In this case the
248 Client ID's are appended as normal arguments.
250 To prevent miss-use of this command wildcards in the nickname
251 or in the server name are not permitted. It is not allowed
252 to request all users on some server. The WHOIS requests MUST
253 be based on explicit nickname request.
255 The WHOIS request MUST be always sent to the router by server
256 so that all users are searched. However, the server still MUST
257 search its locally connected clients. The router MUST send
258 this command to the server which owns the requested client. That
259 server MUST reply to the command. Server MUST NOT send whois
260 replies to the client until it has received the reply from its
263 The <Requested Attributes> is defined in [ATTRS] and can be used
264 to request various information about the client.
266 Reply messages to the command:
269 Arguments: (1) <Status Payload> (2) <Client ID>
270 (3) <nickname>[@<server>] (4) <username@host>
271 (5) <real name> (6) [<Channel Payload
273 (7) [<user mode>] (8) [<idle time>]
274 (9) [<fingerprint>] (10) <channel user
278 This command may reply with several command reply messages to
279 form a list of results. In this case the status payload will
280 include STATUS_LIST_START status in the first reply and
281 STATUS_LIST_END in the last reply to indicate the end of the
282 list. If there are only one reply the status is set to normal
285 The command replies include the Client ID of the nickname,
286 nickname and server name, user name and host name and user's real
287 name. Client SHOULD process these replies only after the last
288 reply has been received with the STATUS_LIST_END status. If the
289 <count> option were defined in the query there will be only
290 <count> many replies from the server.
292 The server returns the list of channels if the client has
293 joined channels. In this case the list is list of Channel
294 Payloads. The Mode Mask in the Channel Payload is the channel's
295 mode. The list is encoded by adding the Channel Payloads one
296 after the other. Private and secret channels MUST NOT be sent,
297 except if the sender of this command is on those channels, or
298 the sender is server. The <channel user mode list> MUST also
299 be sent if client is joined channels. This list includes 32 bit
300 MSB first order values one after the other and each indicate
301 the user's mode on a channel. The order of these values MUST
302 be same as the channel order in the <Channel Payload list>.
304 The server also returns client's user mode, idle time, and the
305 fingerprint of the client's public key. The <fingerprint> is the
306 binary hash digest of the public key. The fingerprint MUST NOT
307 be sent if the server has not verified the proof of posession of
308 the corresponding private key. Server can do this during the
309 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
314 SILC_STATUS_LIST_START
316 SILC_STATUS_ERR_NO_SUCH_NICK
317 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
318 SILC_STATUS_ERR_WILDCARDS
319 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
320 SILC_STATUS_ERR_TOO_MANY_PARAMS
323 2 SILC_COMMAND_WHOWAS
326 Arguments: (1) <nickname>[@<server>] (2) [<count>]
328 Whowas. This command is used to query history information about
329 specific user. The user may be requested by their nickname and
330 server name. The query may find multiple matching users as there
331 are no unique nicknames in the SILC. The <count> option may be
332 given to narrow down the number of accepted results. If this
333 is not defined there are no limit of accepted results. The query
334 may also be narrowed down by defining the server name of the
335 nickname. The <count> is 32 bit MSB first order integer.
337 To prevent miss-use of this command wildcards in the nickname
338 or in the server name are not permitted. The WHOWAS requests MUST
339 be based on specific nickname request.
341 The WHOWAS request MUST be always sent to the router by server
342 so that all users are searched. However, the server still must
343 search its locally connected clients.
345 Reply messages to the command:
348 Arguments: (1) <Status Payload> (2) <Client ID>
349 (3) <nickname>[@<server>] (4) <username@host>
352 This command may reply with several command reply messages to form
353 a list of results. In this case the status payload will include
354 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
355 the last reply to indicate the end of the list. If there are only
356 one reply the status is set to normal STATUS_OK.
358 The command replies with nickname and user name and host name.
359 Every server MUST keep history for some period of time of its
360 locally connected clients.
365 SILC_STATUS_LIST_START
367 SILC_STATUS_ERR_NO_SUCH_NICK
368 SILC_STATUS_ERR_WILDCARDS
369 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
370 SILC_STATUS_ERR_TOO_MANY_PARAMS
373 3 SILC_COMMAND_IDENTIFY
376 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
377 (3) [<channel name>] (4) [<count>]
378 (5) [<ID Payload>] (n) [...]
380 Identify command is used to query information about an entity by
381 the entity's name or ID. This command can be used to query
382 information about clients, server and channels.
384 The query may find multiple matching entities. The <count> option
385 may be given to narrow down the number of accepted results. If
386 this is not defined there are no limit of accepted results. The
387 <count> is 32 bit MSB first order integer.
389 It is also possible to search the entity by its ID. If the
390 <ID Payload> is provided server must use it as the search value
391 instead of the entity's name. One of the arguments must be given.
392 It is also possible to define multiple ID Payloads to search
393 multiple entities sending only one IDENTIFY command. In this case
394 the ID Payloads are appended as normal arguments. The type of the
395 entity is defined by the type of the ID Payload.
397 To prevent miss-use of this command wildcards in the names are
398 not permitted. It is not allowed to request for example all users
401 Implementations may not want to give interface access to this
402 command as it is hardly a command that would be used by an end
403 user. However, it must be implemented as it is used with private
406 The IDENTIFY command MUST be always sent to the router by server
407 so that all users are searched. However, server MUST still search
408 its locally connected clients.
410 Reply messages to the command:
413 Arguments: (1) <Status Payload> (2) <ID Payload>
414 (3) [<entity's name>] (4) [<info>]
416 This command may reply with several command reply messages to form
417 a list of results. In this case the status payload will include
418 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
419 the last reply to indicate the end of the list. If there are only
420 one reply the status is set to normal STATUS_OK.
422 When querying clients the <entity's name> must include the client's
423 nickname in the following format: nickname[@server]. The
424 <info> must include the client's username and host in the following
425 format: username@host.
427 When querying servers the <entity's name> must include the server's
428 full name. The <info> may be omitted.
430 When querying channels the <entity's name> must include the
431 channel's name. The <info> may be omitted.
433 If the <count> option were defined in the query there will be only
434 <count> many replies from the server.
439 SILC_STATUS_LIST_START
441 SILC_STATUS_ERR_NO_SUCH_NICK
442 SILC_STATUS_ERR_NO_SUCH_SERVER
443 SILC_STATUS_ERR_NO_SUCH_CHANNEL
444 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
445 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
446 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
447 SILC_STATUS_ERR_WILDCARDS
448 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
449 SILC_STATUS_ERR_TOO_MANY_PARAMS
455 Arguments: (1) <nickname>
457 Set/change nickname. This command is used to set nickname for
458 user. Nickname MUST NOT include any spaces (` '), non-printable
459 characters, commas (`,') and any wildcard characters. Note that
460 nicknames in SILC are case-sensitive which must be taken into
461 account when searching clients by nickname.
463 When nickname is changed new Client ID is generated. Server MUST
464 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
465 channels (if any) the client is joined on. Then it MUST send
466 SILC_PACKET_REPLACE_ID to its primary route to replace the old
467 Client ID with the new one.
469 Reply messages to the command:
472 Arguments: (1) <Status Payload> (2) <New ID Payload>
474 This command is replied always with New ID Payload that is
475 generated by the server every time user changes their nickname.
476 Client receiving this payload MUST start using the received
477 Client ID as its current valid Client ID. The New ID Payload
478 is described in [SILC2].
483 SILC_STATUS_ERR_WILDCARDS
484 SILC_STATUS_ERR_NICKNAME_IN_USE
485 SILC_STATUS_ERR_BAD_NICKNAME
486 SILC_STATUS_ERR_NOT_REGISTERED
487 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
488 SILC_STATUS_ERR_TOO_MANY_PARAMS
494 Arguments: (1) [<Channel ID>]
496 The list command is used to list channels and their topics on the
497 current server. If the <Channel ID> parameter is used, only the
498 status of that channel is displayed. Secret channels are not
499 listed at all. Private channels are listed with status indicating
500 that the channel is private. Router MAY reply with all channels
503 Reply messages to the command:
506 Arguments: (1) <Status Payload> (2) <Channel ID>
507 (3) <channel> (4) [<topic>]
510 This command may reply with several command reply messages to form
511 a list of results. In this case the status payload will include
512 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
513 the last reply to indicate the end of the list. If there are only
514 one reply the status is set to normal STATUS_OK.
516 This command replies with Channel ID, name and the topic of the
517 channel. If the channel is private channel the <topic> SHOULD
518 include the "*private*" string.
523 SILC_STATUS_LIST_START
525 SILC_STATUS_ERR_WILDCARDS
526 SILC_STATUS_ERR_NOT_REGISTERED
527 SILC_STATUS_ERR_TOO_MANY_PARAMS
528 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
529 SILC_STATUS_ERR_NO_CHANNEL_ID
530 SILC_STATUS_ERR_NO_SUCH_SERVER
536 Arguments: (1) <Channel ID> (2) [<topic>]
538 This command is used to change or view the topic of a channel.
539 The topic for channel <Channel ID> is returned if there is no
540 <topic> given. If the <topic> parameter is present, the topic
541 for that channel will be changed, if the channel modes permit
544 After setting the topic the server MUST send the notify type
545 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
546 the channel which topic was changed.
548 Reply messages to the command:
551 Arguments: (1) <Status Payload> (2) <Channel ID>
554 The command may reply with the topic of the channel if it is
560 SILC_STATUS_ERR_NOT_ON_CHANNEL
561 SILC_STATUS_ERR_WILDCARDS
562 SILC_STATUS_ERR_NOT_REGISTERED
563 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
564 SILC_STATUS_ERR_NO_SUCH_CHANNEL
565 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
566 SILC_STATUS_ERR_NO_CHANNEL_ID
567 SILC_STATUS_ERR_BAD_CHANNEL_ID
568 SILC_STATUS_ERR_TOO_MANY_PARAMS
569 SILC_STATUS_ERR_NO_CHANNEL_PRIV
572 7 SILC_COMMAND_INVITE
575 Arguments: (1) <Channel ID> (2) [<Client ID>]
576 (3) [<adding client>] (4) [<removing client>]
578 This command is used to invite other clients to join to the
579 channel. The <Client ID> argument is the target client's ID that
580 is being invited. The <Channel ID> is the Channel ID of the
581 requested channel. The sender of this command MUST be on the
582 channel. The server MUST also send the notify type
583 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
584 client indicated by the <Client ID>.
586 The <adding client> and <removing client> can be used to add to
587 and remove from the invite list. The format of the <adding client>
588 and <removing client> is as follows:
590 [<nickname>[@<server>]!][<username>]@[<hostname>]
592 When adding to or removing from the invite list the server MUST
593 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
594 and MUST NOT send it to the client which was added to the list.
595 The client which executes this command MUST have at least channel
596 operator privileges to be able to add to or remove from the invite
597 list. The wildcards MAY be used with this command. If adding or
598 removing more than one client then the lists are an comma (`,')
601 Note that the <Client ID> provided MUST be resolved into correct
602 nickname and host name and add to the invite list before sending
605 When this command is given with only <Channel ID> argument then
606 the command merely returns the invite list of the channel. This
607 command MUST fail if the requested channel does not exist, the
608 requested <Client ID> is already on the channel or if the channel
609 is invite only channel and the caller of this command does not
610 have at least channel operator privileges.
612 Reply messages to the command:
615 Arguments: (1) <Status Payload> (2) <Channel ID>
618 This command replies with the invite list of the channel if it
624 SILC_STATUS_ERR_NOT_REGISTERED
625 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
626 SILC_STATUS_ERR_TOO_MANY_PARAMS
627 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
628 SILC_STATUS_ERR_NO_CLIENT_ID
629 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
630 SILC_STATUS_ERR_NO_CHANNEL_ID
631 SILC_STATUS_ERR_NOT_ON_CHANNEL
632 SILC_STATUS_ERR_USER_ON_CHANNEL
633 SILC_STATUS_ERR_NO_CHANNEL_PRIV
639 Arguments: (1) [<quit message>]
641 This command is used by client to end SILC session. The server
642 must close the connection to a client which sends this command.
643 if <quit message> is given it will be sent to other clients on
644 channel if the client is on channel when quitting.
646 Reply messages to the command:
648 This command does not reply anything.
654 Arguments: (1) <Client ID> (2) [<comment>]
656 This command is used by SILC operators to remove a client from
657 SILC network. The removing has temporary effects and client may
658 reconnect to SILC network. The <Client ID> is the client to be
659 removed from SILC. The <comment> argument may be provided to
660 give to the removed client some information why it was removed
663 When killing a client the router MUST first send notify type
664 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
665 The packet MUST NOT be sent to the killed client on the channels.
666 Then, the router MUST send the same notify type to its primary
667 router. Finally, the router MUST send the same notify type
668 directly to the client which was killed.
670 Reply messages to the command:
673 Arguments: (1) <Status Payload>
675 This command replies only with Status Payload.
680 SILC_STATUS_ERR_WILDCARDS
681 SILC_STATUS_ERR_NOT_REGISTERED
682 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
683 SILC_STATUS_ERR_TOO_MANY_PARAMS
684 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
685 SILC_STATUS_ERR_NO_CLIENT_ID
686 SILC_STATUS_ERR_NO_ROUTER_PRIV
692 Arguments: (1) [<server>] (2) [<Server ID>]
694 This command is used to fetch various information about a server.
695 If <server> argument is specified the command MUST be sent to
696 the requested server.
698 If the <Server ID> is specified the server information if fetched
699 by the provided Server ID. One of the arguments must always be
702 Reply messages to the command:
705 Arguments: (1) <Status Payload> (2) <Server ID>
706 (3) <server name> (4) <string>
708 This command replies with the Server ID of the server and a
709 string which tells the information about the server.
714 SILC_STATUS_ERR_WILDCARDS
715 SILC_STATUS_ERR_NOT_REGISTERED
716 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
717 SILC_STATUS_ERR_TOO_MANY_PARAMS
718 SILC_STATUS_ERR_NO_SUCH_SERVER
719 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
720 SILC_STATUS_ERR_NO_SERVER_ID
723 11 SILC_COMMAND_STATS
726 Arguments: (1) <Server ID>
728 This command is used to fetch various statistical information
729 from the server indicated by <Server ID>, which is the ID of
730 server where sender is connected to. Server receiving this
731 command MAY also send this further to its router for fetching
732 other cell and network wide statistics to accompany the reply.
734 Reply messages to the command:
737 Arguments: (1) <Status Payload> (2) <Server ID>
738 (3) [<statistics structure>]
740 This command replies with the Server ID of the server and
741 optional statistics structure which includes 32 bit MSB first
742 ordered integer values to represent various statistical
743 information. The structure is as follows:
745 starttime - time when server was started
746 uptime - uptime of the server
747 my clients - number of locally connected clients
748 my channels - number of locally created channels
749 my server ops - number of local server operators
750 my router ops - number of local router operators
751 cell clients - number of clients in local cell
752 cell channels - number of channels in local cell
753 cell servers - number of servers in local cell
754 clients - number of client in SILC network
755 channels - number of channels in SILC network
756 servers - number of servers in SILC network
757 routers - number of routers in SILC network
758 server ops - number of server operators in SILC network
759 router ops - number of router operators in SILC network
761 If some value is unknown it is set to zero (0) value. The
762 "starttime" is the start time of the server, and is seconds
763 since Epoch (POSIX.1). The "uptime" is time difference of
764 current time and "starttime" in the server, and is seconds
770 SILC_STATUS_ERR_NOT_REGISTERED
771 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
772 SILC_STATUS_ERR_TOO_MANY_PARAMS
773 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
774 SILC_STATUS_ERR_NO_SUCH_SERVER
775 SILC_STATUS_ERR_NO_SERVER_ID
781 Arguments: (1) <Server ID>
783 This command is used by client and server to test the communication
784 channel to its server if one suspects that the communication is not
785 working correctly. The <Server ID> is the ID of the server the
786 sender is connected to.
788 Reply messages to the command:
791 Arguments: (1) <Status Payload>
793 This command replies only with Status Payload. Server returns
794 SILC_STATUS_OK in Status Payload if pinging was successful.
801 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
802 SILC_STATUS_ERR_TOO_MANY_PARAMS
803 SILC_STATUS_ERR_NO_SERVER_ID
804 SILC_STATUS_ERR_NO_SUCH_SERVER
805 SILC_STATUS_ERR_NOT_REGISTERED
811 Arguments: (1) <username> (2) <authentication payload>
813 This command is used by normal client to obtain server operator
814 privileges on some server or router. Note that router operator
815 has router privileges that supersedes the server operator
816 privileges and this does not obtain those privileges. Client
817 MUST use SILCOPER command to obtain router level privileges.
819 The <username> is the username set in the server configurations
820 as operator. The <authentication payload> is the data that the
821 client is authenticated against. It may be passphrase prompted
822 for user on client's screen or it may be public key or certificate
823 authentication data (data signed with private key). The public
824 key that server will use to verify the signature found in the
825 payload should be verified. It is recommended that the public
826 key is saved locally in the server and server would not use
827 any public keys received during the SKE.
829 After changing the mode the server MUST send the notify type
830 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
832 Reply messages to the command:
835 Arguments: (1) <Status Payload>
837 This command replies only with Status Payload.
842 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
843 SILC_STATUS_ERR_TOO_MANY_PARAMS
844 SILC_STATUS_ERR_NOT_REGISTERED
845 SILC_STATUS_ERR_AUTH_FAILED
851 Arguments: (1) <channel> (2) <Client ID>
852 (3) [<passphrase>] (4) [<cipher>]
853 (5) [<hmac>] (6) [<founder auth>]
855 Join to channel/create new channel. This command is used to
856 join to a channel. If the channel does not exist the channel is
857 created. If server is normal server this command MUST be sent
858 to router which will create the channel. The channel MAY be
859 protected with passphrase. If this is the case the passphrase
860 MUST be sent along the join command.
862 The name of the <channel> MUST NOT include any spaces (` '),
863 non-printable characters, commas (`,') or any wildcard characters.
865 The second argument <Client ID> is the Client ID of the client
866 which is joining to the client. When client sends this command
867 to the server the <Client ID> MUST be the client's own ID.
869 Cipher to be used to secure the traffic on the channel MAY be
870 requested by sending the name of the requested <cipher>. This
871 is used only if the channel does not exist and is created. If
872 the channel already exists the cipher set previously for the
873 channel will be used to secure the traffic. The computed MACs
874 of the channel message are produced by the default HMAC or by
875 the <hmac> provided for the command.
877 The <founder auth> is Authentication Payload providing the
878 authentication for gaining founder privileges on the channel
879 when joining the channel. The client may provide this if it
880 knows that it is the founder of the channel and that the
881 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
882 MUST verify whether the client is able to gain the founder
883 privileges the same way as the client had given the
884 SILC_COMMAND_CUMODE command to gain founder privileges. The
885 client is still able to join the channel even if the founder
886 privileges could not be gained.
888 The server MUST check whether the user is allowed to join to
889 the requested channel. Various modes set to the channel affect
890 the ability of the user to join the channel. These conditions
893 o The user MUST be invited to the channel if the channel
894 is invite-only channel.
896 o The Client ID/nickname/username/host name MUST NOT match
899 o The correct passphrase MUST be provided if passphrase
900 is set to the channel.
902 o The user count limit, if set, MUST NOT be reached.
904 If the client provided correct <founder auth> payload it can
905 override these conditions, except the condition for the passphrase.
906 The correct passphrase MUST be provided even if <founder auth>
909 Reply messages to the command:
912 Arguments: (1) <Status Payload> (2) <channel>
913 (3) <Channel ID> (4) <Client ID>
914 (5) <channel mode mask> (6) <created>
915 (7) [<Channel Key Payload>] (8) [<ban list>]
916 (9) [<invite list>] (10) [<topic>]
917 (11) [<hmac>] (12) <list count>
918 (13) <Client ID list> (14) <client mode list>
920 This command replies with the channel name requested by the
921 client, channel ID of the channel and topic of the channel
922 if it exists. The <Client ID> is the Client ID which was joined
923 to the channel. It also replies with the channel mode mask
924 which tells all the modes set on the channel. If the
925 channel is created the mode mask is zero (0). If ban mask
926 and/or invite list is set they are sent as well.
928 The <list count>, <Client ID list> and <client mode list> are
929 the clients currently on the channel and their modes on the
930 channel. The <Client ID list> is formed by adding the ID Payloads
931 one after the other. The <client mode list> is formed by adding
932 32 bit MSB first order values one after the other.
934 Client receives the channel key in the reply message as well
935 inside <Channel Key Payload>.
940 SILC_STATUS_ERR_WILDCARDS
941 SILC_STATUS_ERR_NOT_REGISTERED
942 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
943 SILC_STATUS_ERR_TOO_MANY_PARAMS
944 SILC_STATUS_ERR_BAD_PASSWORD
945 SILC_STATUS_ERR_CHANNEL_IS_FULL
946 SILC_STATUS_ERR_NOT_INVITED
947 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
948 SILC_STATUS_ERR_BAD_CHANNEL
949 SILC_STATUS_ERR_USER_ON_CHANNEL
955 Arguments: (1) <server>
957 This command is used to query the Message of the Day of the server.
959 Reply messages to the command:
962 Arguments: (1) <Status Payload> (2) <Server ID>
965 This command replies with the motd message if it exists.
970 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
971 SILC_STATUS_ERR_TOO_MANY_PARAMS
972 SILC_STATUS_ERR_NOT_REGISTERED
973 SILC_STATUS_ERR_NO_SUCH_SERVER
976 16 SILC_COMMAND_UMODE
979 Arguments: (1) <Client ID> (2) [<client mode mask>]
981 This command is used by client to set/unset modes for itself.
982 However, there are some modes that the client MUST NOT set itself,
983 but they will be set by server. However, client MAY unset any
984 mode. Modes may be masked together ORing them thus having
985 several modes set. Client MUST keep its client mode mask
986 locally so that the mode setting/unsetting would work without
987 problems. Client may change only its own modes.
989 After changing the mode server MUST send the notify type
990 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
992 The following client modes are defined:
994 0x00000000 SILC_UMODE_NONE
996 No specific mode for client. This is the initial
997 setting when new client is created. The client is
998 normal client and is present in the network.
1001 0x00000001 SILC_UMODE_SERVER_OPERATOR
1003 Marks the user as server operator. Client MUST NOT
1004 set this mode itself. Server sets this mode to the
1005 client when client attains the server operator
1006 privileges by SILC_COMMAND_OPER command. Client
1007 MAY unset the mode itself.
1010 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1012 Marks the user as router (SILC) operator. Client
1013 MUST NOT set this mode itself. Router sets this mode
1014 to the client when client attains the router operator
1015 privileges by SILC_COMMAND_SILCOPER command. Client
1016 MAY unset the mode itself.
1019 0x00000004 SILC_UMODE_GONE
1021 Marks that the user is not currently present in the
1022 SILC Network. Client MAY set and unset this mode.
1025 0x00000008 SILC_UMODE_INDISPOSED
1027 Marks that the user is currently indisposed and may
1028 not be able to receive any messages, and that user may
1029 not be present in the network. Client MAY set and
1033 0x00000010 SILC_UMODE_BUSY
1035 Marks that the user is currently busy and may not
1036 want to receive any messages, and that user may not
1037 be present in the network. Client MAY set and unset
1041 0x00000020 SILC_UMODE_PAGE
1043 User is not currently present or is unable to receive
1044 messages, and prefers to be paged in some mechanism
1045 if the user needs to be reached. Client MAY set and
1049 0x00000040 SILC_UMODE_HYPER
1051 Marks that the user is hyper active and is eager to
1052 receive and send messages. Client MAY set and unset
1056 0x00000080 SILC_UMODE_ROBOT
1058 Marks that the client is actually a robot program.
1059 Client MAY set and unset this mode.
1062 0x00000100 SILC_UMODE_ANONYMOUS
1064 Marks that the client is anonymous client. Server
1065 that specificly is designed for anonymous services
1066 can set and unset this mode. Client MUST NOT set or
1067 unset this mode itself. A client with this mode set
1068 would have the username and the hostname information
1069 scrambled by the server which set this mode.
1072 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1074 Marks that the client wishes to block private
1075 messages sent to the client, unless the Private
1076 Message Key flag is set in the SILC packet header.
1077 If this mode is set server MUST NOT deliver private
1078 messages to the client without the Private Message
1081 A separate service could provide additional filtering
1082 features for accepting private messages from certain
1083 sender. However, this document does not specify such
1086 The client MAY set and unset this mode.
1089 0x00000400 SILC_UMODE_DETACHED
1091 Marks that the client is detached from the SILC network.
1092 This means that the actual network connection to the
1093 client is lost but the client entry is still valid. The
1094 detached client can be resumed at a later time. This
1095 mode MUST NOT be set by client. It can only be set when
1096 client has issued command SILC_COMMAND_DETACH. The server
1097 sets this mode. This mode cannot be unset with this
1098 command. It is unset when the client is resuming back to
1099 the network and SILC_PACKET_RESUME_CLIENT packet is
1102 This flag MUST NOT be used to determine whether a packet
1103 can be sent to the client or not. Only the server that
1104 had the original client connection can make the decision
1105 by noticising that the network connection is not active.
1106 In this case the default case is to discard the packet.
1108 If the <client mode mask> was not provided this command merely
1109 returns the mode mask to the client.
1112 Reply messages to the command:
1115 Arguments: (1) <Status Payload> (2) <client mode mask>
1117 This command replies with the changed client mode mask that
1118 the client MUST to keep locally.
1124 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1125 SILC_STATUS_ERR_TOO_MANY_PARAMS
1126 SILC_STATUS_ERR_NOT_REGISTERED
1127 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1128 SILC_STATUS_ERR_BAD_CLIENT_ID
1129 SILC_STATUS_ERR_NOT_YOU
1130 SILC_STATUS_ERR_PERM_DENIED
1131 SILC_STATUS_ERR_UNKNOWN_MODE
1132 SILC_STATUS_ERR_NO_CLIENT_ID
1135 17 SILC_COMMAND_CMODE
1138 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1139 (3) [<user limit>] (4) [<passphrase>]
1140 (5) [<cipher>] (6) [<hmac>]
1141 (7) [<auth payload>]
1143 This command is used by client to set or change channel flags on
1144 a channel. Channel has several modes that set various properties
1145 of a channel. Modes may be masked together by ORing them thus
1146 having several modes set. The <Channel ID> is the ID of the
1147 target channel. The client changing channel mode MUST be on
1148 the same channel and poses sufficient privileges to be able to
1151 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1152 type MUST be distributed to the channel.
1154 The following channel modes are defined:
1156 0x00000000 SILC_CMODE_NONE
1158 No specific mode on channel. This is the default when
1159 channel is created. This means that channel is just plain
1163 0x00000001 SILC_CMODE_PRIVATE
1165 Channel is private channel. Private channels are shown
1166 in the channel list listed with SILC_COMMAND_LIST command
1167 with indication that the channel is private. Also,
1168 client on private channel will no be detected to be on
1169 the channel as the channel is not shown in the client's
1170 currently joined channel list. Channel founder and
1171 channel operator MAY set/unset this mode.
1173 Typical implementation would use [+|-]p on user interface
1174 to set/unset this mode.
1177 0x00000002 SILC_CMODE_SECRET
1179 Channel is secret channel. Secret channels are not shown
1180 in the list listed with SILC_COMMAND_LIST command. Secret
1181 channels can be considered to be invisible channels.
1182 Channel founder and channel operator MAY set/unset this
1185 Typical implementation would use [+|-]s on user interface
1186 to set/unset this mode.
1189 0x00000004 SILC_CMODE_PRIVKEY
1191 Channel uses private channel key to protect the traffic
1192 on the channel. When this mode is set the client will be
1193 responsible to set the key it wants to use to encrypt and
1194 decrypt the traffic on channel. Server generated channel
1195 keys are not used at all. This mode provides additional
1196 security as clients on channel may agree to use private
1197 channel key that even servers do not know. Naturally,
1198 this requires that every client on the channel knows
1199 the key before hand (it is considered to be pre-shared-
1200 key). The key material is RECOMMENDED to be processed
1201 as stated in the [SILC3] in the section Processing the
1204 As it is local setting it is possible to have several
1205 private channel keys on one channel. In this case several
1206 clients can talk on same channel but only those clients
1207 that share the key with the message sender will be able
1208 to hear the talking. Client SHOULD NOT display those
1209 message for the end user that it is not able to decrypt
1210 when this mode is set.
1212 Only channel founder MAY set/unset this mode. If this
1213 mode is unset the server will distribute new channel
1214 key to all clients on the channel which will be used
1217 Typical implementation would use [+|-]k on user interface
1218 to set/unset this mode.
1221 0x00000008 SILC_CMODE_INVITE
1223 Channel is invite only channel. Client may join to this
1224 channel only if it is invited to the channel. Channel
1225 founder and channel operator MAY set/unset this mode.
1227 Typical implementation would use [+|-]i on user interface
1228 to set/unset this mode.
1231 0x00000010 SILC_CMODE_TOPIC
1233 The topic of the channel may only be set by client that
1234 is channel founder or channel operator. Normal clients
1235 on channel will not be able to set topic when this mode
1236 is set. Channel founder and channel operator MAY set/
1239 Typical implementation would use [+|-]t on user interface
1240 to set/unset this mode.
1243 0x00000020 SILC_CMODE_ULIMIT
1245 User limit has been set to the channel. New clients
1246 may not join to the channel when the limit set is
1247 reached. Channel founder and channel operator MAY set/
1248 unset the limit. The <user limit> argument is the
1249 number of limited users.
1251 Typical implementation would use [+|-]l on user interface
1252 to set/unset this mode.
1255 0x00000040 SILC_CMODE_PASSPHRASE
1257 Passphrase has been set to the channel. Client may
1258 join to the channel only if it is able to provide the
1259 correct passphrase. Setting passphrases to channel
1260 is entirely safe as all commands are protected in the
1261 SILC network. Only channel founder MAY set/unset
1262 the passphrase. The <passphrase> argument is the
1265 Typical implementation would use [+|-]a on user interface
1266 to set/unset this mode.
1269 0x00000080 SILC_CMODE_CIPHER
1271 Sets specific cipher to be used to protect channel
1272 traffic. The <cipher> argument is the requested cipher.
1273 When set or unset the server must re-generate new
1274 channel key. Only channel founder MAY set the cipher of
1275 the channel. When unset the new key is generated using
1276 default cipher for the channel.
1278 Typical implementation would use [+|-]c on user interface
1279 to set/unset this mode.
1282 0x00000100 SILC_CMODE_HMAC
1284 Sets specific hmac to be used to compute the MACs of the
1285 channel message. The <hmac> argument is the requested hmac.
1286 Only channel founder may set the hmac of the channel.
1288 Typical implementation would use [+|-]h on user interface
1289 to set/unset this mode.
1292 0x00000200 SILC_CMODE_FOUNDER_AUTH
1294 Channel founder may set this mode to be able to regain
1295 channel founder rights even if the client leaves the
1296 channel. The <auth payload> is the Authentication Payload
1297 consisting of the authentication method and authentication
1298 data to be used in the authentication. The server MUST
1299 NOT accept NONE authentication method. Also, if the
1300 method is public key authentication the server MUST NOT
1301 save the authentication data from the payload as the
1302 data is different on all authentications. In this case the
1303 server only saves the authentication method. However,
1304 server MUST verify the sent authentication payload and
1305 set the mode only if the verification was successful.
1307 Note that this mode is effective only in the current server.
1308 The client MUST connect to the same server later to be able
1309 to regain the channel founder rights. The server MUST save
1310 the public key of the channel founder and use that to identify
1311 the client which is claiming the channel founder rights.
1312 The rights may be claimed by the SILC_CUMODE_FOUNDER
1313 channel user mode using SILC_COMMAND_CUMODE command. The
1314 set authentication data remains valid as long as the channel
1315 exists or until the founder unsets this mode.
1317 Typical implementation would use [+|-]f on user interface
1318 to set/unset this mode.
1321 0x00000400 SILC_CMODE_SILENCE_USERS
1323 Channel founder may set this mode to silence normal users
1324 on the channel. Users with operator privileges are not
1325 affected by this mode. Messages sent by normal users
1326 are dropped by servers when this mode is set. This mode
1327 can be used to moderate the channel. Only channel founder
1328 may set/unset this mode.
1331 0x00000800 SILC_CMODE_SILENCE_OPERS
1333 Channel founder may set this mode to silence operators
1334 on the channel. When used with SILC_CMODE_SILENCE_USERS
1335 mode this can be used to set the channel in state where only
1336 the founder of the channel may send messages to the channel.
1337 Messages sent by operators are dropped by servers when this
1338 mode is set. Only channel founder may set/unset this mode.
1341 To make the mode system work, client MUST keep the channel mode
1342 mask locally so that the mode setting and unsetting would work
1343 without problems. The client receives the initial channel mode
1344 mask when it joins to the channel. When the mode changes on
1345 channel the server MUST distribute the changed channel mode mask
1346 to all clients on the channel by sending the notify type
1347 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1348 to the server's primary router. If the <channel mode mask> was
1349 not provided this command merely returns the mode mask to the
1352 Reply messages to the command:
1355 Arguments: (1) <Status Payload> (2) <Channel ID>
1356 (3) <channel mode mask>
1358 This command replies with the changed channel mode mask that
1359 client MUST keep locally.
1364 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1365 SILC_STATUS_ERR_TOO_MANY_PARAMS
1366 SILC_STATUS_ERR_NOT_REGISTERED
1367 SILC_STATUS_ERR_NOT_ON_CHANNEL
1368 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1369 SILC_STATUS_ERR_BAD_CHANNEL_ID
1370 SILC_STATUS_ERR_NO_CHANNEL_ID
1371 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1372 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1373 SILC_STATUS_ERR_UNKNOWN_MODE
1374 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1375 SILC_STATUS_ERR_AUTH_FAILED
1378 18 SILC_COMMAND_CUMODE
1381 Arguments: (1) <Channel ID> (2) <mode mask>
1382 (3) <Client ID> (4) [<auth payload>]
1384 This command is used by client to change channel user modes on
1385 channel. Users on channel may have some special modes and this
1386 command is used by channel operators to set or change these modes.
1387 The <Channel ID> is the ID of the target channel. The <mode mask>
1388 is OR'ed mask of modes. The <Client ID> is the target client.
1389 The client changing channel user modes MUST be on the same channel
1390 as the target client and poses sufficient privileges to be able to
1393 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1394 type is distributed to the channel.
1396 The following channel modes are defined:
1398 0x00000000 SILC_CUMODE_NONE
1400 No specific mode. This is the normal situation for client.
1401 Also, this is the mode set when removing all modes from
1405 0x00000001 SILC_CUMODE_FOUNDER
1407 The client is channel founder of the channel. Usually this
1408 mode is set only by the server when the channel was created.
1409 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1410 been set, the client can claim channel founder privileges
1411 by providing the <auth payload> that the server will use
1412 to authenticate the client. The public key that server will
1413 use to verify the <auth payload> must the same public key
1414 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1415 mode was set. The client MAY remove this mode at any time.
1418 0x00000002 SILC_CUMODE_OPERATOR
1420 Sets channel operator privileges on the channel for a
1421 client on the channel. Channel founder and channel operator
1422 MAY set/unset this mode. The client MAY remove this mode
1426 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1428 Marks that the client wishes not to receive any channel
1429 messages sent for the channel. Client MAY set and unset
1430 this mode to itself. Client MUST NOT set it to anyone else.
1431 When this mode is set server MUST NOT deliver channel
1432 messages to this client. Other packets such as channel
1433 key packets are still sent to the client.
1435 A separate service could provide additional filtering
1436 features for accepting channel messages from certain
1437 sender. However, this document does not specify such
1441 Reply messages to the command:
1444 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1445 (3) <Channel ID> (4) <Client ID>
1447 This command replies with the changed channel user mode mask that
1448 client MUST keep locally. The <Channel ID> is the specified
1449 channel. The <Client ID> is the target client.
1454 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1455 SILC_STATUS_ERR_TOO_MANY_PARAMS
1456 SILC_STATUS_ERR_NOT_REGISTERED
1457 SILC_STATUS_ERR_NOT_ON_CHANNEL
1458 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1459 SILC_STATUS_ERR_BAD_CHANNEL_ID
1460 SILC_STATUS_ERR_NO_CHANNEL_ID
1461 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1462 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1463 SILC_STATUS_ERR_UNKNOWN_MODE
1464 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1465 SILC_STATUS_ERR_AUTH_FAILED
1468 19 SILC_COMMAND_KICK
1471 Arguments: (1) <Channel ID> (2) <Client ID>
1474 This command is used by channel operators to remove a client from
1475 channel. The <channel> argument is the channel the client to be
1476 removed is on currently. Note that the "kicker" must be on the same
1477 channel. If <comment> is provided it will be sent to the removed
1480 After kicking the client the server MUST send the notify type
1481 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1482 The channel key MUST also be re-generated after kicking, unless
1483 the SILC_CMODE_PRIVKEY mode is set.
1485 Reply messages to the command:
1488 Arguments: (1) <Status Payload>
1490 This command replies only with Status Payload.
1495 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1496 SILC_STATUS_ERR_TOO_MANY_PARAMS
1497 SILC_STATUS_ERR_NOT_REGISTERED
1498 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1499 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1500 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1501 SILC_STATUS_ERR_NO_CLIENT_ID
1507 Arguments: (1) <Channel ID> (2) [<adding client>]
1508 (3) [<removing client>]
1510 This command is used to manage the ban list of the channel
1511 indicated by the <Channel ID>. A client that is banned from
1512 channel is no longer able to join the channel. The client which
1513 is executing this command MUST have at least channel operator
1514 privileges on the channel.
1516 The <adding client> and <removing client> are used to add to and
1517 remove from the ban list. The format of the <adding client> and
1518 the <removing client> is of following format:
1520 [<nickname>[@<server>]!][<username>]@[<hostname>]
1522 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1523 primary router after adding to or removing from the ban list.
1524 The wildcards MAY be used with this command. If adding or removing
1525 from than one clients then the lists are an comma (`,') separated.
1527 If this command is executed without the ban arguments the command
1528 merely replies with the current ban list.
1531 Reply messages to the command:
1534 Arguments: (1) <Status Payload> (2) <Channel ID>
1537 This command replies with the <Channel ID> of the channel and
1538 the current <ban list> of the channel if it exists.
1543 SILC_STATUS_ERR_NOT_REGISTERED
1544 SILC_STATUS_ERR_TOO_MANY_PARAMS
1545 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1546 SILC_STATUS_ERR_NO_CHANNEL_ID
1547 SILC_STATUS_ERR_NOT_ON_CHANNEL
1548 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1551 21 <deprecated command>
1554 22 <deprecated command>
1557 23 SILC_COMMAND_SILCOPER
1560 Arguments: (1) <username> (2) <authentication payload>
1562 This command is used by normal client to obtain router operator
1563 privileges (also known as SILC operator) on the router. Note
1564 that router operator has privileges that supersedes the server
1565 operator privileges.
1567 The <username> is the username set in the server configurations
1568 as operator. The <authentication payload> is the data that the
1569 client is authenticated against. It may be passphrase prompted
1570 for user on client's screen or it may be public key or certificate
1571 authentication data (data signed with private key). The public
1572 key that router will use to verify the signature found in the
1573 payload should be verified. It is recommended that the public
1574 key is saved locally in the router and router would not use
1575 any public keys received during the SKE.
1577 Difference between router operator and server operator is that
1578 router operator is able to handle cell level properties while
1579 server operator (even on router server) is able to handle only
1580 local properties, such as, local connections and normal server
1581 administration. The router operator is also able to use the
1582 SILC_COMMAND_KILL command.
1584 After changing the mode server MUST send the notify type
1585 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1587 Reply messages to the command:
1590 Arguments: (1) <Status Payload>
1592 This command replies only with Status Payload.
1597 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1598 SILC_STATUS_ERR_TOO_MANY_PARAMS
1599 SILC_STATUS_ERR_NOT_REGISTERED
1600 SILC_STATUS_ERR_AUTH_FAILED
1603 24 SILC_COMMAND_LEAVE
1606 Arguments: (1) <Channel ID>
1608 This command is used by client to leave a channel the client is
1611 When leaving channel the server MUST send the notify type
1612 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1613 The channel key MUST also be re-generated when leaving the channel
1614 and distribute it to all clients still currently on the channel.
1615 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1618 Reply messages to the command:
1621 Arguments: (1) <Status Payload> (2) <Channel ID>
1623 The <Channel ID> is the ID of left channel.
1628 SILC_STATUS_ERR_NOT_REGISTERED
1629 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1630 SILC_STATUS_ERR_TOO_MANY_PARAMS
1631 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1632 SILC_STATUS_ERR_BAD_CHANNEL_ID
1633 SILC_STATUS_ERR_NO_CHANNEL_ID
1636 25 SILC_COMMAND_USERS
1639 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1641 This command is used to list user names currently on the requested
1642 channel; either the argument <Channel ID> or the <channel name>.
1643 One of these arguments must be present. The server MUST resolve
1644 the joined clients and reply with a lists of users on the channel
1645 and with list of user modes on the channel.
1647 If the requested channel is a private or secret channel, this
1648 command MUST NOT send the list of users, but error is returned
1649 to the sender, except if the sender is on the channel, or the
1652 Reply messages to the command:
1655 Arguments: (1) <Status Payload> (2) <Channel ID>
1656 (3) <list count> (4) <Client ID list>
1657 (5) <client mode list>
1659 This command replies with the Channel ID of the requested channel
1660 Client ID list of the users on the channel and list of their modes.
1661 The Client ID list has Client ID's of all users in the list. The
1662 <Client ID list> is formed by adding Client ID's one after another.
1663 The <client mode list> is formed by adding client's user modes on
1664 the channel one after another (4 bytes (32 bits) each). The <list
1665 count> of length of 4 bytes (32 bits), tells the number of entries
1666 in the lists. Both lists MUST have equal number of entries.
1671 SILC_STATUS_ERR_NOT_REGISTERED
1672 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1673 SILC_STATUS_ERR_TOO_MANY_PARAMS
1674 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1675 SILC_STATUS_ERR_BAD_CHANNEL_ID
1676 SILC_STATUS_ERR_NO_CHANNEL_ID
1677 SILC_STATUS_ERR_NOT_ON_CHANNEL
1680 26 SILC_COMMAND_GETKEY
1683 Arguments: (1) <ID Payload>
1685 This command is used to fetch the public key of the client or
1686 server indicated by the <ID Payload>. The public key is fetched
1687 from the server where to the client is connected.
1689 Reply messages to the command:
1692 Arguments: (1) <Status Payload> (2) <ID Payload>
1693 (3) [<Public Key Payload>]
1695 This command replies with the client's or server's ID and with
1696 the <Public Key Payload>.
1701 SILC_STATUS_ERR_NOT_REGISTERED
1702 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1703 SILC_STATUS_ERR_TOO_MANY_PARAMS
1704 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1705 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1710 Currently undefined commands.
1715 These commands are reserved for private use and will not be defined
1719 255 SILC_COMMAND_MAX
1721 Reserved command. This must not be sent.
1726 2.3 SILC Command Status Types
1729 2.3.1 SILC Command Status Payload
1731 Command Status Payload is sent in command reply messages to indicate
1732 the status of the command. The payload is one of argument in the
1733 command thus this is the data area in Command Argument Payload described
1734 in [SILC2]. The payload is only 2 bytes of length. The following diagram
1735 represents the Command Status Payload (field is always in MSB order).
1741 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1742 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1744 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1748 Figure 6: SILC Command Status Payload
1752 o Status (1 byte) - Indicates the status message type,
1753 error, start of list, entry of list or end of list.
1755 o Error (1 byte) - Indicates the error if the Status
1756 field is some list status, which means there are list
1760 The values in Status and Error fields are set according
1761 the following rules:
1764 o If there is single reply and error has not occurred
1765 then Status field includes value SILC_STATUS_OK, and
1766 the Error field MUST be ignored (and set to zero
1769 o If there is single error, then Status field includes
1770 one of the error values, and the Error field MUST be
1771 ignored (and set to zero value).
1773 o If there will be multiple successful command replies
1774 then Status field includes SILC_STATUS_LIST_START,
1775 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1776 and Error field is set to SILC_STATUS_OK.
1778 o If there are multiple error replies then Status field
1779 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1780 or SILC_STATUS_LIST_END value, and the Error field
1781 includes the error value.
1784 This way it is possible to send single successful or
1785 single error reply, but also multiple successful and
1786 multiple error replies. Note that it is possible to
1787 send both list of successful replies and list of error
1788 replies at the same time, however in this case the
1789 list of error replies MUST be sent after the successful
1790 replies. This way the recipient may ignore the multiple
1791 errors if it wishes to do so.
1793 All Status messages are described in the next section.
1797 2.3.2 SILC Command Status List
1799 Command Status messages are returned in the command reply messages
1800 to indicate whether the command were executed without errors. If error
1801 has occurred the status indicates which error occurred. Status payload
1802 only sends numeric reply about the status. Receiver of the payload must
1803 convert the numeric values into human readable error messages. The
1804 list of status messages below has an example human readable error
1805 messages that client may display for the user.
1807 List of all defined command status messages following.
1810 Generic status messages:
1814 Ok status. Everything went Ok. The status payload maybe
1815 safely ignored in this case.
1817 1 SILC_STATUS_LIST_START
1819 Start of the list. There will be several command replies and
1820 this reply is the start of the list.
1822 2 SILC_STATUS_LIST_ITEM
1824 Item in the list. This is one of the item in the list but not the
1827 3 SILC_STATUS_LIST_END
1829 End of the list. There were several command replies and this
1830 reply is the last of the list. There won't be other replies
1831 belonging to this list after this one.
1835 Currently undefined and has been reserved for the future.
1838 Error status message:
1842 10 SILC_STATUS_ERR_NO_SUCH_NICK
1844 "No such nickname". Requested nickname does not exist.
1846 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1848 "No such channel". Requested channel name does not exist.
1850 12 SILC_STATUS_ERR_NO_SUCH_SERVER
1852 "No such server". Requested server name does not exist.
1854 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
1856 "Duplicate recipients. No message delivered". Message were
1857 tried to be sent to recipient which has several occurrences in
1860 14 SILC_STATUS_ERR_NO_RECIPIENT
1862 "No recipient given". Command required recipient which was
1865 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
1867 "Unknown command". Command sent to server is unknown by the
1870 16 SILC_STATUS_ERR_WILDCARDS
1872 "Wildcards cannot be used". Wildcards were provided but they
1875 17 SILC_STATUS_ERR_NO_CLIENT_ID
1877 "No Client ID given". Client ID were expected as command
1878 parameter but were not found.
1880 18 SILC_STATUS_ERR_NO_CHANNEL_ID
1882 "No Channel ID given". Channel ID were expected as command
1883 parameter but were not found.
1885 19 SILC_STATUS_ERR_NO_SERVER_ID
1887 "No Serve ID given". Server ID were expected as command
1888 parameter but were not found.
1890 20 SILC_STATUS_ERR_BAD_CLIENT_ID
1892 "Bad Client ID". Client ID provided were erroneous.
1894 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
1896 "Bad Channel ID". Channel ID provided were erroneous.
1898 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1900 "No such Client ID". Client ID provided does not exist.
1902 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1904 "No such Channel ID". Channel ID provided does not exist.
1906 24 SILC_STATUS_ERR_NICKNAME_IN_USE
1908 "Nickname already exists". Nickname created could not be
1909 registered because number of same nicknames were already set to
1910 maximum. This is not expected to happen in real life but is
1913 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
1915 "You are not on that channel". The command were specified for
1916 channel user is not currently on.
1918 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1920 "They are not on channel". The requested target client is not
1921 on requested channel.
1923 27 SILC_STATUS_ERR_USER_ON_CHANNEL
1925 "User already on channel". User were invited on channel they
1928 28 SILC_STATUS_ERR_NOT_REGISTERED
1930 "You have not registered". User executed command that requires
1931 the client to be registered on the server before it may be
1934 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1936 "Not enough parameters". Command requires more parameters
1939 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
1941 "Too many parameters". Too many parameters were provided
1944 31 SILC_STATUS_ERR_PERM_DENIED
1946 "Permission denied". Generic permission denied error status
1947 to indicate disallowed access.
1949 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
1951 "You are banned from this server". The client tried to register
1952 on server that has explicitly denied this host to connect.
1954 33 SILC_STATUS_ERR_BAD_PASSWORD
1956 "Cannot join channel. Incorrect password". Password provided for
1957 channel were not accepted.
1959 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
1961 "Cannot join channel. Channel is full". The channel is full
1962 and client cannot be joined to it.
1964 35 SILC_STATUS_ERR_NOT_INVITED
1966 "Cannot join channel. You have not been invited". The channel
1967 is invite only channel and client has not been invited.
1969 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1971 "Cannot join channel. You have been banned". The client has
1972 been banned from the channel.
1974 37 SILC_STATUS_ERR_UNKNOWN_MODE
1976 "Unknown mode". Mode provided by the client were unknown to
1979 38 SILC_STATUS_ERR_NOT_YOU
1981 "Cannot change mode for other users". User tried to change
1982 someone else's mode.
1984 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1986 "Permission denied. You are not channel operator". Command may
1987 be executed only by channel operator.
1989 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1991 "Permission denied. You are not channel founder". Command may
1992 be executed only by channel operator.
1994 41 SILC_STATUS_ERR_NO_SERVER_PRIV
1996 "Permission denied. You are not server operator". Command may
1997 be executed only by server operator.
1999 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2001 "Permission denied. You are not SILC operator". Command may be
2002 executed only by router (SILC) operator.
2004 43 SILC_STATUS_ERR_BAD_NICKNAME
2006 "Bad nickname". Nickname requested contained illegal characters
2009 44 SILC_STATUS_ERR_BAD_CHANNEL
2011 "Bad channel name". Channel requested contained illegal characters
2014 45 SILC_STATUS_ERR_AUTH_FAILED
2016 "Authentication failed". The authentication data sent as
2017 argument were wrong and thus authentication failed.
2019 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2021 "The algorithm was not supported." The server does not support the
2022 requested algorithm.
2024 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2026 "No such Server ID". Server ID provided does not exist.
2032 3 Security Considerations
2034 Security is central to the design of this protocol, and these security
2035 considerations permeate the specification. Common security considerations
2036 such as keeping private keys truly private and using adequate lengths for
2037 symmetric and asymmetric keys must be followed in order to maintain the
2038 security of this protocol.
2044 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2045 Protocol Specification", Internet Draft, April 2001.
2047 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2050 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2051 Protocols", Internet Draft, April 2001.
2053 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2056 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2059 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2062 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2065 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2068 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2071 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2074 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2077 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2078 Infrastructure, Certificate and CRL Profile", RFC 2459,
2081 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2082 John Wiley & Sons, New York, NY, 1996.
2084 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2087 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2088 RFC 2412, November 1998.
2090 [ISAKMP] Maughan D., et al, "Internet Security Association and
2091 Key Management Protocol (ISAKMP)", RFC 2408, November
2094 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2095 (IKE)", RFC 2409, November 1998.
2097 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2098 Authentication", RFC 2104, February 1997.
2100 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2101 Specifications, Version 2.0", RFC 2437, October 1998.
2103 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2104 Requirement Levels", BCP 14, RFC 2119, March 1997.
2106 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2107 10646", RFC 2279, January 1998.
2118 Snellmanninkatu 34 A 15
2122 EMail: priikone@iki.fi
2124 This Internet-Draft expires XXX