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 25 April 2001
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-00.txt 25 April 2001
20 Expires: 25 October 2001
21
22 .in 3
23
24 .ce 2
25 SILC Commands
26 <draft-riikonen-silc-commands-00.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 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.
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 ...................................... 2
77 2.2 SILC Commands List ........................................ 4
78 2.3 SILC Command Status Types ................................. 32
79 2.3.1 SILC Command Status Payload ......................... 32
80 2.3.2 SILC Command Status List ............................ 32
81 3 Security Considerations ....................................... 37
82 4 References .................................................... 37
83 5 Author's Address .............................................. 39
84
85
86 .ti 0
87 1. Introduction
88
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.
93
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.
97
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.
102
103
104 .ti 0
105 1.1 Requirements Terminology
106
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].
110
111
112 .ti 0
113 2 SILC Commands
114
115 .ti 0
116 2.1 SILC Commands Syntax
117
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].
124
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.
134
135
136
137 .in 6
138 Example: Arguments: (1) <nickname> (2) <username@host>
139 .in 3
140
141
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.
149
150 Example command:
151 .in 6
152
153 EXAMPLE_COMMAND
154
155 .in 8
156 Max Arguments: 3
157 Arguments: (1) <nickname>[@<server>] (2) <message>
158 (3) [<count>]
159
160 The command has maximum of 3 arguments. However, only first
161 and second arguments are mandatory.
162
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.
166
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
171 the Command Payload.
172
173 Reply messages to the command:
174
175 Max Arguments: 4
176 Arguments: (1) <Status Payload> (2) [<channel list>]
177 (3) <idle time> (4) [<away message>]
178
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.
183
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.
187
188
189
190 Status messages:
191
192 SILC_STATUS_OK
193 SILC_STATUS_ERR_TOO_MANY_TARGETS
194 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
195 SILC_STATUS_ERR_NO_SUCH_NICK
196
197 Every command reply also defines set of status message that it
198 may return inside the <Status Payload>. All status messages
199 are defined in the section 2.3 SILC Command Status Types.
200
201 .in 3
202 Every command that has some kind of ID as argument (for example
203 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
204 the type of the ID, length of the ID and the actual ID data. This
205 way variable length ID's can be sent as arguments.
206
207
208 .ti 0
209 2.2 SILC Commands List
210
211 This section lists all SILC commands, however, it is expected that a
212 implementation and especially client implementation has many more
213 commands that has only local affect. These commands are official
214 SILC commands that has both client and server sides and cannot be
215 characterized as local commands.
216
217 List of all defined commands in SILC follows.
218
219 .in 0
220 0 SILC_COMMAND_NONE
221
222 None. This is reserved command and MUST NOT be sent.
223
224
225 1 SILC_COMMAND_WHOIS
226
227 Max Arguments: 3328
228 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
229 (3) [<Client ID>] (n) [...]
230
231 Whois command is used to query various information about specific
232 user. The user may be requested by their nickname and server name.
233 The query may find multiple matching users as there are no unique
234 nicknames in the SILC. The <count> option may be given to narrow
235 down the number of accepted results. If this is not defined there
236 are no limit of accepted results. The query may also be narrowed
237 down by defining the server name of the nickname.
238
239 It is also possible to search the user by Client ID. If the
240 <Client ID> is provided server MUST use it as the search value
241 instead of the <nickname>. One of the arguments MUST be given.
242 It is also possible to define multiple Client ID's to search
243 multiple users sending only one WHOIS command. In this case the
244 Client ID's are appended as normal arguments. The server replies
245 in this case with only one reply message for all requested users.
246
247 To prevent miss-use of this command wildcards in the nickname
248 or in the server name are not permitted. It is not allowed
249 to request all users on some server. The WHOIS requests MUST
250 be based on specific nickname request.
251
252 The WHOIS request MUST be always sent to the router by server
253 so that all users are searched. However, the server still MUST
254 search its locally connected clients. The router MUST send
255 this command to the server which owns the requested client. That
256 server MUST reply to the command. Server MUST NOT send whois
257 replies to the client until it has received the reply from its
258 router.
259
260 Reply messages to the command:
261
262 Max Arguments: 8
263 Arguments: (1) <Status Payload> (2) <Client ID>
264 (3) <nickname>[@<server>] (4) <username@host>
265 (5) <real name> (6) [<Channel Payload
266 list>]
267 (7) [<user mode>] (8) [<idle time>]
268
269
270 This command may reply with several command reply messages to
271 form a list of results. In this case the status payload will
272 include STATUS_LIST_START status in the first reply and
273 STATUS_LIST_END in the last reply to indicate the end of the
274 list. If there are only one reply the status is set to normal
275 STATUS_OK.
276
277 The command replies include the Client ID of the nickname,
278 nickname and server name, user name and host name and user's real
279 name. Client SHOULD process these replies only after the last
280 reply has been received with the STATUS_LIST_END status. If the
281 <count> option were defined in the query there will be only
282 <count> many replies from the server.
283
284 The server MAY return the list of channel the client has joined.
285 In this case the list is list of Channel Payloads. The Mode Mask
286 in the Channel Payload (see [SILC2] and section 2.3.2.3 for the
287 Channel Payload) is the client's mode on the channel. The list
288 is encoded by adding the Channel Payloads one after the other.
289
290 Status messages:
291
292 SILC_STATUS_OK
293 SILC_STATUS_LIST_START
294 SILC_STATUS_LIST_END
295 SILC_STATUS_ERR_NO_SUCH_NICK
296 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
297 SILC_STATUS_ERR_WILDCARDS
298 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
299 SILC_STATUS_ERR_TOO_MANY_PARAMS
300
301
302 2 SILC_COMMAND_WHOWAS
303
304 Max Arguments: 2
305 Arguments: (1) <nickname>[@<server>] (2) [<count>]
306
307 Whowas. This command is used to query history information about
308 specific user. The user may be requested by their nickname and
309 server name. The query may find multiple matching users as there
310 are no unique nicknames in the SILC. The <count> option may be
311 given to narrow down the number of accepted results. If this
312 is not defined there are no limit of accepted results. The query
313 may also be narrowed down by defining the server name of the
314 nickname.
315
316 To prevent miss-use of this command wildcards in the nickname
317 or in the server name are not permitted. The WHOWAS requests MUST
318 be based on specific nickname request.
319
320 The WHOWAS request MUST be always sent to the router by server
321 so that all users are searched. However, the server still must
322 search its locally connected clients.
323
324 Reply messages to the command:
325
326 Max Arguments: 5
327 Arguments: (1) <Status Payload> (2) <Client ID>
328 (3) <nickname>[@<server>] (4) <username@host>
329 (5) [<real name>]
330
331 This command may reply with several command reply messages to form
332 a list of results. In this case the status payload will include
333 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
334 the last reply to indicate the end of the list. If there are only
335 one reply the status is set to normal STATUS_OK.
336
337 The command replies with nickname and user name and host name.
338 Every server MUST keep history for some period of time of its
339 locally connected clients.
340
341 Status messages:
342
343 SILC_STATUS_OK
344 SILC_STATUS_LIST_START
345 SILC_STATUS_LIST_END
346 SILC_STATUS_ERR_NO_SUCH_NICK
347 SILC_STATUS_ERR_WILDCARDS
348 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
349 SILC_STATUS_ERR_TOO_MANY_PARAMS
350
351
352 3 SILC_COMMAND_IDENTIFY
353
354 Max Arguments: 3328
355 Arguments: (1) [<nickname>[@<server>]] (2) [<count>]
356 (3) [<Client ID>] (n) [...]
357
358 Identify. Identify command is almost analogous to WHOIS command,
359 except that it does not return as much information. Only relevant
360 information such as Client ID is returned. This is usually used
361 to get the Client ID of a client used in the communication with
362 the client.
363
364 The query may find multiple matching users as there are no unique
365 nicknames in the SILC. The <count> option may be given to narrow
366 down the number of accepted results. If this is not defined there
367 are no limit of accepted results. The query may also be narrowed
368 down by defining the server name of the nickname.
369
370 It is also possible to search the user by Client ID. If the
371 <Client ID> is provided server must use it as the search value
372 instead of the <nickname>. One of the arguments must be given.
373 It is also possible to define multiple Client ID's to search
374 multiple users sending only one IDENTIFY command. In this case
375 the Client ID's are appended as normal arguments. The server
376 replies in this case with only one reply message for all requested
377 users.
378
379 To prevent miss-use of this command wildcards in the nickname
380 or in the server name are not permitted. It is not allowed
381 to request all users on some server. The IDENTIFY requests MUST
382 be based on specific nickname request.
383
384 Implementations may not want to give interface access to this
385 command as it is hardly a command that would be used by an end user.
386 However, it must be implemented as it is used with private message
387 sending.
388
389 The IDENTIFY MUST be always sent to the router by server so that
390 all users are searched. However, server MUST still search its
391 locally connected clients.
392
393 Reply messages to the command:
394
395 Max Arguments: 4
396 Arguments: (1) <Status Payload> (2) <Client ID>
397 (3) [<nickname>[@<server>]] (4) [<username@host>]
398
399 This command may reply with several command reply messages to form
400 a list of results. In this case the status payload will include
401 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
402 the last reply to indicate the end of the list. If there are only
403 one reply the status is set to normal STATUS_OK.
404
405 The command replies with Client ID of the nickname and if more
406 information is available it MAY reply with nickname and user name
407 and host name. If the <count> option were defined in the query
408 there will be only <count> many replies from the server.
409
410 Status messages:
411
412 SILC_STATUS_OK
413 SILC_STATUS_LIST_START
414 SILC_STATUS_LIST_END
415 SILC_STATUS_ERR_NO_SUCH_NICK
416 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
417 SILC_STATUS_ERR_WILDCARDS
418 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
419 SILC_STATUS_ERR_TOO_MANY_PARAMS
420
421
422 4 SILC_COMMAND_NICK
423
424 Max Arguments: 1
425 Arguments: (1) <nickname>
426
427 Set/change nickname. This command is used to set nickname for
428 user. Nickname MUST NOT include any spaces (` '), non-printable
429 characters, commas (`,') and any wildcard characters. Note that
430 nicknames in SILC are case-sensitive which must be taken into
431 account when searching clients by nickname.
432
433 When nickname is changed new Client ID is generated. Server MUST
434 distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
435 channels (if any) the client is joined on. Then it MUST send
436 SILC_PACKET_REPLACE_ID to its primary route to replace the old
437 Client ID with the new one.
438
439 Reply messages to the command:
440
441 Max Arguments: 2
442 Arguments: (1) <Status Payload> (2) <New ID Payload>
443
444 This command is replied always with New ID Payload that is
445 generated by the server every time user changes their nickname.
446 Client receiving this payload MUST start using the received
447 Client ID as its current valid Client ID. The New ID Payload
448 is described in [SILC2].
449
450 Status messages:
451
452 SILC_STATUS_OK
453 SILC_STATUS_ERR_WILDCARDS
454 SILC_STATUS_ERR_NICKNAME_IN_USE
455 SILC_STATUS_ERR_BAD_NICKNAME
456 SILC_STATUS_ERR_NOT_REGISTERED
457 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
458 SILC_STATUS_ERR_TOO_MANY_PARAMS
459
460
461 5 SILC_COMMAND_LIST
462
463 Max Arguments: 1
464 Arguments: (1) [<Channel ID>]
465
466 The list command is used to list channels and their topics on the
467 current server. If the <Channel ID> parameter is used, only the
468 status of that channel is displayed. Secret channels are not
469 listed at all. Private channels are listed with status indicating
470 that the channel is private. Router MAY reply with all channels
471 it knows about.
472
473 Reply messages to the command:
474
475 Max Arguments: 5
476 Arguments: (1) <Status Payload> (2) <Channel ID>
477 (3) <channel> (4) [<topic>]
478 (5) [<user count>]
479
480 This command may reply with several command reply messages to form
481 a list of results. In this case the status payload will include
482 STATUS_LIST_START status in the first reply and STATUS_LIST_END in
483 the last reply to indicate the end of the list. If there are only
484 one reply the status is set to normal STATUS_OK.
485
486 This command replies with Channel ID, name and the topic of the
487 channel. If the channel is private channel the <topic> SHOULD
488 include the "*private*" string.
489
490 Status messages:
491
492 SILC_STATUS_OK
493 SILC_STATUS_LIST_START
494 SILC_STATUS_LIST_END
495 SILC_STATUS_ERR_WILDCARDS
496 SILC_STATUS_ERR_NOT_REGISTERED
497 SILC_STATUS_ERR_TOO_MANY_PARAMS
498 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
499 SILC_STATUS_ERR_NO_CHANNEL_ID
500 SILC_STATUS_ERR_NO_SUCH_SERVER
501
502
503 6 SILC_COMMAND_TOPIC
504
505 Max Arguments: 2
506 Arguments: (1) <Channel ID> (2) [<topic>]
507
508 This command is used to change or view the topic of a channel.
509 The topic for channel <Channel ID> is returned if there is no
510 <topic> given. If the <topic> parameter is present, the topic
511 for that channel will be changed, if the channel modes permit
512 this action.
513
514 After setting the topic the server MUST send the notify type
515 SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
516 the channel which topic was changed.
517
518 Reply messages to the command:
519
520 Max Arguments: 2
521 Arguments: (1) <Status Payload> (2) <Channel ID>
522 (3) [<topic>]
523
524 The command may reply with the topic of the channel if it is
525 set.
526
527 Status messages:
528
529 SILC_STATUS_OK
530 SILC_STATUS_ERR_NOT_ON_CHANNEL
531 SILC_STATUS_ERR_WILDCARDS
532 SILC_STATUS_ERR_NOT_REGISTERED
533 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
534 SILC_STATUS_ERR_NO_SUCH_CHANNEL
535 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
536 SILC_STATUS_ERR_NO_CHANNEL_ID
537 SILC_STATUS_ERR_BAD_CHANNEL_ID
538 SILC_STATUS_ERR_TOO_MANY_PARAMS
539 SILC_STATUS_ERR_NO_CHANNEL_PRIV
540
541
542 7 SILC_COMMAND_INVITE
543
544 Max Arguments: 4
545 Arguments: (1) <Channel ID> (2) [<Client ID>]
546 (3) [<adding client>] (4) [<removing client>]
547
548 This command is used to invite other clients to join to the
549 channel. The <Client ID> argument is the target client's ID that
550 is being invited. The <Channel ID> is the Channel ID of the
551 requested channel. The sender of this command MUST be on the
552 channel. The server MUST also send the notify type
553 SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
554 client indicated by the <Client ID>.
555
556 The <adding client> and <removing client> can be used to add to
557 and remove from the invite list. The format of the <adding client>
558 and <removing client> is as follows:
559
560 [<nickname>[@<server>]!][<username>]@[<hostname>]
561
562 When adding to or removing from the invite list the server MUST
563 send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
564 and MUST NOT send it to the client which was added to the list.
565 The client which executes this command MUST have at least channel
566 operator privileges to be able to add to or remove from the invite
567 list. The wildcards MAY be used with this command. If adding or
568 removing more than one client then the lists are an comma (`,')
569 separated.
570
571 Note that the <Client ID> provided MUST be resolved into correct
572 nickname and host name and add to the invite list before sending
573 the notify packet.
574
575 When this command is given with only <Channel ID> argument then
576 the command merely returns the invite list of the channel. This
577 command MUST fail if the requested channel does not exist, the
578 requested <Client ID> is already on the channel or if the channel
579 is invite only channel and the caller of this command does not
580 have at least channel operator privileges.
581
582 Reply messages to the command:
583
584 Max Arguments: 3
585 Arguments: (1) <Status Payload> (2) <Channel ID>
586 (3) [<invite list>]
587
588 This command replies with the invite list of the channel if it
589 exists.
590
591 Status messages:
592
593 SILC_STATUS_OK
594 SILC_STATUS_ERR_NOT_REGISTERED
595 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
596 SILC_STATUS_ERR_TOO_MANY_PARAMS
597 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
598 SILC_STATUS_ERR_NO_CLIENT_ID
599 SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
600 SILC_STATUS_ERR_NO_CHANNEL_ID
601 SILC_STATUS_ERR_NOT_ON_CHANNEL
602 SILC_STATUS_ERR_USER_ON_CHANNEL
603 SILC_STATUS_ERR_NO_CHANNEL_PRIV
604
605
606 8 SILC_COMMAND_QUIT
607
608 Max Arguments: 1
609 Arguments: (1) [<quit message>]
610
611 This command is used by client to end SILC session. The server
612 must close the connection to a client which sends this command.
613 if <quit message> is given it will be sent to other clients on
614 channel if the client is on channel when quitting.
615
616 Reply messages to the command:
617
618 This command does not reply anything.
619
620
621 9 SILC_COMMAND_KILL
622
623 Max Arguments: 2
624 Arguments: (1) <Client ID> (2) [<comment>]
625
626 This command is used by SILC operators to remove a client from
627 SILC network. The removing has temporary effects and client may
628 reconnect to SILC network. The <Client ID> is the client to be
629 removed from SILC. The <comment> argument may be provided to
630 give to the removed client some information why it was removed
631 from the network.
632
633 When killing a client the router MUST first send notify type
634 SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
635 The packet MUST NOT be sent to the killed client on the channels.
636 Then, the router MUST send the same notify type to its primary
637 router. Finally, the router MUST send the same notify type
638 directly to the client which was killed.
639
640 Reply messages to the command:
641
642 Max Arguments: 1
643 Arguments: (1) <Status Payload>
644
645 This command replies only with Status Payload.
646
647 Status messages:
648
649 SILC_STATUS_OK
650 SILC_STATUS_ERR_WILDCARDS
651 SILC_STATUS_ERR_NOT_REGISTERED
652 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
653 SILC_STATUS_ERR_TOO_MANY_PARAMS
654 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
655 SILC_STATUS_ERR_NO_CLIENT_ID
656 SILC_STATUS_ERR_NO_ROUTER_PRIV
657
658
659 10 SILC_COMMAND_INFO
660
661 Max Arguments: 2
662 Arguments: (1) [<server>] (2) [<Server ID>]
663
664 This command is used to fetch various information about a server.
665 If <server> argument is specified the command MUST be sent to
666 the requested server.
667
668 If the <Server ID> is specified the server information if fetched
669 by the provided Server ID.
670
671 Reply messages to the command:
672
673 Max Arguments: 4
674 Arguments: (1) <Status Payload> (2) <Server ID>
675 (3) <server name> (4) <string>
676
677 This command replies with the Server ID of the server and a
678 string which tells the information about the server.
679
680 Status messages:
681
682 SILC_STATUS_OK
683 SILC_STATUS_ERR_WILDCARDS
684 SILC_STATUS_ERR_NOT_REGISTERED
685 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
686 SILC_STATUS_ERR_TOO_MANY_PARAMS
687 SILC_STATUS_ERR_NO_SUCH_SERVER
688 SILC_STATUS_ERR_NO_SUCH_SERVER_ID
689 SILC_STATUS_ERR_NO_SERVER_ID
690
691
692 11 SILC_COMMAND_CONNECT
693
694 Max Arguments: 2
695 Arguments: (1) <remote server/router> (2) [<port>]
696
697 This command is used by operators to force a server to try to
698 establish a new connection to remote server or router. The
699 Operator MUST specify the server/router to be connected by
700 setting <remote server> argument. The port is 32 bit MSB value.
701
702 Reply messages to the command:
703
704 Max Arguments: 1
705 Arguments: (1) <Status Payload>
706
707 This command replies only with Status Payload.
708
709
710
711 Status messages:
712
713 SILC_STATUS_OK
714 SILC_STATUS_ERR_WILDCARDS
715 SILC_STATUS_ERR_NOT_REGISTERED
716 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
717 SILC_STATUS_ERR_TOO_MANY_PARAMS
718 SILC_STATUS_ERR_NO_SERVER_PRIV
719 SILC_STATUS_ERR_NO_ROUTER_PRIV
720
721
722 12 SILC_COMMAND_PING
723
724 Max Arguments: 1
725 Arguments: (1) <Server ID>
726
727 This command is used by client and server to test the communication
728 channel to its server if one suspects that the communication is not
729 working correctly. The <Server ID> is the ID of the server the
730 sender is connected to.
731
732 Reply messages to the command:
733
734 Max Arguments: 1
735 Arguments: (1) <Status Payload>
736
737 This command replies only with Status Payload. Server returns
738 SILC_STATUS_OK in Status Payload if pinging was successful.
739
740
741
742 Status messages:
743
744 SILC_STATUS_OK
745 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
746 SILC_STATUS_ERR_TOO_MANY_PARAMS
747 SILC_STATUS_ERR_NO_SERVER_ID
748 SILC_STATUS_ERR_NO_SUCH_SERVER
749 SILC_STATUS_ERR_NOT_REGISTERED
750
751
752 13 SILC_COMMAND_OPER
753
754 Max Arguments: 2
755 Arguments: (1) <username> (2) <authentication payload>
756
757 This command is used by normal client to obtain server operator
758 privileges on some server or router. Note that router operator
759 has router privileges that supersedes the server operator
760 privileges and this does not obtain those privileges. Client
761 MUST use SILCOPER command to obtain router level privileges.
762
763 The <username> is the username set in the server configurations
764 as operator. The <authentication payload> is the data that the
765 client is authenticated against. It may be passphrase prompted
766 for user on client's screen or it may be public key or certificate
767 authentication data (data signed with private key).
768
769 After changing the mode the server MUST send the notify type
770 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
771
772 Reply messages to the command:
773
774 Max Arguments: 1
775 Arguments: (1) <Status Payload>
776
777 This command replies only with Status Payload.
778
779 Status messages:
780
781 SILC_STATUS_OK
782 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
783 SILC_STATUS_ERR_TOO_MANY_PARAMS
784 SILC_STATUS_ERR_NOT_REGISTERED
785 SILC_STATUS_ERR_AUTH_FAILED
786
787
788 14 SILC_COMMAND_JOIN
789
790 Max Arguments: 5
791 Arguments: (1) <channel> (2) <Client ID>
792 (3) [<passphrase>] (4) [<cipher>]
793 (5) [<hmac>]
794
795 Join to channel/create new channel. This command is used to
796 join to a channel. If the channel does not exist the channel is
797 created. If server is normal server this command MUST be sent
798 to router which will create the channel. The channel MAY be
799 protected with passphrase. If this is the case the passphrase
800 MUST be sent along the join command.
801
802 The name of the <channel> MUST NOT include any spaces (` '),
803 non-printable characters, commas (`,') or any wildcard characters.
804
805 The second argument <Client ID> is the Client ID of the client
806 which is joining to the client. When client sends this command
807 to the server the <Client ID> MUST be the client's own ID.
808
809 Cipher to be used to secure the traffic on the channel MAY be
810 requested by sending the name of the requested <cipher>. This
811 is used only if the channel does not exist and is created. If
812 the channel already exists the cipher set previously for the
813 channel will be used to secure the traffic. The computed MACs
814 of the channel message are produced by the default HMAC or by
815 the <hmac> provided for the command.
816
817 The server MUST check whether the user is allowed to join to
818 the requested channel. Various modes set to the channel affect
819 the ability of the user to join the channel. These conditions
820 are:
821
822 o The user MUST be invited to the channel if the channel
823 is invite-only channel.
824
825 o The Client ID/nickname/username/host name MUST NOT match
826 any active bans.
827
828 o The correct passphrase MUST be provided if passphrase
829 is set to the channel.
830
831 o The user count limit, if set, MUST NOT be reached.
832
833 Reply messages to the command:
834
835 Max Arguments: 14
836 Arguments: (1) <Status Payload> (2) <channel>
837 (3) <Channel ID> (4) <Client ID>
838 (5) <channel mode mask> (6) <created>
839 (7) [<Channel Key Payload>] (8) [<ban list>]
840 (9) [<invite list>] (10) [<topic>]
841 (11) [<hmac>] (12) <list count>
842 (13) <Client ID list> (14) <client mode list>
843
844 This command replies with the channel name requested by the
845 client, channel ID of the channel and topic of the channel
846 if it exists. The <Client ID> is the Client ID which was joined
847 to the channel. It also replies with the channel mode mask
848 which tells all the modes set on the channel. If the
849 channel is created the mode mask is zero (0). If ban mask
850 and/or invite list is set they are sent as well.
851
852 The <list count>, <Client ID list> and <client mode list> are
853 the clients currently on the channel and their modes on the
854 channel. The <Client ID list> is formed by adding the ID Payloads
855 one after the other. The <client mode list> is formed by adding
856 32 bit MSB first order values one after the other.
857
858 Client receives the channel key in the reply message as well
859 inside <Channel Key Payload>.
860
861 Status messages:
862
863 SILC_STATUS_OK
864 SILC_STATUS_ERR_WILDCARDS
865 SILC_STATUS_ERR_NOT_REGISTERED
866 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
867 SILC_STATUS_ERR_TOO_MANY_PARAMS
868 SILC_STATUS_ERR_BAD_PASSWORD
869 SILC_STATUS_ERR_CHANNEL_IS_FULL
870 SILC_STATUS_ERR_NOT_INVITED
871 SILC_STATUS_ERR_BANNED_FROM_CHANNEL
872 SILC_STATUS_ERR_BAD_CHANNEL
873 SILC_STATUS_ERR_USER_ON_CHANNEL
874
875
876 15 SILC_COMMAND_MOTD
877
878 Max Arguments: 1
879 Arguments: (1) <server>
880
881 This command is used to query the Message of the Day of the server.
882
883 Reply messages to the command:
884
885 Max Arguments: 3
886 Arguments: (1) <Status Payload> (2) <Server ID>
887 (3) [<motd>]
888
889 This command replies with the motd message if it exists.
890
891 Status messages:
892
893 SILC_STATUS_OK
894 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
895 SILC_STATUS_ERR_TOO_MANY_PARAMS
896 SILC_STATUS_ERR_NOT_REGISTERED
897 SILC_STATUS_ERR_NO_SUCH_SERVER
898
899
900 16 SILC_COMMAND_UMODE
901
902 Max Arguments: 2
903 Arguments: (1) <Client ID> (2) <client mode mask>
904
905 This command is used by client to set/unset modes for itself.
906 However, there are some modes that the client MUST NOT set itself,
907 but they will be set by server. However, client MAY unset any
908 mode. Modes may be masked together ORing them thus having
909 several modes set. Client MUST keep its client mode mask
910 locally so that the mode setting/unsetting would work without
911 problems. Client may change only its own modes.
912
913 After changing the mode server MUST send the notify type
914 SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
915
916 The following client modes are defined:
917
918 0x0000 SILC_UMODE_NONE
919
920 No specific mode for client. This is the initial
921 setting when new client is created. The client is
922 normal client now.
923
924
925 0x0001 SILC_UMODE_SERVER_OPERATOR
926
927 Marks the user as server operator. Client MUST NOT
928 set this mode itself. Server sets this mode to the
929 client when client attains the server operator
930 privileges by SILC_COMMAND_OPER command. Client
931 MAY unset the mode itself.
932
933
934 0x0002 SILC_UMODE_ROUTER_OPERATOR
935
936 Marks the user as router (SILC) operator. Client
937 MUST NOT this mode itself. Router sets this mode to
938 the client when client attains the router operator
939 privileges by SILC_COMMAND_SILCOPER command. Client
940 MAY unset the mode itself.
941
942
943 0x0004 SILC_UMODE_GONE
944
945 Marks that the user is not currently present in the
946 SILC Network. Client MAY set and unset this mode.
947
948 Reply messages to the command:
949
950 Max Arguments: 2
951 Arguments: (1) <Status Payload> (2) <client mode mask>
952
953 This command replies with the changed client mode mask that
954 the client MUST to keep locally.
955
956
957 Status messages:
958
959 SILC_STATUS_OK
960 SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
961 SILC_STATUS_ERR_TOO_MANY_PARAMS
962 SILC_STATUS_ERR_NOT_REGISTERED
963 SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
964 SILC_STATUS_ERR_BAD_CLIENT_ID
965 SILC_STATUS_ERR_NOT_YOU
966 SILC_STATUS_ERR_PERM_DENIED
967 SILC_STATUS_ERR_UNKNOWN_MODE
968 SILC_STATUS_ERR_NO_CLIENT_ID
969
970
971 17 SILC_COMMAND_CMODE
972
973 Max Arguments: 7
974 Arguments: (1) <Channel ID> (2) <channel mode mask>
975 (3) [<user limit>] (4) [<passphrase>]
976 (5) [<cipher>] (6) [<hmac>]
977 (7) [<auth payload>]
978
979 This command is used by client to set or change channel flags on
980 a channel. Channel has several modes that set various properties
981 of a channel. Modes may be masked together by ORing them thus
982 having several modes set. The <Channel ID> is the ID of the
983 target channel. The client changing channel mode MUST be on
984 the same channel and poses sufficient privileges to be able to
985 change the mode.
986
987 When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
988 type MUST be distributed to the channel.
989
990 The following channel modes are defined:
991
992 0x0000 SILC_CMODE_NONE
993
994 No specific mode on channel. This is the default when
995 channel is created. This means that channel is just plain
996 normal channel.
997
998
999 0x0001 SILC_CMODE_PRIVATE
1000
1001 Channel is private channel. Private channels are shown
1002 in the channel list listed with SILC_COMMAND_LIST command
1003 with indication that the channel is private. Also,
1004 client on private channel will no be detected to be on
1005 the channel as the channel is not shown in the client's
1006 currently joined channel list. Channel founder and
1007 channel operator MAY set/unset this mode.
1008
1009 Typical implementation would use [+|-]p on user interface
1010 to set/unset this mode.
1011
1012
1013 0x0002 SILC_CMODE_SECRET
1014
1015 Channel is secret channel. Secret channels are not shown
1016 in the list listed with SILC_COMMAND_LIST command. Secret
1017 channels can be considered to be invisible channels.
1018 Channel founder and channel operator MAY set/unset this
1019 mode.
1020
1021 Typical implementation would use [+|-]s on user interface
1022 to set/unset this mode.
1023
1024
1025 0x0004 SILC_CMODE_PRIVKEY
1026
1027 Channel uses private channel key to protect the traffic
1028 on the channel. When this mode is set the client will be
1029 responsible to set the key it wants to use to encrypt and
1030 decrypt the traffic on channel. Server generated channel
1031 keys are not used at all. This mode provides additional
1032 security as clients on channel may agree to use private
1033 channel key that even servers do not know. Naturally,
1034 this requires that every client on the channel knows
1035 the key before hand (it is considered to be pre-shared-
1036 key). The key material is RECOMMENDED to be processed
1037 as stated in the [SILC3] in the section Processing the
1038 Key Material.
1039
1040 As it is local setting it is possible to have several
1041 private channel keys on one channel. In this case several
1042 clients can talk on same channel but only those clients
1043 that share the key with the message sender will be able
1044 to hear the talking. Client SHOULD NOT display those
1045 message for the end user that it is not able to decrypt
1046 when this mode is set.
1047
1048 Only channel founder MAY set/unset this mode. If this
1049 mode is unset the server will distribute new channel
1050 key to all clients on the channel which will be used
1051 thereafter.
1052
1053 Typical implementation would use [+|-]k on user interface
1054 to set/unset this mode.
1055
1056
1057 0x0008 SILC_CMODE_INVITE
1058