Functions and datatypes for the REST (HTTP) transport. More...

#include <ctype.h>
#include <string.h>
#include <time.h>
#include <freeradius-devel/server/base.h>
#include <freeradius-devel/server/log.h>
#include <freeradius-devel/server/pool.h>
#include <freeradius-devel/server/tmpl.h>
#include <freeradius-devel/unlang/call.h>
#include <freeradius-devel/util/value.h>
#include <talloc.h>
#include "rest.h"

Include dependency graph for rest.c:

Go to the source code of this file.

Data Structures
struct	json_flags_t
	Flags to control the conversion of JSON values to fr_pair_ts. More...

struct	rest_custom_data_t

Macros
#define	CURLAUTH_BASIC 0

#define	CURLAUTH_DIGEST 0

#define	CURLAUTH_DIGEST_IE 0

#define	CURLAUTH_GSSNEGOTIATE 0

#define	CURLAUTH_NTLM 0

#define	CURLAUTH_NTLM_WB 0

#define	CURLOPT_TLSAUTH_SRP 0

#define	LOG_PREFIX mctx->inst->name

#define	SET_AUTH_OPTION(_x, _y)

Functions
static int	_mod_conn_free (fr_curl_io_request_t *randle)
	Frees a libcurl handle, and any additional memory used by context data. More...

static int	json_pair_alloc (rlm_rest_t const instance, rlm_rest_section_t const section, request_t request, json_object object, UNUSED int level, int max)
	Processes JSON response and converts it into multiple fr_pair_ts. More...

static fr_pair_t *	json_pair_alloc_leaf (UNUSED rlm_rest_t const instance, UNUSED rlm_rest_section_t const section, TALLOC_CTX ctx, request_t request, fr_dict_attr_t const da, json_flags_t flags, json_object *leaf)
	Converts JSON "value" key into fr_pair_t. More...

static int	rest_decode_json (rlm_rest_t const instance, rlm_rest_section_t const section, request_t request, UNUSED fr_curl_io_request_t randle, char *raw, UNUSED size_t rawlen)
	Converts JSON response into fr_pair_ts and adds them to the request. More...

static int	rest_decode_plain (UNUSED rlm_rest_t const inst, UNUSED rlm_rest_section_t const section, request_t request, UNUSED fr_curl_io_request_t randle, char *raw, size_t rawlen)
	Converts plain response into a single fr_pair_t. More...

static int	rest_decode_post (UNUSED rlm_rest_t const instance, UNUSED rlm_rest_section_t const section, request_t request, fr_curl_io_request_t randle, char *raw, size_t rawlen)
	Converts POST response into fr_pair_ts and adds them to the request. More...

static size_t	rest_encode_custom (void out, size_t size, size_t nmemb, void userdata)
	Copies a pre-expanded xlat string to the output buffer. More...

static size_t	rest_encode_json (void out, size_t size, size_t nmemb, void userdata)
	Encodes fr_pair_t linked list in JSON format. More...

static size_t	rest_encode_post (void out, size_t size, size_t nmemb, void userdata)
	Encodes fr_pair_t linked list in POST format. More...

size_t	rest_get_handle_data (char const *out, fr_curl_io_request_t randle)
	Extracts pointer to buffer containing response data. More...

void *	rest_mod_conn_create (TALLOC_CTX ctx, void instance, UNUSED fr_time_delta_t timeout)
	Creates a new connection handle for use by the FR connection API. More...

int	rest_request_config (module_ctx_t const mctx, rlm_rest_section_t const section, request_t request, fr_curl_io_request_t randle, http_method_t method, http_body_type_t type, char const uri, char const body_data)
	Configures request curlopts. More...

static int	rest_request_config_body (module_ctx_t const mctx, rlm_rest_section_t const section, request_t request, fr_curl_io_request_t randle, rest_read_t func)
	Configures body specific curlopts. More...

static ssize_t	rest_request_encode_wrapper (char *out, UNUSED rlm_rest_t const inst, rest_read_t func, size_t limit, void *userdata)
	Emulates successive libcurl calls to an encoding function. More...

static void	rest_request_init (rlm_rest_section_t const section, request_t request, rlm_rest_request_t *ctx)
	(Re-)Initialises the data in a rlm_rest_request_t. More...

static size_t	rest_response_body (void in, size_t size, size_t nmemb, void userdata)
	Processes incoming HTTP body data from libcurl. More...

void	rest_response_debug (request_t request, fr_curl_io_request_t handle)
	Print out the response text. More...

