8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-06.txt 12 August 2003
20 Expires: 12 February 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 ............................... 42
80 3 SILC Status Types ............................................. 43
81 4 Security Considerations ....................................... 50
82 5 References .................................................... 50
83 6 Author's Address .............................................. 51
84 Appendix A ...................................................... 51
85 Full Copyright Statement ........................................ 53
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 [RFC2279] encoded. All strings, with exeption of nicknames and
217 channel names [SILC1], are UTF-8 encoded. This includes strings like
218 algorithm names, quit, kick and kill messages, service identifiers and
221 All public keys and certificates that are sent as arguments are actually
222 Public Key Payloads [SILC2]. This way it is possible to send different
223 kind of public keys and certificate types as arguments.
229 2.3 SILC Commands List
231 This section lists all SILC commands, however, it is expected that a
232 implementation and especially client implementation has many more
233 commands that has only local affect. These commands are official
234 SILC commands that has both client and server sides and cannot be
235 characterized as local commands.
237 List of all defined commands in SILC follows.
242 None. This is reserved command and MUST NOT be sent.
248 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
249 (3) [<Requested Attributes>] (4) [<Client ID>]
252 Whois command is used to query various information about specific
253 user. The user may be requested by their nickname and server name.
254 The query may find multiple matching users as there are no unique
255 nicknames in the SILC. The <count> option may be given to narrow
256 down the number of accepted results. If this is not defined there
257 are no limit of accepted results. The query may also be narrowed
258 down by defining the server name of the nickname. The <count> is
259 32 bit MSB first order integer.
261 It is also possible to search the user by Client ID. If the
262 <Client ID> is provided server MUST use it as the search value
263 instead of the <nickname>. One of the arguments MUST be given.
264 It is also possible to define multiple Client ID's to search
265 multiple users sending only one WHOIS command. In this case the
266 Client ID's are appended as normal arguments.
268 To prevent miss-use of this command wildcards in the nickname
269 or in the server name are not permitted. It is not allowed
270 to request all users on some server. The WHOIS requests MUST
271 be based on explicit nickname request.
273 The WHOIS request MUST be always sent to the router by server
274 so that all users are searched. However, the server still MUST
275 search its locally connected clients. The router MUST send
276 this command to the server which owns the requested client, if
277 the router is unable to provide all mandatory information about
278 the client. That server MUST reply to the command. Server MUST
279 NOT send whois replies to the client until it has received the
280 reply from its router.
282 The <Requested Attributes> is defined in [ATTRS] and can be used
283 to request various information about the client. See Appendix A
284 for definition of using these attributes in SILC.
286 Reply messages to the command:
289 Arguments: (1) <Status Payload> (2) <Client ID>
290 (3) <nickname>[@<server>] (4) <username@host>
291 (5) <real name> (6) [<Channel Payload
293 (7) [<user mode>] (8) [<idle time>]
294 (9) [<fingerprint>] (10) <channel user
299 This command may reply with several command reply messages to
300 form a list of results. In this case the status payload will
301 include STATUS_LIST_START status in the first reply and
302 STATUS_LIST_END in the last reply to indicate the end of the
303 list. If there are only one reply the status is set to normal
304 STATUS_OK. If multiple Client IDs was requested then each found
305 and unfound client MUST cause successful or error reply,
308 The command replies include the Client ID of the nickname,
309 nickname and server name, user name and host name and user's real
310 name. Client should process these replies only after the last
311 reply has been received with the STATUS_LIST_END status. If the
312 <count> option were defined in the query there will be only
313 <count> many replies from the server.
315 The server returns the list of channels if the client has
316 joined channels. In this case the list is list of Channel
317 Payloads. The Mode Mask in the Channel Payload is the channel's
318 mode. The list is encoded by adding the Channel Payloads one
319 after the other. Private and secret channels MUST NOT be sent,
320 except if the sender of this command is on those channels, or
321 the sender is server. The <channel user mode list> MUST also
322 be sent if client is joined channels. This list includes 32 bit
323 MSB first order values one after the other and each indicate
324 the user's mode on a channel. The order of these values MUST
325 be same as the channel order in the <Channel Payload list>.
327 The server also returns client's user mode, idle time, and the
328 fingerprint of the client's public key. The <fingerprint> is the
329 binary hash digest of the public key. The fingerprint MUST NOT
330 be sent if the server has not verified the proof of possession of
331 the corresponding private key. Server can do this during the
332 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
334 The <Attributes> is the reply to the <Requested Attributes>.
335 See the Appendix A for more information.
340 SILC_STATUS_LIST_START
342 SILC_STATUS_ERR_NO_SUCH_NICK
343 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
344 SILC_STATUS_ERR_WILDCARDS
345 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
346 SILC_STATUS_ERR_TOO_MANY_PARAMS
349 2 SILC_COMMAND_WHOWAS
352 Arguments: (1) <nickname>[@<server>] (2) [<count>]
354 Whowas. This command is used to query history information about
355 specific user. The user may be requested by their nickname and
356 server name. The query may find multiple matching users as there
357 are no unique nicknames in the SILC. The <count> option may be
358 given to narrow down the number of accepted results. If this
359 is not defined there are no limit of accepted results. The query
360 may also be narrowed down by defining the server name of the
361 nickname. The <count> is 32 bit MSB first order integer.
363 To prevent miss-use of this command wildcards in the nickname
364 or in the server name are not permitted. The WHOWAS requests MUST
365 be based on specific nickname request.
367 The WHOWAS request MUST be always sent to the router by server
368 so that all users are searched. However, the server still must
369 search its locally connected clients.
371 Reply messages to the command:
374 Arguments: (1) <Status Payload> (2) <Client ID>
375 (3) <nickname>[@<server>] (4) <username@host>
378 This command may reply with several command reply messages to form
379 a list of results. In this case the status payload will include
380 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
381 the last reply to indicate the end of the list. If there are only
382 one reply the status is set to normal STATUS_OK.
384 The command replies with nickname and user name and host name.
385 Every server MUST keep history for some period of time of its
386 locally connected clients.
391 SILC_STATUS_LIST_START
393 SILC_STATUS_ERR_NO_SUCH_NICK
394 SILC_STATUS_ERR_WILDCARDS
395 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
396 SILC_STATUS_ERR_TOO_MANY_PARAMS
399 3 SILC_COMMAND_IDENTIFY
402 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
403 (3) [<channel name>] (4) [<count>]
404 (5) [<ID Payload>] (n) [...]
406 Identify command is used to query information about an entity by
407 the entity's name or ID. This command can be used to query
408 information about clients, servers and channels.
410 The query may find multiple matching entities. The <count> option
411 may be given to narrow down the number of accepted results. If
412 this is not defined there are no limit of accepted results. The
413 <count> is 32 bit MSB first order integer.
415 It is also possible to search the entity by its ID. If the
416 <ID Payload> is provided server must use it as the search value
417 instead of the entity's name. One of the arguments MUST be given.
418 It is also possible to define multiple ID Payloads to search
419 multiple entities sending only one IDENTIFY command. In this case
420 the ID Payloads are appended as normal arguments. The type of the
421 entity is defined by the type of the ID Payload.
423 To prevent miss-use of this command wildcards in the names are
424 not permitted. It is not allowed to request for example all users
427 Implementations may not want to give interface access to this
428 command as it is hardly a command that would be used by an end
429 user. However, it must be implemented as it is most likely used
430 with private message sending.
432 The IDENTIFY command MUST be always sent to the router by server
433 so that all users are searched. However, server MUST still search
434 its locally connected clients.
436 Reply messages to the command:
439 Arguments: (1) <Status Payload> (2) <ID Payload>
440 (3) [<entity's name>] (4) [<info>]
442 This command may reply with several command reply messages to form
443 a list of results. In this case the status payload will include
444 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
445 the last reply to indicate the end of the list. If there are only
446 one reply the status is set to normal STATUS_OK. If multiple Client
447 IDs was requested then each found and unfound client must cause
448 successful or error reply, respectively.
450 When querying clients the <entity's name> must include the client's
451 nickname in the following format: nickname[@server]. The
452 <info> must include the client's username and host in the following
453 format: username@host.
455 When querying servers the <entity's name> must include the server's
456 full name. The <info> may be omitted.
458 When querying channels the <entity's name> must include the
459 channel's name. The <info> may be omitted.
461 If the <count> option were defined in the query there will be only
462 <count> many replies from the server.
467 SILC_STATUS_LIST_START
469 SILC_STATUS_ERR_NO_SUCH_NICK
470 SILC_STATUS_ERR_NO_SUCH_SERVER
471 SILC_STATUS_ERR_NO_SUCH_CHANNEL
472 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
473 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
474 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
475 SILC_STATUS_ERR_WILDCARDS
476 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
477 SILC_STATUS_ERR_TOO_MANY_PARAMS
483 Arguments: (1) <nickname>
485 Set/change nickname. This command is used to set nickname for
486 user. Nickname MUST NOT include any whitespaces (` '),
487 non-printable characters, commas (`,'), '@', '!' or any wildcard
490 When nickname is changed new Client ID is generated. Server MUST
491 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
492 channels (if any) the client is joined on. Then it MUST send
493 SILC_NOTIFY_TYPE_NICK_CHANGE notify to its primary route to
494 notify about nickname and Client ID change.
496 Reply messages to the command:
499 Arguments: (1) <Status Payload> (2) <New ID Payload>
502 This command replies always with <New ID Payload> that is
503 generated by the server every time user changes their nickname.
504 Client receiving this payload MUST start using the received
505 Client ID as its current valid Client ID. The New ID Payload
506 is described in [SILC2]. The <nickname> is the user's new
512 SILC_STATUS_ERR_WILDCARDS
513 SILC_STATUS_ERR_NICKNAME_IN_USE
514 SILC_STATUS_ERR_BAD_NICKNAME
515 SILC_STATUS_ERR_NOT_REGISTERED
516 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
517 SILC_STATUS_ERR_TOO_MANY_PARAMS
523 Arguments: (1) [<Channel ID>]
525 The list command is used to list channels and their topics on the
526 current server. If the <Channel ID> parameter is used, only the
527 status of that channel is displayed. Secret channels are not
528 listed at all. Private channels are listed with status indicating
529 that the channel is private. Router MAY reply with all channels
532 Reply messages to the command:
535 Arguments: (1) <Status Payload> (2) <Channel ID>
536 (3) <channel> (4) [<topic>]
539 This command may reply with several command reply messages to form
540 a list of results. In this case the status payload will include
541 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
542 the last reply to indicate the end of the list. If there are only
543 one reply the status is set to normal STATUS_OK.
545 This command replies with Channel ID, name and the topic of the
546 channel. If the channel is private channel the <topic> SHOULD
547 include the "*private*" string.
552 SILC_STATUS_LIST_START
554 SILC_STATUS_ERR_WILDCARDS
555 SILC_STATUS_ERR_NOT_REGISTERED
556 SILC_STATUS_ERR_TOO_MANY_PARAMS
557 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
558 SILC_STATUS_ERR_NO_CHANNEL_ID
559 SILC_STATUS_ERR_NO_SUCH_SERVER
565 Arguments: (1) <Channel ID> (2) [<topic>]
567 This command is used to change or view the topic of a channel.
568 The topic for channel <Channel ID> is returned if there is no
569 <topic> given. If the <topic> parameter is present, the topic
570 for that channel will be changed, if the channel modes permit
573 After setting the topic the server MUST send the notify type
574 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
575 the channel which topic was changed.
577 Reply messages to the command:
580 Arguments: (1) <Status Payload> (2) <Channel ID>
583 The command may reply with the topic of the channel if it is
589 SILC_STATUS_ERR_NOT_ON_CHANNEL
590 SILC_STATUS_ERR_WILDCARDS
591 SILC_STATUS_ERR_NOT_REGISTERED
592 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
593 SILC_STATUS_ERR_NO_SUCH_CHANNEL
594 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
595 SILC_STATUS_ERR_NO_CHANNEL_ID
596 SILC_STATUS_ERR_BAD_CHANNEL_ID
597 SILC_STATUS_ERR_TOO_MANY_PARAMS
598 SILC_STATUS_ERR_NO_CHANNEL_PRIV
601 7 SILC_COMMAND_INVITE
604 Arguments: (1) <Channel ID> (2) [<Client ID>]
605 (3) [<add | del>] (4) [<invite list>]
607 This command can be used to invite other clients to join to a
608 channel, and to manage the channel's invite list. The <Client
609 ID> argument is the target client's ID that is being invited.
610 The <Channel ID> is the Channel ID of the requested channel.
611 The sender of this command MUST be on the channel. The server
612 MUST also send the notify type SILC_NOTIFY_TYPE_INVITE to its
613 primary router and then to the client indicated by the <Client
616 The <add | del> is an argument of size of 1 byte where 0x00 means
617 adding a client to invite list, and 0x01 means deleting a client
618 from invite list. The <invite list>, if present, indicates
619 the information to be added to or removed from the invite list.
620 It may include a string for matching clients, public key of a
621 client (Public Key Payload) or Client ID of a client. The
622 <invite list> is an Argument List Payload.
624 The following Argument Types has been defined for invite list
627 0x01 - Argument is an invite string of following format:
629 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
631 The <hostname> may also be in format of IP/MASK to indicate
632 a network, for example 10.2.1.0/255.255.0.0.
634 0x02 - Argument is the public key of a client
635 0x03 - Argument is the Client ID of a client
637 If unknown type value is received or there is invalid amount of
638 Argument Payloads present in the list, the command MUST be
639 discarded. When argument that is to be deleted from the invite
640 list does not exist in the list the argument is ignored.
642 When adding to or removing from the invite list the server MUST
643 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router.
644 When the SILC_CHANNEL_MODE_INVITE is set the client which executes
645 this command MUST have at least channel operator privileges to be
646 able to add to or remove from the invite list. If this channel
647 mode is not set the list manipulation is allowed for all clients.
648 Wildcards MAY be used with this command. When this command is
649 used to invite explicit client with <Client ID> the ID MUST be
650 added to the invite list by the server.
652 When this command is given with only <Channel ID> argument then
653 the command merely returns the invite list of the channel. This
654 command MUST fail if the requested channel does not exist, the
655 requested <Client ID> is already on the channel or if the channel
656 is invite only channel and the caller of this command does not
657 have at least channel operator privileges on the channel.
659 Reply messages to the command:
662 Arguments: (1) <Status Payload> (2) <Channel ID>
665 This command replies with the invite list of the channel if it
671 SILC_STATUS_ERR_NOT_REGISTERED
672 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
673 SILC_STATUS_ERR_TOO_MANY_PARAMS
674 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
675 SILC_STATUS_ERR_NO_CLIENT_ID
676 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
677 SILC_STATUS_ERR_NO_CHANNEL_ID
678 SILC_STATUS_ERR_NOT_ON_CHANNEL
679 SILC_STATUS_ERR_USER_ON_CHANNEL
680 SILC_STATUS_ERR_NO_CHANNEL_PRIV
681 SILC_STATUS_ERR_RESOURCE_LIMIT
687 Arguments: (1) [<quit message>]
689 This command is used by client to end SILC session. The server
690 must close the connection to a client which sends this command.
691 if <quit message> is given it will be sent to other clients on
692 channel if the client is on channel when quitting.
694 Reply messages to the command:
696 This command does not reply anything.
702 Arguments: (1) <Client ID> (2) [<comment>]
705 This command can be used by SILC operators to remove a client from
706 SILC network. It also can be used by a normal client to remove
707 its own client from network by providing correct authentication
710 Router operator killing a client:
712 The removing has temporary effects and client may reconnect to
713 SILC network. The <Client ID> is the client to be removed from SILC.
714 The <comment> argument may be provided to give to the removed client
715 some information why it was removed from the network. The killer
716 MUST have SILC operator privileges.
718 When killing a client the router MUST first send notify type
719 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
720 The packet MUST NOT be sent to the killed client on the channels.
721 Then, the router MUST send the same notify type to its primary
722 router. Finally, the router MUST send the same notify type
723 destined directly to the client which was killed. The killed
724 client MUST also be removed from the invite lists of joined
725 channels if it is explicitly added in the invite lists.
727 Normal client killing by authentication:
729 When normal client executes this command the <Client ID> is the
730 destination client to be removed from the network. The client
731 MUST provide the <auth payload> which includes a digital signature
732 that MUST be verified with the public key of the client indicated
733 by <Client ID>. The <Client ID> MUST be local client to the server.
734 If the signature verification is successful the server sends
735 SILC_NOTIFY_TYPE_SIGNOFF to network and to the destination client.
736 The SILC_NOTIFY_TYPE_KILLED MUST NOT be used in this case. If the
737 verification fails the destination client remains in network.
738 The hash function used in <auth payload> computing is SHA1.
740 Reply messages to the command:
743 Arguments: (1) <Status Payload> (2) <Client ID>
745 This command returns with the requested Client ID.
750 SILC_STATUS_ERR_WILDCARDS
751 SILC_STATUS_ERR_NOT_REGISTERED
752 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
753 SILC_STATUS_ERR_TOO_MANY_PARAMS
754 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
755 SILC_STATUS_ERR_NO_CLIENT_ID
756 SILC_STATUS_ERR_NO_ROUTER_PRIV
762 Arguments: (1) [<server>] (2) [<Server ID>]
764 This command is used to fetch various information about a server.
765 If <server> argument is specified the command MUST be sent to
766 the requested server.
768 If the <Server ID> is specified the server information if fetched
769 by the provided Server ID. One of the arguments MUST always be
772 Reply messages to the command:
775 Arguments: (1) <Status Payload> (2) <Server ID>
776 (3) <server name> (4) <string>
778 This command replies with the Server ID of the server and a
779 string which tells the information about the server.
784 SILC_STATUS_ERR_WILDCARDS
785 SILC_STATUS_ERR_NOT_REGISTERED
786 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
787 SILC_STATUS_ERR_TOO_MANY_PARAMS
788 SILC_STATUS_ERR_NO_SUCH_SERVER
789 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
790 SILC_STATUS_ERR_NO_SERVER_ID
793 11 SILC_COMMAND_STATS
796 Arguments: (1) <Server ID>
798 This command is used to fetch various statistical information
799 from the server indicated by <Server ID>, which is the ID of
800 server where sender is connected to. Server receiving this
801 command MAY also send this further to its router for fetching
802 other cell and network wide statistics to accompany the reply.
804 Reply messages to the command:
807 Arguments: (1) <Status Payload> (2) <Server ID>
808 (3) [<statistics structure>]
810 This command replies with the Server ID of the server and
811 optional statistics structure which includes 32 bit MSB first
812 ordered integer values to represent various statistical
813 information. The structure is as follows:
815 starttime - time when server was started
816 uptime - uptime of the server
817 my clients - number of locally connected clients
818 my channels - number of locally created channels
819 my server ops - number of local server operators
820 my router ops - number of local router operators
821 cell clients - number of clients in local cell
822 cell channels - number of channels in local cell
823 cell servers - number of servers in local cell
824 clients - number of client in SILC network
825 channels - number of channels in SILC network
826 servers - number of servers in SILC network
827 routers - number of routers in SILC network
828 server ops - number of server operators in SILC network
829 router ops - number of router operators in SILC network
831 If some value is unknown it is set to zero (0) value. The
832 "starttime" is the start time of the server, and is seconds
833 since Epoch (POSIX.1). The "uptime" is time difference of
834 current time and "starttime" in the server, and is seconds
840 SILC_STATUS_ERR_NOT_REGISTERED
841 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
842 SILC_STATUS_ERR_TOO_MANY_PARAMS
843 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
844 SILC_STATUS_ERR_NO_SUCH_SERVER
845 SILC_STATUS_ERR_NO_SERVER_ID
851 Arguments: (1) <Server ID>
853 This command is used by client and server to test the communication
854 channel to its server if one suspects that the communication is not
855 working correctly. The <Server ID> is the ID of the server the
856 sender is connected to.
858 Reply messages to the command:
861 Arguments: (1) <Status Payload>
863 This command replies only with Status Payload. Server returns
864 SILC_STATUS_OK in Status Payload if pinging was successful.
871 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
872 SILC_STATUS_ERR_TOO_MANY_PARAMS
873 SILC_STATUS_ERR_NO_SERVER_ID
874 SILC_STATUS_ERR_NO_SUCH_SERVER
875 SILC_STATUS_ERR_NOT_REGISTERED
881 Arguments: (1) <username> (2) <authentication payload>
883 This command is used by normal client to obtain server operator
884 privileges on some server or router. Note that router operator
885 has router privileges that supersedes the server operator
886 privileges and this does not obtain those privileges. Client
887 MUST use SILCOPER command to obtain router level privileges.
889 The <username> is the username set in the server configurations
890 as operator. The <authentication payload> is the data that the
891 client is authenticated against. It may be passphrase prompted
892 for user on client's screen or it may be public key authentication
893 based on digital signatures. The public key used to verify the
894 signature should be locally saved in the server, and server should
895 not use public key received during the SKE to verify this signature.
897 After changing the mode the server MUST send the notify type
898 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
900 Reply messages to the command:
903 Arguments: (1) <Status Payload>
905 This command replies only with Status Payload.
910 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
911 SILC_STATUS_ERR_TOO_MANY_PARAMS
912 SILC_STATUS_ERR_NOT_REGISTERED
913 SILC_STATUS_ERR_AUTH_FAILED
919 Arguments: (1) <channel> (2) <Client ID>
920 (3) [<passphrase>] (4) [<cipher>]
921 (5) [<hmac>] (6) [<founder auth>]
924 Join to channel/create new channel. This command is used to
925 join to a channel. If the channel does not exist the channel is
926 created. If server is normal server this command MUST be sent
927 to router which will create the channel. The channel MAY be
928 protected with passphrase. If this is the case the passphrase
929 MUST be sent along the join command.
931 The name of the <channel> MUST NOT include any spaces (` '),
932 non-printable characters, commas (`,') or any wildcard characters.
934 The second argument <Client ID> is the Client ID of the client
935 which is joining to the client. When client sends this command
936 to the server the <Client ID> MUST be the client's own ID.
938 Cipher to be used to secure the traffic on the channel MAY be
939 requested by sending the name of the requested <cipher>. This
940 is used only if the channel does not exist and is created. If
941 the channel already exists the cipher set previously for the
942 channel will be used to secure the traffic. The computed MACs
943 of the channel message are produced by the default HMAC or by
944 the <hmac> provided for the command.
946 The <founder auth> is Authentication Payload providing the
947 authentication for gaining founder privileges on the channel
948 when joining the channel. The client may provide this if it
949 knows that it is the founder of the channel and that the
950 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
951 MUST verify whether the client is able to gain the founder
952 privileges the same way as the client had given the
953 SILC_COMMAND_CUMODE command to gain founder privileges. The
954 client is still able to join the channel even if the founder
955 privileges could not be gained. The hash function used with
956 the <founder payload> MUST be sha1.
958 If the <channel auth> is present and the channel mode
959 SILC_CMODE_CHANNEL_AUTH is set the server MUST verify the
960 <channel auth> with channel public key(s). If public key that
961 can verify <channel auth> does not exist on the channel public
962 key list the client MUST NOT be allowed to join the channel.
963 Because more than one public key may be set on channel the
964 <channel auth> Authentication Payload's Public Data field
965 MUST include an indication of the public key to be used. The
966 first 20 bytes of the Public Data field MUST be SHA-1 digest of
967 the public key that must be used in verification. Rest of the
968 Public Data field are set as defined in [SILC1]. This way server
969 can determine from the digest whether that public key exist on the
970 channel and then use that key in verification. The hash function
971 used with <channel auth> MUST be sha1.
973 The server MUST check whether the user is allowed to join to
974 the requested channel. Various modes set to the channel affect
975 the ability of the user to join the channel. These conditions
978 o The user MUST be invited to the channel if the channel
979 is invite-only channel.
981 o The Client ID/nickname/username/host name/public key
982 MUST NOT match any active bans.
984 o The correct passphrase MUST be provided if passphrase
985 is set to the channel, and/or digital signature verification
986 with channel public key MUST be successful if public keys
987 has been set to the channel.
989 o The user count limit, if set, MUST NOT be reached.
991 If the client provided correct <founder auth> payload it can
992 override these conditions, except the condition for the passphrase.
993 The correct passphrase MUST be provided even if <founder auth>
996 Reply messages to the command:
999 Arguments: (1) <Status Payload> (2) <channel>
1000 (3) <Channel ID> (4) <Client ID>
1001 (5) <channel mode mask> (6) <created>
1002 (7) [<Channel Key Payload>] (8) [<ban list>]
1003 (9) [<invite list>] (10) [<topic>]
1004 (11) [<hmac>] (12) <list count>
1005 (13) <Client ID list> (14) <client mode list>
1006 (15) [<founder pubkey>] (16) [<channel pubkeys>]
1008 This command replies with the channel name requested by the
1009 client, channel ID of the channel and topic of the channel
1010 if it exists. The <Client ID> is the Client ID which was joined
1011 to the channel. It also replies with the channel mode mask
1012 which tells all the modes set on the channel. If the channel
1013 is created the mode mask is zero (0) and <created> is 0x01.
1014 If ban mask and/or invite list is set they are sent as well.
1016 The <list count>, <Client ID list> and <client mode list> are
1017 the clients currently on the channel and their modes on the
1018 channel. The <Client ID list> is formed by adding the ID Payloads
1019 one after the other. The <client mode list> is formed by adding
1020 32 bit MSB first order values one after the other. The <founder
1021 pubkey> is the public key (or certificate) of the channel founder.
1022 The <channel pubkeys> is Argument List Payload containing the
1023 channel public keys that has been set for the channel.
1025 Client receives the channel key in the reply message as well
1026 inside <Channel Key Payload>.
1031 SILC_STATUS_ERR_WILDCARDS
1032 SILC_STATUS_ERR_NOT_REGISTERED
1033 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1034 SILC_STATUS_ERR_TOO_MANY_PARAMS
1035 SILC_STATUS_ERR_BAD_PASSWORD
1036 SILC_STATUS_ERR_CHANNEL_IS_FULL
1037 SILC_STATUS_ERR_NOT_INVITED
1038 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1039 SILC_STATUS_ERR_BAD_CHANNEL
1040 SILC_STATUS_ERR_USER_ON_CHANNEL
1043 15 SILC_COMMAND_MOTD
1046 Arguments: (1) <server>
1048 This command is used to query the Message of the Day of the server.
1050 Reply messages to the command:
1053 Arguments: (1) <Status Payload> (2) <Server ID>
1056 This command replies with the motd message if it exists.
1061 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1062 SILC_STATUS_ERR_TOO_MANY_PARAMS
1063 SILC_STATUS_ERR_NOT_REGISTERED
1064 SILC_STATUS_ERR_NO_SUCH_SERVER
1067 16 SILC_COMMAND_UMODE
1070 Arguments: (1) <Client ID> (2) [<client mode mask>]
1072 This command is used by client to set/unset modes for itself.
1073 However, there are some modes that the client MUST NOT set itself,
1074 but they will be set by server. However, client MAY unset any
1075 mode. Modes may be masked together ORing them thus having
1076 several modes set. Client MUST keep its client mode mask
1077 locally so that the mode setting/unsetting would work without
1078 problems. Client may change only its own modes.
1080 After changing the mode server MUST send the notify type
1081 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1083 The following client modes are defined:
1085 0x00000000 SILC_UMODE_NONE
1087 No specific mode for client. This is the initial
1088 setting when new client is created. The client is
1089 normal client and is present in the network.
1092 0x00000001 SILC_UMODE_SERVER_OPERATOR
1094 Marks the user as server operator. Client MUST NOT
1095 set this mode itself. Server sets this mode to the
1096 client when client attains the server operator
1097 privileges by SILC_COMMAND_OPER command. Client
1098 MAY unset the mode itself.
1101 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1103 Marks the user as router (SILC) operator. Client
1104 MUST NOT set this mode itself. Router sets this mode
1105 to the client when client attains the router operator
1106 privileges by SILC_COMMAND_SILCOPER command. Client
1107 MAY unset the mode itself.
1110 0x00000004 SILC_UMODE_GONE
1112 Marks that the user is not currently present in the
1113 SILC Network. Client MAY set and unset this mode.
1116 0x00000008 SILC_UMODE_INDISPOSED
1118 Marks that the user is currently indisposed and may
1119 not be able to receive any messages, and that user may
1120 not be present in the network. Client MAY set and
1124 0x00000010 SILC_UMODE_BUSY
1126 Marks that the user is currently busy and may not
1127 want to receive any messages, and that user may not
1128 be present in the network. Client MAY set and unset
1132 0x00000020 SILC_UMODE_PAGE
1134 User is not currently present or is unable to receive
1135 messages, and prefers to be paged in some mechanism
1136 if the user needs to be reached. Client MAY set and
1140 0x00000040 SILC_UMODE_HYPER
1142 Marks that the user is hyper active and is eager to
1143 receive and send messages. Client MAY set and unset
1147 0x00000080 SILC_UMODE_ROBOT
1149 Marks that the client is actually a robot program.
1150 Client MAY set and unset this mode.
1153 0x00000100 SILC_UMODE_ANONYMOUS
1155 Marks that the client is anonymous client. Server
1156 that specifically is designed for anonymous services
1157 can set and unset this mode. Client MUST NOT set or
1158 unset this mode itself. A client with this mode set
1159 would have the username and the hostname information
1160 scrambled by the server which set this mode.
1163 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1165 Marks that the client wishes to block private
1166 messages sent to the client, unless the Private
1167 Message Key flag is set in the SILC packet header.
1168 If this mode is set server MUST NOT deliver private
1169 messages to the client without the Private Message
1170 Key flag being set. The Private Message Key flag set
1171 indicates that the private message is protected with
1172 a key shared between the sender and the recipient.
1174 A separate service could provide additional filtering
1175 features for accepting private messages from certain
1176 sender. However, this document does not specify such
1179 The client MAY set and unset this mode.
1182 0x00000400 SILC_UMODE_DETACHED
1184 Marks that the client is detached from the SILC network.
1185 This means that the actual network connection to the
1186 client is lost but the client entry is still valid. The
1187 detached client can be resumed at a later time. This
1188 mode MUST NOT be set by client. It can only be set when
1189 client has issued command SILC_COMMAND_DETACH. The server
1190 sets this mode. This mode cannot be unset with this
1191 command. It is unset when the client is resuming back to
1192 the network and SILC_PACKET_RESUME_CLIENT packet is
1195 This flag MUST NOT be used to determine whether a packet
1196 can be sent to the client or not. Only the server that
1197 had the original client connection can make the decision
1198 by knowing that the network connection is not active.
1199 In this case the default case is to discard the packet.
1202 0x00000800 SILC_UMODE_REJECT_WATCHING
1204 Marks that the client rejects that it could be watched
1205 by someone else. If this mode is set notifications about
1206 this client is not send, even if someone is watching the
1207 same nickname this client has. Client MAY set and unset
1208 this mode. Any changes for this client MUST NOT be
1209 notified to any watcher when this mode is set.
1211 A separate service could provide additional filtering
1212 features for rejecting and accepting the watching from
1213 certain users. However, this document does not specify
1217 0x00001000 SILC_UMODE_BLOCK_INVITE
1219 Marks that the client wishes to block incoming invite
1220 notifications. Client MAY set and unset this mode.
1221 When set server does not deliver invite notifications
1222 to the client. Note that this mode may make it harder
1223 to join invite-only channels.
1225 If the <client mode mask> was not provided this command merely
1226 returns the mode mask to the client.
1229 Reply messages to the command:
1232 Arguments: (1) <Status Payload> (2) <client mode mask>
1234 This command replies with the changed client mode mask that
1235 the client MUST to keep locally.
1241 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1242 SILC_STATUS_ERR_TOO_MANY_PARAMS
1243 SILC_STATUS_ERR_NOT_REGISTERED
1244 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1245 SILC_STATUS_ERR_BAD_CLIENT_ID
1246 SILC_STATUS_ERR_NOT_YOU
1247 SILC_STATUS_ERR_PERM_DENIED
1248 SILC_STATUS_ERR_UNKNOWN_MODE
1249 SILC_STATUS_ERR_NO_CLIENT_ID
1252 17 SILC_COMMAND_CMODE
1255 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1256 (3) [<user limit>] (4) [<passphrase>]
1257 (5) [<cipher>] (6) [<hmac>]
1258 (7) [<auth payload>] (8) [<founder pubkey>]
1259 (9) [<channel pubkey>]
1261 This command is used by client to set or change channel flags on
1262 a channel. Channel has several modes that set various properties
1263 of a channel. Modes may be masked together by ORing them thus
1264 having several modes set. The <Channel ID> is the ID of the
1265 target channel. The client changing channel mode MUST be on
1266 the same channel and posses sufficient privileges to be able to
1269 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1270 type MUST be distributed to the channel.
1272 The following channel modes are defined:
1274 0x00000000 SILC_CMODE_NONE
1276 No specific mode on channel. This is the default when
1277 channel is created. This means that channel is just plain
1281 0x00000001 SILC_CMODE_PRIVATE
1283 Channel is private channel. Private channels are shown
1284 in the channel list listed with SILC_COMMAND_LIST command
1285 with indication that the channel is private. Also,
1286 client on private channel will no be detected to be on
1287 the channel as the channel is not shown in the client's
1288 currently joined channel list. Channel founder and
1289 channel operator MAY set/unset this mode.
1292 0x00000002 SILC_CMODE_SECRET
1294 Channel is secret channel. Secret channels are not shown
1295 in the list listed with SILC_COMMAND_LIST command. Secret
1296 channels can be considered to be invisible channels.
1297 Channel founder and channel operator MAY set/unset this
1301 0x00000004 SILC_CMODE_PRIVKEY
1303 Channel uses private channel key to protect the traffic
1304 on the channel. When this mode is set the client will be
1305 responsible to set the key it wants to use to encrypt and
1306 decrypt the traffic on channel. Server generated channel
1307 keys are not used at all. This mode provides additional
1308 security as clients on channel may agree to use private
1309 channel key that even servers do not know. Naturally,
1310 this requires that every client on the channel knows
1311 the key before hand (it is considered to be pre-shared-
1312 key). The key material SHOULD be processed as stated
1313 in the [SILC3] in the section Processing the Key Material.
1315 As it is local setting it is possible to have several
1316 private channel keys on one channel. In this case several
1317 clients can talk on same channel but only those clients
1318 that share the key with the message sender will be able
1319 to hear the talking. Client SHOULD NOT display those
1320 message for the end user that it is not able to decrypt
1321 when this mode is set.
1323 Only channel founder MAY set/unset this mode. If this
1324 mode is unset the server will distribute new channel
1325 key to all clients on the channel which will be used
1329 0x00000008 SILC_CMODE_INVITE
1331 Channel is invite only channel. Client may join to this
1332 channel only if it is invited to the channel. Channel
1333 founder and channel operator MAY set/unset this mode.
1336 0x00000010 SILC_CMODE_TOPIC
1338 The topic of the channel may only be set by client that
1339 is channel founder or channel operator. Normal clients
1340 on channel will not be able to set topic when this mode
1341 is set. Channel founder and channel operator MAY set/
1345 0x00000020 SILC_CMODE_ULIMIT
1347 User limit has been set to the channel. New clients
1348 may not join to the channel when the limit set is
1349 reached. Channel founder and channel operator MAY set/
1350 unset the limit. The <user limit> argument is the
1351 number of limited users.
1354 0x00000040 SILC_CMODE_PASSPHRASE
1356 Passphrase has been set to the channel. Client may
1357 join to the channel only if it is able to provide the
1358 correct passphrase. Setting passphrases to channel
1359 is entirely safe as all commands are protected in the
1360 SILC network. Only channel founder MAY set/unset
1361 the passphrase. The <passphrase> argument is the
1365 0x00000080 SILC_CMODE_CIPHER
1367 Sets specific cipher to be used to protect channel
1368 traffic. The <cipher> argument is the requested cipher.
1369 When set or unset the server must re-generate new
1370 channel key. Only channel founder MAY set the cipher of
1371 the channel. When unset the new key is generated using
1372 default cipher for the channel.
1375 0x00000100 SILC_CMODE_HMAC
1377 Sets specific hmac to be used to compute the MACs of the
1378 channel message. The <hmac> argument is the requested hmac.
1379 Only channel founder may set the hmac of the channel.
1382 0x00000200 SILC_CMODE_FOUNDER_AUTH
1384 Channel founder may set this mode to be able to regain
1385 channel founder rights even if the client leaves the
1386 channel. The <auth payload> is the Authentication Payload
1387 consisting of the public key authentication method and the
1388 digital signature for that method. The passphrase or NONE
1389 authentication methods MUST NOT be accepted.
1391 The server does not save <auth payload> but MUST verify it.
1392 The public key used to verify the payload is the <founder
1393 pubkey> if present, or the public key of the client sending
1394 this command. If <founder pubkey> is present also that
1395 public key MUST be saved as founder's public key. This
1396 mode may be set only if the <auth payload> was verified
1397 successfully. The hash function used with the <auth
1398 payload> MUST be sha1.
1400 The public key of the founder is sent in the
1401 SILC_NOTIFY_TYPE_CMODE_CHANGE notify type so that other
1402 routers and servers in the network may save the public key.
1403 This way the founder can reclaim the founder rights back
1404 to the channel from any server in the network. The founder
1405 rights can be regained by the SILC_CUMODE_FOUNDER channel
1406 user mode, or during joining procedure with the command
1409 If this mode is already set but the <founder pubkey> is
1410 different the new key will replace the old founder key and
1411 the new key is distributed in the network with the
1412 SILC_NOTIFY_TYPE_CMODE_CHANGE notify. Only the original
1413 founder may set this mode multiple times and the client
1414 MUST have SILC_CUMODE_FOUNDER mode on the channel.
1416 When this channel mode is set the channel also becomes
1417 permanent. If all clients leave the channel while this
1418 mode is set the channel MUST NOT be destroyed. The founder
1419 can reclaim the founder mode back on these empty channels
1420 at any time. Implementations MAY limit the number of how
1421 many channels a user can own and how long they remain
1425 0x00000400 SILC_CMODE_SILENCE_USERS
1427 Channel founder may set this mode to silence normal users
1428 on the channel. Users with operator privileges are not
1429 affected by this mode. Messages sent by normal users
1430 are dropped by servers when this mode is set. This mode
1431 can be used to moderate the channel. Only channel founder
1432 may set/unset this mode.
1435 0x00000800 SILC_CMODE_SILENCE_OPERS
1437 Channel founder may set this mode to silence operators
1438 on the channel. When used with SILC_CMODE_SILENCE_USERS
1439 mode this can be used to set the channel in state where only
1440 the founder of the channel may send messages to the channel.
1441 Messages sent by operators are dropped by servers when this
1442 mode is set. Only channel founder may set/unset this mode.
1445 0x00001000 SILC_CMODE_CHANNEL_AUTH
1447 When this mode is set the channel has one or more public keys
1448 or certificates set, and ability to join the channel requires
1449 a client to provide digital signature that can be successfully
1450 verified with one of the channel public keys. This mode is
1451 equivalent to the SILC_MODE_PASSPHRASE except that digital
1452 signatures are used to gain access to the channel. Both
1453 modes MAY be set at the same time. Channel founder may set
1454 and unset this mode.
1456 The <channel pubkey> argument is an Argument List Payload
1457 where each argument is Public Key Payload including public
1458 key to be added or removed from the channel public key list.
1459 To add a public key to channel this mode is set and the
1460 argument type is 0x00, and the argument is the public key.
1461 To remove a public key from channel public key list the
1462 argument type is 0x01, and the argument is the public key
1463 to be removed from the list. To remove all public keys at
1464 once this mode is unset. An implementation MAY limit the
1465 number of public keys that can be set for the channel.
1466 This mode MUST NOT be set if <channel pubkey> is not present
1467 when the mode is set for the first time. Implementation MAY
1468 add and remove multiple public keys at the same time by
1469 including multiple arguments to the <channel pubkey>
1470 Argument List Payload.
1473 To make the mode system work, client MUST keep the channel mode
1474 mask locally so that the mode setting and unsetting would work
1475 without problems. The client receives the initial channel mode
1476 mask when it joins to the channel. When the mode changes on
1477 channel the server MUST distribute the changed channel mode mask
1478 to all clients on the channel by sending the notify type
1479 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1480 to the server's primary router. If the <channel mode mask> was
1481 not provided this command returns the mode mask, founder key
1482 and channel public key list to the client.
1484 Reply messages to the command:
1487 Arguments: (1) <Status Payload> (2) <Channel ID>
1488 (3) <channel mode mask> (4) [<founder pubkey>]
1489 (5) [<channel pubkeys>]
1491 This command replies with the changed channel mode mask that
1492 client MUST keep locally. It may also return the channel
1493 founder's public key if it is set. It may also return list of
1494 channel public keys when the list was altered. The <channel
1495 pubkeys> is Argument List Payload and each argument includes
1501 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1502 SILC_STATUS_ERR_TOO_MANY_PARAMS
1503 SILC_STATUS_ERR_NOT_REGISTERED
1504 SILC_STATUS_ERR_NOT_ON_CHANNEL
1505 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1506 SILC_STATUS_ERR_BAD_CHANNEL_ID
1507 SILC_STATUS_ERR_NO_CHANNEL_ID
1508 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1509 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1510 SILC_STATUS_ERR_UNKNOWN_MODE
1511 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1512 SILC_STATUS_ERR_AUTH_FAILED
1515 18 SILC_COMMAND_CUMODE
1518 Arguments: (1) <Channel ID> (2) <mode mask>
1519 (3) <Client ID> (4) [<auth payload>]
1521 This command is used by client to change channel user modes on
1522 channel. Users on channel may have some special modes and this
1523 command is used by channel operators to set or change these modes.
1524 The <Channel ID> is the ID of the target channel. The <mode mask>
1525 is OR'ed mask of modes. The <Client ID> is the target client.
1526 The client changing channel user modes MUST be on the same channel
1527 as the target client and posses sufficient privileges to be able to
1530 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1531 type is distributed to the channel.
1533 The following channel modes are defined:
1535 0x00000000 SILC_CUMODE_NONE
1537 No specific mode. This is the normal situation for client.
1538 Also, this is the mode set when removing all modes from
1542 0x00000001 SILC_CUMODE_FOUNDER
1544 The client is channel founder of the channel. Usually this
1545 mode is set only by the server when the channel was created.
1546 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1547 been set, the client can claim channel founder privileges
1548 by providing the <auth payload> that the server will use
1549 to authenticate the client. The public key that server will
1550 use to verify the <auth payload> MUST be the same public key
1551 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1552 mode was set. The client MAY remove this mode at any time.
1555 0x00000002 SILC_CUMODE_OPERATOR
1557 Sets channel operator privileges on the channel for a
1558 client on the channel. Channel founder and channel operator
1559 MAY set/unset this mode. The client MAY remove this mode
1563 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1565 Marks that the client wishes not to receive any channel
1566 messages sent for the channel. Client MAY set and unset
1567 this mode to itself. Client MUST NOT set it to anyone else.
1568 When this mode is set server MUST NOT deliver channel
1569 messages to this client. Other packets such as channel
1570 key packets are still sent to the client.
1572 A separate service could provide additional filtering
1573 features for accepting channel messages from certain
1574 sender. However, this document does not specify such
1578 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1580 Marks that the client wishes not to receive any channel
1581 messages sent from normal users. Only messages sent by
1582 channel founder or channel operator is accepted. Client
1583 MAY set and unset this mode to itself. Client MUST NOT
1584 set it to anyone else. When this mode is set server MUST
1585 NOT deliver channel messages that are sent by normal users
1588 A separate service could provide additional filtering
1589 features for accepting channel messages from certain
1590 sender. However, this document does not specify such
1594 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1596 Marks that the client wishes not to receive any channel
1597 messages sent from robots. Messages sent by users with
1598 the SILC_UMODE_ROBOT user mode set are not delivered.
1599 Client MAY set and unset this mode to itself. Client MUST
1600 NOT set it to anyone else. When this mode is set server
1601 MUST NOT deliver channel messages that are sent by robots
1605 0x00000020 SILC_CUMODE_QUIET
1607 Marks that the client cannot talk on the channel. This
1608 mode can be set by channel operator or channel founder to
1609 some other user that is not operator or founder. The
1610 target client MUST NOT unset this mode. When this mode
1611 is set the server MUST drop messages sent by this client
1615 Reply messages to the command:
1618 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1619 (3) <Channel ID> (4) <Client ID>
1621 This command replies with the changed channel user mode mask that
1622 client MUST keep locally. The <Channel ID> is the specified
1623 channel. The <Client ID> is the target client.
1628 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1629 SILC_STATUS_ERR_TOO_MANY_PARAMS
1630 SILC_STATUS_ERR_NOT_REGISTERED
1631 SILC_STATUS_ERR_NOT_ON_CHANNEL
1632 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1633 SILC_STATUS_ERR_BAD_CHANNEL_ID
1634 SILC_STATUS_ERR_NO_CHANNEL_ID
1635 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1636 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1637 SILC_STATUS_ERR_UNKNOWN_MODE
1638 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1639 SILC_STATUS_ERR_AUTH_FAILED
1642 19 SILC_COMMAND_KICK
1645 Arguments: (1) <Channel ID> (2) <Client ID>
1648 This command is used by channel operators to remove a client from
1649 channel. The <channel> argument is the channel the client to be
1650 removed is on currently. Note that the "kicker" must be on the same
1651 channel. If <comment> is provided it will be sent to the removed
1654 After kicking the client the server MUST send the notify type
1655 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1656 The client is removed from the channel after sending this notify.
1657 The kicked client MUST be removed from the invite list of the
1658 channel if it is explicitly added in the list. The channel key
1659 MUST also be re-generated after kicking, unless the
1660 SILC_CMODE_PRIVKEY mode is set.
1662 Reply messages to the command:
1665 Arguments: (1) <Status Payload> (2) <Channel ID>
1668 This command returns the Channel ID and Client ID that was kicked
1674 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1675 SILC_STATUS_ERR_TOO_MANY_PARAMS
1676 SILC_STATUS_ERR_NOT_REGISTERED
1677 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1678 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1679 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1680 SILC_STATUS_ERR_NO_CLIENT_ID
1687 Arguments: (1) <Channel ID> (2) [<add | del>]
1690 This command is used to manage the ban list of the channel
1691 indicated by the <Channel ID>. A client that is banned from
1692 channel is no longer able to join the channel. The client which
1693 is executing this command MUST have at least channel operator
1694 privileges on the channel.
1696 The <add | del> is an argument of size of 1 byte where 0x00 means
1697 adding a client to ban list, and 0x01 means deleting a client
1698 from ban list. The <ban list>, if present, indicates the
1699 information to be added to or removed from the ban list. It
1700 may include a string for matching clients, public key of a
1701 client (Public Key Payload) or Client ID of a client. The
1702 <ban list> is an Argument List Payload.
1704 The following Argument Types has been defined for ban list
1707 0x01 - Argument is an ban string of following format:
1709 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
1711 The <hostname> may also be in format of IP/MASK to indicate
1714 0x02 - Argument is the public key of a client
1715 0x03 - Argument is the Client ID of a client
1717 If unknown type value is received or there is invalid amount of
1718 Argument Payloads present in the list, the command MUST be
1719 discarded. When argument that is to be deleted from the ban
1720 list does not exist in the list the argument is ignored.
1722 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1723 primary router after adding to or removing from the ban list.
1724 The wildcards MAY be used with this command. If this command
1725 is executed without the ban arguments the command merely replies
1726 with the current ban list.
1728 Reply messages to the command:
1731 Arguments: (1) <Status Payload> (2) <Channel ID>
1734 This command replies with the <Channel ID> of the channel and
1735 the current <ban list> of the channel if it exists.
1740 SILC_STATUS_ERR_NOT_REGISTERED
1741 SILC_STATUS_ERR_TOO_MANY_PARAMS
1742 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1743 SILC_STATUS_ERR_NO_CHANNEL_ID
1744 SILC_STATUS_ERR_NOT_ON_CHANNEL
1745 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1746 SILC_STATUS_ERR_RESOURCE_LIMIT
1751 21 SILC_COMMAND_DETACH
1756 This command is used to detach from the network. Client can
1757 send this command to its server to indicate that it will be
1758 detached. By detaching the client remains in the network but
1759 the actual network connection to the server is closed. The
1760 client may then later resume the old session back.
1762 When this command is received the server MUST check that the
1763 client is locally connected client, and set the user mode
1764 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1765 MUST be also sent to routers. The server then sends command
1766 reply to this command and closes the network connection.
1767 The server MUST NOT remove the client from its lists, or send
1768 any signoff notifications for this client. See the [SILC1]
1769 for detailed information about detaching.
1771 Reply messages to the command:
1774 Arguments: (1) <Status Payload>
1776 This command replies only with the status indication.
1781 SILC_STATUS_ERR_NOT_REGISTERED
1785 22 SILC_COMMAND_WATCH
1788 Arguments: (1) <Client ID> (2) [<add nickname>]
1789 (3) [<del nickname>]
1791 This command is used to set up a watch for <add nickname>
1792 nickname. When a user in the network appears with the
1793 nickname, or signoffs the network or user's mode is changed
1794 the client which set up the watch will be notified about
1795 this change. This can be used to watch for certain nicknames
1796 in the network and receive notifications when for example a
1797 friend appears in the network or leaves the network.
1799 The <del nickname> is a nickname that has been previously
1800 added to watch list and is now removed from it. Notifications
1801 for that nickname will not be delivered anymore.
1803 The <Client ID> is the Client ID of the sender of this command.
1805 The nickname set to watch MUST NOT include any wildcards.
1806 Note also that a nickname may match several users since
1807 nicknames are not unique. Implementations MAY set limits
1808 for how many nicknames client can watch.
1810 When normal server receives this command from client it
1811 MUST send it to its router. Router will process the command
1812 and actually keeps the watch list.
1814 Reply messages to the command:
1817 Arguments: (1) <Status Payload>
1819 This command replies only with the status indication.
1824 SILC_STATUS_ERR_NOT_REGISTERED
1825 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1826 SILC_STATUS_ERR_TOO_MANY_PARAMS
1827 SILC_STATUS_ERR_BAD_NICKNAME
1828 SILC_STATUS_ERR_WILDCARDS
1829 SILC_STATUS_ERR_RESOURCE_LIMIT
1830 SILC_STATUS_ERR_NO_SUCH_NICK
1831 SILC_STATUS_ERR_NICKNAME_IN_USE
1834 23 SILC_COMMAND_SILCOPER
1837 Arguments: (1) <username> (2) <authentication payload>
1839 This command is used by normal client to obtain router operator
1840 privileges (also known as SILC operator) on the router. Note
1841 that router operator has privileges that supersedes the server
1842 operator privileges.
1844 The <username> is the username set in the server configurations
1845 as operator. The <authentication payload> is the data that the
1846 client is authenticated against. It may be passphrase prompted
1847 for user on client's screen or it may be public key or certificate
1848 authentication data (data signed with private key). The public
1849 key that router will use to verify the signature found in the
1850 payload should be verified. It is recommended that the public
1851 key is saved locally in the router and router would not use
1852 any public keys received during the SKE.
1854 Difference between router operator and server operator is that
1855 router operator is able to handle cell level properties while
1856 server operator (even on router server) is able to handle only
1857 local properties, such as, local connections and normal server
1858 administration. The router operator is also able to use the
1859 SILC_COMMAND_KILL command.
1861 After changing the mode server MUST send the notify type
1862 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1864 Reply messages to the command:
1867 Arguments: (1) <Status Payload>
1869 This command replies only with Status Payload.
1874 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1875 SILC_STATUS_ERR_TOO_MANY_PARAMS
1876 SILC_STATUS_ERR_NOT_REGISTERED
1877 SILC_STATUS_ERR_AUTH_FAILED
1882 24 SILC_COMMAND_LEAVE
1885 Arguments: (1) <Channel ID>
1887 This command is used by client to leave a channel the client is
1890 When leaving channel the server MUST send the notify type
1891 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1892 The channel key MUST also be re-generated when leaving the channel
1893 and distribute it to all clients still currently on the channel.
1894 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1897 Reply messages to the command:
1900 Arguments: (1) <Status Payload> (2) <Channel ID>
1902 The <Channel ID> is the ID of left channel.
1907 SILC_STATUS_ERR_NOT_REGISTERED
1908 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1909 SILC_STATUS_ERR_TOO_MANY_PARAMS
1910 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1911 SILC_STATUS_ERR_BAD_CHANNEL_ID
1912 SILC_STATUS_ERR_NO_CHANNEL_ID
1915 25 SILC_COMMAND_USERS
1918 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1920 This command is used to list user names currently on the requested
1921 channel; either the argument <Channel ID> or the <channel name>.
1922 One of these arguments must be present. The server MUST resolve
1923 the joined clients and reply with a lists of users on the channel
1924 and with list of user modes on the channel.
1926 If the requested channel is a private or secret channel, this
1927 command MUST NOT send the list of users, except if the sender is
1928 on the channel, or the sender is a server. Otherwise, error is
1929 returned to the sender.
1931 Reply messages to the command:
1934 Arguments: (1) <Status Payload> (2) <Channel ID>
1935 (3) <list count> (4) <Client ID list>
1936 (5) <client mode list>
1938 This command replies with the Channel ID of the requested channel
1939 Client ID list of the users on the channel and list of their modes.
1940 The Client ID list has Client ID's of all users in the list. The
1941 <Client ID list> is formed by adding Client ID's one after another.
1942 The <client mode list> is formed by adding client's user modes on
1943 the channel one after another (4 bytes (32 bits) each). The <list
1944 count> of length of 4 bytes (32 bits), tells the number of entries
1945 in the lists. Both lists MUST have equal number of entries.
1950 SILC_STATUS_ERR_NOT_REGISTERED
1951 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1952 SILC_STATUS_ERR_TOO_MANY_PARAMS
1953 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1954 SILC_STATUS_ERR_BAD_CHANNEL_ID
1955 SILC_STATUS_ERR_NO_CHANNEL_ID
1956 SILC_STATUS_ERR_NOT_ON_CHANNEL
1959 26 SILC_COMMAND_GETKEY
1962 Arguments: (1) <ID Payload>
1964 This command is used to fetch the public key of the client or
1965 server indicated by the <ID Payload>. The public key is fetched
1966 from the server where to the client is connected.
1968 Reply messages to the command:
1971 Arguments: (1) <Status Payload> (2) <ID Payload>
1972 (3) [<Public Key Payload>]
1974 This command replies with the client's or server's ID and with
1975 the <Public Key Payload>.
1980 SILC_STATUS_ERR_NOT_REGISTERED
1981 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1982 SILC_STATUS_ERR_TOO_MANY_PARAMS
1983 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1984 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1987 27 SILC_COMMAND_SERVICE
1990 Arguments: (1) [<service name>] (2) [<auth payload>]
1993 This command is used to negotiate a service agreement with a
1994 remote server. If this command is given without arguments it
1995 MAY return the service list, if it is publicly available. The
1996 <service name> is a service specific identifier, and the
1997 <auth payload> MAY be used to authenticate the requester to the
1998 remote service. The authentication to a service may be based
1999 on previous agreement with the requester and the service
2000 provider. The command MAY also take additional service
2001 specific arguments. The <service name> is UTF-8 string.
2003 This document does not specify any services. How the services
2004 are configured and put available in a server is also out of
2005 scope of this document.
2007 This command MAY be used by client to start using some service
2008 in a server, but it also MAY be used by server to negotiate
2009 to start using a service in some other server or router.
2011 After the negotiation is done both of the parties need to know
2012 from the service identifier how the service can be used. The
2013 service can be considered to be a protocol which both of the
2014 parties need to support.
2016 Reply messages to the command:
2019 Arguments: (1) <Status Payload> (2) [<service list>]
2020 (3) [<service name>] (n) [...]
2023 This command MAY reply with the <service list> when command is
2024 given without arguments, and the list is a comma separated list
2025 of service identifiers. The <service name> is the service that
2026 the sender requested and this is provided when the server has
2027 accepted the sender to use the <service name>. The command
2028 reply MAY also have additional service specific arguments.
2033 SILC_STATUS_ERR_NOT_REGISTERED
2034 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2035 SILC_STATUS_ERR_TOO_MANY_PARAMS
2036 SILC_STATUS_ERR_NO_SUCH_SERVICE
2037 SILC_STATUS_ERR_AUTH_FAILED
2038 SILC_STATUS_ERR_PERM_DENIED
2044 Currently undefined commands.
2049 These commands are reserved for private use and will not be defined
2053 255 SILC_COMMAND_MAX
2055 Reserved command. This must not be sent.
2060 2.4 SILC Command Status Payload
2062 Command Status Payload is sent in command reply messages to indicate
2063 the status of the command. The payload is one of argument in the
2064 command thus this is the data area in Command Argument Payload described
2065 in [SILC2]. The payload is only 2 bytes in length. The following
2066 diagram represents the Command Status Payload (fields are always in
2073 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
2074 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2076 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2080 Figure 6: SILC Command Status Payload
2084 o Status (1 byte) - Indicates the status message type,
2085 error, start of list, entry of list or end of list.
2087 o Error (1 byte) - Indicates the error if the Status
2088 field is some list status, which means there are list
2092 The values in Status and Error fields are set according
2093 the following rules:
2096 o If there is single reply and error has not occurred
2097 then Status field includes value SILC_STATUS_OK, and
2098 the Error field MUST be ignored (and set to zero
2101 o If there is single error, then Status field includes
2102 one of the error values, and the Error field MUST be
2103 ignored (and set to zero value).
2105 o If there will be multiple successful command replies
2106 then Status field includes SILC_STATUS_LIST_START,
2107 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
2108 and Error field is set to SILC_STATUS_OK.
2110 o If there are multiple error replies then Status field
2111 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
2112 or SILC_STATUS_LIST_END value, and the Error field
2113 includes the error value.
2116 This way it is possible to send single successful or
2117 single error reply, but also multiple successful and
2118 multiple error replies. Note that it is possible to
2119 send both list of successful replies and list of error
2120 replies at the same time, however in this case the
2121 list of error replies MUST be sent after the successful
2122 replies. This way the recipient may ignore the multiple
2123 errors if it wishes to do so. Also note that in this
2124 case the successful and error replies belong to the
2127 All Status messages are described in the next section.
2133 Status messages are returned in SILC protocol in command reply
2134 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
2135 the command reply packet and status types are sent inside the
2136 Status Payload as one of command reply argument, as defined in
2137 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
2138 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
2139 types defined in this section are used in both cases.
2141 When returning status messages in the command reply message they
2142 indicate whether the command was executed without errors. If error
2143 occurred the status indicates which error occurred. If error
2144 occurred the arguments to the command replies are dictated by the
2145 error type. If arguments are to be sent, they are defined below
2146 with the error status types.
2148 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
2149 they always send some error status. Usually they are sent to
2150 indicate that error occurred while processing some SILC packet.
2151 Please see the [SILC1] and [SILC2] for more information sending
2152 status types in SILC_NOTIFY_TYPE_ERROR notify.
2154 The Status Types are only numeric values and the receiver must
2155 convert the numeric values into human readable messages if this
2156 is desired in the application.
2158 List of all defined status types:
2161 Generic status messages:
2165 Ok status. Everything went Ok. The status payload maybe
2166 safely ignored in this case.
2168 1 SILC_STATUS_LIST_START
2170 Start of the list. There will be several command replies and
2171 this reply is the start of the list.
2173 2 SILC_STATUS_LIST_ITEM
2175 Item in the list. This is one of the item in the list but not the
2178 3 SILC_STATUS_LIST_END
2180 End of the list. There were several command replies and this
2181 reply is the last of the list. There won't be other replies
2182 belonging to this list after this one.
2186 Currently undefined and has been reserved for the future.
2189 Error status message:
2193 10 SILC_STATUS_ERR_NO_SUCH_NICK
2195 "No such nickname". Requested nickname does not exist.
2196 The next argument MUST be the requested nickname.
2198 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2200 "No such channel". Requested channel name does not exist.
2201 The next argument MUST be the requested channel name.
2203 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2205 "No such server". Requested server name does not exist.
2206 The next argument MUST be the requested server name.
2208 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2210 "Incomplete registration information". Information remote
2211 sent was incomplete.
2213 14 SILC_STATUS_ERR_NO_RECIPIENT
2215 "No recipient given". Command required recipient which was
2218 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2220 "Unknown command". Command sent to server is unknown by the
2223 16 SILC_STATUS_ERR_WILDCARDS
2225 "Wildcards cannot be used". Wildcards were provided but they
2228 17 SILC_STATUS_ERR_NO_CLIENT_ID
2230 "No Client ID given". Client ID were expected as command
2231 parameter but were not found.
2233 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2235 "No Channel ID given". Channel ID were expected as command
2236 parameter but were not found.
2238 19 SILC_STATUS_ERR_NO_SERVER_ID
2240 "No Serve ID given". Server ID were expected as command
2241 parameter but were not found.
2243 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2245 "Bad Client ID". Client ID provided were erroneous.
2246 The next argument MUST be the provided ID.
2248 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2250 "Bad Channel ID". Channel ID provided were erroneous.
2251 The next argument MUST be the provided ID.
2253 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2255 "No such Client ID". Client ID provided does not exist.
2256 The unknown Client ID MUST be provided as next argument
2259 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2261 "No such Channel ID". Channel ID provided does not exist.
2262 The unknown Channel ID MUST be provided as next argument
2265 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2267 "Nickname already exists". Nickname created could not be
2268 registered because number of same nicknames were already set to
2269 maximum. This is not expected to happen in real life but is
2272 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2274 "You are not on that channel". The command were specified for
2275 channel user is not currently on. The next argument MUST be the
2278 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2280 "They are not on channel". The requested target client is not
2281 on requested channel. The next two arguments, in this order,
2282 MUST be the requested Client ID and Channel ID.
2284 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2286 "User already on channel". User were invited on channel they
2287 already are on. The next two arguments, in this order, MUST be
2288 the requested Client ID and Channel ID.
2290 28 SILC_STATUS_ERR_NOT_REGISTERED
2292 "You have not registered". User executed command that requires
2293 the client to be registered on the server before it may be
2296 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2298 "Not enough parameters". Command requires more parameters
2301 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2303 "Too many parameters". Too many parameters were provided
2306 31 SILC_STATUS_ERR_PERM_DENIED
2308 "Permission denied". Generic permission denied error status
2309 to indicate disallowed access.
2311 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2313 "You are banned from this server". The client tried to register
2314 on server that has explicitly denied this host to connect.
2316 33 SILC_STATUS_ERR_BAD_PASSWORD
2318 "Cannot join channel. Incorrect password". Password provided for
2319 channel were not accepted. The next argument MUST be the
2322 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2324 "Cannot join channel. Channel is full". The channel is full
2325 and client cannot be joined to it. The next argument MUST be
2328 35 SILC_STATUS_ERR_NOT_INVITED
2330 "Cannot join channel. You have not been invited". The channel
2331 is invite only channel and client has not been invited. The next
2332 argument MUST be the Channel ID.
2334 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2336 "Cannot join channel. You have been banned". The client has
2337 been banned from the channel. The next argument MUST be the
2340 37 SILC_STATUS_ERR_UNKNOWN_MODE
2342 "Unknown mode". Mode provided by the client were unknown to
2345 38 SILC_STATUS_ERR_NOT_YOU
2347 "Cannot change mode for other users". User tried to change
2348 someone else's mode.
2350 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2352 "Permission denied. You are not channel operator". Command may
2353 be executed only by channel operator. The next argument MUST be
2356 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2358 "Permission denied. You are not channel founder". Command may
2359 be executed only by channel operator. The next argument MUST be
2362 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2364 "Permission denied. You are not server operator". Command may
2365 be executed only by server operator.
2367 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2369 "Permission denied. You are not SILC operator". Command may be
2370 executed only by router (SILC) operator.
2372 43 SILC_STATUS_ERR_BAD_NICKNAME
2374 "Bad nickname". Nickname requested contained illegal characters
2377 44 SILC_STATUS_ERR_BAD_CHANNEL
2379 "Bad channel name". Channel requested contained illegal characters
2382 45 SILC_STATUS_ERR_AUTH_FAILED
2384 "Authentication failed". The authentication data sent as
2385 argument were wrong and thus authentication failed.
2387 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2389 "The algorithm was not supported." The server does not support the
2390 requested algorithm. The next argument MUST be the algorithm name
2393 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2395 "No such Server ID". Server ID provided does not exist.
2396 The unknown Server ID MUST be provided as next argument
2399 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2401 "No more resources available". This can mean that server cannot
2402 or will not accept something due to resource limitations.
2404 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2406 "Service does not exist". Requested service identifier is
2407 unknown. The next argument MUST be the service identifier.
2409 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2411 "You have not been authenticated". Remote connection is not
2412 authenticated even though it is supposed to be.
2414 51 SILC_STATUS_ERR_BAD_SERVER_ID
2416 "Server ID is not valid". Provided server ID is not valid.
2417 The next argument MUST be the provided ID.
2419 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2421 "Key exchange failed". Key Exchange protocol failed.
2423 53 SILC_STATUS_ERR_BAD_VERSION
2425 "Bad version". Protocol or software version mismatch.
2427 54 SILC_STATUS_ERR_TIMEDOUT
2429 "Operation timed out". Operation or service request timed
2430 out, and thus was not processed.
2432 55 SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY
2434 "Unsupported public key type". The public key or certificate
2435 type is not supported in this implementation.
2437 56 SILC_STATUS_ERR_OPERATION_ALLOWED
2439 "Operation is not allowed". A operation, for example a command,
2440 is not allowed or it's execution is not allowed.
2447 4 Security Considerations
2449 Security is central to the design of this protocol, and these security
2450 considerations permeate the specification. Common security considerations
2451 such as keeping private keys truly private and using adequate lengths for
2452 symmetric and asymmetric keys must be followed in order to maintain the
2453 security of this protocol.
2459 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2460 Protocol Specification", Internet Draft, May 2002.
2462 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2465 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2466 Protocols", Internet Draft, May 2002.
2468 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2471 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2474 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2477 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2480 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2483 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2486 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2489 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2492 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2493 Infrastructure, Certificate and CRL Profile", RFC 2459,
2496 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2497 John Wiley & Sons, New York, NY, 1996.
2499 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2502 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2503 RFC 2412, November 1998.
2505 [ISAKMP] Maughan D., et al, "Internet Security Association and
2506 Key Management Protocol (ISAKMP)", RFC 2408, November
2509 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2510 (IKE)", RFC 2409, November 1998.
2512 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2513 Authentication", RFC 2104, February 1997.
2515 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2516 Specifications, Version 2.0", RFC 2437, October 1998.
2518 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2519 Requirement Levels", BCP 14, RFC 2119, March 1997.
2521 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2522 10646", RFC 2279, January 1998.
2524 [ATTRS] Riikonen, P., "User Online Presence and Information
2525 Attributes", Internet Draft, May 2002.
2533 Snellmaninkatu 34 A 15
2537 EMail: priikone@iki.fi
2543 This appendix defines the usage of the <Requested Attributes> argument in
2544 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2545 and may be used to request additional information about the user. Since
2546 the information that may be requested using the attributes is something
2547 that server cannot deliver to the sender, it is possible to send the WHOIS
2548 command directly to the destination client whom will then provide the
2549 requested attributes. This requires the servers to relay the WHOIS
2550 command to the client, and it requires capability for handling the WHOIS
2551 command in the client end.
2553 The <Requested Attributes> MAY include several attributes that are
2554 requested. The format and encoding of the <Requested Attributes> is as
2555 defined in [ATTRS]. When <Requested Attributes> argument is set the
2556 server MAY process the attributes to see whether it can narrow down
2557 the WHOIS search, for example when searching with a nickname. The
2558 normal servers MUST process the WHOIS command as normal WHOIS command,
2559 that is to send the command directly to the router. The router MAY
2560 process the attributes, but it MUST send the command to the server
2561 that owns the requested client.
2563 The server that owns the client and receives the command MUST check
2564 whether the client is detached from the network. If it is detached,
2565 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2566 process the attributes and provide as many of the requested attributes
2567 as possible and then send reply back to the sender. If the client is
2568 active in the network it MUST send the command to the client for
2571 The client receiving WHOIS command SHOULD check whether the
2572 <Requested Attributes> argument is set. If it is not set then the
2573 WHOIS command SHOULD be discarded. The client processes the requested
2574 attributes and SHOULD reply to each of the requested attribute with
2575 either valid value, or with an indication that the requested attribute
2576 is not known or supported. This is to be done as defined in [ATTRS].
2577 The client always MUST send a reply to the command when some attributes
2578 were requested. The client MAY also add additional attributes to the
2579 reply even if they were not requested. The client MAY also digitally
2580 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2581 in [ATTRS]. Then the client sends the reply back to the sender of
2582 the command. The command reply that client assembles does not need
2583 to include any other argument but the <Status Payload> (1), and the
2584 <Attributes> (11). The server receiving reply from client MUST allow
2585 this sort of command reply for WHOIS command.
2587 The information received from the client MAY be cached in the
2588 server's end. The caching may be desired for example if the client
2589 can be detached from the network. This way the server is then able
2590 to provide at least partial information for a requester. The
2591 server MAY also process the command reply and verify whether the
2592 attributes provided in the reply are actually valid. If it can do
2593 this, and verify that they indeed are valid values it MAY append
2594 a digital signature at the end of the attributes with the
2595 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2596 server then MUST provide valid WHOIS command reply to the sender
2597 of the command. Other servers and routers that receive the command
2598 reply en route to the original sender MAY also cache the information.
2600 The client which receives the command reply to the WHOIS command
2601 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2602 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
2606 Full Copyright Statement
2608 Copyright (C) The Internet Society (2003). All Rights Reserved.
2610 This document and translations of it may be copied and furnished to
2611 others, and derivative works that comment on or otherwise explain it
2612 or assist in its implementation may be prepared, copied, published
2613 and distributed, in whole or in part, without restriction of any
2614 kind, provided that the above copyright notice and this paragraph are
2615 included on all such copies and derivative works. However, this
2616 document itself may not be modified in any way, such as by removing
2617 the copyright notice or references to the Internet Society or other
2618 Internet organizations, except as needed for the purpose of
2619 developing Internet standards in which case the procedures for
2620 copyrights defined in the Internet Standards process must be
2621 followed, or as required to translate it into languages other than
2624 The limited permissions granted above are perpetual and will not be
2625 revoked by the Internet Society or its successors or assigns.
2627 This document and the information contained herein is provided on an
2628 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
2629 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
2630 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
2631 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
2632 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
projects / silc.git / blob