1 .pl 10.0i
2 .po 0
3 .ll 7.2i
4 .lt 7.2i
5 .nr LL 7.2i
6 .nr LT 7.2i
7 .ds LF Riikonen
8 .ds RF FORMFEED[Page %]
9 .ds CF
10 .ds LH Internet Draft
11 .ds RH 11 February 2004
12 .ds CH
13 .na
14 .hy 0
15 .in 0
16 .nf
17 Network Working Group P. Riikonen
18 Internet-Draft
19 draft-riikonen-silc-commands-06.txt 11 February 2004
20 Expires: 11 August 2004
21
22 .in 3
23
24 .ce 2
25 SILC Commands
26 <draft-riikonen-silc-commands-06.txt>
27
28 .ti 0
29 Status of this Memo
30
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.
36
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."
41
42 The list of current Internet-Drafts can be accessed at
43 http://www.ietf.org/ietf/1id-abstracts.txt
44
45 The list of Internet-Draft Shadow Directories can be accessed at
46 http://www.ietf.org/shadow.html
47
48 The distribution of this memo is unlimited.
49
50
51 .ti 0
52 Abstract
53
54 This memo describes the commands used in the Secure Internet Live
55 Conferencing (SILC) protocol, specified in the Secure Internet Live
56 Conferencing, Protocol Specification [SILC1]. The SILC Commands are
57 very important part of the SILC protocol. Usually the commands are used
58 by SILC clients to manage the SILC session, but also SILC servers may
59 use the commands. This memo specifies detailed command messages and
60 command reply messages.
61
62
63
64
65
66
67
68
69 .ti 0
70 Table of Contents
71
72 .nf
73 1 Introduction .................................................. 2
74 1.1 Requirements Terminology .................................. 2
75 2 SILC Commands ................................................. 2
76 2.1 SILC Commands Syntax ...................................... 4
77 2.2 SILC Command Argument Idioms .............................. 4
78 2.3 SILC Commands List ........................................ 5
79 2.4 SILC Command Status Payload ............................... 43
80 3 SILC Status Types ............................................. 44
81 4 Security Considerations ....................................... 51
82 5 References .................................................... 51
83 6 Author's Address .............................................. 52
84 Appendix A ...................................................... 52
85 Full Copyright Statement ........................................ 54
86
87
88 .ti 0
89 1. Introduction
90
91 This document describes the commands used in the Secure Internet Live
92 Conferencing (SILC) protocol, specified in the Secure Internet Live
93 Conferencing, Protocol Specification [SILC1]. This document specifies
94 detailed command messages and command reply messages.
95
96 Commands are very important part on SILC network especially for client
97 which uses commands to operate on the SILC network. Commands are used
98 to set nickname, join to channel, change modes and many other things.
99
100 See the [SILC1] for the requirements and the restrictions for the usage
101 of the SILC commands. The [SILC2] defines the command packet type and
102 the Command Payload which is actually used to deliver the commands and
103 command reply messages.
104
105
106 .ti 0
107 1.1 Requirements Terminology
108
109 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
110 MAY, and OPTIONAL, when they appear in this document, are to be
111 interpreted as described in [RFC2119].
112
113
114 .ti 0
115 2 SILC Commands
116
117 .ti 0
118 2.1 SILC Commands Syntax
119
120 This section briefly describes the syntax of the command notions
121 in this document. Every field in command is separated from each
122 other by whitespaces (` ') indicating that each field is independent
123 argument and each argument MUST have own Command Argument Payload.
124 The number of maximum arguments are defined with each command
125 separately. The Command Argument Payload is described in [SILC2].
126
127 Every command defines specific number for each argument. Currently,
128 they are defined in ascending order; first argument has number one
129 (1), second has number two (2) and so on. This number is set into the
130 Argument Type field in the Command Argument Payload. This makes it
131 possible to send the arguments in free order as the number MUST be
132 used to identify the type of the argument. This makes is it also
133 possible to have multiple optional arguments in commands and in
134 command replies. The number of argument is marked in parentheses
135 before the actual argument.
136
137
138
139 .in 6
140 Example: Arguments: (1) <nickname> (2) <username@host>
141 .in 3
142
143
144 Every command replies with Status Payload. This payload tells the
145 sender of the command whether the command was completed successfully or
146 whether there was an error. If error occurred the payload includes the
147 error type. In the next section the Status Payload is not described
148 as it is common to all commands and has been described here. Commands
149 MAY reply with other arguments as well. These arguments are command
150 specific and are described in the next section.
151
152 Example command:
153 .in 6
154
155 EXAMPLE_COMMAND
156
157 .in 8
158 Max Arguments: 3
159 Arguments: (1) <nickname>[@<server>] (2) <message>
160 (3) [<count>]
161
162 The command has maximum of 3 arguments. However, only first
163 and second arguments are mandatory.
164
165 First argument <nickname> is mandatory but may have optional
166 <nickname@server> format as well. Second argument is mandatory
167 <message> argument. Third argument is optional <count> argument.
168
169 The numbers in parentheses are the argument specific numbers
170 that specify the type of the argument in Command Argument Payload.
171 The receiver always knows that, say, argument number two (2) is
172 <message> argument, regardless of the ordering of the arguments in
173 the Command Payload.
174
175 Reply messages to the command:
176
177 Max Arguments: 4
178 Arguments: (1) <Status Payload> (2) [<channel list>]
179 (3) <idle time> (4) [<away message>]
180
181 This command may reply with maximum of 4 arguments. However,
182 only the first and third arguments are mandatory. The numbers
183 in the parentheses have the same meaning as in the upper
184 command sending specification.
185
186 Every command reply with <Status Payload>, it is mandatory
187 argument for all command replies and for this reason it is not
188 described in the command reply descriptions.
189
190
191
192 Status messages:
193
194 SILC_STATUS_OK
195 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
196 SILC_STATUS_ERR_NO_SUCH_NICK
197
198 Every command reply also defines set of status message that it
199 may return inside the <Status Payload>. All status messages
200 are defined in the section 2.3 SILC Command Status Payload
201 The status messages defined with the command are recommendations.
202 It is possible to return other status messages not listed with
203 the command reply definition.
204 .in 3
205
206
207 .ti 0
208 2.2 SILC Command Argument Idioms
209
210 All commands that has an ID as argument (for example <Client ID>) are
211 actually ID Payloads, defined in [SILC2] that includes the type of the
212 ID, length of the ID and the actual ID data. This way variable length
213 ID's can be sent as arguments.
214
215 All passphrases that may be sent in commands as arguments MUST be
216 UTF-8 [RFC3629] encoded. All strings sent as arguments in command and
217 command reply are also UTF-8 encoded, unless otherwise defined. See
218 the [SILC1] for general UTF-8 definition in SILC protocol.
219
220 All public keys and certificates that are sent as arguments are actually
221 Public Key Payloads [SILC2]. This way it is possible to send different
222 kind of public keys and certificate types as arguments.
223
224
225
226
227 .ti 0
228 2.3 SILC Commands List
229
230 This section lists all SILC commands, however, it is expected that a
231 implementation and especially client implementation has many more
232 commands that has only local affect. These commands are official
233 SILC commands that has both client and server sides and cannot be
234 characterized as local commands.
235
236 List of all defined commands in SILC follows.
237
238 .in 0
239 0 SILC_COMMAND_NONE
240
241 None. This is reserved command and MUST NOT be sent.
242
243
244 1 SILC_COMMAND_WHOIS
245
246 Max Arguments: 256
247 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
248 (3) [<Requested Attributes>] (4) [<Client ID>]
249 (n) [...]
250
251 Whois command is used to query various information about specific
252 user. The user may be requested by their nickname and server name.
253 The query may find multiple matching users as there are no unique
254 nicknames in the SILC. The <count> option may be given to narrow
255 down the number of accepted results. If this is not defined there
256 are no limit of accepted results. The query may also be narrowed
257 down by defining the server name of the nickname. The <count> is
258 32 bit MSB first order integer.
259
260 It is also possible to search the user by Client ID. If the
261 <Client ID> is provided server MUST use it as the search value
262 instead of the <nickname>. It is also possible to define multiple
263 Client ID's to search multiple users sending only one WHOIS
264 command. In this case the Client ID's are appended as normal
265 arguments.
266
267 The <Requested Attributes> is defined in [ATTRS] and can be used
268 to request various information about the client. See Appendix A
269 for definition of using these attributes in SILC. If neither the
270 <nickname> or <Client ID> arguments are present but the attributes
271 are, the server MUST use the attributes to do the searching. If
272 none of the arguments, <nickname>, <Client ID> and <Requested
273 Attributes> are present, error MUST be retuned. Server MAY
274 use the <Requested Attributes> to narrow down the search if they
275 present at any time.
276
277 To prevent miss-use of this command wildcards in the nickname
278 or in the server name are not permitted. It is not allowed
279 to request all users on some server. The WHOIS requests MUST
280 be based on explicit nickname request.
281
282 The WHOIS request MUST be always sent to the router by normal
283 server so that all users are searched. However, the server still
284 MUST search its locally connected clients. The router MUST send
285 this command to the server which owns the requested client, if
286 the router is unable to provide all mandatory information about
287 the client. That server MUST reply to the command. Server MUST
288 NOT send whois replies to the client until it has received the
289 reply from its router.
290
291 Reply messages to the command:
292
293 Max Arguments: 11
294 Arguments: (1) <Status Payload> (2) <Client ID>
295 (3) <nickname>[@<server>] (4) <username@host>
296 (5) <real name> (6) [<Channel Payload
297 list>]
298 (7) [<user mode>] (8) [<idle time>]
299 (9) [<fingerprint>] (10) <channel user
300 mode list>
301 (11) [<Attributes>]
302
303
304 This command may reply with several command reply messages to
305 form a list of results. In this case the status payload will
306 include STATUS_LIST_START status in the first reply and
307 STATUS_LIST_END in the last reply to indicate the end of the
308 list. If there are only one reply the status is set to normal
309 STATUS_OK. If multiple Client IDs was requested then each found
310 and unfound client MUST cause successful or error reply,
311 respectively.
312
313 The command replies include the Client ID of the nickname,
314 nickname and server name, user name and host name and user's real
315 name. Client should process these replies only after the last
316 reply has been received with the STATUS_LIST_END status. If the
317 <count> option were defined in the query there will be only
318 <count> many replies from the server.
319
320 The server returns the list of channels if the client has
321 joined channels. In this case the list is list of Channel
322 Payloads. The Mode Mask in the Channel Payload is the channel's
323 mode. The list is encoded by adding the Channel Payloads one
324 after the other. Private and secret channels MUST NOT be sent,
325 except if the sender of this command is on those channels, or
326 the sender is server. The <channel user mode list> MUST also
327 be sent if client is joined channels. This list includes 32 bit
328 MSB first order values one after the other and each indicate
329 the user's mode on a channel. The order of these values MUST
330 be same as the channel order in the <Channel Payload list>.
331
332 The server also returns client's user mode, idle time, and the
333 fingerprint of the client's public key. The <fingerprint> is the
334 binary hash digest of the public key. The fingerprint MUST NOT
335 be sent if the server has not verified the proof of possession of
336 the corresponding private key. Server can do this during the
337 SILC Key Exchange protocol. The <fingerprint> is SHA1 digest.
338
339 The <Attributes> is the reply to the <Requested Attributes>.
340 See the Appendix A for more information.
341
342 Status messages:
343
344 SILC_STATUS_OK
345 SILC_STATUS_LIST_START
346 SILC_STATUS_LIST_END
347 SILC_STATUS_ERR_NO_SUCH_NICK
348 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
349 SILC_STATUS_ERR_WILDCARDS
350 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
351 SILC_STATUS_ERR_TOO_MANY_PARAMS
352
353
354 2 SILC_COMMAND_WHOWAS
355
356 Max Arguments: 2
357 Arguments: (1) <nickname>[@<server>] (2) [<count>]
358
359 Whowas. This command is used to query history information about
360 specific user. The user may be requested by their nickname and
361 server name. The query may find multiple matching users as there
362 are no unique nicknames in the SILC. The <count> option may be
363 given to narrow down the number of accepted results. If this
364 is not defined there are no limit of accepted results. The query
365 may also be narrowed down by defining the server name of the
366 nickname. The <count> is 32 bit MSB first order integer.
367
368 To prevent miss-use of this command wildcards in the nickname
369 or in the server name are not permitted. The WHOWAS requests MUST
370 be based on specific nickname request.
371
372 The WHOWAS request MUST be always sent to the router by server
373 so that all users are searched. However, the server still must
374 search its locally connected clients.
375
376 Reply messages to the command:
377
378 Max Arguments: 5
379 Arguments: (1) <Status Payload> (2) <Client ID>
380 (3) <nickname>[@<server>] (4) <username@host>
381 (5) [<real name>]
382
383 This command may reply with several command reply messages to form
384 a list of results. In this case the status payload will include
385 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
386 the last reply to indicate the end of the list. If there are only
387 one reply the status is set to normal STATUS_OK.
388
389 The command replies with nickname and user name and host name.
390 Every server MUST keep history for some period of time of its
391 locally connected clients.
392
393 Status messages:
394
395 SILC_STATUS_OK
396 SILC_STATUS_LIST_START
397 SILC_STATUS_LIST_END
398 SILC_STATUS_ERR_NO_SUCH_NICK
399 SILC_STATUS_ERR_WILDCARDS
400 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
401 SILC_STATUS_ERR_TOO_MANY_PARAMS
402
403
404 3 SILC_COMMAND_IDENTIFY
405
406 Max Arguments: 256
407 Arguments: (1) [<nickname>[@<server>]] (2) [<server name>]
408 (3) [<channel name>] (4) [<count>]
409 (5) [<ID Payload>] (n) [...]
410
411 Identify command is used to query information about an entity by
412 the entity's name or ID. This command can be used to query
413 information about clients, servers and channels.
414
415 The query may find multiple matching entities. The <count> option
416 may be given to narrow down the number of accepted results. If
417 this is not defined there are no limit of accepted results. The
418 <count> is 32 bit MSB first order integer.
419
420 It is also possible to search the entity by its ID. If the
421 <ID Payload> is provided server must use it as the search value
422 instead of the entity's name. One of the arguments MUST be given.
423 It is also possible to define multiple ID Payloads to search
424 multiple entities sending only one IDENTIFY command. In this case
425 the ID Payloads are appended as normal arguments. The type of the
426 entity is defined by the type of the ID Payload.
427
428 To prevent miss-use of this command wildcards in the names are
429 not permitted. It is not allowed to request for example all users
430 on server.
431
432 Implementations may not want to give interface access to this
433 command as it is hardly a command that would be used by an end
434 user. However, it must be implemented as it is most likely used
435 with private message sending.
436
437 The IDENTIFY command MUST be always sent to the router by server
438 so that all users are searched. However, server MUST still search
439 its locally connected clients.
440
441 Reply messages to the command:
442
443 Max Arguments: 4
444 Arguments: (1) <Status Payload> (2) <ID Payload>
445 (3) [<entity's name>] (4) [<info>]
446
447 This command may reply with several command reply messages to form
448 a list of results. In this case the status payload will include
449 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
450 the last reply to indicate the end of the list. If there are only
451 one reply the status is set to normal STATUS_OK. If multiple Client
452 IDs was requested then each found and unfound client must cause
453 successful or error reply, respectively.
454
455 When querying clients the <entity's name> must include the client's
456 nickname in the following format: nickname[@server]. The
457 <info> must include the client's username and host in the following
458 format: username@host.
459
460 When querying servers the <entity's name> must include the server's
461 full name. The <info> may be omitted.
462
463 When querying channels the <entity's name> must include the
464 channel's name. The <info> may be omitted.
465
466 If the <count> option were defined in the query there will be only
467 <count> many replies from the server.
468
469 Status messages:
470
471 SILC_STATUS_OK
472 SILC_STATUS_LIST_START
473 SILC_STATUS_LIST_END
474 SILC_STATUS_ERR_NO_SUCH_NICK
475 SILC_STATUS_ERR_NO_SUCH_SERVER
476 SILC_STATUS_ERR_NO_SUCH_CHANNEL
477 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
478 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
479 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
480 SILC_STATUS_ERR_WILDCARDS
481 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
482 SILC_STATUS_ERR_TOO_MANY_PARAMS
483
484
485 4 SILC_COMMAND_NICK
486
487 Max Arguments: 1
488 Arguments: (1) <nickname>
489
490 Set/change nickname. This command is used to set nickname for
491 user. See [SILC1] for definition of correctly formatted
492 nickname.
493
494 When nickname is changed new Client ID is generated. Server MUST
495 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
496 channels (if any) the client is joined on. Then it MUST send
497 SILC_NOTIFY_TYPE_NICK_CHANGE notify to its primary route to
498 notify about nickname and Client ID change.
499
500 Reply messages to the command:
501
502 Max Arguments: 3
503 Arguments: (1) <Status Payload> (2) <New ID Payload>
504 (3) <nickname>
505
506 This command replies always with <New ID Payload> that is
507 generated by the server every time user changes their nickname.
508 Client receiving this payload MUST start using the received
509 Client ID as its current valid Client ID. The New ID Payload
510 is described in [SILC2]. The <nickname> is the user's new
511 nickname.
512
513 Status messages:
514
515 SILC_STATUS_OK
516 SILC_STATUS_ERR_WILDCARDS
517 SILC_STATUS_ERR_NICKNAME_IN_USE
518 SILC_STATUS_ERR_BAD_NICKNAME
519 SILC_STATUS_ERR_NOT_REGISTERED
520 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
521 SILC_STATUS_ERR_TOO_MANY_PARAMS
522
523
524 5 SILC_COMMAND_LIST
525
526 Max Arguments: 1
527 Arguments: (1) [<Channel ID>]
528
529 The list command is used to list channels and their topics on the
530 current server. If the <Channel ID> parameter is used, only the
531 status of that channel is displayed. Secret channels are not
532 listed at all. Private channels are listed with status indicating
533 that the channel is private. Router MAY reply with all channels
534 it knows about.
535
536 Reply messages to the command:
537
538 Max Arguments: 5
539 Arguments: (1) <Status Payload> (2) <Channel ID>
540 (3) <channel> (4) [<topic>]
541 (5) [<user count>]
542
543 This command may reply with several command reply messages to form
544 a list of results. In this case the status payload will include
545 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
546 the last reply to indicate the end of the list. If there are only
547 one reply the status is set to normal STATUS_OK.
548
549 This command replies with Channel ID, name and the topic of the
550 channel. If the channel is private channel the <topic> SHOULD
551 include the "*private*" string.
552
553 Status messages:
554
555 SILC_STATUS_OK
556 SILC_STATUS_LIST_START
557 SILC_STATUS_LIST_END
558 SILC_STATUS_ERR_WILDCARDS
559 SILC_STATUS_ERR_NOT_REGISTERED
560 SILC_STATUS_ERR_TOO_MANY_PARAMS
561 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
562 SILC_STATUS_ERR_NO_CHANNEL_ID
563 SILC_STATUS_ERR_NO_SUCH_SERVER
564
565
566 6 SILC_COMMAND_TOPIC
567
568 Max Arguments: 2
569 Arguments: (1) <Channel ID> (2) [<topic>]
570
571 This command is used to change or view the topic of a channel.
572 The topic for channel <Channel ID> is returned if there is no
573 <topic> given. If the <topic> parameter is present, the topic
574 for that channel will be changed, if the channel modes permit
575 this action.
576
577 After setting the topic the server MUST send the notify type
578 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
579 the channel which topic was changed.
580
581 Reply messages to the command:
582
583 Max Arguments: 2
584 Arguments: (1) <Status Payload> (2) <Channel ID>
585 (3) [<topic>]
586
587 The command may reply with the topic of the channel if it is
588 set.
589
590 Status messages:
591
592 SILC_STATUS_OK
593 SILC_STATUS_ERR_NOT_ON_CHANNEL
594 SILC_STATUS_ERR_WILDCARDS
595 SILC_STATUS_ERR_NOT_REGISTERED
596 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
597 SILC_STATUS_ERR_NO_SUCH_CHANNEL
598 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
599 SILC_STATUS_ERR_NO_CHANNEL_ID
600 SILC_STATUS_ERR_BAD_CHANNEL_ID
601 SILC_STATUS_ERR_TOO_MANY_PARAMS
602 SILC_STATUS_ERR_NO_CHANNEL_PRIV
603
604
605 7 SILC_COMMAND_INVITE
606
607 Max Arguments: 4
608 Arguments: (1) <Channel ID> (2) [<Client ID>]
609 (3) [<add | del>] (4) [<invite list>]
610
611 This command can be used to invite other clients to join to a
612 channel, and to manage the channel's invite list. The <Client
613 ID> argument is the target client's ID that is being invited.
614 The <Channel ID> is the Channel ID of the requested channel.
615 The sender of this command MUST be on the channel. The server
616 MUST also send the notify type SILC_NOTIFY_TYPE_INVITE to its
617 primary router and then to the client indicated by the <Client
618 ID>.
619
620 The <add | del> is an argument of size of 1 byte where 0x00 means
621 adding a client to invite list, and 0x01 means deleting a client
622 from invite list. The <invite list>, if present, indicates
623 the information to be added to or removed from the invite list.
624 It may include a string for matching clients, public key of a
625 client (Public Key Payload) or Client ID of a client. The
626 <invite list> is an Argument List Payload.
627
628 The following Argument Types has been defined for invite list
629 Argument Payloads:
630
631 0x01 - Argument is an invite string of following format:
632
633 [<nickname>[@<server>]!][<username>]@[<hostname or IP/MASK>]
634
635 The <hostname> may also be in format of IP/MASK to indicate
636 a network, for example 10.2.1.0/255.255.0.0.
637
638 0x02 - Argument is the public key of a client
639 0x03 - Argument is the Client ID of a client
640
641 If unknown type value is received or there is invalid amount of
642 Argument Payloads present in the list, the command MUST be
643 discarded. When argument that is to be deleted from the invite
644 list does not exist in the list the argument is ignored.
645
646 When adding to or removing from the invite list the server MUST
647 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router.
648 When the SILC_CHANNEL_MODE_INVITE is set the client which executes
649 this command MUST have at least channel operator privileges to be
650 able to add to or remove from the invite list. If this channel
651 mode is not set the list manipulation is allowed for all clients.
652 Wildcards MAY be used with this command. When this command is
653 used to invite explicit client with <Client ID> the ID MUST be
654 added to the invite list by the server.
655
656 When this command is given with only <Channel ID> argument then
657 the command merely returns the invite list of the channel. This
658 command MUST fail if the requested channel does not exist, the
659 requested <Client ID> is already on the channel or if the channel
660 is invite only channel and the caller of this command does not
661 have at least channel operator privileges on the channel.
662
663 Reply messages to the command:
664
665 Max Arguments: 3
666 Arguments: (1) <Status Payload> (2) <Channel ID>
667 (3) [<invite list>]
668
669 This command replies with the invite list of the channel if it
670 exists.
671
672 Status messages:
673
674 SILC_STATUS_OK
675 SILC_STATUS_ERR_NOT_REGISTERED
676 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
677 SILC_STATUS_ERR_TOO_MANY_PARAMS
678 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
679 SILC_STATUS_ERR_NO_CLIENT_ID
680 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
681 SILC_STATUS_ERR_NO_CHANNEL_ID
682 SILC_STATUS_ERR_NOT_ON_CHANNEL
683 SILC_STATUS_ERR_USER_ON_CHANNEL
684 SILC_STATUS_ERR_NO_CHANNEL_PRIV
685 SILC_STATUS_ERR_RESOURCE_LIMIT
686
687
688 8 SILC_COMMAND_QUIT
689
690 Max Arguments: 1
691 Arguments: (1) [<quit message>]
692
693 This command is used by client to end SILC session. The server
694 must close the connection to a client which sends this command.
695 if <quit message> is given it will be sent to other clients on
696 channel if the client is on channel when quitting.
697
698 Reply messages to the command:
699
700 This command does not reply anything.
701
702
703 9 SILC_COMMAND_KILL
704
705 Max Arguments: 3
706 Arguments: (1) <Client ID> (2) [<comment>]
707 (3) [<auth payload>]
708
709 This command can be used by SILC operators to remove a client from
710 SILC network. It also can be used by a normal client to remove
711 its own client from network by providing correct authentication
712 data.
713
714 Router operator killing a client:
715
716 The removing has temporary effects and client may reconnect to
717 SILC network. The <Client ID> is the client to be removed from SILC.
718 The <comment> argument may be provided to give to the removed client
719 some information why it was removed from the network. The killer
720 MUST have SILC operator privileges.
721
722 When killing a client the router MUST first send notify type
723 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
724 The packet MUST NOT be sent to the killed client on the channels.
725 Then, the router MUST send the same notify type to its primary
726 router. Finally, the router MUST send the same notify type
727 destined directly to the client which was killed. The killed
728 client MUST also be removed from the invite lists of joined
729 channels if it is explicitly added in the invite lists.
730
731 Normal client killing by authentication:
732
733 When normal client executes this command the <Client ID> is the
734 destination client to be removed from the network. The client
735 MUST provide the <auth payload> which includes a digital signature
736 that MUST be verified with the public key of the client indicated
737 by <Client ID>. The <Client ID> MUST be local client to the server.
738 If the signature verification is successful the server sends
739 SILC_NOTIFY_TYPE_SIGNOFF to network and to the destination client.
740 The SILC_NOTIFY_TYPE_KILLED MUST NOT be used in this case. If the
741 verification fails the destination client remains in network.
742 The hash function used in <auth payload> computing is SHA1.
743
744 Reply messages to the command:
745
746 Max Arguments: 2
747 Arguments: (1) <Status Payload> (2) <Client ID>
748
749 This command returns with the requested Client ID.
750
751 Status messages:
752
753 SILC_STATUS_OK
754 SILC_STATUS_ERR_WILDCARDS
755 SILC_STATUS_ERR_NOT_REGISTERED
756 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
757 SILC_STATUS_ERR_TOO_MANY_PARAMS
758 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
759 SILC_STATUS_ERR_NO_CLIENT_ID
760 SILC_STATUS_ERR_NO_ROUTER_PRIV
761
762
763 10 SILC_COMMAND_INFO
764
765 Max Arguments: 2
766 Arguments: (1) [<server>] (2) [<Server ID>]
767
768 This command is used to fetch various information about a server.
769 If <server> argument is specified the command MUST be sent to
770 the requested server.
771
772 If the <Server ID> is specified the server information if fetched
773 by the provided Server ID. One of the arguments MUST always be
774 present.
775
776 Reply messages to the command:
777
778 Max Arguments: 4
779 Arguments: (1) <Status Payload> (2) <Server ID>
780 (3) <server name> (4) <string>
781
782 This command replies with the Server ID of the server and a
783 string which tells the information about the server.
784
785 Status messages:
786
787 SILC_STATUS_OK
788 SILC_STATUS_ERR_WILDCARDS
789 SILC_STATUS_ERR_NOT_REGISTERED
790 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
791 SILC_STATUS_ERR_TOO_MANY_PARAMS
792 SILC_STATUS_ERR_NO_SUCH_SERVER
793 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
794 SILC_STATUS_ERR_NO_SERVER_ID
795
796
797 11 SILC_COMMAND_STATS
798
799 Max Arguments: 1
800 Arguments: (1) <Server ID>
801
802 This command is used to fetch various statistical information
803 from the server indicated by <Server ID>, which is the ID of
804 server where sender is connected to. Server receiving this
805 command MAY also send this further to its router for fetching
806 other cell and network wide statistics to accompany the reply.
807
808 Reply messages to the command:
809
810 Max Arguments: 3
811 Arguments: (1) <Status Payload> (2) <Server ID>
812 (3) [<statistics structure>]
813
814 This command replies with the Server ID of the server and
815 optional statistics structure which includes 32 bit MSB first
816 ordered integer values to represent various statistical
817 information. The structure is as follows:
818
819 starttime - time when server was started
820 uptime - uptime of the server
821 my clients - number of locally connected clients
822 my channels - number of locally created channels
823 my server ops - number of local server operators
824 my router ops - number of local router operators
825 cell clients - number of clients in local cell
826 cell channels - number of channels in local cell
827 cell servers - number of servers in local cell
828 clients - number of client in SILC network
829 channels - number of channels in SILC network
830 servers - number of servers in SILC network
831 routers - number of routers in SILC network
832 server ops - number of server operators in SILC network
833 router ops - number of router operators in SILC network
834
835 If some value is unknown it is set to zero (0) value. The
836 "starttime" is the start time of the server, and is seconds
837 since Epoch (POSIX.1). The "uptime" is time difference of
838 current time and "starttime" in the server, and is seconds
839 in value.
840
841 Status messages:
842
843 SILC_STATUS_OK
844 SILC_STATUS_ERR_NOT_REGISTERED
845 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
846 SILC_STATUS_ERR_TOO_MANY_PARAMS
847 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
848 SILC_STATUS_ERR_NO_SUCH_SERVER
849 SILC_STATUS_ERR_NO_SERVER_ID
850
851
852 12 SILC_COMMAND_PING
853
854 Max Arguments: 1
855 Arguments: (1) <Server ID>
856
857 This command is used by client and server to test the communication
858 channel to its server if one suspects that the communication is not
859 working correctly. The <Server ID> is the ID of the server the
860 sender is connected to.
861
862 Reply messages to the command:
863
864 Max Arguments: 1
865 Arguments: (1) <Status Payload>
866
867 This command replies only with Status Payload. Server returns
868 SILC_STATUS_OK in Status Payload if pinging was successful.
869
870
871
872 Status messages:
873
874 SILC_STATUS_OK
875 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
876 SILC_STATUS_ERR_TOO_MANY_PARAMS
877 SILC_STATUS_ERR_NO_SERVER_ID
878 SILC_STATUS_ERR_NO_SUCH_SERVER
879 SILC_STATUS_ERR_NOT_REGISTERED
880
881
882 13 SILC_COMMAND_OPER
883
884 Max Arguments: 2
885 Arguments: (1) <username> (2) <authentication payload>
886
887 This command is used by normal client to obtain server operator
888 privileges on some server or router. Note that router operator
889 has router privileges that supersedes the server operator
890 privileges and this does not obtain those privileges. Client
891 MUST use SILCOPER command to obtain router level privileges.
892
893 The <username> is the username set in the server configurations
894 as operator. The <authentication payload> is the data that the
895 client is authenticated against. It may be passphrase prompted
896 for user on client's screen or it may be public key authentication
897 based on digital signatures. The public key used to verify the
898 signature should be locally saved in the server, and server should
899 not use public key received during the SKE to verify this signature.
900
901 After changing the mode the server MUST send the notify type
902 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
903
904 Reply messages to the command:
905
906 Max Arguments: 1
907 Arguments: (1) <Status Payload>
908
909 This command replies only with Status Payload.
910
911 Status messages:
912
913 SILC_STATUS_OK
914 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
915 SILC_STATUS_ERR_TOO_MANY_PARAMS
916 SILC_STATUS_ERR_NOT_REGISTERED
917 SILC_STATUS_ERR_AUTH_FAILED
918
919
920 14 SILC_COMMAND_JOIN
921
922 Max Arguments: 7
923 Arguments: (1) <channel> (2) <Client ID>
924 (3) [<passphrase>] (4) [<cipher>]
925 (5) [<hmac>] (6) [<founder auth>]
926 (7) [<channel auth>]
927
928 Join to channel/create new channel. This command is used to
929 join to a channel. If the channel does not exist the channel is
930 created. If server is normal server this command MUST be sent
931 to router which will create the channel. The channel MAY be
932 protected with passphrase. If this is the case the passphrase
933 MUST be sent along the join command. See the [SILC1] for
934 definition of correctly formatted channel name, <channel>.
935
936 The second argument <Client ID> is the Client ID of the client
937 which is joining to the client. When client sends this command
938 to the server the <Client ID> MUST be the client's own ID.
939
940 Cipher to be used to secure the traffic on the channel MAY be
941 requested by sending the name of the requested <cipher>. This
942 is used only if the channel does not exist and is created. If
943 the channel already exists the cipher set previously for the
944 channel will be used to secure the traffic. The computed MACs
945 of the channel message are produced by the default HMAC or by
946 the <hmac> provided for the command.
947
948 The <founder auth> is Authentication Payload providing the
949 authentication for gaining founder privileges on the channel
950 when joining the channel. The client may provide this if it
951 knows that it is the founder of the channel and that the
952 SILC_CMODE_FOUNDER_AUTH mode is set on the channel. The server
953 MUST verify whether the client is able to gain the founder
954 privileges the same way as the client had given the
955 SILC_COMMAND_CUMODE command to gain founder privileges. The
956 client is still able to join the channel even if the founder
957 privileges could not be gained. The hash function used with
958 the <founder payload> MUST be sha1.
959
960 If the <channel auth> is present and the channel mode
961 SILC_CMODE_CHANNEL_AUTH is set the server MUST verify the
962 <channel auth> with channel public key(s). If public key that
963 can verify <channel auth> does not exist on the channel public
964 key list the client MUST NOT be allowed to join the channel.
965 Because more than one public key may be set on channel the
966 <channel auth> Authentication Payload's Public Data field
967 MUST include an indication of the public key to be used. The
968 first 20 bytes of the Public Data field MUST be SHA-1 digest of
969 the public key that must be used in verification. The digest
970 is the SILC Public Key fingerprint. Rest of thePublic Data field
971 are set as defined in [SILC1]. This way server can determine from
972 the digest whether that public key exist on the channel and then
973 use that key in verification. The hash function used with
974 <channel auth> MUST be sha1.
975
976 The server MUST check whether the user is allowed to join to
977 the requested channel. Various modes set to the channel affect
978 the ability of the user to join the channel. These conditions
979 are:
980
981 o The user MUST be invited to the channel if the channel
982 is invite-only channel.
983
984 o The Client ID/nickname/username/host name/public key
985 MUST NOT match any active bans.
986
987 o The correct passphrase MUST be provided if passphrase
988 is set to the channel, and/or digital signature verification
989 with channel public key MUST be successful if public keys
990 has been set to the channel.
991
992 o The user count limit, if set, MUST NOT be reached.
993
994 If the client provided correct <founder auth> payload it can
995 override these conditions, except the condition for the passphrase.
996 The correct passphrase MUST be provided even if <founder auth>
997 payload is provided.
998
999 Reply messages to the command:
1000
1001 Max Arguments: 17
1002 Arguments: (1) <Status Payload> (2) <channel>
1003 (3) <Channel ID> (4) <Client ID>
1004 (5) <channel mode mask> (6) <created>
1005 (7) [<Channel Key Payload>] (8) [<ban list>]
1006 (9) [<invite list>] (10) [<topic>]
1007 (11) [<hmac>] (12) <list count>
1008 (13) <Client ID list> (14) <client mode list>
1009 (15) [<founder pubkey>] (16) [<channel pubkeys>]
1010 (17) [<user limit>]
1011
1012 This command replies with the channel name requested by the
1013 client, channel ID of the channel and topic of the channel
1014 if it exists. The <Client ID> is the Client ID which was joined
1015 to the channel. It also replies with the channel mode mask
1016 which tells all the modes set on the channel. If the channel
1017 is created the mode mask is zero (0) and <created> is 0x01.
1018 If ban mask and/or invite list is set they are sent as well.
1019 The <user limit> is the user limit on the channel, if one is set.
1020
1021 The <list count>, <Client ID list> and <client mode list> are
1022 the clients currently on the channel and their modes on the
1023 channel. The <Client ID list> is formed by adding the ID Payloads
1024 one after the other. The <client mode list> is formed by adding
1025 32 bit MSB first order values one after the other. The <founder
1026 pubkey> is the public key (or certificate) of the channel founder.
1027 The <channel pubkeys> is Argument List Payload containing the
1028 channel public keys that has been set for the channel.
1029
1030 Client receives the channel key in the reply message as well
1031 inside <Channel Key Payload>.