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