doc/draft-riikonen-silc-commands-00.nroff

   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
1059               Channel is invite only channel.  Client may join to this
1060               channel only if it is invited to the channel.  Channel
1061               founder and channel operator MAY set/unset this mode.
1062
1063               Typical implementation would use [+|-]i on user interface
1064               to set/unset this mode.
1065
1066
1067            0x0010    SILC_CMODE_TOPIC
1068
1069               The topic of the channel may only be set by client that
1070               is channel founder or channel operator.  Normal clients
1071               on channel will not be able to set topic when this mode
1072               is set.  Channel founder and channel operator MAY set/
1073               unset this mode.
1074
1075               Typical implementation would use [+|-]t on user interface
1076               to set/unset this mode.
1077
1078
1079            0x0020    SILC_CMODE_ULIMIT
1080
1081               User limit has been set to the channel.  New clients
1082               may not join to the channel when the limit set is
1083               reached.  Channel founder and channel operator MAY set/
1084               unset the limit.  The <user limit> argument is the
1085               number of limited users.
1086
1087               Typical implementation would use [+|-]l on user interface
1088               to set/unset this mode.
1089
1090
1091            0x0040    SILC_CMODE_PASSPHRASE
1092
1093               Passphrase has been set to the channel.  Client may
1094               join to the channel only if it is able to provide the
1095               correct passphrase.  Setting passphrases to channel
1096               is entirely safe as all commands are protected in the
1097               SILC network.  Only channel founder MAY set/unset
1098               the passphrase.  The <passphrase> argument is the
1099               set passphrase.
1100
1101               Typical implementation would use [+|-]a on user interface
1102               to set/unset this mode.
1103
1104
1105            0x0080    SILC_CMODE_CIPHER
1106
1107               Sets specific cipher to be used to protect channel
1108               traffic.  The <cipher> argument is the requested cipher.
1109               When set or unset the server must re-generate new
1110               channel key.  Only channel founder MAY set the cipher of
1111               the channel.  When unset the new key is generated using
1112               default cipher for the channel.
1113
1114               Typical implementation would use [+|-]c on user interface
1115               to set/unset this mode.
1116
1117
1118            0x0100    SILC_CMODE_HMAC
1119
1120               Sets specific hmac to be used to compute the MACs of the
1121               channel message.  The <hmac> argument is the requested hmac.
1122               Only channel founder may set the hmac of the channel.
1123
1124               Typical implementation would use [+|-]h on user interface
1125               to set/unset this mode.
1126
1127
1128            0x0200    SILC_CMODE_FOUNDER_AUTH
1129
1130               Channel founder may set this mode to be able to regain
1131               channel founder rights even if the client leaves the
1132               channel.  The <auth payload> is the Authentication Payload
1133               consisting of the authentication method and authentication
1134               data to be used in the authentication.  The server MUST
1135               NOT accept NONE authentication method.  Also, if the
1136               method is public key authentication the server MUST NOT
1137               save the authentication data from the payload as the
1138               data is different on all authentications.  In this case the
1139               server only saves the authentication method.
1140
1141               Note that this mode is effective only in the current server.
1142               The client MUST connect to the same server later to be able
1143               to regain the channel founder rights.  The server MUST save
1144               the public key of the channel founder and use that to identify
1145               the client which is claiming the channel founder rights.
1146               The rights may be claimed by the SILC_CUMODE_FOUNDER
1147               channel user mode using SILC_COMMAND_CUMODE command.  The
1148               set authentication data remains valid as long as the channel
1149               exists or until the founder unsets this mode.
1150
1151               Typical implementation would use [+|-]f on user interface
1152               to set/unset this mode.
1153
1154         To make the mode system work, client MUST keep the channel mode
1155         mask locally so that the mode setting and unsetting would work
1156         without problems.  The client receives the initial channel mode
1157         mask when it joins to the channel.  When the mode changes on
1158         channel the server MUST distribute the changed channel mode mask
1159         to all clients on the channel by sending the notify type
1160         SILC_NOTIFY_TYPE_CMODE_CHANGE.  The notify type MUST also be sent
1161         to the server's primary router.
1162
1163         Reply messages to the command:
1164
1165         Max Arguments:  2
1166             Arguments:  (1) <Status Payload>  (2) <channel mode mask>
1167
1168         This command replies with the changed channel mode mask that
1169         client MUST keep locally.
1170
1171         Status messages:
1172
1173             SILC_STATUS_OK
1174             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1175             SILC_STATUS_ERR_TOO_MANY_PARAMS
1176             SILC_STATUS_ERR_NOT_REGISTERED
1177             SILC_STATUS_ERR_NOT_ON_CHANNEL
1178             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1179             SILC_STATUS_ERR_BAD_CHANNEL_ID
1180             SILC_STATUS_ERR_NO_CHANNEL_ID
1181             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1182             SILC_STATUS_ERR_UNKNOWN_MODE
1183             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1184
1185
1186    18   SILC_COMMAND_CUMODE
1187
1188         Max Arguments:  4
1189             Arguments:  (1) <Channel ID>    (2) <mode mask>
1190                         (3) <Client ID>     (4) [<auth payload>]
1191
1192         This command is used by client to change channel user modes on
1193         channel.  Users on channel may have some special modes and this
1194         command is used by channel operators to set or change these modes.
1195         The <Channel ID> is the ID of the target channel.  The <mode mask>
1196         is OR'ed mask of modes.  The <Client ID> is the target client.
1197         The client changing channel user modes MUST be on the same channel
1198         as the target client and poses sufficient privileges to be able to
1199         change the mode.
1200
1201         When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1202         type is distributed to the channel.
1203
1204         The following channel modes are defined:
1205
1206            0x0000    SILC_CUMODE_NONE
1207
1208               No specific mode.  This is the normal situation for client.
1209               Also, this is the mode set when removing all modes from
1210               the target client.
1211
1212
1213            0x0001    SILC_CUMODE_FOUNDER
1214
1215               The client is channel founder of the channel.  Usually this
1216               mode is set only by the server when the channel was created.
1217               However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1218               been set, the client can claim channel founder privileges
1219               by providing the <auth payload> that the server will use
1220               to authenticate the client.  The client MAY remove this
1221               mode at any time.
1222
1223
1224            0x0002    SILC_CUMODE_OPERATOR
1225
1226               Sets channel operator privileges on the channel for a
1227               client on the channel.  Channel founder and channel operator
1228               MAY set/unset this mode.
1229
1230         Reply messages to the command:
1231
1232         Max Arguments:  3
1233             Arguments:  (1) <Status Payload>  (2) <channel user mode mask>
1234                         (3) <Client ID>
1235
1236         This command replies with the changed channel user mode mask that
1237         client MUST keep locally.  The <Client ID> is the target client.
1238
1239         Status messages:
1240
1241             SILC_STATUS_OK
1242             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1243             SILC_STATUS_ERR_TOO_MANY_PARAMS
1244             SILC_STATUS_ERR_NOT_REGISTERED
1245             SILC_STATUS_ERR_NOT_ON_CHANNEL
1246             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1247             SILC_STATUS_ERR_BAD_CHANNEL_ID
1248             SILC_STATUS_ERR_NO_CHANNEL_ID
1249             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1250             SILC_STATUS_ERR_UNKNOWN_MODE
1251             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1252             SILC_STATUS_ERR_AUTH_FAILED
1253
1254
1255    19   SILC_COMMAND_KICK
1256
1257         Max Arguments:  3
1258             Arguments:  (1) <Channel ID>  (2) <Client ID>
1259                         (3) [<comment>]
1260
1261         This command is used by channel operators to remove a client from
1262         channel.  The <channel> argument is the channel the client to be
1263         removed is on currently.  Note that the "kicker" must be on the same
1264         channel.  If <comment> is provided it will be sent to the removed
1265         client.
1266
1267         After kicking the client the server MUST send the notify type
1268         SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1269         The channel key MUST also be re-generated after kicking, unless
1270         the SILC_CMODE_PRIVKEY mode is set.
1271
1272         Reply messages to the command:
1273
1274         Max Arguments:  1
1275             Arguments:  (1) <Status Payload>
1276
1277         This command replies only with Status Payload.
1278
1279         Status messages:
1280
1281             SILC_STATUS_OK
1282             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1283             SILC_STATUS_ERR_TOO_MANY_PARAMS
1284             SILC_STATUS_ERR_NOT_REGISTERED
1285             SILC_STATUS_ERR_NO_SUCH_CHANNEL
1286             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1287             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1288             SILC_STATUS_ERR_NO_CLIENT_ID
1289
1290
1291    20   SILC_COMMAND_BAN
1292
1293         Max Arguments:  3
1294             Arguments:  (1) <Channel ID>         (2) [<adding client>]
1295                         (3) [<removing client>]
1296
1297         This command is used to manage the ban list of the channel
1298         indicated by the <Channel ID>.  A client that is banned from
1299         channel is no longer able to join the channel.  The client which
1300         is executing this command MUST have at least channel operator
1301         privileges on the channel.
1302
1303         The <adding client> and <removing client> are used to add to and
1304         remove from the ban list.  The format of the <adding client> and
1305         the <removing client> is of following format:
1306
1307             [<nickname>[@<server>]!][<username>]@[<hostname>]
1308
1309         The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1310         primary router after adding to or removing from the ban list.
1311         The wildcards MAY be used with this command.  If adding or removing
1312         from than one clients then the lists are an comma (`,') separated.
1313
1314         If this command is executed without the ban arguments the command
1315         merely replies with the current ban list.
1316
1317
1318         Reply messages to the command:
1319
1320         Max Arguments:  3
1321             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1322                         (3) [<ban list>]
1323
1324         This command replies with the <Channel ID> of the channel and
1325         the current <ban list> of the channel if it exists.
1326
1327         Status messages:
1328
1329             SILC_STATUS_OK
1330             SILC_STATUS_ERR_NOT_REGISTERED
1331             SILC_STATUS_ERR_TOO_MANY_PARAMS
1332             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1333             SILC_STATUS_ERR_NO_CHANNEL_ID
1334             SILC_STATUS_ERR_NOT_ON_CHANNEL
1335             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1336
1337
1338    21   SILC_COMMAND_CLOSE
1339
1340         Max Arguments:  2
1341             Arguments:  (1) <remote server/router>  (2) [<port>]
1342
1343         This command is used only by operator to close connection to a
1344         remote site.
1345
1346         Reply messages to the command:
1347
1348         Max Arguments:  1
1349             Arguments:  (1) <Status Payload>
1350
1351         This command replies only with Status Payload.
1352
1353         Status messages:
1354
1355             SILC_STATUS_OK
1356             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1357             SILC_STATUS_ERR_TOO_MANY_PARAMS
1358             SILC_STATUS_ERR_NOT_REGISTERED
1359             SILC_STATUS_ERR_NO_SUCH_SERVER
1360             SILC_STATUS_ERR_NO_SERVER_PRIV
1361             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1362
1363
1364    22   SILC_COMMAND_SHUTDOWN
1365
1366         Max Arguments:  0
1367             Arguments:  None
1368
1369         This command is used only by operator to shutdown the server.
1370         All connections to the server will be closed and the server is
1371         shutdown.
1372
1373         Reply messages to the command:
1374
1375         Max Arguments:  1
1376             Arguments:  (1) <Status Payload>
1377
1378         This command replies only with Status Payload.
1379
1380         Status messages:
1381
1382             SILC_STATUS_OK
1383             SILC_STATUS_ERR_NOT_REGISTERED
1384             SILC_STATUS_ERR_NO_SERVER_PRIV
1385
1386
1387    23   SILC_COMMAND_SILCOPER
1388
1389         Max Arguments:  2
1390             Arguments:  (1) <username>  (2) <authentication payload>
1391
1392         This command is used by normal client to obtain router operator
1393         privileges (also known as SILC operator) on the router.  Note
1394         that router operator has privileges that supersedes the server
1395         operator privileges.
1396
1397         The <username> is the username set in the server configurations
1398         as operator.  The <authentication payload> is the data that the
1399         client is authenticated against.  It may be passphrase prompted
1400         for user on client's screen or it may be public key or certificate
1401         authentication data (data signed with private key).
1402
1403         Difference between router operator and server operator is that
1404         router operator is able to handle cell level properties while
1405         server operator (even on router server) is able to handle only
1406         local properties, such as, local connections and normal server
1407         administration.  The router operator is also able to use the
1408         SILC_COMMAND_KILL command.
1409
1410         After changing the mode server MUST send the notify type
1411         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1412
1413         Reply messages to the command:
1414
1415         Max Arguments:  1
1416             Arguments:  (1) <Status Payload>
1417
1418         This command replies only with Status Payload.
1419
1420         Status messages:
1421
1422             SILC_STATUS_OK
1423             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1424             SILC_STATUS_ERR_TOO_MANY_PARAMS
1425             SILC_STATUS_ERR_NOT_REGISTERED
1426             SILC_STATUS_ERR_AUTH_FAILED
1427
1428
1429    24   SILC_COMMAND_LEAVE
1430
1431         Max Arguments:  1
1432             Arguments:  (1) <Channel ID>
1433
1434         This command is used by client to leave a channel the client is
1435         joined to.
1436
1437         When leaving channel the server MUST send the notify type
1438         SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1439         The channel key MUST also be re-generated when leaving the channel
1440         and distribute it to all clients still currently on the channel.
1441         The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1442         is set.
1443
1444         Reply messages to the command:
1445
1446         Max Arguments:  1
1447             Arguments:  (1) <Status Payload>
1448
1449         This command replies only with Status Payload.
1450
1451         Status messages:
1452
1453             SILC_STATUS_OK
1454             SILC_STATUS_ERR_NOT_REGISTERED
1455             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1456             SILC_STATUS_ERR_TOO_MANY_PARAMS
1457             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1458             SILC_STATUS_ERR_BAD_CHANNEL_ID
1459             SILC_STATUS_ERR_NO_CHANNEL_ID
1460
1461
1462    25   SILC_COMMAND_USERS
1463
1464         Max Arguments:  1
1465             Arguments:  (1) <Channel ID>
1466
1467         This command is used to list user names currently on the requested
1468         channel; argument <Channel ID>.  The server MUST resolve the
1469         user names and send a comma (`,') separated list of user names
1470         on the channel.  Server or router MAY resolve the names by sending
1471         SILC_COMMAND_WHOIS or SILC_COMMAND_IDENTIFY commands.
1472
1473         If the requested channel is a private or secret channel, this
1474         command MUST NOT send the list of users, as private and secret
1475         channels cannot be seen by outside.  In this case the returned
1476         name list MAY include a indication that the server could not
1477         resolve the names of the users on the channel.  Also, in this case
1478         Client ID's or client modes are not sent either.
1479
1480         Reply messages to the command:
1481
1482         Max Arguments:  5
1483             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1484                         (3) <list count>      (4) <Client ID list>
1485                         (5) <client mode list>
1486
1487         This command replies with the Channel ID of the requested channel
1488         Client ID list of the users on the channel and list of their modes.
1489         The Client ID list has Client ID's of all users in the list.  The
1490         <Client ID list> is formed by adding Client ID's one after another.
1491         The <client mode list> is formed by adding client's user modes on
1492         the channel one after another (4 bytes (32 bits) each).  The <list
1493         count> of length of 4 bytes (32 bits), tells the number of entries
1494         in the lists.  Both lists MUST have equal number of entries.
1495
1496         Status messages:
1497
1498             SILC_STATUS_OK
1499             SILC_STATUS_ERR_NOT_REGISTERED
1500             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1501             SILC_STATUS_ERR_TOO_MANY_PARAMS
1502             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1503             SILC_STATUS_ERR_BAD_CHANNEL_ID
1504             SILC_STATUS_ERR_NO_CHANNEL_ID
1505             SILC_STATUS_ERR_NOT_ON_CHANNEL
1506
1507
1508    26   SILC_COMMAND_GETKEY
1509
1510         Max Arguments:  1
1511             Arguments:  (1) <ID Payload>
1512
1513         This command is used to fetch the public key of the client or
1514         server indicated by the <ID Payload>.  The public key is fetched
1515         from the server where to the client is connected.
1516
1517         Reply messages to the command:
1518
1519         Max Arguments:  3
1520             Arguments:  (1) <Status Payload>      (2) <ID Payload>
1521                         (3) <Public Key Payload>
1522
1523         This command replies with the client's or server's ID and with
1524         the <Public Key Payload>.
1525
1526         Status messages:
1527
1528             SILC_STATUS_OK
1529             SILC_STATUS_ERR_NOT_REGISTERED
1530             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1531             SILC_STATUS_ERR_TOO_MANY_PARAMS
1532             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1533             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1534
1535
1536    27 - 199
1537
1538         Currently undefined commands.
1539
1540
1541    200 - 254
1542
1543         These commands are reserved for private use and will not be defined
1544         in this document.
1545
1546
1547    255  SILC_COMMAND_MAX
1548
1549         Reserved command.  This must not be sent.
1550 .in 3
1551
1552
1553 .ti 0
1554 2.3 SILC Command Status Types
1555
1556 .ti 0
1557 2.3.1 SILC Command Status Payload
1558
1559 Command Status Payload is sent in command reply messages to indicate
1560 the status of the command.  The payload is one of argument in the
1561 command thus this is the data area in Command Argument Payload described
1562 in [SILC2].  The payload is only 2 bytes of length.  The following diagram
1563 represents the Command Status Payload (field is always in MSB order).
1564
1565
1566 .in 21
1567 .nf
1568                      1
1569  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1570 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1571 |        Status Message         |
1572 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1573 .in 3
1574
1575 .ce
1576 Figure 6:  SILC Command Status Payload
1577
1578
1579 .in 6
1580 o Status Message (2 bytes) - Indicates the status message.
1581   All Status messages are described in the next section.
1582 .in 3
1583
1584
1585 .ti 0
1586 2.3.2 SILC Command Status List
1587
1588 Command Status messages are returned in the command reply messages
1589 to indicate whether the command were executed without errors.  If error
1590 has occurred the status indicates which error occurred.  Status payload
1591 only sends numeric reply about the status.  Receiver of the payload must
1592 convert the numeric values into human readable error messages.  The
1593 list of status messages below has an example human readable error
1594 messages that client may display for the user.
1595
1596 List of all defined command status messages following.
1597
1598 .in 0
1599    Generic status messages:
1600
1601    0    SILC_STATUS_OK
1602
1603         Ok status.  Everything went Ok.  The status payload maybe
1604         safely ignored in this case.
1605
1606    1    SILC_STATUS_LIST_START
1607
1608         Start of the list.  There will be several command replies and
1609         this reply is the start of the list.
1610
1611    2    SILC_STATUS_LIST_ITEM
1612
1613         Item in the list.  This is one of the item in the list but not the
1614         first or last one.
1615
1616    3    SILC_STATUS_LIST_END
1617
1618         End of the list.  There were several command replies and this
1619         reply is the last of the list.  There won't be other replies
1620         belonging to this list after this one.
1621
1622    4 - 9
1623
1624         Currently undefined and has been reserved for the future.
1625
1626
1627    Error status message:
1628
1629
1630
1631    10   SILC_STATUS_ERR_NO_SUCH_NICK
1632
1633         "No such nickname".  Requested nickname does not exist.
1634
1635    11   SILC_STATUS_ERR_NO_SUCH_CHANNEL
1636
1637         "No such channel".  Requested channel name does not exist.
1638
1639    12   SILC_STATUS_ERR_NO_SUCH_SERVER
1640
1641         "No such server".  Requested server name does not exist.
1642
1643    13   SILC_STATUS_ERR_TOO_MANY_TARGETS
1644
1645         "Duplicate recipients. No message delivered".  Message were
1646         tried to be sent to recipient which has several occurrences in
1647         the recipient list.
1648
1649    14   SILC_STATUS_ERR_NO_RECIPIENT
1650
1651         "No recipient given".  Command required recipient which was
1652         not provided.
1653
1654    15   SILC_STATUS_ERR_UNKNOWN_COMMAND
1655
1656         "Unknown command".  Command sent to server is unknown by the
1657         server.
1658
1659    16   SILC_STATUS_ERR_WILDCARDS
1660
1661         "Wildcards cannot be used".  Wildcards were provided but they
1662         weren't permitted.
1663
1664    17   SILC_STATUS_ERR_NO_CLIENT_ID
1665
1666         "No Client ID given".  Client ID were expected as command
1667         parameter but were not found.
1668
1669    18   SILC_STATUS_ERR_NO_CHANNEL_ID
1670
1671         "No Channel ID given".  Channel ID were expected as command
1672         parameter but were not found.
1673
1674    19   SILC_STATUS_ERR_NO_SERVER_ID
1675
1676         "No Serve ID given".  Server ID were expected as command
1677         parameter but were not found.
1678
1679    20   SILC_STATUS_ERR_BAD_CLIENT_ID
1680
1681         "Bad Client ID".  Client ID provided were erroneous.
1682
1683    21   SILC_STATUS_ERR_BAD_CHANNEL_ID
1684
1685         "Bad Channel ID".  Channel ID provided were erroneous.
1686
1687    22   SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1688
1689         "No such Client ID".  Client ID provided does not exist.
1690
1691    23   SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1692
1693         "No such Channel ID".  Channel ID provided does not exist.
1694
1695    24   SILC_STATUS_ERR_NICKNAME_IN_USE
1696
1697         "Nickname already exists".  Nickname created could not be
1698         registered because number of same nicknames were already set to
1699         maximum.  This is not expected to happen in real life but is
1700         possible to occur.
1701
1702    25   SILC_STATUS_ERR_NOT_ON_CHANNEL
1703
1704         "You are not on that channel".  The command were specified for
1705         channel user is not currently on.
1706
1707    26   SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1708
1709         "They are not on channel".  The requested target client is not
1710         on requested channel.
1711
1712    27   SILC_STATUS_ERR_USER_ON_CHANNEL
1713
1714         "User already on channel".  User were invited on channel they
1715         already are on.
1716
1717    28   SILC_STATUS_ERR_NOT_REGISTERED
1718
1719         "You have not registered".  User executed command that requires
1720         the client to be registered on the server before it may be
1721         executed.
1722
1723    29   SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1724
1725         "Not enough parameters".  Command requires more parameters
1726         than provided.
1727
1728    30   SILC_STATUS_ERR_TOO_MANY_PARAMS
1729
1730         "Too many parameters".  Too many parameters were provided
1731         for the command.
1732
1733    31   SILC_STATUS_ERR_PERM_DENIED
1734
1735         "Permission denied".  Generic permission denied error status
1736         to indicate disallowed access.
1737
1738    32   SILC_STATUS_ERR_BANNED_FROM_SERVER
1739
1740         "You are banned from this server".  The client tried to register
1741         on server that has explicitly denied this host to connect.
1742
1743    33   SILC_STATUS_ERR_BAD_PASSWORD
1744
1745         "Cannot join channel. Incorrect password".  Password provided for
1746         channel were not accepted.
1747
1748    34   SILC_STATUS_ERR_CHANNEL_IS_FULL
1749
1750         "Cannot join channel. Channel is full".  The channel is full
1751         and client cannot be joined to it.
1752
1753    35   SILC_STATUS_ERR_NOT_INVITED
1754
1755         "Cannot join channel. You have not been invited".  The channel
1756         is invite only channel and client has not been invited.
1757
1758    36   SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1759
1760         "Cannot join channel. You have been banned".  The client has
1761         been banned from the channel.
1762
1763    37   SILC_STATUS_ERR_UNKNOWN_MODE
1764
1765         "Unknown mode".  Mode provided by the client were unknown to
1766         the server.
1767
1768    38   SILC_STATUS_ERR_NOT_YOU
1769
1770         "Cannot change mode for other users".  User tried to change
1771         someone else's mode.
1772
1773    39   SILC_STATUS_ERR_NO_CHANNEL_PRIV
1774
1775         "Permission denied. You are not channel operator".  Command may
1776         be executed only by channel operator.
1777
1778    40   SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1779
1780         "Permission denied. You are not channel founder".  Command may
1781         be executed only by channel operator.
1782
1783    41   SILC_STATUS_ERR_NO_SERVER_PRIV
1784
1785         "Permission denied. You are not server operator".  Command may
1786         be executed only by server operator.
1787
1788    42   SILC_STATUS_ERR_NO_ROUTER_PRIV
1789
1790         "Permission denied. You are not SILC operator".  Command may be
1791         executed only by router (SILC) operator.
1792
1793    43   SILC_STATUS_ERR_BAD_NICKNAME
1794
1795         "Bad nickname".  Nickname requested contained illegal characters
1796         or were malformed.
1797
1798    44   SILC_STATUS_ERR_BAD_CHANNEL
1799
1800         "Bad channel name".  Channel requested contained illegal characters
1801         or were malformed.
1802
1803    45   SILC_STATUS_ERR_AUTH_FAILED
1804
1805         "Authentication failed".  The authentication data sent as
1806         argument were wrong and thus authentication failed.
1807
1808    46   SILC_STATUS_ERR_UNKOWN_ALGORITHM
1809
1810         "The algorithm was not supported."  The server does not support the
1811         requested algorithm.
1812
1813    47   SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1814
1815         "No such Server ID".  Server ID provided does not exist.
1816
1817 .in 3
1818
1819
1820 .ti 0
1821 3 Security Considerations
1822
1823 Security is central to the design of this protocol, and these security
1824 considerations permeate the specification.  Common security considerations
1825 such as keeping private keys truly private and using adequate lengths for
1826 symmetric and asymmetric keys must be followed in order to maintain the
1827 security of this protocol.
1828
1829
1830 .ti 0
1831 4 References
1832
1833 [SILC1]      Riikonen, P., "Secure Internet Live Conferencing (SILC),
1834              Protocol Specification", Internet Draft, April 2001.
1835
1836 [SILC2]      Riikonen, P., "SILC Packet Protocol", Internet Draft,
1837              April 2001.
1838
1839 [SILC3]      Riikonen, P., "SILC Key Exchange and Authentication
1840              Protocols", Internet Draft, April 2001.
1841
1842 [IRC]        Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
1843              RFC 1459, May 1993.
1844
1845 [IRC-ARCH]   Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
1846              April 2000.
1847
1848 [IRC-CHAN]   Kalt, C., "Internet Relay Chat: Channel Management", RFC
1849              2811, April 2000.
1850
1851 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
1852              2812, April 2000.
1853
1854 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
1855              2813, April 2000.
1856
1857 [SSH-TRANS]  Ylonen, T., et al, "SSH Transport Layer Protocol",
1858              Internet Draft.
1859
1860 [PGP]        Callas, J., et al, "OpenPGP Message Format", RFC 2440,
1861              November 1998.
1862
1863 [SPKI]       Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
1864              September 1999.
1865
1866 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
1867              Infrastructure, Certificate and CRL Profile", RFC 2459,
1868              January 1999.
1869
1870 [Schneier]   Schneier, B., "Applied Cryptography Second Edition",
1871              John Wiley & Sons, New York, NY, 1996.
1872
1873 [Menezes]    Menezes, A., et al, "Handbook of Applied Cryptography",
1874              CRC Press 1997.
1875
1876 [OAKLEY]     Orman, H., "The OAKLEY Key Determination Protocol",
1877              RFC 2412, November 1998.
1878
1879 [ISAKMP]     Maughan D., et al, "Internet Security Association and
1880              Key Management Protocol (ISAKMP)", RFC 2408, November
1881              1998.
1882
1883 [IKE]        Harkins D., and Carrel D., "The Internet Key Exchange
1884              (IKE)", RFC 2409, November 1998.
1885
1886 [HMAC]       Krawczyk, H., "HMAC: Keyed-Hashing for Message
1887              Authentication", RFC 2104, February 1997.
1888
1889 [PKCS1]      Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
1890              Specifications, Version 2.0", RFC 2437, October 1998.
1891
1892 [RFC2119]    Bradner, S., "Key Words for use in RFCs to Indicate
1893              Requirement Levels", BCP 14, RFC 2119, March 1997.
1894
1895
1896 .ti 0
1897 5 Author's Address
1898
1899 .nf
1900 Pekka Riikonen
1901 Kasarmikatu 11 A4
1902 70110 Kuopio
1903 Finland
1904
1905 EMail: priikone@poseidon.pspt.fi
1906
1907 This Internet-Draft expires 25 October 2001