HTTP client libcurl implementation file. More...

#include "http_client_libcurl.h"
#include "string_util.h"
#include "http_definitions.h"
#include "mcl_core/mcl_assert.h"
#include "mcl_core/mcl_memory.h"
#include <openssl/ssl.h>
#include <openssl/err.h>

Include dependency graph for http_client_libcurl.c:

Go to the source code of this file.

Data Structures
struct	libcurl_payload_t

struct	mcl_certificate_t

struct	default_callback_user_context_t

Macros
#define	CARRIAGE_RETURN '\r'

#define	LINE_FEED '\n'

#define	DOMAIN_SEPERATOR '\\'

#define	CRLF_LENGTH 2

#define	SUPPORTED_CIPHERS_LIST

#define	CURL_2GB_LIMIT 0x80000000UL

Functions
static CURLcode	_ssl_context_callback (CURL curl, void ssl_context, void *certificates)

static mcl_size_t	_response_payload_callback (void received_data, mcl_size_t size, mcl_size_t count, void response_payload)

static mcl_size_t	_response_header_callback (void received_data, mcl_size_t size, mcl_size_t count, void response_header)

static mcl_size_t	_request_payload_callback_for_put (char buffer, mcl_size_t size, mcl_size_t count, void user_context)

static mcl_bool_t	_is_empty_line (char *line)

static struct curl_slist *	_set_request_options (CURL curl, mcl_http_request_t http_request, default_callback_user_context_t *user_context)

static struct curl_slist *	_set_payload_options (CURL curl, mcl_http_request_t http_request, default_callback_user_context_t user_context, struct curl_slist header_list)

static void	_set_in_file_size (CURL *curl, mcl_size_t payload_size)

static mcl_error_t	_convert_to_mcl_return_code (CURLcode curl_code)

static void	_header_list_destroy_callback (void **item)

static void	_certificate_list_destroy_callback (mcl_certificate_t **certificate)

mcl_error_t	mcl_http_client_initialize (mcl_http_client_configuration_t configuration, mcl_http_client_t *http_client)

mcl_error_t	mcl_http_client_add_certificate (mcl_http_client_t http_client, const char certificate, mcl_bool_t is_file)

mcl_error_t	mcl_http_client_send (mcl_http_client_t http_client, mcl_http_request_t http_request, mcl_http_response_t **http_response)

void	mcl_http_client_destroy (mcl_http_client_t **http_client)

Variables
static mcl_bool_t	curl_global_initialized = MCL_FALSE

Detailed Description

HTTP client libcurl implementation file.

HTTP client implementation file using LibCurl.

Copyright: Copyright (C) 2019 Siemens Aktiengesellschaft.
All rights reserved.

Definition in file http_client_libcurl.c.

Macro Definition Documentation

#define CARRIAGE_RETURN '\r'

Definition at line 19 of file http_client_libcurl.c.

Referenced by _is_empty_line().

#define CRLF_LENGTH 2

Definition at line 22 of file http_client_libcurl.c.

Referenced by _response_header_callback().

#define CURL_2GB_LIMIT 0x80000000UL

Definition at line 29 of file http_client_libcurl.c.

Referenced by _set_in_file_size().

#define DOMAIN_SEPERATOR '\\'

Definition at line 21 of file http_client_libcurl.c.

Referenced by mcl_http_client_initialize().

#define LINE_FEED '\n'

Definition at line 20 of file http_client_libcurl.c.

Referenced by _is_empty_line().

#define SUPPORTED_CIPHERS_LIST

Value:

"AES128-SHA256:AES256-SHA256:AES128-GCM-SHA256:AES256-GCM-SHA384:"\

"ECDHE-RSA-AES128-SHA256:ECDHE-RSA-AES256-SHA384:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-RSA-AES256-GCM-SHA384:"

Definition at line 24 of file http_client_libcurl.c.

Referenced by mcl_http_client_initialize().

Function Documentation

static void _certificate_list_destroy_callback ( mcl_certificate_t ** certificate )

static

Definition at line 862 of file http_client_libcurl.c.

References MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, and MCL_NULL.

Referenced by mcl_http_client_add_certificate(), and mcl_http_client_destroy().

Here is the caller graph for this function:

static mcl_error_t _convert_to_mcl_return_code ( CURLcode curl_code )

static

Definition at line 796 of file http_client_libcurl.c.

