Main Page | Modules | Class Hierarchy | Compound List | File List | Compound Members | File Members | Related Pages

XSCryptCryptoBase64.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 2002-2003 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "<WebSig>" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 2001, Institute for
00053  * Data Communications Systems, <http://www.nue.et-inf.uni-siegen.de/>.
00054  * The development of this software was partly funded by the European 
00055  * Commission in the <WebSig> project in the ISIS Programme. 
00056  * For more information on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 /*
00061  * XSEC
00062  *
00063  * XSCryptCryptoBase64 := Internal implementation of a base64 encoder/decoder
00064  *
00065  * Author(s): Berin Lautenbach
00066  *
00067  * $Id: XSCryptCryptoBase64.hpp,v 1.3 2003/07/05 10:30:34 blautenb Exp $
00068  *
00069  */
00070 
00071 #ifndef XSCRYPTCRYPTOBASE64_INCLUDE
00072 #define XSCRYPTCRYPTOBASE64_INCLUDE
00073 
00074 #include <xsec/framework/XSECDefs.hpp>
00075 #include <xsec/enc/XSECCryptoBase64.hpp>
00076 #include <xsec/utils/XSECSafeBuffer.hpp>
00077 
00089 class DSIG_EXPORT XSCryptCryptoBase64 : public XSECCryptoBase64 {
00090 
00091 
00092 public :
00093 
00094     // Constructors/Destructors
00095     
00096     XSCryptCryptoBase64() : m_state(B64_UNINITIALISED) {};
00097     virtual ~XSCryptCryptoBase64() {};
00098 
00101 
00110     virtual void         decodeInit(void);                  // Setup
00111 
00125     virtual unsigned int decode(unsigned char * inData, 
00126                                 unsigned int inLength,
00127                                 unsigned char * outData,
00128                                 unsigned int outLength);
00129 
00141     virtual unsigned int decodeFinish(unsigned char * outData,
00142                                       unsigned int outLength);
00143 
00145 
00148 
00156     virtual void         encodeInit(void);
00157 
00169     virtual unsigned int encode(unsigned char * inData, 
00170                                 unsigned int inLength,
00171                                 unsigned char * outData,
00172                                 unsigned int outLength);
00173 
00186     virtual unsigned int encodeFinish(unsigned char * outData,
00187                                       unsigned int outLength);
00188 
00190 
00191 private :
00192 
00193     enum b64state {
00194 
00195         B64_UNINITIALISED,
00196         B64_ENCODE,
00197         B64_DECODE,
00198     };
00199 
00200     safeBuffer              m_inputBuffer;      // Carry over buffer
00201     safeBuffer              m_outputBuffer;     // Carry over output
00202 
00203     unsigned int            m_remainingInput;   // Number of bytes in carry input buffer
00204     unsigned int            m_remainingOutput;  // Number of bytes in carry output buffer
00205 
00206     bool                    m_allDone;          // End found (=)
00207 
00208     b64state                m_state;            // What are we currently doing?
00209 
00210     unsigned int            m_charCount;        // How many characters in current line?
00211 
00212     // Private functions
00213     void canonicaliseInput(unsigned char *inData, unsigned int inLength);
00214 
00215 };
00216 
00217 #endif /* XSCRYPTCRYPTOBASE64_INCLUDE */

Generated on Sun Aug 10 06:24:29 2003 for XML-Security-C by doxygen 1.3.2