lib/silcutil/silcstrutil.h

   1 /*
   2
   3   silcstrutil.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2002 - 2005 Pekka Riikonen
   8
   9   This program is free software; you can redistribute it and/or modify
  10   it under the terms of the GNU General Public License as published by
  11   the Free Software Foundation; version 2 of the License.
  12
  13   This program is distributed in the hope that it will be useful,
  14   but WITHOUT ANY WARRANTY; without even the implied warranty of
  15   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16   GNU General Public License for more details.
  17
  18 */
  19
  20 /****h* silcutil/SILC String Utilities
  21  *
  22  * DESCRIPTION
  23  *
  24  * String manipulation utility routines.  These routines provides
  25  * various helper functions for encoding, decoding and otherwise
  26  * managing strings.
  27  *
  28  ***/
  29
  30 #ifndef SILCSTRUTIL_H
  31 #define SILCSTRUTIL_H
  32
  33 /****d* silcutil/SilcStrUtilAPI/SilcStringEncoding
  34  *
  35  * NAME
  36  *
  37  *    typedef enum { ... } SilcStringEncoding;
  38  *
  39  * DESCRIPTION
  40  *
  41  *    String encoding definitions used with various string manipulation
  42  *    routines.  By default, applications are suggested to use
  43  *    SILC_STRING_LOCALE since it encodes and decodes correctly according
  44  *    to local system language and character set (locale).
  45  *
  46  * SOURCE
  47  */
  48 typedef enum {
  49   SILC_STRING_ASCII         = 0,  /* Any 8 bit ASCII encoding (default) */
  50   SILC_STRING_ASCII_ESC     = 1,  /* 7 bit ASCII (>0x7f escaped) */
  51   SILC_STRING_BMP           = 2,  /* 16 bit, UCS-2, BMP, ISO/IEC 10646 */
  52   SILC_STRING_BMP_LSB       = 3,  /* BMP, least significant byte first */
  53   SILC_STRING_UNIVERSAL     = 4,  /* 32 bit, UCS-4, Universal, ISO/IEC 10646 */
  54   SILC_STRING_UNIVERSAL_LSB = 5,  /* Universal, least significant byte first */
  55   SILC_STRING_LOCALE        = 6,  /* A locale specific conversion on
  56                                      those platforms that support iconv().
  57                                      Fallback is SILC_STRING_ASCII. */
  58   SILC_STRING_UTF8          = 7,  /* UTF-8 encoding */
  59   SILC_STRING_PRINTABLE     = 8,  /* Printable ASCII (no escaping) */
  60   SILC_STRING_VISIBLE       = 9,  /* Visible ASCII string */
  61   SILC_STRING_TELETEX       = 10, /* Teletex ASCII string */
  62   SILC_STRING_NUMERICAL     = 11, /* Numerical ASCII string (digits) */
  63   SILC_STRING_LDAP_DN       = 12, /* Strings for LDAP DNs, RFC 2253 */
  64   SILC_STRING_UTF8_ESCAPE   = 12, /* Escaped UTF-8 as defined in RFC 2253 */
  65
  66   SILC_STRING_LANGUAGE      = 6,  /* _Deprecated_, use SILC_STRING_LOCALE. */
  67 } SilcStringEncoding;
  68 /***/
  69
  70 /****f* silcutil/SilcStrUtilAPI/silc_pem_encode
  71  *
  72  * SYNOPSIS
  73  *
  74  *    char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
  75  *
  76  * DESCRIPTION
  77  *
  78  *    Encodes data into PEM encoding. Returns NULL terminated PEM encoded
  79  *    data string. Note: This is originally public domain code and is
  80  *    still PD.
  81  *
  82  ***/
  83 char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
  84
  85 /****f* silcutil/SilcStrUtilAPI/silc_pem_encode_file
  86  *
  87  * SYNOPSIS
  88  *
  89  *    char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
  90  *
  91  * DESCRIPTION
  92  *
  93  *    Same as silc_pem_encode() but puts newline ('\n') every 72 characters.
  94  *
  95  ***/
  96 char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
  97
  98 /****f* silcutil/SilcStrUtilAPI/silc_pem_decode
  99  *
 100  * SYNOPSIS
 101  *
 102  *    unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
 103  *                                   SilcUInt32 *ret_len);
 104  *
 105  * DESCRIPTION
 106  *
 107  *    Decodes PEM into data. Returns the decoded data. Note: This is
 108  *    originally public domain code and is still PD.
 109  *
 110  ***/
 111 unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
 112                                SilcUInt32 *ret_len);
 113
 114 /****f* silcutil/SilcStrUtilAPI/silc_strncat
 115  *
 116  * SYNOPSIS
 117  *
 118  *    char *silc_strncat(char *dest, SilcUInt32 dest_size,
 119  *                       const char *src, SilcUInt32 src_len);
 120  *
 121  * DESCRIPTION
 122  *
 123  *    Concatenates the `src' into `dest'.  If `src_len' is more than the
 124  *    size of the `dest' (minus NULL at the end) the `src' will be
 125  *    truncated to fit.
 126  *
 127  ***/
 128 char *silc_strncat(char *dest, SilcUInt32 dest_size,
 129                    const char *src, SilcUInt32 src_len);
 130
 131 /****f* silcutil/SilcStrUtilAPI/silc_identifier_check
 132  *
 133  * SYNOPSIS
 134  *
 135  *    unsigned char *
 136  *    silc_identifier_check(const unsigned char *identifier,
 137  *                          SilcUInt32 identifier_len,
 138  *                          SilcStringEncoding identifier_encoding,
 139  *                          SilcUInt32 max_allowed_length,
 140  *                          SilcUInt32 *out_len);
 141  *
 142  * DESCRIPTION
 143  *
 144  *    Checks that the 'identifier' string is valid identifier string
 145  *    and does not contain any unassigned or prohibited character.  This
 146  *    function is used to check for valid nicknames, server names,
 147  *    usernames, hostnames, service names, algorithm names, other security
 148  *    property names, and SILC Public Key name.
 149  *
 150  *    If the 'max_allowed_length' is non-zero the identifier cannot be
 151  *    longer than that, and NULL is returned if it is.  If zero (0), no
 152  *    length limit exist.  For nicknames the max length must be 128 bytes.
 153  *    Other identifiers has no default limit, but application may choose
 154 *     one anyway.
 155  *
 156  *    Returns the validated string, that the caller must free.  Returns
 157  *    NULL if the identifier string is not valid or contain unassigned or
 158  *    prohibited characters.  Such identifier strings must not be used
 159  *    SILC protocol.  The returned string is always in UTF-8 encoding.
 160  *    The length of the returned string is in 'out_len'.
 161  *
 162  * NOTES
 163  *
 164  *    In addition of validating the identifier string, this function
 165  *    may map characters to other characters or remove characters from the
 166  *    original string.  This is done as defined in the SILC protocol.  Error
 167  *    is returned only if the string contains unassigned or prohibited
 168  *    characters.  The original 'identifier' is not modified at any point.
 169  *
 170  ***/
 171 unsigned char *silc_identifier_check(const unsigned char *identifier,
 172                                      SilcUInt32 identifier_len,
 173                                      SilcStringEncoding identifier_encoding,
 174                                      SilcUInt32 max_allowed_length,
 175                                      SilcUInt32 *out_len);
 176
 177 /****f* silcutil/SilcStrUtilAPI/silc_identifier_verify
 178  *
 179  * SYNOPSIS
 180  *
 181  *    SilcBool
 182  *    silc_identifier_check(const unsigned char *identifier,
 183  *                          SilcUInt32 identifier_len,
 184  *                          SilcStringEncoding identifier_encoding,
 185  *                          SilcUInt32 max_allowed_length);
 186  *
 187  * DESCRIPTION
 188  *
 189  *    Checks that the 'identifier' string is valid identifier string
 190  *    and does not contain any unassigned or prohibited character.  This
 191  *    function is used to check for valid nicknames, server names,
 192  *    usernames, hostnames, service names, algorithm names, other security
 193  *    property names, and SILC Public Key name.
 194  *
 195  *    If the 'max_allowed_length' is non-zero the identifier cannot be
 196  *    longer than that, and NULL is returned if it is.  If zero (0), no
 197  *    length limit exist.  For nicknames the max length must be 128 bytes.
 198  *    Other identifiers has no default limit, but application may choose
 199  *    one anyway.
 200  *
 201  *    Returns TRUE if the string is valid and FALSE if it is prohibited.
 202  *
 203  ***/
 204 SilcBool silc_identifier_verify(const unsigned char *identifier,
 205                             SilcUInt32 identifier_len,
 206                             SilcStringEncoding identifier_encoding,
 207                             SilcUInt32 max_allowed_length);
 208
 209 /****f* silcutil/SilcStrUtilAPI/silc_channel_name_check
 210  *
 211  * SYNOPSIS
 212  *
 213  *    unsigned char *
 214  *    silc_channel_name_check(const unsigned char *identifier,
 215  *                            SilcUInt32 identifier_len,
 216  *                            SilcStringEncoding identifier_encoding,
 217  *                            SilcUInt32 max_allowed_length,
 218  *                            SilcUInt32 *out_len);
 219  *
 220  * DESCRIPTION
 221  *
 222  *    Checks that the 'identifier' string is valid channel name string
 223  *    and does not contain any unassigned or prohibited character.
 224  *
 225  *    If the 'max_allowed_length' is non-zero the identifier cannot be
 226  *    longer than that, and NULL is returned if it is.  If zero (0), no
 227  *    length limit exist.  For channel names the max length must be 256
 228  *    bytes.
 229  *
 230  *    Returns the validated string, that the caller must free.  Returns
 231  *    NULL if the identifier string is not valid or contain unassigned or
 232  *    prohibited characters.  Such identifier strings must not be used
 233  *    SILC protocol.  The returned string is always in UTF-8 encoding.
 234  *    The length of the returned string is in 'out_len'.
 235  *
 236  * NOTES
 237  *
 238  *    In addition of validating the channel name string, this function
 239  *    may map characters to other characters or remove characters from the
 240  *    original string.  This is done as defined in the SILC protocol.  Error
 241  *    is returned only if the string contains unassigned or prohibited
 242  *    characters.  The original 'identifier' is not modified at any point.
 243  *
 244  ***/
 245 unsigned char *silc_channel_name_check(const unsigned char *identifier,
 246                                        SilcUInt32 identifier_len,
 247                                        SilcStringEncoding identifier_encoding,
 248                                        SilcUInt32 max_allowed_length,
 249                                        SilcUInt32 *out_len);
 250
 251 /****f* silcutil/SilcStrUtilAPI/silc_channel_name_verify
 252  *
 253  * SYNOPSIS
 254  *
 255  *    SilcBool
 256  *    silc_channel_name_check(const unsigned char *identifier,
 257  *                            SilcUInt32 identifier_len,
 258  *                            SilcStringEncoding identifier_encoding,
 259  *                            SilcUInt32 max_allowed_length);
 260  *
 261  * DESCRIPTION
 262  *
 263  *    Checks that the 'identifier' string is valid channel name string
 264  *    and does not contain any unassigned or prohibited character.
 265  *
 266  *    If the 'max_allowed_length' is non-zero the identifier cannot be
 267  *    longer than that, and NULL is returned if it is.  If zero (0), no
 268  *    length limit exist.  For channel names the max length must be 256
 269  *    bytes.
 270  *
 271  *    Returns TRUE if the string is valid and FALSE if it is prohibited.
 272  *
 273  ***/
 274 SilcBool silc_channel_name_verify(const unsigned char *identifier,
 275                               SilcUInt32 identifier_len,
 276                               SilcStringEncoding identifier_encoding,
 277                               SilcUInt32 max_allowed_length);
 278
 279 #endif /* SILCSTRUTIL_H */