doc/draft-riikonen-silc-commands-03.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 XXX
  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-03.txt                     XXX
  20 Expires: XXX
  21
  22 .in 3
  23
  24 .ce 2
  25 SILC Commands
  26 <draft-riikonen-silc-commands-03.txt>
  27
  28 .ti 0
  29 Status of this Memo
  30
  31 This document is an Internet-Draft and is in full conformance with
  32 all provisions of Section 10 of RFC 2026.  Internet-Drafts are
  33 working documents of the Internet Engineering Task Force (IETF), its
  34 areas, and its working groups.  Note that other groups may also
  35 distribute working documents as Internet-Drafts.
  36
  37 Internet-Drafts are draft documents valid for a maximum of six months
  38 and may be updated, replaced, or obsoleted by other documents at any
  39 time.  It is inappropriate to use Internet-Drafts as reference
  40 material or to cite them other than as "work in progress."
  41
  42 The list of current Internet-Drafts can be accessed at
  43 http://www.ietf.org/ietf/1id-abstracts.txt
  44
  45 The list of Internet-Draft Shadow Directories can be accessed at
  46 http://www.ietf.org/shadow.html
  47
  48 The distribution of this memo is unlimited.
  49
  50
  51 .ti 0
  52 Abstract
  53
  54 This memo describes the commands used in the Secure Internet Live
  55 Conferencing (SILC) protocol, specified in the Secure Internet Live
  56 Conferencing, Protocol Specification Internet Draft [SILC1].  The
  57 SILC Commands are very important part of the SILC protocol.  Usually
  58 the commands are used by SILC clients to manage the SILC session, but
  59 also SILC servers may use the commands.  This memo specifies detailed
  60 command messages and command reply messages.
  61
  62
  63
  64
  65
  66
  67
  68
  69 .ti 0
  70 Table of Contents
  71
  72 .nf
  73 1 Introduction ..................................................  2
  74   1.1 Requirements Terminology ..................................  2
  75 2 SILC Commands .................................................  2
  76   2.1 SILC Commands Syntax ......................................  2
  77   2.2 SILC Commands List ........................................  4
  78   2.3 SILC Command Status Types ................................. 33
  79       2.3.1 SILC Command Status Payload ......................... 33
  80       2.3.2 SILC Command Status List ............................ 33
  81 3 Security Considerations ....................................... 38
  82 4 References .................................................... 38
  83 5 Author's Address .............................................. 40
  84
  85
  86 .ti 0
  87 1. Introduction
  88
  89 This document describes the commands used in the Secure Internet Live
  90 Conferencing (SILC) protocol, specified in the Secure Internet Live
  91 Conferencing, Protocol Specification Internet Draft [SILC1].  This
  92 document specifies detailed command messages and command reply messages.
  93
  94 Commands are very important part on SILC network especially for client
  95 which uses commands to operate on the SILC network.  Commands are used
  96 to set nickname, join to channel, change modes and many other things.
  97
  98 See the [SILC1] for the requirements and the restrictions for the usage
  99 of the SILC commands.  The [SILC2] defines the command packet type and
 100 the Command Payload which is actually used to deliver the commands and
 101 command reply messages.
 102
 103
 104 .ti 0
 105 1.1 Requirements Terminology
 106
 107 The keywords MUST, MUST NOT, REQUIRED, SHOULD, SHOULD NOT, RECOMMENDED,
 108 MAY, and OPTIONAL, when they appear in this document, are to be
 109 interpreted as described in [RFC2119].
 110
 111
 112 .ti 0
 113 2 SILC Commands
 114
 115 .ti 0
 116 2.1 SILC Commands Syntax
 117
 118 This section briefly describes the syntax of the command notions
 119 in this document.  Every field in command is separated from each
 120 other by whitespaces (` ') indicating that each field is independent
 121 argument and each argument MUST have own Command Argument Payload.
 122 The number of maximum arguments are defined with each command
 123 separately.  The Command Argument Payload is described in [SILC2].
 124
 125 Every command defines specific number for each argument.  Currently,
 126 they are defined in ascending order; first argument has number one
 127 (1), second has number two (2) and so on.  This number is set into the
 128 Argument Type field in the Command Argument Payload.  This makes it
 129 possible to send the arguments in free order as the number MUST be
 130 used to identify the type of the argument.  This makes is it also
 131 possible to have multiple optional arguments in commands and in
 132 command replies.  The number of argument is marked in parentheses
 133 before the actual argument.
 134
 135
 136
 137 .in 6
 138 Example:  Arguments:  (1) <nickname> (2) <username@host>
 139 .in 3
 140
 141
 142 Every command replies with Status Payload.  This payload tells the
 143 sender of the command whether the command was completed successfully or
 144 whether there was an error.  If error occurred the payload includes the
 145 error type.  In the next section the Status Payload is not described
 146 as it is common to all commands and has been described here.  Commands
 147 MAY reply with other arguments as well.  These arguments are command
 148 specific and are described in the next section.
 149
 150 Example command:
 151 .in 6
 152
 153 EXAMPLE_COMMAND
 154
 155 .in 8
 156 Max Arguments:  3
 157     Arguments:  (1) <nickname>[@<server>]  (2) <message>
 158                 (3) [<count>]
 159
 160 The command has maximum of 3 arguments.  However, only first
 161 and second arguments are mandatory.
 162
 163 First argument <nickname> is mandatory but may have optional
 164 <nickname@server> format as well.  Second argument is mandatory
 165 <message> argument.  Third argument is optional <count> argument.
 166
 167 The numbers in parentheses are the argument specific numbers
 168 that specify the type of the argument in Command Argument Payload.
 169 The receiver always knows that, say, argument number two (2) is
 170 <message> argument, regardless of the ordering of the arguments in
 171 the Command Payload.
 172
 173 Reply messages to the command:
 174
 175 Max Arguments:  4
 176     Arguments:  (1) <Status Payload>  (2) [<channel list>]
 177                 (3) <idle time>       (4) [<away message>]
 178
 179 This command may reply with maximum of 4 arguments.  However,
 180 only the first and third arguments are mandatory.  The numbers
 181 in the parentheses have the same meaning as in the upper
 182 command sending specification.
 183
 184 Every command reply with <Status Payload>, it is mandatory
 185 argument for all command replies and for this reason it is not
 186 described in the command reply descriptions.
 187
 188
 189
 190 Status messages:
 191
 192     SILC_STATUS_OK
 193     SILC_STATUS_ERR_TOO_MANY_TARGETS
 194     SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 195     SILC_STATUS_ERR_NO_SUCH_NICK
 196
 197 Every command reply also defines set of status message that it
 198 may return inside the <Status Payload>.  All status messages
 199 are defined in the section 2.3 SILC Command Status Types.
 200
 201 .in 3
 202 Every command that has some kind of ID as argument (for example
 203 <Client ID>) are actually ID Payloads, defined in [SILC2] that includes
 204 the type of the ID, length of the ID and the actual ID data.  This
 205 way variable length ID's can be sent as arguments.  Also note that
 206 all passphrases that may be sent in commands MUST be UTF-8 [RFC2279]
 207 encoded.
 208
 209
 210 .ti 0
 211 2.2 SILC Commands List
 212
 213 This section lists all SILC commands, however, it is expected that a
 214 implementation and especially client implementation has many more
 215 commands that has only local affect.  These commands are official
 216 SILC commands that has both client and server sides and cannot be
 217 characterized as local commands.
 218
 219 List of all defined commands in SILC follows.
 220
 221 .in 0
 222    0    SILC_COMMAND_NONE
 223
 224         None.  This is reserved command and MUST NOT be sent.
 225
 226
 227    1    SILC_COMMAND_WHOIS
 228
 229         Max Arguments:  256
 230             Arguments:  (1) [<nickname>[@<server>]]  (2) [<count>]
 231                         (3) [<Client ID>]            (n) [...]
 232
 233         Whois command is used to query various information about specific
 234         user.  The user may be requested by their nickname and server name.
 235         The query may find multiple matching users as there are no unique
 236         nicknames in the SILC.  The <count> option may be given to narrow
 237         down the number of accepted results.  If this is not defined there
 238         are no limit of accepted results.  The query may also be narrowed
 239         down by defining the server name of the nickname.  The <count> is
 240         int string format.
 241
 242         It is also possible to search the user by Client ID.  If the
 243         <Client ID> is provided server MUST use it as the search value
 244         instead of the <nickname>.  One of the arguments MUST be given.
 245         It is also possible to define multiple Client ID's to search
 246         multiple users sending only one WHOIS command.  In this case the
 247         Client ID's are appended as normal arguments.
 248
 249         To prevent miss-use of this command wildcards in the nickname
 250         or in the server name are not permitted.  It is not allowed
 251         to request all users on some server.  The WHOIS requests MUST
 252         be based on specific nickname request.
 253
 254         The WHOIS request MUST be always sent to the router by server
 255         so that all users are searched.  However, the server still MUST
 256         search its locally connected clients.  The router MUST send
 257         this command to the server which owns the requested client.  That
 258         server MUST reply to the command.  Server MUST NOT send whois
 259         replies to the client until it has received the reply from its
 260         router.
 261
 262         Reply messages to the command:
 263
 264         Max Arguments:  10
 265             Arguments:  (1) <Status Payload>       (2) <Client ID>
 266                         (3) <nickname>[@<server>]  (4) <username@host>
 267                         (5) <real name>            (6) [<Channel Payload
 268                                                          list>]
 269                         (7) [<user mode>]          (8) [<idle time>]
 270                         (9) [<fingerprint>]        (10) <channel user
 271                                                          mode list>
 272
 273
 274         This command may reply with several command reply messages to
 275         form a list of results.  In this case the status payload will
 276         include STATUS_LIST_START status in the first reply and
 277         STATUS_LIST_END in the last reply to indicate the end of the
 278         list.  If there are only one reply the status is set to normal
 279         STATUS_OK.
 280
 281         The command replies include the Client ID of the nickname,
 282         nickname and server name, user name and host name and user's real
 283         name.  Client SHOULD process these replies only after the last
 284         reply has been received with the STATUS_LIST_END status.  If the
 285         <count> option were defined in the query there will be only
 286         <count> many replies from the server.
 287
 288         The server returns the list of channels if the client has
 289         joined channels.  In this case the list is list of Channel
 290         Payloads.  The Mode Mask in the Channel Payload is the channel's
 291         mode.  The list is encoded by adding the Channel Payloads one
 292         after the other.  Private and secret channels MUST NOT be sent,
 293         except if the sender of this command is on those channels, or
 294         the sender is server.  The <channel user mode list> MUST also
 295         be sent if client is joined channels.  This list includes 32 bit
 296         MSB first order values one after the other and each indicate
 297         the user's mode on a channel.  The order of these values MUST
 298         be same as the channel order in the <Channel Payload list>.
 299
 300         The server also returns client's user mode, idle time, and the
 301         fingerprint of the client's public key.  The <fingerprint> is the
 302         binary hash digest of the public key.  The fingerprint MUST NOT
 303         be sent if the server has not verified the proof of posession of
 304         the corresponding private key.  Server can do this during the
 305         SILC Key Exchange protocol.  The <fingerprint> is SHA1 digest.
 306
 307         Status messages:
 308
 309             SILC_STATUS_OK
 310             SILC_STATUS_LIST_START
 311             SILC_STATUS_LIST_END
 312             SILC_STATUS_ERR_NO_SUCH_NICK
 313             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
 314             SILC_STATUS_ERR_WILDCARDS
 315             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 316             SILC_STATUS_ERR_TOO_MANY_PARAMS
 317
 318
 319    2    SILC_COMMAND_WHOWAS
 320
 321         Max Arguments:  2
 322             Arguments:  (1) <nickname>[@<server>]  (2) [<count>]
 323
 324         Whowas.  This command is used to query history information about
 325         specific user.  The user may be requested by their nickname and
 326         server name.  The query may find multiple matching users as there
 327         are no unique nicknames in the SILC.  The <count> option may be
 328         given to narrow down the number of accepted results.  If this
 329         is not defined there are no limit of accepted results.  The query
 330         may also be narrowed down by defining the server name of the
 331         nickname.  The <count> is in string format.
 332
 333         To prevent miss-use of this command wildcards in the nickname
 334         or in the server name are not permitted.  The WHOWAS requests MUST
 335         be based on specific nickname request.
 336
 337         The WHOWAS request MUST be always sent to the router by server
 338         so that all users are searched.  However, the server still must
 339         search its locally connected clients.
 340
 341         Reply messages to the command:
 342
 343         Max Arguments:  5
 344             Arguments:  (1) <Status Payload>        (2) <Client ID>
 345                         (3) <nickname>[@<server>]   (4) <username@host>
 346                         (5) [<real name>]
 347
 348         This command may reply with several command reply messages to form
 349         a list of results.  In this case the status payload will include
 350         STATUS_LIST_START status in the first reply and STATUS_LIST_END in
 351         the last reply to indicate the end of the list.  If there are only
 352         one reply the status is set to normal STATUS_OK.
 353
 354         The command replies with nickname and user name and host name.
 355         Every server MUST keep history for some period of time of its
 356         locally connected clients.
 357
 358         Status messages:
 359
 360             SILC_STATUS_OK
 361             SILC_STATUS_LIST_START
 362             SILC_STATUS_LIST_END
 363             SILC_STATUS_ERR_NO_SUCH_NICK
 364             SILC_STATUS_ERR_WILDCARDS
 365             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 366             SILC_STATUS_ERR_TOO_MANY_PARAMS
 367
 368
 369    3    SILC_COMMAND_IDENTIFY
 370
 371         Max Arguments:  256
 372             Arguments:  (1) [<nickname>[@<server>]]  (2) [<server name>]
 373                         (3) [<channel name>]         (4) [<count>]
 374                         (5) [<ID Payload>]           (n) [...]
 375
 376         Identify command is used to query information about an entity by
 377         the entity's name or ID.  This command can be used to query
 378         information about clients, server and channels.
 379
 380         The query may find multiple matching entities.  The <count> option
 381         may be given to narrow down the number of accepted results.  If
 382         this is not defined there are no limit of accepted results.  The
 383         <count> is in string format.
 384
 385         It is also possible to search the entity by its ID.  If the
 386         <ID Payload> is provided server must use it as the search value
 387         instead of the entity's name.  One of the arguments must be given.
 388         It is also possible to define multiple ID Payloads to search
 389         multiple entities sending only one IDENTIFY command.  In this case
 390         the ID Payloads are appended as normal arguments.  The type of the
 391         entity is defined by the type of the ID Payload.
 392
 393         To prevent miss-use of this command wildcards in the names are
 394         not permitted.  It is not allowed to request for example all users
 395         on server.
 396
 397         Implementations may not want to give interface access to this
 398         command as it is hardly a command that would be used by an end
 399         user.  However, it must be implemented as it is used with private
 400         message sending.
 401
 402         The IDENTIFY command MUST be always sent to the router by server
 403         so that all users are searched.  However, server MUST still search
 404         its locally connected clients.
 405
 406         Reply messages to the command:
 407
 408         Max Arguments:  4
 409             Arguments:  (1) <Status Payload>   (2) <ID Payload>
 410                         (3) [<entity's name>]  (4) [<info>]
 411
 412         This command may reply with several command reply messages to form
 413         a list of results.  In this case the status payload will include
 414         STATUS_LIST_START status in the first reply and STATUS_LIST_END in
 415         the last reply to indicate the end of the list.  If there are only
 416         one reply the status is set to normal STATUS_OK.
 417
 418         When querying clients the <entity's name> must include the client's
 419         nickname in the following format: nickname[@server].  The
 420         <info> must include the client's username and host in the following
 421         format: username@host.
 422
 423         When querying servers the <entity's name> must include the server's
 424         full name.  The <info> may be omitted.
 425
 426         When querying channels the <entity's name> must include the
 427         channel's name.  The <info> may be omitted.
 428
 429         If the <count> option were defined in the query there will be only
 430         <count> many replies from the server.
 431
 432         Status messages:
 433
 434             SILC_STATUS_OK
 435             SILC_STATUS_LIST_START
 436             SILC_STATUS_LIST_END
 437             SILC_STATUS_ERR_NO_SUCH_NICK
 438             SILC_STATUS_ERR_NO_SUCH_SERVER
 439             SILC_STATUS_ERR_NO_SUCH_CHANNEL
 440             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
 441             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
 442             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
 443             SILC_STATUS_ERR_WILDCARDS
 444             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 445             SILC_STATUS_ERR_TOO_MANY_PARAMS
 446
 447
 448    4    SILC_COMMAND_NICK
 449
 450         Max Arguments:  1
 451             Arguments:  (1) <nickname>
 452
 453         Set/change nickname.  This command is used to set nickname for
 454         user.  Nickname MUST NOT include any spaces (` '), non-printable
 455         characters, commas (`,') and any wildcard characters.  Note that
 456         nicknames in SILC are case-sensitive which must be taken into
 457         account when searching clients by nickname.
 458
 459         When nickname is changed new Client ID is generated.  Server MUST
 460         distribute SILC_NOTIFY_TYPE_NICK_CHANGE to local clients on the
 461         channels (if any) the client is joined on.  Then it MUST send
 462         SILC_PACKET_REPLACE_ID to its primary route to replace the old
 463         Client ID with the new one.
 464
 465         Reply messages to the command:
 466
 467         Max Arguments:  2
 468             Arguments:  (1) <Status Payload>  (2) <New ID Payload>
 469
 470         This command is replied always with New ID Payload that is
 471         generated by the server every time user changes their nickname.
 472         Client receiving this payload MUST start using the received
 473         Client ID as its current valid Client ID.  The New ID Payload
 474         is described in [SILC2].
 475
 476         Status messages:
 477
 478             SILC_STATUS_OK
 479             SILC_STATUS_ERR_WILDCARDS
 480             SILC_STATUS_ERR_NICKNAME_IN_USE
 481             SILC_STATUS_ERR_BAD_NICKNAME
 482             SILC_STATUS_ERR_NOT_REGISTERED
 483             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 484             SILC_STATUS_ERR_TOO_MANY_PARAMS
 485
 486
 487    5    SILC_COMMAND_LIST
 488
 489         Max Arguments:  1
 490             Arguments:  (1) [<Channel ID>]
 491
 492         The list command is used to list channels and their topics on the
 493         current server.  If the <Channel ID> parameter is used, only the
 494         status of that channel is displayed.  Secret channels are not
 495         listed at all.  Private channels are listed with status indicating
 496         that the channel is private.  Router MAY reply with all channels
 497         it knows about.
 498
 499         Reply messages to the command:
 500
 501         Max Arguments:  5
 502             Arguments:  (1) <Status Payload>  (2) <Channel ID>
 503                         (3) <channel>         (4) [<topic>]
 504                         (5) [<user count>]
 505
 506         This command may reply with several command reply messages to form
 507         a list of results.  In this case the status payload will include
 508         STATUS_LIST_START status in the first reply and STATUS_LIST_END in
 509         the last reply to indicate the end of the list.  If there are only
 510         one reply the status is set to normal STATUS_OK.
 511
 512         This command replies with Channel ID, name and the topic of the
 513         channel.  If the channel is private channel the <topic> SHOULD
 514         include the "*private*" string.
 515
 516         Status messages:
 517
 518             SILC_STATUS_OK
 519             SILC_STATUS_LIST_START
 520             SILC_STATUS_LIST_END
 521             SILC_STATUS_ERR_WILDCARDS
 522             SILC_STATUS_ERR_NOT_REGISTERED
 523             SILC_STATUS_ERR_TOO_MANY_PARAMS
 524             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
 525             SILC_STATUS_ERR_NO_CHANNEL_ID
 526             SILC_STATUS_ERR_NO_SUCH_SERVER
 527
 528
 529    6    SILC_COMMAND_TOPIC
 530
 531         Max Arguments:  2
 532             Arguments:  (1) <Channel ID>  (2) [<topic>]
 533
 534         This command is used to change or view the topic of a channel.
 535         The topic for channel <Channel ID> is returned if there is no
 536         <topic> given.  If the <topic> parameter is present, the topic
 537         for that channel will be changed, if the channel modes permit
 538         this action.
 539
 540         After setting the topic the server MUST send the notify type
 541         SILC_NOTIFY_TYPE_TOPIC_SET to its primary router and then to
 542         the channel which topic was changed.
 543
 544         Reply messages to the command:
 545
 546         Max Arguments:  2
 547             Arguments:  (1) <Status Payload>  (2) <Channel ID>
 548                         (3) [<topic>]
 549
 550         The command may reply with the topic of the channel if it is
 551         set.
 552
 553         Status messages:
 554
 555             SILC_STATUS_OK
 556             SILC_STATUS_ERR_NOT_ON_CHANNEL
 557             SILC_STATUS_ERR_WILDCARDS
 558             SILC_STATUS_ERR_NOT_REGISTERED
 559             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 560             SILC_STATUS_ERR_NO_SUCH_CHANNEL
 561             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
 562             SILC_STATUS_ERR_NO_CHANNEL_ID
 563             SILC_STATUS_ERR_BAD_CHANNEL_ID
 564             SILC_STATUS_ERR_TOO_MANY_PARAMS
 565             SILC_STATUS_ERR_NO_CHANNEL_PRIV
 566
 567
 568    7    SILC_COMMAND_INVITE
 569
 570         Max Arguments:  4
 571             Arguments:  (1) <Channel ID>       (2) [<Client ID>]
 572                         (3) [<adding client>]  (4) [<removing client>]
 573
 574         This command is used to invite other clients to join to the
 575         channel.  The <Client ID> argument is the target client's ID that
 576         is being invited.  The <Channel ID> is the Channel ID of the
 577         requested channel.  The sender of this command MUST be on the
 578         channel.  The server MUST also send the notify type
 579         SILC_NOTIFY_TYPE_INVITE to its primary router and then to the
 580         client indicated by the <Client ID>.
 581
 582         The <adding client> and <removing client> can be used to add to
 583         and remove from the invite list.  The format of the <adding client>
 584         and <removing client> is as follows:
 585
 586             [<nickname>[@<server>]!][<username>]@[<hostname>]
 587
 588         When adding to or removing from the invite list the server MUST
 589         send the notify type SILC_NOTIFY_TYPE_INVITE to its primary router
 590         and MUST NOT send it to the client which was added to the list.
 591         The client which executes this command MUST have at least channel
 592         operator privileges to be able to add to or remove from the invite
 593         list.  The wildcards MAY be used with this command.  If adding or
 594         removing more than one client then the lists are an comma (`,')
 595         separated.
 596
 597         Note that the <Client ID> provided MUST be resolved into correct
 598         nickname and host name and add to the invite list before sending
 599         the notify packet.
 600
 601         When this command is given with only <Channel ID> argument then
 602         the command merely returns the invite list of the channel.   This
 603         command MUST fail if the requested channel does not exist, the
 604         requested <Client ID> is already on the channel or if the channel
 605         is invite only channel and the caller of this command does not
 606         have at least channel operator privileges.
 607
 608         Reply messages to the command:
 609
 610         Max Arguments:  3
 611             Arguments:  (1) <Status Payload>  (2) <Channel ID>
 612                         (3) [<invite list>]
 613
 614         This command replies with the invite list of the channel if it
 615         exists.
 616
 617         Status messages:
 618
 619             SILC_STATUS_OK
 620             SILC_STATUS_ERR_NOT_REGISTERED
 621             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 622             SILC_STATUS_ERR_TOO_MANY_PARAMS
 623             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
 624             SILC_STATUS_ERR_NO_CLIENT_ID
 625             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
 626             SILC_STATUS_ERR_NO_CHANNEL_ID
 627             SILC_STATUS_ERR_NOT_ON_CHANNEL
 628             SILC_STATUS_ERR_USER_ON_CHANNEL
 629             SILC_STATUS_ERR_NO_CHANNEL_PRIV
 630
 631
 632    8    SILC_COMMAND_QUIT
 633
 634         Max Arguments:  1
 635             Arguments:  (1) [<quit message>]
 636
 637         This command is used by client to end SILC session.  The server
 638         must close the connection to a client which sends this command.
 639         if <quit message> is given it will be sent to other clients on
 640         channel if the client is on channel when quitting.
 641
 642         Reply messages to the command:
 643
 644         This command does not reply anything.
 645
 646
 647     9   SILC_COMMAND_KILL
 648
 649         Max Arguments:  2
 650             Arguments:  (1) <Client ID>  (2) [<comment>]
 651
 652         This command is used by SILC operators to remove a client from
 653         SILC network.  The removing has temporary effects and client may
 654         reconnect to SILC network.  The <Client ID> is the client to be
 655         removed from SILC.  The <comment> argument may be provided to
 656         give to the removed client some information why it was removed
 657         from the network.
 658
 659         When killing a client the router MUST first send notify type
 660         SILC_NOTIFY_TYPE_KILLED to all channels the client has joined.
 661         The packet MUST NOT be sent to the killed client on the channels.
 662         Then, the router MUST send the same notify type to its primary
 663         router.  Finally, the router MUST send the same notify type
 664         directly to the client which was killed.
 665
 666         Reply messages to the command:
 667
 668         Max Arguments:  1
 669             Arguments:  (1) <Status Payload>
 670
 671         This command replies only with Status Payload.
 672
 673         Status messages:
 674
 675             SILC_STATUS_OK
 676             SILC_STATUS_ERR_WILDCARDS
 677             SILC_STATUS_ERR_NOT_REGISTERED
 678             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 679             SILC_STATUS_ERR_TOO_MANY_PARAMS
 680             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
 681             SILC_STATUS_ERR_NO_CLIENT_ID
 682             SILC_STATUS_ERR_NO_ROUTER_PRIV
 683
 684
 685    10   SILC_COMMAND_INFO
 686
 687         Max Arguments:  2
 688             Arguments:  (1) [<server>]  (2) [<Server ID>]
 689
 690         This command is used to fetch various information about a server.
 691         If <server> argument is specified the command MUST be sent to
 692         the requested server.
 693
 694         If the <Server ID> is specified the server information if fetched
 695         by the provided Server ID.  One of the arguments must always be
 696         present.
 697
 698         Reply messages to the command:
 699
 700         Max Arguments:  4
 701             Arguments:  (1) <Status Payload>  (2) <Server ID>
 702                         (3) <server name>     (4) <string>
 703
 704         This command replies with the Server ID of the server and a
 705         string which tells the information about the server.
 706
 707         Status messages:
 708
 709             SILC_STATUS_OK
 710             SILC_STATUS_ERR_WILDCARDS
 711             SILC_STATUS_ERR_NOT_REGISTERED
 712             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 713             SILC_STATUS_ERR_TOO_MANY_PARAMS
 714             SILC_STATUS_ERR_NO_SUCH_SERVER
 715             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
 716             SILC_STATUS_ERR_NO_SERVER_ID
 717
 718
 719    11   SILC_COMMAND_STATS
 720
 721         Max Arguments:  1
 722             Arguments:  (1) <Server ID>
 723
 724         This command is used to fetch various statistical information
 725         from the server indicated by <Server ID>, which is the ID of
 726         server where sender is connected to.  Server receiving this
 727         command MAY also send this further to its router for fetching
 728         other cell and network wide statistics to accompany the reply.
 729
 730         Reply messages to the command:
 731
 732         Max Arguments:  3
 733             Arguments:  (1) <Status Payload>          (2) <Server ID>
 734                         (3) [<statistics structure>]
 735
 736         This command replies with the Server ID of the server and
 737         optional statistics structure which includes 32 bit MSB first
 738         ordered integer values to represent various statistical
 739         information.  The structure is as follows:
 740
 741           starttime      - time when server was started
 742           uptime         - uptime of the server
 743           my clients     - number of locally connected clients
 744           my channels    - number of locally created channels
 745           my server ops  - number of local server operators
 746           my router ops  - number of local router operators
 747           cell clients   - number of clients in local cell
 748           cell channels  - number of channels in local cell
 749           cell servers   - number of servers in local cell
 750           clients        - number of client in SILC network
 751           channels       - number of channels in SILC network
 752           servers        - number of servers in SILC network
 753           routers        - number of routers in SILC network
 754           server ops     - number of server operators in SILC network
 755           router ops     - number of router operators in SILC network
 756
 757         If some value is unknown it is set to zero (0) value.  The
 758         "starttime" is the start time of the server, and is seconds
 759         since Epoch (POSIX.1).  The "uptime" is time difference of
 760         current time and "starttime" in the server, and is seconds
 761         in value.
 762
 763         Status messages:
 764
 765             SILC_STATUS_OK
 766             SILC_STATUS_ERR_NOT_REGISTERED
 767             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 768             SILC_STATUS_ERR_TOO_MANY_PARAMS
 769             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
 770             SILC_STATUS_ERR_NO_SUCH_SERVER
 771             SILC_STATUS_ERR_NO_SERVER_ID
 772
 773
 774    12   SILC_COMMAND_PING
 775
 776         Max Arguments:  1
 777             Arguments:  (1) <Server ID>
 778
 779         This command is used by client and server to test the communication
 780         channel to its server if one suspects that the communication is not
 781         working correctly.  The <Server ID> is the ID of the server the
 782         sender is connected to.
 783
 784         Reply messages to the command:
 785
 786         Max Arguments:  1
 787             Arguments:  (1) <Status Payload>
 788
 789         This command replies only with Status Payload.  Server returns
 790         SILC_STATUS_OK in Status Payload if pinging was successful.
 791
 792
 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_NO_SERVER_ID
 800             SILC_STATUS_ERR_NO_SUCH_SERVER
 801             SILC_STATUS_ERR_NOT_REGISTERED
 802
 803
 804    13   SILC_COMMAND_OPER
 805
 806         Max Arguments:  2
 807             Arguments:  (1) <username>  (2) <authentication payload>
 808
 809         This command is used by normal client to obtain server operator
 810         privileges on some server or router.  Note that router operator
 811         has router privileges that supersedes the server operator
 812         privileges and this does not obtain those privileges.  Client
 813         MUST use SILCOPER command to obtain router level privileges.
 814
 815         The <username> is the username set in the server configurations
 816         as operator.  The <authentication payload> is the data that the
 817         client is authenticated against.  It may be passphrase prompted
 818         for user on client's screen or it may be public key or certificate
 819         authentication data (data signed with private key).  The public
 820         key that server will use to verify the signature found in the
 821         payload should be verified.  It is recommended that the public
 822         key is saved locally in the server and server would not use
 823         any public keys received during the SKE.
 824
 825         After changing the mode the server MUST send the notify type
 826         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
 827
 828         Reply messages to the command:
 829
 830         Max Arguments:  1
 831             Arguments:  (1) <Status Payload>
 832
 833         This command replies only with Status Payload.
 834
 835         Status messages:
 836
 837             SILC_STATUS_OK
 838             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 839             SILC_STATUS_ERR_TOO_MANY_PARAMS
 840             SILC_STATUS_ERR_NOT_REGISTERED
 841             SILC_STATUS_ERR_AUTH_FAILED
 842
 843
 844    14   SILC_COMMAND_JOIN
 845
 846         Max Arguments:  6
 847             Arguments:  (1) <channel>       (2) <Client ID>
 848                         (3) [<passphrase>]  (4) [<cipher>]
 849                         (5) [<hmac>]        (6) [<founder auth>]
 850
 851         Join to channel/create new channel.  This command is used to
 852         join to a channel.  If the channel does not exist the channel is
 853         created.  If server is normal server this command MUST be sent
 854         to router which will create the channel.  The channel MAY be
 855         protected with passphrase.  If this is the case the passphrase
 856         MUST be sent along the join command.
 857
 858         The name of the <channel> MUST NOT include any spaces (` '),
 859         non-printable characters, commas (`,') or any wildcard characters.
 860
 861         The second argument <Client ID> is the Client ID of the client
 862         which is joining to the client.  When client sends this command
 863         to the server the <Client ID> MUST be the client's own ID.
 864
 865         Cipher to be used to secure the traffic on the channel MAY be
 866         requested by sending the name of the requested <cipher>.  This
 867         is used only if the channel does not exist and is created.  If
 868         the channel already exists the cipher set previously for the
 869         channel will be used to secure the traffic.  The computed MACs
 870         of the channel message are produced by the default HMAC or by
 871         the <hmac> provided for the command.
 872
 873         The <founder auth> is Authentication Payload providing the
 874         authentication for gaining founder privileges on the channel
 875         when joining the channel.  The client may provide this if it
 876         knows that it is the founder of the channel and that the
 877         SILC_CMODE_FOUNDER_AUTH mode is set on the channel.  The server
 878         MUST verify whether the client is able to gain the founder
 879         privileges the same way as the client had given the
 880         SILC_COMMAND_CUMODE command to gain founder privileges.  The
 881         client is still able to join the channel even if the founder
 882         privileges could not be gained.
 883
 884         The server MUST check whether the user is allowed to join to
 885         the requested channel.  Various modes set to the channel affect
 886         the ability of the user to join the channel.  These conditions
 887         are:
 888
 889             o  The user MUST be invited to the channel if the channel
 890                is invite-only channel.
 891
 892             o  The Client ID/nickname/username/host name MUST NOT match
 893                any active bans.
 894
 895             o  The correct passphrase MUST be provided if passphrase
 896                is set to the channel.
 897
 898             o  The user count limit, if set, MUST NOT be reached.
 899
 900         If the client provided correct <founder auth> payload it can
 901         override these conditions, except the condition for the passphrase.
 902         The correct passphrase MUST be provided even if <founder auth>
 903         payload is provided.
 904
 905         Reply messages to the command:
 906
 907         Max Arguments:  14
 908             Arguments:  (1) <Status Payload>        (2) <channel>
 909                         (3) <Channel ID>            (4) <Client ID>
 910                         (5) <channel mode mask>     (6) <created>
 911                         (7) [<Channel Key Payload>] (8) [<ban list>]
 912                         (9) [<invite list>]         (10) [<topic>]
 913                         (11) [<hmac>]               (12) <list count>
 914                         (13) <Client ID list>       (14) <client mode list>
 915
 916         This command replies with the channel name requested by the
 917         client, channel ID of the channel and topic of the channel
 918         if it exists.  The <Client ID> is the Client ID which was joined
 919         to the channel.  It also replies with the channel mode mask
 920         which tells all the modes set on the channel.  If the
 921         channel is created the mode mask is zero (0).  If ban mask
 922         and/or invite list is set they are sent as well.
 923
 924         The <list count>, <Client ID list> and <client mode list> are
 925         the clients currently on the channel and their modes on the
 926         channel.  The <Client ID list> is formed by adding the ID Payloads
 927         one after the other.  The <client mode list> is formed by adding
 928         32 bit MSB first order values one after the other.
 929
 930         Client receives the channel key in the reply message as well
 931         inside <Channel Key Payload>.
 932
 933         Status messages:
 934
 935             SILC_STATUS_OK
 936             SILC_STATUS_ERR_WILDCARDS
 937             SILC_STATUS_ERR_NOT_REGISTERED
 938             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 939             SILC_STATUS_ERR_TOO_MANY_PARAMS
 940             SILC_STATUS_ERR_BAD_PASSWORD
 941             SILC_STATUS_ERR_CHANNEL_IS_FULL
 942             SILC_STATUS_ERR_NOT_INVITED
 943             SILC_STATUS_ERR_BANNED_FROM_CHANNEL
 944             SILC_STATUS_ERR_BAD_CHANNEL
 945             SILC_STATUS_ERR_USER_ON_CHANNEL
 946
 947
 948    15   SILC_COMMAND_MOTD
 949
 950         Max Arguments:  1
 951             Arguments:  (1) <server>
 952
 953         This command is used to query the Message of the Day of the server.
 954
 955         Reply messages to the command:
 956
 957         Max Arguments:  3
 958             Arguments:  (1) <Status Payload>  (2) <Server ID>
 959                         (3) [<motd>]
 960
 961         This command replies with the motd message if it exists.
 962
 963         Status messages:
 964
 965             SILC_STATUS_OK
 966             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
 967             SILC_STATUS_ERR_TOO_MANY_PARAMS
 968             SILC_STATUS_ERR_NOT_REGISTERED
 969             SILC_STATUS_ERR_NO_SUCH_SERVER
 970
 971
 972    16   SILC_COMMAND_UMODE
 973
 974         Max Arguments:  2
 975             Arguments:  (1) <Client ID>  (2) [<client mode mask>]
 976
 977         This command is used by client to set/unset modes for itself.
 978         However, there are some modes that the client MUST NOT set itself,
 979         but they will be set by server.  However, client MAY unset any
 980         mode.  Modes may be masked together ORing them thus having
 981         several modes set.  Client MUST keep its client mode mask
 982         locally so that the mode setting/unsetting would work without
 983         problems.  Client may change only its own modes.
 984
 985         After changing the mode server MUST send the notify type
 986         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
 987
 988         The following client modes are defined:
 989
 990            0x00000000    SILC_UMODE_NONE
 991
 992               No specific mode for client.  This is the initial
 993               setting when new client is created.  The client is
 994               normal client and is present in the network.
 995
 996
 997            0x00000001    SILC_UMODE_SERVER_OPERATOR
 998
 999               Marks the user as server operator.  Client MUST NOT
1000               set this mode itself.  Server sets this mode to the
1001               client when client attains the server operator
1002               privileges by SILC_COMMAND_OPER command.  Client
1003               MAY unset the mode itself.
1004
1005
1006            0x00000002    SILC_UMODE_ROUTER_OPERATOR
1007
1008               Marks the user as router (SILC) operator.  Client
1009               MUST NOT set this mode itself.  Router sets this mode
1010               to the client when client attains the router operator
1011               privileges by SILC_COMMAND_SILCOPER command.  Client
1012               MAY unset the mode itself.
1013
1014
1015            0x00000004    SILC_UMODE_GONE
1016
1017               Marks that the user is not currently present in the
1018               SILC Network.  Client MAY set and unset this mode.
1019
1020
1021            0x00000008    SILC_UMODE_INDISPOSED
1022
1023               Marks that the user is currently indisposed and may
1024               not be able to receive any messages, and that user may
1025               not be present in the network.  Client MAY set and
1026               unset this mode.
1027
1028
1029            0x00000010    SILC_UMODE_BUSY
1030
1031               Marks that the user is currently busy and may not
1032               want to receive any messages, and that user may not
1033               be present in the network.  Client MAY set and unset
1034               this mode.
1035
1036
1037            0x00000020    SILC_UMODE_PAGE
1038
1039               User is not currently present or is unable to receive
1040               messages, and prefers to be paged in some mechanism
1041               if the user needs to be reached.  Client MAY set and
1042               unset this mode.
1043
1044
1045            0x00000040    SILC_UMODE_HYPER
1046
1047               Marks that the user is hyper active and is eager to
1048               receive and send messages.   Client MAY set and unset
1049               this mode.
1050
1051
1052            0x00000080    SILC_UMODE_ROBOT
1053
1054               Marks that the client is actually a robot program.
1055               Client MAY set and unset this mode.
1056
1057
1058            0x00000100    SILC_UMODE_ANONYMOUS
1059
1060               Marks that the client is anonymous client.  Server
1061               that specificly is designed for anonymous services
1062               can set and unset this mode.  Client MUST NOT set or
1063               unset this mode itself.  A client with this mode set
1064               would have the username and the hostname information
1065               scrambled by the server which set this mode.
1066
1067
1068            0x00000200    SILC_UMODE_BLOCK_PRIVMSG
1069
1070               Marks that the client wishes to block private
1071               messages sent to the client, unless the Private
1072               Message Key flag is set in the SILC packet header.
1073               If this mode is set server MUST NOT deliver private
1074               messages to the client without the Private Message
1075               Key flag being set.
1076
1077               A separate service could provide additional filtering
1078               features for accepting private messages from certain
1079               sender.  However, this document does not specify such
1080               service.
1081
1082               The client MAY set and unset this mode.
1083
1084
1085            0x00000400    SILC_UMODE_DETACHED
1086
1087               Marks that the client is detached from the SILC network.
1088               This means that the actual network connection to the
1089               client is lost but the client entry is still valid.  The
1090               detached client can be resumed at a later time.  This
1091               mode MUST NOT be set by client.  It can only be set when
1092               client has issued command SILC_COMMAND_DETACH.  The server
1093               sets this mode.  This mode cannot be unset with this
1094               command.  It is unset when the client is resuming back to
1095               the network and SILC_PACKET_RESUME_CLIENT packet is
1096               received.
1097
1098               This flag MUST NOT be used to determine whether a packet
1099               can be sent to the client or not.  Only the server that
1100               had the original client connection can make the decision
1101               by noticising that the network connection is not active.
1102               In this case the default case is to discard the packet.
1103
1104         If the <client mode mask> was not provided this command merely
1105         returns the mode mask to the client.
1106
1107
1108         Reply messages to the command:
1109
1110         Max Arguments:  2
1111             Arguments:  (1) <Status Payload>  (2) <client mode mask>
1112
1113         This command replies with the changed client mode mask that
1114         the client MUST to keep locally.
1115
1116
1117         Status messages:
1118
1119             SILC_STATUS_OK
1120             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1121             SILC_STATUS_ERR_TOO_MANY_PARAMS
1122             SILC_STATUS_ERR_NOT_REGISTERED
1123             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1124             SILC_STATUS_ERR_BAD_CLIENT_ID
1125             SILC_STATUS_ERR_NOT_YOU
1126             SILC_STATUS_ERR_PERM_DENIED
1127             SILC_STATUS_ERR_UNKNOWN_MODE
1128             SILC_STATUS_ERR_NO_CLIENT_ID
1129
1130
1131    17   SILC_COMMAND_CMODE
1132
1133         Max Arguments:  7
1134             Arguments:  (1) <Channel ID>      (2) [<channel mode mask>]
1135                         (3) [<user limit>]    (4) [<passphrase>]
1136                         (5) [<cipher>]        (6) [<hmac>]
1137                         (7) [<auth payload>]
1138
1139         This command is used by client to set or change channel flags on
1140         a channel.  Channel has several modes that set various properties
1141         of a channel.  Modes may be masked together by ORing them thus
1142         having several modes set.  The <Channel ID> is the ID of the
1143         target channel.  The client changing channel mode MUST be on
1144         the same channel and poses sufficient privileges to be able to
1145         change the mode.
1146
1147         When the mode is changed SILC_NOTIFY_TYPE_CMODE_CHANGE notify
1148         type MUST be distributed to the channel.
1149
1150         The following channel modes are defined:
1151
1152            0x00000000    SILC_CMODE_NONE
1153
1154               No specific mode on channel.  This is the default when
1155               channel is created.  This means that channel is just plain
1156               normal channel.
1157
1158
1159            0x00000001    SILC_CMODE_PRIVATE
1160
1161               Channel is private channel.  Private channels are shown
1162               in the channel list listed with SILC_COMMAND_LIST command
1163               with indication that the channel is private.  Also,
1164               client on private channel will no be detected to be on
1165               the channel as the channel is not shown in the client's
1166               currently joined channel list.  Channel founder and
1167               channel operator MAY set/unset this mode.
1168
1169               Typical implementation would use [+|-]p on user interface
1170               to set/unset this mode.
1171
1172
1173            0x00000002    SILC_CMODE_SECRET
1174
1175               Channel is secret channel.  Secret channels are not shown
1176               in the list listed with SILC_COMMAND_LIST command.  Secret
1177               channels can be considered to be invisible channels.
1178               Channel founder and channel operator MAY set/unset this
1179               mode.
1180
1181               Typical implementation would use [+|-]s on user interface
1182               to set/unset this mode.
1183
1184
1185            0x00000004    SILC_CMODE_PRIVKEY
1186
1187               Channel uses private channel key to protect the traffic
1188               on the channel.  When this mode is set the client will be
1189               responsible to set the key it wants to use to encrypt and
1190               decrypt the traffic on channel.  Server generated channel
1191               keys are not used at all.  This mode provides additional
1192               security as clients on channel may agree to use private
1193               channel key that even servers do not know.  Naturally,
1194               this requires that every client on the channel knows
1195               the key before hand (it is considered to be pre-shared-
1196               key).  The key material is RECOMMENDED to be processed
1197               as stated in the [SILC3] in the section Processing the
1198               Key Material.
1199
1200               As it is local setting it is possible to have several
1201               private channel keys on one channel.  In this case several
1202               clients can talk on same channel but only those clients
1203               that share the key with the message sender will be able
1204               to hear the talking.  Client SHOULD NOT display those
1205               message for the end user that it is not able to decrypt
1206               when this mode is set.
1207
1208               Only channel founder MAY set/unset this mode.  If this
1209               mode is unset the server will distribute new channel
1210               key to all clients on the channel which will be used
1211               thereafter.
1212
1213               Typical implementation would use [+|-]k on user interface
1214               to set/unset this mode.
1215
1216
1217            0x00000008    SILC_CMODE_INVITE
1218
1219               Channel is invite only channel.  Client may join to this
1220               channel only if it is invited to the channel.  Channel
1221               founder and channel operator MAY set/unset this mode.
1222
1223               Typical implementation would use [+|-]i on user interface
1224               to set/unset this mode.
1225
1226
1227            0x00000010    SILC_CMODE_TOPIC
1228
1229               The topic of the channel may only be set by client that
1230               is channel founder or channel operator.  Normal clients
1231               on channel will not be able to set topic when this mode
1232               is set.  Channel founder and channel operator MAY set/
1233               unset this mode.
1234
1235               Typical implementation would use [+|-]t on user interface
1236               to set/unset this mode.
1237
1238
1239            0x00000020    SILC_CMODE_ULIMIT
1240
1241               User limit has been set to the channel.  New clients
1242               may not join to the channel when the limit set is
1243               reached.  Channel founder and channel operator MAY set/
1244               unset the limit.  The <user limit> argument is the
1245               number of limited users.
1246
1247               Typical implementation would use [+|-]l on user interface
1248               to set/unset this mode.
1249
1250
1251            0x00000040    SILC_CMODE_PASSPHRASE
1252
1253               Passphrase has been set to the channel.  Client may
1254               join to the channel only if it is able to provide the
1255               correct passphrase.  Setting passphrases to channel
1256               is entirely safe as all commands are protected in the
1257               SILC network.  Only channel founder MAY set/unset
1258               the passphrase.  The <passphrase> argument is the
1259               set passphrase.
1260
1261               Typical implementation would use [+|-]a on user interface
1262               to set/unset this mode.
1263
1264
1265            0x00000080    SILC_CMODE_CIPHER
1266
1267               Sets specific cipher to be used to protect channel
1268               traffic.  The <cipher> argument is the requested cipher.
1269               When set or unset the server must re-generate new
1270               channel key.  Only channel founder MAY set the cipher of
1271               the channel.  When unset the new key is generated using
1272               default cipher for the channel.
1273
1274               Typical implementation would use [+|-]c on user interface
1275               to set/unset this mode.
1276
1277
1278            0x00000100    SILC_CMODE_HMAC
1279
1280               Sets specific hmac to be used to compute the MACs of the
1281               channel message.  The <hmac> argument is the requested hmac.
1282               Only channel founder may set the hmac of the channel.
1283
1284               Typical implementation would use [+|-]h on user interface
1285               to set/unset this mode.
1286
1287
1288            0x00000200    SILC_CMODE_FOUNDER_AUTH
1289
1290               Channel founder may set this mode to be able to regain
1291               channel founder rights even if the client leaves the
1292               channel.  The <auth payload> is the Authentication Payload
1293               consisting of the authentication method and authentication
1294               data to be used in the authentication.  The server MUST
1295               NOT accept NONE authentication method.  Also, if the
1296               method is public key authentication the server MUST NOT
1297               save the authentication data from the payload as the
1298               data is different on all authentications.  In this case the
1299               server only saves the authentication method.  However,
1300               server MUST verify the sent authentication payload and
1301               set the mode only if the verification was successful.
1302
1303               Note that this mode is effective only in the current server.
1304               The client MUST connect to the same server later to be able
1305               to regain the channel founder rights.  The server MUST save
1306               the public key of the channel founder and use that to identify
1307               the client which is claiming the channel founder rights.
1308               The rights may be claimed by the SILC_CUMODE_FOUNDER
1309               channel user mode using SILC_COMMAND_CUMODE command.  The
1310               set authentication data remains valid as long as the channel
1311               exists or until the founder unsets this mode.
1312
1313               Typical implementation would use [+|-]f on user interface
1314               to set/unset this mode.
1315
1316
1317            0x00000400    SILC_CMODE_SILENCE_USERS
1318
1319               Channel founder may set this mode to silence normal users
1320               on the channel.  Users with operator privileges are not
1321               affected by this mode.  Messages sent by normal users
1322               are dropped by servers when this mode is set.  This mode
1323               can be used to moderate the channel.  Only channel founder
1324               may set/unset this mode.
1325
1326
1327            0x00000800    SILC_CMODE_SILENCE_OPERS
1328
1329               Channel founder may set this mode to silence operators
1330               on the channel.  When used with SILC_CMODE_SILENCE_USERS
1331               mode this can be used to set the channel in state where only
1332               the founder of the channel may send messages to the channel.
1333               Messages sent by operators are dropped by servers when this
1334               mode is set.  Only channel founder may set/unset this mode.
1335
1336
1337         To make the mode system work, client MUST keep the channel mode
1338         mask locally so that the mode setting and unsetting would work
1339         without problems.  The client receives the initial channel mode
1340         mask when it joins to the channel.  When the mode changes on
1341         channel the server MUST distribute the changed channel mode mask
1342         to all clients on the channel by sending the notify type
1343         SILC_NOTIFY_TYPE_CMODE_CHANGE.  The notify type MUST also be sent
1344         to the server's primary router.  If the <channel mode mask> was
1345         not provided this command merely returns the mode mask to the
1346         client.
1347
1348         Reply messages to the command:
1349
1350         Max Arguments:  3
1351             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1352                         (3) <channel mode mask>
1353
1354         This command replies with the changed channel mode mask that
1355         client MUST keep locally.
1356
1357         Status messages:
1358
1359             SILC_STATUS_OK
1360             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1361             SILC_STATUS_ERR_TOO_MANY_PARAMS
1362             SILC_STATUS_ERR_NOT_REGISTERED
1363             SILC_STATUS_ERR_NOT_ON_CHANNEL
1364             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1365             SILC_STATUS_ERR_BAD_CHANNEL_ID
1366             SILC_STATUS_ERR_NO_CHANNEL_ID
1367             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1368             SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1369             SILC_STATUS_ERR_UNKNOWN_MODE
1370             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1371             SILC_STATUS_ERR_AUTH_FAILED
1372
1373
1374    18   SILC_COMMAND_CUMODE
1375
1376         Max Arguments:  4
1377             Arguments:  (1) <Channel ID>    (2) <mode mask>
1378                         (3) <Client ID>     (4) [<auth payload>]
1379
1380         This command is used by client to change channel user modes on
1381         channel.  Users on channel may have some special modes and this
1382         command is used by channel operators to set or change these modes.
1383         The <Channel ID> is the ID of the target channel.  The <mode mask>
1384         is OR'ed mask of modes.  The <Client ID> is the target client.
1385         The client changing channel user modes MUST be on the same channel
1386         as the target client and poses sufficient privileges to be able to
1387         change the mode.
1388
1389         When the mode is changed SILC_NOTIFY_TYPE_CUMODE_CHANGE notify
1390         type is distributed to the channel.
1391
1392         The following channel modes are defined:
1393
1394            0x00000000    SILC_CUMODE_NONE
1395
1396               No specific mode.  This is the normal situation for client.
1397               Also, this is the mode set when removing all modes from
1398               the target client.
1399
1400
1401            0x00000001    SILC_CUMODE_FOUNDER
1402
1403               The client is channel founder of the channel.  Usually this
1404               mode is set only by the server when the channel was created.
1405               However, if the SILC_CMODE_FOUNDER_AUTH channel mode has
1406               been set, the client can claim channel founder privileges
1407               by providing the <auth payload> that the server will use
1408               to authenticate the client.  The public key that server will
1409               use to verify the <auth payload> must the same public key
1410               that was saved when the SILC_CMODE_FOUNDER_AUTH channel
1411               mode was set.  The client MAY remove this mode at any time.
1412
1413
1414            0x00000002    SILC_CUMODE_OPERATOR
1415
1416               Sets channel operator privileges on the channel for a
1417               client on the channel.  Channel founder and channel operator
1418               MAY set/unset this mode.  The client MAY remove this mode
1419               at any time.
1420
1421
1422            0x00000004    SILC_CUMODE_BLOCK_MESSAGES
1423
1424               Marks that the client wishes not to receive any channel
1425               messages sent for the channel.  Client MAY set and unset
1426               this mode to itself.  Client MUST NOT set it to anyone else.
1427               When this mode is set server MUST NOT deliver channel
1428               messages to this client.  Other packets such as channel
1429               key packets are still sent to the client.
1430
1431               A separate service could provide additional filtering
1432               features for accepting channel messages from certain
1433               sender.  However, this document does not specify such
1434               service.
1435
1436
1437         Reply messages to the command:
1438
1439         Max Arguments:  4
1440             Arguments:  (1) <Status Payload>  (2) <channel user mode mask>
1441                         (3) <Channel ID>      (4) <Client ID>
1442
1443         This command replies with the changed channel user mode mask that
1444         client MUST keep locally. The <Channel ID> is the specified
1445         channel.  The <Client ID> is the target client.
1446
1447         Status messages:
1448
1449             SILC_STATUS_OK
1450             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1451             SILC_STATUS_ERR_TOO_MANY_PARAMS
1452             SILC_STATUS_ERR_NOT_REGISTERED
1453             SILC_STATUS_ERR_NOT_ON_CHANNEL
1454             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1455             SILC_STATUS_ERR_BAD_CHANNEL_ID
1456             SILC_STATUS_ERR_NO_CHANNEL_ID
1457             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1458             SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1459             SILC_STATUS_ERR_UNKNOWN_MODE
1460             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1461             SILC_STATUS_ERR_AUTH_FAILED
1462
1463
1464    19   SILC_COMMAND_KICK
1465
1466         Max Arguments:  3
1467             Arguments:  (1) <Channel ID>  (2) <Client ID>
1468                         (3) [<comment>]
1469
1470         This command is used by channel operators to remove a client from
1471         channel.  The <channel> argument is the channel the client to be
1472         removed is on currently.  Note that the "kicker" must be on the same
1473         channel.  If <comment> is provided it will be sent to the removed
1474         client.
1475
1476         After kicking the client the server MUST send the notify type
1477         SILC_NOTIFY_TYPE_KICKED to the channel and to its primary router.
1478         The channel key MUST also be re-generated after kicking, unless
1479         the SILC_CMODE_PRIVKEY mode is set.
1480
1481         Reply messages to the command:
1482
1483         Max Arguments:  1
1484             Arguments:  (1) <Status Payload>
1485
1486         This command replies only with Status Payload.
1487
1488         Status messages:
1489
1490             SILC_STATUS_OK
1491             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1492             SILC_STATUS_ERR_TOO_MANY_PARAMS
1493             SILC_STATUS_ERR_NOT_REGISTERED
1494             SILC_STATUS_ERR_NO_SUCH_CHANNEL
1495             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1496             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1497             SILC_STATUS_ERR_NO_CLIENT_ID
1498
1499
1500    20   SILC_COMMAND_BAN
1501
1502         Max Arguments:  3
1503             Arguments:  (1) <Channel ID>         (2) [<adding client>]
1504                         (3) [<removing client>]
1505
1506         This command is used to manage the ban list of the channel
1507         indicated by the <Channel ID>.  A client that is banned from
1508         channel is no longer able to join the channel.  The client which
1509         is executing this command MUST have at least channel operator
1510         privileges on the channel.
1511
1512         The <adding client> and <removing client> are used to add to and
1513         remove from the ban list.  The format of the <adding client> and
1514         the <removing client> is of following format:
1515
1516             [<nickname>[@<server>]!][<username>]@[<hostname>]
1517
1518         The server MUST send the notify type SILC_NOTIFY_TYPE_BAN to its
1519         primary router after adding to or removing from the ban list.
1520         The wildcards MAY be used with this command.  If adding or removing
1521         from than one clients then the lists are an comma (`,') separated.
1522
1523         If this command is executed without the ban arguments the command
1524         merely replies with the current ban list.
1525
1526
1527         Reply messages to the command:
1528
1529         Max Arguments:  3
1530             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1531                         (3) [<ban list>]
1532
1533         This command replies with the <Channel ID> of the channel and
1534         the current <ban list> of the channel if it exists.
1535
1536         Status messages:
1537
1538             SILC_STATUS_OK
1539             SILC_STATUS_ERR_NOT_REGISTERED
1540             SILC_STATUS_ERR_TOO_MANY_PARAMS
1541             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1542             SILC_STATUS_ERR_NO_CHANNEL_ID
1543             SILC_STATUS_ERR_NOT_ON_CHANNEL
1544             SILC_STATUS_ERR_NO_CHANNEL_PRIV
1545
1546
1547    21   <deprecated command>
1548
1549
1550    22   <deprecated command>
1551
1552
1553    23   SILC_COMMAND_SILCOPER
1554
1555         Max Arguments:  2
1556             Arguments:  (1) <username>  (2) <authentication payload>
1557
1558         This command is used by normal client to obtain router operator
1559         privileges (also known as SILC operator) on the router.  Note
1560         that router operator has privileges that supersedes the server
1561         operator privileges.
1562
1563         The <username> is the username set in the server configurations
1564         as operator.  The <authentication payload> is the data that the
1565         client is authenticated against.  It may be passphrase prompted
1566         for user on client's screen or it may be public key or certificate
1567         authentication data (data signed with private key).  The public
1568         key that router will use to verify the signature found in the
1569         payload should be verified.  It is recommended that the public
1570         key is saved locally in the router and router would not use
1571         any public keys received during the SKE.
1572
1573         Difference between router operator and server operator is that
1574         router operator is able to handle cell level properties while
1575         server operator (even on router server) is able to handle only
1576         local properties, such as, local connections and normal server
1577         administration.  The router operator is also able to use the
1578         SILC_COMMAND_KILL command.
1579
1580         After changing the mode server MUST send the notify type
1581         SILC_NOTIFY_TYPE_UMODE_CHANGE to its primary router.
1582
1583         Reply messages to the command:
1584
1585         Max Arguments:  1
1586             Arguments:  (1) <Status Payload>
1587
1588         This command replies only with Status Payload.
1589
1590         Status messages:
1591
1592             SILC_STATUS_OK
1593             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1594             SILC_STATUS_ERR_TOO_MANY_PARAMS
1595             SILC_STATUS_ERR_NOT_REGISTERED
1596             SILC_STATUS_ERR_AUTH_FAILED
1597
1598
1599    24   SILC_COMMAND_LEAVE
1600
1601         Max Arguments:  1
1602             Arguments:  (1) <Channel ID>
1603
1604         This command is used by client to leave a channel the client is
1605         joined to.
1606
1607         When leaving channel the server MUST send the notify type
1608         SILC_NOTIFY_TYPE_LEAVE to its primary router and to the channel.
1609         The channel key MUST also be re-generated when leaving the channel
1610         and distribute it to all clients still currently on the channel.
1611         The key MUST NOT be re-generated if the SILC_CMODE_PRIVKEY mode
1612         is set.
1613
1614         Reply messages to the command:
1615
1616         Max Arguments:  2
1617             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1618
1619         The <Channel ID> is the ID of left channel.
1620
1621         Status messages:
1622
1623             SILC_STATUS_OK
1624             SILC_STATUS_ERR_NOT_REGISTERED
1625             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1626             SILC_STATUS_ERR_TOO_MANY_PARAMS
1627             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1628             SILC_STATUS_ERR_BAD_CHANNEL_ID
1629             SILC_STATUS_ERR_NO_CHANNEL_ID
1630
1631
1632    25   SILC_COMMAND_USERS
1633
1634         Max Arguments:  2
1635             Arguments:  (1) [<Channel ID>]  (2) [<channel name>]
1636
1637         This command is used to list user names currently on the requested
1638         channel; either the argument <Channel ID> or the <channel name>.
1639         One of these arguments must be present.  The server MUST resolve
1640         the joined clients and reply with a lists of users on the channel
1641         and with list of user modes on the channel.
1642
1643         If the requested channel is a private or secret channel, this
1644         command MUST NOT send the list of users, but error is returned
1645         to the sender, except if the sender is on the channel, or the
1646         sender is server.
1647
1648         Reply messages to the command:
1649
1650         Max Arguments:  5
1651             Arguments:  (1) <Status Payload>  (2) <Channel ID>
1652                         (3) <list count>      (4) <Client ID list>
1653                         (5) <client mode list>
1654
1655         This command replies with the Channel ID of the requested channel
1656         Client ID list of the users on the channel and list of their modes.
1657         The Client ID list has Client ID's of all users in the list.  The
1658         <Client ID list> is formed by adding Client ID's one after another.
1659         The <client mode list> is formed by adding client's user modes on
1660         the channel one after another (4 bytes (32 bits) each).  The <list
1661         count> of length of 4 bytes (32 bits), tells the number of entries
1662         in the lists.  Both lists MUST have equal number of entries.
1663
1664         Status messages:
1665
1666             SILC_STATUS_OK
1667             SILC_STATUS_ERR_NOT_REGISTERED
1668             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1669             SILC_STATUS_ERR_TOO_MANY_PARAMS
1670             SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1671             SILC_STATUS_ERR_BAD_CHANNEL_ID
1672             SILC_STATUS_ERR_NO_CHANNEL_ID
1673             SILC_STATUS_ERR_NOT_ON_CHANNEL
1674
1675
1676    26   SILC_COMMAND_GETKEY
1677
1678         Max Arguments:  1
1679             Arguments:  (1) <ID Payload>
1680
1681         This command is used to fetch the public key of the client or
1682         server indicated by the <ID Payload>.  The public key is fetched
1683         from the server where to the client is connected.
1684
1685         Reply messages to the command:
1686
1687         Max Arguments:  3
1688             Arguments:  (1) <Status Payload>      (2) <ID Payload>
1689                         (3) [<Public Key Payload>]
1690
1691         This command replies with the client's or server's ID and with
1692         the <Public Key Payload>.
1693
1694         Status messages:
1695
1696             SILC_STATUS_OK
1697             SILC_STATUS_ERR_NOT_REGISTERED
1698             SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1699             SILC_STATUS_ERR_TOO_MANY_PARAMS
1700             SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1701             SILC_STATUS_ERR_NO_SUCH_SERVER_ID
1702
1703
1704    27 - 199
1705
1706         Currently undefined commands.
1707
1708
1709    200 - 254
1710
1711         These commands are reserved for private use and will not be defined
1712         in this document.
1713
1714
1715    255  SILC_COMMAND_MAX
1716
1717         Reserved command.  This must not be sent.
1718 .in 3
1719
1720
1721 .ti 0
1722 2.3 SILC Command Status Types
1723
1724 .ti 0
1725 2.3.1 SILC Command Status Payload
1726
1727 Command Status Payload is sent in command reply messages to indicate
1728 the status of the command.  The payload is one of argument in the
1729 command thus this is the data area in Command Argument Payload described
1730 in [SILC2].  The payload is only 2 bytes of length.  The following diagram
1731 represents the Command Status Payload (field is always in MSB order).
1732
1733
1734 .in 21
1735 .nf
1736                      1
1737  0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5
1738 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1739 |     Status    |     Error     |
1740 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
1741 .in 3
1742
1743 .ce
1744 Figure 6:  SILC Command Status Payload
1745
1746
1747 .in 6
1748 o Status (1 byte) - Indicates the status message type,
1749   error, start of list, entry of list or end of list.
1750
1751 o Error (1 byte) - Indicates the error if the Status
1752   field is some list status, which means there are list
1753   of errors.
1754 .in 3
1755
1756 The values in Status and Error fields are set according
1757 the following rules:
1758
1759 .in 6
1760 o If there is single reply and error has not occurred
1761   then Status field includes value SILC_STATUS_OK, and
1762   the Error field MUST be ignored (and set to zero
1763   value).
1764
1765 o If there is single error, then Status field includes
1766   one of the error values, and the Error field MUST be
1767   ignored (and set to zero value).
1768
1769 o If there will be multiple successful command replies
1770   then Status field includes SILC_STATUS_LIST_START,
1771   SILC_STATUS_LIST_ITEM or SILC_STATUS_LIST_END value,
1772   and Error field is set to SILC_STATUS_OK.
1773
1774 o If there are multiple error replies then Status field
1775   includes SILC_STATUS_LIST_START, SILC_STATUS_LIST_ITEM
1776   or SILC_STATUS_LIST_END value, and the Error field
1777   includes the error value.
1778 .in 3
1779
1780 This way it is possible to send single successful or
1781 single error reply, but also multiple successful and
1782 multiple error replies.  Note that it is possible to
1783 send both list of successful replies and list of error
1784 replies at the same time, however in this case the
1785 list of error replies MUST be sent after the successful
1786 replies.  This way the recipient may ignore the multiple
1787 errors if it wishes to do so.
1788
1789 All Status messages are described in the next section.
1790
1791
1792 .ti 0
1793 2.3.2 SILC Command Status List
1794
1795 Command Status messages are returned in the command reply messages
1796 to indicate whether the command were executed without errors.  If error
1797 has occurred the status indicates which error occurred.  Status payload
1798 only sends numeric reply about the status.  Receiver of the payload must
1799 convert the numeric values into human readable error messages.  The
1800 list of status messages below has an example human readable error
1801 messages that client may display for the user.
1802
1803 List of all defined command status messages following.
1804
1805 .in 0
1806    Generic status messages:
1807
1808    0    SILC_STATUS_OK
1809
1810         Ok status.  Everything went Ok.  The status payload maybe
1811         safely ignored in this case.
1812
1813    1    SILC_STATUS_LIST_START
1814
1815         Start of the list.  There will be several command replies and
1816         this reply is the start of the list.
1817
1818    2    SILC_STATUS_LIST_ITEM
1819
1820         Item in the list.  This is one of the item in the list but not the
1821         first or last one.
1822
1823    3    SILC_STATUS_LIST_END
1824
1825         End of the list.  There were several command replies and this
1826         reply is the last of the list.  There won't be other replies
1827         belonging to this list after this one.
1828
1829    4 - 9
1830
1831         Currently undefined and has been reserved for the future.
1832
1833
1834    Error status message:
1835
1836
1837
1838    10   SILC_STATUS_ERR_NO_SUCH_NICK
1839
1840         "No such nickname".  Requested nickname does not exist.
1841
1842    11   SILC_STATUS_ERR_NO_SUCH_CHANNEL
1843
1844         "No such channel".  Requested channel name does not exist.
1845
1846    12   SILC_STATUS_ERR_NO_SUCH_SERVER
1847
1848         "No such server".  Requested server name does not exist.
1849
1850    13   SILC_STATUS_ERR_TOO_MANY_TARGETS
1851
1852         "Duplicate recipients. No message delivered".  Message were
1853         tried to be sent to recipient which has several occurrences in
1854         the recipient list.
1855
1856    14   SILC_STATUS_ERR_NO_RECIPIENT
1857
1858         "No recipient given".  Command required recipient which was
1859         not provided.
1860
1861    15   SILC_STATUS_ERR_UNKNOWN_COMMAND
1862
1863         "Unknown command".  Command sent to server is unknown by the
1864         server.
1865
1866    16   SILC_STATUS_ERR_WILDCARDS
1867
1868         "Wildcards cannot be used".  Wildcards were provided but they
1869         weren't permitted.
1870
1871    17   SILC_STATUS_ERR_NO_CLIENT_ID
1872
1873         "No Client ID given".  Client ID were expected as command
1874         parameter but were not found.
1875
1876    18   SILC_STATUS_ERR_NO_CHANNEL_ID
1877
1878         "No Channel ID given".  Channel ID were expected as command
1879         parameter but were not found.
1880
1881    19   SILC_STATUS_ERR_NO_SERVER_ID
1882
1883         "No Serve ID given".  Server ID were expected as command
1884         parameter but were not found.
1885
1886    20   SILC_STATUS_ERR_BAD_CLIENT_ID
1887
1888         "Bad Client ID".  Client ID provided were erroneous.
1889
1890    21   SILC_STATUS_ERR_BAD_CHANNEL_ID
1891
1892         "Bad Channel ID".  Channel ID provided were erroneous.
1893
1894    22   SILC_STATUS_ERR_NO_SUCH_CLIENT_ID
1895
1896         "No such Client ID".  Client ID provided does not exist.
1897
1898    23   SILC_STATUS_ERR_NO_SUCH_CHANNEL_ID
1899
1900         "No such Channel ID".  Channel ID provided does not exist.
1901
1902    24   SILC_STATUS_ERR_NICKNAME_IN_USE
1903
1904         "Nickname already exists".  Nickname created could not be
1905         registered because number of same nicknames were already set to
1906         maximum.  This is not expected to happen in real life but is
1907         possible to occur.
1908
1909    25   SILC_STATUS_ERR_NOT_ON_CHANNEL
1910
1911         "You are not on that channel".  The command were specified for
1912         channel user is not currently on.
1913
1914    26   SILC_STATUS_ERR_USER_NOT_ON_CHANNEL
1915
1916         "They are not on channel".  The requested target client is not
1917         on requested channel.
1918
1919    27   SILC_STATUS_ERR_USER_ON_CHANNEL
1920
1921         "User already on channel".  User were invited on channel they
1922         already are on.
1923
1924    28   SILC_STATUS_ERR_NOT_REGISTERED
1925
1926         "You have not registered".  User executed command that requires
1927         the client to be registered on the server before it may be
1928         executed.
1929
1930    29   SILC_STATUS_ERR_NOT_ENOUGH_PARAMS
1931
1932         "Not enough parameters".  Command requires more parameters
1933         than provided.
1934
1935    30   SILC_STATUS_ERR_TOO_MANY_PARAMS
1936
1937         "Too many parameters".  Too many parameters were provided
1938         for the command.
1939
1940    31   SILC_STATUS_ERR_PERM_DENIED
1941
1942         "Permission denied".  Generic permission denied error status
1943         to indicate disallowed access.
1944
1945    32   SILC_STATUS_ERR_BANNED_FROM_SERVER
1946
1947         "You are banned from this server".  The client tried to register
1948         on server that has explicitly denied this host to connect.
1949
1950    33   SILC_STATUS_ERR_BAD_PASSWORD
1951
1952         "Cannot join channel. Incorrect password".  Password provided for
1953         channel were not accepted.
1954
1955    34   SILC_STATUS_ERR_CHANNEL_IS_FULL
1956
1957         "Cannot join channel. Channel is full".  The channel is full
1958         and client cannot be joined to it.
1959
1960    35   SILC_STATUS_ERR_NOT_INVITED
1961
1962         "Cannot join channel. You have not been invited".  The channel
1963         is invite only channel and client has not been invited.
1964
1965    36   SILC_STATUS_ERR_BANNED_FROM_CHANNEL
1966
1967         "Cannot join channel. You have been banned".  The client has
1968         been banned from the channel.
1969
1970    37   SILC_STATUS_ERR_UNKNOWN_MODE
1971
1972         "Unknown mode".  Mode provided by the client were unknown to
1973         the server.
1974
1975    38   SILC_STATUS_ERR_NOT_YOU
1976
1977         "Cannot change mode for other users".  User tried to change
1978         someone else's mode.
1979
1980    39   SILC_STATUS_ERR_NO_CHANNEL_PRIV
1981
1982         "Permission denied. You are not channel operator".  Command may
1983         be executed only by channel operator.
1984
1985    40   SILC_STATUS_ERR_NO_CHANNEL_FOPRIV
1986
1987         "Permission denied. You are not channel founder".  Command may
1988         be executed only by channel operator.
1989
1990    41   SILC_STATUS_ERR_NO_SERVER_PRIV
1991
1992         "Permission denied. You are not server operator".  Command may
1993         be executed only by server operator.
1994
1995    42   SILC_STATUS_ERR_NO_ROUTER_PRIV
1996
1997         "Permission denied. You are not SILC operator".  Command may be
1998         executed only by router (SILC) operator.
1999
2000    43   SILC_STATUS_ERR_BAD_NICKNAME
2001
2002         "Bad nickname".  Nickname requested contained illegal characters
2003         or were malformed.
2004
2005    44   SILC_STATUS_ERR_BAD_CHANNEL
2006
2007         "Bad channel name".  Channel requested contained illegal characters
2008         or were malformed.
2009
2010    45   SILC_STATUS_ERR_AUTH_FAILED
2011
2012         "Authentication failed".  The authentication data sent as
2013         argument were wrong and thus authentication failed.
2014
2015    46   SILC_STATUS_ERR_UNKOWN_ALGORITHM
2016
2017         "The algorithm was not supported."  The server does not support the
2018         requested algorithm.
2019
2020    47   SILC_STATUS_ERR_NO_SUCH_SERVER_ID
2021
2022         "No such Server ID".  Server ID provided does not exist.
2023
2024 .in 3
2025
2026
2027 .ti 0
2028 3 Security Considerations
2029
2030 Security is central to the design of this protocol, and these security
2031 considerations permeate the specification.  Common security considerations
2032 such as keeping private keys truly private and using adequate lengths for
2033 symmetric and asymmetric keys must be followed in order to maintain the
2034 security of this protocol.
2035
2036
2037 .ti 0
2038 4 References
2039
2040 [SILC1]      Riikonen, P., "Secure Internet Live Conferencing (SILC),
2041              Protocol Specification", Internet Draft, April 2001.
2042
2043 [SILC2]      Riikonen, P., "SILC Packet Protocol", Internet Draft,
2044              April 2001.
2045
2046 [SILC3]      Riikonen, P., "SILC Key Exchange and Authentication
2047              Protocols", Internet Draft, April 2001.
2048
2049 [IRC]        Oikarinen, J., and Reed D., "Internet Relay Chat Protocol",
2050              RFC 1459, May 1993.
2051
2052 [IRC-ARCH]   Kalt, C., "Internet Relay Chat: Architecture", RFC 2810,
2053              April 2000.
2054
2055 [IRC-CHAN]   Kalt, C., "Internet Relay Chat: Channel Management", RFC
2056              2811, April 2000.
2057
2058 [IRC-CLIENT] Kalt, C., "Internet Relay Chat: Client Protocol", RFC
2059              2812, April 2000.
2060
2061 [IRC-SERVER] Kalt, C., "Internet Relay Chat: Server Protocol", RFC
2062              2813, April 2000.
2063
2064 [SSH-TRANS]  Ylonen, T., et al, "SSH Transport Layer Protocol",
2065              Internet Draft.
2066
2067 [PGP]        Callas, J., et al, "OpenPGP Message Format", RFC 2440,
2068              November 1998.
2069
2070 [SPKI]       Ellison C., et al, "SPKI Certificate Theory", RFC 2693,
2071              September 1999.
2072
2073 [PKIX-Part1] Housley, R., et al, "Internet X.509 Public Key
2074              Infrastructure, Certificate and CRL Profile", RFC 2459,
2075              January 1999.
2076
2077 [Schneier]   Schneier, B., "Applied Cryptography Second Edition",
2078              John Wiley & Sons, New York, NY, 1996.
2079
2080 [Menezes]    Menezes, A., et al, "Handbook of Applied Cryptography",
2081              CRC Press 1997.
2082
2083 [OAKLEY]     Orman, H., "The OAKLEY Key Determination Protocol",
2084              RFC 2412, November 1998.
2085
2086 [ISAKMP]     Maughan D., et al, "Internet Security Association and
2087              Key Management Protocol (ISAKMP)", RFC 2408, November
2088              1998.
2089
2090 [IKE]        Harkins D., and Carrel D., "The Internet Key Exchange
2091              (IKE)", RFC 2409, November 1998.
2092
2093 [HMAC]       Krawczyk, H., "HMAC: Keyed-Hashing for Message
2094              Authentication", RFC 2104, February 1997.
2095
2096 [PKCS1]      Kalinski, B., and Staddon, J., "PKCS #1 RSA Cryptography
2097              Specifications, Version 2.0", RFC 2437, October 1998.
2098
2099 [RFC2119]    Bradner, S., "Key Words for use in RFCs to Indicate
2100              Requirement Levels", BCP 14, RFC 2119, March 1997.
2101
2102 [RFC2279]    Yergeau, F., "UTF-8, a transformation format of ISO
2103              10646", RFC 2279, January 1998.
2104
2105
2106
2107
2108
2109 .ti 0
2110 5 Author's Address
2111
2112 .nf
2113 Pekka Riikonen
2114 Snellmanninkatu 34 A 15
2115 70100 Kuopio
2116 Finland
2117
2118 EMail: priikone@iki.fi
2119
2120 This Internet-Draft expires XXX
2121