Moved SILC protocol ID utility functions to SILC core library.
[crypto.git] / lib / silcutil / silcutil.h
index e62e768d15d0bede90cb82b3f191969e0ea07bde..726c67f4f455c6161d0ac3d20ce4573d03196aef 100644 (file)
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 1997 - 2007 Pekka Riikonen
+  Copyright (C) 1997 - 2008 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
  ***/
 int silc_gets(char *dest, int destlen, const char *src, int srclen, int begin);
 
-/****f* silcutil/SilcUtilAPI/silc_check_line
- *
- * SYNOPSIS
- *
- *    int silc_check_line(char *buf);
- *
- * DESCRIPTION
- *
- *    Checks line for illegal characters. Return -1 when illegal character
- *    were found. This is used to check for bad lines when reading data from
- *    for example a configuration file.
- *
- ***/
-int silc_check_line(char *buf);
-
 /****f* silcutil/SilcUtilAPI/silc_to_upper
  *
  * SYNOPSIS
@@ -146,192 +131,6 @@ void silc_parse_command_line(unsigned char *buffer,
  ***/
 char *silc_format(char *fmt, ...);
 
-/****f* silcutil/SilcUtilAPI/silc_hash_string
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_string(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- *    Basic has function to hash strings. May be used with the SilcHashTable.
- *    Note that this lowers the characters of the string (with tolower()) so
- *    this can be used to provide case-insensitive hashing.
- *
- ***/
-SilcUInt32 silc_hash_string(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_utf8_string
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- *    Basic has function to hash UTF-8 strings. May be used with the
- *    SilcHashTable.  Used with identifier strings.  The key is
- *    expected to be casefolded.
- *
- ***/
-SilcUInt32 silc_hash_utf8_string(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_uint
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_uint(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- *    Basic hash function to hash integers. May be used with the SilcHashTable.
- *
- ***/
-SilcUInt32 silc_hash_uint(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_ptr
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_ptr(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- *    Basic hash funtion to hash pointers. May be used with the SilcHashTable.
- *
- ***/
-SilcUInt32 silc_hash_ptr(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_id
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_id(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- *    Hash a ID. The `user_context' is the ID type.
- *
- ***/
-SilcUInt32 silc_hash_id(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_client_id_hash
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context)
- *
- * DESCRIPTION
- *
- *    Hash Client ID's hash.
- *
- ***/
-SilcUInt32 silc_hash_client_id_hash(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_data
- *
- * SYNOPSIS
- *
- *    SilcUInt32 silc_hash_data(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- *    Hash binary data. The `user_context' is the data length.
- *
- ***/
-SilcUInt32 silc_hash_data(void *key, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_string_compare
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_string_compare(void *key1, void *key2,
- *                                  void *user_context);
- *
- * DESCRIPTION
- *
- *    Compares two strings. This ignores the case while comparing.  It may
- *    be used as SilcHashTable comparison function.
- *
- ***/
-SilcBool silc_hash_string_compare(void *key1, void *key2, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_id_compare
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_id_compare(void *key1, void *key2,
- *                                  void *user_context);
- *
- * DESCRIPTION
- *
- *    Compares two ID's. May be used as SilcHashTable comparison function.
- *    The Client ID's compares only the hash of the Client ID not any other
- *    part of the Client ID. Other ID's are fully compared.
- *
- ***/
-SilcBool silc_hash_id_compare(void *key1, void *key2, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_id_compare_full
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_id_compare_full(void *key1, void *key2,
- *                                       void *user_context)
- *
- * DESCRIPTION
- *
- *    Compares two ID's. May be used as SilcHashTable comparison function.
- *    To compare full ID's instead of only partial, like the
- *    silc_hash_id_compare does, use this function.
- *
- ***/
-SilcBool silc_hash_id_compare_full(void *key1, void *key2, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_client_id_compare(void *key1, void *key2,
- *                                         void *user_context);
- *
- * DESCRIPTION
- *
- *    Compare two Client ID's entirely and not just the hash from the ID.
- *
- ***/
-SilcBool silc_hash_client_id_compare(void *key1, void *key2,
-                                    void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_data_compare
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_data_compare(void *key1, void *key2,
- *                                    void *user_context);
- *
- * DESCRIPTION
- *
- *    Compares binary data. May be used as SilcHashTable comparison function.
- *
- ***/
-SilcBool silc_hash_data_compare(void *key1, void *key2, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_utf8_compare
- *
- * SYNOPSIS
- *
- *    SilcBool silc_hash_utf8_compare(void *key1, void *key2,
- *                                    void *user_context);
- *
- * DESCRIPTION
- *
- *    Compares UTF-8 strings.  Casefolded and NULL terminated strings are
- *    expected.  May be used as SilcHashTable comparison function.
- *
- ***/
-SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
-
 /****f* silcutil/SilcUtilAPI/silc_fingerprint
  *
  * SYNOPSIS
@@ -341,7 +140,9 @@ SilcBool silc_hash_utf8_compare(void *key1, void *key2, void *user_context);
  * DESCRIPTION
  *
  *    Return a textual representation of the fingerprint in *data, the
- *    caller must free the returned string.
+ *    caller must free the returned string.  Returns NULL on error.  If
+ *    the `data_len' is longer than 255 bytes, only the first 255 bytes are
+ *    used to create the fingerprint.
  *
  ***/
 char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);