Added SILC Server library.

[crypto.git] / lib / silccore / silcid.h

diff --git a/lib/silccore/silcid.h b/lib/silccore/silcid.h
index 9fb5630cf3d2d155f8d488608a84582c301a71c3..8bdf6cc0e2e019bcc9db230e7d29de19e311ba01 100644 (file)
--- a/lib/silccore/silcid.h
+++ b/lib/silccore/silcid.h
@@ -1,16 +1,15 @@
 /*
- 
+
   silcid.h
- 
+
   Author: Pekka Riikonen <priikone@silcnet.org>
- 
-  Copyright (C) 1997 - 2000 Pekka Riikonen
- 
+
+  Copyright (C) 1997 - 2005 Pekka Riikonen
+
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
-  the Free Software Foundation; either version 2 of the License, or
-  (at your option) any later version.
- 
+  the Free Software Foundation; version 2 of the License.
+
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
@@ -43,7 +42,7 @@
 /****d* silccore/SilcIDAPI/SilcIdType
  *
  * NAME
- * 
+ *
  *    typedef SilcUInt16 SilcIdType;
  *
  * DESCRIPTION
@@ -72,7 +71,7 @@ typedef SilcUInt16 SilcIdType;
 /****s* silccore/SilcIDAPI/SilcIDPayload
  *
  * NAME
- * 
+ *
  *    typedef struct SilcIDPayloadStruct *SilcIDPayload;
  *
  * DESCRIPTION
@@ -108,18 +107,20 @@ SilcIDPayload silc_id_payload_parse(const unsigned char *payload,
  *
  * SYNOPSIS
  *
- *    void *silc_id_payload_parse_id(const unsigned char *data, 
- *                                   SilcUInt32 len,
- *                                   SilcIdType *type);
+ *    SilcBool silc_id_payload_parse_id(const unsigned char *data,
+ *                                      SilcUInt32 len,
+ *                                      SilcIdType *type, void *ret_id,
+ *                                      SilcUInt32 ret_id_size);
  *
  * DESCRIPTION
  *
- *    Return ID directly from the raw ID Payload data buffer. The
- *    caller must free the returned ID.
+ *    Return ID directly from the raw ID Payload data buffer.  This does
+ *    not allocate any memory.
  *
  ***/
-void *silc_id_payload_parse_id(const unsigned char *data, SilcUInt32 len,
-                              SilcIdType *type);
+SilcBool silc_id_payload_parse_id(const unsigned char *data, SilcUInt32 len,
+                                 SilcIdType *type, void *ret_id,
+                                 SilcUInt32 ret_id_size);
 
 /****f* silccore/SilcIDAPI/silc_id_payload_encode
  *
@@ -182,15 +183,16 @@ SilcIdType silc_id_payload_get_type(SilcIDPayload payload);
  *
  * SYNOPSIS
  *
- *    void *silc_id_payload_get_id(SilcIDPayload payload);
+ *    SilcBool silc_id_payload_get_id(SilcIDPayload payload, void *ret_id,
+ *                                    SilcUInt32 ret_id_len);
  *
  * DESCRIPTION
  *
- *    Returns the ID in the ID Payload. The caller must free the
- *    returned ID.
+ *    Returns the ID in the ID Payload. This does not allocate any memory.
  *
  ***/
