lib/libalpm/base64.h

   1 /**
   2  * \file base64.h
   3  *
   4  *  Copyright (C) 2006-2010, Brainspark B.V.
   5  *
   6  *  This file is part of PolarSSL (http://www.polarssl.org)
   7  *  Lead Maintainer: Paul Bakker <polarssl_maintainer at polarssl.org>
   8  *
   9  *  All rights reserved.
  10  *
  11  *  This program is free software; you can redistribute it and/or modify
  12  *  it under the terms of the GNU General Public License as published by
  13  *  the Free Software Foundation; either version 2 of the License, or
  14  *  (at your option) any later version.
  15  *
  16  *  This program is distributed in the hope that it will be useful,
  17  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  *  GNU General Public License for more details.
  20  *
  21  *  You should have received a copy of the GNU General Public License
  22  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
  23  */
  24
  25 #ifndef _BASE64_H
  26 #define _BASE64_H
  27
  28 #define POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL               0x0010
  29 #define POLARSSL_ERR_BASE64_INVALID_CHARACTER              0x0012
  30
  31 /**
  32  * \brief          Encode a buffer into base64 format
  33  *
  34  * \param dst      destination buffer
  35  * \param dlen     size of the buffer
  36  * \param src      source buffer
  37  * \param slen     amount of data to be encoded
  38  *
  39  * \return         0 if successful, or POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL.
  40  *                 *dlen is always updated to reflect the amount
  41  *                 of data that has (or would have) been written.
  42  *
  43  * \note           Call this function with *dlen = 0 to obtain the
  44  *                 required buffer size in *dlen
  45  */
  46 int base64_encode( unsigned char *dst, int *dlen,
  47                    const unsigned char *src, int  slen );
  48
  49 /**
  50  * \brief          Decode a base64-formatted buffer
  51  *
  52  * \param dst      destination buffer
  53  * \param dlen     size of the buffer
  54  * \param src      source buffer
  55  * \param slen     amount of data to be decoded
  56  *
  57  * \return         0 if successful, POLARSSL_ERR_BASE64_BUFFER_TOO_SMALL, or
  58  *                 POLARSSL_ERR_BASE64_INVALID_DATA if the input data is not
  59  *                 correct. *dlen is always updated to reflect the amount
  60  *                 of data that has (or would have) been written.
  61  *
  62  * \note           Call this function with *dlen = 0 to obtain the
  63  *                 required buffer size in *dlen
  64  */
  65 int base64_decode( unsigned char *dst, int *dlen,
  66                    const unsigned char *src, int  slen );
  67
  68 #endif /* base64.h */