Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 1997 - 2002 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
+/****f* silcutil/SilcUtilAPI/silc_to_upper
*
* SYNOPSIS
*
- * char *silc_get_time();
+ * SilcBool silc_to_upper(const char *string, char *dest,
+ * SilcUInt32 dest_size);
*
* DESCRIPTION
*
- * Returns current time as string.
+ * Converts string to capital characters.
*
***/
-char *silc_get_time();
+SilcBool silc_to_upper(const char *string, char *dest, SilcUInt32 dest_size);
-/****f* silcutil/SilcUtilAPI/silc_to_upper
+/****f* silcutil/SilcUtilAPI/silc_to_lower
*
* SYNOPSIS
*
- * char *silc_to_upper(char *string);
+ * SilcBool silc_to_lower(const char *string, char *dest,
+ * SilcUInt32 dest_size);
*
* DESCRIPTION
*
* Converts string to capital characters.
*
***/
-char *silc_to_upper(char *string);
+SilcBool silc_to_lower(const char *string, char *dest, SilcUInt32 dest_size);
/****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
*
* SYNOPSIS
*
- * bool silc_parse_userfqdn(const char *string, char **left, char **right);
+ * int silc_parse_userfqdn(const char *string,
+ * char *user, SilcUInt32 user_size,
+ * char *fqdn, SilcUInt32 fqdn_size);
*
* DESCRIPTION
*
- * Parse userfqdn string which is in user@fqdn format.
+ * Parse userfqdn string which is in user@fqdn format. Returns 0 on
+ * error, 1 if `user' was filled and 2 if both `user' and `fqdn'
+ * was filled.
*
***/
-bool silc_parse_userfqdn(const char *string, char **left, char **right);
+int silc_parse_userfqdn(const char *string,
+ char *user, SilcUInt32 user_size,
+ char *fqdn, SilcUInt32 fqdn_size);
/****f* silcutil/SilcUtilAPI/silc_parse_command_line
*
***/
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_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_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
- *
- * bool silc_hash_string_compare(void *key1, void *key2,
- * void *user_context);
- *
- * DESCRIPTION
- *
- * Compares two strings. It may be used as SilcHashTable comparison
- * function.
- *
- ***/
-bool silc_hash_string_compare(void *key1, void *key2, void *user_context);
-
-/****f* silcutil/SilcUtilAPI/silc_hash_id_compare
+/****f* silcutil/SilcUtilAPI/silc_fingerprint
*
* SYNOPSIS
*
- * bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
+ * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
*
* 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.
+ * Return a textual representation of the fingerprint in *data, the
+ * 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.
*
***/
-bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
+char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
-/****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
+/****f* silcutil/SilcUtilAPI/silc_string_is_ascii
*
* SYNOPSIS
*
- * bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
+ * SilcBool silc_string_is_ascii(const unsigned char *data,
+ * SilcUInt32 data_len);
*
* DESCRIPTION
*
- * Compare two Client ID's entirely and not just the hash from the ID.
+ * Return TRUE if the `data' is ASCII string.
*
***/
-bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
+SilcBool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
-/****f* silcutil/SilcUtilAPI/silc_hash_data_compare
+/****f* silcutil/SilcUtilAPI/silc_get_input
*
* SYNOPSIS
*
- * bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
+ * char *silc_get_input(const char *prompt, SilcBool echo_off);
*
* DESCRIPTION
*
- * Compares binary data. May be used as SilcHashTable comparison function.
+ * Displays input prompt on command line and takes input data from user.
*
***/
-bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
+char *silc_get_input(const char *prompt, SilcBool echo_off);
-/****f* silcutil/SilcUtilAPI/silc_hash_public_key_compare
- *
- * SYNOPSIS
- *
- * bool 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.
- *
- ***/
-bool silc_hash_public_key_compare(void *key1, void *key2, void *user_context);
+/* System dependant prototypes */
-/****f* silcutil/SilcUtilAPI/silc_client_chmode
+/****f* silcutil/SilcUtilAPI/silc_get_username
*
* SYNOPSIS
*
- * char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
- * const char *hmac);
+ * char *silc_get_username();
*
* 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
+ * Returns the username of the user. If the global variable LOGNAME
+ * does not exists we will get the name from the passwd file. The
+ * caller must free the returned name.
*
- * Parses channel user mode mask and returns te mode as string.
+ * This function is system dependant.
*
***/
-char *silc_client_chumode(SilcUInt32 mode);
+char *silc_get_username();
-/****f* silcutil/SilcUtilAPI/silc_client_chumode_char
+/****f* silcutil/SilcUtilAPI/silc_get_real_name
*
* SYNOPSIS
*
- * char *silc_client_chumode_char(SilcUInt32 mode);
+ * char *silc_get_real_name();
*
* DESCRIPTION
*
- * Parses channel user mode and returns it as special mode character.
+ * Returns the real name of ther user from the passwd file. The
+ * caller must free the returned name.
*
- ***/
-char *silc_client_chumode_char(SilcUInt32 mode);
-
-/****f* silcutil/SilcUtilAPI/silc_fingerprint
- *
- * SYNOPSIS
- *
- * char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
- *
- * DESCRIPTION
- *
- * Creates fingerprint from data, usually used with SHA1 digests.
+ * This function is system dependant.
*
***/
-char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
+char *silc_get_real_name();
-/****f* silcutil/SilcUtilAPI/silc_string_is_ascii
+/****f* silcutil/SilcUtilAPI/silc_va_copy
*
* SYNOPSIS
*
- * bool silc_string_is_ascii(const unsigned char *data,
- * SilcUInt32 data_len);
+ * void silc_va_copy(va_list dest, va_list src);
*
* DESCRIPTION
*
- * Return TRUE if the `data' is ASCII string.
+ * 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.
*
***/
-bool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
-
-/****f* silcutil/SilcUtilAPI/silc_parse_version_string
+#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_hexdump
*
* SYNOPSIS
*
- * bool silc_parse_version_string(const char *version,
- * SilcUInt32 *protocol_version,
- * char **protocol_version_string,
- * SilcUInt32 *software_version,
- * char **software_version_string,
- * char **vendor_version);
+ * void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
+ * FILE *output);
*
* DESCRIPTION
*
- * Parses SILC protocol style version string.
+ * Dumps the `data' of length of `data_len' bytes as HEX. The `output'
+ * file specifies the destination.
*
***/
-bool silc_parse_version_string(const char *version,
- SilcUInt32 *protocol_version,
- char **protocol_version_string,
- SilcUInt32 *software_version,
- char **software_version_string,
- char **vendor_version);
+void silc_hexdump(const unsigned char *data, SilcUInt32 data_len,
+ FILE *output);
-/****f* silcutil/SilcUtilAPI/silc_version_to_num
+/****f* silcutil/SilcUtilAPI/silc_hex2data
*
* SYNOPSIS
*
- * SilcUInt32 silc_version_to_num(const char *version);
+ * SilcBool silc_hex2data(const char *hex, unsigned char *data,
+ * SilcUInt32 data_size, SilcUInt32 *ret_data_len);
*
* DESCRIPTION
*
- * Converts version string x.x into number representation.
+ * Converts HEX character string to binary data. Each HEX numbers must
+ * have two characters in the `hex' string.
*
***/
-SilcUInt32 silc_version_to_num(const char *version);
+SilcBool silc_hex2data(const char *hex, unsigned char *data,
+ SilcUInt32 data_size, SilcUInt32 *ret_data_len);
-/****f* silcutil/SilcUtilAPI/silc_get_input
+/****f* silcutil/SilcUtilAPI/silc_data2hex
*
* SYNOPSIS
*
- * char *silc_get_input(const char *prompt, bool echo_off);
+ * SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
+ * char *hex, SilcUInt32 hex_size);
*
* DESCRIPTION
*
- * Displays input prompt on command line and takes input data from user.
+ * Converts binary data to HEX string. This NULL terminates the `hex'
+ * buffer automatically.
*
***/
-char *silc_get_input(const char *prompt, bool echo_off);
-
-/* XXX - System dependant prototypes */
-
-int silc_gettimeofday(struct timeval *p);
-char *silc_string_regexify(const char *string);
-int silc_string_regex_match(const char *regex, const char *string);
-int silc_string_match(const char *string1, const char *string2);
-char *silc_get_username();
-char *silc_get_real_name();
+SilcBool silc_data2hex(const unsigned char *data, SilcUInt32 data_len,
+ char *hex, SilcUInt32 hex_size);
#endif /* !SILCUTIL_H */
projects / crypto.git / blobdiff