mirror of
https://github.com/pocoproject/poco.git
synced 2024-12-23 23:39:23 +01:00
138 lines
4.6 KiB
C++
138 lines
4.6 KiB
C++
//
|
|
// HTTPSClientSession.h
|
|
//
|
|
// $Id: //poco/Main/NetSSL_OpenSSL/include/Poco/Net/HTTPSClientSession.h#9 $
|
|
//
|
|
// Library: NetSSL_OpenSSL
|
|
// Package: HTTPSClient
|
|
// Module: HTTPSClientSession
|
|
//
|
|
// Definition of the HTTPSClientSession class.
|
|
//
|
|
// Copyright (c) 2006-2009, Applied Informatics Software Engineering GmbH.
|
|
// and Contributors.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person or organization
|
|
// obtaining a copy of the software and accompanying documentation covered by
|
|
// this license (the "Software") to use, reproduce, display, distribute,
|
|
// execute, and transmit the Software, and to prepare derivative works of the
|
|
// Software, and to permit third-parties to whom the Software is furnished to
|
|
// do so, all subject to the following:
|
|
//
|
|
// The copyright notices in the Software and this entire statement, including
|
|
// the above license grant, this restriction and the following disclaimer,
|
|
// must be included in all copies of the Software, in whole or in part, and
|
|
// all derivative works of the Software, unless such copies or derivative
|
|
// works are solely in the form of machine-executable object code generated by
|
|
// a source language processor.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
|
|
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
|
|
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
|
|
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
|
// DEALINGS IN THE SOFTWARE.
|
|
//
|
|
|
|
|
|
#ifndef NetSSL_HTTPSClientSession_INCLUDED
|
|
#define NetSSL_HTTPSClientSession_INCLUDED
|
|
|
|
|
|
#include "Poco/Net/NetSSL.h"
|
|
#include "Poco/Net/Utility.h"
|
|
#include "Poco/Net/HTTPClientSession.h"
|
|
#include "Poco/Net/Context.h"
|
|
#include "Poco/Net/X509Certificate.h"
|
|
|
|
|
|
namespace Poco {
|
|
namespace Net {
|
|
|
|
|
|
class SecureStreamSocket;
|
|
class HTTPRequest;
|
|
class HTTPResponse;
|
|
|
|
|
|
class NetSSL_API HTTPSClientSession: public HTTPClientSession
|
|
/// This class implements the client-side of
|
|
/// a HTTPS session.
|
|
///
|
|
/// To send a HTTPS request to a HTTPS server, first
|
|
/// instantiate a HTTPSClientSession object and
|
|
/// specify the server's host name and port number.
|
|
///
|
|
/// Then create a HTTPRequest object, fill it accordingly,
|
|
/// and pass it as argument to the sendRequst() method.
|
|
///
|
|
/// sendRequest() will return an output stream that can
|
|
/// be used to send the request body, if there is any.
|
|
///
|
|
/// After you are done sending the request body, create
|
|
/// a HTTPResponse object and pass it to receiveResponse().
|
|
///
|
|
/// This will return an input stream that can be used to
|
|
/// read the response body.
|
|
///
|
|
/// See RFC 2616 <http://www.faqs.org/rfcs/rfc2616.html> for more
|
|
/// information about the HTTP protocol.
|
|
///
|
|
/// Note that sending requests that neither contain a content length
|
|
/// field in the header nor are using chunked transfer encoding will
|
|
/// result in a SSL protocol violation, as the framework shuts down
|
|
/// the socket after sending the message body. No orderly SSL shutdown
|
|
/// will be performed in this case.
|
|
{
|
|
public:
|
|
enum
|
|
{
|
|
HTTPS_PORT = 443
|
|
};
|
|
|
|
HTTPSClientSession();
|
|
/// Creates an unconnected HTTPSClientSession.
|
|
|
|
explicit HTTPSClientSession(const SecureStreamSocket& socket);
|
|
/// Creates a HTTPSClientSession using the given socket.
|
|
/// The socket must not be connected. The session
|
|
/// takes ownership of the socket.
|
|
|
|
HTTPSClientSession(const std::string& host, Poco::UInt16 port = HTTPS_PORT);
|
|
/// Creates a HTTPSClientSession using the given host and port.
|
|
|
|
explicit HTTPSClientSession(Context::Ptr pContext);
|
|
/// Creates an unconnected HTTPSClientSession, using the
|
|
/// give SSL context.
|
|
|
|
HTTPSClientSession(const std::string& host, Poco::UInt16 port, Context::Ptr pContext);
|
|
/// Creates a HTTPSClientSession using the given host and port,
|
|
/// using the given SSL context.
|
|
|
|
~HTTPSClientSession();
|
|
/// Destroys the HTTPSClientSession and closes
|
|
/// the underlying socket.
|
|
|
|
X509Certificate serverCertificate();
|
|
/// Returns the server's certificate.
|
|
///
|
|
/// The certificate is available after the first request has been sent.
|
|
|
|
protected:
|
|
void connect(const SocketAddress& address);
|
|
std::string proxyRequestPrefix() const;
|
|
|
|
private:
|
|
HTTPSClientSession(const HTTPSClientSession&);
|
|
HTTPSClientSession& operator = (const HTTPSClientSession&);
|
|
|
|
Context::Ptr _pContext;
|
|
};
|
|
|
|
|
|
} } // namespace Poco::Net
|
|
|
|
|
|
#endif // Net_HTTPSClientSession_INCLUDED
|