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
  32 #include "utils.h"
  33
  34 #define UH_LIMIT_CLIENTS        64
  35 #define UH_LIMIT_HEADERS        64
  36 #define UH_LIMIT_MSGHEAD        4096
  37
  38 struct config {
  39         char docroot[PATH_MAX];
  40         char *realm;
  41         char *file;
  42         char *error_handler;
  43         int no_symlinks;
  44         int no_dirlists;
  45         int network_timeout;
  46         int rfc1918_filter;
  47         int tcp_keepalive;
  48         int max_requests;
  49         int http_keepalive;
  50         int script_timeout;
  51 };
  52
  53 struct auth_realm {
  54         struct list_head list;
  55         char path[PATH_MAX];
  56         char user[32];
  57         char pass[128];
  58 };
  59
  60 enum http_method {
  61         UH_HTTP_MSG_GET,
  62         UH_HTTP_MSG_POST,
  63         UH_HTTP_MSG_HEAD,
  64 };
  65
  66 enum http_version {
  67         UH_HTTP_VER_0_9,
  68         UH_HTTP_VER_1_0,
  69         UH_HTTP_VER_1_1,
  70 };
  71
  72 struct http_request {
  73         enum http_method method;
  74         enum http_version version;
  75         int redirect_status;
  76         char *url;
  77         struct auth_realm *realm;
  78 };
  79
  80 struct http_response {
  81         int statuscode;
  82         char *statusmsg;
  83         char *headers[UH_LIMIT_HEADERS];
  84 };
  85
  86 enum client_state {
  87         CLIENT_STATE_INIT,
  88         CLIENT_STATE_HEADER,
  89         CLIENT_STATE_DATA,
  90         CLIENT_STATE_DONE,
  91         CLIENT_STATE_CLOSE,
  92 };
  93
  94 struct client {
  95         struct list_head list;
  96         int id;
  97
  98         struct ustream *us;
  99         struct ustream_fd sfd;
 100 #ifdef HAVE_TLS
 101         struct ustream_ssl stream_ssl;
 102 #endif
 103         struct uloop_fd rpipe;
 104         struct uloop_fd wpipe;
 105         struct uloop_process proc;
 106         struct uloop_timeout timeout;
 107         bool (*cb)(struct client *);
 108         void *priv;
 109
 110         enum client_state state;
 111
 112         struct http_request request;
 113         struct http_response response;
 114         struct sockaddr_in6 servaddr;
 115         struct sockaddr_in6 peeraddr;
 116
 117         struct blob_buf hdr;
 118
 119         void (*dispatch_write_cb)(struct client *cl);
 120         void (*dispatch_free)(struct client *cl);
 121
 122         union {
 123                 struct {
 124                         struct blob_attr **hdr;
 125                         int fd;
 126                 } file;
 127         } data;
 128 };
 129
 130 extern int n_clients;
 131 extern struct config conf;
 132
 133 void uh_index_add(const char *filename);
 134
 135 void uh_accept_client(int fd);
 136
 137 void uh_unblock_listeners(void);
 138 void uh_setup_listeners(void);
 139 int uh_socket_bind(const char *host, const char *port, bool tls);
 140
 141 bool uh_use_chunked(struct client *cl);
 142 void uh_chunk_write(struct client *cl, const void *data, int len);
 143 void uh_chunk_vprintf(struct client *cl, const char *format, va_list arg);
 144
 145 void __printf(2, 3)
 146 uh_chunk_printf(struct client *cl, const char *format, ...);
 147
 148 void uh_chunk_eof(struct client *cl);
 149 void uh_request_done(struct client *cl);
 150
 151 void uh_http_header(struct client *cl, int code, const char *summary);
 152 void __printf(4, 5)
 153 uh_client_error(struct client *cl, int code, const char *summary, const char *fmt, ...);
 154
 155 void uh_handle_file_request(struct client *cl);
 156
 157 void uh_auth_add(const char *path, const char *user, const char *pass);
 158
 159 #endif