lib/silccore/silcpacket.h

   1 /*
   2
   3   silcpacket.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2006 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; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 /****h* silccore/Packet Protocol Interface
  21  *
  22  * DESCRIPTION
  23  *
  24  * The SILC secure binary packet protocol interface, provides interface for
  25  * sending and receiving SILC packets.  The interface provides a packet
  26  * engine, that can be used to receive packets from packet streams, and
  27  * routines for sending all kinds of SILC packets.
  28  *
  29  * The packet engine and packet stream are thread safe.  They can be safely
  30  * used in multi threaded environment.
  31  *
  32  ***/
  33
  34 #ifndef SILCPACKET_H
  35 #define SILCPACKET_H
  36
  37 /* XXX many of these could go to silcpacket_i.h */
  38
  39 /* Maximum packet length */
  40 #define SILC_PACKET_MAX_LEN 0xffff
  41
  42 /* Maximum length of ID */
  43 #define SILC_PACKET_MAX_ID_LEN 28
  44
  45 /****d* silccore/SilcPacketAPI/SilcPacketType
  46  *
  47  * NAME
  48  *
  49  *    typedef SilcUInt8 SilcPacketType;
  50  *
  51  * DESCRIPTION
  52  *
  53  *    SILC packet type definition and all the packet types.
  54  *
  55  * SOURCE
  56  */
  57 typedef SilcUInt8 SilcPacketType;
  58
  59 /* SILC Packet types. */
  60 #define SILC_PACKET_DISCONNECT           1       /* Disconnection */
  61 #define SILC_PACKET_SUCCESS              2       /* Success */
  62 #define SILC_PACKET_FAILURE              3       /* Failure */
  63 #define SILC_PACKET_REJECT               4       /* Rejected */
  64 #define SILC_PACKET_NOTIFY               5       /* Notify message */
  65 #define SILC_PACKET_ERROR                6       /* Error message */
  66 #define SILC_PACKET_CHANNEL_MESSAGE      7       /* Message for channel */
  67 #define SILC_PACKET_CHANNEL_KEY          8       /* Key of the channel */
  68 #define SILC_PACKET_PRIVATE_MESSAGE      9       /* Private message */
  69 #define SILC_PACKET_PRIVATE_MESSAGE_KEY  10      /* Private message key*/
  70 #define SILC_PACKET_COMMAND              11      /* Command */
  71 #define SILC_PACKET_COMMAND_REPLY        12      /* Reply to a command */
  72 #define SILC_PACKET_KEY_EXCHANGE         13      /* Start of KE */
  73 #define SILC_PACKET_KEY_EXCHANGE_1       14      /* KE1 */
  74 #define SILC_PACKET_KEY_EXCHANGE_2       15      /* KE2 */
  75 #define SILC_PACKET_CONNECTION_AUTH_REQUEST 16   /* Request of auth meth */
  76 #define SILC_PACKET_CONNECTION_AUTH      17      /* Connectinon auth */
  77 #define SILC_PACKET_NEW_ID               18      /* Sending new ID */
  78 #define SILC_PACKET_NEW_CLIENT           19      /* Client registering */
  79 #define SILC_PACKET_NEW_SERVER           20      /* Server registering */
  80 #define SILC_PACKET_NEW_CHANNEL          21      /* Channel registering */
  81 #define SILC_PACKET_REKEY                22      /* Re-key start */
  82 #define SILC_PACKET_REKEY_DONE           23      /* Re-key done */
  83 #define SILC_PACKET_HEARTBEAT            24      /* Heartbeat */
  84 #define SILC_PACKET_KEY_AGREEMENT        25      /* Key Agreement request */
  85 #define SILC_PACKET_RESUME_ROUTER        26      /* Backup router resume */
  86 #define SILC_PACKET_FTP                  27      /* File Transfer */
  87 #define SILC_PACKET_RESUME_CLIENT        28      /* Client resume */
  88
  89 #define SILC_PACKET_PRIVATE              200     /* Private range start  */
  90 #define SILC_PACKET_MAX                  255     /* RESERVED */
  91
  92 #define SILC_PACKET_NONE                 0       /* RESERVED */
  93 #define SILC_PACKET_ANY                  0
  94 /***/
  95
  96 /****d* silccore/SilcPacketAPI/SilcPacketFlags
  97  *
  98  * NAME
  99  *
 100  *    typedef SilcUInt8 SilcPacketFlags;
 101  *
 102  * DESCRIPTION
 103  *
 104  *    SILC packet flags type definition and all the packet flags.
 105  *
 106  * SOURCE
 107  */
 108 typedef SilcUInt8 SilcPacketFlags;
 109
 110 /* All defined packet flags */
 111 #define SILC_PACKET_FLAG_NONE             0x00    /* No flags */
 112 #define SILC_PACKET_FLAG_PRIVMSG_KEY      0x01    /* Private message key */
 113 #define SILC_PACKET_FLAG_LIST             0x02    /* Packet is a list */
 114 #define SILC_PACKET_FLAG_BROADCAST        0x04    /* Packet is a broadcast */
 115 #define SILC_PACKET_FLAG_COMPRESSED       0x08    /* Payload is compressed */
 116
 117 /* Impelemntation specific flags */
 118 #define SILC_PACKET_FLAG_LONG_PAD         0x10    /* Use maximum padding */
 119 /***/
 120
 121 /****s* silccore/SilcPacketAPI/SilcPacketEngine
 122  *
 123  * NAME
 124  *
 125  *    typedef struct SilcPacketEngineStruct *SilcPacketEngine;
 126  *
 127  * DESCRIPTION
 128  *
 129  *    The packet engine context, allocated by silc_packet_engine_start.
 130  *    The engine is destroyed with silc_packet_engine_stop.
 131  *
 132  ***/
 133 typedef struct SilcPacketEngineStruct *SilcPacketEngine;
 134
 135 /****s* silccore/SilcPacketAPI/SilcPacketStream
 136  *
 137  * NAME
 138  *
 139  *    typedef struct SilcPacketStreamStruct *SilcPacketStream;
 140  *
 141  * DESCRIPTION
 142  *
 143  *    The packet stream context, allocated by silc_packet_stream_create.
 144  *    The stream is destroyed with silc_packet_stream_destroy.
 145  *
 146  ***/
 147 typedef struct SilcPacketStreamStruct *SilcPacketStream;
 148
 149 /****s* silccore/SilcPacketAPI/SilcPacket
 150  *
 151  * NAME
 152  *
 153  *    typedef struct SilcPacketStruct *SilcPacket;
 154  *
 155  * DESCRIPTION
 156  *
 157  *    The SilcPacket is returned by the packet engine in the SilcPacketReceive
 158  *    callback.  The application can parse the data payload from the
 159  *    SilcPacket.  Also packet type, flags, and sender and destination
 160  *    IDs are available.  The application must free the packet with the
 161  *    silc_packet_free function if it takes it in for processing.
 162  *
 163  *    The `buffer' field contains the parsed packet payload and the start
 164  *    of the data area will point to the start of the packet payload.
 165  *
 166  *    The list pointer `next' can be used by the application to put the
 167  *    packet context in a list during processing, if needed.
 168  *
 169  * SOURCE
 170  */
 171 typedef struct SilcPacketStruct {
 172   struct SilcPacketStruct *next;     /* List pointer, application may set */
 173   SilcPacketStream stream;           /* Packet stream this packet is from */
 174   SilcBufferStruct buffer;           /* Packet data payload */
 175   unsigned char *src_id;             /* Source ID */
 176   unsigned char *dst_id;             /* Destination ID */
 177   unsigned int src_id_len  : 6;      /* Source ID length */
 178   unsigned int src_id_type : 2;      /* Source ID type */
 179   unsigned int dst_id_len  : 6;      /* Destination ID length */
 180   unsigned int dst_id_type : 2;      /* Destination ID type */
 181   SilcPacketType type;               /* Packet type */
 182   SilcPacketFlags flags;             /* Packet flags */
 183 } *SilcPacket;
 184 /***/
 185
 186 /****d* silcutil/SilcPacketAPI/SilcPacketError
 187  *
 188  * NAME
 189  *
 190  *    typedef enum { ... } SilcPacketError
 191  *
 192  * DESCRIPTION
 193  *
 194  *    Packet errors.  This is returned in the error callback.  If application
 195  *    needs the actual lower level stream error, it needs to retrieve it
 196  *    from the actual stream.  It can retrieve the underlaying stream from
 197  *    the packet stream by calling silc_packet_stream_get_stream function.
 198  *
 199  * SOURCE
 200  */
 201 typedef enum {
 202   SILC_PACKET_ERR_READ,                  /* Error while reading */
 203   SILC_PACKET_ERR_WRITE,                 /* Error while writing */
 204   SILC_PACKET_ERR_MAC_FAILED,            /* Packet MAC check failed */
 205   SILC_PACKET_ERR_DECRYPTION_FAILED,     /* Packet decryption failed */
 206   SILC_PACKET_ERR_UNKNOWN_SID,           /* Unknown SID (with IV included) */
 207   SILC_PACKET_ERR_MALFORMED,             /* Packet is malformed */
 208   SILC_PACKET_ERR_NO_MEMORY,             /* System out of memory */
 209 } SilcPacketError;
 210 /***/
 211
 212 /****f* silccore/SilcPacketAPI/SilcPacketReceiveCb
 213  *
 214  * SYNOPSIS
 215  *
 216  *    typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
 217  *                                            SilcPacketStream stream,
 218  *                                            SilcPacket packet,
 219  *                                            void *callback_context,
 220  *                                            void *stream_context);
 221  *
 222  * DESCRIPTION
 223  *
 224  *    The packet receive callback is called by the packet engine when a new
 225  *    SILC Packet has arrived.  The application must free the returned
 226  *    SilcPacket with silc_packet_free if it takes the packet in for
 227  *    processing.  This callback is set in the SilcPacketCallbacks structure.
 228  *    The `callback_context' is the context set as argument in the
 229  *    silc_packet_engine_start function.  The `stream_context' is stream
 230  *    specific context that was set by calling silc_packet_set_context.
 231  *
 232  *    If the application takes the received packet `packet' into processing
 233  *    TRUE must be returned.  If FALSE is returned the packet engine will
 234  *    pass the packet to other packet processor, if one has been linked
 235  *    to the stream with silc_packet_stream_link function.  If no extra
 236  *    processor is linked the packet is dropped.
 237  *
 238  * EXAMPLE
 239  *
 240  *    SilcBool
 241  *    silc_foo_packet_receive_cb(SilcPacketEngine engine,
 242  *                               SilcPacketStream stream, SilcPacket packet,
 243  *                               void *callback_context, void *stream_context)
 244  *    {
 245  *      Application ctx = callback_context;
 246  *
 247  *      // If we're not up yet, let's not process the packet
 248  *      if (ctx->initialized == FALSE)
 249  *        return FALSE;
 250  *
 251  *      // Process the incoming packet...
 252  *      ...
 253  *
 254  *      // It's our packet now, no one else will get it
 255  *      return TRUE;
 256  *    }
 257  *
 258  ***/
 259 typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
 260                                         SilcPacketStream stream,
 261                                         SilcPacket packet,
 262                                         void *callback_context,
 263                                         void *stream_context);
 264
 265 /****f* silccore/SilcPacketAPI/SilcPacketEosCb
 266  *
 267  * SYNOPSIS
 268  *
 269  *    typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
 270  *                                    SilcPacketStream stream,
 271  *                                    void *callback_context,
 272  *                                    void *stream_context);
 273  *
 274  * DESCRIPTION
 275  *
 276  *    The End Of Stream (EOS) callback, that is called by the packet engine
 277  *    when the underlaying stream has ended.  No more data can be sent to
 278  *    the stream or read from it.  The `stream' must be destroyed by
 279  *    calling the silc_packet_stream_destroy.  This callback is set in the
 280  *    SilcPacketCallbacks structure.
 281  *
 282  ***/
 283 typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
 284                                 SilcPacketStream stream,
 285                                 void *callback_context,
 286                                 void *stream_context);
 287
 288 /****f* silccore/SilcPacketAPI/SilcPacketErrorCb
 289  *
 290  * SYNOPSIS
 291  *
 292  *    typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
 293  *                                      SilcPacketStream stream,
 294  *                                      SilcPacketError error,
 295  *                                      void *callback_context,
 296  *                                      void *stream_context);
 297  *
 298  * DESCRIPTION
 299  *
 300  *    The error callback that is called by the packet engine if an error
 301  *    occurs.  The `error' will indicate the error.  This callback is set
 302  *    in the SilcPacketCallbacks structure.
 303  *
 304  ***/
 305 typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
 306                                   SilcPacketStream stream,
 307                                   SilcPacketError error,
 308                                   void *callback_context,
 309                                   void *stream_context);
 310
 311 /****s* silccore/SilcPacketAPI/SilcPacketStream
 312  *
 313  * NAME
 314  *
 315  *    typedef struct SilcPacketStreamStruct *SilcPacketStream;
 316  *
 317  * DESCRIPTION
 318  *
 319  *    This structure is sent as argument to the silc_packet_engine_start
 320  *    function to set the callback functions for the packet engine.  The
 321  *    packet engine will call the callbacks when necessary.  Application
 322  *    must always be provided for the packet engine.
 323  *
 324  * SOURCE
 325  */
 326 typedef struct {
 327   SilcPacketReceiveCb packet_receive;    /* Called when packet is received */
 328   SilcPacketEosCb eos;                   /* Called on end of stream */
 329   SilcPacketErrorCb error;               /* Called on an error */
 330 } SilcPacketCallbacks;
 331 /***/
 332
 333 /* Prototypes */
 334
 335 /****f* silccore/SilcPacketAPI/silc_packet_engine_start
 336  *
 337  * SYNOPSIS
 338  *
 339  *    SilcPacketEngine
 340  *    silc_packet_engine_start(SilcRng rng, SilcBool router,
 341  *                             SilcPacketCallbacks *callbacks,
 342  *                             void *callback_context);
 343  *
 344  * DESCRIPTION
 345  *
 346  *    Create new packet engine for processing incoming and outgoing packets.
 347  *    If `router' is  TRUE then the application is considered to be router
 348  *    server, and certain packets are handled differently.  Client and normal
 349  *    server must set it to FALSE.  The `callbacks' is a SilcPacketCallbacks
 350  *    structure provided by the caller which includes the callbacks that is
 351  *    called when for example packet is received, or end of stream is called.
 352  *
 353  * NOTES
 354  *
 355  *    The packet engine is thread safe.  You can use one packet engine in
 356  *    multi threaded application.
 357  *
 358  ***/
 359 SilcPacketEngine
 360 silc_packet_engine_start(SilcRng rng, SilcBool router,
 361                          SilcPacketCallbacks *callbacks,
 362                          void *callback_context);
 363
 364 /****f* silccore/SilcPacketAPI/silc_packet_engine_stop
 365  *
 366  * SYNOPSIS
 367  *
 368  *    void silc_packet_engine_stop(SilcPacketEngine engine);
 369  *
 370  * DESCRIPTION
 371  *
 372  *    Stop the packet engine.  No new packets can be sent or received after
 373  *    calling this, and the `engine' will become invalid.
 374  *
 375  ***/
 376 void silc_packet_engine_stop(SilcPacketEngine engine);
 377
 378 /****f* silccore/SilcPacketAPI/silc_packet_stream_create
 379  *
 380  * SYNOPSIS
 381  *
 382  *    SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
 383  *                                               SilcSchedule schedule,
 384  *                                               SilcStream stream);
 385  *
 386  * DESCRIPTION
 387  *
 388  *    Create new packet stream and use the `stream' as underlaying stream.
 389  *    Usually the `stream' would be a socket stream, but it can be any
 390  *    stream.  After this function returns, packets can immediately be
 391  *    sent to or received from the stream.
 392  *
 393  * NOTES
 394  *
 395  *    SilcPacketStream cannot be used with silc_stream_* routines (such as
 396  *    silc_stream_read and silc_stream_write) because of its special nature.
 397  *    Use the silc_packet_send and the silc_packet_send_ext to send packets.
 398  *    To read packets you will receive the packet receive callback from
 399  *    packet engine.  Destroy the stream with silc_packet_stream_destroy.
 400  *
 401  *    The SilcPacketStream is thread safe.  Same context can be safely used
 402  *    in multi threaded environment.
 403  *
 404  ***/
 405 SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
 406                                            SilcSchedule schedule,
 407                                            SilcStream stream);
 408
 409 /****f* silccore/SilcPacketAPI/silc_packet_stream_destroy
 410  *
 411  * SYNOPSIS
 412  *
 413  *    void silc_packet_stream_destroy(SilcPacketStream stream);
 414  *
 415  * DESCRIPTION
 416  *
 417  *    Destroy packet stream and the underlaying stream.  This will also
 418  *    send end of stream to the underlaying stream.
 419  *
 420  ***/
 421 void silc_packet_stream_destroy(SilcPacketStream stream);
 422
 423 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_router
 424  *
 425  * SYNOPSIS
 426  *
 427  *    void silc_packet_stream_set_router(SilcPacketStream stream);
 428  *
 429  * DESCRIPTION
 430  *
 431  *    When called sets the stream indicates by `stream' as SILC router
 432  *    connection stream.  This causes that certain packets are handled
 433  *    differently.  This must be called for router connection streams and
 434  *    must not be called for any other stream.
 435  *
 436  ***/
 437 void silc_packet_stream_set_router(SilcPacketStream stream);
 438
 439 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_iv_included
 440  *
 441  * SYNOPSIS
 442  *
 443  *    void silc_packet_stream_set_iv_included(SilcPacketStream stream);
 444  *
 445  * DESCRIPTION
 446  *
 447  *    Sets an IV Included property for the stream indicated by `stream'.
 448  *    This means that the IV used in the encryption will be included in
 449  *    the resulted ciphertext.  This makes it possible to send and receive
 450  *    packets on unreliable network transport protocol, such as UDP/IP.
 451  *    This must be called if the underlaying stream in the `stream' is UDP
 452  *    stream.
 453  *
 454  *    When this is set to the stream the silc_packet_set_sid must be called
 455  *    to set new Security ID.  The Security ID will be included with the IV
 456  *    in the ciphertext.
 457  *
 458  ***/
 459 void silc_packet_stream_set_iv_included(SilcPacketStream stream);
 460
 461 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_stream
 462  *
 463  * SYNOPSIS
 464  *
 465  *    void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
 466  *                                       SilcStream stream,
 467  *                                       SilcSchedule schedule);
 468  *
 469  * DESCRIPTION
 470  *
 471  *    This function may be used to change the underlaying stream in the
 472  *    packet stream indicated by `packet_stream'.  Note that the old
 473  *    stream will not be used after calling this function.  The caller is
 474  *    responsible destroying the old stream.
 475  *
 476  ***/
 477 void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
 478                                    SilcStream stream,
 479                                    SilcSchedule schedule);
 480
 481 /****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream
 482  *
 483  * SYNOPSIS
 484  *
 485  *    SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
 486  *
 487  * DESCRIPTION
 488  *
 489  *    Returns the actual stream that is associated with the packet stream
 490  *    `stream'.  The caller must not free the returned stream.  The returned
 491  *    stream is the same pointer that was set for silc_packet_stream_create.
 492  *    This function could be used for example when an error callback is
 493  *    called by the packet engine to retrieve the actual lower level error
 494  *    from the stream.
 495  *
 496  ***/
 497 SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
 498
 499 /****f* silccore/SilcPacketAPI/silc_packet_stream_link
 500  *
 501  * SYNOPSIS
 502  *
 503  *    SilcBool silc_packet_stream_link(SilcPacketStream stream,
 504  *                                     SilcPacketCallbacks *callbacks,
 505  *                                     void *callback_context,
 506  *                                     int priority, ...);
 507  *
 508  * DESCRIPTION
 509  *
 510  *    Links the packet processing callbacks indicated by `callbacks' into
 511  *    the packet stream indicated by `stream' with priority `priority' for
 512  *    the packet types given in the variable argument list.  This function
 513  *    can be used to link to the packet stream for specific packet types
 514  *    and receive them in the specified callbacks.  This way, a third party,
 515  *    for example some library may attach itself into the packet stream
 516  *    and receive and process certain packets.  The variable argument
 517  *    list is ended with -1.  To link to receive all packets use
 518  *    SILC_PACKET_ANY.
 519  *
 520  *    The default packet processing callbacks given as argument to the
 521  *    silc_packet_engine_start has the priority 0.  Any priority higher
 522  *    than 0 will then take precedence over the default callbacks.  Any
 523  *    priority lower than 0 (negative value) will be processed after the
 524  *    default callbacks.
 525  *
 526  *    Note that setting only the 'packet_receive' callback in the `callbacks'
 527  *    is required.
 528  *
 529  * EXAMPLE
 530  *
 531  *    // Link to this packet stream, with high priority, for
 532  *    // SILC_PACKET_CONNECTION_AUTH and SILC_PACKET_CONNECTION_AUTH_REQUEST
 533  *    // packets. We don't care about other packets.
 534  *    silc_packet_stream_link(stream, our_callbacks, our_context,
 535  *                            1000000, SILC_PACKET_CONNECTION_AUTH,
 536  *                            SILC_PACKET_CONNECTION_AUTH_REQUEST, -1);
 537  *
 538  ***/
 539 SilcBool silc_packet_stream_link(SilcPacketStream stream,
 540                                  SilcPacketCallbacks *callbacks,
 541                                  void *callback_context,
 542                                  int priority, ...);
 543
 544 /****f* silccore/SilcPacketAPI/silc_packet_stream_unlink
 545  *
 546  * SYNOPSIS
 547  *
 548  *    void silc_packet_stream_unlink(SilcPacketStream stream,
 549  *                                   SilcPacketCallbacks *callbacks,
 550  *                                   void *callback_context);
 551  *
 552  * DESCRIPTION
 553  *
 554  *    Unlinks the `callbacks' with `callback_context' from the packet stream
 555  *    indicated by `stream'.  This function must be called for the callbacks
 556  *    that was linked to `stream' when they are not needed anymore.
 557  *
 558  ***/
 559 void silc_packet_stream_unlink(SilcPacketStream stream,
 560                                SilcPacketCallbacks *callbacks,
 561                                void *callback_context);
 562
 563 /****f* silccore/SilcPacketAPI/silc_packet_stream_ref
 564  *
 565  * SYNOPSIS
 566  *
 567  *    void silc_packet_stream_ref(SilcPacketStream stream);
 568  *
 569  * DESCRIPTION
 570  *
 571  *    Increase reference counter for the stream indicated by `stream'.  This
 572  *    can be used to take a reference for the stream.  To unreference the
 573  *    stream call silc_packet_stream_unref function.
 574  *
 575  ***/
 576 void silc_packet_stream_ref(SilcPacketStream stream);
 577
 578 /****f* silccore/SilcPacketAPI/silc_packet_stream_unref
 579  *
 580  * SYNOPSIS
 581  *
 582  *    void silc_packet_stream_unref(SilcPacketStream stream);
 583  *
 584  * DESCRIPTION
 585  *
 586  *    Decrease reference counter for the stream indicated by `stream'.  If
 587  *    the counter hits zero the stream will be destroyed automatically.
 588  *
 589  ***/
 590 void silc_packet_stream_unref(SilcPacketStream stream);
 591
 592 /****f* silccore/SilcPacketAPI/silc_packet_get_engine
 593  *
 594  * SYNOPSIS
 595  *
 596  *    SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
 597  *
 598  * DESCRIPTION
 599  *
 600  *    Returns the packet engine from the `stream'.
 601  *
 602  ***/
 603 SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
 604
 605 /****f* silccore/SilcPacketAPI/silc_packet_set_context
 606  *
 607  * SYNOPSIS
 608  *
 609  *    void silc_packet_set_context(SilcPacketStream stream,
 610  *                                 void *stream_context);
 611  *
 612  * DESCRIPTION
 613  *
 614  *    Sets a stream specific context to the stream.  The context will
 615  *    be delivered to all callback functions, and it can be retrieved by
 616  *    calling silc_packet_get_context function as well.  Note that this is
 617  *    separate packet stream specific context, and not the same as
 618  *    `callback_context' in silc_packet_engine_start.  Both will be delivered
 619  *    to the callbacks, and this context as the `stream_context' argument.
 620  *
 621  ***/
 622 void silc_packet_set_context(SilcPacketStream stream, void *stream_context);
 623
 624 /****f* silccore/SilcPacketAPI/silc_packet_get_context
 625  *
 626  * SYNOPSIS
 627  *
 628  *    void *silc_packet_get_context(SilcPacketStream stream);
 629  *
 630  * DESCRIPTION
 631  *
 632  *    Returns the current set application context, or NULL if none is set.
 633  *
 634  ***/
 635 void *silc_packet_get_context(SilcPacketStream stream);
 636
 637 /****f* silccore/SilcPacketAPI/silc_packet_set_ciphers
 638  *
 639  * SYNOPSIS
 640  *
 641  *    void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send,
 642  *                                 SilcCipher receive);
 643  *
 644  * DESCRIPTION
 645  *
 646  *    Set ciphers to be used to encrypt sent packets, and decrypt received
 647  *    packets.  This can be called multiple times to change the ciphers.
 648  *    In this case if old cipher is set it will be freed.  If ciphers are
 649  *    not set packets will not be encrypted or decrypted.
 650  *
 651  ***/
 652 void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send,
 653                              SilcCipher receive);
 654
 655 /****f* silccore/SilcPacketAPI/silc_packet_get_ciphers
 656  *
 657  * SYNOPSIS
 658  *
 659  *    SilcBool silc_packet_get_ciphers(SilcPacketStream stream,
 660  *                                     SilcCipher *send,
 661  *                                     SilcCipher *receive);
 662  *
 663  * DESCRIPTION
 664  *
 665  *    Returns the pointers of current ciphers from the `stream'.  Returns
 666  *    FALSE if ciphers are not set.
 667  *
 668  ***/
 669 SilcBool silc_packet_get_ciphers(SilcPacketStream stream, SilcCipher *send,
 670                                  SilcCipher *receive);
 671
 672 /****f* silccore/SilcPacketAPI/silc_packet_set_hmacs
 673  *
 674  * SYNOPSIS
 675  *
 676  *    void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send,
 677  *                               SilcHmac receive);
 678  *
 679  * DESCRIPTION
 680  *
 681  *    Set HMACs to be used to create MACs for sent packets and to check
 682  *    MAC for received packets.  This can be called multiple times to change
 683  *    the HMACs.  In this case if old HMAC is set it will be freed.  If
 684  *    HMACs are not set MACs are not generated or verified for packets.
 685  *
 686  ***/
 687 void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send,
 688                            SilcHmac receive);
 689
 690 /****f* silccore/SilcPacketAPI/silc_packet_get_hmacs
 691  *
 692  * SYNOPSIS
 693  *
 694  *    SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send,
 695  *                                   SilcHmac *receive);
 696  *
 697  * DESCRIPTION
 698  *
 699  *    Returns the pointers of current HMACs from the `stream'.  Returns
 700  *    FALSE if HMACs are not set.
 701  *
 702  ***/
 703 SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send,
 704                                SilcHmac *receive);
 705
 706 /****f* silccore/SilcPacketAPI/silc_packet_set_ids
 707  *
 708  * SYNOPSIS
 709  *
 710  *    SilcBool silc_packet_set_ids(SilcPacketStream stream,
 711  *                                 SilcIdType src_id_type, const void *src_id
 712  *                                 SilcIdType dst_id_type, const void *dst_id);
 713  *
 714  * DESCRIPTION
 715  *
 716  *    Set the source ID and destinaion ID to be used when sending packets to
 717  *    this packet stream.  The IDs to be used for a packet stream can be
 718  *    overridden when sending packets.  However, if the IDs do not ever change
 719  *    for the packet stream it is recommended they are set using this function.
 720  *    In this case they can be omitted when sending packets to the stream.
 721  *    It is also possible to set only source or destination ID.
 722  *
 723  ***/
 724 SilcBool silc_packet_set_ids(SilcPacketStream stream,
 725                              SilcIdType src_id_type, const void *src_id,
 726                              SilcIdType dst_id_type, const void *dst_id);
 727
 728 /****f* silccore/SilcPacketAPI/silc_packet_set_sid
 729  *
 730  * SYNOPSIS
 731  *
 732  *    SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
 733  *
 734  * DESCRIPTION
 735  *
 736  *    Sets new Security ID to the packet stream indicated by `stream'.  This
 737  *    is called only if the IV Included property was set to the stream
 738  *    by calling silc_packet_stream_set_iv_included.  This function sets
 739  *    new Security ID to the stream which is then included in the ciphertext
 740  *    of a packet.  The `sid' must be 0 when it is set for the very first
 741  *    time and must be increased by one after each rekey.  This function must
 742  *    be called every time new keys are added to the stream after a rekey.
 743  *
 744  *    If this function is called when the IV Included property has not been
 745  *    set to the stream the `sid' will be ignored.  Returns FALSE if the
 746  *    IV Included has not been set, TRUE otherwise.
 747  *
 748  ***/
 749 SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
 750
 751 /****f* silccore/SilcPacketAPI/silc_packet_send
 752  *
 753  * SYNOPSIS
 754  *
 755  *    SilcBool silc_packet_send(SilcPacketStream stream,
 756  *                              SilcPacketType type, SilcPacketFlags flags,
 757  *                              const unsigned char *data,
 758  *                              SilcUInt32 data_len);
 759  *
 760  * DESCRIPTION
 761  *
 762  *    Send `data' of length of `data_len' to the packet stream indicated by
 763  *    `stream'.  If ciphers and HMACs were set using silc_packet_set_ciphers
 764  *    and silc_packet_set_hmacs the packet will be encrypted and MAC will be
 765  *    computed for it.  If silc_packet_set_ids was used to set source and
 766  *    destination ID for the packet stream those IDs are used in the
 767  *    packet.  If IDs have not been set and they need to be provided then
 768  *    silc_packet_send_ext function should be used.  Otherwise, the packet
 769  *    will not have IDs set at all.  Returns FALSE if packet could not be
 770  *    sent.
 771  *
 772  ***/
 773 SilcBool silc_packet_send(SilcPacketStream stream,
 774                           SilcPacketType type, SilcPacketFlags flags,
 775                           const unsigned char *data, SilcUInt32 data_len);
 776
 777 /****f* silccore/SilcPacketAPI/silc_packet_send_ext
 778  *
 779  * SYNOPSIS
 780  *
 781  *    SilcBool
 782  *    silc_packet_send_ext(SilcPacketStream stream,
 783  *                         SilcPacketType type, SilcPacketFlags flags,
 784  *                         SilcIdType src_id_type, void *srd_id,
 785  *                         SilcIdType dst_id_type, void *dst_id,
 786  *                         const unsigned char *data, SilcUInt32 data_len,
 787  *                         SilcCipher cipher, SilcHmac hmac);
 788  *
 789  * DESCRIPTION
 790  *
 791  *    Same as silc_packet_send but with this function different sending
 792  *    parameters can be sent as argument.  This function can be used to
 793  *    set specific IDs, cipher and HMAC to be used in packet sending,
 794  *    instead of the ones saved in the `stream'.  If any of the extra
 795  *    pointers are NULL, default values set to the stream will apply.
 796  *
 797  ***/
 798 SilcBool silc_packet_send_ext(SilcPacketStream stream,
 799                               SilcPacketType type, SilcPacketFlags flags,
 800                               SilcIdType src_id_type, void *src_id,
 801                               SilcIdType dst_id_type, void *dst_id,
 802                               const unsigned char *data, SilcUInt32 data_len,
 803                               SilcCipher cipher, SilcHmac hmac);
 804
 805 /****f* silccore/SilcPacketAPI/silc_packet_send_va
 806  *
 807  * SYNOPSIS
 808  *
 809  *    SilcBool silc_packet_send_va(SilcPacketStream stream,
 810  *                                 SilcPacketType type,
 811  *                                 SilcPacketFlags flags, ...);
 812  *
 813  * DESCRIPTION
 814  *
 815  *    Same as silc_packet_send but takes the data in as variable argument
 816  *    formatted buffer (see silcbuffmt.h).  The arguments must be ended
 817  *    with SILC_STR_END.  Returns FALSE if packet could not be sent or
 818  *    the buffer could not be formatted.
 819  *
 820  * EXAMPLE
 821  *
 822  *    // Send NEW_CLIENT packet
 823  *    silc_packet_send_va(stream, SILC_PACKET_NEW_CLIENT, 0,
 824  *                        SILC_STR_UI_SHORT(username_len),
 825  *                        SILC_STR_DATA(username, username_len),
 826  *                        SILC_STR_UI_SHORT(realname_len),
 827  *                        SILC_STR_DATA(realname, realname_len),
 828  *                        SILC_STR_END);
 829  *
 830  ***/
 831 SilcBool silc_packet_send_va(SilcPacketStream stream,
 832                              SilcPacketType type, SilcPacketFlags flags, ...);
 833
 834 /****f* silccore/SilcPacketAPI/silc_packet_send_va_ext
 835  *
 836  * SYNOPSIS
 837  *
 838  *    SilcBool
 839  *    silc_packet_send_va_ext(SilcPacketStream stream,
 840  *                            SilcPacketType type, SilcPacketFlags flags,
 841  *                            SilcIdType src_id_type, void *srd_id,
 842  *                            SilcIdType dst_id_type, void *dst_id,
 843  *                            SilcCipher cipher, SilcHmac hmac, ...);
 844  *
 845  * DESCRIPTION
 846  *
 847  *    Same as silc_packet_send_va but with this function different sending
 848  *    parameters can be sent as argument.  This function can be used to
 849  *    set specific IDs, cipher and HMAC to be used in packet sending,
 850  *    instead of the ones saved in the `stream'.  If any of the extra
 851  *    pointers are NULL, default values set to the stream will apply.
 852  *
 853  ***/
 854 SilcBool silc_packet_send_va_ext(SilcPacketStream stream,
 855                                  SilcPacketType type, SilcPacketFlags flags,
 856                                  SilcIdType src_id_type, void *src_id,
 857                                  SilcIdType dst_id_type, void *dst_id,
 858                                  SilcCipher cipher, SilcHmac hmac, ...);
 859
 860 /****f* silccore/SilcPacketAPI/silc_packet_wait
 861  *
 862  * SYNOPSIS
 863  *
 864  *    void *silc_packet_wait_init(SilcPacketStream stream, ...);
 865  *
 866  * DESCRIPTION
 867  *
 868  *    Initializes a packet waiter for the packet stream `stream' and
 869  *    for the variable argument list of packet types.  The function
 870  *    silc_packet_wait can be used to block the thread until a packet
 871  *    has been received.  This function is used to initialize the waiting
 872  *    and to give the list of packet types that caller wish to receive.
 873  *    The variable argument list must end with -1.  To receive all
 874  *    packets use SILC_PACKET_ANY.  Returns a context that must be given
 875  *    to the silc_packet_wait function as argument.  Returns NULL on
 876  *    error.  To uninitialize the waiting call silc_packet_wait_uninit.
 877  *
 878  * NOTES
 879  *
 880  *    Note that packets may be available immediately after calling this
 881  *    function and they will be buffered, until silc_packet_wait is called.
 882  *
 883  * EXAMPLE
 884  *
 885  *    void *waiter;
 886  *
 887  *    // Will wait for private message packets
 888  *    waiter = silc_packet_wait_init(stream,
 889  *                                   SILC_PACKET_PRIVATE_MESSAGE, -1);
 890  *
 891  *
 892  ***/
 893 void *silc_packet_wait_init(SilcPacketStream stream, ...);
 894
 895 /****f* silccore/SilcPacketAPI/silc_packet_wait
 896  *
 897  * SYNOPSIS
 898  *
 899  *    void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
 900  *
 901  * DESCRIPTION
 902  *
 903  *    Uninitializes the waiting context.  This may be called also from
 904  *    another thread while other thread is waiting for packets.  This will
 905  *    inform the waiting thread to stop waiting.
 906  *
 907  ***/
 908 void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
 909
 910 /****f* silccore/SilcPacketAPI/silc_packet_wait
 911  *
 912  * SYNOPSIS
 913  *
 914  *    int silc_packet_wait(void *waiter, int timeout,
 915  *                         SilcPacket *return_packet)
 916  *
 917  * DESCRIPTION
 918  *
 919  *    A special function that can be used to wait for a packet to arrive.
 920  *    This function will block the calling process or thread until either
 921  *    a packet is received into the `return_packet' pointer or the specified
 922  *    timeout value `timeout', which is in milliseconds, will expire.  If
 923  *    the timeout is 0, no timeout exist.  Before calling this function the
 924  *    silc_packet_wait_init must be called.  The caller is responsible for
 925  *    freeing the returned packet with silc_packet_free.
 926  *
 927  *    This function can be used for example from a thread that wants to
 928  *    block until SILC packet has been received.
 929  *
 930  *    Returns 1 when packet was received, 0 if timeout occurred and -1 if
 931  *    error occurred.
 932  *
 933  * EXAMPLE
 934  *
 935  *    static int foo_read_data(FooContext c)
 936  *    {
 937  *      SilcPacket packet;
 938  *      void *waiter;
 939  *      ...
 940  *
 941  *      // Will wait for private message packets
 942  *      if (c->initialized == FALSE) {
 943  *        waiter = silc_packet_wait_init(stream,
 944  *                                       SILC_PACKET_PRIVATE_MESSAGE, -1);
 945  *        c->initialized = TRUE;
 946  *      }
 947  *
 948  *      ...
 949  *      // Wait here until private message packet is received
 950  *      if ((silc_packet_wait(waiter, 0, &packet)) < 0)
 951  *        return -1;
 952  *
 953  *      ... process packet ...
 954  *
 955  *      return 1;
 956  *    }
 957  *
 958  ***/
 959 int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet);
 960
 961 /****f* silccore/SilcPacketAPI/silc_packet_free
 962  *
 963  * SYNOPSIS
 964  *
 965  *    void silc_packet_free(SilcPacket packet);
 966  *
 967  * DESCRIPTION
 968  *
 969  *    This function is used to free the SilcPacket pointer that application
 970  *    receives in the SilcPacketReceive callback.  Application must free
 971  *    the packet if it takes it in to processing.
 972  *
 973  ***/
 974 void silc_packet_free(SilcPacket packet);
 975
 976 #endif /* SILCPACKET_H */