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 list pointer `next' can be used by the application to put the
 164  *    packet context in a list during processing, if needed.
 165  *
 166  * SOURCE
 167  */
 168 typedef struct SilcPacketStruct {
 169   struct SilcPacketStruct *next;     /* List pointer, application may set */
 170   SilcPacketStream stream;           /* Packet stream this packet is from */
 171   SilcBufferStruct buffer;           /* Packet data payload */
 172   unsigned char *src_id;             /* Source ID */
 173   unsigned char *dst_id;             /* Destination ID */
 174   unsigned int src_id_len  : 6;      /* Source ID length */
 175   unsigned int src_id_type : 2;      /* Source ID type */
 176   unsigned int dst_id_len  : 6;      /* Destination ID length */
 177   unsigned int dst_id_type : 2;      /* Destination ID type */
 178   SilcPacketType type;               /* Packet type */
 179   SilcPacketFlags flags;             /* Packet flags */
 180 } *SilcPacket;
 181 /***/
 182
 183 /****d* silcutil/SilcPacketAPI/SilcPacketError
 184  *
 185  * NAME
 186  *
 187  *    typedef enum { ... } SilcPacketError
 188  *
 189  * DESCRIPTION
 190  *
 191  *    Packet errors.  This is returned in the error callback.  If application
 192  *    needs the actual lower level stream error, it needs to retrieve it
 193  *    from the actual stream.  It can retrieve the underlaying stream from
 194  *    the packet stream by calling silc_packet_stream_get_stream function.
 195  *
 196  * SOURCE
 197  */
 198 typedef enum {
 199   SILC_PACKET_ERR_READ,                  /* Error while reading */
 200   SILC_PACKET_ERR_WRITE,                 /* Error while writing */
 201   SILC_PACKET_ERR_MAC_FAILED,            /* Packet MAC check failed */
 202   SILC_PACKET_ERR_DECRYPTION_FAILED,     /* Packet decryption failed */
 203   SILC_PACKET_ERR_MALFORMED,             /* Packet is malformed */
 204   SILC_PACKET_ERR_NO_MEMORY,             /* System out of memory */
 205 } SilcPacketError;
 206 /***/
 207
 208 /****f* silccore/SilcPacketAPI/SilcPacketReceiveCb
 209  *
 210  * SYNOPSIS
 211  *
 212  *    typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
 213  *                                            SilcPacketStream stream,
 214  *                                            SilcPacket packet,
 215  *                                            void *callback_context,
 216  *                                            void *stream_context);
 217  *
 218  * DESCRIPTION
 219  *
 220  *    The packet receive callback is called by the packet engine when a new
 221  *    SILC Packet has arrived.  The application must free the returned
 222  *    SilcPacket with silc_packet_free if it takes the packet in for
 223  *    processing.  This callback is set in the SilcPacketCallbacks structure.
 224  *    The `callback_context' is the context set as argument in the
 225  *    silc_packet_engine_start function.  The `stream_context' is stream
 226  *    specific context that was set by calling silc_packet_set_context.
 227  *
 228  *    If the application takes the received packet `packet' into processing
 229  *    TRUE must be returned.  If FALSE is returned the packet engine will
 230  *    pass the packet to other packet processor, if one has been linked
 231  *    to the stream with silc_packet_stream_link function.  If no extra
 232  *    processor is linked the packet is dropped.
 233  *
 234  * EXAMPLE
 235  *
 236  *    SilcBool
 237  *    silc_foo_packet_receive_cb(SilcPacketEngine engine,
 238  *                               SilcPacketStream stream, SilcPacket packet,
 239  *                               void *callback_context, void *stream_context)
 240  *    {
 241  *      Application ctx = callback_context;
 242  *
 243  *      // If we're not up yet, let's not process the packet
 244  *      if (ctx->initialized == FALSE)
 245  *        return FALSE;
 246  *
 247  *      // Process the incoming packet...
 248  *      ...
 249  *
 250  *      // It's our packet now, no one else will get it
 251  *      return TRUE;
 252  *    }
 253  *
 254  ***/
 255 typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
 256                                         SilcPacketStream stream,
 257                                         SilcPacket packet,
 258                                         void *callback_context,
 259                                         void *stream_context);
 260
 261 /****f* silccore/SilcPacketAPI/SilcPacketEosCb
 262  *
 263  * SYNOPSIS
 264  *
 265  *    typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
 266  *                                    SilcPacketStream stream,
 267  *                                    void *callback_context,
 268  *                                    void *stream_context);
 269  *
 270  * DESCRIPTION
 271  *
 272  *    The End Of Stream (EOS) callback, that is called by the packet engine
 273  *    when the underlaying stream has ended.  No more data can be sent to
 274  *    the stream or read from it.  The `stream' must be destroyed by
 275  *    calling the silc_packet_stream_destroy.  This callback is set in the
 276  *    SilcPacketCallbacks structure.
 277  *
 278  ***/
 279 typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
 280                                 SilcPacketStream stream,
 281                                 void *callback_context,
 282                                 void *stream_context);
 283
 284 /****f* silccore/SilcPacketAPI/SilcPacketErrorCb
 285  *
 286  * SYNOPSIS
 287  *
 288  *    typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
 289  *                                      SilcPacketStream stream,
 290  *                                      SilcPacketError error,
 291  *                                      void *callback_context,
 292  *                                      void *stream_context);
 293  *
 294  * DESCRIPTION
 295  *
 296  *    The error callback that is called by the packet engine if an error
 297  *    occurs.  The `error' will indicate the error.  This callback is set
 298  *    in the SilcPacketCallbacks structure.
 299  *
 300  ***/
 301 typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
 302                                   SilcPacketStream stream,
 303                                   SilcPacketError error,
 304                                   void *callback_context,
 305                                   void *stream_context);
 306
 307 /****s* silccore/SilcPacketAPI/SilcPacketStream
 308  *
 309  * NAME
 310  *
 311  *    typedef struct SilcPacketStreamStruct *SilcPacketStream;
 312  *
 313  * DESCRIPTION
 314  *
 315  *    This structure is sent as argument to the silc_packet_engine_start
 316  *    function to set the callback functions for the packet engine.  The
 317  *    packet engine will call the callbacks when necessary.  Application
 318  *    must always be provided for the packet engine.
 319  *
 320  * SOURCE
 321  */
 322 typedef struct {
 323   SilcPacketReceiveCb packet_receive;    /* Called when packet is received */
 324   SilcPacketEosCb eos;                   /* Called on end of stream */
 325   SilcPacketErrorCb error;               /* Called on an error */
 326 } SilcPacketCallbacks;
 327 /***/
 328
 329 /* Prototypes */
 330
 331 /****f* silccore/SilcPacketAPI/silc_packet_engine_start
 332  *
 333  * SYNOPSIS
 334  *
 335  *    SilcPacketEngine
 336  *    silc_packet_engine_start(SilcRng rng, SilcBool router,
 337  *                             SilcPacketCallbacks *callbacks,
 338  *                             void *callback_context);
 339  *
 340  * DESCRIPTION
 341  *
 342  *    Create new packet engine for processing incoming and outgoing packets.
 343  *    If `router' is  TRUE then the application is considered to be router
 344  *    server, and certain packets are handled differently.  Client and normal
 345  *    server must set it to FALSE.  The `callbacks' is a SilcPacketCallbacks
 346  *    structure provided by the caller which includes the callbacks that is
 347  *    called when for example packet is received, or end of stream is called.
 348  *
 349  * NOTES
 350  *
 351  *    The packet engine is thread safe.  You can use one packet engine in
 352  *    multi threaded application.
 353  *
 354  ***/
 355 SilcPacketEngine
 356 silc_packet_engine_start(SilcRng rng, SilcBool router,
 357                          SilcPacketCallbacks *callbacks,
 358                          void *callback_context);
 359
 360 /****f* silccore/SilcPacketAPI/silc_packet_engine_stop
 361  *
 362  * SYNOPSIS
 363  *
 364  *    void silc_packet_engine_stop(SilcPacketEngine engine);
 365  *
 366  * DESCRIPTION
 367  *
 368  *    Stop the packet engine.  No new packets can be sent or received after
 369  *    calling this, and the `engine' will become invalid.
 370  *
 371  ***/
 372 void silc_packet_engine_stop(SilcPacketEngine engine);
 373
 374 /****f* silccore/SilcPacketAPI/silc_packet_stream_create
 375  *
 376  * SYNOPSIS
 377  *
 378  *    SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
 379  *                                               SilcSchedule schedule,
 380  *                                               SilcStream stream);
 381  *
 382  * DESCRIPTION
 383  *
 384  *    Create new packet stream and use the `stream' as underlaying stream.
 385  *    Usually the `stream' would be a socket stream, but it can be any
 386  *    stream.  After this function returns, packets can immediately be
 387  *    sent to or received from the stream.
 388  *
 389  * NOTES
 390  *
 391  *    SilcPacketStream cannot be used with silc_stream_* routines (such as
 392  *    silc_stream_read and silc_stream_write) because of its special nature.
 393  *    Use the silc_packet_send and the silc_packet_send_ext to send packets.
 394  *    To read packets you will receive the packet receive callback from
 395  *    packet engine.  Destroy the stream with silc_packet_stream_destroy.
 396  *
 397  *    The SilcPacketStream is thread safe.  Same context can be safely used
 398  *    in multi threaded environment.
 399  *
 400  ***/
 401 SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
 402                                            SilcSchedule schedule,
 403                                            SilcStream stream);
 404
 405 /****f* silccore/SilcPacketAPI/silc_packet_stream_destroy
 406  *
 407  * SYNOPSIS
 408  *
 409  *    void silc_packet_stream_destroy(SilcPacketStream stream);
 410  *
 411  * DESCRIPTION
 412  *
 413  *    Destroy packet stream and the underlaying stream.  This will also
 414  *    send end of stream to the underlaying stream.
 415  *
 416  ***/
 417 void silc_packet_stream_destroy(SilcPacketStream stream);
 418
 419 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_router
 420  *
 421  * SYNOPSIS
 422  *
 423  *    void silc_packet_stream_set_router(SilcPacketStream stream);
 424  *
 425  * DESCRIPTION
 426  *
 427  *    When called sets the stream indicates by `stream' as SILC router
 428  *    connection stream.  This causes that certain packets are handled
 429  *    differently.  This must be called for router connection streams and
 430  *    must not be called for any other stream.
 431  *
 432  ***/
 433 void silc_packet_stream_set_router(SilcPacketStream stream);
 434
 435 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_iv_included
 436  *
 437  * SYNOPSIS
 438  *
 439  *    void silc_packet_stream_set_iv_included(SilcPacketStream stream);
 440  *
 441  * DESCRIPTION
 442  *
 443  *    Sets an IV Included property for the stream indicated by `stream'.
 444  *    This means that the IV used in the encryption will be included in
 445  *    the resulted ciphertext.  This makes it possible to send and receive
 446  *    packets on unreliable network transport protocol, such as UDP/IP.
 447  *    This must be called if the underlaying stream in the `stream' is UDP
 448  *    stream.
 449  *
 450  ***/
 451 void silc_packet_stream_set_iv_included(SilcPacketStream stream);
 452
 453 /****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream
 454  *
 455  * SYNOPSIS
 456  *
 457  *    SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
 458  *
 459  * DESCRIPTION
 460  *
 461  *    Returns the actual stream that is associated with the packet stream
 462  *    `stream'.  The caller must not free the returned stream.  The returned
 463  *    stream is the same pointer that was set for silc_packet_stream_create.
 464  *    This function could be used for example when an error callback is
 465  *    called by the packet engine to retrieve the actual lower level error
 466  *    from the stream.
 467  *
 468  ***/
 469 SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
 470
 471 /****f* silccore/SilcPacketAPI/silc_packet_stream_link
 472  *
 473  * SYNOPSIS
 474  *
 475  *    SilcBool silc_packet_stream_link(SilcPacketStream stream,
 476  *                                     SilcPacketCallbacks *callbacks,
 477  *                                     void *callback_context,
 478  *                                     int priority, ...);
 479  *
 480  * DESCRIPTION
 481  *
 482  *    Links the packet processing callbacks indicated by `callbacks' into
 483  *    the packet stream indicated by `stream' with priority `priority' for
 484  *    the packet types given in the variable argument list.  This function
 485  *    can be used to link to the packet stream for specific packet types
 486  *    and receive them in the specified callbacks.  This way, a third party,
 487  *    for example some library may attach itself into the packet stream
 488  *    and receive and process certain packets.  The variable argument
 489  *    list is ended with -1.  To link to receive all packets use
 490  *    SILC_PACKET_ANY.
 491  *
 492  *    The default packet processing callbacks given as argument to the
 493  *    silc_packet_engine_start has the priority 0.  Any priority higher
 494  *    than 0 will then take precedence over the default callbacks.  Any
 495  *    priority lower than 0 (negative value) will be processed after the
 496  *    default callbacks.
 497  *
 498  *    Note that setting only the 'packet_receive' callback in the `callbacks'
 499  *    is required.
 500  *
 501  * EXAMPLE
 502  *
 503  *    // Link to this packet stream, with high priority, for
 504  *    // SILC_PACKET_CONNECTION_AUTH and SILC_PACKET_CONNECTION_AUTH_REQUEST
 505  *    // packets. We don't care about other packets.
 506  *    silc_packet_stream_link(stream, our_callbacks, our_context,
 507  *                            1000000, SILC_PACKET_CONNECTION_AUTH,
 508  *                            SILC_PACKET_CONNECTION_AUTH_REQUEST, -1);
 509  *
 510  ***/
 511 SilcBool silc_packet_stream_link(SilcPacketStream stream,
 512                                  SilcPacketCallbacks *callbacks,
 513                                  void *callback_context,
 514                                  int priority, ...);
 515
 516 /****f* silccore/SilcPacketAPI/silc_packet_stream_unlink
 517  *
 518  * SYNOPSIS
 519  *
 520  *    void silc_packet_stream_unlink(SilcPacketStream stream,
 521  *                                   SilcPacketCallbacks *callbacks,
 522  *                                   void *callback_context);
 523  *
 524  * DESCRIPTION
 525  *
 526  *    Unlinks the `callbacks' with `callback_context' from the packet stream
 527  *    indicated by `stream'.  This function must be called for the callbacks
 528  *    that was linked to `stream' when they are not needed anymore.
 529  *
 530  ***/
 531 void silc_packet_stream_unlink(SilcPacketStream stream,
 532                                SilcPacketCallbacks *callbacks,
 533                                void *callback_context);
 534
 535 /****f* silccore/SilcPacketAPI/silc_packet_stream_ref
 536  *
 537  * SYNOPSIS
 538  *
 539  *    void silc_packet_stream_ref(SilcPacketStream stream);
 540  *
 541  * DESCRIPTION
 542  *
 543  *    Increase reference counter for the stream indicated by `stream'.  This
 544  *    can be used to take a reference for the stream.  To unreference the
 545  *    stream call silc_packet_stream_unref function.
 546  *
 547  ***/
 548 void silc_packet_stream_ref(SilcPacketStream stream);
 549
 550 /****f* silccore/SilcPacketAPI/silc_packet_stream_unref
 551  *
 552  * SYNOPSIS
 553  *
 554  *    void silc_packet_stream_unref(SilcPacketStream stream);
 555  *
 556  * DESCRIPTION
 557  *
 558  *    Decrease reference counter for the stream indicated by `stream'.  If
 559  *    the counter hits zero the stream will be destroyed automatically.
 560  *
 561  ***/
 562 void silc_packet_stream_unref(SilcPacketStream stream);
 563
 564 /****f* silccore/SilcPacketAPI/silc_packet_get_engine
 565  *
 566  * SYNOPSIS
 567  *
 568  *    SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
 569  *
 570  * DESCRIPTION
 571  *
 572  *    Returns the packet engine from the `stream'.
 573  *
 574  ***/
 575 SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
 576
 577 /****f* silccore/SilcPacketAPI/silc_packet_set_context
 578  *
 579  * SYNOPSIS
 580  *
 581  *    void silc_packet_set_context(SilcPacketStream stream,
 582  *                                 void *stream_context);
 583  *
 584  * DESCRIPTION
 585  *
 586  *    Sets a stream specific context to the stream.  The context will
 587  *    be delivered to all callback functions, and it can be retrieved by
 588  *    calling silc_packet_get_context function as well.  Note that this is
 589  *    separate packet stream specific context, and not the same as
 590  *    `callback_context' in silc_packet_engine_start.  Both will be delivered
 591  *    to the callbacks, and this context as the `stream_context' argument.
 592  *
 593  ***/
 594 void silc_packet_set_context(SilcPacketStream stream, void *stream_context);
 595
 596 /****f* silccore/SilcPacketAPI/silc_packet_get_context
 597  *
 598  * SYNOPSIS
 599  *
 600  *    void *silc_packet_get_context(SilcPacketStream stream);
 601  *
 602  * DESCRIPTION
 603  *
 604  *    Returns the current set application context, or NULL if none is set.
 605  *
 606  ***/
 607 void *silc_packet_get_context(SilcPacketStream stream);
 608
 609 /****f* silccore/SilcPacketAPI/silc_packet_set_ciphers
 610  *
 611  * SYNOPSIS
 612  *
 613  *    void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send,
 614  *                                 SilcCipher receive);
 615  *
 616  * DESCRIPTION
 617  *
 618  *    Set ciphers to be used to encrypt sent packets, and decrypt received
 619  *    packets.  This can be called multiple times to change the ciphers.
 620  *    In this case if old cipher is set it will be freed.  If ciphers are
 621  *    not set packets will not be encrypted or decrypted.
 622  *
 623  ***/
 624 void silc_packet_set_ciphers(SilcPacketStream stream, SilcCipher send,
 625                              SilcCipher receive);
 626
 627 /****f* silccore/SilcPacketAPI/silc_packet_get_ciphers
 628  *
 629  * SYNOPSIS
 630  *
 631  *    SilcBool silc_packet_get_ciphers(SilcPacketStream stream,
 632  *                                     SilcCipher *send,
 633  *                                     SilcCipher *receive);
 634  *
 635  * DESCRIPTION
 636  *
 637  *    Returns the pointers of current ciphers from the `stream'.  Returns
 638  *    FALSE if ciphers are not set.
 639  *
 640  ***/
 641 SilcBool silc_packet_get_ciphers(SilcPacketStream stream, SilcCipher *send,
 642                                  SilcCipher *receive);
 643
 644 /****f* silccore/SilcPacketAPI/silc_packet_set_hmacs
 645  *
 646  * SYNOPSIS
 647  *
 648  *    void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send,
 649  *                               SilcHmac receive);
 650  *
 651  * DESCRIPTION
 652  *
 653  *    Set HMACs to be used to create MACs for sent packets and to check
 654  *    MAC for received packets.  This can be called multiple times to change
 655  *    the HMACs.  In this case if old HMAC is set it will be freed.  If
 656  *    HMACs are not set MACs are not generated or verified for packets.
 657  *
 658  ***/
 659 void silc_packet_set_hmacs(SilcPacketStream stream, SilcHmac send,
 660                            SilcHmac receive);
 661
 662 /****f* silccore/SilcPacketAPI/silc_packet_get_hmacs
 663  *
 664  * SYNOPSIS
 665  *
 666  *    SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send,
 667  *                                   SilcHmac *receive);
 668  *
 669  * DESCRIPTION
 670  *
 671  *    Returns the pointers of current HMACs from the `stream'.  Returns
 672  *    FALSE if HMACs are not set.
 673  *
 674  ***/
 675 SilcBool silc_packet_get_hmacs(SilcPacketStream stream, SilcHmac *send,
 676                                SilcHmac *receive);
 677
 678 /****f* silccore/SilcPacketAPI/silc_packet_set_ids
 679  *
 680  * SYNOPSIS
 681  *
 682  *    SilcBool silc_packet_set_ids(SilcPacketStream stream,
 683  *                                 SilcIdType src_id_type, const void *src_id
 684  *                                 SilcIdType dst_id_type, const void *dst_id);
 685  *
 686  * DESCRIPTION
 687  *
 688  *    Set the source ID and destinaion ID to be used when sending packets to
 689  *    this packet stream.  The IDs to be used for a packet stream can be
 690  *    overridden when sending packets.  However, if the IDs do not ever change
 691  *    for the packet stream it is recommended they are set using this function.
 692  *    In this case they can be omitted when sending packets to the stream.
 693  *    It is also possible to set only source or destination ID.
 694  *
 695  ***/
 696 SilcBool silc_packet_set_ids(SilcPacketStream stream,
 697                              SilcIdType src_id_type, const void *src_id,
 698                              SilcIdType dst_id_type, const void *dst_id);
 699
 700 /****f* silccore/SilcPacketAPI/silc_packet_send
 701  *
 702  * SYNOPSIS
 703  *
 704  *    SilcBool silc_packet_send(SilcPacketStream stream,
 705  *                              SilcPacketType type, SilcPacketFlags flags,
 706  *                              const unsigned char *data,
 707  *                              SilcUInt32 data_len);
 708  *
 709  * DESCRIPTION
 710  *
 711  *    Send `data' of length of `data_len' to the packet stream indicated by
 712  *    `stream'.  If ciphers and HMACs were set using silc_packet_set_ciphers
 713  *    and silc_packet_set_hmacs the packet will be encrypted and MAC will be
 714  *    computed for it.  If silc_packet_set_ids was used to set source and
 715  *    destination ID for the packet stream those IDs are used in the
 716  *    packet.  If IDs have not been set and they need to be provided then
 717  *    silc_packet_send_ext function should be used.  Otherwise, the packet
 718  *    will not have IDs set at all.  Returns FALSE if packet could not be
 719  *    sent.
 720  *
 721  ***/
 722 SilcBool silc_packet_send(SilcPacketStream stream,
 723                           SilcPacketType type, SilcPacketFlags flags,
 724                           const unsigned char *data, SilcUInt32 data_len);
 725
 726 /****f* silccore/SilcPacketAPI/silc_packet_send_ext
 727  *
 728  * SYNOPSIS
 729  *
 730  *    SilcBool
 731  *    silc_packet_send_ext(SilcPacketStream stream,
 732  *                         SilcPacketType type, SilcPacketFlags flags,
 733  *                         SilcIdType src_id_type, void *srd_id,
 734  *                         SilcIdType dst_id_type, void *dst_id,
 735  *                         const unsigned char *data, SilcUInt32 data_len,
 736  *                         SilcCipher cipher, SilcHmac hmac);
 737  *
 738  * DESCRIPTION
 739  *
 740  *    Same as silc_packet_send but with this function different sending
 741  *    parameters can be sent as argument.  This function can be used to
 742  *    set specific IDs, cipher and HMAC to be used in packet sending,
 743  *    instead of the ones saved in the `stream'.  If any of the extra
 744  *    pointers are NULL, default values set to the stream will apply.
 745  *
 746  ***/
 747 SilcBool silc_packet_send_ext(SilcPacketStream stream,
 748                               SilcPacketType type, SilcPacketFlags flags,
 749                               SilcIdType src_id_type, void *src_id,
 750                               SilcIdType dst_id_type, void *dst_id,
 751                               const unsigned char *data, SilcUInt32 data_len,
 752                               SilcCipher cipher, SilcHmac hmac);
 753
 754 /****f* silccore/SilcPacketAPI/silc_packet_wait
 755  *
 756  * SYNOPSIS
 757  *
 758  *    void *silc_packet_wait_init(SilcPacketStream stream, ...);
 759  *
 760  * DESCRIPTION
 761  *
 762  *    Initializes a packet waiter for the packet stream `stream' and
 763  *    for the variable argument list of packet types.  The function
 764  *    silc_packet_wait can be used to block the thread until a packet
 765  *    has been received.  This function is used to initialize the waiting
 766  *    and to give the list of packet types that caller wish to receive.
 767  *    The variable argument list must end with -1.  To receive all
 768  *    packets use SILC_PACKET_ANY.  Returns a context that must be given
 769  *    to the silc_packet_wait function as argument.  Returns NULL on
 770  *    error.  To uninitialize the waiting call silc_packet_wait_uninit.
 771  *
 772  * NOTES
 773  *
 774  *    Note that packets may be available immediately after calling this
 775  *    function and they will be buffered, until silc_packet_wait is called.
 776  *
 777  * EXAMPLE
 778  *
 779  *      void *waiter;
 780  *
 781  *      // Will wait for private message packets
 782  *      waiter = silc_packet_wait_init(stream,
 783  *                                     SILC_PACKET_PRIVATE_MESSAGE, -1);
 784  *
 785  *
 786  ***/
 787 void *silc_packet_wait_init(SilcPacketStream stream, ...);
 788
 789 /****f* silccore/SilcPacketAPI/silc_packet_wait
 790  *
 791  * SYNOPSIS
 792  *
 793  *    void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
 794  *
 795  * DESCRIPTION
 796  *
 797  *    Uninitializes the waiting context.  This may be called also from
 798  *    another thread while other thread is waiting for packets.  This will
 799  *    inform the waiting thread to stop waiting.
 800  *
 801  ***/
 802 void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
 803
 804 /****f* silccore/SilcPacketAPI/silc_packet_wait
 805  *
 806  * SYNOPSIS
 807  *
 808  *    int silc_packet_wait(void *waiter, int timeout,
 809  *                         SilcPacket *return_packet)
 810  *
 811  * DESCRIPTION
 812  *
 813  *    A special function that can be used to wait for a packet to arrive.
 814  *    This function will block the calling process or thread until either
 815  *    a packet is received into the `return_packet' pointer or the specified
 816  *    timeout value `timeout', which is in milliseconds, will expire.  If
 817  *    the timeout is 0, no timeout exist.  Before calling this function the
 818  *    silc_packet_wait_init must be called.  The caller is responsible for
 819  *    freeing the returned packet with silc_packet_free.
 820  *
 821  *    This function can be used for example from a thread that wants to
 822  *    block until SILC packet has been received.
 823  *
 824  *    Returns 1 when packet was received, 0 if timeout occurred and -1 if
 825  *    error occurred.
 826  *
 827  * EXAMPLE
 828  *
 829  *    static int foo_read_data(FooContext c)
 830  *    {
 831  *      SilcPacket packet;
 832  *      void *waiter;
 833  *      ...
 834  *
 835  *      // Will wait for private message packets
 836  *      if (c->initialized == FALSE) {
 837  *        waiter = silc_packet_wait_init(stream,
 838  *                                       SILC_PACKET_PRIVATE_MESSAGE, -1);
 839  *        c->initialized = TRUE;
 840  *      }
 841  *
 842  *      ...
 843  *      // Wait here until private message packet is received
 844  *      if ((silc_packet_wait(waiter, 0, &packet)) < 0)
 845  *        return -1;
 846  *
 847  *      ... process packet ...
 848  *
 849  *      return 1;
 850  *    }
 851  *
 852  ***/
 853 int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet);
 854
 855 /****f* silccore/SilcPacketAPI/silc_packet_free
 856  *
 857  * SYNOPSIS
 858  *
 859  *    void silc_packet_free(SilcPacket packet);
 860  *
 861  * DESCRIPTION
 862  *
 863  *    This function is used to free the SilcPacket pointer that application
 864  *    receives in the SilcPacketReceive callback.  Application must free
 865  *    the packet if it takes it in to processing.
 866  *
 867  ***/
 868 void silc_packet_free(SilcPacket packet);
 869
 870 #endif /* SILCPACKET_H */