OW_HTTPUtils.hpp

Go to the documentation of this file.

/*******************************************************************************
* Copyright (C) 2001-2004 Vintela, Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
*  - Redistributions of source code must retain the above copyright notice,
*    this list of conditions and the following disclaimer.
*
*  - Redistributions in binary form must reproduce the above copyright notice,
*    this list of conditions and the following disclaimer in the documentation
*    and/or other materials provided with the distribution.
*
*  - Neither the name of Vintela, Inc. nor the names of its
*    contributors may be used to endorse or promote products derived from this
*    software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL Vintela, Inc. OR THE CONTRIBUTORS
* BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*******************************************************************************/

#ifndef OW_HTTPUTILS_HPP_
#define OW_HTTPUTILS_HPP_
#include "OW_config.h"
#include "OW_Array.hpp"
#include "OW_Map.hpp"
#include "OW_String.hpp"
#include "OW_Base64FormatException.hpp"
#include <iosfwd>

namespace OW_NAMESPACE
{

typedef Map<String, String> HTTPHeaderMap;
namespace HTTPUtils
{
   extern OW_HTTP_API const char* const Header_BypassLocker; 
   extern OW_HTTP_API const char* const HeaderValue_true; 
   extern OW_HTTP_API const char* const HeaderValue_false; 
   OW_HTTP_API bool parseHeader(HTTPHeaderMap& map, Array<String>& array,
                           std::istream& istr);
   OW_HTTP_API bool parseHeader(HTTPHeaderMap& map, std::istream& istr);
   OW_HTTP_API String date( void );
   OW_HTTP_API String status2String(int code);
   OW_HTTP_API String getCounterStr();
   OW_HTTP_API String base64Decode(const String& arg);
   OW_HTTP_API Array<char> base64Decode(const char* src);
   OW_HTTP_API String base64Encode(const String& arg);
   OW_HTTP_API String base64Encode(const char* src);
   OW_HTTP_API String base64Encode(const UInt8* src, size_t len);
#ifndef OW_DISABLE_DIGEST
   /* calculate H(A1) as per HTTP Digest spec */
   OW_HTTP_API void DigestCalcHA1(
               const String &sAlg,
               const String &sUserName,
               const String &sRealm,
               const String &sPassword,
               const String &sNonce,
               const String &sCNonce,
               String &sSessionKey
                 );
   /* calculate request-digest/response-digest as per HTTP Digest spec */
   OW_HTTP_API void DigestCalcResponse(
               const String &sHA1,        /* H(A1) */
               const String &sNonce,      /* nonce from server */
               const String &sNonceCount, /* 8 hex digits */
               const String &sCNonce,     /* client nonce */
               const String &sQop,        /* qop-value: "", "auth", "auth-int" */
               const String &sMethod,     /* method from the request */
               const String &sDigestUri,  /* requested URL */
               const String &sHEntity,    /* H(entity body) if qop="auth-int" */
               String &Response
                     );
#endif

   OW_HTTP_API bool headerHasKey(const HTTPHeaderMap& headers,
      const String& key);
   OW_HTTP_API String getHeaderValue(const HTTPHeaderMap& headers,
      const String& key);
   OW_HTTP_API void addHeader(Array<String>& headers,
      const String& key, const String& value);
   OW_HTTP_API void eatEntity(std::istream& istr);
   OW_HTTP_API void decodeBasicCreds(const String& info, String& name,
      String& password);
   
   OW_HTTP_API bool buildMap(HTTPHeaderMap& map, std::istream& istr);
   OW_HTTP_API String escapeCharForURL(char c);

   OW_DECLARE_APIEXCEPTION(UnescapeCharForURL, OW_HTTP_API);
   OW_HTTP_API char unescapeCharForURL(const char* str);
   OW_HTTP_API String escapeForURL(const String& input);
   OW_HTTP_API String unescapeForURL(const String& input);
};

} // end namespace OW_NAMESPACE

namespace OW_HTTPUtils = OW_NAMESPACE::HTTPUtils;

#endif   // OW_HTTPUTILS_HPP_

---