uhttpd.h

   1 /*
   2  * uhttpd - Tiny single-threaded httpd - Main header
   3  *
   4  *   Copyright (C) 2010-2012 Jo-Philipp Wich <xm@subsignal.org>
   5  *   Copyright (C) 2012 Felix Fietkau <nbd@openwrt.org>
   6  *
   7  *  Licensed under the Apache License, Version 2.0 (the "License");
   8  *  you may not use this file except in compliance with the License.
   9  *  You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  *  Unless required by applicable law or agreed to in writing, software
  14  *  distributed under the License is distributed on an "AS IS" BASIS,
  15  *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  *  See the License for the specific language governing permissions and
  17  *  limitations under the License.
  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) HDR_##_name,
  45 #define __blobmsg_header(_name) [HDR_##_name] = { .name = #_name, .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_requests;
  66         int http_keepalive;
  67         int script_timeout;
  68 };
  69
  70 struct auth_realm {
  71         struct list_head list;
  72         const char *path;
  73         const char *user;
  74         const char *pass;
  75 };
  76
  77 enum http_method {
  78         UH_HTTP_MSG_GET,
  79         UH_HTTP_MSG_POST,
  80         UH_HTTP_MSG_HEAD,
  81 };
  82
  83 enum http_version {
  84         UH_HTTP_VER_0_9,
  85         UH_HTTP_VER_1_0,
  86         UH_HTTP_VER_1_1,
  87 };
  88
  89 struct http_request {
  90         enum http_method method;
  91         enum http_version version;
  92         int redirect_status;
  93         int content_length;
  94         bool expect_cont;
  95         uint8_t transfer_chunked;
  96         const struct auth_realm *realm;
  97 };
  98
  99 enum client_state {
 100         CLIENT_STATE_INIT,
 101         CLIENT_STATE_HEADER,
 102         CLIENT_STATE_DATA,
 103         CLIENT_STATE_DONE,
 104         CLIENT_STATE_CLOSE,
 105 };
 106
 107 struct interpreter {
 108         struct list_head list;
 109         const char *path;
 110         const char *ext;
 111 };
 112
 113 struct path_info {
 114         const char *root;
 115         const char *phys;
 116         const char *name;
 117         const char *info;
 118         const char *query;
 119         const char *auth;
 120         bool redirected;
 121         struct stat stat;
 122         const struct interpreter *ip;
 123 };
 124
 125 struct env_var {
 126         const char *name;
 127         const char *value;
 128 };
 129
 130 struct relay {
 131         struct ustream_fd sfd;
 132         struct uloop_process proc;
 133         struct client *cl;
 134
 135         bool process_done;
 136         int ret;
 137         int header_ofs;
 138
 139         void (*header_cb)(struct relay *r, const char *name, const char *value);
 140         void (*header_end)(struct relay *r);
 141         void (*close)(struct relay *r, int ret);
 142 };
 143
 144 struct dispatch_proc {
 145         struct blob_buf hdr;
 146         struct uloop_fd wrfd;
 147         struct relay r;
 148         int status_code;
 149         char *status_msg;
 150 };
 151
 152 struct dispatch_handler {
 153         struct list_head list;
 154
 155         bool (*check_url)(const char *url);
 156         bool (*check_path)(struct path_info *pi, const char *url);
 157         void (*handle_request)(struct client *cl, char *url, struct path_info *pi);
 158 };
 159
 160 #ifdef HAVE_UBUS
 161 struct dispatch_ubus {
 162         struct ubus_request req;
 163         struct json_tokener *jstok;
 164         struct json_object *jsobj;
 165         uint32_t obj;
 166         int post_len;
 167         const char *func;
 168         bool req_pending;
 169         bool header_sent;
 170 };
 171 #endif
 172
 173 struct dispatch {
 174         int (*data_send)(struct client *cl, const char *data, int len);
 175         void (*data_done)(struct client *cl);
 176         void (*write_cb)(struct client *cl);
 177         void (*close_fds)(struct client *cl);
 178         void (*free)(struct client *cl);
 179         bool data_blocked;
 180
 181         union {
 182                 struct {
 183                         struct blob_attr **hdr;
 184                         int fd;
 185                 } file;
 186                 struct dispatch_proc proc;
 187 #ifdef HAVE_UBUS
 188                 struct dispatch_ubus ubus;
 189 #endif
 190         };
 191 };
 192
 193 struct client {
 194         struct list_head list;
 195         int id;
 196
 197         struct ustream *us;
 198         struct ustream_fd sfd;
 199 #ifdef HAVE_TLS
 200         struct ustream_ssl ssl;
 201 #endif
 202         struct uloop_timeout timeout;
 203
 204         enum client_state state;
 205         bool tls;
 206
 207         struct http_request request;
 208         struct uh_addr srv_addr, peer_addr;
 209
 210         struct blob_buf hdr;
 211         struct dispatch dispatch;
 212 };
 213
 214 extern char uh_buf[4096];
 215 extern int n_clients;
 216 extern struct config conf;
 217 extern const char * const http_versions[];
 218 extern const char * const http_methods[];
 219 extern struct dispatch_handler cgi_dispatch;
 220
 221 void uh_index_add(const char *filename);
 222
 223 bool uh_accept_client(int fd, bool tls);
 224
 225 void uh_unblock_listeners(void);
 226 void uh_setup_listeners(void);
 227 int uh_socket_bind(const char *host, const char *port, bool tls);
 228
 229 bool uh_use_chunked(struct client *cl);
 230 void uh_chunk_write(struct client *cl, const void *data, int len);
 231 void uh_chunk_vprintf(struct client *cl, const char *format, va_list arg);
 232
 233 void __printf(2, 3)
 234 uh_chunk_printf(struct client *cl, const char *format, ...);
 235
 236 void uh_chunk_eof(struct client *cl);
 237 void uh_request_done(struct client *cl);
 238
 239 void uh_http_header(struct client *cl, int code, const char *summary);
 240 void __printf(4, 5)
 241 uh_client_error(struct client *cl, int code, const char *summary, const char *fmt, ...);
 242
 243 void uh_handle_request(struct client *cl);
 244 void client_poll_post_data(struct client *cl);
 245 void uh_client_read_cb(struct client *cl);
 246 void uh_client_notify_state(struct client *cl);
 247
 248 void uh_auth_add(const char *path, const char *user, const char *pass);
 249 bool uh_auth_check(struct client *cl, struct path_info *pi);
 250
 251 void uh_close_listen_fds(void);
 252 void uh_close_fds(void);
 253
 254 void uh_interpreter_add(const char *ext, const char *path);
 255 void uh_dispatch_add(struct dispatch_handler *d);
 256
 257 void uh_relay_open(struct client *cl, struct relay *r, int fd, int pid);
 258 void uh_relay_close(struct relay *r, int ret);
 259 void uh_relay_free(struct relay *r);
 260
 261 struct env_var *uh_get_process_vars(struct client *cl, struct path_info *pi);
 262 bool uh_create_process(struct client *cl, struct path_info *pi, char *url,
 263                        void (*cb)(struct client *cl, struct path_info *pi, char *url));
 264
 265 int uh_plugin_init(const char *name);
 266 void uh_plugin_post_init(void);
 267
 268 #endif