Base64.hpp Source File

00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2001 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 "Xerces" 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, and was
00051  * originally based on software copyright (c) 2001, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Id: Base64.hpp,v 1.8 2003/12/17 00:18:35 cargilld Exp $
00059  */
00060 
00061 #ifndef BASE64_HPP
00062 #define BASE64_HPP
00063 
00064 #include <xercesc/util/XercesDefs.hpp>
00065 #include <xercesc/util/XMLUniDefs.hpp>
00066 #include <xercesc/framework/MemoryManager.hpp>
00067 
00068 XERCES_CPP_NAMESPACE_BEGIN
00069 
00070 //
00071 // This class provides encode/decode for RFC 2045 Base64 as
00072 // defined by RFC 2045, N. Freed and N. Borenstein.
00073 // RFC 2045: Multipurpose Internet Mail Extensions (MIME)
00074 // Part One: Format of Internet Message Bodies. Reference
00075 // 1996 Available at: http://www.ietf.org/rfc/rfc2045.txt
00076 // This class is used by XML Schema binary format validation
00077 //
00078 //
00079 class  Base64
00080 {
00081 public :
00082 
00084 
00103     static XMLByte* encode(const XMLByte* const inputData
00104                          , const unsigned int   inputLength
00105                          , unsigned int*        outputLength                         
00106                          , MemoryManager* const memMgr = 0);
00107 
00125     static XMLByte* decode(const XMLByte* const inputData
00126                          , unsigned int*        outputLength                         
00127                          , MemoryManager* const memMgr = 0);
00128 
00146     static XMLCh* decode(const XMLCh* const   inputData
00147                        , unsigned int*        outputLength
00148                        , MemoryManager* const memMgr = 0);
00149 
00160     static int getDataLength(const XMLCh* const inputData
00161         , MemoryManager* const memMgr = 0);
00162 
00164 
00165 private :
00166 
00167     // -----------------------------------------------------------------------
00168     //  Helper methods
00169     // -----------------------------------------------------------------------
00170 
00171     static void init();
00172 
00173     static bool isData(const XMLByte& octet);
00174     static bool isPad(const XMLByte& octet);
00175 
00176     static XMLByte set1stOctet(const XMLByte&, const XMLByte&);
00177     static XMLByte set2ndOctet(const XMLByte&, const XMLByte&);
00178     static XMLByte set3rdOctet(const XMLByte&, const XMLByte&);
00179 
00180     static void split1stOctet(const XMLByte&, XMLByte&, XMLByte&);
00181     static void split2ndOctet(const XMLByte&, XMLByte&, XMLByte&);
00182     static void split3rdOctet(const XMLByte&, XMLByte&, XMLByte&);
00183 
00184     // -----------------------------------------------------------------------
00185     //  Unimplemented constructors and operators
00186     // -----------------------------------------------------------------------
00187     Base64();
00188     Base64(const Base64&);
00189 
00190     // -----------------------------------------------------------------------
00191     //  Private data members
00192     //
00193     //  base64Alphabet
00194     //     The Base64 alphabet (see RFC 2045).
00195     //
00196     //  base64Padding
00197     //     Padding character (see RFC 2045).
00198     //
00199     //  base64Inverse
00200     //     Table used in decoding base64.
00201     //
00202     //  isInitialized
00203     //     Set once base64Inverse is initalized.
00204     //
00205     //  quadsPerLine
00206     //     Number of quadruplets per one line. The encoded output
00207     //     stream must be represented in lines of no more
00208     //     than 19 quadruplets each.
00209     //
00210     // -----------------------------------------------------------------------
00211 
00212     static const XMLByte  base64Alphabet[];
00213     static const XMLByte  base64Padding;
00214 
00215     static XMLByte  base64Inverse[];
00216     static bool  isInitialized;
00217 
00218     static const unsigned int  quadsPerLine;
00219 };
00220 
00221 // -----------------------------------------------------------------------
00222 //  Helper methods
00223 // -----------------------------------------------------------------------
00224 inline bool Base64::isPad(const XMLByte& octet)
00225 {
00226     return ( octet == base64Padding );
00227 }
00228 
00229 inline XMLByte Base64::set1stOctet(const XMLByte& b1, const XMLByte& b2)
00230 {
00231     return (( b1 << 2 ) | ( b2 >> 4 ));
00232 }
00233 
00234 inline XMLByte Base64::set2ndOctet(const XMLByte& b2, const XMLByte& b3)
00235 {
00236     return (( b2 << 4 ) | ( b3 >> 2 ));
00237 }
00238 
00239 inline XMLByte Base64::set3rdOctet(const XMLByte& b3, const XMLByte& b4)
00240 {
00241     return (( b3 << 6 ) | b4 );
00242 }
00243 
00244 inline void Base64::split1stOctet(const XMLByte& ch, XMLByte& b1, XMLByte& b2) {
00245     b1 = ch >> 2;
00246     b2 = ( ch & 0x3 ) << 4;
00247 }
00248 
00249 inline void Base64::split2ndOctet(const XMLByte& ch, XMLByte& b2, XMLByte& b3) {
00250     b2 |= ch >> 4;  // combine with previous value
00251     b3 = ( ch & 0xf ) << 2;
00252 }
00253 
00254 inline void Base64::split3rdOctet(const XMLByte& ch, XMLByte& b3, XMLByte& b4) {
00255     b3 |= ch >> 6;  // combine with previous value
00256     b4 = ( ch & 0x3f );
00257 }
00258 
00259 XERCES_CPP_NAMESPACE_END
00260 
00261 #endif