8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-05.txt 27 June 2003
20 Expires: 27 December 2003
26 <draft-riikonen-silc-commands-05.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.
218 All public keys and certificates that are sent as arguments are actually
219 Public Key Payloads [SILC2]. This way it is possible to send different
220 kind of public keys and certificate types as arguments.
226 2.3 SILC Commands List
228 This section lists all SILC commands, however, it is expected that a
229 implementation and especially client implementation has many more
230 commands that has only local affect. These commands are official
231 SILC commands that has both client and server sides and cannot be
232 characterized as local commands.
234 List of all defined commands in SILC follows.
239 None. This is reserved command and MUST NOT be sent.
245 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
246 (3) [<Requested Attributes>] (4) [<Client ID>]
249 Whois command is used to query various information about specific
250 user. The user may be requested by their nickname and server name.
251 The query may find multiple matching users as there are no unique
252 nicknames in the SILC. The <count> option may be given to narrow
253 down the number of accepted results. If this is not defined there
254 are no limit of accepted results. The query may also be narrowed
255 down by defining the server name of the nickname. The <count> is
256 32 bit MSB first order integer.
258 It is also possible to search the user by Client ID. If the
259 <Client ID> is provided server MUST use it as the search value
260 instead of the <nickname>. One of the arguments MUST be given.
261 It is also possible to define multiple Client ID's to search
262 multiple users sending only one WHOIS command. In this case the
263 Client ID's are appended as normal arguments.
265 To prevent miss-use of this command wildcards in the nickname
266 or in the server name are not permitted. It is not allowed
267 to request all users on some server. The WHOIS requests MUST
268 be based on explicit nickname request.
270 The WHOIS request MUST be always sent to the router by server
271 so that all users are searched. However, the server still MUST
272 search its locally connected clients. The router MUST send
273 this command to the server which owns the requested client, if
274 the router is unable to provide all mandatory information about
275 the client. That server MUST reply to the command. Server MUST
276 NOT send whois replies to the client until it has received the
277 reply from its router.
279 The <Requested Attributes> is defined in [ATTRS] and can be used
280 to request various information about the client. See Appendix A
281 for definition of using these attributes in SILC.
283 Reply messages to the command:
286 Arguments: (1) <Status Payload> (2) <Client ID>
287 (3) <nickname>[@<server>] (4) <username@host>
288 (5) <real name> (6) [<Channel Payload
290 (7) [<user mode>] (8) [<idle time>]
291 (9) [<fingerprint>] (10) <channel user
296 This command may reply with several command reply messages to
297 form a list of results. In this case the status payload will
298 include STATUS_LIST_START status in the first reply and
299 STATUS_LIST_END in the last reply to indicate the end of the
300 list. If there are only one reply the status is set to normal
301 STATUS_OK. If multiple Client IDs was requested then each found
302 and unfound client MUST cause successful or error reply,
305 The command replies include the Client ID of the nickname,
306 nickname and server name, user name and host name and user's real
307 name. Client should process these replies only after the last
308 reply has been received with the STATUS_LIST_END status. If the
309 <count> option were defined in the query there will be only
310 <count> many replies from the server.
312 The server returns the list of channels if the client has
313 joined channels. In this case the list is list of Channel
314 Payloads. The Mode Mask in the Channel Payload is the channel's
315 mode. The list is encoded by adding the Channel Payloads one
316 after the other. Private and secret channels MUST NOT be sent,
317 except if the sender of this command is on those channels, or
318 the sender is server. The <channel user mode list> MUST also
319 be sent if client is joined channels. This list includes 32 bit
320 MSB first order values one after the other and each indicate
321 the user's mode on a channel. The order of these values MUST
322 be same as the channel order in the <Channel Payload list>.
324 The server also returns client's user mode, idle time, and the
325 fingerprint of the client's public key. The <fingerprint> is the
326 binary hash digest of the public key. The fingerprint MUST NOT
327 be sent if the server has not verified the proof of possession of
328 the corresponding private key. Server can do this during the
329 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
331 The <Attributes> is the reply to the <Requested Attributes>.
332 See the Appendix A for more information.
337 SILC_STATUS_LIST_START
339 SILC_STATUS_ERR_NO_SUCH_NICK
340 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
341 SILC_STATUS_ERR_WILDCARDS
342 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
343 SILC_STATUS_ERR_TOO_MANY_PARAMS
346 2 SILC_COMMAND_WHOWAS
349 Arguments: (1) <nickname>[@<server>] (2) [<count>]
351 Whowas. This command is used to query history information about
352 specific user. The user may be requested by their nickname and
353 server name. The query may find multiple matching users as there
354 are no unique nicknames in the SILC. The <count> option may be
355 given to narrow down the number of accepted results. If this
356 is not defined there are no limit of accepted results. The query
357 may also be narrowed down by defining the server name of the
358 nickname. The <count> is 32 bit MSB first order integer.
360 To prevent miss-use of this command wildcards in the nickname
361 or in the server name are not permitted. The WHOWAS requests MUST
362 be based on specific nickname request.
364 The WHOWAS request MUST be always sent to the router by server
365 so that all users are searched. However, the server still must
366 search its locally connected clients.
368 Reply messages to the command:
371 Arguments: (1) <Status Payload> (2) <Client ID>
372 (3) <nickname>[@<server>] (4) <username@host>
375 This command may reply with several command reply messages to form
376 a list of results. In this case the status payload will include
377 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
378 the last reply to indicate the end of the list. If there are only
379 one reply the status is set to normal STATUS_OK.
381 The command replies with nickname and user name and host name.
382 Every server MUST keep history for some period of time of its
383 locally connected clients.
388 SILC_STATUS_LIST_START
390 SILC_STATUS_ERR_NO_SUCH_NICK
391 SILC_STATUS_ERR_WILDCARDS
392 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
393 SILC_STATUS_ERR_TOO_MANY_PARAMS
396 3 SILC_COMMAND_IDENTIFY
399 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
400 (3) [<channel name>] (4) [<count>]
401 (5) [<ID Payload>] (n) [...]
403 Identify command is used to query information about an entity by
404 the entity's name or ID. This command can be used to query
405 information about clients, servers and channels.
407 The query may find multiple matching entities. The <count> option
408 may be given to narrow down the number of accepted results. If
409 this is not defined there are no limit of accepted results. The
410 <count> is 32 bit MSB first order integer.
412 It is also possible to search the entity by its ID. If the
413 <ID Payload> is provided server must use it as the search value
414 instead of the entity's name. One of the arguments MUST be given.
415 It is also possible to define multiple ID Payloads to search
416 multiple entities sending only one IDENTIFY command. In this case
417 the ID Payloads are appended as normal arguments. The type of the
418 entity is defined by the type of the ID Payload.
420 To prevent miss-use of this command wildcards in the names are
421 not permitted. It is not allowed to request for example all users
424 Implementations may not want to give interface access to this
425 command as it is hardly a command that would be used by an end
426 user. However, it must be implemented as it is most likely used
427 with private message sending.
429 The IDENTIFY command MUST be always sent to the router by server
430 so that all users are searched. However, server MUST still search
431 its locally connected clients.
433 Reply messages to the command:
436 Arguments: (1) <Status Payload> (2) <ID Payload>
437 (3) [<entity's name>] (4) [<info>]
439 This command may reply with several command reply messages to form
440 a list of results. In this case the status payload will include
441 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
442 the last reply to indicate the end of the list. If there are only
443 one reply the status is set to normal STATUS_OK. If multiple Client
444 IDs was requested then each found and unfound client must cause
445 successful or error reply, respectively.
447 When querying clients the <entity's name> must include the client's
448 nickname in the following format: nickname[@server]. The
449 <info> must include the client's username and host in the following
450 format: username@host.
452 When querying servers the <entity's name> must include the server's
453 full name. The <info> may be omitted.
455 When querying channels the <entity's name> must include the
456 channel's name. The <info> may be omitted.
458 If the <count> option were defined in the query there will be only
459 <count> many replies from the server.
464 SILC_STATUS_LIST_START
466 SILC_STATUS_ERR_NO_SUCH_NICK
467 SILC_STATUS_ERR_NO_SUCH_SERVER
468 SILC_STATUS_ERR_NO_SUCH_CHANNEL
469 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
470 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
471 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
472 SILC_STATUS_ERR_WILDCARDS
473 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
474 SILC_STATUS_ERR_TOO_MANY_PARAMS
480 Arguments: (1) <nickname>
482 Set/change nickname. This command is used to set nickname for
483 user. Nickname MUST NOT include any whitespaces (` '),
484 non-printable characters, commas (`,'), '@', '!' or any wildcard
487 When nickname is changed new Client ID is generated. Server MUST
488 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
489 channels (if any) the client is joined on. Then it MUST send
490 SILC_NOTIFY_TYPE_NICK_CHANGE notify to its primary route to
491 notify about nickname and Client ID change.
493 Reply messages to the command:
496 Arguments: (1) <Status Payload> (2) <New ID Payload>
499 This command replies always with <New ID Payload> that is
500 generated by the server every time user changes their nickname.
501 Client receiving this payload MUST start using the received
502 Client ID as its current valid Client ID. The New ID Payload
503 is described in [SILC2]. The <nickname> is the user's new
509 SILC_STATUS_ERR_WILDCARDS
510 SILC_STATUS_ERR_NICKNAME_IN_USE
511 SILC_STATUS_ERR_BAD_NICKNAME
512 SILC_STATUS_ERR_NOT_REGISTERED
513 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
514 SILC_STATUS_ERR_TOO_MANY_PARAMS
520 Arguments: (1) [<Channel ID>]
522 The list command is used to list channels and their topics on the
523 current server. If the <Channel ID> parameter is used, only the
524 status of that channel is displayed. Secret channels are not
525 listed at all. Private channels are listed with status indicating
526 that the channel is private. Router MAY reply with all channels
529 Reply messages to the command:
532 Arguments: (1) <Status Payload> (2) <Channel ID>
533 (3) <channel> (4) [<topic>]
536 This command may reply with several command reply messages to form
537 a list of results. In this case the status payload will include
538 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
539 the last reply to indicate the end of the list. If there are only
540 one reply the status is set to normal STATUS_OK.
542 This command replies with Channel ID, name and the topic of the
543 channel. If the channel is private channel the <topic> SHOULD
544 include the "*private*" string.
549 SILC_STATUS_LIST_START
551 SILC_STATUS_ERR_WILDCARDS
552 SILC_STATUS_ERR_NOT_REGISTERED
553 SILC_STATUS_ERR_TOO_MANY_PARAMS
554 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
555 SILC_STATUS_ERR_NO_CHANNEL_ID
556 SILC_STATUS_ERR_NO_SUCH_SERVER
562 Arguments: (1) <Channel ID> (2) [<topic>]
564 This command is used to change or view the topic of a channel.
565 The topic for channel <Channel ID> is returned if there is no
566 <topic> given. If the <topic> parameter is present, the topic
567 for that channel will be changed, if the channel modes permit
570 After setting the topic the server MUST send the notify type
571 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
572 the channel which topic was changed.
574 Reply messages to the command:
577 Arguments: (1) <Status Payload> (2) <Channel ID>
580 The command may reply with the topic of the channel if it is
586 SILC_STATUS_ERR_NOT_ON_CHANNEL
587 SILC_STATUS_ERR_WILDCARDS
588 SILC_STATUS_ERR_NOT_REGISTERED
589 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
590 SILC_STATUS_ERR_NO_SUCH_CHANNEL
591 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
592 SILC_STATUS_ERR_NO_CHANNEL_ID
593 SILC_STATUS_ERR_BAD_CHANNEL_ID
594 SILC_STATUS_ERR_TOO_MANY_PARAMS
595 SILC_STATUS_ERR_NO_CHANNEL_PRIV
598 7 SILC_COMMAND_INVITE
601 Arguments: (1) <Channel ID> (2) [<Client ID>]
602 (3) [<add | del>] (4) [<invite list>]
604 This command can be used to invite other clients to join to a
605 channel, and to manage the channel's invite list. The <Client
606 ID> argument is the target client's ID that is being invited.
607 The <Channel ID> is the Channel ID of the requested channel.
608 The sender of this command MUST be on the channel. The server
609 MUST also send the notify type SILC_NOTIFY_TYPE_INVITE to its
610 primary router and then to the client indicated by the <Client
613 The <add | del> is an argument of size of 1 byte where 0x00 means
614 adding a client to invite list, and 0x01 means deleting a client
615 from invite list. The <invite list>, if present, indicates
616 the information to be added to or removed from the invite list.
617 It may include a string for matching clients, public key of a
618 client or Client ID of a client. The <invite list> is an
619 Argument List Payload.
621 The following Argument Types has been defined for invite list
624 0x01 - Argument is an invite string of following format:
626 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
628 The <hostname> may also be in format of IP/MASK to indicate
629 a network, for example 10.2.1.0/255.255.0.0.
631 0x02 - Argument is the public key of a client
632 0x03 - Argument is the Client ID of a client
634 If unknown type value is received or there is invalid amount of
635 Argument Payloads present in the list, the command MUST be
636 discarded. When argument that is to be deleted from the invite
637 list does not exist in the list the argument is ignored.
639 When adding to or removing from the invite list the server MUST
640 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router.
641 The client which executes this command MUST have at least channel
642 operator privileges to be able to add to or remove from the invite
643 list. The wildcards MAY be used with this command. When this
644 command is used to invite explicit client with <Client ID> the
645 ID MUST be added to the invite list by the server.
647 When this command is given with only <Channel ID> argument then
648 the command merely returns the invite list of the channel. This
649 command MUST fail if the requested channel does not exist, the
650 requested <Client ID> is already on the channel or if the channel
651 is invite only channel and the caller of this command does not
652 have at least channel operator privileges on the channel.
654 Reply messages to the command:
657 Arguments: (1) <Status Payload> (2) <Channel ID>
660 This command replies with the invite list of the channel if it
666 SILC_STATUS_ERR_NOT_REGISTERED
667 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
668 SILC_STATUS_ERR_TOO_MANY_PARAMS
669 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
670 SILC_STATUS_ERR_NO_CLIENT_ID
671 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
672 SILC_STATUS_ERR_NO_CHANNEL_ID
673 SILC_STATUS_ERR_NOT_ON_CHANNEL
674 SILC_STATUS_ERR_USER_ON_CHANNEL
675 SILC_STATUS_ERR_NO_CHANNEL_PRIV
676 SILC_STATUS_ERR_RESOURCE_LIMIT
682 Arguments: (1) [<quit message>]
684 This command is used by client to end SILC session. The server
685 must close the connection to a client which sends this command.
686 if <quit message> is given it will be sent to other clients on
687 channel if the client is on channel when quitting.
689 Reply messages to the command:
691 This command does not reply anything.
697 Arguments: (1) <Client ID> (2) [<comment>]
700 This command can be used by SILC operators to remove a client from
701 SILC network. It also can be used by a normal client to remove
702 its own client from network by providing correct authentication
705 Router operator killing a client:
707 The removing has temporary effects and client may reconnect to
708 SILC network. The <Client ID> is the client to be removed from SILC.
709 The <comment> argument may be provided to give to the removed client
710 some information why it was removed from the network. The killer
711 MUST have SILC operator privileges.
713 When killing a client the router MUST first send notify type
714 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
715 The packet MUST NOT be sent to the killed client on the channels.
716 Then, the router MUST send the same notify type to its primary
717 router. Finally, the router MUST send the same notify type
718 destined directly to the client which was killed. The killed
719 client MUST also be removed from the invite lists of joined
720 channels if it is explicitly added in the invite lists.
722 Normal client killing by authentication:
724 When normal client executes this command the <Client ID> is the
725 destination client to be removed from the network. The client
726 MUST provide the <auth payload> which includes a digital signature
727 that MUST be verified with the public key of the client indicated
728 by <Client ID>. The <Client ID> MUST be local client to the server.
729 If the signature verification is successful the server sends
730 SILC_NOTIFY_TYPE_SIGNOFF to network and to the destination client.
731 The SILC_NOTIFY_TYPE_KILLED MUST NOT be used in this case. If the
732 verification fails the destination client remains in network.
733 The hash function used in <auth payload> computing is SHA1.
735 Reply messages to the command:
738 Arguments: (1) <Status Payload>
740 This command replies only with Status Payload.
745 SILC_STATUS_ERR_WILDCARDS
746 SILC_STATUS_ERR_NOT_REGISTERED
747 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
748 SILC_STATUS_ERR_TOO_MANY_PARAMS
749 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
750 SILC_STATUS_ERR_NO_CLIENT_ID
751 SILC_STATUS_ERR_NO_ROUTER_PRIV
757 Arguments: (1) [<server>] (2) [<Server ID>]
759 This command is used to fetch various information about a server.
760 If <server> argument is specified the command MUST be sent to
761 the requested server.
763 If the <Server ID> is specified the server information if fetched
764 by the provided Server ID. One of the arguments MUST always be
767 Reply messages to the command:
770 Arguments: (1) <Status Payload> (2) <Server ID>
771 (3) <server name> (4) <string>
773 This command replies with the Server ID of the server and a
774 string which tells the information about the server.
779 SILC_STATUS_ERR_WILDCARDS
780 SILC_STATUS_ERR_NOT_REGISTERED
781 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
782 SILC_STATUS_ERR_TOO_MANY_PARAMS
783 SILC_STATUS_ERR_NO_SUCH_SERVER
784 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
785 SILC_STATUS_ERR_NO_SERVER_ID
788 11 SILC_COMMAND_STATS
791 Arguments: (1) <Server ID>
793 This command is used to fetch various statistical information
794 from the server indicated by <Server ID>, which is the ID of
795 server where sender is connected to. Server receiving this
796 command MAY also send this further to its router for fetching
797 other cell and network wide statistics to accompany the reply.
799 Reply messages to the command:
802 Arguments: (1) <Status Payload> (2) <Server ID>
803 (3) [<statistics structure>]
805 This command replies with the Server ID of the server and
806 optional statistics structure which includes 32 bit MSB first
807 ordered integer values to represent various statistical
808 information. The structure is as follows:
810 starttime - time when server was started
811 uptime - uptime of the server
812 my clients - number of locally connected clients
813 my channels - number of locally created channels
814 my server ops - number of local server operators
815 my router ops - number of local router operators
816 cell clients - number of clients in local cell
817 cell channels - number of channels in local cell
818 cell servers - number of servers in local cell
819 clients - number of client in SILC network
820 channels - number of channels in SILC network
821 servers - number of servers in SILC network
822 routers - number of routers in SILC network
823 server ops - number of server operators in SILC network
824 router ops - number of router operators in SILC network
826 If some value is unknown it is set to zero (0) value. The
827 "starttime" is the start time of the server, and is seconds
828 since Epoch (POSIX.1). The "uptime" is time difference of
829 current time and "starttime" in the server, and is seconds
835 SILC_STATUS_ERR_NOT_REGISTERED
836 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
837 SILC_STATUS_ERR_TOO_MANY_PARAMS
838 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
839 SILC_STATUS_ERR_NO_SUCH_SERVER
840 SILC_STATUS_ERR_NO_SERVER_ID
846 Arguments: (1) <Server ID>
848 This command is used by client and server to test the communication
849 channel to its server if one suspects that the communication is not
850 working correctly. The <Server ID> is the ID of the server the
851 sender is connected to.
853 Reply messages to the command:
856 Arguments: (1) <Status Payload>
858 This command replies only with Status Payload. Server returns
859 SILC_STATUS_OK in Status Payload if pinging was successful.
866 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
867 SILC_STATUS_ERR_TOO_MANY_PARAMS
868 SILC_STATUS_ERR_NO_SERVER_ID
869 SILC_STATUS_ERR_NO_SUCH_SERVER
870 SILC_STATUS_ERR_NOT_REGISTERED
876 Arguments: (1) <username> (2) <authentication payload>
878 This command is used by normal client to obtain server operator
879 privileges on some server or router. Note that router operator
880 has router privileges that supersedes the server operator
881 privileges and this does not obtain those privileges. Client
882 MUST use SILCOPER command to obtain router level privileges.
884 The <username> is the username set in the server configurations
885 as operator. The <authentication payload> is the data that the
886 client is authenticated against. It may be passphrase prompted
887 for user on client's screen or it may be public key authentication
888 based on digital signatures. The public key used to verify the
889 signature should be locally saved in the server, and server should
890 not use public key received during the SKE to verify this signature.
892 After changing the mode the server MUST send the notify type
893 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
895 Reply messages to the command:
898 Arguments: (1) <Status Payload>
900 This command replies only with Status Payload.
905 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
906 SILC_STATUS_ERR_TOO_MANY_PARAMS
907 SILC_STATUS_ERR_NOT_REGISTERED
908 SILC_STATUS_ERR_AUTH_FAILED
914 Arguments: (1) <channel> (2) <Client ID>
915 (3) [<passphrase>] (4) [<cipher>]
916 (5) [<hmac>] (6) [<founder auth>]
919 Join to channel/create new channel. This command is used to
920 join to a channel. If the channel does not exist the channel is
921 created. If server is normal server this command MUST be sent
922 to router which will create the channel. The channel MAY be
923 protected with passphrase. If this is the case the passphrase
924 MUST be sent along the join command.
926 The name of the <channel> MUST NOT include any spaces (` '),
927 non-printable characters, commas (`,') or any wildcard characters.
929 The second argument <Client ID> is the Client ID of the client
930 which is joining to the client. When client sends this command
931 to the server the <Client ID> MUST be the client's own ID.
933 Cipher to be used to secure the traffic on the channel MAY be
934 requested by sending the name of the requested <cipher>. This
935 is used only if the channel does not exist and is created. If
936 the channel already exists the cipher set previously for the
937 channel will be used to secure the traffic. The computed MACs
938 of the channel message are produced by the default HMAC or by
939 the <hmac> provided for the command.
941 The <founder auth> is Authentication Payload providing the
942 authentication for gaining founder privileges on the channel
943 when joining the channel. The client may provide this if it
944 knows that it is the founder of the channel and that the
945 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
946 MUST verify whether the client is able to gain the founder
947 privileges the same way as the client had given the
948 SILC_COMMAND_CUMODE command to gain founder privileges. The
949 client is still able to join the channel even if the founder
950 privileges could not be gained. The hash function used with
951 the <founder payload> MUST be sha1.
953 If the <channel auth> is present and the channel mode
954 SILC_CMODE_CHANNEL_AUTH is set the server MUST verify the
955 <channel auth> with channel public key(s). If public key that
956 can verify <channel auth> does not exist on the channel public
957 key list the client MUST NOT be allowed to join the channel.
958 Because more than one public key may be set on channel the
959 <channel auth> Authentication Payload's Public Data field
960 MUST include an indication of the public key to be used. The
961 first 20 bytes of the Public Data field MUST be SHA-1 digest of
962 the public key that must be used in verification. Rest of the
963 Public Data field are set as defined in [SILC1]. This way server
964 can determine from the digest whether that public key exist on the
965 channel and then use that key in verification. The hash function
966 used with <channel auth> MUST be sha1.
968 The server MUST check whether the user is allowed to join to
969 the requested channel. Various modes set to the channel affect
970 the ability of the user to join the channel. These conditions
973 o The user MUST be invited to the channel if the channel
974 is invite-only channel.
976 o The Client ID/nickname/username/host name/public key
977 MUST NOT match any active bans.
979 o The correct passphrase MUST be provided if passphrase
980 is set to the channel, and/or digital signature verification
981 with channel public key MUST be successful if public keys
982 has been set to the channel.
984 o The user count limit, if set, MUST NOT be reached.
986 If the client provided correct <founder auth> payload it can
987 override these conditions, except the condition for the passphrase.
988 The correct passphrase MUST be provided even if <founder auth>
991 Reply messages to the command:
994 Arguments: (1) <Status Payload> (2) <channel>
995 (3) <Channel ID> (4) <Client ID>
996 (5) <channel mode mask> (6) <created>
997 (7) [<Channel Key Payload>] (8) [<ban list>]
998 (9) [<invite list>] (10) [<topic>]
999 (11) [<hmac>] (12) <list count>
1000 (13) <Client ID list> (14) <client mode list>
1001 (15) [<founder pubkey>]
1003 This command replies with the channel name requested by the
1004 client, channel ID of the channel and topic of the channel
1005 if it exists. The <Client ID> is the Client ID which was joined
1006 to the channel. It also replies with the channel mode mask
1007 which tells all the modes set on the channel. If the channel
1008 is created the mode mask is zero (0) and <created> is 0x01.
1009 If ban mask and/or invite list is set they are sent as well.
1011 The <list count>, <Client ID list> and <client mode list> are
1012 the clients currently on the channel and their modes on the
1013 channel. The <Client ID list> is formed by adding the ID Payloads
1014 one after the other. The <client mode list> is formed by adding
1015 32 bit MSB first order values one after the other. The <founder
1016 pubkey> is the public key (or certificate) of the channel founder.
1018 Client receives the channel key in the reply message as well
1019 inside <Channel Key Payload>.
1024 SILC_STATUS_ERR_WILDCARDS
1025 SILC_STATUS_ERR_NOT_REGISTERED
1026 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1027 SILC_STATUS_ERR_TOO_MANY_PARAMS
1028 SILC_STATUS_ERR_BAD_PASSWORD
1029 SILC_STATUS_ERR_CHANNEL_IS_FULL
1030 SILC_STATUS_ERR_NOT_INVITED
1031 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1032 SILC_STATUS_ERR_BAD_CHANNEL
1033 SILC_STATUS_ERR_USER_ON_CHANNEL
1036 15 SILC_COMMAND_MOTD
1039 Arguments: (1) <server>
1041 This command is used to query the Message of the Day of the server.
1043 Reply messages to the command:
1046 Arguments: (1) <Status Payload> (2) <Server ID>
1049 This command replies with the motd message if it exists.
1054 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1055 SILC_STATUS_ERR_TOO_MANY_PARAMS
1056 SILC_STATUS_ERR_NOT_REGISTERED
1057 SILC_STATUS_ERR_NO_SUCH_SERVER
1060 16 SILC_COMMAND_UMODE
1063 Arguments: (1) <Client ID> (2) [<client mode mask>]
1065 This command is used by client to set/unset modes for itself.
1066 However, there are some modes that the client MUST NOT set itself,
1067 but they will be set by server. However, client MAY unset any
1068 mode. Modes may be masked together ORing them thus having
1069 several modes set. Client MUST keep its client mode mask
1070 locally so that the mode setting/unsetting would work without
1071 problems. Client may change only its own modes.
1073 After changing the mode server MUST send the notify type
1074 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1076 The following client modes are defined:
1078 0x00000000 SILC_UMODE_NONE
1080 No specific mode for client. This is the initial
1081 setting when new client is created. The client is
1082 normal client and is present in the network.
1085 0x00000001 SILC_UMODE_SERVER_OPERATOR
1087 Marks the user as server operator. Client MUST NOT
1088 set this mode itself. Server sets this mode to the
1089 client when client attains the server operator
1090 privileges by SILC_COMMAND_OPER command. Client
1091 MAY unset the mode itself.
1094 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1096 Marks the user as router (SILC) operator. Client
1097 MUST NOT set this mode itself. Router sets this mode
1098 to the client when client attains the router operator
1099 privileges by SILC_COMMAND_SILCOPER command. Client
1100 MAY unset the mode itself.
1103 0x00000004 SILC_UMODE_GONE
1105 Marks that the user is not currently present in the
1106 SILC Network. Client MAY set and unset this mode.
1109 0x00000008 SILC_UMODE_INDISPOSED
1111 Marks that the user is currently indisposed and may
1112 not be able to receive any messages, and that user may
1113 not be present in the network. Client MAY set and
1117 0x00000010 SILC_UMODE_BUSY
1119 Marks that the user is currently busy and may not
1120 want to receive any messages, and that user may not
1121 be present in the network. Client MAY set and unset
1125 0x00000020 SILC_UMODE_PAGE
1127 User is not currently present or is unable to receive
1128 messages, and prefers to be paged in some mechanism
1129 if the user needs to be reached. Client MAY set and
1133 0x00000040 SILC_UMODE_HYPER
1135 Marks that the user is hyper active and is eager to
1136 receive and send messages. Client MAY set and unset
1140 0x00000080 SILC_UMODE_ROBOT
1142 Marks that the client is actually a robot program.
1143 Client MAY set and unset this mode.
1146 0x00000100 SILC_UMODE_ANONYMOUS
1148 Marks that the client is anonymous client. Server
1149 that specifically is designed for anonymous services
1150 can set and unset this mode. Client MUST NOT set or
1151 unset this mode itself. A client with this mode set
1152 would have the username and the hostname information
1153 scrambled by the server which set this mode.
1156 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1158 Marks that the client wishes to block private
1159 messages sent to the client, unless the Private
1160 Message Key flag is set in the SILC packet header.
1161 If this mode is set server MUST NOT deliver private
1162 messages to the client without the Private Message
1163 Key flag being set. The Private Message Key flag set
1164 indicates that the private message is protected with
1165 a key shared between the sender and the recipient.
1167 A separate service could provide additional filtering
1168 features for accepting private messages from certain
1169 sender. However, this document does not specify such
1172 The client MAY set and unset this mode.
1175 0x00000400 SILC_UMODE_DETACHED
1177 Marks that the client is detached from the SILC network.
1178 This means that the actual network connection to the
1179 client is lost but the client entry is still valid. The
1180 detached client can be resumed at a later time. This
1181 mode MUST NOT be set by client. It can only be set when
1182 client has issued command SILC_COMMAND_DETACH. The server
1183 sets this mode. This mode cannot be unset with this
1184 command. It is unset when the client is resuming back to
1185 the network and SILC_PACKET_RESUME_CLIENT packet is
1188 This flag MUST NOT be used to determine whether a packet
1189 can be sent to the client or not. Only the server that
1190 had the original client connection can make the decision
1191 by knowing that the network connection is not active.
1192 In this case the default case is to discard the packet.
1195 0x00000800 SILC_UMODE_REJECT_WATCHING
1197 Marks that the client rejects that it could be watched
1198 by someone else. If this mode is set notifications about
1199 this client is not send, even if someone is watching the
1200 same nickname this client has. Client MAY set and unset
1201 this mode. Any changes for this client MUST NOT be
1202 notified to any watcher when this mode is set.
1204 A separate service could provide additional filtering
1205 features for rejecting and accepting the watching from
1206 certain users. However, this document does not specify
1210 0x00001000 SILC_UMODE_BLOCK_INVITE
1212 Marks that the client wishes to block incoming invite
1213 notifications. Client MAY set and unset this mode.
1214 When set server does not deliver invite notifications
1215 to the client. Note that this mode may make it harder
1216 to join invite-only channels.
1218 If the <client mode mask> was not provided this command merely
1219 returns the mode mask to the client.
1222 Reply messages to the command:
1225 Arguments: (1) <Status Payload> (2) <client mode mask>
1227 This command replies with the changed client mode mask that
1228 the client MUST to keep locally.
1234 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1235 SILC_STATUS_ERR_TOO_MANY_PARAMS
1236 SILC_STATUS_ERR_NOT_REGISTERED
1237 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1238 SILC_STATUS_ERR_BAD_CLIENT_ID
1239 SILC_STATUS_ERR_NOT_YOU
1240 SILC_STATUS_ERR_PERM_DENIED
1241 SILC_STATUS_ERR_UNKNOWN_MODE
1242 SILC_STATUS_ERR_NO_CLIENT_ID
1245 17 SILC_COMMAND_CMODE
1248 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1249 (3) [<user limit>] (4) [<passphrase>]
1250 (5) [<cipher>] (6) [<hmac>]
1251 (7) [<auth payload>] (8) [<founder pubkey>]
1252 (9) [<add | del>] (10) [<channel pubkey>]
1254 This command is used by client to set or change channel flags on
1255 a channel. Channel has several modes that set various properties
1256 of a channel. Modes may be masked together by ORing them thus
1257 having several modes set. The <Channel ID> is the ID of the
1258 target channel. The client changing channel mode MUST be on
1259 the same channel and posses sufficient privileges to be able to
1262 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1263 type MUST be distributed to the channel.
1265 The following channel modes are defined:
1267 0x00000000 SILC_CMODE_NONE
1269 No specific mode on channel. This is the default when
1270 channel is created. This means that channel is just plain
1274 0x00000001 SILC_CMODE_PRIVATE
1276 Channel is private channel. Private channels are shown
1277 in the channel list listed with SILC_COMMAND_LIST command
1278 with indication that the channel is private. Also,
1279 client on private channel will no be detected to be on
1280 the channel as the channel is not shown in the client's
1281 currently joined channel list. Channel founder and
1282 channel operator MAY set/unset this mode.
1285 0x00000002 SILC_CMODE_SECRET
1287 Channel is secret channel. Secret channels are not shown
1288 in the list listed with SILC_COMMAND_LIST command. Secret
1289 channels can be considered to be invisible channels.
1290 Channel founder and channel operator MAY set/unset this
1294 0x00000004 SILC_CMODE_PRIVKEY
1296 Channel uses private channel key to protect the traffic
1297 on the channel. When this mode is set the client will be
1298 responsible to set the key it wants to use to encrypt and
1299 decrypt the traffic on channel. Server generated channel
1300 keys are not used at all. This mode provides additional
1301 security as clients on channel may agree to use private
1302 channel key that even servers do not know. Naturally,
1303 this requires that every client on the channel knows
1304 the key before hand (it is considered to be pre-shared-
1305 key). The key material SHOULD be processed as stated
1306 in the [SILC3] in the section Processing the Key Material.
1308 As it is local setting it is possible to have several
1309 private channel keys on one channel. In this case several
1310 clients can talk on same channel but only those clients
1311 that share the key with the message sender will be able
1312 to hear the talking. Client SHOULD NOT display those
1313 message for the end user that it is not able to decrypt
1314 when this mode is set.
1316 Only channel founder MAY set/unset this mode. If this
1317 mode is unset the server will distribute new channel
1318 key to all clients on the channel which will be used
1322 0x00000008 SILC_CMODE_INVITE
1324 Channel is invite only channel. Client may join to this
1325 channel only if it is invited to the channel. Channel
1326 founder and channel operator MAY set/unset this mode.
1329 0x00000010 SILC_CMODE_TOPIC
1331 The topic of the channel may only be set by client that
1332 is channel founder or channel operator. Normal clients
1333 on channel will not be able to set topic when this mode
1334 is set. Channel founder and channel operator MAY set/
1338 0x00000020 SILC_CMODE_ULIMIT
1340 User limit has been set to the channel. New clients
1341 may not join to the channel when the limit set is
1342 reached. Channel founder and channel operator MAY set/
1343 unset the limit. The <user limit> argument is the
1344 number of limited users.
1347 0x00000040 SILC_CMODE_PASSPHRASE
1349 Passphrase has been set to the channel. Client may
1350 join to the channel only if it is able to provide the
1351 correct passphrase. Setting passphrases to channel
1352 is entirely safe as all commands are protected in the
1353 SILC network. Only channel founder MAY set/unset
1354 the passphrase. The <passphrase> argument is the
1358 0x00000080 SILC_CMODE_CIPHER
1360 Sets specific cipher to be used to protect channel
1361 traffic. The <cipher> argument is the requested cipher.
1362 When set or unset the server must re-generate new
1363 channel key. Only channel founder MAY set the cipher of
1364 the channel. When unset the new key is generated using
1365 default cipher for the channel.
1368 0x00000100 SILC_CMODE_HMAC
1370 Sets specific hmac to be used to compute the MACs of the
1371 channel message. The <hmac> argument is the requested hmac.
1372 Only channel founder may set the hmac of the channel.
1375 0x00000200 SILC_CMODE_FOUNDER_AUTH
1377 Channel founder may set this mode to be able to regain
1378 channel founder rights even if the client leaves the
1379 channel. The <auth payload> is the Authentication Payload
1380 consisting of the public key authentication method and the
1381 digital signature for that method. The passphrase or NONE
1382 authentication methods MUST NOT be accepted.
1384 The server does not save <auth payload> but MUST verify it.
1385 The public key used to verify the payload is the <founder
1386 pubkey> if present, or the public key of the client sending
1387 this command. If <founder pubkey> is present also that
1388 public key MUST be saved as founder's public key. This
1389 mode may be set only if the <auth payload> was verified
1390 successfully. The hash function used with the <auth
1391 payload> MUST be sha1.
1393 The public key of the founder is sent in the
1394 SILC_NOTIFY_TYPE_CMODE_CHANGE notify type so that other
1395 routers and servers in the network may save the public key.
1396 This way the founder can reclaim the founder rights back
1397 to the channel from any server in the network. The founder
1398 rights can be regained by the SILC_CUMODE_FOUNDER channel
1399 user mode, or during joining procedure with the command
1402 If this mode is already set but the <founder pubkey> is
1403 different the new key will replace the old founder key and
1404 the new key is distributed in the network with the
1405 SILC_NOTIFY_TYPE_CMODE_CHANGE notify. Only the original
1406 founder may set this mode multiple times and the client
1407 MUST have SILC_CUMODE_FOUNDER mode on the channel.
1409 When this channel mode is set the channel also becomes
1410 permanent. If all clients leave the channel while this
1411 mode is set the channel MUST NOT be destroyed. The founder
1412 can reclaim the founder mode back on these empty channels
1413 at any time. Implementations MAY limit the number of how
1414 many channels a user can own and how long they remain
1418 0x00000400 SILC_CMODE_SILENCE_USERS
1420 Channel founder may set this mode to silence normal users
1421 on the channel. Users with operator privileges are not
1422 affected by this mode. Messages sent by normal users
1423 are dropped by servers when this mode is set. This mode
1424 can be used to moderate the channel. Only channel founder
1425 may set/unset this mode.
1428 0x00000800 SILC_CMODE_SILENCE_OPERS
1430 Channel founder may set this mode to silence operators
1431 on the channel. When used with SILC_CMODE_SILENCE_USERS
1432 mode this can be used to set the channel in state where only
1433 the founder of the channel may send messages to the channel.
1434 Messages sent by operators are dropped by servers when this
1435 mode is set. Only channel founder may set/unset this mode.
1438 0x00001000 SILC_CMODE_CHANNEL_AUTH
1440 When this mode is set the channel has one or more public keys
1441 or certificates set, and ability to join the channel requires
1442 a client to provide digital signature that can be successfully
1443 verified with one of the channel public keys. This mode is
1444 equivalent to the SILC_MODE_PASSPHRASE except that digital
1445 signatures are used to gain access to the channel. Both
1446 modes MAY be set at the same time. Channel founder may set
1447 and unset this mode.
1449 To add one public key to channel this mode is set and the
1450 <add | del> argument includes 0x00 value, and the <channel
1451 pubkey> is the public key. To remove one public key from
1452 channel public key list the <add | del> includes 0x01 value
1453 and <channel pubkey> is the public key to be removed. To
1454 remove all public keys at once this mode is unset. An
1455 implementation MAY limit the number of public keys that can
1456 be set on the channel. This mode MUST NOT be set if <channel
1457 pubkey> is not present when the mode is set for the first
1461 To make the mode system work, client MUST keep the channel mode
1462 mask locally so that the mode setting and unsetting would work
1463 without problems. The client receives the initial channel mode
1464 mask when it joins to the channel. When the mode changes on
1465 channel the server MUST distribute the changed channel mode mask
1466 to all clients on the channel by sending the notify type
1467 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1468 to the server's primary router. If the <channel mode mask> was
1469 not provided this command merely returns the mode mask to the
1472 Reply messages to the command:
1475 Arguments: (1) <Status Payload> (2) <Channel ID>
1476 (3) <channel mode mask> (4) [<founder pubkey>]
1477 (5) [<channel pubkeys>]
1479 This command replies with the changed channel mode mask that
1480 client MUST keep locally. It may also return the channel
1481 founder's public key if it is set. It may also return list of
1482 channel public keys. The <channel pubkeys> is Argument List
1483 Payload and each argument includes one public key.
1488 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1489 SILC_STATUS_ERR_TOO_MANY_PARAMS
1490 SILC_STATUS_ERR_NOT_REGISTERED
1491 SILC_STATUS_ERR_NOT_ON_CHANNEL
1492 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1493 SILC_STATUS_ERR_BAD_CHANNEL_ID
1494 SILC_STATUS_ERR_NO_CHANNEL_ID
1495 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1496 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1497 SILC_STATUS_ERR_UNKNOWN_MODE
1498 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1499 SILC_STATUS_ERR_AUTH_FAILED
1502 18 SILC_COMMAND_CUMODE
1505 Arguments: (1) <Channel ID> (2) <mode mask>
1506 (3) <Client ID> (4) [<auth payload>]
1508 This command is used by client to change channel user modes on
1509 channel. Users on channel may have some special modes and this
1510 command is used by channel operators to set or change these modes.
1511 The <Channel ID> is the ID of the target channel. The <mode mask>
1512 is OR'ed mask of modes. The <Client ID> is the target client.
1513 The client changing channel user modes MUST be on the same channel
1514 as the target client and posses sufficient privileges to be able to
1517 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1518 type is distributed to the channel.
1520 The following channel modes are defined:
1522 0x00000000 SILC_CUMODE_NONE
1524 No specific mode. This is the normal situation for client.
1525 Also, this is the mode set when removing all modes from
1529 0x00000001 SILC_CUMODE_FOUNDER
1531 The client is channel founder of the channel. Usually this
1532 mode is set only by the server when the channel was created.
1533 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1534 been set, the client can claim channel founder privileges
1535 by providing the <auth payload> that the server will use
1536 to authenticate the client. The public key that server will
1537 use to verify the <auth payload> MUST be the same public key
1538 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1539 mode was set. The client MAY remove this mode at any time.
1542 0x00000002 SILC_CUMODE_OPERATOR
1544 Sets channel operator privileges on the channel for a
1545 client on the channel. Channel founder and channel operator
1546 MAY set/unset this mode. The client MAY remove this mode
1550 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1552 Marks that the client wishes not to receive any channel
1553 messages sent for the channel. Client MAY set and unset
1554 this mode to itself. Client MUST NOT set it to anyone else.
1555 When this mode is set server MUST NOT deliver channel
1556 messages to this client. Other packets such as channel
1557 key packets are still sent to the client.
1559 A separate service could provide additional filtering
1560 features for accepting channel messages from certain
1561 sender. However, this document does not specify such
1565 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1567 Marks that the client wishes not to receive any channel
1568 messages sent from normal users. Only messages sent by
1569 channel founder or channel operator is accepted. Client
1570 MAY set and unset this mode to itself. Client MUST NOT
1571 set it to anyone else. When this mode is set server MUST
1572 NOT deliver channel messages that are sent by normal users
1575 A separate service could provide additional filtering
1576 features for accepting channel messages from certain
1577 sender. However, this document does not specify such
1581 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1583 Marks that the client wishes not to receive any channel
1584 messages sent from robots. Messages sent by users with
1585 the SILC_UMODE_ROBOT user mode set are not delivered.
1586 Client MAY set and unset this mode to itself. Client MUST
1587 NOT set it to anyone else. When this mode is set server
1588 MUST NOT deliver channel messages that are sent by robots
1592 0x00000020 SILC_CUMODE_QUIET
1594 Marks that the client cannot talk on the channel. This
1595 mode can be set by channel operator or channel founder to
1596 some other user that is not operator or founder. The
1597 target client MUST NOT unset this mode. When this mode
1598 is set the server MUST drop messages sent by this client
1602 Reply messages to the command:
1605 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1606 (3) <Channel ID> (4) <Client ID>
1608 This command replies with the changed channel user mode mask that
1609 client MUST keep locally. The <Channel ID> is the specified
1610 channel. The <Client ID> is the target client.
1615 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1616 SILC_STATUS_ERR_TOO_MANY_PARAMS
1617 SILC_STATUS_ERR_NOT_REGISTERED
1618 SILC_STATUS_ERR_NOT_ON_CHANNEL
1619 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1620 SILC_STATUS_ERR_BAD_CHANNEL_ID
1621 SILC_STATUS_ERR_NO_CHANNEL_ID
1622 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1623 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1624 SILC_STATUS_ERR_UNKNOWN_MODE
1625 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1626 SILC_STATUS_ERR_AUTH_FAILED
1629 19 SILC_COMMAND_KICK
1632 Arguments: (1) <Channel ID> (2) <Client ID>
1635 This command is used by channel operators to remove a client from
1636 channel. The <channel> argument is the channel the client to be
1637 removed is on currently. Note that the "kicker" must be on the same
1638 channel. If <comment> is provided it will be sent to the removed
1641 After kicking the client the server MUST send the notify type
1642 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1643 The client is removed from the channel after sending this notify.
1644 The kicked client MUST be removed from the invite list of the
1645 channel if it is explicitly added in the list. The channel key
1646 MUST also be re-generated after kicking, unless the
1647 SILC_CMODE_PRIVKEY mode is set.
1649 Reply messages to the command:
1652 Arguments: (1) <Status Payload>
1654 This command replies only with Status Payload.
1659 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1660 SILC_STATUS_ERR_TOO_MANY_PARAMS
1661 SILC_STATUS_ERR_NOT_REGISTERED
1662 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1663 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1664 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1665 SILC_STATUS_ERR_NO_CLIENT_ID
1672 Arguments: (1) <Channel ID> (2) [<add | del>]
1675 This command is used to manage the ban list of the channel
1676 indicated by the <Channel ID>. A client that is banned from
1677 channel is no longer able to join the channel. The client which
1678 is executing this command MUST have at least channel operator
1679 privileges on the channel.
1681 The <add | del> is an argument of size of 1 byte where 0x00 means
1682 adding a client to ban list, and 0x01 means deleting a client
1683 from ban list. The <ban list>, if present, indicates the
1684 information to be added to or removed from the ban list. It
1685 may include a string for matching clients, public key of a
1686 client or Client ID of a client. The <ban list> is an Argument
1689 The following Argument Types has been defined for ban list
1692 0x01 - Argument is an ban string of following format:
1694 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
1696 The <hostname> may also be in format of IP/MASK to indicate
1699 0x02 - Argument is the public key of a client
1700 0x03 - Argument is the Client ID of a client
1702 If unknown type value is received or there is invalid amount of
1703 Argument Payloads present in the list, the command MUST be
1704 discarded. When argument that is to be deleted from the ban
1705 list does not exist in the list the argument is ignored.
1707 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1708 primary router after adding to or removing from the ban list.
1709 The wildcards MAY be used with this command. If this command
1710 is executed without the ban arguments the command merely replies
1711 with the current ban list.
1713 Reply messages to the command:
1716 Arguments: (1) <Status Payload> (2) <Channel ID>
1719 This command replies with the <Channel ID> of the channel and
1720 the current <ban list> of the channel if it exists.
1725 SILC_STATUS_ERR_NOT_REGISTERED
1726 SILC_STATUS_ERR_TOO_MANY_PARAMS
1727 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1728 SILC_STATUS_ERR_NO_CHANNEL_ID
1729 SILC_STATUS_ERR_NOT_ON_CHANNEL
1730 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1731 SILC_STATUS_ERR_RESOURCE_LIMIT
1736 21 SILC_COMMAND_DETACH
1741 This command is used to detach from the network. Client can
1742 send this command to its server to indicate that it will be
1743 detached. By detaching the client remains in the network but
1744 the actual network connection to the server is closed. The
1745 client may then later resume the old session back.
1747 When this command is received the server MUST check that the
1748 client is locally connected client, and set the user mode
1749 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1750 MUST be also sent to routers. The server then sends command
1751 reply to this command and closes the network connection.
1752 The server MUST NOT remove the client from its lists, or send
1753 any signoff notifications for this client. See the [SILC1]
1754 for detailed information about detaching.
1756 Reply messages to the command:
1759 Arguments: (1) <Status Payload>
1761 This command replies only with the status indication.
1766 SILC_STATUS_ERR_NOT_REGISTERED
1770 22 SILC_COMMAND_WATCH
1773 Arguments: (1) <Client ID> (2) [<add nickname>]
1774 (3) [<del nickname>]
1776 This command is used to set up a watch for <add nickname>
1777 nickname. When a user in the network appears with the
1778 nickname, or signoffs the network or user's mode is changed
1779 the client which set up the watch will be notified about
1780 this change. This can be used to watch for certain nicknames
1781 in the network and receive notifications when for example a
1782 friend appears in the network or leaves the network.
1784 The <del nickname> is a nickname that has been previously
1785 added to watch list and is now removed from it. Notifications
1786 for that nickname will not be delivered anymore.
1788 The <Client ID> is the Client ID of the sender of this command.
1790 The nickname set to watch MUST NOT include any wildcards.
1791 Note also that a nickname may match several users since
1792 nicknames are not unique. Implementations MAY set limits
1793 for how many nicknames client can watch.
1795 When normal server receives this command from client it
1796 MUST send it to its router. Router will process the command
1797 and actually keeps the watch list.
1799 Reply messages to the command:
1802 Arguments: (1) <Status Payload>
1804 This command replies only with the status indication.
1809 SILC_STATUS_ERR_NOT_REGISTERED
1810 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1811 SILC_STATUS_ERR_TOO_MANY_PARAMS
1812 SILC_STATUS_ERR_BAD_NICKNAME
1813 SILC_STATUS_ERR_WILDCARDS
1814 SILC_STATUS_ERR_RESOURCE_LIMIT
1815 SILC_STATUS_ERR_NO_SUCH_NICK
1816 SILC_STATUS_ERR_NICKNAME_IN_USE
1819 23 SILC_COMMAND_SILCOPER
1822 Arguments: (1) <username> (2) <authentication payload>
1824 This command is used by normal client to obtain router operator
1825 privileges (also known as SILC operator) on the router. Note
1826 that router operator has privileges that supersedes the server
1827 operator privileges.
1829 The <username> is the username set in the server configurations
1830 as operator. The <authentication payload> is the data that the
1831 client is authenticated against. It may be passphrase prompted
1832 for user on client's screen or it may be public key or certificate
1833 authentication data (data signed with private key). The public
1834 key that router will use to verify the signature found in the
1835 payload should be verified. It is recommended that the public
1836 key is saved locally in the router and router would not use
1837 any public keys received during the SKE.
1839 Difference between router operator and server operator is that
1840 router operator is able to handle cell level properties while
1841 server operator (even on router server) is able to handle only
1842 local properties, such as, local connections and normal server
1843 administration. The router operator is also able to use the
1844 SILC_COMMAND_KILL command.
1846 After changing the mode server MUST send the notify type
1847 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1849 Reply messages to the command:
1852 Arguments: (1) <Status Payload>
1854 This command replies only with Status Payload.
1859 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1860 SILC_STATUS_ERR_TOO_MANY_PARAMS
1861 SILC_STATUS_ERR_NOT_REGISTERED
1862 SILC_STATUS_ERR_AUTH_FAILED
1867 24 SILC_COMMAND_LEAVE
1870 Arguments: (1) <Channel ID>
1872 This command is used by client to leave a channel the client is
1875 When leaving channel the server MUST send the notify type
1876 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1877 The channel key MUST also be re-generated when leaving the channel
1878 and distribute it to all clients still currently on the channel.
1879 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1882 Reply messages to the command:
1885 Arguments: (1) <Status Payload> (2) <Channel ID>
1887 The <Channel ID> is the ID of left channel.
1892 SILC_STATUS_ERR_NOT_REGISTERED
1893 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1894 SILC_STATUS_ERR_TOO_MANY_PARAMS
1895 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1896 SILC_STATUS_ERR_BAD_CHANNEL_ID
1897 SILC_STATUS_ERR_NO_CHANNEL_ID
1900 25 SILC_COMMAND_USERS
1903 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1905 This command is used to list user names currently on the requested
1906 channel; either the argument <Channel ID> or the <channel name>.
1907 One of these arguments must be present. The server MUST resolve
1908 the joined clients and reply with a lists of users on the channel
1909 and with list of user modes on the channel.
1911 If the requested channel is a private or secret channel, this
1912 command MUST NOT send the list of users, except if the sender is
1913 on the channel, or the sender is a server. Otherwise, error is
1914 returned to the sender.
1916 Reply messages to the command:
1919 Arguments: (1) <Status Payload> (2) <Channel ID>
1920 (3) <list count> (4) <Client ID list>
1921 (5) <client mode list>
1923 This command replies with the Channel ID of the requested channel
1924 Client ID list of the users on the channel and list of their modes.
1925 The Client ID list has Client ID's of all users in the list. The
1926 <Client ID list> is formed by adding Client ID's one after another.
1927 The <client mode list> is formed by adding client's user modes on
1928 the channel one after another (4 bytes (32 bits) each). The <list
1929 count> of length of 4 bytes (32 bits), tells the number of entries
1930 in the lists. Both lists MUST have equal number of entries.
1935 SILC_STATUS_ERR_NOT_REGISTERED
1936 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1937 SILC_STATUS_ERR_TOO_MANY_PARAMS
1938 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1939 SILC_STATUS_ERR_BAD_CHANNEL_ID
1940 SILC_STATUS_ERR_NO_CHANNEL_ID
1941 SILC_STATUS_ERR_NOT_ON_CHANNEL
1944 26 SILC_COMMAND_GETKEY
1947 Arguments: (1) <ID Payload>
1949 This command is used to fetch the public key of the client or
1950 server indicated by the <ID Payload>. The public key is fetched
1951 from the server where to the client is connected.
1953 Reply messages to the command:
1956 Arguments: (1) <Status Payload> (2) <ID Payload>
1957 (3) [<Public Key Payload>]
1959 This command replies with the client's or server's ID and with
1960 the <Public Key Payload>.
1965 SILC_STATUS_ERR_NOT_REGISTERED
1966 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1967 SILC_STATUS_ERR_TOO_MANY_PARAMS
1968 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1969 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1972 27 SILC_COMMAND_SERVICE
1975 Arguments: (1) [<service name>] (2) [<auth payload>]
1978 This command is used to negotiate a service agreement with a
1979 remote server. If this command is given without arguments it
1980 MAY return the service list, if it is publicly available. The
1981 <service name> is a service specific identifier, and the
1982 <auth payload> MAY be used to authenticate the requester to the
1983 remote service. The authentication to a service may be based
1984 on previous agreement with the requester and the service
1985 provider. The command MAY also take additional service
1988 This document does not specify any services. How the services
1989 are configured and put available in a server is also out of
1990 scope of this document.
1992 This command MAY be used by client to start using some service
1993 in a server, but it also MAY be used by server to negotiate
1994 to start using a service in some other server or router.
1996 After the negotiation is done both of the parties need to know
1997 from the service identifier how the service can be used. The
1998 service can be considered to be a protocol which both of the
1999 parties need to support.
2001 Reply messages to the command:
2004 Arguments: (1) <Status Payload> (2) [<service list>]
2005 (3) [<service name>] (n) [...]
2008 This command MAY reply with the <service list> when command is
2009 given without arguments, and the list is a comma separated list
2010 of service identifiers. The <service name> is the service that
2011 the sender requested and this is provided when the server has
2012 accepted the sender to use the <service name>. The command
2013 reply MAY also have additional service specific arguments.
2018 SILC_STATUS_ERR_NOT_REGISTERED
2019 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2020 SILC_STATUS_ERR_TOO_MANY_PARAMS
2021 SILC_STATUS_ERR_NO_SUCH_SERVICE
2022 SILC_STATUS_ERR_AUTH_FAILED
2023 SILC_STATUS_ERR_PERM_DENIED
2029 Currently undefined commands.
2034 These commands are reserved for private use and will not be defined
2038 255 SILC_COMMAND_MAX
2040 Reserved command. This must not be sent.
2045 2.4 SILC Command Status Payload
2047 Command Status Payload is sent in command reply messages to indicate
2048 the status of the command. The payload is one of argument in the
2049 command thus this is the data area in Command Argument Payload described
2050 in [SILC2]. The payload is only 2 bytes in length. The following
2051 diagram represents the Command Status Payload (fields are always in
2058 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
2059 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2061 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
2065 Figure 6: SILC Command Status Payload
2069 o Status (1 byte) - Indicates the status message type,
2070 error, start of list, entry of list or end of list.
2072 o Error (1 byte) - Indicates the error if the Status
2073 field is some list status, which means there are list
2077 The values in Status and Error fields are set according
2078 the following rules:
2081 o If there is single reply and error has not occurred
2082 then Status field includes value SILC_STATUS_OK, and
2083 the Error field MUST be ignored (and set to zero
2086 o If there is single error, then Status field includes
2087 one of the error values, and the Error field MUST be
2088 ignored (and set to zero value).
2090 o If there will be multiple successful command replies
2091 then Status field includes SILC_STATUS_LIST_START,
2092 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
2093 and Error field is set to SILC_STATUS_OK.
2095 o If there are multiple error replies then Status field
2096 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
2097 or SILC_STATUS_LIST_END value, and the Error field
2098 includes the error value.
2101 This way it is possible to send single successful or
2102 single error reply, but also multiple successful and
2103 multiple error replies. Note that it is possible to
2104 send both list of successful replies and list of error
2105 replies at the same time, however in this case the
2106 list of error replies MUST be sent after the successful
2107 replies. This way the recipient may ignore the multiple
2108 errors if it wishes to do so. Also note that in this
2109 case the successful and error replies belong to the
2112 All Status messages are described in the next section.
2118 Status messages are returned in SILC protocol in command reply
2119 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
2120 the command reply packet and status types are sent inside the
2121 Status Payload as one of command reply argument, as defined in
2122 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
2123 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
2124 types defined in this section are used in both cases.
2126 When returning status messages in the command reply message they
2127 indicate whether the command was executed without errors. If error
2128 occurred the status indicates which error occurred.
2130 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
2131 they always send some error status. Usually they are sent to
2132 indicate that error occurred while processing some SILC packet.
2133 Please see the [SILC1] and [SILC2] for more information sending
2134 status types in SILC_NOTIFY_TYPE_ERROR notify.
2136 The Status Types are only numeric values and the receiver must
2137 convert the numeric values into human readable messages if this
2138 is desired in the application.
2140 List of all defined status types:
2143 Generic status messages:
2147 Ok status. Everything went Ok. The status payload maybe
2148 safely ignored in this case.
2150 1 SILC_STATUS_LIST_START
2152 Start of the list. There will be several command replies and
2153 this reply is the start of the list.
2155 2 SILC_STATUS_LIST_ITEM
2157 Item in the list. This is one of the item in the list but not the
2160 3 SILC_STATUS_LIST_END
2162 End of the list. There were several command replies and this
2163 reply is the last of the list. There won't be other replies
2164 belonging to this list after this one.
2168 Currently undefined and has been reserved for the future.
2171 Error status message:
2175 10 SILC_STATUS_ERR_NO_SUCH_NICK
2177 "No such nickname". Requested nickname does not exist.
2179 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2181 "No such channel". Requested channel name does not exist.
2183 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2185 "No such server". Requested server name does not exist.
2187 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2189 "Incomplete registration information". Information remote
2190 sent was incomplete.
2192 14 SILC_STATUS_ERR_NO_RECIPIENT
2194 "No recipient given". Command required recipient which was
2197 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2199 "Unknown command". Command sent to server is unknown by the
2202 16 SILC_STATUS_ERR_WILDCARDS
2204 "Wildcards cannot be used". Wildcards were provided but they
2207 17 SILC_STATUS_ERR_NO_CLIENT_ID
2209 "No Client ID given". Client ID were expected as command
2210 parameter but were not found.
2212 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2214 "No Channel ID given". Channel ID were expected as command
2215 parameter but were not found.
2217 19 SILC_STATUS_ERR_NO_SERVER_ID
2219 "No Serve ID given". Server ID were expected as command
2220 parameter but were not found.
2222 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2224 "Bad Client ID". Client ID provided were erroneous.
2226 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2228 "Bad Channel ID". Channel ID provided were erroneous.
2230 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2232 "No such Client ID". Client ID provided does not exist.
2233 The unknown Client ID MUST be provided as next argument
2236 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2238 "No such Channel ID". Channel ID provided does not exist.
2239 The unknown Channel ID MUST be provided as next argument
2242 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2244 "Nickname already exists". Nickname created could not be
2245 registered because number of same nicknames were already set to
2246 maximum. This is not expected to happen in real life but is
2249 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2251 "You are not on that channel". The command were specified for
2252 channel user is not currently on.
2254 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2256 "They are not on channel". The requested target client is not
2257 on requested channel.
2259 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2261 "User already on channel". User were invited on channel they
2264 28 SILC_STATUS_ERR_NOT_REGISTERED
2266 "You have not registered". User executed command that requires
2267 the client to be registered on the server before it may be
2270 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2272 "Not enough parameters". Command requires more parameters
2275 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2277 "Too many parameters". Too many parameters were provided
2280 31 SILC_STATUS_ERR_PERM_DENIED
2282 "Permission denied". Generic permission denied error status
2283 to indicate disallowed access.
2285 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2287 "You are banned from this server". The client tried to register
2288 on server that has explicitly denied this host to connect.
2290 33 SILC_STATUS_ERR_BAD_PASSWORD
2292 "Cannot join channel. Incorrect password". Password provided for
2293 channel were not accepted.
2295 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2297 "Cannot join channel. Channel is full". The channel is full
2298 and client cannot be joined to it.
2300 35 SILC_STATUS_ERR_NOT_INVITED
2302 "Cannot join channel. You have not been invited". The channel
2303 is invite only channel and client has not been invited.
2305 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2307 "Cannot join channel. You have been banned". The client has
2308 been banned from the channel.
2310 37 SILC_STATUS_ERR_UNKNOWN_MODE
2312 "Unknown mode". Mode provided by the client were unknown to
2315 38 SILC_STATUS_ERR_NOT_YOU
2317 "Cannot change mode for other users". User tried to change
2318 someone else's mode.
2320 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2322 "Permission denied. You are not channel operator". Command may
2323 be executed only by channel operator.
2325 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2327 "Permission denied. You are not channel founder". Command may
2328 be executed only by channel operator.
2330 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2332 "Permission denied. You are not server operator". Command may
2333 be executed only by server operator.
2335 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2337 "Permission denied. You are not SILC operator". Command may be
2338 executed only by router (SILC) operator.
2340 43 SILC_STATUS_ERR_BAD_NICKNAME
2342 "Bad nickname". Nickname requested contained illegal characters
2345 44 SILC_STATUS_ERR_BAD_CHANNEL
2347 "Bad channel name". Channel requested contained illegal characters
2350 45 SILC_STATUS_ERR_AUTH_FAILED
2352 "Authentication failed". The authentication data sent as
2353 argument were wrong and thus authentication failed.
2355 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2357 "The algorithm was not supported." The server does not support the
2358 requested algorithm.
2360 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2362 "No such Server ID". Server ID provided does not exist.
2363 The unknown Server ID MUST be provided as next argument
2366 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2368 "No more resources available". This can mean that server cannot
2369 or will not accept something due to resource limitations.
2371 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2373 "Service does not exist". Requested service identifier is
2376 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2378 "You have not been authenticated". Remote connection is not
2379 authenticated even though it is supposed to be.
2381 51 SILC_STATUS_ERR_BAD_SERVER_ID
2383 "Server ID is not valid". Provided server ID is not valid.
2385 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2387 "Key exchange failed". Key Exchange protocol failed.
2389 53 SILC_STATUS_ERR_BAD_VERSION
2391 "Bad version". Protocol or software version mismatch.
2393 54 SILC_STATUS_ERR_TIMEDOUT
2395 "Operation timed out". Operation or service request timed
2396 out, and thus was not processed.
2398 55 SILC_STATUS_ERR_UNSUPPORTED_PUBLIC_KEY
2400 "Unsupported public key type". The public key or certificate
2401 type is not supported in this implementation.
2403 56 SILC_STATUS_ERR_OPERATION_ALLOWED
2405 "Operation is not allowed". A operation, for example a command,
2406 is not allowed or it's execution is not allowed.
2413 4 Security Considerations
2415 Security is central to the design of this protocol, and these security
2416 considerations permeate the specification. Common security considerations
2417 such as keeping private keys truly private and using adequate lengths for
2418 symmetric and asymmetric keys must be followed in order to maintain the
2419 security of this protocol.
2425 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2426 Protocol Specification", Internet Draft, May 2002.
2428 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2431 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2432 Protocols", Internet Draft, May 2002.
2434 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2437 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2440 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2443 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2446 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2449 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2452 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2455 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2458 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2459 Infrastructure, Certificate and CRL Profile", RFC 2459,
2462 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2463 John Wiley & Sons, New York, NY, 1996.
2465 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2468 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2469 RFC 2412, November 1998.
2471 [ISAKMP] Maughan D., et al, "Internet Security Association and
2472 Key Management Protocol (ISAKMP)", RFC 2408, November
2475 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2476 (IKE)", RFC 2409, November 1998.
2478 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2479 Authentication", RFC 2104, February 1997.
2481 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2482 Specifications, Version 2.0", RFC 2437, October 1998.
2484 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2485 Requirement Levels", BCP 14, RFC 2119, March 1997.
2487 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2488 10646", RFC 2279, January 1998.
2490 [ATTRS] Riikonen, P., "User Online Presence and Information
2491 Attributes", Internet Draft, May 2002.
2499 Snellmaninkatu 34 A 15
2503 EMail: priikone@iki.fi
2509 This appendix defines the usage of the <Requested Attributes> argument in
2510 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2511 and may be used to request additional information about the user. Since
2512 the information that may be requested using the attributes is something
2513 that server cannot deliver to the sender, it is possible to send the WHOIS
2514 command directly to the destination client whom will then provide the
2515 requested attributes. This requires the servers to relay the WHOIS
2516 command to the client, and it requires capability for handling the WHOIS
2517 command in the client end.
2519 The <Requested Attributes> MAY include several attributes that are
2520 requested. The format and encoding of the <Requested Attributes> is as
2521 defined in [ATTRS]. When <Requested Attributes> argument is set the
2522 server MAY process the attributes to see whether it can narrow down
2523 the WHOIS search, for example when searching with a nickname. The
2524 normal servers MUST process the WHOIS command as normal WHOIS command,
2525 that is to send the command directly to the router. The router MAY
2526 process the attributes, but it MUST send the command to the server
2527 that owns the requested client.
2529 The server that owns the client and receives the command MUST check
2530 whether the client is detached from the network. If it is detached,
2531 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2532 process the attributes and provide as many of the requested attributes
2533 as possible and then send reply back to the sender. If the client is
2534 active in the network it MUST send the command to the client for
2537 The client receiving WHOIS command SHOULD check whether the
2538 <Requested Attributes> argument is set. If it is not set then the
2539 WHOIS command SHOULD be discarded. The client processes the requested
2540 attributes and SHOULD reply to each of the requested attribute with
2541 either valid value, or with an indication that the requested attribute
2542 is not known or supported. This is to be done as defined in [ATTRS].
2543 The client always MUST send a reply to the command when some attributes
2544 were requested. The client MAY also add additional attributes to the
2545 reply even if they were not requested. The client MAY also digitally
2546 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2547 in [ATTRS]. Then the client sends the reply back to the sender of
2548 the command. The command reply that client assembles does not need
2549 to include any other argument but the <Status Payload> (1), and the
2550 <Attributes> (11). The server receiving reply from client MUST allow
2551 this sort of command reply for WHOIS command.
2553 The information received from the client MAY be cached in the
2554 server's end. The caching may be desired for example if the client
2555 can be detached from the network. This way the server is then able
2556 to provide at least partial information for a requester. The
2557 server MAY also process the command reply and verify whether the
2558 attributes provided in the reply are actually valid. If it can do
2559 this, and verify that they indeed are valid values it MAY append
2560 a digital signature at the end of the attributes with the
2561 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2562 server then MUST provide valid WHOIS command reply to the sender
2563 of the command. Other servers and routers that receive the command
2564 reply en route to the original sender MAY also cache the information.
2566 The client which receives the command reply to the WHOIS command
2567 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2568 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
2572 Full Copyright Statement
2574 Copyright (C) The Internet Society (2003). All Rights Reserved.
2576 This document and translations of it may be copied and furnished to
2577 others, and derivative works that comment on or otherwise explain it
2578 or assist in its implementation may be prepared, copied, published
2579 and distributed, in whole or in part, without restriction of any
2580 kind, provided that the above copyright notice and this paragraph are
2581 included on all such copies and derivative works. However, this
2582 document itself may not be modified in any way, such as by removing
2583 the copyright notice or references to the Internet Society or other
2584 Internet organizations, except as needed for the purpose of
2585 developing Internet standards in which case the procedures for
2586 copyrights defined in the Internet Standards process must be
2587 followed, or as required to translate it into languages other than
2590 The limited permissions granted above are perpetual and will not be
2591 revoked by the Internet Society or its successors or assigns.
2593 This document and the information contained herein is provided on an
2594 "AS IS" basis and THE INTERNET SOCIETY AND THE INTERNET ENGINEERING
2595 TASK FORCE DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING
2596 BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION
2597 HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF
2598 MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
projects / silc.git / blob