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