Open Socket Callback

Collaboration diagram for Open Socket Callback:

Data Structures
struct	curl_open_socket_data
	Context structure passed to ast_curl_open_socket_default_cb. More...

Functions
curl_socket_t	curl_open_socket_cb (void *client_data, curlsocktype purpose, struct curl_sockaddr *address)
	A default implementation of an open socket callback. More...
void	curl_open_socket_data_free (void *obj)

Detailed Description

If you need to allocate the socket curl uses to make the request yourself or you need to do some checking on the request's resolved IP address, this is the callback for you.

Your callback must follow the specification defined for CURLOPT_OPENSOCKETFUNCTION and implement the 'curl_opensocket_callback' prototype.

The following ast_open_socket objects compose a default implementation that will not allow requests to servers not whitelisted in the provided ast_acl_list.

Function Documentation

curl_open_socket_cb()

curl_socket_t curl_open_socket_cb	(	void *	client_data,
		curlsocktype	purpose,
		struct curl_sockaddr *	address
	)

A default implementation of an open socket callback.

This is an implementation of the function described by CURLOPT_OPENSOCKETFUNCTION that checks the request's IP address against a user-supplied ast_acl_list and either rejects the request if the IP address isn't allowed, or opens a socket and returns it to curl. See the CURLOPT_OPENSOCKETFUNCTION documentation for more info.

Parameters

client_data	A pointer to whatever structure you passed to ast_curler in the curl_write_data parameter.
purpose	Will always be CURLSOCKTYPE_IPCXN
address	The request server's resolved IP address

Returns

A socket opened by socket() or -1 to signal an error.

Definition at line 205 of file curl_utils.c.

{
    struct curl_open_socket_data *cb_data = client_data;
    char *debug_info = S_OR(cb_data->debug_info, "");
    SCOPE_ENTER(5, "'%s': Opening socket\n", debug_info);
 
    if (!ast_acl_list_is_empty((struct ast_acl_list *)cb_data->acl)) {
        struct ast_sockaddr ast_address = { {0,} };
 
        ast_sockaddr_copy_sockaddr(&ast_address, &address->addr, address->addrlen);
 
        if (ast_apply_acl((struct ast_acl_list *)cb_data->acl, &ast_address, NULL) != AST_SENSE_ALLOW) {
            SCOPE_EXIT_LOG_RTN_VALUE(CURL_SOCKET_BAD, LOG_WARNING,
                "'%s': Unable to apply acl\n", debug_info);
        }
    }
 
    cb_data->sockfd = socket(address->family, address->socktype, address->protocol);
    if (cb_data->sockfd < 0) {
        SCOPE_EXIT_LOG_RTN_VALUE(CURL_SOCKET_BAD, LOG_WARNING,
            "'%s': Failed to open socket: %s\n", debug_info, strerror(errno));
    }
 
    SCOPE_EXIT_RTN_VALUE(cb_data->sockfd, "Success");
}

References curl_open_socket_data::acl, ast_acl_list_is_empty(), ast_apply_acl(), AST_SENSE_ALLOW, ast_sockaddr_copy_sockaddr(), curl_open_socket_data::debug_info, errno, LOG_WARNING, NULL, S_OR, SCOPE_ENTER, SCOPE_EXIT_LOG_RTN_VALUE, SCOPE_EXIT_RTN_VALUE, and curl_open_socket_data::sockfd.

Referenced by curler().

curl_open_socket_data_free()

void curl_open_socket_data_free

(

void *

obj

)

Definition at line 193 of file curl_utils.c.

{
    struct curl_open_socket_data *cb_data = obj;
    if (!cb_data) {
        return;
    }
    if (cb_data->debug_info) {
        ast_free(cb_data->debug_info);
    }
    ast_free(cb_data);
}

References ast_free, and curl_open_socket_data::debug_info.

Referenced by retrieve_cert_from_url().