8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-03.txt XXX
26 <draft-riikonen-silc-commands-03.txt>
31 This document is an Internet-Draft and is in full conformance with
32 all provisions of Section 10 of RFC 2026. Internet-Drafts are
33 working documents of the Internet Engineering Task Force (IETF), its
34 areas, and its working groups. Note that other groups may also
35 distribute working documents as Internet-Drafts.
37 Internet-Drafts are draft documents valid for a maximum of six months
38 and may be updated, replaced, or obsoleted by other documents at any
39 time. It is inappropriate to use Internet-Drafts as reference
40 material or to cite them other than as "work in progress."
42 The list of current Internet-Drafts can be accessed at
43 http://www.ietf.org/ietf/1id-abstracts.txt
45 The list of Internet-Draft Shadow Directories can be accessed at
46 http://www.ietf.org/shadow.html
48 The distribution of this memo is unlimited.
54 This memo describes the commands used in the Secure Internet Live
55 Conferencing (SILC) protocol, specified in the Secure Internet Live
56 Conferencing, Protocol Specification Internet Draft [SILC1]. The
57 SILC Commands are very important part of the SILC protocol. Usually
58 the commands are used by SILC clients to manage the SILC session, but
59 also SILC servers may use the commands. This memo specifies detailed
60 command messages and command reply messages.
73 1 Introduction .................................................. 2
74 1.1 Requirements Terminology .................................. 2
75 2 SILC Commands ................................................. 2
76 2.1 SILC Commands Syntax ...................................... 2
77 2.2 SILC Commands List ........................................ 4
78 2.3 SILC Command Status Types ................................. 33
79 2.3.1 SILC Command Status Payload ......................... 33
80 2.3.2 SILC Command Status List ............................ 33
81 3 Security Considerations ....................................... 38
82 4 References .................................................... 38
83 5 Author's Address .............................................. 40
89 This document describes the commands used in the Secure Internet Live
90 Conferencing (SILC) protocol, specified in the Secure Internet Live
91 Conferencing, Protocol Specification Internet Draft [SILC1]. This
92 document specifies detailed command messages and command reply messages.
94 Commands are very important part on SILC network especially for client
95 which uses commands to operate on the SILC network. Commands are used
96 to set nickname, join to channel, change modes and many other things.
98 See the [SILC1] for the requirements and the restrictions for the usage
99 of the SILC commands. The [SILC2] defines the command packet type and
100 the Command Payload which is actually used to deliver the commands and
101 command reply messages.
105 1.1 Requirements Terminology
107 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
108 MAY, and OPTIONAL, when they appear in this document, are to be
109 interpreted as described in [RFC2119].
116 2.1 SILC Commands Syntax
118 This section briefly describes the syntax of the command notions
119 in this document. Every field in command is separated from each
120 other by whitespaces (` ') indicating that each field is independent
121 argument and each argument MUST have own Command Argument Payload.
122 The number of maximum arguments are defined with each command
123 separately. The Command Argument Payload is described in [SILC2].
125 Every command defines specific number for each argument. Currently,
126 they are defined in ascending order; first argument has number one
127 (1), second has number two (2) and so on. This number is set into the
128 Argument Type field in the Command Argument Payload. This makes it
129 possible to send the arguments in free order as the number MUST be
130 used to identify the type of the argument. This makes is it also
131 possible to have multiple optional arguments in commands and in
132 command replies. The number of argument is marked in parentheses
133 before the actual argument.
138 Example: Arguments: (1) <nickname> (2) <username@host>
142 Every command replies with Status Payload. This payload tells the
143 sender of the command whether the command was completed successfully or
144 whether there was an error. If error occurred the payload includes the
145 error type. In the next section the Status Payload is not described
146 as it is common to all commands and has been described here. Commands
147 MAY reply with other arguments as well. These arguments are command
148 specific and are described in the next section.
157 Arguments: (1) <nickname>[@<server>] (2) <message>
160 The command has maximum of 3 arguments. However, only first
161 and second arguments are mandatory.
163 First argument <nickname> is mandatory but may have optional
164 <nickname@server> format as well. Second argument is mandatory
165 <message> argument. Third argument is optional <count> argument.
167 The numbers in parentheses are the argument specific numbers
168 that specify the type of the argument in Command Argument Payload.
169 The receiver always knows that, say, argument number two (2) is
170 <message> argument, regardless of the ordering of the arguments in
173 Reply messages to the command:
176 Arguments: (1) <Status Payload> (2) [<channel list>]
177 (3) <idle time> (4) [<away message>]
179 This command may reply with maximum of 4 arguments. However,
180 only the first and third arguments are mandatory. The numbers
181 in the parentheses have the same meaning as in the upper
182 command sending specification.
184 Every command reply with <Status Payload>, it is mandatory
185 argument for all command replies and for this reason it is not
186 described in the command reply descriptions.
193 SILC_STATUS_ERR_TOO_MANY_TARGETS
194 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195 SILC_STATUS_ERR_NO_SUCH_NICK
197 Every command reply also defines set of status message that it
198 may return inside the <Status Payload>. All status messages
199 are defined in the section 2.3 SILC Command Status Types.
202 Every command that has some kind of ID as argument (for example
203 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
204 the type of the ID, length of the ID and the actual ID data. This
205 way variable length ID's can be sent as arguments. Also note that
206 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
211 2.2 SILC Commands List
213 This section lists all SILC commands, however, it is expected that a
214 implementation and especially client implementation has many more
215 commands that has only local affect. These commands are official
216 SILC commands that has both client and server sides and cannot be
217 characterized as local commands.
219 List of all defined commands in SILC follows.
224 None. This is reserved command and MUST NOT be sent.
230 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
231 (3) [<Client ID>] (n) [...]
233 Whois command is used to query various information about specific
234 user. The user may be requested by their nickname and server name.
235 The query may find multiple matching users as there are no unique
236 nicknames in the SILC. The <count> option may be given to narrow
237 down the number of accepted results. If this is not defined there
238 are no limit of accepted results. The query may also be narrowed
239 down by defining the server name of the nickname. The <count> is
242 It is also possible to search the user by Client ID. If the
243 <Client ID> is provided server MUST use it as the search value
244 instead of the <nickname>. One of the arguments MUST be given.
245 It is also possible to define multiple Client ID's to search
246 multiple users sending only one WHOIS command. In this case the
247 Client ID's are appended as normal arguments.
249 To prevent miss-use of this command wildcards in the nickname
250 or in the server name are not permitted. It is not allowed
251 to request all users on some server. The WHOIS requests MUST
252 be based on specific nickname request.
254 The WHOIS request MUST be always sent to the router by server
255 so that all users are searched. However, the server still MUST
256 search its locally connected clients. The router MUST send
257 this command to the server which owns the requested client. That
258 server MUST reply to the command. Server MUST NOT send whois
259 replies to the client until it has received the reply from its
262 Reply messages to the command:
265 Arguments: (1) <Status Payload> (2) <Client ID>
266 (3) <nickname>[@<server>] (4) <username@host>
267 (5) <real name> (6) [<Channel Payload
269 (7) [<user mode>] (8) [<idle time>]
273 This command may reply with several command reply messages to
274 form a list of results. In this case the status payload will
275 include STATUS_LIST_START status in the first reply and
276 STATUS_LIST_END in the last reply to indicate the end of the
277 list. If there are only one reply the status is set to normal
280 The command replies include the Client ID of the nickname,
281 nickname and server name, user name and host name and user's real
282 name. Client SHOULD process these replies only after the last
283 reply has been received with the STATUS_LIST_END status. If the
284 <count> option were defined in the query there will be only
285 <count> many replies from the server.
287 The server may return the list of channels if the client has
288 joined channels. In this case the list is list of Channel
289 Payloads. The Mode Mask in the Channel Payload (see [SILC2] and
290 section 2.3.2.3 for the Channel Payload) is the client's mode
291 on the channel. The list is encoded by adding the Channel
292 Payloads one after the other.
294 The server may also send client's user mode, idle time, and the
295 fingerprint of the client's public key. The <fingerprint> is the
296 binary hash digest of the public key. The fingerprint MUST NOT
297 be sent if the server has not verified the proof of posession of
298 the corresponding private key. Server can do this during the
299 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
304 SILC_STATUS_LIST_START
306 SILC_STATUS_ERR_NO_SUCH_NICK
307 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
308 SILC_STATUS_ERR_WILDCARDS
309 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
310 SILC_STATUS_ERR_TOO_MANY_PARAMS
313 2 SILC_COMMAND_WHOWAS
316 Arguments: (1) <nickname>[@<server>] (2) [<count>]
318 Whowas. This command is used to query history information about
319 specific user. The user may be requested by their nickname and
320 server name. The query may find multiple matching users as there
321 are no unique nicknames in the SILC. The <count> option may be
322 given to narrow down the number of accepted results. If this
323 is not defined there are no limit of accepted results. The query
324 may also be narrowed down by defining the server name of the
325 nickname. The <count> is in string format.
327 To prevent miss-use of this command wildcards in the nickname
328 or in the server name are not permitted. The WHOWAS requests MUST
329 be based on specific nickname request.
331 The WHOWAS request MUST be always sent to the router by server
332 so that all users are searched. However, the server still must
333 search its locally connected clients.
335 Reply messages to the command:
338 Arguments: (1) <Status Payload> (2) <Client ID>
339 (3) <nickname>[@<server>] (4) <username@host>
342 This command may reply with several command reply messages to form
343 a list of results. In this case the status payload will include
344 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
345 the last reply to indicate the end of the list. If there are only
346 one reply the status is set to normal STATUS_OK.
348 The command replies with nickname and user name and host name.
349 Every server MUST keep history for some period of time of its
350 locally connected clients.
355 SILC_STATUS_LIST_START
357 SILC_STATUS_ERR_NO_SUCH_NICK
358 SILC_STATUS_ERR_WILDCARDS
359 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
360 SILC_STATUS_ERR_TOO_MANY_PARAMS
363 3 SILC_COMMAND_IDENTIFY
366 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
367 (3) [<channel name>] (4) [<count>]
368 (5) [<ID Payload>] (n) [...]
370 Identify command is used to query information about an entity by
371 the entity's name or ID. This command can be used to query
372 information about clients, server and channels.
374 The query may find multiple matching entities. The <count> option
375 may be given to narrow down the number of accepted results. If
376 this is not defined there are no limit of accepted results. The
377 <count> is in string format.
379 It is also possible to search the entity by its ID. If the
380 <ID Payload> is provided server must use it as the search value
381 instead of the entity's name. One of the arguments must be given.
382 It is also possible to define multiple ID Payloads to search
383 multiple entities sending only one IDENTIFY command. In this case
384 the ID Payloads are appended as normal arguments. The type of the
385 entity is defined by the type of the ID Payload.
387 To prevent miss-use of this command wildcards in the names are
388 not permitted. It is not allowed to request for example all users
391 Implementations may not want to give interface access to this
392 command as it is hardly a command that would be used by an end
393 user. However, it must be implemented as it is used with private
396 The IDENTIFY command MUST be always sent to the router by server
397 so that all users are searched. However, server MUST still search
398 its locally connected clients.
400 Reply messages to the command:
403 Arguments: (1) <Status Payload> (2) <ID Payload>
404 (3) [<entity's name>] (4) [<info>]
406 This command may reply with several command reply messages to form
407 a list of results. In this case the status payload will include
408 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
409 the last reply to indicate the end of the list. If there are only
410 one reply the status is set to normal STATUS_OK.
412 When querying clients the <entity's name> must include the client's
413 nickname in the following format: nickname[@server]. The
414 <info> must include the client's username and host in the following
415 format: username@host.
417 When querying servers the <entity's name> must include the server's
418 full name. The <info> may be omitted.
420 When querying channels the <entity's name> must include the
421 channel's name. The <info> may be omitted.
423 If the <count> option were defined in the query there will be only
424 <count> many replies from the server.
429 SILC_STATUS_LIST_START
431 SILC_STATUS_ERR_NO_SUCH_NICK
432 SILC_STATUS_ERR_NO_SUCH_SERVER
433 SILC_STATUS_ERR_NO_SUCH_CHANNEL
434 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
435 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
436 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
437 SILC_STATUS_ERR_WILDCARDS
438 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
439 SILC_STATUS_ERR_TOO_MANY_PARAMS
445 Arguments: (1) <nickname>
447 Set/change nickname. This command is used to set nickname for
448 user. Nickname MUST NOT include any spaces (` '), non-printable
449 characters, commas (`,') and any wildcard characters. Note that
450 nicknames in SILC are case-sensitive which must be taken into
451 account when searching clients by nickname.
453 When nickname is changed new Client ID is generated. Server MUST
454 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
455 channels (if any) the client is joined on. Then it MUST send
456 SILC_PACKET_REPLACE_ID to its primary route to replace the old
457 Client ID with the new one.
459 Reply messages to the command:
462 Arguments: (1) <Status Payload> (2) <New ID Payload>
464 This command is replied always with New ID Payload that is
465 generated by the server every time user changes their nickname.
466 Client receiving this payload MUST start using the received
467 Client ID as its current valid Client ID. The New ID Payload
468 is described in [SILC2].
473 SILC_STATUS_ERR_WILDCARDS
474 SILC_STATUS_ERR_NICKNAME_IN_USE
475 SILC_STATUS_ERR_BAD_NICKNAME
476 SILC_STATUS_ERR_NOT_REGISTERED
477 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
478 SILC_STATUS_ERR_TOO_MANY_PARAMS
484 Arguments: (1) [<Channel ID>]
486 The list command is used to list channels and their topics on the
487 current server. If the <Channel ID> parameter is used, only the
488 status of that channel is displayed. Secret channels are not
489 listed at all. Private channels are listed with status indicating
490 that the channel is private. Router MAY reply with all channels
493 Reply messages to the command:
496 Arguments: (1) <Status Payload> (2) <Channel ID>
497 (3) <channel> (4) [<topic>]
500 This command may reply with several command reply messages to form
501 a list of results. In this case the status payload will include
502 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
503 the last reply to indicate the end of the list. If there are only
504 one reply the status is set to normal STATUS_OK.
506 This command replies with Channel ID, name and the topic of the
507 channel. If the channel is private channel the <topic> SHOULD
508 include the "*private*" string.
513 SILC_STATUS_LIST_START
515 SILC_STATUS_ERR_WILDCARDS
516 SILC_STATUS_ERR_NOT_REGISTERED
517 SILC_STATUS_ERR_TOO_MANY_PARAMS
518 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
519 SILC_STATUS_ERR_NO_CHANNEL_ID
520 SILC_STATUS_ERR_NO_SUCH_SERVER
526 Arguments: (1) <Channel ID> (2) [<topic>]
528 This command is used to change or view the topic of a channel.
529 The topic for channel <Channel ID> is returned if there is no
530 <topic> given. If the <topic> parameter is present, the topic
531 for that channel will be changed, if the channel modes permit
534 After setting the topic the server MUST send the notify type
535 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
536 the channel which topic was changed.
538 Reply messages to the command:
541 Arguments: (1) <Status Payload> (2) <Channel ID>
544 The command may reply with the topic of the channel if it is
550 SILC_STATUS_ERR_NOT_ON_CHANNEL
551 SILC_STATUS_ERR_WILDCARDS
552 SILC_STATUS_ERR_NOT_REGISTERED
553 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
554 SILC_STATUS_ERR_NO_SUCH_CHANNEL
555 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
556 SILC_STATUS_ERR_NO_CHANNEL_ID
557 SILC_STATUS_ERR_BAD_CHANNEL_ID
558 SILC_STATUS_ERR_TOO_MANY_PARAMS
559 SILC_STATUS_ERR_NO_CHANNEL_PRIV
562 7 SILC_COMMAND_INVITE
565 Arguments: (1) <Channel ID> (2) [<Client ID>]
566 (3) [<adding client>] (4) [<removing client>]
568 This command is used to invite other clients to join to the
569 channel. The <Client ID> argument is the target client's ID that
570 is being invited. The <Channel ID> is the Channel ID of the
571 requested channel. The sender of this command MUST be on the
572 channel. The server MUST also send the notify type
573 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
574 client indicated by the <Client ID>.
576 The <adding client> and <removing client> can be used to add to
577 and remove from the invite list. The format of the <adding client>
578 and <removing client> is as follows:
580 [<nickname>[@<server>]!][<username>]@[<hostname>]
582 When adding to or removing from the invite list the server MUST
583 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
584 and MUST NOT send it to the client which was added to the list.
585 The client which executes this command MUST have at least channel
586 operator privileges to be able to add to or remove from the invite
587 list. The wildcards MAY be used with this command. If adding or
588 removing more than one client then the lists are an comma (`,')
591 Note that the <Client ID> provided MUST be resolved into correct
592 nickname and host name and add to the invite list before sending
595 When this command is given with only <Channel ID> argument then
596 the command merely returns the invite list of the channel. This
597 command MUST fail if the requested channel does not exist, the
598 requested <Client ID> is already on the channel or if the channel
599 is invite only channel and the caller of this command does not
600 have at least channel operator privileges.
602 Reply messages to the command:
605 Arguments: (1) <Status Payload> (2) <Channel ID>
608 This command replies with the invite list of the channel if it
614 SILC_STATUS_ERR_NOT_REGISTERED
615 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
616 SILC_STATUS_ERR_TOO_MANY_PARAMS
617 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
618 SILC_STATUS_ERR_NO_CLIENT_ID
619 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
620 SILC_STATUS_ERR_NO_CHANNEL_ID
621 SILC_STATUS_ERR_NOT_ON_CHANNEL
622 SILC_STATUS_ERR_USER_ON_CHANNEL
623 SILC_STATUS_ERR_NO_CHANNEL_PRIV
629 Arguments: (1) [<quit message>]
631 This command is used by client to end SILC session. The server
632 must close the connection to a client which sends this command.
633 if <quit message> is given it will be sent to other clients on
634 channel if the client is on channel when quitting.
636 Reply messages to the command:
638 This command does not reply anything.
644 Arguments: (1) <Client ID> (2) [<comment>]
646 This command is used by SILC operators to remove a client from
647 SILC network. The removing has temporary effects and client may
648 reconnect to SILC network. The <Client ID> is the client to be
649 removed from SILC. The <comment> argument may be provided to
650 give to the removed client some information why it was removed
653 When killing a client the router MUST first send notify type
654 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
655 The packet MUST NOT be sent to the killed client on the channels.
656 Then, the router MUST send the same notify type to its primary
657 router. Finally, the router MUST send the same notify type
658 directly to the client which was killed.
660 Reply messages to the command:
663 Arguments: (1) <Status Payload>
665 This command replies only with Status Payload.
670 SILC_STATUS_ERR_WILDCARDS
671 SILC_STATUS_ERR_NOT_REGISTERED
672 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
673 SILC_STATUS_ERR_TOO_MANY_PARAMS
674 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
675 SILC_STATUS_ERR_NO_CLIENT_ID
676 SILC_STATUS_ERR_NO_ROUTER_PRIV
682 Arguments: (1) [<server>] (2) [<Server ID>]
684 This command is used to fetch various information about a server.
685 If <server> argument is specified the command MUST be sent to
686 the requested server.
688 If the <Server ID> is specified the server information if fetched
689 by the provided Server ID. One of the arguments must always be
692 Reply messages to the command:
695 Arguments: (1) <Status Payload> (2) <Server ID>
696 (3) <server name> (4) <string>
698 This command replies with the Server ID of the server and a
699 string which tells the information about the server.
704 SILC_STATUS_ERR_WILDCARDS
705 SILC_STATUS_ERR_NOT_REGISTERED
706 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
707 SILC_STATUS_ERR_TOO_MANY_PARAMS
708 SILC_STATUS_ERR_NO_SUCH_SERVER
709 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
710 SILC_STATUS_ERR_NO_SERVER_ID
713 11 SILC_COMMAND_STATS
716 Arguments: (1) <Server ID>
718 This command is used to fetch various statistical information
719 from the server indicated by <Server ID>, which is the ID of
720 server where sender is connected to. Server receiving this
721 command MAY also send this further to its router for fetching
722 other cell and network wide statistics to accompany the reply.
724 Reply messages to the command:
727 Arguments: (1) <Status Payload> (2) <Server ID>
728 (3) [<statistics structure>]
730 This command replies with the Server ID of the server and
731 optional statistics structure which includes 32 bit MSB first
732 ordered integer values to represent various statistical
733 information. The structure is as follows:
735 starttime - time when server was started
736 uptime - uptime of the server
737 my clients - number of locally connected clients
738 my channels - number of locally created channels
739 my server ops - number of local server operators
740 my router ops - number of local router operators
741 cell clients - number of clients in local cell
742 cell channels - number of channels in local cell
743 cell servers - number of servers in local cell
744 clients - number of client in SILC network
745 channels - number of channels in SILC network
746 servers - number of servers in SILC network
747 routers - number of routers in SILC network
748 server ops - number of server operators in SILC network
749 router ops - number of router operators in SILC network
751 If some value is unknown it is set to zero (0) value. The
752 "starttime" is the start time of the server, and is seconds
753 since Epoch (POSIX.1). The "uptime" is time difference of
754 current time and "starttime" in the server, and is seconds
760 SILC_STATUS_ERR_NOT_REGISTERED
761 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
762 SILC_STATUS_ERR_TOO_MANY_PARAMS
763 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
764 SILC_STATUS_ERR_NO_SUCH_SERVER
765 SILC_STATUS_ERR_NO_SERVER_ID
771 Arguments: (1) <Server ID>
773 This command is used by client and server to test the communication
774 channel to its server if one suspects that the communication is not
775 working correctly. The <Server ID> is the ID of the server the
776 sender is connected to.
778 Reply messages to the command:
781 Arguments: (1) <Status Payload>
783 This command replies only with Status Payload. Server returns
784 SILC_STATUS_OK in Status Payload if pinging was successful.
791 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
792 SILC_STATUS_ERR_TOO_MANY_PARAMS
793 SILC_STATUS_ERR_NO_SERVER_ID
794 SILC_STATUS_ERR_NO_SUCH_SERVER
795 SILC_STATUS_ERR_NOT_REGISTERED
801 Arguments: (1) <username> (2) <authentication payload>
803 This command is used by normal client to obtain server operator
804 privileges on some server or router. Note that router operator
805 has router privileges that supersedes the server operator
806 privileges and this does not obtain those privileges. Client
807 MUST use SILCOPER command to obtain router level privileges.
809 The <username> is the username set in the server configurations
810 as operator. The <authentication payload> is the data that the
811 client is authenticated against. It may be passphrase prompted
812 for user on client's screen or it may be public key or certificate
813 authentication data (data signed with private key). The public
814 key that server will use to verify the signature found in the
815 payload should be verified. It is recommended that the public
816 key is saved locally in the server and server would not use
817 any public keys received during the SKE.
819 After changing the mode the server MUST send the notify type
820 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
822 Reply messages to the command:
825 Arguments: (1) <Status Payload>
827 This command replies only with Status Payload.
832 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
833 SILC_STATUS_ERR_TOO_MANY_PARAMS
834 SILC_STATUS_ERR_NOT_REGISTERED
835 SILC_STATUS_ERR_AUTH_FAILED
841 Arguments: (1) <channel> (2) <Client ID>
842 (3) [<passphrase>] (4) [<cipher>]
843 (5) [<hmac>] (6) [<founder auth>]
845 Join to channel/create new channel. This command is used to
846 join to a channel. If the channel does not exist the channel is
847 created. If server is normal server this command MUST be sent
848 to router which will create the channel. The channel MAY be
849 protected with passphrase. If this is the case the passphrase
850 MUST be sent along the join command.
852 The name of the <channel> MUST NOT include any spaces (` '),
853 non-printable characters, commas (`,') or any wildcard characters.
855 The second argument <Client ID> is the Client ID of the client
856 which is joining to the client. When client sends this command
857 to the server the <Client ID> MUST be the client's own ID.
859 Cipher to be used to secure the traffic on the channel MAY be
860 requested by sending the name of the requested <cipher>. This
861 is used only if the channel does not exist and is created. If
862 the channel already exists the cipher set previously for the
863 channel will be used to secure the traffic. The computed MACs
864 of the channel message are produced by the default HMAC or by
865 the <hmac> provided for the command.
867 The <founder auth> is Authentication Payload providing the
868 authentication for gaining founder privileges on the channel
869 when joining the channel. The client may provide this if it
870 knows that it is the founder of the channel and that the
871 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
872 MUST verify whether the client is able to gain the founder
873 privileges the same way as the client had given the
874 SILC_COMMAND_CUMODE command to gain founder privileges. The
875 client is still able to join the channel even if the founder
876 privileges could not be gained.
878 The server MUST check whether the user is allowed to join to
879 the requested channel. Various modes set to the channel affect
880 the ability of the user to join the channel. These conditions
883 o The user MUST be invited to the channel if the channel
884 is invite-only channel.
886 o The Client ID/nickname/username/host name MUST NOT match
889 o The correct passphrase MUST be provided if passphrase
890 is set to the channel.
892 o The user count limit, if set, MUST NOT be reached.
894 If the client provided correct <founder auth> payload it can
895 override these conditions, except the condition for the passphrase.
896 The correct passphrase MUST be provided even if <founder auth>
899 Reply messages to the command:
902 Arguments: (1) <Status Payload> (2) <channel>
903 (3) <Channel ID> (4) <Client ID>
904 (5) <channel mode mask> (6) <created>
905 (7) [<Channel Key Payload>] (8) [<ban list>]
906 (9) [<invite list>] (10) [<topic>]
907 (11) [<hmac>] (12) <list count>
908 (13) <Client ID list> (14) <client mode list>
910 This command replies with the channel name requested by the
911 client, channel ID of the channel and topic of the channel
912 if it exists. The <Client ID> is the Client ID which was joined
913 to the channel. It also replies with the channel mode mask
914 which tells all the modes set on the channel. If the
915 channel is created the mode mask is zero (0). If ban mask
916 and/or invite list is set they are sent as well.
918 The <list count>, <Client ID list> and <client mode list> are
919 the clients currently on the channel and their modes on the
920 channel. The <Client ID list> is formed by adding the ID Payloads
921 one after the other. The <client mode list> is formed by adding
922 32 bit MSB first order values one after the other.
924 Client receives the channel key in the reply message as well
925 inside <Channel Key Payload>.
930 SILC_STATUS_ERR_WILDCARDS
931 SILC_STATUS_ERR_NOT_REGISTERED
932 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
933 SILC_STATUS_ERR_TOO_MANY_PARAMS
934 SILC_STATUS_ERR_BAD_PASSWORD
935 SILC_STATUS_ERR_CHANNEL_IS_FULL
936 SILC_STATUS_ERR_NOT_INVITED
937 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
938 SILC_STATUS_ERR_BAD_CHANNEL
939 SILC_STATUS_ERR_USER_ON_CHANNEL
945 Arguments: (1) <server>
947 This command is used to query the Message of the Day of the server.
949 Reply messages to the command:
952 Arguments: (1) <Status Payload> (2) <Server ID>
955 This command replies with the motd message if it exists.
960 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
961 SILC_STATUS_ERR_TOO_MANY_PARAMS
962 SILC_STATUS_ERR_NOT_REGISTERED
963 SILC_STATUS_ERR_NO_SUCH_SERVER
966 16 SILC_COMMAND_UMODE
969 Arguments: (1) <Client ID> (2) [<client mode mask>]
971 This command is used by client to set/unset modes for itself.
972 However, there are some modes that the client MUST NOT set itself,
973 but they will be set by server. However, client MAY unset any
974 mode. Modes may be masked together ORing them thus having
975 several modes set. Client MUST keep its client mode mask
976 locally so that the mode setting/unsetting would work without
977 problems. Client may change only its own modes.
979 After changing the mode server MUST send the notify type
980 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
982 The following client modes are defined:
984 0x00000000 SILC_UMODE_NONE
986 No specific mode for client. This is the initial
987 setting when new client is created. The client is
988 normal client and is present in the network.
991 0x00000001 SILC_UMODE_SERVER_OPERATOR
993 Marks the user as server operator. Client MUST NOT
994 set this mode itself. Server sets this mode to the
995 client when client attains the server operator
996 privileges by SILC_COMMAND_OPER command. Client
997 MAY unset the mode itself.
1000 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1002 Marks the user as router (SILC) operator. Client
1003 MUST NOT set this mode itself. Router sets this mode
1004 to the client when client attains the router operator
1005 privileges by SILC_COMMAND_SILCOPER command. Client
1006 MAY unset the mode itself.
1009 0x00000004 SILC_UMODE_GONE
1011 Marks that the user is not currently present in the
1012 SILC Network. Client MAY set and unset this mode.
1015 0x00000008 SILC_UMODE_INDISPOSED
1017 Marks that the user is currently indisposed and may
1018 not be able to receive any messages, and that user may
1019 not be present in the network. Client MAY set and
1023 0x00000010 SILC_UMODE_BUSY
1025 Marks that the user is currently busy and may not
1026 want to receive any messages, and that user may not
1027 be present in the network. Client MAY set and unset
1031 0x00000020 SILC_UMODE_PAGE
1033 User is not currently present or is unable to receive
1034 messages, and prefers to be paged in some mechanism
1035 if the user needs to be reached. Client MAY set and
1039 0x00000040 SILC_UMODE_HYPER
1041 Marks that the user is hyper active and is eager to
1042 receive and send messages. Client MAY set and unset
1046 0x00000080 SILC_UMODE_ROBOT
1048 Marks that the client is actually a robot program.
1049 Client MAY set and unset this mode.
1052 0x00000100 SILC_UMODE_ANONYMOUS
1054 Marks that the client is anonymous client. Server
1055 that specificly is designed for anonymous services
1056 can set and unset this mode. Client MUST NOT set or
1057 unset this mode itself. A client with this mode set
1058 would have the username and the hostname information
1059 scrambled by the server which set this mode.
1062 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1064 Marks that the client wishes to block private
1065 messages sent to the client, unless the Private
1066 Message Key flag is set in the SILC packet header.
1067 If this mode is set server MUST NOT deliver private
1068 messages to the client without the Private Message
1071 A separate service could provide additional filtering
1072 features for accepting private messages from certain
1073 sender. However, this document does not specify such
1076 The client MAY set and unset this mode.
1079 0x00000400 SILC_UMODE_DETACHED
1081 Marks that the client is detached from the SILC network.
1082 This means that the actual network connection to the
1083 client is lost but the client entry is still valid. The
1084 detached client can be resumed at a later time. This
1085 mode MUST NOT be set by client. It can only be set when
1086 client has issued command SILC_COMMAND_DETACH. The server
1087 sets this mode. This mode cannot be unset with this
1088 command. It is unset when the client is resuming back to
1089 the network and SILC_PACKET_RESUME_CLIENT packet is
1092 This flag MUST NOT be used to determine whether a packet
1093 can be sent to the client or not. Only the server that
1094 had the original client connection can make the decision
1095 by noticising that the network connection is not active.
1096 In this case the default case is to discard the packet.
1098 If the <client mode mask> was not provided this command merely
1099 returns the mode mask to the client.
1102 Reply messages to the command:
1105 Arguments: (1) <Status Payload> (2) <client mode mask>
1107 This command replies with the changed client mode mask that
1108 the client MUST to keep locally.
1114 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1115 SILC_STATUS_ERR_TOO_MANY_PARAMS
1116 SILC_STATUS_ERR_NOT_REGISTERED
1117 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1118 SILC_STATUS_ERR_BAD_CLIENT_ID
1119 SILC_STATUS_ERR_NOT_YOU
1120 SILC_STATUS_ERR_PERM_DENIED
1121 SILC_STATUS_ERR_UNKNOWN_MODE
1122 SILC_STATUS_ERR_NO_CLIENT_ID
1125 17 SILC_COMMAND_CMODE
1128 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1129 (3) [<user limit>] (4) [<passphrase>]
1130 (5) [<cipher>] (6) [<hmac>]
1131 (7) [<auth payload>]
1133 This command is used by client to set or change channel flags on
1134 a channel. Channel has several modes that set various properties
1135 of a channel. Modes may be masked together by ORing them thus
1136 having several modes set. The <Channel ID> is the ID of the
1137 target channel. The client changing channel mode MUST be on
1138 the same channel and poses sufficient privileges to be able to
1141 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1142 type MUST be distributed to the channel.
1144 The following channel modes are defined:
1146 0x00000000 SILC_CMODE_NONE
1148 No specific mode on channel. This is the default when
1149 channel is created. This means that channel is just plain
1153 0x00000001 SILC_CMODE_PRIVATE
1155 Channel is private channel. Private channels are shown
1156 in the channel list listed with SILC_COMMAND_LIST command
1157 with indication that the channel is private. Also,
1158 client on private channel will no be detected to be on
1159 the channel as the channel is not shown in the client's
1160 currently joined channel list. Channel founder and
1161 channel operator MAY set/unset this mode.
1163 Typical implementation would use [+|-]p on user interface
1164 to set/unset this mode.
1167 0x00000002 SILC_CMODE_SECRET
1169 Channel is secret channel. Secret channels are not shown
1170 in the list listed with SILC_COMMAND_LIST command. Secret
1171 channels can be considered to be invisible channels.
1172 Channel founder and channel operator MAY set/unset this
1175 Typical implementation would use [+|-]s on user interface
1176 to set/unset this mode.
1179 0x00000004 SILC_CMODE_PRIVKEY
1181 Channel uses private channel key to protect the traffic
1182 on the channel. When this mode is set the client will be
1183 responsible to set the key it wants to use to encrypt and
1184 decrypt the traffic on channel. Server generated channel
1185 keys are not used at all. This mode provides additional
1186 security as clients on channel may agree to use private
1187 channel key that even servers do not know. Naturally,
1188 this requires that every client on the channel knows
1189 the key before hand (it is considered to be pre-shared-
1190 key). The key material is RECOMMENDED to be processed
1191 as stated in the [SILC3] in the section Processing the
1194 As it is local setting it is possible to have several
1195 private channel keys on one channel. In this case several
1196 clients can talk on same channel but only those clients
1197 that share the key with the message sender will be able
1198 to hear the talking. Client SHOULD NOT display those
1199 message for the end user that it is not able to decrypt
1200 when this mode is set.
1202 Only channel founder MAY set/unset this mode. If this
1203 mode is unset the server will distribute new channel
1204 key to all clients on the channel which will be used
1207 Typical implementation would use [+|-]k on user interface
1208 to set/unset this mode.
1211 0x00000008 SILC_CMODE_INVITE
1213 Channel is invite only channel. Client may join to this
1214 channel only if it is invited to the channel. Channel
1215 founder and channel operator MAY set/unset this mode.
1217 Typical implementation would use [+|-]i on user interface
1218 to set/unset this mode.
1221 0x00000010 SILC_CMODE_TOPIC
1223 The topic of the channel may only be set by client that
1224 is channel founder or channel operator. Normal clients
1225 on channel will not be able to set topic when this mode
1226 is set. Channel founder and channel operator MAY set/
1229 Typical implementation would use [+|-]t on user interface
1230 to set/unset this mode.
1233 0x00000020 SILC_CMODE_ULIMIT
1235 User limit has been set to the channel. New clients
1236 may not join to the channel when the limit set is
1237 reached. Channel founder and channel operator MAY set/
1238 unset the limit. The <user limit> argument is the
1239 number of limited users.
1241 Typical implementation would use [+|-]l on user interface
1242 to set/unset this mode.
1245 0x00000040 SILC_CMODE_PASSPHRASE
1247 Passphrase has been set to the channel. Client may
1248 join to the channel only if it is able to provide the
1249 correct passphrase. Setting passphrases to channel
1250 is entirely safe as all commands are protected in the
1251 SILC network. Only channel founder MAY set/unset
1252 the passphrase. The <passphrase> argument is the
1255 Typical implementation would use [+|-]a on user interface
1256 to set/unset this mode.
1259 0x00000080 SILC_CMODE_CIPHER
1261 Sets specific cipher to be used to protect channel
1262 traffic. The <cipher> argument is the requested cipher.
1263 When set or unset the server must re-generate new
1264 channel key. Only channel founder MAY set the cipher of
1265 the channel. When unset the new key is generated using
1266 default cipher for the channel.
1268 Typical implementation would use [+|-]c on user interface
1269 to set/unset this mode.
1272 0x00000100 SILC_CMODE_HMAC
1274 Sets specific hmac to be used to compute the MACs of the
1275 channel message. The <hmac> argument is the requested hmac.
1276 Only channel founder may set the hmac of the channel.
1278 Typical implementation would use [+|-]h on user interface
1279 to set/unset this mode.
1282 0x00000200 SILC_CMODE_FOUNDER_AUTH
1284 Channel founder may set this mode to be able to regain
1285 channel founder rights even if the client leaves the
1286 channel. The <auth payload> is the Authentication Payload
1287 consisting of the authentication method and authentication
1288 data to be used in the authentication. The server MUST
1289 NOT accept NONE authentication method. Also, if the
1290 method is public key authentication the server MUST NOT
1291 save the authentication data from the payload as the
1292 data is different on all authentications. In this case the
1293 server only saves the authentication method. However,
1294 server MUST verify the sent authentication payload and
1295 set the mode only if the verification was successful.
1297 Note that this mode is effective only in the current server.
1298 The client MUST connect to the same server later to be able
1299 to regain the channel founder rights. The server MUST save
1300 the public key of the channel founder and use that to identify
1301 the client which is claiming the channel founder rights.
1302 The rights may be claimed by the SILC_CUMODE_FOUNDER
1303 channel user mode using SILC_COMMAND_CUMODE command. The
1304 set authentication data remains valid as long as the channel
1305 exists or until the founder unsets this mode.
1307 Typical implementation would use [+|-]f on user interface
1308 to set/unset this mode.
1311 0x00000400 SILC_CMODE_SILENCE_USERS
1313 Channel founder may set this mode to silence normal users
1314 on the channel. Users with operator privileges are not
1315 affected by this mode. Messages sent by normal users
1316 are dropped by servers when this mode is set. This mode
1317 can be used to moderate the channel. Only channel founder
1318 may set/unset this mode.
1321 0x00000800 SILC_CMODE_SILENCE_OPERS
1323 Channel founder may set this mode to silence operators
1324 on the channel. When used with SILC_CMODE_SILENCE_USERS
1325 mode this can be used to set the channel in state where only
1326 the founder of the channel may send messages to the channel.
1327 Messages sent by operators are dropped by servers when this
1328 mode is set. Only channel founder may set/unset this mode.
1331 To make the mode system work, client MUST keep the channel mode
1332 mask locally so that the mode setting and unsetting would work
1333 without problems. The client receives the initial channel mode
1334 mask when it joins to the channel. When the mode changes on
1335 channel the server MUST distribute the changed channel mode mask
1336 to all clients on the channel by sending the notify type
1337 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1338 to the server's primary router. If the <channel mode mask> was
1339 not provided this command merely returns the mode mask to the
1342 Reply messages to the command:
1345 Arguments: (1) <Status Payload> (2) <Channel ID>
1346 (3) <channel mode mask>
1348 This command replies with the changed channel mode mask that
1349 client MUST keep locally.
1354 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1355 SILC_STATUS_ERR_TOO_MANY_PARAMS
1356 SILC_STATUS_ERR_NOT_REGISTERED
1357 SILC_STATUS_ERR_NOT_ON_CHANNEL
1358 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1359 SILC_STATUS_ERR_BAD_CHANNEL_ID
1360 SILC_STATUS_ERR_NO_CHANNEL_ID
1361 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1362 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1363 SILC_STATUS_ERR_UNKNOWN_MODE
1364 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1365 SILC_STATUS_ERR_AUTH_FAILED
1368 18 SILC_COMMAND_CUMODE
1371 Arguments: (1) <Channel ID> (2) <mode mask>
1372 (3) <Client ID> (4) [<auth payload>]
1374 This command is used by client to change channel user modes on
1375 channel. Users on channel may have some special modes and this
1376 command is used by channel operators to set or change these modes.
1377 The <Channel ID> is the ID of the target channel. The <mode mask>
1378 is OR'ed mask of modes. The <Client ID> is the target client.
1379 The client changing channel user modes MUST be on the same channel
1380 as the target client and poses sufficient privileges to be able to
1383 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1384 type is distributed to the channel.
1386 The following channel modes are defined:
1388 0x00000000 SILC_CUMODE_NONE
1390 No specific mode. This is the normal situation for client.
1391 Also, this is the mode set when removing all modes from
1395 0x00000001 SILC_CUMODE_FOUNDER
1397 The client is channel founder of the channel. Usually this
1398 mode is set only by the server when the channel was created.
1399 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1400 been set, the client can claim channel founder privileges
1401 by providing the <auth payload> that the server will use
1402 to authenticate the client. The public key that server will
1403 use to verify the <auth payload> must the same public key
1404 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1405 mode was set. The client MAY remove this mode at any time.
1408 0x00000002 SILC_CUMODE_OPERATOR
1410 Sets channel operator privileges on the channel for a
1411 client on the channel. Channel founder and channel operator
1412 MAY set/unset this mode. The client MAY remove this mode
1416 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1418 Marks that the client wishes not to receive any channel
1419 messages sent for the channel. Client MAY set and unset
1420 this mode to itself. Client MUST NOT set it to anyone else.
1421 When this mode is set server MUST NOT deliver channel
1422 messages to this client. Other packets such as channel
1423 key packets are still sent to the client.
1425 A separate service could provide additional filtering
1426 features for accepting channel messages from certain
1427 sender. However, this document does not specify such
1431 Reply messages to the command:
1434 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1435 (3) <Channel ID> (4) <Client ID>
1437 This command replies with the changed channel user mode mask that
1438 client MUST keep locally. The <Channel ID> is the specified
1439 channel. The <Client ID> is the target client.
1444 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1445 SILC_STATUS_ERR_TOO_MANY_PARAMS
1446 SILC_STATUS_ERR_NOT_REGISTERED
1447 SILC_STATUS_ERR_NOT_ON_CHANNEL
1448 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1449 SILC_STATUS_ERR_BAD_CHANNEL_ID
1450 SILC_STATUS_ERR_NO_CHANNEL_ID
1451 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1452 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1453 SILC_STATUS_ERR_UNKNOWN_MODE
1454 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1455 SILC_STATUS_ERR_AUTH_FAILED
1458 19 SILC_COMMAND_KICK
1461 Arguments: (1) <Channel ID> (2) <Client ID>
1464 This command is used by channel operators to remove a client from
1465 channel. The <channel> argument is the channel the client to be
1466 removed is on currently. Note that the "kicker" must be on the same
1467 channel. If <comment> is provided it will be sent to the removed
1470 After kicking the client the server MUST send the notify type
1471 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1472 The channel key MUST also be re-generated after kicking, unless
1473 the SILC_CMODE_PRIVKEY mode is set.
1475 Reply messages to the command:
1478 Arguments: (1) <Status Payload>
1480 This command replies only with Status Payload.
1485 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1486 SILC_STATUS_ERR_TOO_MANY_PARAMS
1487 SILC_STATUS_ERR_NOT_REGISTERED
1488 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1489 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1490 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1491 SILC_STATUS_ERR_NO_CLIENT_ID
1497 Arguments: (1) <Channel ID> (2) [<adding client>]
1498 (3) [<removing client>]
1500 This command is used to manage the ban list of the channel
1501 indicated by the <Channel ID>. A client that is banned from
1502 channel is no longer able to join the channel. The client which
1503 is executing this command MUST have at least channel operator
1504 privileges on the channel.
1506 The <adding client> and <removing client> are used to add to and
1507 remove from the ban list. The format of the <adding client> and
1508 the <removing client> is of following format:
1510 [<nickname>[@<server>]!][<username>]@[<hostname>]
1512 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1513 primary router after adding to or removing from the ban list.
1514 The wildcards MAY be used with this command. If adding or removing
1515 from than one clients then the lists are an comma (`,') separated.
1517 If this command is executed without the ban arguments the command
1518 merely replies with the current ban list.
1521 Reply messages to the command:
1524 Arguments: (1) <Status Payload> (2) <Channel ID>
1527 This command replies with the <Channel ID> of the channel and
1528 the current <ban list> of the channel if it exists.
1533 SILC_STATUS_ERR_NOT_REGISTERED
1534 SILC_STATUS_ERR_TOO_MANY_PARAMS
1535 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1536 SILC_STATUS_ERR_NO_CHANNEL_ID
1537 SILC_STATUS_ERR_NOT_ON_CHANNEL
1538 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1541 21 <deprecated command>
1544 22 <deprecated command>
1547 23 SILC_COMMAND_SILCOPER
1550 Arguments: (1) <username> (2) <authentication payload>
1552 This command is used by normal client to obtain router operator
1553 privileges (also known as SILC operator) on the router. Note
1554 that router operator has privileges that supersedes the server
1555 operator privileges.
1557 The <username> is the username set in the server configurations
1558 as operator. The <authentication payload> is the data that the
1559 client is authenticated against. It may be passphrase prompted
1560 for user on client's screen or it may be public key or certificate
1561 authentication data (data signed with private key). The public
1562 key that router will use to verify the signature found in the
1563 payload should be verified. It is recommended that the public
1564 key is saved locally in the router and router would not use
1565 any public keys received during the SKE.
1567 Difference between router operator and server operator is that
1568 router operator is able to handle cell level properties while
1569 server operator (even on router server) is able to handle only
1570 local properties, such as, local connections and normal server
1571 administration. The router operator is also able to use the
1572 SILC_COMMAND_KILL command.
1574 After changing the mode server MUST send the notify type
1575 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1577 Reply messages to the command:
1580 Arguments: (1) <Status Payload>
1582 This command replies only with Status Payload.
1587 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1588 SILC_STATUS_ERR_TOO_MANY_PARAMS
1589 SILC_STATUS_ERR_NOT_REGISTERED
1590 SILC_STATUS_ERR_AUTH_FAILED
1593 24 SILC_COMMAND_LEAVE
1596 Arguments: (1) <Channel ID>
1598 This command is used by client to leave a channel the client is
1601 When leaving channel the server MUST send the notify type
1602 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1603 The channel key MUST also be re-generated when leaving the channel
1604 and distribute it to all clients still currently on the channel.
1605 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1608 Reply messages to the command:
1611 Arguments: (1) <Status Payload> (2) <Channel ID>
1613 The <Channel ID> is the ID of left channel.
1618 SILC_STATUS_ERR_NOT_REGISTERED
1619 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1620 SILC_STATUS_ERR_TOO_MANY_PARAMS
1621 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1622 SILC_STATUS_ERR_BAD_CHANNEL_ID
1623 SILC_STATUS_ERR_NO_CHANNEL_ID
1626 25 SILC_COMMAND_USERS
1629 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1631 This command is used to list user names currently on the requested
1632 channel; either the argument <Channel ID> or the <channel name>.
1633 One of these arguments must be present. The server MUST resolve
1634 the user names and send a comma (`,') separated list of user names
1635 on the channel. Server or router MAY resolve the names by sending
1636 SILC_COMMAND_WHOIS or SILC_COMMAND_IDENTIFY commands.
1638 If the requested channel is a private or secret channel, this
1639 command MUST NOT send the list of users, as private and secret
1640 channels cannot be seen by outside. In this case the returned
1641 name list MAY include a indication that the server could not
1642 resolve the names of the users on the channel. Also, in this case
1643 Client ID's or client modes are not sent either.
1645 Reply messages to the command:
1648 Arguments: (1) <Status Payload> (2) <Channel ID>
1649 (3) <list count> (4) <Client ID list>
1650 (5) <client mode list>
1652 This command replies with the Channel ID of the requested channel
1653 Client ID list of the users on the channel and list of their modes.
1654 The Client ID list has Client ID's of all users in the list. The
1655 <Client ID list> is formed by adding Client ID's one after another.
1656 The <client mode list> is formed by adding client's user modes on
1657 the channel one after another (4 bytes (32 bits) each). The <list
1658 count> of length of 4 bytes (32 bits), tells the number of entries
1659 in the lists. Both lists MUST have equal number of entries.
1664 SILC_STATUS_ERR_NOT_REGISTERED
1665 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1666 SILC_STATUS_ERR_TOO_MANY_PARAMS
1667 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1668 SILC_STATUS_ERR_BAD_CHANNEL_ID
1669 SILC_STATUS_ERR_NO_CHANNEL_ID
1670 SILC_STATUS_ERR_NOT_ON_CHANNEL
1673 26 SILC_COMMAND_GETKEY
1676 Arguments: (1) <ID Payload>
1678 This command is used to fetch the public key of the client or
1679 server indicated by the <ID Payload>. The public key is fetched
1680 from the server where to the client is connected.
1682 Reply messages to the command:
1685 Arguments: (1) <Status Payload> (2) <ID Payload>
1686 (3) [<Public Key Payload>]
1688 This command replies with the client's or server's ID and with
1689 the <Public Key Payload>.
1694 SILC_STATUS_ERR_NOT_REGISTERED
1695 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1696 SILC_STATUS_ERR_TOO_MANY_PARAMS
1697 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1698 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1703 Currently undefined commands.
1708 These commands are reserved for private use and will not be defined
1712 255 SILC_COMMAND_MAX
1714 Reserved command. This must not be sent.
1719 2.3 SILC Command Status Types
1722 2.3.1 SILC Command Status Payload
1724 Command Status Payload is sent in command reply messages to indicate
1725 the status of the command. The payload is one of argument in the
1726 command thus this is the data area in Command Argument Payload described
1727 in [SILC2]. The payload is only 2 bytes of length. The following diagram
1728 represents the Command Status Payload (field is always in MSB order).
1734 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1735 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1737 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1741 Figure 6: SILC Command Status Payload
1745 o Status (1 byte) - Indicates the status message type,
1746 error, start of list, entry of list or end of list.
1748 o Error (1 byte) - Indicates the error if the Status
1749 field is some list status, which means there are list
1753 The values in Status and Error fields are set according
1754 the following rules:
1757 o If there is single reply and error has not occurred
1758 then Status field includes value SILC_STATUS_OK, and
1759 the Error field MUST be ignored (and set to zero
1762 o If there is single error, then Status field includes
1763 one of the error values, and the Error field MUST be
1764 ignored (and set to zero value).
1766 o If there will be multiple successful command replies
1767 then Status field includes SILC_STATUS_LIST_START,
1768 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1769 and Error field is set to SILC_STATUS_OK.
1771 o If there are multiple error replies then Status field
1772 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1773 or SILC_STATUS_LIST_END value, and the Error field
1774 includes the error value.
1777 This way it is possible to send single successful or
1778 single error reply, but also multiple successful and
1779 multiple error replies. Note that it is possible to
1780 send both list of successful replies and list of error
1781 replies at the same time, however in this case the
1782 list of error replies MUST be sent after the successful
1783 replies. This way the recipient may ignore the multiple
1784 errors if it wishes to do so.
1786 All Status messages are described in the next section.
1790 2.3.2 SILC Command Status List
1792 Command Status messages are returned in the command reply messages
1793 to indicate whether the command were executed without errors. If error
1794 has occurred the status indicates which error occurred. Status payload
1795 only sends numeric reply about the status. Receiver of the payload must
1796 convert the numeric values into human readable error messages. The
1797 list of status messages below has an example human readable error
1798 messages that client may display for the user.
1800 List of all defined command status messages following.
1803 Generic status messages:
1807 Ok status. Everything went Ok. The status payload maybe
1808 safely ignored in this case.
1810 1 SILC_STATUS_LIST_START
1812 Start of the list. There will be several command replies and
1813 this reply is the start of the list.
1815 2 SILC_STATUS_LIST_ITEM
1817 Item in the list. This is one of the item in the list but not the
1820 3 SILC_STATUS_LIST_END
1822 End of the list. There were several command replies and this
1823 reply is the last of the list. There won't be other replies
1824 belonging to this list after this one.
1828 Currently undefined and has been reserved for the future.
1831 Error status message:
1835 10 SILC_STATUS_ERR_NO_SUCH_NICK
1837 "No such nickname". Requested nickname does not exist.
1839 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1841 "No such channel". Requested channel name does not exist.
1843 12 SILC_STATUS_ERR_NO_SUCH_SERVER
1845 "No such server". Requested server name does not exist.
1847 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
1849 "Duplicate recipients. No message delivered". Message were
1850 tried to be sent to recipient which has several occurrences in
1853 14 SILC_STATUS_ERR_NO_RECIPIENT
1855 "No recipient given". Command required recipient which was
1858 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
1860 "Unknown command". Command sent to server is unknown by the
1863 16 SILC_STATUS_ERR_WILDCARDS
1865 "Wildcards cannot be used". Wildcards were provided but they
1868 17 SILC_STATUS_ERR_NO_CLIENT_ID
1870 "No Client ID given". Client ID were expected as command
1871 parameter but were not found.
1873 18 SILC_STATUS_ERR_NO_CHANNEL_ID
1875 "No Channel ID given". Channel ID were expected as command
1876 parameter but were not found.
1878 19 SILC_STATUS_ERR_NO_SERVER_ID
1880 "No Serve ID given". Server ID were expected as command
1881 parameter but were not found.
1883 20 SILC_STATUS_ERR_BAD_CLIENT_ID
1885 "Bad Client ID". Client ID provided were erroneous.
1887 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
1889 "Bad Channel ID". Channel ID provided were erroneous.
1891 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1893 "No such Client ID". Client ID provided does not exist.
1895 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1897 "No such Channel ID". Channel ID provided does not exist.
1899 24 SILC_STATUS_ERR_NICKNAME_IN_USE
1901 "Nickname already exists". Nickname created could not be
1902 registered because number of same nicknames were already set to
1903 maximum. This is not expected to happen in real life but is
1906 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
1908 "You are not on that channel". The command were specified for
1909 channel user is not currently on.
1911 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1913 "They are not on channel". The requested target client is not
1914 on requested channel.
1916 27 SILC_STATUS_ERR_USER_ON_CHANNEL
1918 "User already on channel". User were invited on channel they
1921 28 SILC_STATUS_ERR_NOT_REGISTERED
1923 "You have not registered". User executed command that requires
1924 the client to be registered on the server before it may be
1927 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1929 "Not enough parameters". Command requires more parameters
1932 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
1934 "Too many parameters". Too many parameters were provided
1937 31 SILC_STATUS_ERR_PERM_DENIED
1939 "Permission denied". Generic permission denied error status
1940 to indicate disallowed access.
1942 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
1944 "You are banned from this server". The client tried to register
1945 on server that has explicitly denied this host to connect.
1947 33 SILC_STATUS_ERR_BAD_PASSWORD
1949 "Cannot join channel. Incorrect password". Password provided for
1950 channel were not accepted.
1952 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
1954 "Cannot join channel. Channel is full". The channel is full
1955 and client cannot be joined to it.
1957 35 SILC_STATUS_ERR_NOT_INVITED
1959 "Cannot join channel. You have not been invited". The channel
1960 is invite only channel and client has not been invited.
1962 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1964 "Cannot join channel. You have been banned". The client has
1965 been banned from the channel.
1967 37 SILC_STATUS_ERR_UNKNOWN_MODE
1969 "Unknown mode". Mode provided by the client were unknown to
1972 38 SILC_STATUS_ERR_NOT_YOU
1974 "Cannot change mode for other users". User tried to change
1975 someone else's mode.
1977 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1979 "Permission denied. You are not channel operator". Command may
1980 be executed only by channel operator.
1982 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1984 "Permission denied. You are not channel founder". Command may
1985 be executed only by channel operator.
1987 41 SILC_STATUS_ERR_NO_SERVER_PRIV
1989 "Permission denied. You are not server operator". Command may
1990 be executed only by server operator.
1992 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
1994 "Permission denied. You are not SILC operator". Command may be
1995 executed only by router (SILC) operator.
1997 43 SILC_STATUS_ERR_BAD_NICKNAME
1999 "Bad nickname". Nickname requested contained illegal characters
2002 44 SILC_STATUS_ERR_BAD_CHANNEL
2004 "Bad channel name". Channel requested contained illegal characters
2007 45 SILC_STATUS_ERR_AUTH_FAILED
2009 "Authentication failed". The authentication data sent as
2010 argument were wrong and thus authentication failed.
2012 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2014 "The algorithm was not supported." The server does not support the
2015 requested algorithm.
2017 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2019 "No such Server ID". Server ID provided does not exist.
2025 3 Security Considerations
2027 Security is central to the design of this protocol, and these security
2028 considerations permeate the specification. Common security considerations
2029 such as keeping private keys truly private and using adequate lengths for
2030 symmetric and asymmetric keys must be followed in order to maintain the
2031 security of this protocol.
2037 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2038 Protocol Specification", Internet Draft, April 2001.
2040 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2043 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2044 Protocols", Internet Draft, April 2001.
2046 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2049 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2052 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2055 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2058 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2061 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2064 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2067 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2070 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2071 Infrastructure, Certificate and CRL Profile", RFC 2459,
2074 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2075 John Wiley & Sons, New York, NY, 1996.
2077 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2080 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2081 RFC 2412, November 1998.
2083 [ISAKMP] Maughan D., et al, "Internet Security Association and
2084 Key Management Protocol (ISAKMP)", RFC 2408, November
2087 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2088 (IKE)", RFC 2409, November 1998.
2090 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2091 Authentication", RFC 2104, February 1997.
2093 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2094 Specifications, Version 2.0", RFC 2437, October 1998.
2096 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2097 Requirement Levels", BCP 14, RFC 2119, March 1997.
2099 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2100 10646", RFC 2279, January 1998.
2111 Snellmanninkatu 34 A 15
2115 EMail: priikone@iki.fi
2117 This Internet-Draft expires XXX