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         CLIENT_STATE_CLEANUP,
 122 };
 123
 124 struct interpreter {
 125         struct list_head list;
 126         const char *path;
 127         const char *ext;
 128 };
 129
 130 struct path_info {
 131         const char *root;
 132         const char *phys;
 133         const char *name;
 134         const char *info;
 135         const char *query;
 136         const char *auth;
 137         bool redirected;
 138         struct stat stat;
 139         const struct interpreter *ip;
 140 };
 141
 142 struct env_var {
 143         const char *name;
 144         const char *value;
 145 };
 146
 147 struct relay {
 148         struct ustream_fd sfd;
 149         struct uloop_process proc;
 150         struct uloop_timeout timeout;
 151         struct client *cl;
 152
 153         bool process_done;
 154         bool error;
 155         int ret;
 156         int header_ofs;
 157
 158         void (*header_cb)(struct relay *r, const char *name, const char *value);
 159         void (*header_end)(struct relay *r);
 160         void (*close)(struct relay *r, int ret);
 161 };
 162
 163 struct dispatch_proc {
 164         struct uloop_timeout timeout;
 165         struct blob_buf hdr;
 166         struct uloop_fd wrfd;
 167         struct relay r;
 168         int status_code;
 169         char *status_msg;
 170 };
 171
 172 struct dispatch_handler {
 173         struct list_head list;
 174         bool script;
 175
 176         bool (*check_url)(const char *url);
 177         bool (*check_path)(struct path_info *pi, const char *url);
 178         void (*handle_request)(struct client *cl, char *url, struct path_info *pi);
 179 };
 180
 181 #ifdef HAVE_UBUS
 182 struct dispatch_ubus {
 183         struct ubus_request req;
 184
 185         struct uloop_timeout timeout;
 186         struct json_tokener *jstok;
 187         struct json_object *jsobj;
 188         struct json_object *jsobj_cur;
 189         int post_len;
 190
 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 refcount;
 228         int id;
 229
 230         struct ustream *us;
 231         struct ustream_fd sfd;
 232 #ifdef HAVE_TLS
 233         struct ustream_ssl ssl;
 234 #endif
 235         struct uloop_timeout timeout;
 236         int requests;
 237
 238         enum client_state state;
 239         bool tls;
 240
 241         struct http_request request;
 242         struct uh_addr srv_addr, peer_addr;
 243
 244         struct blob_buf hdr;
 245         struct dispatch dispatch;
 246 };
 247
 248 extern char uh_buf[4096];
 249 extern int n_clients;
 250 extern struct config conf;
 251 extern const char * const http_versions[];
 252 extern const char * const http_methods[];
 253 extern struct dispatch_handler cgi_dispatch;
 254
 255 void uh_index_add(const char *filename);
 256
 257 bool uh_accept_client(int fd, bool tls);
 258
 259 void uh_unblock_listeners(void);
 260 void uh_setup_listeners(void);
 261 int uh_socket_bind(const char *host, const char *port, bool tls);
 262
 263 bool uh_use_chunked(struct client *cl);
 264 void uh_chunk_write(struct client *cl, const void *data, int len);
 265 void uh_chunk_vprintf(struct client *cl, const char *format, va_list arg);
 266
 267 void __printf(2, 3)
 268 uh_chunk_printf(struct client *cl, const char *format, ...);
 269
 270 void uh_chunk_eof(struct client *cl);
 271 void uh_request_done(struct client *cl);
 272
 273 void uh_http_header(struct client *cl, int code, const char *summary);
 274 void __printf(4, 5)
 275 uh_client_error(struct client *cl, int code, const char *summary, const char *fmt, ...);
 276
 277 void uh_handle_request(struct client *cl);
 278 void client_poll_post_data(struct client *cl);
 279 void uh_client_read_cb(struct client *cl);
 280 void uh_client_notify_state(struct client *cl);
 281
 282 void uh_auth_add(const char *path, const char *user, const char *pass);
 283 bool uh_auth_check(struct client *cl, struct path_info *pi);
 284
 285 void uh_close_listen_fds(void);
 286 void uh_close_fds(void);
 287
 288 void uh_interpreter_add(const char *ext, const char *path);
 289 void uh_dispatch_add(struct dispatch_handler *d);
 290
 291 void uh_relay_open(struct client *cl, struct relay *r, int fd, int pid);
 292 void uh_relay_close(struct relay *r, int ret);
 293 void uh_relay_free(struct relay *r);
 294 void uh_relay_kill(struct client *cl, struct relay *r);
 295
 296 struct env_var *uh_get_process_vars(struct client *cl, struct path_info *pi);
 297 bool uh_create_process(struct client *cl, struct path_info *pi, char *url,
 298                        void (*cb)(struct client *cl, struct path_info *pi, char *url));
 299
 300 int uh_plugin_init(const char *name);
 301 void uh_plugin_post_init(void);
 302
 303 static inline void uh_client_ref(struct client *cl)
 304 {
 305         cl->refcount++;
 306 }
 307
 308 static inline void uh_client_unref(struct client *cl)
 309 {
 310         if (--cl->refcount)
 311                 return;
 312
 313         if (cl->state == CLIENT_STATE_CLEANUP)
 314                 ustream_state_change(cl->us);
 315 }
 316
 317 #endif