lib/silcutil/silcstrutil.h

   1 /*
   2
   3   silcstrutil.h
   4
   5   Author: Pekka Riikonen <priikone@silcnet.org>
   6
   7   Copyright (C) 2002 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 /****f* silcutil/SilcStrUtilAPI/silc_pem_encode
  34  *
  35  * SYNOPSIS
  36  *
  37  *    char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
  38  *
  39  * DESCRIPTION
  40  *
  41  *    Encodes data into PEM encoding. Returns NULL terminated PEM encoded
  42  *    data string. Note: This is originally public domain code and is
  43  *    still PD.
  44  *
  45  ***/
  46 char *silc_pem_encode(unsigned char *data, SilcUInt32 len);
  47
  48 /****f* silcutil/SilcStrUtilAPI/silc_pem_encode_file
  49  *
  50  * SYNOPSIS
  51  *
  52  *    char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
  53  *
  54  * DESCRIPTION
  55  *
  56  *    Same as silc_pem_encode() but puts newline ('\n') every 72 characters.
  57  *
  58  ***/
  59 char *silc_pem_encode_file(unsigned char *data, SilcUInt32 data_len);
  60
  61 /****f* silcutil/SilcStrUtilAPI/silc_pem_decode
  62  *
  63  * SYNOPSIS
  64  *
  65  *    unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
  66  *                                   SilcUInt32 *ret_len);
  67  *
  68  * DESCRIPTION
  69  *
  70  *    Decodes PEM into data. Returns the decoded data. Note: This is
  71  *    originally public domain code and is still PD.
  72  *
  73  ***/
  74 unsigned char *silc_pem_decode(unsigned char *pem, SilcUInt32 pem_len,
  75                                SilcUInt32 *ret_len);
  76
  77 /****d* silcutil/SilcStrUtilAPI/SilcStringEncoding
  78  *
  79  * NAME
  80  *
  81  *    typedef enum { ... } SilcStringEncoding;
  82  *
  83  * DESCRIPTION
  84  *
  85  *    String encoding definitions used with the UTF-8 encoding and
  86  *    decoding functions.
  87  *
  88  * SOURCE
  89  */
  90 typedef enum {
  91   SILC_STRING_ASCII     = 0,    /* Any 8 bit ASCII encoding (default) */
  92
  93   /* Rest are not implemented yet */
  94   SILC_STRING_ASCII_ESC = 1,    /* 7 bit ASCII (>0x7f escaped) */
  95   SILC_STRING_BMP       = 2,    /* 16 bit, UCS-2, BMP, ISO/IEC 10646 */
  96   SILC_STRING_UNIVERSAL = 3,    /* 32 bit, UCS-4, Universal, ISO/IEC 10646 */
  97 } SilcStringEncoding;
  98 /***/
  99
 100 /****f* silcutil/SilcStrUtilAPI/silc_utf8_encode
 101  *
 102  * SYNOPSIS
 103  *
 104  *    SilcUInt32 silc_utf8_encode(const unsigned char *bin, SilcUInt32 bin_len,
 105  *                                SilcStringEncoding bin_encoding,
 106  *                                unsigned char *utf8, SilcUInt32 utf8_size);
 107  *
 108  * DESCRIPTION
 109  *
 110  *    Encodes the string `bin' of which encoding is `bin_encoding' to the
 111  *    UTF-8 encoding into the buffer `utf8' which is of size of `utf8_size'.
 112  *    Returns the length of the UTF-8 encoded string, or zero (0) on error.
 113  *    By default `bin_encoding' is ASCII, and the caller needs to know the
 114  *    encoding of the input string if it is anything else.
 115  *
 116  ***/
 117 SilcUInt32 silc_utf8_encode(const unsigned char *bin, SilcUInt32 bin_len,
 118                             SilcStringEncoding bin_encoding,
 119                             unsigned char *utf8, SilcUInt32 utf8_size);
 120
 121 /****f* silcutil/SilcStrUtilAPI/silc_utf8_decode
 122  *
 123  * SYNOPSIS
 124  *
 125  *    SilcUInt32 silc_utf8_decode(const unsigned char *utf8,
 126  *                                SilcUInt32 utf8_len,
 127  *                                SilcStringEncoding bin_encoding,
 128  *                                unsigned char *bin, SilcUInt32 bin_size);
 129  *
 130  * DESCRIPTION
 131  *
 132  *    Decodes UTF-8 encoded string `utf8' to string of which encoding is
 133  *    to be `bin_encoding', into the `bin' buffer of size of `bin_size'.
 134  *    Returns the length of the decoded buffer, or zero (0) on error.
 135  *    By default `bin_encoding' is ASCII, and the caller needs to know to
 136  *    which encoding the output string is to be encoded if ASCII is not
 137  *    desired.
 138  *
 139  ***/
 140 SilcUInt32 silc_utf8_decode(const unsigned char *utf8, SilcUInt32 utf8_len,
 141                             SilcStringEncoding bin_encoding,
 142                             unsigned char *bin, SilcUInt32 bin_size);
 143
 144 /****f* silcutil/SilcStrUtilAPI/silc_utf8_encoded_len
 145  *
 146  * SYNOPSIS
 147  *
 148  *    SilcUInt32 silc_utf8_encoded_len(const unsigned char *bin,
 149  *                                     SilcUInt32 bin_len,
 150  *                                     SilcStringEncoding bin_encoding);
 151  *
 152  * DESCRIPTION
 153  *
 154  *    Returns the length of UTF-8 encoded string if the `bin' of
 155  *    encoding of `bin_encoding' is encoded with silc_utf8_encode.
 156  *
 157  ***/
 158 SilcUInt32 silc_utf8_encoded_len(const unsigned char *bin, SilcUInt32 bin_len,
 159                                  SilcStringEncoding bin_encoding);
 160
 161 /****f* silcutil/SilcStrUtilAPI/silc_utf8_valid
 162  *
 163  * SYNOPSIS
 164  *
 165  *    bool silc_utf8_valid(const unsigned char *utf8, SilcUInt32 utf8_len);
 166  *
 167  * DESCRIPTION
 168  *
 169  *    Returns TRUE if the `utf8' string of length of `utf8_len' is valid
 170  *    UTF-8 encoded string, FALSE if it is not UTF-8 encoded string.
 171  *
 172  ***/
 173 bool silc_utf8_valid(const unsigned char *utf8, SilcUInt32 utf8_len);
 174
 175 /****f* silcutil/SilcStrUtilAPI/silc_mime_parse
 176  *
 177  * SYNOPSIS
 178  *
 179  *    bool
 180  *    silc_mime_parse(const unsigned char *mime, SilcUInt32 mime_len,
 181  *                    char *version, SilcUInt32 version_size,
 182  *                    char *content_type, SilcUInt32 content_type_size,
 183  *                    char *transfer_encoding,
 184  *                    SilcUInt32 transfer_encoding_size,
 185  *                    unsigned char **mime_data_ptr,
 186  *                    SilcUInt32 *mime_data_len);
 187  *
 188  * DESCRIPTION
 189  *
 190  *    Parses MIME header indicated by `mime' data block of length of
 191  *    `mime_len'.  Returns TRUE if the `mime' is valid MIME object.
 192  *    Parses from the MIME header the MIME Version (if present) and
 193  *    copies it to the `version' pointer if provided, content type
 194  *    indicating the data in the MIME object and copies it to the
 195  *    `content_type' if provided, and the tranfer encoding (if present)
 196  *    indicating the encoding of the data and copies it to the
 197  *    `content_transfer_encoding' if provided.
 198  *
 199  *    The pointer to the actual data in the MIME object is saved into
 200  *    `mime_data_ptr'.  The pointer is a location in the `mime' and it
 201  *    does not allocate or copy anything, ie. the `mime_data_ptr' is a
 202  *    pointer to the `mime'.  The `mime_data_len' indicates the length of
 203  *    the data without the MIME header.  The caller is responsible of
 204  *    NULL terminating the buffers it provides.
 205  *
 206  ***/
 207 bool
 208 silc_mime_parse(const unsigned char *mime, SilcUInt32 mime_len,
 209                 char *version, SilcUInt32 version_size,
 210                 char *content_type, SilcUInt32 content_type_size,
 211                 char *transfer_encoding, SilcUInt32 transfer_encoding_size,
 212                 unsigned char **mime_data_ptr, SilcUInt32 *mime_data_len);
 213
 214 #endif /* SILCSTRUTIL_H */