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