Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2005 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_get_time
- *
- * SYNOPSIS
- *
- * const char *silc_get_time(SilcUInt32 timeval)
- *
- * DESCRIPTION
- *
- * Returns time as string. If the the `timeval' is non-zero that
- * value is returned as string. If it is zero the current time of the
- * local machine is returned.
- *
- ***/
-const char *silc_get_time(SilcUInt32 timeval);
-
/****f* silcutil/SilcUtilAPI/silc_to_upper
*
* SYNOPSIS
*
- * SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
+ * SilcBool silc_to_upper(const char *string, char *dest,
+ * SilcUInt32 dest_size);
*
* DESCRIPTION
*
*
* SYNOPSIS
*
- * SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
+ * SilcBool silc_to_lower(const char *string, char *dest,
+ * SilcUInt32 dest_size);
*
* DESCRIPTION
*
***/
char *silc_format(char *fmt, ...);
-/****f* silcutil/SilcUtilAPI/silc_id_render
- *
- * SYNOPSIS
- *
- * char *silc_id_render(void *id, SilcUInt16 type);
- *
- * DESCRIPTION
- *
- * Renders ID to suitable to print for example to log file.
- *
- ***/
-char *silc_id_render(void *id, SilcUInt16 type);
-
-/****f* silcutil/SilcUtilAPI/silc_string_compare
- *
- * SYNOPSIS
- *
- * int silc_string_compare(char *string1, char *string2);
- *
- * DESCRIPTION
- *
- * Compares two strings. Strings may include wildcards '*' and '?'.
- * Returns TRUE if strings match.
- *
- ***/
-int silc_string_compare(char *string1, char *string2);
-
-/****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 is used usually with nicknames, channel and server names to provide
- * case insensitive keys.
- *
- ***/
-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_public_key
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_hash_public_key(void *key, void *user_context);
- *
- * DESCRIPTION
- *
- * Hashed SILC Public key.
- *
- ***/
-SilcUInt32 silc_hash_public_key(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. 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_hash_public_key_compare
- *
- * SYNOPSIS
- *
- * SilcBool silc_hash_public_key_compare(void *key1, void *key2,
- * void *user_context);
- *
- * DESCRIPTION
- *
- * Compares two SILC Public keys. It may be used as SilcHashTable
- * comparison function.
- *
- ***/
-SilcBool silc_hash_public_key_compare(void *key1, void *key2,
- void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_client_chmode
- *
- * SYNOPSIS
- *
- * char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
- * const char *hmac);
- *
- * DESCRIPTION
- *
- * Parses mode mask and returns the mode as string.
- *
- ***/
-char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
- const char *hmac);
-
-/****f* silcutil/SilcUtilAPI/silc_client_chumode
- *
- * SYNOPSIS
- *
- * char *silc_client_chumode(SilcUInt32 mode);
- *
- * DESCRIPTION
- *
- * Parses channel user mode mask and returns te mode as string.
- *
- ***/
-char *silc_client_chumode(SilcUInt32 mode);
-
-/****f* silcutil/SilcUtilAPI/silc_client_chumode_char
- *
- * SYNOPSIS
- *
- * char *silc_client_chumode_char(SilcUInt32 mode);
- *
- * DESCRIPTION
- *
- * Parses channel user mode and returns it as special mode character.
- *
- ***/
-char *silc_client_chumode_char(SilcUInt32 mode);
-
/****f* silcutil/SilcUtilAPI/silc_fingerprint
*
* SYNOPSIS
* 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);
***/
SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
-/****f* silcutil/SilcUtilAPI/silc_parse_version_string
- *
- * SYNOPSIS
- *
- * SilcBool silc_parse_version_string(const char *version,
- * SilcUInt32 *protocol_version,
- * char **protocol_version_string,
- * SilcUInt32 *software_version,
- * char **software_version_string,
- * char **vendor_version);
- *
- * DESCRIPTION
- *
- * Parses SILC protocol style version string.
- *
- ***/
-SilcBool silc_parse_version_string(const char *version,
- SilcUInt32 *protocol_version,
- char **protocol_version_string,
- SilcUInt32 *software_version,
- char **software_version_string,
- char **vendor_version);
-
-/****f* silcutil/SilcUtilAPI/silc_version_to_num
- *
- * SYNOPSIS
- *
- * SilcUInt32 silc_version_to_num(const char *version);
- *
- * DESCRIPTION
- *
- * Converts version string x.x into number representation.
- *
- ***/
-SilcUInt32 silc_version_to_num(const char *version);
-
/****f* silcutil/SilcUtilAPI/silc_get_input
*
* SYNOPSIS
/* System dependant prototypes */
-/****f* silcutil/SilcUtilAPI/silc_gettimeofday
- *
- * SYNOPSIS
- *
- * int silc_gettimeofday(struct timeval *p);
- *
- * DESCRIPTION
- *
- * Return current time to struct timeval. This function is system
- * dependant. Returns 0 on success and -1 on error.
- *
- ***/
-int silc_gettimeofday(struct timeval *p);
-
-/****f* silcutil/SilcUtilAPI/silc_compare_timeval
- *
- * SYNOPSIS
- *
- * SilcBool silc_compare_timeval(struct timeval *smaller,
- * struct timeval *bigger)
- *
- * DESCRIPTION
- *
- * Compare two timeval structures and return TRUE if the first
- * time value is smaller than the second time value.
- *
- ***/
-SilcBool silc_compare_timeval(struct timeval *smaller,
- struct timeval *bigger);
-
-/****f* silcutil/SilcUtilAPI/silc_string_regexify
- *
- * SYNOPSIS
- *
- * char *silc_string_regexify(const char *string);
- *
- * DESCRIPTION
- *
- * Inspects the `string' for wildcards and returns regex string that can
- * be used by the GNU regex library. A comma (`,') in the `string' means
- * that the string is list.
- *
- * This function is system dependant.
- *
- ***/
-char *silc_string_regexify(const char *string);
-
-/****f* silcutil/SilcUtilAPI/silc_string_regex_match
- *
- * SYNOPSIS
- *
- * int silc_string_regex_match(const char *regex, const char *string);
- *
- * DESCRIPTION
- *
- * Matches the two strings and returns TRUE if the strings match.
- *
- * This function is system dependant.
- *
- ***/
-int silc_string_regex_match(const char *regex, const char *string);
-
-/****f* silcutil/SilcUtilAPI/silc_string_match
- *
- * SYNOPSIS
- *
- * int silc_string_match(const char *string1, const char *string2);
- *
- * DESCRIPTION
- *
- * Do regex match to the two strings `string1' and `string2'. If the
- * `string2' matches the `string1' this returns TRUE.
- *
- * This function is system dependant.
- *
- ***/
-int silc_string_match(const char *string1, const char *string2);
-
/****f* silcutil/SilcUtilAPI/silc_get_username
*
* SYNOPSIS
***/
char *silc_get_real_name();
-/****f* silcutil/SilcUtilAPI/silc_get_mode_list
+/****f* silcutil/SilcUtilAPI/silc_va_copy
*
* SYNOPSIS
*
- * SilcBool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
- * SilcUInt32 **list);
+ * void silc_va_copy(va_list dest, va_list src);
*
* DESCRIPTION
*
- * Returns modes from list of 32 bit MSB first order values that are
- * encoded one after the other in the `mode_list' into the `list'
- * array. The caller must free the returned list. Return FALSE if
- * there is error parsing the list.
+ * Copies variable argument list. This must be called in case the
+ * variable argument list must be evaluated multiple times. For each
+ * evaluation the list must be copied and va_end must be called for
+ * each copied list.
*
***/
-SilcBool silc_get_mode_list(SilcBuffer mode_list, SilcUInt32 mode_list_count,
- SilcUInt32 **list);
+#if defined(HAVE_VA_COPY)
+#define silc_va_copy(dest, src) va_copy(dest, src);
+#elif defined(HAVE___VA_COPY)
+#define silc_va_copy(dest, src) __va_copy(dest, src);
+#elif defined(SILC_VA_COPY_ARRAY)
+#define silc_va_copy(dest, src) memmove(dest, src, sizeof(va_list));
+#else
+#define silc_va_copy(dest, src) dest = src;
+#endif
-/****f* silcutil/SilcUtilAPI/silc_get_status_message
+/****f* silcutil/SilcUtilAPI/silc_hexdump
*
* SYNOPSIS
*
- * char *silc_get_status_message(SilcStatus status)
+ * void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
+ * FILE *output);
*
* DESCRIPTION
*
- * Returns status message string
+ * Dumps the `data' of length of `data_len' bytes as HEX. The `output'
+ * file specifies the destination.
*
***/
-const char *silc_get_status_message(unsigned char status);
+void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
+ FILE *output);
-/****f* silcutil/SilcUtilAPI/silc_get_packet_name
+/****f* silcutil/SilcUtilAPI/silc_hex2data
*
* SYNOPSIS
*
- * char *silc_get_packet_name(SilcPacketType type);
+ * SilcBool silc_hex2data(const char *hex, unsigned char *data,
+ * SilcUInt32 data_size, SilcUInt32 *ret_data_len);
*
* DESCRIPTION
*
- * Returns the name corresponding packet type `type'.
+ * Converts HEX character string to binary data. Each HEX numbers must
+ * have two characters in the `hex' string.
*
***/
-const char *silc_get_packet_name(unsigned char type);
+SilcBool silc_hex2data(const char *hex, unsigned char *data,
+ SilcUInt32 data_size, SilcUInt32 *ret_data_len);
-/****f* silcutil/SilcUtilAPI/silc_get_command_name
+/****f* silcutil/SilcUtilAPI/silc_data2hex
*
* SYNOPSIS
*
- * char *silc_get_command_name(SilcCommand command);
+ * SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
+ * char *hex, SilcUInt32 hex_size);
*
* DESCRIPTION
*
- * Returns the name corresponding SILC command `command'.
+ * Converts binary data to HEX string. This NULL terminates the `hex'
+ * buffer automatically.
*
***/
-const char *silc_get_command_name(unsigned char command);
+SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
+ char *hex, SilcUInt32 hex_size);
#endif /* !SILCUTIL_H */
projects / crypto.git / blobdiff