8 .ds RF FORMFEED[Page %]
11 .ds RH 15 January 2007
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-07.txt 15 January 2007
26 <draft-riikonen-silc-commands-07.txt>
31 By submitting this Internet-Draft, each author represents that any
32 applicable patent or other IPR claims of which he or she is aware
33 have been or will be disclosed, and any of which he or she becomes
34 aware will be disclosed, in accordance with Section 6 of BCP 79.
36 Internet-Drafts are working documents of the Internet Engineering
37 Task Force (IETF), its areas, and its working groups. Note that
38 other groups may also distribute working documents as Internet-
39 Drafts. Internet-Drafts are draft documents valid for a maximum of
40 six months and may be updated, replaced, or obsoleted by other
41 documents at any time. It is inappropriate to use Internet-Drafts as
42 reference material or to cite them other than as "work in progress".
44 The list of current Internet-Drafts can be accessed at
45 http://www.ietf.org/1id-abstracts.html
46 The list of Internet-Draft Shadow Directories can be accessed at
47 http://www.ietf.org/shadow.html.
53 This memo describes the commands used in the Secure Internet Live
54 Conferencing (SILC) protocol, specified in the Secure Internet Live
55 Conferencing, Protocol Specification [SILC1]. The SILC Commands are
56 very important part of the SILC protocol. Usually the commands are used
57 by SILC clients to manage the SILC session, but also SILC servers may
58 use the commands. This memo specifies detailed command messages and
59 command reply messages.
72 1 Introduction .................................................. 2
73 1.1 Requirements Terminology .................................. 2
74 2 SILC Commands ................................................. 2
75 2.1 SILC Commands Syntax ...................................... 4
76 2.2 SILC Command Argument Idioms .............................. 4
77 2.3 SILC Commands List ........................................ 5
78 2.4 SILC Command Status Payload ............................... 43
79 3 SILC Status Types ............................................. 44
80 4 Security Considerations ....................................... 51
81 5 References .................................................... 51
82 6 Author's Address .............................................. 52
83 Appendix A ...................................................... 52
84 Full Copyright Statement ........................................ 54
90 This document describes the commands used in the Secure Internet Live
91 Conferencing (SILC) protocol, specified in the Secure Internet Live
92 Conferencing, Protocol Specification [SILC1]. This document specifies
93 detailed command messages and command reply messages.
95 Commands are very important part on SILC network especially for client
96 which uses commands to operate on the SILC network. Commands are used
97 to set nickname, join to channel, change modes and many other things.
99 See the [SILC1] for the requirements and the restrictions for the usage
100 of the SILC commands. The [SILC2] defines the command packet type and
101 the Command Payload which is actually used to deliver the commands and
102 command reply messages.
106 1.1 Requirements Terminology
108 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
109 MAY, and OPTIONAL, when they appear in this document, are to be
110 interpreted as described in [RFC2119].
117 2.1 SILC Commands Syntax
119 This section briefly describes the syntax of the command notions
120 in this document. Every field in command is separated from each
121 other by whitespaces (` ') indicating that each field is independent
122 argument and each argument MUST have own Command Argument Payload.
123 The number of maximum arguments are defined with each command
124 separately. The Command Argument Payload is described in [SILC2].
126 Every command defines specific number for each argument. Currently,
127 they are defined in ascending order; first argument has number one
128 (1), second has number two (2) and so on. This number is set into the
129 Argument Type field in the Command Argument Payload. This makes it
130 possible to send the arguments in free order as the number MUST be
131 used to identify the type of the argument. This makes is it also
132 possible to have multiple optional arguments in commands and in
133 command replies. The number of argument is marked in parentheses
134 before the actual argument.
139 Example: Arguments: (1) <nickname> (2) <username@host>
143 Every command replies with Status Payload. This payload tells the
144 sender of the command whether the command was completed successfully or
145 whether there was an error. If error occurred the payload includes the
146 error type. In the next section the Status Payload is not described
147 as it is common to all commands and has been described here. Commands
148 MAY reply with other arguments as well. These arguments are command
149 specific and are described in the next section.
158 Arguments: (1) <nickname>[@<server>] (2) <message>
161 The command has maximum of 3 arguments. However, only first
162 and second arguments are mandatory.
164 First argument <nickname> is mandatory but may have optional
165 <nickname@server> format as well. Second argument is mandatory
166 <message> argument. Third argument is optional <count> argument.
168 The numbers in parentheses are the argument specific numbers
169 that specify the type of the argument in Command Argument Payload.
170 The receiver always knows that, say, argument number two (2) is
171 <message> argument, regardless of the ordering of the arguments in
174 Reply messages to the command:
177 Arguments: (1) <Status Payload> (2) [<channel list>]
178 (3) <idle time> (4) [<away message>]
180 This command may reply with maximum of 4 arguments. However,
181 only the first and third arguments are mandatory. The numbers
182 in the parentheses have the same meaning as in the upper
183 command sending specification.
185 Every command reply with <Status Payload>, it is mandatory
186 argument for all command replies and for this reason it is not
187 described in the command reply descriptions.
194 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195 SILC_STATUS_ERR_NO_SUCH_NICK
197 Every command reply also defines set of status message that it
198 may return inside the <Status Payload>. All status messages
199 are defined in the section 2.3 SILC Command Status Payload
200 The status messages defined with the command are recommendations.
201 It is possible to return other status messages not listed with
202 the command reply definition.
207 2.2 SILC Command Argument Idioms
209 All commands that has an ID as argument (for example <Client ID>) are
210 actually ID Payloads, defined in [SILC2] that includes the type of the
211 ID, length of the ID and the actual ID data. This way variable length
212 ID's can be sent as arguments.
214 All passphrases that may be sent in commands as arguments MUST be
215 UTF-8 [RFC3629] encoded. All strings sent as arguments in command and
216 command reply are also UTF-8 encoded, unless otherwise defined. See
217 the [SILC1] for general UTF-8 definition in SILC protocol.
219 All public keys and certificates that are sent as arguments are actually
220 Public Key Payloads [SILC2]. This way it is possible to send different
221 kind of public keys and certificate types as arguments.
227 2.3 SILC Commands List
229 This section lists all SILC commands, however, it is expected that a
230 implementation and especially client implementation has many more
231 commands that has only local affect. These commands are official
232 SILC commands that has both client and server sides and cannot be
233 characterized as local commands.
235 List of all defined commands in SILC follows.
240 None. This is reserved command and MUST NOT be sent.
246 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
247 (3) [<Requested Attributes>] (4) [<Client ID>]
250 Whois command is used to query various information about specific
251 user. The user may be requested by their nickname and server name.
252 The query may find multiple matching users as there are no unique
253 nicknames in the SILC. The <count> option may be given to narrow
254 down the number of accepted results. If this is not defined there
255 are no limit of accepted results. The query may also be narrowed
256 down by defining the server name of the nickname. The <count> is
257 32 bit MSB first order integer.
259 It is also possible to search the user by Client ID. If the
260 <Client ID> is provided server MUST use it as the search value
261 instead of the <nickname>. It is also possible to define multiple
262 Client ID's to search multiple users sending only one WHOIS
263 command. In this case the Client ID's are appended as normal
266 The <Requested Attributes> is defined in [ATTRS] and can be used
267 to request various information about the client. See Appendix A
268 for definition of using these attributes in SILC. If neither the
269 <nickname> or <Client ID> arguments are present but the attributes
270 are, the server MUST use the attributes to do the searching. If
271 none of the arguments, <nickname>, <Client ID> and <Requested
272 Attributes> are present, error MUST be retuned. Server MAY
273 use the <Requested Attributes> to narrow down the search if they
276 To prevent miss-use of this command wildcards in the nickname
277 or in the server name are not permitted. It is not allowed
278 to request all users on some server. The WHOIS requests MUST
279 be based on explicit nickname request.
281 The WHOIS request MUST be always sent to the router by normal
282 server so that all users are searched. However, the server still
283 MUST search its locally connected clients. The router MUST send
284 this command to the server which owns the requested client, if
285 the router is unable to provide all mandatory information about
286 the client. That server MUST reply to the command. Server MUST
287 NOT send whois replies to the client until it has received the
288 reply from its router.
290 Reply messages to the command:
293 Arguments: (1) <Status Payload> (2) <Client ID>
294 (3) <nickname>[@<server>] (4) <username@host>
295 (5) <real name> (6) [<Channel Payload
297 (7) [<user mode>] (8) [<idle time>]
298 (9) [<fingerprint>] (10) <channel user
303 This command may reply with several command reply messages to
304 form a list of results. In this case the status payload will
305 include STATUS_LIST_START status in the first reply and
306 STATUS_LIST_END in the last reply to indicate the end of the
307 list. If there are only one reply the status is set to normal
308 STATUS_OK. If multiple Client IDs was requested then each found
309 and unfound client MUST cause successful or error reply,
312 The command replies include the Client ID of the nickname,
313 nickname and server name, user name and host name and user's real
314 name. Client should process these replies only after the last
315 reply has been received with the STATUS_LIST_END status. If the
316 <count> option were defined in the query there will be only
317 <count> many replies from the server.
319 The server returns the list of channels if the client has
320 joined channels. In this case the list is list of Channel
321 Payloads. The Mode Mask in the Channel Payload is the channel's
322 mode. The list is encoded by adding the Channel Payloads one
323 after the other. Private and secret channels MUST NOT be sent,
324 except if the sender of this command is on those channels, or
325 the sender is server. The <channel user mode list> MUST also
326 be sent if client is joined channels. This list includes 32 bit
327 MSB first order values one after the other and each indicate
328 the user's mode on a channel. The order of these values MUST
329 be same as the channel order in the <Channel Payload list>.
331 The server also returns client's user mode, idle time, and the
332 fingerprint of the client's public key. The <fingerprint> is the
333 binary hash digest of the public key. The fingerprint MUST NOT
334 be sent if the server has not verified the proof of possession of
335 the corresponding private key. Server can do this during the
336 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
338 The <Attributes> is the reply to the <Requested Attributes>.
339 See the Appendix A for more information.
344 SILC_STATUS_LIST_START
346 SILC_STATUS_ERR_NO_SUCH_NICK
347 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
348 SILC_STATUS_ERR_WILDCARDS
349 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
350 SILC_STATUS_ERR_TOO_MANY_PARAMS
353 2 SILC_COMMAND_WHOWAS
356 Arguments: (1) <nickname>[@<server>] (2) [<count>]
358 Whowas. This command is used to query history information about
359 specific user. The user may be requested by their nickname and
360 server name. The query may find multiple matching users as there
361 are no unique nicknames in the SILC. The <count> option may be
362 given to narrow down the number of accepted results. If this
363 is not defined there are no limit of accepted results. The query
364 may also be narrowed down by defining the server name of the
365 nickname. The <count> is 32 bit MSB first order integer.
367 To prevent miss-use of this command wildcards in the nickname
368 or in the server name are not permitted. The WHOWAS requests MUST
369 be based on specific nickname request.
371 The WHOWAS request MUST be always sent to the router by server
372 so that all users are searched. However, the server still must
373 search its locally connected clients.
375 Reply messages to the command:
378 Arguments: (1) <Status Payload> (2) <Client ID>
379 (3) <nickname>[@<server>] (4) <username@host>
382 This command may reply with several command reply messages to form
383 a list of results. In this case the status payload will include
384 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
385 the last reply to indicate the end of the list. If there are only
386 one reply the status is set to normal STATUS_OK.
388 The command replies with nickname and user name and host name.
389 Every server MUST keep history for some period of time of its
390 locally connected clients.
395 SILC_STATUS_LIST_START
397 SILC_STATUS_ERR_NO_SUCH_NICK
398 SILC_STATUS_ERR_WILDCARDS
399 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
400 SILC_STATUS_ERR_TOO_MANY_PARAMS
403 3 SILC_COMMAND_IDENTIFY
406 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
407 (3) [<channel name>] (4) [<count>]
408 (5) [<ID Payload>] (n) [...]
410 Identify command is used to query information about an entity by
411 the entity's name or ID. This command can be used to query
412 information about clients, servers and channels.
414 The query may find multiple matching entities. The <count> option
415 may be given to narrow down the number of accepted results. If
416 this is not defined there are no limit of accepted results. The
417 <count> is 32 bit MSB first order integer.
419 It is also possible to search the entity by its ID. If the
420 <ID Payload> is provided server must use it as the search value
421 instead of the entity's name. One of the arguments MUST be given.
422 It is also possible to define multiple ID Payloads to search
423 multiple entities sending only one IDENTIFY command. In this case
424 the ID Payloads are appended as normal arguments. The type of the
425 entity is defined by the type of the ID Payload.
427 To prevent miss-use of this command wildcards in the names are
428 not permitted. It is not allowed to request for example all users
431 Implementations may not want to give interface access to this
432 command as it is hardly a command that would be used by an end
433 user. However, it must be implemented as it is most likely used
434 with private message sending.
436 The IDENTIFY command MUST be always sent to the router by server
437 so that all users are searched. However, server MUST still search
438 its locally connected clients.
440 Reply messages to the command:
443 Arguments: (1) <Status Payload> (2) <ID Payload>
444 (3) [<entity's name>] (4) [<info>]
446 This command may reply with several command reply messages to form
447 a list of results. In this case the status payload will include
448 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
449 the last reply to indicate the end of the list. If there are only
450 one reply the status is set to normal STATUS_OK. If multiple Client
451 IDs was requested then each found and unfound client must cause
452 successful or error reply, respectively.
454 When querying clients the <entity's name> must include the client's
455 nickname in the following format: nickname[@server]. The
456 <info> must include the client's username and host in the following
457 format: username@host.
459 When querying servers the <entity's name> must include the server's
460 full name. The <info> may be omitted.
462 When querying channels the <entity's name> must include the
463 channel's name. The <info> may be omitted.
465 If the <count> option were defined in the query there will be only
466 <count> many replies from the server.
471 SILC_STATUS_LIST_START
473 SILC_STATUS_ERR_NO_SUCH_NICK
474 SILC_STATUS_ERR_NO_SUCH_SERVER
475 SILC_STATUS_ERR_NO_SUCH_CHANNEL
476 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
477 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
478 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
479 SILC_STATUS_ERR_WILDCARDS
480 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
481 SILC_STATUS_ERR_TOO_MANY_PARAMS
487 Arguments: (1) <nickname>
489 Set/change nickname. This command is used to set nickname for
490 user. See [SILC1] for definition of correctly formatted
493 When nickname is changed new Client ID is generated. Server MUST
494 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
495 channels (if any) the client is joined on. Then it MUST send
496 SILC_NOTIFY_TYPE_NICK_CHANGE notify to its primary route to
497 notify about nickname and Client ID change.
499 Reply messages to the command:
502 Arguments: (1) <Status Payload> (2) <New ID Payload>
505 This command replies always with <New ID Payload> that is
506 generated by the server every time user changes their nickname.
507 Client receiving this payload MUST start using the received
508 Client ID as its current valid Client ID. The New ID Payload
509 is described in [SILC2]. The <nickname> is the user's new
515 SILC_STATUS_ERR_WILDCARDS
516 SILC_STATUS_ERR_NICKNAME_IN_USE
517 SILC_STATUS_ERR_BAD_NICKNAME
518 SILC_STATUS_ERR_NOT_REGISTERED
519 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
520 SILC_STATUS_ERR_TOO_MANY_PARAMS
526 Arguments: (1) [<Channel ID>]
528 The list command is used to list channels and their topics on the
529 current server. If the <Channel ID> parameter is used, only the
530 status of that channel is displayed. Secret channels are not
531 listed at all. Private channels are listed with status indicating
532 that the channel is private. Router MAY reply with all channels
535 Reply messages to the command:
538 Arguments: (1) <Status Payload> (2) <Channel ID>
539 (3) <channel> (4) [<topic>]
542 This command may reply with several command reply messages to form
543 a list of results. In this case the status payload will include
544 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
545 the last reply to indicate the end of the list. If there are only
546 one reply the status is set to normal STATUS_OK.
548 This command replies with Channel ID, name and the topic of the
549 channel. If the channel is private channel the <topic> SHOULD
550 include the "*private*" string.
555 SILC_STATUS_LIST_START
557 SILC_STATUS_ERR_WILDCARDS
558 SILC_STATUS_ERR_NOT_REGISTERED
559 SILC_STATUS_ERR_TOO_MANY_PARAMS
560 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
561 SILC_STATUS_ERR_NO_CHANNEL_ID
562 SILC_STATUS_ERR_NO_SUCH_SERVER
568 Arguments: (1) <Channel ID> (2) [<topic>]
570 This command is used to change or view the topic of a channel.
571 The topic for channel <Channel ID> is returned if there is no
572 <topic> given. If the <topic> parameter is present, the topic
573 for that channel will be changed, if the channel modes permit
576 After setting the topic the server MUST send the notify type
577 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
578 the channel which topic was changed.
580 Reply messages to the command:
583 Arguments: (1) <Status Payload> (2) <Channel ID>
586 The command may reply with the topic of the channel if it is
592 SILC_STATUS_ERR_NOT_ON_CHANNEL
593 SILC_STATUS_ERR_WILDCARDS
594 SILC_STATUS_ERR_NOT_REGISTERED
595 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
596 SILC_STATUS_ERR_NO_SUCH_CHANNEL
597 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
598 SILC_STATUS_ERR_NO_CHANNEL_ID
599 SILC_STATUS_ERR_BAD_CHANNEL_ID
600 SILC_STATUS_ERR_TOO_MANY_PARAMS
601 SILC_STATUS_ERR_NO_CHANNEL_PRIV
604 7 SILC_COMMAND_INVITE
607 Arguments: (1) <Channel ID> (2) [<Client ID>]
608 (3) [<add | del>] (4) [<invite list>]
610 This command can be used to invite other clients to join to a
611 channel, and to manage the channel's invite list. The <Client
612 ID> argument is the target client's ID that is being invited.
613 The <Channel ID> is the Channel ID of the requested channel.
614 The sender of this command MUST be on the channel. The server
615 MUST also send the notify type SILC_NOTIFY_TYPE_INVITE to its
616 primary router and then to the client indicated by the <Client
619 The <add | del> is an argument of size of 1 byte where 0x00 means
620 adding a client to invite list, and 0x01 means deleting a client
621 from invite list. The <invite list>, if present, indicates
622 the information to be added to or removed from the invite list.
623 It may include a string for matching clients, public key of a
624 client (Public Key Payload) or Client ID of a client. The
625 <invite list> is an Argument List Payload.
627 The following Argument Types has been defined for invite list
630 0x01 - Argument is an invite string of following format:
632 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
634 The <hostname> may also be in format of IP/MASK to indicate
635 a network, for example 10.2.1.0/255.255.0.0.
637 0x02 - Argument is the public key of a client
638 0x03 - Argument is the Client ID of a client
640 If unknown type value is received or there is invalid amount of
641 Argument Payloads present in the list, the command MUST be
642 discarded. When argument that is to be deleted from the invite
643 list does not exist in the list the argument is ignored.
645 When adding to or removing from the invite list the server MUST
646 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router.
647 When the SILC_CHANNEL_MODE_INVITE is set the client which executes
648 this command MUST have at least channel operator privileges to be
649 able to add to or remove from the invite list. If this channel
650 mode is not set the list manipulation is allowed for all clients.
651 Wildcards MAY be used with this command. When this command is
652 used to invite explicit client with <Client ID> the ID MUST be
653 added to the invite list by the server.
655 When this command is given with only <Channel ID> argument then
656 the command merely returns the invite list of the channel. This
657 command MUST fail if the requested channel does not exist, the
658 requested <Client ID> is already on the channel or if the channel
659 is invite only channel and the caller of this command does not
660 have at least channel operator privileges on the channel.
662 Reply messages to the command:
665 Arguments: (1) <Status Payload> (2) <Channel ID>
668 This command replies with the invite list of the channel if it
674 SILC_STATUS_ERR_NOT_REGISTERED
675 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
676 SILC_STATUS_ERR_TOO_MANY_PARAMS
677 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
678 SILC_STATUS_ERR_NO_CLIENT_ID
679 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
680 SILC_STATUS_ERR_NO_CHANNEL_ID
681 SILC_STATUS_ERR_NOT_ON_CHANNEL
682 SILC_STATUS_ERR_USER_ON_CHANNEL
683 SILC_STATUS_ERR_NO_CHANNEL_PRIV
684 SILC_STATUS_ERR_RESOURCE_LIMIT
690 Arguments: (1) [<quit message>]
692 This command is used by client to end SILC session. The server
693 must close the connection to a client which sends this command.
694 if <quit message> is given it will be sent to other clients on
695 channel if the client is on channel when quitting.
697 Reply messages to the command:
699 This command does not reply anything.
705 Arguments: (1) <Client ID> (2) [<comment>]
708 This command can be used by SILC operators to remove a client from
709 SILC network. It also can be used by a normal client to remove
710 its own client from network by providing correct authentication
713 Router operator killing a client:
715 The removing has temporary effects and client may reconnect to
716 SILC network. The <Client ID> is the client to be removed from SILC.
717 The <comment> argument may be provided to give to the removed client
718 some information why it was removed from the network. The killer
719 MUST have SILC operator privileges.
721 When killing a client the router MUST first send notify type
722 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
723 The packet MUST NOT be sent to the killed client on the channels.
724 Then, the router MUST send the same notify type to its primary
725 router. Finally, the router MUST send the same notify type
726 destined directly to the client which was killed. The killed
727 client MUST also be removed from the invite lists of joined
728 channels if it is explicitly added in the invite lists.
730 Normal client killing by authentication:
732 When normal client executes this command the <Client ID> is the
733 destination client to be removed from the network. The client
734 MUST provide the <auth payload> which includes a digital signature
735 that MUST be verified with the public key of the client indicated
736 by <Client ID>. The <Client ID> MUST be local client to the server.
737 If the signature verification is successful the server sends
738 SILC_NOTIFY_TYPE_SIGNOFF to network and to the destination client.
739 The SILC_NOTIFY_TYPE_KILLED MUST NOT be used in this case. If the
740 verification fails the destination client remains in network.
741 The hash function used in <auth payload> computing is selected
742 by user or SHA1 otherwise.
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> is selected by user or SHA1 otherwise.
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. The digest
970 is the SILC Public Key fingerprint. Rest of thePublic Data field
971 are set as defined in [SILC1]. This way server can determine from
972 the digest whether that public key exist on the channel and then
973 use that key in verification. The hash function used with
974 <channel auth> is selected by user or SHA1 otherwise.
976 The server MUST check whether the user is allowed to join to
977 the requested channel. Various modes set to the channel affect
978 the ability of the user to join the channel. These conditions
981 o The user MUST be invited to the channel if the channel
982 is invite-only channel.
984 o The Client ID/nickname/username/host name/public key
985 MUST NOT match any active bans.
987 o The correct passphrase MUST be provided if passphrase
988 is set to the channel, and/or digital signature verification
989 with channel public key MUST be successful if public keys
990 has been set to the channel.
992 o The user count limit, if set, MUST NOT be reached.
994 If the client provided correct <founder auth> payload it can
995 override these conditions, except the condition for the passphrase.
996 The correct passphrase MUST be provided even if <founder auth>
999 Reply messages to the command:
1002 Arguments: (1) <Status Payload> (2) <channel>
1003 (3) <Channel ID> (4) <Client ID>
1004 (5) <channel mode mask> (6) <created>
1005 (7) [<Channel Key Payload>] (8) [<ban list>]
1006 (9) [<invite list>] (10) [<topic>]
1007 (11) [<hmac>] (12) <list count>
1008 (13) <Client ID list> (14) <client mode list>
1009 (15) [<founder pubkey>] (16) [<channel pubkeys>]
1012 This command replies with the channel name requested by the
1013 client, channel ID of the channel and topic of the channel
1014 if it exists. The <Client ID> is the Client ID which was joined
1015 to the channel. It also replies with the channel mode mask
1016 which tells all the modes set on the channel. If the channel
1017 is created the mode mask is zero (0) and <created> is 0x01.
1018 If ban mask and/or invite list is set they are sent as well.
1019 The <user limit> is the user limit on the channel, if one is set.
1021 The <list count>, <Client ID list> and <client mode list> are
1022 the clients currently on the channel and their modes on the
1023 channel. The <Client ID list> is formed by adding the ID Payloads
1024 one after the other. The <client mode list> is formed by adding
1025 32 bit MSB first order values one after the other. The <founder
1026 pubkey> is the public key (or certificate) of the channel founder.
1027 The <channel pubkeys> is Argument List Payload containing the
1028 channel public keys that has been set for the channel.
1030 Client receives the channel key in the reply message as well
1031 inside <Channel Key Payload>.
1036 SILC_STATUS_ERR_WILDCARDS
1037 SILC_STATUS_ERR_NOT_REGISTERED
1038 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1039 SILC_STATUS_ERR_TOO_MANY_PARAMS
1040 SILC_STATUS_ERR_BAD_PASSWORD
1041 SILC_STATUS_ERR_CHANNEL_IS_FULL
1042 SILC_STATUS_ERR_NOT_INVITED
1043 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1044 SILC_STATUS_ERR_BAD_CHANNEL
1045 SILC_STATUS_ERR_USER_ON_CHANNEL
1048 15 SILC_COMMAND_MOTD
1051 Arguments: (1) <server>
1053 This command is used to query the Message of the Day of the server.
1055 Reply messages to the command:
1058 Arguments: (1) <Status Payload> (2) <Server ID>
1061 This command replies with the motd message if it exists.
1066 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1067 SILC_STATUS_ERR_TOO_MANY_PARAMS
1068 SILC_STATUS_ERR_NOT_REGISTERED
1069 SILC_STATUS_ERR_NO_SUCH_SERVER
1072 16 SILC_COMMAND_UMODE
1075 Arguments: (1) <Client ID> (2) [<client mode mask>]
1077 This command is used by client to set/unset modes for itself.
1078 However, there are some modes that the client MUST NOT set itself,
1079 but they will be set by server. However, client MAY unset any
1080 mode. Modes may be masked together ORing them thus having
1081 several modes set. Client MUST keep its client mode mask
1082 locally so that the mode setting/unsetting would work without
1083 problems. Client may change only its own modes.
1085 After changing the mode server MUST send the notify type
1086 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1088 The following client modes are defined:
1090 0x00000000 SILC_UMODE_NONE
1092 No specific mode for client. This is the initial
1093 setting when new client is created. The client is
1094 normal client and is present in the network.
1097 0x00000001 SILC_UMODE_SERVER_OPERATOR
1099 Marks the user as server operator. Client MUST NOT
1100 set this mode itself. Server sets this mode to the
1101 client when client attains the server operator
1102 privileges by SILC_COMMAND_OPER command. Client
1103 MAY unset the mode itself.
1106 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1108 Marks the user as router (SILC) operator. Client
1109 MUST NOT set this mode itself. Router sets this mode
1110 to the client when client attains the router operator
1111 privileges by SILC_COMMAND_SILCOPER command. Client
1112 MAY unset the mode itself.
1115 0x00000004 SILC_UMODE_GONE
1117 Marks that the user is not currently present in the
1118 SILC Network. Client MAY set and unset this mode.
1121 0x00000008 SILC_UMODE_INDISPOSED
1123 Marks that the user is currently indisposed and may
1124 not be able to receive any messages, and that user may
1125 not be present in the network. Client MAY set and
1129 0x00000010 SILC_UMODE_BUSY
1131 Marks that the user is currently busy and may not
1132 want to receive any messages, and that user may not
1133 be present in the network. Client MAY set and unset
1137 0x00000020 SILC_UMODE_PAGE
1139 User is not currently present or is unable to receive
1140 messages, and prefers to be paged in some mechanism
1141 if the user needs to be reached. Client MAY set and
1145 0x00000040 SILC_UMODE_HYPER
1147 Marks that the user is hyper active and is eager to
1148 receive and send messages. Client MAY set and unset
1152 0x00000080 SILC_UMODE_ROBOT
1154 Marks that the client is actually a robot program.
1155 Client MAY set and unset this mode.
1158 0x00000100 SILC_UMODE_ANONYMOUS
1160 Marks that the client is anonymous client. Server
1161 that specifically is designed for anonymous services
1162 can set and unset this mode. Client MUST NOT set or
1163 unset this mode itself. A client with this mode set
1164 would have the username and the hostname information
1165 scrambled by the server which set this mode.
1168 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1170 Marks that the client wishes to block private
1171 messages sent to the client, unless the Private
1172 Message Key flag is set in the SILC packet header.
1173 If this mode is set server MUST NOT deliver private
1174 messages to the client without the Private Message
1175 Key flag being set. The Private Message Key flag set
1176 indicates that the private message is protected with
1177 a key shared between the sender and the recipient.
1179 A separate service could provide additional filtering
1180 features for accepting private messages from certain
1181 sender. However, this document does not specify such
1184 The client MAY set and unset this mode.
1187 0x00000400 SILC_UMODE_DETACHED
1189 Marks that the client is detached from the SILC network.
1190 This means that the actual network connection to the
1191 client is lost but the client entry is still valid. The
1192 detached client can be resumed at a later time. This
1193 mode MUST NOT be set by client. It can only be set when
1194 client has issued command SILC_COMMAND_DETACH. The server
1195 sets this mode. This mode cannot be unset with this
1196 command. It is unset when the client is resuming back to
1197 the network and SILC_PACKET_RESUME_CLIENT packet is
1200 This flag MUST NOT be used to determine whether a packet
1201 can be sent to the client or not. Only the server that
1202 had the original client connection can make the decision
1203 by knowing that the network connection is not active.
1204 In this case the default case is to discard the packet.
1207 0x00000800 SILC_UMODE_REJECT_WATCHING
1209 Marks that the client rejects that it could be watched
1210 by someone else. If this mode is set notifications about
1211 this client is not send, even if someone is watching the
1212 same nickname this client has. Client MAY set and unset
1213 this mode. Any changes for this client MUST NOT be
1214 notified to any watcher when this mode is set.
1216 A separate service could provide additional filtering
1217 features for rejecting and accepting the watching from
1218 certain users. However, this document does not specify
1222 0x00001000 SILC_UMODE_BLOCK_INVITE
1224 Marks that the client wishes to block incoming invite
1225 notifications. Client MAY set and unset this mode.
1226 When set server does not deliver invite notifications
1227 to the client. Note that this mode may make it harder
1228 to join invite-only channels.
1230 If the <client mode mask> was not provided this command merely
1231 returns the mode mask to the client.
1234 Reply messages to the command:
1237 Arguments: (1) <Status Payload> (2) <client mode mask>
1239 This command replies with the changed client mode mask that
1240 the client MUST to keep locally.
1246 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1247 SILC_STATUS_ERR_TOO_MANY_PARAMS
1248 SILC_STATUS_ERR_NOT_REGISTERED
1249 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1250 SILC_STATUS_ERR_BAD_CLIENT_ID
1251 SILC_STATUS_ERR_NOT_YOU
1252 SILC_STATUS_ERR_PERM_DENIED
1253 SILC_STATUS_ERR_UNKNOWN_MODE
1254 SILC_STATUS_ERR_NO_CLIENT_ID
1257 17 SILC_COMMAND_CMODE
1260 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1261 (3) [<user limit>] (4) [<passphrase>]
1262 (5) [<cipher>] (6) [<hmac>]
1263 (7) [<auth payload>] (8) [<founder pubkey>]
1264 (9) [<channel pubkey>]
1266 This command is used by client to set or change channel flags on
1267 a channel. Channel has several modes that set various properties
1268 of a channel. Modes may be masked together by ORing them thus
1269 having several modes set. The <Channel ID> is the ID of the
1270 target channel. The client changing channel mode MUST be on
1271 the same channel and posses sufficient privileges to be able to
1274 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1275 type MUST be distributed to the channel.
1277 The following channel modes are defined:
1279 0x00000000 SILC_CMODE_NONE
1281 No specific mode on channel. This is the default when
1282 channel is created. This means that channel is just plain
1286 0x00000001 SILC_CMODE_PRIVATE
1288 Channel is private channel. Private channels are shown
1289 in the channel list listed with SILC_COMMAND_LIST command
1290 with indication that the channel is private. Also,
1291 client on private channel will no be detected to be on
1292 the channel as the channel is not shown in the client's
1293 currently joined channel list. Channel founder and
1294 channel operator MAY set/unset this mode.
1297 0x00000002 SILC_CMODE_SECRET
1299 Channel is secret channel. Secret channels are not shown
1300 in the list listed with SILC_COMMAND_LIST command. Secret
1301 channels can be considered to be invisible channels.
1302 Channel founder and channel operator MAY set/unset this
1306 0x00000004 SILC_CMODE_PRIVKEY
1308 Channel uses private channel key to protect the traffic
1309 on the channel. When this mode is set the client will be
1310 responsible to set the key it wants to use to encrypt and
1311 decrypt the traffic on channel. Server generated channel
1312 keys are not used at all. This mode provides additional
1313 security as clients on channel may agree to use private
1314 channel key that even servers do not know. Naturally,
1315 this requires that every client on the channel knows
1316 the key before hand (it is considered to be pre-shared-
1317 key). The key material SHOULD be processed as stated
1318 in the [SILC3] in the section Processing the Key Material.
1320 As it is local setting it is possible to have several
1321 private channel keys on one channel. In this case several
1322 clients can talk on same channel but only those clients
1323 that share the key with the message sender will be able
1324 to hear the talking. Client SHOULD NOT display those
1325 message for the end user that it is not able to decrypt
1326 when this mode is set.
1328 Only channel founder MAY set/unset this mode. If this
1329 mode is unset the server will distribute new channel
1330 key to all clients on the channel which will be used
1334 0x00000008 SILC_CMODE_INVITE
1336 Channel is invite only channel. Client may join to this
1337 channel only if it is invited to the channel. Channel
1338 founder and channel operator MAY set/unset this mode.
1341 0x00000010 SILC_CMODE_TOPIC
1343 The topic of the channel may only be set by client that
1344 is channel founder or channel operator. Normal clients
1345 on channel will not be able to set topic when this mode
1346 is set. Channel founder and channel operator MAY set/
1350 0x00000020 SILC_CMODE_ULIMIT
1352 User limit has been set to the channel. New clients
1353 may not join to the channel when the limit set is
1354 reached. Channel founder and channel operator MAY set/
1355 unset the limit. The <user limit> argument is the
1356 number of limited users.
1359 0x00000040 SILC_CMODE_PASSPHRASE
1361 Passphrase has been set to the channel. Client may
1362 join to the channel only if it is able to provide the
1363 correct passphrase. Setting passphrases to channel
1364 is entirely safe as all commands are protected in the
1365 SILC network. Only channel founder MAY set/unset
1366 the passphrase. The <passphrase> argument is the
1370 0x00000080 SILC_CMODE_CIPHER
1372 Sets specific cipher to be used to protect channel
1373 traffic. The <cipher> argument is the requested cipher.
1374 When set or unset the server must re-generate new
1375 channel key. Only channel founder MAY set the cipher of
1376 the channel. When unset the new key is generated using
1377 default cipher for the channel.
1380 0x00000100 SILC_CMODE_HMAC
1382 Sets specific hmac to be used to compute the MACs of the
1383 channel message. The <hmac> argument is the requested hmac.
1384 Only channel founder may set the hmac of the channel.
1387 0x00000200 SILC_CMODE_FOUNDER_AUTH
1389 Channel founder may set this mode to be able to regain
1390 channel founder rights even if the client leaves the
1391 channel. The <auth payload> is the Authentication Payload
1392 consisting of the public key authentication method and the
1393 digital signature for that method. The passphrase or NONE
1394 authentication methods MUST NOT be accepted.
1396 The server does not save <auth payload> but MUST verify it.
1397 The public key used to verify the payload is the <founder
1398 pubkey> if present, or the public key of the client sending
1399 this command. If <founder pubkey> is present also that
1400 public key MUST be saved as founder's public key. This
1401 mode may be set only if the <auth payload> was verified
1402 successfully. The hash function used with the <auth
1403 payload> is selected by user or SHA1 otherwise.
1405 The public key of the founder is sent in the
1406 SILC_NOTIFY_TYPE_CMODE_CHANGE notify type so that other
1407 routers and servers in the network may save the public key.
1408 This way the founder can reclaim the founder rights back
1409 to the channel from any server in the network. The founder
1410 rights can be regained by the SILC_CUMODE_FOUNDER channel
1411 user mode, or during joining procedure with the command
1414 If this mode is already set but the <founder pubkey> is
1415 different the new key will replace the old founder key and
1416 the new key is distributed in the network with the
1417 SILC_NOTIFY_TYPE_CMODE_CHANGE notify. Only the original
1418 founder may set this mode multiple times and the client
1419 MUST have SILC_CUMODE_FOUNDER mode on the channel.
1421 When this channel mode is set the channel also becomes
1422 permanent. If all clients leave the channel while this
1423 mode is set the channel MUST NOT be destroyed. The founder
1424 can reclaim the founder mode back on these empty channels
1425 at any time. Implementations MAY limit the number of how
1426 many channels a user can own and how long they remain
1430 0x00000400 SILC_CMODE_SILENCE_USERS
1432 Channel founder may set this mode to silence normal users
1433 on the channel. Users with operator privileges are not
1434 affected by this mode. Messages sent by normal users
1435 are dropped by servers when this mode is set. This mode
1436 can be used to moderate the channel. Only channel founder
1437 may set/unset this mode.
1440 0x00000800 SILC_CMODE_SILENCE_OPERS
1442 Channel founder may set this mode to silence operators
1443 on the channel. When used with SILC_CMODE_SILENCE_USERS
1444 mode this can be used to set the channel in state where only
1445 the founder of the channel may send messages to the channel.
1446 Messages sent by operators are dropped by servers when this
1447 mode is set. Only channel founder may set/unset this mode.
1450 0x00001000 SILC_CMODE_CHANNEL_AUTH
1452 When this mode is set the channel has one or more public keys
1453 or certificates set, and ability to join the channel requires
1454 a client to provide digital signature that can be successfully
1455 verified with one of the channel public keys. This mode is
1456 equivalent to the SILC_MODE_PASSPHRASE except that digital
1457 signatures are used to gain access to the channel. Both
1458 modes MAY be set at the same time. Channel founder may set
1459 and unset this mode.
1461 The <channel pubkey> argument is an Argument List Payload
1462 where each argument is Public Key Payload including public
1463 key to be added or removed from the channel public key list.
1464 To add a public key to channel this mode is set and the
1465 argument type is 0x00, and the argument is the public key.
1466 To remove a public key from channel public key list the
1467 argument type is 0x01, and the argument is the public key
1468 to be removed from the list. To remove all public keys at
1469 once this mode is unset. An implementation MAY limit the
1470 number of public keys that can be set for the channel.
1471 This mode MUST NOT be set if <channel pubkey> is not present
1472 when the mode is set for the first time. Implementation MAY
1473 add and remove multiple public keys at the same time by
1474 including multiple arguments to the <channel pubkey>
1475 Argument List Payload.
1478 To make the mode system work, client MUST keep the channel mode
1479 mask locally so that the mode setting and unsetting would work
1480 without problems. The client receives the initial channel mode
1481 mask when it joins to the channel. When the mode changes on
1482 channel the server MUST distribute the changed channel mode mask
1483 to all clients on the channel by sending the notify type
1484 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1485 to the server's primary router. If the <channel mode mask> was
1486 not provided this command returns the mode mask, founder key,
1487 channel public key list and the current user limit to the client.
1489 Reply messages to the command:
1492 Arguments: (1) <Status Payload> (2) <Channel ID>
1493 (3) <channel mode mask> (4) [<founder pubkey>]
1494 (5) [<channel pubkeys>] (6) [<user limit>]
1496 This command replies with the changed channel mode mask that
1497 client MUST keep locally. It may also return the channel
1498 founder's public key if it is set. It may also return list of
1499 channel public keys when the list was altered. The <channel
1500 pubkeys> is Argument List Payload and each argument includes
1501 one public key. The <user limit> is the current user limit
1502 on the channel, if one is set.
1507 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1508 SILC_STATUS_ERR_TOO_MANY_PARAMS
1509 SILC_STATUS_ERR_NOT_REGISTERED
1510 SILC_STATUS_ERR_NOT_ON_CHANNEL
1511 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1512 SILC_STATUS_ERR_BAD_CHANNEL_ID
1513 SILC_STATUS_ERR_NO_CHANNEL_ID
1514 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1515 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1516 SILC_STATUS_ERR_UNKNOWN_MODE
1517 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1518 SILC_STATUS_ERR_AUTH_FAILED
1521 18 SILC_COMMAND_CUMODE
1524 Arguments: (1) <Channel ID> (2) <mode mask>
1525 (3) <Client ID> (4) [<auth payload>]
1527 This command is used by client to change channel user modes on
1528 channel. Users on channel may have some special modes and this
1529 command is used by channel operators to set or change these modes.
1530 The <Channel ID> is the ID of the target channel. The <mode mask>
1531 is OR'ed mask of modes. The <Client ID> is the target client.
1532 The client changing channel user modes MUST be on the same channel
1533 as the target client and posses sufficient privileges to be able to
1536 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1537 type is distributed to the channel.
1539 The following channel modes are defined:
1541 0x00000000 SILC_CUMODE_NONE
1543 No specific mode. This is the normal situation for client.
1544 Also, this is the mode set when removing all modes from
1548 0x00000001 SILC_CUMODE_FOUNDER
1550 The client is channel founder of the channel. Usually this
1551 mode is set only by the server when the channel was created.
1552 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1553 been set, the client can claim channel founder privileges
1554 by providing the <auth payload> that the server will use
1555 to authenticate the client. The public key that server will
1556 use to verify the <auth payload> MUST be the same public key
1557 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1558 mode was set. The client MAY remove this mode at any time.
1561 0x00000002 SILC_CUMODE_OPERATOR
1563 Sets channel operator privileges on the channel for a
1564 client on the channel. Channel founder and channel operator
1565 MAY set/unset this mode. The client MAY remove this mode
1569 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1571 Marks that the client wishes not to receive any channel
1572 messages sent for the channel. Client MAY set and unset
1573 this mode to itself. Client MUST NOT set it to anyone else.
1574 When this mode is set server MUST NOT deliver channel
1575 messages to this client. Other packets such as channel
1576 key packets are still sent to the client.
1578 A separate service could provide additional filtering
1579 features for accepting channel messages from certain
1580 sender. However, this document does not specify such
1584 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1586 Marks that the client wishes not to receive any channel
1587 messages sent from normal users. Only messages sent by
1588 channel founder or channel operator is accepted. Client
1589 MAY set and unset this mode to itself. Client MUST NOT
1590 set it to anyone else. When this mode is set server MUST
1591 NOT deliver channel messages that are sent by normal users
1594 A separate service could provide additional filtering
1595 features for accepting channel messages from certain
1596 sender. However, this document does not specify such
1600 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1602 Marks that the client wishes not to receive any channel
1603 messages sent from robots. Messages sent by users with
1604 the SILC_UMODE_ROBOT user mode set are not delivered.
1605 Client MAY set and unset this mode to itself. Client MUST
1606 NOT set it to anyone else. When this mode is set server
1607 MUST NOT deliver channel messages that are sent by robots
1611 0x00000020 SILC_CUMODE_QUIET
1613 Marks that the client cannot talk on the channel. This
1614 mode can be set by channel operator or channel founder to
1615 some other user that is not operator or founder. The
1616 target client MUST NOT unset this mode. When this mode
1617 is set the server MUST drop messages sent by this client
1621 Reply messages to the command:
1624 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1625 (3) <Channel ID> (4) <Client ID>
1627 This command replies with the changed channel user mode mask that
1628 client MUST keep locally. The <Channel ID> is the specified
1629 channel. The <Client ID> is the target client.
1634 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1635 SILC_STATUS_ERR_TOO_MANY_PARAMS
1636 SILC_STATUS_ERR_NOT_REGISTERED
1637 SILC_STATUS_ERR_NOT_ON_CHANNEL
1638 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1639 SILC_STATUS_ERR_BAD_CHANNEL_ID
1640 SILC_STATUS_ERR_NO_CHANNEL_ID
1641 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1642 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1643 SILC_STATUS_ERR_UNKNOWN_MODE
1644 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1645 SILC_STATUS_ERR_AUTH_FAILED
1648 19 SILC_COMMAND_KICK
1651 Arguments: (1) <Channel ID> (2) <Client ID>
1654 This command is used by channel operators to remove a client from
1655 channel. The <channel> argument is the channel the client to be
1656 removed is on currently. Note that the "kicker" must be on the same
1657 channel. If <comment> is provided it will be sent to the removed
1660 After kicking the client the server MUST send the notify type
1661 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1662 The client is removed from the channel after sending this notify.
1663 The kicked client MUST be removed from the invite list of the
1664 channel if it is explicitly added in the list. The channel key
1665 MUST also be re-generated after kicking, unless the
1666 SILC_CMODE_PRIVKEY mode is set.
1668 Reply messages to the command:
1671 Arguments: (1) <Status Payload> (2) <Channel ID>
1674 This command returns the Channel ID and Client ID that was kicked
1680 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1681 SILC_STATUS_ERR_TOO_MANY_PARAMS
1682 SILC_STATUS_ERR_NOT_REGISTERED
1683 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1684 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1685 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1686 SILC_STATUS_ERR_NO_CLIENT_ID
1693 Arguments: (1) <Channel ID> (2) [<add | del>]
1696 This command is used to manage the ban list of the channel
1697 indicated by the <Channel ID>. A client that is banned from
1698 channel is no longer able to join the channel. The client which
1699 is executing this command MUST have at least channel operator
1700 privileges on the channel.
1702 The <add | del> is an argument of size of 1 byte where 0x00 means
1703 adding a client to ban list, and 0x01 means deleting a client
1704 from ban list. The <ban list>, if present, indicates the
1705 information to be added to or removed from the ban list. It
1706 may include a string for matching clients, public key of a
1707 client (Public Key Payload) or Client ID of a client. The
1708 <ban list> is an Argument List Payload.
1710 The following Argument Types has been defined for ban list
1713 0x01 - Argument is an ban string of following format:
1715 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
1717 The <hostname> may also be in format of IP/MASK to indicate
1720 0x02 - Argument is the public key of a client
1721 0x03 - Argument is the Client ID of a client
1723 If unknown type value is received or there is invalid amount of
1724 Argument Payloads present in the list, the command MUST be
1725 discarded. When argument that is to be deleted from the ban
1726 list does not exist in the list the argument is ignored.
1728 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1729 primary router after adding to or removing from the ban list.
1730 The wildcards MAY be used with this command. If this command
1731 is executed without the ban arguments the command merely replies
1732 with the current ban list.
1734 Reply messages to the command:
1737 Arguments: (1) <Status Payload> (2) <Channel ID>
1740 This command replies with the <Channel ID> of the channel and
1741 the current <ban list> of the channel if it exists.
1746 SILC_STATUS_ERR_NOT_REGISTERED
1747 SILC_STATUS_ERR_TOO_MANY_PARAMS
1748 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1749 SILC_STATUS_ERR_NO_CHANNEL_ID
1750 SILC_STATUS_ERR_NOT_ON_CHANNEL
1751 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1752 SILC_STATUS_ERR_RESOURCE_LIMIT
1757 21 SILC_COMMAND_DETACH
1762 This command is used to detach from the network. Client can
1763 send this command to its server to indicate that it will be
1764 detached. By detaching the client remains in the network but
1765 the actual network connection to the server is closed. The
1766 client may then later resume the old session back.
1768 When this command is received the server MUST check that the
1769 client is locally connected client, and set the user mode
1770 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1771 MUST be also sent to routers. The server then sends command
1772 reply to this command and closes the network connection.
1773 The server MUST NOT remove the client from its lists, or send
1774 any signoff notifications for this client. See the [SILC1]
1775 for detailed information about detaching.
1777 Reply messages to the command:
1780 Arguments: (1) <Status Payload>
1782 This command replies only with the status indication.
1787 SILC_STATUS_ERR_NOT_REGISTERED
1791 22 SILC_COMMAND_WATCH
1794 Arguments: (1) <Client ID> (2) [<add nickname>]
1795 (3) [<del nickname>] (4) [<public key>]
1797 This command is used to set up a watch for <add nickname>
1798 nickname. When a user in the network appears with the
1799 nickname, or signoffs the network or user's mode is changed
1800 the client which set up the watch will be notified about
1801 this change. This can be used to watch for certain nicknames
1802 in the network and receive notifications when for example a
1803 friend appears in the network or leaves the network.
1805 The <del nickname> is a nickname that has been previously
1806 added to watch list and is now removed from it. Notifications
1807 for that nickname will not be delivered anymore. The nickname
1808 set to watch MUST NOT include any wildcards. Note also that a
1809 nickname may match several users since nicknames are not unique.
1810 Implementations MAY set limits for how many nicknames client
1813 OPTIONALLY this command may also be set to watch clients' actions
1814 in the network using their public key or certificate. The
1815 <public key> MAY be present, and it is an Argument List Payload
1816 where each argument is a Public Key Payload including public key
1817 to be added or removed from the watch list. To To add a public
1818 key to watch list the argument type is 0x00, and the argument is
1819 the public key. To remove a public key from watch list list the
1820 argument type is 0x01, and the argument is the public key to be
1821 removed from the list. An implementation MAY limit the number of
1822 public keys that can be set on the watch list. Implementation MAY
1823 add and remove multiple public keys at the same time by including
1824 multiple arguments to the <public key> Argument List Payload.
1826 The <Client ID> is the Client ID of the sender of this command.
1828 When normal server receives this command from client it
1829 MUST send it to its router. Router will process the command
1830 and actually keeps the watch list.
1832 Reply messages to the command:
1835 Arguments: (1) <Status Payload>
1837 This command replies only with the status indication.
1842 SILC_STATUS_ERR_NOT_REGISTERED
1843 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1844 SILC_STATUS_ERR_TOO_MANY_PARAMS
1845 SILC_STATUS_ERR_BAD_NICKNAME
1846 SILC_STATUS_ERR_WILDCARDS
1847 SILC_STATUS_ERR_RESOURCE_LIMIT
1848 SILC_STATUS_ERR_NO_SUCH_NICK
1849 SILC_STATUS_ERR_NICKNAME_IN_USE
1852 23 SILC_COMMAND_SILCOPER
1855 Arguments: (1) <username> (2) <authentication payload>
1857 This command is used by normal client to obtain router operator
1858 privileges (also known as SILC operator) on the router. Note
1859 that router operator has privileges that supersedes the server
1860 operator privileges.
1862 The <username> is the username set in the server configurations
1863 as operator. The <authentication payload> is the data that the
1864 client is authenticated against. It may be passphrase prompted
1865 for user on client's screen or it may be public key or certificate
1866 authentication data (data signed with private key). The public
1867 key that router will use to verify the signature found in the
1868 payload should be verified. It is recommended that the public
1869 key is saved locally in the router and router would not use
1870 any public keys received during the SKE.
1872 Difference between router operator and server operator is that
1873 router operator is able to handle cell level properties while
1874 server operator (even on router server) is able to handle only
1875 local properties, such as, local connections and normal server
1876 administration. The router operator is also able to use the
1877 SILC_COMMAND_KILL command.
1879 After changing the mode server MUST send the notify type
1880 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1882 Reply messages to the command:
1885 Arguments: (1) <Status Payload>
1887 This command replies only with Status Payload.
1892 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1893 SILC_STATUS_ERR_TOO_MANY_PARAMS
1894 SILC_STATUS_ERR_NOT_REGISTERED
1895 SILC_STATUS_ERR_AUTH_FAILED
1900 24 SILC_COMMAND_LEAVE
1903 Arguments: (1) <Channel ID>
1905 This command is used by client to leave a channel the client is
1908 When leaving channel the server MUST send the notify type
1909 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1910 The channel key MUST also be re-generated when leaving the channel
1911 and distribute it to all clients still currently on the channel.
1912 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1915 Reply messages to the command:
1918 Arguments: (1) <Status Payload> (2) <Channel ID>
1920 The <Channel ID> is the ID of left channel.
1925 SILC_STATUS_ERR_NOT_REGISTERED
1926 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1927 SILC_STATUS_ERR_TOO_MANY_PARAMS
1928 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1929 SILC_STATUS_ERR_BAD_CHANNEL_ID
1930 SILC_STATUS_ERR_NO_CHANNEL_ID
1933 25 SILC_COMMAND_USERS
1936 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1938 This command is used to list user names currently on the requested
1939 channel; either the argument <Channel ID> or the <channel name>.
1940 One of these arguments must be present. The server MUST resolve
1941 the joined clients and reply with a lists of users on the channel
1942 and with list of user modes on the channel.
1944 If the requested channel is a private or secret channel, this
1945 command MUST NOT send the list of users, except if the sender is
1946 on the channel, or the sender is a server. Otherwise, error is
1947 returned to the sender.
1949 Reply messages to the command:
1952 Arguments: (1) <Status Payload> (2) <Channel ID>
1953 (3) <list count> (4) <Client ID list>
1954 (5) <client mode list>
1956 This command replies with the Channel ID of the requested channel
1957 Client ID list of the users on the channel and list of their modes.
1958 The Client ID list has Client ID's of all users in the list. The
1959 <Client ID list> is formed by adding Client ID's one after another.
1960 The <client mode list> is formed by adding client's user modes on
1961 the channel one after another (4 bytes (32 bits) each). The <list
1962 count> of length of 4 bytes (32 bits), tells the number of entries
1963 in the lists. Both lists MUST have equal number of entries.
1968 SILC_STATUS_ERR_NOT_REGISTERED
1969 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1970 SILC_STATUS_ERR_TOO_MANY_PARAMS
1971 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1972 SILC_STATUS_ERR_BAD_CHANNEL_ID
1973 SILC_STATUS_ERR_NO_CHANNEL_ID
1974 SILC_STATUS_ERR_NOT_ON_CHANNEL
1977 26 SILC_COMMAND_GETKEY
1980 Arguments: (1) <ID Payload>
1982 This command is used to fetch the public key of the client or
1983 server indicated by the <ID Payload>. The public key is fetched
1984 from the server where to the client is connected.
1986 Reply messages to the command:
1989 Arguments: (1) <Status Payload> (2) <ID Payload>
1990 (3) [<Public Key Payload>]
1992 This command replies with the client's or server's ID and with
1993 the <Public Key Payload>.
1998 SILC_STATUS_ERR_NOT_REGISTERED
1999 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2000 SILC_STATUS_ERR_TOO_MANY_PARAMS
2001 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2002 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2005 27 SILC_COMMAND_SERVICE
2008 Arguments: (1) [<service name>] (2) [<auth payload>]
2011 This command is used to negotiate a service agreement with a
2012 remote server. If this command is given without arguments it
2013 MAY return the service list, if it is publicly available. The
2014 <service name> is a service specific identifier, and the
2015 <auth payload> MAY be used to authenticate the requester to the
2016 remote service. The authentication to a service may be based
2017 on previous agreement with the requester and the service
2018 provider. The command MAY also take additional service
2021 This document does not specify any services. How the services
2022 are configured and put available in a server is also out of
2023 scope of this document.
2025 This command MAY be used by client to start using some service
2026 in a server, but it also MAY be used by server to negotiate
2027 to start using a service in some other server or router.
2029 After the negotiation is done both of the parties need to know
2030 from the service identifier how the service can be used. The
2031 service can be considered to be a protocol which both of the
2032 parties need to support.
2034 Reply messages to the command:
2037 Arguments: (1) <Status Payload> (2) [<service list>]
2038 (3) [<service name>] (n) [...]
2041 This command MAY reply with the <service list> when command is
2042 given without arguments, and the list is a comma separated list
2043 of service identifiers. The <service name> is the service that
2044 the sender requested and this is provided when the server has
2045 accepted the sender to use the <service name>. The command
2046 reply MAY also have additional service specific arguments.
2051 SILC_STATUS_ERR_NOT_REGISTERED
2052 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2053 SILC_STATUS_ERR_TOO_MANY_PARAMS
2054 SILC_STATUS_ERR_NO_SUCH_SERVICE
2055 SILC_STATUS_ERR_AUTH_FAILED
2056 SILC_STATUS_ERR_PERM_DENIED
2062 Currently undefined commands.
2067 These commands are reserved for private use and will not be defined
2071 255 SILC_COMMAND_MAX
2073 Reserved command. This must not be sent.
2078 2.4 SILC Command Status Payload
2080 Command Status Payload is sent in command reply messages to indicate
2081 the status of the command. The payload is one of argument in the
2082 command thus this is the data area in Command Argument Payload described
2083 in [SILC2]. The payload is only 2 bytes in length. The following
2084 diagram represents the Command Status Payload (fields are always in
2091 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
2092 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2094 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2098 Figure 6: SILC Command Status Payload
2102 o Status (1 byte) - Indicates the status message type,
2103 error, start of list, entry of list or end of list.
2105 o Error (1 byte) - Indicates the error if the Status
2106 field is some list status, which means there are list
2110 The values in Status and Error fields are set according
2111 the following rules:
2114 o If there is single reply and error has not occurred
2115 then Status field includes value SILC_STATUS_OK, and
2116 the Error field MUST be ignored (and set to zero
2119 o If there is single error, then Status field includes
2120 one of the error values, and the Error field MUST be
2121 ignored (and set to zero value).
2123 o If there will be multiple successful command replies
2124 then Status field includes SILC_STATUS_LIST_START,
2125 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
2126 and Error field is set to SILC_STATUS_OK.
2128 o If there are multiple error replies then Status field
2129 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
2130 or SILC_STATUS_LIST_END value, and the Error field
2131 includes the error value.
2134 This way it is possible to send single successful or
2135 single error reply, but also multiple successful and
2136 multiple error replies. Note that it is possible to
2137 send both list of successful replies and list of error
2138 replies at the same time, however in this case the
2139 list of error replies MUST be sent after the successful
2140 replies. This way the recipient may ignore the multiple
2141 errors if it wishes to do so. Also note that in this
2142 case the successful and error replies belong to the
2145 All Status messages are described in the next section.
2151 Status messages are returned in SILC protocol in command reply
2152 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
2153 the command reply packet and status types are sent inside the
2154 Status Payload as one of command reply argument, as defined in
2155 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
2156 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
2157 types defined in this section are used in both cases.
2159 When returning status messages in the command reply message they
2160 indicate whether the command was executed without errors. If error
2161 occurred the status indicates which error occurred. If error
2162 occurred the arguments to the command replies are dictated by the
2163 error type. If arguments are to be sent, they are defined below
2164 with the error status types.
2166 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
2167 they always send some error status. Usually they are sent to
2168 indicate that error occurred while processing some SILC packet.
2169 Please see the [SILC1] and [SILC2] for more information sending
2170 status types in SILC_NOTIFY_TYPE_ERROR notify.
2172 The Status Types are only numeric values and the receiver must
2173 convert the numeric values into human readable messages if this
2174 is desired in the application.
2176 List of all defined status types:
2179 Generic status messages:
2183 Ok status. Everything went Ok. The status payload maybe
2184 safely ignored in this case.
2186 1 SILC_STATUS_LIST_START
2188 Start of the list. There will be several command replies and
2189 this reply is the start of the list.
2191 2 SILC_STATUS_LIST_ITEM
2193 Item in the list. This is one of the item in the list but not the
2196 3 SILC_STATUS_LIST_END
2198 End of the list. There were several command replies and this
2199 reply is the last of the list. There won't be other replies
2200 belonging to this list after this one.
2204 Currently undefined and has been reserved for the future.
2207 Error status message:
2211 10 SILC_STATUS_ERR_NO_SUCH_NICK
2213 "No such nickname". Requested nickname does not exist.
2214 The next argument MUST be the requested nickname.
2216 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2218 "No such channel". Requested channel name does not exist.
2219 The next argument MUST be the requested channel name.
2221 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2223 "No such server". Requested server name does not exist.
2224 The next argument MUST be the requested server name.
2226 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2228 "Incomplete registration information". Information remote
2229 sent was incomplete.
2231 14 SILC_STATUS_ERR_NO_RECIPIENT
2233 "No recipient given". Command required recipient which was
2236 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2238 "Unknown command". Command sent to server is unknown by the
2241 16 SILC_STATUS_ERR_WILDCARDS
2243 "Wildcards cannot be used". Wildcards were provided but they
2246 17 SILC_STATUS_ERR_NO_CLIENT_ID
2248 "No Client ID given". Client ID were expected as command
2249 parameter but were not found.
2251 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2253 "No Channel ID given". Channel ID were expected as command
2254 parameter but were not found.
2256 19 SILC_STATUS_ERR_NO_SERVER_ID
2258 "No Serve ID given". Server ID were expected as command
2259 parameter but were not found.
2261 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2263 "Bad Client ID". Client ID provided were erroneous.
2264 The next argument MUST be the provided ID.
2266 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2268 "Bad Channel ID". Channel ID provided were erroneous.
2269 The next argument MUST be the provided ID.
2271 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2273 "No such Client ID". Client ID provided does not exist.
2274 The unknown Client ID MUST be provided as next argument
2277 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2279 "No such Channel ID". Channel ID provided does not exist.
2280 The unknown Channel ID MUST be provided as next argument
2283 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2285 "Nickname already exists". Nickname created could not be
2286 registered because number of same nicknames were already set to
2287 maximum. This is not expected to happen in real life but is
2290 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2292 "You are not on that channel". The command were specified for
2293 channel user is not currently on. The next argument MUST be the
2296 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2298 "They are not on channel". The requested target client is not
2299 on requested channel. The next two arguments, in this order,
2300 MUST be the requested Client ID and Channel ID.
2302 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2304 "User already on channel". User were invited on channel they
2305 already are on. The next two arguments, in this order, MUST be
2306 the requested Client ID and Channel ID.
2308 28 SILC_STATUS_ERR_NOT_REGISTERED
2310 "You have not registered". User executed command that requires
2311 the client to be registered on the server before it may be
2314 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2316 "Not enough parameters". Command requires more parameters
2319 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2321 "Too many parameters". Too many parameters were provided
2324 31 SILC_STATUS_ERR_PERM_DENIED
2326 "Permission denied". Generic permission denied error status
2327 to indicate disallowed access.
2329 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2331 "You are banned from this server". The client tried to register
2332 on server that has explicitly denied this host to connect.
2334 33 SILC_STATUS_ERR_BAD_PASSWORD
2336 "Cannot join channel. Incorrect password". Password provided for
2337 channel were not accepted. The next argument MUST be the
2340 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2342 "Cannot join channel. Channel is full". The channel is full
2343 and client cannot be joined to it. The next argument MUST be
2346 35 SILC_STATUS_ERR_NOT_INVITED
2348 "Cannot join channel. You have not been invited". The channel
2349 is invite only channel and client has not been invited. The next
2350 argument MUST be the Channel ID.
2352 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2354 "Cannot join channel. You have been banned". The client has
2355 been banned from the channel. The next argument MUST be the
2358 37 SILC_STATUS_ERR_UNKNOWN_MODE
2360 "Unknown mode". Mode provided by the client were unknown to
2363 38 SILC_STATUS_ERR_NOT_YOU
2365 "Cannot change mode for other users". User tried to change
2366 someone else's mode.
2368 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2370 "Permission denied. You are not channel operator". Command may
2371 be executed only by channel operator. The next argument MUST be
2374 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2376 "Permission denied. You are not channel founder". Command may
2377 be executed only by channel operator. The next argument MUST be
2380 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2382 "Permission denied. You are not server operator". Command may
2383 be executed only by server operator.
2385 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2387 "Permission denied. You are not SILC operator". Command may be
2388 executed only by router (SILC) operator.
2390 43 SILC_STATUS_ERR_BAD_NICKNAME
2392 "Bad nickname". Nickname requested contained illegal characters
2395 44 SILC_STATUS_ERR_BAD_CHANNEL
2397 "Bad channel name". Channel requested contained illegal characters
2400 45 SILC_STATUS_ERR_AUTH_FAILED
2402 "Authentication failed". The authentication data sent as
2403 argument were wrong and thus authentication failed.
2405 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2407 "The algorithm was not supported." The server does not support the
2408 requested algorithm. The next argument MUST be the algorithm name
2411 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2413 "No such Server ID". Server ID provided does not exist.
2414 The unknown Server ID MUST be provided as next argument
2417 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2419 "No more resources available". This can mean that server cannot
2420 or will not accept something due to resource limitations.
2422 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2424 "Service does not exist". Requested service identifier is
2425 unknown. The next argument MUST be the service identifier.
2427 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2429 "You have not been authenticated". Remote connection is not
2430 authenticated even though it is supposed to be.
2432 51 SILC_STATUS_ERR_BAD_SERVER_ID
2434 "Server ID is not valid". Provided server ID is not valid.
2435 The next argument MUST be the provided ID.
2437 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2439 "Key exchange failed". Key Exchange protocol failed.
2441 53 SILC_STATUS_ERR_BAD_VERSION
2443 "Bad version". Protocol or software version mismatch.
2445 54 SILC_STATUS_ERR_TIMEDOUT
2447 "Operation timed out". Operation or service request timed
2448 out, and thus was not processed.
2450 55 SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY
2452 "Unsupported public key type". The public key or certificate
2453 type is not supported in this implementation.
2455 56 SILC_STATUS_ERR_OPERATION_ALLOWED
2457 "Operation is not allowed". A operation, for example a command,
2458 is not allowed or it's execution is not allowed.
2465 4 Security Considerations
2467 Security is central to the design of this protocol, and these security
2468 considerations permeate the specification. Common security considerations
2469 such as keeping private keys truly private and using adequate lengths for
2470 symmetric and asymmetric keys must be followed in order to maintain the
2471 security of this protocol.
2477 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2478 Protocol Specification", Internet Draft, January 2007.
2480 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2483 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2484 Protocols", Internet Draft, January 2007.
2486 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2489 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2492 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2495 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2498 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2501 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2504 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2507 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2510 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2511 Infrastructure, Certificate and CRL Profile", RFC 2459,
2514 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2515 John Wiley & Sons, New York, NY, 1996.
2517 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2520 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2521 RFC 2412, November 1998.
2523 [ISAKMP] Maughan D., et al, "Internet Security Association and
2524 Key Management Protocol (ISAKMP)", RFC 2408, November
2527 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2528 (IKE)", RFC 2409, November 1998.
2530 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2531 Authentication", RFC 2104, February 1997.
2533 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2534 Specifications, Version 2.0", RFC 2437, October 1998.
2536 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2537 Requirement Levels", BCP 14, RFC 2119, March 1997.
2539 [RFC3629] Yergeau, F., "UTF-8, a transformation format of ISO
2540 10646", RFC 3629, November 2003.
2542 [ATTRS] Riikonen, P., "User Online Presence and Information
2543 Attributes", Internet Draft, May 2002.
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 (2007).
2627 This document is subject to the rights, licenses and restrictions
2628 contained in BCP 78, and except as set forth therein, the authors
2629 retain all their rights.
2631 This document and the information contained herein are provided on an
2632 "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS
2633 OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY AND THE INTERNET
2634 ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED,
2635 INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE
2636 INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED
2637 WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
projects / crypto.git / blob