Ulfius
HTTP Framework for REST Applications in C
ulfius.h
Go to the documentation of this file.
1 
27 #ifndef __ULFIUS_H__
28 #define __ULFIUS_H__
29 
30 #ifdef __cplusplus
31 extern "C"
32 {
33 #endif
34 
35 #include "ulfius-cfg.h"
36 
39 #ifndef U_DISABLE_GNUTLS
40  #ifndef _GNU_SOURCE
41  #define _GNU_SOURCE
42  #endif
43  #include <gnutls/gnutls.h>
44  #include <gnutls/x509.h>
45 #endif
46 
47 #ifndef U_DISABLE_WEBSOCKET
48  #include <poll.h>
49  #ifndef POLLRDHUP
50  #define POLLRDHUP 0x2000
51  #endif
52 #endif
53 
54 #include <pthread.h>
55 #include <microhttpd.h>
56 
57 #if defined(_WIN32) && !defined(U_DISABLE_WEBSOCKET)
58  #define U_DISABLE_WEBSOCKET
59 #endif
60 
61 #if (MHD_VERSION < 0x00095300) && !defined(U_DISABLE_WEBSOCKET)
62  #define U_DISABLE_WEBSOCKET
63 #endif
64 
66 #include <orcania.h>
67 
69 #ifndef U_DISABLE_YDER
70  #include <yder.h>
71 #else
72 
73 #define Y_LOG_MODE_NONE 0
74 #define Y_LOG_MODE_CONSOLE 0
75 #define Y_LOG_MODE_SYSLOG 0
76 #define Y_LOG_MODE_FILE 0
77 #define Y_LOG_MODE_JOURNALD 0
78 #define Y_LOG_MODE_CALLBACK 0
79 #define Y_LOG_MODE_CURRENT 0
80 
81 #define Y_LOG_LEVEL_NONE 0
82 #define Y_LOG_LEVEL_DEBUG 0
83 #define Y_LOG_LEVEL_INFO 0
84 #define Y_LOG_LEVEL_WARNING 0
85 #define Y_LOG_LEVEL_ERROR 0
86 #define Y_LOG_LEVEL_CURRENT 0
87 
88 int y_init_logs(const char * app, const unsigned long init_mode, const unsigned long init_level, const char * init_log_file, const char * message);
89 int y_set_logs_callback(void (* y_callback_log_message) (void * cls, const char * app_name, const time_t date, const unsigned long level, const char * message), void * cls, const char * message);
90 void y_log_message(const unsigned long type, const char * message, ...);
91 int y_close_logs();
92 #endif
93 
94 #ifndef U_DISABLE_JANSSON
95 #include <jansson.h>
96 #endif
97 
103 #define ULFIUS_STREAM_BLOCK_SIZE_DEFAULT 1024
104 #define U_STREAM_END MHD_CONTENT_READER_END_OF_STREAM
105 #define U_STREAM_ERROR MHD_CONTENT_READER_END_WITH_ERROR
106 #define U_STREAM_SIZE_UNKNOWN MHD_SIZE_UNKNOWN
107 #define U_STREAM_SIZE_UNKOWN U_STREAM_SIZE_UNKNOWN // Backward compatibility
108 
109 #define U_OK 0
110 #define U_ERROR 1
111 #define U_ERROR_MEMORY 2
112 #define U_ERROR_PARAMS 3
113 #define U_ERROR_LIBMHD 4
114 #define U_ERROR_LIBCURL 5
115 #define U_ERROR_NOT_FOUND 6
116 #define U_ERROR_DISCONNECTED 7
117 
118 #define U_CALLBACK_CONTINUE 0
119 #define U_CALLBACK_COMPLETE 1
120 #define U_CALLBACK_UNAUTHORIZED 2
121 #define U_CALLBACK_ERROR 3
122 
123 #define U_COOKIE_SAME_SITE_NONE 0
124 #define U_COOKIE_SAME_SITE_STRICT 1
125 #define U_COOKIE_SAME_SITE_LAX 2
126 
127 #define U_USE_IPV4 0x0001
128 #define U_USE_IPV6 0x0010
129 #define U_USE_ALL (U_USE_IPV4|U_USE_IPV6)
130 
131 #define U_SSL_VERIFY_PEER 0x0001
132 #define U_SSL_VERIFY_HOSTNAME 0x0010
133 
134 
138 typedef enum {
143 #if MHD_VERSION >= 0x00095208
144  U_OPT_NETWORK_TYPE = 4,
145 #endif
165 #ifndef U_DISABLE_JANSSON
167 #endif
168 #ifndef U_DISABLE_GNUTLS
172 #endif
175  U_OPT_SHARED_DATA = 30
177 
182 /*************
183  * Structures
184  *************/
185 
195 struct _u_map {
196  int nb_values; /* !< Values count */
197  char ** keys; /* !< Array of keys */
198  char ** values; /* !< Array of values */
199  size_t * lengths; /* !< Lengths of each values */
200 };
201 
206 struct _u_cookie {
207  char * key; /* !< key if the cookie */
208  char * value; /* !< value of the cookie */
209  char * expires; /* !< expiration date of the cookie */
210  unsigned int max_age; /* !< duration of the cookie in seconds */
211  char * domain; /* !< domain for the cookie */
212  char * path; /* !< url path for the cookie */
213  int secure; /* !< flag to set cookie secure or not */
214  int http_only; /* !< flag to set cookie for HTTP connections only or not */
215  int same_site; /* !< flag to set same_site option to the cookie */
216 };
217 
224 struct _u_request {
225  char * http_protocol; /* !< http protocol used (1.0 or 1.1) */
226  char * http_verb; /* !< http method (GET, POST, PUT, DELETE, etc.) */
227  char * http_url; /* !< full url used to call this callback function or full url to call when used in a ulfius_send_http_request */
228  char * url_path; /* !< url path only used to call this callback function (ex, if http_url is /path/?param=1, url_path is /path/) */
229  char * proxy; /* !<proxy address to use for outgoing connections, used by ulfius_send_http_request */
230 #if MHD_VERSION >= 0x00095208
231  unsigned short network_type; /* !< Force connect to ipv4, ipv6 addresses or both, values available are U_USE_ALL, U_USE_IPV4 or U_USE_IPV6 */
232 #endif
233  int check_server_certificate; /* !< check server certificate and hostname, default true, used by ulfius_send_http_request */
234  int check_server_certificate_flag; /* !< check certificate peer and or server hostname if check_server_certificate is enabled, values available are U_SSL_VERIFY_PEER, U_SSL_VERIFY_HOSTNAME or both, default value is both (U_SSL_VERIFY_PEER|U_SSL_VERIFY_HOSTNAME), used by ulfius_send_http_request */
235  int check_proxy_certificate; /* !< check proxy certificate and hostname, default true, used by ulfius_send_http_request, requires libcurl >= 7.52 */
236  int check_proxy_certificate_flag; /* !< check certificate peer and or proxy hostname if check_proxy_certificate is enabled, values available are U_SSL_VERIFY_PEER, U_SSL_VERIFY_HOSTNAME or both, default value is both (U_SSL_VERIFY_PEER|U_SSL_VERIFY_HOSTNAME), used by ulfius_send_http_request, requires libcurl >= 7.52 */
237  int follow_redirect; /* !< follow url redirections, used by ulfius_send_http_request */
238  char * ca_path; /* !< specify a path to CA certificates instead of system path, used by ulfius_send_http_request */
239  unsigned long timeout; /* !< connection timeout used by ulfius_send_http_request, default is 0 */
240  struct sockaddr * client_address; /* !< IP address of the client */
241  char * auth_basic_user; /* !< basic authentication username */
242  char * auth_basic_password; /* !< basic authentication password */
243  struct _u_map * map_url; /* !< map containing the url variables, both from the route and the ?key=value variables */
244  struct _u_map * map_header; /* !< map containing the header variables */
245  struct _u_map * map_cookie; /* !< map containing the cookie variables */
246  struct _u_map * map_post_body; /* !< map containing the post body variables (if available) */
247  void * binary_body; /* !< raw body */
248  size_t binary_body_length; /* !< length of raw body */
249  unsigned int callback_position; /* !< position of the current callback function in the callback list, starts at 0 */
250 #ifndef U_DISABLE_GNUTLS
251  gnutls_x509_crt_t client_cert; /* !< x509 certificate of the client if the instance uses client certificate authentication and the client is authenticated, available only if GnuTLS support is enabled */
252  char * client_cert_file; /* !< path to client certificate file for sending http requests with certificate authentication, available only if GnuTLS support is enabled */
253  char * client_key_file; /* !< path to client key file for sending http requests with certificate authentication, available only if GnuTLS support is enabled */
254  char * client_key_password; /* !< password to unlock client key file, available only if GnuTLS support is enabled */
255 #endif
256 };
257 
264 struct _u_response {
265  long status; /* !< HTTP status code (200, 404, 500, etc) */
266  char * protocol; /* !< HTTP Protocol sent */
267  struct _u_map * map_header; /* !< map containing the header variables */
268  unsigned int nb_cookies; /* !< number of cookies sent */
269  struct _u_cookie * map_cookie; /* !< array of cookies sent */
270  char * auth_realm; /* !< realm to send to the client on authenticationb failed */
271  void * binary_body; /* !< raw binary content */
272  size_t binary_body_length; /* !< length of the binary_body */
273  ssize_t (* stream_callback) (void * stream_user_data, uint64_t offset, char * out_buf, size_t max); /* !< callback function to stream data in response body */
274  void (* stream_callback_free) (void * stream_user_data); /* !< callback function to free data allocated for streaming */
275  uint64_t stream_size; /* !< size of the streamed data (U_STREAM_SIZE_UNKNOWN if unknown) */
276  size_t stream_block_size; /* !< size of each block to be streamed, set according to your system */
277  void * stream_user_data; /* !< user defined data that will be available in your callback stream functions */
278  void * websocket_handle; /* !< handle for websocket extension */
279  void * shared_data; /* !< any data shared between callback functions, must be allocated and freed by the callback functions */
280  unsigned int timeout; /* !< Timeout in seconds to close the connection because of inactivity between the client and the server */
281 };
282 
289 struct _u_endpoint {
290  char * http_method; /* !< http verb (GET, POST, PUT, etc.) in upper case */
291  char * url_prefix; /* !< prefix for the url (optional) */
292  char * url_format; /* !< string used to define the endpoint format, separate words with / to define a variable in the url, prefix it with @ or :, example: /test/resource/:name/elements, on an url_format that ends with '*', the rest of the url will not be tested */
293  unsigned int priority; /* !< endpoint priority in descending order (0 is the higher priority) */
294  int (* callback_function)(const struct _u_request * request, /* !< pointer to a function that will be executed each time the endpoint is called, you must declare the function as described. */
295  struct _u_response * response,
296  void * user_data);
297  void * user_data; /* !< pointer to a data or a structure that will be available in callback_function */
298 };
299 
306 struct _u_instance {
307  struct MHD_Daemon * mhd_daemon; /* !< pointer to the libmicrohttpd daemon */
308  int status; /* !< status of the current instance, status are U_STATUS_STOP, U_STATUS_RUNNING or U_STATUS_ERROR */
309  unsigned int port; /* !< port number to listen to */
310 #if MHD_VERSION >= 0x00095208
311  unsigned short network_type; /* !< Listen to ipv4 and or ipv6 connections, values available are U_USE_ALL, U_USE_IPV4 or U_USE_IPV6 */
312 #endif
313  struct sockaddr_in * bind_address; /* !< ipv4 address to listen to (optional) */
314  struct sockaddr_in6 * bind_address6; /* !< ipv6 address to listen to (optional) */
315  unsigned int timeout; /* !< Timeout to close the connection because of inactivity between the client and the server */
316  int nb_endpoints; /* !< Number of available endpoints */
317  char * default_auth_realm; /* !< Default realm on authentication error */
318  struct _u_endpoint * endpoint_list; /* !< List of available endpoints */
319  struct _u_endpoint * default_endpoint; /* !< Default endpoint if no other endpoint match the current url */
320  struct _u_map * default_headers; /* !< Default headers that will be added to all response->map_header */
321  size_t max_post_param_size; /* !< maximum size for a post parameter, 0 means no limit, default 0 */
322  size_t max_post_body_size; /* !< maximum size for the entire post body, 0 means no limit, default 0 */
323  void * websocket_handler; /* !< handler for the websocket structure */
324  int (* file_upload_callback) (const struct _u_request * request, /* !< callback function to manage file upload by blocks */
325  const char * key,
326  const char * filename,
327  const char * content_type,
328  const char * transfer_encoding,
329  const char * data,
330  uint64_t off,
331  size_t size,
332  void * cls);
333  void * file_upload_cls; /* !< any pointer to pass to the file_upload_callback function */
334  int mhd_response_copy_data; /* !< to choose between MHD_RESPMEM_MUST_COPY and MHD_RESPMEM_MUST_FREE, only if you use MHD < 0.9.61, otherwise this option is skipped because it's useless */
335  int check_utf8; /* !< check that all parameters values in the request (url, header and post_body), are valid utf8 strings, if a parameter value has non utf8 character, the value, will be ignored, default 1 */
336 #ifndef U_DISABLE_GNUTLS
337  int use_client_cert_auth; /* !< Internal variable use to indicate if the instance uses client certificate authentication, Do not change this value, available only if websocket support is enabled */
338 #endif
339 };
340 
350  struct MHD_PostProcessor * post_processor;
353  struct _u_request * request;
355  struct _u_map map_url_initial;
356 };
357 
358 /**********************************
359  * Instance functions declarations
360  **********************************/
361 
372 void u_free(void * data);
373 
381 int ulfius_global_init();
382 
386 void ulfius_global_close();
387 
408 int ulfius_init_instance(struct _u_instance * u_instance, unsigned int port, struct sockaddr_in * bind_address, const char * default_auth_realm);
409 
410 #if MHD_VERSION >= 0x00095208
411 
422 int ulfius_init_instance_ipv6(struct _u_instance * u_instance, unsigned int port, struct sockaddr_in6 * bind_address, unsigned short network_type, const char * default_auth_realm);
423 #endif
424 
431 void ulfius_clean_instance(struct _u_instance * u_instance);
432 
440 int ulfius_start_framework(struct _u_instance * u_instance);
441 
451 int ulfius_start_secure_framework(struct _u_instance * u_instance, const char * key_pem, const char * cert_pem);
452 
453 #ifndef U_DISABLE_GNUTLS
454 
465 int ulfius_start_secure_ca_trust_framework(struct _u_instance * u_instance, const char * key_pem, const char * cert_pem, const char * root_ca_pem);
466 #endif
467 
486 int ulfius_start_framework_with_mhd_options(struct _u_instance * u_instance, unsigned int mhd_flags, struct MHD_OptionItem * options);
487 
491 void mhd_request_completed (void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe);
492 void * ulfius_uri_logger (void * cls, const char * uri);
493 
501 int ulfius_stop_framework(struct _u_instance * u_instance);
502 
524  int (* file_upload_callback) (const struct _u_request * request,
525  const char * key,
526  const char * filename,
527  const char * content_type,
528  const char * transfer_encoding,
529  const char * data,
530  uint64_t off,
531  size_t size,
532  void * cls),
533  void * cls);
534 
545 /***********************************
546  * Endpoints functions declarations
547  ***********************************/
548 
556 int ulfius_add_endpoint(struct _u_instance * u_instance, const struct _u_endpoint * u_endpoint);
557 
575 int ulfius_add_endpoint_by_val(struct _u_instance * u_instance,
576  const char * http_method,
577  const char * url_prefix,
578  const char * url_format,
579  unsigned int priority,
580  int (* callback_function)(const struct _u_request * request, // Input parameters (set by the framework)
581  struct _u_response * response, // Output parameters (set by the user)
582  void * user_data),
583  void * user_data);
584 
592 int ulfius_add_endpoint_list(struct _u_instance * u_instance, const struct _u_endpoint ** u_endpoint_list);
593 
603 int ulfius_remove_endpoint(struct _u_instance * u_instance, const struct _u_endpoint * u_endpoint);
604 
620 int ulfius_set_default_endpoint(struct _u_instance * u_instance,
621  int (* callback_function)(const struct _u_request * request, struct _u_response * response, void * user_data),
622  void * user_data);
623 
636 int ulfius_remove_endpoint_by_val(struct _u_instance * u_instance, const char * http_method, const char * url_prefix, const char * url_format);
637 
642 const struct _u_endpoint * ulfius_empty_endpoint();
643 
651 int ulfius_copy_endpoint(struct _u_endpoint * dest, const struct _u_endpoint * source);
652 
660 struct _u_endpoint * ulfius_duplicate_endpoint_list(const struct _u_endpoint * endpoint_list);
661 
667 void ulfius_clean_endpoint(struct _u_endpoint * endpoint);
668 
674 void ulfius_clean_endpoint_list(struct _u_endpoint * endpoint_list);
675 
683 int ulfius_equals_endpoints(const struct _u_endpoint * endpoint1, const struct _u_endpoint * endpoint2);
684 
695 #ifndef U_DISABLE_CURL
696 /********************************************
697  * Requests/Responses functions declarations
698  ********************************************/
699 
707 int ulfius_send_http_request(const struct _u_request * request, struct _u_response * response);
708 
719 int ulfius_send_http_streaming_request(const struct _u_request * request, struct _u_response * response, size_t (* write_body_function)(void * contents, size_t size, size_t nmemb, void * user_data), void * write_body_data);
720 
739 int ulfius_send_smtp_email(const char * host,
740  const int port,
741  const int use_tls,
742  const int verify_certificate,
743  const char * user,
744  const char * password,
745  const char * from,
746  const char * to,
747  const char * cc,
748  const char * bcc,
749  const char * subject,
750  const char * mail_body);
751 
771 int ulfius_send_smtp_rich_email(const char * host,
772  const int port,
773  const int use_tls,
774  const int verify_certificate,
775  const char * user,
776  const char * password,
777  const char * from,
778  const char * to,
779  const char * cc,
780  const char * bcc,
781  const char * content_type,
782  const char * subject,
783  const char * mail_body);
784 #endif
785 
810 int ulfius_add_cookie_to_response(struct _u_response * response, const char * key, const char * value, const char * expires, const unsigned int max_age,
811  const char * domain, const char * path, const int secure, const int http_only);
812 
831 int ulfius_add_same_site_cookie_to_response(struct _u_response * response, const char * key, const char * value, const char * expires, const unsigned int max_age,
832  const char * domain, const char * path, const int secure, const int http_only, const int same_site);
833 
852 int ulfius_add_header_to_response(struct _u_response * response, const char * key, const char * value);
853 
861 int ulfius_set_string_body_request(struct _u_request * request, const char * string_body);
862 
871 int ulfius_set_binary_body_request(struct _u_request * request, const char * binary_body, const size_t length);
872 
879 int ulfius_set_empty_body_request(struct _u_request * request);
880 
889 int ulfius_set_string_body_response(struct _u_response * response, const unsigned int status, const char * body);
890 
900 int ulfius_set_binary_body_response(struct _u_response * response, const unsigned int status, const char * body, const size_t length);
901 
909 int ulfius_set_empty_body_response(struct _u_response * response, const unsigned int status);
910 
933 int ulfius_set_stream_response(struct _u_response * response,
934  const unsigned int status,
935  ssize_t (* stream_callback) (void * stream_user_data, uint64_t offset, char * out_buf, size_t max),
936  void (* stream_callback_free) (void * stream_user_data),
937  uint64_t stream_size,
938  size_t stream_block_size,
939  void * stream_user_data);
940 
957 int ulfius_init_request(struct _u_request * request);
958 
967 int ulfius_clean_request(struct _u_request * request);
968 
975 int ulfius_clean_request_full(struct _u_request * request);
976 
984 int ulfius_copy_request(struct _u_request * dest, const struct _u_request * source);
985 
991 int ulfius_set_request_properties(struct _u_request * request, ...);
992 
999 int ulfius_init_response(struct _u_response * response);
1000 
1009 int ulfius_clean_response(struct _u_response * response);
1010 
1017 int ulfius_clean_response_full(struct _u_response * response);
1018 
1026 int ulfius_copy_response(struct _u_response * dest, const struct _u_response * source);
1027 
1034 int ulfius_clean_cookie(struct _u_cookie * cookie);
1035 
1042 int ulfius_copy_cookie(struct _u_cookie * dest, const struct _u_cookie * source);
1043 
1050 struct _u_request * ulfius_duplicate_request(const struct _u_request * request);
1051 
1058 struct _u_response * ulfius_duplicate_response(const struct _u_response * response);
1059 
1065 int ulfius_set_response_properties(struct _u_response * response, ...);
1066 
1085 char * ulfius_url_decode(const char * str);
1086 
1095 char * ulfius_url_encode(const char * str);
1096 
1107 #ifndef U_DISABLE_JANSSON
1108 
1118 json_t * ulfius_get_json_body_request(const struct _u_request * request, json_error_t * json_error);
1119 
1127 int ulfius_set_json_body_request(struct _u_request * request, json_t * j_body);
1128 
1139 json_t * ulfius_get_json_body_response(struct _u_response * response, json_error_t * json_error);
1140 
1148 int ulfius_set_json_body_response(struct _u_response * response, const unsigned int status, const json_t * j_body);
1149 #endif
1150 
1161 /************************************************************************
1162  * _u_map declarations *
1163  * _u_map is a simple map structure that handles sets of key/value maps *
1164  ************************************************************************/
1165 
1172 int u_map_init(struct _u_map * u_map);
1173 
1179 int u_map_clean(struct _u_map * u_map);
1180 
1186 int u_map_clean_full(struct _u_map * u_map);
1187 
1193 int u_map_clean_enum(char ** array);
1194 
1200 const char ** u_map_enum_keys(const struct _u_map * u_map);
1201 
1207 const char ** u_map_enum_values(const struct _u_map * u_map);
1208 
1217 int u_map_has_key(const struct _u_map * u_map, const char * key);
1218 
1227 int u_map_has_value(const struct _u_map * u_map, const char * value);
1228 
1238 int u_map_has_value_binary(const struct _u_map * u_map, const char * value, size_t length);
1239 
1248 int u_map_has_key_case(const struct _u_map * u_map, const char * key);
1249 
1258 int u_map_has_value_case(const struct _u_map * u_map, const char * value);
1259 
1268 int u_map_put(struct _u_map * u_map, const char * key, const char * value);
1269 
1281 int u_map_put_binary(struct _u_map * u_map, const char * key, const char * value, uint64_t offset, size_t length);
1282 
1290 ssize_t u_map_get_length(const struct _u_map * u_map, const char * key);
1291 
1299 ssize_t u_map_get_case_length(const struct _u_map * u_map, const char * key);
1300 
1308 const char * u_map_get(const struct _u_map * u_map, const char * key);
1309 
1317 const char * u_map_get_case(const struct _u_map * u_map, const char * key);
1318 
1326 int u_map_remove_from_key(struct _u_map * u_map, const char * key);
1327 
1335 int u_map_remove_from_key_case(struct _u_map * u_map, const char * key);
1336 
1344 int u_map_remove_from_value(struct _u_map * u_map, const char * value);
1345 
1353 int u_map_remove_from_value_case(struct _u_map * u_map, const char * value);
1354 
1362 int u_map_remove_from_value_binary(struct _u_map * u_map, const char * key, size_t length);
1363 
1370 int u_map_remove_at(struct _u_map * u_map, const int index);
1371 
1378 struct _u_map * u_map_copy(const struct _u_map * source);
1379 
1387 int u_map_copy_into(struct _u_map * dest, const struct _u_map * source);
1388 
1395 int u_map_count(const struct _u_map * source);
1396 
1402 int u_map_empty(struct _u_map * u_map);
1403 
1414 #ifndef U_DISABLE_WEBSOCKET
1415 
1416 /**********************************
1417  * Websocket functions declarations
1418  **********************************/
1419 
1420 #define U_WEBSOCKET_USER_AGENT "Ulfius Websocket Client Framework"
1421 
1422 #define U_WEBSOCKET_MAGIC_STRING "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
1423 #define U_WEBSOCKET_UPGRADE_VALUE "websocket"
1424 #define U_WEBSOCKET_BAD_REQUEST_BODY "Error in websocket handshake, wrong parameters"
1425 #define U_WEBSOCKET_USEC_WAIT 50
1426 #define WEBSOCKET_MAX_CLOSE_TRY 10
1427 
1428 #define U_WEBSOCKET_BIT_FIN 0x80
1429 #define U_WEBSOCKET_MASK 0x80
1430 #define U_WEBSOCKET_LEN_MASK 0x7F
1431 #define U_WEBSOCKET_OPCODE_CONTINUE 0x00
1432 #define U_WEBSOCKET_OPCODE_TEXT 0x01
1433 #define U_WEBSOCKET_OPCODE_BINARY 0x02
1434 #define U_WEBSOCKET_OPCODE_CLOSE 0x08
1435 #define U_WEBSOCKET_OPCODE_PING 0x09
1436 #define U_WEBSOCKET_OPCODE_PONG 0x0A
1437 #define U_WEBSOCKET_OPCODE_CLOSED 0xFD
1438 #define U_WEBSOCKET_OPCODE_ERROR 0xFE
1439 #define U_WEBSOCKET_OPCODE_NONE 0xFF
1440 
1441 #define U_WEBSOCKET_NONE 0
1442 #define U_WEBSOCKET_SERVER 1
1443 #define U_WEBSOCKET_CLIENT 2
1444 
1445 #define U_WEBSOCKET_STATUS_OPEN 0
1446 #define U_WEBSOCKET_STATUS_CLOSE 1
1447 #define U_WEBSOCKET_STATUS_ERROR 2
1448 
1449 #define WEBSOCKET_RESPONSE_HTTP 0x0001
1450 #define WEBSOCKET_RESPONSE_UPGRADE 0x0002
1451 #define WEBSOCKET_RESPONSE_CONNECTION 0x0004
1452 #define WEBSOCKET_RESPONSE_ACCEPT 0x0008
1453 #define WEBSOCKET_RESPONSE_PROTCOL 0x0010
1454 #define WEBSOCKET_RESPONSE_EXTENSION 0x0020
1455 
1462 struct _websocket_manager {
1463  struct _websocket_message_list * message_list_incoming; /* !< list of incoming messages */
1464  struct _websocket_message_list * message_list_outcoming; /* !< list of outcoming messages */
1465  int connected; /* !< flag to know if the websocket is connected or not */
1466  int close_flag; /* !< flag to set before closing a websocket */
1467  MHD_socket mhd_sock; /* !< reference to libmicrohttpd's socket for websocket server */
1468  int tcp_sock; /* !< tcp socket for websocket client */
1469  int tls; /* !< set to 1 if the websocket is in a TLS socket */
1470  gnutls_session_t gnutls_session; /* !< GnuTLS session for websocket client */
1471  gnutls_certificate_credentials_t xcred; /* !< certificate credential used by GnuTLS */
1472  char * protocol; /* !< websocket protocol */
1473  char * extensions; /* !< websocket extension */
1474  pthread_mutex_t read_lock; /* !< mutex to read data in the socket */
1475  pthread_mutex_t write_lock; /* !< mutex to write data in the socket */
1476  pthread_mutex_t status_lock; /* !< mutex to broadcast new status */
1477  pthread_cond_t status_cond; /* !< condition to broadcast new status */
1478  struct pollfd fds;
1479  int type;
1480 };
1481 
1487 struct _websocket_message {
1488  time_t datestamp; /* !< date stamp of the message */
1489  uint8_t opcode; /* !< opcode for the message (string or binary) */
1490  uint8_t has_mask; /* !< does the message contain a mask? */
1491  uint8_t mask[4]; /* !< mask used if any */
1492  size_t data_len; /* !< length of the data */
1493  char * data; /* !< message data */
1494 };
1495 
1499 struct _websocket_message_list {
1500  struct _websocket_message ** list; /* !< messages list */
1501  size_t len; /* !< message list length */
1502 };
1503 
1508 struct _websocket {
1509  struct _u_instance * instance; /* !< reference to the ulfius instance if any */
1510  struct _u_request * request; /* !< refrence to the ulfius request of any */
1511  void (* websocket_manager_callback) (const struct _u_request * request, /* !< reference to a function called after the websocket handshake */
1512  struct _websocket_manager * websocket_manager,
1513  void * websocket_manager_user_data);
1514  void * websocket_manager_user_data; /* !< a user-defined reference that will be available in websocket_manager_callback */
1515  void (* websocket_incoming_message_callback) (const struct _u_request * request, /* !< reference to a function called each time a message arrives */
1516  struct _websocket_manager * websocket_manager,
1517  const struct _websocket_message * message,
1518  void * websocket_incoming_user_data);
1519  void * websocket_incoming_user_data; /* !< a user-defined reference that will be available in websocket_incoming_message_callback */
1520  void (* websocket_onclose_callback) (const struct _u_request * request, /* !< reference to a function called after the websocket connection ends */
1521  struct _websocket_manager * websocket_manager,
1522  void * websocket_onclose_user_data);
1523  void * websocket_onclose_user_data; /* !< a user-defined reference that will be available in websocket_onclose_callback */
1524  struct _websocket_manager * websocket_manager; /* !< refrence to the websocket manager if any */
1525  struct MHD_UpgradeResponseHandle * urh; /* !< reference used by libmicrohttpd to upgrade the connection */
1526 };
1527 
1531 struct _websocket_client_handler {
1532  struct _websocket * websocket; /* !< the websocket to use */
1533  struct _u_response * response; /* !< the response attached to the websocket */
1534 };
1535 
1536 /********************************/
1538 /********************************/
1539 
1549 int ulfius_websocket_send_message(struct _websocket_manager * websocket_manager,
1550  const uint8_t opcode,
1551  const uint64_t data_len,
1552  const char * data);
1553 
1565 int ulfius_websocket_send_fragmented_message(struct _websocket_manager * websocket_manager,
1566  const uint8_t opcode,
1567  const uint64_t data_len,
1568  const char * data,
1569  const uint64_t fragment_len);
1570 
1577 #ifndef U_DISABLE_JANSSON
1578 int ulfius_websocket_send_json_message(struct _websocket_manager * websocket_manager,
1579  json_t * message);
1580 #endif
1581 
1591 struct _websocket_message * ulfius_websocket_pop_first_message(struct _websocket_message_list * message_list);
1592 
1597 void ulfius_clear_websocket_message(struct _websocket_message * message);
1598 
1599 /********************************/
1601 /********************************/
1602 
1617 int ulfius_set_websocket_response(struct _u_response * response,
1618  const char * websocket_protocol,
1619  const char * websocket_extensions,
1620  void (* websocket_manager_callback) (const struct _u_request * request,
1621  struct _websocket_manager * websocket_manager,
1622  void * websocket_manager_user_data),
1623  void * websocket_manager_user_data,
1624  void (* websocket_incoming_message_callback) (const struct _u_request * request,
1625  struct _websocket_manager * websocket_manager,
1626  const struct _websocket_message * message,
1627  void * websocket_incoming_user_data),
1628  void * websocket_incoming_user_data,
1629  void (* websocket_onclose_callback) (const struct _u_request * request,
1630  struct _websocket_manager * websocket_manager,
1631  void * websocket_onclose_user_data),
1632  void * websocket_onclose_user_data);
1633 
1643 int ulfius_websocket_send_close_signal(struct _websocket_manager * websocket_manager);
1644 
1652 int ulfius_websocket_status(struct _websocket_manager * websocket_manager);
1653 
1662 int ulfius_websocket_wait_close(struct _websocket_manager * websocket_manager, unsigned int timeout);
1663 
1664 /********************************/
1666 /********************************/
1667 
1682  void (* websocket_manager_callback) (const struct _u_request * request,
1683  struct _websocket_manager * websocket_manager,
1684  void * websocket_manager_user_data),
1685  void * websocket_manager_user_data,
1686  void (* websocket_incoming_message_callback) (const struct _u_request * request,
1687  struct _websocket_manager * websocket_manager,
1688  const struct _websocket_message * message,
1689  void * websocket_incoming_user_data),
1690  void * websocket_incoming_user_data,
1691  void (* websocket_onclose_callback) (const struct _u_request * request,
1692  struct _websocket_manager * websocket_manager,
1693  void * websocket_onclose_user_data),
1694  void * websocket_onclose_user_data,
1695  struct _websocket_client_handler * websocket_client_handler,
1696  struct _u_response * response);
1702 int ulfius_websocket_client_connection_send_close_signal(struct _websocket_client_handler * websocket_client_handler);
1703 
1709 int ulfius_websocket_client_connection_close(struct _websocket_client_handler * websocket_client_handler);
1710 
1717 int ulfius_websocket_client_connection_status(struct _websocket_client_handler * websocket_client_handler);
1718 
1727 int ulfius_websocket_client_connection_wait_close(struct _websocket_client_handler * websocket_client_handler, unsigned int timeout);
1728 
1738 int ulfius_set_websocket_request(struct _u_request * request,
1739  const char * url,
1740  const char * websocket_protocol,
1741  const char * websocket_extensions);
1742 
1743 #endif
1744 
1746 #define ULFIUS_URL_SEPARATOR "/"
1747 #define ULFIUS_HTTP_ENCODING_JSON "application/json"
1748 #define ULFIUS_HTTP_HEADER_CONTENT "Content-Type"
1749 #define ULFIUS_HTTP_NOT_FOUND_BODY "Resource not found"
1750 #define ULFIUS_HTTP_ERROR_BODY "Server Error"
1751 
1752 #define ULFIUS_COOKIE_ATTRIBUTE_EXPIRES "Expires"
1753 #define ULFIUS_COOKIE_ATTRIBUTE_MAX_AGE "Max-Age"
1754 #define ULFIUS_COOKIE_ATTRIBUTE_DOMAIN "Domain"
1755 #define ULFIUS_COOKIE_ATTRIBUTE_PATH "Path"
1756 #define ULFIUS_COOKIE_ATTRIBUTE_SECURE "Secure"
1757 #define ULFIUS_COOKIE_ATTRIBUTE_HTTPONLY "HttpOnly"
1758 
1759 #define ULFIUS_POSTBUFFERSIZE 65536
1760 
1761 #define U_STATUS_STOP 0
1762 #define U_STATUS_RUNNING 1
1763 #define U_STATUS_ERROR 2
1764 
1765 #ifndef U_DISABLE_WEBSOCKET
1766 
1770 struct _websocket_handle {
1771  char * websocket_protocol; /* !< protocol for the websocket */
1772  char * websocket_extensions; /* !< extensions for the websocket */
1773  void (* websocket_manager_callback) (const struct _u_request * request, /* !< callback function for working with the websocket */
1774  struct _websocket_manager * websocket_manager,
1775  void * websocket_manager_user_data);
1776  void * websocket_manager_user_data; /* !< user-defined data that will be handled to websocket_manager_callback */
1777  void (* websocket_incoming_message_callback) (const struct _u_request * request, /* !< callback function that will be called every time a message arrives from the client in the websocket */
1778  struct _websocket_manager * websocket_manager,
1779  const struct _websocket_message * message,
1780  void * websocket_incoming_user_data);
1781  void * websocket_incoming_user_data; /* !< user-defined data that will be handled to websocket_incoming_message_callback */
1782  void (* websocket_onclose_callback) (const struct _u_request * request, /* !< callback function that will be called if the websocket is open while the program calls ulfius_stop_framework */
1783  struct _websocket_manager * websocket_manager,
1784  void * websocket_onclose_user_data);
1785  void * websocket_onclose_user_data; /* !< user-defined data that will be handled to websocket_onclose_callback */
1786 };
1787 
1791 struct _websocket_handler {
1792  size_t nb_websocket_active; /* !< number of active websocket */
1793  struct _websocket ** websocket_active; /* !< array of active websocket */
1794  pthread_mutex_t websocket_close_lock; /* !< mutex to broadcast close signal */
1795  pthread_cond_t websocket_close_cond; /* !< condition to broadcast close signal */
1796  int pthread_init;
1797 };
1798 
1799 #endif // U_DISABLE_WEBSOCKET
1800 
1811 #ifndef U_DISABLE_GNUTLS
1812 /*
1813  * ulfius_export_client_certificate_pem
1814  * Exports the client certificate using PEM format
1815  * @param request struct _u_request used
1816  * @return the certificate in PEM format
1817  * returned value must be u_free'd after use
1818  */
1819 char * ulfius_export_client_certificate_pem(const struct _u_request * request);
1820 
1821 /*
1822  * ulfius_import_client_certificate_pem
1823  * Imports the client certificate using PEM format
1824  * @param request struct _u_request used
1825  * @param str_cert client certificate in PEM format
1826  * @return U_OK on success
1827  */
1828 int ulfius_import_client_certificate_pem(struct _u_request * request, const char * str_cert);
1829 
1830 #endif // U_DISABLE_GNUTLS
1831 
1836 #ifdef __cplusplus
1837 }
1838 #endif
1839 
1840 #endif // __ULFIUS_H__
U_OPT_CA_PATH
@ U_OPT_CA_PATH
specify a path to CA certificates instead of system path, used by ulfius_send_http_request,...
Definition: ulfius.h:151
_u_instance::endpoint_list
struct _u_endpoint * endpoint_list
Definition: ulfius.h:318
connection_info_struct
Definition: ulfius.h:348
ulfius_stop_framework
int ulfius_stop_framework(struct _u_instance *u_instance)
Definition: ulfius.c:1116
u_map_init
int u_map_init(struct _u_map *u_map)
Definition: u_map.c:38
u_map_empty
int u_map_empty(struct _u_map *u_map)
Definition: u_map.c:627
_u_instance::mhd_response_copy_data
int mhd_response_copy_data
Definition: ulfius.h:334
u_map_has_key
int u_map_has_key(const struct _u_map *u_map, const char *key)
Definition: u_map.c:143
U_OPT_AUTH_REALM
@ U_OPT_AUTH_REALM
realm to send to the client response on authenticationb failed, expected option value type: const cha...
Definition: ulfius.h:174
_u_request::proxy
char * proxy
Definition: ulfius.h:229
u_map_get_case
const char * u_map_get_case(const struct _u_map *u_map, const char *key)
Definition: u_map.c:505
ulfius_equals_endpoints
int ulfius_equals_endpoints(const struct _u_endpoint *endpoint1, const struct _u_endpoint *endpoint2)
Definition: ulfius.c:1368
_u_response::stream_size
uint64_t stream_size
Definition: ulfius.h:275
ulfius_add_endpoint_by_val
int ulfius_add_endpoint_by_val(struct _u_instance *u_instance, const char *http_method, const char *url_prefix, const char *url_format, unsigned int priority, int(*callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data), void *user_data)
Definition: ulfius.c:1403
U_OPT_AUTH_BASIC_USER
@ U_OPT_AUTH_BASIC_USER
basic authentication username, expected option value type: const char *
Definition: ulfius.h:153
_u_instance::file_upload_cls
void * file_upload_cls
Definition: ulfius.h:333
_u_request::url_path
char * url_path
Definition: ulfius.h:228
_u_map
Definition: ulfius.h:195
u_map_get_case_length
ssize_t u_map_get_case_length(const struct _u_map *u_map, const char *key)
Definition: u_map.c:543
U_OPT_URL_PARAMETER
@ U_OPT_URL_PARAMETER
Add to the map containing the url variables, both from the route and the ?key=value variables,...
Definition: ulfius.h:155
U_OPT_CLIENT_CERT_FILE
@ U_OPT_CLIENT_CERT_FILE
path to client certificate file for sending http requests with certificate authentication,...
Definition: ulfius.h:169
_u_instance::mhd_daemon
struct MHD_Daemon * mhd_daemon
Definition: ulfius.h:307
ulfius_start_secure_framework
int ulfius_start_secure_framework(struct _u_instance *u_instance, const char *key_pem, const char *cert_pem)
Definition: ulfius.c:980
u_map_enum_values
const char ** u_map_enum_values(const struct _u_map *u_map)
Definition: u_map.c:134
ulfius_clean_instance
void ulfius_clean_instance(struct _u_instance *u_instance)
Definition: ulfius.c:1528
_u_map::values
char ** values
Definition: ulfius.h:198
U_OPT_CHECK_SERVER_CERTIFICATE
@ U_OPT_CHECK_SERVER_CERTIFICATE
check server certificate and hostname, default true, used by ulfius_send_http_request,...
Definition: ulfius.h:146
_u_response::auth_realm
char * auth_realm
Definition: ulfius.h:270
u_map_copy_into
int u_map_copy_into(struct _u_map *dest, const struct _u_map *source)
Definition: u_map.c:592
connection_info_struct::has_post_processor
int has_post_processor
Definition: ulfius.h:351
ulfius_url_decode
char * ulfius_url_decode(const char *str)
Definition: ulfius.c:1788
_u_instance::port
unsigned int port
Definition: ulfius.h:309
ulfius_uri_logger
void * ulfius_uri_logger(void *cls, const char *uri)
Definition: ulfius.c:205
ulfius_init_instance
int ulfius_init_instance(struct _u_instance *u_instance, unsigned int port, struct sockaddr_in *bind_address, const char *default_auth_realm)
Definition: ulfius.c:1638
ulfius_set_string_body_response
int ulfius_set_string_body_response(struct _u_response *response, const unsigned int status, const char *body)
Definition: u_response.c:569
U_OPT_CHECK_PROXY_CERTIFICATE
@ U_OPT_CHECK_PROXY_CERTIFICATE
check proxy certificate and hostname, default true, used by ulfius_send_http_request,...
Definition: ulfius.h:148
_u_response::timeout
unsigned int timeout
Definition: ulfius.h:280
U_OPT_HEADER_PARAMETER_REMOVE
@ U_OPT_HEADER_PARAMETER_REMOVE
Remove from map containing the header variables, expected option value type: const char *.
Definition: ulfius.h:160
_u_response::stream_callback
ssize_t(* stream_callback)(void *stream_user_data, uint64_t offset, char *out_buf, size_t max)
Definition: ulfius.h:273
_u_endpoint
Contains all informations needed for an endpoint.
Definition: ulfius.h:289
_u_instance::default_auth_realm
char * default_auth_realm
Definition: ulfius.h:317
u_map_get
const char * u_map_get(const struct _u_map *u_map, const char *key)
Definition: u_map.c:448
ulfius_add_endpoint_list
int ulfius_add_endpoint_list(struct _u_instance *u_instance, const struct _u_endpoint **u_endpoint_list)
Definition: ulfius.c:1269
_u_instance::websocket_handler
void * websocket_handler
Definition: ulfius.h:323
ulfius_global_init
int ulfius_global_init()
Definition: ulfius.c:1817
_u_instance::bind_address
struct sockaddr_in * bind_address
Definition: ulfius.h:313
ulfius_set_empty_body_request
int ulfius_set_empty_body_request(struct _u_request *request)
Definition: u_request.c:766
u_map_has_key_case
int u_map_has_key_case(const struct _u_map *u_map, const char *key)
Definition: u_map.c:471
_u_instance::timeout
unsigned int timeout
Definition: ulfius.h:315
ulfius_import_client_certificate_pem
int ulfius_import_client_certificate_pem(struct _u_request *request, const char *str_cert)
Definition: u_request.c:892
connection_info_struct::callback_first_iteration
int callback_first_iteration
Definition: ulfius.h:352
U_OPT_FOLLOW_REDIRECT
@ U_OPT_FOLLOW_REDIRECT
follow url redirections, used by ulfius_send_http_request, expected option value type: int
Definition: ulfius.h:150
u_map_clean
int u_map_clean(struct _u_map *u_map)
Definition: u_map.c:75
ulfius_set_binary_body_response
int ulfius_set_binary_body_response(struct _u_response *response, const unsigned int status, const char *body, const size_t length)
Definition: u_response.c:592
ulfius_start_framework
int ulfius_start_framework(struct _u_instance *u_instance)
Definition: ulfius.c:963
_u_map::nb_values
int nb_values
Definition: ulfius.h:196
_u_request::client_key_file
char * client_key_file
Definition: ulfius.h:253
_u_request::check_server_certificate_flag
int check_server_certificate_flag
Definition: ulfius.h:234
ulfius_websocket_client_connection_close
int ulfius_websocket_client_connection_close(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:1689
_u_request::callback_position
unsigned int callback_position
Definition: ulfius.h:249
_u_instance::default_endpoint
struct _u_endpoint * default_endpoint
Definition: ulfius.h:319
u_map_put
int u_map_put(struct _u_map *u_map, const char *key, const char *value)
Definition: u_map.c:186
U_OPT_SHARED_DATA
@ U_OPT_SHARED_DATA
any data shared between callback functions, must be allocated and freed by the callback functions,...
Definition: ulfius.h:175
U_OPT_STATUS
@ U_OPT_STATUS
HTTP response status code (200, 404, 500, etc), expected option value type: long.
Definition: ulfius.h:173
U_OPT_CLIENT_KEY_FILE
@ U_OPT_CLIENT_KEY_FILE
path to client key file for sending http requests with certificate authentication,...
Definition: ulfius.h:170
_u_request::timeout
unsigned long timeout
Definition: ulfius.h:239
U_OPT_BINARY_BODY
@ U_OPT_BINARY_BODY
Set a raw body to the request or the reponse, expected option value type: const char *,...
Definition: ulfius.h:163
_u_instance::file_upload_callback
int(* file_upload_callback)(const struct _u_request *request, const char *key, const char *filename, const char *content_type, const char *transfer_encoding, const char *data, uint64_t off, size_t size, void *cls)
Definition: ulfius.h:324
_u_instance::use_client_cert_auth
int use_client_cert_auth
Definition: ulfius.h:337
_u_response::binary_body_length
size_t binary_body_length
Definition: ulfius.h:272
ulfius_set_string_body_request
int ulfius_set_string_body_request(struct _u_request *request, const char *string_body)
Definition: u_request.c:719
ulfius_send_smtp_rich_email
int ulfius_send_smtp_rich_email(const char *host, const int port, const int use_tls, const int verify_certificate, const char *user, const char *password, const char *from, const char *to, const char *cc, const char *bcc, const char *content_type, const char *subject, const char *mail_body)
Definition: u_send_request.c:692
ulfius_url_encode
char * ulfius_url_encode(const char *str)
Definition: ulfius.c:1754
_u_request::follow_redirect
int follow_redirect
Definition: ulfius.h:237
u_map_enum_keys
const char ** u_map_enum_keys(const struct _u_map *u_map)
Definition: u_map.c:126
connection_info_struct::u_instance
struct _u_instance * u_instance
Definition: ulfius.h:349
U_OPT_COOKIE_PARAMETER_REMOVE
@ U_OPT_COOKIE_PARAMETER_REMOVE
Remove from map containing the cookie variables, expected option value type: const char *.
Definition: ulfius.h:161
u_map_has_value_case
int u_map_has_value_case(const struct _u_map *u_map, const char *value)
Definition: u_map.c:488
ulfius_send_smtp_email
int ulfius_send_smtp_email(const char *host, const int port, const int use_tls, const int verify_certificate, const char *user, const char *password, const char *from, const char *to, const char *cc, const char *bcc, const char *subject, const char *mail_body)
Definition: u_send_request.c:895
U_OPT_AUTH_BASIC_PASSWORD
@ U_OPT_AUTH_BASIC_PASSWORD
basic authentication password, expected option value type: const char *
Definition: ulfius.h:154
_u_request::auth_basic_user
char * auth_basic_user
Definition: ulfius.h:241
u_map_remove_from_key
int u_map_remove_from_key(struct _u_map *u_map, const char *key)
Definition: u_map.c:292
mhd_request_completed
void mhd_request_completed(void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe)
Definition: ulfius.c:282
ulfius_websocket_send_fragmented_message
int ulfius_websocket_send_fragmented_message(struct _websocket_manager *websocket_manager, const uint8_t opcode, const uint64_t data_len, const char *data, const uint64_t fragment_len)
Definition: u_websocket.c:1101
ulfius_websocket_send_message
int ulfius_websocket_send_message(struct _websocket_manager *websocket_manager, const uint8_t opcode, const uint64_t data_len, const char *data)
Definition: u_websocket.c:1146
_u_request::map_url
struct _u_map * map_url
Definition: ulfius.h:243
ulfius_websocket_status
int ulfius_websocket_status(struct _websocket_manager *websocket_manager)
Definition: u_websocket.c:1427
_u_map::keys
char ** keys
Definition: ulfius.h:197
_u_response::websocket_handle
void * websocket_handle
Definition: ulfius.h:278
ulfius_start_secure_ca_trust_framework
int ulfius_start_secure_ca_trust_framework(struct _u_instance *u_instance, const char *key_pem, const char *cert_pem, const char *root_ca_pem)
Definition: ulfius.c:1029
ulfius_set_empty_body_response
int ulfius_set_empty_body_response(struct _u_response *response, const unsigned int status)
Definition: u_response.c:618
u_map_put_binary
int u_map_put_binary(struct _u_map *u_map, const char *key, const char *value, uint64_t offset, size_t length)
Definition: u_map.c:200
_u_endpoint::priority
unsigned int priority
Definition: ulfius.h:293
U_OPT_STRING_BODY
@ U_OPT_STRING_BODY
Set a char * body to the request or the reponse, expected option value type: const char *.
Definition: ulfius.h:164
_u_endpoint::url_prefix
char * url_prefix
Definition: ulfius.h:291
U_OPT_CHECK_PROXY_CERTIFICATE_FLAG
@ U_OPT_CHECK_PROXY_CERTIFICATE_FLAG
check certificate peer and or proxy hostname if check_proxy_certificate is enabled,...
Definition: ulfius.h:149
u_map_remove_from_key_case
int u_map_remove_from_key_case(struct _u_map *u_map, const char *key)
Definition: u_map.c:319
_u_response::stream_block_size
size_t stream_block_size
Definition: ulfius.h:276
ulfius_websocket_send_close_signal
int ulfius_websocket_send_close_signal(struct _websocket_manager *websocket_manager)
Definition: u_websocket.c:1413
ulfius_set_upload_file_callback_function
int ulfius_set_upload_file_callback_function(struct _u_instance *u_instance, int(*file_upload_callback)(const struct _u_request *request, const char *key, const char *filename, const char *content_type, const char *transfer_encoding, const char *data, uint64_t off, size_t size, void *cls), void *cls)
Definition: ulfius.c:1503
ulfius_clean_endpoint
void ulfius_clean_endpoint(struct _u_endpoint *endpoint)
Definition: ulfius.c:1189
U_OPT_COOKIE_PARAMETER
@ U_OPT_COOKIE_PARAMETER
Add to the map containing the cookie variables, expected option value type: const char *,...
Definition: ulfius.h:157
_u_response
definition of the parameters available in a struct _u_response
Definition: ulfius.h:264
_u_request::map_cookie
struct _u_map * map_cookie
Definition: ulfius.h:245
_u_request::check_proxy_certificate_flag
int check_proxy_certificate_flag
Definition: ulfius.h:236
_u_request::check_server_certificate
int check_server_certificate
Definition: ulfius.h:233
_u_instance::check_utf8
int check_utf8
Definition: ulfius.h:335
_u_instance::default_headers
struct _u_map * default_headers
Definition: ulfius.h:320
_u_request::client_cert
gnutls_x509_crt_t client_cert
Definition: ulfius.h:251
_u_instance::nb_endpoints
int nb_endpoints
Definition: ulfius.h:316
_u_response::protocol
char * protocol
Definition: ulfius.h:266
_u_request::check_proxy_certificate
int check_proxy_certificate
Definition: ulfius.h:235
ulfius_clean_endpoint_list
void ulfius_clean_endpoint_list(struct _u_endpoint *endpoint_list)
Definition: ulfius.c:1204
_u_request::binary_body_length
size_t binary_body_length
Definition: ulfius.h:248
_u_response::stream_user_data
void * stream_user_data
Definition: ulfius.h:277
ulfius_websocket_pop_first_message
struct _websocket_message * ulfius_websocket_pop_first_message(struct _websocket_message_list *message_list)
Definition: u_websocket.c:1172
u_map_remove_from_value_binary
int u_map_remove_from_value_binary(struct _u_map *u_map, const char *key, size_t length)
Definition: u_map.c:354
_u_request::map_header
struct _u_map * map_header
Definition: ulfius.h:244
u_map_clean_full
int u_map_clean_full(struct _u_map *u_map)
Definition: u_map.c:95
_u_endpoint::http_method
char * http_method
Definition: ulfius.h:290
_u_map::lengths
size_t * lengths
Definition: ulfius.h:199
U_OPT_CLIENT_KEY_PASSWORD
@ U_OPT_CLIENT_KEY_PASSWORD
password to unlock client key file, available only if GnuTLS support is enabled, expected option valu...
Definition: ulfius.h:171
U_OPT_URL_PARAMETER_REMOVE
@ U_OPT_URL_PARAMETER_REMOVE
Remove from the map containing the url variables, both from the route and the ?key=value variables,...
Definition: ulfius.h:159
ulfius_websocket_client_connection_wait_close
int ulfius_websocket_client_connection_wait_close(struct _websocket_client_handler *websocket_client_handler, unsigned int timeout)
Definition: u_websocket.c:1726
u_map_count
int u_map_count(const struct _u_map *source)
Definition: u_map.c:614
U_OPT_HTTP_VERB
@ U_OPT_HTTP_VERB
http method (GET, POST, PUT, DELETE, etc.), expected option value type: const char *
Definition: ulfius.h:140
ulfius_set_websocket_response
int ulfius_set_websocket_response(struct _u_response *response, const char *websocket_protocol, const char *websocket_extensions, void(*websocket_manager_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_manager_user_data), void *websocket_manager_user_data, void(*websocket_incoming_message_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, const struct _websocket_message *message, void *websocket_incoming_user_data), void *websocket_incoming_user_data, void(*websocket_onclose_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_onclose_user_data), void *websocket_onclose_user_data)
Definition: u_websocket.c:1359
ulfius_start_framework_with_mhd_options
int ulfius_start_framework_with_mhd_options(struct _u_instance *u_instance, unsigned int mhd_flags, struct MHD_OptionItem *options)
Definition: ulfius.c:1089
U_OPT_NONE
@ U_OPT_NONE
Empty option to complete a ulfius_set_request_properties or ulfius_set_request_properties.
Definition: ulfius.h:139
U_OPT_POST_BODY_PARAMETER
@ U_OPT_POST_BODY_PARAMETER
Add to the map containing the post body variables (if available), expected option value type: const c...
Definition: ulfius.h:158
_u_instance::status
int status
Definition: ulfius.h:308
ulfius_add_header_to_response
int ulfius_add_header_to_response(struct _u_response *response, const char *key, const char *value)
Definition: u_response.c:784
ulfius_set_default_endpoint
int ulfius_set_default_endpoint(struct _u_instance *u_instance, int(*callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data), void *user_data)
Definition: ulfius.c:1461
ulfius_add_endpoint
int ulfius_add_endpoint(struct _u_instance *u_instance, const struct _u_endpoint *u_endpoint)
Definition: ulfius.c:1222
ulfius_remove_endpoint_by_val
int ulfius_remove_endpoint_by_val(struct _u_instance *u_instance, const char *http_method, const char *url_prefix, const char *url_format)
Definition: ulfius.c:1438
_u_request::map_post_body
struct _u_map * map_post_body
Definition: ulfius.h:246
ulfius_clear_websocket_message
void ulfius_clear_websocket_message(struct _websocket_message *message)
Definition: u_websocket.c:1194
ulfius_remove_endpoint
int ulfius_remove_endpoint(struct _u_instance *u_instance, const struct _u_endpoint *u_endpoint)
Definition: ulfius.c:1295
ulfius_set_websocket_request
int ulfius_set_websocket_request(struct _u_request *request, const char *url, const char *websocket_protocol, const char *websocket_extensions)
Definition: u_websocket.c:1515
_u_response::map_header
struct _u_map * map_header
Definition: ulfius.h:267
ulfius_set_binary_body_request
int ulfius_set_binary_body_request(struct _u_request *request, const char *binary_body, const size_t length)
Definition: u_request.c:741
u_map_remove_from_value_case
int u_map_remove_from_value_case(struct _u_map *u_map, const char *value)
Definition: u_map.c:381
u_map_remove_from_value
int u_map_remove_from_value(struct _u_map *u_map, const char *value)
Definition: u_map.c:346
_u_request::http_protocol
char * http_protocol
Definition: ulfius.h:225
ulfius_set_stream_response
int ulfius_set_stream_response(struct _u_response *response, const unsigned int status, ssize_t(*stream_callback)(void *stream_user_data, uint64_t offset, char *out_buf, size_t max), void(*stream_callback_free)(void *stream_user_data), uint64_t stream_size, size_t stream_block_size, void *stream_user_data)
Definition: u_response.c:639
_u_request
definition of the parameters available in a struct _u_request
Definition: ulfius.h:224
U_OPT_HTTP_PROXY
@ U_OPT_HTTP_PROXY
proxy address to use for outgoing connections, used by ulfius_send_http_request, expected option valu...
Definition: ulfius.h:142
_u_response::nb_cookies
unsigned int nb_cookies
Definition: ulfius.h:268
u_option
u_option
Definition: ulfius.h:138
U_OPT_POST_BODY_PARAMETER_REMOVE
@ U_OPT_POST_BODY_PARAMETER_REMOVE
Remove from map containing the post body variables (if available), expected option value type: const ...
Definition: ulfius.h:162
connection_info_struct::request
struct _u_request * request
Definition: ulfius.h:353
ulfius_duplicate_endpoint_list
struct _u_endpoint * ulfius_duplicate_endpoint_list(const struct _u_endpoint *endpoint_list)
Definition: ulfius.c:1168
_u_endpoint::user_data
void * user_data
Definition: ulfius.h:297
ulfius_global_close
void ulfius_global_close()
Definition: ulfius.c:1841
U_OPT_HEADER_PARAMETER
@ U_OPT_HEADER_PARAMETER
Add to the map containing the header variables, expected option value type: const char *,...
Definition: ulfius.h:156
U_OPT_CHECK_SERVER_CERTIFICATE_FLAG
@ U_OPT_CHECK_SERVER_CERTIFICATE_FLAG
check certificate peer and or server hostname if check_server_certificate is enabled,...
Definition: ulfius.h:147
_u_instance::bind_address6
struct sockaddr_in6 * bind_address6
Definition: ulfius.h:314
_u_request::http_verb
char * http_verb
Definition: ulfius.h:226
u_map_clean_enum
int u_map_clean_enum(char **array)
Definition: u_map.c:108
_u_request::client_cert_file
char * client_cert_file
Definition: ulfius.h:252
U_OPT_TIMEOUT
@ U_OPT_TIMEOUT
connection timeout used by ulfius_send_http_request, default is 0 or Timeout in seconds to close the ...
Definition: ulfius.h:152
u_map_remove_at
int u_map_remove_at(struct _u_map *u_map, const int index)
Definition: u_map.c:408
_u_response::stream_callback_free
void(* stream_callback_free)(void *stream_user_data)
Definition: ulfius.h:274
ulfius_send_http_streaming_request
int ulfius_send_http_streaming_request(const struct _u_request *request, struct _u_response *response, size_t(*write_body_function)(void *contents, size_t size, size_t nmemb, void *user_data), void *write_body_data)
Definition: u_send_request.c:189
connection_info_struct::map_url_initial
struct _u_map map_url_initial
Definition: ulfius.h:355
_u_request::binary_body
void * binary_body
Definition: ulfius.h:247
_u_request::http_url
char * http_url
Definition: ulfius.h:227
_u_instance
Contains the needed data for an ulfius instance to work.
Definition: ulfius.h:306
_u_request::client_key_password
char * client_key_password
Definition: ulfius.h:254
_u_request::auth_basic_password
char * auth_basic_password
Definition: ulfius.h:242
u_map_copy
struct _u_map * u_map_copy(const struct _u_map *source)
Definition: u_map.c:562
_u_response::map_cookie
struct _u_cookie * map_cookie
Definition: ulfius.h:269
ulfius_open_websocket_client_connection
int ulfius_open_websocket_client_connection(struct _u_request *request, void(*websocket_manager_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_manager_user_data), void *websocket_manager_user_data, void(*websocket_incoming_message_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, const struct _websocket_message *message, void *websocket_incoming_user_data), void *websocket_incoming_user_data, void(*websocket_onclose_callback)(const struct _u_request *request, struct _websocket_manager *websocket_manager, void *websocket_onclose_user_data), void *websocket_onclose_user_data, struct _websocket_client_handler *websocket_client_handler, struct _u_response *response)
Definition: u_websocket.c:1560
U_OPT_JSON_BODY
@ U_OPT_JSON_BODY
Set a stringified json_t * body to the request or the reponse, expected option value type: json_t *.
Definition: ulfius.h:166
_u_request::client_address
struct sockaddr * client_address
Definition: ulfius.h:240
_u_instance::max_post_param_size
size_t max_post_param_size
Definition: ulfius.h:321
u_map_get_length
ssize_t u_map_get_length(const struct _u_map *u_map, const char *key)
Definition: u_map.c:524
u_map_has_value_binary
int u_map_has_value_binary(const struct _u_map *u_map, const char *value, size_t length)
Definition: u_map.c:169
ulfius_copy_endpoint
int ulfius_copy_endpoint(struct _u_endpoint *dest, const struct _u_endpoint *source)
Definition: ulfius.c:1146
u_free
void u_free(void *data)
Definition: ulfius.c:1666
ulfius_export_client_certificate_pem
char * ulfius_export_client_certificate_pem(const struct _u_request *request)
Definition: u_request.c:868
U_OPT_HTTP_URL
@ U_OPT_HTTP_URL
full url used to call this callback function or full url to call when used in a ulfius_send_http_requ...
Definition: ulfius.h:141
ulfius_websocket_client_connection_send_close_signal
int ulfius_websocket_client_connection_send_close_signal(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:1676
u_map_has_value
int u_map_has_value(const struct _u_map *u_map, const char *value)
Definition: u_map.c:160
_u_request::ca_path
char * ca_path
Definition: ulfius.h:238
ulfius_websocket_send_json_message
int ulfius_websocket_send_json_message(struct _websocket_manager *websocket_manager, json_t *message)
Definition: u_websocket.c:1158
_u_response::binary_body
void * binary_body
Definition: ulfius.h:271
_u_response::shared_data
void * shared_data
Definition: ulfius.h:279
connection_info_struct::post_processor
struct MHD_PostProcessor * post_processor
Definition: ulfius.h:350
_u_response::status
long status
Definition: ulfius.h:265
connection_info_struct::max_post_param_size
size_t max_post_param_size
Definition: ulfius.h:354
ulfius_send_http_request
int ulfius_send_http_request(const struct _u_request *request, struct _u_response *response)
Definition: u_send_request.c:157
ulfius_websocket_wait_close
int ulfius_websocket_wait_close(struct _websocket_manager *websocket_manager, unsigned int timeout)
Definition: u_websocket.c:1441
ulfius_empty_endpoint
const struct _u_endpoint * ulfius_empty_endpoint()
Definition: ulfius.c:1353
_u_instance::max_post_body_size
size_t max_post_body_size
Definition: ulfius.h:322
_u_endpoint::callback_function
int(* callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data)
Definition: ulfius.h:294
ulfius_websocket_client_connection_status
int ulfius_websocket_client_connection_status(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:1712
_u_endpoint::url_format
char * url_format
Definition: ulfius.h:292