Author: Pekka Riikonen <priikone@silcnet.org>
- Copyright (C) 2002 - 2005 Pekka Riikonen
+ Copyright (C) 2002 - 2007 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
unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
SilcUInt32 *ret_len);
-/****f* silcutil/SilcStrUtilAPI/silc_strncat
+/****f* silcutil/SilcStrStrUtilAPI/silc_snprintf
+ *
+ * SYNOPSIS
+ *
+ * int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
+ *
+ * DESCRIPTION
+ *
+ * Produces output string according to the `format'. The formatting
+ * is equivalent to silc_snprintf(3) and sprintf(3). Returns the number of
+ * characters output into `str', at most `size' characters including the
+ * trailing '\0' character. Returns negative value on error.
+ *
+ ***/
+#ifndef SILC_SNPRINTF
+int silc_snprintf(char *str, SilcUInt32 size, const char *format, ...);
+#else
+#define silc_snprintf snprintf
+#endif /* SILC_SNPRINTF */
+
+/****f* silcutil/SilcStrStrUtilAPI/silc_strncat
*
* SYNOPSIS
*
char *silc_strncat(char *dest, SilcUInt32 dest_size,
const char *src, SilcUInt32 src_len);
-/****f* silcutil/SilcStrUtilAPI/silc_identifier_check
+/****f* silcutil/SilcStrUtilAPI/silc_string_regexify
*
* SYNOPSIS
*
- * unsigned char *
- * silc_identifier_check(const unsigned char *identifier,
- * SilcUInt32 identifier_len,
- * SilcStringEncoding identifier_encoding,
- * SilcUInt32 max_allowed_length,
- * SilcUInt32 *out_len);
+ * char *silc_string_regexify(const char *string);
*
* DESCRIPTION
*
- * Checks that the 'identifier' string is valid identifier string
- * and does not contain any unassigned or prohibited character. This
- * function is used to check for valid nicknames, server names,
- * usernames, hostnames, service names, algorithm names, other security
- * property names, and SILC Public Key name.
- *
- * If the 'max_allowed_length' is non-zero the identifier cannot be
- * longer than that, and NULL is returned if it is. If zero (0), no
- * length limit exist. For nicknames the max length must be 128 bytes.
- * Other identifiers has no default limit, but application may choose
-* one anyway.
- *
- * Returns the validated string, that the caller must free. Returns
- * NULL if the identifier string is not valid or contain unassigned or
- * prohibited characters. Such identifier strings must not be used
- * SILC protocol. The returned string is always in UTF-8 encoding.
- * The length of the returned string is in 'out_len'.
+ * 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.
*
- * NOTES
- *
- * In addition of validating the identifier string, this function
- * may map characters to other characters or remove characters from the
- * original string. This is done as defined in the SILC protocol. Error
- * is returned only if the string contains unassigned or prohibited
- * characters. The original 'identifier' is not modified at any point.
+ * This function is system dependant.
*
***/
-unsigned char *silc_identifier_check(const unsigned char *identifier,
- SilcUInt32 identifier_len,
- SilcStringEncoding identifier_encoding,
- SilcUInt32 max_allowed_length,
- SilcUInt32 *out_len);
+char *silc_string_regexify(const char *string);
-/****f* silcutil/SilcStrUtilAPI/silc_identifier_verify
+/****f* silcutil/SilcStrUtilAPI/silc_string_regex_match
*
* SYNOPSIS
*
- * SilcBool
- * silc_identifier_check(const unsigned char *identifier,
- * SilcUInt32 identifier_len,
- * SilcStringEncoding identifier_encoding,
- * SilcUInt32 max_allowed_length);
+ * int silc_string_regex_match(const char *regex, const char *string);
*
* DESCRIPTION
*
- * Checks that the 'identifier' string is valid identifier string
- * and does not contain any unassigned or prohibited character. This
- * function is used to check for valid nicknames, server names,
- * usernames, hostnames, service names, algorithm names, other security
- * property names, and SILC Public Key name.
- *
- * If the 'max_allowed_length' is non-zero the identifier cannot be
- * longer than that, and NULL is returned if it is. If zero (0), no
- * length limit exist. For nicknames the max length must be 128 bytes.
- * Other identifiers has no default limit, but application may choose
- * one anyway.
+ * Matches the two strings and returns TRUE if the strings match.
*
- * Returns TRUE if the string is valid and FALSE if it is prohibited.
+ * This function is system dependant.
*
***/
-SilcBool silc_identifier_verify(const unsigned char *identifier,
- SilcUInt32 identifier_len,
- SilcStringEncoding identifier_encoding,
- SilcUInt32 max_allowed_length);
+int silc_string_regex_match(const char *regex, const char *string);
-/****f* silcutil/SilcStrUtilAPI/silc_channel_name_check
+/****f* silcutil/SilcStrUtilAPI/silc_string_match
*
* SYNOPSIS
*
- * unsigned char *
- * silc_channel_name_check(const unsigned char *identifier,
- * SilcUInt32 identifier_len,
- * SilcStringEncoding identifier_encoding,
- * SilcUInt32 max_allowed_length,
- * SilcUInt32 *out_len);
+ * int silc_string_match(const char *string1, const char *string2);
*
* DESCRIPTION
*
- * Checks that the 'identifier' string is valid channel name string
- * and does not contain any unassigned or prohibited character.
+ * 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/SilcStrUtilAPI/silc_string_compare
*
- * If the 'max_allowed_length' is non-zero the identifier cannot be
- * longer than that, and NULL is returned if it is. If zero (0), no
- * length limit exist. For channel names the max length must be 256
- * bytes.
+ * SYNOPSIS
*
- * Returns the validated string, that the caller must free. Returns
- * NULL if the identifier string is not valid or contain unassigned or
- * prohibited characters. Such identifier strings must not be used
- * SILC protocol. The returned string is always in UTF-8 encoding.
- * The length of the returned string is in 'out_len'.
+ * int silc_string_compare(char *string1, char *string2);
*
- * NOTES
+ * DESCRIPTION
*
- * In addition of validating the channel name string, this function
- * may map characters to other characters or remove characters from the
- * original string. This is done as defined in the SILC protocol. Error
- * is returned only if the string contains unassigned or prohibited
- * characters. The original 'identifier' is not modified at any point.
+ * Compares two strings. Strings may include wildcards '*' and '?'.
+ * Returns TRUE if strings match.
*
***/
-unsigned char *silc_channel_name_check(const unsigned char *identifier,
- SilcUInt32 identifier_len,
- SilcStringEncoding identifier_encoding,
- SilcUInt32 max_allowed_length,
- SilcUInt32 *out_len);
+int silc_string_compare(char *string1, char *string2);
-/****f* silcutil/SilcStrUtilAPI/silc_channel_name_verify
+/****f* silcutil/SilcStrUtilAPI/silc_string_split
*
* SYNOPSIS
*
- * SilcBool
- * silc_channel_name_check(const unsigned char *identifier,
- * SilcUInt32 identifier_len,
- * SilcStringEncoding identifier_encoding,
- * SilcUInt32 max_allowed_length);
+ * char **silc_string_split(const char *string, char ch, int *ret_count);
*
* DESCRIPTION
*
- * Checks that the 'identifier' string is valid channel name string
- * and does not contain any unassigned or prohibited character.
- *
- * If the 'max_allowed_length' is non-zero the identifier cannot be
- * longer than that, and NULL is returned if it is. If zero (0), no
- * length limit exist. For channel names the max length must be 256
- * bytes.
- *
- * Returns TRUE if the string is valid and FALSE if it is prohibited.
+ * Splits a `string' that has a separator `ch' into an array of strings
+ * and returns the array. The `ret_count' will contain the number of
+ * strings in the array. Caller must free the strings and the array.
+ * Returns NULL on error. If the string does not have `ch' separator
+ * this returns the `string' in the array.
*
***/
-SilcBool silc_channel_name_verify(const unsigned char *identifier,
- SilcUInt32 identifier_len,
- SilcStringEncoding identifier_encoding,
- SilcUInt32 max_allowed_length);
+char **silc_string_split(const char *string, char ch, int *ret_count);
#endif /* SILCSTRUTIL_H */
projects / silc.git / blobdiff