Main Page | Modules | Namespace List | Data Structures | File List | Data Fields | Globals | Related Pages

apr_base64.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  *
00054  * The apr_vsnprintf/apr_snprintf functions are based on, and used with the
00055  * permission of, the  SIO stdio-replacement strx_* functions by Panos
00056  * Tsirigotis <panos@alumni.cs.colorado.edu> for xinetd.
00057  */
00058 
00063 #ifndef APR_BASE64_H
00064 #define APR_BASE64_H
00065 
00066 #include "apu.h"
00067 #include "apr_general.h"
00068 
00069 #ifdef __cplusplus
00070 extern "C" {
00071 #endif
00072 
00079 /* Simple BASE64 encode/decode functions.
00080  * 
00081  * As we might encode binary strings, hence we require the length of
00082  * the incoming plain source. And return the length of what we decoded.
00083  *
00084  * The decoding function takes any non valid char (i.e. whitespace, \0
00085  * or anything non A-Z,0-9 etc as terminal.
00086  * 
00087  * plain strings/binary sequences are not assumed '\0' terminated. Encoded
00088  * strings are neither. But probably should.
00089  *
00090  */
00091 
00098 APU_DECLARE(int) apr_base64_encode_len(int len);
00099 
00107 APU_DECLARE(int) apr_base64_encode(char * coded_dst, const char *plain_src, 
00108                                  int len_plain_src);
00109 
00117 APU_DECLARE(int) apr_base64_encode_binary(char * coded_dst, 
00118                                         const unsigned char *plain_src,
00119                                         int len_plain_src);
00120 
00126 APU_DECLARE(int) apr_base64_decode_len(const char * coded_src);
00127 
00134 APU_DECLARE(int) apr_base64_decode(char * plain_dst, const char *coded_src);
00135 
00142 APU_DECLARE(int) apr_base64_decode_binary(unsigned char * plain_dst, 
00143                                         const char *coded_src);
00144 
00146 #ifdef __cplusplus
00147 }
00148 #endif
00149 
00150 #endif  /* !APR_BASE64_H */

Generated on Wed Dec 8 00:35:22 2010 for Apache Portable Runtime Utility Library by  doxygen 1.3.9.1