8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-03.txt XXX
26 <draft-riikonen-silc-commands-03.txt>
31 This document is an Internet-Draft and is in full conformance with
32 all provisions of Section 10 of RFC 2026. Internet-Drafts are
33 working documents of the Internet Engineering Task Force (IETF), its
34 areas, and its working groups. Note that other groups may also
35 distribute working documents as Internet-Drafts.
37 Internet-Drafts are draft documents valid for a maximum of six months
38 and may be updated, replaced, or obsoleted by other documents at any
39 time. It is inappropriate to use Internet-Drafts as reference
40 material or to cite them other than as "work in progress."
42 The list of current Internet-Drafts can be accessed at
43 http://www.ietf.org/ietf/1id-abstracts.txt
45 The list of Internet-Draft Shadow Directories can be accessed at
46 http://www.ietf.org/shadow.html
48 The distribution of this memo is unlimited.
54 This memo describes the commands used in the Secure Internet Live
55 Conferencing (SILC) protocol, specified in the Secure Internet Live
56 Conferencing, Protocol Specification Internet Draft [SILC1]. The
57 SILC Commands are very important part of the SILC protocol. Usually
58 the commands are used by SILC clients to manage the SILC session, but
59 also SILC servers may use the commands. This memo specifies detailed
60 command messages and command reply messages.
73 1 Introduction .................................................. 2
74 1.1 Requirements Terminology .................................. 2
75 2 SILC Commands ................................................. 2
76 2.1 SILC Commands Syntax ...................................... 2
77 2.2 SILC Commands List ........................................ 4
78 2.3 SILC Command Status Payload ............................... 33
79 3 SILC Status Types ............................................. 33
80 4 Security Considerations ....................................... 38
81 5 References .................................................... 38
82 6 Author's Address .............................................. 40
83 Appendix A ...................................................... xx
89 This document describes the commands used in the Secure Internet Live
90 Conferencing (SILC) protocol, specified in the Secure Internet Live
91 Conferencing, Protocol Specification Internet Draft [SILC1]. This
92 document specifies detailed command messages and command reply messages.
94 Commands are very important part on SILC network especially for client
95 which uses commands to operate on the SILC network. Commands are used
96 to set nickname, join to channel, change modes and many other things.
98 See the [SILC1] for the requirements and the restrictions for the usage
99 of the SILC commands. The [SILC2] defines the command packet type and
100 the Command Payload which is actually used to deliver the commands and
101 command reply messages.
105 1.1 Requirements Terminology
107 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
108 MAY, and OPTIONAL, when they appear in this document, are to be
109 interpreted as described in [RFC2119].
116 2.1 SILC Commands Syntax
118 This section briefly describes the syntax of the command notions
119 in this document. Every field in command is separated from each
120 other by whitespaces (` ') indicating that each field is independent
121 argument and each argument MUST have own Command Argument Payload.
122 The number of maximum arguments are defined with each command
123 separately. The Command Argument Payload is described in [SILC2].
125 Every command defines specific number for each argument. Currently,
126 they are defined in ascending order; first argument has number one
127 (1), second has number two (2) and so on. This number is set into the
128 Argument Type field in the Command Argument Payload. This makes it
129 possible to send the arguments in free order as the number MUST be
130 used to identify the type of the argument. This makes is it also
131 possible to have multiple optional arguments in commands and in
132 command replies. The number of argument is marked in parentheses
133 before the actual argument.
138 Example: Arguments: (1) <nickname> (2) <username@host>
142 Every command replies with Status Payload. This payload tells the
143 sender of the command whether the command was completed successfully or
144 whether there was an error. If error occurred the payload includes the
145 error type. In the next section the Status Payload is not described
146 as it is common to all commands and has been described here. Commands
147 MAY reply with other arguments as well. These arguments are command
148 specific and are described in the next section.
157 Arguments: (1) <nickname>[@<server>] (2) <message>
160 The command has maximum of 3 arguments. However, only first
161 and second arguments are mandatory.
163 First argument <nickname> is mandatory but may have optional
164 <nickname@server> format as well. Second argument is mandatory
165 <message> argument. Third argument is optional <count> argument.
167 The numbers in parentheses are the argument specific numbers
168 that specify the type of the argument in Command Argument Payload.
169 The receiver always knows that, say, argument number two (2) is
170 <message> argument, regardless of the ordering of the arguments in
173 Reply messages to the command:
176 Arguments: (1) <Status Payload> (2) [<channel list>]
177 (3) <idle time> (4) [<away message>]
179 This command may reply with maximum of 4 arguments. However,
180 only the first and third arguments are mandatory. The numbers
181 in the parentheses have the same meaning as in the upper
182 command sending specification.
184 Every command reply with <Status Payload>, it is mandatory
185 argument for all command replies and for this reason it is not
186 described in the command reply descriptions.
193 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
194 SILC_STATUS_ERR_NO_SUCH_NICK
196 Every command reply also defines set of status message that it
197 may return inside the <Status Payload>. All status messages
198 are defined in the section 2.3 SILC Command Status Payload
201 Every command that has some kind of ID as argument (for example
202 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
203 the type of the ID, length of the ID and the actual ID data. This
204 way variable length ID's can be sent as arguments. Also note that
205 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
210 2.2 SILC Commands List
212 This section lists all SILC commands, however, it is expected that a
213 implementation and especially client implementation has many more
214 commands that has only local affect. These commands are official
215 SILC commands that has both client and server sides and cannot be
216 characterized as local commands.
218 List of all defined commands in SILC follows.
223 None. This is reserved command and MUST NOT be sent.
229 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
230 (3) [<Requested Attributes>] (4) [<Client ID>]
233 Whois command is used to query various information about specific
234 user. The user may be requested by their nickname and server name.
235 The query may find multiple matching users as there are no unique
236 nicknames in the SILC. The <count> option may be given to narrow
237 down the number of accepted results. If this is not defined there
238 are no limit of accepted results. The query may also be narrowed
239 down by defining the server name of the nickname. The <count> is
240 32 bit MSB first order integer.
242 It is also possible to search the user by Client ID. If the
243 <Client ID> is provided server MUST use it as the search value
244 instead of the <nickname>. One of the arguments MUST be given.
245 It is also possible to define multiple Client ID's to search
246 multiple users sending only one WHOIS command. In this case the
247 Client ID's are appended as normal arguments.
249 To prevent miss-use of this command wildcards in the nickname
250 or in the server name are not permitted. It is not allowed
251 to request all users on some server. The WHOIS requests MUST
252 be based on explicit nickname request.
254 The WHOIS request MUST be always sent to the router by server
255 so that all users are searched. However, the server still MUST
256 search its locally connected clients. The router MUST send
257 this command to the server which owns the requested client, if
258 the router is unable to provide all mandatory information about
259 the client. That server MUST reply to the command. Server MUST
260 NOT send whois replies to the client until it has received the
261 reply from its router.
263 The <Requested Attributes> is defined in [ATTRS] and can be used
264 to request various information about the client. See Appendix A
265 for definition of using these attributes in SILC.
267 Reply messages to the command:
270 Arguments: (1) <Status Payload> (2) <Client ID>
271 (3) <nickname>[@<server>] (4) <username@host>
272 (5) <real name> (6) [<Channel Payload
274 (7) [<user mode>] (8) [<idle time>]
275 (9) [<fingerprint>] (10) <channel user
280 This command may reply with several command reply messages to
281 form a list of results. In this case the status payload will
282 include STATUS_LIST_START status in the first reply and
283 STATUS_LIST_END in the last reply to indicate the end of the
284 list. If there are only one reply the status is set to normal
287 The command replies include the Client ID of the nickname,
288 nickname and server name, user name and host name and user's real
289 name. Client SHOULD process these replies only after the last
290 reply has been received with the STATUS_LIST_END status. If the
291 <count> option were defined in the query there will be only
292 <count> many replies from the server.
294 The server returns the list of channels if the client has
295 joined channels. In this case the list is list of Channel
296 Payloads. The Mode Mask in the Channel Payload is the channel's
297 mode. The list is encoded by adding the Channel Payloads one
298 after the other. Private and secret channels MUST NOT be sent,
299 except if the sender of this command is on those channels, or
300 the sender is server. The <channel user mode list> MUST also
301 be sent if client is joined channels. This list includes 32 bit
302 MSB first order values one after the other and each indicate
303 the user's mode on a channel. The order of these values MUST
304 be same as the channel order in the <Channel Payload list>.
306 The server also returns client's user mode, idle time, and the
307 fingerprint of the client's public key. The <fingerprint> is the
308 binary hash digest of the public key. The fingerprint MUST NOT
309 be sent if the server has not verified the proof of posession of
310 the corresponding private key. Server can do this during the
311 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
313 The <Attributes> is the reply to the <Requested Attributes>.
314 See the Appendix A for more information.
319 SILC_STATUS_LIST_START
321 SILC_STATUS_ERR_NO_SUCH_NICK
322 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
323 SILC_STATUS_ERR_WILDCARDS
324 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
325 SILC_STATUS_ERR_TOO_MANY_PARAMS
328 2 SILC_COMMAND_WHOWAS
331 Arguments: (1) <nickname>[@<server>] (2) [<count>]
333 Whowas. This command is used to query history information about
334 specific user. The user may be requested by their nickname and
335 server name. The query may find multiple matching users as there
336 are no unique nicknames in the SILC. The <count> option may be
337 given to narrow down the number of accepted results. If this
338 is not defined there are no limit of accepted results. The query
339 may also be narrowed down by defining the server name of the
340 nickname. The <count> is 32 bit MSB first order integer.
342 To prevent miss-use of this command wildcards in the nickname
343 or in the server name are not permitted. The WHOWAS requests MUST
344 be based on specific nickname request.
346 The WHOWAS request MUST be always sent to the router by server
347 so that all users are searched. However, the server still must
348 search its locally connected clients.
350 Reply messages to the command:
353 Arguments: (1) <Status Payload> (2) <Client ID>
354 (3) <nickname>[@<server>] (4) <username@host>
357 This command may reply with several command reply messages to form
358 a list of results. In this case the status payload will include
359 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
360 the last reply to indicate the end of the list. If there are only
361 one reply the status is set to normal STATUS_OK.
363 The command replies with nickname and user name and host name.
364 Every server MUST keep history for some period of time of its
365 locally connected clients.
370 SILC_STATUS_LIST_START
372 SILC_STATUS_ERR_NO_SUCH_NICK
373 SILC_STATUS_ERR_WILDCARDS
374 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
375 SILC_STATUS_ERR_TOO_MANY_PARAMS
378 3 SILC_COMMAND_IDENTIFY
381 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
382 (3) [<channel name>] (4) [<count>]
383 (5) [<ID Payload>] (n) [...]
385 Identify command is used to query information about an entity by
386 the entity's name or ID. This command can be used to query
387 information about clients, server and channels.
389 The query may find multiple matching entities. The <count> option
390 may be given to narrow down the number of accepted results. If
391 this is not defined there are no limit of accepted results. The
392 <count> is 32 bit MSB first order integer.
394 It is also possible to search the entity by its ID. If the
395 <ID Payload> is provided server must use it as the search value
396 instead of the entity's name. One of the arguments must be given.
397 It is also possible to define multiple ID Payloads to search
398 multiple entities sending only one IDENTIFY command. In this case
399 the ID Payloads are appended as normal arguments. The type of the
400 entity is defined by the type of the ID Payload.
402 To prevent miss-use of this command wildcards in the names are
403 not permitted. It is not allowed to request for example all users
406 Implementations may not want to give interface access to this
407 command as it is hardly a command that would be used by an end
408 user. However, it must be implemented as it is used with private
411 The IDENTIFY command MUST be always sent to the router by server
412 so that all users are searched. However, server MUST still search
413 its locally connected clients.
415 Reply messages to the command:
418 Arguments: (1) <Status Payload> (2) <ID Payload>
419 (3) [<entity's name>] (4) [<info>]
421 This command may reply with several command reply messages to form
422 a list of results. In this case the status payload will include
423 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
424 the last reply to indicate the end of the list. If there are only
425 one reply the status is set to normal STATUS_OK.
427 When querying clients the <entity's name> must include the client's
428 nickname in the following format: nickname[@server]. The
429 <info> must include the client's username and host in the following
430 format: username@host.
432 When querying servers the <entity's name> must include the server's
433 full name. The <info> may be omitted.
435 When querying channels the <entity's name> must include the
436 channel's name. The <info> may be omitted.
438 If the <count> option were defined in the query there will be only
439 <count> many replies from the server.
444 SILC_STATUS_LIST_START
446 SILC_STATUS_ERR_NO_SUCH_NICK
447 SILC_STATUS_ERR_NO_SUCH_SERVER
448 SILC_STATUS_ERR_NO_SUCH_CHANNEL
449 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
450 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
451 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
452 SILC_STATUS_ERR_WILDCARDS
453 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
454 SILC_STATUS_ERR_TOO_MANY_PARAMS
460 Arguments: (1) <nickname>
462 Set/change nickname. This command is used to set nickname for
463 user. Nickname MUST NOT include any spaces (` '), non-printable
464 characters, commas (`,') and any wildcard characters.
466 When nickname is changed new Client ID is generated. Server MUST
467 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
468 channels (if any) the client is joined on. Then it MUST send
469 SILC_PACKET_REPLACE_ID to its primary route to replace the old
470 Client ID with the new one.
472 Reply messages to the command:
475 Arguments: (1) <Status Payload> (2) <New ID Payload>
477 This command is replied always with New ID Payload that is
478 generated by the server every time user changes their nickname.
479 Client receiving this payload MUST start using the received
480 Client ID as its current valid Client ID. The New ID Payload
481 is described in [SILC2].
486 SILC_STATUS_ERR_WILDCARDS
487 SILC_STATUS_ERR_NICKNAME_IN_USE
488 SILC_STATUS_ERR_BAD_NICKNAME
489 SILC_STATUS_ERR_NOT_REGISTERED
490 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
491 SILC_STATUS_ERR_TOO_MANY_PARAMS
497 Arguments: (1) [<Channel ID>]
499 The list command is used to list channels and their topics on the
500 current server. If the <Channel ID> parameter is used, only the
501 status of that channel is displayed. Secret channels are not
502 listed at all. Private channels are listed with status indicating
503 that the channel is private. Router MAY reply with all channels
506 Reply messages to the command:
509 Arguments: (1) <Status Payload> (2) <Channel ID>
510 (3) <channel> (4) [<topic>]
513 This command may reply with several command reply messages to form
514 a list of results. In this case the status payload will include
515 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
516 the last reply to indicate the end of the list. If there are only
517 one reply the status is set to normal STATUS_OK.
519 This command replies with Channel ID, name and the topic of the
520 channel. If the channel is private channel the <topic> SHOULD
521 include the "*private*" string.
526 SILC_STATUS_LIST_START
528 SILC_STATUS_ERR_WILDCARDS
529 SILC_STATUS_ERR_NOT_REGISTERED
530 SILC_STATUS_ERR_TOO_MANY_PARAMS
531 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
532 SILC_STATUS_ERR_NO_CHANNEL_ID
533 SILC_STATUS_ERR_NO_SUCH_SERVER
539 Arguments: (1) <Channel ID> (2) [<topic>]
541 This command is used to change or view the topic of a channel.
542 The topic for channel <Channel ID> is returned if there is no
543 <topic> given. If the <topic> parameter is present, the topic
544 for that channel will be changed, if the channel modes permit
547 After setting the topic the server MUST send the notify type
548 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
549 the channel which topic was changed.
551 Reply messages to the command:
554 Arguments: (1) <Status Payload> (2) <Channel ID>
557 The command may reply with the topic of the channel if it is
563 SILC_STATUS_ERR_NOT_ON_CHANNEL
564 SILC_STATUS_ERR_WILDCARDS
565 SILC_STATUS_ERR_NOT_REGISTERED
566 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
567 SILC_STATUS_ERR_NO_SUCH_CHANNEL
568 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
569 SILC_STATUS_ERR_NO_CHANNEL_ID
570 SILC_STATUS_ERR_BAD_CHANNEL_ID
571 SILC_STATUS_ERR_TOO_MANY_PARAMS
572 SILC_STATUS_ERR_NO_CHANNEL_PRIV
575 7 SILC_COMMAND_INVITE
578 Arguments: (1) <Channel ID> (2) [<Client ID>]
579 (3) [<adding client>] (4) [<removing client>]
581 This command is used to invite other clients to join to the
582 channel. The <Client ID> argument is the target client's ID that
583 is being invited. The <Channel ID> is the Channel ID of the
584 requested channel. The sender of this command MUST be on the
585 channel. The server MUST also send the notify type
586 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
587 client indicated by the <Client ID>.
589 The <adding client> and <removing client> can be used to add to
590 and remove from the invite list. The format of the <adding client>
591 and <removing client> is as follows:
593 [<nickname>[@<server>]!][<username>]@[<hostname>]
595 When adding to or removing from the invite list the server MUST
596 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
597 and MUST NOT send it to the client which was added to the list.
598 The client which executes this command MUST have at least channel
599 operator privileges to be able to add to or remove from the invite
600 list. The wildcards MAY be used with this command. If adding or
601 removing more than one client then the lists are an comma (`,')
604 Note that the <Client ID> provided MUST be resolved into correct
605 nickname and host name and add to the invite list before sending
608 When this command is given with only <Channel ID> argument then
609 the command merely returns the invite list of the channel. This
610 command MUST fail if the requested channel does not exist, the
611 requested <Client ID> is already on the channel or if the channel
612 is invite only channel and the caller of this command does not
613 have at least channel operator privileges.
615 Reply messages to the command:
618 Arguments: (1) <Status Payload> (2) <Channel ID>
621 This command replies with the invite list of the channel if it
627 SILC_STATUS_ERR_NOT_REGISTERED
628 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
629 SILC_STATUS_ERR_TOO_MANY_PARAMS
630 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
631 SILC_STATUS_ERR_NO_CLIENT_ID
632 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
633 SILC_STATUS_ERR_NO_CHANNEL_ID
634 SILC_STATUS_ERR_NOT_ON_CHANNEL
635 SILC_STATUS_ERR_USER_ON_CHANNEL
636 SILC_STATUS_ERR_NO_CHANNEL_PRIV
637 SILC_STATUS_ERR_RESOURCE_LIMIT
643 Arguments: (1) [<quit message>]
645 This command is used by client to end SILC session. The server
646 must close the connection to a client which sends this command.
647 if <quit message> is given it will be sent to other clients on
648 channel if the client is on channel when quitting.
650 Reply messages to the command:
652 This command does not reply anything.
658 Arguments: (1) <Client ID> (2) [<comment>]
660 This command is used by SILC operators to remove a client from
661 SILC network. The removing has temporary effects and client may
662 reconnect to SILC network. The <Client ID> is the client to be
663 removed from SILC. The <comment> argument may be provided to
664 give to the removed client some information why it was removed
667 When killing a client the router MUST first send notify type
668 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
669 The packet MUST NOT be sent to the killed client on the channels.
670 Then, the router MUST send the same notify type to its primary
671 router. Finally, the router MUST send the same notify type
672 directly to the client which was killed.
674 Reply messages to the command:
677 Arguments: (1) <Status Payload>
679 This command replies only with Status Payload.
684 SILC_STATUS_ERR_WILDCARDS
685 SILC_STATUS_ERR_NOT_REGISTERED
686 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
687 SILC_STATUS_ERR_TOO_MANY_PARAMS
688 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
689 SILC_STATUS_ERR_NO_CLIENT_ID
690 SILC_STATUS_ERR_NO_ROUTER_PRIV
696 Arguments: (1) [<server>] (2) [<Server ID>]
698 This command is used to fetch various information about a server.
699 If <server> argument is specified the command MUST be sent to
700 the requested server.
702 If the <Server ID> is specified the server information if fetched
703 by the provided Server ID. One of the arguments must always be
706 Reply messages to the command:
709 Arguments: (1) <Status Payload> (2) <Server ID>
710 (3) <server name> (4) <string>
712 This command replies with the Server ID of the server and a
713 string which tells the information about the server.
718 SILC_STATUS_ERR_WILDCARDS
719 SILC_STATUS_ERR_NOT_REGISTERED
720 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
721 SILC_STATUS_ERR_TOO_MANY_PARAMS
722 SILC_STATUS_ERR_NO_SUCH_SERVER
723 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
724 SILC_STATUS_ERR_NO_SERVER_ID
727 11 SILC_COMMAND_STATS
730 Arguments: (1) <Server ID>
732 This command is used to fetch various statistical information
733 from the server indicated by <Server ID>, which is the ID of
734 server where sender is connected to. Server receiving this
735 command MAY also send this further to its router for fetching
736 other cell and network wide statistics to accompany the reply.
738 Reply messages to the command:
741 Arguments: (1) <Status Payload> (2) <Server ID>
742 (3) [<statistics structure>]
744 This command replies with the Server ID of the server and
745 optional statistics structure which includes 32 bit MSB first
746 ordered integer values to represent various statistical
747 information. The structure is as follows:
749 starttime - time when server was started
750 uptime - uptime of the server
751 my clients - number of locally connected clients
752 my channels - number of locally created channels
753 my server ops - number of local server operators
754 my router ops - number of local router operators
755 cell clients - number of clients in local cell
756 cell channels - number of channels in local cell
757 cell servers - number of servers in local cell
758 clients - number of client in SILC network
759 channels - number of channels in SILC network
760 servers - number of servers in SILC network
761 routers - number of routers in SILC network
762 server ops - number of server operators in SILC network
763 router ops - number of router operators in SILC network
765 If some value is unknown it is set to zero (0) value. The
766 "starttime" is the start time of the server, and is seconds
767 since Epoch (POSIX.1). The "uptime" is time difference of
768 current time and "starttime" in the server, and is seconds
774 SILC_STATUS_ERR_NOT_REGISTERED
775 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
776 SILC_STATUS_ERR_TOO_MANY_PARAMS
777 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
778 SILC_STATUS_ERR_NO_SUCH_SERVER
779 SILC_STATUS_ERR_NO_SERVER_ID
785 Arguments: (1) <Server ID>
787 This command is used by client and server to test the communication
788 channel to its server if one suspects that the communication is not
789 working correctly. The <Server ID> is the ID of the server the
790 sender is connected to.
792 Reply messages to the command:
795 Arguments: (1) <Status Payload>
797 This command replies only with Status Payload. Server returns
798 SILC_STATUS_OK in Status Payload if pinging was successful.
805 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
806 SILC_STATUS_ERR_TOO_MANY_PARAMS
807 SILC_STATUS_ERR_NO_SERVER_ID
808 SILC_STATUS_ERR_NO_SUCH_SERVER
809 SILC_STATUS_ERR_NOT_REGISTERED
815 Arguments: (1) <username> (2) <authentication payload>
817 This command is used by normal client to obtain server operator
818 privileges on some server or router. Note that router operator
819 has router privileges that supersedes the server operator
820 privileges and this does not obtain those privileges. Client
821 MUST use SILCOPER command to obtain router level privileges.
823 The <username> is the username set in the server configurations
824 as operator. The <authentication payload> is the data that the
825 client is authenticated against. It may be passphrase prompted
826 for user on client's screen or it may be public key or certificate
827 authentication data (data signed with private key). The public
828 key that server will use to verify the signature found in the
829 payload should be verified. It is recommended that the public
830 key is saved locally in the server and server would not use
831 any public keys received during the SKE.
833 After changing the mode the server MUST send the notify type
834 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
836 Reply messages to the command:
839 Arguments: (1) <Status Payload>
841 This command replies only with Status Payload.
846 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
847 SILC_STATUS_ERR_TOO_MANY_PARAMS
848 SILC_STATUS_ERR_NOT_REGISTERED
849 SILC_STATUS_ERR_AUTH_FAILED
855 Arguments: (1) <channel> (2) <Client ID>
856 (3) [<passphrase>] (4) [<cipher>]
857 (5) [<hmac>] (6) [<founder auth>]
859 Join to channel/create new channel. This command is used to
860 join to a channel. If the channel does not exist the channel is
861 created. If server is normal server this command MUST be sent
862 to router which will create the channel. The channel MAY be
863 protected with passphrase. If this is the case the passphrase
864 MUST be sent along the join command.
866 The name of the <channel> MUST NOT include any spaces (` '),
867 non-printable characters, commas (`,') or any wildcard characters.
869 The second argument <Client ID> is the Client ID of the client
870 which is joining to the client. When client sends this command
871 to the server the <Client ID> MUST be the client's own ID.
873 Cipher to be used to secure the traffic on the channel MAY be
874 requested by sending the name of the requested <cipher>. This
875 is used only if the channel does not exist and is created. If
876 the channel already exists the cipher set previously for the
877 channel will be used to secure the traffic. The computed MACs
878 of the channel message are produced by the default HMAC or by
879 the <hmac> provided for the command.
881 The <founder auth> is Authentication Payload providing the
882 authentication for gaining founder privileges on the channel
883 when joining the channel. The client may provide this if it
884 knows that it is the founder of the channel and that the
885 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
886 MUST verify whether the client is able to gain the founder
887 privileges the same way as the client had given the
888 SILC_COMMAND_CUMODE command to gain founder privileges. The
889 client is still able to join the channel even if the founder
890 privileges could not be gained.
892 The server MUST check whether the user is allowed to join to
893 the requested channel. Various modes set to the channel affect
894 the ability of the user to join the channel. These conditions
897 o The user MUST be invited to the channel if the channel
898 is invite-only channel.
900 o The Client ID/nickname/username/host name MUST NOT match
903 o The correct passphrase MUST be provided if passphrase
904 is set to the channel.
906 o The user count limit, if set, MUST NOT be reached.
908 If the client provided correct <founder auth> payload it can
909 override these conditions, except the condition for the passphrase.
910 The correct passphrase MUST be provided even if <founder auth>
913 Reply messages to the command:
916 Arguments: (1) <Status Payload> (2) <channel>
917 (3) <Channel ID> (4) <Client ID>
918 (5) <channel mode mask> (6) <created>
919 (7) [<Channel Key Payload>] (8) [<ban list>]
920 (9) [<invite list>] (10) [<topic>]
921 (11) [<hmac>] (12) <list count>
922 (13) <Client ID list> (14) <client mode list>
924 This command replies with the channel name requested by the
925 client, channel ID of the channel and topic of the channel
926 if it exists. The <Client ID> is the Client ID which was joined
927 to the channel. It also replies with the channel mode mask
928 which tells all the modes set on the channel. If the
929 channel is created the mode mask is zero (0). If ban mask
930 and/or invite list is set they are sent as well.
932 The <list count>, <Client ID list> and <client mode list> are
933 the clients currently on the channel and their modes on the
934 channel. The <Client ID list> is formed by adding the ID Payloads
935 one after the other. The <client mode list> is formed by adding
936 32 bit MSB first order values one after the other.
938 Client receives the channel key in the reply message as well
939 inside <Channel Key Payload>.
944 SILC_STATUS_ERR_WILDCARDS
945 SILC_STATUS_ERR_NOT_REGISTERED
946 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
947 SILC_STATUS_ERR_TOO_MANY_PARAMS
948 SILC_STATUS_ERR_BAD_PASSWORD
949 SILC_STATUS_ERR_CHANNEL_IS_FULL
950 SILC_STATUS_ERR_NOT_INVITED
951 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
952 SILC_STATUS_ERR_BAD_CHANNEL
953 SILC_STATUS_ERR_USER_ON_CHANNEL
959 Arguments: (1) <server>
961 This command is used to query the Message of the Day of the server.
963 Reply messages to the command:
966 Arguments: (1) <Status Payload> (2) <Server ID>
969 This command replies with the motd message if it exists.
974 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
975 SILC_STATUS_ERR_TOO_MANY_PARAMS
976 SILC_STATUS_ERR_NOT_REGISTERED
977 SILC_STATUS_ERR_NO_SUCH_SERVER
980 16 SILC_COMMAND_UMODE
983 Arguments: (1) <Client ID> (2) [<client mode mask>]
985 This command is used by client to set/unset modes for itself.
986 However, there are some modes that the client MUST NOT set itself,
987 but they will be set by server. However, client MAY unset any
988 mode. Modes may be masked together ORing them thus having
989 several modes set. Client MUST keep its client mode mask
990 locally so that the mode setting/unsetting would work without
991 problems. Client may change only its own modes.
993 After changing the mode server MUST send the notify type
994 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
996 The following client modes are defined:
998 0x00000000 SILC_UMODE_NONE
1000 No specific mode for client. This is the initial
1001 setting when new client is created. The client is
1002 normal client and is present in the network.
1005 0x00000001 SILC_UMODE_SERVER_OPERATOR
1007 Marks the user as server operator. Client MUST NOT
1008 set this mode itself. Server sets this mode to the
1009 client when client attains the server operator
1010 privileges by SILC_COMMAND_OPER command. Client
1011 MAY unset the mode itself.
1014 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1016 Marks the user as router (SILC) operator. Client
1017 MUST NOT set this mode itself. Router sets this mode
1018 to the client when client attains the router operator
1019 privileges by SILC_COMMAND_SILCOPER command. Client
1020 MAY unset the mode itself.
1023 0x00000004 SILC_UMODE_GONE
1025 Marks that the user is not currently present in the
1026 SILC Network. Client MAY set and unset this mode.
1029 0x00000008 SILC_UMODE_INDISPOSED
1031 Marks that the user is currently indisposed and may
1032 not be able to receive any messages, and that user may
1033 not be present in the network. Client MAY set and
1037 0x00000010 SILC_UMODE_BUSY
1039 Marks that the user is currently busy and may not
1040 want to receive any messages, and that user may not
1041 be present in the network. Client MAY set and unset
1045 0x00000020 SILC_UMODE_PAGE
1047 User is not currently present or is unable to receive
1048 messages, and prefers to be paged in some mechanism
1049 if the user needs to be reached. Client MAY set and
1053 0x00000040 SILC_UMODE_HYPER
1055 Marks that the user is hyper active and is eager to
1056 receive and send messages. Client MAY set and unset
1060 0x00000080 SILC_UMODE_ROBOT
1062 Marks that the client is actually a robot program.
1063 Client MAY set and unset this mode.
1066 0x00000100 SILC_UMODE_ANONYMOUS
1068 Marks that the client is anonymous client. Server
1069 that specificly is designed for anonymous services
1070 can set and unset this mode. Client MUST NOT set or
1071 unset this mode itself. A client with this mode set
1072 would have the username and the hostname information
1073 scrambled by the server which set this mode.
1076 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1078 Marks that the client wishes to block private
1079 messages sent to the client, unless the Private
1080 Message Key flag is set in the SILC packet header.
1081 If this mode is set server MUST NOT deliver private
1082 messages to the client without the Private Message
1083 Key flag being set. The Private Message Key flag set
1084 indicates that the private message is protected with
1085 a key shared between the sender and the recipient.
1087 A separate service could provide additional filtering
1088 features for accepting private messages from certain
1089 sender. However, this document does not specify such
1092 The client MAY set and unset this mode.
1095 0x00000400 SILC_UMODE_DETACHED
1097 Marks that the client is detached from the SILC network.
1098 This means that the actual network connection to the
1099 client is lost but the client entry is still valid. The
1100 detached client can be resumed at a later time. This
1101 mode MUST NOT be set by client. It can only be set when
1102 client has issued command SILC_COMMAND_DETACH. The server
1103 sets this mode. This mode cannot be unset with this
1104 command. It is unset when the client is resuming back to
1105 the network and SILC_PACKET_RESUME_CLIENT packet is
1108 This flag MUST NOT be used to determine whether a packet
1109 can be sent to the client or not. Only the server that
1110 had the original client connection can make the decision
1111 by knowing that the network connection is not active.
1112 In this case the default case is to discard the packet.
1115 0x00000800 SILC_UMODE_REJECT_WATCHING
1117 Marks that the client rejects that it could be watched
1118 by someone else. If this mode is set notifications about
1119 this client is not send, even if someone is watching the
1120 same nickname this client has. Client MAY set and unset
1121 this mode. Any changes for this client MUST NOT be
1122 notified to any watcher when this mode is set.
1124 A separate service could provide additional filtering
1125 features for rejecting and accepting the watching from
1126 certain users. However, this document does not specify
1129 If the <client mode mask> was not provided this command merely
1130 returns the mode mask to the client.
1133 Reply messages to the command:
1136 Arguments: (1) <Status Payload> (2) <client mode mask>
1138 This command replies with the changed client mode mask that
1139 the client MUST to keep locally.
1145 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1146 SILC_STATUS_ERR_TOO_MANY_PARAMS
1147 SILC_STATUS_ERR_NOT_REGISTERED
1148 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1149 SILC_STATUS_ERR_BAD_CLIENT_ID
1150 SILC_STATUS_ERR_NOT_YOU
1151 SILC_STATUS_ERR_PERM_DENIED
1152 SILC_STATUS_ERR_UNKNOWN_MODE
1153 SILC_STATUS_ERR_NO_CLIENT_ID
1156 17 SILC_COMMAND_CMODE
1159 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1160 (3) [<user limit>] (4) [<passphrase>]
1161 (5) [<cipher>] (6) [<hmac>]
1162 (7) [<auth payload>]
1164 This command is used by client to set or change channel flags on
1165 a channel. Channel has several modes that set various properties
1166 of a channel. Modes may be masked together by ORing them thus
1167 having several modes set. The <Channel ID> is the ID of the
1168 target channel. The client changing channel mode MUST be on
1169 the same channel and poses sufficient privileges to be able to
1172 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1173 type MUST be distributed to the channel.
1175 The following channel modes are defined:
1177 0x00000000 SILC_CMODE_NONE
1179 No specific mode on channel. This is the default when
1180 channel is created. This means that channel is just plain
1184 0x00000001 SILC_CMODE_PRIVATE
1186 Channel is private channel. Private channels are shown
1187 in the channel list listed with SILC_COMMAND_LIST command
1188 with indication that the channel is private. Also,
1189 client on private channel will no be detected to be on
1190 the channel as the channel is not shown in the client's
1191 currently joined channel list. Channel founder and
1192 channel operator MAY set/unset this mode.
1194 Typical implementation would use [+|-]p on user interface
1195 to set/unset this mode.
1198 0x00000002 SILC_CMODE_SECRET
1200 Channel is secret channel. Secret channels are not shown
1201 in the list listed with SILC_COMMAND_LIST command. Secret
1202 channels can be considered to be invisible channels.
1203 Channel founder and channel operator MAY set/unset this
1206 Typical implementation would use [+|-]s on user interface
1207 to set/unset this mode.
1210 0x00000004 SILC_CMODE_PRIVKEY
1212 Channel uses private channel key to protect the traffic
1213 on the channel. When this mode is set the client will be
1214 responsible to set the key it wants to use to encrypt and
1215 decrypt the traffic on channel. Server generated channel
1216 keys are not used at all. This mode provides additional
1217 security as clients on channel may agree to use private
1218 channel key that even servers do not know. Naturally,
1219 this requires that every client on the channel knows
1220 the key before hand (it is considered to be pre-shared-
1221 key). The key material is RECOMMENDED to be processed
1222 as stated in the [SILC3] in the section Processing the
1225 As it is local setting it is possible to have several
1226 private channel keys on one channel. In this case several
1227 clients can talk on same channel but only those clients
1228 that share the key with the message sender will be able
1229 to hear the talking. Client SHOULD NOT display those
1230 message for the end user that it is not able to decrypt
1231 when this mode is set.
1233 Only channel founder MAY set/unset this mode. If this
1234 mode is unset the server will distribute new channel
1235 key to all clients on the channel which will be used
1238 Typical implementation would use [+|-]k on user interface
1239 to set/unset this mode.
1242 0x00000008 SILC_CMODE_INVITE
1244 Channel is invite only channel. Client may join to this
1245 channel only if it is invited to the channel. Channel
1246 founder and channel operator MAY set/unset this mode.
1248 Typical implementation would use [+|-]i on user interface
1249 to set/unset this mode.
1252 0x00000010 SILC_CMODE_TOPIC
1254 The topic of the channel may only be set by client that
1255 is channel founder or channel operator. Normal clients
1256 on channel will not be able to set topic when this mode
1257 is set. Channel founder and channel operator MAY set/
1260 Typical implementation would use [+|-]t on user interface
1261 to set/unset this mode.
1264 0x00000020 SILC_CMODE_ULIMIT
1266 User limit has been set to the channel. New clients
1267 may not join to the channel when the limit set is
1268 reached. Channel founder and channel operator MAY set/
1269 unset the limit. The <user limit> argument is the
1270 number of limited users.
1272 Typical implementation would use [+|-]l on user interface
1273 to set/unset this mode.
1276 0x00000040 SILC_CMODE_PASSPHRASE
1278 Passphrase has been set to the channel. Client may
1279 join to the channel only if it is able to provide the
1280 correct passphrase. Setting passphrases to channel
1281 is entirely safe as all commands are protected in the
1282 SILC network. Only channel founder MAY set/unset
1283 the passphrase. The <passphrase> argument is the
1286 Typical implementation would use [+|-]a on user interface
1287 to set/unset this mode.
1290 0x00000080 SILC_CMODE_CIPHER
1292 Sets specific cipher to be used to protect channel
1293 traffic. The <cipher> argument is the requested cipher.
1294 When set or unset the server must re-generate new
1295 channel key. Only channel founder MAY set the cipher of
1296 the channel. When unset the new key is generated using
1297 default cipher for the channel.
1299 Typical implementation would use [+|-]c on user interface
1300 to set/unset this mode.
1303 0x00000100 SILC_CMODE_HMAC
1305 Sets specific hmac to be used to compute the MACs of the
1306 channel message. The <hmac> argument is the requested hmac.
1307 Only channel founder may set the hmac of the channel.
1309 Typical implementation would use [+|-]h on user interface
1310 to set/unset this mode.
1313 0x00000200 SILC_CMODE_FOUNDER_AUTH
1315 Channel founder may set this mode to be able to regain
1316 channel founder rights even if the client leaves the
1317 channel. The <auth payload> is the Authentication Payload
1318 consisting of the authentication method and authentication
1319 data to be used in the authentication. The server MUST
1320 NOT accept NONE authentication method. Also, if the
1321 method is public key authentication the server MUST NOT
1322 save the authentication data from the payload as the
1323 data is different on all authentications. In this case the
1324 server only saves the authentication method. However,
1325 server MUST verify the sent authentication payload and
1326 set the mode only if the verification was successful.
1328 Note that this mode is effective only in the current server.
1329 The client MUST connect to the same server later to be able
1330 to regain the channel founder rights. The server MUST save
1331 the public key of the channel founder and use that to identify
1332 the client which is claiming the channel founder rights.
1333 The rights may be claimed by the SILC_CUMODE_FOUNDER
1334 channel user mode using SILC_COMMAND_CUMODE command. The
1335 set authentication data remains valid as long as the channel
1336 exists or until the founder unsets this mode.
1338 Typical implementation would use [+|-]f on user interface
1339 to set/unset this mode.
1342 0x00000400 SILC_CMODE_SILENCE_USERS
1344 Channel founder may set this mode to silence normal users
1345 on the channel. Users with operator privileges are not
1346 affected by this mode. Messages sent by normal users
1347 are dropped by servers when this mode is set. This mode
1348 can be used to moderate the channel. Only channel founder
1349 may set/unset this mode.
1352 0x00000800 SILC_CMODE_SILENCE_OPERS
1354 Channel founder may set this mode to silence operators
1355 on the channel. When used with SILC_CMODE_SILENCE_USERS
1356 mode this can be used to set the channel in state where only
1357 the founder of the channel may send messages to the channel.
1358 Messages sent by operators are dropped by servers when this
1359 mode is set. Only channel founder may set/unset this mode.
1362 To make the mode system work, client MUST keep the channel mode
1363 mask locally so that the mode setting and unsetting would work
1364 without problems. The client receives the initial channel mode
1365 mask when it joins to the channel. When the mode changes on
1366 channel the server MUST distribute the changed channel mode mask
1367 to all clients on the channel by sending the notify type
1368 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1369 to the server's primary router. If the <channel mode mask> was
1370 not provided this command merely returns the mode mask to the
1373 Reply messages to the command:
1376 Arguments: (1) <Status Payload> (2) <Channel ID>
1377 (3) <channel mode mask>
1379 This command replies with the changed channel mode mask that
1380 client MUST keep locally.
1385 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1386 SILC_STATUS_ERR_TOO_MANY_PARAMS
1387 SILC_STATUS_ERR_NOT_REGISTERED
1388 SILC_STATUS_ERR_NOT_ON_CHANNEL
1389 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1390 SILC_STATUS_ERR_BAD_CHANNEL_ID
1391 SILC_STATUS_ERR_NO_CHANNEL_ID
1392 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1393 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1394 SILC_STATUS_ERR_UNKNOWN_MODE
1395 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1396 SILC_STATUS_ERR_AUTH_FAILED
1399 18 SILC_COMMAND_CUMODE
1402 Arguments: (1) <Channel ID> (2) <mode mask>
1403 (3) <Client ID> (4) [<auth payload>]
1405 This command is used by client to change channel user modes on
1406 channel. Users on channel may have some special modes and this
1407 command is used by channel operators to set or change these modes.
1408 The <Channel ID> is the ID of the target channel. The <mode mask>
1409 is OR'ed mask of modes. The <Client ID> is the target client.
1410 The client changing channel user modes MUST be on the same channel
1411 as the target client and poses sufficient privileges to be able to
1414 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1415 type is distributed to the channel.
1417 The following channel modes are defined:
1419 0x00000000 SILC_CUMODE_NONE
1421 No specific mode. This is the normal situation for client.
1422 Also, this is the mode set when removing all modes from
1426 0x00000001 SILC_CUMODE_FOUNDER
1428 The client is channel founder of the channel. Usually this
1429 mode is set only by the server when the channel was created.
1430 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1431 been set, the client can claim channel founder privileges
1432 by providing the <auth payload> that the server will use
1433 to authenticate the client. The public key that server will
1434 use to verify the <auth payload> must the same public key
1435 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1436 mode was set. The client MAY remove this mode at any time.
1439 0x00000002 SILC_CUMODE_OPERATOR
1441 Sets channel operator privileges on the channel for a
1442 client on the channel. Channel founder and channel operator
1443 MAY set/unset this mode. The client MAY remove this mode
1447 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1449 Marks that the client wishes not to receive any channel
1450 messages sent for the channel. Client MAY set and unset
1451 this mode to itself. Client MUST NOT set it to anyone else.
1452 When this mode is set server MUST NOT deliver channel
1453 messages to this client. Other packets such as channel
1454 key packets are still sent to the client.
1456 A separate service could provide additional filtering
1457 features for accepting channel messages from certain
1458 sender. However, this document does not specify such
1462 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1464 Marks that the client wishes not to receive any channel
1465 messages sent from normal users. Only messages sent by
1466 channel founder or channel operator is accepted. Client
1467 MAY set and unset this mode to itself. Client MUST NOT
1468 set it to anyone else. When this mode is set server MUST
1469 NOT deliver channel messages that are sent by normal users
1472 A separate service could provide additional filtering
1473 features for accepting channel messages from certain
1474 sender. However, this document does not specify such
1478 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1480 Marks that the client wishes not to receive any channel
1481 messages sent from robots. Messages sent by Users with
1482 the SILC_UMODE_ROBOT user mode set are not delivered.
1483 Client MAY set and unset this mode to itself. Client MUST
1484 NOT set it to anyone else. When this mode is set server
1485 MUST NOT deliver channel messages that are sent by robots
1489 Reply messages to the command:
1492 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1493 (3) <Channel ID> (4) <Client ID>
1495 This command replies with the changed channel user mode mask that
1496 client MUST keep locally. The <Channel ID> is the specified
1497 channel. The <Client ID> is the target client.
1502 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1503 SILC_STATUS_ERR_TOO_MANY_PARAMS
1504 SILC_STATUS_ERR_NOT_REGISTERED
1505 SILC_STATUS_ERR_NOT_ON_CHANNEL
1506 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1507 SILC_STATUS_ERR_BAD_CHANNEL_ID
1508 SILC_STATUS_ERR_NO_CHANNEL_ID
1509 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1510 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1511 SILC_STATUS_ERR_UNKNOWN_MODE
1512 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1513 SILC_STATUS_ERR_AUTH_FAILED
1516 19 SILC_COMMAND_KICK
1519 Arguments: (1) <Channel ID> (2) <Client ID>
1522 This command is used by channel operators to remove a client from
1523 channel. The <channel> argument is the channel the client to be
1524 removed is on currently. Note that the "kicker" must be on the same
1525 channel. If <comment> is provided it will be sent to the removed
1528 After kicking the client the server MUST send the notify type
1529 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1530 The channel key MUST also be re-generated after kicking, unless
1531 the SILC_CMODE_PRIVKEY mode is set.
1533 Reply messages to the command:
1536 Arguments: (1) <Status Payload>
1538 This command replies only with Status Payload.
1543 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1544 SILC_STATUS_ERR_TOO_MANY_PARAMS
1545 SILC_STATUS_ERR_NOT_REGISTERED
1546 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1547 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1548 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1549 SILC_STATUS_ERR_NO_CLIENT_ID
1555 Arguments: (1) <Channel ID> (2) [<adding client>]
1556 (3) [<removing client>]
1558 This command is used to manage the ban list of the channel
1559 indicated by the <Channel ID>. A client that is banned from
1560 channel is no longer able to join the channel. The client which
1561 is executing this command MUST have at least channel operator
1562 privileges on the channel.
1564 The <adding client> and <removing client> are used to add to and
1565 remove from the ban list. The format of the <adding client> and
1566 the <removing client> is of following format:
1568 [<nickname>[@<server>]!][<username>]@[<hostname>]
1570 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1571 primary router after adding to or removing from the ban list.
1572 The wildcards MAY be used with this command. If adding or removing
1573 from than one clients then the lists are an comma (`,') separated.
1575 If this command is executed without the ban arguments the command
1576 merely replies with the current ban list.
1579 Reply messages to the command:
1582 Arguments: (1) <Status Payload> (2) <Channel ID>
1585 This command replies with the <Channel ID> of the channel and
1586 the current <ban list> of the channel if it exists.
1591 SILC_STATUS_ERR_NOT_REGISTERED
1592 SILC_STATUS_ERR_TOO_MANY_PARAMS
1593 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1594 SILC_STATUS_ERR_NO_CHANNEL_ID
1595 SILC_STATUS_ERR_NOT_ON_CHANNEL
1596 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1597 SILC_STATUS_ERR_RESOURCE_LIMIT
1600 21 SILC_COMMAND_DETACH
1605 This command is used to detach from the network. Client can
1606 send this command to its server to indicate that it will be
1607 detached. By detaching the client remains in the network but
1608 the actual network connection to the server is closed. The
1609 client may then later resume the old session back.
1611 When this command is received the server MUST check that the
1612 client is locally connected client, and set the user mode
1613 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1614 MUST be also sent to routers. The server then sends command
1615 reply to this command and closes the network connection.
1616 The server MUST NOT remove the client from its lists, or send
1617 any signoff notifications for this client. See the [SILC1]
1618 for detailed information about detaching.
1620 Reply messages to the command:
1623 Arguments: (1) <Status Payload>
1625 This command replies only with the status indication.
1630 SILC_STATUS_ERR_NOT_REGISTERED
1633 22 SILC_COMMAND_WATCH
1636 Arguments: (1) <Client ID> (2) [<add nickname>]
1637 (3) [<del nickname>]
1639 This command is used to set up a watch for <add nickname>
1640 nickname. When a user in the network appears with the
1641 nickname, or signoffs the network or user's mode is changed
1642 the client which set up the watch will be notified about
1643 this change. This can be used to watch for certain nicknames
1644 in the network and receive notifications when for example a
1645 friend appears in the network or leaves the network.
1647 The <del nickname> is a nickname that has been previously
1648 added to watch list and is now removed from it. Notifications
1649 for that nickname will not be delivered anymore.
1651 The <Client ID> is the Client ID of the sender of this command.
1653 The nickname set to watch MUST NOT include any wildcards.
1654 Note also that a nickname may match several users since
1655 nicknames are not unique. Implementations MAY set limits
1656 for how many nicknames client can watch.
1658 When normal server receives this command from client it
1659 MUST send it to its router. Router will process the command
1660 and actually keeps the watch list.
1662 Reply messages to the command:
1665 Arguments: (1) <Status Payload>
1667 This command replies only with the status indication.
1672 SILC_STATUS_ERR_NOT_REGISTERED
1673 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1674 SILC_STATUS_ERR_TOO_MANY_PARAMS
1675 SILC_STATUS_ERR_BAD_NICKNAME
1676 SILC_STATUS_ERR_WILDCARDS
1677 SILC_STATUS_ERR_RESOURCE_LIMIT
1678 SILC_STATUS_ERR_NO_SUCH_NICK
1679 SILC_STATUS_ERR_NICKNAME_IN_USE
1682 23 SILC_COMMAND_SILCOPER
1685 Arguments: (1) <username> (2) <authentication payload>
1687 This command is used by normal client to obtain router operator
1688 privileges (also known as SILC operator) on the router. Note
1689 that router operator has privileges that supersedes the server
1690 operator privileges.
1692 The <username> is the username set in the server configurations
1693 as operator. The <authentication payload> is the data that the
1694 client is authenticated against. It may be passphrase prompted
1695 for user on client's screen or it may be public key or certificate
1696 authentication data (data signed with private key). The public
1697 key that router will use to verify the signature found in the
1698 payload should be verified. It is recommended that the public
1699 key is saved locally in the router and router would not use
1700 any public keys received during the SKE.
1702 Difference between router operator and server operator is that
1703 router operator is able to handle cell level properties while
1704 server operator (even on router server) is able to handle only
1705 local properties, such as, local connections and normal server
1706 administration. The router operator is also able to use the
1707 SILC_COMMAND_KILL command.
1709 After changing the mode server MUST send the notify type
1710 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1712 Reply messages to the command:
1715 Arguments: (1) <Status Payload>
1717 This command replies only with Status Payload.
1722 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1723 SILC_STATUS_ERR_TOO_MANY_PARAMS
1724 SILC_STATUS_ERR_NOT_REGISTERED
1725 SILC_STATUS_ERR_AUTH_FAILED
1728 24 SILC_COMMAND_LEAVE
1731 Arguments: (1) <Channel ID>
1733 This command is used by client to leave a channel the client is
1736 When leaving channel the server MUST send the notify type
1737 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1738 The channel key MUST also be re-generated when leaving the channel
1739 and distribute it to all clients still currently on the channel.
1740 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1743 Reply messages to the command:
1746 Arguments: (1) <Status Payload> (2) <Channel ID>
1748 The <Channel ID> is the ID of left channel.
1753 SILC_STATUS_ERR_NOT_REGISTERED
1754 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1755 SILC_STATUS_ERR_TOO_MANY_PARAMS
1756 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1757 SILC_STATUS_ERR_BAD_CHANNEL_ID
1758 SILC_STATUS_ERR_NO_CHANNEL_ID
1761 25 SILC_COMMAND_USERS
1764 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1766 This command is used to list user names currently on the requested
1767 channel; either the argument <Channel ID> or the <channel name>.
1768 One of these arguments must be present. The server MUST resolve
1769 the joined clients and reply with a lists of users on the channel
1770 and with list of user modes on the channel.
1772 If the requested channel is a private or secret channel, this
1773 command MUST NOT send the list of users, but error is returned
1774 to the sender, except if the sender is on the channel, or the
1777 Reply messages to the command:
1780 Arguments: (1) <Status Payload> (2) <Channel ID>
1781 (3) <list count> (4) <Client ID list>
1782 (5) <client mode list>
1784 This command replies with the Channel ID of the requested channel
1785 Client ID list of the users on the channel and list of their modes.
1786 The Client ID list has Client ID's of all users in the list. The
1787 <Client ID list> is formed by adding Client ID's one after another.
1788 The <client mode list> is formed by adding client's user modes on
1789 the channel one after another (4 bytes (32 bits) each). The <list
1790 count> of length of 4 bytes (32 bits), tells the number of entries
1791 in the lists. Both lists MUST have equal number of entries.
1796 SILC_STATUS_ERR_NOT_REGISTERED
1797 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1798 SILC_STATUS_ERR_TOO_MANY_PARAMS
1799 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1800 SILC_STATUS_ERR_BAD_CHANNEL_ID
1801 SILC_STATUS_ERR_NO_CHANNEL_ID
1802 SILC_STATUS_ERR_NOT_ON_CHANNEL
1805 26 SILC_COMMAND_GETKEY
1808 Arguments: (1) <ID Payload>
1810 This command is used to fetch the public key of the client or
1811 server indicated by the <ID Payload>. The public key is fetched
1812 from the server where to the client is connected.
1814 Reply messages to the command:
1817 Arguments: (1) <Status Payload> (2) <ID Payload>
1818 (3) [<Public Key Payload>]
1820 This command replies with the client's or server's ID and with
1821 the <Public Key Payload>.
1826 SILC_STATUS_ERR_NOT_REGISTERED
1827 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1828 SILC_STATUS_ERR_TOO_MANY_PARAMS
1829 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1830 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1833 27 SILC_COMMAND_SERVICE
1836 Arguments: (1) [<service name>] (2) [<auth payload>]
1839 This command is used to negotiate a service agreement with a
1840 remote server. If this command is given without arguments it
1841 MAY return the service list, if it is publicly available. The
1842 <service name> is a service sepcific identifier, and the
1843 <auth payload> MAY be used to authenticate the requestor to the
1844 remote service. The authentication to a service may be based
1845 on previous agreement with the requestor and the service
1846 provider. The command MAY also take additional service
1849 This document does not specify any services. How the services
1850 are configured and put available in a server is also out of
1851 scope of this document.
1853 This command MAY be used by client to start using some service
1854 in a server, but it also MAY be used by server to negotiate
1855 to start using a service in some other server or router.
1857 After the negotiation is done both of the parties need to know
1858 from the service identifier how the service can be used. The
1859 service can be considered to be a protocol which both of the
1860 parties need to support.
1862 Reply messages to the command:
1865 Arguments: (1) <Status Payload> (2) [<service list>]
1866 (3) [<service name>] (n) [...]
1869 This command MAY reply with the <service list> when command is
1870 given without arguments, and the list is a comma separated list
1871 of service identifiers. The <service name> is the service that
1872 the sender requested and this is provided when the server has
1873 accepted the sender to use the <service name>. The command
1874 reply MAY also have additional service specific arguments.
1879 SILC_STATUS_ERR_NOT_REGISTERED
1880 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1881 SILC_STATUS_ERR_TOO_MANY_PARAMS
1882 SILC_STATUS_ERR_NO_SUCH_SERVICE
1883 SILC_STATUS_ERR_AUTH_FAILED
1884 SILC_STATUS_ERR_PERM_DENIED
1889 Currently undefined commands.
1894 These commands are reserved for private use and will not be defined
1898 255 SILC_COMMAND_MAX
1900 Reserved command. This must not be sent.
1905 2.3.1 SILC Command Status Payload
1907 Command Status Payload is sent in command reply messages to indicate
1908 the status of the command. The payload is one of argument in the
1909 command thus this is the data area in Command Argument Payload described
1910 in [SILC2]. The payload is only 2 bytes of length. The following
1911 diagram represents the Command Status Payload (field is always in
1918 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1919 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1921 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1925 Figure 6: SILC Command Status Payload
1929 o Status (1 byte) - Indicates the status message type,
1930 error, start of list, entry of list or end of list.
1932 o Error (1 byte) - Indicates the error if the Status
1933 field is some list status, which means there are list
1937 The values in Status and Error fields are set according
1938 the following rules:
1941 o If there is single reply and error has not occurred
1942 then Status field includes value SILC_STATUS_OK, and
1943 the Error field MUST be ignored (and set to zero
1946 o If there is single error, then Status field includes
1947 one of the error values, and the Error field MUST be
1948 ignored (and set to zero value).
1950 o If there will be multiple successful command replies
1951 then Status field includes SILC_STATUS_LIST_START,
1952 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1953 and Error field is set to SILC_STATUS_OK.
1955 o If there are multiple error replies then Status field
1956 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1957 or SILC_STATUS_LIST_END value, and the Error field
1958 includes the error value.
1961 This way it is possible to send single successful or
1962 single error reply, but also multiple successful and
1963 multiple error replies. Note that it is possible to
1964 send both list of successful replies and list of error
1965 replies at the same time, however in this case the
1966 list of error replies MUST be sent after the successful
1967 replies. This way the recipient may ignore the multiple
1968 errors if it wishes to do so.
1970 All Status messages are described in the next section.
1974 2.3.2 SILC Status Types
1976 Status messages are returned in SILC protocol in command reply
1977 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
1978 the command reply packet and status types are sent inside the
1979 Status Payload as one of command reply argument, as defined in
1980 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
1981 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
1982 types defined in this section are used in both cases.
1984 When returning status messages in the command reply message they
1985 indicate whether the command was executed without errors. If error
1986 occurred the status indicates which error occurred.
1988 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
1989 they always send some error status. Usually they are sent to
1990 indicate that error occurred while processing some SILC packet.
1991 Please see the [SILC1] and [SILC2] for more information sending
1992 status types in SILC_NOTIFY_TYPE_ERROR notify.
1994 The Status Types are only numeric values and the receiver must
1995 convert the numeric values into human readable messages if this
1996 is desired in the application.
1998 List of all defined status types:
2001 Generic status messages:
2005 Ok status. Everything went Ok. The status payload maybe
2006 safely ignored in this case.
2008 1 SILC_STATUS_LIST_START
2010 Start of the list. There will be several command replies and
2011 this reply is the start of the list.
2013 2 SILC_STATUS_LIST_ITEM
2015 Item in the list. This is one of the item in the list but not the
2018 3 SILC_STATUS_LIST_END
2020 End of the list. There were several command replies and this
2021 reply is the last of the list. There won't be other replies
2022 belonging to this list after this one.
2026 Currently undefined and has been reserved for the future.
2029 Error status message:
2033 10 SILC_STATUS_ERR_NO_SUCH_NICK
2035 "No such nickname". Requested nickname does not exist.
2037 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2039 "No such channel". Requested channel name does not exist.
2041 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2043 "No such server". Requested server name does not exist.
2045 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2047 "Incomplete registration information". Information remote
2048 sent was incomplete.
2050 14 SILC_STATUS_ERR_NO_RECIPIENT
2052 "No recipient given". Command required recipient which was
2055 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2057 "Unknown command". Command sent to server is unknown by the
2060 16 SILC_STATUS_ERR_WILDCARDS
2062 "Wildcards cannot be used". Wildcards were provided but they
2065 17 SILC_STATUS_ERR_NO_CLIENT_ID
2067 "No Client ID given". Client ID were expected as command
2068 parameter but were not found.
2070 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2072 "No Channel ID given". Channel ID were expected as command
2073 parameter but were not found.
2075 19 SILC_STATUS_ERR_NO_SERVER_ID
2077 "No Serve ID given". Server ID were expected as command
2078 parameter but were not found.
2080 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2082 "Bad Client ID". Client ID provided were erroneous.
2084 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2086 "Bad Channel ID". Channel ID provided were erroneous.
2088 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2090 "No such Client ID". Client ID provided does not exist.
2091 The unknown Client ID MUST be provided as next argument
2094 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2096 "No such Channel ID". Channel ID provided does not exist.
2097 The unknown Channel ID MUST be provided as next argument
2100 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2102 "Nickname already exists". Nickname created could not be
2103 registered because number of same nicknames were already set to
2104 maximum. This is not expected to happen in real life but is
2107 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2109 "You are not on that channel". The command were specified for
2110 channel user is not currently on.
2112 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2114 "They are not on channel". The requested target client is not
2115 on requested channel.
2117 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2119 "User already on channel". User were invited on channel they
2122 28 SILC_STATUS_ERR_NOT_REGISTERED
2124 "You have not registered". User executed command that requires
2125 the client to be registered on the server before it may be
2128 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2130 "Not enough parameters". Command requires more parameters
2133 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2135 "Too many parameters". Too many parameters were provided
2138 31 SILC_STATUS_ERR_PERM_DENIED
2140 "Permission denied". Generic permission denied error status
2141 to indicate disallowed access.
2143 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2145 "You are banned from this server". The client tried to register
2146 on server that has explicitly denied this host to connect.
2148 33 SILC_STATUS_ERR_BAD_PASSWORD
2150 "Cannot join channel. Incorrect password". Password provided for
2151 channel were not accepted.
2153 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2155 "Cannot join channel. Channel is full". The channel is full
2156 and client cannot be joined to it.
2158 35 SILC_STATUS_ERR_NOT_INVITED
2160 "Cannot join channel. You have not been invited". The channel
2161 is invite only channel and client has not been invited.
2163 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2165 "Cannot join channel. You have been banned". The client has
2166 been banned from the channel.
2168 37 SILC_STATUS_ERR_UNKNOWN_MODE
2170 "Unknown mode". Mode provided by the client were unknown to
2173 38 SILC_STATUS_ERR_NOT_YOU
2175 "Cannot change mode for other users". User tried to change
2176 someone else's mode.
2178 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2180 "Permission denied. You are not channel operator". Command may
2181 be executed only by channel operator.
2183 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2185 "Permission denied. You are not channel founder". Command may
2186 be executed only by channel operator.
2188 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2190 "Permission denied. You are not server operator". Command may
2191 be executed only by server operator.
2193 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2195 "Permission denied. You are not SILC operator". Command may be
2196 executed only by router (SILC) operator.
2198 43 SILC_STATUS_ERR_BAD_NICKNAME
2200 "Bad nickname". Nickname requested contained illegal characters
2203 44 SILC_STATUS_ERR_BAD_CHANNEL
2205 "Bad channel name". Channel requested contained illegal characters
2208 45 SILC_STATUS_ERR_AUTH_FAILED
2210 "Authentication failed". The authentication data sent as
2211 argument were wrong and thus authentication failed.
2213 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2215 "The algorithm was not supported." The server does not support the
2216 requested algorithm.
2218 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2220 "No such Server ID". Server ID provided does not exist.
2221 The unknown Server ID MUST be provided as next argument
2224 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2226 "No more resources available". This can mean that server cannot
2227 or will not accept something due to resource limitations.
2229 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2231 "Service does not exist". Requested service identifier is
2234 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2236 "You have not been authenticated". Remote connection is not
2237 authenticated even though it is supposed to be.
2239 51 SILC_STATUS_ERR_BAD_SERVER_ID
2241 "Server ID is not valid". Provided server ID is not valid.
2243 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2245 "Key exchange failed". Key Exchange protocol failed.
2247 53 SILC_STATUS_ERR_BAD_VERSION
2249 "Bad version". Protocol or software version mismatch.
2255 3 Security Considerations
2257 Security is central to the design of this protocol, and these security
2258 considerations permeate the specification. Common security considerations
2259 such as keeping private keys truly private and using adequate lengths for
2260 symmetric and asymmetric keys must be followed in order to maintain the
2261 security of this protocol.
2267 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2268 Protocol Specification", Internet Draft, April 2001.
2270 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2273 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2274 Protocols", Internet Draft, April 2001.
2276 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2279 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2282 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2285 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2288 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2291 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2294 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2297 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2300 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2301 Infrastructure, Certificate and CRL Profile", RFC 2459,
2304 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2305 John Wiley & Sons, New York, NY, 1996.
2307 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2310 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2311 RFC 2412, November 1998.
2313 [ISAKMP] Maughan D., et al, "Internet Security Association and
2314 Key Management Protocol (ISAKMP)", RFC 2408, November
2317 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2318 (IKE)", RFC 2409, November 1998.
2320 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2321 Authentication", RFC 2104, February 1997.
2323 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2324 Specifications, Version 2.0", RFC 2437, October 1998.
2326 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2327 Requirement Levels", BCP 14, RFC 2119, March 1997.
2329 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2330 10646", RFC 2279, January 1998.
2341 Snellmanninkatu 34 A 15
2345 EMail: priikone@iki.fi
2347 This Internet-Draft expires XXX
2353 This appendix defines the usage of the <Requested Attributes> argument in
2354 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2355 and may be used to request additional information about the user. Since
2356 the information that may be requested using the attributes is something
2357 that server cannot deliver to the sender, it is possible to send the WHOIS
2358 command directly to the destination client whom will then provide the
2359 requested attributes. This requires the servers to relay the WHOIS
2360 command to the client, and it requires capability for handling the WHOIS
2361 command in the client end.
2363 The <Requested Attributes> MAY include several attributes that are
2364 requested. The format and encoding of the <Requested Attributes> is as
2365 defined in [ATTRS]. When <Requested Attributes> argument is set the
2366 server MAY process the attributes to see whether it can narrow down
2367 the WHOIS search, for example when searching with a nickname. The
2368 normal servers MUST process the WHOIS command as normal WHOIS command,
2369 that is to send the command directly to the router. The router MAY
2370 process the attributes, but it MUST send the command to the server
2371 that owns the requested client.
2373 The server that owns the client and receives the command MUST check
2374 whether the client is detached from the network. If it is detached,
2375 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2376 process the attributes and provide as many of the requested attributes
2377 as possible and then send reply back to the sender. If the client is
2378 active in the network it MUST send the command to the client for
2381 The client receiving WHOIS command SHOULD check whether the
2382 <Requested Attributes> argument is set. If it is not set then the
2383 WHOIS command SHOULD be discarded. The client processes the requested
2384 attributes and SHOULD reply to each of the requested attribute with
2385 either valid value, or with an indication that the requested attribute
2386 is not known or supported. This is to be done as defined in [ATTRS].
2387 The client always MUST send a reply to the command when some attributes
2388 were requested. The client MAY also add additional attributes to the
2389 reply even if they were not requested. The client MAY also digitally
2390 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2391 in [ATTRS]. Then the client sends the reply back to the sender of
2392 the command. The command reply that client assembles does not need
2393 to include any other argument but the <Status Payload> (1), and the
2394 <Attributes> (11). The server receiving reply from client MUST allow
2395 this sort of command reply for WHOIS command.
2397 The information received from the client MAY be cached in the
2398 server's end. The caching may be desired for example if the client
2399 can be detached from the network. This way the server is then able
2400 to provide at least partial information for a requestor. The
2401 server MAY also process the command reply and verify whether the
2402 attributes provided in the reply are actually valid. If it can do
2403 this, and verify that they indeed are valid values it MAY append
2404 a digital signature at the end of the attributes with the
2405 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2406 server then MUST provide valid WHOIS command reply to the sender
2407 of the command. Other servers and routers that receive the command
2408 reply enroute to the original sender MAY also cache the information.
2410 The client which receives the command reply to the WHOIS command
2411 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2412 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
projects / silc.git / blob