2 * This program is free software; you can redistribute it and/or modify
3 * it under the terms of the GNU General Public License as published by
4 * the Free Software Foundation; either version 2 of the License, or
5 * (at your option) any later version.
7 * This program is distributed in the hope that it will be useful,
8 * but WITHOUT ANY WARRANTY; without even the implied warranty of
9 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
10 * GNU General Public License for more details.
12 * You should have received a copy of the GNU General Public License
13 * along with this program; if not, write to the Free Software
14 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA
20 * @brief Functions and datatypes for the REST (HTTP) transport.
23 * @copyright 2012-2013 Arran Cudbard-Bell <a.cudbard-bell@freeradius.org>
26 #include <freeradius-devel/ident.h>
34 #include <freeradius-devel/radiusd.h>
35 #include <freeradius-devel/libradius.h>
36 #include <freeradius-devel/connection.h>
40 /** Table of encoder/decoder support.
42 * Indexes in this table match the http_body_type_t enum, and should be
43 * updated if additional enum values are added.
45 * @see http_body_type_t
47 const http_body_type_t http_body_type_supported[HTTP_BODY_NUM_ENTRIES] = {
48 HTTP_BODY_UNSUPPORTED, // HTTP_BODY_UNKOWN
49 HTTP_BODY_UNSUPPORTED, // HTTP_BODY_UNSUPPORTED
50 HTTP_BODY_UNSUPPORTED, // HTTP_BODY_INVALID
51 HTTP_BODY_POST, // HTTP_BODY_POST
53 HTTP_BODY_JSON, // HTTP_BODY_JSON
55 HTTP_BODY_UNAVAILABLE,
57 HTTP_BODY_UNSUPPORTED, // HTTP_BODY_XML
58 HTTP_BODY_UNSUPPORTED, // HTTP_BODY_YAML
59 HTTP_BODY_INVALID, // HTTP_BODY_HTML
60 HTTP_BODY_INVALID // HTTP_BODY_PLAIN
64 * Lib CURL doesn't define symbols for unsupported auth methods
66 #ifndef CURLOPT_TLSAUTH_SRP
67 #define CURLOPT_TLSAUTH_SRP 0
69 #ifndef CURLAUTH_BASIC
70 #define CURLAUTH_BASIC 0
72 #ifndef CURLAUTH_DIGEST
73 #define CURLAUTH_DIGEST 0
75 #ifndef CURLAUTH_DIGEST_IE
76 #define CURLAUTH_DIGEST_IE 0
78 #ifndef CURLAUTH_GSSNEGOTIATE
79 #define CURLAUTH_GSSNEGOTIATE 0
82 #define CURLAUTH_NTLM 0
84 #ifndef CURLAUTH_NTLM_WB
85 #define CURLAUTH_NTLM_WB 0
88 const http_body_type_t http_curl_auth[HTTP_AUTH_NUM_ENTRIES] = {
89 0, // HTTP_AUTH_UNKNOWN
91 CURLOPT_TLSAUTH_SRP, // HTTP_AUTH_TLS_SRP
92 CURLAUTH_BASIC, // HTTP_AUTH_BASIC
93 CURLAUTH_DIGEST, // HTTP_AUTH_DIGEST
94 CURLAUTH_DIGEST_IE, // HTTP_AUTH_DIGEST_IE
95 CURLAUTH_GSSNEGOTIATE, // HTTP_AUTH_GSSNEGOTIATE
96 CURLAUTH_NTLM, // HTTP_AUTH_NTLM
97 CURLAUTH_NTLM_WB, // HTTP_AUTH_NTLM_WB
98 CURLAUTH_ANY, // HTTP_AUTH_ANY
99 CURLAUTH_ANYSAFE // HTTP_AUTH_ANY_SAFE
103 /** Conversion table for method config values.
105 * HTTP verb strings for http_method_t enum values. Used by libcurl in the
106 * status line of the outgoing HTTP header, by rest_write_header for decoding
107 * incoming HTTP responses, and by the configuration parser.
113 const FR_NAME_NUMBER http_method_table[] = {
114 { "GET", HTTP_METHOD_GET },
115 { "POST", HTTP_METHOD_POST },
116 { "PUT", HTTP_METHOD_PUT },
117 { "DELETE", HTTP_METHOD_DELETE },
122 /** Conversion table for type config values.
124 * Textual names for http_body_type_t enum values, used by the
125 * configuration parser.
127 * @see http_body_Type_t
131 const FR_NAME_NUMBER http_body_type_table[] = {
132 { "unknown", HTTP_BODY_UNKNOWN },
133 { "unsupported", HTTP_BODY_UNSUPPORTED },
134 { "unavailable", HTTP_BODY_UNAVAILABLE },
135 { "invalid", HTTP_BODY_INVALID },
136 { "post", HTTP_BODY_POST },
137 { "json", HTTP_BODY_JSON },
138 { "xml", HTTP_BODY_XML },
139 { "yaml", HTTP_BODY_YAML },
140 { "html", HTTP_BODY_HTML },
141 { "plain", HTTP_BODY_PLAIN },
146 const FR_NAME_NUMBER http_auth_table[] = {
147 { "none", HTTP_AUTH_NONE },
148 { "srp", HTTP_AUTH_TLS_SRP },
149 { "basic", HTTP_AUTH_BASIC },
150 { "digest", HTTP_AUTH_DIGEST },
151 { "digest-ie", HTTP_AUTH_DIGEST_IE },
152 { "gss-negotiate", HTTP_AUTH_GSSNEGOTIATE },
153 { "ntlm", HTTP_AUTH_NTLM },
154 { "ntlm-winbind", HTTP_AUTH_NTLM_WB },
155 { "any", HTTP_AUTH_ANY },
156 { "safe", HTTP_AUTH_ANY_SAFE },
161 /** Conversion table for "Content-Type" header values.
163 * Used by rest_write_header for parsing incoming headers.
165 * Values we expect to see in the 'Content-Type:' header of the incoming
168 * Some data types (like YAML) do no have standard MIME types defined,
169 * so multiple types, are listed here.
171 * @see http_body_Type_t
175 const FR_NAME_NUMBER http_content_type_table[] = {
176 { "application/x-www-form-urlencoded", HTTP_BODY_POST },
177 { "application/json", HTTP_BODY_JSON },
178 { "text/html", HTTP_BODY_HTML },
179 { "text/plain", HTTP_BODY_PLAIN },
180 { "text/xml", HTTP_BODY_XML },
181 { "text/yaml", HTTP_BODY_YAML },
182 { "text/x-yaml", HTTP_BODY_YAML },
183 { "application/yaml", HTTP_BODY_YAML },
184 { "application/x-yaml", HTTP_BODY_YAML },
189 /** Flags to control the conversion of JSON values to VALUE_PAIRs.
191 * These fields are set when parsing the expanded format for value pairs in
192 * JSON, and control how json_pairmake_leaf and json_pairmake convert the JSON
193 * value, and move the new VALUE_PAIR into an attribute list.
196 * @see json_pairmake_leaf
198 typedef struct json_flags {
199 boolean do_xlat; //!< If TRUE value will be expanded with xlat.
200 boolean is_json; //!< If TRUE value will be inserted as raw JSON
201 // (multiple values not supported).
202 FR_TOKEN op; //!< The operator that determines how the new VP
203 // is processed. @see fr_tokens
207 /** Initialises libcurl.
209 * Allocates global variables and memory required for libcurl to fundtion.
210 * MUST only be called once per module instance.
212 * rest_cleanup must not be called if rest_init fails.
216 * @param[in] instance configuration data.
217 * @return TRUE if init succeeded FALSE if it failed.
219 int rest_init(rlm_rest_t *instance)
223 ret = curl_global_init(CURL_GLOBAL_ALL);
224 if (ret != CURLE_OK) {
226 "rlm_rest (%s): CURL init returned error: %i - %s",
228 ret, curl_easy_strerror(ret));
230 curl_global_cleanup();
234 radlog(L_DBG, "rlm_rest (%s): CURL library version: %s",
241 /** Cleans up after libcurl.
243 * Wrapper around curl_global_cleanup, frees any memory allocated by rest_init.
244 * Must only be called once per call of rest_init.
248 void rest_cleanup(void)
250 curl_global_cleanup();
253 /** Creates a new connection handle for use by the FR connection API.
255 * Matches the fr_connection_create_t function prototype, is passed to
256 * fr_connection_pool_init, and called when a new connection is required by the
257 * connection pool API.
259 * Creates an instances of rlm_rest_handle_t, and rlm_rest_curl_context_t
260 * which hold the context data required for generating requests and parsing
261 * responses. Calling rest_socket_delete will free this memory.
263 * If instance->connect_uri is not NULL libcurl will attempt to open a
264 * TCP socket to the server specified in the URI. This is done so that when the
265 * socket is first used, there will already be a cached TCP connection to the
266 * REST server associated with the curl handle.
268 * @see rest_socket_delete
269 * @see fr_connection_pool_init
270 * @see fr_connection_create_t
273 * @param[in] instance configuration data.
274 * @return connection handle or NULL if the connection failed or couldn't
277 void *rest_socket_create(void *instance)
279 rlm_rest_t *inst = instance;
281 rlm_rest_handle_t *randle;
282 rlm_rest_curl_context_t *ctx;
284 CURL *candle = curl_easy_init();
288 radlog(L_ERR, "rlm_rest (%s): Failed to create CURL handle",
293 if (!*inst->connect_uri) {
294 radlog(L_ERR, "rlm_rest (%s): Skipping pre-connect,"
295 " connect_uri not specified", inst->xlat_name);
300 * Pre-establish TCP connection to webserver. This would usually be
301 * done on the first request, but we do it here to minimise
304 ret = curl_easy_setopt(candle, CURLOPT_CONNECT_ONLY, 1);
305 if (ret != CURLE_OK) goto error;
307 ret = curl_easy_setopt(candle, CURLOPT_URL,
309 if (ret != CURLE_OK) goto error;
311 radlog(L_DBG, "rlm_rest (%s): Connecting to \"%s\"",
315 ret = curl_easy_perform(candle);
316 if (ret != CURLE_OK) {
317 radlog(L_ERR, "rlm_rest (%s): Connection failed: %i - %s",
319 ret, curl_easy_strerror(ret));
321 goto connection_error;
325 * Malloc memory for the connection handle abstraction.
327 randle = malloc(sizeof(*randle));
328 memset(randle, 0, sizeof(*randle));
330 ctx = malloc(sizeof(*ctx));
331 memset(ctx, 0, sizeof(*ctx));
333 ctx->headers = NULL; /* CURL needs this to be NULL */
334 ctx->read.instance = inst;
337 randle->handle = candle;
340 * Clear any previously configured options for the first request.
342 curl_easy_reset(candle);
347 * Cleanup for error conditions.
351 radlog(L_ERR, "rlm_rest (%s): Failed setting curl option: %i - %s",
353 ret, curl_easy_strerror(ret));
356 * So we don't leak CURL handles.
360 curl_easy_cleanup(candle);
365 /** Verifies that the last TCP socket associated with a handle is still active.
367 * Quieries libcurl to try and determine if the TCP socket associated with a
368 * connection handle is still viable.
370 * @param[in] instance configuration data.
371 * @param[in] handle to check.
372 * @returns FALSE if the last socket is dead, or if the socket state couldn't be
373 * determined, else TRUE.
375 int rest_socket_alive(void *instance, void *handle)
377 rlm_rest_t *inst = instance;
378 rlm_rest_handle_t *randle = handle;
379 CURL *candle = randle->handle;
384 curl_easy_getinfo(candle, CURLINFO_LASTSOCKET, &last_socket);
385 if (ret != CURLE_OK) {
387 "rlm_rest (%s): Couldn't determine socket"
388 " state: %i - %s", inst->xlat_name, ret,
389 curl_easy_strerror(ret));
394 if (last_socket == -1) {
401 /** Frees a libcurl handle, and any additional memory used by context data.
403 * @param[in] instance configuration data.
404 * @param[in] handle rlm_rest_handle_t to close and free.
405 * @return returns TRUE.
407 int rest_socket_delete(UNUSED void *instance, void *handle)
409 rlm_rest_handle_t *randle = handle;
410 CURL *candle = randle->handle;
412 curl_easy_cleanup(candle);
420 /** Encodes VALUE_PAIR linked list in POST format
422 * This is a stream function matching the rest_read_t prototype. Multiple
423 * successive calls will return additional encoded VALUE_PAIRs.
424 * Only complete attribute headers @verbatim '<name>=' @endverbatim and values
425 * will be written to the ptr buffer.
427 * POST request format is:
428 * @verbatim <attribute0>=<value0>&<attribute1>=<value1>&<attributeN>=<valueN>@endverbatim
430 * All attributes and values are url encoded. There is currently no support for
431 * nested attributes, or attribute qualifiers.
433 * Nested attributes may be added in the future using
434 * @verbatim <attribute-outer>:<attribute-inner>@endverbatim
435 * to denotate nesting.
437 * Requires libcurl for url encoding.
439 * @see rest_decode_post
441 * @param[out] ptr Char buffer to write encoded data to.
442 * @param[in] size Multiply by nmemb to get the length of ptr.
443 * @param[in] nmemb Multiply by size to get the length of ptr.
444 * @param[in] userdata rlm_rest_read_t to keep encoding state between calls.
445 * @return length of data (including NULL) written to ptr, or 0 if no more
448 static size_t rest_encode_post(void *ptr, size_t size, size_t nmemb,
451 rlm_rest_read_t *ctx = userdata;
452 REQUEST *request = ctx->request; /* Used by RDEBUG */
453 VALUE_PAIR **current = ctx->next;
455 char *p = ptr; /* Position in buffer */
456 char *f = ptr; /* Position in buffer of last fully encoded attribute or value */
457 char *escaped; /* Pointer to current URL escaped data */
460 ssize_t s = (size * nmemb) - 1;
462 /* Allow manual chunking */
463 if ((ctx->chunk) && (ctx->chunk <= s)) {
464 s = (ctx->chunk - 1);
467 if (ctx->state == READ_STATE_END) return FALSE;
469 /* Post data requires no headers */
470 if (ctx->state == READ_STATE_INIT) {
471 ctx->state = READ_STATE_ATTR_BEGIN;
476 ctx->state = READ_STATE_END;
481 RDEBUG2("Encoding attribute \"%s\"", current[0]->name);
483 if (ctx->state == READ_STATE_ATTR_BEGIN) {
484 escaped = curl_escape(current[0]->name,
485 strlen(current[0]->name));
486 len = strlen(escaped);
493 len = sprintf(p, "%s=", escaped);
501 * We wrote the attribute header, record progress.
504 ctx->state = READ_STATE_ATTR_CONT;
508 * Write out single attribute string.
510 len = vp_prints_value(p , s, current[0], 0);
511 escaped = curl_escape(p, len);
512 len = strlen(escaped);
519 len = strlcpy(p, escaped, len + 1);
523 RDEBUG("\tLength : %i", len);
524 RDEBUG("\tValue : %s", p);
530 if (!--s) goto no_space;
535 * We wrote one full attribute value pair, record progress.
539 ctx->state = READ_STATE_ATTR_BEGIN;
546 len = p - (char*)ptr;
548 RDEBUG2("POST Data: %s", (char*) ptr);
549 RDEBUG2("Returning %i bytes of POST data", len);
554 * Cleanup for error conditions
560 len = f - (char*)ptr;
562 RDEBUG2("POST Data: %s", (char*) ptr);
565 * The buffer wasn't big enough to encode a single attribute chunk.
568 radlog(L_ERR, "rlm_rest (%s): AVP exceeds buffer length"
569 " or chunk", ctx->instance->xlat_name);
571 RDEBUG2("Returning %i bytes of POST data"
572 " (buffer full or chunk exceeded)", len);
578 /** Encodes VALUE_PAIR linked list in JSON format
580 * This is a stream function matching the rest_read_t prototype. Multiple
581 * successive calls will return additional encoded VALUE_PAIRs.
583 * Only complete attribute headers
584 * @verbatim "<name>":{"type":"<type>","value":[' @endverbatim
585 * and complete attribute values will be written to ptr.
587 * If an attribute occurs multiple times in the request the attribute values
588 * will be concatenated into a single value array.
590 * JSON request format is:
595 "value":[<value0>,<value1>,<valueN>]
608 * @param[out] ptr Char buffer to write encoded data to.
609 * @param[in] size Multiply by nmemb to get the length of ptr.
610 * @param[in] nmemb Multiply by size to get the length of ptr.
611 * @param[in] userdata rlm_rest_read_t to keep encoding state between calls.
612 * @return length of data (including NULL) written to ptr, or 0 if no more
615 static size_t rest_encode_json(void *ptr, size_t size, size_t nmemb,
618 rlm_rest_read_t *ctx = userdata;
619 REQUEST *request = ctx->request; /* Used by RDEBUG */
620 VALUE_PAIR **current = ctx->next;
622 char *p = ptr; /* Position in buffer */
623 char *f = ptr; /* Position in buffer of last fully encoded attribute or value */
628 ssize_t s = (size * nmemb) - 1;
632 /* Allow manual chunking */
633 if ((ctx->chunk) && (ctx->chunk <= s)) {
634 s = (ctx->chunk - 1);
637 if (ctx->state == READ_STATE_END) return FALSE;
639 if (ctx->state == READ_STATE_INIT) {
640 ctx->state = READ_STATE_ATTR_BEGIN;
642 if (!--s) goto no_space;
648 ctx->state = READ_STATE_END;
650 if (!--s) goto no_space;
657 * New attribute, write name, type, and beginning of
660 RDEBUG2("Encoding attribute \"%s\"", current[0]->name);
661 if (ctx->state == READ_STATE_ATTR_BEGIN) {
662 type = fr_int2str(dict_attr_types, current[0]->type,
666 len += strlen(current[0]->name);
668 if (s < (23 + len)) goto no_space;
670 len = sprintf(p, "\"%s\":{\"type\":\"%s\",\"value\":[" ,
671 current[0]->name, type);
675 RDEBUG2("\tType : %s", type);
678 * We wrote the attribute header, record progress
681 ctx->state = READ_STATE_ATTR_CONT;
685 * Put all attribute values in an array for easier remote
686 * parsing whether they're multivalued or not.
689 len = vp_prints_value_json(p , s, current[0]);
690 assert((s - len) >= 0);
692 if (len < 0) goto no_space;
695 * Show actual value length minus quotes
697 RDEBUG2("\tLength : %i", (*p == '"') ? (len - 2) : len);
698 RDEBUG2("\tValue : %s", p);
704 * Multivalued attribute
707 ((current[0]->attribute == current[1]->attribute) &&
708 (current[0]->vendor == current[1]->vendor))) {
713 * We wrote one attribute value, record
723 if (!(s -= 2)) goto no_space;
728 if (!--s) goto no_space;
733 * We wrote one full attribute value pair, record progress.
737 ctx->state = READ_STATE_ATTR_BEGIN;
744 len = p - (char*)ptr;
746 RDEBUG2("JSON Data: %s", (char*) ptr);
747 RDEBUG2("Returning %i bytes of JSON data", len);
752 * Were out of buffer space
758 len = f - (char*)ptr;
760 RDEBUG2("JSON Data: %s", (char*) ptr);
763 * The buffer wasn't big enough to encode a single attribute chunk.
766 radlog(L_ERR, "rlm_rest (%s): AVP exceeds buffer length"
767 " or chunk", ctx->instance->xlat_name);
769 RDEBUG2("Returning %i bytes of JSON data"
770 " (buffer full or chunk exceeded)", len);
776 /** Emulates successive libcurl calls to an encoding function
778 * This function is used when the request will be sent to the HTTP server as one
779 * contiguous entity. A buffer of REST_BODY_INCR bytes is allocated and passed
780 * to the stream encoding function.
782 * If the stream function does not return 0, a new buffer is allocated which is
783 * the size of the previous buffer + REST_BODY_INCR bytes, the data from the
784 * previous buffer is copied, and freed, and another call is made to the stream
785 * function, passing a pointer into the new buffer at the end of the previously
788 * This process continues until the stream function signals (by returning 0)
789 * that it has no more data to write.
791 * @param[out] buffer where the pointer to the malloced buffer should
793 * @param[in] func Stream function.
794 * @param[in] limit Maximum buffer size to alloc.
795 * @param[in] userdata rlm_rest_read_t to keep encoding state between calls to
797 * @return the length of the data written to the buffer (excluding NULL) or -1
800 static ssize_t rest_read_wrapper(char **buffer, rest_read_t func,
801 size_t limit, void *userdata)
803 char *previous = NULL;
806 size_t alloc = REST_BODY_INCR; /* Size of buffer to malloc */
807 size_t used = 0; /* Size of data written */
810 while (alloc < limit) {
811 current = rad_malloc(alloc);
814 strlcpy(current, previous, used + 1);
818 len = func(current + used, REST_BODY_INCR, 1, userdata);
825 alloc += REST_BODY_INCR;
834 /** (Re-)Initialises the data in a rlm_rest_read_t.
836 * Resets the values of a rlm_rest_read_t to their defaults.
838 * Must be called between encoding sessions.
840 * As part of initialisation all VALUE_PAIR pointers in the REQUEST packet are
841 * written to an array.
843 * If sort is TRUE, this array of VALUE_PAIR pointers will be sorted by vendor
844 * and then by attribute. This is for stream encoders which may concatenate
845 * multiple attribute values together into an array.
847 * After the encoding session has completed this array must be freed by calling
848 * rest_read_ctx_free .
850 * @see rest_read_ctx_free
852 * @param[in] request Current request.
853 * @param[in] ctx to initialise.
854 * @param[in] sort If TRUE VALUE_PAIRs will be sorted within the VALUE_PAIR
857 static void rest_read_ctx_init(REQUEST *request,
858 rlm_rest_read_t *ctx,
861 unsigned short count = 0, i;
864 VALUE_PAIR **current, *tmp;
867 * Setup stream read data
869 ctx->request = request;
870 ctx->state = READ_STATE_INIT;
873 * Create sorted array of VP pointers
875 tmp = request->packet->vps;
876 while (tmp != NULL) {
881 ctx->first = current = rad_malloc((sizeof(tmp) * (count + 1)));
882 ctx->next = ctx->first;
884 tmp = request->packet->vps;
885 while (tmp != NULL) {
890 current = ctx->first;
892 if (!sort || (count < 2)) return;
894 /* TODO: Quicksort would be faster... */
896 for(i = 1; i < count; i++) {
897 assert(current[i-1]->attribute &&
898 current[i]->attribute);
901 if ((current[i-1]->vendor > current[i]->vendor) ||
902 ((current[i-1]->vendor == current[i]->vendor) &&
903 (current[i-1]->attribute > current[i]->attribute)
906 current[i] = current[i-1];
914 /** Frees the VALUE_PAIR array created by rest_read_ctx_init.
916 * Must be called between encoding sessions else module will leak VALUE_PAIR
919 * @see rest_read_ctx_init
921 * @param[in] ctx to free.
923 static void rest_read_ctx_free(rlm_rest_read_t *ctx)
925 if (ctx->first != NULL) {
930 /** Verify that value wasn't truncated when it was converted to a VALUE_PAIR
932 * Certain values may be truncated when they're converted into VALUE_PAIRs
933 * for example 64bit integers converted to 32bit integers. Warn the user
936 * @param[in] request Current request.
937 * @param[in] raw string from decoder.
938 * @param[in] vp containing parsed value.
940 static void rest_check_truncation(REQUEST *request, const char *raw,
945 vp_prints_value(cooked, sizeof(cooked), vp, 0);
946 if (strcmp(raw, cooked) != 0) {
947 RDEBUG("WARNING: Value-Pair does not match POST value, "
948 "truncation may have occurred");
949 RDEBUG("\tValue (pair) : \"%s\"", cooked);
950 RDEBUG("\tValue (post) : \"%s\"", raw);
954 /** Converts POST response into VALUE_PAIRs and adds them to the request
956 * Accepts VALUE_PAIRS in the same format as rest_encode_post, but with the
957 * addition of optional attribute list qualifiers as part of the attribute name
960 * If no qualifiers are specified, will default to the request list.
962 * POST response format is:
963 * @verbatim [outer.][<list>:]<attribute0>=<value0>&[outer.][<list>:]<attribute1>=<value1>&[outer.][<list>:]<attributeN>=<valueN> @endverbatim
965 * @see rest_encode_post
967 * @param[in] instance configuration data.
968 * @param[in] section configuration data.
969 * @param[in] handle rlm_rest_handle_t to use.
970 * @param[in] request Current request.
971 * @param[in] raw buffer containing POST data.
972 * @param[in] rawlen Length of data in raw buffer.
973 * @return the number of VALUE_PAIRs processed or -1 on unrecoverable error.
975 static int rest_decode_post(rlm_rest_t *instance,
976 UNUSED rlm_rest_section_t *section,
977 REQUEST *request, void *handle, char *raw,
978 UNUSED size_t rawlen)
980 rlm_rest_handle_t *randle = handle;
981 CURL *candle = randle->handle;
983 const char *p = raw, *q;
985 const char *attribute;
992 const DICT_ATTR **current, *processed[REST_BODY_MAX_ATTRS + 1];
995 pair_lists_t list_name;
996 request_refs_t request_name;
997 REQUEST *reference = request;
1001 int curl_len; /* Length from last curl_easy_unescape call */
1005 processed[0] = NULL;
1010 while (isspace(*p)) p++;
1011 if (*p == '\0') return FALSE;
1013 while (((q = strchr(p, '=')) != NULL) &&
1014 (count < REST_BODY_MAX_ATTRS)) {
1016 reference = request;
1018 name = curl_easy_unescape(candle, p, (q - p), &curl_len);
1021 RDEBUG("Decoding attribute \"%s\"", name);
1023 request_name = radius_request_name(&attribute, REQUEST_CURRENT);
1024 if (request_name == REQUEST_UNKNOWN) {
1025 RDEBUG("WARNING: Invalid request qualifier, skipping");
1032 if (!radius_request(&reference, request_name)) {
1033 RDEBUG("WARNING: Attribute name refers to outer request"
1034 " but not in a tunnel, skipping");
1041 list_name = radius_list_name(&attribute, PAIR_LIST_REPLY);
1042 if (list_name == PAIR_LIST_UNKNOWN) {
1043 RDEBUG("WARNING: Invalid list qualifier, skipping");
1050 da = dict_attrbyname(attribute);
1052 RDEBUG("WARNING: Attribute \"%s\" unknown, skipping",
1060 vps = radius_list(reference, list_name);
1064 RDEBUG2("\tType : %s", fr_int2str(dict_attr_types, da->type,
1068 len = (q == NULL) ? (rawlen - (p - raw)) : (unsigned)(q - p);
1070 value = curl_easy_unescape(candle, p, len, &curl_len);
1073 * If we found a delimiter we want to skip over it,
1074 * if we didn't we do *NOT* want to skip over the end
1077 p += (q == NULL) ? len : (len + 1);
1079 RDEBUG2("\tLength : %i", curl_len);
1080 RDEBUG2("\tValue : \"%s\"", value);
1082 vp = paircreate(da->attr, da->vendor, da->type);
1084 radlog(L_ERR, "rlm_rest (%s): Failed creating"
1085 " value-pair", instance->xlat_name);
1093 * Check to see if we've already processed an
1094 * attribute of the same type if we have, change the op
1095 * from T_OP_ADD to T_OP_SET.
1097 current = processed;
1098 while (*current++) {
1099 if ((current[0]->attr == da->attr) &&
1100 (current[0]->vendor == da->vendor)) {
1106 if (vp->op != T_OP_ADD) {
1111 tmp = pairparsevalue(vp, value);
1113 RDEBUG("Incompatible value assignment, skipping");
1119 rest_check_truncation(request, value, vp);
1121 vp->flags.do_xlat = 1;
1123 RDEBUG("Performing xlat expansion of response value", value);
1124 pairxlatmove(request, vps, &vp);
1126 if (++count == REST_BODY_MAX_ATTRS) {
1127 radlog(L_ERR, "rlm_rest (%s): At maximum"
1128 " attribute limit", instance->xlat_name);
1148 radlog(L_ERR, "rlm_rest (%s): Malformed POST data \"%s\"",
1149 instance->xlat_name, raw);
1157 /** Converts JSON "value" key into VALUE_PAIR.
1159 * If leaf is not in fact a leaf node, but contains JSON data, the data will
1160 * written to the attribute in JSON string format.
1162 * @param[in] instance configuration data.
1163 * @param[in] section configuration data.
1164 * @param[in] request Current request.
1165 * @param[in] da Attribute to create.
1166 * @param[in] flags containing the operator other flags controlling value
1168 * @param[in] leaf object containing the VALUE_PAIR value.
1169 * @return The VALUE_PAIR just created, or NULL on error.
1171 static VALUE_PAIR *json_pairmake_leaf(rlm_rest_t *instance,
1172 UNUSED rlm_rest_section_t *section,
1173 REQUEST *request, const DICT_ATTR *da,
1174 json_flags_t *flags, json_object *leaf)
1177 VALUE_PAIR *vp, *tmp;
1180 * Should encode any nested JSON structures into JSON strings.
1182 * "I knew you liked JSON so I put JSON in your JSON!"
1184 value = json_object_get_string(leaf);
1186 RDEBUG2("\tType : %s", fr_int2str(dict_attr_types, da->type,
1188 RDEBUG2("\tLength : %i", strlen(value));
1189 RDEBUG2("\tValue : \"%s\"", value);
1191 vp = paircreate(da->attr, da->vendor, da->type);
1193 radlog(L_ERR, "rlm_rest (%s): Failed creating value-pair",
1194 instance->xlat_name);
1200 tmp = pairparsevalue(vp, value);
1202 RDEBUG("Incompatible value assignment, skipping");
1208 rest_check_truncation(request, value, vp);
1210 if (flags->do_xlat) vp->flags.do_xlat = 1;
1215 /** Processes JSON response and converts it into multiple VALUE_PAIRs
1217 * Processes JSON attribute declarations in the format below. Will recurse when
1218 * processing nested attributes. When processing nested attributes flags and
1219 * operators from previous attributes are not inherited.
1221 * JSON response format is:
1228 "value":[<value0>,<value1>,<valueN>]
1232 "<nested-attribute0>":{
1238 "<attribute2>":"<value0>",
1239 "<attributeN>":"[<value0>,<value1>,<valueN>]"
1243 * JSON valuepair flags (bools):
1244 * - do_xlat (optional) Controls xlat expansion of values. Defaults to TRUE.
1245 * - is_json (optional) If TRUE, any nested JSON data will be copied to the
1246 * VALUE_PAIR in string form. Defaults to TRUE.
1247 * - op (optional) Controls how the attribute is inserted into
1248 * the target list. Defaults to ':=' (T_OP_SET).
1250 * If "op" is ':=' or '=', it will be automagically changed to '+=' for the
1251 * second and subsequent values in multivalued attributes. This does not work
1252 * between multiple attribute declarations.
1256 * @param[in] instance configuration data.
1257 * @param[in] section configuration data.
1258 * @param[in] request Current request.
1259 * @param[in] object containing root node, or parent node.
1260 * @param[in] level Current nesting level.
1261 * @param[in] max_attrs counter, decremented after each VALUE_PAIR is created,
1262 * when 0 no more attributes will be processed.
1263 * @return VALUE_PAIR or NULL on error.
1265 static VALUE_PAIR *json_pairmake(rlm_rest_t *instance,
1266 UNUSED rlm_rest_section_t *section,
1267 REQUEST *request, json_object *object,
1268 int level, int *max_attrs)
1273 const char *name, *attribute;
1275 struct json_object *value, *idx, *tmp;
1276 struct lh_entry *entry;
1279 const DICT_ATTR *da;
1282 request_refs_t request_name;
1283 pair_lists_t list_name;
1284 REQUEST *reference = request;
1289 if (!json_object_is_type(object, json_type_object)) {
1290 RDEBUG("Can't process VP container, expected JSON object,"
1291 " got \"%s\", skipping",
1292 json_object_get_type(object));
1297 * Process VP container
1299 entry = json_object_get_object(object)->head;
1301 flags.op = T_OP_SET;
1305 name = (char*)entry->k;
1307 /* Fix the compiler warnings regarding const... */
1308 memcpy(&value, &entry->v, sizeof(value));
1310 entry = entry->next;
1313 * For people handcrafting JSON responses
1316 while ((p = q = strchr(p, '|'))) {
1322 reference = request;
1325 * Resolve attribute name to a dictionary entry and
1328 RDEBUG2("Decoding attribute \"%s\"", name);
1330 request_name = radius_request_name(&attribute, REQUEST_CURRENT);
1331 if (request_name == REQUEST_UNKNOWN) {
1332 RDEBUG("WARNING: Request qualifier, skipping");
1337 if (!radius_request(&reference, request_name)) {
1338 RDEBUG("WARNING: Attribute name refers to outer request"
1339 " but not in a tunnel, skipping");
1344 list_name = radius_list_name(&attribute, PAIR_LIST_REPLY);
1345 if (list_name == PAIR_LIST_UNKNOWN) {
1346 RDEBUG("WARNING: Invalid list qualifier, skipping");
1351 da = dict_attrbyname(attribute);
1353 RDEBUG("WARNING: Attribute \"%s\" unknown, skipping",
1359 vps = radius_list(reference, list_name);
1364 * Alternate JSON structure that allows operator,
1365 * and other flags to be specified.
1375 * - [] Multivalued array
1376 * - {} Nested Valuepair
1377 * - * Integer or string value
1379 if (json_object_is_type(value, json_type_object)) {
1381 * Process operator if present.
1383 tmp = json_object_object_get(value, "op");
1385 flags.op = fr_str2int(fr_tokens,
1386 json_object_get_string(tmp), 0);
1389 RDEBUG("Invalid operator value \"%s\","
1396 * Process optional do_xlat bool.
1398 tmp = json_object_object_get(value, "do_xlat");
1400 flags.do_xlat = json_object_get_boolean(tmp);
1404 * Process optional is_json bool.
1406 tmp = json_object_object_get(value, "is_json");
1408 flags.is_json = json_object_get_boolean(tmp);
1412 * Value key must be present if were using
1413 * the expanded syntax.
1415 value = json_object_object_get(value, "value");
1417 RDEBUG("Value key missing, skipping", value);
1423 * Setup pairmake / recursion loop.
1425 if (!flags.is_json &&
1426 json_object_is_type(value, json_type_array)) {
1427 len = json_object_array_length(value);
1429 RDEBUG("Zero length value array, skipping", value);
1432 idx = json_object_array_get_idx(value, 0);
1440 if (!(*max_attrs)--) {
1441 radlog(L_ERR, "rlm_rest (%s): At maximum"
1442 " attribute limit", instance->xlat_name);
1447 * Automagically switch the op for multivalued
1450 if (((flags.op == T_OP_SET) ||
1451 (flags.op == T_OP_EQ)) && (len > 1)) {
1452 flags.op = T_OP_ADD;
1455 if (!flags.is_json &&
1456 json_object_is_type(value, json_type_object)) {
1457 /* TODO: Insert nested VP into VP structure...*/
1458 RDEBUG("Found nested VP", value);
1459 vp = json_pairmake(instance, section,
1461 level + 1, max_attrs);
1463 vp = json_pairmake_leaf(instance, section,
1464 request, da, &flags,
1468 if (vp->flags.do_xlat) {
1469 RDEBUG("Performing xlat"
1470 " expansion of response"
1474 pairxlatmove(request, vps, &vp);
1477 } while ((++i < len) && (idx = json_object_array_get_idx(value, i)));
1483 /** Converts JSON response into VALUE_PAIRs and adds them to the request.
1485 * Converts the raw JSON string into a json-c object tree and passes it to
1486 * json_pairmake. After the tree has been parsed json_object_put is called
1487 * which decrements the reference count of the root node by one, and frees
1490 * @see rest_encode_json
1491 * @see json_pairmake
1493 * @param[in] instance configuration data.
1494 * @param[in] section configuration data.
1495 * @param[in,out] request Current request.
1496 * @param[in] handle REST handle.
1497 * @param[in] raw buffer containing JSON data.
1498 * @param[in] rawlen Length of data in raw buffer.
1499 * @return the number of VALUE_PAIRs processed or -1 on unrecoverable error.
1501 static int rest_decode_json(rlm_rest_t *instance,
1502 UNUSED rlm_rest_section_t *section,
1503 REQUEST *request, UNUSED void *handle,
1504 char *raw, UNUSED size_t rawlen)
1506 const char *p = raw;
1508 struct json_object *json;
1510 int max = REST_BODY_MAX_ATTRS;
1515 while (isspace(*p)) p++;
1516 if (*p == '\0') return FALSE;
1518 json = json_tokener_parse(p);
1520 radlog(L_ERR, "rlm_rest (%s): Malformed JSON data \"%s\"",
1521 instance->xlat_name, raw);
1525 json_pairmake(instance, section, request, json, 0, &max);
1528 * Decrement reference count for root object, should free entire
1531 json_object_put(json);
1533 return (REST_BODY_MAX_ATTRS - max);
1537 /** Processes incoming HTTP header data from libcurl.
1539 * Processes the status line, and Content-Type headers from the incoming HTTP
1542 * Matches prototype for CURLOPT_HEADERFUNCTION, and will be called directly
1545 * @param[in] ptr Char buffer where inbound header data is written.
1546 * @param[in] size Multiply by nmemb to get the length of ptr.
1547 * @param[in] nmemb Multiply by size to get the length of ptr.
1548 * @param[in] userdata rlm_rest_write_t to keep parsing state between calls.
1549 * @return Length of data processed, or 0 on error.
1551 static size_t rest_write_header(void *ptr, size_t size, size_t nmemb,
1554 rlm_rest_write_t *ctx = userdata;
1555 REQUEST *request = ctx->request; /* Used by RDEBUG */
1557 const char *p = ptr, *q;
1560 const size_t t = (size * nmemb);
1564 http_body_type_t type;
1565 http_body_type_t supp;
1569 case WRITE_STATE_INIT:
1570 RDEBUG("Processing header");
1573 * HTTP/<version> <reason_code>[ <reason_phrase>]\r\n
1575 * "HTTP/1.1 " (8) + "100 " (4) + "\r\n" (2) = 14
1577 if (s < 14) goto malformed;
1580 * Check start of header matches...
1582 if (strncasecmp("HTTP/", p, 5) != 0) goto malformed;
1588 * Skip the version field, next space should mark start
1591 q = memchr(p, ' ', s);
1592 if (q == NULL) goto malformed;
1598 * Process reason_code.
1600 * " 100" (4) + "\r\n" (2) = 6
1602 if (s < 6) goto malformed;
1606 /* Char after reason code must be a space, or \r */
1607 if (!((p[3] == ' ') || (p[3] == '\r'))) goto malformed;
1609 ctx->code = atoi(p);
1612 * Process reason_phrase (if present).
1618 q = memchr(p, '\r', s);
1619 if (q == NULL) goto malformed;
1623 tmp = rad_malloc(len + 1);
1624 strlcpy(tmp, p, len + 1);
1626 RDEBUG("\tStatus : %i (%s)", ctx->code, tmp);
1630 RDEBUG("\tStatus : %i", ctx->code);
1633 ctx->state = WRITE_STATE_PARSE_HEADERS;
1637 case WRITE_STATE_PARSE_HEADERS:
1639 (strncasecmp("Content-Type: ", p, 14) == 0)) {
1644 * Check to see if there's a parameter
1647 q = memchr(p, ';', s);
1650 * If there's not, find the end of this
1653 if (q == NULL) q = memchr(p, '\r', s);
1655 len = (q == NULL) ? s : (unsigned)(q - p);
1657 type = fr_substr2int(http_content_type_table,
1658 p, HTTP_BODY_UNKNOWN,
1661 supp = http_body_type_supported[type];
1663 tmp = rad_malloc(len + 1);
1664 strlcpy(tmp, p, len + 1);
1666 RDEBUG("\tType : %s (%s)",
1667 fr_int2str(http_body_type_table, type,
1668 "¿Unknown?"), tmp);
1672 if (type == HTTP_BODY_UNKNOWN) {
1673 RDEBUG("Couldn't determine type, using"
1674 " request type \"%s\".",
1675 fr_int2str(http_body_type_table,
1679 } else if (supp == HTTP_BODY_UNSUPPORTED) {
1680 RDEBUG("Type \"%s\" is currently"
1682 fr_int2str(http_body_type_table,
1683 type, "¿Unknown?"));
1684 ctx->type = HTTP_BODY_UNSUPPORTED;
1685 } else if (supp == HTTP_BODY_UNAVAILABLE) {
1686 RDEBUG("Type \"%s\" is currently"
1687 " unavailable, please rebuild"
1688 " this module with the required"
1690 fr_int2str(http_body_type_table,
1691 type, "¿Unknown?"));
1692 ctx->type = HTTP_BODY_UNSUPPORTED;
1694 } else if (supp == HTTP_BODY_INVALID) {
1695 RDEBUG("Type \"%s\" is not a valid web"
1696 " API data markup format",
1697 fr_int2str(http_body_type_table,
1698 type, "¿Unknown?"));
1700 ctx->type = HTTP_BODY_INVALID;
1702 } else if (type != ctx->type) {
1715 RDEBUG("Incoming header was malformed");
1721 /** Processes incoming HTTP body data from libcurl.
1723 * Writes incoming body data to an intermediary buffer for later parsing by
1724 * one of the decode functions.
1726 * @param[in] ptr Char buffer where inbound header data is written
1727 * @param[in] size Multiply by nmemb to get the length of ptr.
1728 * @param[in] nmemb Multiply by size to get the length of ptr.
1729 * @param[in] userdata rlm_rest_write_t to keep parsing state between calls.
1730 * @return length of data processed, or 0 on error.
1732 static size_t rest_write_body(void *ptr, size_t size, size_t nmemb,
1735 rlm_rest_write_t *ctx = userdata;
1736 REQUEST *request = ctx->request; /* Used by RDEBUG */
1738 const char *p = ptr;
1741 const size_t t = (size * nmemb);
1744 * Any post processing of headers should go here...
1746 if (ctx->state == WRITE_STATE_PARSE_HEADERS) {
1747 ctx->state = WRITE_STATE_PARSE_CONTENT;
1752 case HTTP_BODY_UNSUPPORTED:
1755 case HTTP_BODY_INVALID:
1756 tmp = rad_malloc(t + 1);
1757 strlcpy(tmp, p, t + 1);
1766 if (t > (ctx->alloc - ctx->used)) {
1767 ctx->alloc += ((t + 1) > REST_BODY_INCR) ?
1768 t + 1 : REST_BODY_INCR;
1772 ctx->buffer = rad_malloc(ctx->alloc);
1774 /* If data has been written previously */
1776 strlcpy(ctx->buffer, tmp,
1781 strlcpy(ctx->buffer + ctx->used, p, t + 1);
1790 /** (Re-)Initialises the data in a rlm_rest_write_t.
1792 * This resets the values of the a rlm_rest_write_t to their defaults.
1793 * Must be called between encoding sessions.
1795 * @see rest_write_body
1796 * @see rest_write_header
1798 * @param[in] request Current request.
1799 * @param[in] ctx data to initialise.
1800 * @param[in] type Default http_body_type to use when decoding raw data, may be
1801 * overwritten by rest_write_header.
1803 static void rest_write_ctx_init(REQUEST *request, rlm_rest_write_t *ctx,
1804 http_body_type_t type)
1806 ctx->request = request;
1808 ctx->state = WRITE_STATE_INIT;
1814 /** Frees the intermediary buffer created by rest_write.
1816 * @param[in] ctx data to be freed.
1818 static void rest_write_free(rlm_rest_write_t *ctx)
1820 if (ctx->buffer != NULL) {
1825 /** Configures body specific curlopts.
1827 * Configures libcurl handle to use either chunked mode, where the request
1828 * data will be sent using multiple HTTP requests, or contiguous mode where
1829 * the request data will be sent in a single HTTP request.
1831 * @param[in] instance configuration data.
1832 * @param[in] section configuration data.
1833 * @param[in] handle rlm_rest_handle_t to configure.
1834 * @param[in] func to pass to libcurl for chunked.
1835 * transfers (NULL if not using chunked mode).
1836 * @return TRUE on success FALSE on error.
1838 static int rest_request_config_body(rlm_rest_t *instance,
1839 rlm_rest_section_t *section,
1840 rlm_rest_handle_t *handle,
1843 rlm_rest_curl_context_t *ctx = handle->ctx;
1844 CURL *candle = handle->handle;
1849 if (section->chunk > 0) {
1850 ret = curl_easy_setopt(candle, CURLOPT_READDATA,
1852 if (ret != CURLE_OK) goto error;
1854 ret = curl_easy_setopt(candle, CURLOPT_READFUNCTION,
1856 if (ret != CURLE_OK) goto error;
1858 len = rest_read_wrapper(&ctx->body, func,
1859 REST_BODY_MAX_LEN , &ctx->read);
1861 radlog(L_ERR, "rlm_rest (%s): Failed creating HTTP"
1862 " body content", instance->xlat_name);
1866 ret = curl_easy_setopt(candle, CURLOPT_POSTFIELDS,
1868 if (ret != CURLE_OK) goto error;
1870 ret = curl_easy_setopt(candle, CURLOPT_POSTFIELDSIZE,
1872 if (ret != CURLE_OK) goto error;
1878 radlog(L_ERR, "rlm_rest (%s): Failed setting curl option: %i - %s",
1879 instance->xlat_name, ret, curl_easy_strerror(ret));
1884 /** Configures request curlopts.
1886 * Configures libcurl handle setting various curlopts for things like local
1887 * client time, Content-Type, and other FreeRADIUS custom headers.
1889 * Current FreeRADIUS custom headers are:
1890 * - X-FreeRADIUS-Section The module section being processed.
1891 * - X-FreeRADIUS-Server The current virtual server the REQUEST is
1894 * Sets up callbacks for all response processing (buffers and body data).
1896 * @param[in] instance configuration data.
1897 * @param[in] section configuration data.
1898 * @param[in] handle to configure.
1899 * @param[in] request Current request.
1900 * @param[in] method to use (HTTP verbs PUT, POST, DELETE etc...).
1901 * @param[in] type Content-Type for request encoding, also sets the default
1903 * @param[in] uri buffer containing the expanded URI to send the request to.
1904 * @return TRUE on success (all opts configured) FALSE on error.
1906 int rest_request_config(rlm_rest_t *instance, rlm_rest_section_t *section,
1907 REQUEST *request, void *handle, http_method_t method,
1908 http_body_type_t type, char *uri)
1910 rlm_rest_handle_t *randle = handle;
1911 rlm_rest_curl_context_t *ctx = randle->ctx;
1912 CURL *candle = randle->handle;
1914 http_auth_type_t auth = section->auth;
1921 buffer[(sizeof(buffer) - 1)] = '\0';
1924 * Setup any header options and generic headers.
1926 ret = curl_easy_setopt(candle, CURLOPT_URL, uri);
1927 if (ret != CURLE_OK) goto error;
1929 ret = curl_easy_setopt(candle, CURLOPT_USERAGENT, "FreeRADIUS");
1930 if (ret != CURLE_OK) goto error;
1932 snprintf(buffer, (sizeof(buffer) - 1), "Content-Type: %s",
1933 fr_int2str(http_content_type_table, type, "¿Unknown?"));
1934 ctx->headers = curl_slist_append(ctx->headers, buffer);
1935 if (!ctx->headers) goto error_header;
1937 if (section->timeout) {
1938 ret = curl_easy_setopt(candle, CURLOPT_TIMEOUT,
1940 if (ret != CURLE_OK) goto error;
1943 ret = curl_easy_setopt(candle, CURLOPT_PROTOCOLS,
1944 (CURLPROTO_HTTP | CURLPROTO_HTTPS));
1945 if (ret != CURLE_OK) goto error;
1948 * FreeRADIUS custom headers
1950 snprintf(buffer, (sizeof(buffer) - 1), "X-FreeRADIUS-Section: %s",
1952 ctx->headers = curl_slist_append(ctx->headers, buffer);
1953 if (!ctx->headers) goto error_header;
1955 snprintf(buffer, (sizeof(buffer) - 1), "X-FreeRADIUS-Server: %s",
1957 ctx->headers = curl_slist_append(ctx->headers, buffer);
1958 if (!ctx->headers) goto error_header;
1961 * Configure HTTP verb (GET, POST, PUT, DELETE, other...)
1965 case HTTP_METHOD_GET :
1966 ret = curl_easy_setopt(candle, CURLOPT_HTTPGET,
1968 if (ret != CURLE_OK) goto error;
1972 case HTTP_METHOD_POST :
1973 ret = curl_easy_setopt(candle, CURLOPT_POST,
1975 if (ret != CURLE_OK) goto error;
1979 case HTTP_METHOD_PUT :
1980 ret = curl_easy_setopt(candle, CURLOPT_PUT,
1982 if (ret != CURLE_OK) goto error;
1986 case HTTP_METHOD_DELETE :
1987 ret = curl_easy_setopt(candle, CURLOPT_HTTPGET,
1989 if (ret != CURLE_OK) goto error;
1991 ret = curl_easy_setopt(candle,
1992 CURLOPT_CUSTOMREQUEST, "DELETE");
1993 if (ret != CURLE_OK) goto error;
1997 case HTTP_METHOD_CUSTOM :
1998 ret = curl_easy_setopt(candle, CURLOPT_HTTPGET,
2000 if (ret != CURLE_OK) goto error;
2002 ret = curl_easy_setopt(candle,
2003 CURLOPT_CUSTOMREQUEST,
2005 if (ret != CURLE_OK) goto error;
2013 * Set user based authentication parameters
2016 if ((auth >= HTTP_AUTH_BASIC) &&
2017 (auth <= HTTP_AUTH_ANY_SAFE)) {
2018 ret = curl_easy_setopt(candle, CURLOPT_HTTPAUTH,
2019 http_curl_auth[auth]);
2020 if (ret != CURLE_OK) goto error;
2022 if (section->username) {
2023 radius_xlat(buffer, sizeof(buffer),
2024 section->username, request, NULL, NULL);
2026 ret = curl_easy_setopt(candle, CURLOPT_USERNAME,
2028 if (ret != CURLE_OK) goto error;
2030 if (section->password) {
2031 radius_xlat(buffer, sizeof(buffer),
2032 section->password, request, NULL, NULL);
2034 ret = curl_easy_setopt(candle, CURLOPT_PASSWORD,
2036 if (ret != CURLE_OK) goto error;
2039 #ifdef CURLOPT_TLSAUTH_USERNAME
2040 } else if (type == HTTP_AUTH_TLS_SRP) {
2041 ret = curl_easy_setopt(candle, CURLOPT_TLSAUTH_TYPE,
2042 http_curl_auth[auth]);
2044 if (section->username) {
2045 radius_xlat(buffer, sizeof(buffer),
2046 section->username, request, NULL, NULL);
2048 ret = curl_easy_setopt(candle,
2049 CURLOPT_TLSAUTH_USERNAME,
2051 if (ret != CURLE_OK) goto error;
2053 if (section->password) {
2054 radius_xlat(buffer, sizeof(buffer),
2055 section->password, request, NULL, NULL);
2057 ret = curl_easy_setopt(candle,
2058 CURLOPT_TLSAUTH_PASSWORD,
2060 if (ret != CURLE_OK) goto error;
2067 * Set SSL/TLS authentication parameters
2069 if (section->tls_certfile) {
2070 ret = curl_easy_setopt(candle,
2072 section->tls_certfile);
2073 if (ret != CURLE_OK) goto error;
2076 if (section->tls_keyfile) {
2077 ret = curl_easy_setopt(candle,
2079 section->tls_keyfile);
2080 if (ret != CURLE_OK) goto error;
2083 if (section->tls_keypassword) {
2084 ret = curl_easy_setopt(candle,
2086 section->tls_keypassword);
2087 if (ret != CURLE_OK) goto error;
2090 if (section->tls_cacertfile) {
2091 ret = curl_easy_setopt(candle,
2093 section->tls_cacertfile);
2094 if (ret != CURLE_OK) goto error;
2097 if (section->tls_cacertdir) {
2098 ret = curl_easy_setopt(candle,
2100 section->tls_cacertdir);
2101 if (ret != CURLE_OK) goto error;
2104 if (section->tls_randfile) {
2105 ret = curl_easy_setopt(candle,
2106 CURLOPT_RANDOM_FILE,
2107 section->tls_randfile);
2108 if (ret != CURLE_OK) goto error;
2111 if (section->tls_verify_cert) {
2112 ret = curl_easy_setopt(candle,
2113 CURLOPT_SSL_VERIFYHOST,
2114 (section->tls_verify_cert_cn == TRUE) ?
2116 if (ret != CURLE_OK) goto error;
2118 ret = curl_easy_setopt(candle,
2119 CURLOPT_SSL_VERIFYPEER,
2121 if (ret != CURLE_OK) goto error;
2125 * Tell CURL how to get HTTP body content, and how to process
2128 rest_write_ctx_init(request, &ctx->write, type);
2130 ret = curl_easy_setopt(candle, CURLOPT_HEADERFUNCTION,
2132 if (ret != CURLE_OK) goto error;
2134 ret = curl_easy_setopt(candle, CURLOPT_HEADERDATA,
2136 if (ret != CURLE_OK) goto error;
2138 ret = curl_easy_setopt(candle, CURLOPT_WRITEFUNCTION,
2140 if (ret != CURLE_OK) goto error;
2142 ret = curl_easy_setopt(candle, CURLOPT_WRITEDATA,
2144 if (ret != CURLE_OK) goto error;
2148 case HTTP_METHOD_GET :
2149 case HTTP_METHOD_DELETE :
2153 case HTTP_METHOD_POST :
2154 case HTTP_METHOD_PUT :
2155 case HTTP_METHOD_CUSTOM :
2156 if (section->chunk > 0) {
2157 ctx->read.chunk = section->chunk;
2159 ctx->headers = curl_slist_append(ctx->headers,
2161 if (!ctx->headers) goto error_header;
2163 ctx->headers = curl_slist_append(ctx->headers,
2164 "Transfer-Encoding: chunked");
2165 if (!ctx->headers) goto error_header;
2171 case HTTP_BODY_JSON:
2172 rest_read_ctx_init(request,
2175 ret = rest_request_config_body(instance,
2179 if (!ret) return -1;
2184 case HTTP_BODY_POST:
2185 rest_read_ctx_init(request,
2188 ret = rest_request_config_body(instance,
2192 if (!ret) return -1;
2200 ret = curl_easy_setopt(candle, CURLOPT_HTTPHEADER,
2202 if (ret != CURLE_OK) goto error;
2213 radlog(L_ERR, "rlm_rest (%s): Failed setting curl option: %i - %s",
2214 instance->xlat_name, ret, curl_easy_strerror(ret));
2218 radlog(L_ERR, "rlm_rest (%s): Failed creating header",
2219 instance->xlat_name);
2223 /** Sends a REST (HTTP) request.
2225 * Send the actual REST request to the server. The response will be handled by
2226 * the numerous callbacks configured in rest_request_config.
2228 * @param[in] instance configuration data.
2229 * @param[in] section configuration data.
2230 * @param[in] handle to use.
2231 * @return TRUE on success or FALSE on error.
2233 int rest_request_perform(rlm_rest_t *instance,
2234 UNUSED rlm_rest_section_t *section, void *handle)
2236 rlm_rest_handle_t *randle = handle;
2237 CURL *candle = randle->handle;
2240 ret = curl_easy_perform(candle);
2241 if (ret != CURLE_OK) {
2242 radlog(L_ERR, "rlm_rest (%s): Request failed: %i - %s",
2243 instance->xlat_name, ret, curl_easy_strerror(ret));
2250 /** Sends the response to the correct decode function.
2252 * Uses the Content-Type information written in rest_write_header to
2253 * determine the correct decode function to use. The decode function will
2254 * then convert the raw received data into VALUE_PAIRs.
2256 * @param[in] instance configuration data.
2257 * @param[in] section configuration data.
2258 * @param[in] request Current request.
2259 * @param[in] handle to use.
2260 * @return TRUE on success or FALSE on error.
2262 int rest_request_decode(rlm_rest_t *instance,
2263 UNUSED rlm_rest_section_t *section,
2264 REQUEST *request, void *handle)
2266 rlm_rest_handle_t *randle = handle;
2267 rlm_rest_curl_context_t *ctx = randle->ctx;
2271 if (ctx->write.buffer == NULL) {
2272 RDEBUG("Skipping attribute processing, no body data received");
2276 RDEBUG("Processing body", ret);
2278 switch (ctx->write.type)
2280 case HTTP_BODY_POST:
2281 ret = rest_decode_post(instance, section, request,
2282 handle, ctx->write.buffer,
2286 case HTTP_BODY_JSON:
2287 ret = rest_decode_json(instance, section, request,
2288 handle, ctx->write.buffer,
2292 case HTTP_BODY_UNSUPPORTED:
2293 case HTTP_BODY_UNAVAILABLE:
2294 case HTTP_BODY_INVALID:
2304 /** Cleans up after a REST request.
2306 * Resets all options associated with a CURL handle, and frees any headers
2307 * associated with it.
2309 * Calls rest_read_ctx_free and rest_write_free to free any memory used by
2312 * @param[in] instance configuration data.
2313 * @param[in] section configuration data.
2314 * @param[in] handle to cleanup.
2315 * @return TRUE on success or FALSE on error.
2317 void rest_request_cleanup(UNUSED rlm_rest_t *instance,
2318 UNUSED rlm_rest_section_t *section, void *handle)
2320 rlm_rest_handle_t *randle = handle;
2321 rlm_rest_curl_context_t *ctx = randle->ctx;
2322 CURL *candle = randle->handle;
2325 * Clear any previously configured options
2327 curl_easy_reset(candle);
2332 if (ctx->headers != NULL) {
2333 curl_slist_free_all(ctx->headers);
2334 ctx->headers = NULL;
2338 * Free body data (only used if chunking is disabled)
2340 if (ctx->body != NULL) free(ctx->body);
2343 * Free other context info
2345 rest_read_ctx_free(&ctx->read);
2346 rest_write_free(&ctx->write);
2349 /** URL encodes a string.
2351 * Encode special chars as per RFC 3986 section 4.
2353 * @param[in] request Current request.
2354 * @param[out] out Where to write escaped string.
2355 * @param[in] outlen Size of out buffer.
2356 * @param[in] raw string to be urlencoded.
2357 * @param[in] arg pointer, gives context for escaping.
2358 * @return length of data written to out (excluding NULL).
2360 static size_t rest_uri_escape(UNUSED REQUEST *request, char *out, size_t outlen,
2361 const char *raw, UNUSED void *arg)
2365 escaped = curl_escape(raw, strlen(raw));
2366 strlcpy(out, escaped, outlen);
2372 /** Builds URI; performs XLAT expansions and encoding.
2374 * Splits the URI into "http://example.org" and "/%{xlat}/query/?bar=foo"
2375 * Both components are expanded, but values expanded for the second component
2376 * are also url encoded.
2378 * @param[in] instance configuration data.
2379 * @param[in] section configuration data.
2380 * @param[in] request Current request
2381 * @param[out] buffer to write expanded URI to.
2382 * @param[in] bufsize Size of buffer.
2383 * @return length of data written to buffer (excluding NULL) or < 0 if an error
2386 ssize_t rest_uri_build(rlm_rest_t *instance, rlm_rest_section_t *section,
2387 REQUEST *request, char *buffer, size_t bufsize)
2394 unsigned short count = 0;
2401 * All URLs must contain at least <scheme>://<server>/
2403 while ((q = strchr(p, '/'))) {
2412 radlog(L_ERR, "rlm_rest (%s): Error URI is malformed,"
2413 " can't find start of path", instance->xlat_name);
2419 scheme = rad_malloc(len + 1);
2420 strlcpy(scheme, section->uri, len + 1);
2425 out += radius_xlat(out, bufsize, scheme, request, NULL, NULL);
2429 out += radius_xlat(out, (bufsize - (buffer - out)), path, request,
2430 rest_uri_escape, NULL);
2432 return (buffer - out);