References MCL_COULD_NOT_CONNECT, MCL_COULD_NOT_RESOLVE_HOST, MCL_COULD_NOT_RESOLVE_PROXY, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FAIL, MCL_IMPROPER_CERTIFICATE, MCL_NETWORK_RECEIVE_FAIL, MCL_NETWORK_SEND_FAIL, MCL_OK, MCL_OUT_OF_MEMORY, MCL_REQUEST_TIMEOUT, MCL_SERVER_CERTIFICATE_NOT_VERIFIED, and MCL_SSL_HANDSHAKE_FAIL.

Referenced by mcl_http_client_send().

Here is the caller graph for this function:

static void _header_list_destroy_callback ( void ** item )

static

Definition at line 857 of file http_client_libcurl.c.

References MCL_FREE.

Referenced by mcl_http_client_send().

Here is the caller graph for this function:

static mcl_bool_t _is_empty_line ( char * line )

static

Definition at line 593 of file http_client_libcurl.c.

References CARRIAGE_RETURN, LINE_FEED, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FALSE, and MCL_TRUE.

Referenced by _response_header_callback().

Here is the caller graph for this function:

static mcl_size_t _request_payload_callback_for_put	(	char *	buffer,
		mcl_size_t	size,
		mcl_size_t	count,
		void *	user_context
	)

static

Definition at line 568 of file http_client_libcurl.c.

References default_callback_user_context_t::callback_offset, default_callback_user_context_t::http_request, MCL_DEBUG, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, mcl_http_request_t::payload, mcl_http_request_t::payload_size, and string_util_memcpy().

Referenced by _set_payload_options().

Here is the call graph for this function:

Here is the caller graph for this function:

static mcl_size_t _response_header_callback	(	void *	received_data,
		mcl_size_t	size,
		mcl_size_t	count,
		void *	response_header
	)

static

Definition at line 522 of file http_client_libcurl.c.

References _is_empty_line(), CRLF_LENGTH, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, mcl_list_add(), MCL_MALLOC, MCL_NULL, MCL_NULL_CHAR, MCL_OK, MCL_TRUE, and string_util_memcpy().

Referenced by mcl_http_client_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

static mcl_size_t _response_payload_callback	(	void *	received_data,
		mcl_size_t	size,
		mcl_size_t	count,
		void *	response_payload
	)

static

Definition at line 492 of file http_client_libcurl.c.

References libcurl_payload_t::data, MCL_ASSERT_CODE_MESSAGE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_MALLOC, MCL_NULL, MCL_RESIZE, libcurl_payload_t::size, and string_util_memcpy().

Referenced by mcl_http_client_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

static void _set_in_file_size	(	CURL *	curl,
		mcl_size_t	payload_size
	)

static

Definition at line 735 of file http_client_libcurl.c.

References CURL_2GB_LIMIT, libcurl_payload_t::data, MCL_DEBUG, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, and libcurl_payload_t::size.

Referenced by _set_payload_options().

Here is the caller graph for this function:

static struct curl_slist * _set_payload_options	(	CURL *	curl,
		mcl_http_request_t *	http_request,
		default_callback_user_context_t *	user_context,
		struct curl_slist *	header_list
	)

static

Definition at line 695 of file http_client_libcurl.c.

References _request_payload_callback_for_put(), _set_in_file_size(), default_callback_user_context_t::callback_offset, http_header_names, HTTP_HEADER_TRANSFER_ENCODING_CHUNKED, default_callback_user_context_t::http_request, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_NULL, mcl_http_request_t::payload_size, mcl_http_request_t::stream_callback, and mcl_http_request_t::stream_data.

Referenced by _set_request_options().

Here is the call graph for this function:

Here is the caller graph for this function:

static struct curl_slist * _set_request_options	(	CURL *	curl,
		mcl_http_request_t *	http_request,
		default_callback_user_context_t *	user_context
	)

static

Definition at line 606 of file http_client_libcurl.c.

References _set_payload_options(), mcl_list_t::count, mcl_list_t::current, mcl_list_node_t::data, mcl_http_request_t::header, http_header_names, HTTP_HEADER_TRANSFER_ENCODING_CHUNKED, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_ERROR_RETURN, MCL_HTTP_GET, MCL_HTTP_PATCH, MCL_HTTP_POST, MCL_HTTP_PUT, mcl_list_reset(), MCL_NULL, mcl_http_request_t::method, mcl_list_node_t::next, mcl_http_request_t::payload, mcl_http_request_t::payload_size, mcl_http_request_t::stream_callback, mcl_http_request_t::stream_data, and mcl_http_request_t::uri.

