modules/platforms/cpp/network/src/network/ssl/secure_socket_client.h

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef _IGNITE_NETWORK_SSL_SECURE_SOCKET_CLIENT
#define _IGNITE_NETWORK_SSL_SECURE_SOCKET_CLIENT

#include <stdint.h>
#include <string>

#include <ignite/network/socket_client.h>
#include <ignite/network/ssl/secure_configuration.h>

namespace ignite
{
    namespace network
    {
        namespace ssl
        {
            /**
             * Secure socket client.
             */
            class SecureSocketClient : public SocketClient
            {
            public:
                /**
                 * Constructor.
                 *
                 * @param cfg Secure configuration.
                 */
                SecureSocketClient(const SecureConfiguration& cfg);

                /**
                 * Destructor.
                 */
                virtual ~SecureSocketClient();

                /**
                 * Establish connection with the host.
                 *
                 * @param hostname Host name or address.
                 * @param port TCP port.
                 * @param timeout Timeout in seconds.
                 * @return @c true on success and @c false on timeout.
                 */
                virtual bool Connect(const char* hostname, uint16_t port, int32_t timeout);

                /**
                 * Close the connection.
                 */
                virtual void Close();

                /**
                 * Send data using connection.
                 * @param data Data to send.
                 * @param size Number of bytes to send.
                 * @param timeout Timeout in seconds.
                 * @return Number of bytes that have been sent on success,
                 *     WaitResult::TIMEOUT on timeout and -errno on failure.
                 */
                virtual int Send(const int8_t* data, size_t size, int32_t timeout);

                /**
                 * Receive data from established connection.
                 *
                 * @param buffer Pointer to data buffer.
                 * @param size Size of the buffer in bytes.
                 * @param timeout Timeout in seconds.
                 * @return Number of bytes that have been received on success,
                 *     WaitResult::TIMEOUT on timeout and -errno on failure.
                 */
                virtual int Receive(int8_t* buffer, size_t size, int32_t timeout);

                /**
                 * Check if the socket is blocking or not.
                 * @return @c true if the socket is blocking and false otherwise.
                 */
                virtual bool IsBlocking() const;

            private:
                /**
                 * Close the connection.
                 * Internal call.
                 */
                void CloseInternal();

                /**
                 * Wait on the socket for any event for specified time.
                 * This function uses poll to achive timeout functionality
                 * for every separate socket operation.
                 *
                 * @param ssl SSL instance.
                 * @param timeout Timeout in seconds.
                 * @param rd Wait for read if @c true, or for write if @c false.
                 * @return -errno on error, WaitResult::TIMEOUT on timeout and
                 *     WaitResult::SUCCESS on success.
                 */
                static int WaitOnSocket(void* ssl, int32_t timeout, bool rd);

                /**
                 * Wait on the socket if it's required by SSL.
                 *
                 * @param res Operation result.
                 * @param ssl SSl instance.
                 * @param timeout Timeout in seconds.
                 * @return
                 */
                static int WaitOnSocketIfNeeded(int res, void* ssl, int timeout);

                /**
                 * Make new SSL instance.
                 *
                 * @param context SSL context.
                 * @param hostname Host name or address.
                 * @param port TCP port.
                 * @param blocking Indicates if the resulted SSL is blocking or not.
                 * @return New SSL instance on success and null-pointer on fail.
                 */
                static void* MakeSsl(void* context, const char* hostname, uint16_t port, bool& blocking);

                /**
                 * Complete async connect.
                 *
                 * @param ssl SSL instance.
                 * @param timeout Timeout in seconds.
                 * @return @c true on success and @c false on timeout.
                 */
                static bool CompleteConnectInternal(void* ssl, int timeout);

                /** Secure configuration. */
                SecureConfiguration cfg;

                /** SSL context. */
                void* context;

                /** OpenSSL instance */
                void* ssl;

                /** Blocking flag. */
                bool blocking;
            };
        }
    }
}

#endif //_IGNITE_NETWORK_SSL_SECURE_SOCKET_CLIENT