8 .ds RF FORMFEED[Page %]
11 .ds RH 11 February 2004
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-06.txt 11 February 2004
20 Expires: 11 August 2004
26 <draft-riikonen-silc-commands-06.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 [SILC1]. The SILC Commands are
57 very important part of the SILC protocol. Usually the commands are used
58 by SILC clients to manage the SILC session, but also SILC servers may
59 use the commands. This memo specifies detailed command messages and
60 command reply messages.
73 1 Introduction .................................................. 2
74 1.1 Requirements Terminology .................................. 2
75 2 SILC Commands ................................................. 2
76 2.1 SILC Commands Syntax ...................................... 4
77 2.2 SILC Command Argument Idioms .............................. 4
78 2.3 SILC Commands List ........................................ 5
79 2.4 SILC Command Status Payload ............................... 43
80 3 SILC Status Types ............................................. 44
81 4 Security Considerations ....................................... 51
82 5 References .................................................... 51
83 6 Author's Address .............................................. 52
84 Appendix A ...................................................... 52
85 Full Copyright Statement ........................................ 54
91 This document describes the commands used in the Secure Internet Live
92 Conferencing (SILC) protocol, specified in the Secure Internet Live
93 Conferencing, Protocol Specification [SILC1]. This document specifies
94 detailed command messages and command reply messages.
96 Commands are very important part on SILC network especially for client
97 which uses commands to operate on the SILC network. Commands are used
98 to set nickname, join to channel, change modes and many other things.
100 See the [SILC1] for the requirements and the restrictions for the usage
101 of the SILC commands. The [SILC2] defines the command packet type and
102 the Command Payload which is actually used to deliver the commands and
103 command reply messages.
107 1.1 Requirements Terminology
109 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
110 MAY, and OPTIONAL, when they appear in this document, are to be
111 interpreted as described in [RFC2119].
118 2.1 SILC Commands Syntax
120 This section briefly describes the syntax of the command notions
121 in this document. Every field in command is separated from each
122 other by whitespaces (` ') indicating that each field is independent
123 argument and each argument MUST have own Command Argument Payload.
124 The number of maximum arguments are defined with each command
125 separately. The Command Argument Payload is described in [SILC2].
127 Every command defines specific number for each argument. Currently,
128 they are defined in ascending order; first argument has number one
129 (1), second has number two (2) and so on. This number is set into the
130 Argument Type field in the Command Argument Payload. This makes it
131 possible to send the arguments in free order as the number MUST be
132 used to identify the type of the argument. This makes is it also
133 possible to have multiple optional arguments in commands and in
134 command replies. The number of argument is marked in parentheses
135 before the actual argument.
140 Example: Arguments: (1) <nickname> (2) <username@host>
144 Every command replies with Status Payload. This payload tells the
145 sender of the command whether the command was completed successfully or
146 whether there was an error. If error occurred the payload includes the
147 error type. In the next section the Status Payload is not described
148 as it is common to all commands and has been described here. Commands
149 MAY reply with other arguments as well. These arguments are command
150 specific and are described in the next section.
159 Arguments: (1) <nickname>[@<server>] (2) <message>
162 The command has maximum of 3 arguments. However, only first
163 and second arguments are mandatory.
165 First argument <nickname> is mandatory but may have optional
166 <nickname@server> format as well. Second argument is mandatory
167 <message> argument. Third argument is optional <count> argument.
169 The numbers in parentheses are the argument specific numbers
170 that specify the type of the argument in Command Argument Payload.
171 The receiver always knows that, say, argument number two (2) is
172 <message> argument, regardless of the ordering of the arguments in
175 Reply messages to the command:
178 Arguments: (1) <Status Payload> (2) [<channel list>]
179 (3) <idle time> (4) [<away message>]
181 This command may reply with maximum of 4 arguments. However,
182 only the first and third arguments are mandatory. The numbers
183 in the parentheses have the same meaning as in the upper
184 command sending specification.
186 Every command reply with <Status Payload>, it is mandatory
187 argument for all command replies and for this reason it is not
188 described in the command reply descriptions.
195 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
196 SILC_STATUS_ERR_NO_SUCH_NICK
198 Every command reply also defines set of status message that it
199 may return inside the <Status Payload>. All status messages
200 are defined in the section 2.3 SILC Command Status Payload
201 The status messages defined with the command are recommendations.
202 It is possible to return other status messages not listed with
203 the command reply definition.
208 2.2 SILC Command Argument Idioms
210 All commands that has an ID as argument (for example <Client ID>) are
211 actually ID Payloads, defined in [SILC2] that includes the type of the
212 ID, length of the ID and the actual ID data. This way variable length
213 ID's can be sent as arguments.
215 All passphrases that may be sent in commands as arguments MUST be
216 UTF-8 [RFC3629] encoded. All strings sent as arguments in command and
217 command reply are also UTF-8 encoded, unless otherwise defined. See
218 the [SILC1] for general UTF-8 definition in SILC protocol.
220 All public keys and certificates that are sent as arguments are actually
221 Public Key Payloads [SILC2]. This way it is possible to send different
222 kind of public keys and certificate types as arguments.
228 2.3 SILC Commands List
230 This section lists all SILC commands, however, it is expected that a
231 implementation and especially client implementation has many more
232 commands that has only local affect. These commands are official
233 SILC commands that has both client and server sides and cannot be
234 characterized as local commands.
236 List of all defined commands in SILC follows.
241 None. This is reserved command and MUST NOT be sent.
247 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
248 (3) [<Requested Attributes>] (4) [<Client ID>]
251 Whois command is used to query various information about specific
252 user. The user may be requested by their nickname and server name.
253 The query may find multiple matching users as there are no unique
254 nicknames in the SILC. The <count> option may be given to narrow
255 down the number of accepted results. If this is not defined there
256 are no limit of accepted results. The query may also be narrowed
257 down by defining the server name of the nickname. The <count> is
258 32 bit MSB first order integer.
260 It is also possible to search the user by Client ID. If the
261 <Client ID> is provided server MUST use it as the search value
262 instead of the <nickname>. It is also possible to define multiple
263 Client ID's to search multiple users sending only one WHOIS
264 command. In this case the Client ID's are appended as normal
267 The <Requested Attributes> is defined in [ATTRS] and can be used
268 to request various information about the client. See Appendix A
269 for definition of using these attributes in SILC. If neither the
270 <nickname> or <Client ID> arguments are present but the attributes
271 are, the server MUST use the attributes to do the searching. If
272 none of the arguments, <nickname>, <Client ID> and <Requested
273 Attributes> are present, error MUST be retuned. Server MAY
274 use the <Requested Attributes> to narrow down the search if they
277 To prevent miss-use of this command wildcards in the nickname
278 or in the server name are not permitted. It is not allowed
279 to request all users on some server. The WHOIS requests MUST
280 be based on explicit nickname request.
282 The WHOIS request MUST be always sent to the router by normal
283 server so that all users are searched. However, the server still
284 MUST search its locally connected clients. The router MUST send
285 this command to the server which owns the requested client, if
286 the router is unable to provide all mandatory information about
287 the client. That server MUST reply to the command. Server MUST
288 NOT send whois replies to the client until it has received the
289 reply from its router.
291 Reply messages to the command:
294 Arguments: (1) <Status Payload> (2) <Client ID>
295 (3) <nickname>[@<server>] (4) <username@host>
296 (5) <real name> (6) [<Channel Payload
298 (7) [<user mode>] (8) [<idle time>]
299 (9) [<fingerprint>] (10) <channel user
304 This command may reply with several command reply messages to
305 form a list of results. In this case the status payload will
306 include STATUS_LIST_START status in the first reply and
307 STATUS_LIST_END in the last reply to indicate the end of the
308 list. If there are only one reply the status is set to normal
309 STATUS_OK. If multiple Client IDs was requested then each found
310 and unfound client MUST cause successful or error reply,
313 The command replies include the Client ID of the nickname,
314 nickname and server name, user name and host name and user's real
315 name. Client should process these replies only after the last
316 reply has been received with the STATUS_LIST_END status. If the
317 <count> option were defined in the query there will be only
318 <count> many replies from the server.
320 The server returns the list of channels if the client has
321 joined channels. In this case the list is list of Channel
322 Payloads. The Mode Mask in the Channel Payload is the channel's
323 mode. The list is encoded by adding the Channel Payloads one
324 after the other. Private and secret channels MUST NOT be sent,
325 except if the sender of this command is on those channels, or
326 the sender is server. The <channel user mode list> MUST also
327 be sent if client is joined channels. This list includes 32 bit
328 MSB first order values one after the other and each indicate
329 the user's mode on a channel. The order of these values MUST
330 be same as the channel order in the <Channel Payload list>.
332 The server also returns client's user mode, idle time, and the
333 fingerprint of the client's public key. The <fingerprint> is the
334 binary hash digest of the public key. The fingerprint MUST NOT
335 be sent if the server has not verified the proof of possession of
336 the corresponding private key. Server can do this during the
337 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
339 The <Attributes> is the reply to the <Requested Attributes>.
340 See the Appendix A for more information.
345 SILC_STATUS_LIST_START
347 SILC_STATUS_ERR_NO_SUCH_NICK
348 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
349 SILC_STATUS_ERR_WILDCARDS
350 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
351 SILC_STATUS_ERR_TOO_MANY_PARAMS
354 2 SILC_COMMAND_WHOWAS
357 Arguments: (1) <nickname>[@<server>] (2) [<count>]
359 Whowas. This command is used to query history information about
360 specific user. The user may be requested by their nickname and
361 server name. The query may find multiple matching users as there
362 are no unique nicknames in the SILC. The <count> option may be
363 given to narrow down the number of accepted results. If this
364 is not defined there are no limit of accepted results. The query
365 may also be narrowed down by defining the server name of the
366 nickname. The <count> is 32 bit MSB first order integer.
368 To prevent miss-use of this command wildcards in the nickname
369 or in the server name are not permitted. The WHOWAS requests MUST
370 be based on specific nickname request.
372 The WHOWAS request MUST be always sent to the router by server
373 so that all users are searched. However, the server still must
374 search its locally connected clients.
376 Reply messages to the command:
379 Arguments: (1) <Status Payload> (2) <Client ID>
380 (3) <nickname>[@<server>] (4) <username@host>
383 This command may reply with several command reply messages to form
384 a list of results. In this case the status payload will include
385 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
386 the last reply to indicate the end of the list. If there are only
387 one reply the status is set to normal STATUS_OK.
389 The command replies with nickname and user name and host name.
390 Every server MUST keep history for some period of time of its
391 locally connected clients.
396 SILC_STATUS_LIST_START
398 SILC_STATUS_ERR_NO_SUCH_NICK
399 SILC_STATUS_ERR_WILDCARDS
400 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
401 SILC_STATUS_ERR_TOO_MANY_PARAMS
404 3 SILC_COMMAND_IDENTIFY
407 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
408 (3) [<channel name>] (4) [<count>]
409 (5) [<ID Payload>] (n) [...]
411 Identify command is used to query information about an entity by
412 the entity's name or ID. This command can be used to query
413 information about clients, servers and channels.
415 The query may find multiple matching entities. The <count> option
416 may be given to narrow down the number of accepted results. If
417 this is not defined there are no limit of accepted results. The
418 <count> is 32 bit MSB first order integer.
420 It is also possible to search the entity by its ID. If the
421 <ID Payload> is provided server must use it as the search value
422 instead of the entity's name. One of the arguments MUST be given.
423 It is also possible to define multiple ID Payloads to search
424 multiple entities sending only one IDENTIFY command. In this case
425 the ID Payloads are appended as normal arguments. The type of the
426 entity is defined by the type of the ID Payload.
428 To prevent miss-use of this command wildcards in the names are
429 not permitted. It is not allowed to request for example all users
432 Implementations may not want to give interface access to this
433 command as it is hardly a command that would be used by an end
434 user. However, it must be implemented as it is most likely used
435 with private message sending.
437 The IDENTIFY command MUST be always sent to the router by server
438 so that all users are searched. However, server MUST still search
439 its locally connected clients.
441 Reply messages to the command:
444 Arguments: (1) <Status Payload> (2) <ID Payload>
445 (3) [<entity's name>] (4) [<info>]
447 This command may reply with several command reply messages to form
448 a list of results. In this case the status payload will include
449 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
450 the last reply to indicate the end of the list. If there are only
451 one reply the status is set to normal STATUS_OK. If multiple Client
452 IDs was requested then each found and unfound client must cause
453 successful or error reply, respectively.
455 When querying clients the <entity's name> must include the client's
456 nickname in the following format: nickname[@server]. The
457 <info> must include the client's username and host in the following
458 format: username@host.
460 When querying servers the <entity's name> must include the server's
461 full name. The <info> may be omitted.
463 When querying channels the <entity's name> must include the
464 channel's name. The <info> may be omitted.
466 If the <count> option were defined in the query there will be only
467 <count> many replies from the server.
472 SILC_STATUS_LIST_START
474 SILC_STATUS_ERR_NO_SUCH_NICK
475 SILC_STATUS_ERR_NO_SUCH_SERVER
476 SILC_STATUS_ERR_NO_SUCH_CHANNEL
477 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
478 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
479 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
480 SILC_STATUS_ERR_WILDCARDS
481 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
482 SILC_STATUS_ERR_TOO_MANY_PARAMS
488 Arguments: (1) <nickname>
490 Set/change nickname. This command is used to set nickname for
491 user. See [SILC1] for definition of correctly formatted
494 When nickname is changed new Client ID is generated. Server MUST
495 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
496 channels (if any) the client is joined on. Then it MUST send
497 SILC_NOTIFY_TYPE_NICK_CHANGE notify to its primary route to
498 notify about nickname and Client ID change.
500 Reply messages to the command:
503 Arguments: (1) <Status Payload> (2) <New ID Payload>
506 This command replies always with <New ID Payload> that is
507 generated by the server every time user changes their nickname.
508 Client receiving this payload MUST start using the received
509 Client ID as its current valid Client ID. The New ID Payload
510 is described in [SILC2]. The <nickname> is the user's new
516 SILC_STATUS_ERR_WILDCARDS
517 SILC_STATUS_ERR_NICKNAME_IN_USE
518 SILC_STATUS_ERR_BAD_NICKNAME
519 SILC_STATUS_ERR_NOT_REGISTERED
520 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
521 SILC_STATUS_ERR_TOO_MANY_PARAMS
527 Arguments: (1) [<Channel ID>]
529 The list command is used to list channels and their topics on the
530 current server. If the <Channel ID> parameter is used, only the
531 status of that channel is displayed. Secret channels are not
532 listed at all. Private channels are listed with status indicating
533 that the channel is private. Router MAY reply with all channels
536 Reply messages to the command:
539 Arguments: (1) <Status Payload> (2) <Channel ID>
540 (3) <channel> (4) [<topic>]
543 This command may reply with several command reply messages to form
544 a list of results. In this case the status payload will include
545 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
546 the last reply to indicate the end of the list. If there are only
547 one reply the status is set to normal STATUS_OK.
549 This command replies with Channel ID, name and the topic of the
550 channel. If the channel is private channel the <topic> SHOULD
551 include the "*private*" string.
556 SILC_STATUS_LIST_START
558 SILC_STATUS_ERR_WILDCARDS
559 SILC_STATUS_ERR_NOT_REGISTERED
560 SILC_STATUS_ERR_TOO_MANY_PARAMS
561 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
562 SILC_STATUS_ERR_NO_CHANNEL_ID
563 SILC_STATUS_ERR_NO_SUCH_SERVER
569 Arguments: (1) <Channel ID> (2) [<topic>]
571 This command is used to change or view the topic of a channel.
572 The topic for channel <Channel ID> is returned if there is no
573 <topic> given. If the <topic> parameter is present, the topic
574 for that channel will be changed, if the channel modes permit
577 After setting the topic the server MUST send the notify type
578 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
579 the channel which topic was changed.
581 Reply messages to the command:
584 Arguments: (1) <Status Payload> (2) <Channel ID>
587 The command may reply with the topic of the channel if it is
593 SILC_STATUS_ERR_NOT_ON_CHANNEL
594 SILC_STATUS_ERR_WILDCARDS
595 SILC_STATUS_ERR_NOT_REGISTERED
596 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
597 SILC_STATUS_ERR_NO_SUCH_CHANNEL
598 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
599 SILC_STATUS_ERR_NO_CHANNEL_ID
600 SILC_STATUS_ERR_BAD_CHANNEL_ID
601 SILC_STATUS_ERR_TOO_MANY_PARAMS
602 SILC_STATUS_ERR_NO_CHANNEL_PRIV
605 7 SILC_COMMAND_INVITE
608 Arguments: (1) <Channel ID> (2) [<Client ID>]
609 (3) [<add | del>] (4) [<invite list>]
611 This command can be used to invite other clients to join to a
612 channel, and to manage the channel's invite list. The <Client
613 ID> argument is the target client's ID that is being invited.
614 The <Channel ID> is the Channel ID of the requested channel.
615 The sender of this command MUST be on the channel. The server
616 MUST also send the notify type SILC_NOTIFY_TYPE_INVITE to its
617 primary router and then to the client indicated by the <Client
620 The <add | del> is an argument of size of 1 byte where 0x00 means
621 adding a client to invite list, and 0x01 means deleting a client
622 from invite list. The <invite list>, if present, indicates
623 the information to be added to or removed from the invite list.
624 It may include a string for matching clients, public key of a
625 client (Public Key Payload) or Client ID of a client. The
626 <invite list> is an Argument List Payload.
628 The following Argument Types has been defined for invite list
631 0x01 - Argument is an invite string of following format:
633 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
635 The <hostname> may also be in format of IP/MASK to indicate
636 a network, for example 10.2.1.0/255.255.0.0.
638 0x02 - Argument is the public key of a client
639 0x03 - Argument is the Client ID of a client
641 If unknown type value is received or there is invalid amount of
642 Argument Payloads present in the list, the command MUST be
643 discarded. When argument that is to be deleted from the invite
644 list does not exist in the list the argument is ignored.
646 When adding to or removing from the invite list the server MUST
647 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router.
648 When the SILC_CHANNEL_MODE_INVITE is set the client which executes
649 this command MUST have at least channel operator privileges to be
650 able to add to or remove from the invite list. If this channel
651 mode is not set the list manipulation is allowed for all clients.
652 Wildcards MAY be used with this command. When this command is
653 used to invite explicit client with <Client ID> the ID MUST be
654 added to the invite list by the server.
656 When this command is given with only <Channel ID> argument then
657 the command merely returns the invite list of the channel. This
658 command MUST fail if the requested channel does not exist, the
659 requested <Client ID> is already on the channel or if the channel
660 is invite only channel and the caller of this command does not
661 have at least channel operator privileges on the channel.
663 Reply messages to the command:
666 Arguments: (1) <Status Payload> (2) <Channel ID>
669 This command replies with the invite list of the channel if it
675 SILC_STATUS_ERR_NOT_REGISTERED
676 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
677 SILC_STATUS_ERR_TOO_MANY_PARAMS
678 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
679 SILC_STATUS_ERR_NO_CLIENT_ID
680 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
681 SILC_STATUS_ERR_NO_CHANNEL_ID
682 SILC_STATUS_ERR_NOT_ON_CHANNEL
683 SILC_STATUS_ERR_USER_ON_CHANNEL
684 SILC_STATUS_ERR_NO_CHANNEL_PRIV
685 SILC_STATUS_ERR_RESOURCE_LIMIT
691 Arguments: (1) [<quit message>]
693 This command is used by client to end SILC session. The server
694 must close the connection to a client which sends this command.
695 if <quit message> is given it will be sent to other clients on
696 channel if the client is on channel when quitting.
698 Reply messages to the command:
700 This command does not reply anything.
706 Arguments: (1) <Client ID> (2) [<comment>]
709 This command can be used by SILC operators to remove a client from
710 SILC network. It also can be used by a normal client to remove
711 its own client from network by providing correct authentication
714 Router operator killing a client:
716 The removing has temporary effects and client may reconnect to
717 SILC network. The <Client ID> is the client to be removed from SILC.
718 The <comment> argument may be provided to give to the removed client
719 some information why it was removed from the network. The killer
720 MUST have SILC operator privileges.
722 When killing a client the router MUST first send notify type
723 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
724 The packet MUST NOT be sent to the killed client on the channels.
725 Then, the router MUST send the same notify type to its primary
726 router. Finally, the router MUST send the same notify type
727 destined directly to the client which was killed. The killed
728 client MUST also be removed from the invite lists of joined
729 channels if it is explicitly added in the invite lists.
731 Normal client killing by authentication:
733 When normal client executes this command the <Client ID> is the
734 destination client to be removed from the network. The client
735 MUST provide the <auth payload> which includes a digital signature
736 that MUST be verified with the public key of the client indicated
737 by <Client ID>. The <Client ID> MUST be local client to the server.
738 If the signature verification is successful the server sends
739 SILC_NOTIFY_TYPE_SIGNOFF to network and to the destination client.
740 The SILC_NOTIFY_TYPE_KILLED MUST NOT be used in this case. If the
741 verification fails the destination client remains in network.
742 The hash function used in <auth payload> computing is SHA1.
744 Reply messages to the command:
747 Arguments: (1) <Status Payload> (2) <Client ID>
749 This command returns with the requested Client ID.
754 SILC_STATUS_ERR_WILDCARDS
755 SILC_STATUS_ERR_NOT_REGISTERED
756 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
757 SILC_STATUS_ERR_TOO_MANY_PARAMS
758 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
759 SILC_STATUS_ERR_NO_CLIENT_ID
760 SILC_STATUS_ERR_NO_ROUTER_PRIV
766 Arguments: (1) [<server>] (2) [<Server ID>]
768 This command is used to fetch various information about a server.
769 If <server> argument is specified the command MUST be sent to
770 the requested server.
772 If the <Server ID> is specified the server information if fetched
773 by the provided Server ID. One of the arguments MUST always be
776 Reply messages to the command:
779 Arguments: (1) <Status Payload> (2) <Server ID>
780 (3) <server name> (4) <string>
782 This command replies with the Server ID of the server and a
783 string which tells the information about the server.
788 SILC_STATUS_ERR_WILDCARDS
789 SILC_STATUS_ERR_NOT_REGISTERED
790 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
791 SILC_STATUS_ERR_TOO_MANY_PARAMS
792 SILC_STATUS_ERR_NO_SUCH_SERVER
793 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
794 SILC_STATUS_ERR_NO_SERVER_ID
797 11 SILC_COMMAND_STATS
800 Arguments: (1) <Server ID>
802 This command is used to fetch various statistical information
803 from the server indicated by <Server ID>, which is the ID of
804 server where sender is connected to. Server receiving this
805 command MAY also send this further to its router for fetching
806 other cell and network wide statistics to accompany the reply.
808 Reply messages to the command:
811 Arguments: (1) <Status Payload> (2) <Server ID>
812 (3) [<statistics structure>]
814 This command replies with the Server ID of the server and
815 optional statistics structure which includes 32 bit MSB first
816 ordered integer values to represent various statistical
817 information. The structure is as follows:
819 starttime - time when server was started
820 uptime - uptime of the server
821 my clients - number of locally connected clients
822 my channels - number of locally created channels
823 my server ops - number of local server operators
824 my router ops - number of local router operators
825 cell clients - number of clients in local cell
826 cell channels - number of channels in local cell
827 cell servers - number of servers in local cell
828 clients - number of client in SILC network
829 channels - number of channels in SILC network
830 servers - number of servers in SILC network
831 routers - number of routers in SILC network
832 server ops - number of server operators in SILC network
833 router ops - number of router operators in SILC network
835 If some value is unknown it is set to zero (0) value. The
836 "starttime" is the start time of the server, and is seconds
837 since Epoch (POSIX.1). The "uptime" is time difference of
838 current time and "starttime" in the server, and is seconds
844 SILC_STATUS_ERR_NOT_REGISTERED
845 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
846 SILC_STATUS_ERR_TOO_MANY_PARAMS
847 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
848 SILC_STATUS_ERR_NO_SUCH_SERVER
849 SILC_STATUS_ERR_NO_SERVER_ID
855 Arguments: (1) <Server ID>
857 This command is used by client and server to test the communication
858 channel to its server if one suspects that the communication is not
859 working correctly. The <Server ID> is the ID of the server the
860 sender is connected to.
862 Reply messages to the command:
865 Arguments: (1) <Status Payload>
867 This command replies only with Status Payload. Server returns
868 SILC_STATUS_OK in Status Payload if pinging was successful.
875 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
876 SILC_STATUS_ERR_TOO_MANY_PARAMS
877 SILC_STATUS_ERR_NO_SERVER_ID
878 SILC_STATUS_ERR_NO_SUCH_SERVER
879 SILC_STATUS_ERR_NOT_REGISTERED
885 Arguments: (1) <username> (2) <authentication payload>
887 This command is used by normal client to obtain server operator
888 privileges on some server or router. Note that router operator
889 has router privileges that supersedes the server operator
890 privileges and this does not obtain those privileges. Client
891 MUST use SILCOPER command to obtain router level privileges.
893 The <username> is the username set in the server configurations
894 as operator. The <authentication payload> is the data that the
895 client is authenticated against. It may be passphrase prompted
896 for user on client's screen or it may be public key authentication
897 based on digital signatures. The public key used to verify the
898 signature should be locally saved in the server, and server should
899 not use public key received during the SKE to verify this signature.
901 After changing the mode the server MUST send the notify type
902 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
904 Reply messages to the command:
907 Arguments: (1) <Status Payload>
909 This command replies only with Status Payload.
914 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
915 SILC_STATUS_ERR_TOO_MANY_PARAMS
916 SILC_STATUS_ERR_NOT_REGISTERED
917 SILC_STATUS_ERR_AUTH_FAILED
923 Arguments: (1) <channel> (2) <Client ID>
924 (3) [<passphrase>] (4) [<cipher>]
925 (5) [<hmac>] (6) [<founder auth>]
928 Join to channel/create new channel. This command is used to
929 join to a channel. If the channel does not exist the channel is
930 created. If server is normal server this command MUST be sent
931 to router which will create the channel. The channel MAY be
932 protected with passphrase. If this is the case the passphrase
933 MUST be sent along the join command. See the [SILC1] for
934 definition of correctly formatted channel name, <channel>.
936 The second argument <Client ID> is the Client ID of the client
937 which is joining to the client. When client sends this command
938 to the server the <Client ID> MUST be the client's own ID.
940 Cipher to be used to secure the traffic on the channel MAY be
941 requested by sending the name of the requested <cipher>. This
942 is used only if the channel does not exist and is created. If
943 the channel already exists the cipher set previously for the
944 channel will be used to secure the traffic. The computed MACs
945 of the channel message are produced by the default HMAC or by
946 the <hmac> provided for the command.
948 The <founder auth> is Authentication Payload providing the
949 authentication for gaining founder privileges on the channel
950 when joining the channel. The client may provide this if it
951 knows that it is the founder of the channel and that the
952 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
953 MUST verify whether the client is able to gain the founder
954 privileges the same way as the client had given the
955 SILC_COMMAND_CUMODE command to gain founder privileges. The
956 client is still able to join the channel even if the founder
957 privileges could not be gained. The hash function used with
958 the <founder payload> MUST be sha1.
960 If the <channel auth> is present and the channel mode
961 SILC_CMODE_CHANNEL_AUTH is set the server MUST verify the
962 <channel auth> with channel public key(s). If public key that
963 can verify <channel auth> does not exist on the channel public
964 key list the client MUST NOT be allowed to join the channel.
965 Because more than one public key may be set on channel the
966 <channel auth> Authentication Payload's Public Data field
967 MUST include an indication of the public key to be used. The
968 first 20 bytes of the Public Data field MUST be SHA-1 digest of
969 the public key that must be used in verification. Rest of the
970 Public Data field are set as defined in [SILC1]. This way server
971 can determine from the digest whether that public key exist on the
972 channel and then use that key in verification. The hash function
973 used with <channel auth> MUST be sha1.
975 The server MUST check whether the user is allowed to join to
976 the requested channel. Various modes set to the channel affect
977 the ability of the user to join the channel. These conditions
980 o The user MUST be invited to the channel if the channel
981 is invite-only channel.
983 o The Client ID/nickname/username/host name/public key
984 MUST NOT match any active bans.
986 o The correct passphrase MUST be provided if passphrase
987 is set to the channel, and/or digital signature verification
988 with channel public key MUST be successful if public keys
989 has been set to the channel.
991 o The user count limit, if set, MUST NOT be reached.
993 If the client provided correct <founder auth> payload it can
994 override these conditions, except the condition for the passphrase.
995 The correct passphrase MUST be provided even if <founder auth>
998 Reply messages to the command:
1001 Arguments: (1) <Status Payload> (2) <channel>
1002 (3) <Channel ID> (4) <Client ID>
1003 (5) <channel mode mask> (6) <created>
1004 (7) [<Channel Key Payload>] (8) [<ban list>]
1005 (9) [<invite list>] (10) [<topic>]
1006 (11) [<hmac>] (12) <list count>
1007 (13) <Client ID list> (14) <client mode list>
1008 (15) [<founder pubkey>] (16) [<channel pubkeys>]
1011 This command replies with the channel name requested by the
1012 client, channel ID of the channel and topic of the channel
1013 if it exists. The <Client ID> is the Client ID which was joined
1014 to the channel. It also replies with the channel mode mask
1015 which tells all the modes set on the channel. If the channel
1016 is created the mode mask is zero (0) and <created> is 0x01.
1017 If ban mask and/or invite list is set they are sent as well.
1018 The <user limit> is the user limit on the channel, if one is set.
1020 The <list count>, <Client ID list> and <client mode list> are
1021 the clients currently on the channel and their modes on the
1022 channel. The <Client ID list> is formed by adding the ID Payloads
1023 one after the other. The <client mode list> is formed by adding
1024 32 bit MSB first order values one after the other. The <founder
1025 pubkey> is the public key (or certificate) of the channel founder.
1026 The <channel pubkeys> is Argument List Payload containing the
1027 channel public keys that has been set for the channel.
1029 Client receives the channel key in the reply message as well
1030 inside <Channel Key Payload>.
1035 SILC_STATUS_ERR_WILDCARDS
1036 SILC_STATUS_ERR_NOT_REGISTERED
1037 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1038 SILC_STATUS_ERR_TOO_MANY_PARAMS
1039 SILC_STATUS_ERR_BAD_PASSWORD
1040 SILC_STATUS_ERR_CHANNEL_IS_FULL
1041 SILC_STATUS_ERR_NOT_INVITED
1042 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1043 SILC_STATUS_ERR_BAD_CHANNEL
1044 SILC_STATUS_ERR_USER_ON_CHANNEL
1047 15 SILC_COMMAND_MOTD
1050 Arguments: (1) <server>
1052 This command is used to query the Message of the Day of the server.
1054 Reply messages to the command:
1057 Arguments: (1) <Status Payload> (2) <Server ID>
1060 This command replies with the motd message if it exists.
1065 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1066 SILC_STATUS_ERR_TOO_MANY_PARAMS
1067 SILC_STATUS_ERR_NOT_REGISTERED
1068 SILC_STATUS_ERR_NO_SUCH_SERVER
1071 16 SILC_COMMAND_UMODE
1074 Arguments: (1) <Client ID> (2) [<client mode mask>]
1076 This command is used by client to set/unset modes for itself.
1077 However, there are some modes that the client MUST NOT set itself,
1078 but they will be set by server. However, client MAY unset any
1079 mode. Modes may be masked together ORing them thus having
1080 several modes set. Client MUST keep its client mode mask
1081 locally so that the mode setting/unsetting would work without
1082 problems. Client may change only its own modes.
1084 After changing the mode server MUST send the notify type
1085 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1087 The following client modes are defined:
1089 0x00000000 SILC_UMODE_NONE
1091 No specific mode for client. This is the initial
1092 setting when new client is created. The client is
1093 normal client and is present in the network.
1096 0x00000001 SILC_UMODE_SERVER_OPERATOR
1098 Marks the user as server operator. Client MUST NOT
1099 set this mode itself. Server sets this mode to the
1100 client when client attains the server operator
1101 privileges by SILC_COMMAND_OPER command. Client
1102 MAY unset the mode itself.
1105 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1107 Marks the user as router (SILC) operator. Client
1108 MUST NOT set this mode itself. Router sets this mode
1109 to the client when client attains the router operator
1110 privileges by SILC_COMMAND_SILCOPER command. Client
1111 MAY unset the mode itself.
1114 0x00000004 SILC_UMODE_GONE
1116 Marks that the user is not currently present in the
1117 SILC Network. Client MAY set and unset this mode.
1120 0x00000008 SILC_UMODE_INDISPOSED
1122 Marks that the user is currently indisposed and may
1123 not be able to receive any messages, and that user may
1124 not be present in the network. Client MAY set and
1128 0x00000010 SILC_UMODE_BUSY
1130 Marks that the user is currently busy and may not
1131 want to receive any messages, and that user may not
1132 be present in the network. Client MAY set and unset
1136 0x00000020 SILC_UMODE_PAGE
1138 User is not currently present or is unable to receive
1139 messages, and prefers to be paged in some mechanism
1140 if the user needs to be reached. Client MAY set and
1144 0x00000040 SILC_UMODE_HYPER
1146 Marks that the user is hyper active and is eager to
1147 receive and send messages. Client MAY set and unset
1151 0x00000080 SILC_UMODE_ROBOT
1153 Marks that the client is actually a robot program.
1154 Client MAY set and unset this mode.
1157 0x00000100 SILC_UMODE_ANONYMOUS
1159 Marks that the client is anonymous client. Server
1160 that specifically is designed for anonymous services
1161 can set and unset this mode. Client MUST NOT set or
1162 unset this mode itself. A client with this mode set
1163 would have the username and the hostname information
1164 scrambled by the server which set this mode.
1167 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1169 Marks that the client wishes to block private
1170 messages sent to the client, unless the Private
1171 Message Key flag is set in the SILC packet header.
1172 If this mode is set server MUST NOT deliver private
1173 messages to the client without the Private Message
1174 Key flag being set. The Private Message Key flag set
1175 indicates that the private message is protected with
1176 a key shared between the sender and the recipient.
1178 A separate service could provide additional filtering
1179 features for accepting private messages from certain
1180 sender. However, this document does not specify such
1183 The client MAY set and unset this mode.
1186 0x00000400 SILC_UMODE_DETACHED
1188 Marks that the client is detached from the SILC network.
1189 This means that the actual network connection to the
1190 client is lost but the client entry is still valid. The
1191 detached client can be resumed at a later time. This
1192 mode MUST NOT be set by client. It can only be set when
1193 client has issued command SILC_COMMAND_DETACH. The server
1194 sets this mode. This mode cannot be unset with this
1195 command. It is unset when the client is resuming back to
1196 the network and SILC_PACKET_RESUME_CLIENT packet is
1199 This flag MUST NOT be used to determine whether a packet
1200 can be sent to the client or not. Only the server that
1201 had the original client connection can make the decision
1202 by knowing that the network connection is not active.
1203 In this case the default case is to discard the packet.
1206 0x00000800 SILC_UMODE_REJECT_WATCHING
1208 Marks that the client rejects that it could be watched
1209 by someone else. If this mode is set notifications about
1210 this client is not send, even if someone is watching the
1211 same nickname this client has. Client MAY set and unset
1212 this mode. Any changes for this client MUST NOT be
1213 notified to any watcher when this mode is set.
1215 A separate service could provide additional filtering
1216 features for rejecting and accepting the watching from
1217 certain users. However, this document does not specify
1221 0x00001000 SILC_UMODE_BLOCK_INVITE
1223 Marks that the client wishes to block incoming invite
1224 notifications. Client MAY set and unset this mode.
1225 When set server does not deliver invite notifications
1226 to the client. Note that this mode may make it harder
1227 to join invite-only channels.
1229 If the <client mode mask> was not provided this command merely
1230 returns the mode mask to the client.
1233 Reply messages to the command:
1236 Arguments: (1) <Status Payload> (2) <client mode mask>
1238 This command replies with the changed client mode mask that
1239 the client MUST to keep locally.
1245 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1246 SILC_STATUS_ERR_TOO_MANY_PARAMS
1247 SILC_STATUS_ERR_NOT_REGISTERED
1248 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1249 SILC_STATUS_ERR_BAD_CLIENT_ID
1250 SILC_STATUS_ERR_NOT_YOU
1251 SILC_STATUS_ERR_PERM_DENIED
1252 SILC_STATUS_ERR_UNKNOWN_MODE
1253 SILC_STATUS_ERR_NO_CLIENT_ID
1256 17 SILC_COMMAND_CMODE
1259 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1260 (3) [<user limit>] (4) [<passphrase>]
1261 (5) [<cipher>] (6) [<hmac>]
1262 (7) [<auth payload>] (8) [<founder pubkey>]
1263 (9) [<channel pubkey>]
1265 This command is used by client to set or change channel flags on
1266 a channel. Channel has several modes that set various properties
1267 of a channel. Modes may be masked together by ORing them thus
1268 having several modes set. The <Channel ID> is the ID of the
1269 target channel. The client changing channel mode MUST be on
1270 the same channel and posses sufficient privileges to be able to
1273 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1274 type MUST be distributed to the channel.
1276 The following channel modes are defined:
1278 0x00000000 SILC_CMODE_NONE
1280 No specific mode on channel. This is the default when
1281 channel is created. This means that channel is just plain
1285 0x00000001 SILC_CMODE_PRIVATE
1287 Channel is private channel. Private channels are shown
1288 in the channel list listed with SILC_COMMAND_LIST command
1289 with indication that the channel is private. Also,
1290 client on private channel will no be detected to be on
1291 the channel as the channel is not shown in the client's
1292 currently joined channel list. Channel founder and
1293 channel operator MAY set/unset this mode.
1296 0x00000002 SILC_CMODE_SECRET
1298 Channel is secret channel. Secret channels are not shown
1299 in the list listed with SILC_COMMAND_LIST command. Secret
1300 channels can be considered to be invisible channels.
1301 Channel founder and channel operator MAY set/unset this
1305 0x00000004 SILC_CMODE_PRIVKEY
1307 Channel uses private channel key to protect the traffic
1308 on the channel. When this mode is set the client will be
1309 responsible to set the key it wants to use to encrypt and
1310 decrypt the traffic on channel. Server generated channel
1311 keys are not used at all. This mode provides additional
1312 security as clients on channel may agree to use private
1313 channel key that even servers do not know. Naturally,
1314 this requires that every client on the channel knows
1315 the key before hand (it is considered to be pre-shared-
1316 key). The key material SHOULD be processed as stated
1317 in the [SILC3] in the section Processing the Key Material.
1319 As it is local setting it is possible to have several
1320 private channel keys on one channel. In this case several
1321 clients can talk on same channel but only those clients
1322 that share the key with the message sender will be able
1323 to hear the talking. Client SHOULD NOT display those
1324 message for the end user that it is not able to decrypt
1325 when this mode is set.
1327 Only channel founder MAY set/unset this mode. If this
1328 mode is unset the server will distribute new channel
1329 key to all clients on the channel which will be used
1333 0x00000008 SILC_CMODE_INVITE
1335 Channel is invite only channel. Client may join to this
1336 channel only if it is invited to the channel. Channel
1337 founder and channel operator MAY set/unset this mode.
1340 0x00000010 SILC_CMODE_TOPIC
1342 The topic of the channel may only be set by client that
1343 is channel founder or channel operator. Normal clients
1344 on channel will not be able to set topic when this mode
1345 is set. Channel founder and channel operator MAY set/
1349 0x00000020 SILC_CMODE_ULIMIT
1351 User limit has been set to the channel. New clients
1352 may not join to the channel when the limit set is
1353 reached. Channel founder and channel operator MAY set/
1354 unset the limit. The <user limit> argument is the
1355 number of limited users.
1358 0x00000040 SILC_CMODE_PASSPHRASE
1360 Passphrase has been set to the channel. Client may
1361 join to the channel only if it is able to provide the
1362 correct passphrase. Setting passphrases to channel
1363 is entirely safe as all commands are protected in the
1364 SILC network. Only channel founder MAY set/unset
1365 the passphrase. The <passphrase> argument is the
1369 0x00000080 SILC_CMODE_CIPHER
1371 Sets specific cipher to be used to protect channel
1372 traffic. The <cipher> argument is the requested cipher.
1373 When set or unset the server must re-generate new
1374 channel key. Only channel founder MAY set the cipher of
1375 the channel. When unset the new key is generated using
1376 default cipher for the channel.
1379 0x00000100 SILC_CMODE_HMAC
1381 Sets specific hmac to be used to compute the MACs of the
1382 channel message. The <hmac> argument is the requested hmac.
1383 Only channel founder may set the hmac of the channel.
1386 0x00000200 SILC_CMODE_FOUNDER_AUTH
1388 Channel founder may set this mode to be able to regain
1389 channel founder rights even if the client leaves the
1390 channel. The <auth payload> is the Authentication Payload
1391 consisting of the public key authentication method and the
1392 digital signature for that method. The passphrase or NONE
1393 authentication methods MUST NOT be accepted.
1395 The server does not save <auth payload> but MUST verify it.
1396 The public key used to verify the payload is the <founder
1397 pubkey> if present, or the public key of the client sending
1398 this command. If <founder pubkey> is present also that
1399 public key MUST be saved as founder's public key. This
1400 mode may be set only if the <auth payload> was verified
1401 successfully. The hash function used with the <auth
1402 payload> MUST be sha1.
1404 The public key of the founder is sent in the
1405 SILC_NOTIFY_TYPE_CMODE_CHANGE notify type so that other
1406 routers and servers in the network may save the public key.
1407 This way the founder can reclaim the founder rights back
1408 to the channel from any server in the network. The founder
1409 rights can be regained by the SILC_CUMODE_FOUNDER channel
1410 user mode, or during joining procedure with the command
1413 If this mode is already set but the <founder pubkey> is
1414 different the new key will replace the old founder key and
1415 the new key is distributed in the network with the
1416 SILC_NOTIFY_TYPE_CMODE_CHANGE notify. Only the original
1417 founder may set this mode multiple times and the client
1418 MUST have SILC_CUMODE_FOUNDER mode on the channel.
1420 When this channel mode is set the channel also becomes
1421 permanent. If all clients leave the channel while this
1422 mode is set the channel MUST NOT be destroyed. The founder
1423 can reclaim the founder mode back on these empty channels
1424 at any time. Implementations MAY limit the number of how
1425 many channels a user can own and how long they remain
1429 0x00000400 SILC_CMODE_SILENCE_USERS
1431 Channel founder may set this mode to silence normal users
1432 on the channel. Users with operator privileges are not
1433 affected by this mode. Messages sent by normal users
1434 are dropped by servers when this mode is set. This mode
1435 can be used to moderate the channel. Only channel founder
1436 may set/unset this mode.
1439 0x00000800 SILC_CMODE_SILENCE_OPERS
1441 Channel founder may set this mode to silence operators
1442 on the channel. When used with SILC_CMODE_SILENCE_USERS
1443 mode this can be used to set the channel in state where only
1444 the founder of the channel may send messages to the channel.
1445 Messages sent by operators are dropped by servers when this
1446 mode is set. Only channel founder may set/unset this mode.
1449 0x00001000 SILC_CMODE_CHANNEL_AUTH
1451 When this mode is set the channel has one or more public keys
1452 or certificates set, and ability to join the channel requires
1453 a client to provide digital signature that can be successfully
1454 verified with one of the channel public keys. This mode is
1455 equivalent to the SILC_MODE_PASSPHRASE except that digital
1456 signatures are used to gain access to the channel. Both
1457 modes MAY be set at the same time. Channel founder may set
1458 and unset this mode.
1460 The <channel pubkey> argument is an Argument List Payload
1461 where each argument is Public Key Payload including public
1462 key to be added or removed from the channel public key list.
1463 To add a public key to channel this mode is set and the
1464 argument type is 0x00, and the argument is the public key.
1465 To remove a public key from channel public key list the
1466 argument type is 0x01, and the argument is the public key
1467 to be removed from the list. To remove all public keys at
1468 once this mode is unset. An implementation MAY limit the
1469 number of public keys that can be set for the channel.
1470 This mode MUST NOT be set if <channel pubkey> is not present
1471 when the mode is set for the first time. Implementation MAY
1472 add and remove multiple public keys at the same time by
1473 including multiple arguments to the <channel pubkey>
1474 Argument List Payload.
1477 To make the mode system work, client MUST keep the channel mode
1478 mask locally so that the mode setting and unsetting would work
1479 without problems. The client receives the initial channel mode
1480 mask when it joins to the channel. When the mode changes on
1481 channel the server MUST distribute the changed channel mode mask
1482 to all clients on the channel by sending the notify type
1483 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1484 to the server's primary router. If the <channel mode mask> was
1485 not provided this command returns the mode mask, founder key,
1486 channel public key list and the current user limit to the client.
1488 Reply messages to the command:
1491 Arguments: (1) <Status Payload> (2) <Channel ID>
1492 (3) <channel mode mask> (4) [<founder pubkey>]
1493 (5) [<channel pubkeys>] (6) [<user limit>]
1495 This command replies with the changed channel mode mask that
1496 client MUST keep locally. It may also return the channel
1497 founder's public key if it is set. It may also return list of
1498 channel public keys when the list was altered. The <channel
1499 pubkeys> is Argument List Payload and each argument includes
1500 one public key. The <user limit> is the current user limit
1501 on the channel, if one is set.
1506 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1507 SILC_STATUS_ERR_TOO_MANY_PARAMS
1508 SILC_STATUS_ERR_NOT_REGISTERED
1509 SILC_STATUS_ERR_NOT_ON_CHANNEL
1510 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1511 SILC_STATUS_ERR_BAD_CHANNEL_ID
1512 SILC_STATUS_ERR_NO_CHANNEL_ID
1513 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1514 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1515 SILC_STATUS_ERR_UNKNOWN_MODE
1516 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1517 SILC_STATUS_ERR_AUTH_FAILED
1520 18 SILC_COMMAND_CUMODE
1523 Arguments: (1) <Channel ID> (2) <mode mask>
1524 (3) <Client ID> (4) [<auth payload>]
1526 This command is used by client to change channel user modes on
1527 channel. Users on channel may have some special modes and this
1528 command is used by channel operators to set or change these modes.
1529 The <Channel ID> is the ID of the target channel. The <mode mask>
1530 is OR'ed mask of modes. The <Client ID> is the target client.
1531 The client changing channel user modes MUST be on the same channel
1532 as the target client and posses sufficient privileges to be able to
1535 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1536 type is distributed to the channel.
1538 The following channel modes are defined:
1540 0x00000000 SILC_CUMODE_NONE
1542 No specific mode. This is the normal situation for client.
1543 Also, this is the mode set when removing all modes from
1547 0x00000001 SILC_CUMODE_FOUNDER
1549 The client is channel founder of the channel. Usually this
1550 mode is set only by the server when the channel was created.
1551 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1552 been set, the client can claim channel founder privileges
1553 by providing the <auth payload> that the server will use
1554 to authenticate the client. The public key that server will
1555 use to verify the <auth payload> MUST be the same public key
1556 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1557 mode was set. The client MAY remove this mode at any time.
1560 0x00000002 SILC_CUMODE_OPERATOR
1562 Sets channel operator privileges on the channel for a
1563 client on the channel. Channel founder and channel operator
1564 MAY set/unset this mode. The client MAY remove this mode
1568 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1570 Marks that the client wishes not to receive any channel
1571 messages sent for the channel. Client MAY set and unset
1572 this mode to itself. Client MUST NOT set it to anyone else.
1573 When this mode is set server MUST NOT deliver channel
1574 messages to this client. Other packets such as channel
1575 key packets are still sent to the client.
1577 A separate service could provide additional filtering
1578 features for accepting channel messages from certain
1579 sender. However, this document does not specify such
1583 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1585 Marks that the client wishes not to receive any channel
1586 messages sent from normal users. Only messages sent by
1587 channel founder or channel operator is accepted. Client
1588 MAY set and unset this mode to itself. Client MUST NOT
1589 set it to anyone else. When this mode is set server MUST
1590 NOT deliver channel messages that are sent by normal users
1593 A separate service could provide additional filtering
1594 features for accepting channel messages from certain
1595 sender. However, this document does not specify such
1599 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1601 Marks that the client wishes not to receive any channel
1602 messages sent from robots. Messages sent by users with
1603 the SILC_UMODE_ROBOT user mode set are not delivered.
1604 Client MAY set and unset this mode to itself. Client MUST
1605 NOT set it to anyone else. When this mode is set server
1606 MUST NOT deliver channel messages that are sent by robots
1610 0x00000020 SILC_CUMODE_QUIET
1612 Marks that the client cannot talk on the channel. This
1613 mode can be set by channel operator or channel founder to
1614 some other user that is not operator or founder. The
1615 target client MUST NOT unset this mode. When this mode
1616 is set the server MUST drop messages sent by this client
1620 Reply messages to the command:
1623 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1624 (3) <Channel ID> (4) <Client ID>
1626 This command replies with the changed channel user mode mask that
1627 client MUST keep locally. The <Channel ID> is the specified
1628 channel. The <Client ID> is the target client.
1633 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1634 SILC_STATUS_ERR_TOO_MANY_PARAMS
1635 SILC_STATUS_ERR_NOT_REGISTERED
1636 SILC_STATUS_ERR_NOT_ON_CHANNEL
1637 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1638 SILC_STATUS_ERR_BAD_CHANNEL_ID
1639 SILC_STATUS_ERR_NO_CHANNEL_ID
1640 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1641 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1642 SILC_STATUS_ERR_UNKNOWN_MODE
1643 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1644 SILC_STATUS_ERR_AUTH_FAILED
1647 19 SILC_COMMAND_KICK
1650 Arguments: (1) <Channel ID> (2) <Client ID>
1653 This command is used by channel operators to remove a client from
1654 channel. The <channel> argument is the channel the client to be
1655 removed is on currently. Note that the "kicker" must be on the same
1656 channel. If <comment> is provided it will be sent to the removed
1659 After kicking the client the server MUST send the notify type
1660 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1661 The client is removed from the channel after sending this notify.
1662 The kicked client MUST be removed from the invite list of the
1663 channel if it is explicitly added in the list. The channel key
1664 MUST also be re-generated after kicking, unless the
1665 SILC_CMODE_PRIVKEY mode is set.
1667 Reply messages to the command:
1670 Arguments: (1) <Status Payload> (2) <Channel ID>
1673 This command returns the Channel ID and Client ID that was kicked
1679 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1680 SILC_STATUS_ERR_TOO_MANY_PARAMS
1681 SILC_STATUS_ERR_NOT_REGISTERED
1682 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1683 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1684 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1685 SILC_STATUS_ERR_NO_CLIENT_ID
1692 Arguments: (1) <Channel ID> (2) [<add | del>]
1695 This command is used to manage the ban list of the channel
1696 indicated by the <Channel ID>. A client that is banned from
1697 channel is no longer able to join the channel. The client which
1698 is executing this command MUST have at least channel operator
1699 privileges on the channel.
1701 The <add | del> is an argument of size of 1 byte where 0x00 means
1702 adding a client to ban list, and 0x01 means deleting a client
1703 from ban list. The <ban list>, if present, indicates the
1704 information to be added to or removed from the ban list. It
1705 may include a string for matching clients, public key of a
1706 client (Public Key Payload) or Client ID of a client. The
1707 <ban list> is an Argument List Payload.
1709 The following Argument Types has been defined for ban list
1712 0x01 - Argument is an ban string of following format:
1714 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
1716 The <hostname> may also be in format of IP/MASK to indicate
1719 0x02 - Argument is the public key of a client
1720 0x03 - Argument is the Client ID of a client
1722 If unknown type value is received or there is invalid amount of
1723 Argument Payloads present in the list, the command MUST be
1724 discarded. When argument that is to be deleted from the ban
1725 list does not exist in the list the argument is ignored.
1727 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1728 primary router after adding to or removing from the ban list.
1729 The wildcards MAY be used with this command. If this command
1730 is executed without the ban arguments the command merely replies
1731 with the current ban list.
1733 Reply messages to the command:
1736 Arguments: (1) <Status Payload> (2) <Channel ID>
1739 This command replies with the <Channel ID> of the channel and
1740 the current <ban list> of the channel if it exists.
1745 SILC_STATUS_ERR_NOT_REGISTERED
1746 SILC_STATUS_ERR_TOO_MANY_PARAMS
1747 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1748 SILC_STATUS_ERR_NO_CHANNEL_ID
1749 SILC_STATUS_ERR_NOT_ON_CHANNEL
1750 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1751 SILC_STATUS_ERR_RESOURCE_LIMIT
1756 21 SILC_COMMAND_DETACH
1761 This command is used to detach from the network. Client can
1762 send this command to its server to indicate that it will be
1763 detached. By detaching the client remains in the network but
1764 the actual network connection to the server is closed. The
1765 client may then later resume the old session back.
1767 When this command is received the server MUST check that the
1768 client is locally connected client, and set the user mode
1769 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1770 MUST be also sent to routers. The server then sends command
1771 reply to this command and closes the network connection.
1772 The server MUST NOT remove the client from its lists, or send
1773 any signoff notifications for this client. See the [SILC1]
1774 for detailed information about detaching.
1776 Reply messages to the command:
1779 Arguments: (1) <Status Payload>
1781 This command replies only with the status indication.
1786 SILC_STATUS_ERR_NOT_REGISTERED
1790 22 SILC_COMMAND_WATCH
1793 Arguments: (1) <Client ID> (2) [<add nickname>]
1794 (3) [<del nickname>] (4) [<public key>]
1796 This command is used to set up a watch for <add nickname>
1797 nickname. When a user in the network appears with the
1798 nickname, or signoffs the network or user's mode is changed
1799 the client which set up the watch will be notified about
1800 this change. This can be used to watch for certain nicknames
1801 in the network and receive notifications when for example a
1802 friend appears in the network or leaves the network.
1804 The <del nickname> is a nickname that has been previously
1805 added to watch list and is now removed from it. Notifications
1806 for that nickname will not be delivered anymore. The nickname
1807 set to watch MUST NOT include any wildcards. Note also that a
1808 nickname may match several users since nicknames are not unique.
1809 Implementations MAY set limits for how many nicknames client
1812 OPTIONALLY this command may also be set to watch clients' actions
1813 in the network using their public key or certificate. The
1814 <public key> MAY be present, and it is an Argument List Payload
1815 where each argument is a Public Key Payload including public key
1816 to be added or removed from the watch list. To To add a public
1817 key to watch list the argument type is 0x00, and the argument is
1818 the public key. To remove a public key from watch list list the
1819 argument type is 0x01, and the argument is the public key to be
1820 removed from the list. An implementation MAY limit the number of
1821 public keys that can be set on the watch list. Implementation MAY
1822 add and remove multiple public keys at the same time by including
1823 multiple arguments to the <public key> Argument List Payload.
1825 The <Client ID> is the Client ID of the sender of this command.
1827 When normal server receives this command from client it
1828 MUST send it to its router. Router will process the command
1829 and actually keeps the watch list.
1831 Reply messages to the command:
1834 Arguments: (1) <Status Payload>
1836 This command replies only with the status indication.
1841 SILC_STATUS_ERR_NOT_REGISTERED
1842 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1843 SILC_STATUS_ERR_TOO_MANY_PARAMS
1844 SILC_STATUS_ERR_BAD_NICKNAME
1845 SILC_STATUS_ERR_WILDCARDS
1846 SILC_STATUS_ERR_RESOURCE_LIMIT
1847 SILC_STATUS_ERR_NO_SUCH_NICK
1848 SILC_STATUS_ERR_NICKNAME_IN_USE
1851 23 SILC_COMMAND_SILCOPER
1854 Arguments: (1) <username> (2) <authentication payload>
1856 This command is used by normal client to obtain router operator
1857 privileges (also known as SILC operator) on the router. Note
1858 that router operator has privileges that supersedes the server
1859 operator privileges.
1861 The <username> is the username set in the server configurations
1862 as operator. The <authentication payload> is the data that the
1863 client is authenticated against. It may be passphrase prompted
1864 for user on client's screen or it may be public key or certificate
1865 authentication data (data signed with private key). The public
1866 key that router will use to verify the signature found in the
1867 payload should be verified. It is recommended that the public
1868 key is saved locally in the router and router would not use
1869 any public keys received during the SKE.
1871 Difference between router operator and server operator is that
1872 router operator is able to handle cell level properties while
1873 server operator (even on router server) is able to handle only
1874 local properties, such as, local connections and normal server
1875 administration. The router operator is also able to use the
1876 SILC_COMMAND_KILL command.
1878 After changing the mode server MUST send the notify type
1879 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1881 Reply messages to the command:
1884 Arguments: (1) <Status Payload>
1886 This command replies only with Status Payload.
1891 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1892 SILC_STATUS_ERR_TOO_MANY_PARAMS
1893 SILC_STATUS_ERR_NOT_REGISTERED
1894 SILC_STATUS_ERR_AUTH_FAILED
1899 24 SILC_COMMAND_LEAVE
1902 Arguments: (1) <Channel ID>
1904 This command is used by client to leave a channel the client is
1907 When leaving channel the server MUST send the notify type
1908 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1909 The channel key MUST also be re-generated when leaving the channel
1910 and distribute it to all clients still currently on the channel.
1911 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1914 Reply messages to the command:
1917 Arguments: (1) <Status Payload> (2) <Channel ID>
1919 The <Channel ID> is the ID of left channel.
1924 SILC_STATUS_ERR_NOT_REGISTERED
1925 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1926 SILC_STATUS_ERR_TOO_MANY_PARAMS
1927 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1928 SILC_STATUS_ERR_BAD_CHANNEL_ID
1929 SILC_STATUS_ERR_NO_CHANNEL_ID
1932 25 SILC_COMMAND_USERS
1935 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1937 This command is used to list user names currently on the requested
1938 channel; either the argument <Channel ID> or the <channel name>.
1939 One of these arguments must be present. The server MUST resolve
1940 the joined clients and reply with a lists of users on the channel
1941 and with list of user modes on the channel.
1943 If the requested channel is a private or secret channel, this
1944 command MUST NOT send the list of users, except if the sender is
1945 on the channel, or the sender is a server. Otherwise, error is
1946 returned to the sender.
1948 Reply messages to the command:
1951 Arguments: (1) <Status Payload> (2) <Channel ID>
1952 (3) <list count> (4) <Client ID list>
1953 (5) <client mode list>
1955 This command replies with the Channel ID of the requested channel
1956 Client ID list of the users on the channel and list of their modes.
1957 The Client ID list has Client ID's of all users in the list. The
1958 <Client ID list> is formed by adding Client ID's one after another.
1959 The <client mode list> is formed by adding client's user modes on
1960 the channel one after another (4 bytes (32 bits) each). The <list
1961 count> of length of 4 bytes (32 bits), tells the number of entries
1962 in the lists. Both lists MUST have equal number of entries.
1967 SILC_STATUS_ERR_NOT_REGISTERED
1968 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1969 SILC_STATUS_ERR_TOO_MANY_PARAMS
1970 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1971 SILC_STATUS_ERR_BAD_CHANNEL_ID
1972 SILC_STATUS_ERR_NO_CHANNEL_ID
1973 SILC_STATUS_ERR_NOT_ON_CHANNEL
1976 26 SILC_COMMAND_GETKEY
1979 Arguments: (1) <ID Payload>
1981 This command is used to fetch the public key of the client or
1982 server indicated by the <ID Payload>. The public key is fetched
1983 from the server where to the client is connected.
1985 Reply messages to the command:
1988 Arguments: (1) <Status Payload> (2) <ID Payload>
1989 (3) [<Public Key Payload>]
1991 This command replies with the client's or server's ID and with
1992 the <Public Key Payload>.
1997 SILC_STATUS_ERR_NOT_REGISTERED
1998 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1999 SILC_STATUS_ERR_TOO_MANY_PARAMS
2000 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2001 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2004 27 SILC_COMMAND_SERVICE
2007 Arguments: (1) [<service name>] (2) [<auth payload>]
2010 This command is used to negotiate a service agreement with a
2011 remote server. If this command is given without arguments it
2012 MAY return the service list, if it is publicly available. The
2013 <service name> is a service specific identifier, and the
2014 <auth payload> MAY be used to authenticate the requester to the
2015 remote service. The authentication to a service may be based
2016 on previous agreement with the requester and the service
2017 provider. The command MAY also take additional service
2020 This document does not specify any services. How the services
2021 are configured and put available in a server is also out of
2022 scope of this document.
2024 This command MAY be used by client to start using some service
2025 in a server, but it also MAY be used by server to negotiate
2026 to start using a service in some other server or router.
2028 After the negotiation is done both of the parties need to know
2029 from the service identifier how the service can be used. The
2030 service can be considered to be a protocol which both of the
2031 parties need to support.
2033 Reply messages to the command:
2036 Arguments: (1) <Status Payload> (2) [<service list>]
2037 (3) [<service name>] (n) [...]
2040 This command MAY reply with the <service list> when command is
2041 given without arguments, and the list is a comma separated list
2042 of service identifiers. The <service name> is the service that
2043 the sender requested and this is provided when the server has
2044 accepted the sender to use the <service name>. The command
2045 reply MAY also have additional service specific arguments.
2050 SILC_STATUS_ERR_NOT_REGISTERED
2051 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2052 SILC_STATUS_ERR_TOO_MANY_PARAMS
2053 SILC_STATUS_ERR_NO_SUCH_SERVICE
2054 SILC_STATUS_ERR_AUTH_FAILED
2055 SILC_STATUS_ERR_PERM_DENIED
2061 Currently undefined commands.
2066 These commands are reserved for private use and will not be defined
2070 255 SILC_COMMAND_MAX
2072 Reserved command. This must not be sent.
2077 2.4 SILC Command Status Payload
2079 Command Status Payload is sent in command reply messages to indicate
2080 the status of the command. The payload is one of argument in the
2081 command thus this is the data area in Command Argument Payload described
2082 in [SILC2]. The payload is only 2 bytes in length. The following
2083 diagram represents the Command Status Payload (fields are always in
2090 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
2091 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2093 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2097 Figure 6: SILC Command Status Payload
2101 o Status (1 byte) - Indicates the status message type,
2102 error, start of list, entry of list or end of list.
2104 o Error (1 byte) - Indicates the error if the Status
2105 field is some list status, which means there are list
2109 The values in Status and Error fields are set according
2110 the following rules:
2113 o If there is single reply and error has not occurred
2114 then Status field includes value SILC_STATUS_OK, and
2115 the Error field MUST be ignored (and set to zero
2118 o If there is single error, then Status field includes
2119 one of the error values, and the Error field MUST be
2120 ignored (and set to zero value).
2122 o If there will be multiple successful command replies
2123 then Status field includes SILC_STATUS_LIST_START,
2124 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
2125 and Error field is set to SILC_STATUS_OK.
2127 o If there are multiple error replies then Status field
2128 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
2129 or SILC_STATUS_LIST_END value, and the Error field
2130 includes the error value.
2133 This way it is possible to send single successful or
2134 single error reply, but also multiple successful and
2135 multiple error replies. Note that it is possible to
2136 send both list of successful replies and list of error
2137 replies at the same time, however in this case the
2138 list of error replies MUST be sent after the successful
2139 replies. This way the recipient may ignore the multiple
2140 errors if it wishes to do so. Also note that in this
2141 case the successful and error replies belong to the
2144 All Status messages are described in the next section.
2150 Status messages are returned in SILC protocol in command reply
2151 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
2152 the command reply packet and status types are sent inside the
2153 Status Payload as one of command reply argument, as defined in
2154 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
2155 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
2156 types defined in this section are used in both cases.
2158 When returning status messages in the command reply message they
2159 indicate whether the command was executed without errors. If error
2160 occurred the status indicates which error occurred. If error
2161 occurred the arguments to the command replies are dictated by the
2162 error type. If arguments are to be sent, they are defined below
2163 with the error status types.
2165 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
2166 they always send some error status. Usually they are sent to
2167 indicate that error occurred while processing some SILC packet.
2168 Please see the [SILC1] and [SILC2] for more information sending
2169 status types in SILC_NOTIFY_TYPE_ERROR notify.
2171 The Status Types are only numeric values and the receiver must
2172 convert the numeric values into human readable messages if this
2173 is desired in the application.
2175 List of all defined status types:
2178 Generic status messages:
2182 Ok status. Everything went Ok. The status payload maybe
2183 safely ignored in this case.
2185 1 SILC_STATUS_LIST_START
2187 Start of the list. There will be several command replies and
2188 this reply is the start of the list.
2190 2 SILC_STATUS_LIST_ITEM
2192 Item in the list. This is one of the item in the list but not the
2195 3 SILC_STATUS_LIST_END
2197 End of the list. There were several command replies and this
2198 reply is the last of the list. There won't be other replies
2199 belonging to this list after this one.
2203 Currently undefined and has been reserved for the future.
2206 Error status message:
2210 10 SILC_STATUS_ERR_NO_SUCH_NICK
2212 "No such nickname". Requested nickname does not exist.
2213 The next argument MUST be the requested nickname.
2215 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2217 "No such channel". Requested channel name does not exist.
2218 The next argument MUST be the requested channel name.
2220 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2222 "No such server". Requested server name does not exist.
2223 The next argument MUST be the requested server name.
2225 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2227 "Incomplete registration information". Information remote
2228 sent was incomplete.
2230 14 SILC_STATUS_ERR_NO_RECIPIENT
2232 "No recipient given". Command required recipient which was
2235 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2237 "Unknown command". Command sent to server is unknown by the
2240 16 SILC_STATUS_ERR_WILDCARDS
2242 "Wildcards cannot be used". Wildcards were provided but they
2245 17 SILC_STATUS_ERR_NO_CLIENT_ID
2247 "No Client ID given". Client ID were expected as command
2248 parameter but were not found.
2250 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2252 "No Channel ID given". Channel ID were expected as command
2253 parameter but were not found.
2255 19 SILC_STATUS_ERR_NO_SERVER_ID
2257 "No Serve ID given". Server ID were expected as command
2258 parameter but were not found.
2260 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2262 "Bad Client ID". Client ID provided were erroneous.
2263 The next argument MUST be the provided ID.
2265 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2267 "Bad Channel ID". Channel ID provided were erroneous.
2268 The next argument MUST be the provided ID.
2270 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2272 "No such Client ID". Client ID provided does not exist.
2273 The unknown Client ID MUST be provided as next argument
2276 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2278 "No such Channel ID". Channel ID provided does not exist.
2279 The unknown Channel ID MUST be provided as next argument
2282 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2284 "Nickname already exists". Nickname created could not be
2285 registered because number of same nicknames were already set to
2286 maximum. This is not expected to happen in real life but is
2289 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2291 "You are not on that channel". The command were specified for
2292 channel user is not currently on. The next argument MUST be the
2295 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2297 "They are not on channel". The requested target client is not
2298 on requested channel. The next two arguments, in this order,
2299 MUST be the requested Client ID and Channel ID.
2301 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2303 "User already on channel". User were invited on channel they
2304 already are on. The next two arguments, in this order, MUST be
2305 the requested Client ID and Channel ID.
2307 28 SILC_STATUS_ERR_NOT_REGISTERED
2309 "You have not registered". User executed command that requires
2310 the client to be registered on the server before it may be
2313 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2315 "Not enough parameters". Command requires more parameters
2318 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2320 "Too many parameters". Too many parameters were provided
2323 31 SILC_STATUS_ERR_PERM_DENIED
2325 "Permission denied". Generic permission denied error status
2326 to indicate disallowed access.
2328 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2330 "You are banned from this server". The client tried to register
2331 on server that has explicitly denied this host to connect.
2333 33 SILC_STATUS_ERR_BAD_PASSWORD
2335 "Cannot join channel. Incorrect password". Password provided for
2336 channel were not accepted. The next argument MUST be the
2339 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2341 "Cannot join channel. Channel is full". The channel is full
2342 and client cannot be joined to it. The next argument MUST be
2345 35 SILC_STATUS_ERR_NOT_INVITED
2347 "Cannot join channel. You have not been invited". The channel
2348 is invite only channel and client has not been invited. The next
2349 argument MUST be the Channel ID.
2351 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2353 "Cannot join channel. You have been banned". The client has
2354 been banned from the channel. The next argument MUST be the
2357 37 SILC_STATUS_ERR_UNKNOWN_MODE
2359 "Unknown mode". Mode provided by the client were unknown to
2362 38 SILC_STATUS_ERR_NOT_YOU
2364 "Cannot change mode for other users". User tried to change
2365 someone else's mode.
2367 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2369 "Permission denied. You are not channel operator". Command may
2370 be executed only by channel operator. The next argument MUST be
2373 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2375 "Permission denied. You are not channel founder". Command may
2376 be executed only by channel operator. The next argument MUST be
2379 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2381 "Permission denied. You are not server operator". Command may
2382 be executed only by server operator.
2384 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2386 "Permission denied. You are not SILC operator". Command may be
2387 executed only by router (SILC) operator.
2389 43 SILC_STATUS_ERR_BAD_NICKNAME
2391 "Bad nickname". Nickname requested contained illegal characters
2394 44 SILC_STATUS_ERR_BAD_CHANNEL
2396 "Bad channel name". Channel requested contained illegal characters
2399 45 SILC_STATUS_ERR_AUTH_FAILED
2401 "Authentication failed". The authentication data sent as
2402 argument were wrong and thus authentication failed.
2404 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2406 "The algorithm was not supported." The server does not support the
2407 requested algorithm. The next argument MUST be the algorithm name
2410 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2412 "No such Server ID". Server ID provided does not exist.
2413 The unknown Server ID MUST be provided as next argument
2416 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2418 "No more resources available". This can mean that server cannot
2419 or will not accept something due to resource limitations.
2421 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2423 "Service does not exist". Requested service identifier is
2424 unknown. The next argument MUST be the service identifier.
2426 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2428 "You have not been authenticated". Remote connection is not
2429 authenticated even though it is supposed to be.
2431 51 SILC_STATUS_ERR_BAD_SERVER_ID
2433 "Server ID is not valid". Provided server ID is not valid.
2434 The next argument MUST be the provided ID.
2436 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2438 "Key exchange failed". Key Exchange protocol failed.
2440 53 SILC_STATUS_ERR_BAD_VERSION
2442 "Bad version". Protocol or software version mismatch.
2444 54 SILC_STATUS_ERR_TIMEDOUT
2446 "Operation timed out". Operation or service request timed
2447 out, and thus was not processed.
2449 55 SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY
2451 "Unsupported public key type". The public key or certificate
2452 type is not supported in this implementation.
2454 56 SILC_STATUS_ERR_OPERATION_ALLOWED
2456 "Operation is not allowed". A operation, for example a command,
2457 is not allowed or it's execution is not allowed.
2464 4 Security Considerations
2466 Security is central to the design of this protocol, and these security
2467 considerations permeate the specification. Common security considerations
2468 such as keeping private keys truly private and using adequate lengths for
2469 symmetric and asymmetric keys must be followed in order to maintain the
2470 security of this protocol.
2476 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2477 Protocol Specification", Internet Draft, May 2002.
2479 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2482 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2483 Protocols", Internet Draft, May 2002.
2485 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2488 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2491 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2494 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2497 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2500 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2503 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2506 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2509 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2510 Infrastructure, Certificate and CRL Profile", RFC 2459,
2513 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2514 John Wiley & Sons, New York, NY, 1996.
2516 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2519 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2520 RFC 2412, November 1998.
2522 [ISAKMP] Maughan D., et al, "Internet Security Association and
2523 Key Management Protocol (ISAKMP)", RFC 2408, November
2526 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2527 (IKE)", RFC 2409, November 1998.
2529 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2530 Authentication", RFC 2104, February 1997.
2532 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2533 Specifications, Version 2.0", RFC 2437, October 1998.
2535 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2536 Requirement Levels", BCP 14, RFC 2119, March 1997.
2538 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
2539 10646", RFC 3629, November 2003.
2541 [ATTRS] Riikonen, P., "User Online Presence and Information
2542 Attributes", Internet Draft, May 2002.
2550 Snellmaninkatu 34 A 15
2554 EMail: priikone@iki.fi
2560 This appendix defines the usage of the <Requested Attributes> argument in
2561 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2562 and may be used to request additional information about the user. Since
2563 the information that may be requested using the attributes is something
2564 that server cannot deliver to the sender, it is possible to send the WHOIS
2565 command directly to the destination client whom will then provide the
2566 requested attributes. This requires the servers to relay the WHOIS
2567 command to the client, and it requires capability for handling the WHOIS
2568 command in the client end.
2570 The <Requested Attributes> MAY include several attributes that are
2571 requested. The format and encoding of the <Requested Attributes> is as
2572 defined in [ATTRS]. When <Requested Attributes> argument is set the
2573 server MAY process the attributes to see whether it can narrow down
2574 the WHOIS search, for example when searching with a nickname. The
2575 normal servers MUST process the WHOIS command as normal WHOIS command,
2576 that is to send the command directly to the router. The router MAY
2577 process the attributes, but it MUST send the command to the server
2578 that owns the requested client.
2580 The server that owns the client and receives the command MUST check
2581 whether the client is detached from the network. If it is detached,
2582 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2583 process the attributes and provide as many of the requested attributes
2584 as possible and then send reply back to the sender. If the client is
2585 active in the network it MUST send the command to the client for
2588 The client receiving WHOIS command SHOULD check whether the
2589 <Requested Attributes> argument is set. If it is not set then the
2590 WHOIS command SHOULD be discarded. The client processes the requested
2591 attributes and SHOULD reply to each of the requested attribute with
2592 either valid value, or with an indication that the requested attribute
2593 is not known or supported. This is to be done as defined in [ATTRS].
2594 The client always MUST send a reply to the command when some attributes
2595 were requested. The client MAY also add additional attributes to the
2596 reply even if they were not requested. The client MAY also digitally
2597 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2598 in [ATTRS]. Then the client sends the reply back to the sender of
2599 the command. The command reply that client assembles does not need
2600 to include any other argument but the <Status Payload> (1), and the
2601 <Attributes> (11). The server receiving reply from client MUST allow
2602 this sort of command reply for WHOIS command.
2604 The information received from the client MAY be cached in the
2605 server's end. The caching may be desired for example if the client
2606 can be detached from the network. This way the server is then able
2607 to provide at least partial information for a requester. The
2608 server MAY also process the command reply and verify whether the
2609 attributes provided in the reply are actually valid. If it can do
2610 this, and verify that they indeed are valid values it MAY append
2611 a digital signature at the end of the attributes with the
2612 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2613 server then MUST provide valid WHOIS command reply to the sender
2614 of the command. Other servers and routers that receive the command
2615 reply en route to the original sender MAY also cache the information.
2617 The client which receives the command reply to the WHOIS command
2618 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2619 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
2623 Full Copyright Statement
2625 Copyright (C) The Internet Society (2003). All Rights Reserved.
2627 This document and translations of it may be copied and furnished to
2628 others, and derivative works that comment on or otherwise explain it
2629 or assist in its implementation may be prepared, copied, published
2630 and distributed, in whole or in part, without restriction of any
2631 kind, provided that the above copyright notice and this paragraph are
2632 included on all such copies and derivative works. However, this
2633 document itself may not be modified in any way, such as by removing
2634 the copyright notice or references to the Internet Society or other
2635 Internet organizations, except as needed for the purpose of
2636 developing Internet standards in which case the procedures for
2637 copyrights defined in the Internet Standards process must be
2638 followed, or as required to translate it into languages other than
2641 The limited permissions granted above are perpetual and will not be
2642 revoked by the Internet Society or its successors or assigns.
2644 This document and the information contained herein is provided on an
2645 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
2646 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
2647 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
2648 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
2649 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
projects / silc.git / blob