int	rest_response_decode (rlm_rest_t const instance, rlm_rest_section_t const section, request_t request, fr_curl_io_request_t randle)
	Sends the response to the correct decode function. More...

void	rest_response_error (request_t request, fr_curl_io_request_t handle)
	Print out the response text as error lines. More...

static size_t	rest_response_header (void in, size_t size, size_t nmemb, void userdata)
	Processes incoming HTTP header data from libcurl. More...

static void	rest_response_init (rlm_rest_section_t const section, request_t request, rlm_rest_response_t ctx, http_body_type_t type, tmpl_t header)
	(Re-)Initialises the data in a rlm_rest_response_t. More...

size_t	rest_uri_escape (UNUSED request_t request, char out, size_t outlen, char const raw, UNUSED void arg)
	URL encodes a string. More...

ssize_t	rest_uri_host_unescape (char *out, UNUSED rlm_rest_t const inst, request_t request, fr_curl_io_request_t randle, char const *uri)
	Unescapes the host portion of a URI string. More...

Variables
fr_table_num_sorted_t const	http_auth_table []

size_t	http_auth_table_len = NUM_ELEMENTS(http_auth_table)

const http_body_type_t	http_body_type_supported [REST_HTTP_BODY_NUM_ENTRIES]
	Table of encoder/decoder support. More...

fr_table_num_sorted_t const	http_body_type_table []
	Conversion table for type config values. More...

size_t	http_body_type_table_len = NUM_ELEMENTS(http_body_type_table)

fr_table_num_sorted_t const	http_content_type_table []
	Conversion table for "Content-Type" header values. More...

size_t	http_content_type_table_len = NUM_ELEMENTS(http_content_type_table)

const unsigned long	http_curl_auth [REST_HTTP_AUTH_NUM_ENTRIES]

fr_table_num_sorted_t const	http_method_table []
	Conversion table for method config values. More...

size_t	http_method_table_len = NUM_ELEMENTS(http_method_table)

Detailed Description

Functions and datatypes for the REST (HTTP) transport.

Id: 6c0e2a62d2c78ba4fec1de10c285283e2c0f6b49

Copyright: 2012-2021 Arran Cudbard-Bell (a.cud.nosp@m.bard.nosp@m.b@fre.nosp@m.erad.nosp@m.ius.o.nosp@m.rg)

Definition in file rest.c.

Data Structure Documentation

◆ json_flags_t

struct json_flags_t

Flags to control the conversion of JSON values to fr_pair_ts.

These fields are set when parsing the expanded format for value pairs in JSON, and control how json_pair_alloc_leaf and json_pair_alloc convert the JSON value, and move the new fr_pair_t into an attribute list.

See also: json_pair_alloc; json_pair_alloc_leaf

Definition at line 221 of file rest.c.

Data Fields
int	do_xlat	If true value will be expanded with xlat.
int	is_json	If true value will be inserted as raw JSON.
fr_token_t	op	The operator that determines how the new VP.

◆ rest_custom_data_t

struct rest_custom_data_t

Definition at line 205 of file rest.c.

Data Fields
size_t	len	Length of data.
char const *	p	how much text we've sent so far.
char const *	start	Start of the buffer.

Macro Definition Documentation

◆ CURLAUTH_BASIC

#define CURLAUTH_BASIC 0

Definition at line 77 of file rest.c.

◆ CURLAUTH_DIGEST

#define CURLAUTH_DIGEST 0

Definition at line 80 of file rest.c.

◆ CURLAUTH_DIGEST_IE

#define CURLAUTH_DIGEST_IE 0

Definition at line 83 of file rest.c.

◆ CURLAUTH_GSSNEGOTIATE

#define CURLAUTH_GSSNEGOTIATE 0

Definition at line 86 of file rest.c.

◆ CURLAUTH_NTLM

#define CURLAUTH_NTLM 0

Definition at line 89 of file rest.c.

◆ CURLAUTH_NTLM_WB

#define CURLAUTH_NTLM_WB 0

Definition at line 92 of file rest.c.

◆ CURLOPT_TLSAUTH_SRP

#define CURLOPT_TLSAUTH_SRP 0

Definition at line 74 of file rest.c.

◆ LOG_PREFIX

#define LOG_PREFIX mctx->inst->name

Definition at line 27 of file rest.c.

◆ SET_AUTH_OPTION

#define SET_AUTH_OPTION	(	_x,
		_y
	)

Value:

