wkdhash 0.1.0

Calculate WKD (Web-Key-Directory) UID Hashes for OpenGPG UIDs

wkdhash

Calculate Web-Key-Directory hashes of OpenPGP UIDs.

The Web-Key-Directory (WKD) is a method for deploying OpenPGP public keys for an email address through HTTPS.

For this, the keys user IDs are decomposed into their mailbox local part (the thing before the @ sign). This is then sha1 hashed and z-base-32 encoded, resulting in the "hu" (hashed user-id, I guess?).

The public key is then made available under a well-known URL containing the hu. So to deploy your public key to your webserver, you have to figure out what your uid's hu is. This can be done with

gpg --list-keys --with-wkd-hash $IDENTITY

but it is not easily doable from Python when using python-gnupg.

API

A single function is the only thing you really need:

from wkdhash import userid_to_wkd_hash

assert(userid_to_wkd_hash("[e-mail]") == "dizb37aqa5h4skgu7jf1xjr4q71w4paq")
assert(userid_to_wkd_hash("Test User <[e-mail]>", include_domain=True) == "[e-mail]")

Command-line-utility

A simple command line utility entry-point is provided by this package, which reads user IDs from an input stream (default stdin) and writes the hu to an output stream (default stdout). So this module can also be used for bash scripting.

usage: wkdhash [-h] [-F] [-o outfile] [infile]

Read OpenPGP User IDs line-by-line and print their corresponding Web-Key-Directory hashed-user-id (hu).

positional arguments:
  infile                Input OpenPGP UserID, defaults to stdin

options:
  -h, --help            show this help message and exit
  -F, --full            If set, output 'hu@domain', instead of just 'hu'
  -o, --output outfile  Output, default stdout

MIT License, Copyright (c) 2025 Gregor Vollmer

Example Usage

$ echo "[e-mail]" | poetry run wkdhash
dizb37aqa5h4skgu7jf1xjr4q71w4paq
$ echo "Test User <[e-mail]>" | poetry run wkdhash -F
[e-mail]
$ poetry run wkdhash
[e-mail]^Ddizb37aqa5h4skgu7jf1xjr4q71w4paq