Skip to content
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update documentation for web key directory support
  • Loading branch information
pravi committed Jun 2, 2024
commit 72bf97b856eba9e2e70e87b8471b599cdad46525
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,13 +50,38 @@ The HKP APIs are not documented here. Please refer to the [HKP specification](ht

#### Accepted `options` parameters
* mr
* wkd

### Web Key Directory support

Web Key Directory support can be enabled by adding a rewrite rule to web server
configured as a reverse proxy.

Example configuration for caddy webserver (for example.com domain),

```
openpgpkey.example.com {
header /.well-known/openpgpkey/puri.sm/policy Content-Type text/plain
respond /.well-known/openpgpkey/puri.sm/policy `protocol-version 5`
route /.well-known/openpgpkey/example.com/hu/* {
rewrite * /pks/lookup?op=get&{query}%40example.com&options=mr
reverse_proxy localhost:3000
}
}

openpgpkey.example.com DNS records should be pointing to the mailvelope
keyserver instance.
```
#### Usage example with GnuPG

```
gpg --keyserver hkps://keys.mailvelope.com --search info@mailvelope.com
```

If Web Key Directory is enabled,
```
gpg --locate-keys info@mailvelope.com
```
## REST API

### Lookup a key
Expand Down