do {\
        if ((ret = curl_easy_setopt(candle, _x, _y)) != CURLE_OK) {\
                option = STRINGIFY(_x);\
                REDEBUG("Failed setting curl option %s: %s (%i)", option, curl_easy_strerror(ret), ret); \
                goto error;\
        }\
} while (0)

Function Documentation

◆ _mod_conn_free()

static int _mod_conn_free ( fr_curl_io_request_t * randle )

static

Frees a libcurl handle, and any additional memory used by context data.

Parameters

[in] randle fr_curl_io_request_t to close and free.

Returns: returns true.

Definition at line 235 of file rest.c.

Here is the caller graph for this function:

◆ json_pair_alloc()

static int json_pair_alloc	(	rlm_rest_t const *	instance,
		rlm_rest_section_t const *	section,
		request_t *	request,
		json_object *	object,
		UNUSED int	level,
		int	max
	)

static

Processes JSON response and converts it into multiple fr_pair_ts.

Processes JSON attribute declarations in the format below. Will recurse when processing nested attributes. When processing nested attributes flags and operators from previous attributes are not inherited.

JSON response format is:

{
        "<attribute0>":{
                "do_xlat":<bool>,
                "is_json":<bool>,
                "op":"<operator>",
                "value":[<value0>,<value1>,<valueN>]
        },
        "<attribute1>":{
                "value":{
                        "<nested-attribute0>":{
                                "op":"<operator>",
                                "value":<value0>
                        }
                }
        },
        "<attribute2>":"<value0>",
        "<attributeN>":[<value0>,<value1>,<valueN>]
}

JSON valuepair flags:

do_xlat (optional) Controls xlat expansion of values. Defaults to true.
is_json (optional) If true, any nested JSON data will be copied to the fr_pair_t in string form. Defaults to true.
op (optional) Controls how the attribute is inserted into the target list. Defaults to ':=' (T_OP_SET).

If "op" is ':=' or '=', it will be automagically changed to '+=' for the second and subsequent values in multivalued attributes. This does not work between multiple attribute declarations.

See also: fr_tokens_table

Parameters

[in]	instance	configuration data.
[in]	section	configuration data.
[in]	request	Current request.
[in]	object	containing root node, or parent node.
[in]	level	Current nesting level.
[in]	max	counter, decremented after each fr_pair_t is created, when 0 no more attributes will be processed.

Returns

Number of attributes created.
< 0 on error.

Definition at line 987 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ json_pair_alloc_leaf()

static fr_pair_t* json_pair_alloc_leaf	(	UNUSED rlm_rest_t const *	instance,
		UNUSED rlm_rest_section_t const *	section,
		TALLOC_CTX *	ctx,
		request_t *	request,
		fr_dict_attr_t const *	da,
		json_flags_t *	flags,
		json_object *	leaf
	)

static

Converts JSON "value" key into fr_pair_t.

If leaf is not in fact a leaf node, but contains JSON data, the data will written to the attribute in JSON string format.

Parameters

[in]	instance	configuration data.
[in]	section	configuration data.
[in]	ctx	to allocate new fr_pair_ts in.
[in]	request	Current request.
[in]	da	Attribute to create.
[in]	flags	containing the operator other flags controlling value expansion.
[in]	leaf	object containing the fr_pair_t value.

Returns

fr_pair_t just created.
NULL on error.

Definition at line 851 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_decode_json()

static int rest_decode_json	(	rlm_rest_t const *	instance,
		rlm_rest_section_t const *	section,
		request_t *	request,
		UNUSED fr_curl_io_request_t *	randle,
		char *	raw,
		UNUSED size_t	rawlen
	)

static

Converts JSON response into fr_pair_ts and adds them to the request.

Converts the raw JSON string into a json-c object tree and passes it to json_pair_alloc. After the tree has been parsed json_object_put is called which decrements the reference count of the root node by one, and frees the entire tree.

See also: rest_encode_json; json_pair_alloc

Parameters

[in]	instance	configuration data.
[in]	section	configuration data.
[in,out]	request	Current request.
[in]	randle	REST handle.
[in]	raw	buffer containing JSON data.
[in]	rawlen	Length of data in raw buffer.

Returns

The number of fr_pair_t processed.
-1 on unrecoverable error.

Definition at line 1202 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_decode_plain()

static int rest_decode_plain	(	UNUSED rlm_rest_t const *	inst,
		UNUSED rlm_rest_section_t const *	section,
		request_t *	request,
		UNUSED fr_curl_io_request_t *	randle,
		char *	raw,
		size_t	rawlen
	)

static

Converts plain response into a single fr_pair_t.

Parameters

