8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-03.txt 15 May 2002
20 Expires: 15 November 2002
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 ............................... 40
79 3 SILC Status Types ............................................. 41
80 4 Security Considerations ....................................... 47
81 5 References .................................................... 47
82 6 Author's Address .............................................. 49
83 Appendix A ...................................................... 49
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
285 STATUS_OK. If multiple Client IDs was requested then each found
286 and unfound client must cause successful or error reply,
289 The command replies include the Client ID of the nickname,
290 nickname and server name, user name and host name and user's real
291 name. Client SHOULD process these replies only after the last
292 reply has been received with the STATUS_LIST_END status. If the
293 <count> option were defined in the query there will be only
294 <count> many replies from the server.
296 The server returns the list of channels if the client has
297 joined channels. In this case the list is list of Channel
298 Payloads. The Mode Mask in the Channel Payload is the channel's
299 mode. The list is encoded by adding the Channel Payloads one
300 after the other. Private and secret channels MUST NOT be sent,
301 except if the sender of this command is on those channels, or
302 the sender is server. The <channel user mode list> MUST also
303 be sent if client is joined channels. This list includes 32 bit
304 MSB first order values one after the other and each indicate
305 the user's mode on a channel. The order of these values MUST
306 be same as the channel order in the <Channel Payload list>.
308 The server also returns client's user mode, idle time, and the
309 fingerprint of the client's public key. The <fingerprint> is the
310 binary hash digest of the public key. The fingerprint MUST NOT
311 be sent if the server has not verified the proof of possession of
312 the corresponding private key. Server can do this during the
313 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
315 The <Attributes> is the reply to the <Requested Attributes>.
316 See the Appendix A for more information.
321 SILC_STATUS_LIST_START
323 SILC_STATUS_ERR_NO_SUCH_NICK
324 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
325 SILC_STATUS_ERR_WILDCARDS
326 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
327 SILC_STATUS_ERR_TOO_MANY_PARAMS
330 2 SILC_COMMAND_WHOWAS
333 Arguments: (1) <nickname>[@<server>] (2) [<count>]
335 Whowas. This command is used to query history information about
336 specific user. The user may be requested by their nickname and
337 server name. The query may find multiple matching users as there
338 are no unique nicknames in the SILC. The <count> option may be
339 given to narrow down the number of accepted results. If this
340 is not defined there are no limit of accepted results. The query
341 may also be narrowed down by defining the server name of the
342 nickname. The <count> is 32 bit MSB first order integer.
344 To prevent miss-use of this command wildcards in the nickname
345 or in the server name are not permitted. The WHOWAS requests MUST
346 be based on specific nickname request.
348 The WHOWAS request MUST be always sent to the router by server
349 so that all users are searched. However, the server still must
350 search its locally connected clients.
352 Reply messages to the command:
355 Arguments: (1) <Status Payload> (2) <Client ID>
356 (3) <nickname>[@<server>] (4) <username@host>
359 This command may reply with several command reply messages to form
360 a list of results. In this case the status payload will include
361 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
362 the last reply to indicate the end of the list. If there are only
363 one reply the status is set to normal STATUS_OK.
365 The command replies with nickname and user name and host name.
366 Every server MUST keep history for some period of time of its
367 locally connected clients.
372 SILC_STATUS_LIST_START
374 SILC_STATUS_ERR_NO_SUCH_NICK
375 SILC_STATUS_ERR_WILDCARDS
376 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
377 SILC_STATUS_ERR_TOO_MANY_PARAMS
380 3 SILC_COMMAND_IDENTIFY
383 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
384 (3) [<channel name>] (4) [<count>]
385 (5) [<ID Payload>] (n) [...]
387 Identify command is used to query information about an entity by
388 the entity's name or ID. This command can be used to query
389 information about clients, server and channels.
391 The query may find multiple matching entities. The <count> option
392 may be given to narrow down the number of accepted results. If
393 this is not defined there are no limit of accepted results. The
394 <count> is 32 bit MSB first order integer.
396 It is also possible to search the entity by its ID. If the
397 <ID Payload> is provided server must use it as the search value
398 instead of the entity's name. One of the arguments must be given.
399 It is also possible to define multiple ID Payloads to search
400 multiple entities sending only one IDENTIFY command. In this case
401 the ID Payloads are appended as normal arguments. The type of the
402 entity is defined by the type of the ID Payload.
404 To prevent miss-use of this command wildcards in the names are
405 not permitted. It is not allowed to request for example all users
408 Implementations may not want to give interface access to this
409 command as it is hardly a command that would be used by an end
410 user. However, it must be implemented as it is used with private
413 The IDENTIFY command MUST be always sent to the router by server
414 so that all users are searched. However, server MUST still search
415 its locally connected clients.
417 Reply messages to the command:
420 Arguments: (1) <Status Payload> (2) <ID Payload>
421 (3) [<entity's name>] (4) [<info>]
423 This command may reply with several command reply messages to form
424 a list of results. In this case the status payload will include
425 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
426 the last reply to indicate the end of the list. If there are only
427 one reply the status is set to normal STATUS_OK. If multiple Client
428 IDs was requested then each found and unfound client must cause
429 successful or error reply, respectively.
431 When querying clients the <entity's name> must include the client's
432 nickname in the following format: nickname[@server]. The
433 <info> must include the client's username and host in the following
434 format: username@host.
436 When querying servers the <entity's name> must include the server's
437 full name. The <info> may be omitted.
439 When querying channels the <entity's name> must include the
440 channel's name. The <info> may be omitted.
442 If the <count> option were defined in the query there will be only
443 <count> many replies from the server.
448 SILC_STATUS_LIST_START
450 SILC_STATUS_ERR_NO_SUCH_NICK
451 SILC_STATUS_ERR_NO_SUCH_SERVER
452 SILC_STATUS_ERR_NO_SUCH_CHANNEL
453 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
454 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
455 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
456 SILC_STATUS_ERR_WILDCARDS
457 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
458 SILC_STATUS_ERR_TOO_MANY_PARAMS
464 Arguments: (1) <nickname>
466 Set/change nickname. This command is used to set nickname for
467 user. Nickname MUST NOT include any spaces (` '), non-printable
468 characters, commas (`,') and any wildcard characters.
470 When nickname is changed new Client ID is generated. Server MUST
471 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
472 channels (if any) the client is joined on. Then it MUST send
473 SILC_PACKET_REPLACE_ID to its primary route to replace the old
474 Client ID with the new one.
476 Reply messages to the command:
479 Arguments: (1) <Status Payload> (2) <New ID Payload>
482 This command is replied always with New ID Payload that is
483 generated by the server every time user changes their nickname.
484 Client receiving this payload MUST start using the received
485 Client ID as its current valid Client ID. The New ID Payload
486 is described in [SILC2]. The <nickname> is the user's new
492 SILC_STATUS_ERR_WILDCARDS
493 SILC_STATUS_ERR_NICKNAME_IN_USE
494 SILC_STATUS_ERR_BAD_NICKNAME
495 SILC_STATUS_ERR_NOT_REGISTERED
496 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
497 SILC_STATUS_ERR_TOO_MANY_PARAMS
503 Arguments: (1) [<Channel ID>]
505 The list command is used to list channels and their topics on the
506 current server. If the <Channel ID> parameter is used, only the
507 status of that channel is displayed. Secret channels are not
508 listed at all. Private channels are listed with status indicating
509 that the channel is private. Router MAY reply with all channels
512 Reply messages to the command:
515 Arguments: (1) <Status Payload> (2) <Channel ID>
516 (3) <channel> (4) [<topic>]
519 This command may reply with several command reply messages to form
520 a list of results. In this case the status payload will include
521 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
522 the last reply to indicate the end of the list. If there are only
523 one reply the status is set to normal STATUS_OK.
525 This command replies with Channel ID, name and the topic of the
526 channel. If the channel is private channel the <topic> SHOULD
527 include the "*private*" string.
532 SILC_STATUS_LIST_START
534 SILC_STATUS_ERR_WILDCARDS
535 SILC_STATUS_ERR_NOT_REGISTERED
536 SILC_STATUS_ERR_TOO_MANY_PARAMS
537 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
538 SILC_STATUS_ERR_NO_CHANNEL_ID
539 SILC_STATUS_ERR_NO_SUCH_SERVER
545 Arguments: (1) <Channel ID> (2) [<topic>]
547 This command is used to change or view the topic of a channel.
548 The topic for channel <Channel ID> is returned if there is no
549 <topic> given. If the <topic> parameter is present, the topic
550 for that channel will be changed, if the channel modes permit
553 After setting the topic the server MUST send the notify type
554 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
555 the channel which topic was changed.
557 Reply messages to the command:
560 Arguments: (1) <Status Payload> (2) <Channel ID>
563 The command may reply with the topic of the channel if it is
569 SILC_STATUS_ERR_NOT_ON_CHANNEL
570 SILC_STATUS_ERR_WILDCARDS
571 SILC_STATUS_ERR_NOT_REGISTERED
572 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
573 SILC_STATUS_ERR_NO_SUCH_CHANNEL
574 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
575 SILC_STATUS_ERR_NO_CHANNEL_ID
576 SILC_STATUS_ERR_BAD_CHANNEL_ID
577 SILC_STATUS_ERR_TOO_MANY_PARAMS
578 SILC_STATUS_ERR_NO_CHANNEL_PRIV
581 7 SILC_COMMAND_INVITE
584 Arguments: (1) <Channel ID> (2) [<Client ID>]
585 (3) [<adding client>] (4) [<removing client>]
587 This command is used to invite other clients to join to the
588 channel. The <Client ID> argument is the target client's ID that
589 is being invited. The <Channel ID> is the Channel ID of the
590 requested channel. The sender of this command MUST be on the
591 channel. The server MUST also send the notify type
592 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
593 client indicated by the <Client ID>.
595 The <adding client> and <removing client> can be used to add to
596 and remove from the invite list. The format of the <adding client>
597 and <removing client> is as follows:
599 [<nickname>[@<server>]!][<username>]@[<hostname>]
601 When adding to or removing from the invite list the server MUST
602 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
603 and MUST NOT send it to the client which was added to the list.
604 The client which executes this command MUST have at least channel
605 operator privileges to be able to add to or remove from the invite
606 list. The wildcards MAY be used with this command. If adding or
607 removing more than one client then the lists are an comma (`,')
610 Note that the <Client ID> provided MUST be resolved into correct
611 nickname and host name and add to the invite list before sending
614 When this command is given with only <Channel ID> argument then
615 the command merely returns the invite list of the channel. This
616 command MUST fail if the requested channel does not exist, the
617 requested <Client ID> is already on the channel or if the channel
618 is invite only channel and the caller of this command does not
619 have at least channel operator privileges.
621 Reply messages to the command:
624 Arguments: (1) <Status Payload> (2) <Channel ID>
627 This command replies with the invite list of the channel if it
633 SILC_STATUS_ERR_NOT_REGISTERED
634 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
635 SILC_STATUS_ERR_TOO_MANY_PARAMS
636 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
637 SILC_STATUS_ERR_NO_CLIENT_ID
638 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
639 SILC_STATUS_ERR_NO_CHANNEL_ID
640 SILC_STATUS_ERR_NOT_ON_CHANNEL
641 SILC_STATUS_ERR_USER_ON_CHANNEL
642 SILC_STATUS_ERR_NO_CHANNEL_PRIV
643 SILC_STATUS_ERR_RESOURCE_LIMIT
649 Arguments: (1) [<quit message>]
651 This command is used by client to end SILC session. The server
652 must close the connection to a client which sends this command.
653 if <quit message> is given it will be sent to other clients on
654 channel if the client is on channel when quitting.
656 Reply messages to the command:
658 This command does not reply anything.
664 Arguments: (1) <Client ID> (2) [<comment>]
666 This command is used by SILC operators to remove a client from
667 SILC network. The removing has temporary effects and client may
668 reconnect to SILC network. The <Client ID> is the client to be
669 removed from SILC. The <comment> argument may be provided to
670 give to the removed client some information why it was removed
673 When killing a client the router MUST first send notify type
674 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
675 The packet MUST NOT be sent to the killed client on the channels.
676 Then, the router MUST send the same notify type to its primary
677 router. Finally, the router MUST send the same notify type
678 directly to the client which was killed.
680 Reply messages to the command:
683 Arguments: (1) <Status Payload>
685 This command replies only with Status Payload.
690 SILC_STATUS_ERR_WILDCARDS
691 SILC_STATUS_ERR_NOT_REGISTERED
692 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
693 SILC_STATUS_ERR_TOO_MANY_PARAMS
694 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
695 SILC_STATUS_ERR_NO_CLIENT_ID
696 SILC_STATUS_ERR_NO_ROUTER_PRIV
702 Arguments: (1) [<server>] (2) [<Server ID>]
704 This command is used to fetch various information about a server.
705 If <server> argument is specified the command MUST be sent to
706 the requested server.
708 If the <Server ID> is specified the server information if fetched
709 by the provided Server ID. One of the arguments must always be
712 Reply messages to the command:
715 Arguments: (1) <Status Payload> (2) <Server ID>
716 (3) <server name> (4) <string>
718 This command replies with the Server ID of the server and a
719 string which tells the information about the server.
724 SILC_STATUS_ERR_WILDCARDS
725 SILC_STATUS_ERR_NOT_REGISTERED
726 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
727 SILC_STATUS_ERR_TOO_MANY_PARAMS
728 SILC_STATUS_ERR_NO_SUCH_SERVER
729 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
730 SILC_STATUS_ERR_NO_SERVER_ID
733 11 SILC_COMMAND_STATS
736 Arguments: (1) <Server ID>
738 This command is used to fetch various statistical information
739 from the server indicated by <Server ID>, which is the ID of
740 server where sender is connected to. Server receiving this
741 command MAY also send this further to its router for fetching
742 other cell and network wide statistics to accompany the reply.
744 Reply messages to the command:
747 Arguments: (1) <Status Payload> (2) <Server ID>
748 (3) [<statistics structure>]
750 This command replies with the Server ID of the server and
751 optional statistics structure which includes 32 bit MSB first
752 ordered integer values to represent various statistical
753 information. The structure is as follows:
755 starttime - time when server was started
756 uptime - uptime of the server
757 my clients - number of locally connected clients
758 my channels - number of locally created channels
759 my server ops - number of local server operators
760 my router ops - number of local router operators
761 cell clients - number of clients in local cell
762 cell channels - number of channels in local cell
763 cell servers - number of servers in local cell
764 clients - number of client in SILC network
765 channels - number of channels in SILC network
766 servers - number of servers in SILC network
767 routers - number of routers in SILC network
768 server ops - number of server operators in SILC network
769 router ops - number of router operators in SILC network
771 If some value is unknown it is set to zero (0) value. The
772 "starttime" is the start time of the server, and is seconds
773 since Epoch (POSIX.1). The "uptime" is time difference of
774 current time and "starttime" in the server, and is seconds
780 SILC_STATUS_ERR_NOT_REGISTERED
781 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
782 SILC_STATUS_ERR_TOO_MANY_PARAMS
783 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
784 SILC_STATUS_ERR_NO_SUCH_SERVER
785 SILC_STATUS_ERR_NO_SERVER_ID
791 Arguments: (1) <Server ID>
793 This command is used by client and server to test the communication
794 channel to its server if one suspects that the communication is not
795 working correctly. The <Server ID> is the ID of the server the
796 sender is connected to.
798 Reply messages to the command:
801 Arguments: (1) <Status Payload>
803 This command replies only with Status Payload. Server returns
804 SILC_STATUS_OK in Status Payload if pinging was successful.
811 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
812 SILC_STATUS_ERR_TOO_MANY_PARAMS
813 SILC_STATUS_ERR_NO_SERVER_ID
814 SILC_STATUS_ERR_NO_SUCH_SERVER
815 SILC_STATUS_ERR_NOT_REGISTERED
821 Arguments: (1) <username> (2) <authentication payload>
823 This command is used by normal client to obtain server operator
824 privileges on some server or router. Note that router operator
825 has router privileges that supersedes the server operator
826 privileges and this does not obtain those privileges. Client
827 MUST use SILCOPER command to obtain router level privileges.
829 The <username> is the username set in the server configurations
830 as operator. The <authentication payload> is the data that the
831 client is authenticated against. It may be passphrase prompted
832 for user on client's screen or it may be public key or certificate
833 authentication data (data signed with private key). The public
834 key that server will use to verify the signature found in the
835 payload should be verified. It is recommended that the public
836 key is saved locally in the server and server would not use
837 any public keys received during the SKE.
839 After changing the mode the server MUST send the notify type
840 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
842 Reply messages to the command:
845 Arguments: (1) <Status Payload>
847 This command replies only with Status Payload.
852 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
853 SILC_STATUS_ERR_TOO_MANY_PARAMS
854 SILC_STATUS_ERR_NOT_REGISTERED
855 SILC_STATUS_ERR_AUTH_FAILED
861 Arguments: (1) <channel> (2) <Client ID>
862 (3) [<passphrase>] (4) [<cipher>]
863 (5) [<hmac>] (6) [<founder auth>]
865 Join to channel/create new channel. This command is used to
866 join to a channel. If the channel does not exist the channel is
867 created. If server is normal server this command MUST be sent
868 to router which will create the channel. The channel MAY be
869 protected with passphrase. If this is the case the passphrase
870 MUST be sent along the join command.
872 The name of the <channel> MUST NOT include any spaces (` '),
873 non-printable characters, commas (`,') or any wildcard characters.
875 The second argument <Client ID> is the Client ID of the client
876 which is joining to the client. When client sends this command
877 to the server the <Client ID> MUST be the client's own ID.
879 Cipher to be used to secure the traffic on the channel MAY be
880 requested by sending the name of the requested <cipher>. This
881 is used only if the channel does not exist and is created. If
882 the channel already exists the cipher set previously for the
883 channel will be used to secure the traffic. The computed MACs
884 of the channel message are produced by the default HMAC or by
885 the <hmac> provided for the command.
887 The <founder auth> is Authentication Payload providing the
888 authentication for gaining founder privileges on the channel
889 when joining the channel. The client may provide this if it
890 knows that it is the founder of the channel and that the
891 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
892 MUST verify whether the client is able to gain the founder
893 privileges the same way as the client had given the
894 SILC_COMMAND_CUMODE command to gain founder privileges. The
895 client is still able to join the channel even if the founder
896 privileges could not be gained. The hash function used with
897 the <founder payload> MUST be sha1.
899 The server MUST check whether the user is allowed to join to
900 the requested channel. Various modes set to the channel affect
901 the ability of the user to join the channel. These conditions
904 o The user MUST be invited to the channel if the channel
905 is invite-only channel.
907 o The Client ID/nickname/username/host name MUST NOT match
910 o The correct passphrase MUST be provided if passphrase
911 is set to the channel.
913 o The user count limit, if set, MUST NOT be reached.
915 If the client provided correct <founder auth> payload it can
916 override these conditions, except the condition for the passphrase.
917 The correct passphrase MUST be provided even if <founder auth>
920 Reply messages to the command:
923 Arguments: (1) <Status Payload> (2) <channel>
924 (3) <Channel ID> (4) <Client ID>
925 (5) <channel mode mask> (6) <created>
926 (7) [<Channel Key Payload>] (8) [<ban list>]
927 (9) [<invite list>] (10) [<topic>]
928 (11) [<hmac>] (12) <list count>
929 (13) <Client ID list> (14) <client mode list>
931 This command replies with the channel name requested by the
932 client, channel ID of the channel and topic of the channel
933 if it exists. The <Client ID> is the Client ID which was joined
934 to the channel. It also replies with the channel mode mask
935 which tells all the modes set on the channel. If the
936 channel is created the mode mask is zero (0). If ban mask
937 and/or invite list is set they are sent as well.
939 The <list count>, <Client ID list> and <client mode list> are
940 the clients currently on the channel and their modes on the
941 channel. The <Client ID list> is formed by adding the ID Payloads
942 one after the other. The <client mode list> is formed by adding
943 32 bit MSB first order values one after the other.
945 Client receives the channel key in the reply message as well
946 inside <Channel Key Payload>.
951 SILC_STATUS_ERR_WILDCARDS
952 SILC_STATUS_ERR_NOT_REGISTERED
953 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
954 SILC_STATUS_ERR_TOO_MANY_PARAMS
955 SILC_STATUS_ERR_BAD_PASSWORD
956 SILC_STATUS_ERR_CHANNEL_IS_FULL
957 SILC_STATUS_ERR_NOT_INVITED
958 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
959 SILC_STATUS_ERR_BAD_CHANNEL
960 SILC_STATUS_ERR_USER_ON_CHANNEL
966 Arguments: (1) <server>
968 This command is used to query the Message of the Day of the server.
970 Reply messages to the command:
973 Arguments: (1) <Status Payload> (2) <Server ID>
976 This command replies with the motd message if it exists.
981 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
982 SILC_STATUS_ERR_TOO_MANY_PARAMS
983 SILC_STATUS_ERR_NOT_REGISTERED
984 SILC_STATUS_ERR_NO_SUCH_SERVER
987 16 SILC_COMMAND_UMODE
990 Arguments: (1) <Client ID> (2) [<client mode mask>]
992 This command is used by client to set/unset modes for itself.
993 However, there are some modes that the client MUST NOT set itself,
994 but they will be set by server. However, client MAY unset any
995 mode. Modes may be masked together ORing them thus having
996 several modes set. Client MUST keep its client mode mask
997 locally so that the mode setting/unsetting would work without
998 problems. Client may change only its own modes.
1000 After changing the mode server MUST send the notify type
1001 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1003 The following client modes are defined:
1005 0x00000000 SILC_UMODE_NONE
1007 No specific mode for client. This is the initial
1008 setting when new client is created. The client is
1009 normal client and is present in the network.
1012 0x00000001 SILC_UMODE_SERVER_OPERATOR
1014 Marks the user as server operator. Client MUST NOT
1015 set this mode itself. Server sets this mode to the
1016 client when client attains the server operator
1017 privileges by SILC_COMMAND_OPER command. Client
1018 MAY unset the mode itself.
1021 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1023 Marks the user as router (SILC) operator. Client
1024 MUST NOT set this mode itself. Router sets this mode
1025 to the client when client attains the router operator
1026 privileges by SILC_COMMAND_SILCOPER command. Client
1027 MAY unset the mode itself.
1030 0x00000004 SILC_UMODE_GONE
1032 Marks that the user is not currently present in the
1033 SILC Network. Client MAY set and unset this mode.
1036 0x00000008 SILC_UMODE_INDISPOSED
1038 Marks that the user is currently indisposed and may
1039 not be able to receive any messages, and that user may
1040 not be present in the network. Client MAY set and
1044 0x00000010 SILC_UMODE_BUSY
1046 Marks that the user is currently busy and may not
1047 want to receive any messages, and that user may not
1048 be present in the network. Client MAY set and unset
1052 0x00000020 SILC_UMODE_PAGE
1054 User is not currently present or is unable to receive
1055 messages, and prefers to be paged in some mechanism
1056 if the user needs to be reached. Client MAY set and
1060 0x00000040 SILC_UMODE_HYPER
1062 Marks that the user is hyper active and is eager to
1063 receive and send messages. Client MAY set and unset
1067 0x00000080 SILC_UMODE_ROBOT
1069 Marks that the client is actually a robot program.
1070 Client MAY set and unset this mode.
1073 0x00000100 SILC_UMODE_ANONYMOUS
1075 Marks that the client is anonymous client. Server
1076 that specifically is designed for anonymous services
1077 can set and unset this mode. Client MUST NOT set or
1078 unset this mode itself. A client with this mode set
1079 would have the username and the hostname information
1080 scrambled by the server which set this mode.
1083 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1085 Marks that the client wishes to block private
1086 messages sent to the client, unless the Private
1087 Message Key flag is set in the SILC packet header.
1088 If this mode is set server MUST NOT deliver private
1089 messages to the client without the Private Message
1090 Key flag being set. The Private Message Key flag set
1091 indicates that the private message is protected with
1092 a key shared between the sender and the recipient.
1094 A separate service could provide additional filtering
1095 features for accepting private messages from certain
1096 sender. However, this document does not specify such
1099 The client MAY set and unset this mode.
1102 0x00000400 SILC_UMODE_DETACHED
1104 Marks that the client is detached from the SILC network.
1105 This means that the actual network connection to the
1106 client is lost but the client entry is still valid. The
1107 detached client can be resumed at a later time. This
1108 mode MUST NOT be set by client. It can only be set when
1109 client has issued command SILC_COMMAND_DETACH. The server
1110 sets this mode. This mode cannot be unset with this
1111 command. It is unset when the client is resuming back to
1112 the network and SILC_PACKET_RESUME_CLIENT packet is
1115 This flag MUST NOT be used to determine whether a packet
1116 can be sent to the client or not. Only the server that
1117 had the original client connection can make the decision
1118 by knowing that the network connection is not active.
1119 In this case the default case is to discard the packet.
1122 0x00000800 SILC_UMODE_REJECT_WATCHING
1124 Marks that the client rejects that it could be watched
1125 by someone else. If this mode is set notifications about
1126 this client is not send, even if someone is watching the
1127 same nickname this client has. Client MAY set and unset
1128 this mode. Any changes for this client MUST NOT be
1129 notified to any watcher when this mode is set.
1131 A separate service could provide additional filtering
1132 features for rejecting and accepting the watching from
1133 certain users. However, this document does not specify
1137 0x00001000 SILC_UMODE_BLOCK_INVITE
1139 Marks that the client wishes to block incoming invite
1140 notifications. Client MAY set and unset this mode.
1141 When set server does not deliver invite notifications
1142 to the client. Note that this mode may make it harder
1143 to join invite-only channels.
1145 If the <client mode mask> was not provided this command merely
1146 returns the mode mask to the client.
1149 Reply messages to the command:
1152 Arguments: (1) <Status Payload> (2) <client mode mask>
1154 This command replies with the changed client mode mask that
1155 the client MUST to keep locally.
1161 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1162 SILC_STATUS_ERR_TOO_MANY_PARAMS
1163 SILC_STATUS_ERR_NOT_REGISTERED
1164 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1165 SILC_STATUS_ERR_BAD_CLIENT_ID
1166 SILC_STATUS_ERR_NOT_YOU
1167 SILC_STATUS_ERR_PERM_DENIED
1168 SILC_STATUS_ERR_UNKNOWN_MODE
1169 SILC_STATUS_ERR_NO_CLIENT_ID
1172 17 SILC_COMMAND_CMODE
1175 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1176 (3) [<user limit>] (4) [<passphrase>]
1177 (5) [<cipher>] (6) [<hmac>]
1178 (7) [<auth payload>]
1180 This command is used by client to set or change channel flags on
1181 a channel. Channel has several modes that set various properties
1182 of a channel. Modes may be masked together by ORing them thus
1183 having several modes set. The <Channel ID> is the ID of the
1184 target channel. The client changing channel mode MUST be on
1185 the same channel and posses sufficient privileges to be able to
1188 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1189 type MUST be distributed to the channel.
1191 The following channel modes are defined:
1193 0x00000000 SILC_CMODE_NONE
1195 No specific mode on channel. This is the default when
1196 channel is created. This means that channel is just plain
1200 0x00000001 SILC_CMODE_PRIVATE
1202 Channel is private channel. Private channels are shown
1203 in the channel list listed with SILC_COMMAND_LIST command
1204 with indication that the channel is private. Also,
1205 client on private channel will no be detected to be on
1206 the channel as the channel is not shown in the client's
1207 currently joined channel list. Channel founder and
1208 channel operator MAY set/unset this mode.
1210 Typical implementation would use [+|-]p on user interface
1211 to set/unset this mode.
1214 0x00000002 SILC_CMODE_SECRET
1216 Channel is secret channel. Secret channels are not shown
1217 in the list listed with SILC_COMMAND_LIST command. Secret
1218 channels can be considered to be invisible channels.
1219 Channel founder and channel operator MAY set/unset this
1222 Typical implementation would use [+|-]s on user interface
1223 to set/unset this mode.
1226 0x00000004 SILC_CMODE_PRIVKEY
1228 Channel uses private channel key to protect the traffic
1229 on the channel. When this mode is set the client will be
1230 responsible to set the key it wants to use to encrypt and
1231 decrypt the traffic on channel. Server generated channel
1232 keys are not used at all. This mode provides additional
1233 security as clients on channel may agree to use private
1234 channel key that even servers do not know. Naturally,
1235 this requires that every client on the channel knows
1236 the key before hand (it is considered to be pre-shared-
1237 key). The key material is RECOMMENDED to be processed
1238 as stated in the [SILC3] in the section Processing the
1241 As it is local setting it is possible to have several
1242 private channel keys on one channel. In this case several
1243 clients can talk on same channel but only those clients
1244 that share the key with the message sender will be able
1245 to hear the talking. Client SHOULD NOT display those
1246 message for the end user that it is not able to decrypt
1247 when this mode is set.
1249 Only channel founder MAY set/unset this mode. If this
1250 mode is unset the server will distribute new channel
1251 key to all clients on the channel which will be used
1254 Typical implementation would use [+|-]k on user interface
1255 to set/unset this mode.
1258 0x00000008 SILC_CMODE_INVITE
1260 Channel is invite only channel. Client may join to this
1261 channel only if it is invited to the channel. Channel
1262 founder and channel operator MAY set/unset this mode.
1264 Typical implementation would use [+|-]i on user interface
1265 to set/unset this mode.
1268 0x00000010 SILC_CMODE_TOPIC
1270 The topic of the channel may only be set by client that
1271 is channel founder or channel operator. Normal clients
1272 on channel will not be able to set topic when this mode
1273 is set. Channel founder and channel operator MAY set/
1276 Typical implementation would use [+|-]t on user interface
1277 to set/unset this mode.
1280 0x00000020 SILC_CMODE_ULIMIT
1282 User limit has been set to the channel. New clients
1283 may not join to the channel when the limit set is
1284 reached. Channel founder and channel operator MAY set/
1285 unset the limit. The <user limit> argument is the
1286 number of limited users.
1288 Typical implementation would use [+|-]l on user interface
1289 to set/unset this mode.
1292 0x00000040 SILC_CMODE_PASSPHRASE
1294 Passphrase has been set to the channel. Client may
1295 join to the channel only if it is able to provide the
1296 correct passphrase. Setting passphrases to channel
1297 is entirely safe as all commands are protected in the
1298 SILC network. Only channel founder MAY set/unset
1299 the passphrase. The <passphrase> argument is the
1302 Typical implementation would use [+|-]a on user interface
1303 to set/unset this mode.
1306 0x00000080 SILC_CMODE_CIPHER
1308 Sets specific cipher to be used to protect channel
1309 traffic. The <cipher> argument is the requested cipher.
1310 When set or unset the server must re-generate new
1311 channel key. Only channel founder MAY set the cipher of
1312 the channel. When unset the new key is generated using
1313 default cipher for the channel.
1315 Typical implementation would use [+|-]c on user interface
1316 to set/unset this mode.
1319 0x00000100 SILC_CMODE_HMAC
1321 Sets specific hmac to be used to compute the MACs of the
1322 channel message. The <hmac> argument is the requested hmac.
1323 Only channel founder may set the hmac of the channel.
1325 Typical implementation would use [+|-]h on user interface
1326 to set/unset this mode.
1329 0x00000200 SILC_CMODE_FOUNDER_AUTH
1331 Channel founder may set this mode to be able to regain
1332 channel founder rights even if the client leaves the
1333 channel. The <auth payload> is the Authentication Payload
1334 consisting of the public key authentication method and the
1335 authentication data for that method. The passphrase
1336 method cannot be used with this mode. The server MUST NOT
1337 accept NONE authentication method. The server does not
1338 save <auth payload> but MUST verify it. The public key
1339 used to verify the payload is the public key of the
1340 client sending this command. The mode may be set only
1341 if the <auth payload> was verified successfully. The
1342 server also MUST save the founder's public key. The
1343 hash function used with the <auth payload> MUST be sha1.
1345 The public key of the founder is sent in the
1346 SILC_NOTIFY_TYPE_CMODE_CHANGE notify type so that other
1347 routers and servers in the network may save the public key.
1348 This way the founder can reclaim the founder rights back
1349 to the channel from any server in the network. The founder
1350 rights can be regained by the SILC_CUMODE_FOUNDER channel
1351 user mode, or during joining procedure with the command
1354 When this channel mode is set the channel also becomes
1355 permanent. If all clients leave the channel while this
1356 mode is set the channel MUST NOT be destroyed. The founder
1357 can reclaim the founder mode back on these empty channels
1358 at any time. Implementations MAY limit the number of how
1359 many channels a user can own.
1361 Typical implementation would use [+|-]f on user interface
1362 to set/unset this mode.
1365 0x00000400 SILC_CMODE_SILENCE_USERS
1367 Channel founder may set this mode to silence normal users
1368 on the channel. Users with operator privileges are not
1369 affected by this mode. Messages sent by normal users
1370 are dropped by servers when this mode is set. This mode
1371 can be used to moderate the channel. Only channel founder
1372 may set/unset this mode.
1375 0x00000800 SILC_CMODE_SILENCE_OPERS
1377 Channel founder may set this mode to silence operators
1378 on the channel. When used with SILC_CMODE_SILENCE_USERS
1379 mode this can be used to set the channel in state where only
1380 the founder of the channel may send messages to the channel.
1381 Messages sent by operators are dropped by servers when this
1382 mode is set. Only channel founder may set/unset this mode.
1385 To make the mode system work, client MUST keep the channel mode
1386 mask locally so that the mode setting and unsetting would work
1387 without problems. The client receives the initial channel mode
1388 mask when it joins to the channel. When the mode changes on
1389 channel the server MUST distribute the changed channel mode mask
1390 to all clients on the channel by sending the notify type
1391 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1392 to the server's primary router. If the <channel mode mask> was
1393 not provided this command merely returns the mode mask to the
1396 Reply messages to the command:
1399 Arguments: (1) <Status Payload> (2) <Channel ID>
1400 (3) <channel mode mask>
1402 This command replies with the changed channel mode mask that
1403 client MUST keep locally.
1408 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1409 SILC_STATUS_ERR_TOO_MANY_PARAMS
1410 SILC_STATUS_ERR_NOT_REGISTERED
1411 SILC_STATUS_ERR_NOT_ON_CHANNEL
1412 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1413 SILC_STATUS_ERR_BAD_CHANNEL_ID
1414 SILC_STATUS_ERR_NO_CHANNEL_ID
1415 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1416 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1417 SILC_STATUS_ERR_UNKNOWN_MODE
1418 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1419 SILC_STATUS_ERR_AUTH_FAILED
1422 18 SILC_COMMAND_CUMODE
1425 Arguments: (1) <Channel ID> (2) <mode mask>
1426 (3) <Client ID> (4) [<auth payload>]
1428 This command is used by client to change channel user modes on
1429 channel. Users on channel may have some special modes and this
1430 command is used by channel operators to set or change these modes.
1431 The <Channel ID> is the ID of the target channel. The <mode mask>
1432 is OR'ed mask of modes. The <Client ID> is the target client.
1433 The client changing channel user modes MUST be on the same channel
1434 as the target client and posses sufficient privileges to be able to
1437 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1438 type is distributed to the channel.
1440 The following channel modes are defined:
1442 0x00000000 SILC_CUMODE_NONE
1444 No specific mode. This is the normal situation for client.
1445 Also, this is the mode set when removing all modes from
1449 0x00000001 SILC_CUMODE_FOUNDER
1451 The client is channel founder of the channel. Usually this
1452 mode is set only by the server when the channel was created.
1453 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1454 been set, the client can claim channel founder privileges
1455 by providing the <auth payload> that the server will use
1456 to authenticate the client. The public key that server will
1457 use to verify the <auth payload> MUST the same public key
1458 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1459 mode was set. The client MAY remove this mode at any time.
1462 0x00000002 SILC_CUMODE_OPERATOR
1464 Sets channel operator privileges on the channel for a
1465 client on the channel. Channel founder and channel operator
1466 MAY set/unset this mode. The client MAY remove this mode
1470 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1472 Marks that the client wishes not to receive any channel
1473 messages sent for the channel. Client MAY set and unset
1474 this mode to itself. Client MUST NOT set it to anyone else.
1475 When this mode is set server MUST NOT deliver channel
1476 messages to this client. Other packets such as channel
1477 key packets are still sent to the client.
1479 A separate service could provide additional filtering
1480 features for accepting channel messages from certain
1481 sender. However, this document does not specify such
1485 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1487 Marks that the client wishes not to receive any channel
1488 messages sent from normal users. Only messages sent by
1489 channel founder or channel operator is accepted. Client
1490 MAY set and unset this mode to itself. Client MUST NOT
1491 set it to anyone else. When this mode is set server MUST
1492 NOT deliver channel messages that are sent by normal users
1495 A separate service could provide additional filtering
1496 features for accepting channel messages from certain
1497 sender. However, this document does not specify such
1501 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1503 Marks that the client wishes not to receive any channel
1504 messages sent from robots. Messages sent by users with
1505 the SILC_UMODE_ROBOT user mode set are not delivered.
1506 Client MAY set and unset this mode to itself. Client MUST
1507 NOT set it to anyone else. When this mode is set server
1508 MUST NOT deliver channel messages that are sent by robots
1512 0x00000020 SILC_CUMODE_QUIET
1514 Marks that the client cannot talk on the channel. This
1515 mode can be set by channel operator or channel founder to
1516 some other user that is not operator or founder. The
1517 target client MUST NOT unset this mode. When this mode
1518 is set the server MUST drop messages sent by this client
1522 Reply messages to the command:
1525 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1526 (3) <Channel ID> (4) <Client ID>
1528 This command replies with the changed channel user mode mask that
1529 client MUST keep locally. The <Channel ID> is the specified
1530 channel. The <Client ID> is the target client.
1535 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1536 SILC_STATUS_ERR_TOO_MANY_PARAMS
1537 SILC_STATUS_ERR_NOT_REGISTERED
1538 SILC_STATUS_ERR_NOT_ON_CHANNEL
1539 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1540 SILC_STATUS_ERR_BAD_CHANNEL_ID
1541 SILC_STATUS_ERR_NO_CHANNEL_ID
1542 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1543 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1544 SILC_STATUS_ERR_UNKNOWN_MODE
1545 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1546 SILC_STATUS_ERR_AUTH_FAILED
1549 19 SILC_COMMAND_KICK
1552 Arguments: (1) <Channel ID> (2) <Client ID>
1555 This command is used by channel operators to remove a client from
1556 channel. The <channel> argument is the channel the client to be
1557 removed is on currently. Note that the "kicker" must be on the same
1558 channel. If <comment> is provided it will be sent to the removed
1561 After kicking the client the server MUST send the notify type
1562 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1563 The channel key MUST also be re-generated after kicking, unless
1564 the SILC_CMODE_PRIVKEY mode is set.
1566 Reply messages to the command:
1569 Arguments: (1) <Status Payload>
1571 This command replies only with Status Payload.
1576 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1577 SILC_STATUS_ERR_TOO_MANY_PARAMS
1578 SILC_STATUS_ERR_NOT_REGISTERED
1579 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1580 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1581 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1582 SILC_STATUS_ERR_NO_CLIENT_ID
1590 Arguments: (1) <Channel ID> (2) [<adding client>]
1591 (3) [<removing client>]
1593 This command is used to manage the ban list of the channel
1594 indicated by the <Channel ID>. A client that is banned from
1595 channel is no longer able to join the channel. The client which
1596 is executing this command MUST have at least channel operator
1597 privileges on the channel.
1599 The <adding client> and <removing client> are used to add to and
1600 remove from the ban list. The format of the <adding client> and
1601 the <removing client> is of following format:
1603 [<nickname>[@<server>]!][<username>]@[<hostname>]
1605 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1606 primary router after adding to or removing from the ban list.
1607 The wildcards MAY be used with this command. If adding or removing
1608 from than one clients then the lists are an comma (`,') separated.
1610 If this command is executed without the ban arguments the command
1611 merely replies with the current ban list.
1614 Reply messages to the command:
1617 Arguments: (1) <Status Payload> (2) <Channel ID>
1620 This command replies with the <Channel ID> of the channel and
1621 the current <ban list> of the channel if it exists.
1626 SILC_STATUS_ERR_NOT_REGISTERED
1627 SILC_STATUS_ERR_TOO_MANY_PARAMS
1628 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1629 SILC_STATUS_ERR_NO_CHANNEL_ID
1630 SILC_STATUS_ERR_NOT_ON_CHANNEL
1631 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1632 SILC_STATUS_ERR_RESOURCE_LIMIT
1637 21 SILC_COMMAND_DETACH
1642 This command is used to detach from the network. Client can
1643 send this command to its server to indicate that it will be
1644 detached. By detaching the client remains in the network but
1645 the actual network connection to the server is closed. The
1646 client may then later resume the old session back.
1648 When this command is received the server MUST check that the
1649 client is locally connected client, and set the user mode
1650 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1651 MUST be also sent to routers. The server then sends command
1652 reply to this command and closes the network connection.
1653 The server MUST NOT remove the client from its lists, or send
1654 any signoff notifications for this client. See the [SILC1]
1655 for detailed information about detaching.
1657 Reply messages to the command:
1660 Arguments: (1) <Status Payload>
1662 This command replies only with the status indication.
1667 SILC_STATUS_ERR_NOT_REGISTERED
1670 22 SILC_COMMAND_WATCH
1673 Arguments: (1) <Client ID> (2) [<add nickname>]
1674 (3) [<del nickname>]
1676 This command is used to set up a watch for <add nickname>
1677 nickname. When a user in the network appears with the
1678 nickname, or signoffs the network or user's mode is changed
1679 the client which set up the watch will be notified about
1680 this change. This can be used to watch for certain nicknames
1681 in the network and receive notifications when for example a
1682 friend appears in the network or leaves the network.
1684 The <del nickname> is a nickname that has been previously
1685 added to watch list and is now removed from it. Notifications
1686 for that nickname will not be delivered anymore.
1688 The <Client ID> is the Client ID of the sender of this command.
1690 The nickname set to watch MUST NOT include any wildcards.
1691 Note also that a nickname may match several users since
1692 nicknames are not unique. Implementations MAY set limits
1693 for how many nicknames client can watch.
1695 When normal server receives this command from client it
1696 MUST send it to its router. Router will process the command
1697 and actually keeps the watch list.
1699 Reply messages to the command:
1702 Arguments: (1) <Status Payload>
1704 This command replies only with the status indication.
1709 SILC_STATUS_ERR_NOT_REGISTERED
1710 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1711 SILC_STATUS_ERR_TOO_MANY_PARAMS
1712 SILC_STATUS_ERR_BAD_NICKNAME
1713 SILC_STATUS_ERR_WILDCARDS
1714 SILC_STATUS_ERR_RESOURCE_LIMIT
1715 SILC_STATUS_ERR_NO_SUCH_NICK
1716 SILC_STATUS_ERR_NICKNAME_IN_USE
1719 23 SILC_COMMAND_SILCOPER
1722 Arguments: (1) <username> (2) <authentication payload>
1724 This command is used by normal client to obtain router operator
1725 privileges (also known as SILC operator) on the router. Note
1726 that router operator has privileges that supersedes the server
1727 operator privileges.
1729 The <username> is the username set in the server configurations
1730 as operator. The <authentication payload> is the data that the
1731 client is authenticated against. It may be passphrase prompted
1732 for user on client's screen or it may be public key or certificate
1733 authentication data (data signed with private key). The public
1734 key that router will use to verify the signature found in the
1735 payload should be verified. It is recommended that the public
1736 key is saved locally in the router and router would not use
1737 any public keys received during the SKE.
1739 Difference between router operator and server operator is that
1740 router operator is able to handle cell level properties while
1741 server operator (even on router server) is able to handle only
1742 local properties, such as, local connections and normal server
1743 administration. The router operator is also able to use the
1744 SILC_COMMAND_KILL command.
1746 After changing the mode server MUST send the notify type
1747 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1749 Reply messages to the command:
1752 Arguments: (1) <Status Payload>
1754 This command replies only with Status Payload.
1759 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1760 SILC_STATUS_ERR_TOO_MANY_PARAMS
1761 SILC_STATUS_ERR_NOT_REGISTERED
1762 SILC_STATUS_ERR_AUTH_FAILED
1765 24 SILC_COMMAND_LEAVE
1768 Arguments: (1) <Channel ID>
1770 This command is used by client to leave a channel the client is
1773 When leaving channel the server MUST send the notify type
1774 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1775 The channel key MUST also be re-generated when leaving the channel
1776 and distribute it to all clients still currently on the channel.
1777 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1780 Reply messages to the command:
1783 Arguments: (1) <Status Payload> (2) <Channel ID>
1785 The <Channel ID> is the ID of left channel.
1790 SILC_STATUS_ERR_NOT_REGISTERED
1791 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1792 SILC_STATUS_ERR_TOO_MANY_PARAMS
1793 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1794 SILC_STATUS_ERR_BAD_CHANNEL_ID
1795 SILC_STATUS_ERR_NO_CHANNEL_ID
1798 25 SILC_COMMAND_USERS
1801 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1803 This command is used to list user names currently on the requested
1804 channel; either the argument <Channel ID> or the <channel name>.
1805 One of these arguments must be present. The server MUST resolve
1806 the joined clients and reply with a lists of users on the channel
1807 and with list of user modes on the channel.
1809 If the requested channel is a private or secret channel, this
1810 command MUST NOT send the list of users, but error is returned
1811 to the sender, except if the sender is on the channel, or the
1814 Reply messages to the command:
1817 Arguments: (1) <Status Payload> (2) <Channel ID>
1818 (3) <list count> (4) <Client ID list>
1819 (5) <client mode list>
1821 This command replies with the Channel ID of the requested channel
1822 Client ID list of the users on the channel and list of their modes.
1823 The Client ID list has Client ID's of all users in the list. The
1824 <Client ID list> is formed by adding Client ID's one after another.
1825 The <client mode list> is formed by adding client's user modes on
1826 the channel one after another (4 bytes (32 bits) each). The <list
1827 count> of length of 4 bytes (32 bits), tells the number of entries
1828 in the lists. Both lists MUST have equal number of entries.
1833 SILC_STATUS_ERR_NOT_REGISTERED
1834 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1835 SILC_STATUS_ERR_TOO_MANY_PARAMS
1836 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1837 SILC_STATUS_ERR_BAD_CHANNEL_ID
1838 SILC_STATUS_ERR_NO_CHANNEL_ID
1839 SILC_STATUS_ERR_NOT_ON_CHANNEL
1842 26 SILC_COMMAND_GETKEY
1845 Arguments: (1) <ID Payload>
1847 This command is used to fetch the public key of the client or
1848 server indicated by the <ID Payload>. The public key is fetched
1849 from the server where to the client is connected.
1851 Reply messages to the command:
1854 Arguments: (1) <Status Payload> (2) <ID Payload>
1855 (3) [<Public Key Payload>]
1857 This command replies with the client's or server's ID and with
1858 the <Public Key Payload>.
1863 SILC_STATUS_ERR_NOT_REGISTERED
1864 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1865 SILC_STATUS_ERR_TOO_MANY_PARAMS
1866 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1867 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1870 27 SILC_COMMAND_SERVICE
1873 Arguments: (1) [<service name>] (2) [<auth payload>]
1876 This command is used to negotiate a service agreement with a
1877 remote server. If this command is given without arguments it
1878 MAY return the service list, if it is publicly available. The
1879 <service name> is a service specific identifier, and the
1880 <auth payload> MAY be used to authenticate the requester to the
1881 remote service. The authentication to a service may be based
1882 on previous agreement with the requester and the service
1883 provider. The command MAY also take additional service
1886 This document does not specify any services. How the services
1887 are configured and put available in a server is also out of
1888 scope of this document.
1890 This command MAY be used by client to start using some service
1891 in a server, but it also MAY be used by server to negotiate
1892 to start using a service in some other server or router.
1894 After the negotiation is done both of the parties need to know
1895 from the service identifier how the service can be used. The
1896 service can be considered to be a protocol which both of the
1897 parties need to support.
1899 Reply messages to the command:
1902 Arguments: (1) <Status Payload> (2) [<service list>]
1903 (3) [<service name>] (n) [...]
1906 This command MAY reply with the <service list> when command is
1907 given without arguments, and the list is a comma separated list
1908 of service identifiers. The <service name> is the service that
1909 the sender requested and this is provided when the server has
1910 accepted the sender to use the <service name>. The command
1911 reply MAY also have additional service specific arguments.
1916 SILC_STATUS_ERR_NOT_REGISTERED
1917 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1918 SILC_STATUS_ERR_TOO_MANY_PARAMS
1919 SILC_STATUS_ERR_NO_SUCH_SERVICE
1920 SILC_STATUS_ERR_AUTH_FAILED
1921 SILC_STATUS_ERR_PERM_DENIED
1928 Currently undefined commands.
1933 These commands are reserved for private use and will not be defined
1937 255 SILC_COMMAND_MAX
1939 Reserved command. This must not be sent.
1944 2.3.1 SILC Command Status Payload
1946 Command Status Payload is sent in command reply messages to indicate
1947 the status of the command. The payload is one of argument in the
1948 command thus this is the data area in Command Argument Payload described
1949 in [SILC2]. The payload is only 2 bytes of length. The following
1950 diagram represents the Command Status Payload (field is always in
1957 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1958 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1960 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1964 Figure 6: SILC Command Status Payload
1968 o Status (1 byte) - Indicates the status message type,
1969 error, start of list, entry of list or end of list.
1971 o Error (1 byte) - Indicates the error if the Status
1972 field is some list status, which means there are list
1976 The values in Status and Error fields are set according
1977 the following rules:
1980 o If there is single reply and error has not occurred
1981 then Status field includes value SILC_STATUS_OK, and
1982 the Error field MUST be ignored (and set to zero
1985 o If there is single error, then Status field includes
1986 one of the error values, and the Error field MUST be
1987 ignored (and set to zero value).
1989 o If there will be multiple successful command replies
1990 then Status field includes SILC_STATUS_LIST_START,
1991 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1992 and Error field is set to SILC_STATUS_OK.
1994 o If there are multiple error replies then Status field
1995 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1996 or SILC_STATUS_LIST_END value, and the Error field
1997 includes the error value.
2000 This way it is possible to send single successful or
2001 single error reply, but also multiple successful and
2002 multiple error replies. Note that it is possible to
2003 send both list of successful replies and list of error
2004 replies at the same time, however in this case the
2005 list of error replies MUST be sent after the successful
2006 replies. This way the recipient may ignore the multiple
2007 errors if it wishes to do so. Also note that in this
2008 case the successful and error replies belong to the
2011 All Status messages are described in the next section.
2015 2.3.2 SILC Status Types
2017 Status messages are returned in SILC protocol in command reply
2018 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
2019 the command reply packet and status types are sent inside the
2020 Status Payload as one of command reply argument, as defined in
2021 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
2022 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
2023 types defined in this section are used in both cases.
2025 When returning status messages in the command reply message they
2026 indicate whether the command was executed without errors. If error
2027 occurred the status indicates which error occurred.
2029 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
2030 they always send some error status. Usually they are sent to
2031 indicate that error occurred while processing some SILC packet.
2032 Please see the [SILC1] and [SILC2] for more information sending
2033 status types in SILC_NOTIFY_TYPE_ERROR notify.
2035 The Status Types are only numeric values and the receiver must
2036 convert the numeric values into human readable messages if this
2037 is desired in the application.
2039 List of all defined status types:
2042 Generic status messages:
2046 Ok status. Everything went Ok. The status payload maybe
2047 safely ignored in this case.
2049 1 SILC_STATUS_LIST_START
2051 Start of the list. There will be several command replies and
2052 this reply is the start of the list.
2054 2 SILC_STATUS_LIST_ITEM
2056 Item in the list. This is one of the item in the list but not the
2059 3 SILC_STATUS_LIST_END
2061 End of the list. There were several command replies and this
2062 reply is the last of the list. There won't be other replies
2063 belonging to this list after this one.
2067 Currently undefined and has been reserved for the future.
2070 Error status message:
2074 10 SILC_STATUS_ERR_NO_SUCH_NICK
2076 "No such nickname". Requested nickname does not exist.
2078 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2080 "No such channel". Requested channel name does not exist.
2082 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2084 "No such server". Requested server name does not exist.
2086 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2088 "Incomplete registration information". Information remote
2089 sent was incomplete.
2091 14 SILC_STATUS_ERR_NO_RECIPIENT
2093 "No recipient given". Command required recipient which was
2096 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2098 "Unknown command". Command sent to server is unknown by the
2101 16 SILC_STATUS_ERR_WILDCARDS
2103 "Wildcards cannot be used". Wildcards were provided but they
2106 17 SILC_STATUS_ERR_NO_CLIENT_ID
2108 "No Client ID given". Client ID were expected as command
2109 parameter but were not found.
2111 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2113 "No Channel ID given". Channel ID were expected as command
2114 parameter but were not found.
2116 19 SILC_STATUS_ERR_NO_SERVER_ID
2118 "No Serve ID given". Server ID were expected as command
2119 parameter but were not found.
2121 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2123 "Bad Client ID". Client ID provided were erroneous.
2125 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2127 "Bad Channel ID". Channel ID provided were erroneous.
2129 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2131 "No such Client ID". Client ID provided does not exist.
2132 The unknown Client ID MUST be provided as next argument
2135 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2137 "No such Channel ID". Channel ID provided does not exist.
2138 The unknown Channel ID MUST be provided as next argument
2141 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2143 "Nickname already exists". Nickname created could not be
2144 registered because number of same nicknames were already set to
2145 maximum. This is not expected to happen in real life but is
2148 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2150 "You are not on that channel". The command were specified for
2151 channel user is not currently on.
2153 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2155 "They are not on channel". The requested target client is not
2156 on requested channel.
2158 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2160 "User already on channel". User were invited on channel they
2163 28 SILC_STATUS_ERR_NOT_REGISTERED
2165 "You have not registered". User executed command that requires
2166 the client to be registered on the server before it may be
2169 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2171 "Not enough parameters". Command requires more parameters
2174 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2176 "Too many parameters". Too many parameters were provided
2179 31 SILC_STATUS_ERR_PERM_DENIED
2181 "Permission denied". Generic permission denied error status
2182 to indicate disallowed access.
2184 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2186 "You are banned from this server". The client tried to register
2187 on server that has explicitly denied this host to connect.
2189 33 SILC_STATUS_ERR_BAD_PASSWORD
2191 "Cannot join channel. Incorrect password". Password provided for
2192 channel were not accepted.
2194 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2196 "Cannot join channel. Channel is full". The channel is full
2197 and client cannot be joined to it.
2199 35 SILC_STATUS_ERR_NOT_INVITED
2201 "Cannot join channel. You have not been invited". The channel
2202 is invite only channel and client has not been invited.
2204 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2206 "Cannot join channel. You have been banned". The client has
2207 been banned from the channel.
2209 37 SILC_STATUS_ERR_UNKNOWN_MODE
2211 "Unknown mode". Mode provided by the client were unknown to
2214 38 SILC_STATUS_ERR_NOT_YOU
2216 "Cannot change mode for other users". User tried to change
2217 someone else's mode.
2219 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2221 "Permission denied. You are not channel operator". Command may
2222 be executed only by channel operator.
2224 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2226 "Permission denied. You are not channel founder". Command may
2227 be executed only by channel operator.
2229 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2231 "Permission denied. You are not server operator". Command may
2232 be executed only by server operator.
2234 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2236 "Permission denied. You are not SILC operator". Command may be
2237 executed only by router (SILC) operator.
2239 43 SILC_STATUS_ERR_BAD_NICKNAME
2241 "Bad nickname". Nickname requested contained illegal characters
2244 44 SILC_STATUS_ERR_BAD_CHANNEL
2246 "Bad channel name". Channel requested contained illegal characters
2249 45 SILC_STATUS_ERR_AUTH_FAILED
2251 "Authentication failed". The authentication data sent as
2252 argument were wrong and thus authentication failed.
2254 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2256 "The algorithm was not supported." The server does not support the
2257 requested algorithm.
2259 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2261 "No such Server ID". Server ID provided does not exist.
2262 The unknown Server ID MUST be provided as next argument
2265 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2267 "No more resources available". This can mean that server cannot
2268 or will not accept something due to resource limitations.
2270 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2272 "Service does not exist". Requested service identifier is
2275 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2277 "You have not been authenticated". Remote connection is not
2278 authenticated even though it is supposed to be.
2280 51 SILC_STATUS_ERR_BAD_SERVER_ID
2282 "Server ID is not valid". Provided server ID is not valid.
2284 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2286 "Key exchange failed". Key Exchange protocol failed.
2288 53 SILC_STATUS_ERR_BAD_VERSION
2290 "Bad version". Protocol or software version mismatch.
2296 3 Security Considerations
2298 Security is central to the design of this protocol, and these security
2299 considerations permeate the specification. Common security considerations
2300 such as keeping private keys truly private and using adequate lengths for
2301 symmetric and asymmetric keys must be followed in order to maintain the
2302 security of this protocol.
2308 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2309 Protocol Specification", Internet Draft, May 2002.
2311 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2314 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2315 Protocols", Internet Draft, May 2002.
2317 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2320 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2323 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2326 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2329 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2332 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2335 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2338 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2341 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2342 Infrastructure, Certificate and CRL Profile", RFC 2459,
2345 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2346 John Wiley & Sons, New York, NY, 1996.
2348 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2351 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2352 RFC 2412, November 1998.
2354 [ISAKMP] Maughan D., et al, "Internet Security Association and
2355 Key Management Protocol (ISAKMP)", RFC 2408, November
2358 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2359 (IKE)", RFC 2409, November 1998.
2361 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2362 Authentication", RFC 2104, February 1997.
2364 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2365 Specifications, Version 2.0", RFC 2437, October 1998.
2367 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2368 Requirement Levels", BCP 14, RFC 2119, March 1997.
2370 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2371 10646", RFC 2279, January 1998.
2373 [ATTRS] Riikonen, P., "User Online Presence and Information
2374 Attributes", Internet Draft, May 2002.
2382 Snellmaninkatu 34 A 15
2386 EMail: priikone@iki.fi
2388 This Internet-Draft expires 15 November 2002
2394 This appendix defines the usage of the <Requested Attributes> argument in
2395 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2396 and may be used to request additional information about the user. Since
2397 the information that may be requested using the attributes is something
2398 that server cannot deliver to the sender, it is possible to send the WHOIS
2399 command directly to the destination client whom will then provide the
2400 requested attributes. This requires the servers to relay the WHOIS
2401 command to the client, and it requires capability for handling the WHOIS
2402 command in the client end.
2404 The <Requested Attributes> MAY include several attributes that are
2405 requested. The format and encoding of the <Requested Attributes> is as
2406 defined in [ATTRS]. When <Requested Attributes> argument is set the
2407 server MAY process the attributes to see whether it can narrow down
2408 the WHOIS search, for example when searching with a nickname. The
2409 normal servers MUST process the WHOIS command as normal WHOIS command,
2410 that is to send the command directly to the router. The router MAY
2411 process the attributes, but it MUST send the command to the server
2412 that owns the requested client.
2414 The server that owns the client and receives the command MUST check
2415 whether the client is detached from the network. If it is detached,
2416 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2417 process the attributes and provide as many of the requested attributes
2418 as possible and then send reply back to the sender. If the client is
2419 active in the network it MUST send the command to the client for
2422 The client receiving WHOIS command SHOULD check whether the
2423 <Requested Attributes> argument is set. If it is not set then the
2424 WHOIS command SHOULD be discarded. The client processes the requested
2425 attributes and SHOULD reply to each of the requested attribute with
2426 either valid value, or with an indication that the requested attribute
2427 is not known or supported. This is to be done as defined in [ATTRS].
2428 The client always MUST send a reply to the command when some attributes
2429 were requested. The client MAY also add additional attributes to the
2430 reply even if they were not requested. The client MAY also digitally
2431 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2432 in [ATTRS]. Then the client sends the reply back to the sender of
2433 the command. The command reply that client assembles does not need
2434 to include any other argument but the <Status Payload> (1), and the
2435 <Attributes> (11). The server receiving reply from client MUST allow
2436 this sort of command reply for WHOIS command.
2438 The information received from the client MAY be cached in the
2439 server's end. The caching may be desired for example if the client
2440 can be detached from the network. This way the server is then able
2441 to provide at least partial information for a requester. The
2442 server MAY also process the command reply and verify whether the
2443 attributes provided in the reply are actually valid. If it can do
2444 this, and verify that they indeed are valid values it MAY append
2445 a digital signature at the end of the attributes with the
2446 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2447 server then MUST provide valid WHOIS command reply to the sender
2448 of the command. Other servers and routers that receive the command
2449 reply en route to the original sender MAY also cache the information.
2451 The client which receives the command reply to the WHOIS command
2452 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2453 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
projects / crypto.git / blob