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