include/yaz/base64.h

   1 /* This file is part of the YAZ toolkit.
   2  * Copyright (C) 1995-2013 Index Data.
   3  * All rights reserved.
   4  * Redistribution and use in source and binary forms, with or without
   5  * modification, are permitted provided that the following conditions are met:
   6  *
   7  *     * Redistributions of source code must retain the above copyright
   8  *       notice, this list of conditions and the following disclaimer.
   9  *     * Redistributions in binary form must reproduce the above copyright
  10  *       notice, this list of conditions and the following disclaimer in the
  11  *       documentation and/or other materials provided with the distribution.
  12  *     * Neither the name of Index Data nor the names of its contributors
  13  *       may be used to endorse or promote products derived from this
  14  *       software without specific prior written permission.
  15  *
  16  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
  17  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19  * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
  20  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26  */
  27
  28 /**
  29  * \file base64.h
  30  * \brief Header for Base64 utilities
  31  */
  32
  33 #ifndef YAZ_BASE64_H
  34 #define YAZ_BASE64_H
  35
  36 #include <yaz/yconfig.h>
  37
  38 YAZ_BEGIN_CDECL
  39
  40 /** \brief encodes Base64 string
  41     \param in input string
  42     \param out resulting Base64 string
  43
  44     The out buffer should at least be of size:
  45
  46     (strlen(in)*8) / 6 + 12
  47 */
  48 YAZ_EXPORT
  49 void yaz_base64encode(const char *in, char *out);
  50
  51 /** \brief decodes Base64 string
  52     \param in input Base64 encoded string
  53     \param out result string
  54     \retval 0 OK
  55     \retval -1 invalid character
  56
  57     The out buffer should at least be of size:
  58
  59     strlen(in)
  60 */
  61 YAZ_EXPORT
  62 int yaz_base64decode(const char *in, char *out);
  63
  64 YAZ_END_CDECL
  65
  66 #endif
  67 /*
  68  * Local variables:
  69  * c-basic-offset: 4
  70  * c-file-style: "Stroustrup"
  71  * indent-tabs-mode: nil
  72  * End:
  73  * vim: shiftwidth=4 tabstop=8 expandtab
  74  */
  75