/*
- silcutil.c
+ silcutil.c
Author: Pekka Riikonen <priikone@silcnet.org>
{
static int start = 0;
int i;
-
+
memset(dest, 0, destlen);
-
+
if (begin != start)
start = 0;
-
+
i = 0;
for ( ; start <= srclen; i++, start++) {
if (i > destlen)
return -1;
-
+
dest[i] = src[start];
-
- if (dest[i] == EOF)
+
+ if (dest[i] == EOF)
return EOF;
-
- if (dest[i] == '\n')
+
+ if (dest[i] == '\n')
break;
}
start++;
-
+
return start;
}
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)
+int silc_check_line(char *buf)
{
/* Illegal characters in line */
if (strchr(buf, '#')) return -1;
if (strchr(buf, '\a')) return -1;
if (strchr(buf, '\b')) return -1;
if (strchr(buf, '\f')) return -1;
-
+
/* Empty line */
if (buf[0] == '\n')
return -1;
-
+
return 0;
}
return return_time;
}
-/* Converts string to capital characters */
+/* Converts string to capital characters. */
char *silc_to_upper(char *string)
{
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
/* Encodes data into PEM encoding. Returns NULL terminated PEM encoded
- data string. Note: This is originally public domain code and is
+ data string. Note: This is originally public domain code and is
still PD. */
char *silc_encode_pem(unsigned char *data, SilcUInt32 len)
return data;
}
-/* Parse userfqdn string which is in user@fqdn format */
+/* Parse userfqdn string which is in user@fqdn format. */
bool silc_parse_userfqdn(const char *string, char **left, char **right)
{
if (strchr(string, '@')) {
tlen = strcspn(string, "@");
-
+
if (left) {
*left = silc_calloc(tlen + 1, sizeof(char));
memcpy(*left, string, tlen);
}
-
+
if (right) {
*right = silc_calloc((strlen(string) - tlen) + 1, sizeof(char));
memcpy(*right, string + tlen + 1, strlen(string) - tlen - 1);
arguments in the line. Note that the command name is counted as one
argument and is saved. */
-void silc_parse_command_line(unsigned char *buffer,
+void silc_parse_command_line(unsigned char *buffer,
unsigned char ***parsed,
SilcUInt32 **parsed_lens,
SilcUInt32 **parsed_types,
len--;
if (!len)
break;
-
+
*parsed = silc_realloc(*parsed, sizeof(**parsed) * (argc + 1));
- *parsed_lens = silc_realloc(*parsed_lens,
+ *parsed_lens = silc_realloc(*parsed_lens,
sizeof(**parsed_lens) * (argc + 1));
(*parsed)[argc] = silc_calloc(len + 1, sizeof(char));
memcpy((*parsed)[argc], cp, len);
/* Renders ID to suitable to print for example to log file. */
static char rid[256];
-#define _PUT_STRING(d, s) \
-do { \
- int sp = (sizeof(d) - 1) - strlen(d); \
- if (sp < strlen(s)) { \
- if (sp) \
- strncat(d, s, (sizeof(d) - 1) - strlen(d)); \
- } else { \
- strncat(d, s, strlen(s)); \
- } \
+#define _PUT_STRING(__d__, __s__) \
+do { \
+ int __sp = sizeof(__d__) - 1 - strlen(__d__); \
+ if (__sp < strlen(__s__)) { \
+ if (__sp) \
+ strncat(__d__, __s__, (sizeof(__d__) - 1) - strlen(__d__)); \
+ } else { \
+ strncat(__d__, __s__, strlen(__s__)); \
+ } \
} while(0)
char *silc_id_render(void *id, SilcUInt16 type)
snprintf(tmp, sizeof(tmp) - 1, ",%02x,", client_id->rnd);
_PUT_STRING(rid, tmp);
memset(tmp, 0, sizeof(tmp));
- snprintf(tmp, sizeof(tmp) - 1, "[%02x %02x %02x %02x...]",
+ snprintf(tmp, sizeof(tmp) - 1, "[%02x %02x %02x %02x...]",
client_id->hash[0], client_id->hash[1],
client_id->hash[2], client_id->hash[3]);
_PUT_STRING(rid, tmp);
return rid;
}
+#undef _PUT_STRING
-/* Compares two strings. Strings may include wildcards * and ?.
+/* Compares two strings. Strings may include wildcards '*' and '?'.
Returns TRUE if strings match. */
int silc_string_compare(char *string1, char *string2)
if (slen2 < slen1)
if (!strchr(string1, '*'))
return FALSE;
-
+
/* Take copies of the original strings as we will change them */
tmpstr1 = silc_calloc(slen1 + 1, sizeof(char));
memcpy(tmpstr1, string1, slen1);
tmpstr2 = silc_calloc(slen2 + 1, sizeof(char));
memcpy(tmpstr2, string2, slen2);
-
+
for (i = 0; i < slen1; i++) {
-
+
/* * wildcard. Only one * wildcard is possible. */
if (tmpstr1[i] == '*')
if (!strncmp(tmpstr1, tmpstr2, i)) {
strncpy(tmpstr2, tmpstr1, i);
break;
}
-
+
/* ? wildcard */
if (tmpstr1[i] == '?') {
if (!strncmp(tmpstr1, tmpstr2, i)) {
if (tmpstr1[i + 1] != '?' &&
tmpstr1[i + 1] != tmpstr2[i + 1])
continue;
-
+
if (!(slen1 < slen2))
tmpstr2[i] = '?';
}
}
}
-
+
/* if using *, remove it */
if (strchr(tmpstr1, '*'))
*strchr(tmpstr1, '*') = 0;
-
+
if (!strcmp(tmpstr1, tmpstr2)) {
memset(tmpstr1, 0, slen1);
memset(tmpstr2, 0, slen2);
silc_free(tmpstr2);
return TRUE;
}
-
+
memset(tmpstr1, 0, slen1);
memset(tmpstr2, 0, slen2);
silc_free(tmpstr1);
return FALSE;
}
-/* Basic has function to hash strings. May be used with the SilcHashTable.
+/* 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. */
{
char *s = (char *)key;
SilcUInt32 h = 0, g;
-
+
while (*s != '\0') {
h = (h << 4) + tolower(*s);
if ((g = h & 0xf0000000)) {
}
s++;
}
-
+
return h;
}
{
SilcClientID *id = (SilcClientID *)key;
SilcUInt32 g;
-
- /* The client ID is hashed by hashing the hash of the ID
+
+ /* The client ID is hashed by hashing the hash of the ID
(which is a truncated MD5 hash of the nickname) so that we
can access the entry from the cache with both Client ID but
with just a hash from the ID as well. */
case SILC_ID_SERVER:
{
SilcServerID *id = (SilcServerID *)key;
-
+
h = id->port * id->rnd;
for (i = 0; i < id->ip.data_len; i++)
h ^= id->ip.data[i];
-
+
return h;
}
break;
case SILC_ID_CHANNEL:
{
SilcChannelID *id = (SilcChannelID *)key;
-
+
h = id->port * id->rnd;
for (i = 0; i < id->ip.data_len; i++)
h ^= id->ip.data[i];
-
+
return h;
}
break;
silc_hash_data(pk->pk, (void *)pk->pk_len));
}
-/* Compares two strings. May be used as SilcHashTable comparison function. */
+/* Compares two strings. It may be used as SilcHashTable comparison
+ function. */
bool silc_hash_string_compare(void *key1, void *key2, void *user_context)
{
return !strcasecmp((char *)key1, (char *)key2);
}
-/* Compares two ID's. May be used as SilcHashTable comparison function.
+/* 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. */
bool silc_hash_id_compare(void *key1, void *key2, void *user_context)
{
SilcIdType id_type = (SilcIdType)(SilcUInt32)user_context;
- return (id_type == SILC_ID_CLIENT ?
+ return (id_type == SILC_ID_CLIENT ?
SILC_ID_COMPARE_HASH((SilcClientID *)key1, (SilcClientID *)key2) :
SILC_ID_COMPARE_TYPE(key1, key2, id_type));
}
return !memcmp(key1, key2, len);
}
-/* Compares two SILC Public keys. May be used as SilcHashTable comparison
- function. */
+/* 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)
{
for (i = 0; i < data_len; i++) {
snprintf(cp, sizeof(fingerprint), "%02X", data[i]);
cp += 2;
-
+
if ((i + 1) % 2 == 0)
snprintf(cp++, sizeof(fingerprint), " ");
cp[-2] = 0;
if ((i + 1) % 10 == 0)
cp[-1] = 0;
-
+
return strdup(fingerprint);
}
bool silc_parse_version_string(const char *version,
SilcUInt32 *protocol_version,
char **protocol_version_string,
- SilcUInt32 *software_version,
+ SilcUInt32 *software_version,
char **software_version_string,
char **vendor_version)
{
/* Take software version */
- maj = 0;
+ maj = 0;
min = 0;
cp = strchr(cp, '-');
if (!cp)
/*
- silcutil.h
+ silcutil.h
Author: Pekka Riikonen <priikone@silcnet.org>
*/
+/****h* silcutil/SILC Utilities
+ *
+ * DESCRIPTION
+ *
+ * XXX
+ *
+ ***/
+
#ifndef SILCUTIL_H
#define SILCUTIL_H
-/* Prototypes */
+/****f* silcutil/SilcUtilAPI/silc_gets
+ *
+ * SYNOPSIS
+ *
+ * int silc_gets(char *dest, int destlen, const char *src, int srclen,
+ * int begin);
+ *
+ * DESCRIPTION
+ *
+ * Gets line from a buffer. Stops reading when a newline or EOF occurs.
+ * This doesn't remove the newline sign from the destination buffer. The
+ * argument begin is returned and should be passed again for the function.
+ *
+ ***/
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
+ *
+ * char *silc_get_time();
+ *
+ * DESCRIPTION
+ *
+ * Returns current time as string.
+ *
+ ***/
char *silc_get_time();
+
+/****f* silcutil/SilcUtilAPI/silc_to_upper
+ *
+ * SYNOPSIS
+ *
+ * char *silc_to_upper(char *string);
+ *
+ * DESCRIPTION
+ *
+ * Converts string to capital characters.
+ *
+ ***/
char *silc_to_upper(char *string);
+
+/****f* silcutil/SilcUtilAPI/silc_encode_pem
+ *
+ * SYNOPSIS
+ *
+ * char *silc_encode_pem(unsigned char *data, SilcUInt32 len);
+ *
+ * DESCRIPTION
+ *
+ * Encodes data into PEM encoding. Returns NULL terminated PEM encoded
+ * data string. Note: This is originally public domain code and is
+ * still PD.
+ *
+ ***/
char *silc_encode_pem(unsigned char *data, SilcUInt32 len);
+
+/****f* silcutil/SilcUtilAPI/silc_encode_pem_file
+ *
+ * SYNOPSIS
+ *
+ * char *silc_encode_pem_file(unsigned char *data, SilcUInt32 data_len);
+ *
+ * DESCRIPTION
+ *
+ * Same as silc_encode_pem() but puts newline ('\n') every 72 characters.
+ *
+ ***/
char *silc_encode_pem_file(unsigned char *data, SilcUInt32 data_len);
+
+/****f* silcutil/SilcUtilAPI/silc_decode_pem
+ *
+ * SYNOPSIS
+ *
+ * unsigned char *silc_decode_pem(unsigned char *pem, SilcUInt32 pem_len,
+ * SilcUInt32 *ret_len);
+ *
+ * DESCRIPTION
+ *
+ * Decodes PEM into data. Returns the decoded data. Note: This is
+ * originally public domain code and is still PD.
+ *
+ ***/
unsigned char *silc_decode_pem(unsigned char *pem, SilcUInt32 pem_len,
SilcUInt32 *ret_len);
+
+/****f* silcutil/SilcUtilAPI/silc_parse_userfqdn
+ *
+ * SYNOPSIS
+ *
+ * bool silc_parse_userfqdn(const char *string, char **left, char **right);
+ *
+ * DESCRIPTION
+ *
+ * Parse userfqdn string which is in user@fqdn format.
+ *
+ ***/
bool silc_parse_userfqdn(const char *string, char **left, char **right);
-void silc_parse_command_line(unsigned char *buffer,
+
+/****f* silcutil/SilcUtilAPI/silc_parse_command_line
+ *
+ * SYNOPSIS
+ *
+ * void silc_parse_command_line(unsigned char *buffer,
+ * unsigned char ***parsed,
+ * SilcUInt32 **parsed_lens,
+ * SilcUInt32 **parsed_types,
+ * SilcUInt32 *parsed_num,
+ * SilcUInt32 max_args);
+ *
+ * DESCRIPTION
+ *
+ * Parses command line. At most `max_args' is taken. Rest of the line
+ * will be allocated as the last argument if there are more than `max_args'
+ * arguments in the line. Note that the command name is counted as one
+ * argument and is saved.
+ *
+ ***/
+void silc_parse_command_line(unsigned char *buffer,
unsigned char ***parsed,
SilcUInt32 **parsed_lens,
SilcUInt32 **parsed_types,
SilcUInt32 *parsed_num,
SilcUInt32 max_args);
+
+/****f* silcutil/SilcUtilAPI/silc_format
+ *
+ * SYNOPSIS
+ *
+ * char *silc_format(char *fmt, ...);
+ *
+ * DESCRIPTION
+ *
+ * Formats arguments to a string and returns it after allocating memory
+ * for it. It must be remembered to free it later.
+ *
+ ***/
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);
-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();
+
+/****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
+ *
+ * SYNOPSIS
+ *
+ * bool 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.
+ *
+ ***/
bool silc_hash_id_compare(void *key1, void *key2, void *user_context);
+
+/****f* silcutil/SilcUtilAPI/silc_hash_client_id_compare
+ *
+ * SYNOPSIS
+ *
+ * bool 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.
+ *
+ ***/
bool silc_hash_client_id_compare(void *key1, void *key2, void *user_context);
+
+/****f* silcutil/SilcUtilAPI/silc_hash_data_compare
+ *
+ * SYNOPSIS
+ *
+ * bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
+ *
+ * DESCRIPTION
+ *
+ * Compares binary data. May be used as SilcHashTable comparison function.
+ *
+ ***/
bool silc_hash_data_compare(void *key1, void *key2, void *user_context);
+
+/****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);
-char *silc_client_chmode(SilcUInt32 mode, const char *cipher,
+
+/****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);
-int silc_gettimeofday(struct timeval *p);
+
+/****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.
+ *
+ ***/
char *silc_fingerprint(const unsigned char *data, SilcUInt32 data_len);
+
+/****f* silcutil/SilcUtilAPI/silc_string_is_ascii
+ *
+ * SYNOPSIS
+ *
+ * bool silc_string_is_ascii(const unsigned char *data,
+ * SilcUInt32 data_len);
+ *
+ * DESCRIPTION
+ *
+ * Return TRUE if the `data' is ASCII string.
+ *
+ ***/
bool silc_string_is_ascii(const unsigned char *data, SilcUInt32 data_len);
+
+/****f* silcutil/SilcUtilAPI/silc_parse_version_string
+ *
+ * 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);
+ *
+ * DESCRIPTION
+ *
+ * Parses SILC protocol style version string.
+ *
+ ***/
bool silc_parse_version_string(const char *version,
SilcUInt32 *protocol_version,
char **protocol_version_string,
- SilcUInt32 *software_version,
+ 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
+ *
+ * char *silc_get_input(const char *prompt, bool echo_off);
+ *
+ * DESCRIPTION
+ *
+ * Displays input prompt on command line and takes input data from user.
+ *
+ ***/
char *silc_get_input(const char *prompt, bool echo_off);
-#endif
+/* 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();
+
+#endif /* !SILCUTIL_H */
projects / silc.git / commitdiff