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  #include <zlib.h>
50  #ifndef POLLRDHUP
51  #define POLLRDHUP 0x2000
52  #endif
53 #endif
54 
55 #include <pthread.h>
56 #include <microhttpd.h>
57 
58 #if defined(_WIN32) && !defined(U_DISABLE_WEBSOCKET)
59  #define U_DISABLE_WEBSOCKET
60 #endif
61 
62 #if (MHD_VERSION < 0x00095300) && !defined(U_DISABLE_WEBSOCKET)
63  #define U_DISABLE_WEBSOCKET
64 #endif
65 
67 #include <orcania.h>
68 
70 #ifndef U_DISABLE_YDER
71  #include <yder.h>
72 #else
73 
74 #define Y_LOG_MODE_NONE 0
75 #define Y_LOG_MODE_CONSOLE 0
76 #define Y_LOG_MODE_SYSLOG 0
77 #define Y_LOG_MODE_FILE 0
78 #define Y_LOG_MODE_JOURNALD 0
79 #define Y_LOG_MODE_CALLBACK 0
80 #define Y_LOG_MODE_CURRENT 0
81 
82 #define Y_LOG_LEVEL_NONE 0
83 #define Y_LOG_LEVEL_DEBUG 0
84 #define Y_LOG_LEVEL_INFO 0
85 #define Y_LOG_LEVEL_WARNING 0
86 #define Y_LOG_LEVEL_ERROR 0
87 #define Y_LOG_LEVEL_CURRENT 0
88 
89 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);
90 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);
91 void y_log_message(const unsigned long type, const char * message, ...);
92 int y_close_logs();
93 #endif
94 
95 #ifndef U_DISABLE_JANSSON
96 #include <jansson.h>
97 #endif
98 
104 #define ULFIUS_STREAM_BLOCK_SIZE_DEFAULT 1024
105 #define U_STREAM_END MHD_CONTENT_READER_END_OF_STREAM
106 #define U_STREAM_ERROR MHD_CONTENT_READER_END_WITH_ERROR
107 #define U_STREAM_SIZE_UNKNOWN MHD_SIZE_UNKNOWN
108 #define U_STREAM_SIZE_UNKOWN U_STREAM_SIZE_UNKNOWN // Backward compatibility
109 
110 #define U_OK 0
111 #define U_ERROR 1
112 #define U_ERROR_MEMORY 2
113 #define U_ERROR_PARAMS 3
114 #define U_ERROR_LIBMHD 4
115 #define U_ERROR_LIBCURL 5
116 #define U_ERROR_NOT_FOUND 6
117 #define U_ERROR_DISCONNECTED 7
118 
119 #define U_CALLBACK_CONTINUE 0
120 #define U_CALLBACK_IGNORE 1
121 #define U_CALLBACK_COMPLETE 2
122 #define U_CALLBACK_UNAUTHORIZED 3
123 #define U_CALLBACK_ERROR 4
124 
125 #define U_COOKIE_SAME_SITE_NONE 0
126 #define U_COOKIE_SAME_SITE_STRICT 1
127 #define U_COOKIE_SAME_SITE_LAX 2
128 
129 #define U_USE_IPV4 0x0001
130 #define U_USE_IPV6 0x0010
131 #define U_USE_ALL (U_USE_IPV4|U_USE_IPV6)
132 
133 #define U_SSL_VERIFY_PEER 0x0001
134 #define U_SSL_VERIFY_HOSTNAME 0x0010
135 
140 typedef enum {
145 #if MHD_VERSION >= 0x00095208
146  U_OPT_NETWORK_TYPE = 4,
147 #endif
167 #ifndef U_DISABLE_JANSSON
169 #endif
170 #ifndef U_DISABLE_GNUTLS
174 #endif
180 
185 /*************
186  * Structures
187  *************/
188 
198 struct _u_map {
199  int nb_values; /* !< Values count */
200  char ** keys; /* !< Array of keys */
201  char ** values; /* !< Array of values */
202  size_t * lengths; /* !< Lengths of each values */
203 };
204 
209 struct _u_cookie {
210  char * key; /* !< key if the cookie */
211  char * value; /* !< value of the cookie */
212  char * expires; /* !< expiration date of the cookie */
213  unsigned int max_age; /* !< duration of the cookie in seconds */
214  char * domain; /* !< domain for the cookie */
215  char * path; /* !< url path for the cookie */
216  int secure; /* !< flag to set cookie secure or not */
217  int http_only; /* !< flag to set cookie for HTTP connections only or not */
218  int same_site; /* !< flag to set same_site option to the cookie */
219 };
220 
227 struct _u_request {
228  char * http_protocol; /* !< http protocol used (1.0 or 1.1) */
229  char * http_verb; /* !< http method (GET, POST, PUT, DELETE, etc.) */
230  char * http_url; /* !< full url used to call this callback function or full url to call when used in a ulfius_send_http_request */
231  char * url_path; /* !< url path only used to call this callback function (ex, if http_url is /path/?param=1, url_path is /path/) */
232  char * proxy; /* !<proxy address to use for outgoing connections, used by ulfius_send_http_request */
233 #if MHD_VERSION >= 0x00095208
234  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 */
235 #endif
236  int check_server_certificate; /* !< check server certificate and hostname, default true, used by ulfius_send_http_request */
237  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 */
238  int check_proxy_certificate; /* !< check proxy certificate and hostname, default true, used by ulfius_send_http_request, requires libcurl >= 7.52 */
239  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 */
240  int follow_redirect; /* !< follow url redirections, used by ulfius_send_http_request */
241  char * ca_path; /* !< specify a path to CA certificates instead of system path, used by ulfius_send_http_request */
242  unsigned long timeout; /* !< connection timeout used by ulfius_send_http_request, default is 0 */
243  struct sockaddr * client_address; /* !< IP address of the client */
244  char * auth_basic_user; /* !< basic authentication username */
245  char * auth_basic_password; /* !< basic authentication password */
246  struct _u_map * map_url; /* !< map containing the url variables, both from the route and the ?key=value variables */
247  struct _u_map * map_header; /* !< map containing the header variables */
248  struct _u_map * map_cookie; /* !< map containing the cookie variables */
249  struct _u_map * map_post_body; /* !< map containing the post body variables (if available) */
250  void * binary_body; /* !< raw body */
251  size_t binary_body_length; /* !< length of raw body */
252  unsigned int callback_position; /* !< position of the current callback function in the callback list, starts at 0 */
253 #ifndef U_DISABLE_GNUTLS
254  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 */
255  char * client_cert_file; /* !< path to client certificate file for sending http requests with certificate authentication, available only if GnuTLS support is enabled */
256  char * client_key_file; /* !< path to client key file for sending http requests with certificate authentication, available only if GnuTLS support is enabled */
257  char * client_key_password; /* !< password to unlock client key file, available only if GnuTLS support is enabled */
258 #endif
259 };
260 
267 struct _u_response {
268  long status; /* !< HTTP status code (200, 404, 500, etc) */
269  char * protocol; /* !< HTTP Protocol sent */
270  struct _u_map * map_header; /* !< map containing the header variables */
271  unsigned int nb_cookies; /* !< number of cookies sent */
272  struct _u_cookie * map_cookie; /* !< array of cookies sent */
273  char * auth_realm; /* !< realm to send to the client on authenticationb failed */
274  void * binary_body; /* !< raw binary content */
275  size_t binary_body_length; /* !< length of the binary_body */
276  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 */
277  void (* stream_callback_free) (void * stream_user_data); /* !< callback function to free data allocated for streaming */
278  uint64_t stream_size; /* !< size of the streamed data (U_STREAM_SIZE_UNKNOWN if unknown) */
279  size_t stream_block_size; /* !< size of each block to be streamed, set according to your system */
280  void * stream_user_data; /* !< user defined data that will be available in your callback stream functions */
281  void * websocket_handle; /* !< handle for websocket extension */
282  void * shared_data; /* !< any data shared between callback functions, must be allocated and freed by the callback functions */
283  unsigned int timeout; /* !< Timeout in seconds to close the connection because of inactivity between the client and the server */
284 };
285 
292 struct _u_endpoint {
293  char * http_method; /* !< http verb (GET, POST, PUT, etc.) in upper case */
294  char * url_prefix; /* !< prefix for the url (optional) */
295  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 */
296  unsigned int priority; /* !< endpoint priority in descending order (0 is the higher priority) */
297  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. */
298  struct _u_response * response,
299  void * user_data);
300  void * user_data; /* !< pointer to a data or a structure that will be available in callback_function */
301 };
302 
309 struct _u_instance {
310  struct MHD_Daemon * mhd_daemon; /* !< pointer to the libmicrohttpd daemon */
311  int status; /* !< status of the current instance, status are U_STATUS_STOP, U_STATUS_RUNNING or U_STATUS_ERROR */
312  unsigned int port; /* !< port number to listen to */
313 #if MHD_VERSION >= 0x00095208
314  unsigned short network_type; /* !< Listen to ipv4 and or ipv6 connections, values available are U_USE_ALL, U_USE_IPV4 or U_USE_IPV6 */
315 #endif
316  struct sockaddr_in * bind_address; /* !< ipv4 address to listen to (optional) */
317  struct sockaddr_in6 * bind_address6; /* !< ipv6 address to listen to (optional) */
318  unsigned int timeout; /* !< Timeout to close the connection because of inactivity between the client and the server */
319  int nb_endpoints; /* !< Number of available endpoints */
320  char * default_auth_realm; /* !< Default realm on authentication error */
321  struct _u_endpoint * endpoint_list; /* !< List of available endpoints */
322  struct _u_endpoint * default_endpoint; /* !< Default endpoint if no other endpoint match the current url */
323  struct _u_map * default_headers; /* !< Default headers that will be added to all response->map_header */
324  size_t max_post_param_size; /* !< maximum size for a post parameter, 0 means no limit, default 0 */
325  size_t max_post_body_size; /* !< maximum size for the entire post body, 0 means no limit, default 0 */
326  void * websocket_handler; /* !< handler for the websocket structure */
327  int (* file_upload_callback) (const struct _u_request * request, /* !< callback function to manage file upload by blocks */
328  const char * key,
329  const char * filename,
330  const char * content_type,
331  const char * transfer_encoding,
332  const char * data,
333  uint64_t off,
334  size_t size,
335  void * cls);
336  void * file_upload_cls; /* !< any pointer to pass to the file_upload_callback function */
337  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 */
338  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 */
339 #ifndef U_DISABLE_GNUTLS
340  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 */
341 #endif
342 };
343 
353  struct MHD_PostProcessor * post_processor;
356  struct _u_request * request;
358  struct _u_map map_url_initial;
359 };
360 
361 /**********************************
362  * Instance functions declarations
363  **********************************/
364 
375 void u_free(void * data);
376 
384 int ulfius_global_init();
385 
389 void ulfius_global_close();
390 
412 int ulfius_init_instance(struct _u_instance * u_instance, unsigned int port, struct sockaddr_in * bind_address, const char * default_auth_realm);
413 
414 #if MHD_VERSION >= 0x00095208
426 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);
427 #endif
428 
435 void ulfius_clean_instance(struct _u_instance * u_instance);
436 
444 int ulfius_start_framework(struct _u_instance * u_instance);
445 
455 int ulfius_start_secure_framework(struct _u_instance * u_instance, const char * key_pem, const char * cert_pem);
456 
457 #ifndef U_DISABLE_GNUTLS
469 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);
470 #endif
471 
490 int ulfius_start_framework_with_mhd_options(struct _u_instance * u_instance, unsigned int mhd_flags, struct MHD_OptionItem * options);
491 
495 void mhd_request_completed (void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe);
496 void * ulfius_uri_logger (void * cls, const char * uri);
497 
505 int ulfius_stop_framework(struct _u_instance * u_instance);
506 
528  int (* file_upload_callback) (const struct _u_request * request,
529  const char * key,
530  const char * filename,
531  const char * content_type,
532  const char * transfer_encoding,
533  const char * data,
534  uint64_t off,
535  size_t size,
536  void * cls),
537  void * cls);
538 
549 /***********************************
550  * Endpoints functions declarations
551  ***********************************/
552 
560 int ulfius_add_endpoint(struct _u_instance * u_instance, const struct _u_endpoint * u_endpoint);
561 
579 int ulfius_add_endpoint_by_val(struct _u_instance * u_instance,
580  const char * http_method,
581  const char * url_prefix,
582  const char * url_format,
583  unsigned int priority,
584  int (* callback_function)(const struct _u_request * request, // Input parameters (set by the framework)
585  struct _u_response * response, // Output parameters (set by the user)
586  void * user_data),
587  void * user_data);
588 
596 int ulfius_add_endpoint_list(struct _u_instance * u_instance, const struct _u_endpoint ** u_endpoint_list);
597 
607 int ulfius_remove_endpoint(struct _u_instance * u_instance, const struct _u_endpoint * u_endpoint);
608 
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
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 
1149 int ulfius_set_json_body_response(struct _u_response * response, const unsigned int status, const json_t * j_body);
1150 #endif
1151 
1162 /************************************************************************
1163  * _u_map declarations *
1164  * _u_map is a simple map structure that handles sets of key/value maps *
1165  ************************************************************************/
1166 
1173 int u_map_init(struct _u_map * u_map);
1174 
1180 int u_map_clean(struct _u_map * u_map);
1181 
1187 int u_map_clean_full(struct _u_map * u_map);
1188 
1194 int u_map_clean_enum(char ** array);
1195 
1201 const char ** u_map_enum_keys(const struct _u_map * u_map);
1202 
1208 const char ** u_map_enum_values(const struct _u_map * u_map);
1209 
1218 int u_map_has_key(const struct _u_map * u_map, const char * key);
1219 
1228 int u_map_has_value(const struct _u_map * u_map, const char * value);
1229 
1239 int u_map_has_value_binary(const struct _u_map * u_map, const char * value, size_t length);
1240 
1249 int u_map_has_key_case(const struct _u_map * u_map, const char * key);
1250 
1259 int u_map_has_value_case(const struct _u_map * u_map, const char * value);
1260 
1269 int u_map_put(struct _u_map * u_map, const char * key, const char * value);
1270 
1282 int u_map_put_binary(struct _u_map * u_map, const char * key, const char * value, uint64_t offset, size_t length);
1283 
1291 ssize_t u_map_get_length(const struct _u_map * u_map, const char * key);
1292 
1300 ssize_t u_map_get_case_length(const struct _u_map * u_map, const char * key);
1301 
1309 const char * u_map_get(const struct _u_map * u_map, const char * key);
1310 
1318 const char * u_map_get_case(const struct _u_map * u_map, const char * key);
1319 
1327 int u_map_remove_from_key(struct _u_map * u_map, const char * key);
1328 
1336 int u_map_remove_from_key_case(struct _u_map * u_map, const char * key);
1337 
1345 int u_map_remove_from_value(struct _u_map * u_map, const char * value);
1346 
1354 int u_map_remove_from_value_case(struct _u_map * u_map, const char * value);
1355 
1363 int u_map_remove_from_value_binary(struct _u_map * u_map, const char * key, size_t length);
1364 
1371 int u_map_remove_at(struct _u_map * u_map, const int index);
1372 
1379 struct _u_map * u_map_copy(const struct _u_map * source);
1380 
1388 int u_map_copy_into(struct _u_map * dest, const struct _u_map * source);
1389 
1396 int u_map_count(const struct _u_map * source);
1397 
1403 int u_map_empty(struct _u_map * u_map);
1404 
1415 #ifndef U_DISABLE_WEBSOCKET
1416 
1417 /**********************************
1418  * Websocket functions declarations
1419  **********************************/
1420 
1421 #define U_WEBSOCKET_USER_AGENT "Ulfius Websocket Client Framework"
1422 
1423 #define U_WEBSOCKET_MAGIC_STRING "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
1424 #define U_WEBSOCKET_UPGRADE_VALUE "websocket"
1425 #define U_WEBSOCKET_BAD_REQUEST_BODY "Error in websocket handshake, wrong parameters"
1426 #define U_WEBSOCKET_USEC_WAIT 50
1427 #define WEBSOCKET_MAX_CLOSE_TRY 10
1428 
1429 #define U_WEBSOCKET_BIT_FIN 0x80
1430 #define U_WEBSOCKET_MASK 0x80
1431 #define U_WEBSOCKET_LEN_MASK 0x7F
1432 #define U_WEBSOCKET_OPCODE_CONTINUE 0x00
1433 #define U_WEBSOCKET_OPCODE_TEXT 0x01
1434 #define U_WEBSOCKET_OPCODE_BINARY 0x02
1435 #define U_WEBSOCKET_OPCODE_CLOSE 0x08
1436 #define U_WEBSOCKET_OPCODE_PING 0x09
1437 #define U_WEBSOCKET_OPCODE_PONG 0x0A
1438 #define U_WEBSOCKET_OPCODE_CLOSED 0xFD
1439 #define U_WEBSOCKET_OPCODE_ERROR 0xFE
1440 #define U_WEBSOCKET_OPCODE_NONE 0xFF
1441 
1442 #define U_WEBSOCKET_NONE 0
1443 #define U_WEBSOCKET_SERVER 1
1444 #define U_WEBSOCKET_CLIENT 2
1445 
1446 #define U_WEBSOCKET_STATUS_OPEN 0
1447 #define U_WEBSOCKET_STATUS_CLOSE 1
1448 #define U_WEBSOCKET_STATUS_ERROR 2
1449 
1450 #define U_WEBSOCKET_RSV1 0x40
1451 #define U_WEBSOCKET_RSV2 0x20
1452 #define U_WEBSOCKET_RSV3 0x10
1453 
1454 #define WEBSOCKET_RESPONSE_HTTP 0x0001
1455 #define WEBSOCKET_RESPONSE_UPGRADE 0x0002
1456 #define WEBSOCKET_RESPONSE_CONNECTION 0x0004
1457 #define WEBSOCKET_RESPONSE_ACCEPT 0x0008
1458 #define WEBSOCKET_RESPONSE_PROTCOL 0x0010
1459 #define WEBSOCKET_RESPONSE_EXTENSION 0x0020
1460 
1461 #define WEBSOCKET_DEFLATE_CHUNK_SIZE 32768
1462 #define WEBSOCKET_DEFLATE_WINDOWS_BITS 15
1463 
1467 struct _websocket_deflate_context {
1468  z_stream infstream;
1469  z_stream defstream;
1470  int deflate_mask;
1471  int inflate_mask;
1472  uint server_no_context_takeover;
1473  uint client_no_context_takeover;
1474  uint server_max_window_bits;
1475  uint client_max_window_bits;
1476 };
1477 
1482 struct _websocket_extension {
1483  char * extension_server;
1484  char * extension_client;
1485  uint8_t rsv;
1486  int (* websocket_extension_message_out_perform)(const uint8_t opcode,
1487  const uint64_t data_len_in,
1488  const char * data_in,
1489  uint64_t * data_len_out,
1490  char ** data_out,
1491  const uint64_t fragment_len,
1492  void * user_data,
1493  void * context);
1494  void * websocket_extension_message_out_perform_user_data;
1495  int (* websocket_extension_message_in_perform)(const uint8_t opcode,
1496  const uint64_t data_len_in,
1497  const char * data_in,
1498  uint64_t * data_len_out,
1499  char ** data_out,
1500  const uint64_t fragment_len,
1501  void * user_data,
1502  void * context);
1503  void * websocket_extension_message_in_perform_user_data;
1504  int (* websocket_extension_server_match)(const char * extension_client,
1505  const char ** extension_client_list,
1506  char ** extension_server,
1507  void * user_data,
1508  void ** context);
1509  void * websocket_extension_server_match_user_data;
1510  int (* websocket_extension_client_match)(const char * extension_server,
1511  void * user_data,
1512  void ** context);
1513  void * websocket_extension_client_match_user_data;
1514  void (* websocket_extension_free_context)(void * user_data,
1515  void * context);
1516  void * websocket_extension_free_context_user_data;
1517  int enabled;
1518  void * context;
1519 };
1520 
1527 struct _websocket_manager {
1528  struct _websocket_message_list * message_list_incoming; /* !< list of incoming messages */
1529  struct _websocket_message_list * message_list_outcoming; /* !< list of outcoming messages */
1530  int connected; /* !< flag to know if the websocket is connected or not */
1531  int ping_sent; /* !< flag to know if the websocket has sent a ping frame or not, before receiving a pong */
1532  int close_flag; /* !< flag to set before closing a websocket */
1533  MHD_socket mhd_sock; /* !< reference to libmicrohttpd's socket for websocket server */
1534  int tcp_sock; /* !< tcp socket for websocket client */
1535  int tls; /* !< set to 1 if the websocket is in a TLS socket */
1536  gnutls_session_t gnutls_session; /* !< GnuTLS session for websocket client */
1537  gnutls_certificate_credentials_t xcred; /* !< certificate credential used by GnuTLS */
1538  char * protocol; /* !< websocket protocol */
1539  char * extensions; /* !< websocket extension */
1540  pthread_mutex_t read_lock; /* !< mutex to read data in the socket */
1541  pthread_mutex_t write_lock; /* !< mutex to write data in the socket */
1542  pthread_mutex_t status_lock; /* !< mutex to broadcast new status */
1543  pthread_cond_t status_cond; /* !< condition to broadcast new status */
1544  struct pollfd fds_in;
1545  struct pollfd fds_out;
1546  int type;
1547  int rsv_expected;
1548  struct _pointer_list * websocket_extension_list;
1549 };
1550 
1556 struct _websocket_message {
1557  time_t datestamp; /* !< date stamp of the message */
1558  uint8_t rsv; /* !< flags RSV1-3 of the message */
1559  uint8_t opcode; /* !< opcode for the message (string or binary) */
1560  uint8_t has_mask; /* !< does the message contain a mask? */
1561  uint8_t mask[4]; /* !< mask used if any */
1562  size_t data_len; /* !< length of the data */
1563  char * data; /* !< message data */
1564  size_t fragment_len; /* !< length of the fragment, 0 if not fragmented */
1565  uint8_t fin; /* !< flag fin (end of fragmented message) */
1566 };
1567 
1571 struct _websocket_message_list {
1572  struct _websocket_message ** list; /* !< messages list */
1573  size_t len; /* !< message list length */
1574 };
1575 
1580 struct _websocket {
1581  struct _u_instance * instance; /* !< reference to the ulfius instance if any */
1582  struct _u_request * request; /* !< refrence to the ulfius request of any */
1583  void (* websocket_manager_callback) (const struct _u_request * request, /* !< reference to a function called after the websocket handshake */
1584  struct _websocket_manager * websocket_manager,
1585  void * websocket_manager_user_data);
1586  void * websocket_manager_user_data; /* !< a user-defined reference that will be available in websocket_manager_callback */
1587  void (* websocket_incoming_message_callback) (const struct _u_request * request, /* !< reference to a function called each time a message arrives */
1588  struct _websocket_manager * websocket_manager,
1589  const struct _websocket_message * message,
1590  void * websocket_incoming_user_data);
1591  void * websocket_incoming_user_data; /* !< a user-defined reference that will be available in websocket_incoming_message_callback */
1592  void (* websocket_onclose_callback) (const struct _u_request * request, /* !< reference to a function called after the websocket connection ends */
1593  struct _websocket_manager * websocket_manager,
1594  void * websocket_onclose_user_data);
1595  void * websocket_onclose_user_data; /* !< a user-defined reference that will be available in websocket_onclose_callback */
1596  struct _websocket_manager * websocket_manager; /* !< refrence to the websocket manager if any */
1597  struct MHD_UpgradeResponseHandle * urh; /* !< reference used by libmicrohttpd to upgrade the connection */
1598 };
1599 
1603 struct _websocket_client_handler {
1604  struct _websocket * websocket; /* !< the websocket to use */
1605  struct _u_response * response; /* !< the response attached to the websocket */
1606 };
1607 
1608 /********************************/
1610 /********************************/
1611 
1621 int ulfius_websocket_send_message(struct _websocket_manager * websocket_manager,
1622  const uint8_t opcode,
1623  const uint64_t data_len,
1624  const char * data);
1625 
1637 int ulfius_websocket_send_fragmented_message(struct _websocket_manager * websocket_manager,
1638  const uint8_t opcode,
1639  const uint64_t data_len,
1640  const char * data,
1641  const uint64_t fragment_len);
1642 
1649 #ifndef U_DISABLE_JANSSON
1650 int ulfius_websocket_send_json_message(struct _websocket_manager * websocket_manager,
1651  json_t * message);
1652 #endif
1653 
1663 struct _websocket_message * ulfius_websocket_pop_first_message(struct _websocket_message_list * message_list);
1664 
1669 void ulfius_clear_websocket_message(struct _websocket_message * message);
1670 
1671 /********************************/
1673 /********************************/
1674 
1689 int ulfius_set_websocket_response(struct _u_response * response,
1690  const char * websocket_protocol,
1691  const char * websocket_extensions,
1692  void (* websocket_manager_callback) (const struct _u_request * request,
1693  struct _websocket_manager * websocket_manager,
1694  void * websocket_manager_user_data),
1695  void * websocket_manager_user_data,
1696  void (* websocket_incoming_message_callback) (const struct _u_request * request,
1697  struct _websocket_manager * websocket_manager,
1698  const struct _websocket_message * message,
1699  void * websocket_incoming_user_data),
1700  void * websocket_incoming_user_data,
1701  void (* websocket_onclose_callback) (const struct _u_request * request,
1702  struct _websocket_manager * websocket_manager,
1703  void * websocket_onclose_user_data),
1704  void * websocket_onclose_user_data);
1705 
1723  const char * extension_server,
1724  uint8_t rsv,
1725  int (* websocket_extension_message_out_perform)(const uint8_t opcode,
1726  const uint64_t data_len_in,
1727  const char * data_in,
1728  uint64_t * data_len_out,
1729  char ** data_out,
1730  const uint64_t fragment_len,
1731  void * user_data,
1732  void * context),
1733  void * websocket_extension_message_out_perform_user_data,
1734  int (* websocket_extension_message_in_perform)(const uint8_t opcode,
1735  const uint64_t data_len_in,
1736  const char * data_in,
1737  uint64_t * data_len_out,
1738  char ** data_out,
1739  const uint64_t fragment_len,
1740  void * user_data,
1741  void * context),
1742  void * websocket_extension_message_in_perform_user_data,
1743  int (* websocket_extension_server_match)(const char * extension_client,
1744  const char ** extension_client_list,
1745  char ** extension_server,
1746  void * user_data,
1747  void ** context),
1748  void * websocket_extension_server_match_user_data,
1749  void (* websocket_extension_free_context)(void * user_data,
1750  void * context),
1751  void * websocket_extension_free_context_user_data);
1752 
1767 int websocket_extension_message_out_deflate(const uint8_t opcode,
1768  const uint64_t data_len_in,
1769  const char * data_in,
1770  uint64_t * data_len_out,
1771  char ** data_out,
1772  const uint64_t fragment_len,
1773  void * user_data,
1774  void * context);
1775 
1789 int websocket_extension_message_in_inflate(const uint8_t opcode,
1790  const uint64_t data_len_in,
1791  const char * data_in,
1792  uint64_t * data_len_out,
1793  char ** data_out,
1794  const uint64_t fragment_len,
1795  void * user_data,
1796  void * context);
1797 
1804 void websocket_extension_deflate_free_context(void * user_data, void * context);
1805 
1815 int websocket_extension_server_match_deflate(const char * extension_client, const char ** extension_client_list, char ** extension_server, void * user_data, void ** context);
1816 
1826 
1836 int ulfius_websocket_send_close_signal(struct _websocket_manager * websocket_manager);
1837 
1845 int ulfius_websocket_status(struct _websocket_manager * websocket_manager);
1846 
1855 int ulfius_websocket_wait_close(struct _websocket_manager * websocket_manager, unsigned int timeout);
1856 
1857 /********************************/
1859 /********************************/
1860 
1875  void (* websocket_manager_callback) (const struct _u_request * request,
1876  struct _websocket_manager * websocket_manager,
1877  void * websocket_manager_user_data),
1878  void * websocket_manager_user_data,
1879  void (* websocket_incoming_message_callback) (const struct _u_request * request,
1880  struct _websocket_manager * websocket_manager,
1881  const struct _websocket_message * message,
1882  void * websocket_incoming_user_data),
1883  void * websocket_incoming_user_data,
1884  void (* websocket_onclose_callback) (const struct _u_request * request,
1885  struct _websocket_manager * websocket_manager,
1886  void * websocket_onclose_user_data),
1887  void * websocket_onclose_user_data,
1888  struct _websocket_client_handler * websocket_client_handler,
1889  struct _u_response * response);
1890 
1906 int ulfius_add_websocket_client_extension_message_perform(struct _websocket_client_handler * websocket_client_handler,
1907  const char * extension,
1908  uint8_t rsv,
1909  int (* websocket_extension_message_out_perform)(const uint8_t opcode,
1910  const uint64_t data_len_in,
1911  const char * data_in,
1912  uint64_t * data_len_out,
1913  char ** data_out,
1914  const uint64_t fragment_len,
1915  void * user_data,
1916  void * context),
1917  void * websocket_extension_message_out_perform_user_data,
1918  int (* websocket_extension_message_in_perform)(const uint8_t opcode,
1919  const uint64_t data_len_in,
1920  const char * data_in,
1921  uint64_t * data_len_out,
1922  char ** data_out,
1923  const uint64_t fragment_len,
1924  void * user_data,
1925  void * context),
1926  void * websocket_extension_message_in_perform_user_data,
1927  int (* websocket_extension_client_match)(const char * extension_server,
1928  void * user_data,
1929  void ** context),
1930  void * websocket_extension_client_match_user_data,
1931  void (* websocket_extension_free_context)(void * user_data,
1932  void * context),
1933  void * websocket_extension_free_context_user_data);
1934 
1942 int websocket_extension_client_match_deflate(const char * extension_server, void * user_data, void ** context);
1943 
1951 int ulfius_add_websocket_client_deflate_extension(struct _websocket_client_handler * websocket_client_handler);
1952 
1958 int ulfius_websocket_client_connection_send_close_signal(struct _websocket_client_handler * websocket_client_handler);
1959 
1965 int ulfius_websocket_client_connection_close(struct _websocket_client_handler * websocket_client_handler);
1966 
1973 int ulfius_websocket_client_connection_status(struct _websocket_client_handler * websocket_client_handler);
1974 
1983 int ulfius_websocket_client_connection_wait_close(struct _websocket_client_handler * websocket_client_handler, unsigned int timeout);
1984 
1994 int ulfius_set_websocket_request(struct _u_request * request,
1995  const char * url,
1996  const char * websocket_protocol,
1997  const char * websocket_extensions);
1998 
1999 #endif
2000 
2002 #define ULFIUS_URL_SEPARATOR "/"
2003 #define ULFIUS_HTTP_ENCODING_JSON "application/json"
2004 #define ULFIUS_HTTP_HEADER_CONTENT "Content-Type"
2005 #define ULFIUS_HTTP_NOT_FOUND_BODY "Resource not found"
2006 #define ULFIUS_HTTP_ERROR_BODY "Server Error"
2007 
2008 #define ULFIUS_COOKIE_ATTRIBUTE_EXPIRES "Expires"
2009 #define ULFIUS_COOKIE_ATTRIBUTE_MAX_AGE "Max-Age"
2010 #define ULFIUS_COOKIE_ATTRIBUTE_DOMAIN "Domain"
2011 #define ULFIUS_COOKIE_ATTRIBUTE_PATH "Path"
2012 #define ULFIUS_COOKIE_ATTRIBUTE_SECURE "Secure"
2013 #define ULFIUS_COOKIE_ATTRIBUTE_HTTPONLY "HttpOnly"
2014 
2015 #define ULFIUS_POSTBUFFERSIZE 65536
2016 
2017 #define U_STATUS_STOP 0
2018 #define U_STATUS_RUNNING 1
2019 #define U_STATUS_ERROR 2
2020 
2021 #ifndef U_DISABLE_WEBSOCKET
2022 
2026 struct _websocket_handle {
2027  char * websocket_protocol; /* !< protocol for the websocket */
2028  char * websocket_extensions; /* !< extensions for the websocket */
2029  void (* websocket_manager_callback) (const struct _u_request * request, /* !< callback function for working with the websocket */
2030  struct _websocket_manager * websocket_manager,
2031  void * websocket_manager_user_data);
2032  void * websocket_manager_user_data; /* !< user-defined data that will be handled to websocket_manager_callback */
2033  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 */
2034  struct _websocket_manager * websocket_manager,
2035  const struct _websocket_message * message,
2036  void * websocket_incoming_user_data);
2037  void * websocket_incoming_user_data; /* !< user-defined data that will be handled to websocket_incoming_message_callback */
2038  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 */
2039  struct _websocket_manager * websocket_manager,
2040  void * websocket_onclose_user_data);
2041  void * websocket_onclose_user_data; /* !< user-defined data that will be handled to websocket_onclose_callback */
2042  int rsv_expected;
2043  struct _pointer_list * websocket_extension_list;
2044 };
2045 
2049 struct _websocket_handler {
2050  pthread_mutex_t websocket_active_lock; /* !< mutex to change nb_websocket_active value */
2051  size_t nb_websocket_active; /* !< number of active websocket */
2052  struct _websocket ** websocket_active; /* !< array of active websocket */
2053  pthread_mutex_t websocket_close_lock; /* !< mutex to broadcast close signal */
2054  pthread_cond_t websocket_close_cond; /* !< condition to broadcast close signal */
2055  int pthread_init;
2056 };
2057 
2058 #endif // U_DISABLE_WEBSOCKET
2059 
2070 #ifndef U_DISABLE_GNUTLS
2071 /*
2072  * ulfius_export_client_certificate_pem
2073  * Exports the client certificate using PEM format
2074  * @param request struct _u_request used
2075  * @return the certificate in PEM format
2076  * returned value must be u_free'd after use
2077  */
2078 char * ulfius_export_client_certificate_pem(const struct _u_request * request);
2079 
2080 /*
2081  * ulfius_import_client_certificate_pem
2082  * Imports the client certificate using PEM format
2083  * @param request struct _u_request used
2084  * @param str_cert client certificate in PEM format
2085  * @return U_OK on success
2086  */
2087 int ulfius_import_client_certificate_pem(struct _u_request * request, const char * str_cert);
2088 
2089 #endif // U_DISABLE_GNUTLS
2090 
2095 #ifdef __cplusplus
2096 }
2097 #endif
2098 
2099 #endif // __ULFIUS_H__
char * ulfius_export_client_certificate_pem(const struct _u_request *request)
Definition: u_request.c:872
int ulfius_import_client_certificate_pem(struct _u_request *request, const char *str_cert)
Definition: u_request.c:896
u_option
Definition: ulfius.h:140
@ U_OPT_POST_BODY_PARAMETER_REMOVE
Remove from map containing the post body variables (if available), expected option value type: const ...
Definition: ulfius.h:164
@ U_OPT_CHECK_PROXY_CERTIFICATE
check proxy certificate and hostname, default true, used by ulfius_send_http_request,...
Definition: ulfius.h:150
@ U_OPT_CLIENT_KEY_PASSWORD
password to unlock client key file, available only if GnuTLS support is enabled, expected option valu...
Definition: ulfius.h:173
@ U_OPT_STATUS
HTTP response status code (200, 404, 500, etc), expected option value type: long.
Definition: ulfius.h:175
@ U_OPT_FOLLOW_REDIRECT
follow url redirections, used by ulfius_send_http_request, expected option value type: int
Definition: ulfius.h:152
@ U_OPT_COOKIE_PARAMETER
Add to the map containing the cookie variables, expected option value type: const char *,...
Definition: ulfius.h:159
@ U_OPT_TIMEOUT
connection timeout used by ulfius_send_http_request, default is 0 or Timeout in seconds to close the ...
Definition: ulfius.h:154
@ U_OPT_AUTH_BASIC_USER
basic authentication username, expected option value type: const char *
Definition: ulfius.h:155
@ U_OPT_CA_PATH
specify a path to CA certificates instead of system path, used by ulfius_send_http_request,...
Definition: ulfius.h:153
@ U_OPT_AUTH_REALM
realm to send to the client response on authenticationb failed, expected option value type: const cha...
Definition: ulfius.h:176
@ 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:143
@ U_OPT_HEADER_PARAMETER_REMOVE
Remove from map containing the header variables, expected option value type: const char *.
Definition: ulfius.h:162
@ U_OPT_CLIENT_CERT_FILE
path to client certificate file for sending http requests with certificate authentication,...
Definition: ulfius.h:171
@ U_OPT_CLIENT_KEY_FILE
path to client key file for sending http requests with certificate authentication,...
Definition: ulfius.h:172
@ 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:168
@ U_OPT_HTTP_PROXY
proxy address to use for outgoing connections, used by ulfius_send_http_request, expected option valu...
Definition: ulfius.h:144
@ U_OPT_COOKIE_PARAMETER_REMOVE
Remove from map containing the cookie variables, expected option value type: const char *.
Definition: ulfius.h:163
@ U_OPT_HTTP_VERB
http method (GET, POST, PUT, DELETE, etc.), expected option value type: const char *
Definition: ulfius.h:142
@ U_OPT_NONE
Empty option to complete a ulfius_set_request_properties or ulfius_set_request_properties.
Definition: ulfius.h:141
@ U_OPT_BINARY_BODY
Set a raw body to the request or the reponse, expected option value type: const char *,...
Definition: ulfius.h:165
@ U_OPT_AUTH_BASIC_PASSWORD
basic authentication password, expected option value type: const char *
Definition: ulfius.h:156
@ U_OPT_SHARED_DATA
any data shared between callback functions, must be allocated and freed by the callback functions,...
Definition: ulfius.h:177
@ 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:161
@ U_OPT_CHECK_SERVER_CERTIFICATE
check server certificate and hostname, default true, used by ulfius_send_http_request,...
Definition: ulfius.h:148
@ 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:160
@ U_OPT_CHECK_PROXY_CERTIFICATE_FLAG
check certificate peer and or proxy hostname if check_proxy_certificate is enabled,...
Definition: ulfius.h:151
@ U_OPT_STRING_BODY
Set a char * body to the request or the reponse, expected option value type: const char *.
Definition: ulfius.h:166
@ U_OPT_URL_PARAMETER
Add to the map containing the url variables, both from the route and the ?key=value variables,...
Definition: ulfius.h:157
@ U_OPT_HEADER_PARAMETER
Add to the map containing the header variables, expected option value type: const char *,...
Definition: ulfius.h:158
@ U_OPT_HTTP_URL_APPEND
append char * value to the current url, expected option value type: const char *
Definition: ulfius.h:178
@ U_OPT_CHECK_SERVER_CERTIFICATE_FLAG
check certificate peer and or server hostname if check_server_certificate is enabled,...
Definition: ulfius.h:149
void ulfius_clean_endpoint_list(struct _u_endpoint *endpoint_list)
Definition: ulfius.c:1392
int ulfius_add_endpoint_list(struct _u_instance *u_instance, const struct _u_endpoint **u_endpoint_list)
Definition: ulfius.c:1443
int ulfius_add_endpoint(struct _u_instance *u_instance, const struct _u_endpoint *u_endpoint)
Definition: ulfius.c:1403
int ulfius_remove_endpoint(struct _u_instance *u_instance, const struct _u_endpoint *u_endpoint)
Definition: ulfius.c:1460
int ulfius_copy_endpoint(struct _u_endpoint *dest, const struct _u_endpoint *source)
Definition: ulfius.c:1334
const struct _u_endpoint * ulfius_empty_endpoint()
Definition: ulfius.c:1514
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:1566
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:1543
int ulfius_equals_endpoints(const struct _u_endpoint *endpoint1, const struct _u_endpoint *endpoint2)
Definition: ulfius.c:1525
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:1579
struct _u_endpoint * ulfius_duplicate_endpoint_list(const struct _u_endpoint *endpoint_list)
Definition: ulfius.c:1356
void ulfius_clean_endpoint(struct _u_endpoint *endpoint)
Definition: ulfius.c:1377
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:906
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:191
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:703
int ulfius_send_http_request(const struct _u_request *request, struct _u_response *response)
Definition: u_send_request.c:159
void mhd_request_completed(void *cls, struct MHD_Connection *connection, void **con_cls, enum MHD_RequestTerminationCode toe)
Definition: ulfius.c:282
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:1727
void * ulfius_uri_logger(void *cls, const char *uri)
Definition: ulfius.c:205
void ulfius_clean_instance(struct _u_instance *u_instance)
Definition: ulfius.c:1622
int ulfius_stop_framework(struct _u_instance *u_instance)
Definition: ulfius.c:1299
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:1212
int ulfius_start_framework(struct _u_instance *u_instance)
Definition: ulfius.c:1146
int ulfius_start_framework_with_mhd_options(struct _u_instance *u_instance, unsigned int mhd_flags, struct MHD_OptionItem *options)
Definition: ulfius.c:1272
int ulfius_start_secure_framework(struct _u_instance *u_instance, const char *key_pem, const char *cert_pem)
Definition: ulfius.c:1163
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:1602
void ulfius_global_close()
Definition: ulfius.c:1925
void u_free(void *data)
Definition: ulfius.c:1741
int ulfius_global_init()
Definition: ulfius.c:1901
int ulfius_add_header_to_response(struct _u_response *response, const char *key, const char *value)
Definition: u_response.c:697
int ulfius_set_empty_body_request(struct _u_request *request)
Definition: u_request.c:770
int ulfius_set_string_body_response(struct _u_response *response, const unsigned int status, const char *body)
Definition: u_response.c:509
int ulfius_set_string_body_request(struct _u_request *request, const char *string_body)
Definition: u_request.c:723
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:527
int ulfius_set_binary_body_request(struct _u_request *request, const char *binary_body, const size_t length)
Definition: u_request.c:745
int ulfius_set_empty_body_response(struct _u_response *response, const unsigned int status)
Definition: u_response.c:548
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:562
int u_map_init(struct _u_map *u_map)
Definition: u_map.c:33
int u_map_remove_from_value_binary(struct _u_map *u_map, const char *key, size_t length)
Definition: u_map.c:287
int u_map_remove_from_key(struct _u_map *u_map, const char *key)
Definition: u_map.c:237
int u_map_clean(struct _u_map *u_map)
Definition: u_map.c:66
int u_map_remove_at(struct _u_map *u_map, const int index)
Definition: u_map.c:333
int u_map_remove_from_value_case(struct _u_map *u_map, const char *value)
Definition: u_map.c:310
struct _u_map * u_map_copy(const struct _u_map *source)
Definition: u_map.c:452
ssize_t u_map_get_case_length(const struct _u_map *u_map, const char *key)
Definition: u_map.c:438
const char * u_map_get(const struct _u_map *u_map, const char *key)
Definition: u_map.c:368
int u_map_remove_from_key_case(struct _u_map *u_map, const char *key)
Definition: u_map.c:260
int u_map_has_value(const struct _u_map *u_map, const char *value)
Definition: u_map.c:125
int u_map_has_value_case(const struct _u_map *u_map, const char *value)
Definition: u_map.c:398
int u_map_clean_enum(char **array)
Definition: u_map.c:91
int u_map_clean_full(struct _u_map *u_map)
Definition: u_map.c:82
const char ** u_map_enum_keys(const struct _u_map *u_map)
Definition: u_map.c:105
int u_map_has_key_case(const struct _u_map *u_map, const char *key)
Definition: u_map.c:386
ssize_t u_map_get_length(const struct _u_map *u_map, const char *key)
Definition: u_map.c:424
int u_map_empty(struct _u_map *u_map)
Definition: u_map.c:504
int u_map_copy_into(struct _u_map *dest, const struct _u_map *source)
Definition: u_map.c:477
int u_map_put(struct _u_map *u_map, const char *key, const char *value)
Definition: u_map.c:141
int u_map_has_value_binary(const struct _u_map *u_map, const char *value, size_t length)
Definition: u_map.c:129
const char ** u_map_enum_values(const struct _u_map *u_map)
Definition: u_map.c:109
int u_map_has_key(const struct _u_map *u_map, const char *key)
Definition: u_map.c:113
int u_map_remove_from_value(struct _u_map *u_map, const char *value)
Definition: u_map.c:283
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:149
int u_map_count(const struct _u_map *source)
Definition: u_map.c:495
const char * u_map_get_case(const struct _u_map *u_map, const char *key)
Definition: u_map.c:410
char * ulfius_url_encode(const char *str)
Definition: ulfius.c:1838
char * ulfius_url_decode(const char *str)
Definition: ulfius.c:1872
Contains all informations needed for an endpoint.
Definition: ulfius.h:292
int(* callback_function)(const struct _u_request *request, struct _u_response *response, void *user_data)
Definition: ulfius.h:297
void * user_data
Definition: ulfius.h:300
unsigned int priority
Definition: ulfius.h:296
char * http_method
Definition: ulfius.h:293
char * url_format
Definition: ulfius.h:295
char * url_prefix
Definition: ulfius.h:294
Contains the needed data for an ulfius instance to work.
Definition: ulfius.h:309
int status
Definition: ulfius.h:311
size_t max_post_param_size
Definition: ulfius.h:324
struct MHD_Daemon * mhd_daemon
Definition: ulfius.h:310
unsigned int port
Definition: ulfius.h:312
unsigned int timeout
Definition: ulfius.h:318
size_t max_post_body_size
Definition: ulfius.h:325
struct sockaddr_in * bind_address
Definition: ulfius.h:316
void * file_upload_cls
Definition: ulfius.h:336
struct _u_map * default_headers
Definition: ulfius.h:323
int check_utf8
Definition: ulfius.h:338
struct sockaddr_in6 * bind_address6
Definition: ulfius.h:317
struct _u_endpoint * endpoint_list
Definition: ulfius.h:321
int nb_endpoints
Definition: ulfius.h:319
struct _u_endpoint * default_endpoint
Definition: ulfius.h:322
void * websocket_handler
Definition: ulfius.h:326
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:327
char * default_auth_realm
Definition: ulfius.h:320
int mhd_response_copy_data
Definition: ulfius.h:337
int use_client_cert_auth
Definition: ulfius.h:340
Definition: ulfius.h:198
int nb_values
Definition: ulfius.h:199
size_t * lengths
Definition: ulfius.h:202
char ** keys
Definition: ulfius.h:200
char ** values
Definition: ulfius.h:201
definition of the parameters available in a struct _u_request
Definition: ulfius.h:227
unsigned long timeout
Definition: ulfius.h:242
int check_server_certificate_flag
Definition: ulfius.h:237
int follow_redirect
Definition: ulfius.h:240
char * auth_basic_password
Definition: ulfius.h:245
char * http_protocol
Definition: ulfius.h:228
int check_proxy_certificate_flag
Definition: ulfius.h:239
char * client_key_password
Definition: ulfius.h:257
void * binary_body
Definition: ulfius.h:250
gnutls_x509_crt_t client_cert
Definition: ulfius.h:254
struct _u_map * map_cookie
Definition: ulfius.h:248
size_t binary_body_length
Definition: ulfius.h:251
struct _u_map * map_header
Definition: ulfius.h:247
int check_server_certificate
Definition: ulfius.h:236
struct sockaddr * client_address
Definition: ulfius.h:243
char * ca_path
Definition: ulfius.h:241
struct _u_map * map_post_body
Definition: ulfius.h:249
int check_proxy_certificate
Definition: ulfius.h:238
char * client_key_file
Definition: ulfius.h:256
char * url_path
Definition: ulfius.h:231
char * auth_basic_user
Definition: ulfius.h:244
char * http_verb
Definition: ulfius.h:229
unsigned int callback_position
Definition: ulfius.h:252
char * proxy
Definition: ulfius.h:232
char * http_url
Definition: ulfius.h:230
struct _u_map * map_url
Definition: ulfius.h:246
char * client_cert_file
Definition: ulfius.h:255
definition of the parameters available in a struct _u_response
Definition: ulfius.h:267
char * protocol
Definition: ulfius.h:269
size_t stream_block_size
Definition: ulfius.h:279
void * stream_user_data
Definition: ulfius.h:280
ssize_t(* stream_callback)(void *stream_user_data, uint64_t offset, char *out_buf, size_t max)
Definition: ulfius.h:276
void * websocket_handle
Definition: ulfius.h:281
uint64_t stream_size
Definition: ulfius.h:278
size_t binary_body_length
Definition: ulfius.h:275
struct _u_map * map_header
Definition: ulfius.h:270
long status
Definition: ulfius.h:268
unsigned int nb_cookies
Definition: ulfius.h:271
unsigned int timeout
Definition: ulfius.h:283
struct _u_cookie * map_cookie
Definition: ulfius.h:272
char * auth_realm
Definition: ulfius.h:273
void(* stream_callback_free)(void *stream_user_data)
Definition: ulfius.h:277
void * binary_body
Definition: ulfius.h:274
void * shared_data
Definition: ulfius.h:282
Definition: ulfius.h:351
struct _u_request * request
Definition: ulfius.h:356
struct _u_map map_url_initial
Definition: ulfius.h:358
struct _u_instance * u_instance
Definition: ulfius.h:352
size_t max_post_param_size
Definition: ulfius.h:357
struct MHD_PostProcessor * post_processor
Definition: ulfius.h:353
int callback_first_iteration
Definition: ulfius.h:355
int has_post_processor
Definition: ulfius.h:354
int websocket_extension_message_in_inflate(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context)
Definition: u_websocket.c:1944
int ulfius_add_websocket_extension_message_perform(struct _u_response *response, const char *extension_server, uint8_t rsv, int(*websocket_extension_message_out_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_out_perform_user_data, int(*websocket_extension_message_in_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_in_perform_user_data, int(*websocket_extension_server_match)(const char *extension_client, const char **extension_client_list, char **extension_server, void *user_data, void **context), void *websocket_extension_server_match_user_data, void(*websocket_extension_free_context)(void *user_data, void *context), void *websocket_extension_free_context_user_data)
Definition: u_websocket.c:1785
int ulfius_websocket_client_connection_send_close_signal(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2653
int ulfius_websocket_send_close_signal(struct _websocket_manager *websocket_manager)
Definition: u_websocket.c:2182
int ulfius_websocket_send_json_message(struct _websocket_manager *websocket_manager, json_t *message)
Definition: u_websocket.c:1535
int websocket_extension_server_match_deflate(const char *extension_client, const char **extension_client_list, char **extension_server, void *user_data, void **context)
Definition: u_websocket.c:2022
int ulfius_add_websocket_client_deflate_extension(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2644
int ulfius_websocket_client_connection_wait_close(struct _websocket_client_handler *websocket_client_handler, unsigned int timeout)
Definition: u_websocket.c:2707
int ulfius_add_websocket_client_extension_message_perform(struct _websocket_client_handler *websocket_client_handler, const char *extension, uint8_t rsv, int(*websocket_extension_message_out_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_out_perform_user_data, int(*websocket_extension_message_in_perform)(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context), void *websocket_extension_message_in_perform_user_data, int(*websocket_extension_client_match)(const char *extension_server, void *user_data, void **context), void *websocket_extension_client_match_user_data, void(*websocket_extension_free_context)(void *user_data, void *context), void *websocket_extension_free_context_user_data)
Definition: u_websocket.c:2326
int ulfius_websocket_client_connection_status(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2693
int ulfius_websocket_wait_close(struct _websocket_manager *websocket_manager, unsigned int timeout)
Definition: u_websocket.c:2211
int ulfius_websocket_status(struct _websocket_manager *websocket_manager)
Definition: u_websocket.c:2197
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:2412
int websocket_extension_message_out_deflate(const uint8_t opcode, const uint64_t data_len_in, const char *data_in, uint64_t *data_len_out, char **data_out, const uint64_t fragment_len, void *user_data, void *context)
Definition: u_websocket.c:1854
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:1738
int ulfius_add_websocket_deflate_extension(struct _u_response *response)
Definition: u_websocket.c:2170
void websocket_extension_deflate_free_context(void *user_data, void *context)
Definition: u_websocket.c:2163
int ulfius_websocket_client_connection_close(struct _websocket_client_handler *websocket_client_handler)
Definition: u_websocket.c:2666
int ulfius_set_websocket_request(struct _u_request *request, const char *url, const char *websocket_protocol, const char *websocket_extensions)
Definition: u_websocket.c:2285
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:1523
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:1433
struct _websocket_message * ulfius_websocket_pop_first_message(struct _websocket_message_list *message_list)
Definition: u_websocket.c:1549
int websocket_extension_client_match_deflate(const char *extension_server, void *user_data, void **context)
Definition: u_websocket.c:2533
void ulfius_clear_websocket_message(struct _websocket_message *message)
Definition: u_websocket.c:1571