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