lib/silccore/silccommand.h

   1 /*
   2
   3   silccommand.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2001 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; either version 2 of the License, or
  12   (at your option) any later version.
  13
  14   This program is distributed in the hope that it will be useful,
  15   but WITHOUT ANY WARRANTY; without even the implied warranty of
  16   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  17   GNU General Public License for more details.
  18
  19 */
  20
  21 /****h* silccore/SILC Command Interface
  22  *
  23  * DESCRIPTION
  24  *
  25  * Implementation of the Command Payload. The Command Payload is used to
  26  * send commands and also command replies usually between client and
  27  * server.
  28  *
  29  ***/
  30
  31 #ifndef SILCCOMMAND_H
  32 #define SILCCOMMAND_H
  33
  34 /****f* silccore/SilcCommandAPI/SilcCommandCb
  35  *
  36  * SYNOPSIS
  37  *
  38  *    typedef void (*SilcCommandCb)(void *context, void *context2);
  39  *
  40  * DESCRIPTION
  41  *
  42  *    Command function callback. The actual command function pointer.
  43  *    This is generic command callback that the application may choose to
  44  *    use with its command routines.  However, none of the generic
  45  *    routines depend on this callback so application may freely define
  46  *    their own command callback if desired.
  47  *
  48  ***/
  49 typedef void (*SilcCommandCb)(void *context, void *context2);
  50
  51 /****s* silccore/SilcCommandAPI/SilcCommandPayload
  52  *
  53  * NAME
  54  *
  55  *    typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
  56  *
  57  * DESCRIPTION
  58  *
  59  *    This context is the actual Command Payload and is allocated
  60  *    by silc_command_payload_parse and given as argument usually to
  61  *    all silc_command_payload_* functions.  It is freed by the
  62  *    silc_command_payload_free function.
  63  *
  64  ***/
  65 typedef struct SilcCommandPayloadStruct *SilcCommandPayload;
  66
  67 /****d* silccore/SilcCommandAPI/SilcCommandFlags
  68  *
  69  * NAME
  70  *
  71  *    typedef enum { ... } SilcCommandFlags;
  72  *
  73  * DESCRIPTION
  74  *
  75  *    Command flags that set how the commands behave on different
  76  *    situations. These can be OR'es together to set multiple flags.
  77  *    The application is resoponsible of implementing the behaviour
  78  *    of these flags. These are here just to define generic flags.
  79  *    The server usually makes use of these flags.
  80  *
  81  * SOURCE
  82  */
  83 typedef enum {
  84   SILC_CF_NONE           = 0,
  85
  86   /* Command may only be used once per (about) 2 seconds. Bursts up
  87      to 5 commands are allowed though. */
  88   SILC_CF_LAG            = (1L << 1),
  89
  90   /* Command may only be used once per (about) 2 seconds. No bursts
  91      are allowed at all. */
  92   SILC_CF_LAG_STRICT     = (1L << 2),
  93
  94   /* Command is available for registered connections (connections
  95      whose ID has been created. */
  96   SILC_CF_REG            = (1L << 3),
  97
  98   /* Command is available only for server operators */
  99   SILC_CF_OPER           = (1L << 4),
 100
 101   /* Command is available only for SILC (router) operators. If this
 102      is set SILC_CF_OPER is not necessary to be set. */
 103   SILC_CF_SILC_OPER      = (1L << 5),
 104
 105 } SilcCommandFlag;
 106 /***/
 107
 108 /****d* silccore/SilcCommandAPI/SilcCommand
 109  *
 110  * NAME
 111  *
 112  *    typedef unsigned char SilcCommand;
 113  *
 114  * DESCRIPTION
 115  *
 116  *    The SilcCommand type definition and the commands. The commands
 117  *    listed here are the official SILC Commands and they have client
 118  *    and server counterparts.
 119  *
 120  * SOURCE
 121  */
 122 typedef unsigned char SilcCommand;
 123
 124 /* All SILC commands. These are commands that have client and server
 125    counterparts. */
 126 #define SILC_COMMAND_NONE               0
 127 #define SILC_COMMAND_WHOIS              1
 128 #define SILC_COMMAND_WHOWAS             2
 129 #define SILC_COMMAND_IDENTIFY           3
 130 #define SILC_COMMAND_NICK               4
 131 #define SILC_COMMAND_LIST               5
 132 #define SILC_COMMAND_TOPIC              6
 133 #define SILC_COMMAND_INVITE             7
 134 #define SILC_COMMAND_QUIT               8
 135 #define SILC_COMMAND_KILL               9
 136 #define SILC_COMMAND_INFO               10
 137 #define SILC_COMMAND_STATS              11
 138 #define SILC_COMMAND_PING               12
 139 #define SILC_COMMAND_OPER               13
 140 #define SILC_COMMAND_JOIN               14
 141 #define SILC_COMMAND_MOTD               15
 142 #define SILC_COMMAND_UMODE              16
 143 #define SILC_COMMAND_CMODE              17
 144 #define SILC_COMMAND_CUMODE             18
 145 #define SILC_COMMAND_KICK               19
 146 #define SILC_COMMAND_BAN                20
 147 #define SILC_COMMAND_DETACH             21
 148 #define SILC_COMMAND_SILCOPER           23
 149 #define SILC_COMMAND_LEAVE              24
 150 #define SILC_COMMAND_USERS              25
 151 #define SILC_COMMAND_GETKEY             26
 152
 153 /* Private range start */
 154 #define SILC_COMMAND_PRIV_CONNECT       200
 155 #define SILC_COMMAND_PRIV_CLOSE         201
 156 #define SILC_COMMAND_PRIV_SHUTDOWN      202
 157
 158 /* Reserved */
 159 #define SILC_COMMAND_RESERVED           255
 160 /***/
 161
 162 /* Prototypes */
 163
 164 /****f* silccore/SilcCommandAPI/silc_command_payload_parse
 165  *
 166  * SYNOPSIS
 167  *
 168  *    SilcCommandPayload
 169  *    silc_command_payload_parse(const unsigned char *payload,
 170  *                               SilcUInt32 payload_len);
 171  *
 172  * DESCRIPTION
 173  *
 174  *    Parses command payload returning new command payload structure. The
 175  *    `buffer' is the raw payload.
 176  *
 177  ***/
 178 SilcCommandPayload silc_command_payload_parse(const unsigned char *payload,
 179                                               SilcUInt32 payload_len);
 180
 181 /****f* silccore/SilcCommandAPI/silc_command_payload_encode
 182  *
 183  * SYNOPSIS
 184  *
 185  *    SilcBuffer silc_command_payload_encode(SilcCommand cmd,
 186  *                                           SilcUInt32 argc,
 187  *                                           unsigned char **argv,
 188  *                                           SilcUInt32 *argv_lens,
 189  *                                           SilcUInt32 *argv_types,
 190  *                                           SilcUInt16 ident);
 191  *
 192  * DESCRIPTION
 193  *
 194  *     Encodes Command Payload returning it to SilcBuffer.
 195  *
 196  ***/
 197 SilcBuffer silc_command_payload_encode(SilcCommand cmd,
 198                                        SilcUInt32 argc,
 199                                        unsigned char **argv,
 200                                        SilcUInt32 *argv_lens,
 201                                        SilcUInt32 *argv_types,
 202                                        SilcUInt16 ident);
 203
 204 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_payload
 205  *
 206  * SYNOPSIS
 207  *
 208  *    SilcBuffer
 209  *    silc_command_payload_encode_payload(SilcCommandPayload payload);
 210  *
 211  * DESCRIPTION
 212  *
 213  *    Same as silc_command_payload_encode but encodes the buffer from
 214  *    SilcCommandPayload structure instead of raw data.
 215  *
 216  ***/
 217 SilcBuffer silc_command_payload_encode_payload(SilcCommandPayload payload);
 218
 219 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_va
 220  *
 221  * SYNOPSIS
 222  *
 223  *    SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
 224  *                                              SilcUInt16 ident,
 225  *                                              SilcUInt32 argc, ...);
 226  *
 227  * DESCRIPTION
 228  *
 229  *    Encodes Command payload with variable argument list. The arguments
 230  *    must be: SilcUInt32, unsigned char *, unsigned int, ... One
 231  *    {SilcUInt32, unsigned char * and unsigned int} forms one argument,
 232  *    thus `argc' in case when sending one {SilcUInt32, unsigned char *
 233  *    and SilcUInt32} equals one (1) and when sending two of those it
 234  *    equals two (2), and so on. This has to be preserved or bad things
 235  *    will happen. The variable arguments is: {type, data, data_len}.
 236  *
 237  ***/
 238 SilcBuffer silc_command_payload_encode_va(SilcCommand cmd,
 239                                           SilcUInt16 ident,
 240                                           SilcUInt32 argc, ...);
 241
 242 /****f* silccore/SilcCommandAPI/silc_command_payload_encode_vap
 243  *
 244  * SYNOPSIS
 245  *
 246  *    SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
 247  *                                               SilcUInt16 ident,
 248  *                                               SilcUInt32 argc, va_list ap);
 249  *
 250  * DESCRIPTION
 251  *
 252  *    This is equivalent to the silc_command_payload_encode_va except
 253  *    takes the va_list as argument.
 254  *
 255  ***/
 256 SilcBuffer silc_command_payload_encode_vap(SilcCommand cmd,
 257                                            SilcUInt16 ident,
 258                                            SilcUInt32 argc, va_list ap);
 259
 260 /****f* silccore/SilcCommandAPI/silc_command_reply_payload_encode_va
 261  *
 262  * SYNOPSIS
 263  *
 264  *    SilcBuffer
 265  *    silc_command_reply_payload_encode_va(SilcCommand cmd,
 266  *                                         SilcStatus status,
 267  *                                         SilcStatus error,
 268  *                                         SilcUInt16 ident,
 269  *                                         SilcUInt32 argc, ...);
 270  *
 271  * DESCRIPTION
 272  *
 273  *    Same as silc_command_payload_encode_va except that this is used to
 274  *    encode strictly command reply packets.  The `argc' must not count
 275  *    `status' and `error' as arguments.  The `status' includes the
 276  *    command reply status.  If single reply will be sent then it includes
 277  *    SILC_STATUS_OK if error did not occur.  It includes an error value
 278  *    if error did occur.  In this case `error' field is ignored.  If
 279  *    there will be multiple successful command replies then the `status'
 280  *    includes a list value and `error' is ignored.  If there will
 281  *    multiple error replies the `status' includes a list value, and
 282  *    the `error' includes an error value.  Thus, the `error' value is
 283  *    specified only if there will be list of errors.
 284  *
 285  * NOTES
 286  *
 287  *    Protocol defines that it is possible to send both list of successful
 288  *    and list of error replies at the same time, as long as the error
 289  *    replies are sent after the successful replies.
 290  *
 291  ***/
 292 SilcBuffer
 293 silc_command_reply_payload_encode_va(SilcCommand cmd,
 294                                      SilcStatus status,
 295                                      SilcStatus error,
 296                                      SilcUInt16 ident,
 297                                      SilcUInt32 argc, ...);
 298
 299 /****f* silccore/SilcCommandAPI/silc_command_reply_payload_encode_vap
 300  *
 301  * SYNOPSIS
 302  *
 303  *    SilcBuffer
 304  *    silc_command_reply_payload_encode_vap(SilcCommand cmd,
 305  *                                          SilcStatus status,
 306  *                                          SilcStatus error,
 307  *                                          SilcUInt16 ident, SilcUInt32 argc,
 308  *                                          va_list ap);
 309  *
 310  * DESCRIPTION
 311  *
 312  *    This is equivalent to the silc_command_reply_payload_encode_va except
 313  *    takes the va_list as argument.
 314  *
 315  ***/
 316 SilcBuffer
 317 silc_command_reply_payload_encode_vap(SilcCommand cmd,
 318                                       SilcStatus status,
 319                                       SilcStatus error,
 320                                       SilcUInt16 ident, SilcUInt32 argc,
 321                                       va_list ap);
 322
 323 /****f* silccore/SilcCommandAPI/silc_command_free
 324  *
 325  * SYNOPSIS
 326  *
 327  *    void silc_command_payload_free(SilcCommandPayload payload);
 328  *
 329  * DESCRIPTION
 330  *
 331  *    Frees the Command Payload and all data in it.
 332  *
 333  ***/
 334 void silc_command_payload_free(SilcCommandPayload payload);
 335
 336 /****f* silccore/SilcCommandAPI/silc_command_get
 337  *
 338  * SYNOPSIS
 339  *
 340  *    SilcCommand silc_command_get(SilcCommandPayload payload);
 341  *
 342  * DESCRIPTION
 343  *
 344  *    Return the command from the payload.
 345  *
 346  ***/
 347 SilcCommand silc_command_get(SilcCommandPayload payload);
 348
 349 /****f* silccore/SilcCommandAPI/silc_command_get_args
 350  *
 351  * SYNOPSIS
 352  *
 353  *    SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
 354  *
 355  * DESCRIPTION
 356  *
 357  *    Return the Arguments Payload containing the arguments from the
 358  *    Command Payload. The caller must not free it.
 359  *
 360  ***/
 361 SilcArgumentPayload silc_command_get_args(SilcCommandPayload payload);
 362
 363 /****f* silccore/SilcCommandAPI/silc_command_get_ident
 364  *
 365  * SYNOPSIS
 366  *
 367  *    SilcUInt16 silc_command_get_ident(SilcCommandPayload payload);
 368  *
 369  * DESCRIPTION
 370  *
 371  *    Return the command identifier from the payload. The identifier can
 372  *    be used to identify which command reply belongs to which command.
 373  *    The client sets the identifier to the payload and server must return
 374  *    the same identifier in the command reply.
 375  *
 376  ***/
 377 SilcUInt16 silc_command_get_ident(SilcCommandPayload payload);
 378
 379 /****f* silccore/SilcCommandAPI/silc_command_get_status
 380  *
 381  * SYNOPSIS
 382  *
 383  *    bool silc_command_get_status(SilcCommandPayload payload,
 384  *                                 SilcStatus *status,
 385  *                                 SilcStatus *error);
 386  *
 387  * DESCRIPTION
 388  *
 389  *    This function returns the command reply status into `status' and
 390  *    error status, if error occurred into the `error'.  The function
 391  *    returns TRUE if command reply status is not error, and FALSE if
 392  *    error occurred.  In this case the `error' will include the actual
 393  *    error status.  The `status' can be in this case some list value
 394  *    which indicates that there will be list of errors.
 395  *
 396  ***/
 397 bool silc_command_get_status(SilcCommandPayload payload,
 398                              SilcStatus *status,
 399                              SilcStatus *error);
 400
 401 /****f* silccore/SilcCommandAPI/silc_command_set_ident
 402  *
 403  * SYNOPSIS
 404  *
 405  *    void silc_command_set_ident(SilcCommandPayload payload,
 406  *                                SilcUInt16 ident);
 407  *
 408  * DESCRIPTION
 409  *
 410  *    Function to set identifier to already allocated Command Payload. Command
 411  *    payloads are frequentlly resent in SILC and thusly this makes it easy
 412  *    to set the identifier without encoding new Command Payload.
 413  *
 414  ***/
 415 void silc_command_set_ident(SilcCommandPayload payload, SilcUInt16 ident);
 416
 417 /****f* silccore/SilcCommandAPI/silc_command_set_command
 418  *
 419  * SYNOPSIS
 420  *
 421  *    void silc_command_set_command(SilcCommandPayload payload,
 422  *                                  SilcCommand command);
 423  *
 424  * DESCRIPTION
 425  *
 426  *    Function to set the command to already allocated Command Payload. This
 427  *    makes it easy to change the command in the payload without encoding new
 428  *    Command Payload.
 429  *
 430  ***/
 431 void silc_command_set_command(SilcCommandPayload payload, SilcCommand command);
 432
 433 #endif