[in]	inst	configuration data.
[in]	section	configuration data.
[in]	randle	fr_curl_io_request_t to use.
[in]	request	Current request.
[in]	raw	buffer containing POST data.
[in]	rawlen	Length of data in raw buffer.

Returns

Number of fr_pair_t processed.
-1 on unrecoverable error.

Definition at line 654 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_decode_post()

static int rest_decode_post	(	UNUSED rlm_rest_t const *	instance,
		UNUSED rlm_rest_section_t const *	section,
		request_t *	request,
		fr_curl_io_request_t *	randle,
		char *	raw,
		size_t	rawlen
	)

static

Converts POST response into fr_pair_ts and adds them to the request.

Accepts fr_pair_tS in the same format as rest_encode_post, but with the addition of optional attribute list qualifiers as part of the attribute name string.

If no qualifiers are specified, will default to the request list.

POST response format is:

[outer.][<list>.]<attribute0>=<value0>&[outer.][<list>.]<attribute1>=<value1>&[outer.][<list>.]<attributeN>=<valueN>

See also: rest_encode_post

Parameters

[in]	instance	configuration data.
[in]	section	configuration data.
[in]	randle	fr_curl_io_request_t to use.
[in]	request	Current request.
[in]	raw	buffer containing POST data.
[in]	rawlen	Length of data in raw buffer.

Returns

Number of fr_pair_ts processed.
-1 on unrecoverable error.

Definition at line 698 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_encode_custom()

static size_t rest_encode_custom	(	void *	out,
		size_t	size,
		size_t	nmemb,
		void *	userdata
	)

static

Copies a pre-expanded xlat string to the output buffer.

Parameters

[out]	out	Char buffer to write encoded data to.
[in]	size	Multiply by nmemb to get the length of ptr.
[in]	nmemb	Multiply by size to get the length of ptr.
[in]	userdata	rlm_rest_request_t to keep encoding state between calls.

Returns

Length of data (including NULL) written to ptr.
0 if no more data to write.

Definition at line 296 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_encode_json()

static size_t rest_encode_json	(	void *	out,
		size_t	size,
		size_t	nmemb,
		void *	userdata
	)

static

Encodes fr_pair_t linked list in JSON format.

This is a stream function matching the rest_read_t prototype. Multiple successive calls will return additional encoded fr_pair_ts.

Only complete attribute headers

