8 .ds RF FORMFEED[Page %]
17 Network Working Group P. Riikonen
19 draft-riikonen-silc-commands-03.txt XXX
26 <draft-riikonen-silc-commands-03.txt>
31 This document is an Internet-Draft and is in full conformance with
32 all provisions of Section 10 of RFC 2026. Internet-Drafts are
33 working documents of the Internet Engineering Task Force (IETF), its
34 areas, and its working groups. Note that other groups may also
35 distribute working documents as Internet-Drafts.
37 Internet-Drafts are draft documents valid for a maximum of six months
38 and may be updated, replaced, or obsoleted by other documents at any
39 time. It is inappropriate to use Internet-Drafts as reference
40 material or to cite them other than as "work in progress."
42 The list of current Internet-Drafts can be accessed at
43 http://www.ietf.org/ietf/1id-abstracts.txt
45 The list of Internet-Draft Shadow Directories can be accessed at
46 http://www.ietf.org/shadow.html
48 The distribution of this memo is unlimited.
54 This memo describes the commands used in the Secure Internet Live
55 Conferencing (SILC) protocol, specified in the Secure Internet Live
56 Conferencing, Protocol Specification Internet Draft [SILC1]. The
57 SILC Commands are very important part of the SILC protocol. Usually
58 the commands are used by SILC clients to manage the SILC session, but
59 also SILC servers may use the commands. This memo specifies detailed
60 command messages and command reply messages.
73 1 Introduction .................................................. 2
74 1.1 Requirements Terminology .................................. 2
75 2 SILC Commands ................................................. 2
76 2.1 SILC Commands Syntax ...................................... 2
77 2.2 SILC Commands List ........................................ 4
78 2.3 SILC Command Status Payload ............................... 33
79 3 SILC Status Types ............................................. 33
80 4 Security Considerations ....................................... 38
81 5 References .................................................... 38
82 6 Author's Address .............................................. 40
83 Appendix A ...................................................... xx
89 This document describes the commands used in the Secure Internet Live
90 Conferencing (SILC) protocol, specified in the Secure Internet Live
91 Conferencing, Protocol Specification Internet Draft [SILC1]. This
92 document specifies detailed command messages and command reply messages.
94 Commands are very important part on SILC network especially for client
95 which uses commands to operate on the SILC network. Commands are used
96 to set nickname, join to channel, change modes and many other things.
98 See the [SILC1] for the requirements and the restrictions for the usage
99 of the SILC commands. The [SILC2] defines the command packet type and
100 the Command Payload which is actually used to deliver the commands and
101 command reply messages.
105 1.1 Requirements Terminology
107 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
108 MAY, and OPTIONAL, when they appear in this document, are to be
109 interpreted as described in [RFC2119].
116 2.1 SILC Commands Syntax
118 This section briefly describes the syntax of the command notions
119 in this document. Every field in command is separated from each
120 other by whitespaces (` ') indicating that each field is independent
121 argument and each argument MUST have own Command Argument Payload.
122 The number of maximum arguments are defined with each command
123 separately. The Command Argument Payload is described in [SILC2].
125 Every command defines specific number for each argument. Currently,
126 they are defined in ascending order; first argument has number one
127 (1), second has number two (2) and so on. This number is set into the
128 Argument Type field in the Command Argument Payload. This makes it
129 possible to send the arguments in free order as the number MUST be
130 used to identify the type of the argument. This makes is it also
131 possible to have multiple optional arguments in commands and in
132 command replies. The number of argument is marked in parentheses
133 before the actual argument.
138 Example: Arguments: (1) <nickname> (2) <username@host>
142 Every command replies with Status Payload. This payload tells the
143 sender of the command whether the command was completed successfully or
144 whether there was an error. If error occurred the payload includes the
145 error type. In the next section the Status Payload is not described
146 as it is common to all commands and has been described here. Commands
147 MAY reply with other arguments as well. These arguments are command
148 specific and are described in the next section.
157 Arguments: (1) <nickname>[@<server>] (2) <message>
160 The command has maximum of 3 arguments. However, only first
161 and second arguments are mandatory.
163 First argument <nickname> is mandatory but may have optional
164 <nickname@server> format as well. Second argument is mandatory
165 <message> argument. Third argument is optional <count> argument.
167 The numbers in parentheses are the argument specific numbers
168 that specify the type of the argument in Command Argument Payload.
169 The receiver always knows that, say, argument number two (2) is
170 <message> argument, regardless of the ordering of the arguments in
173 Reply messages to the command:
176 Arguments: (1) <Status Payload> (2) [<channel list>]
177 (3) <idle time> (4) [<away message>]
179 This command may reply with maximum of 4 arguments. However,
180 only the first and third arguments are mandatory. The numbers
181 in the parentheses have the same meaning as in the upper
182 command sending specification.
184 Every command reply with <Status Payload>, it is mandatory
185 argument for all command replies and for this reason it is not
186 described in the command reply descriptions.
193 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
194 SILC_STATUS_ERR_NO_SUCH_NICK
196 Every command reply also defines set of status message that it
197 may return inside the <Status Payload>. All status messages
198 are defined in the section 2.3 SILC Command Status Payload
201 Every command that has some kind of ID as argument (for example
202 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
203 the type of the ID, length of the ID and the actual ID data. This
204 way variable length ID's can be sent as arguments. Also note that
205 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
210 2.2 SILC Commands List
212 This section lists all SILC commands, however, it is expected that a
213 implementation and especially client implementation has many more
214 commands that has only local affect. These commands are official
215 SILC commands that has both client and server sides and cannot be
216 characterized as local commands.
218 List of all defined commands in SILC follows.
223 None. This is reserved command and MUST NOT be sent.
229 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
230 (3) [<Requested Attributes>] (4) [<Client ID>]
233 Whois command is used to query various information about specific
234 user. The user may be requested by their nickname and server name.
235 The query may find multiple matching users as there are no unique
236 nicknames in the SILC. The <count> option may be given to narrow
237 down the number of accepted results. If this is not defined there
238 are no limit of accepted results. The query may also be narrowed
239 down by defining the server name of the nickname. The <count> is
240 32 bit MSB first order integer.
242 It is also possible to search the user by Client ID. If the
243 <Client ID> is provided server MUST use it as the search value
244 instead of the <nickname>. One of the arguments MUST be given.
245 It is also possible to define multiple Client ID's to search
246 multiple users sending only one WHOIS command. In this case the
247 Client ID's are appended as normal arguments.
249 To prevent miss-use of this command wildcards in the nickname
250 or in the server name are not permitted. It is not allowed
251 to request all users on some server. The WHOIS requests MUST
252 be based on explicit nickname request.
254 The WHOIS request MUST be always sent to the router by server
255 so that all users are searched. However, the server still MUST
256 search its locally connected clients. The router MUST send
257 this command to the server which owns the requested client, if
258 the router is unable to provide all mandatory information about
259 the client. That server MUST reply to the command. Server MUST
260 NOT send whois replies to the client until it has received the
261 reply from its router.
263 The <Requested Attributes> is defined in [ATTRS] and can be used
264 to request various information about the client. See Appendix A
265 for definition of using these attributes in SILC.
267 Reply messages to the command:
270 Arguments: (1) <Status Payload> (2) <Client ID>
271 (3) <nickname>[@<server>] (4) <username@host>
272 (5) <real name> (6) [<Channel Payload
274 (7) [<user mode>] (8) [<idle time>]
275 (9) [<fingerprint>] (10) <channel user
280 This command may reply with several command reply messages to
281 form a list of results. In this case the status payload will
282 include STATUS_LIST_START status in the first reply and
283 STATUS_LIST_END in the last reply to indicate the end of the
284 list. If there are only one reply the status is set to normal
287 The command replies include the Client ID of the nickname,
288 nickname and server name, user name and host name and user's real
289 name. Client SHOULD process these replies only after the last
290 reply has been received with the STATUS_LIST_END status. If the
291 <count> option were defined in the query there will be only
292 <count> many replies from the server.
294 The server returns the list of channels if the client has
295 joined channels. In this case the list is list of Channel
296 Payloads. The Mode Mask in the Channel Payload is the channel's
297 mode. The list is encoded by adding the Channel Payloads one
298 after the other. Private and secret channels MUST NOT be sent,
299 except if the sender of this command is on those channels, or
300 the sender is server. The <channel user mode list> MUST also
301 be sent if client is joined channels. This list includes 32 bit
302 MSB first order values one after the other and each indicate
303 the user's mode on a channel. The order of these values MUST
304 be same as the channel order in the <Channel Payload list>.
306 The server also returns client's user mode, idle time, and the
307 fingerprint of the client's public key. The <fingerprint> is the
308 binary hash digest of the public key. The fingerprint MUST NOT
309 be sent if the server has not verified the proof of posession of
310 the corresponding private key. Server can do this during the
311 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
313 The <Attributes> is the reply to the <Requested Attributes>.
314 See the Appendix A for more information.
319 SILC_STATUS_LIST_START
321 SILC_STATUS_ERR_NO_SUCH_NICK
322 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
323 SILC_STATUS_ERR_WILDCARDS
324 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
325 SILC_STATUS_ERR_TOO_MANY_PARAMS
328 2 SILC_COMMAND_WHOWAS
331 Arguments: (1) <nickname>[@<server>] (2) [<count>]
333 Whowas. This command is used to query history information about
334 specific user. The user may be requested by their nickname and
335 server name. The query may find multiple matching users as there
336 are no unique nicknames in the SILC. The <count> option may be
337 given to narrow down the number of accepted results. If this
338 is not defined there are no limit of accepted results. The query
339 may also be narrowed down by defining the server name of the
340 nickname. The <count> is 32 bit MSB first order integer.
342 To prevent miss-use of this command wildcards in the nickname
343 or in the server name are not permitted. The WHOWAS requests MUST
344 be based on specific nickname request.
346 The WHOWAS request MUST be always sent to the router by server
347 so that all users are searched. However, the server still must
348 search its locally connected clients.
350 Reply messages to the command:
353 Arguments: (1) <Status Payload> (2) <Client ID>
354 (3) <nickname>[@<server>] (4) <username@host>
357 This command may reply with several command reply messages to form
358 a list of results. In this case the status payload will include
359 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
360 the last reply to indicate the end of the list. If there are only
361 one reply the status is set to normal STATUS_OK.
363 The command replies with nickname and user name and host name.
364 Every server MUST keep history for some period of time of its
365 locally connected clients.
370 SILC_STATUS_LIST_START
372 SILC_STATUS_ERR_NO_SUCH_NICK
373 SILC_STATUS_ERR_WILDCARDS
374 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
375 SILC_STATUS_ERR_TOO_MANY_PARAMS
378 3 SILC_COMMAND_IDENTIFY
381 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
382 (3) [<channel name>] (4) [<count>]
383 (5) [<ID Payload>] (n) [...]
385 Identify command is used to query information about an entity by
386 the entity's name or ID. This command can be used to query
387 information about clients, server and channels.
389 The query may find multiple matching entities. The <count> option
390 may be given to narrow down the number of accepted results. If
391 this is not defined there are no limit of accepted results. The
392 <count> is 32 bit MSB first order integer.
394 It is also possible to search the entity by its ID. If the
395 <ID Payload> is provided server must use it as the search value
396 instead of the entity's name. One of the arguments must be given.
397 It is also possible to define multiple ID Payloads to search
398 multiple entities sending only one IDENTIFY command. In this case
399 the ID Payloads are appended as normal arguments. The type of the
400 entity is defined by the type of the ID Payload.
402 To prevent miss-use of this command wildcards in the names are
403 not permitted. It is not allowed to request for example all users
406 Implementations may not want to give interface access to this
407 command as it is hardly a command that would be used by an end
408 user. However, it must be implemented as it is used with private
411 The IDENTIFY command MUST be always sent to the router by server
412 so that all users are searched. However, server MUST still search
413 its locally connected clients.
415 Reply messages to the command:
418 Arguments: (1) <Status Payload> (2) <ID Payload>
419 (3) [<entity's name>] (4) [<info>]
421 This command may reply with several command reply messages to form
422 a list of results. In this case the status payload will include
423 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
424 the last reply to indicate the end of the list. If there are only
425 one reply the status is set to normal STATUS_OK.
427 When querying clients the <entity's name> must include the client's
428 nickname in the following format: nickname[@server]. The
429 <info> must include the client's username and host in the following
430 format: username@host.
432 When querying servers the <entity's name> must include the server's
433 full name. The <info> may be omitted.
435 When querying channels the <entity's name> must include the
436 channel's name. The <info> may be omitted.
438 If the <count> option were defined in the query there will be only
439 <count> many replies from the server.
444 SILC_STATUS_LIST_START
446 SILC_STATUS_ERR_NO_SUCH_NICK
447 SILC_STATUS_ERR_NO_SUCH_SERVER
448 SILC_STATUS_ERR_NO_SUCH_CHANNEL
449 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
450 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
451 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
452 SILC_STATUS_ERR_WILDCARDS
453 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
454 SILC_STATUS_ERR_TOO_MANY_PARAMS
460 Arguments: (1) <nickname>
462 Set/change nickname. This command is used to set nickname for
463 user. Nickname MUST NOT include any spaces (` '), non-printable
464 characters, commas (`,') and any wildcard characters.
466 When nickname is changed new Client ID is generated. Server MUST
467 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
468 channels (if any) the client is joined on. Then it MUST send
469 SILC_PACKET_REPLACE_ID to its primary route to replace the old
470 Client ID with the new one.
472 Reply messages to the command:
475 Arguments: (1) <Status Payload> (2) <New ID Payload>
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]. The <nickname> is the user's new
488 SILC_STATUS_ERR_WILDCARDS
489 SILC_STATUS_ERR_NICKNAME_IN_USE
490 SILC_STATUS_ERR_BAD_NICKNAME
491 SILC_STATUS_ERR_NOT_REGISTERED
492 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
493 SILC_STATUS_ERR_TOO_MANY_PARAMS
499 Arguments: (1) [<Channel ID>]
501 The list command is used to list channels and their topics on the
502 current server. If the <Channel ID> parameter is used, only the
503 status of that channel is displayed. Secret channels are not
504 listed at all. Private channels are listed with status indicating
505 that the channel is private. Router MAY reply with all channels
508 Reply messages to the command:
511 Arguments: (1) <Status Payload> (2) <Channel ID>
512 (3) <channel> (4) [<topic>]
515 This command may reply with several command reply messages to form
516 a list of results. In this case the status payload will include
517 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
518 the last reply to indicate the end of the list. If there are only
519 one reply the status is set to normal STATUS_OK.
521 This command replies with Channel ID, name and the topic of the
522 channel. If the channel is private channel the <topic> SHOULD
523 include the "*private*" string.
528 SILC_STATUS_LIST_START
530 SILC_STATUS_ERR_WILDCARDS
531 SILC_STATUS_ERR_NOT_REGISTERED
532 SILC_STATUS_ERR_TOO_MANY_PARAMS
533 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
534 SILC_STATUS_ERR_NO_CHANNEL_ID
535 SILC_STATUS_ERR_NO_SUCH_SERVER
541 Arguments: (1) <Channel ID> (2) [<topic>]
543 This command is used to change or view the topic of a channel.
544 The topic for channel <Channel ID> is returned if there is no
545 <topic> given. If the <topic> parameter is present, the topic
546 for that channel will be changed, if the channel modes permit
549 After setting the topic the server MUST send the notify type
550 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
551 the channel which topic was changed.
553 Reply messages to the command:
556 Arguments: (1) <Status Payload> (2) <Channel ID>
559 The command may reply with the topic of the channel if it is
565 SILC_STATUS_ERR_NOT_ON_CHANNEL
566 SILC_STATUS_ERR_WILDCARDS
567 SILC_STATUS_ERR_NOT_REGISTERED
568 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
569 SILC_STATUS_ERR_NO_SUCH_CHANNEL
570 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
571 SILC_STATUS_ERR_NO_CHANNEL_ID
572 SILC_STATUS_ERR_BAD_CHANNEL_ID
573 SILC_STATUS_ERR_TOO_MANY_PARAMS
574 SILC_STATUS_ERR_NO_CHANNEL_PRIV
577 7 SILC_COMMAND_INVITE
580 Arguments: (1) <Channel ID> (2) [<Client ID>]
581 (3) [<adding client>] (4) [<removing client>]
583 This command is used to invite other clients to join to the
584 channel. The <Client ID> argument is the target client's ID that
585 is being invited. The <Channel ID> is the Channel ID of the
586 requested channel. The sender of this command MUST be on the
587 channel. The server MUST also send the notify type
588 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
589 client indicated by the <Client ID>.
591 The <adding client> and <removing client> can be used to add to
592 and remove from the invite list. The format of the <adding client>
593 and <removing client> is as follows:
595 [<nickname>[@<server>]!][<username>]@[<hostname>]
597 When adding to or removing from the invite list the server MUST
598 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
599 and MUST NOT send it to the client which was added to the list.
600 The client which executes this command MUST have at least channel
601 operator privileges to be able to add to or remove from the invite
602 list. The wildcards MAY be used with this command. If adding or
603 removing more than one client then the lists are an comma (`,')
606 Note that the <Client ID> provided MUST be resolved into correct
607 nickname and host name and add to the invite list before sending
610 When this command is given with only <Channel ID> argument then
611 the command merely returns the invite list of the channel. This
612 command MUST fail if the requested channel does not exist, the
613 requested <Client ID> is already on the channel or if the channel
614 is invite only channel and the caller of this command does not
615 have at least channel operator privileges.
617 Reply messages to the command:
620 Arguments: (1) <Status Payload> (2) <Channel ID>
623 This command replies with the invite list of the channel if it
629 SILC_STATUS_ERR_NOT_REGISTERED
630 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
631 SILC_STATUS_ERR_TOO_MANY_PARAMS
632 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
633 SILC_STATUS_ERR_NO_CLIENT_ID
634 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
635 SILC_STATUS_ERR_NO_CHANNEL_ID
636 SILC_STATUS_ERR_NOT_ON_CHANNEL
637 SILC_STATUS_ERR_USER_ON_CHANNEL
638 SILC_STATUS_ERR_NO_CHANNEL_PRIV
639 SILC_STATUS_ERR_RESOURCE_LIMIT
645 Arguments: (1) [<quit message>]
647 This command is used by client to end SILC session. The server
648 must close the connection to a client which sends this command.
649 if <quit message> is given it will be sent to other clients on
650 channel if the client is on channel when quitting.
652 Reply messages to the command:
654 This command does not reply anything.
660 Arguments: (1) <Client ID> (2) [<comment>]
662 This command is used by SILC operators to remove a client from
663 SILC network. The removing has temporary effects and client may
664 reconnect to SILC network. The <Client ID> is the client to be
665 removed from SILC. The <comment> argument may be provided to
666 give to the removed client some information why it was removed
669 When killing a client the router MUST first send notify type
670 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
671 The packet MUST NOT be sent to the killed client on the channels.
672 Then, the router MUST send the same notify type to its primary
673 router. Finally, the router MUST send the same notify type
674 directly to the client which was killed.
676 Reply messages to the command:
679 Arguments: (1) <Status Payload>
681 This command replies only with Status Payload.
686 SILC_STATUS_ERR_WILDCARDS
687 SILC_STATUS_ERR_NOT_REGISTERED
688 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
689 SILC_STATUS_ERR_TOO_MANY_PARAMS
690 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
691 SILC_STATUS_ERR_NO_CLIENT_ID
692 SILC_STATUS_ERR_NO_ROUTER_PRIV
698 Arguments: (1) [<server>] (2) [<Server ID>]
700 This command is used to fetch various information about a server.
701 If <server> argument is specified the command MUST be sent to
702 the requested server.
704 If the <Server ID> is specified the server information if fetched
705 by the provided Server ID. One of the arguments must always be
708 Reply messages to the command:
711 Arguments: (1) <Status Payload> (2) <Server ID>
712 (3) <server name> (4) <string>
714 This command replies with the Server ID of the server and a
715 string which tells the information about the server.
720 SILC_STATUS_ERR_WILDCARDS
721 SILC_STATUS_ERR_NOT_REGISTERED
722 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
723 SILC_STATUS_ERR_TOO_MANY_PARAMS
724 SILC_STATUS_ERR_NO_SUCH_SERVER
725 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
726 SILC_STATUS_ERR_NO_SERVER_ID
729 11 SILC_COMMAND_STATS
732 Arguments: (1) <Server ID>
734 This command is used to fetch various statistical information
735 from the server indicated by <Server ID>, which is the ID of
736 server where sender is connected to. Server receiving this
737 command MAY also send this further to its router for fetching
738 other cell and network wide statistics to accompany the reply.
740 Reply messages to the command:
743 Arguments: (1) <Status Payload> (2) <Server ID>
744 (3) [<statistics structure>]
746 This command replies with the Server ID of the server and
747 optional statistics structure which includes 32 bit MSB first
748 ordered integer values to represent various statistical
749 information. The structure is as follows:
751 starttime - time when server was started
752 uptime - uptime of the server
753 my clients - number of locally connected clients
754 my channels - number of locally created channels
755 my server ops - number of local server operators
756 my router ops - number of local router operators
757 cell clients - number of clients in local cell
758 cell channels - number of channels in local cell
759 cell servers - number of servers in local cell
760 clients - number of client in SILC network
761 channels - number of channels in SILC network
762 servers - number of servers in SILC network
763 routers - number of routers in SILC network
764 server ops - number of server operators in SILC network
765 router ops - number of router operators in SILC network
767 If some value is unknown it is set to zero (0) value. The
768 "starttime" is the start time of the server, and is seconds
769 since Epoch (POSIX.1). The "uptime" is time difference of
770 current time and "starttime" in the server, and is seconds
776 SILC_STATUS_ERR_NOT_REGISTERED
777 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
778 SILC_STATUS_ERR_TOO_MANY_PARAMS
779 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
780 SILC_STATUS_ERR_NO_SUCH_SERVER
781 SILC_STATUS_ERR_NO_SERVER_ID
787 Arguments: (1) <Server ID>
789 This command is used by client and server to test the communication
790 channel to its server if one suspects that the communication is not
791 working correctly. The <Server ID> is the ID of the server the
792 sender is connected to.
794 Reply messages to the command:
797 Arguments: (1) <Status Payload>
799 This command replies only with Status Payload. Server returns
800 SILC_STATUS_OK in Status Payload if pinging was successful.
807 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
808 SILC_STATUS_ERR_TOO_MANY_PARAMS
809 SILC_STATUS_ERR_NO_SERVER_ID
810 SILC_STATUS_ERR_NO_SUCH_SERVER
811 SILC_STATUS_ERR_NOT_REGISTERED
817 Arguments: (1) <username> (2) <authentication payload>
819 This command is used by normal client to obtain server operator
820 privileges on some server or router. Note that router operator
821 has router privileges that supersedes the server operator
822 privileges and this does not obtain those privileges. Client
823 MUST use SILCOPER command to obtain router level privileges.
825 The <username> is the username set in the server configurations
826 as operator. The <authentication payload> is the data that the
827 client is authenticated against. It may be passphrase prompted
828 for user on client's screen or it may be public key or certificate
829 authentication data (data signed with private key). The public
830 key that server will use to verify the signature found in the
831 payload should be verified. It is recommended that the public
832 key is saved locally in the server and server would not use
833 any public keys received during the SKE.
835 After changing the mode the server MUST send the notify type
836 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
838 Reply messages to the command:
841 Arguments: (1) <Status Payload>
843 This command replies only with Status Payload.
848 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
849 SILC_STATUS_ERR_TOO_MANY_PARAMS
850 SILC_STATUS_ERR_NOT_REGISTERED
851 SILC_STATUS_ERR_AUTH_FAILED
857 Arguments: (1) <channel> (2) <Client ID>
858 (3) [<passphrase>] (4) [<cipher>]
859 (5) [<hmac>] (6) [<founder auth>]
861 Join to channel/create new channel. This command is used to
862 join to a channel. If the channel does not exist the channel is
863 created. If server is normal server this command MUST be sent
864 to router which will create the channel. The channel MAY be
865 protected with passphrase. If this is the case the passphrase
866 MUST be sent along the join command.
868 The name of the <channel> MUST NOT include any spaces (` '),
869 non-printable characters, commas (`,') or any wildcard characters.
871 The second argument <Client ID> is the Client ID of the client
872 which is joining to the client. When client sends this command
873 to the server the <Client ID> MUST be the client's own ID.
875 Cipher to be used to secure the traffic on the channel MAY be
876 requested by sending the name of the requested <cipher>. This
877 is used only if the channel does not exist and is created. If
878 the channel already exists the cipher set previously for the
879 channel will be used to secure the traffic. The computed MACs
880 of the channel message are produced by the default HMAC or by
881 the <hmac> provided for the command.
883 The <founder auth> is Authentication Payload providing the
884 authentication for gaining founder privileges on the channel
885 when joining the channel. The client may provide this if it
886 knows that it is the founder of the channel and that the
887 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
888 MUST verify whether the client is able to gain the founder
889 privileges the same way as the client had given the
890 SILC_COMMAND_CUMODE command to gain founder privileges. The
891 client is still able to join the channel even if the founder
892 privileges could not be gained.
894 The server MUST check whether the user is allowed to join to
895 the requested channel. Various modes set to the channel affect
896 the ability of the user to join the channel. These conditions
899 o The user MUST be invited to the channel if the channel
900 is invite-only channel.
902 o The Client ID/nickname/username/host name MUST NOT match
905 o The correct passphrase MUST be provided if passphrase
906 is set to the channel.
908 o The user count limit, if set, MUST NOT be reached.
910 If the client provided correct <founder auth> payload it can
911 override these conditions, except the condition for the passphrase.
912 The correct passphrase MUST be provided even if <founder auth>
915 Reply messages to the command:
918 Arguments: (1) <Status Payload> (2) <channel>
919 (3) <Channel ID> (4) <Client ID>
920 (5) <channel mode mask> (6) <created>
921 (7) [<Channel Key Payload>] (8) [<ban list>]
922 (9) [<invite list>] (10) [<topic>]
923 (11) [<hmac>] (12) <list count>
924 (13) <Client ID list> (14) <client mode list>
926 This command replies with the channel name requested by the
927 client, channel ID of the channel and topic of the channel
928 if it exists. The <Client ID> is the Client ID which was joined
929 to the channel. It also replies with the channel mode mask
930 which tells all the modes set on the channel. If the
931 channel is created the mode mask is zero (0). If ban mask
932 and/or invite list is set they are sent as well.
934 The <list count>, <Client ID list> and <client mode list> are
935 the clients currently on the channel and their modes on the
936 channel. The <Client ID list> is formed by adding the ID Payloads
937 one after the other. The <client mode list> is formed by adding
938 32 bit MSB first order values one after the other.
940 Client receives the channel key in the reply message as well
941 inside <Channel Key Payload>.
946 SILC_STATUS_ERR_WILDCARDS
947 SILC_STATUS_ERR_NOT_REGISTERED
948 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
949 SILC_STATUS_ERR_TOO_MANY_PARAMS
950 SILC_STATUS_ERR_BAD_PASSWORD
951 SILC_STATUS_ERR_CHANNEL_IS_FULL
952 SILC_STATUS_ERR_NOT_INVITED
953 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
954 SILC_STATUS_ERR_BAD_CHANNEL
955 SILC_STATUS_ERR_USER_ON_CHANNEL
961 Arguments: (1) <server>
963 This command is used to query the Message of the Day of the server.
965 Reply messages to the command:
968 Arguments: (1) <Status Payload> (2) <Server ID>
971 This command replies with the motd message if it exists.
976 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
977 SILC_STATUS_ERR_TOO_MANY_PARAMS
978 SILC_STATUS_ERR_NOT_REGISTERED
979 SILC_STATUS_ERR_NO_SUCH_SERVER
982 16 SILC_COMMAND_UMODE
985 Arguments: (1) <Client ID> (2) [<client mode mask>]
987 This command is used by client to set/unset modes for itself.
988 However, there are some modes that the client MUST NOT set itself,
989 but they will be set by server. However, client MAY unset any
990 mode. Modes may be masked together ORing them thus having
991 several modes set. Client MUST keep its client mode mask
992 locally so that the mode setting/unsetting would work without
993 problems. Client may change only its own modes.
995 After changing the mode server MUST send the notify type
996 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
998 The following client modes are defined:
1000 0x00000000 SILC_UMODE_NONE
1002 No specific mode for client. This is the initial
1003 setting when new client is created. The client is
1004 normal client and is present in the network.
1007 0x00000001 SILC_UMODE_SERVER_OPERATOR
1009 Marks the user as server operator. Client MUST NOT
1010 set this mode itself. Server sets this mode to the
1011 client when client attains the server operator
1012 privileges by SILC_COMMAND_OPER command. Client
1013 MAY unset the mode itself.
1016 0x00000002 SILC_UMODE_ROUTER_OPERATOR
1018 Marks the user as router (SILC) operator. Client
1019 MUST NOT set this mode itself. Router sets this mode
1020 to the client when client attains the router operator
1021 privileges by SILC_COMMAND_SILCOPER command. Client
1022 MAY unset the mode itself.
1025 0x00000004 SILC_UMODE_GONE
1027 Marks that the user is not currently present in the
1028 SILC Network. Client MAY set and unset this mode.
1031 0x00000008 SILC_UMODE_INDISPOSED
1033 Marks that the user is currently indisposed and may
1034 not be able to receive any messages, and that user may
1035 not be present in the network. Client MAY set and
1039 0x00000010 SILC_UMODE_BUSY
1041 Marks that the user is currently busy and may not
1042 want to receive any messages, and that user may not
1043 be present in the network. Client MAY set and unset
1047 0x00000020 SILC_UMODE_PAGE
1049 User is not currently present or is unable to receive
1050 messages, and prefers to be paged in some mechanism
1051 if the user needs to be reached. Client MAY set and
1055 0x00000040 SILC_UMODE_HYPER
1057 Marks that the user is hyper active and is eager to
1058 receive and send messages. Client MAY set and unset
1062 0x00000080 SILC_UMODE_ROBOT
1064 Marks that the client is actually a robot program.
1065 Client MAY set and unset this mode.
1068 0x00000100 SILC_UMODE_ANONYMOUS
1070 Marks that the client is anonymous client. Server
1071 that specificly is designed for anonymous services
1072 can set and unset this mode. Client MUST NOT set or
1073 unset this mode itself. A client with this mode set
1074 would have the username and the hostname information
1075 scrambled by the server which set this mode.
1078 0x00000200 SILC_UMODE_BLOCK_PRIVMSG
1080 Marks that the client wishes to block private
1081 messages sent to the client, unless the Private
1082 Message Key flag is set in the SILC packet header.
1083 If this mode is set server MUST NOT deliver private
1084 messages to the client without the Private Message
1085 Key flag being set. The Private Message Key flag set
1086 indicates that the private message is protected with
1087 a key shared between the sender and the recipient.
1089 A separate service could provide additional filtering
1090 features for accepting private messages from certain
1091 sender. However, this document does not specify such
1094 The client MAY set and unset this mode.
1097 0x00000400 SILC_UMODE_DETACHED
1099 Marks that the client is detached from the SILC network.
1100 This means that the actual network connection to the
1101 client is lost but the client entry is still valid. The
1102 detached client can be resumed at a later time. This
1103 mode MUST NOT be set by client. It can only be set when
1104 client has issued command SILC_COMMAND_DETACH. The server
1105 sets this mode. This mode cannot be unset with this
1106 command. It is unset when the client is resuming back to
1107 the network and SILC_PACKET_RESUME_CLIENT packet is
1110 This flag MUST NOT be used to determine whether a packet
1111 can be sent to the client or not. Only the server that
1112 had the original client connection can make the decision
1113 by knowing that the network connection is not active.
1114 In this case the default case is to discard the packet.
1117 0x00000800 SILC_UMODE_REJECT_WATCHING
1119 Marks that the client rejects that it could be watched
1120 by someone else. If this mode is set notifications about
1121 this client is not send, even if someone is watching the
1122 same nickname this client has. Client MAY set and unset
1123 this mode. Any changes for this client MUST NOT be
1124 notified to any watcher when this mode is set.
1126 A separate service could provide additional filtering
1127 features for rejecting and accepting the watching from
1128 certain users. However, this document does not specify
1132 0x00001000 SILC_UMODE_BLOCK_INVITE
1134 Marks that the client wishes to block incoming invite
1135 notifications. Client MAY set and unset this mode.
1136 When set server does not deliver invite notifications
1137 to the client. Note that this mode may make it harder
1138 to join invite-only channels.
1140 If the <client mode mask> was not provided this command merely
1141 returns the mode mask to the client.
1144 Reply messages to the command:
1147 Arguments: (1) <Status Payload> (2) <client mode mask>
1149 This command replies with the changed client mode mask that
1150 the client MUST to keep locally.
1156 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1157 SILC_STATUS_ERR_TOO_MANY_PARAMS
1158 SILC_STATUS_ERR_NOT_REGISTERED
1159 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1160 SILC_STATUS_ERR_BAD_CLIENT_ID
1161 SILC_STATUS_ERR_NOT_YOU
1162 SILC_STATUS_ERR_PERM_DENIED
1163 SILC_STATUS_ERR_UNKNOWN_MODE
1164 SILC_STATUS_ERR_NO_CLIENT_ID
1167 17 SILC_COMMAND_CMODE
1170 Arguments: (1) <Channel ID> (2) [<channel mode mask>]
1171 (3) [<user limit>] (4) [<passphrase>]
1172 (5) [<cipher>] (6) [<hmac>]
1173 (7) [<auth payload>]
1175 This command is used by client to set or change channel flags on
1176 a channel. Channel has several modes that set various properties
1177 of a channel. Modes may be masked together by ORing them thus
1178 having several modes set. The <Channel ID> is the ID of the
1179 target channel. The client changing channel mode MUST be on
1180 the same channel and poses sufficient privileges to be able to
1183 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1184 type MUST be distributed to the channel.
1186 The following channel modes are defined:
1188 0x00000000 SILC_CMODE_NONE
1190 No specific mode on channel. This is the default when
1191 channel is created. This means that channel is just plain
1195 0x00000001 SILC_CMODE_PRIVATE
1197 Channel is private channel. Private channels are shown
1198 in the channel list listed with SILC_COMMAND_LIST command
1199 with indication that the channel is private. Also,
1200 client on private channel will no be detected to be on
1201 the channel as the channel is not shown in the client's
1202 currently joined channel list. Channel founder and
1203 channel operator MAY set/unset this mode.
1205 Typical implementation would use [+|-]p on user interface
1206 to set/unset this mode.
1209 0x00000002 SILC_CMODE_SECRET
1211 Channel is secret channel. Secret channels are not shown
1212 in the list listed with SILC_COMMAND_LIST command. Secret
1213 channels can be considered to be invisible channels.
1214 Channel founder and channel operator MAY set/unset this
1217 Typical implementation would use [+|-]s on user interface
1218 to set/unset this mode.
1221 0x00000004 SILC_CMODE_PRIVKEY
1223 Channel uses private channel key to protect the traffic
1224 on the channel. When this mode is set the client will be
1225 responsible to set the key it wants to use to encrypt and
1226 decrypt the traffic on channel. Server generated channel
1227 keys are not used at all. This mode provides additional
1228 security as clients on channel may agree to use private
1229 channel key that even servers do not know. Naturally,
1230 this requires that every client on the channel knows
1231 the key before hand (it is considered to be pre-shared-
1232 key). The key material is RECOMMENDED to be processed
1233 as stated in the [SILC3] in the section Processing the
1236 As it is local setting it is possible to have several
1237 private channel keys on one channel. In this case several
1238 clients can talk on same channel but only those clients
1239 that share the key with the message sender will be able
1240 to hear the talking. Client SHOULD NOT display those
1241 message for the end user that it is not able to decrypt
1242 when this mode is set.
1244 Only channel founder MAY set/unset this mode. If this
1245 mode is unset the server will distribute new channel
1246 key to all clients on the channel which will be used
1249 Typical implementation would use [+|-]k on user interface
1250 to set/unset this mode.
1253 0x00000008 SILC_CMODE_INVITE
1255 Channel is invite only channel. Client may join to this
1256 channel only if it is invited to the channel. Channel
1257 founder and channel operator MAY set/unset this mode.
1259 Typical implementation would use [+|-]i on user interface
1260 to set/unset this mode.
1263 0x00000010 SILC_CMODE_TOPIC
1265 The topic of the channel may only be set by client that
1266 is channel founder or channel operator. Normal clients
1267 on channel will not be able to set topic when this mode
1268 is set. Channel founder and channel operator MAY set/
1271 Typical implementation would use [+|-]t on user interface
1272 to set/unset this mode.
1275 0x00000020 SILC_CMODE_ULIMIT
1277 User limit has been set to the channel. New clients
1278 may not join to the channel when the limit set is
1279 reached. Channel founder and channel operator MAY set/
1280 unset the limit. The <user limit> argument is the
1281 number of limited users.
1283 Typical implementation would use [+|-]l on user interface
1284 to set/unset this mode.
1287 0x00000040 SILC_CMODE_PASSPHRASE
1289 Passphrase has been set to the channel. Client may
1290 join to the channel only if it is able to provide the
1291 correct passphrase. Setting passphrases to channel
1292 is entirely safe as all commands are protected in the
1293 SILC network. Only channel founder MAY set/unset
1294 the passphrase. The <passphrase> argument is the
1297 Typical implementation would use [+|-]a on user interface
1298 to set/unset this mode.
1301 0x00000080 SILC_CMODE_CIPHER
1303 Sets specific cipher to be used to protect channel
1304 traffic. The <cipher> argument is the requested cipher.
1305 When set or unset the server must re-generate new
1306 channel key. Only channel founder MAY set the cipher of
1307 the channel. When unset the new key is generated using
1308 default cipher for the channel.
1310 Typical implementation would use [+|-]c on user interface
1311 to set/unset this mode.
1314 0x00000100 SILC_CMODE_HMAC
1316 Sets specific hmac to be used to compute the MACs of the
1317 channel message. The <hmac> argument is the requested hmac.
1318 Only channel founder may set the hmac of the channel.
1320 Typical implementation would use [+|-]h on user interface
1321 to set/unset this mode.
1324 0x00000200 SILC_CMODE_FOUNDER_AUTH
1326 Channel founder may set this mode to be able to regain
1327 channel founder rights even if the client leaves the
1328 channel. The <auth payload> is the Authentication Payload
1329 consisting of the public key authentication method and the
1330 authentication data for that method. The passphrase
1331 method cannot be used with this mode. The server MUST NOT
1332 accept NONE authentication method. The server does not
1333 save <auth payload> but MUST verify it. The public key
1334 used to verify the payload is the public key of the
1335 client sending this command. The mode may be set only
1336 if the <auth payload> was verified successfully. The
1337 server also MUST save the founder's public key.
1339 The public key of the founder is sent in the
1340 SILC_NOTIFY_TYPE_CMODE_CHANGE notify type so that other
1341 routers and servers in the network may save the public key.
1342 This way the founder can reclaim the founder rights back
1343 to the channel from any server in the network. The founder
1344 rights can be regained by the SILC_CUMODE_FOUNDER channel
1345 user mode, or during joining procedure with the command
1348 When this channel mode is set the channel also becomes
1349 permanent. If all clients leave the channel while this
1350 mode is set the channel MUST NOT be destroyed. The founder
1351 can reclaim the founder mode back on these empty channels
1352 at any time. Implementations MAY limit the number of how
1353 many channels a user can own.
1355 Typical implementation would use [+|-]f on user interface
1356 to set/unset this mode.
1359 0x00000400 SILC_CMODE_SILENCE_USERS
1361 Channel founder may set this mode to silence normal users
1362 on the channel. Users with operator privileges are not
1363 affected by this mode. Messages sent by normal users
1364 are dropped by servers when this mode is set. This mode
1365 can be used to moderate the channel. Only channel founder
1366 may set/unset this mode.
1369 0x00000800 SILC_CMODE_SILENCE_OPERS
1371 Channel founder may set this mode to silence operators
1372 on the channel. When used with SILC_CMODE_SILENCE_USERS
1373 mode this can be used to set the channel in state where only
1374 the founder of the channel may send messages to the channel.
1375 Messages sent by operators are dropped by servers when this
1376 mode is set. Only channel founder may set/unset this mode.
1379 To make the mode system work, client MUST keep the channel mode
1380 mask locally so that the mode setting and unsetting would work
1381 without problems. The client receives the initial channel mode
1382 mask when it joins to the channel. When the mode changes on
1383 channel the server MUST distribute the changed channel mode mask
1384 to all clients on the channel by sending the notify type
1385 SILC_NOTIFY_TYPE_CMODE_CHANGE. The notify type MUST also be sent
1386 to the server's primary router. If the <channel mode mask> was
1387 not provided this command merely returns the mode mask to the
1390 Reply messages to the command:
1393 Arguments: (1) <Status Payload> (2) <Channel ID>
1394 (3) <channel mode mask>
1396 This command replies with the changed channel mode mask that
1397 client MUST keep locally.
1402 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1403 SILC_STATUS_ERR_TOO_MANY_PARAMS
1404 SILC_STATUS_ERR_NOT_REGISTERED
1405 SILC_STATUS_ERR_NOT_ON_CHANNEL
1406 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1407 SILC_STATUS_ERR_BAD_CHANNEL_ID
1408 SILC_STATUS_ERR_NO_CHANNEL_ID
1409 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1410 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1411 SILC_STATUS_ERR_UNKNOWN_MODE
1412 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1413 SILC_STATUS_ERR_AUTH_FAILED
1416 18 SILC_COMMAND_CUMODE
1419 Arguments: (1) <Channel ID> (2) <mode mask>
1420 (3) <Client ID> (4) [<auth payload>]
1422 This command is used by client to change channel user modes on
1423 channel. Users on channel may have some special modes and this
1424 command is used by channel operators to set or change these modes.
1425 The <Channel ID> is the ID of the target channel. The <mode mask>
1426 is OR'ed mask of modes. The <Client ID> is the target client.
1427 The client changing channel user modes MUST be on the same channel
1428 as the target client and poses sufficient privileges to be able to
1431 When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1432 type is distributed to the channel.
1434 The following channel modes are defined:
1436 0x00000000 SILC_CUMODE_NONE
1438 No specific mode. This is the normal situation for client.
1439 Also, this is the mode set when removing all modes from
1443 0x00000001 SILC_CUMODE_FOUNDER
1445 The client is channel founder of the channel. Usually this
1446 mode is set only by the server when the channel was created.
1447 However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1448 been set, the client can claim channel founder privileges
1449 by providing the <auth payload> that the server will use
1450 to authenticate the client. The public key that server will
1451 use to verify the <auth payload> MUST the same public key
1452 that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1453 mode was set. The client MAY remove this mode at any time.
1456 0x00000002 SILC_CUMODE_OPERATOR
1458 Sets channel operator privileges on the channel for a
1459 client on the channel. Channel founder and channel operator
1460 MAY set/unset this mode. The client MAY remove this mode
1464 0x00000004 SILC_CUMODE_BLOCK_MESSAGES
1466 Marks that the client wishes not to receive any channel
1467 messages sent for the channel. Client MAY set and unset
1468 this mode to itself. Client MUST NOT set it to anyone else.
1469 When this mode is set server MUST NOT deliver channel
1470 messages to this client. Other packets such as channel
1471 key packets are still sent to the client.
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 0x00000008 SILC_CUMODE_BLOCK_MESSAGES_USERS
1481 Marks that the client wishes not to receive any channel
1482 messages sent from normal users. Only messages sent by
1483 channel founder or channel operator is accepted. Client
1484 MAY set and unset this mode to itself. Client MUST NOT
1485 set it to anyone else. When this mode is set server MUST
1486 NOT deliver channel messages that are sent by normal users
1489 A separate service could provide additional filtering
1490 features for accepting channel messages from certain
1491 sender. However, this document does not specify such
1495 0x00000010 SILC_CUMODE_BLOCK_MESSAGES_ROBOTS
1497 Marks that the client wishes not to receive any channel
1498 messages sent from robots. Messages sent by users with
1499 the SILC_UMODE_ROBOT user mode set are not delivered.
1500 Client MAY set and unset this mode to itself. Client MUST
1501 NOT set it to anyone else. When this mode is set server
1502 MUST NOT deliver channel messages that are sent by robots
1506 0x00000020 SILC_CUMODE_QUIET
1508 Marks that the client cannot talk on the channel. This
1509 mode can be set by channel operator or channel founder to
1510 some other user that is not operator or founder. The
1511 target client MUST NOT unset this mode. When this mode
1512 is set the server MUST drop messages sent by this client
1516 Reply messages to the command:
1519 Arguments: (1) <Status Payload> (2) <channel user mode mask>
1520 (3) <Channel ID> (4) <Client ID>
1522 This command replies with the changed channel user mode mask that
1523 client MUST keep locally. The <Channel ID> is the specified
1524 channel. The <Client ID> is the target client.
1529 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1530 SILC_STATUS_ERR_TOO_MANY_PARAMS
1531 SILC_STATUS_ERR_NOT_REGISTERED
1532 SILC_STATUS_ERR_NOT_ON_CHANNEL
1533 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1534 SILC_STATUS_ERR_BAD_CHANNEL_ID
1535 SILC_STATUS_ERR_NO_CHANNEL_ID
1536 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1537 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1538 SILC_STATUS_ERR_UNKNOWN_MODE
1539 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1540 SILC_STATUS_ERR_AUTH_FAILED
1543 19 SILC_COMMAND_KICK
1546 Arguments: (1) <Channel ID> (2) <Client ID>
1549 This command is used by channel operators to remove a client from
1550 channel. The <channel> argument is the channel the client to be
1551 removed is on currently. Note that the "kicker" must be on the same
1552 channel. If <comment> is provided it will be sent to the removed
1555 After kicking the client the server MUST send the notify type
1556 SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1557 The channel key MUST also be re-generated after kicking, unless
1558 the SILC_CMODE_PRIVKEY mode is set.
1560 Reply messages to the command:
1563 Arguments: (1) <Status Payload>
1565 This command replies only with Status Payload.
1570 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1571 SILC_STATUS_ERR_TOO_MANY_PARAMS
1572 SILC_STATUS_ERR_NOT_REGISTERED
1573 SILC_STATUS_ERR_NO_SUCH_CHANNEL
1574 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1575 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1576 SILC_STATUS_ERR_NO_CLIENT_ID
1582 Arguments: (1) <Channel ID> (2) [<adding client>]
1583 (3) [<removing client>]
1585 This command is used to manage the ban list of the channel
1586 indicated by the <Channel ID>. A client that is banned from
1587 channel is no longer able to join the channel. The client which
1588 is executing this command MUST have at least channel operator
1589 privileges on the channel.
1591 The <adding client> and <removing client> are used to add to and
1592 remove from the ban list. The format of the <adding client> and
1593 the <removing client> is of following format:
1595 [<nickname>[@<server>]!][<username>]@[<hostname>]
1597 The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1598 primary router after adding to or removing from the ban list.
1599 The wildcards MAY be used with this command. If adding or removing
1600 from than one clients then the lists are an comma (`,') separated.
1602 If this command is executed without the ban arguments the command
1603 merely replies with the current ban list.
1606 Reply messages to the command:
1609 Arguments: (1) <Status Payload> (2) <Channel ID>
1612 This command replies with the <Channel ID> of the channel and
1613 the current <ban list> of the channel if it exists.
1618 SILC_STATUS_ERR_NOT_REGISTERED
1619 SILC_STATUS_ERR_TOO_MANY_PARAMS
1620 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1621 SILC_STATUS_ERR_NO_CHANNEL_ID
1622 SILC_STATUS_ERR_NOT_ON_CHANNEL
1623 SILC_STATUS_ERR_NO_CHANNEL_PRIV
1624 SILC_STATUS_ERR_RESOURCE_LIMIT
1627 21 SILC_COMMAND_DETACH
1632 This command is used to detach from the network. Client can
1633 send this command to its server to indicate that it will be
1634 detached. By detaching the client remains in the network but
1635 the actual network connection to the server is closed. The
1636 client may then later resume the old session back.
1638 When this command is received the server MUST check that the
1639 client is locally connected client, and set the user mode
1640 SILC_UMODE_DETACHED flag. The SILC_NOTIFY_TYPE_UMODE_CHANGE
1641 MUST be also sent to routers. The server then sends command
1642 reply to this command and closes the network connection.
1643 The server MUST NOT remove the client from its lists, or send
1644 any signoff notifications for this client. See the [SILC1]
1645 for detailed information about detaching.
1647 Reply messages to the command:
1650 Arguments: (1) <Status Payload>
1652 This command replies only with the status indication.
1657 SILC_STATUS_ERR_NOT_REGISTERED
1660 22 SILC_COMMAND_WATCH
1663 Arguments: (1) <Client ID> (2) [<add nickname>]
1664 (3) [<del nickname>]
1666 This command is used to set up a watch for <add nickname>
1667 nickname. When a user in the network appears with the
1668 nickname, or signoffs the network or user's mode is changed
1669 the client which set up the watch will be notified about
1670 this change. This can be used to watch for certain nicknames
1671 in the network and receive notifications when for example a
1672 friend appears in the network or leaves the network.
1674 The <del nickname> is a nickname that has been previously
1675 added to watch list and is now removed from it. Notifications
1676 for that nickname will not be delivered anymore.
1678 The <Client ID> is the Client ID of the sender of this command.
1680 The nickname set to watch MUST NOT include any wildcards.
1681 Note also that a nickname may match several users since
1682 nicknames are not unique. Implementations MAY set limits
1683 for how many nicknames client can watch.
1685 When normal server receives this command from client it
1686 MUST send it to its router. Router will process the command
1687 and actually keeps the watch list.
1689 Reply messages to the command:
1692 Arguments: (1) <Status Payload>
1694 This command replies only with the status indication.
1699 SILC_STATUS_ERR_NOT_REGISTERED
1700 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1701 SILC_STATUS_ERR_TOO_MANY_PARAMS
1702 SILC_STATUS_ERR_BAD_NICKNAME
1703 SILC_STATUS_ERR_WILDCARDS
1704 SILC_STATUS_ERR_RESOURCE_LIMIT
1705 SILC_STATUS_ERR_NO_SUCH_NICK
1706 SILC_STATUS_ERR_NICKNAME_IN_USE
1709 23 SILC_COMMAND_SILCOPER
1712 Arguments: (1) <username> (2) <authentication payload>
1714 This command is used by normal client to obtain router operator
1715 privileges (also known as SILC operator) on the router. Note
1716 that router operator has privileges that supersedes the server
1717 operator privileges.
1719 The <username> is the username set in the server configurations
1720 as operator. The <authentication payload> is the data that the
1721 client is authenticated against. It may be passphrase prompted
1722 for user on client's screen or it may be public key or certificate
1723 authentication data (data signed with private key). The public
1724 key that router will use to verify the signature found in the
1725 payload should be verified. It is recommended that the public
1726 key is saved locally in the router and router would not use
1727 any public keys received during the SKE.
1729 Difference between router operator and server operator is that
1730 router operator is able to handle cell level properties while
1731 server operator (even on router server) is able to handle only
1732 local properties, such as, local connections and normal server
1733 administration. The router operator is also able to use the
1734 SILC_COMMAND_KILL command.
1736 After changing the mode server MUST send the notify type
1737 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1739 Reply messages to the command:
1742 Arguments: (1) <Status Payload>
1744 This command replies only with Status Payload.
1749 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1750 SILC_STATUS_ERR_TOO_MANY_PARAMS
1751 SILC_STATUS_ERR_NOT_REGISTERED
1752 SILC_STATUS_ERR_AUTH_FAILED
1755 24 SILC_COMMAND_LEAVE
1758 Arguments: (1) <Channel ID>
1760 This command is used by client to leave a channel the client is
1763 When leaving channel the server MUST send the notify type
1764 SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1765 The channel key MUST also be re-generated when leaving the channel
1766 and distribute it to all clients still currently on the channel.
1767 The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1770 Reply messages to the command:
1773 Arguments: (1) <Status Payload> (2) <Channel ID>
1775 The <Channel ID> is the ID of left channel.
1780 SILC_STATUS_ERR_NOT_REGISTERED
1781 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1782 SILC_STATUS_ERR_TOO_MANY_PARAMS
1783 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1784 SILC_STATUS_ERR_BAD_CHANNEL_ID
1785 SILC_STATUS_ERR_NO_CHANNEL_ID
1788 25 SILC_COMMAND_USERS
1791 Arguments: (1) [<Channel ID>] (2) [<channel name>]
1793 This command is used to list user names currently on the requested
1794 channel; either the argument <Channel ID> or the <channel name>.
1795 One of these arguments must be present. The server MUST resolve
1796 the joined clients and reply with a lists of users on the channel
1797 and with list of user modes on the channel.
1799 If the requested channel is a private or secret channel, this
1800 command MUST NOT send the list of users, but error is returned
1801 to the sender, except if the sender is on the channel, or the
1804 Reply messages to the command:
1807 Arguments: (1) <Status Payload> (2) <Channel ID>
1808 (3) <list count> (4) <Client ID list>
1809 (5) <client mode list>
1811 This command replies with the Channel ID of the requested channel
1812 Client ID list of the users on the channel and list of their modes.
1813 The Client ID list has Client ID's of all users in the list. The
1814 <Client ID list> is formed by adding Client ID's one after another.
1815 The <client mode list> is formed by adding client's user modes on
1816 the channel one after another (4 bytes (32 bits) each). The <list
1817 count> of length of 4 bytes (32 bits), tells the number of entries
1818 in the lists. Both lists MUST have equal number of entries.
1823 SILC_STATUS_ERR_NOT_REGISTERED
1824 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1825 SILC_STATUS_ERR_TOO_MANY_PARAMS
1826 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1827 SILC_STATUS_ERR_BAD_CHANNEL_ID
1828 SILC_STATUS_ERR_NO_CHANNEL_ID
1829 SILC_STATUS_ERR_NOT_ON_CHANNEL
1832 26 SILC_COMMAND_GETKEY
1835 Arguments: (1) <ID Payload>
1837 This command is used to fetch the public key of the client or
1838 server indicated by the <ID Payload>. The public key is fetched
1839 from the server where to the client is connected.
1841 Reply messages to the command:
1844 Arguments: (1) <Status Payload> (2) <ID Payload>
1845 (3) [<Public Key Payload>]
1847 This command replies with the client's or server's ID and with
1848 the <Public Key Payload>.
1853 SILC_STATUS_ERR_NOT_REGISTERED
1854 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1855 SILC_STATUS_ERR_TOO_MANY_PARAMS
1856 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1857 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1860 27 SILC_COMMAND_SERVICE
1863 Arguments: (1) [<service name>] (2) [<auth payload>]
1866 This command is used to negotiate a service agreement with a
1867 remote server. If this command is given without arguments it
1868 MAY return the service list, if it is publicly available. The
1869 <service name> is a service sepcific identifier, and the
1870 <auth payload> MAY be used to authenticate the requestor to the
1871 remote service. The authentication to a service may be based
1872 on previous agreement with the requestor and the service
1873 provider. The command MAY also take additional service
1876 This document does not specify any services. How the services
1877 are configured and put available in a server is also out of
1878 scope of this document.
1880 This command MAY be used by client to start using some service
1881 in a server, but it also MAY be used by server to negotiate
1882 to start using a service in some other server or router.
1884 After the negotiation is done both of the parties need to know
1885 from the service identifier how the service can be used. The
1886 service can be considered to be a protocol which both of the
1887 parties need to support.
1889 Reply messages to the command:
1892 Arguments: (1) <Status Payload> (2) [<service list>]
1893 (3) [<service name>] (n) [...]
1896 This command MAY reply with the <service list> when command is
1897 given without arguments, and the list is a comma separated list
1898 of service identifiers. The <service name> is the service that
1899 the sender requested and this is provided when the server has
1900 accepted the sender to use the <service name>. The command
1901 reply MAY also have additional service specific arguments.
1906 SILC_STATUS_ERR_NOT_REGISTERED
1907 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1908 SILC_STATUS_ERR_TOO_MANY_PARAMS
1909 SILC_STATUS_ERR_NO_SUCH_SERVICE
1910 SILC_STATUS_ERR_AUTH_FAILED
1911 SILC_STATUS_ERR_PERM_DENIED
1916 Currently undefined commands.
1921 These commands are reserved for private use and will not be defined
1925 255 SILC_COMMAND_MAX
1927 Reserved command. This must not be sent.
1932 2.3.1 SILC Command Status Payload
1934 Command Status Payload is sent in command reply messages to indicate
1935 the status of the command. The payload is one of argument in the
1936 command thus this is the data area in Command Argument Payload described
1937 in [SILC2]. The payload is only 2 bytes of length. The following
1938 diagram represents the Command Status Payload (field is always in
1945 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1946 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1948 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1952 Figure 6: SILC Command Status Payload
1956 o Status (1 byte) - Indicates the status message type,
1957 error, start of list, entry of list or end of list.
1959 o Error (1 byte) - Indicates the error if the Status
1960 field is some list status, which means there are list
1964 The values in Status and Error fields are set according
1965 the following rules:
1968 o If there is single reply and error has not occurred
1969 then Status field includes value SILC_STATUS_OK, and
1970 the Error field MUST be ignored (and set to zero
1973 o If there is single error, then Status field includes
1974 one of the error values, and the Error field MUST be
1975 ignored (and set to zero value).
1977 o If there will be multiple successful command replies
1978 then Status field includes SILC_STATUS_LIST_START,
1979 SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1980 and Error field is set to SILC_STATUS_OK.
1982 o If there are multiple error replies then Status field
1983 includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1984 or SILC_STATUS_LIST_END value, and the Error field
1985 includes the error value.
1988 This way it is possible to send single successful or
1989 single error reply, but also multiple successful and
1990 multiple error replies. Note that it is possible to
1991 send both list of successful replies and list of error
1992 replies at the same time, however in this case the
1993 list of error replies MUST be sent after the successful
1994 replies. This way the recipient may ignore the multiple
1995 errors if it wishes to do so.
1997 All Status messages are described in the next section.
2001 2.3.2 SILC Status Types
2003 Status messages are returned in SILC protocol in command reply
2004 packet and in notify packet. The SILC_PACKET_COMMAND_REPLY is
2005 the command reply packet and status types are sent inside the
2006 Status Payload as one of command reply argument, as defined in
2007 previous sections. For SILC_PACKET_NOTIFY packet they can be sent
2008 as defined in [SILC2] for SILC_NOTIFY_TYPE_ERROR type. The same
2009 types defined in this section are used in both cases.
2011 When returning status messages in the command reply message they
2012 indicate whether the command was executed without errors. If error
2013 occurred the status indicates which error occurred.
2015 When sending status messages in SILC_NOTIFY_TYPE_ERROR notify type
2016 they always send some error status. Usually they are sent to
2017 indicate that error occurred while processing some SILC packet.
2018 Please see the [SILC1] and [SILC2] for more information sending
2019 status types in SILC_NOTIFY_TYPE_ERROR notify.
2021 The Status Types are only numeric values and the receiver must
2022 convert the numeric values into human readable messages if this
2023 is desired in the application.
2025 List of all defined status types:
2028 Generic status messages:
2032 Ok status. Everything went Ok. The status payload maybe
2033 safely ignored in this case.
2035 1 SILC_STATUS_LIST_START
2037 Start of the list. There will be several command replies and
2038 this reply is the start of the list.
2040 2 SILC_STATUS_LIST_ITEM
2042 Item in the list. This is one of the item in the list but not the
2045 3 SILC_STATUS_LIST_END
2047 End of the list. There were several command replies and this
2048 reply is the last of the list. There won't be other replies
2049 belonging to this list after this one.
2053 Currently undefined and has been reserved for the future.
2056 Error status message:
2060 10 SILC_STATUS_ERR_NO_SUCH_NICK
2062 "No such nickname". Requested nickname does not exist.
2064 11 SILC_STATUS_ERR_NO_SUCH_CHANNEL
2066 "No such channel". Requested channel name does not exist.
2068 12 SILC_STATUS_ERR_NO_SUCH_SERVER
2070 "No such server". Requested server name does not exist.
2072 13 SILC_STATUS_ERR_INCOMPLETE_INFORMATION
2074 "Incomplete registration information". Information remote
2075 sent was incomplete.
2077 14 SILC_STATUS_ERR_NO_RECIPIENT
2079 "No recipient given". Command required recipient which was
2082 15 SILC_STATUS_ERR_UNKNOWN_COMMAND
2084 "Unknown command". Command sent to server is unknown by the
2087 16 SILC_STATUS_ERR_WILDCARDS
2089 "Wildcards cannot be used". Wildcards were provided but they
2092 17 SILC_STATUS_ERR_NO_CLIENT_ID
2094 "No Client ID given". Client ID were expected as command
2095 parameter but were not found.
2097 18 SILC_STATUS_ERR_NO_CHANNEL_ID
2099 "No Channel ID given". Channel ID were expected as command
2100 parameter but were not found.
2102 19 SILC_STATUS_ERR_NO_SERVER_ID
2104 "No Serve ID given". Server ID were expected as command
2105 parameter but were not found.
2107 20 SILC_STATUS_ERR_BAD_CLIENT_ID
2109 "Bad Client ID". Client ID provided were erroneous.
2111 21 SILC_STATUS_ERR_BAD_CHANNEL_ID
2113 "Bad Channel ID". Channel ID provided were erroneous.
2115 22 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
2117 "No such Client ID". Client ID provided does not exist.
2118 The unknown Client ID MUST be provided as next argument
2121 23 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
2123 "No such Channel ID". Channel ID provided does not exist.
2124 The unknown Channel ID MUST be provided as next argument
2127 24 SILC_STATUS_ERR_NICKNAME_IN_USE
2129 "Nickname already exists". Nickname created could not be
2130 registered because number of same nicknames were already set to
2131 maximum. This is not expected to happen in real life but is
2134 25 SILC_STATUS_ERR_NOT_ON_CHANNEL
2136 "You are not on that channel". The command were specified for
2137 channel user is not currently on.
2139 26 SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
2141 "They are not on channel". The requested target client is not
2142 on requested channel.
2144 27 SILC_STATUS_ERR_USER_ON_CHANNEL
2146 "User already on channel". User were invited on channel they
2149 28 SILC_STATUS_ERR_NOT_REGISTERED
2151 "You have not registered". User executed command that requires
2152 the client to be registered on the server before it may be
2155 29 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
2157 "Not enough parameters". Command requires more parameters
2160 30 SILC_STATUS_ERR_TOO_MANY_PARAMS
2162 "Too many parameters". Too many parameters were provided
2165 31 SILC_STATUS_ERR_PERM_DENIED
2167 "Permission denied". Generic permission denied error status
2168 to indicate disallowed access.
2170 32 SILC_STATUS_ERR_BANNED_FROM_SERVER
2172 "You are banned from this server". The client tried to register
2173 on server that has explicitly denied this host to connect.
2175 33 SILC_STATUS_ERR_BAD_PASSWORD
2177 "Cannot join channel. Incorrect password". Password provided for
2178 channel were not accepted.
2180 34 SILC_STATUS_ERR_CHANNEL_IS_FULL
2182 "Cannot join channel. Channel is full". The channel is full
2183 and client cannot be joined to it.
2185 35 SILC_STATUS_ERR_NOT_INVITED
2187 "Cannot join channel. You have not been invited". The channel
2188 is invite only channel and client has not been invited.
2190 36 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
2192 "Cannot join channel. You have been banned". The client has
2193 been banned from the channel.
2195 37 SILC_STATUS_ERR_UNKNOWN_MODE
2197 "Unknown mode". Mode provided by the client were unknown to
2200 38 SILC_STATUS_ERR_NOT_YOU
2202 "Cannot change mode for other users". User tried to change
2203 someone else's mode.
2205 39 SILC_STATUS_ERR_NO_CHANNEL_PRIV
2207 "Permission denied. You are not channel operator". Command may
2208 be executed only by channel operator.
2210 40 SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
2212 "Permission denied. You are not channel founder". Command may
2213 be executed only by channel operator.
2215 41 SILC_STATUS_ERR_NO_SERVER_PRIV
2217 "Permission denied. You are not server operator". Command may
2218 be executed only by server operator.
2220 42 SILC_STATUS_ERR_NO_ROUTER_PRIV
2222 "Permission denied. You are not SILC operator". Command may be
2223 executed only by router (SILC) operator.
2225 43 SILC_STATUS_ERR_BAD_NICKNAME
2227 "Bad nickname". Nickname requested contained illegal characters
2230 44 SILC_STATUS_ERR_BAD_CHANNEL
2232 "Bad channel name". Channel requested contained illegal characters
2235 45 SILC_STATUS_ERR_AUTH_FAILED
2237 "Authentication failed". The authentication data sent as
2238 argument were wrong and thus authentication failed.
2240 46 SILC_STATUS_ERR_UNKOWN_ALGORITHM
2242 "The algorithm was not supported." The server does not support the
2243 requested algorithm.
2245 47 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2247 "No such Server ID". Server ID provided does not exist.
2248 The unknown Server ID MUST be provided as next argument
2251 48 SILC_STATUS_ERR_RESOURCE_LIMIT
2253 "No more resources available". This can mean that server cannot
2254 or will not accept something due to resource limitations.
2256 49 SILC_STATUS_ERR_NO_SUCH_SERVICE
2258 "Service does not exist". Requested service identifier is
2261 50 SILC_STATUS_ERR_NOT_AUTHENTICATED
2263 "You have not been authenticated". Remote connection is not
2264 authenticated even though it is supposed to be.
2266 51 SILC_STATUS_ERR_BAD_SERVER_ID
2268 "Server ID is not valid". Provided server ID is not valid.
2270 52 SILC_STATUS_ERR_KEY_EXCHANGE_FAILED
2272 "Key exchange failed". Key Exchange protocol failed.
2274 53 SILC_STATUS_ERR_BAD_VERSION
2276 "Bad version". Protocol or software version mismatch.
2282 3 Security Considerations
2284 Security is central to the design of this protocol, and these security
2285 considerations permeate the specification. Common security considerations
2286 such as keeping private keys truly private and using adequate lengths for
2287 symmetric and asymmetric keys must be followed in order to maintain the
2288 security of this protocol.
2294 [SILC1] Riikonen, P., "Secure Internet Live Conferencing (SILC),
2295 Protocol Specification", Internet Draft, April 2001.
2297 [SILC2] Riikonen, P., "SILC Packet Protocol", Internet Draft,
2300 [SILC3] Riikonen, P., "SILC Key Exchange and Authentication
2301 Protocols", Internet Draft, April 2001.
2303 [IRC] Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2306 [IRC-ARCH] Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2309 [IRC-CHAN] Kalt, C., "Internet Relay Chat: Channel Management", RFC
2312 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2315 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2318 [SSH-TRANS] Ylonen, T., et al, "SSH Transport Layer Protocol",
2321 [PGP] Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2324 [SPKI] Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2327 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2328 Infrastructure, Certificate and CRL Profile", RFC 2459,
2331 [Schneier] Schneier, B., "Applied Cryptography Second Edition",
2332 John Wiley & Sons, New York, NY, 1996.
2334 [Menezes] Menezes, A., et al, "Handbook of Applied Cryptography",
2337 [OAKLEY] Orman, H., "The OAKLEY Key Determination Protocol",
2338 RFC 2412, November 1998.
2340 [ISAKMP] Maughan D., et al, "Internet Security Association and
2341 Key Management Protocol (ISAKMP)", RFC 2408, November
2344 [IKE] Harkins D., and Carrel D., "The Internet Key Exchange
2345 (IKE)", RFC 2409, November 1998.
2347 [HMAC] Krawczyk, H., "HMAC: Keyed-Hashing for Message
2348 Authentication", RFC 2104, February 1997.
2350 [PKCS1] Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2351 Specifications, Version 2.0", RFC 2437, October 1998.
2353 [RFC2119] Bradner, S., "Key Words for use in RFCs to Indicate
2354 Requirement Levels", BCP 14, RFC 2119, March 1997.
2356 [RFC2279] Yergeau, F., "UTF-8, a transformation format of ISO
2357 10646", RFC 2279, January 1998.
2368 Snellmanninkatu 34 A 15
2372 EMail: priikone@iki.fi
2374 This Internet-Draft expires XXX
2380 This appendix defines the usage of the <Requested Attributes> argument in
2381 the SILC_COMMAND_WHOIS command. The attributes are defined in [ATTRS],
2382 and may be used to request additional information about the user. Since
2383 the information that may be requested using the attributes is something
2384 that server cannot deliver to the sender, it is possible to send the WHOIS
2385 command directly to the destination client whom will then provide the
2386 requested attributes. This requires the servers to relay the WHOIS
2387 command to the client, and it requires capability for handling the WHOIS
2388 command in the client end.
2390 The <Requested Attributes> MAY include several attributes that are
2391 requested. The format and encoding of the <Requested Attributes> is as
2392 defined in [ATTRS]. When <Requested Attributes> argument is set the
2393 server MAY process the attributes to see whether it can narrow down
2394 the WHOIS search, for example when searching with a nickname. The
2395 normal servers MUST process the WHOIS command as normal WHOIS command,
2396 that is to send the command directly to the router. The router MAY
2397 process the attributes, but it MUST send the command to the server
2398 that owns the requested client.
2400 The server that owns the client and receives the command MUST check
2401 whether the client is detached from the network. If it is detached,
2402 that is the user mode has the SILC_UMODE_DETACHED mode set, it SHOULD
2403 process the attributes and provide as many of the requested attributes
2404 as possible and then send reply back to the sender. If the client is
2405 active in the network it MUST send the command to the client for
2408 The client receiving WHOIS command SHOULD check whether the
2409 <Requested Attributes> argument is set. If it is not set then the
2410 WHOIS command SHOULD be discarded. The client processes the requested
2411 attributes and SHOULD reply to each of the requested attribute with
2412 either valid value, or with an indication that the requested attribute
2413 is not known or supported. This is to be done as defined in [ATTRS].
2414 The client always MUST send a reply to the command when some attributes
2415 were requested. The client MAY also add additional attributes to the
2416 reply even if they were not requested. The client MAY also digitally
2417 sign the attributes with ATTRIBUTE_USER_DIGITAL_SIGNATURE as defined
2418 in [ATTRS]. Then the client sends the reply back to the sender of
2419 the command. The command reply that client assembles does not need
2420 to include any other argument but the <Status Payload> (1), and the
2421 <Attributes> (11). The server receiving reply from client MUST allow
2422 this sort of command reply for WHOIS command.
2424 The information received from the client MAY be cached in the
2425 server's end. The caching may be desired for example if the client
2426 can be detached from the network. This way the server is then able
2427 to provide at least partial information for a requestor. The
2428 server MAY also process the command reply and verify whether the
2429 attributes provided in the reply are actually valid. If it can do
2430 this, and verify that they indeed are valid values it MAY append
2431 a digital signature at the end of the attributes with the
2432 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE as defined in [ATTRS]. The
2433 server then MUST provide valid WHOIS command reply to the sender
2434 of the command. Other servers and routers that receive the command
2435 reply enroute to the original sender MAY also cache the information.
2437 The client which receives the command reply to the WHOIS command
2438 SHOULD verify the ATTRIBUTE_USER_DIGITAL_SIGNATURE and the
2439 ATTRIBUTE_SERVER_DIGITAL_SIGNATURE if they are provided.
projects / crypto.git / blob