Skip to content

Commit f9cb8ac

Browse files
committed
Update documentation for web key directory support
1 parent 9f5e3f6 commit f9cb8ac

File tree

1 file changed

+25
-0
lines changed

1 file changed

+25
-0
lines changed

README.md

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,13 +50,38 @@ The HKP APIs are not documented here. Please refer to the [HKP specification](ht
5050

5151
#### Accepted `options` parameters
5252
* mr
53+
* wkd
5354

55+
### Web Key Directory support
56+
57+
Web Key Directory support can be enabled by adding a rewrite rule to web server
58+
configured as a reverse proxy.
59+
60+
Example configuration for caddy webserver (for example.com domain),
61+
62+
```
63+
openpgpkey.example.com {
64+
header /.well-known/openpgpkey/puri.sm/policy Content-Type text/plain
65+
respond /.well-known/openpgpkey/puri.sm/policy `protocol-version 5`
66+
route /.well-known/openpgpkey/example.com/hu/* {
67+
uri strip_prefix /.well-known/openpgpkey/example.com/hu/
68+
rewrite * /pks/lookup?op=get&search={uri}%40example.com&options=wkd
69+
reverse_proxy localhost:3000
70+
}
71+
}
72+
73+
openpgpkey.example.com DNS records should be pointing to the mailvelope keyserver.
74+
```
5475
#### Usage example with GnuPG
5576

5677
```
5778
gpg --keyserver hkps://keys.mailvelope.com --search info@mailvelope.com
5879
```
5980

81+
If Web Key Directory is enabled,
82+
```
83+
gpg --locate-keys info@mailvelope.com
84+
```
6085
## REST API
6186

6287
### Lookup a key

0 commit comments

Comments
 (0)