Mirrors/keyoxide-web
1
0
Fork 1
mirror of https://codeberg.org/keyoxide/keyoxide-web.git synced 2024-12-22 23:09:29 -07:00
Code Issues Projects Releases Packages Wiki Activity

Add guide

Browse source
This commit is contained in:
Yarmo Mackenbach 2020-06-29 21:14:25 +02:00
parent 32b8d58bd6
commit 94d40b6e72
3 changed files with 37 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
pages/guides.html
View file

@ -33,7 +33,7 @@
<h3>Beyond Keyoxide.org</h3>
<a href="/guides/openpgp-proofs">How OpenPGP identity proofs work</a><br>
<!-- <a href="/guides/web-key-directory">Uploading your keys using web key directory</a><br> -->
<a href="/guides/web-key-directory">Uploading keys using web key directory</a><br>
<!-- <a href="/guides/upload-to-openpgp">Uploading your keys to keys.openpgp.org</a><br> -->
<a href="/guides/selfhosting-keyoxide">Selfhosting Keyoxide</a><br>

35
pages/guides/web-key-directory.content.html Normal file
View file

@ -0,0 +1,35 @@
<h3>Web key directory</h3>
<p><a href="https://datatracker.ietf.org/doc/draft-koch-openpgp-webkey-service/">Web key directory</a> or WKD refers to the method of uploading one's public key to their website in a specific location to make it easily accessible by other services supporting WKD. The key will be discoverable using an identifier similar to an email address: <strong>username@domain.org</strong>.</p>
<p>The benefit of WKD is having full control over the key while still having it widely available. It does however require a domain and some form of file hosting. Luckily, <a href="https://keys.openpgp.org/about/usage#wkd-as-a-service">openpgp.org</a> have made a WKD-as-a-service. Read more at the end of the guide.</p>
<p>It exists in two variants: the Direct setup and the Advanced setup. Despite their names, both require roughly the same steps.</p>
<h3>The Direct setup</h3>
<p>To make your keys available via WKD using the Direct setup, you'll need two paths on your server:</p>
<p><strong>https://domain.org/.well-known/openpgpkey/policy</strong>: this is an empty file</p>
<p><strong>https://domain.org/.well-known/openpgpkey/hu/LOCALPART</strong>: this is the binary public key (so NOT ASCII armored)</p>
<p>The LOCALPART above is actually the username hashed using the SHA-1 algorithm and encoded using the Z-Base-32 method. As it's not humanly possible to compute this by ourselves, Keyoxide provides a <a href="/util/wkd">small utility to do this for you</a>.</p>
<p>So if you wish to make your key available as <strong>jimothy@dm.com</strong>, according to the <a href="/util/wkd">small utility</a>, the URL would become:</p>
<code>https://dm.com/.well-known/openpgpkey/hu/n9utc41qty791upt63rm5xtiudabmw6m</code>
<h3>The Advanced setup</h3>
<p>While not necessary if the Direct setup works, there is a second setup to make WKD work: the Advanced setup. The paths needed are:</p>
<p><strong>https://openpgpkey.domain.org/.well-known/openpgpkey/policy</strong>: this is an empty file</p>
<p><strong>https://openpgpkey.domain.org/.well-known/openpgpkey/domain.org/hu/LOCALPART</strong>: this is the binary public key (so NOT ASCII armored)</p>
<p>Indeed, quite similar to the Direct setup, except for the <strong>openpgpkey</strong> subdomain and the additional <strong>domain.org</strong> in the path of the public key.</p>
<p>The public key for <strong>jimothy@dm.com</strong> would be available at:</p>
<code>https://openpgpkey.dm.com/.well-known/openpgpkey/hu/dm.com/n9utc41qty791upt63rm5xtiudabmw6m</code>
<h3>WKD-as-a-service</h3>
<p>In case hosting is problem, Openpgp.org has a handy <a href="https://keys.openpgp.org/about/usage#wkd-as-a-service">WKD-as-a-service</a>.</p>

1
pages/guides/web-key-directory.title.html Normal file
View file

@ -0,0 +1 @@
Uploading keys using web key directory