lib/silccore/silcpacket.h

   1 /*
   2
   3   silcpacket.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 1997 - 2007 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/SILC Packet Engine 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 #define SILC_PACKET_ACK                  29      /* Acknowledgement */
  89
  90 #define SILC_PACKET_PRIVATE              200     /* Private range start  */
  91 #define SILC_PACKET_MAX                  255     /* RESERVED */
  92
  93 #define SILC_PACKET_NONE                 0       /* RESERVED */
  94 #define SILC_PACKET_ANY                  0
  95 /***/
  96
  97 /****d* silccore/SilcPacketAPI/SilcPacketFlags
  98  *
  99  * NAME
 100  *
 101  *    typedef SilcUInt8 SilcPacketFlags;
 102  *
 103  * DESCRIPTION
 104  *
 105  *    SILC packet flags type definition and all the packet flags.
 106  *
 107  * SOURCE
 108  */
 109 typedef SilcUInt8 SilcPacketFlags;
 110
 111 /* All defined packet flags */
 112 #define SILC_PACKET_FLAG_NONE             0x00    /* No flags */
 113 #define SILC_PACKET_FLAG_PRIVMSG_KEY      0x01    /* Private message key */
 114 #define SILC_PACKET_FLAG_LIST             0x02    /* Packet is a list */
 115 #define SILC_PACKET_FLAG_BROADCAST        0x04    /* Packet is a broadcast */
 116 #define SILC_PACKET_FLAG_COMPRESSED       0x08    /* Payload is compressed */
 117 #define SILC_PACKET_FLAG_ACK              0x10    /* Acknowledge packet */
 118
 119 /* Impelemntation specific flags */
 120 #define SILC_PACKET_FLAG_LONG_PAD         0x12    /* Use maximum padding */
 121 /***/
 122
 123 /****s* silccore/SilcPacketAPI/SilcPacketEngine
 124  *
 125  * NAME
 126  *
 127  *    typedef struct SilcPacketEngineStruct *SilcPacketEngine;
 128  *
 129  * DESCRIPTION
 130  *
 131  *    The packet engine context, allocated by silc_packet_engine_start.
 132  *    The engine is destroyed with silc_packet_engine_stop.
 133  *
 134  ***/
 135 typedef struct SilcPacketEngineStruct *SilcPacketEngine;
 136
 137 /****s* silccore/SilcPacketAPI/SilcPacketStream
 138  *
 139  * NAME
 140  *
 141  *    typedef struct SilcPacketStreamStruct *SilcPacketStream;
 142  *
 143  * DESCRIPTION
 144  *
 145  *    The packet stream context, allocated by silc_packet_stream_create.
 146  *    The stream is destroyed with silc_packet_stream_destroy.
 147  *
 148  ***/
 149 typedef struct SilcPacketStreamStruct *SilcPacketStream;
 150
 151 /****s* silccore/SilcPacketAPI/SilcPacket
 152  *
 153  * NAME
 154  *
 155  *    typedef struct SilcPacketStruct *SilcPacket;
 156  *
 157  * DESCRIPTION
 158  *
 159  *    The SilcPacket is returned by the packet engine in the SilcPacketReceive
 160  *    callback.  The application can parse the data payload from the
 161  *    SilcPacket.  Also packet type, flags, and sender and destination
 162  *    IDs are available.  The application must free the packet with the
 163  *    silc_packet_free function if it takes it in for processing.
 164  *
 165  *    The `buffer' field contains the parsed packet payload and the start
 166  *    of the data area will point to the start of the packet payload.
 167  *
 168  *    The list pointer `next' can be used by the application to put the
 169  *    packet context in a list during processing, if needed.
 170  *
 171  * SOURCE
 172  */
 173 typedef struct SilcPacketStruct {
 174   struct SilcPacketStruct *next;     /* List pointer, application may set */
 175   SilcPacketStream stream;           /* Packet stream this packet is from */
 176   SilcBufferStruct buffer;           /* Packet data payload */
 177   unsigned char *src_id;             /* Source ID */
 178   unsigned char *dst_id;             /* Destination ID */
 179   unsigned int src_id_len  : 6;      /* Source ID length */
 180   unsigned int src_id_type : 2;      /* Source ID type */
 181   unsigned int dst_id_len  : 6;      /* Destination ID length */
 182   unsigned int dst_id_type : 2;      /* Destination ID type */
 183   SilcPacketType type;               /* Packet type */
 184   SilcPacketFlags flags;             /* Packet flags */
 185 } *SilcPacket;
 186 /***/
 187
 188 /****d* silcutil/SilcPacketAPI/SilcPacketError
 189  *
 190  * NAME
 191  *
 192  *    typedef enum { ... } SilcPacketError
 193  *
 194  * DESCRIPTION
 195  *
 196  *    Packet errors.  This is returned in the error callback.  If application
 197  *    needs the actual lower level stream error, it needs to retrieve it
 198  *    from the actual stream.  It can retrieve the underlaying stream from
 199  *    the packet stream by calling silc_packet_stream_get_stream function.
 200  *
 201  * SOURCE
 202  */
 203 typedef enum {
 204   SILC_PACKET_ERR_READ,                  /* Error while reading */
 205   SILC_PACKET_ERR_WRITE,                 /* Error while writing */
 206   SILC_PACKET_ERR_MAC_FAILED,            /* Packet MAC check failed */
 207   SILC_PACKET_ERR_DECRYPTION_FAILED,     /* Packet decryption failed */
 208   SILC_PACKET_ERR_UNKNOWN_SID,           /* Unknown SID (with IV included) */
 209   SILC_PACKET_ERR_MALFORMED,             /* Packet is malformed */
 210   SILC_PACKET_ERR_NO_MEMORY,             /* System out of memory */
 211 } SilcPacketError;
 212 /***/
 213
 214 /****f* silccore/SilcPacketAPI/SilcPacketReceiveCb
 215  *
 216  * SYNOPSIS
 217  *
 218  *    typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
 219  *                                            SilcPacketStream stream,
 220  *                                            SilcPacket packet,
 221  *                                            void *callback_context,
 222  *                                            void *stream_context);
 223  *
 224  * DESCRIPTION
 225  *
 226  *    The packet receive callback is called by the packet engine when a new
 227  *    SILC Packet has arrived.  The application must free the returned
 228  *    SilcPacket with silc_packet_free if it takes the packet in for
 229  *    processing.  This callback is set in the SilcPacketCallbacks structure.
 230  *    The `callback_context' is the context set as argument in the
 231  *    silc_packet_engine_start function.  The `stream_context' is stream
 232  *    specific context that was set by calling silc_packet_set_context.
 233  *
 234  *    If the application takes the received packet `packet' into processing
 235  *    TRUE must be returned.  If FALSE is returned the packet engine will
 236  *    pass the packet to other packet processor, if one has been linked
 237  *    to the stream with silc_packet_stream_link function.  If no extra
 238  *    processor is linked the packet is dropped.
 239  *
 240  * EXAMPLE
 241  *
 242  *    SilcBool
 243  *    silc_foo_packet_receive_cb(SilcPacketEngine engine,
 244  *                               SilcPacketStream stream, SilcPacket packet,
 245  *                               void *callback_context, void *stream_context)
 246  *    {
 247  *      Application ctx = callback_context;
 248  *
 249  *      // If we're not up yet, let's not process the packet
 250  *      if (ctx->initialized == FALSE)
 251  *        return FALSE;
 252  *
 253  *      // Process the incoming packet...
 254  *      ...
 255  *
 256  *      // It's our packet now, no one else will get it
 257  *      return TRUE;
 258  *    }
 259  *
 260  ***/
 261 typedef SilcBool (*SilcPacketReceiveCb)(SilcPacketEngine engine,
 262                                         SilcPacketStream stream,
 263                                         SilcPacket packet,
 264                                         void *callback_context,
 265                                         void *stream_context);
 266
 267 /****f* silccore/SilcPacketAPI/SilcPacketEosCb
 268  *
 269  * SYNOPSIS
 270  *
 271  *    typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
 272  *                                    SilcPacketStream stream,
 273  *                                    void *callback_context,
 274  *                                    void *stream_context);
 275  *
 276  * DESCRIPTION
 277  *
 278  *    The End Of Stream (EOS) callback, that is called by the packet engine
 279  *    when the underlaying stream has ended.  No more data can be sent to
 280  *    the stream or read from it.  The `stream' must be destroyed by
 281  *    calling the silc_packet_stream_destroy.  This callback is set in the
 282  *    SilcPacketCallbacks structure.
 283  *
 284  ***/
 285 typedef void (*SilcPacketEosCb)(SilcPacketEngine engine,
 286                                 SilcPacketStream stream,
 287                                 void *callback_context,
 288                                 void *stream_context);
 289
 290 /****f* silccore/SilcPacketAPI/SilcPacketErrorCb
 291  *
 292  * SYNOPSIS
 293  *
 294  *    typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
 295  *                                      SilcPacketStream stream,
 296  *                                      SilcPacketError error,
 297  *                                      void *callback_context,
 298  *                                      void *stream_context);
 299  *
 300  * DESCRIPTION
 301  *
 302  *    The error callback that is called by the packet engine if an error
 303  *    occurs.  The `error' will indicate the error.  This callback is set
 304  *    in the SilcPacketCallbacks structure.
 305  *
 306  ***/
 307 typedef void (*SilcPacketErrorCb)(SilcPacketEngine engine,
 308                                   SilcPacketStream stream,
 309                                   SilcPacketError error,
 310                                   void *callback_context,
 311                                   void *stream_context);
 312
 313 /****s* silccore/SilcPacketAPI/SilcPacketCallbacks
 314  *
 315  * NAME
 316  *
 317  *    typedef struct { ... } *SilcPacketCallbacks;
 318  *
 319  * DESCRIPTION
 320  *
 321  *    This structure is sent as argument to the silc_packet_engine_start
 322  *    function to set the callback functions for the packet engine.  The
 323  *    packet engine will call the callbacks when necessary.  Application
 324  *    must always be provided for the packet engine.
 325  *
 326  * SOURCE
 327  */
 328 typedef struct {
 329   SilcPacketReceiveCb packet_receive;    /* Called when packet is received */
 330   SilcPacketEosCb eos;                   /* Called on end of stream */
 331   SilcPacketErrorCb error;               /* Called on an error */
 332 } SilcPacketCallbacks;
 333 /***/
 334
 335 /* Prototypes */
 336
 337 /****f* silccore/SilcPacketAPI/silc_packet_engine_start
 338  *
 339  * SYNOPSIS
 340  *
 341  *    SilcPacketEngine
 342  *    silc_packet_engine_start(SilcRng rng, SilcBool router,
 343  *                             SilcPacketCallbacks *callbacks,
 344  *                             void *callback_context);
 345  *
 346  * DESCRIPTION
 347  *
 348  *    Create new packet engine for processing incoming and outgoing packets.
 349  *    If `router' is  TRUE then the application is considered to be router
 350  *    server, and certain packets are handled differently.  Client and normal
 351  *    server must set it to FALSE.  The `callbacks' is a SilcPacketCallbacks
 352  *    structure provided by the caller which includes the callbacks that is
 353  *    called when for example packet is received, or end of stream is called.
 354  *
 355  * NOTES
 356  *
 357  *    The packet engine is thread safe.  You can use one packet engine in
 358  *    multi threaded application.
 359  *
 360  ***/
 361 SilcPacketEngine
 362 silc_packet_engine_start(SilcRng rng, SilcBool router,
 363                          SilcPacketCallbacks *callbacks,
 364                          void *callback_context);
 365
 366 /****f* silccore/SilcPacketAPI/silc_packet_engine_stop
 367  *
 368  * SYNOPSIS
 369  *
 370  *    void silc_packet_engine_stop(SilcPacketEngine engine);
 371  *
 372  * DESCRIPTION
 373  *
 374  *    Stop the packet engine.  No new packets can be sent or received after
 375  *    calling this, and the `engine' will become invalid.
 376  *
 377  ***/
 378 void silc_packet_engine_stop(SilcPacketEngine engine);
 379
 380 /****f* silccore/SilcPacketAPI/silc_packet_engine_get_streams
 381  *
 382  * SYNOPSIS
 383  *
 384  *    SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine);
 385  *
 386  * DESCRIPTION
 387  *
 388  *    Returns list of packet streams added to the packet engine.  The caller
 389  *    must free the list with silc_dlist_uninit.
 390  *
 391  ***/
 392 SilcDList silc_packet_engine_get_streams(SilcPacketEngine engine);
 393
 394 /****f* silccore/SilcPacketAPI/silc_packet_stream_create
 395  *
 396  * SYNOPSIS
 397  *
 398  *    SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
 399  *                                               SilcSchedule schedule,
 400  *                                               SilcStream stream);
 401  *
 402  * DESCRIPTION
 403  *
 404  *    Create new packet stream and use the `stream' as underlaying stream.
 405  *    Usually the `stream' would be a socket stream, but it can be any
 406  *    stream.  After this function returns, packets can immediately be
 407  *    sent to and received from the stream.
 408  *
 409  * NOTES
 410  *
 411  *    SilcPacketStream cannot be used with silc_stream_* routines (such as
 412  *    silc_stream_read and silc_stream_write) because of its special nature.
 413  *    Use the silc_packet_send and the silc_packet_send_ext to send packets.
 414  *    To read packets you will receive the packet receive callback from
 415  *    packet engine.  Destroy the stream with silc_packet_stream_destroy.
 416  *
 417  *    The SilcPacketStream is thread safe.  Same context can be safely used
 418  *    in multi threaded environment.
 419  *
 420  ***/
 421 SilcPacketStream silc_packet_stream_create(SilcPacketEngine engine,
 422                                            SilcSchedule schedule,
 423                                            SilcStream stream);
 424
 425 /****f* silccore/SilcPacketAPI/silc_packet_stream_add_remote
 426  *
 427  * SYNOPSIS
 428  *
 429  *    SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
 430  *                                                   const char *remote_ip,
 431  *                                                   SilcUInt16 remote_port,
 432  *                                                   SilcPacket packet);
 433  *
 434  * DESCRIPTION
 435  *
 436  *    This function is used to add remote receivers in packet stream `stream'
 437  *    that has UDP/IP socket stream as the underlaying stream.  This function
 438  *    cannot be used with other type of streams.  This returns new packet
 439  *    stream context that can be used to send to and receive packets from
 440  *    the specified remote IP and remote port, or NULL on error.  The `stream'
 441  *    is the actual stream that is used to send and receive the data.
 442  *
 443  *    When the parent `stream' receives packets from remote IP address
 444  *    and port that does not have its own remote packet stream, it returns
 445  *    the packet to the packet callback set for `stream'.  The sender's
 446  *    IP address and port can then be retrieved by using the
 447  *    silc_packet_get_sender function and to create new packet stream by
 448  *    calling this function.  After that, all packets from that IP address
 449  *    and port will be received by the new packet stream.
 450  *
 451  *    If the `packet' is non-NULL it will be injected into the new packet
 452  *    stream as soon as the scheduler associated with `stream' schedules
 453  *    new tasks.  It can be used to inject an incoming packet to the stream.
 454  *
 455  *    This interface is for connectionless UDP streams.  If it is possible
 456  *    to create connected stream it should be done for performance reasons.
 457  *
 458  * EXAMPLE
 459  *
 460  *    // Create parent packet stream, it can receive packets from anywhere
 461  *    listener = silc_net_udp_connect("0.0.0.0", 500, NULL, 0, schedule);
 462  *    parent = silc_packet_stream_create(engine, schedule, listener);
 463  *
 464  *    ...
 465  *    // Received a packet to the parent stream, get the sender information.
 466  *    silc_packet_get_sender(packet, &ip, &port);
 467  *
 468  *    // Create new packet stream for this remote location.
 469  *    remote = silc_packet_stream_add_remote(parent, ip, port, packet);
 470  *
 471  ***/
 472 SilcPacketStream silc_packet_stream_add_remote(SilcPacketStream stream,
 473                                                const char *remote_ip,
 474                                                SilcUInt16 remote_port,
 475                                                SilcPacket packet);
 476
 477 /****f* silccore/SilcPacketAPI/silc_packet_stream_destroy
 478  *
 479  * SYNOPSIS
 480  *
 481  *    void silc_packet_stream_destroy(SilcPacketStream stream);
 482  *
 483  * DESCRIPTION
 484  *
 485  *    Destroy packet stream and the underlaying stream.  This will also
 486  *    close and destroy the underlaying stream.
 487  *
 488  ***/
 489 void silc_packet_stream_destroy(SilcPacketStream stream);
 490
 491 /****f* silccore/SilcPacketAPI/silc_packet_stream_is_valid
 492  *
 493  * SYNOPSIS
 494  *
 495  *    SilcBool silc_packet_stream_is_valid(SilcPacketStream stream);
 496  *
 497  * DESCRIPTION
 498  *
 499  *    Returns TRUE if the packet stream indicated by `stream' is valid and
 500  *    has not been disconnected or destroyed.
 501  *
 502  ***/
 503 SilcBool silc_packet_stream_is_valid(SilcPacketStream stream);
 504
 505 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_router
 506  *
 507  * SYNOPSIS
 508  *
 509  *    void silc_packet_stream_set_router(SilcPacketStream stream);
 510  *
 511  * DESCRIPTION
 512  *
 513  *    When called sets the stream indicates by `stream' as SILC router
 514  *    connection stream.  This causes that certain packets are handled
 515  *    differently.  This must be called for router connection streams and
 516  *    must not be called for any other stream.
 517  *
 518  ***/
 519 void silc_packet_stream_set_router(SilcPacketStream stream);
 520
 521 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_iv_included
 522  *
 523  * SYNOPSIS
 524  *
 525  *    void silc_packet_stream_set_iv_included(SilcPacketStream stream);
 526  *
 527  * DESCRIPTION
 528  *
 529  *    Sets an IV Included property for the stream indicated by `stream'.
 530  *    This means that the IV used in the encryption will be included in
 531  *    the resulted ciphertext.  This makes it possible to send and receive
 532  *    packets on unreliable network transport protocol, such as UDP/IP.
 533  *    This must be called if the underlaying stream in the `stream' is UDP
 534  *    stream.
 535  *
 536  *    When this is set to the stream the silc_packet_set_sid must be called
 537  *    to set new Security ID.  The Security ID will be included with the IV
 538  *    in the ciphertext.
 539  *
 540  ***/
 541 void silc_packet_stream_set_iv_included(SilcPacketStream stream);
 542
 543 /****f* silccore/SilcPacketAPI/silc_packet_stream_set_stream
 544  *
 545  * SYNOPSIS
 546  *
 547  *    void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
 548  *                                       SilcStream stream);
 549  *
 550  * DESCRIPTION
 551  *
 552  *    This function may be used to change the underlaying stream in the
 553  *    packet stream indicated by `packet_stream'.  Note that the old
 554  *    stream will not be used after calling this function.  The caller is
 555  *    responsible destroying the old stream.  The `stream' will use
 556  *    the same scheduler as the `packet_stream'.
 557  *
 558  ***/
 559 void silc_packet_stream_set_stream(SilcPacketStream packet_stream,
 560                                    SilcStream stream);
 561
 562 /****f* silccore/SilcPacketAPI/silc_packet_stream_get_stream
 563  *
 564  * SYNOPSIS
 565  *
 566  *    SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
 567  *
 568  * DESCRIPTION
 569  *
 570  *    Returns the actual stream that is associated with the packet stream
 571  *    `stream'.  The caller must not free the returned stream.  The returned
 572  *    stream is the same pointer that was set for silc_packet_stream_create.
 573  *    This function could be used for example when an error callback is
 574  *    called by the packet engine to retrieve the actual lower level error
 575  *    from the stream.
 576  *
 577  ***/
 578 SilcStream silc_packet_stream_get_stream(SilcPacketStream stream);
 579
 580 /****f* silccore/SilcPacketAPI/silc_packet_stream_link
 581  *
 582  * SYNOPSIS
 583  *
 584  *    SilcBool silc_packet_stream_link(SilcPacketStream stream,
 585  *                                     SilcPacketCallbacks *callbacks,
 586  *                                     void *callback_context,
 587  *                                     int priority, ...);
 588  *
 589  * DESCRIPTION
 590  *
 591  *    Links the packet processing callbacks indicated by `callbacks' into
 592  *    the packet stream indicated by `stream' with priority `priority' for
 593  *    the packet types given in the variable argument list.  This function
 594  *    can be used to link to the packet stream for specific packet types
 595  *    and receive them in the specified callbacks.  This way, a third party,
 596  *    for example some library may attach itself into the packet stream
 597  *    and receive and process certain packets.  The variable argument
 598  *    list is ended with -1.  To link to receive all packets use
 599  *    SILC_PACKET_ANY.
 600  *
 601  *    The default packet processing callbacks given as argument to the
 602  *    silc_packet_engine_start has the priority 0.  Any priority higher
 603  *    than 0 will then take precedence over the default callbacks.  Any
 604  *    priority lower than 0 (negative value) will be processed after the
 605  *    default callbacks.
 606  *
 607  *    Note that setting only the 'packet_receive' callback in the `callbacks'
 608  *    is required.
 609  *
 610  * EXAMPLE
 611  *
 612  *    // Link to this packet stream, with high priority, for
 613  *    // SILC_PACKET_CONNECTION_AUTH and SILC_PACKET_CONNECTION_AUTH_REQUEST
 614  *    // packets. We don't care about other packets.
 615  *    silc_packet_stream_link(stream, our_callbacks, our_context,
 616  *                            1000000, SILC_PACKET_CONNECTION_AUTH,
 617  *                            SILC_PACKET_CONNECTION_AUTH_REQUEST, -1);
 618  *
 619  ***/
 620 SilcBool silc_packet_stream_link(SilcPacketStream stream,
 621                                  SilcPacketCallbacks *callbacks,
 622                                  void *callback_context,
 623                                  int priority, ...);
 624
 625 /****f* silccore/SilcPacketAPI/silc_packet_stream_unlink
 626  *
 627  * SYNOPSIS
 628  *
 629  *    void silc_packet_stream_unlink(SilcPacketStream stream,
 630  *                                   SilcPacketCallbacks *callbacks,
 631  *                                   void *callback_context);
 632  *
 633  * DESCRIPTION
 634  *
 635  *    Unlinks the `callbacks' with `callback_context' from the packet stream
 636  *    indicated by `stream'.  This function must be called for the callbacks
 637  *    that was linked to `stream' when they are not needed anymore.
 638  *
 639  ***/
 640 void silc_packet_stream_unlink(SilcPacketStream stream,
 641                                SilcPacketCallbacks *callbacks,
 642                                void *callback_context);
 643
 644 /****f* silccore/SilcPacketAPI/SilcPacketWrapCoder
 645  *
 646  * SYNOPSIS
 647  *
 648  *    typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream,
 649  *                                            SilcStreamStatus status,
 650  *                                            SilcBuffer buffer,
 651  *                                            void *context);
 652  *
 653  * DESCRIPTION
 654  *
 655  *    The encoder/decoder callback for silc_packet_stream_wrap.  If the
 656  *    `status' is SILC_STREAM_CAN_WRITE then additional data can be added
 657  *    to `buffer'.  It is added before the data that is written with
 658  *    silc_stream_write.  The silc_buffer_enlarge should be called to verify
 659  *    there is enough room in `buffer' before adding data to it.  The `buffer'
 660  *    must not be freed.
 661  *
 662  *    If the `status' is SILC_STREAM_CAN_READ then data from the `buffer'
 663  *    may be read before it is passed to readed when silc_stream_read is
 664  *    called.  The `buffer' may be advanced also to hide data in it.
 665  *
 666  *    This function returns FALSE in case of error.
 667  *
 668  ***/
 669 typedef SilcBool (*SilcPacketWrapCoder)(SilcStream stream,
 670                                         SilcStreamStatus status,
 671                                         SilcBuffer buffer,
 672                                         void *context);
 673
 674 /****f* silccore/SilcPacketAPI/silc_packet_stream_wrap
 675  *
 676  * SYNOPSIS
 677  *
 678  *    SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
 679  *                                       SilcPacketType type,
 680  *                                       SilcPacketFlags flags,
 681  *                                       SilcBool blocking_mode,
 682  *                                       SilcPacketWrapCoder coder,
 683  *                                       void *context);
 684  *
 685  * DESCRIPTION
 686  *
 687  *    Wraps the packet stream indicated by `stream' into a SilcStream for
 688  *    the packet type indicated by `type' with packet flags indicated by
 689  *    `flags'.  The returned SilcStream can be used to read and write the
 690  *    specified SILC packets with the specified packet flags, by calling
 691  *    silc_stream_read and silc_stream_write, respectively.  The returned
 692  *    stream can be destroyed by calling silc_stream_destroy.  It does not
 693  *    destroy the wrapped packet stream.
 694  *
 695  *    If the `blocking_mode' mode is TRUE then the silc_stream_read and
 696  *    silc_stream_write may block the calling process or thread until SILC
 697  *    packet is read or written.  If it is FALSE the stream is in non-blocking
 698  *    mode and the calls never block.  The returned stream is thread-safe and
 699  *    packets may be read and written in multi-threaded environment.
 700  *
 701  *    In non-blocking mode the silc_stream_set_notifier must be called before
 702  *    the returned stream can be used to read packets.  The stream status
 703  *    SILC_STREAM_CAN_READ will be returned to the notifier callback to
 704  *    indicate that a packet is ready for reading.  Calling silc_stream_read
 705  *    once returns one complete SILC packet data payload (which is of type of
 706  *    `type').
 707  *
 708  *    The `coder' is optional encoder/decoder callback which the packet engine
 709  *    will call if it is non-NULL.  It can be used to encode additional data
 710  *    into each packet when silc_stream_write is called or decode data before
 711  *    it is passed to reader when silc_stream_read is called.  The `context'
 712  *    is passed to `coder'.
 713  *
 714  *    The returned SilcStream can be used as any normal stream and all
 715  *    SilcStream API functions may be used with the stream.  This returns
 716  *    NULL on error.
 717  *
 718  ***/
 719 SilcStream silc_packet_stream_wrap(SilcPacketStream stream,
 720                                    SilcPacketType type,
 721                                    SilcPacketFlags flags,
 722                                    SilcBool blocking_mode,
 723                                    SilcPacketWrapCoder coder,
 724                                    void *context);
 725
 726 /****f* silccore/SilcPacketAPI/silc_packet_stream_is_udp
 727  *
 728  * SYNOPSIS
 729  *
 730  *    SilcBool silc_packet_stream_is_udp(SilcPacketStream stream);
 731  *
 732  * DESCRIPTION
 733  *
 734  *    Returns TRUE if the packet stream indicated by `stream' is using
 735  *    UDP transport.
 736  *
 737  ***/
 738 SilcBool silc_packet_stream_is_udp(SilcPacketStream stream);
 739
 740 /****f* silccore/SilcPacketAPI/silc_packet_get_sender
 741  *
 742  * SYNOPSIS
 743  *
 744  *    SilcBool silc_packet_get_sender(SilcPacket packet,
 745  *                                    const char **sender_ip,
 746  *                                    SilcUInt16 *sender_port);
 747  *
 748  * DESCRIPTION
 749  *
 750  *    Returns the packet sender's IP address and port from UDP packet
 751  *    indicated by `packet'.  This can be called only from the packet
 752  *    callback to retrieve the information of the packet's sender.  Returns
 753  *    FALSE if the information is not available.
 754  *
 755  ***/
 756 SilcBool silc_packet_get_sender(SilcPacket packet,
 757                                 const char **sender_ip,
 758                                 SilcUInt16 *sender_port);
 759
 760 /****f* silccore/SilcPacketAPI/silc_packet_stream_ref
 761  *
 762  * SYNOPSIS
 763  *
 764  *    void silc_packet_stream_ref(SilcPacketStream stream);
 765  *
 766  * DESCRIPTION
 767  *
 768  *    Increase reference counter for the stream indicated by `stream'.  This
 769  *    can be used to take a reference for the stream.  To unreference the
 770  *    stream call silc_packet_stream_unref function.
 771  *
 772  ***/
 773 void silc_packet_stream_ref(SilcPacketStream stream);
 774
 775 /****f* silccore/SilcPacketAPI/silc_packet_stream_unref
 776  *
 777  * SYNOPSIS
 778  *
 779  *    void silc_packet_stream_unref(SilcPacketStream stream);
 780  *
 781  * DESCRIPTION
 782  *
 783  *    Decrease reference counter for the stream indicated by `stream'.  If
 784  *    the counter hits zero the stream will be destroyed automatically.
 785  *
 786  ***/
 787 void silc_packet_stream_unref(SilcPacketStream stream);
 788
 789 /****f* silccore/SilcPacketAPI/silc_packet_get_engine
 790  *
 791  * SYNOPSIS
 792  *
 793  *    SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
 794  *
 795  * DESCRIPTION
 796  *
 797  *    Returns the packet engine from the `stream'.
 798  *
 799  ***/
 800 SilcPacketEngine silc_packet_get_engine(SilcPacketStream stream);
 801
 802 /****f* silccore/SilcPacketAPI/silc_packet_set_context
 803  *
 804  * SYNOPSIS
 805  *
 806  *    void silc_packet_set_context(SilcPacketStream stream,
 807  *                                 void *stream_context);
 808  *
 809  * DESCRIPTION
 810  *
 811  *    Sets a stream specific context to the stream.  The context will
 812  *    be delivered to all callback functions, and it can be retrieved by
 813  *    calling silc_packet_get_context function as well.  Note that this is
 814  *    separate packet stream specific context, and not the same as
 815  *    `callback_context' in silc_packet_engine_start.  Both will be delivered
 816  *    to the callbacks, and this context as the `stream_context' argument.
 817  *
 818  ***/
 819 void silc_packet_set_context(SilcPacketStream stream, void *stream_context);
 820
 821 /****f* silccore/SilcPacketAPI/silc_packet_get_context
 822  *
 823  * SYNOPSIS
 824  *
 825  *    void *silc_packet_get_context(SilcPacketStream stream);
 826  *
 827  * DESCRIPTION
 828  *
 829  *    Returns the current set application context, or NULL if none is set.
 830  *
 831  ***/
 832 void *silc_packet_get_context(SilcPacketStream stream);
 833
 834 /****f* silccore/SilcPacketAPI/silc_packet_set_keys
 835  *
 836  * SYNOPSIS
 837  *
 838  *    void silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key,
 839  *                              SilcCipher receive_key, SilcHmac send_hmac,
 840  *                              SilcHmac receive_hmac, SilcBool rekey);
 841  *
 842  * DESCRIPTION
 843  *
 844  *    Set ciphers and HMACs to be used to encrypt sent packets, and decrypt
 845  *    received packets.  This can be called multiple times to change the
 846  *    ciphers and HMACs.
 847  *
 848  *    If the `rekey' is TRUE this function will send SILC_PACKET_REKEY_DONE
 849  *    to the `stream' and will set the new keys.  If it is FALSE the keys
 850  *    are changed but the packet is not changed.
 851  *
 852  *    When changing keys the old cipher and HMACs will be freed.  If the keys
 853  *    are not set at all, packets will not be encrypted or decrypted.
 854  *
 855  ***/
 856 SilcBool silc_packet_set_keys(SilcPacketStream stream, SilcCipher send_key,
 857                               SilcCipher receive_key, SilcHmac send_hmac,
 858                               SilcHmac receive_hmac, SilcBool rekey);
 859
 860 /****f* silccore/SilcPacketAPI/silc_packet_get_keys
 861  *
 862  * SYNOPSIS
 863  *
 864  *    SilcBool silc_packet_get_keys(SilcPacketStream stream,
 865  *                                  SilcCipher *send_key,
 866  *                                  SilcCipher *receive_key,
 867  *                                  SilcHmac *send_hmac,
 868  *                                  SilcHmac *receive_hmac);
 869  *
 870  * DESCRIPTION
 871  *
 872  *    Returns the pointers of current ciphers and HMACs from the `stream'.
 873  *    Returns FALSE if keys are not set.
 874  *
 875  ***/
 876 SilcBool silc_packet_get_keys(SilcPacketStream stream,
 877                               SilcCipher *send_key, SilcCipher *receive_key,
 878                               SilcHmac *send_hmac, SilcHmac *receive_hmac);
 879
 880 /****f* silccore/SilcPacketAPI/silc_packet_set_ids
 881  *
 882  * SYNOPSIS
 883  *
 884  *    SilcBool silc_packet_set_ids(SilcPacketStream stream,
 885  *                                 SilcIdType src_id_type, const void *src_id
 886  *                                 SilcIdType dst_id_type, const void *dst_id);
 887  *
 888  * DESCRIPTION
 889  *
 890  *    Set the source ID and destination ID to be used when sending packets to
 891  *    this packet stream.  The IDs to be used for a packet stream can be
 892  *    overridden when sending packets.  However, if the IDs do not ever change
 893  *    for the packet stream it is recommended they are set using this function.
 894  *    In this case they can be omitted when sending packets to the stream.
 895  *    It is also possible to set only source or destination ID.
 896  *
 897  ***/
 898 SilcBool silc_packet_set_ids(SilcPacketStream stream,
 899                              SilcIdType src_id_type, const void *src_id,
 900                              SilcIdType dst_id_type, const void *dst_id);
 901
 902 /****f* silccore/SilcPacketAPI/silc_packet_set_ids
 903  *
 904  * SYNOPSIS
 905  *
 906  *    SilcBool silc_packet_get_ids(SilcPacketStream stream,
 907  *                                 SilcBool *src_id_set, SilcID *src_id,
 908  *                                 SilcBool *dst_id_set, SilcID *dst_id);
 909  *
 910  * DESCRIPTION
 911  *
 912  *    Returns source and destination IDs from the packet stream.  The
 913  *    `src_id_set' is set to TRUE if the source ID was returned.  The
 914  *    `dst_id_set' is set to TRUE if the destination ID was returned.
 915  *
 916  ***/
 917 SilcBool silc_packet_get_ids(SilcPacketStream stream,
 918                              SilcBool *src_id_set, SilcID *src_id,
 919                              SilcBool *dst_id_set, SilcID *dst_id);
 920
 921 /****f* silccore/SilcPacketAPI/silc_packet_set_sid
 922  *
 923  * SYNOPSIS
 924  *
 925  *    SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
 926  *
 927  * DESCRIPTION
 928  *
 929  *    Sets new Security ID to the packet stream indicated by `stream'.  This
 930  *    is called only if the IV Included property was set to the stream
 931  *    by calling silc_packet_stream_set_iv_included.  This function sets
 932  *    new Security ID to the stream which is then included in the ciphertext
 933  *    of a packet.  The `sid' must be 0 when it is set for the very first
 934  *    time and must be increased by one after each rekey.  This function must
 935  *    be called every time new keys are added to the stream after a rekey.
 936  *
 937  *    If this function is called when the IV Included property has not been
 938  *    set to the stream the `sid' will be ignored.  Returns FALSE if the
 939  *    IV Included has not been set, TRUE otherwise.
 940  *
 941  ***/
 942 SilcBool silc_packet_set_sid(SilcPacketStream stream, SilcUInt8 sid);
 943
 944 /****f* silccore/SilcPacketAPI/silc_packet_send
 945  *
 946  * SYNOPSIS
 947  *
 948  *    SilcBool silc_packet_send(SilcPacketStream stream,
 949  *                              SilcPacketType type, SilcPacketFlags flags,
 950  *                              const unsigned char *data,
 951  *                              SilcUInt32 data_len);
 952  *
 953  * DESCRIPTION
 954  *
 955  *    Send `data' of length of `data_len' to the packet stream indicated by
 956  *    `stream'.  If ciphers and HMACs were set using silc_packet_set_keys
 957  *    the packet will be encrypted and MAC will be computed for it.  If
 958  *    silc_packet_set_ids was used to set source and destination ID for the
 959  *    packet stream those IDs are used in the packet.  If IDs have not been
 960  *    set and they need to be provided then silc_packet_send_ext function
 961  *    should be used.  Otherwise, the packet will not have IDs set at all.
 962  *    Returns FALSE if packet could not be sent.
 963  *
 964  ***/
 965 SilcBool silc_packet_send(SilcPacketStream stream,
 966                           SilcPacketType type, SilcPacketFlags flags,
 967                           const unsigned char *data, SilcUInt32 data_len);
 968
 969 /****f* silccore/SilcPacketAPI/silc_packet_send_ext
 970  *
 971  * SYNOPSIS
 972  *
 973  *    SilcBool
 974  *    silc_packet_send_ext(SilcPacketStream stream,
 975  *                         SilcPacketType type, SilcPacketFlags flags,
 976  *                         SilcIdType src_id_type, void *srd_id,
 977  *                         SilcIdType dst_id_type, void *dst_id,
 978  *                         const unsigned char *data, SilcUInt32 data_len,
 979  *                         SilcCipher cipher, SilcHmac hmac);
 980  *
 981  * DESCRIPTION
 982  *
 983  *    Same as silc_packet_send but with this function different sending
 984  *    parameters can be sent as argument.  This function can be used to
 985  *    set specific IDs, cipher and HMAC to be used in packet sending,
 986  *    instead of the ones saved in the `stream'.  If any of the extra
 987  *    pointers are NULL, default values set to the stream will apply.
 988  *
 989  ***/
 990 SilcBool silc_packet_send_ext(SilcPacketStream stream,
 991                               SilcPacketType type, SilcPacketFlags flags,
 992                               SilcIdType src_id_type, void *src_id,
 993                               SilcIdType dst_id_type, void *dst_id,
 994                               const unsigned char *data, SilcUInt32 data_len,
 995                               SilcCipher cipher, SilcHmac hmac);
 996
 997 /****f* silccore/SilcPacketAPI/silc_packet_send_va
 998  *
 999  * SYNOPSIS
1000  *
1001  *    SilcBool silc_packet_send_va(SilcPacketStream stream,
1002  *                                 SilcPacketType type,
1003  *                                 SilcPacketFlags flags, ...);
1004  *
1005  * DESCRIPTION
1006  *
1007  *    Same as silc_packet_send but takes the data in as variable argument
1008  *    formatted buffer (see silcbuffmt.h).  The arguments must be ended
1009  *    with SILC_STR_END.  Returns FALSE if packet could not be sent or
1010  *    the buffer could not be formatted.
1011  *
1012  * EXAMPLE
1013  *
1014  *    // Send NEW_CLIENT packet
1015  *    silc_packet_send_va(stream, SILC_PACKET_NEW_CLIENT, 0,
1016  *                        SILC_STR_UI_SHORT(username_len),
1017  *                        SILC_STR_DATA(username, username_len),
1018  *                        SILC_STR_UI_SHORT(realname_len),
1019  *                        SILC_STR_DATA(realname, realname_len),
1020  *                        SILC_STR_END);
1021  *
1022  ***/
1023 SilcBool silc_packet_send_va(SilcPacketStream stream,
1024                              SilcPacketType type, SilcPacketFlags flags, ...);
1025
1026 /****f* silccore/SilcPacketAPI/silc_packet_send_va_ext
1027  *
1028  * SYNOPSIS
1029  *
1030  *    SilcBool
1031  *    silc_packet_send_va_ext(SilcPacketStream stream,
1032  *                            SilcPacketType type, SilcPacketFlags flags,
1033  *                            SilcIdType src_id_type, void *srd_id,
1034  *                            SilcIdType dst_id_type, void *dst_id,
1035  *                            SilcCipher cipher, SilcHmac hmac, ...);
1036  *
1037  * DESCRIPTION
1038  *
1039  *    Same as silc_packet_send_va but with this function different sending
1040  *    parameters can be sent as argument.  This function can be used to
1041  *    set specific IDs, cipher and HMAC to be used in packet sending,
1042  *    instead of the ones saved in the `stream'.  If any of the extra
1043  *    pointers are NULL, default values set to the stream will apply.
1044  *
1045  ***/
1046 SilcBool silc_packet_send_va_ext(SilcPacketStream stream,
1047                                  SilcPacketType type, SilcPacketFlags flags,
1048                                  SilcIdType src_id_type, void *src_id,
1049                                  SilcIdType dst_id_type, void *dst_id,
1050                                  SilcCipher cipher, SilcHmac hmac, ...);
1051
1052 /****f* silccore/SilcPacketAPI/silc_packet_wait
1053  *
1054  * SYNOPSIS
1055  *
1056  *    void *silc_packet_wait_init(SilcPacketStream stream, ...);
1057  *
1058  * DESCRIPTION
1059  *
1060  *    Initializes a packet waiter for the packet stream `stream' and
1061  *    for the variable argument list of packet types.  The function
1062  *    silc_packet_wait can be used to block the thread until a packet
1063  *    has been received.  This function is used to initialize the waiting
1064  *    and to give the list of packet types that caller wish to receive.
1065  *    The variable argument list must end with -1.  To receive all
1066  *    packets use SILC_PACKET_ANY.  Returns a context that must be given
1067  *    to the silc_packet_wait function as argument.  Returns NULL on
1068  *    error.  To uninitialize the waiting call silc_packet_wait_uninit.
1069  *
1070  * NOTES
1071  *
1072  *    Note that packets may be available immediately after calling this
1073  *    function and they will be buffered, until silc_packet_wait is called.
1074  *
1075  * EXAMPLE
1076  *
1077  *    void *waiter;
1078  *
1079  *    // Will wait for private message packets
1080  *    waiter = silc_packet_wait_init(stream,
1081  *                                   SILC_PACKET_PRIVATE_MESSAGE, -1);
1082  *
1083  *
1084  ***/
1085 void *silc_packet_wait_init(SilcPacketStream stream, ...);
1086
1087 /****f* silccore/SilcPacketAPI/silc_packet_wait_uninit
1088  *
1089  * SYNOPSIS
1090  *
1091  *    void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
1092  *
1093  * DESCRIPTION
1094  *
1095  *    Uninitializes the waiting context.  This may be called also from
1096  *    another thread while other thread is waiting for packets.  This will
1097  *    inform the waiting thread to stop waiting.
1098  *
1099  ***/
1100 void silc_packet_wait_uninit(void *waiter, SilcPacketStream stream);
1101
1102 /****f* silccore/SilcPacketAPI/silc_packet_wait
1103  *
1104  * SYNOPSIS
1105  *
1106  *    int silc_packet_wait(void *waiter, int timeout,
1107  *                         SilcPacket *return_packet)
1108  *
1109  * DESCRIPTION
1110  *
1111  *    A special function that can be used to wait for a packet to arrive.
1112  *    This function will block the calling process or thread until either
1113  *    a packet is received into the `return_packet' pointer or the specified
1114  *    timeout value `timeout', which is in milliseconds, will expire.  If
1115  *    the timeout is 0, no timeout exist.  Before calling this function the
1116  *    silc_packet_wait_init must be called.  The caller is responsible for
1117  *    freeing the returned packet with silc_packet_free.
1118  *
1119  *    This function can be used for example from a thread that wants to
1120  *    block until SILC packet has been received.
1121  *
1122  *    Returns 1 when packet was received, 0 if timeout occurred and -1 if
1123  *    error occurred.
1124  *
1125  * EXAMPLE
1126  *
1127  *    static int foo_read_data(FooContext c)
1128  *    {
1129  *      SilcPacket packet;
1130  *      void *waiter;
1131  *      ...
1132  *
1133  *      // Will wait for private message packets
1134  *      if (c->initialized == FALSE) {
1135  *        waiter = silc_packet_wait_init(stream,
1136  *                                       SILC_PACKET_PRIVATE_MESSAGE, -1);
1137  *        c->initialized = TRUE;
1138  *      }
1139  *
1140  *      ...
1141  *      // Wait here until private message packet is received
1142  *      if ((silc_packet_wait(waiter, 0, &packet)) < 0)
1143  *        return -1;
1144  *
1145  *      ... process packet ...
1146  *
1147  *      return 1;
1148  *    }
1149  *
1150  ***/
1151 int silc_packet_wait(void *waiter, int timeout, SilcPacket *return_packet);
1152
1153 /****f* silccore/SilcPacketAPI/silc_packet_free
1154  *
1155  * SYNOPSIS
1156  *
1157  *    void silc_packet_free(SilcPacket packet);
1158  *
1159  * DESCRIPTION
1160  *
1161  *    This function is used to free the SilcPacket pointer that application
1162  *    receives in the SilcPacketReceive callback.  Application must free
1163  *    the packet if it takes it in to processing.
1164  *
1165  ***/
1166 void silc_packet_free(SilcPacket packet);
1167
1168 #endif /* SILCPACKET_H */