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_TOO_MANY_TARGETS
194 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195 SILC_STATUS_ERR_NO_SUCH_NICK
197 Every command reply also defines set of status message that it
198 may return inside the <Status Payload>. All status messages
199 are defined in the section 2.3 SILC Command Status Payload
202 Every command that has some kind of ID as argument (for example
203 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
204 the type of the ID, length of the ID and the actual ID data. This
205 way variable length ID's can be sent as arguments. Also note that
206 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
211 2.2 SILC Commands List
213 This section lists all SILC commands, however, it is expected that a
214 implementation and especially client implementation has many more
215 commands that has only local affect. These commands are official
216 SILC commands that has both client and server sides and cannot be
217 characterized as local commands.
219 List of all defined commands in SILC follows.
224 None. This is reserved command and MUST NOT be sent.
230 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
231 (3) [<Requested Attributes>] (4) [<Client ID>]
234 Whois command is used to query various information about specific
235 user. The user may be requested by their nickname and server name.
236 The query may find multiple matching users as there are no unique
237 nicknames in the SILC. The <count> option may be given to narrow
238 down the number of accepted results. If this is not defined there
239 are no limit of accepted results. The query may also be narrowed
240 down by defining the server name of the nickname. The <count> is
241 32 bit MSB first order integer.
243 It is also possible to search the user by Client ID. If the
244 <Client ID> is provided server MUST use it as the search value
245 instead of the <nickname>. One of the arguments MUST be given.
246 It is also possible to define multiple Client ID's to search
247 multiple users sending only one WHOIS command. In this case the
248 Client ID's are appended as normal arguments.
250 To prevent miss-use of this command wildcards in the nickname
251 or in the server name are not permitted. It is not allowed
252 to request all users on some server. The WHOIS requests MUST
253 be based on explicit nickname request.
255 The WHOIS request MUST be always sent to the router by server
256 so that all users are searched. However, the server still MUST
257 search its locally connected clients. The router MUST send
258 this command to the server which owns the requested client, if
259 the router is unable to provide all mandatory information about
260 the client. That server MUST reply to the command. Server MUST
261 NOT send whois replies to the client until it has received the
262 reply from its router.
264 The <Requested Attributes> is defined in [ATTRS] and can be used
265 to request various information about the client. See Appendix A
266 for definition of using these attributes in SILC.
268 Reply messages to the command:
271 Arguments: (1) <Status Payload> (2) <Client ID>
272 (3) <nickname>[@<server>] (4) <username@host>
273 (5) <real name> (6) [<Channel Payload
275 (7) [<user mode>] (8) [<idle time>]
276 (9) [<fingerprint>] (10) <channel user
281 This command may reply with several command reply messages to
282 form a list of results. In this case the status payload will
283 include STATUS_LIST_START status in the first reply and
284 STATUS_LIST_END in the last reply to indicate the end of the
285 list. If there are only one reply the status is set to normal
288 The command replies include the Client ID of the nickname,
289 nickname and server name, user name and host name and user's real
290 name. Client SHOULD process these replies only after the last
291 reply has been received with the STATUS_LIST_END status. If the
292 <count> option were defined in the query there will be only
293 <count> many replies from the server.
295 The server returns the list of channels if the client has
296 joined channels. In this case the list is list of Channel
297 Payloads. The Mode Mask in the Channel Payload is the channel's
298 mode. The list is encoded by adding the Channel Payloads one
299 after the other. Private and secret channels MUST NOT be sent,
300 except if the sender of this command is on those channels, or
301 the sender is server. The <channel user mode list> MUST also
302 be sent if client is joined channels. This list includes 32 bit
303 MSB first order values one after the other and each indicate
304 the user's mode on a channel. The order of these values MUST
305 be same as the channel order in the <Channel Payload list>.
307 The server also returns client's user mode, idle time, and the
308 fingerprint of the client's public key. The <fingerprint> is the
309 binary hash digest of the public key. The fingerprint MUST NOT
310 be sent if the server has not verified the proof of posession of
311 the corresponding private key. Server can do this during the
312 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
314 The <Attributes> is the reply to the <Requested Attributes>.
315 See the Appendix A for more information.
320 SILC_STATUS_LIST_START
322 SILC_STATUS_ERR_NO_SUCH_NICK
323 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
324 SILC_STATUS_ERR_WILDCARDS
325 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
326 SILC_STATUS_ERR_TOO_MANY_PARAMS
329 2 SILC_COMMAND_WHOWAS
332 Arguments: (1) <nickname>[@<server>] (2) [<count>]
334 Whowas. This command is used to query history information about
335 specific user. The user may be requested by their nickname and
336 server name. The query may find multiple matching users as there
337 are no unique nicknames in the SILC. The <count> option may be
338 given to narrow down the number of accepted results. If this
339 is not defined there are no limit of accepted results. The query
340 may also be narrowed down by defining the server name of the
341 nickname. The <count> is 32 bit MSB first order integer.
343 To prevent miss-use of this command wildcards in the nickname
344 or in the server name are not permitted. The WHOWAS requests MUST
345 be based on specific nickname request.
347 The WHOWAS request MUST be always sent to the router by server
348 so that all users are searched. However, the server still must
349 search its locally connected clients.
351 Reply messages to the command:
354 Arguments: (1) <Status Payload> (2) <Client ID>
355 (3) <nickname>[@<server>] (4) <username@host>
358 This command may reply with several command reply messages to form
359 a list of results. In this case the status payload will include
360 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
361 the last reply to indicate the end of the list. If there are only
362 one reply the status is set to normal STATUS_OK.
364 The command replies with nickname and user name and host name.
365 Every server MUST keep history for some period of time of its
366 locally connected clients.
371 SILC_STATUS_LIST_START
373 SILC_STATUS_ERR_NO_SUCH_NICK
374 SILC_STATUS_ERR_WILDCARDS
375 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
376 SILC_STATUS_ERR_TOO_MANY_PARAMS
379 3 SILC_COMMAND_IDENTIFY
382 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
383 (3) [<channel name>] (4) [<count>]
384 (5) [<ID Payload>] (n) [...]
386 Identify command is used to query information about an entity by
387 the entity's name or ID. This command can be used to query
388 information about clients, server and channels.
390 The query may find multiple matching entities. The <count> option
391 may be given to narrow down the number of accepted results. If
392 this is not defined there are no limit of accepted results. The
393 <count> is 32 bit MSB first order integer.
395 It is also possible to search the entity by its ID. If the
396 <ID Payload> is provided server must use it as the search value
397 instead of the entity's name. One of the arguments must be given.
398 It is also possible to define multiple ID Payloads to search
399 multiple entities sending only one IDENTIFY command. In this case
400 the ID Payloads are appended as normal arguments. The type of the
401 entity is defined by the type of the ID Payload.
403 To prevent miss-use of this command wildcards in the names are
404 not permitted. It is not allowed to request for example all users
407 Implementations may not want to give interface access to this
408 command as it is hardly a command that would be used by an end
409 user. However, it must be implemented as it is used with private
412 The IDENTIFY command MUST be always sent to the router by server
413 so that all users are searched. However, server MUST still search
414 its locally connected clients.
416 Reply messages to the command:
419 Arguments: (1) <Status Payload> (2) <ID Payload>
420 (3) [<entity's name>] (4) [<info>]
422 This command may reply with several command reply messages to form
423 a list of results. In this case the status payload will include
424 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
425 the last reply to indicate the end of the list. If there are only
426 one reply the status is set to normal STATUS_OK.
428 When querying clients the <entity's name> must include the client's
429 nickname in the following format: nickname[@server]. The
430 <info> must include the client's username and host in the following
431 format: username@host.
433 When querying servers the <entity's name> must include the server's
434 full name. The <info> may be omitted.
436 When querying channels the <entity's name> must include the
437 channel's name. The <info> may be omitted.
439 If the <count> option were defined in the query there will be only
440 <count> many replies from the server.
445 SILC_STATUS_LIST_START
447 SILC_STATUS_ERR_NO_SUCH_NICK
448 SILC_STATUS_ERR_NO_SUCH_SERVER
449 SILC_STATUS_ERR_NO_SUCH_CHANNEL
450 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
451 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
452 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
453 SILC_STATUS_ERR_WILDCARDS
454 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
455 SILC_STATUS_ERR_TOO_MANY_PARAMS
461 Arguments: (1) <nickname>
463 Set/change nickname. This command is used to set nickname for
464 user. Nickname MUST NOT include any spaces (` '), non-printable
465 characters, commas (`,') and any wildcard characters.
467 When nickname is changed new Client ID is generated. Server MUST
468 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
469 channels (if any) the client is joined on. Then it MUST send
470 SILC_PACKET_REPLACE_ID to its primary route to replace the old
471 Client ID with the new one.
473 Reply messages to the command:
476 Arguments: (1) <Status Payload> (2) <New ID Payload>
478 This command is replied always with New ID Payload that is
479 generated by the server every time user changes their nickname.
480 Client receiving this payload MUST start using the received
481 Client ID as its current valid Client ID. The New ID Payload
482 is described in [SILC2].
487 SILC_STATUS_ERR_WILDCARDS
488 SILC_STATUS_ERR_NICKNAME_IN_USE
489 SILC_STATUS_ERR_BAD_NICKNAME
490 SILC_STATUS_ERR_NOT_REGISTERED
491 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
492 SILC_STATUS_ERR_TOO_MANY_PARAMS
498 Arguments: (1) [<Channel ID>]
500 The list command is used to list channels and their topics on the
501 current server. If the <Channel ID> parameter is used, only the
502 status of that channel is displayed. Secret channels are not
503 listed at all. Private channels are listed with status indicating
504 that the channel is private. Router MAY reply with all channels
507 Reply messages to the command:
510 Arguments: (1) <Status Payload> (2) <Channel ID>
511 (3) <channel> (4) [<topic>]
514 This command may reply with several command reply messages to form
515 a list of results. In this case the status payload will include
516 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
517 the last reply to indicate the end of the list. If there are only
518 one reply the status is set to normal STATUS_OK.
520 This command replies with Channel ID, name and the topic of the
521 channel. If the channel is private channel the <topic> SHOULD
522 include the "*private*" string.
527 SILC_STATUS_LIST_START
529 SILC_STATUS_ERR_WILDCARDS
530 SILC_STATUS_ERR_NOT_REGISTERED
531 SILC_STATUS_ERR_TOO_MANY_PARAMS
532 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
533 SILC_STATUS_ERR_NO_CHANNEL_ID
534 SILC_STATUS_ERR_NO_SUCH_SERVER
540 Arguments: (1) <Channel ID> (2) [<topic>]
542 This command is used to change or view the topic of a channel.
543 The topic for channel <Channel ID> is returned if there is no
544 <topic> given. If the <topic> parameter is present, the topic
545 for that channel will be changed, if the channel modes permit
548 After setting the topic the server MUST send the notify type
549 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
550 the channel which topic was changed.
552 Reply messages to the command:
555 Arguments: (1) <Status Payload> (2) <Channel ID>
558 The command may reply with the topic of the channel if it is
564 SILC_STATUS_ERR_NOT_ON_CHANNEL
565 SILC_STATUS_ERR_WILDCARDS
566 SILC_STATUS_ERR_NOT_REGISTERED
567 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
568 SILC_STATUS_ERR_NO_SUCH_CHANNEL
569 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
570 SILC_STATUS_ERR_NO_CHANNEL_ID
571 SILC_STATUS_ERR_BAD_CHANNEL_ID
572 SILC_STATUS_ERR_TOO_MANY_PARAMS
573 SILC_STATUS_ERR_NO_CHANNEL_PRIV
576 7 SILC_COMMAND_INVITE
579 Arguments: (1) <Channel ID> (2) [<Client ID>]
580 (3) [<adding client>] (4) [<removing client>]
582 This command is used to invite other clients to join to the
583 channel. The <Client ID> argument is the target client's ID that
584 is being invited. The <Channel ID> is the Channel ID of the
585 requested channel. The sender of this command MUST be on the
586 channel. The server MUST also send the notify type
587 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
588 client indicated by the <Client ID>.
590 The <adding client> and <removing client> can be used to add to
591 and remove from the invite list. The format of the <adding client>
592 and <removing client> is as follows:
594 [<nickname>[@<server>]!][<username>]@[<hostname>]
596 When adding to or removing from the invite list the server MUST
597 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
598 and MUST NOT send it to the client which was added to the list.
599 The client which executes this command MUST have at least channel
600 operator privileges to be able to add to or remove from the invite
601 list. The wildcards MAY be used with this command. If adding or
602 removing more than one client then the lists are an comma (`,')
605 Note that the <Client ID> provided MUST be resolved into correct
606 nickname and host name and add to the invite list before sending
609 When this command is given with only <Channel ID> argument then
610 the command merely returns the invite list of the channel. This
611 command MUST fail if the requested channel does not exist, the
612 requested <Client ID> is already on the channel or if the channel
613 is invite only channel and the caller of this command does not
614 have at least channel operator privileges.
616 Reply messages to the command:
619 Arguments: (1) <Status Payload> (2) <Channel ID>
622 This command replies with the invite list of the channel if it
628 SILC_STATUS_ERR_NOT_REGISTERED
629 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
630 SILC_STATUS_ERR_TOO_MANY_PARAMS
631 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
632 SILC_STATUS_ERR_NO_CLIENT_ID
633 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
634 SILC_STATUS_ERR_NO_CHANNEL_ID
635 SILC_STATUS_ERR_NOT_ON_CHANNEL
636 SILC_STATUS_ERR_USER_ON_CHANNEL
637 SILC_STATUS_ERR_NO_CHANNEL_PRIV
638 SILC_STATUS_ERR_RESOURCE_LIMIT
644 Arguments: (1) [<quit message>]
646 This command is used by client to end SILC session. The server
647 must close the connection to a client which sends this command.
648 if <quit message> is given it will be sent to other clients on
649 channel if the client is on channel when quitting.
651 Reply messages to the command:
653 This command does not reply anything.
659 Arguments: (1) <Client ID> (2) [<comment>]
661 This command is used by SILC operators to remove a client from
662 SILC network. The removing has temporary effects and client may
663 reconnect to SILC network. The <Client ID> is the client to be
664 removed from SILC. The <comment> argument may be provided to
665 give to the removed client some information why it was removed
668 When killing a client the router MUST first send notify type
669 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
670 The packet MUST NOT be sent to the killed client on the channels.
671 Then, the router MUST send the same notify type to its primary
672 router. Finally, the router MUST send the same notify type
673 directly to the client which was killed.
675 Reply messages to the command:
678 Arguments: (1) <Status Payload>
680 This command replies only with Status Payload.
685 SILC_STATUS_ERR_WILDCARDS
686 SILC_STATUS_ERR_NOT_REGISTERED
687 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
688 SILC_STATUS_ERR_TOO_MANY_PARAMS
689 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
690 SILC_STATUS_ERR_NO_CLIENT_ID
691 SILC_STATUS_ERR_NO_ROUTER_PRIV
697 Arguments: (1) [<server>] (2) [<Server ID>]
699 This command is used to fetch various information about a server.
700 If <server> argument is specified the command MUST be sent to
701 the requested server.
703 If the <Server ID> is specified the server information if fetched
704 by the provided Server ID. One of the arguments must always be
707 Reply messages to the command:
710 Arguments: (1) <Status Payload> (2) <Server ID>
711 (3) <server name> (4) <string>
713 This command replies with the Server ID of the server and a
714 string which tells the information about the server.
719 SILC_STATUS_ERR_WILDCARDS
720 SILC_STATUS_ERR_NOT_REGISTERED
721 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
722 SILC_STATUS_ERR_TOO_MANY_PARAMS
723 SILC_STATUS_ERR_NO_SUCH_SERVER
724 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
725 SILC_STATUS_ERR_NO_SERVER_ID
728 11 SILC_COMMAND_STATS
731 Arguments: (1) <Server ID>
733 This command is used to fetch various statistical information
734 from the server indicated by <Server ID>, which is the ID of
735 server where sender is connected to. Server receiving this
736 command MAY also send this further to its router for fetching
737 other cell and network wide statistics to accompany the reply.
739 Reply messages to the command:
742 Arguments: (1) <Status Payload> (2) <Server ID>
743 (3) [<statistics structure>]
745 This command replies with the Server ID of the server and
746 optional statistics structure which includes 32 bit MSB first
747 ordered integer values to represent various statistical
748 information. The structure is as follows:
750 starttime - time when server was started
751 uptime - uptime of the server
752 my clients - number of locally connected clients
753 my channels - number of locally created channels
754 my server ops - number of local server operators
755 my router ops - number of local router operators
756 cell clients - number of clients in local cell
757 cell channels - number of channels in local cell
758 cell servers - number of servers in local cell
759 clients - number of client in SILC network
760 channels - number of channels in SILC network
761 servers - number of servers in SILC network
762 routers - number of routers in SILC network
763 server ops - number of server operators in SILC network
764 router ops - number of router operators in SILC network
766 If some value is unknown it is set to zero (0) value. The
767 "starttime" is the start time of the server, and is seconds
768 since Epoch (POSIX.1). The "uptime" is time difference of
769 current time and "starttime" in the server, and is seconds
775 SILC_STATUS_ERR_NOT_REGISTERED
776 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
777 SILC_STATUS_ERR_TOO_MANY_PARAMS
778 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
779 SILC_STATUS_ERR_NO_SUCH_SERVER
780 SILC_STATUS_ERR_NO_SERVER_ID
786 Arguments: (1) <Server ID>
788 This command is used by client and server to test the communication
789 channel to its server if one suspects that the communication is not
790 working correctly. The <Server ID> is the ID of the server the
791 sender is connected to.
793 Reply messages to the command:
796 Arguments: (1) <Status Payload>
798 This command replies only with Status Payload. Server returns
799 SILC_STATUS_OK in Status Payload if pinging was successful.
806 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
807 SILC_STATUS_ERR_TOO_MANY_PARAMS
808 SILC_STATUS_ERR_NO_SERVER_ID
809 SILC_STATUS_ERR_NO_SUCH_SERVER
810 SILC_STATUS_ERR_NOT_REGISTERED
816 Arguments: (1) <username> (2) <authentication payload>
818 This command is used by normal client to obtain server operator
819 privileges on some server or router. Note that router operator
820 has router privileges that supersedes the server operator
821 privileges and this does not obtain those privileges. Client
822 MUST use SILCOPER command to obtain router level privileges.
824 The <username> is the username set in the server configurations
825 as operator. The <authentication payload> is the data that the
826 client is authenticated against. It may be passphrase prompted
827 for user on client's screen or it may be public key or certificate
828 authentication data (data signed with private key). The public
829 key that server will use to verify the signature found in the
830 payload should be verified. It is recommended that the public
831 key is saved locally in the server and server would not use
832 any public keys received during the SKE.
834 After changing the mode the server MUST send the notify type
835 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
837 Reply messages to the command:
840 Arguments: (1) <Status Payload>
842 This command replies only with Status Payload.
847 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
848 SILC_STATUS_ERR_TOO_MANY_PARAMS
849 SILC_STATUS_ERR_NOT_REGISTERED
850 SILC_STATUS_ERR_AUTH_FAILED
856 Arguments: (1) <channel> (2) <Client ID>
857 (3) [<passphrase>] (4) [<cipher>]
858 (5) [<hmac>] (6) [<founder auth>]
860 Join to channel/create new channel. This command is used to
861 join to a channel. If the channel does not exist the channel is
862 created. If server is normal server this command MUST be sent
863 to router which will create the channel. The channel MAY be
864 protected with passphrase. If this is the case the passphrase
865 MUST be sent along the join command.
867 The name of the <channel> MUST NOT include any spaces (` '),
868 non-printable characters, commas (`,') or any wildcard characters.
870 The second argument <Client ID> is the Client ID of the client
871 which is joining to the client. When client sends this command
872 to the server the <Client ID> MUST be the client's own ID.
874 Cipher to be used to secure the traffic on the channel MAY be
875 requested by sending the name of the requested <cipher>. This
876 is used only if the channel does not exist and is created. If
877 the channel already exists the cipher set previously for the
878 channel will be used to secure the traffic. The computed MACs
879 of the channel message are produced by the default HMAC or by
880 the <hmac> provided for the command.
882 The <founder auth> is Authentication Payload providing the
883 authentication for gaining founder privileges on the channel
884 when joining the channel. The client may provide this if it
885 knows that it is the founder of the channel and that the
886 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
887 MUST verify whether the client is able to gain the founder
888 privileges the same way as the client had given the
889 SILC_COMMAND_CUMODE command to gain founder privileges. The
890 client is still able to join the channel even if the founder
891 privileges could not be gained.
893 The server MUST check whether the user is allowed to join to
894 the requested channel. Various modes set to the channel affect
895 the ability of the user to join the channel. These conditions
898 o The user MUST be invited to the channel if the channel
899 is invite-only channel.
901 o The Client ID/nickname/username/host name MUST NOT match
904 o The correct passphrase MUST be provided if passphrase
905 is set to the channel.
907 o The user count limit, if set, MUST NOT be reached.
909 If the client provided correct <founder auth> payload it can
910 override these conditions, except the condition for the passphrase.
911 The correct passphrase MUST be provided even if <founder auth>
914 Reply messages to the command:
917 Arguments: (1) <Status Payload> (2) <channel>
918 (3) <Channel ID> (4) <Client ID>
919 (5) <channel mode mask> (6) <created>
920 (7) [<Channel Key Payload>] (8) [<ban list>]
921 (9) [<invite list>] (10) [<topic>]
922 (11) [<hmac>] (12) <list count>
923 (13) <Client ID list> (14) <client mode list>
925 This command replies with the channel name requested by the
926 client, channel ID of the channel and topic of the channel
927 if it exists. The <Client ID> is the Client ID which was joined
928 to the channel. It also replies with the channel mode mask
929 which tells all the modes set on the channel. If the
930 channel is created the mode mask is zero (0). If ban mask
931 and/or invite list is set they are sent as well.
933 The <list count>, <Client ID list> and <client mode list> are
934 the clients currently on the channel and their modes on the
935 channel. The <Client ID list> is formed by adding the ID Payloads
936 one after the other. The <client mode list> is formed by adding
937 32 bit MSB first order values one after the other.
939 Client receives the channel key in the reply message as well
940 inside <Channel Key Payload>.
945 SILC_STATUS_ERR_WILDCARDS
946 SILC_STATUS_ERR_NOT_REGISTERED
947 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
948 SILC_STATUS_ERR_TOO_MANY_PARAMS
949 SILC_STATUS_ERR_BAD_PASSWORD
950 SILC_STATUS_ERR_CHANNEL_IS_FULL
951 SILC_STATUS_ERR_NOT_INVITED
952 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
953 SILC_STATUS_ERR_BAD_CHANNEL
954 SILC_STATUS_ERR_USER_ON_CHANNEL
960 Arguments: (1) <server>
962 This command is used to query the Message of the Day of the server.
964 Reply messages to the command:
967 Arguments: (1) <Status Payload> (2) <Server ID>
970 This command replies with the motd message if it exists.
975 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
976 SILC_STATUS_ERR_TOO_MANY_PARAMS
977 SILC_STATUS_ERR_NOT_REGISTERED
978 SILC_STATUS_ERR_NO_SUCH_SERVER
981 16 SILC_COMMAND_UMODE
984 Arguments: (1) <Client ID> (2) [<client mode mask>]
986 This command is used by client to set/unset modes for itself.
987 However, there are some modes that the client MUST NOT set itself,
988 but they will be set by server. However, client MAY unset any
989 mode. Modes may be masked together ORing them thus having
990 several modes set. Client MUST keep its client mode mask
991 locally so that the mode setting/unsetting would work without
992 problems. Client may change only its own modes.
994 After changing the mode server MUST send the notify type
995 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
997 The following client modes are defined:
999 0x00000000 SILC_UMODE_NONE
1001 No specific mode for client. This is the initial
1002 setting when new client is created. The client is
1003 normal client and is present in the network.
1006 0x00000001 SILC_UMODE_SERVER_OPERATOR
1008 Marks the user as server operator. Client MUST NOT
1009 set this mode itself. Server sets this mode to the
1010 client when client attains the server operator
1011 privileges by SILC_COMMAND_OPER command. Client
1012 MAY unset the mode itself.
1015 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1017 Marks the user as router (SILC) operator. Client
1018 MUST NOT set this mode itself. Router sets this mode
1019 to the client when client attains the router operator
1020 privileges by SILC_COMMAND_SILCOPER command. Client
1021 MAY unset the mode itself.
1024 0x00000004 SILC_UMODE_GONE
1026 Marks that the user is not currently present in the
1027 SILC Network. Client MAY set and unset this mode.
1030 0x00000008 SILC_UMODE_INDISPOSED
1032 Marks that the user is currently indisposed and may
1033 not be able to receive any messages, and that user may
1034 not be present in the network. Client MAY set and
1038 0x00000010 SILC_UMODE_BUSY
1040 Marks that the user is currently busy and may not
1041 want to receive any messages, and that user may not
1042 be present in the network. Client MAY set and unset
1046 0x00000020 SILC_UMODE_PAGE
1048 User is not currently present or is unable to receive
1049 messages, and prefers to be paged in some mechanism
1050 if the user needs to be reached. Client MAY set and
1054 0x00000040 SILC_UMODE_HYPER
1056 Marks that the user is hyper active and is eager to
1057 receive and send messages. Client MAY set and unset
1061 0x00000080 SILC_UMODE_ROBOT
1063 Marks that the client is actually a robot program.
1064 Client MAY set and unset this mode.
1067 0x00000100 SILC_UMODE_ANONYMOUS
1069 Marks that the client is anonymous client. Server
1070 that specificly is designed for anonymous services
1071 can set and unset this mode. Client MUST NOT set or
1072 unset this mode itself. A client with this mode set
1073 would have the username and the hostname information
1074 scrambled by the server which set this mode.
1077 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1079 Marks that the client wishes to block private
1080 messages sent to the client, unless the Private
1081 Message Key flag is set in the SILC packet header.
1082 If this mode is set server MUST NOT deliver private
1083 messages to the client without the Private Message
1084 Key flag being set. The Private Message Key flag set
1085 indicates that the private message is protected with
1086 a key shared between the sender and the recipient.
1088 A separate service could provide additional filtering
1089 features for accepting private messages from certain
1090 sender. However, this document does not specify such
1093 The client MAY set and unset this mode.
1096 0x00000400 SILC_UMODE_DETACHED
1098 Marks that the client is detached from the SILC network.
1099 This means that the actual network connection to the
1100 client is lost but the client entry is still valid. The
1101 detached client can be resumed at a later time. This
1102 mode MUST NOT be set by client. It can only be set when
1103 client has issued command SILC_COMMAND_DETACH. The server
1104 sets this mode. This mode cannot be unset with this
1105 command. It is unset when the client is resuming back to
1106 the network and SILC_PACKET_RESUME_CLIENT packet is
1109 This flag MUST NOT be used to determine whether a packet
1110 can be sent to the client or not. Only the server that
1111 had the original client connection can make the decision
1112 by knowing that the network connection is not active.
1113 In this case the default case is to discard the packet.
1116 0x00000800 SILC_UMODE_REJECT_WATCHING
1118 Marks that the client rejects that it could be watched
1119 by someone else. If this mode is set notifications about
1120 this client is not send, even if someone is watching the
1121 same nickname this client has. Client MAY set and unset
1122 this mode. Any changes for this client MUST NOT be
1123 notified to any watcher when this mode is set.
1125 A separate service could provide additional filtering
1126 features for rejecting and accepting the watching from
1127 certain users. However, this document does not specify
1130 If the <client mode mask> was not provided this command merely
1131 returns the mode mask to the client.
1134 Reply messages to the command:
1137 Arguments: (1) <Status Payload> (2) <client mode mask>
1139 This command replies with the changed client mode mask that
1140 the client MUST to keep locally.
1146 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1147 SILC_STATUS_ERR_TOO_MANY_PARAMS
1148 SILC_STATUS_ERR_NOT_REGISTERED
1149 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1150 SILC_STATUS_ERR_BAD_CLIENT_ID
1151 SILC_STATUS_ERR_NOT_YOU
1152 SILC_STATUS_ERR_PERM_DENIED
1153 SILC_STATUS_ERR_UNKNOWN_MODE
1154 SILC_STATUS_ERR_NO_CLIENT_ID
1157 17 SILC_COMMAND_CMODE
1160 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1161 (3) [<user limit>] (4) [<passphrase>]
1162 (5) [<cipher>] (6) [<hmac>]
1163 (7) [<auth payload>]
1165 This command is used by client to set or change channel flags on
1166 a channel. Channel has several modes that set various properties
1167 of a channel. Modes may be masked together by ORing them thus
1168 having several modes set. The <Channel ID> is the ID of the
1169 target channel. The client changing channel mode MUST be on
1170 the same channel and poses sufficient privileges to be able to
1173 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1174 type MUST be distributed to the channel.
1176 The following channel modes are defined:
1178 0x00000000 SILC_CMODE_NONE
1180 No specific mode on channel. This is the default when
1181 channel is created. This means that channel is just plain
1185 0x00000001 SILC_CMODE_PRIVATE
1187 Channel is private channel. Private channels are shown
1188 in the channel list listed with SILC_COMMAND_LIST command
1189 with indication that the channel is private. Also,
1190 client on private channel will no be detected to be on
1191 the channel as the channel is not shown in the client's
1192 currently joined channel list. Channel founder and
1193 channel operator MAY set/unset this mode.
1195 Typical implementation would use [+|-]p on user interface
1196 to set/unset this mode.
1199 0x00000002 SILC_CMODE_SECRET
1201 Channel is secret channel. Secret channels are not shown
1202 in the list listed with SILC_COMMAND_LIST command. Secret
1203 channels can be considered to be invisible channels.
1204 Channel founder and channel operator MAY set/unset this
1207 Typical implementation would use [+|-]s on user interface
1208 to set/unset this mode.
1211 0x00000004 SILC_CMODE_PRIVKEY
1213 Channel uses private channel key to protect the traffic
1214 on the channel. When this mode is set the client will be
1215 responsible to set the key it wants to use to encrypt and
1216 decrypt the traffic on channel. Server generated channel
1217 keys are not used at all. This mode provides additional
1218 security as clients on channel may agree to use private
1219 channel key that even servers do not know. Naturally,
1220 this requires that every client on the channel knows
1221 the key before hand (it is considered to be pre-shared-
1222 key). The key material is RECOMMENDED to be processed
1223 as stated in the [SILC3] in the section Processing the
1226 As it is local setting it is possible to have several
1227 private channel keys on one channel. In this case several
1228 clients can talk on same channel but only those clients
1229 that share the key with the message sender will be able
1230 to hear the talking. Client SHOULD NOT display those
1231 message for the end user that it is not able to decrypt
1232 when this mode is set.
1234 Only channel founder MAY set/unset this mode. If this
1235 mode is unset the server will distribute new channel
1236 key to all clients on the channel which will be used
1239 Typical implementation would use [+|-]k on user interface
1240 to set/unset this mode.
1243 0x00000008 SILC_CMODE_INVITE
1245 Channel is invite only channel. Client may join to this
1246 channel only if it is invited to the channel. Channel
1247 founder and channel operator MAY set/unset this mode.
1249 Typical implementation would use [+|-]i on user interface
1250 to set/unset this mode.
1253 0x00000010 SILC_CMODE_TOPIC
1255 The topic of the channel may only be set by client that
1256 is channel founder or channel operator. Normal clients
1257 on channel will not be able to set topic when this mode
1258 is set. Channel founder and channel operator MAY set/
1261 Typical implementation would use [+|-]t on user interface
1262 to set/unset this mode.
1265 0x00000020 SILC_CMODE_ULIMIT
1267 User limit has been set to the channel. New clients
1268 may not join to the channel when the limit set is
1269 reached. Channel founder and channel operator MAY set/
1270 unset the limit. The <user limit> argument is the
1271 number of limited users.
1273 Typical implementation would use [+|-]l on user interface
1274 to set/unset this mode.
1277 0x00000040 SILC_CMODE_PASSPHRASE
1279 Passphrase has been set to the channel. Client may
1280 join to the channel only if it is able to provide the
1281 correct passphrase. Setting passphrases to channel
1282 is entirely safe as all commands are protected in the
1283 SILC network. Only channel founder MAY set/unset
1284 the passphrase. The <passphrase> argument is the
1287 Typical implementation would use [+|-]a on user interface
1288 to set/unset this mode.
1291 0x00000080 SILC_CMODE_CIPHER
1293 Sets specific cipher to be used to protect channel
1294 traffic. The <cipher> argument is the requested cipher.
1295 When set or unset the server must re-generate new
1296 channel key. Only channel founder MAY set the cipher of
1297 the channel. When unset the new key is generated using
1298 default cipher for the channel.
1300 Typical implementation would use [+|-]c on user interface
1301 to set/unset this mode.
1304 0x00000100 SILC_CMODE_HMAC
1306 Sets specific hmac to be used to compute the MACs of the
1307 channel message. The <hmac> argument is the requested hmac.
1308 Only channel founder may set the hmac of the channel.
1310 Typical implementation would use [+|-]h on user interface
1311 to set/unset this mode.
1314 0x00000200 SILC_CMODE_FOUNDER_AUTH
1316 Channel founder may set this mode to be able to regain
1317 channel founder rights even if the client leaves the
1318 channel. The <auth payload> is the Authentication Payload
1319 consisting of the authentication method and authentication
1320 data to be used in the authentication. The server MUST
1321 NOT accept NONE authentication method. Also, if the
1322 method is public key authentication the server MUST NOT
1323 save the authentication data from the payload as the
1324 data is different on all authentications. In this case the
1325 server only saves the authentication method. However,
1326 server MUST verify the sent authentication payload and
1327 set the mode only if the verification was successful.
1329 Note that this mode is effective only in the current server.
1330 The client MUST connect to the same server later to be able
1331 to regain the channel founder rights. The server MUST save
1332 the public key of the channel founder and use that to identify
1333 the client which is claiming the channel founder rights.
1334 The rights may be claimed by the SILC_CUMODE_FOUNDER
1335 channel user mode using SILC_COMMAND_CUMODE command. The
1336 set authentication data remains valid as long as the channel
1337 exists or until the founder unsets this mode.
1339 Typical implementation would use [+|-]f on user interface
1340 to set/unset this mode.
1343 0x00000400 SILC_CMODE_SILENCE_USERS
1345 Channel founder may set this mode to silence normal users
1346 on the channel. Users with operator privileges are not
1347 affected by this mode. Messages sent by normal users
1348 are dropped by servers when this mode is set. This mode
1349 can be used to moderate the channel. Only channel founder
1350 may set/unset this mode.
1353 0x00000800 SILC_CMODE_SILENCE_OPERS
1355 Channel founder may set this mode to silence operators
1356 on the channel. When used with SILC_CMODE_SILENCE_USERS
1357 mode this can be used to set the channel in state where only
1358 the founder of the channel may send messages to the channel.
1359 Messages sent by operators are dropped by servers when this
1360 mode is set. Only channel founder may set/unset this mode.
1363 To make the mode system work, client MUST keep the channel mode
1364 mask locally so that the mode setting and unsetting would work
1365 without problems. The client receives the initial channel mode
1366 mask when it joins to the channel. When the mode changes on
1367 channel the server MUST distribute the changed channel mode mask
1368 to all clients on the channel by sending the notify type
1369 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1370 to the server's primary router. If the <channel mode mask> was
1371 not provided this command merely returns the mode mask to the
1374 Reply messages to the command:
1377 Arguments: (1) <Status Payload> (2) <Channel ID>
1378 (3) <channel mode mask>
1380 This command replies with the changed channel mode mask that
1381 client MUST keep locally.
1386 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1387 SILC_STATUS_ERR_TOO_MANY_PARAMS
1388 SILC_STATUS_ERR_NOT_REGISTERED
1389 SILC_STATUS_ERR_NOT_ON_CHANNEL
1390 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1391 SILC_STATUS_ERR_BAD_CHANNEL_ID
1392 SILC_STATUS_ERR_NO_CHANNEL_ID
1393 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1394 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1395 SILC_STATUS_ERR_UNKNOWN_MODE
1396 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1397 SILC_STATUS_ERR_AUTH_FAILED
1400 18 SILC_COMMAND_CUMODE
1403 Arguments: (1) <Channel ID> (2) <mode mask>
1404 (3) <Client ID> (4) [<auth payload>]
1406 This command is used by client to change channel user modes on
1407 channel. Users on channel may have some special modes and this
1408 command is used by channel operators to set or change these modes.
1409 The <Channel ID> is the ID of the target channel. The <mode mask>
1410 is OR'ed mask of modes. The <Client ID> is the target client.
1411 The client changing channel user modes MUST be on the same channel
1412 as the target client and poses sufficient privileges to be able to
1415 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1416 type is distributed to the channel.
1418 The following channel modes are defined:
1420 0x00000000 SILC_CUMODE_NONE
1422 No specific mode. This is the normal situation for client.
1423 Also, this is the mode set when removing all modes from
1427 0x00000001 SILC_CUMODE_FOUNDER
1429 The client is channel founder of the channel. Usually this
1430 mode is set only by the server when the channel was created.
1431 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1432 been set, the client can claim channel founder privileges
1433 by providing the <auth payload> that the server will use
1434 to authenticate the client. The public key that server will
1435 use to verify the <auth payload> must the same public key
1436 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1437 mode was set. The client MAY remove this mode at any time.
1440 0x00000002 SILC_CUMODE_OPERATOR
1442 Sets channel operator privileges on the channel for a
1443 client on the channel. Channel founder and channel operator
1444 MAY set/unset this mode. The client MAY remove this mode
1448 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1450 Marks that the client wishes not to receive any channel
1451 messages sent for the channel. Client MAY set and unset
1452 this mode to itself. Client MUST NOT set it to anyone else.
1453 When this mode is set server MUST NOT deliver channel
1454 messages to this client. Other packets such as channel
1455 key packets are still sent to the client.
1457 A separate service could provide additional filtering
1458 features for accepting channel messages from certain
1459 sender. However, this document does not specify such
1463 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1465 Marks that the client wishes not to receive any channel
1466 messages sent from normal users. Only messages sent by
1467 channel founder or channel operator is accepted. Client
1468 MAY set and unset this mode to itself. Client MUST NOT
1469 set it to anyone else. When this mode is set server MUST
1470 NOT deliver channel messages that are sent by normal users
1473 A separate service could provide additional filtering
1474 features for accepting channel messages from certain
1475 sender. However, this document does not specify such
1479 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1481 Marks that the client wishes not to receive any channel
1482 messages sent from robots. Messages sent by Users with
1483 the SILC_UMODE_ROBOT user mode set are not delivered.
1484 Client MAY set and unset this mode to itself. Client MUST
1485 NOT set it to anyone else. When this mode is set server
1486 MUST NOT deliver channel messages that are sent by robots
1490 Reply messages to the command:
1493 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1494 (3) <Channel ID> (4) <Client ID>
1496 This command replies with the changed channel user mode mask that
1497 client MUST keep locally. The <Channel ID> is the specified
1498 channel. The <Client ID> is the target client.
1503 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1504 SILC_STATUS_ERR_TOO_MANY_PARAMS
1505 SILC_STATUS_ERR_NOT_REGISTERED
1506 SILC_STATUS_ERR_NOT_ON_CHANNEL
1507 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1508 SILC_STATUS_ERR_BAD_CHANNEL_ID
1509 SILC_STATUS_ERR_NO_CHANNEL_ID
1510 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1511 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1512 SILC_STATUS_ERR_UNKNOWN_MODE
1513 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1514 SILC_STATUS_ERR_AUTH_FAILED
1517 19 SILC_COMMAND_KICK
1520 Arguments: (1) <Channel ID> (2) <Client ID>
1523 This command is used by channel operators to remove a client from
1524 channel. The <channel> argument is the channel the client to be
1525 removed is on currently. Note that the "kicker" must be on the same
1526 channel. If <comment> is provided it will be sent to the removed
1529 After kicking the client the server MUST send the notify type
1530 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1531 The channel key MUST also be re-generated after kicking, unless
1532 the SILC_CMODE_PRIVKEY mode is set.
1534 Reply messages to the command:
1537 Arguments: (1) <Status Payload>
1539 This command replies only with Status Payload.
1544 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1545 SILC_STATUS_ERR_TOO_MANY_PARAMS
1546 SILC_STATUS_ERR_NOT_REGISTERED
1547 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1548 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1549 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1550 SILC_STATUS_ERR_NO_CLIENT_ID
1556 Arguments: (1) <Channel ID> (2) [<adding client>]
1557 (3) [<removing client>]
1559 This command is used to manage the ban list of the channel
1560 indicated by the <Channel ID>. A client that is banned from
1561 channel is no longer able to join the channel. The client which
1562 is executing this command MUST have at least channel operator
1563 privileges on the channel.
1565 The <adding client> and <removing client> are used to add to and
1566 remove from the ban list. The format of the <adding client> and
1567 the <removing client> is of following format:
1569 [<nickname>[@<server>]!][<username>]@[<hostname>]
1571 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1572 primary router after adding to or removing from the ban list.
1573 The wildcards MAY be used with this command. If adding or removing
1574 from than one clients then the lists are an comma (`,') separated.
1576 If this command is executed without the ban arguments the command
1577 merely replies with the current ban list.
1580 Reply messages to the command:
1583 Arguments: (1) <Status Payload> (2) <Channel ID>
1586 This command replies with the <Channel ID> of the channel and
1587 the current <ban list> of the channel if it exists.
1592 SILC_STATUS_ERR_NOT_REGISTERED
1593 SILC_STATUS_ERR_TOO_MANY_PARAMS
1594 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1595 SILC_STATUS_ERR_NO_CHANNEL_ID
1596 SILC_STATUS_ERR_NOT_ON_CHANNEL
1597 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1598 SILC_STATUS_ERR_RESOURCE_LIMIT
1601 21 SILC_COMMAND_DETACH
1606 This command is used to detach from the network. Client can
1607 send this command to its server to indicate that it will be
1608 detached. By detaching the client remains in the network but
1609 the actual network connection to the server is closed. The
1610 client may then later resume the old session back.
1612 When this command is received the server MUST check that the
1613 client is locally connected client, and set the user mode
1614 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1615 MUST be also sent to routers. The server then sends command
1616 reply to this command and closes the network connection.
1617 The server MUST NOT remove the client from its lists, or send
1618 any signoff notifications for this client. See the [SILC1]
1619 for detailed information about detaching.
1621 Reply messages to the command:
1624 Arguments: (1) <Status Payload>
1626 This command replies only with the status indication.
1631 SILC_STATUS_ERR_NOT_REGISTERED
1634 22 SILC_COMMAND_WATCH
1637 Arguments: (1) <Client ID> (2) [<add nickname>]
1638 (3) [<del nickname>]
1640 This command is used to set up a watch for <add nickname>
1641 nickname. When a user in the network appears with the
1642 nickname, or signoffs the network or user's mode is changed
1643 the client which set up the watch will be notified about
1644 this change. This can be used to watch for certain nicknames
1645 in the network and receive notifications when for example a
1646 friend appears in the network or leaves the network.
1648 The <del nickname> is a nickname that has been previously
1649 added to watch list and is now removed from it. Notifications
1650 for that nickname will not be delivered anymore.
1652 The <Client ID> is the Client ID of the sender of this command.
1654 The nickname set to watch MUST NOT include any wildcards.
1655 Note also that a nickname may match several users since
1656 nicknames are not unique. Implementations MAY set limits
1657 for how many nicknames client can watch.
1659 When normal server receives this command from client it
1660 MUST send it to its router. Router will process the command
1661 and actually keeps the watch list.
1663 Reply messages to the command:
1666 Arguments: (1) <Status Payload>
1668 This command replies only with the status indication.
1673 SILC_STATUS_ERR_NOT_REGISTERED
1674 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1675 SILC_STATUS_ERR_TOO_MANY_PARAMS
1676 SILC_STATUS_ERR_BAD_NICKNAME
1677 SILC_STATUS_ERR_WILDCARDS
1678 SILC_STATUS_ERR_RESOURCE_LIMIT
1679 SILC_STATUS_ERR_NO_SUCH_NICK
1680 SILC_STATUS_ERR_NICKNAME_IN_USE
1683 23 SILC_COMMAND_SILCOPER
1686 Arguments: (1) <username> (2) <authentication payload>
1688 This command is used by normal client to obtain router operator
1689 privileges (also known as SILC operator) on the router. Note
1690 that router operator has privileges that supersedes the server
1691 operator privileges.
1693 The <username> is the username set in the server configurations
1694 as operator. The <authentication payload> is the data that the
1695 client is authenticated against. It may be passphrase prompted
1696 for user on client's screen or it may be public key or certificate
1697 authentication data (data signed with private key). The public
1698 key that router will use to verify the signature found in the
1699 payload should be verified. It is recommended that the public
1700 key is saved locally in the router and router would not use
1701 any public keys received during the SKE.
1703 Difference between router operator and server operator is that
1704 router operator is able to handle cell level properties while
1705 server operator (even on router server) is able to handle only
1706 local properties, such as, local connections and normal server
1707 administration. The router operator is also able to use the
1708 SILC_COMMAND_KILL command.
1710 After changing the mode server MUST send the notify type
1711 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1713 Reply messages to the command:
1716 Arguments: (1) <Status Payload>
1718 This command replies only with Status Payload.
1723 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1724 SILC_STATUS_ERR_TOO_MANY_PARAMS
1725 SILC_STATUS_ERR_NOT_REGISTERED
1726 SILC_STATUS_ERR_AUTH_FAILED
1729 24 SILC_COMMAND_LEAVE
1732 Arguments: (1) <Channel ID>
1734 This command is used by client to leave a channel the client is
1737 When leaving channel the server MUST send the notify type
1738 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1739 The channel key MUST also be re-generated when leaving the channel
1740 and distribute it to all clients still currently on the channel.
1741 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1744 Reply messages to the command:
1747 Arguments: (1) <Status Payload> (2) <Channel ID>
1749 The <Channel ID> is the ID of left channel.
1754 SILC_STATUS_ERR_NOT_REGISTERED
1755 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1756 SILC_STATUS_ERR_TOO_MANY_PARAMS
1757 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1758 SILC_STATUS_ERR_BAD_CHANNEL_ID
1759 SILC_STATUS_ERR_NO_CHANNEL_ID
1762 25 SILC_COMMAND_USERS
1765 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1767 This command is used to list user names currently on the requested
1768 channel; either the argument <Channel ID> or the <channel name>.
1769 One of these arguments must be present. The server MUST resolve
1770 the joined clients and reply with a lists of users on the channel
1771 and with list of user modes on the channel.
1773 If the requested channel is a private or secret channel, this
1774 command MUST NOT send the list of users, but error is returned
1775 to the sender, except if the sender is on the channel, or the
1778 Reply messages to the command:
1781 Arguments: (1) <Status Payload> (2) <Channel ID>
1782 (3) <list count> (4) <Client ID list>
1783 (5) <client mode list>
1785 This command replies with the Channel ID of the requested channel
1786 Client ID list of the users on the channel and list of their modes.
1787 The Client ID list has Client ID's of all users in the list. The
1788 <Client ID list> is formed by adding Client ID's one after another.
1789 The <client mode list> is formed by adding client's user modes on
1790 the channel one after another (4 bytes (32 bits) each). The <list
1791 count> of length of 4 bytes (32 bits), tells the number of entries
1792 in the lists. Both lists MUST have equal number of entries.
1797 SILC_STATUS_ERR_NOT_REGISTERED
1798 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1799 SILC_STATUS_ERR_TOO_MANY_PARAMS
1800 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1801 SILC_STATUS_ERR_BAD_CHANNEL_ID
1802 SILC_STATUS_ERR_NO_CHANNEL_ID
1803 SILC_STATUS_ERR_NOT_ON_CHANNEL
1806 26 SILC_COMMAND_GETKEY
1809 Arguments: (1) <ID Payload>
1811 This command is used to fetch the public key of the client or
1812 server indicated by the <ID Payload>. The public key is fetched
1813 from the server where to the client is connected.
1815 Reply messages to the command:
1818 Arguments: (1) <Status Payload> (2) <ID Payload>
1819 (3) [<Public Key Payload>]
1821 This command replies with the client's or server's ID and with
1822 the <Public Key Payload>.
1827 SILC_STATUS_ERR_NOT_REGISTERED
1828 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1829 SILC_STATUS_ERR_TOO_MANY_PARAMS
1830 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1831 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1834 27 SILC_COMMAND_SERVICE
1837 Arguments: (1) [<service name>] (2) [<auth payload>]
1840 This command is used to negotiate a service agreement with a
1841 remote server. If this command is given without arguments it
1842 MAY return the service list, if it is publicly available. The
1843 <service name> is a service sepcific identifier, and the
1844 <auth payload> MAY be used to authenticate the requestor to the
1845 remote service. The authentication to a service may be based
1846 on previous agreement with the requestor and the service
1847 provider. The command MAY also take additional service
1850 This document does not specify any services. How the services
1851 are configured and put available in a server is also out of
1852 scope of this document.
1854 This command MAY be used by client to start using some service
1855 in a server, but it also MAY be used by server to negotiate
1856 to start using a service in some other server or router.
1858 After the negotiation is done both of the parties need to know
1859 from the service identifier how the service can be used. The
1860 service can be considered to be a protocol which both of the
1861 parties need to support.
1863 Reply messages to the command:
1866 Arguments: (1) <Status Payload> (2) [<service list>]
1867 (3) [<service name>] (n) [...]
1870 This command MAY reply with the <service list> when command is
1871 given without arguments, and the list is a comma separated list
1872 of service identifiers. The <service name> is the service that
1873 the sender requested and this is provided when the server has
1874 accepted the sender to use the <service name>. The command
1875 reply MAY also have additional service specific arguments.
1880 SILC_STATUS_ERR_NOT_REGISTERED
1881 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1882 SILC_STATUS_ERR_TOO_MANY_PARAMS
1883 SILC_STATUS_ERR_NO_SUCH_SERVICE
1884 SILC_STATUS_ERR_AUTH_FAILED
1885 SILC_STATUS_ERR_PERM_DENIED
1890 Currently undefined commands.
1895 These commands are reserved for private use and will not be defined
1899 255 SILC_COMMAND_MAX
1901 Reserved command. This must not be sent.
1906 2.3.1 SILC Command Status Payload
1908 Command Status Payload is sent in command reply messages to indicate
1909 the status of the command. The payload is one of argument in the
1910 command thus this is the data area in Command Argument Payload described
1911 in [SILC2]. The payload is only 2 bytes of length. The following
1912 diagram represents the Command Status Payload (field is always in
1919 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1920 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1922 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1926 Figure 6: SILC Command Status Payload
1930 o Status (1 byte) - Indicates the status message type,
1931 error, start of list, entry of list or end of list.
1933 o Error (1 byte) - Indicates the error if the Status
1934 field is some list status, which means there are list
1938 The values in Status and Error fields are set according
1939 the following rules:
1942 o If there is single reply and error has not occurred
1943 then Status field includes value SILC_STATUS_OK, and
1944 the Error field MUST be ignored (and set to zero
1947 o If there is single error, then Status field includes
1948 one of the error values, and the Error field MUST be
1949 ignored (and set to zero value).
1951 o If there will be multiple successful command replies
1952 then Status field includes SILC_STATUS_LIST_START,
1953 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1954 and Error field is set to SILC_STATUS_OK.
1956 o If there are multiple error replies then Status field
1957 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1958 or SILC_STATUS_LIST_END value, and the Error field
1959 includes the error value.
1962 This way it is possible to send single successful or
1963 single error reply, but also multiple successful and
1964 multiple error replies. Note that it is possible to
1965 send both list of successful replies and list of error
1966 replies at the same time, however in this case the
1967 list of error replies MUST be sent after the successful
1968 replies. This way the recipient may ignore the multiple
1969 errors if it wishes to do so.
1971 All Status messages are described in the next section.
1975 2.3.2 SILC Status Types
1977 Status messages are returned in SILC protocol in command reply
1978 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
1979 the command reply packet and status types are sent inside the
1980 Status Payload as one of command reply argument, as defined in
1981 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
1982 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
1983 types defined in this section are used in both cases.
1985 When returning status messages in the command reply message they
1986 indicate whether the command was executed without errors. If error
1987 occurred the status indicates which error occurred.
1989 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
1990 they always send some error status. Usually they are sent to
1991 indicate that error occurred while processing some SILC packet.
1992 Please see the [SILC1] and [SILC2] for more information sending
1993 status types in SILC_NOTIFY_TYPE_ERROR notify.
1995 The Status Types are only numeric values and the receiver must
1996 convert the numeric values into human readable messages if this
1997 is desired in the application.
1999 List of all defined status types:
2002 Generic status messages:
2006 Ok status. Everything went Ok. The status payload maybe
2007 safely ignored in this case.
2009 1 SILC_STATUS_LIST_START
2011 Start of the list. There will be several command replies and
2012 this reply is the start of the list.
2014 2 SILC_STATUS_LIST_ITEM
2016 Item in the list. This is one of the item in the list but not the
2019 3 SILC_STATUS_LIST_END
2021 End of the list. There were several command replies and this
2022 reply is the last of the list. There won't be other replies
2023 belonging to this list after this one.
2027 Currently undefined and has been reserved for the future.
2030 Error status message:
2034 10 SILC_STATUS_ERR_NO_SUCH_NICK
2036 "No such nickname". Requested nickname does not exist.
2038 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2040 "No such channel". Requested channel name does not exist.
2042 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2044 "No such server". Requested server name does not exist.
2046 13 SILC_STATUS_ERR_TOO_MANY_TARGETS
2048 "Duplicate recipients. No message delivered". Message were
2049 tried to be sent to recipient which has several occurrences in
2052 14 SILC_STATUS_ERR_NO_RECIPIENT
2054 "No recipient given". Command required recipient which was
2057 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2059 "Unknown command". Command sent to server is unknown by the
2062 16 SILC_STATUS_ERR_WILDCARDS
2064 "Wildcards cannot be used". Wildcards were provided but they
2067 17 SILC_STATUS_ERR_NO_CLIENT_ID
2069 "No Client ID given". Client ID were expected as command
2070 parameter but were not found.
2072 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2074 "No Channel ID given". Channel ID were expected as command
2075 parameter but were not found.
2077 19 SILC_STATUS_ERR_NO_SERVER_ID
2079 "No Serve ID given". Server ID were expected as command
2080 parameter but were not found.
2082 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2084 "Bad Client ID". Client ID provided were erroneous.
2086 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2088 "Bad Channel ID". Channel ID provided were erroneous.
2090 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2092 "No such Client ID". Client ID provided does not exist.
2093 The unknown Client ID MUST be provided as next argument
2096 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2098 "No such Channel ID". Channel ID provided does not exist.
2099 The unknown Channel ID MUST be provided as next argument
2102 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2104 "Nickname already exists". Nickname created could not be
2105 registered because number of same nicknames were already set to
2106 maximum. This is not expected to happen in real life but is
2109 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2111 "You are not on that channel". The command were specified for
2112 channel user is not currently on.
2114 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2116 "They are not on channel". The requested target client is not
2117 on requested channel.
2119 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2121 "User already on channel". User were invited on channel they
2124 28 SILC_STATUS_ERR_NOT_REGISTERED
2126 "You have not registered". User executed command that requires
2127 the client to be registered on the server before it may be
2130 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2132 "Not enough parameters". Command requires more parameters
2135 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2137 "Too many parameters". Too many parameters were provided
2140 31 SILC_STATUS_ERR_PERM_DENIED
2142 "Permission denied". Generic permission denied error status
2143 to indicate disallowed access.
2145 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2147 "You are banned from this server". The client tried to register
2148 on server that has explicitly denied this host to connect.
2150 33 SILC_STATUS_ERR_BAD_PASSWORD
2152 "Cannot join channel. Incorrect password". Password provided for
2153 channel were not accepted.
2155 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2157 "Cannot join channel. Channel is full". The channel is full
2158 and client cannot be joined to it.
2160 35 SILC_STATUS_ERR_NOT_INVITED
2162 "Cannot join channel. You have not been invited". The channel
2163 is invite only channel and client has not been invited.
2165 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2167 "Cannot join channel. You have been banned". The client has
2168 been banned from the channel.
2170 37 SILC_STATUS_ERR_UNKNOWN_MODE
2172 "Unknown mode". Mode provided by the client were unknown to
2175 38 SILC_STATUS_ERR_NOT_YOU
2177 "Cannot change mode for other users". User tried to change
2178 someone else's mode.
2180 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2182 "Permission denied. You are not channel operator". Command may
2183 be executed only by channel operator.
2185 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2187 "Permission denied. You are not channel founder". Command may
2188 be executed only by channel operator.
2190 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2192 "Permission denied. You are not server operator". Command may
2193 be executed only by server operator.
2195 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2197 "Permission denied. You are not SILC operator". Command may be
2198 executed only by router (SILC) operator.
2200 43 SILC_STATUS_ERR_BAD_NICKNAME
2202 "Bad nickname". Nickname requested contained illegal characters
2205 44 SILC_STATUS_ERR_BAD_CHANNEL
2207 "Bad channel name". Channel requested contained illegal characters
2210 45 SILC_STATUS_ERR_AUTH_FAILED
2212 "Authentication failed". The authentication data sent as
2213 argument were wrong and thus authentication failed.
2215 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2217 "The algorithm was not supported." The server does not support the
2218 requested algorithm.
2220 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2222 "No such Server ID". Server ID provided does not exist.
2223 The unknown Server ID MUST be provided as next argument
2226 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2228 "No more resources available". This can mean that server cannot
2229 or will not accept something due to resource limitations.
2231 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2233 "Service does not exist". Requested service identifier is
2240 3 Security Considerations
2242 Security is central to the design of this protocol, and these security
2243 considerations permeate the specification. Common security considerations
2244 such as keeping private keys truly private and using adequate lengths for
2245 symmetric and asymmetric keys must be followed in order to maintain the
2246 security of this protocol.
2252 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2253 Protocol Specification", Internet Draft, April 2001.
2255 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2258 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2259 Protocols", Internet Draft, April 2001.
2261 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2264 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2267 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2270 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2273 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2276 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2279 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2282 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2285 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2286 Infrastructure, Certificate and CRL Profile", RFC 2459,
2289 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2290 John Wiley & Sons, New York, NY, 1996.
2292 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2295 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2296 RFC 2412, November 1998.
2298 [ISAKMP] Maughan D., et al, "Internet Security Association and
2299 Key Management Protocol (ISAKMP)", RFC 2408, November
2302 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2303 (IKE)", RFC 2409, November 1998.
2305 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2306 Authentication", RFC 2104, February 1997.
2308 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2309 Specifications, Version 2.0", RFC 2437, October 1998.
2311 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2312 Requirement Levels", BCP 14, RFC 2119, March 1997.
2314 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2315 10646", RFC 2279, January 1998.
2326 Snellmanninkatu 34 A 15
2330 EMail: priikone@iki.fi
2332 This Internet-Draft expires XXX
2338 This appendix defines the usage of the <Requested Attributes> argument in
2339 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2340 and may be used to request additional information about the user. Since
2341 the information that may be requested using the attributes is something
2342 that server cannot deliver to the sender, it is possible to send the WHOIS
2343 command directly to the destination client whom will then provide the
2344 requested attributes. This requires the servers to relay the WHOIS
2345 command to the client, and it requires capability for handling the WHOIS
2346 command in the client end.
2348 The <Requested Attributes> MAY include several attributes that are
2349 requested. The format and encoding of the <Requested Attributes> is as
2350 defined in [ATTRS]. When <Requested Attributes> argument is set the
2351 server MAY process the attributes to see whether it can narrow down
2352 the WHOIS search, for example when searching with a nickname. The
2353 normal servers MUST process the WHOIS command as normal WHOIS command,
2354 that is to send the command directly to the router. The router MAY
2355 process the attributes, but it MUST send the command to the server
2356 that owns the requested client.
2358 The server that owns the client and receives the command MUST check
2359 whether the client is detached from the network. If it is detached,
2360 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2361 process the attributes and provide as many of the requested attributes
2362 as possible and then send reply back to the sender. If the client is
2363 active in the network it MUST send the command to the client for
2366 The client receiving WHOIS command SHOULD check whether the
2367 <Requested Attributes> argument is set. If it is not set then the
2368 WHOIS command SHOULD be discarded. The client processes the requested
2369 attributes and SHOULD reply to each of the requested attribute with
2370 either valid value, or with an indication that the requested attribute
2371 is not known or supported. This is to be done as defined in [ATTRS].
2372 The client always MUST send a reply to the command when some attributes
2373 were requested. The client MAY also add additional attributes to the
2374 reply even if they were not requested. The client MAY also digitally
2375 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2376 in [ATTRS]. Then the client sends the reply back to the sender of
2377 the command. The command reply that client assembles does not need
2378 to include any other argument but the <Status Payload> (1), and the
2379 <Attributes> (11). The server receiving reply from client MUST allow
2380 this sort of command reply for WHOIS command.
2382 The information received from the client MAY be cached in the
2383 server's end. The caching may be desired for example if the client
2384 can be detached from the network. This way the server is then able
2385 to provide at least partial information for a requestor. The
2386 server MAY also process the command reply and verify whether the
2387 attributes provided in the reply are actually valid. If it can do
2388 this, and verify that they indeed are valid values it MAY append
2389 a digital signature at the end of the attributes with the
2390 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2391 server then MUST provide valid WHOIS command reply to the sender
2392 of the command. Other servers and routers that receive the command
2393 reply enroute to the original sender MAY also cache the information.
2395 The client which receives the command reply to the WHOIS command
2396 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2397 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
projects / silc.git / blob