Referenced by mcl_http_client_send().

Here is the call graph for this function:

Here is the caller graph for this function:

static CURLcode _ssl_context_callback	(	CURL *	curl,
		void *	ssl_context,
		void *	certificates
	)

static

Definition at line 381 of file http_client_libcurl.c.

References mcl_certificate_t::content, mcl_list_t::count, mcl_list_node_t::data, mcl_certificate_t::is_file, MCL_ASSERT_CODE_MESSAGE, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_ERROR, MCL_ERROR_STRING, MCL_INFO, mcl_list_next(), mcl_list_reset(), MCL_NULL, MCL_OK, MCL_TRUE, and string_util_strlen().

Referenced by mcl_http_client_add_certificate().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t mcl_http_client_add_certificate	(	mcl_http_client_t *	http_client,
		const char *	certificate,
		mcl_bool_t	is_file
	)

This function adds server certificate to certificate list of http client. The certificate list is used by the http client to identify server(s).

Parameters

[in]	http_client	HTTP client handle.
[in]	certificate	Certificate.
[in]	is_file	MCL_TRUE if certificate is given as file.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.

Definition at line 223 of file http_client_libcurl.c.

References _certificate_list_destroy_callback(), _ssl_context_callback(), mcl_http_client_t::certificates, mcl_certificate_t::content, mcl_list_t::count, mcl_http_client_t::curl, mcl_certificate_t::is_file, MCL_ASSERT_NOT_NULL, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FUNCTION_LEAVE_LABEL, mcl_list_add(), MCL_NEW, MCL_NULL, MCL_OK, MCL_OUT_OF_MEMORY, MCL_TRUE, and string_util_strdup().

Referenced by mcl_http_client_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

void mcl_http_client_destroy ( mcl_http_client_t ** http_client )

This function will release the resources of HTTP client handle.

Parameters

[in] http_client HTTP client handle.

Definition at line 356 of file http_client_libcurl.c.

References _certificate_list_destroy_callback(), MCL_DEBUG, MCL_DEBUG_ENTRY, MCL_DEBUG_LEAVE, MCL_FREE, mcl_list_destroy_with_content(), and MCL_NULL.

Referenced by core_processor_destroy(), and mcl_http_client_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t mcl_http_client_initialize	(	mcl_http_client_configuration_t *	configuration,
		mcl_http_client_t **	http_client
	)

This function initializes the underlying implementation (like libcurl) with the given configuration data.

Parameters

[in]	configuration	Pointer to preinitialized mcl_http_client_configuration_t struct.
[out]	http_client	Handle for the http client initialized.

Returns

MCL_OK in case of success.
MCL_TRIGGERED_WITH_NULL in case input parameter is NULL.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.

Definition at line 70 of file http_client_libcurl.c.

Referenced by core_processor_initialize().

Here is the call graph for this function:

Here is the caller graph for this function:

mcl_error_t mcl_http_client_send	(	mcl_http_client_t *	http_client,
		mcl_http_request_t *	http_request,
		mcl_http_response_t **	http_response
	)

This function sends the given request to the pre-configured destination and returns the response using underlying implementation. It is blocking until response is received or timeout occurred.

Parameters

[in]	http_client	HTTP client handle.
[in]	http_request	HTTP request object.
[out]	http_response	HTTP response object.

Returns

MCL_OK in case of success.
MCL_OUT_OF_MEMORY in case there is not enough memory in the system to proceed.
MCL_COULD_NOT_RESOLVE_PROXY in case the proxy host name can not be resolved.
MCL_COULD_NOT_RESOLVE_HOST in case the remote host name can not be resolved.
MCL_SSL_HANDSHAKE_FAIL in case a problem occurs during SSL handshake.
MCL_COULD_NOT_CONNECT in case there is a connection error.
MCL_SERVER_CERTIFICATE_NOT_VERIFIED in case the server can not be verified.
MCL_IMPROPER_CERTIFICATE in case the certificate provided is in improper format and it can not be parsed.
MCL_NETWORK_SEND_FAIL in case of an error in sending data to network.
MCL_NETWORK_RECEIVE_FAIL in case of an error in receiving data from the network.
MCL_FAIL in case of an internal error in MCL.