.gitignorecommits | blame
ChangeLogcommits | blame
Dockerfilecommits | blame
LICENSEcommits | blame
Makefilecommits | blame
README.mdcommits | blame
configure*commits | blame
ex.ccommits | blame
gg.1commits | blame
gg.ccommits | blame
gmid.1commits | blame
gmid.ccommits | blame
gmid.hcommits | blame
iri.ccommits | blame
lex.lcommits | blame
mime.ccommits | blame
parse.ycommits | blame
sample.confcommits | blame
sandbox.ccommits | blame
server.ccommits | blame
utf8.ccommits | blame

# gmid

> dead simple, zero configuration Gemini server

gmid is a simple and minimal Gemini server.  It can run without
configuration, so it's well suited for local development, but at the
same time has a configuration file flexible enough to meet the
requirements of most capsules.

gmid was initially written to serve static files, but can also
optionally execute CGI scripts.  It was also written with security in
mind: on Linux, FreeBSD and OpenBSD is sandboxed via `seccomp(2)`,
`capsicum(4)`and `pledge(2)`+`unveil(2)` respectively.

## Features

 - IRI support (RFC3987)
 - dual stack: can serve over both IPv4 and IPv6
 - CGI scripts
 - (very) low memory footprint
 - small codebase, easily hackable
 - virtual hosts
 - sandboxed by default on OpenBSD, Linux and FreeBSD

## Drawbacks

 - not suited for very busy hosts.  If you receive an high number of
   connection per-second you'd probably want to run multiple gmid
   instances behind relayd/haproxy or a different server.

## Building

gmid depends on a POSIX libc and libtls (provided either by LibreSSL
or libretls).  At build time, flex and yacc (or GNU bison) are also

The build is as simple as


If the configure scripts fails to pick up something, please open an
issue or notify me via email.

To install execute:

    make install

If you have trouble installing LibreSSL or libretls, as they aren't
available as package on various Linux distribution, you can use Docker
to build a `gmid` image with:

    docker build -t gmid .

and then run it with something along the lines of

    docker run --rm -it -p 1965:1965 \
        -v /path/to/cert.pem:...:ro \
        -v /path/to/key.pem:...:ro \
        -v /path/to/docs:/var/gemini \
        gmid -f -d /var/gemini -K ... -C ...

ellipses used for brevity.

### Local libretls

This is **NOT** recommended, please try to port LibreSSL/LibreTLS to
your distribution of choice or use docker instead.

However, it's possible to link `gmid` to locally-installed libtls
quite easily.  (It's how I test gmid on Fedora, for instance)

Let's say you have compiled and installed libretls in `$LIBRETLS`,
then you can build `gmid` with

    ./configure CFLAGS="-I$LIBRETLS/include" \
                LDFLAGS="$LIBRETLS/lib/libtls.a -lssl -lcrypto -lpthread"

### Testing


    make regress

to start the suite.  Keep in mind that the suite will create files
inside the `regress` directory and bind the 10965 port.

## Architecture/Security considerations

gmid is composed by two processes: a listener and an executor.  The
listener process is the only one that needs internet access and is
sandboxed.  When a CGI script needs to be executed, the executor
(outside of the sandbox) sets up a pipe and gives one end to the
listener, while the other is bound to the CGI script standard output.
This way, is still possible to execute CGI scripts without restriction
even in the presence of a sandbox.

On OpenBSD, the listener process runs with the `stdio recvfd rpath
inet` pledges and has `unveil(2)`ed only the directories that it
serves; the executor has `stdio sendfd proc exec` as pledges.

On FreeBSD, the executor process is sandboxed with `capsicum(4)`.

On Linux, a `seccomp(2)` filter is installed to allow only certain
syscalls, see [sandbox.c](sandbox.c) for more information on the BPF

In any case, you are invited to run gmid inside some sort of