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 * XSECSafeBuffer := a class for storing expanding amounts of information. 00064 * 00065 * Author(s): Berin Lautenbach 00066 * 00067 * $Id: XSECSafeBuffer.hpp,v 1.11 2003/07/05 10:30:37 blautenb Exp $ 00068 * 00069 */ 00070 00071 00072 #ifndef XSECSAFEBUFFER_INCLUDE 00073 #define XSECSAFEBUFFER_INCLUDE 00074 00075 #include <xsec/framework/XSECDefs.hpp> 00076 #include <xercesc/util/XMLString.hpp> 00077 00084 #define DEFAULT_SAFE_BUFFER_SIZE 1024 // Default size for a safe Buffer 00085 00102 class CANON_EXPORT safeBuffer { 00103 00104 public: 00105 00106 // For checking we are operating on the buffer correctly 00107 enum bufferType { 00108 00109 BUFFER_UNKNOWN = 0, 00110 BUFFER_CHAR = 1, 00111 BUFFER_UNICODE = 2 00112 }; 00113 00114 00115 safeBuffer(); 00116 safeBuffer(int initialSize); 00117 safeBuffer(const char * inStr, unsigned int initialSize = DEFAULT_SAFE_BUFFER_SIZE); 00118 safeBuffer(const safeBuffer & other); 00119 00120 ~safeBuffer(); 00121 00122 static void init(void); 00123 00124 // "IN" functions - these read in information to the buffer 00125 00126 void sbStrcpyIn(const char * inStr); 00127 void sbStrcpyIn(const safeBuffer & inStr); 00128 void sbStrncpyIn(const char * inStr, int n); 00129 void sbStrncpyIn(const safeBuffer & inStr, int n); 00130 void sbStrcatIn(const char * inStr); 00131 void sbStrcatIn(const safeBuffer & inStr); 00132 void sbStrncatIn(const char * inStr, int n); 00133 void sbStrinsIn(const char * inStr, unsigned int offset); 00134 00135 void sbMemcpyIn(const void * inBuf, int n); 00136 void sbMemcpyIn(int offset, const void * inBuf, int n); 00137 00138 void sbMemcpyOut(void * outBuf, int n) const; 00139 void sbMemshift(int toOffset, int fromOffset, int len); 00140 00141 // Comparison functions 00142 00143 int sbStrncmp(const char * inStr, int n) const; 00144 int sbOffsetStrcmp(const char * inStr, unsigned int offset) const; 00145 int sbOffsetStrncmp(const char * inStr, unsigned int offset, int n) const; 00146 int sbStrcmp(const char * inStr) const; 00147 int sbStrcmp(const safeBuffer & inStr) const; 00148 int sbStrstr(const char * inStr) const; 00149 int sbOffsetStrstr(const char * inStr, unsigned int offset) const; 00150 00151 // XMLCh versions 00152 int sbStrstr(const XMLCh * inStr) const; 00153 void sbStrinsIn(const XMLCh * inStr, unsigned int offset); 00154 00155 // XMLCh and char common functions 00156 void sbStrlwr(void); // Lowercase the string 00157 00158 // Operators 00159 00160 unsigned char & operator[](int n); 00161 safeBuffer & operator= (const safeBuffer & cpy); 00162 safeBuffer & operator= (const XMLCh * inStr); 00163 00164 // Get functions 00165 00166 int sbStrlen(void) const; 00167 unsigned int sbRawBufferSize(void) const; 00168 00169 // raw buffer manipulation 00170 00171 const unsigned char * rawBuffer() const; 00172 const char * rawCharBuffer() const; 00173 const XMLCh * rawXMLChBuffer() const; 00174 void resize(unsigned int sz); // NOTE : Only grows 00175 void setBufferType(bufferType bt); // Use with care 00176 00177 // Unicode (UTF-16 manipulation) 00178 const XMLCh * sbStrToXMLCh(void); // Note does not affect internal buffer 00179 void sbTranscodeIn(const XMLCh * inStr); // Create a local string from UTF-16 00180 void sbTranscodeIn(const char * inStr); // Create a UTF-16 string from local 00181 void sbXMLChIn(const XMLCh * in); // Buffer holds XMLCh * 00182 void sbXMLChAppendCh(const XMLCh c); // Append a Unicode character to the buffer 00183 void sbXMLChCat(const XMLCh *str); // Append a UTF-16 string to the buffer 00184 void sbXMLChCat(const char * str); // Append a (transcoded) local string to the buffer 00185 00186 // Sensitive data functions 00187 void isSensitive(void); 00188 void cleanseBuffer(void); 00189 00190 private: 00191 00192 // Internal function that is used to get a string size and 00193 // then re-allocate if necessary 00194 00195 void checkAndExpand(unsigned int size); 00196 void checkBufferType(bufferType bt) const; 00197 00198 unsigned char * buffer; 00199 unsigned int bufferSize; 00200 XMLCh * mp_XMLCh; 00201 bufferType m_bufferType; 00202 00203 // For XMLCh manipulation 00204 static size_t size_XMLCh; 00205 00206 // For sensitive data 00207 bool m_isSensitive; 00208 }; 00209 00212 #endif /* XSECSAFEBUFFER_INCLUDE */ 00213