httkey-server

httkey

httkey is a simple web server that serves static files but with a twist. The host and path of an incoming HTTP request are hashed and the result of this is used to determine the file to serve. httkey was in part inspired by Google's SFFE (Static File Front End) web server.

Design Specification

• Binaries should be statically-linked with any assets (e.g. error pages) embedded.
• Files should be served from a single directory. There should be no sub-hierarchy.
• The hash should be a 128-bit MurmurHash3 of the request path, seeded with the contents of the Host header.
• If a file exists with a name that matches the output of the hash and the request method is GET then we should serve it.
• If a file exists but the requests method is not GET then we should serve a 405 error page.
• If a file does not exist then we should serve a 404 error page.

Build

To compile httkey you can run the following in a terminal. This will produce 64-bit binaries for Windows and macOS in addition to Linux binaries for the arm, arm64, i386 and amd64 architectures.

make clean && make build

Quickstart

This quick example demonstrates how you can deploy a static MTA-STS policy (RFC 8461) using httkey:

$ httkey hash https://mta-sts.example.com/.well-known/mta-sts.txt
https://mta-sts.example.com/.well-known/mta-sts.txt: 1078522949910736262516577261162986308780

$ cat <<END > /tmp/1078522949910736262516577261162986308780
version: STSv1
mode: enforce
mx: mail.example.com
max_age: 86400
END

$ httkey serve -p /tmp

And in a different terminal tab:

$ curl --resolve mta-sts.example.com:8080:127.0.0.1 https://mta-sts.example.com:8080/.well-known/mta-sts.txt
version: STSv1
mode: enforce
mx: mail.example.com
max_age: 86400

Usage

Usage:
  httkey [command]

Available Commands:
  hash        Hash a URL
  help        Help about any command
  serve       Run web server
  version     Print version information

Use "httkey [command] --help" for more information about a command.

Copyright

Copyright (c) 2021 Charlie Jonas.
The code here is released under the BSD 2-Clause License.
See the LICENSE file for full details.