8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-03.txt XXX
26 <draft-riikonen-silc-commands-03.txt>
31 This document is an Internet-Draft and is in full conformance with
32 all provisions of Section 10 of RFC 2026. Internet-Drafts are
33 working documents of the Internet Engineering Task Force (IETF), its
34 areas, and its working groups. Note that other groups may also
35 distribute working documents as Internet-Drafts.
37 Internet-Drafts are draft documents valid for a maximum of six months
38 and may be updated, replaced, or obsoleted by other documents at any
39 time. It is inappropriate to use Internet-Drafts as reference
40 material or to cite them other than as "work in progress."
42 The list of current Internet-Drafts can be accessed at
43 http://www.ietf.org/ietf/1id-abstracts.txt
45 The list of Internet-Draft Shadow Directories can be accessed at
46 http://www.ietf.org/shadow.html
48 The distribution of this memo is unlimited.
54 This memo describes the commands used in the Secure Internet Live
55 Conferencing (SILC) protocol, specified in the Secure Internet Live
56 Conferencing, Protocol Specification Internet Draft [SILC1]. The
57 SILC Commands are very important part of the SILC protocol. Usually
58 the commands are used by SILC clients to manage the SILC session, but
59 also SILC servers may use the commands. This memo specifies detailed
60 command messages and command reply messages.
73 1 Introduction .................................................. 2
74 1.1 Requirements Terminology .................................. 2
75 2 SILC Commands ................................................. 2
76 2.1 SILC Commands Syntax ...................................... 2
77 2.2 SILC Commands List ........................................ 4
78 2.3 SILC Command Status Types ................................. 33
79 2.3.1 SILC Command Status Payload ......................... 33
80 2.3.2 SILC Command Status List ............................ 33
81 3 Security Considerations ....................................... 38
82 4 References .................................................... 38
83 5 Author's Address .............................................. 40
89 This document describes the commands used in the Secure Internet Live
90 Conferencing (SILC) protocol, specified in the Secure Internet Live
91 Conferencing, Protocol Specification Internet Draft [SILC1]. This
92 document specifies detailed command messages and command reply messages.
94 Commands are very important part on SILC network especially for client
95 which uses commands to operate on the SILC network. Commands are used
96 to set nickname, join to channel, change modes and many other things.
98 See the [SILC1] for the requirements and the restrictions for the usage
99 of the SILC commands. The [SILC2] defines the command packet type and
100 the Command Payload which is actually used to deliver the commands and
101 command reply messages.
105 1.1 Requirements Terminology
107 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
108 MAY, and OPTIONAL, when they appear in this document, are to be
109 interpreted as described in [RFC2119].
116 2.1 SILC Commands Syntax
118 This section briefly describes the syntax of the command notions
119 in this document. Every field in command is separated from each
120 other by whitespaces (` ') indicating that each field is independent
121 argument and each argument MUST have own Command Argument Payload.
122 The number of maximum arguments are defined with each command
123 separately. The Command Argument Payload is described in [SILC2].
125 Every command defines specific number for each argument. Currently,
126 they are defined in ascending order; first argument has number one
127 (1), second has number two (2) and so on. This number is set into the
128 Argument Type field in the Command Argument Payload. This makes it
129 possible to send the arguments in free order as the number MUST be
130 used to identify the type of the argument. This makes is it also
131 possible to have multiple optional arguments in commands and in
132 command replies. The number of argument is marked in parentheses
133 before the actual argument.
138 Example: Arguments: (1) <nickname> (2) <username@host>
142 Every command replies with Status Payload. This payload tells the
143 sender of the command whether the command was completed successfully or
144 whether there was an error. If error occurred the payload includes the
145 error type. In the next section the Status Payload is not described
146 as it is common to all commands and has been described here. Commands
147 MAY reply with other arguments as well. These arguments are command
148 specific and are described in the next section.
157 Arguments: (1) <nickname>[@<server>] (2) <message>
160 The command has maximum of 3 arguments. However, only first
161 and second arguments are mandatory.
163 First argument <nickname> is mandatory but may have optional
164 <nickname@server> format as well. Second argument is mandatory
165 <message> argument. Third argument is optional <count> argument.
167 The numbers in parentheses are the argument specific numbers
168 that specify the type of the argument in Command Argument Payload.
169 The receiver always knows that, say, argument number two (2) is
170 <message> argument, regardless of the ordering of the arguments in
173 Reply messages to the command:
176 Arguments: (1) <Status Payload> (2) [<channel list>]
177 (3) <idle time> (4) [<away message>]
179 This command may reply with maximum of 4 arguments. However,
180 only the first and third arguments are mandatory. The numbers
181 in the parentheses have the same meaning as in the upper
182 command sending specification.
184 Every command reply with <Status Payload>, it is mandatory
185 argument for all command replies and for this reason it is not
186 described in the command reply descriptions.
193 SILC_STATUS_ERR_TOO_MANY_TARGETS
194 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195 SILC_STATUS_ERR_NO_SUCH_NICK
197 Every command reply also defines set of status message that it
198 may return inside the <Status Payload>. All status messages
199 are defined in the section 2.3 SILC Command Status Types.
202 Every command that has some kind of ID as argument (for example
203 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
204 the type of the ID, length of the ID and the actual ID data. This
205 way variable length ID's can be sent as arguments. Also note that
206 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
211 2.2 SILC Commands List
213 This section lists all SILC commands, however, it is expected that a
214 implementation and especially client implementation has many more
215 commands that has only local affect. These commands are official
216 SILC commands that has both client and server sides and cannot be
217 characterized as local commands.
219 List of all defined commands in SILC follows.
224 None. This is reserved command and MUST NOT be sent.
230 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
231 (3) [<Client ID>] (n) [...]
233 Whois command is used to query various information about specific
234 user. The user may be requested by their nickname and server name.
235 The query may find multiple matching users as there are no unique
236 nicknames in the SILC. The <count> option may be given to narrow
237 down the number of accepted results. If this is not defined there
238 are no limit of accepted results. The query may also be narrowed
239 down by defining the server name of the nickname. The <count> is
242 It is also possible to search the user by Client ID. If the
243 <Client ID> is provided server MUST use it as the search value
244 instead of the <nickname>. One of the arguments MUST be given.
245 It is also possible to define multiple Client ID's to search
246 multiple users sending only one WHOIS command. In this case the
247 Client ID's are appended as normal arguments.
249 To prevent miss-use of this command wildcards in the nickname
250 or in the server name are not permitted. It is not allowed
251 to request all users on some server. The WHOIS requests MUST
252 be based on specific nickname request.
254 The WHOIS request MUST be always sent to the router by server
255 so that all users are searched. However, the server still MUST
256 search its locally connected clients. The router MUST send
257 this command to the server which owns the requested client. That
258 server MUST reply to the command. Server MUST NOT send whois
259 replies to the client until it has received the reply from its
262 Reply messages to the command:
265 Arguments: (1) <Status Payload> (2) <Client ID>
266 (3) <nickname>[@<server>] (4) <username@host>
267 (5) <real name> (6) [<Channel Payload
269 (7) [<user mode>] (8) [<idle time>]
273 This command may reply with several command reply messages to
274 form a list of results. In this case the status payload will
275 include STATUS_LIST_START status in the first reply and
276 STATUS_LIST_END in the last reply to indicate the end of the
277 list. If there are only one reply the status is set to normal
280 The command replies include the Client ID of the nickname,
281 nickname and server name, user name and host name and user's real
282 name. Client SHOULD process these replies only after the last
283 reply has been received with the STATUS_LIST_END status. If the
284 <count> option were defined in the query there will be only
285 <count> many replies from the server.
287 The server may return the list of channel the client has joined.
288 In this case the list is list of Channel Payloads. The Mode Mask
289 in the Channel Payload (see [SILC2] and section 2.3.2.3 for the
290 Channel Payload) is the client's mode on the channel. The list
291 is encoded by adding the Channel Payloads one after the other.
293 The server may also send client's user mode, idle time, and the
294 fingerprint of the client's public key. The <fingerprint> is the
295 binary hash digest of the public key. The fingerprint MUST NOT
296 be sent if the server has not verified the proof of posession of
297 the corresponding private key. Server can do this during the
298 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
303 SILC_STATUS_LIST_START
305 SILC_STATUS_ERR_NO_SUCH_NICK
306 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
307 SILC_STATUS_ERR_WILDCARDS
308 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
309 SILC_STATUS_ERR_TOO_MANY_PARAMS
312 2 SILC_COMMAND_WHOWAS
315 Arguments: (1) <nickname>[@<server>] (2) [<count>]
317 Whowas. This command is used to query history information about
318 specific user. The user may be requested by their nickname and
319 server name. The query may find multiple matching users as there
320 are no unique nicknames in the SILC. The <count> option may be
321 given to narrow down the number of accepted results. If this
322 is not defined there are no limit of accepted results. The query
323 may also be narrowed down by defining the server name of the
324 nickname. The <count> is in string format.
326 To prevent miss-use of this command wildcards in the nickname
327 or in the server name are not permitted. The WHOWAS requests MUST
328 be based on specific nickname request.
330 The WHOWAS request MUST be always sent to the router by server
331 so that all users are searched. However, the server still must
332 search its locally connected clients.
334 Reply messages to the command:
337 Arguments: (1) <Status Payload> (2) <Client ID>
338 (3) <nickname>[@<server>] (4) <username@host>
341 This command may reply with several command reply messages to form
342 a list of results. In this case the status payload will include
343 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
344 the last reply to indicate the end of the list. If there are only
345 one reply the status is set to normal STATUS_OK.
347 The command replies with nickname and user name and host name.
348 Every server MUST keep history for some period of time of its
349 locally connected clients.
354 SILC_STATUS_LIST_START
356 SILC_STATUS_ERR_NO_SUCH_NICK
357 SILC_STATUS_ERR_WILDCARDS
358 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
359 SILC_STATUS_ERR_TOO_MANY_PARAMS
362 3 SILC_COMMAND_IDENTIFY
365 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
366 (3) [<channel name>] (4) [<count>]
367 (5) [<ID Payload>] (n) [...]
369 Identify command is used to query information about an entity by
370 the entity's name or ID. This command can be used to query
371 information about clients, server and channels.
373 The query may find multiple matching entities. The <count> option
374 may be given to narrow down the number of accepted results. If
375 this is not defined there are no limit of accepted results. The
376 <count> is in string format.
378 It is also possible to search the entity by its ID. If the
379 <ID Payload> is provided server must use it as the search value
380 instead of the entity's name. One of the arguments must be given.
381 It is also possible to define multiple ID Payloads to search
382 multiple entities sending only one IDENTIFY command. In this case
383 the ID Payloads are appended as normal arguments. The type of the
384 entity is defined by the type of the ID Payload.
386 To prevent miss-use of this command wildcards in the names are
387 not permitted. It is not allowed to request for example all users
390 Implementations may not want to give interface access to this
391 command as it is hardly a command that would be used by an end
392 user. However, it must be implemented as it is used with private
395 The IDENTIFY command MUST be always sent to the router by server
396 so that all users are searched. However, server MUST still search
397 its locally connected clients.
399 Reply messages to the command:
402 Arguments: (1) <Status Payload> (2) <ID Payload>
403 (3) [<entity's name>] (4) [<info>]
405 This command may reply with several command reply messages to form
406 a list of results. In this case the status payload will include
407 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
408 the last reply to indicate the end of the list. If there are only
409 one reply the status is set to normal STATUS_OK.
411 When querying clients the <entity's name> must include the client's
412 nickname in the following format: nickname[@server]. The
413 <info> must include the client's username and host in the following
414 format: username@host.
416 When querying servers the <entity's name> must include the server's
417 full name. The <info> may be omitted.
419 When querying channels the <entity's name> must include the
420 channel's name. The <info> may be omitted.
422 If the <count> option were defined in the query there will be only
423 <count> many replies from the server.
428 SILC_STATUS_LIST_START
430 SILC_STATUS_ERR_NO_SUCH_NICK
431 SILC_STATUS_ERR_NO_SUCH_SERVER
432 SILC_STATUS_ERR_NO_SUCH_CHANNEL
433 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
434 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
435 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
436 SILC_STATUS_ERR_WILDCARDS
437 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
438 SILC_STATUS_ERR_TOO_MANY_PARAMS
444 Arguments: (1) <nickname>
446 Set/change nickname. This command is used to set nickname for
447 user. Nickname MUST NOT include any spaces (` '), non-printable
448 characters, commas (`,') and any wildcard characters. Note that
449 nicknames in SILC are case-sensitive which must be taken into
450 account when searching clients by nickname.
452 When nickname is changed new Client ID is generated. Server MUST
453 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
454 channels (if any) the client is joined on. Then it MUST send
455 SILC_PACKET_REPLACE_ID to its primary route to replace the old
456 Client ID with the new one.
458 Reply messages to the command:
461 Arguments: (1) <Status Payload> (2) <New ID Payload>
463 This command is replied always with New ID Payload that is
464 generated by the server every time user changes their nickname.
465 Client receiving this payload MUST start using the received
466 Client ID as its current valid Client ID. The New ID Payload
467 is described in [SILC2].
472 SILC_STATUS_ERR_WILDCARDS
473 SILC_STATUS_ERR_NICKNAME_IN_USE
474 SILC_STATUS_ERR_BAD_NICKNAME
475 SILC_STATUS_ERR_NOT_REGISTERED
476 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
477 SILC_STATUS_ERR_TOO_MANY_PARAMS
483 Arguments: (1) [<Channel ID>]
485 The list command is used to list channels and their topics on the
486 current server. If the <Channel ID> parameter is used, only the
487 status of that channel is displayed. Secret channels are not
488 listed at all. Private channels are listed with status indicating
489 that the channel is private. Router MAY reply with all channels
492 Reply messages to the command:
495 Arguments: (1) <Status Payload> (2) <Channel ID>
496 (3) <channel> (4) [<topic>]
499 This command may reply with several command reply messages to form
500 a list of results. In this case the status payload will include
501 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
502 the last reply to indicate the end of the list. If there are only
503 one reply the status is set to normal STATUS_OK.
505 This command replies with Channel ID, name and the topic of the
506 channel. If the channel is private channel the <topic> SHOULD
507 include the "*private*" string.
512 SILC_STATUS_LIST_START
514 SILC_STATUS_ERR_WILDCARDS
515 SILC_STATUS_ERR_NOT_REGISTERED
516 SILC_STATUS_ERR_TOO_MANY_PARAMS
517 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
518 SILC_STATUS_ERR_NO_CHANNEL_ID
519 SILC_STATUS_ERR_NO_SUCH_SERVER
525 Arguments: (1) <Channel ID> (2) [<topic>]
527 This command is used to change or view the topic of a channel.
528 The topic for channel <Channel ID> is returned if there is no
529 <topic> given. If the <topic> parameter is present, the topic
530 for that channel will be changed, if the channel modes permit
533 After setting the topic the server MUST send the notify type
534 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
535 the channel which topic was changed.
537 Reply messages to the command:
540 Arguments: (1) <Status Payload> (2) <Channel ID>
543 The command may reply with the topic of the channel if it is
549 SILC_STATUS_ERR_NOT_ON_CHANNEL
550 SILC_STATUS_ERR_WILDCARDS
551 SILC_STATUS_ERR_NOT_REGISTERED
552 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
553 SILC_STATUS_ERR_NO_SUCH_CHANNEL
554 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
555 SILC_STATUS_ERR_NO_CHANNEL_ID
556 SILC_STATUS_ERR_BAD_CHANNEL_ID
557 SILC_STATUS_ERR_TOO_MANY_PARAMS
558 SILC_STATUS_ERR_NO_CHANNEL_PRIV
561 7 SILC_COMMAND_INVITE
564 Arguments: (1) <Channel ID> (2) [<Client ID>]
565 (3) [<adding client>] (4) [<removing client>]
567 This command is used to invite other clients to join to the
568 channel. The <Client ID> argument is the target client's ID that
569 is being invited. The <Channel ID> is the Channel ID of the
570 requested channel. The sender of this command MUST be on the
571 channel. The server MUST also send the notify type
572 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
573 client indicated by the <Client ID>.
575 The <adding client> and <removing client> can be used to add to
576 and remove from the invite list. The format of the <adding client>
577 and <removing client> is as follows:
579 [<nickname>[@<server>]!][<username>]@[<hostname>]
581 When adding to or removing from the invite list the server MUST
582 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
583 and MUST NOT send it to the client which was added to the list.
584 The client which executes this command MUST have at least channel
585 operator privileges to be able to add to or remove from the invite
586 list. The wildcards MAY be used with this command. If adding or
587 removing more than one client then the lists are an comma (`,')
590 Note that the <Client ID> provided MUST be resolved into correct
591 nickname and host name and add to the invite list before sending
594 When this command is given with only <Channel ID> argument then
595 the command merely returns the invite list of the channel. This
596 command MUST fail if the requested channel does not exist, the
597 requested <Client ID> is already on the channel or if the channel
598 is invite only channel and the caller of this command does not
599 have at least channel operator privileges.
601 Reply messages to the command:
604 Arguments: (1) <Status Payload> (2) <Channel ID>
607 This command replies with the invite list of the channel if it
613 SILC_STATUS_ERR_NOT_REGISTERED
614 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
615 SILC_STATUS_ERR_TOO_MANY_PARAMS
616 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
617 SILC_STATUS_ERR_NO_CLIENT_ID
618 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
619 SILC_STATUS_ERR_NO_CHANNEL_ID
620 SILC_STATUS_ERR_NOT_ON_CHANNEL
621 SILC_STATUS_ERR_USER_ON_CHANNEL
622 SILC_STATUS_ERR_NO_CHANNEL_PRIV
628 Arguments: (1) [<quit message>]
630 This command is used by client to end SILC session. The server
631 must close the connection to a client which sends this command.
632 if <quit message> is given it will be sent to other clients on
633 channel if the client is on channel when quitting.
635 Reply messages to the command:
637 This command does not reply anything.
643 Arguments: (1) <Client ID> (2) [<comment>]
645 This command is used by SILC operators to remove a client from
646 SILC network. The removing has temporary effects and client may
647 reconnect to SILC network. The <Client ID> is the client to be
648 removed from SILC. The <comment> argument may be provided to
649 give to the removed client some information why it was removed
652 When killing a client the router MUST first send notify type
653 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
654 The packet MUST NOT be sent to the killed client on the channels.
655 Then, the router MUST send the same notify type to its primary
656 router. Finally, the router MUST send the same notify type
657 directly to the client which was killed.
659 Reply messages to the command:
662 Arguments: (1) <Status Payload>
664 This command replies only with Status Payload.
669 SILC_STATUS_ERR_WILDCARDS
670 SILC_STATUS_ERR_NOT_REGISTERED
671 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
672 SILC_STATUS_ERR_TOO_MANY_PARAMS
673 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
674 SILC_STATUS_ERR_NO_CLIENT_ID
675 SILC_STATUS_ERR_NO_ROUTER_PRIV
681 Arguments: (1) [<server>] (2) [<Server ID>]
683 This command is used to fetch various information about a server.
684 If <server> argument is specified the command MUST be sent to
685 the requested server.
687 If the <Server ID> is specified the server information if fetched
688 by the provided Server ID. One of the arguments must always be
691 Reply messages to the command:
694 Arguments: (1) <Status Payload> (2) <Server ID>
695 (3) <server name> (4) <string>
697 This command replies with the Server ID of the server and a
698 string which tells the information about the server.
703 SILC_STATUS_ERR_WILDCARDS
704 SILC_STATUS_ERR_NOT_REGISTERED
705 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
706 SILC_STATUS_ERR_TOO_MANY_PARAMS
707 SILC_STATUS_ERR_NO_SUCH_SERVER
708 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
709 SILC_STATUS_ERR_NO_SERVER_ID
712 11 SILC_COMMAND_STATS
715 Arguments: (1) <Server ID>
717 This command is used to fetch various statistical information
718 from the server indicated by <Server ID>, which is the ID of
719 server where sender is connected to. Server receiving this
720 command MAY also send this further to its router for fetching
721 other cell and network wide statistics to accompany the reply.
723 Reply messages to the command:
726 Arguments: (1) <Status Payload> (2) <Server ID>
727 (3) [<statistics structure>]
729 This command replies with the Server ID of the server and
730 optional statistics structure which includes 32 bit MSB first
731 ordered integer values to represent various statistical
732 information. The structure is as follows:
734 starttime - time when server was started
735 uptime - uptime of the server
736 my clients - number of locally connected clients
737 my channels - number of locally created channels
738 my server ops - number of local server operators
739 my router ops - number of local router operators
740 cell clients - number of clients in local cell
741 cell channels - number of channels in local cell
742 cell servers - number of servers in local cell
743 clients - number of client in SILC network
744 channels - number of channels in SILC network
745 servers - number of servers in SILC network
746 routers - number of routers in SILC network
747 server ops - number of server operators in SILC network
748 router ops - number of router operators in SILC network
750 If some value is unknown it is set to zero (0) value. The
751 "starttime" is the start time of the server, and is seconds
752 since Epoch (POSIX.1). The "uptime" is time difference of
753 current time and "starttime" in the server, and is seconds
759 SILC_STATUS_ERR_NOT_REGISTERED
760 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
761 SILC_STATUS_ERR_TOO_MANY_PARAMS
762 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
763 SILC_STATUS_ERR_NO_SUCH_SERVER
764 SILC_STATUS_ERR_NO_SERVER_ID
770 Arguments: (1) <Server ID>
772 This command is used by client and server to test the communication
773 channel to its server if one suspects that the communication is not
774 working correctly. The <Server ID> is the ID of the server the
775 sender is connected to.
777 Reply messages to the command:
780 Arguments: (1) <Status Payload>
782 This command replies only with Status Payload. Server returns
783 SILC_STATUS_OK in Status Payload if pinging was successful.
790 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
791 SILC_STATUS_ERR_TOO_MANY_PARAMS
792 SILC_STATUS_ERR_NO_SERVER_ID
793 SILC_STATUS_ERR_NO_SUCH_SERVER
794 SILC_STATUS_ERR_NOT_REGISTERED
800 Arguments: (1) <username> (2) <authentication payload>
802 This command is used by normal client to obtain server operator
803 privileges on some server or router. Note that router operator
804 has router privileges that supersedes the server operator
805 privileges and this does not obtain those privileges. Client
806 MUST use SILCOPER command to obtain router level privileges.
808 The <username> is the username set in the server configurations
809 as operator. The <authentication payload> is the data that the
810 client is authenticated against. It may be passphrase prompted
811 for user on client's screen or it may be public key or certificate
812 authentication data (data signed with private key). The public
813 key that server will use to verify the signature found in the
814 payload should be verified. It is recommended that the public
815 key is saved locally in the server and server would not use
816 any public keys received during the SKE.
818 After changing the mode the server MUST send the notify type
819 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
821 Reply messages to the command:
824 Arguments: (1) <Status Payload>
826 This command replies only with Status Payload.
831 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
832 SILC_STATUS_ERR_TOO_MANY_PARAMS
833 SILC_STATUS_ERR_NOT_REGISTERED
834 SILC_STATUS_ERR_AUTH_FAILED
840 Arguments: (1) <channel> (2) <Client ID>
841 (3) [<passphrase>] (4) [<cipher>]
842 (5) [<hmac>] (6) [<founder auth>]
844 Join to channel/create new channel. This command is used to
845 join to a channel. If the channel does not exist the channel is
846 created. If server is normal server this command MUST be sent
847 to router which will create the channel. The channel MAY be
848 protected with passphrase. If this is the case the passphrase
849 MUST be sent along the join command.
851 The name of the <channel> MUST NOT include any spaces (` '),
852 non-printable characters, commas (`,') or any wildcard characters.
854 The second argument <Client ID> is the Client ID of the client
855 which is joining to the client. When client sends this command
856 to the server the <Client ID> MUST be the client's own ID.
858 Cipher to be used to secure the traffic on the channel MAY be
859 requested by sending the name of the requested <cipher>. This
860 is used only if the channel does not exist and is created. If
861 the channel already exists the cipher set previously for the
862 channel will be used to secure the traffic. The computed MACs
863 of the channel message are produced by the default HMAC or by
864 the <hmac> provided for the command.
866 The <founder auth> is Authentication Payload providing the
867 authentication for gaining founder privileges on the channel
868 when joining the channel. The client may provide this if it
869 knows that it is the founder of the channel and that the
870 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
871 MUST verify whether the client is able to gain the founder
872 privileges the same way as the client had given the
873 SILC_COMMAND_CUMODE command to gain founder privileges. The
874 client is still able to join the channel even if the founder
875 privileges could not be gained.
877 The server MUST check whether the user is allowed to join to
878 the requested channel. Various modes set to the channel affect
879 the ability of the user to join the channel. These conditions
882 o The user MUST be invited to the channel if the channel
883 is invite-only channel.
885 o The Client ID/nickname/username/host name MUST NOT match
888 o The correct passphrase MUST be provided if passphrase
889 is set to the channel.
891 o The user count limit, if set, MUST NOT be reached.
893 If the client provided correct <founder auth> payload it can
894 override these conditions, except the condition for the passphrase.
895 The correct passphrase MUST be provided even if <founder auth>
898 Reply messages to the command:
901 Arguments: (1) <Status Payload> (2) <channel>
902 (3) <Channel ID> (4) <Client ID>
903 (5) <channel mode mask> (6) <created>
904 (7) [<Channel Key Payload>] (8) [<ban list>]
905 (9) [<invite list>] (10) [<topic>]
906 (11) [<hmac>] (12) <list count>
907 (13) <Client ID list> (14) <client mode list>
909 This command replies with the channel name requested by the
910 client, channel ID of the channel and topic of the channel
911 if it exists. The <Client ID> is the Client ID which was joined
912 to the channel. It also replies with the channel mode mask
913 which tells all the modes set on the channel. If the
914 channel is created the mode mask is zero (0). If ban mask
915 and/or invite list is set they are sent as well.
917 The <list count>, <Client ID list> and <client mode list> are
918 the clients currently on the channel and their modes on the
919 channel. The <Client ID list> is formed by adding the ID Payloads
920 one after the other. The <client mode list> is formed by adding
921 32 bit MSB first order values one after the other.
923 Client receives the channel key in the reply message as well
924 inside <Channel Key Payload>.
929 SILC_STATUS_ERR_WILDCARDS
930 SILC_STATUS_ERR_NOT_REGISTERED
931 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
932 SILC_STATUS_ERR_TOO_MANY_PARAMS
933 SILC_STATUS_ERR_BAD_PASSWORD
934 SILC_STATUS_ERR_CHANNEL_IS_FULL
935 SILC_STATUS_ERR_NOT_INVITED
936 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
937 SILC_STATUS_ERR_BAD_CHANNEL
938 SILC_STATUS_ERR_USER_ON_CHANNEL
944 Arguments: (1) <server>
946 This command is used to query the Message of the Day of the server.
948 Reply messages to the command:
951 Arguments: (1) <Status Payload> (2) <Server ID>
954 This command replies with the motd message if it exists.
959 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
960 SILC_STATUS_ERR_TOO_MANY_PARAMS
961 SILC_STATUS_ERR_NOT_REGISTERED
962 SILC_STATUS_ERR_NO_SUCH_SERVER
965 16 SILC_COMMAND_UMODE
968 Arguments: (1) <Client ID> (2) <client mode mask>
970 This command is used by client to set/unset modes for itself.
971 However, there are some modes that the client MUST NOT set itself,
972 but they will be set by server. However, client MAY unset any
973 mode. Modes may be masked together ORing them thus having
974 several modes set. Client MUST keep its client mode mask
975 locally so that the mode setting/unsetting would work without
976 problems. Client may change only its own modes.
978 After changing the mode server MUST send the notify type
979 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
981 The following client modes are defined:
983 0x00000000 SILC_UMODE_NONE
985 No specific mode for client. This is the initial
986 setting when new client is created. The client is
987 normal client and is present in the network.
990 0x00000001 SILC_UMODE_SERVER_OPERATOR
992 Marks the user as server operator. Client MUST NOT
993 set this mode itself. Server sets this mode to the
994 client when client attains the server operator
995 privileges by SILC_COMMAND_OPER command. Client
996 MAY unset the mode itself.
999 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1001 Marks the user as router (SILC) operator. Client
1002 MUST NOT this mode itself. Router sets this mode to
1003 the client when client attains the router operator
1004 privileges by SILC_COMMAND_SILCOPER command. Client
1005 MAY unset the mode itself.
1008 0x00000004 SILC_UMODE_GONE
1010 Marks that the user is not currently present in the
1011 SILC Network. Client MAY set and unset this mode.
1014 0x00000008 SILC_UMODE_INDISPOSED
1016 Marks that the user is currently indisposed and may
1017 not be able to receive any messages, and that user may
1018 not be present in the network. Client MAY set and
1022 0x00000010 SILC_UMODE_BUSY
1024 Marks that the user is currently busy and may not
1025 want to receive any messages, and that user may not
1026 be present in the network. Client MAY set and unset
1030 0x00000020 SILC_UMODE_PAGE
1032 User is not currently present or is unable to receive
1033 messages, and prefers to be paged in some mechanism
1034 if the user needs to be reached. Client MAY set and
1038 0x00000040 SILC_UMODE_HYPER
1040 Marks that the user is hyper active and is eager to
1041 receive and send messages. Client MAY set and unset
1045 0x00000080 SILC_UMODE_ROBOT
1047 Marks that the client is actually a robot program.
1048 Client MAY set and unset this mode.
1051 Reply messages to the command:
1054 Arguments: (1) <Status Payload> (2) <client mode mask>
1056 This command replies with the changed client mode mask that
1057 the client MUST to keep locally.
1063 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1064 SILC_STATUS_ERR_TOO_MANY_PARAMS
1065 SILC_STATUS_ERR_NOT_REGISTERED
1066 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1067 SILC_STATUS_ERR_BAD_CLIENT_ID
1068 SILC_STATUS_ERR_NOT_YOU
1069 SILC_STATUS_ERR_PERM_DENIED
1070 SILC_STATUS_ERR_UNKNOWN_MODE
1071 SILC_STATUS_ERR_NO_CLIENT_ID
1074 17 SILC_COMMAND_CMODE
1077 Arguments: (1) <Channel ID> (2) <channel mode mask>
1078 (3) [<user limit>] (4) [<passphrase>]
1079 (5) [<cipher>] (6) [<hmac>]
1080 (7) [<auth payload>]
1082 This command is used by client to set or change channel flags on
1083 a channel. Channel has several modes that set various properties
1084 of a channel. Modes may be masked together by ORing them thus
1085 having several modes set. The <Channel ID> is the ID of the
1086 target channel. The client changing channel mode MUST be on
1087 the same channel and poses sufficient privileges to be able to
1090 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1091 type MUST be distributed to the channel.
1093 The following channel modes are defined:
1095 0x00000000 SILC_CMODE_NONE
1097 No specific mode on channel. This is the default when
1098 channel is created. This means that channel is just plain
1102 0x00000001 SILC_CMODE_PRIVATE
1104 Channel is private channel. Private channels are shown
1105 in the channel list listed with SILC_COMMAND_LIST command
1106 with indication that the channel is private. Also,
1107 client on private channel will no be detected to be on
1108 the channel as the channel is not shown in the client's
1109 currently joined channel list. Channel founder and
1110 channel operator MAY set/unset this mode.
1112 Typical implementation would use [+|-]p on user interface
1113 to set/unset this mode.
1116 0x00000002 SILC_CMODE_SECRET
1118 Channel is secret channel. Secret channels are not shown
1119 in the list listed with SILC_COMMAND_LIST command. Secret
1120 channels can be considered to be invisible channels.
1121 Channel founder and channel operator MAY set/unset this
1124 Typical implementation would use [+|-]s on user interface
1125 to set/unset this mode.
1128 0x00000004 SILC_CMODE_PRIVKEY
1130 Channel uses private channel key to protect the traffic
1131 on the channel. When this mode is set the client will be
1132 responsible to set the key it wants to use to encrypt and
1133 decrypt the traffic on channel. Server generated channel
1134 keys are not used at all. This mode provides additional
1135 security as clients on channel may agree to use private
1136 channel key that even servers do not know. Naturally,
1137 this requires that every client on the channel knows
1138 the key before hand (it is considered to be pre-shared-
1139 key). The key material is RECOMMENDED to be processed
1140 as stated in the [SILC3] in the section Processing the
1143 As it is local setting it is possible to have several
1144 private channel keys on one channel. In this case several
1145 clients can talk on same channel but only those clients
1146 that share the key with the message sender will be able
1147 to hear the talking. Client SHOULD NOT display those
1148 message for the end user that it is not able to decrypt
1149 when this mode is set.
1151 Only channel founder MAY set/unset this mode. If this
1152 mode is unset the server will distribute new channel
1153 key to all clients on the channel which will be used
1156 Typical implementation would use [+|-]k on user interface
1157 to set/unset this mode.
1160 0x00000008 SILC_CMODE_INVITE
1162 Channel is invite only channel. Client may join to this
1163 channel only if it is invited to the channel. Channel
1164 founder and channel operator MAY set/unset this mode.
1166 Typical implementation would use [+|-]i on user interface
1167 to set/unset this mode.
1170 0x00000010 SILC_CMODE_TOPIC
1172 The topic of the channel may only be set by client that
1173 is channel founder or channel operator. Normal clients
1174 on channel will not be able to set topic when this mode
1175 is set. Channel founder and channel operator MAY set/
1178 Typical implementation would use [+|-]t on user interface
1179 to set/unset this mode.
1182 0x00000020 SILC_CMODE_ULIMIT
1184 User limit has been set to the channel. New clients
1185 may not join to the channel when the limit set is
1186 reached. Channel founder and channel operator MAY set/
1187 unset the limit. The <user limit> argument is the
1188 number of limited users.
1190 Typical implementation would use [+|-]l on user interface
1191 to set/unset this mode.
1194 0x00000040 SILC_CMODE_PASSPHRASE
1196 Passphrase has been set to the channel. Client may
1197 join to the channel only if it is able to provide the
1198 correct passphrase. Setting passphrases to channel
1199 is entirely safe as all commands are protected in the
1200 SILC network. Only channel founder MAY set/unset
1201 the passphrase. The <passphrase> argument is the
1204 Typical implementation would use [+|-]a on user interface
1205 to set/unset this mode.
1208 0x00000080 SILC_CMODE_CIPHER
1210 Sets specific cipher to be used to protect channel
1211 traffic. The <cipher> argument is the requested cipher.
1212 When set or unset the server must re-generate new
1213 channel key. Only channel founder MAY set the cipher of
1214 the channel. When unset the new key is generated using
1215 default cipher for the channel.
1217 Typical implementation would use [+|-]c on user interface
1218 to set/unset this mode.
1221 0x00000100 SILC_CMODE_HMAC
1223 Sets specific hmac to be used to compute the MACs of the
1224 channel message. The <hmac> argument is the requested hmac.
1225 Only channel founder may set the hmac of the channel.
1227 Typical implementation would use [+|-]h on user interface
1228 to set/unset this mode.
1231 0x00000200 SILC_CMODE_FOUNDER_AUTH
1233 Channel founder may set this mode to be able to regain
1234 channel founder rights even if the client leaves the
1235 channel. The <auth payload> is the Authentication Payload
1236 consisting of the authentication method and authentication
1237 data to be used in the authentication. The server MUST
1238 NOT accept NONE authentication method. Also, if the
1239 method is public key authentication the server MUST NOT
1240 save the authentication data from the payload as the
1241 data is different on all authentications. In this case the
1242 server only saves the authentication method. However,
1243 server MUST verify the sent authentication payload and
1244 set the mode only if the verification was successful.
1246 Note that this mode is effective only in the current server.
1247 The client MUST connect to the same server later to be able
1248 to regain the channel founder rights. The server MUST save
1249 the public key of the channel founder and use that to identify
1250 the client which is claiming the channel founder rights.
1251 The rights may be claimed by the SILC_CUMODE_FOUNDER
1252 channel user mode using SILC_COMMAND_CUMODE command. The
1253 set authentication data remains valid as long as the channel
1254 exists or until the founder unsets this mode.
1256 Typical implementation would use [+|-]f on user interface
1257 to set/unset this mode.
1260 0x00000400 SILC_CMODE_SILENCE_USERS
1262 Channel founder may set this mode to silence normal users
1263 on the channel. Users with operator privileges are not
1264 affected by this mode. Messages sent by normal users
1265 are dropped by servers when this mode is set. This mode
1266 can be used to moderate the channel. Only channel founder
1267 may set/unset this mode.
1270 0x00000800 SILC_CMODE_SILENCE_OPERS
1272 Channel founder may set this mode to silence operators
1273 on the channel. When used with SILC_CMODE_SILENCE_USERS
1274 mode this can be used to set the channel in state where only
1275 the founder of the channel may send messages to the channel.
1276 Messages sent by operators are dropped by servers when this
1277 mode is set. Only channel founder may set/unset this mode.
1280 To make the mode system work, client MUST keep the channel mode
1281 mask locally so that the mode setting and unsetting would work
1282 without problems. The client receives the initial channel mode
1283 mask when it joins to the channel. When the mode changes on
1284 channel the server MUST distribute the changed channel mode mask
1285 to all clients on the channel by sending the notify type
1286 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1287 to the server's primary router.
1289 Reply messages to the command:
1292 Arguments: (1) <Status Payload> (2) <Channel ID>
1293 (3) <channel mode mask>
1295 This command replies with the changed channel mode mask that
1296 client MUST keep locally.
1301 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1302 SILC_STATUS_ERR_TOO_MANY_PARAMS
1303 SILC_STATUS_ERR_NOT_REGISTERED
1304 SILC_STATUS_ERR_NOT_ON_CHANNEL
1305 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1306 SILC_STATUS_ERR_BAD_CHANNEL_ID
1307 SILC_STATUS_ERR_NO_CHANNEL_ID
1308 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1309 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1310 SILC_STATUS_ERR_UNKNOWN_MODE
1311 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1312 SILC_STATUS_ERR_AUTH_FAILED
1315 18 SILC_COMMAND_CUMODE
1318 Arguments: (1) <Channel ID> (2) <mode mask>
1319 (3) <Client ID> (4) [<auth payload>]
1321 This command is used by client to change channel user modes on
1322 channel. Users on channel may have some special modes and this
1323 command is used by channel operators to set or change these modes.
1324 The <Channel ID> is the ID of the target channel. The <mode mask>
1325 is OR'ed mask of modes. The <Client ID> is the target client.
1326 The client changing channel user modes MUST be on the same channel
1327 as the target client and poses sufficient privileges to be able to
1330 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1331 type is distributed to the channel.
1333 The following channel modes are defined:
1335 0x00000000 SILC_CUMODE_NONE
1337 No specific mode. This is the normal situation for client.
1338 Also, this is the mode set when removing all modes from
1342 0x00000001 SILC_CUMODE_FOUNDER
1344 The client is channel founder of the channel. Usually this
1345 mode is set only by the server when the channel was created.
1346 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1347 been set, the client can claim channel founder privileges
1348 by providing the <auth payload> that the server will use
1349 to authenticate the client. The public key that server will
1350 use to verify the <auth payload> must the same public key
1351 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1352 mode was set. The client MAY remove this mode at any time.
1355 0x00000002 SILC_CUMODE_OPERATOR
1357 Sets channel operator privileges on the channel for a
1358 client on the channel. Channel founder and channel operator
1359 MAY set/unset this mode.
1361 Reply messages to the command:
1364 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1365 (3) <Channel ID> (4) <Client ID>
1367 This command replies with the changed channel user mode mask that
1368 client MUST keep locally. The <Channel ID> is the specified
1369 channel. The <Client ID> is the target client.
1374 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1375 SILC_STATUS_ERR_TOO_MANY_PARAMS
1376 SILC_STATUS_ERR_NOT_REGISTERED
1377 SILC_STATUS_ERR_NOT_ON_CHANNEL
1378 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1379 SILC_STATUS_ERR_BAD_CHANNEL_ID
1380 SILC_STATUS_ERR_NO_CHANNEL_ID
1381 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1382 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1383 SILC_STATUS_ERR_UNKNOWN_MODE
1384 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1385 SILC_STATUS_ERR_AUTH_FAILED
1388 19 SILC_COMMAND_KICK
1391 Arguments: (1) <Channel ID> (2) <Client ID>
1394 This command is used by channel operators to remove a client from
1395 channel. The <channel> argument is the channel the client to be
1396 removed is on currently. Note that the "kicker" must be on the same
1397 channel. If <comment> is provided it will be sent to the removed
1400 After kicking the client the server MUST send the notify type
1401 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1402 The channel key MUST also be re-generated after kicking, unless
1403 the SILC_CMODE_PRIVKEY mode is set.
1405 Reply messages to the command:
1408 Arguments: (1) <Status Payload>
1410 This command replies only with Status Payload.
1415 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1416 SILC_STATUS_ERR_TOO_MANY_PARAMS
1417 SILC_STATUS_ERR_NOT_REGISTERED
1418 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1419 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1420 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1421 SILC_STATUS_ERR_NO_CLIENT_ID
1427 Arguments: (1) <Channel ID> (2) [<adding client>]
1428 (3) [<removing client>]
1430 This command is used to manage the ban list of the channel
1431 indicated by the <Channel ID>. A client that is banned from
1432 channel is no longer able to join the channel. The client which
1433 is executing this command MUST have at least channel operator
1434 privileges on the channel.
1436 The <adding client> and <removing client> are used to add to and
1437 remove from the ban list. The format of the <adding client> and
1438 the <removing client> is of following format:
1440 [<nickname>[@<server>]!][<username>]@[<hostname>]
1442 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1443 primary router after adding to or removing from the ban list.
1444 The wildcards MAY be used with this command. If adding or removing
1445 from than one clients then the lists are an comma (`,') separated.
1447 If this command is executed without the ban arguments the command
1448 merely replies with the current ban list.
1451 Reply messages to the command:
1454 Arguments: (1) <Status Payload> (2) <Channel ID>
1457 This command replies with the <Channel ID> of the channel and
1458 the current <ban list> of the channel if it exists.
1463 SILC_STATUS_ERR_NOT_REGISTERED
1464 SILC_STATUS_ERR_TOO_MANY_PARAMS
1465 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1466 SILC_STATUS_ERR_NO_CHANNEL_ID
1467 SILC_STATUS_ERR_NOT_ON_CHANNEL
1468 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1471 21 <deprecated command>
1474 22 <deprecated command>
1477 23 SILC_COMMAND_SILCOPER
1480 Arguments: (1) <username> (2) <authentication payload>
1482 This command is used by normal client to obtain router operator
1483 privileges (also known as SILC operator) on the router. Note
1484 that router operator has privileges that supersedes the server
1485 operator privileges.
1487 The <username> is the username set in the server configurations
1488 as operator. The <authentication payload> is the data that the
1489 client is authenticated against. It may be passphrase prompted
1490 for user on client's screen or it may be public key or certificate
1491 authentication data (data signed with private key). The public
1492 key that router will use to verify the signature found in the
1493 payload should be verified. It is recommended that the public
1494 key is saved locally in the router and router would not use
1495 any public keys received during the SKE.
1497 Difference between router operator and server operator is that
1498 router operator is able to handle cell level properties while
1499 server operator (even on router server) is able to handle only
1500 local properties, such as, local connections and normal server
1501 administration. The router operator is also able to use the
1502 SILC_COMMAND_KILL command.
1504 After changing the mode server MUST send the notify type
1505 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1507 Reply messages to the command:
1510 Arguments: (1) <Status Payload>
1512 This command replies only with Status Payload.
1517 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1518 SILC_STATUS_ERR_TOO_MANY_PARAMS
1519 SILC_STATUS_ERR_NOT_REGISTERED
1520 SILC_STATUS_ERR_AUTH_FAILED
1523 24 SILC_COMMAND_LEAVE
1526 Arguments: (1) <Channel ID>
1528 This command is used by client to leave a channel the client is
1531 When leaving channel the server MUST send the notify type
1532 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1533 The channel key MUST also be re-generated when leaving the channel
1534 and distribute it to all clients still currently on the channel.
1535 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1538 Reply messages to the command:
1541 Arguments: (1) <Status Payload> (2) <Channel ID>
1543 The <Channel ID> is the ID of left channel.
1548 SILC_STATUS_ERR_NOT_REGISTERED
1549 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1550 SILC_STATUS_ERR_TOO_MANY_PARAMS
1551 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1552 SILC_STATUS_ERR_BAD_CHANNEL_ID
1553 SILC_STATUS_ERR_NO_CHANNEL_ID
1556 25 SILC_COMMAND_USERS
1559 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1561 This command is used to list user names currently on the requested
1562 channel; either the argument <Channel ID> or the <channel name>.
1563 One of these arguments must be present. The server MUST resolve
1564 the user names and send a comma (`,') separated list of user names
1565 on the channel. Server or router MAY resolve the names by sending
1566 SILC_COMMAND_WHOIS or SILC_COMMAND_IDENTIFY commands.
1568 If the requested channel is a private or secret channel, this
1569 command MUST NOT send the list of users, as private and secret
1570 channels cannot be seen by outside. In this case the returned
1571 name list MAY include a indication that the server could not
1572 resolve the names of the users on the channel. Also, in this case
1573 Client ID's or client modes are not sent either.
1575 Reply messages to the command:
1578 Arguments: (1) <Status Payload> (2) <Channel ID>
1579 (3) <list count> (4) <Client ID list>
1580 (5) <client mode list>
1582 This command replies with the Channel ID of the requested channel
1583 Client ID list of the users on the channel and list of their modes.
1584 The Client ID list has Client ID's of all users in the list. The
1585 <Client ID list> is formed by adding Client ID's one after another.
1586 The <client mode list> is formed by adding client's user modes on
1587 the channel one after another (4 bytes (32 bits) each). The <list
1588 count> of length of 4 bytes (32 bits), tells the number of entries
1589 in the lists. Both lists MUST have equal number of entries.
1594 SILC_STATUS_ERR_NOT_REGISTERED
1595 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1596 SILC_STATUS_ERR_TOO_MANY_PARAMS
1597 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1598 SILC_STATUS_ERR_BAD_CHANNEL_ID
1599 SILC_STATUS_ERR_NO_CHANNEL_ID
1600 SILC_STATUS_ERR_NOT_ON_CHANNEL
1603 26 SILC_COMMAND_GETKEY
1606 Arguments: (1) <ID Payload>
1608 This command is used to fetch the public key of the client or
1609 server indicated by the <ID Payload>. The public key is fetched
1610 from the server where to the client is connected.
1612 Reply messages to the command:
1615 Arguments: (1) <Status Payload> (2) <ID Payload>
1616 (3) [<Public Key Payload>]
1618 This command replies with the client's or server's ID and with
1619 the <Public Key Payload>.
1624 SILC_STATUS_ERR_NOT_REGISTERED
1625 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1626 SILC_STATUS_ERR_TOO_MANY_PARAMS
1627 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1628 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1633 Currently undefined commands.
1638 These commands are reserved for private use and will not be defined
1642 255 SILC_COMMAND_MAX
1644 Reserved command. This must not be sent.
1649 2.3 SILC Command Status Types
1652 2.3.1 SILC Command Status Payload
1654 Command Status Payload is sent in command reply messages to indicate
1655 the status of the command. The payload is one of argument in the
1656 command thus this is the data area in Command Argument Payload described
1657 in [SILC2]. The payload is only 2 bytes of length. The following diagram
1658 represents the Command Status Payload (field is always in MSB order).
1664 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1665 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1667 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1671 Figure 6: SILC Command Status Payload
1675 o Status (1 byte) - Indicates the status message type,
1676 error, start of list, entry of list or end of list.
1678 o Error (1 byte) - Indicates the error if the Status
1679 field is some list status, which means there are list
1683 The values in Status and Error fields are set according
1684 the following rules:
1687 o If there is single reply and error has not occurred
1688 then Status field includes value SILC_STATUS_OK, and
1689 the Error field MUST be ignored (and set to zero
1692 o If there is single error, then Status field includes
1693 one of the error values, and the Error field MUST be
1694 ignored (and set to zero value).
1696 o If there will be multiple successful command replies
1697 then Status field includes SILC_STATUS_LIST_START,
1698 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1699 and Error field is set to SILC_STATUS_OK.
1701 o If there are multiple error replies then Status field
1702 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1703 or SILC_STATUS_LIST_END value, and the Error field
1704 includes the error value.
1707 This way it is possible to send single successful or
1708 single error reply, but also multiple successful and
1709 multiple error replies. Note that it is possible to
1710 send both list of successful replies and list of error
1711 replies at the same time, however in this case the
1712 list of error replies MUST be sent after the successful
1713 replies. This way the recipient may ignore the multiple
1714 errors if it wishes to do so.
1716 All Status messages are described in the next section.
1720 2.3.2 SILC Command Status List
1722 Command Status messages are returned in the command reply messages
1723 to indicate whether the command were executed without errors. If error
1724 has occurred the status indicates which error occurred. Status payload
1725 only sends numeric reply about the status. Receiver of the payload must
1726 convert the numeric values into human readable error messages. The
1727 list of status messages below has an example human readable error
1728 messages that client may display for the user.
1730 List of all defined command status messages following.
1733 Generic status messages:
1737 Ok status. Everything went Ok. The status payload maybe
1738 safely ignored in this case.
1740 1 SILC_STATUS_LIST_START
1742 Start of the list. There will be several command replies and
1743 this reply is the start of the list.
1745 2 SILC_STATUS_LIST_ITEM
1747 Item in the list. This is one of the item in the list but not the
1750 3 SILC_STATUS_LIST_END
1752 End of the list. There were several command replies and this
1753 reply is the last of the list. There won't be other replies
1754 belonging to this list after this one.
1758 Currently undefined and has been reserved for the future.
1761 Error status message:
1765 10 SILC_STATUS_ERR_NO_SUCH_NICK
1767 "No such nickname". Requested nickname does not exist.
1769 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1771 "No such channel". Requested channel name does not exist.
1773 12 SILC_STATUS_ERR_NO_SUCH_SERVER
1775 "No such server". Requested server name does not exist.
1777 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
1779 "Duplicate recipients. No message delivered". Message were
1780 tried to be sent to recipient which has several occurrences in
1783 14 SILC_STATUS_ERR_NO_RECIPIENT
1785 "No recipient given". Command required recipient which was
1788 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
1790 "Unknown command". Command sent to server is unknown by the
1793 16 SILC_STATUS_ERR_WILDCARDS
1795 "Wildcards cannot be used". Wildcards were provided but they
1798 17 SILC_STATUS_ERR_NO_CLIENT_ID
1800 "No Client ID given". Client ID were expected as command
1801 parameter but were not found.
1803 18 SILC_STATUS_ERR_NO_CHANNEL_ID
1805 "No Channel ID given". Channel ID were expected as command
1806 parameter but were not found.
1808 19 SILC_STATUS_ERR_NO_SERVER_ID
1810 "No Serve ID given". Server ID were expected as command
1811 parameter but were not found.
1813 20 SILC_STATUS_ERR_BAD_CLIENT_ID
1815 "Bad Client ID". Client ID provided were erroneous.
1817 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
1819 "Bad Channel ID". Channel ID provided were erroneous.
1821 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1823 "No such Client ID". Client ID provided does not exist.
1825 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1827 "No such Channel ID". Channel ID provided does not exist.
1829 24 SILC_STATUS_ERR_NICKNAME_IN_USE
1831 "Nickname already exists". Nickname created could not be
1832 registered because number of same nicknames were already set to
1833 maximum. This is not expected to happen in real life but is
1836 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
1838 "You are not on that channel". The command were specified for
1839 channel user is not currently on.
1841 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1843 "They are not on channel". The requested target client is not
1844 on requested channel.
1846 27 SILC_STATUS_ERR_USER_ON_CHANNEL
1848 "User already on channel". User were invited on channel they
1851 28 SILC_STATUS_ERR_NOT_REGISTERED
1853 "You have not registered". User executed command that requires
1854 the client to be registered on the server before it may be
1857 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1859 "Not enough parameters". Command requires more parameters
1862 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
1864 "Too many parameters". Too many parameters were provided
1867 31 SILC_STATUS_ERR_PERM_DENIED
1869 "Permission denied". Generic permission denied error status
1870 to indicate disallowed access.
1872 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
1874 "You are banned from this server". The client tried to register
1875 on server that has explicitly denied this host to connect.
1877 33 SILC_STATUS_ERR_BAD_PASSWORD
1879 "Cannot join channel. Incorrect password". Password provided for
1880 channel were not accepted.
1882 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
1884 "Cannot join channel. Channel is full". The channel is full
1885 and client cannot be joined to it.
1887 35 SILC_STATUS_ERR_NOT_INVITED
1889 "Cannot join channel. You have not been invited". The channel
1890 is invite only channel and client has not been invited.
1892 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1894 "Cannot join channel. You have been banned". The client has
1895 been banned from the channel.
1897 37 SILC_STATUS_ERR_UNKNOWN_MODE
1899 "Unknown mode". Mode provided by the client were unknown to
1902 38 SILC_STATUS_ERR_NOT_YOU
1904 "Cannot change mode for other users". User tried to change
1905 someone else's mode.
1907 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1909 "Permission denied. You are not channel operator". Command may
1910 be executed only by channel operator.
1912 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1914 "Permission denied. You are not channel founder". Command may
1915 be executed only by channel operator.
1917 41 SILC_STATUS_ERR_NO_SERVER_PRIV
1919 "Permission denied. You are not server operator". Command may
1920 be executed only by server operator.
1922 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
1924 "Permission denied. You are not SILC operator". Command may be
1925 executed only by router (SILC) operator.
1927 43 SILC_STATUS_ERR_BAD_NICKNAME
1929 "Bad nickname". Nickname requested contained illegal characters
1932 44 SILC_STATUS_ERR_BAD_CHANNEL
1934 "Bad channel name". Channel requested contained illegal characters
1937 45 SILC_STATUS_ERR_AUTH_FAILED
1939 "Authentication failed". The authentication data sent as
1940 argument were wrong and thus authentication failed.
1942 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
1944 "The algorithm was not supported." The server does not support the
1945 requested algorithm.
1947 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1949 "No such Server ID". Server ID provided does not exist.
1955 3 Security Considerations
1957 Security is central to the design of this protocol, and these security
1958 considerations permeate the specification. Common security considerations
1959 such as keeping private keys truly private and using adequate lengths for
1960 symmetric and asymmetric keys must be followed in order to maintain the
1961 security of this protocol.
1967 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
1968 Protocol Specification", Internet Draft, April 2001.
1970 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
1973 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
1974 Protocols", Internet Draft, April 2001.
1976 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
1979 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
1982 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
1985 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
1988 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
1991 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
1994 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
1997 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2000 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2001 Infrastructure, Certificate and CRL Profile", RFC 2459,
2004 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2005 John Wiley & Sons, New York, NY, 1996.
2007 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2010 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2011 RFC 2412, November 1998.
2013 [ISAKMP] Maughan D., et al, "Internet Security Association and
2014 Key Management Protocol (ISAKMP)", RFC 2408, November
2017 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2018 (IKE)", RFC 2409, November 1998.
2020 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2021 Authentication", RFC 2104, February 1997.
2023 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2024 Specifications, Version 2.0", RFC 2437, October 1998.
2026 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2027 Requirement Levels", BCP 14, RFC 2119, March 1997.
2029 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2030 10646", RFC 2279, January 1998.
2041 Snellmanninkatu 34 A 15
2045 EMail: priikone@iki.fi
2047 This Internet-Draft expires XXX