"<name>":{"type":"<type>","value":['

and complete attribute values will be written to ptr.

If an attribute occurs multiple times in the request the attribute values will be concatenated into a single value array.

JSON request format is:

{
        "<attribute0>":{
                "type":"<type0>",
                "value":[<value0>,<value1>,<valueN>]
        },
        "<attribute1>":{
                "type":"<type1>",
                "value":[...]
        },
        "<attributeN>":{
                "type":"<typeN>",
                "value":[...]
        },
}

Parameters

[out]	out	Char buffer to write encoded data to.
[in]	size	Multiply by nmemb to get the length of ptr.
[in]	nmemb	Multiply by size to get the length of ptr.
[in]	userdata	rlm_rest_request_t to keep encoding state between calls.

Returns

Length of data (including NULL) written to ptr.
0 if no more data to write.

Definition at line 532 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_encode_post()

static size_t rest_encode_post	(	void *	out,
		size_t	size,
		size_t	nmemb,
		void *	userdata
	)

static

Encodes fr_pair_t linked list in POST format.

This is a stream function matching the rest_read_t prototype. Multiple successive calls will return additional encoded fr_pair_ts. Only complete attribute headers

'<name>='

and values will be written to the ptr buffer.

POST request format is:

<attribute0>=<value0>&<attribute1>=<value1>&<attributeN>=<valueN>

All attributes and values are url encoded. There is currently no support for nested attributes, or attribute qualifiers.

Nested attributes may be added in the future using

<attribute-outer>:<attribute-inner>

to denotate nesting.

Requires libcurl for url encoding.

See also: rest_decode_post

Parameters

[out]	out	Char buffer to write encoded data to.
[in]	size	Multiply by nmemb to get the length of ptr.
[in]	nmemb	Multiply by size to get the length of ptr.
[in]	userdata	rlm_rest_request_t to keep encoding state between calls.

Returns

Length of data (including NULL) written to ptr.
0 if no more data to write.

Definition at line 355 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_get_handle_data()

size_t rest_get_handle_data	(	char const **	out,
		fr_curl_io_request_t *	randle
	)

Extracts pointer to buffer containing response data.

Parameters

[out]	out	Where to write the pointer to the buffer.
[in]	randle	used for the last request.

Returns

0 if no data i available.
> 0 if data is available.

Definition at line 1625 of file rest.c.

Here is the caller graph for this function:

◆ rest_mod_conn_create()

void* rest_mod_conn_create	(	TALLOC_CTX *	ctx,
		void *	instance,
		UNUSED fr_time_delta_t	timeout
	)

Creates a new connection handle for use by the FR connection API.

Matches the fr_pool_connection_create_t function prototype, is passed to fr_pool_init, and called when a new connection is required by the connection pool API.

Creates an instances of fr_curl_io_request_t, and rlm_rest_curl_context_t which hold the context data required for generating requests and parsing responses.

If instance->connect_uri is not NULL libcurl will attempt to open a TCP socket to the server specified in the URI. This is done so that when the socket is first used, there will already be a cached TCP connection to the REST server associated with the curl handle.

See also: fr_pool_init; fr_pool_connection_create_t; connection.c

Definition at line 261 of file rest.c.

Here is the call graph for this function:

◆ rest_request_config()

int rest_request_config	(	module_ctx_t const *	mctx,
		rlm_rest_section_t const *	section,
		request_t *	request,
		fr_curl_io_request_t *	randle,
		http_method_t	method,
		http_body_type_t	type,
		char const *	uri,
		char const *	body_data
	)

Configures request curlopts.

Configures libcurl handle setting various curlopts for things like local client time, Content-Type, and other FreeRADIUS custom headers.

Current FreeRADIUS custom headers are:

X-FreeRADIUS-Section The module section being processed.
X-FreeRADIUS-Server The current virtual server the request_t is passing through.

Sets up callbacks for all response processing (buffers and body data).

Parameters

[in]	mctx	call data.
[in]	section	configuration data.
[in]	randle	to configure.
[in]	request	Current request.
[in]	method	to use (HTTP verbs PUT, POST, DELETE etc...).
[in]	type	Content-Type for request encoding, also sets the default for decoding.
[in]	uri	buffer containing the expanded URI to send the request to.
[in]	body_data	(optional) custom body data. Must persist whilst we're writing data out to the socket. Must be a talloced buffer which is \0 terminated.

Returns

0 on success (all opts configured).
-1 on failure.

Definition at line 1726 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_request_config_body()

static int rest_request_config_body	(	module_ctx_t const *	mctx,
		rlm_rest_section_t const *	section,
		request_t *	request,
		fr_curl_io_request_t *	randle,
		rest_read_t	func
	)

static

Configures body specific curlopts.

Configures libcurl handle to use either chunked mode, where the request data will be sent using multiple HTTP requests, or contiguous mode where the request data will be sent in a single HTTP request.

Parameters

[in]	mctx	Call data.
[in]	section	configuration data.
[in]	request	Current request.
[in]	randle	fr_curl_io_request_t to configure.
[in]	func	to pass to libcurl for chunked. transfers (NULL if not using chunked mode).

Returns

0 on success.
-1 on failure.

Definition at line 1651 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_request_encode_wrapper()

static ssize_t rest_request_encode_wrapper	(	char **	out,
		UNUSED rlm_rest_t const *	inst,
		rest_read_t	func,
		size_t	limit,
		void *	userdata
	)

static

Emulates successive libcurl calls to an encoding function.

This function is used when the request will be sent to the HTTP server as one contiguous entity. A buffer of REST_BODY_ALLOC_CHUNK bytes is allocated and passed to the stream encoding function.

If the stream function does not return 0, a new buffer is allocated which is the size of the previous buffer + REST_BODY_ALLOC_CHUNK bytes, the data from the previous buffer is copied, and freed, and another call is made to the stream function, passing a pointer into the new buffer at the end of the previously written data.

This process continues until the stream function signals (by returning 0) that it has no more data to write.

Parameters

[out]	out	where the pointer to the alloced buffer should be written.
[in]	inst	of rlm_rest.
[in]	func	Stream function.
[in]	limit	Maximum buffer size to alloc.
[in]	userdata	rlm_rest_request_t to keep encoding state between calls to stream function.

Returns

Length of the data written to the buffer (excluding NULL).
-1 if alloc >= limit.

Definition at line 595 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_request_init()

static void rest_request_init	(	rlm_rest_section_t const *	section,
		request_t *	request,
		rlm_rest_request_t *	ctx
	)

static

(Re-)Initialises the data in a rlm_rest_request_t.

Resets the values of a rlm_rest_request_t to their defaults.

Parameters

[in]	section	configuration data.
[in]	request	Current request.
[in]	ctx	to initialise.

Definition at line 631 of file rest.c.

Here is the caller graph for this function:

◆ rest_response_body()

static size_t rest_response_body	(	void *	in,
		size_t	size,
		size_t	nmemb,
		void *	userdata
	)

static

Processes incoming HTTP body data from libcurl.

Writes incoming body data to an intermediary buffer for later parsing by one of the decode functions.

Parameters

[in]	in	Char buffer where inbound header data is written
[in]	size	Multiply by nmemb to get the length of ptr.
[in]	nmemb	Multiply by size to get the length of ptr.
[in]	userdata	rlm_rest_response_t to keep parsing state between calls.

Returns

Length of data processed.
0 on error.

Definition at line 1463 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_response_debug()

void rest_response_debug	(	request_t *	request,
		fr_curl_io_request_t *	handle
	)

Print out the response text.

Parameters

request	The Current request.
handle	fr_curl_io_request_t used to execute the previous request.

Definition at line 1568 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_response_decode()

int rest_response_decode	(	rlm_rest_t const *	instance,
		rlm_rest_section_t const *	section,
		request_t *	request,
		fr_curl_io_request_t *	randle
	)

Sends the response to the correct decode function.

Uses the Content-Type information written in rest_response_header to determine the correct decode function to use. The decode function will then convert the raw received data into fr_pair_ts.

Parameters

[in]	instance	configuration data.
[in]	section	configuration data.
[in]	request	Current request.
[in]	randle	to use.

Returns

0 on success.
-1 on failure.

Definition at line 2072 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_response_error()

void rest_response_error	(	request_t *	request,
		fr_curl_io_request_t *	handle
	)

Print out the response text as error lines.

Parameters

request	The Current request.
handle	fr_curl_io_request_t used to execute the previous request.

Definition at line 1543 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_response_header()

static size_t rest_response_header	(	void *	in,
		size_t	size,
		size_t	nmemb,
		void *	userdata
	)

static

Processes incoming HTTP header data from libcurl.

Processes the status line, and Content-Type headers from the incoming HTTP response.

Matches prototype for CURLOPT_HEADERFUNCTION, and will be called directly by libcurl.

Parameters

[in]	in	Char buffer where inbound header data is written.
[in]	size	Multiply by nmemb to get the length of ptr.
[in]	nmemb	Multiply by size to get the length of ptr.
[in]	userdata	rlm_rest_response_t to keep parsing state between calls.

Returns

Length of data processed.
0 on error.

Definition at line 1250 of file rest.c.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ rest_response_init()

static void rest_response_init	(	rlm_rest_section_t const *	section,
		request_t *	request,
		rlm_rest_response_t *	ctx,
		http_body_type_t	type,
		tmpl_t *	header
	)

static

(Re-)Initialises the data in a rlm_rest_response_t.

This resets the values of the a rlm_rest_response_t to their defaults. Must be called between encoding sessions.

See also: rest_response_body; rest_response_header

Parameters

[in]	section	that created the request.
[in]	request	Current request.
[in]	ctx	data to initialise.
[in]	type	Default http_body_type to use when decoding raw data, may be overwritten by rest_response_header.
[in]	header	Where to write out headers, may be NULL.

Definition at line 1603 of file rest.c.

Here is the caller graph for this function:

◆ rest_uri_escape()

size_t rest_uri_escape	(	UNUSED request_t *	request,
		char *	out,
		size_t	outlen,
		char const *	raw,
		UNUSED void *	arg
	)

URL encodes a string.

Encode special chars as per RFC 3986 section 4.

Parameters

[in]	request	Current request.
[out]	out	Where to write escaped string.
[in]	outlen	Size of out buffer.
[in]	raw	string to be urlencoded.
[in]	arg	pointer, gives context for escaping.

Returns: length of data written to out (excluding NULL).

Definition at line 2125 of file rest.c.

Here is the call graph for this function:

◆ rest_uri_host_unescape()

ssize_t rest_uri_host_unescape	(	char **	out,
		UNUSED rlm_rest_t const *	inst,
		request_t *	request,
		fr_curl_io_request_t *	randle,
		char const *	uri
	)

Unescapes the host portion of a URI string.

This is required because the xlat functions which operate on the input string cannot distinguish between host and path components.

Parameters

[out]	out	Where to write the pointer to the new buffer containing the escaped URI.
[in]	inst	of rlm_rest.
[in]	request	Current request
[in]	randle	to use.
[in]	uri	configuration data.

Returns

Length of data written to buffer (excluding NULL).
< 0 if an error occurred.

Definition at line 2151 of file rest.c.

Here is the call graph for this function:

Variable Documentation

◆ http_auth_table

fr_table_num_sorted_t const http_auth_table[]

Initial value:

= {
        { L("any"),                                     REST_HTTP_AUTH_ANY              },
        { L("basic"),                                   REST_HTTP_AUTH_BASIC            },
        { L("digest"),                                  REST_HTTP_AUTH_DIGEST           },
        { L("digest-ie"),                               REST_HTTP_AUTH_DIGEST_IE        },
        { L("gss-negotiate"),                           REST_HTTP_AUTH_GSSNEGOTIATE     },
        { L("none"),                                    REST_HTTP_AUTH_NONE             },
        { L("ntlm"),                                    REST_HTTP_AUTH_NTLM             },
        { L("ntlm-winbind"),                            REST_HTTP_AUTH_NTLM_WB          },
        { L("safe"),                                    REST_HTTP_AUTH_ANY_SAFE         },
        { L("srp"),                                     REST_HTTP_AUTH_TLS_SRP          }
}

Definition at line 160 of file rest.c.

◆ http_auth_table_len

size_t http_auth_table_len = NUM_ELEMENTS(http_auth_table)

Definition at line 172 of file rest.c.

◆ http_body_type_supported

const http_body_type_t http_body_type_supported[REST_HTTP_BODY_NUM_ENTRIES]

Initial value:

= {
        REST_HTTP_BODY_UNKNOWN,                 
        REST_HTTP_BODY_UNSUPPORTED,             
        REST_HTTP_BODY_UNSUPPORTED,             
        REST_HTTP_BODY_UNSUPPORTED,             
        REST_HTTP_BODY_NONE,                    
        REST_HTTP_BODY_CUSTOM,                  
        REST_HTTP_BODY_POST,                    
 
        REST_HTTP_BODY_JSON,                    
 
 
 
        REST_HTTP_BODY_UNSUPPORTED,             
        REST_HTTP_BODY_UNSUPPORTED,             
        REST_HTTP_BODY_INVALID,                 
        REST_HTTP_BODY_PLAIN                    
}

Table of encoder/decoder support.

Indexes in this table match the http_body_type_t enum, and should be updated if additional enum values are added.

See also: http_body_type_t

Definition at line 51 of file rest.c.

◆ http_body_type_table

fr_table_num_sorted_t const http_body_type_table[]

Initial value:

= {
        { L("html"),                                    REST_HTTP_BODY_HTML             },
        { L("invalid"),                                 REST_HTTP_BODY_INVALID          },
        { L("json"),                                    REST_HTTP_BODY_JSON             },
        { L("none"),                                    REST_HTTP_BODY_NONE             },
        { L("plain"),                                   REST_HTTP_BODY_PLAIN            },
        { L("post"),                                    REST_HTTP_BODY_POST             },
        { L("unavailable"),                             REST_HTTP_BODY_UNAVAILABLE      },
        { L("unknown"),                                 REST_HTTP_BODY_UNKNOWN          },
        { L("unsupported"),                             REST_HTTP_BODY_UNSUPPORTED      },
        { L("xml"),                                     REST_HTTP_BODY_XML              },
        { L("yaml"),                                    REST_HTTP_BODY_YAML             }
}

Conversion table for type config values.

Textual names for http_body_type_t enum values, used by the configuration parser.

See also: http_body_Type_t; fr_table_value_by_str; fr_table_str_by_value

Definition at line 145 of file rest.c.

◆ http_body_type_table_len

size_t http_body_type_table_len = NUM_ELEMENTS(http_body_type_table)

Definition at line 158 of file rest.c.

◆ http_content_type_table

fr_table_num_sorted_t const http_content_type_table[]

Initial value:

= {
        { L("application/json"),                        REST_HTTP_BODY_JSON             },
        { L("application/x-www-form-urlencoded"),       REST_HTTP_BODY_POST             },
        { L("application/x-yaml"),                      REST_HTTP_BODY_YAML             },
        { L("application/yaml"),                        REST_HTTP_BODY_YAML             },
        { L("text/html"),                               REST_HTTP_BODY_HTML             },
        { L("text/plain"),                              REST_HTTP_BODY_PLAIN            },
        { L("text/x-yaml"),                             REST_HTTP_BODY_YAML             },
        { L("text/xml"),                                REST_HTTP_BODY_XML              },
        { L("text/yaml"),                               REST_HTTP_BODY_YAML             }
}

Conversion table for "Content-Type" header values.

Used by rest_response_header for parsing incoming headers.

Values we expect to see in the 'Content-Type:' header of the incoming response.

Some data types (like YAML) do no have standard MIME types defined, so multiple types, are listed here.

See also: http_body_Type_t; fr_table_value_by_str; fr_table_str_by_value

Definition at line 188 of file rest.c.

◆ http_content_type_table_len

size_t http_content_type_table_len = NUM_ELEMENTS(http_content_type_table)

Definition at line 199 of file rest.c.

◆ http_curl_auth

const unsigned long http_curl_auth[REST_HTTP_AUTH_NUM_ENTRIES]

Initial value:

= {
        [REST_HTTP_AUTH_UNKNOWN]                        = 0,
        [REST_HTTP_AUTH_NONE]                           = 0,
        [REST_HTTP_AUTH_TLS_SRP]                        = CURLOPT_TLSAUTH_SRP,
        [REST_HTTP_AUTH_BASIC]                          = CURLAUTH_BASIC,
        [REST_HTTP_AUTH_DIGEST]                         = CURLAUTH_DIGEST,
        [REST_HTTP_AUTH_DIGEST_IE]                      = CURLAUTH_DIGEST_IE,
        [REST_HTTP_AUTH_GSSNEGOTIATE]                   = CURLAUTH_GSSNEGOTIATE,
        [REST_HTTP_AUTH_NTLM]                           = CURLAUTH_NTLM,
        [REST_HTTP_AUTH_NTLM_WB]                        = CURLAUTH_NTLM_WB,
        [REST_HTTP_AUTH_ANY]                            = CURLAUTH_ANY,
        [REST_HTTP_AUTH_ANY_SAFE]                       = CURLAUTH_ANYSAFE
}

Definition at line 100 of file rest.c.

◆ http_method_table

fr_table_num_sorted_t const http_method_table[]

Initial value:

= {
        { L("DELETE"),                                  REST_HTTP_METHOD_DELETE         },
        { L("GET"),                                     REST_HTTP_METHOD_GET            },
        { L("PATCH"),                                   REST_HTTP_METHOD_PATCH          },
        { L("POST"),                                    REST_HTTP_METHOD_POST           },
        { L("PUT"),                                     REST_HTTP_METHOD_PUT            },
        { L("UNKNOWN"),                                 REST_HTTP_METHOD_UNKNOWN        }
}

Conversion table for method config values.

HTTP verb strings for http_method_t enum values. Used by libcurl in the status line of the outgoing HTTP header, by rest_response_header for decoding incoming HTTP responses, and by the configuration parser.

Note: must be kept in sync with http_method_t enum.

See also: http_method_t; fr_table_value_by_str; fr_table_str_by_value

Definition at line 126 of file rest.c.

◆ http_method_table_len

size_t http_method_table_len = NUM_ELEMENTS(http_method_table)

Definition at line 134 of file rest.c.

Data Structures

Macros

Functions

Variables

Detailed Description

Data Structure Documentation

◆ json_flags_t

◆ rest_custom_data_t

Macro Definition Documentation

◆ CURLAUTH_BASIC

◆ CURLAUTH_DIGEST

◆ CURLAUTH_DIGEST_IE

◆ CURLAUTH_GSSNEGOTIATE

◆ CURLAUTH_NTLM

◆ CURLAUTH_NTLM_WB

◆ CURLOPT_TLSAUTH_SRP

◆ LOG_PREFIX

◆ SET_AUTH_OPTION

Function Documentation

◆ _mod_conn_free()

◆ json_pair_alloc()

◆ json_pair_alloc_leaf()

◆ rest_decode_json()

◆ rest_decode_plain()

◆ rest_decode_post()

◆ rest_encode_custom()

◆ rest_encode_json()

◆ rest_encode_post()

◆ rest_get_handle_data()

◆ rest_mod_conn_create()

◆ rest_request_config()

◆ rest_request_config_body()

◆ rest_request_encode_wrapper()

◆ rest_request_init()

◆ rest_response_body()

◆ rest_response_debug()

◆ rest_response_decode()

◆ rest_response_error()

◆ rest_response_header()

◆ rest_response_init()

◆ rest_uri_escape()

◆ rest_uri_host_unescape()

Variable Documentation

◆ http_auth_table

◆ http_auth_table_len

◆ http_body_type_supported

◆ http_body_type_table

◆ http_body_type_table_len

◆ http_content_type_table

◆ http_content_type_table_len

◆ http_curl_auth

◆ http_method_table

◆ http_method_table_len