uhttpd.h

   1 /*
   2  * uhttpd - Tiny single-threaded httpd
   3  *
   4  *   Copyright (C) 2010-2013 Jo-Philipp Wich <xm@subsignal.org>
   5  *   Copyright (C) 2013 Felix Fietkau <nbd@openwrt.org>
   6  *
   7  * Permission to use, copy, modify, and/or distribute this software for any
   8  * purpose with or without fee is hereby granted, provided that the above
   9  * copyright notice and this permission notice appear in all copies.
  10  *
  11  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  12  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  13  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  14  * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  15  * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  16  * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  17  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  18  */
  19
  20 #ifndef __UHTTPD_H
  21 #define __UHTTPD_H
  22
  23 #include <netinet/in.h>
  24 #include <limits.h>
  25 #include <dirent.h>
  26
  27 #include <libubox/list.h>
  28 #include <libubox/uloop.h>
  29 #include <libubox/ustream.h>
  30 #include <libubox/blob.h>
  31 #include <libubox/utils.h>
  32 #ifdef HAVE_UBUS
  33 #include <libubus.h>
  34 #include <json/json.h>
  35 #endif
  36 #ifdef HAVE_TLS
  37 #include <libubox/ustream-ssl.h>
  38 #endif
  39
  40 #include "utils.h"
  41
  42 #define UH_LIMIT_CLIENTS        64
  43
  44 #define __enum_header(_name, _val) HDR_##_name,
  45 #define __blobmsg_header(_name, _val) [HDR_##_name] = { .name = #_val, .type = BLOBMSG_TYPE_STRING },
  46
  47 struct client;
  48
  49 struct config {
  50         const char *docroot;
  51         const char *realm;
  52         const char *file;
  53         const char *error_handler;
  54         const char *cgi_prefix;
  55         const char *cgi_path;
  56         const char *lua_handler;
  57         const char *lua_prefix;
  58         const char *ubus_prefix;
  59         const char *ubus_socket;
  60         int no_symlinks;
  61         int no_dirlists;
  62         int network_timeout;
  63         int rfc1918_filter;
  64         int tcp_keepalive;
  65         int max_script_requests;
  66         int max_connections;
  67         int http_keepalive;
  68         int script_timeout;
  69         int ubus_noauth;
  70 };
  71
  72 struct auth_realm {
  73         struct list_head list;
  74         const char *path;
  75         const char *user;
  76         const char *pass;
  77 };
  78
  79 enum http_method {
  80         UH_HTTP_MSG_GET,
  81         UH_HTTP_MSG_POST,
  82         UH_HTTP_MSG_HEAD,
  83 };
  84
  85 enum http_version {
  86         UH_HTTP_VER_0_9,
  87         UH_HTTP_VER_1_0,
  88         UH_HTTP_VER_1_1,
  89 };
  90
  91 enum http_user_agent {
  92         UH_UA_UNKNOWN,
  93         UH_UA_GECKO,
  94         UH_UA_CHROME,
  95         UH_UA_SAFARI,
  96         UH_UA_MSIE,
  97         UH_UA_KONQUEROR,
  98         UH_UA_OPERA,
  99         UH_UA_MSIE_OLD,
 100         UH_UA_MSIE_NEW,
 101 };
 102
 103 struct http_request {
 104         enum http_method method;
 105         enum http_version version;
 106         enum http_user_agent ua;
 107         int redirect_status;
 108         int content_length;
 109         bool expect_cont;
 110         bool connection_close;
 111         uint8_t transfer_chunked;
 112         const struct auth_realm *realm;
 113 };
 114
 115 enum client_state {
 116         CLIENT_STATE_INIT,
 117         CLIENT_STATE_HEADER,
 118         CLIENT_STATE_DATA,
 119         CLIENT_STATE_DONE,
 120         CLIENT_STATE_CLOSE,
 121 };
 122
 123 struct interpreter {
 124         struct list_head list;
 125         const char *path;
 126         const char *ext;
 127 };
 128
 129 struct path_info {
 130         const char *root;
 131         const char *phys;
 132         const char *name;
 133         const char *info;
 134         const char *query;
 135         const char *auth;
 136         bool redirected;
 137         struct stat stat;
 138         const struct interpreter *ip;
 139 };
 140
 141 struct env_var {
 142         const char *name;
 143         const char *value;
 144 };
 145
 146 struct relay {
 147         struct ustream_fd sfd;
 148         struct uloop_process proc;
 149         struct uloop_timeout timeout;
 150         struct client *cl;
 151
 152         bool process_done;
 153         bool error;
 154         int ret;
 155         int header_ofs;
 156
 157         void (*header_cb)(struct relay *r, const char *name, const char *value);
 158         void (*header_end)(struct relay *r);
 159         void (*close)(struct relay *r, int ret);
 160 };
 161
 162 struct dispatch_proc {
 163         struct uloop_timeout timeout;
 164         struct blob_buf hdr;
 165         struct uloop_fd wrfd;
 166         struct relay r;
 167         int status_code;
 168         char *status_msg;
 169 };
 170
 171 struct dispatch_handler {
 172         struct list_head list;
 173         bool script;
 174
 175         bool (*check_url)(const char *url);
 176         bool (*check_path)(struct path_info *pi, const char *url);
 177         void (*handle_request)(struct client *cl, char *url, struct path_info *pi);
 178 };
 179
 180 #ifdef HAVE_UBUS
 181 struct dispatch_ubus {
 182         struct ubus_request req;
 183
 184         struct uloop_timeout timeout;
 185         struct json_tokener *jstok;
 186         struct json_object *jsobj;
 187         struct json_object *jsobj_cur;
 188         int post_len;
 189
 190         const char *sid;
 191         uint32_t obj;
 192         const char *func;
 193
 194         struct blob_buf buf;
 195         bool req_pending;
 196         bool array;
 197         int array_idx;
 198 };
 199 #endif
 200
 201 struct dispatch {
 202         int (*data_send)(struct client *cl, const char *data, int len);
 203         void (*data_done)(struct client *cl);
 204         void (*write_cb)(struct client *cl);
 205         void (*close_fds)(struct client *cl);
 206         void (*free)(struct client *cl);
 207
 208         void *req_data;
 209         void (*req_free)(struct client *cl);
 210
 211         bool data_blocked;
 212
 213         union {
 214                 struct {
 215                         struct blob_attr **hdr;
 216                         int fd;
 217                 } file;
 218                 struct dispatch_proc proc;
 219 #ifdef HAVE_UBUS
 220                 struct dispatch_ubus ubus;
 221 #endif
 222         };
 223 };
 224
 225 struct client {
 226         struct list_head list;
 227         int id;
 228
 229         struct ustream *us;
 230         struct ustream_fd sfd;
 231 #ifdef HAVE_TLS
 232         struct ustream_ssl ssl;
 233 #endif
 234         struct uloop_timeout timeout;
 235         int requests;
 236
 237         enum client_state state;
 238         bool tls;
 239
 240         struct http_request request;
 241         struct uh_addr srv_addr, peer_addr;
 242
 243         struct blob_buf hdr;
 244         struct dispatch dispatch;
 245 };
 246
 247 extern char uh_buf[4096];
 248 extern int n_clients;
 249 extern struct config conf;
 250 extern const char * const http_versions[];
 251 extern const char * const http_methods[];
 252 extern struct dispatch_handler cgi_dispatch;
 253
 254 void uh_index_add(const char *filename);
 255
 256 bool uh_accept_client(int fd, bool tls);
 257
 258 void uh_unblock_listeners(void);
 259 void uh_setup_listeners(void);
 260 int uh_socket_bind(const char *host, const char *port, bool tls);
 261
 262 bool uh_use_chunked(struct client *cl);
 263 void uh_chunk_write(struct client *cl, const void *data, int len);
 264 void uh_chunk_vprintf(struct client *cl, const char *format, va_list arg);
 265
 266 void __printf(2, 3)
 267 uh_chunk_printf(struct client *cl, const char *format, ...);
 268
 269 void uh_chunk_eof(struct client *cl);
 270 void uh_request_done(struct client *cl);
 271
 272 void uh_http_header(struct client *cl, int code, const char *summary);
 273 void __printf(4, 5)
 274 uh_client_error(struct client *cl, int code, const char *summary, const char *fmt, ...);
 275
 276 void uh_handle_request(struct client *cl);
 277 void client_poll_post_data(struct client *cl);
 278 void uh_client_read_cb(struct client *cl);
 279 void uh_client_notify_state(struct client *cl);
 280
 281 void uh_auth_add(const char *path, const char *user, const char *pass);
 282 bool uh_auth_check(struct client *cl, struct path_info *pi);
 283
 284 void uh_close_listen_fds(void);
 285 void uh_close_fds(void);
 286
 287 void uh_interpreter_add(const char *ext, const char *path);
 288 void uh_dispatch_add(struct dispatch_handler *d);
 289
 290 void uh_relay_open(struct client *cl, struct relay *r, int fd, int pid);
 291 void uh_relay_close(struct relay *r, int ret);
 292 void uh_relay_free(struct relay *r);
 293 void uh_relay_kill(struct client *cl, struct relay *r);
 294
 295 struct env_var *uh_get_process_vars(struct client *cl, struct path_info *pi);
 296 bool uh_create_process(struct client *cl, struct path_info *pi, char *url,
 297                        void (*cb)(struct client *cl, struct path_info *pi, char *url));
 298
 299 int uh_plugin_init(const char *name);
 300 void uh_plugin_post_init(void);
 301
 302 #endif