libuhttpd/README.md

libuhttpd(中文)

A very tiny and fast 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.
• tiny and fast
• use libubox as its event backend
• support HTTPS: OpenSSL, mbedtls and CyaSSl(wolfssl)
• flexible and you can easily extend your application to have HTTP/HTTPS services
• code structure is concise and understandable, also suitable for learning

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

Build Example

~/libuhttpd/build$ cd ../example
~/libuhttpd/example$ mkdir build && cd build
~/libuhttpd/example/build$ cmake .. && make

Run Example

First generate the SSL certificate file

~/libuhttpd/example/build$ cd ..
~/libuhttpd/example$ ./gen_cert.sh

Run

~/libuhttpd/example$ ./build/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

Example

#include <uhttpd.h>

#define port "8000"

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>PATH: %s</h1>", cl->get_path(cl));
    cl->chunk_printf(cl, "<h1>QUERY: %s</h1>", cl->get_query(cl));
    cl->chunk_printf(cl, "<h1>BODY:%s</h1>", cl->get_body(cl, &body_len));
    cl->request_done(cl);
}

int main(int argc, char **argv)
{
    struct uh_server *srv = NULL;
    
    uh_log_debug("libuhttpd version: %s", UHTTPD_VERSION_STRING);

    uloop_init();

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

    uh_log_debug("Listen on: *:%s", port);

#if (UHTTPD_SSL_SUPPORT)
    if (srv->ssl_init(srv, "server-key.pem", "server-cert.pem") < 0)
        goto done;
#endif

    uh_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.