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
84 Appendix A ...................................................... xx
90 This document describes the commands used in the Secure Internet Live
91 Conferencing (SILC) protocol, specified in the Secure Internet Live
92 Conferencing, Protocol Specification Internet Draft [SILC1]. This
93 document specifies detailed command messages and command reply messages.
95 Commands are very important part on SILC network especially for client
96 which uses commands to operate on the SILC network. Commands are used
97 to set nickname, join to channel, change modes and many other things.
99 See the [SILC1] for the requirements and the restrictions for the usage
100 of the SILC commands. The [SILC2] defines the command packet type and
101 the Command Payload which is actually used to deliver the commands and
102 command reply messages.
106 1.1 Requirements Terminology
108 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
109 MAY, and OPTIONAL, when they appear in this document, are to be
110 interpreted as described in [RFC2119].
117 2.1 SILC Commands Syntax
119 This section briefly describes the syntax of the command notions
120 in this document. Every field in command is separated from each
121 other by whitespaces (` ') indicating that each field is independent
122 argument and each argument MUST have own Command Argument Payload.
123 The number of maximum arguments are defined with each command
124 separately. The Command Argument Payload is described in [SILC2].
126 Every command defines specific number for each argument. Currently,
127 they are defined in ascending order; first argument has number one
128 (1), second has number two (2) and so on. This number is set into the
129 Argument Type field in the Command Argument Payload. This makes it
130 possible to send the arguments in free order as the number MUST be
131 used to identify the type of the argument. This makes is it also
132 possible to have multiple optional arguments in commands and in
133 command replies. The number of argument is marked in parentheses
134 before the actual argument.
139 Example: Arguments: (1) <nickname> (2) <username@host>
143 Every command replies with Status Payload. This payload tells the
144 sender of the command whether the command was completed successfully or
145 whether there was an error. If error occurred the payload includes the
146 error type. In the next section the Status Payload is not described
147 as it is common to all commands and has been described here. Commands
148 MAY reply with other arguments as well. These arguments are command
149 specific and are described in the next section.
158 Arguments: (1) <nickname>[@<server>] (2) <message>
161 The command has maximum of 3 arguments. However, only first
162 and second arguments are mandatory.
164 First argument <nickname> is mandatory but may have optional
165 <nickname@server> format as well. Second argument is mandatory
166 <message> argument. Third argument is optional <count> argument.
168 The numbers in parentheses are the argument specific numbers
169 that specify the type of the argument in Command Argument Payload.
170 The receiver always knows that, say, argument number two (2) is
171 <message> argument, regardless of the ordering of the arguments in
174 Reply messages to the command:
177 Arguments: (1) <Status Payload> (2) [<channel list>]
178 (3) <idle time> (4) [<away message>]
180 This command may reply with maximum of 4 arguments. However,
181 only the first and third arguments are mandatory. The numbers
182 in the parentheses have the same meaning as in the upper
183 command sending specification.
185 Every command reply with <Status Payload>, it is mandatory
186 argument for all command replies and for this reason it is not
187 described in the command reply descriptions.
194 SILC_STATUS_ERR_TOO_MANY_TARGETS
195 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
196 SILC_STATUS_ERR_NO_SUCH_NICK
198 Every command reply also defines set of status message that it
199 may return inside the <Status Payload>. All status messages
200 are defined in the section 2.3 SILC Command Status Types.
203 Every command that has some kind of ID as argument (for example
204 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
205 the type of the ID, length of the ID and the actual ID data. This
206 way variable length ID's can be sent as arguments. Also note that
207 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
212 2.2 SILC Commands List
214 This section lists all SILC commands, however, it is expected that a
215 implementation and especially client implementation has many more
216 commands that has only local affect. These commands are official
217 SILC commands that has both client and server sides and cannot be
218 characterized as local commands.
220 List of all defined commands in SILC follows.
225 None. This is reserved command and MUST NOT be sent.
231 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
232 (3) [<Requested Attributes>] (4) [<Client ID>]
235 Whois command is used to query various information about specific
236 user. The user may be requested by their nickname and server name.
237 The query may find multiple matching users as there are no unique
238 nicknames in the SILC. The <count> option may be given to narrow
239 down the number of accepted results. If this is not defined there
240 are no limit of accepted results. The query may also be narrowed
241 down by defining the server name of the nickname. The <count> is
242 32 bit MSB first order integer.
244 It is also possible to search the user by Client ID. If the
245 <Client ID> is provided server MUST use it as the search value
246 instead of the <nickname>. One of the arguments MUST be given.
247 It is also possible to define multiple Client ID's to search
248 multiple users sending only one WHOIS command. In this case the
249 Client ID's are appended as normal arguments.
251 To prevent miss-use of this command wildcards in the nickname
252 or in the server name are not permitted. It is not allowed
253 to request all users on some server. The WHOIS requests MUST
254 be based on explicit nickname request.
256 The WHOIS request MUST be always sent to the router by server
257 so that all users are searched. However, the server still MUST
258 search its locally connected clients. The router MUST send
259 this command to the server which owns the requested client. That
260 server MUST reply to the command. Server MUST NOT send whois
261 replies to the client until it has received the reply from its
264 The <Requested Attributes> is defined in [ATTRS] and can be used
265 to request various information about the client. See Appendix A
266 for definition of using these attaributes in SILC.
268 Reply messages to the command:
271 Arguments: (1) <Status Payload> (2) <Client ID>
272 (3) <nickname>[@<server>] (4) <username@host>
273 (5) <real name> (6) [<Channel Payload
275 (7) [<user mode>] (8) [<idle time>]
276 (9) [<fingerprint>] (10) <channel user
280 This command may reply with several command reply messages to
281 form a list of results. In this case the status payload will
282 include STATUS_LIST_START status in the first reply and
283 STATUS_LIST_END in the last reply to indicate the end of the
284 list. If there are only one reply the status is set to normal
287 The command replies include the Client ID of the nickname,
288 nickname and server name, user name and host name and user's real
289 name. Client SHOULD process these replies only after the last
290 reply has been received with the STATUS_LIST_END status. If the
291 <count> option were defined in the query there will be only
292 <count> many replies from the server.
294 The server returns the list of channels if the client has
295 joined channels. In this case the list is list of Channel
296 Payloads. The Mode Mask in the Channel Payload is the channel's
297 mode. The list is encoded by adding the Channel Payloads one
298 after the other. Private and secret channels MUST NOT be sent,
299 except if the sender of this command is on those channels, or
300 the sender is server. The <channel user mode list> MUST also
301 be sent if client is joined channels. This list includes 32 bit
302 MSB first order values one after the other and each indicate
303 the user's mode on a channel. The order of these values MUST
304 be same as the channel order in the <Channel Payload list>.
306 The server also returns client's user mode, idle time, and the
307 fingerprint of the client's public key. The <fingerprint> is the
308 binary hash digest of the public key. The fingerprint MUST NOT
309 be sent if the server has not verified the proof of posession of
310 the corresponding private key. Server can do this during the
311 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
316 SILC_STATUS_LIST_START
318 SILC_STATUS_ERR_NO_SUCH_NICK
319 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
320 SILC_STATUS_ERR_WILDCARDS
321 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
322 SILC_STATUS_ERR_TOO_MANY_PARAMS
325 2 SILC_COMMAND_WHOWAS
328 Arguments: (1) <nickname>[@<server>] (2) [<count>]
330 Whowas. This command is used to query history information about
331 specific user. The user may be requested by their nickname and
332 server name. The query may find multiple matching users as there
333 are no unique nicknames in the SILC. The <count> option may be
334 given to narrow down the number of accepted results. If this
335 is not defined there are no limit of accepted results. The query
336 may also be narrowed down by defining the server name of the
337 nickname. The <count> is 32 bit MSB first order integer.
339 To prevent miss-use of this command wildcards in the nickname
340 or in the server name are not permitted. The WHOWAS requests MUST
341 be based on specific nickname request.
343 The WHOWAS request MUST be always sent to the router by server
344 so that all users are searched. However, the server still must
345 search its locally connected clients.
347 Reply messages to the command:
350 Arguments: (1) <Status Payload> (2) <Client ID>
351 (3) <nickname>[@<server>] (4) <username@host>
354 This command may reply with several command reply messages to form
355 a list of results. In this case the status payload will include
356 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
357 the last reply to indicate the end of the list. If there are only
358 one reply the status is set to normal STATUS_OK.
360 The command replies with nickname and user name and host name.
361 Every server MUST keep history for some period of time of its
362 locally connected clients.
367 SILC_STATUS_LIST_START
369 SILC_STATUS_ERR_NO_SUCH_NICK
370 SILC_STATUS_ERR_WILDCARDS
371 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
372 SILC_STATUS_ERR_TOO_MANY_PARAMS
375 3 SILC_COMMAND_IDENTIFY
378 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
379 (3) [<channel name>] (4) [<count>]
380 (5) [<ID Payload>] (n) [...]
382 Identify command is used to query information about an entity by
383 the entity's name or ID. This command can be used to query
384 information about clients, server and channels.
386 The query may find multiple matching entities. The <count> option
387 may be given to narrow down the number of accepted results. If
388 this is not defined there are no limit of accepted results. The
389 <count> is 32 bit MSB first order integer.
391 It is also possible to search the entity by its ID. If the
392 <ID Payload> is provided server must use it as the search value
393 instead of the entity's name. One of the arguments must be given.
394 It is also possible to define multiple ID Payloads to search
395 multiple entities sending only one IDENTIFY command. In this case
396 the ID Payloads are appended as normal arguments. The type of the
397 entity is defined by the type of the ID Payload.
399 To prevent miss-use of this command wildcards in the names are
400 not permitted. It is not allowed to request for example all users
403 Implementations may not want to give interface access to this
404 command as it is hardly a command that would be used by an end
405 user. However, it must be implemented as it is used with private
408 The IDENTIFY command MUST be always sent to the router by server
409 so that all users are searched. However, server MUST still search
410 its locally connected clients.
412 Reply messages to the command:
415 Arguments: (1) <Status Payload> (2) <ID Payload>
416 (3) [<entity's name>] (4) [<info>]
418 This command may reply with several command reply messages to form
419 a list of results. In this case the status payload will include
420 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
421 the last reply to indicate the end of the list. If there are only
422 one reply the status is set to normal STATUS_OK.
424 When querying clients the <entity's name> must include the client's
425 nickname in the following format: nickname[@server]. The
426 <info> must include the client's username and host in the following
427 format: username@host.
429 When querying servers the <entity's name> must include the server's
430 full name. The <info> may be omitted.
432 When querying channels the <entity's name> must include the
433 channel's name. The <info> may be omitted.
435 If the <count> option were defined in the query there will be only
436 <count> many replies from the server.
441 SILC_STATUS_LIST_START
443 SILC_STATUS_ERR_NO_SUCH_NICK
444 SILC_STATUS_ERR_NO_SUCH_SERVER
445 SILC_STATUS_ERR_NO_SUCH_CHANNEL
446 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
447 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
448 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
449 SILC_STATUS_ERR_WILDCARDS
450 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
451 SILC_STATUS_ERR_TOO_MANY_PARAMS
457 Arguments: (1) <nickname>
459 Set/change nickname. This command is used to set nickname for
460 user. Nickname MUST NOT include any spaces (` '), non-printable
461 characters, commas (`,') and any wildcard characters. Note that
462 nicknames in SILC are case-sensitive which must be taken into
463 account when searching clients by nickname.
465 When nickname is changed new Client ID is generated. Server MUST
466 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
467 channels (if any) the client is joined on. Then it MUST send
468 SILC_PACKET_REPLACE_ID to its primary route to replace the old
469 Client ID with the new one.
471 Reply messages to the command:
474 Arguments: (1) <Status Payload> (2) <New ID Payload>
476 This command is replied always with New ID Payload that is
477 generated by the server every time user changes their nickname.
478 Client receiving this payload MUST start using the received
479 Client ID as its current valid Client ID. The New ID Payload
480 is described in [SILC2].
485 SILC_STATUS_ERR_WILDCARDS
486 SILC_STATUS_ERR_NICKNAME_IN_USE
487 SILC_STATUS_ERR_BAD_NICKNAME
488 SILC_STATUS_ERR_NOT_REGISTERED
489 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
490 SILC_STATUS_ERR_TOO_MANY_PARAMS
496 Arguments: (1) [<Channel ID>]
498 The list command is used to list channels and their topics on the
499 current server. If the <Channel ID> parameter is used, only the
500 status of that channel is displayed. Secret channels are not
501 listed at all. Private channels are listed with status indicating
502 that the channel is private. Router MAY reply with all channels
505 Reply messages to the command:
508 Arguments: (1) <Status Payload> (2) <Channel ID>
509 (3) <channel> (4) [<topic>]
512 This command may reply with several command reply messages to form
513 a list of results. In this case the status payload will include
514 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
515 the last reply to indicate the end of the list. If there are only
516 one reply the status is set to normal STATUS_OK.
518 This command replies with Channel ID, name and the topic of the
519 channel. If the channel is private channel the <topic> SHOULD
520 include the "*private*" string.
525 SILC_STATUS_LIST_START
527 SILC_STATUS_ERR_WILDCARDS
528 SILC_STATUS_ERR_NOT_REGISTERED
529 SILC_STATUS_ERR_TOO_MANY_PARAMS
530 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
531 SILC_STATUS_ERR_NO_CHANNEL_ID
532 SILC_STATUS_ERR_NO_SUCH_SERVER
538 Arguments: (1) <Channel ID> (2) [<topic>]
540 This command is used to change or view the topic of a channel.
541 The topic for channel <Channel ID> is returned if there is no
542 <topic> given. If the <topic> parameter is present, the topic
543 for that channel will be changed, if the channel modes permit
546 After setting the topic the server MUST send the notify type
547 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
548 the channel which topic was changed.
550 Reply messages to the command:
553 Arguments: (1) <Status Payload> (2) <Channel ID>
556 The command may reply with the topic of the channel if it is
562 SILC_STATUS_ERR_NOT_ON_CHANNEL
563 SILC_STATUS_ERR_WILDCARDS
564 SILC_STATUS_ERR_NOT_REGISTERED
565 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
566 SILC_STATUS_ERR_NO_SUCH_CHANNEL
567 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
568 SILC_STATUS_ERR_NO_CHANNEL_ID
569 SILC_STATUS_ERR_BAD_CHANNEL_ID
570 SILC_STATUS_ERR_TOO_MANY_PARAMS
571 SILC_STATUS_ERR_NO_CHANNEL_PRIV
574 7 SILC_COMMAND_INVITE
577 Arguments: (1) <Channel ID> (2) [<Client ID>]
578 (3) [<adding client>] (4) [<removing client>]
580 This command is used to invite other clients to join to the
581 channel. The <Client ID> argument is the target client's ID that
582 is being invited. The <Channel ID> is the Channel ID of the
583 requested channel. The sender of this command MUST be on the
584 channel. The server MUST also send the notify type
585 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
586 client indicated by the <Client ID>.
588 The <adding client> and <removing client> can be used to add to
589 and remove from the invite list. The format of the <adding client>
590 and <removing client> is as follows:
592 [<nickname>[@<server>]!][<username>]@[<hostname>]
594 When adding to or removing from the invite list the server MUST
595 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
596 and MUST NOT send it to the client which was added to the list.
597 The client which executes this command MUST have at least channel
598 operator privileges to be able to add to or remove from the invite
599 list. The wildcards MAY be used with this command. If adding or
600 removing more than one client then the lists are an comma (`,')
603 Note that the <Client ID> provided MUST be resolved into correct
604 nickname and host name and add to the invite list before sending
607 When this command is given with only <Channel ID> argument then
608 the command merely returns the invite list of the channel. This
609 command MUST fail if the requested channel does not exist, the
610 requested <Client ID> is already on the channel or if the channel
611 is invite only channel and the caller of this command does not
612 have at least channel operator privileges.
614 Reply messages to the command:
617 Arguments: (1) <Status Payload> (2) <Channel ID>
620 This command replies with the invite list of the channel if it
626 SILC_STATUS_ERR_NOT_REGISTERED
627 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
628 SILC_STATUS_ERR_TOO_MANY_PARAMS
629 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
630 SILC_STATUS_ERR_NO_CLIENT_ID
631 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
632 SILC_STATUS_ERR_NO_CHANNEL_ID
633 SILC_STATUS_ERR_NOT_ON_CHANNEL
634 SILC_STATUS_ERR_USER_ON_CHANNEL
635 SILC_STATUS_ERR_NO_CHANNEL_PRIV
641 Arguments: (1) [<quit message>]
643 This command is used by client to end SILC session. The server
644 must close the connection to a client which sends this command.
645 if <quit message> is given it will be sent to other clients on
646 channel if the client is on channel when quitting.
648 Reply messages to the command:
650 This command does not reply anything.
656 Arguments: (1) <Client ID> (2) [<comment>]
658 This command is used by SILC operators to remove a client from
659 SILC network. The removing has temporary effects and client may
660 reconnect to SILC network. The <Client ID> is the client to be
661 removed from SILC. The <comment> argument may be provided to
662 give to the removed client some information why it was removed
665 When killing a client the router MUST first send notify type
666 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
667 The packet MUST NOT be sent to the killed client on the channels.
668 Then, the router MUST send the same notify type to its primary
669 router. Finally, the router MUST send the same notify type
670 directly to the client which was killed.
672 Reply messages to the command:
675 Arguments: (1) <Status Payload>
677 This command replies only with Status Payload.
682 SILC_STATUS_ERR_WILDCARDS
683 SILC_STATUS_ERR_NOT_REGISTERED
684 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
685 SILC_STATUS_ERR_TOO_MANY_PARAMS
686 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
687 SILC_STATUS_ERR_NO_CLIENT_ID
688 SILC_STATUS_ERR_NO_ROUTER_PRIV
694 Arguments: (1) [<server>] (2) [<Server ID>]
696 This command is used to fetch various information about a server.
697 If <server> argument is specified the command MUST be sent to
698 the requested server.
700 If the <Server ID> is specified the server information if fetched
701 by the provided Server ID. One of the arguments must always be
704 Reply messages to the command:
707 Arguments: (1) <Status Payload> (2) <Server ID>
708 (3) <server name> (4) <string>
710 This command replies with the Server ID of the server and a
711 string which tells the information about the server.
716 SILC_STATUS_ERR_WILDCARDS
717 SILC_STATUS_ERR_NOT_REGISTERED
718 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
719 SILC_STATUS_ERR_TOO_MANY_PARAMS
720 SILC_STATUS_ERR_NO_SUCH_SERVER
721 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
722 SILC_STATUS_ERR_NO_SERVER_ID
725 11 SILC_COMMAND_STATS
728 Arguments: (1) <Server ID>
730 This command is used to fetch various statistical information
731 from the server indicated by <Server ID>, which is the ID of
732 server where sender is connected to. Server receiving this
733 command MAY also send this further to its router for fetching
734 other cell and network wide statistics to accompany the reply.
736 Reply messages to the command:
739 Arguments: (1) <Status Payload> (2) <Server ID>
740 (3) [<statistics structure>]
742 This command replies with the Server ID of the server and
743 optional statistics structure which includes 32 bit MSB first
744 ordered integer values to represent various statistical
745 information. The structure is as follows:
747 starttime - time when server was started
748 uptime - uptime of the server
749 my clients - number of locally connected clients
750 my channels - number of locally created channels
751 my server ops - number of local server operators
752 my router ops - number of local router operators
753 cell clients - number of clients in local cell
754 cell channels - number of channels in local cell
755 cell servers - number of servers in local cell
756 clients - number of client in SILC network
757 channels - number of channels in SILC network
758 servers - number of servers in SILC network
759 routers - number of routers in SILC network
760 server ops - number of server operators in SILC network
761 router ops - number of router operators in SILC network
763 If some value is unknown it is set to zero (0) value. The
764 "starttime" is the start time of the server, and is seconds
765 since Epoch (POSIX.1). The "uptime" is time difference of
766 current time and "starttime" in the server, and is seconds
772 SILC_STATUS_ERR_NOT_REGISTERED
773 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
774 SILC_STATUS_ERR_TOO_MANY_PARAMS
775 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
776 SILC_STATUS_ERR_NO_SUCH_SERVER
777 SILC_STATUS_ERR_NO_SERVER_ID
783 Arguments: (1) <Server ID>
785 This command is used by client and server to test the communication
786 channel to its server if one suspects that the communication is not
787 working correctly. The <Server ID> is the ID of the server the
788 sender is connected to.
790 Reply messages to the command:
793 Arguments: (1) <Status Payload>
795 This command replies only with Status Payload. Server returns
796 SILC_STATUS_OK in Status Payload if pinging was successful.
803 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
804 SILC_STATUS_ERR_TOO_MANY_PARAMS
805 SILC_STATUS_ERR_NO_SERVER_ID
806 SILC_STATUS_ERR_NO_SUCH_SERVER
807 SILC_STATUS_ERR_NOT_REGISTERED
813 Arguments: (1) <username> (2) <authentication payload>
815 This command is used by normal client to obtain server operator
816 privileges on some server or router. Note that router operator
817 has router privileges that supersedes the server operator
818 privileges and this does not obtain those privileges. Client
819 MUST use SILCOPER command to obtain router level privileges.
821 The <username> is the username set in the server configurations
822 as operator. The <authentication payload> is the data that the
823 client is authenticated against. It may be passphrase prompted
824 for user on client's screen or it may be public key or certificate
825 authentication data (data signed with private key). The public
826 key that server will use to verify the signature found in the
827 payload should be verified. It is recommended that the public
828 key is saved locally in the server and server would not use
829 any public keys received during the SKE.
831 After changing the mode the server MUST send the notify type
832 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
834 Reply messages to the command:
837 Arguments: (1) <Status Payload>
839 This command replies only with Status Payload.
844 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
845 SILC_STATUS_ERR_TOO_MANY_PARAMS
846 SILC_STATUS_ERR_NOT_REGISTERED
847 SILC_STATUS_ERR_AUTH_FAILED
853 Arguments: (1) <channel> (2) <Client ID>
854 (3) [<passphrase>] (4) [<cipher>]
855 (5) [<hmac>] (6) [<founder auth>]
857 Join to channel/create new channel. This command is used to
858 join to a channel. If the channel does not exist the channel is
859 created. If server is normal server this command MUST be sent
860 to router which will create the channel. The channel MAY be
861 protected with passphrase. If this is the case the passphrase
862 MUST be sent along the join command.
864 The name of the <channel> MUST NOT include any spaces (` '),
865 non-printable characters, commas (`,') or any wildcard characters.
867 The second argument <Client ID> is the Client ID of the client
868 which is joining to the client. When client sends this command
869 to the server the <Client ID> MUST be the client's own ID.
871 Cipher to be used to secure the traffic on the channel MAY be
872 requested by sending the name of the requested <cipher>. This
873 is used only if the channel does not exist and is created. If
874 the channel already exists the cipher set previously for the
875 channel will be used to secure the traffic. The computed MACs
876 of the channel message are produced by the default HMAC or by
877 the <hmac> provided for the command.
879 The <founder auth> is Authentication Payload providing the
880 authentication for gaining founder privileges on the channel
881 when joining the channel. The client may provide this if it
882 knows that it is the founder of the channel and that the
883 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
884 MUST verify whether the client is able to gain the founder
885 privileges the same way as the client had given the
886 SILC_COMMAND_CUMODE command to gain founder privileges. The
887 client is still able to join the channel even if the founder
888 privileges could not be gained.
890 The server MUST check whether the user is allowed to join to
891 the requested channel. Various modes set to the channel affect
892 the ability of the user to join the channel. These conditions
895 o The user MUST be invited to the channel if the channel
896 is invite-only channel.
898 o The Client ID/nickname/username/host name MUST NOT match
901 o The correct passphrase MUST be provided if passphrase
902 is set to the channel.
904 o The user count limit, if set, MUST NOT be reached.
906 If the client provided correct <founder auth> payload it can
907 override these conditions, except the condition for the passphrase.
908 The correct passphrase MUST be provided even if <founder auth>
911 Reply messages to the command:
914 Arguments: (1) <Status Payload> (2) <channel>
915 (3) <Channel ID> (4) <Client ID>
916 (5) <channel mode mask> (6) <created>
917 (7) [<Channel Key Payload>] (8) [<ban list>]
918 (9) [<invite list>] (10) [<topic>]
919 (11) [<hmac>] (12) <list count>
920 (13) <Client ID list> (14) <client mode list>
922 This command replies with the channel name requested by the
923 client, channel ID of the channel and topic of the channel
924 if it exists. The <Client ID> is the Client ID which was joined
925 to the channel. It also replies with the channel mode mask
926 which tells all the modes set on the channel. If the
927 channel is created the mode mask is zero (0). If ban mask
928 and/or invite list is set they are sent as well.
930 The <list count>, <Client ID list> and <client mode list> are
931 the clients currently on the channel and their modes on the
932 channel. The <Client ID list> is formed by adding the ID Payloads
933 one after the other. The <client mode list> is formed by adding
934 32 bit MSB first order values one after the other.
936 Client receives the channel key in the reply message as well
937 inside <Channel Key Payload>.
942 SILC_STATUS_ERR_WILDCARDS
943 SILC_STATUS_ERR_NOT_REGISTERED
944 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
945 SILC_STATUS_ERR_TOO_MANY_PARAMS
946 SILC_STATUS_ERR_BAD_PASSWORD
947 SILC_STATUS_ERR_CHANNEL_IS_FULL
948 SILC_STATUS_ERR_NOT_INVITED
949 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
950 SILC_STATUS_ERR_BAD_CHANNEL
951 SILC_STATUS_ERR_USER_ON_CHANNEL
957 Arguments: (1) <server>
959 This command is used to query the Message of the Day of the server.
961 Reply messages to the command:
964 Arguments: (1) <Status Payload> (2) <Server ID>
967 This command replies with the motd message if it exists.
972 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
973 SILC_STATUS_ERR_TOO_MANY_PARAMS
974 SILC_STATUS_ERR_NOT_REGISTERED
975 SILC_STATUS_ERR_NO_SUCH_SERVER
978 16 SILC_COMMAND_UMODE
981 Arguments: (1) <Client ID> (2) [<client mode mask>]
983 This command is used by client to set/unset modes for itself.
984 However, there are some modes that the client MUST NOT set itself,
985 but they will be set by server. However, client MAY unset any
986 mode. Modes may be masked together ORing them thus having
987 several modes set. Client MUST keep its client mode mask
988 locally so that the mode setting/unsetting would work without
989 problems. Client may change only its own modes.
991 After changing the mode server MUST send the notify type
992 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
994 The following client modes are defined:
996 0x00000000 SILC_UMODE_NONE
998 No specific mode for client. This is the initial
999 setting when new client is created. The client is
1000 normal client and is present in the network.
1003 0x00000001 SILC_UMODE_SERVER_OPERATOR
1005 Marks the user as server operator. Client MUST NOT
1006 set this mode itself. Server sets this mode to the
1007 client when client attains the server operator
1008 privileges by SILC_COMMAND_OPER command. Client
1009 MAY unset the mode itself.
1012 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1014 Marks the user as router (SILC) operator. Client
1015 MUST NOT set this mode itself. Router sets this mode
1016 to the client when client attains the router operator
1017 privileges by SILC_COMMAND_SILCOPER command. Client
1018 MAY unset the mode itself.
1021 0x00000004 SILC_UMODE_GONE
1023 Marks that the user is not currently present in the
1024 SILC Network. Client MAY set and unset this mode.
1027 0x00000008 SILC_UMODE_INDISPOSED
1029 Marks that the user is currently indisposed and may
1030 not be able to receive any messages, and that user may
1031 not be present in the network. Client MAY set and
1035 0x00000010 SILC_UMODE_BUSY
1037 Marks that the user is currently busy and may not
1038 want to receive any messages, and that user may not
1039 be present in the network. Client MAY set and unset
1043 0x00000020 SILC_UMODE_PAGE
1045 User is not currently present or is unable to receive
1046 messages, and prefers to be paged in some mechanism
1047 if the user needs to be reached. Client MAY set and
1051 0x00000040 SILC_UMODE_HYPER
1053 Marks that the user is hyper active and is eager to
1054 receive and send messages. Client MAY set and unset
1058 0x00000080 SILC_UMODE_ROBOT
1060 Marks that the client is actually a robot program.
1061 Client MAY set and unset this mode.
1064 0x00000100 SILC_UMODE_ANONYMOUS
1066 Marks that the client is anonymous client. Server
1067 that specificly is designed for anonymous services
1068 can set and unset this mode. Client MUST NOT set or
1069 unset this mode itself. A client with this mode set
1070 would have the username and the hostname information
1071 scrambled by the server which set this mode.
1074 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1076 Marks that the client wishes to block private
1077 messages sent to the client, unless the Private
1078 Message Key flag is set in the SILC packet header.
1079 If this mode is set server MUST NOT deliver private
1080 messages to the client without the Private Message
1083 A separate service could provide additional filtering
1084 features for accepting private messages from certain
1085 sender. However, this document does not specify such
1088 The client MAY set and unset this mode.
1091 0x00000400 SILC_UMODE_DETACHED
1093 Marks that the client is detached from the SILC network.
1094 This means that the actual network connection to the
1095 client is lost but the client entry is still valid. The
1096 detached client can be resumed at a later time. This
1097 mode MUST NOT be set by client. It can only be set when
1098 client has issued command SILC_COMMAND_DETACH. The server
1099 sets this mode. This mode cannot be unset with this
1100 command. It is unset when the client is resuming back to
1101 the network and SILC_PACKET_RESUME_CLIENT packet is
1104 This flag MUST NOT be used to determine whether a packet
1105 can be sent to the client or not. Only the server that
1106 had the original client connection can make the decision
1107 by noticising that the network connection is not active.
1108 In this case the default case is to discard the packet.
1110 If the <client mode mask> was not provided this command merely
1111 returns the mode mask to the client.
1114 Reply messages to the command:
1117 Arguments: (1) <Status Payload> (2) <client mode mask>
1119 This command replies with the changed client mode mask that
1120 the client MUST to keep locally.
1126 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1127 SILC_STATUS_ERR_TOO_MANY_PARAMS
1128 SILC_STATUS_ERR_NOT_REGISTERED
1129 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1130 SILC_STATUS_ERR_BAD_CLIENT_ID
1131 SILC_STATUS_ERR_NOT_YOU
1132 SILC_STATUS_ERR_PERM_DENIED
1133 SILC_STATUS_ERR_UNKNOWN_MODE
1134 SILC_STATUS_ERR_NO_CLIENT_ID
1137 17 SILC_COMMAND_CMODE
1140 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1141 (3) [<user limit>] (4) [<passphrase>]
1142 (5) [<cipher>] (6) [<hmac>]
1143 (7) [<auth payload>]
1145 This command is used by client to set or change channel flags on
1146 a channel. Channel has several modes that set various properties
1147 of a channel. Modes may be masked together by ORing them thus
1148 having several modes set. The <Channel ID> is the ID of the
1149 target channel. The client changing channel mode MUST be on
1150 the same channel and poses sufficient privileges to be able to
1153 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1154 type MUST be distributed to the channel.
1156 The following channel modes are defined:
1158 0x00000000 SILC_CMODE_NONE
1160 No specific mode on channel. This is the default when
1161 channel is created. This means that channel is just plain
1165 0x00000001 SILC_CMODE_PRIVATE
1167 Channel is private channel. Private channels are shown
1168 in the channel list listed with SILC_COMMAND_LIST command
1169 with indication that the channel is private. Also,
1170 client on private channel will no be detected to be on
1171 the channel as the channel is not shown in the client's
1172 currently joined channel list. Channel founder and
1173 channel operator MAY set/unset this mode.
1175 Typical implementation would use [+|-]p on user interface
1176 to set/unset this mode.
1179 0x00000002 SILC_CMODE_SECRET
1181 Channel is secret channel. Secret channels are not shown
1182 in the list listed with SILC_COMMAND_LIST command. Secret
1183 channels can be considered to be invisible channels.
1184 Channel founder and channel operator MAY set/unset this
1187 Typical implementation would use [+|-]s on user interface
1188 to set/unset this mode.
1191 0x00000004 SILC_CMODE_PRIVKEY
1193 Channel uses private channel key to protect the traffic
1194 on the channel. When this mode is set the client will be
1195 responsible to set the key it wants to use to encrypt and
1196 decrypt the traffic on channel. Server generated channel
1197 keys are not used at all. This mode provides additional
1198 security as clients on channel may agree to use private
1199 channel key that even servers do not know. Naturally,
1200 this requires that every client on the channel knows
1201 the key before hand (it is considered to be pre-shared-
1202 key). The key material is RECOMMENDED to be processed
1203 as stated in the [SILC3] in the section Processing the
1206 As it is local setting it is possible to have several
1207 private channel keys on one channel. In this case several
1208 clients can talk on same channel but only those clients
1209 that share the key with the message sender will be able
1210 to hear the talking. Client SHOULD NOT display those
1211 message for the end user that it is not able to decrypt
1212 when this mode is set.
1214 Only channel founder MAY set/unset this mode. If this
1215 mode is unset the server will distribute new channel
1216 key to all clients on the channel which will be used
1219 Typical implementation would use [+|-]k on user interface
1220 to set/unset this mode.
1223 0x00000008 SILC_CMODE_INVITE
1225 Channel is invite only channel. Client may join to this
1226 channel only if it is invited to the channel. Channel
1227 founder and channel operator MAY set/unset this mode.
1229 Typical implementation would use [+|-]i on user interface
1230 to set/unset this mode.
1233 0x00000010 SILC_CMODE_TOPIC
1235 The topic of the channel may only be set by client that
1236 is channel founder or channel operator. Normal clients
1237 on channel will not be able to set topic when this mode
1238 is set. Channel founder and channel operator MAY set/
1241 Typical implementation would use [+|-]t on user interface
1242 to set/unset this mode.
1245 0x00000020 SILC_CMODE_ULIMIT
1247 User limit has been set to the channel. New clients
1248 may not join to the channel when the limit set is
1249 reached. Channel founder and channel operator MAY set/
1250 unset the limit. The <user limit> argument is the
1251 number of limited users.
1253 Typical implementation would use [+|-]l on user interface
1254 to set/unset this mode.
1257 0x00000040 SILC_CMODE_PASSPHRASE
1259 Passphrase has been set to the channel. Client may
1260 join to the channel only if it is able to provide the
1261 correct passphrase. Setting passphrases to channel
1262 is entirely safe as all commands are protected in the
1263 SILC network. Only channel founder MAY set/unset
1264 the passphrase. The <passphrase> argument is the
1267 Typical implementation would use [+|-]a on user interface
1268 to set/unset this mode.
1271 0x00000080 SILC_CMODE_CIPHER
1273 Sets specific cipher to be used to protect channel
1274 traffic. The <cipher> argument is the requested cipher.
1275 When set or unset the server must re-generate new
1276 channel key. Only channel founder MAY set the cipher of
1277 the channel. When unset the new key is generated using
1278 default cipher for the channel.
1280 Typical implementation would use [+|-]c on user interface
1281 to set/unset this mode.
1284 0x00000100 SILC_CMODE_HMAC
1286 Sets specific hmac to be used to compute the MACs of the
1287 channel message. The <hmac> argument is the requested hmac.
1288 Only channel founder may set the hmac of the channel.
1290 Typical implementation would use [+|-]h on user interface
1291 to set/unset this mode.
1294 0x00000200 SILC_CMODE_FOUNDER_AUTH
1296 Channel founder may set this mode to be able to regain
1297 channel founder rights even if the client leaves the
1298 channel. The <auth payload> is the Authentication Payload
1299 consisting of the authentication method and authentication
1300 data to be used in the authentication. The server MUST
1301 NOT accept NONE authentication method. Also, if the
1302 method is public key authentication the server MUST NOT
1303 save the authentication data from the payload as the
1304 data is different on all authentications. In this case the
1305 server only saves the authentication method. However,
1306 server MUST verify the sent authentication payload and
1307 set the mode only if the verification was successful.
1309 Note that this mode is effective only in the current server.
1310 The client MUST connect to the same server later to be able
1311 to regain the channel founder rights. The server MUST save
1312 the public key of the channel founder and use that to identify
1313 the client which is claiming the channel founder rights.
1314 The rights may be claimed by the SILC_CUMODE_FOUNDER
1315 channel user mode using SILC_COMMAND_CUMODE command. The
1316 set authentication data remains valid as long as the channel
1317 exists or until the founder unsets this mode.
1319 Typical implementation would use [+|-]f on user interface
1320 to set/unset this mode.
1323 0x00000400 SILC_CMODE_SILENCE_USERS
1325 Channel founder may set this mode to silence normal users
1326 on the channel. Users with operator privileges are not
1327 affected by this mode. Messages sent by normal users
1328 are dropped by servers when this mode is set. This mode
1329 can be used to moderate the channel. Only channel founder
1330 may set/unset this mode.
1333 0x00000800 SILC_CMODE_SILENCE_OPERS
1335 Channel founder may set this mode to silence operators
1336 on the channel. When used with SILC_CMODE_SILENCE_USERS
1337 mode this can be used to set the channel in state where only
1338 the founder of the channel may send messages to the channel.
1339 Messages sent by operators are dropped by servers when this
1340 mode is set. Only channel founder may set/unset this mode.
1343 To make the mode system work, client MUST keep the channel mode
1344 mask locally so that the mode setting and unsetting would work
1345 without problems. The client receives the initial channel mode
1346 mask when it joins to the channel. When the mode changes on
1347 channel the server MUST distribute the changed channel mode mask
1348 to all clients on the channel by sending the notify type
1349 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1350 to the server's primary router. If the <channel mode mask> was
1351 not provided this command merely returns the mode mask to the
1354 Reply messages to the command:
1357 Arguments: (1) <Status Payload> (2) <Channel ID>
1358 (3) <channel mode mask>
1360 This command replies with the changed channel mode mask that
1361 client MUST keep locally.
1366 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1367 SILC_STATUS_ERR_TOO_MANY_PARAMS
1368 SILC_STATUS_ERR_NOT_REGISTERED
1369 SILC_STATUS_ERR_NOT_ON_CHANNEL
1370 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1371 SILC_STATUS_ERR_BAD_CHANNEL_ID
1372 SILC_STATUS_ERR_NO_CHANNEL_ID
1373 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1374 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1375 SILC_STATUS_ERR_UNKNOWN_MODE
1376 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1377 SILC_STATUS_ERR_AUTH_FAILED
1380 18 SILC_COMMAND_CUMODE
1383 Arguments: (1) <Channel ID> (2) <mode mask>
1384 (3) <Client ID> (4) [<auth payload>]
1386 This command is used by client to change channel user modes on
1387 channel. Users on channel may have some special modes and this
1388 command is used by channel operators to set or change these modes.
1389 The <Channel ID> is the ID of the target channel. The <mode mask>
1390 is OR'ed mask of modes. The <Client ID> is the target client.
1391 The client changing channel user modes MUST be on the same channel
1392 as the target client and poses sufficient privileges to be able to
1395 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1396 type is distributed to the channel.
1398 The following channel modes are defined:
1400 0x00000000 SILC_CUMODE_NONE
1402 No specific mode. This is the normal situation for client.
1403 Also, this is the mode set when removing all modes from
1407 0x00000001 SILC_CUMODE_FOUNDER
1409 The client is channel founder of the channel. Usually this
1410 mode is set only by the server when the channel was created.
1411 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1412 been set, the client can claim channel founder privileges
1413 by providing the <auth payload> that the server will use
1414 to authenticate the client. The public key that server will
1415 use to verify the <auth payload> must the same public key
1416 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1417 mode was set. The client MAY remove this mode at any time.
1420 0x00000002 SILC_CUMODE_OPERATOR
1422 Sets channel operator privileges on the channel for a
1423 client on the channel. Channel founder and channel operator
1424 MAY set/unset this mode. The client MAY remove this mode
1428 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1430 Marks that the client wishes not to receive any channel
1431 messages sent for the channel. Client MAY set and unset
1432 this mode to itself. Client MUST NOT set it to anyone else.
1433 When this mode is set server MUST NOT deliver channel
1434 messages to this client. Other packets such as channel
1435 key packets are still sent to the client.
1437 A separate service could provide additional filtering
1438 features for accepting channel messages from certain
1439 sender. However, this document does not specify such
1443 Reply messages to the command:
1446 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1447 (3) <Channel ID> (4) <Client ID>
1449 This command replies with the changed channel user mode mask that
1450 client MUST keep locally. The <Channel ID> is the specified
1451 channel. The <Client ID> is the target client.
1456 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1457 SILC_STATUS_ERR_TOO_MANY_PARAMS
1458 SILC_STATUS_ERR_NOT_REGISTERED
1459 SILC_STATUS_ERR_NOT_ON_CHANNEL
1460 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1461 SILC_STATUS_ERR_BAD_CHANNEL_ID
1462 SILC_STATUS_ERR_NO_CHANNEL_ID
1463 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1464 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1465 SILC_STATUS_ERR_UNKNOWN_MODE
1466 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1467 SILC_STATUS_ERR_AUTH_FAILED
1470 19 SILC_COMMAND_KICK
1473 Arguments: (1) <Channel ID> (2) <Client ID>
1476 This command is used by channel operators to remove a client from
1477 channel. The <channel> argument is the channel the client to be
1478 removed is on currently. Note that the "kicker" must be on the same
1479 channel. If <comment> is provided it will be sent to the removed
1482 After kicking the client the server MUST send the notify type
1483 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1484 The channel key MUST also be re-generated after kicking, unless
1485 the SILC_CMODE_PRIVKEY mode is set.
1487 Reply messages to the command:
1490 Arguments: (1) <Status Payload>
1492 This command replies only with Status Payload.
1497 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1498 SILC_STATUS_ERR_TOO_MANY_PARAMS
1499 SILC_STATUS_ERR_NOT_REGISTERED
1500 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1501 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1502 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1503 SILC_STATUS_ERR_NO_CLIENT_ID
1509 Arguments: (1) <Channel ID> (2) [<adding client>]
1510 (3) [<removing client>]
1512 This command is used to manage the ban list of the channel
1513 indicated by the <Channel ID>. A client that is banned from
1514 channel is no longer able to join the channel. The client which
1515 is executing this command MUST have at least channel operator
1516 privileges on the channel.
1518 The <adding client> and <removing client> are used to add to and
1519 remove from the ban list. The format of the <adding client> and
1520 the <removing client> is of following format:
1522 [<nickname>[@<server>]!][<username>]@[<hostname>]
1524 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1525 primary router after adding to or removing from the ban list.
1526 The wildcards MAY be used with this command. If adding or removing
1527 from than one clients then the lists are an comma (`,') separated.
1529 If this command is executed without the ban arguments the command
1530 merely replies with the current ban list.
1533 Reply messages to the command:
1536 Arguments: (1) <Status Payload> (2) <Channel ID>
1539 This command replies with the <Channel ID> of the channel and
1540 the current <ban list> of the channel if it exists.
1545 SILC_STATUS_ERR_NOT_REGISTERED
1546 SILC_STATUS_ERR_TOO_MANY_PARAMS
1547 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1548 SILC_STATUS_ERR_NO_CHANNEL_ID
1549 SILC_STATUS_ERR_NOT_ON_CHANNEL
1550 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1553 21 <deprecated command>
1556 22 <deprecated command>
1559 23 SILC_COMMAND_SILCOPER
1562 Arguments: (1) <username> (2) <authentication payload>
1564 This command is used by normal client to obtain router operator
1565 privileges (also known as SILC operator) on the router. Note
1566 that router operator has privileges that supersedes the server
1567 operator privileges.
1569 The <username> is the username set in the server configurations
1570 as operator. The <authentication payload> is the data that the
1571 client is authenticated against. It may be passphrase prompted
1572 for user on client's screen or it may be public key or certificate
1573 authentication data (data signed with private key). The public
1574 key that router will use to verify the signature found in the
1575 payload should be verified. It is recommended that the public
1576 key is saved locally in the router and router would not use
1577 any public keys received during the SKE.
1579 Difference between router operator and server operator is that
1580 router operator is able to handle cell level properties while
1581 server operator (even on router server) is able to handle only
1582 local properties, such as, local connections and normal server
1583 administration. The router operator is also able to use the
1584 SILC_COMMAND_KILL command.
1586 After changing the mode server MUST send the notify type
1587 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1589 Reply messages to the command:
1592 Arguments: (1) <Status Payload>
1594 This command replies only with Status Payload.
1599 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1600 SILC_STATUS_ERR_TOO_MANY_PARAMS
1601 SILC_STATUS_ERR_NOT_REGISTERED
1602 SILC_STATUS_ERR_AUTH_FAILED
1605 24 SILC_COMMAND_LEAVE
1608 Arguments: (1) <Channel ID>
1610 This command is used by client to leave a channel the client is
1613 When leaving channel the server MUST send the notify type
1614 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1615 The channel key MUST also be re-generated when leaving the channel
1616 and distribute it to all clients still currently on the channel.
1617 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1620 Reply messages to the command:
1623 Arguments: (1) <Status Payload> (2) <Channel ID>
1625 The <Channel ID> is the ID of left channel.
1630 SILC_STATUS_ERR_NOT_REGISTERED
1631 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1632 SILC_STATUS_ERR_TOO_MANY_PARAMS
1633 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1634 SILC_STATUS_ERR_BAD_CHANNEL_ID
1635 SILC_STATUS_ERR_NO_CHANNEL_ID
1638 25 SILC_COMMAND_USERS
1641 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1643 This command is used to list user names currently on the requested
1644 channel; either the argument <Channel ID> or the <channel name>.
1645 One of these arguments must be present. The server MUST resolve
1646 the joined clients and reply with a lists of users on the channel
1647 and with list of user modes on the channel.
1649 If the requested channel is a private or secret channel, this
1650 command MUST NOT send the list of users, but error is returned
1651 to the sender, except if the sender is on the channel, or the
1654 Reply messages to the command:
1657 Arguments: (1) <Status Payload> (2) <Channel ID>
1658 (3) <list count> (4) <Client ID list>
1659 (5) <client mode list>
1661 This command replies with the Channel ID of the requested channel
1662 Client ID list of the users on the channel and list of their modes.
1663 The Client ID list has Client ID's of all users in the list. The
1664 <Client ID list> is formed by adding Client ID's one after another.
1665 The <client mode list> is formed by adding client's user modes on
1666 the channel one after another (4 bytes (32 bits) each). The <list
1667 count> of length of 4 bytes (32 bits), tells the number of entries
1668 in the lists. Both lists MUST have equal number of entries.
1673 SILC_STATUS_ERR_NOT_REGISTERED
1674 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1675 SILC_STATUS_ERR_TOO_MANY_PARAMS
1676 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1677 SILC_STATUS_ERR_BAD_CHANNEL_ID
1678 SILC_STATUS_ERR_NO_CHANNEL_ID
1679 SILC_STATUS_ERR_NOT_ON_CHANNEL
1682 26 SILC_COMMAND_GETKEY
1685 Arguments: (1) <ID Payload>
1687 This command is used to fetch the public key of the client or
1688 server indicated by the <ID Payload>. The public key is fetched
1689 from the server where to the client is connected.
1691 Reply messages to the command:
1694 Arguments: (1) <Status Payload> (2) <ID Payload>
1695 (3) [<Public Key Payload>]
1697 This command replies with the client's or server's ID and with
1698 the <Public Key Payload>.
1703 SILC_STATUS_ERR_NOT_REGISTERED
1704 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1705 SILC_STATUS_ERR_TOO_MANY_PARAMS
1706 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1707 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1712 Currently undefined commands.
1717 These commands are reserved for private use and will not be defined
1721 255 SILC_COMMAND_MAX
1723 Reserved command. This must not be sent.
1728 2.3 SILC Command Status Types
1731 2.3.1 SILC Command Status Payload
1733 Command Status Payload is sent in command reply messages to indicate
1734 the status of the command. The payload is one of argument in the
1735 command thus this is the data area in Command Argument Payload described
1736 in [SILC2]. The payload is only 2 bytes of length. The following diagram
1737 represents the Command Status Payload (field is always in MSB order).
1743 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1744 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1746 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1750 Figure 6: SILC Command Status Payload
1754 o Status (1 byte) - Indicates the status message type,
1755 error, start of list, entry of list or end of list.
1757 o Error (1 byte) - Indicates the error if the Status
1758 field is some list status, which means there are list
1762 The values in Status and Error fields are set according
1763 the following rules:
1766 o If there is single reply and error has not occurred
1767 then Status field includes value SILC_STATUS_OK, and
1768 the Error field MUST be ignored (and set to zero
1771 o If there is single error, then Status field includes
1772 one of the error values, and the Error field MUST be
1773 ignored (and set to zero value).
1775 o If there will be multiple successful command replies
1776 then Status field includes SILC_STATUS_LIST_START,
1777 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1778 and Error field is set to SILC_STATUS_OK.
1780 o If there are multiple error replies then Status field
1781 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1782 or SILC_STATUS_LIST_END value, and the Error field
1783 includes the error value.
1786 This way it is possible to send single successful or
1787 single error reply, but also multiple successful and
1788 multiple error replies. Note that it is possible to
1789 send both list of successful replies and list of error
1790 replies at the same time, however in this case the
1791 list of error replies MUST be sent after the successful
1792 replies. This way the recipient may ignore the multiple
1793 errors if it wishes to do so.
1795 All Status messages are described in the next section.
1799 2.3.2 SILC Command Status List
1801 Command Status messages are returned in the command reply messages
1802 to indicate whether the command were executed without errors. If error
1803 has occurred the status indicates which error occurred. Status payload
1804 only sends numeric reply about the status. Receiver of the payload must
1805 convert the numeric values into human readable error messages. The
1806 list of status messages below has an example human readable error
1807 messages that client may display for the user.
1809 List of all defined command status messages following.
1812 Generic status messages:
1816 Ok status. Everything went Ok. The status payload maybe
1817 safely ignored in this case.
1819 1 SILC_STATUS_LIST_START
1821 Start of the list. There will be several command replies and
1822 this reply is the start of the list.
1824 2 SILC_STATUS_LIST_ITEM
1826 Item in the list. This is one of the item in the list but not the
1829 3 SILC_STATUS_LIST_END
1831 End of the list. There were several command replies and this
1832 reply is the last of the list. There won't be other replies
1833 belonging to this list after this one.
1837 Currently undefined and has been reserved for the future.
1840 Error status message:
1844 10 SILC_STATUS_ERR_NO_SUCH_NICK
1846 "No such nickname". Requested nickname does not exist.
1848 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1850 "No such channel". Requested channel name does not exist.
1852 12 SILC_STATUS_ERR_NO_SUCH_SERVER
1854 "No such server". Requested server name does not exist.
1856 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
1858 "Duplicate recipients. No message delivered". Message were
1859 tried to be sent to recipient which has several occurrences in
1862 14 SILC_STATUS_ERR_NO_RECIPIENT
1864 "No recipient given". Command required recipient which was
1867 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
1869 "Unknown command". Command sent to server is unknown by the
1872 16 SILC_STATUS_ERR_WILDCARDS
1874 "Wildcards cannot be used". Wildcards were provided but they
1877 17 SILC_STATUS_ERR_NO_CLIENT_ID
1879 "No Client ID given". Client ID were expected as command
1880 parameter but were not found.
1882 18 SILC_STATUS_ERR_NO_CHANNEL_ID
1884 "No Channel ID given". Channel ID were expected as command
1885 parameter but were not found.
1887 19 SILC_STATUS_ERR_NO_SERVER_ID
1889 "No Serve ID given". Server ID were expected as command
1890 parameter but were not found.
1892 20 SILC_STATUS_ERR_BAD_CLIENT_ID
1894 "Bad Client ID". Client ID provided were erroneous.
1896 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
1898 "Bad Channel ID". Channel ID provided were erroneous.
1900 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1902 "No such Client ID". Client ID provided does not exist.
1904 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1906 "No such Channel ID". Channel ID provided does not exist.
1908 24 SILC_STATUS_ERR_NICKNAME_IN_USE
1910 "Nickname already exists". Nickname created could not be
1911 registered because number of same nicknames were already set to
1912 maximum. This is not expected to happen in real life but is
1915 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
1917 "You are not on that channel". The command were specified for
1918 channel user is not currently on.
1920 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1922 "They are not on channel". The requested target client is not
1923 on requested channel.
1925 27 SILC_STATUS_ERR_USER_ON_CHANNEL
1927 "User already on channel". User were invited on channel they
1930 28 SILC_STATUS_ERR_NOT_REGISTERED
1932 "You have not registered". User executed command that requires
1933 the client to be registered on the server before it may be
1936 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1938 "Not enough parameters". Command requires more parameters
1941 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
1943 "Too many parameters". Too many parameters were provided
1946 31 SILC_STATUS_ERR_PERM_DENIED
1948 "Permission denied". Generic permission denied error status
1949 to indicate disallowed access.
1951 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
1953 "You are banned from this server". The client tried to register
1954 on server that has explicitly denied this host to connect.
1956 33 SILC_STATUS_ERR_BAD_PASSWORD
1958 "Cannot join channel. Incorrect password". Password provided for
1959 channel were not accepted.
1961 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
1963 "Cannot join channel. Channel is full". The channel is full
1964 and client cannot be joined to it.
1966 35 SILC_STATUS_ERR_NOT_INVITED
1968 "Cannot join channel. You have not been invited". The channel
1969 is invite only channel and client has not been invited.
1971 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1973 "Cannot join channel. You have been banned". The client has
1974 been banned from the channel.
1976 37 SILC_STATUS_ERR_UNKNOWN_MODE
1978 "Unknown mode". Mode provided by the client were unknown to
1981 38 SILC_STATUS_ERR_NOT_YOU
1983 "Cannot change mode for other users". User tried to change
1984 someone else's mode.
1986 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1988 "Permission denied. You are not channel operator". Command may
1989 be executed only by channel operator.
1991 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1993 "Permission denied. You are not channel founder". Command may
1994 be executed only by channel operator.
1996 41 SILC_STATUS_ERR_NO_SERVER_PRIV
1998 "Permission denied. You are not server operator". Command may
1999 be executed only by server operator.
2001 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2003 "Permission denied. You are not SILC operator". Command may be
2004 executed only by router (SILC) operator.
2006 43 SILC_STATUS_ERR_BAD_NICKNAME
2008 "Bad nickname". Nickname requested contained illegal characters
2011 44 SILC_STATUS_ERR_BAD_CHANNEL
2013 "Bad channel name". Channel requested contained illegal characters
2016 45 SILC_STATUS_ERR_AUTH_FAILED
2018 "Authentication failed". The authentication data sent as
2019 argument were wrong and thus authentication failed.
2021 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2023 "The algorithm was not supported." The server does not support the
2024 requested algorithm.
2026 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2028 "No such Server ID". Server ID provided does not exist.
2034 3 Security Considerations
2036 Security is central to the design of this protocol, and these security
2037 considerations permeate the specification. Common security considerations
2038 such as keeping private keys truly private and using adequate lengths for
2039 symmetric and asymmetric keys must be followed in order to maintain the
2040 security of this protocol.
2046 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2047 Protocol Specification", Internet Draft, April 2001.
2049 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2052 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2053 Protocols", Internet Draft, April 2001.
2055 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2058 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2061 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2064 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2067 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2070 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2073 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2076 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2079 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2080 Infrastructure, Certificate and CRL Profile", RFC 2459,
2083 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2084 John Wiley & Sons, New York, NY, 1996.
2086 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2089 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2090 RFC 2412, November 1998.
2092 [ISAKMP] Maughan D., et al, "Internet Security Association and
2093 Key Management Protocol (ISAKMP)", RFC 2408, November
2096 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2097 (IKE)", RFC 2409, November 1998.
2099 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2100 Authentication", RFC 2104, February 1997.
2102 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2103 Specifications, Version 2.0", RFC 2437, October 1998.
2105 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2106 Requirement Levels", BCP 14, RFC 2119, March 1997.
2108 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2109 10646", RFC 2279, January 1998.
2120 Snellmanninkatu 34 A 15
2124 EMail: priikone@iki.fi
2130 This appendix defines the usage of the <Requested Attributes> argument in
2131 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2132 and may be used to request additional information about the user. Since
2133 the information that may be requested using the attributes is something
2134 that server cannot deliver to the sender, it is possible to send the WHOIS
2135 command directly to the destination client whom will then provide the
2136 requested attributes. This requires the servers to relay the WHOIS
2137 command to the client, and it requires capability for handling the WHOIS
2138 command in the client end.
2143 This Internet-Draft expires XXX
projects / silc.git / blob