libuhttpd/README.md

libuhttpd(中文)

A Lightweight and fully asynchronous HTTP server library based on libubox and referenced from uhttpd for Embedded Linux.

Keep Watching for More Actions on This Space

Features

• Action - processes requests by invoking registered C functions which mapped to a specific path.
• Lightweight and fully asynchronous
• Use libubox as its event backend
• Support HTTPS - OpenSSL, mbedtls and CyaSSl(wolfssl)
• Flexible - you can easily extend your application to have HTTP/HTTPS services
• Code structure is concise and understandable, also suitable for learning
• Lua Template - Embed Lua code into HTML code, like embedding PHP into HTML

TO DO

• Lua API - Using Lua programming

Dependencies

• libubox
• ustream-ssl - If you need to support SSL
• mbedtls - If you choose mbedtls as your SSL backend
• CyaSSl(wolfssl) - If you choose wolfssl as your SSL backend
• openssl - If you choose openssl as your SSL backend

Configure

See which configuration are supported

~/libuhttpd/$ mkdir build && cd build
~/libuhttpd/build$ cmake .. -L
~/libuhttpd/build$ cmake .. -LH

Build and install

~/libuhttpd/build$ make && sudo make install

Run Example

Run

~/libuhttpd/build$ ./example/helloworld

Then use the command curl or browser to test

$ curl -k 'https://127.0.0.1:8000/hello?name=test' -d '{"name":"libuhttpd"}' -v

How to use on OpenWRT

add new feed into "feeds.conf.default":

src-git libuhttpd https://github.com/zhaojh329/libuhttpd-feed.git

Install libuhttpd packages:

./scripts/feeds update libuhttpd
./scripts/feeds install -a -p libuhttpd

Select package libuhttpd in menuconfig and compile new image.

Libraries  --->
    Networking  --->
        <*> libuhttpd-mbedtls.................................... libuhttpd (mbedtls)
        < > libuhttpd-nossl....................................... libuhttpd (NO SSL)
        < > libuhttpd-openssl.................................... libuhttpd (openssl)
        < > libuhttpd-wolfssl.................................... libuhttpd (wolfssl)

Example

#include <uhttpd.h>

static void hello_action(struct uh_client *cl)
{
    int body_len = 0;

    cl->send_header(cl, 200, "OK", -1);
    cl->append_header(cl, "Myheader", "Hello");
    cl->header_end(cl);

    cl->chunk_printf(cl, "<h1>Hello Libuhttpd %s</h1>", UHTTPD_VERSION_STRING);
    cl->chunk_printf(cl, "<h1>REMOTE_ADDR: %s</h1>", cl->get_peer_addr(cl));
    cl->chunk_printf(cl, "<h1>URL: %s</h1>", cl->get_url(cl));
    cl->chunk_printf(cl, "<h1>PATH: %s</h1>", cl->get_path(cl));
    cl->chunk_printf(cl, "<h1>QUERY: %s</h1>", cl->get_query(cl));
    cl->chunk_printf(cl, "<h1>VAR name: %s</h1>", cl->get_var(cl, "name"));
    cl->chunk_printf(cl, "<h1>BODY:%s</h1>", cl->get_body(cl, &body_len));
    cl->request_done(cl);
}

static void usage(const char *prog)
{
    fprintf(stderr, "Usage: %s [option]\n"
        "          -p port  # Default port is 8080\n"
        "          -s       # SSl on\n"
        "          -v       # verbose\n", prog);
    exit(1);
}

int main(int argc, char **argv)
{
    struct uh_server *srv = NULL;
    int verbose = false;
    int ssl = false;
    int port = 8080;
    int opt;

    while ((opt = getopt(argc, argv, "p:vs")) != -1) {
        switch (opt)
        {
        case 'p':
            port = atoi(optarg);
            break;
        case 's':
            ssl = true;
            break;
        case 'v':
            verbose = true;
            break;
        default: /* '?' */
            usage(argv[0]);
        }
    }

    if (!verbose)
        ulog_threshold(LOG_ERR);
    
    uh_log_debug("libuhttpd version: %s", UHTTPD_VERSION_STRING);

    uloop_init();

    srv = uh_server_new("0.0.0.0", port);
    if (!srv)
        goto done;

#if (!UHTTPD_SSL_SUPPORT)
    if (ssl)
        uh_log_debug("SSl is not compiled in");
#else
    if (ssl && srv->ssl_init(srv, "server-key.pem", "server-cert.pem") < 0)
        goto done;
#endif

    uh_log_debug("Listen on: %s *:%d", srv->ssl ? "https" : "http", port);

    srv->add_action(srv, "/hello", hello_action);
    
    uloop_run();
done:
    uloop_done();
    srv->free(srv);
    
    return 0;
}

Contributing

If you would like to help making libuhttpd better, see the CONTRIBUTING.md file.