gemini server written in C used with inetd
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Solene Rapenne 365e99400a Support all other BSD ! <3 7 months ago
tests percent-decoding 7 months ago
LICENSE Bump LICENSE to include 2021 8 months ago
Makefile Add a configure script to make compiling on Linux easier 7 months ago
README.md Add a configure script to make compiling on Linux easier 7 months ago
config.mk Add a configure script to make compiling on Linux easier 7 months ago
main.c Merge branch 'master' of tildegit.org:solene/vger 7 months ago
mimes.c add mimetype and autoindex option + minor changes 9 months ago
mimes.h add mimetype and autoindex option + minor changes 9 months ago
opts.h Add simple cgi support +: 9 months ago
utils.c Support all other BSD ! <3 7 months ago
utils.h Add simple cgi support +: 9 months ago
vger.8 Rewording 8 months ago

README.md

A simplistic and secure Gemini server

Vger is a gemini server supporting chroot, virtualhosts, CGI, default language choice, redirections and MIME types detection.

Vger design is relying on inetd and a daemon to take care of TLS. The idea is to delegate TLS and network to daemons which proved doing it correctly, so vger takes its request from stdin and output the result to stdout.

The average setup should look like:

         client
           ↓           TCP request on port 1965
       relayd or haproxy
       or stunnel on inetd
           ↓           TCP request to a port of choice on localhost
       vger on inetd

Vger is perfectly secure if run on OpenBSD, using unveil() the filesystem access is restricted to one directory (default to /var/gemini/) and with pledge() only systems calls related to reading files and reading input/output are allowed. More explanations about Vger security can be found on this link.

For all supported OS, it's possible to run Vger in a chroot and drop privileges to a dedicated user.

Install

git clone https://tildegit.org/solene/vger.git
cd vger
./configure (only really useful for Linux)
make
doas make install

On GNU/Linux, make sure you installed libbsd, it has been reported that using clang was required too.

Running tests

Vger comes with a test suite you can use with make test.

Some files under /var/gemini/ are required to test the code path without a -d parameter.

Command line parameters

Vger has a few parameters you can use in inetd configuration.

  • -d PATH: use PATH as the data directory to serve files from. Default is /var/gemini
  • -l LANG: change the language in the status return code. Default is no language specified.
  • -v: enable virtualhost support, the hostname in the query will be considered as a directory name.
  • -u username: enable chroot to the data directory and drop privileges to username.
  • -m MIME : use MIME as default instead of "application/octet-stream".
  • -i : Enable auto index if no "index.gmi" file is found in a directory.
  • -c CGI_PATH : files in CGI_PATH are executed and their output is returned to the client.

How to configure Vger using relayd and inetd

Create directory /var/gemini/ (I'd allow this to be configured later), files will be served from there.

Create an user gemini_user.

Add this line to inetd.conf:

127.0.0.1:11965 stream tcp nowait gemini_user /usr/local/bin/vger vger

Add this to relayd.conf

log connection
tcp protocol "gemini" {
    tls keypair hostname.example
}

relay "gemini" {
    listen on hostname.example port 1965 tls
    protocol "gemini"
    forward to 127.0.0.1 port 11965
}

Make sure certificates files match hostname: /etc/ssl/private/hostname.example.key and /etc/ssl/hostname.example.crt.

On OpenBSD, enable inetd and relayd and start them:

# rcctl enable relayd inetd
# rcctl start relayd inetd

Don't forget to open the TCP port 1965 in your firewall.

Vger will serve files named index.gmi if no explicit filename is given. If this file doesn't exist and auto index is enabled, an index file with a link to every file in the directory will be served.