gemini client written in C
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.
 
 
 
 
Florian Obser fa328268e2 No need to copy path to a local buffer, use it directly. 11 months ago
tests Add a check for OpenBSD unveil() 11 months ago
LICENSE Move the license from the code to dedicated LICENSE file 11 months ago
Makefile Do not include c sources 11 months ago
README.md Enhance README with install instructions and tell about chroot for everyone 11 months ago
main.c No need to copy path to a local buffer, use it directly. 11 months ago
mimes.c Return a constant string from the mimes database. 11 months ago
mimes.h Return a constant string from the mimes database. 11 months ago
vger.8 Document exit status in man page 11 months ago

README.md

A simplistic and secure Gemini server

Vger is a gemini server supporting chroot, virtualhosts, default language choice 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.

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
make
sudo make install

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 en
  • -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.

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.

Add this line to inetd.conf:

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

Add this to relayd.conf

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

Make links to the certificates and key files according to relayd.conf documentation

# ln -s /etc/ssl/acme/cert.pem /etc/ssl/hostname.example\:1965.crt
# ln -s /etc/ssl/acme/private/privkey.pem /etc/ssl/private/hostname.example\:1965.key

On OpenBSD, enable inetd and relayd and start them:

# rcctl enable relayd inetd
# rcctl start relayd inetd