-void *silc_id_payload_get_id(SilcIDPayload payload);
+SilcBool silc_id_payload_get_id(SilcIDPayload payload, void *ret_id,
+                               SilcUInt32 ret_id_len);
 
 /****f* silccore/SilcIDAPI/silc_id_payload_get_data
  *
@@ -222,7 +224,7 @@ SilcUInt32 silc_id_payload_get_len(SilcIDPayload payload);
 /****s* silccore/SilcIDAPI/SilcIDIP
  *
  * NAME
- * 
+ *
  *    typedef struct { ... } SilcIDIP;
  *
  * DESCRIPTION
@@ -242,13 +244,13 @@ typedef struct {
 /****s* silccore/SilcIDAPI/SilcServerID
  *
  * NAME
- * 
+ *
  *    typedef struct { ... } SilcServerID;
  *
  * DESCRIPTION
  *
  *    64 or 160 bit SilcServerID structure:
- *  
+ *
  *     n bit IP address
  *    16 bit port
  *    16 bit random number
@@ -265,7 +267,7 @@ typedef struct {
 /****s* silccore/SilcIDAPI/SilcClientID
  *
  * NAME
- * 
+ *
  *    typedef struct { ... } SilcClientID;
  *
  * DESCRIPTION
@@ -288,7 +290,7 @@ typedef struct {
 /****s* silccore/SilcIDAPI/SilcChannelID
  *
  * NAME
- * 
+ *
  *    typedef struct { ... } SilcChannelID;
  *
  * DESCRIPTION
@@ -313,7 +315,7 @@ typedef struct {
 /****d* silccore/SilcIDAPI/SILC_ID_COMPARE
  *
  * NAME
- * 
+ *
  *    #define SILC_ID_COMPARE ...
  *
  * DESCRIPTION
@@ -329,7 +331,7 @@ typedef struct {
 /****d* silccore/SilcIDAPI/SILC_ID_CLIENT_COMPARE
  *
  * NAME
- * 
+ *
  *    #define SILC_ID_CLIENT_COMPARE ...
  *
  * DESCRIPTION
@@ -345,7 +347,7 @@ typedef struct {
 /****d* silccore/SilcIDAPI/SILC_ID_SERVER_COMPARE
  *
  * NAME
- * 
+ *
  *    #define SILC_ID_SERVER_COMPARE ...
  *
  * DESCRIPTION
@@ -361,7 +363,7 @@ typedef struct {
 /****d* silccore/SilcIDAPI/SILC_ID_CHANNEL_COMPARE
  *
  * NAME
- * 
+ *
  *    #define SILC_ID_CHANNEL_COMPARE ...
  *
  * DESCRIPTION
@@ -377,7 +379,7 @@ typedef struct {
 /****d* silccore/SilcIDAPI/SILC_ID_COMPARE_TYPE
  *
  * NAME
- * 
+ *
  *    #define SILC_ID_COMPARE_TYPE ...
  *
  * DESCRIPTION
@@ -395,7 +397,7 @@ typedef struct {
 /****d* silccore/SilcIDAPI/SILC_ID_COMPARE_HASH
  *
  * NAME
- * 
+ *
  *    #define SILC_ID_COMPARE_HASH ...
  *
  * DESCRIPTION
@@ -417,31 +419,38 @@ typedef struct {
  *
  * SYNOPSIS
  *
- *    unsigned char *silc_id_id2str(const void *id, SilcIdType type);
+ *    SilcBool silc_id_id2str(const void *id, SilcIdType type,
+ *                            unsigned char *ret_id, SilcUInt32 ret_id_size,
+ *                            SilcUInt32 *ret_id_len);
  *
  * DESCRIPTION
  *
  *    Converts an ID of type `type' to data. This can be used to
- *    convert the ID's to data for inclusion in the packets.
+ *    convert the ID's to data for inclusion in the packets.  This does
+ *    not allocate any memory.
  *
  ***/
-unsigned char *silc_id_id2str(const void *id, SilcIdType type);
+SilcBool silc_id_id2str(const void *id, SilcIdType type,
+                       unsigned char *ret_id, SilcUInt32 ret_id_size,
+                       SilcUInt32 *ret_id_len);
 
 /****f* silccore/SilcIDAPI/silc_id_str2id
  *
  * SYNOPSIS
  *
- *    void *silc_id_str2id(const unsigned char *id, SilcUInt32 id_len, 
- *                         SilcIdType type);
+ *    SilcBool silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
+ *                            SilcIdType type, void *ret_id,
+ *                            SilcUInt32 ret_id_size);
  *
  * DESCRIPTION
  *
  *    Converts ID data string to an ID. This can be used to get the
- *    ID out of data that has been taken for example from packet.
+ *    ID out of data that has been taken for example from packet.  This
+ *    does not allocate any memory.
  *
  ***/
-void *silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
-                    SilcIdType type);
+SilcBool silc_id_str2id(const unsigned char *id, SilcUInt32 id_len,
+                       SilcIdType type, void *ret_id, SilcUInt32 ret_id_size);
 
 /****f* silccore/SilcIDAPI/silc_id_get_len
  *