|
Size: 4750
Comment: Document simple WKD setup with generate-openpgpkey-hu
|
Size: 9086
Comment: removed information about Posteo that could be misunderstood
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| = Much easier Email crypto, by fetching pubkey via HTTPS | <<TableOfContents(2)>> |
| Line 3: | Line 3: |
| == How does it work? As an email user, you just select the recipient(s) and can see that the email will be encrypted. |
== What is a Web Key Directory? |
| Line 6: | Line 5: |
| If you and your peers use email-providers offering this "web key service", it works by the first email. Otherwise encryption will start after you have exchanged some emails. |
A Web Key Directory (WKD) provides an easy way to provide and get the current public key for a given email address through H~T~T~P~S. Thus it is infrastructure **to improve the user experience for exchanging secure emails and files**. Because the email address is needed to ask for a public key, using a Web Key Directory preserves the privacy of this address. If a public key is found, it can be used to encrypt to the email address right away. == for Users * [[/forUsers]] |
| Line 10: | Line 20: |
| Technically your email client will automatically * prepare for this by creating a crypto key for you and uploading it to your provider (or second best to public keyservers). * sign all emails so others see that you are ready for crypto (unless you opt out) * ask the mail provider of your recipients for their pubkeys. |
== How does an email client use WKD? |
| Line 16: | Line 22: |
| An email-provider offering the "web key service" technically has to * provide a pubkey for users via ~HT~TPS * allow each user's email client to automatically manage the pubkey that gets published by email. |
# A user selects a recipient for an email. # The email client uses the domain part of the email address to construct which server to ask. # HTT~PS is used to get the current public key. # The email client is ready to encrypt and send now. An example: {{{https://intevation.de/.well-known/openpgpkey/hu/it5sewh54rxz33fwmr8u6dy4bbz8itz4}}} is the //direct method// URL for "bernhard.reiter@intevation.de". |
| Line 21: | Line 32: |
| == What does it mean for users? | |
| Line 22: | Line 34: |
| == Details / Discussion of the proposal | A user just selects the recipients of a message and by default the encryption state of that mail will toggle if encryption keys can be found for all of them. |
| Line 24: | Line 38: |
| **[[EasyGpg2016/PubkeyDistributionConcept|Pubkey Distribution Concept]] <- the (technical) details** | [[https://files.intevation.de/users/aheinecke/wkd-autoencrypt.gif|Example from Gpg4win / GpgOL]] |
| Line 26: | Line 40: |
| * 2016-09-08 ~OpenPGP.conf presentation by Werner Koch: [[https://www.openpgp-conf.org/program.html#werner|Abstract]] [[https://www.openpgp-conf.org/2016/openpgp-2016-simple-key-discovery.pdf|Slides.PDF]] * 2016-09-08 ~OpenPGP.conf presentation by Bernhard Reiter, pages 21-24 [[https://www.intevation.de/~bernhard/presentations/201609-openpgpconf/20160908-3bsi-contracts.odp|Slides.ODP]] [[https://www.intevation.de/~bernhard/presentations/201609-openpgpconf/20160908-3bsi-contracts.pdf|Slides.PDF]] * 2016-09-09 //[[http://www.golem.de/news/web-key-service-openpgp-schluessel-ueber-https-verteilen-1609-123194.html|OpenPGP-Schlüssel über HTTPS verteilen]]// Golem news by Hanno Böck * 2016-09-11 //[[https://www.heise.de/newsticker/meldung/Spezifikation-fuer-die-Verteilung-von-OpenPGP-Keys-per-HTTPS-veroeffentlicht-3317914.html|Spezifikation für die Verteilung von OpenPGP-Keys per HTTPS veröffentlicht]]// Heise news by Johannes Merkert * 2016-09-11 //[[http://lists.gnupg.org/pipermail/gnupg-de/2016-September/000547.html|Anmerkungen zum Web Key Service]]// gnupg-de@ by Werner Koch * 2016-10-05 Draft 02 of the specs published (see details page linked above). |
For a basic level of security the user does **not need to check a fingerprint** or do any key management manually. |
| Line 39: | Line 43: |
| The elaborated proposal is a result of the EasyGpg2016 contract. | == How to set it up? If you want to set up a Web Key Directory for your own server or your own server you only need access to a webserver for your domain. See: WKDHosting For a larger organization it is recommended to set up a complete Web Key Service, which will help to automate Web Key Directory publishing. === Stopgap method - temporary central keyserver Not recommended - but a temporary workaround - is to use "WKD~aaS" and delegate delivery of your pubkey to a central service. Doing this you'll expose all people that want to use crypto when communication with you towards another party of the central service or monitoring the central service. This third party can then see the communication pattern. However this maybe a temporary solution until you will convince your mail provider to enable at least the WKD serving part or to switch to a more privacy aware mail provider. One service is keys.openpgp.org, where you can set the ~C~N~A~M~E record of the "openpgpkey" subdomainto "wkd.keys.openpgp.org" the CNAME entry should look like this. {{{ openpgpkey.example.org. 300 IN CNAME wkd.keys.openpgp.org. }}} In addition you need to register your pubkey with them. Other drawbacks: * As any WKD service, they'll be able to serve a different pubkey to some domains at some time, however opposed to your email provider you do not have a contractual relationship with them. * Elder Gnu~PGs like the some on Debian Stretch do not offer the necessary modern WKD implementation for a successful request, so you are reaching less communication partners with this compared to real WKD. * (For the overall ecosystem, we need more decentral services instead, it is at the core of Open~PGP security promise. So you are missing to set a good example. ;) ) == Web Key Directory (WKD) / Web Key Service (WKS) what is the difference? The Web Key Directory is the H~T~T~P~S directory from which keys can be fetched. The Web Key Service is a tool / protocol to automatically publish and update keys in the Web Key Directory. It is **optional** to reduce the administrative effort of a Web Key Directory. Documentation how to set up a Web Key Service can be found on the [[WKS|Web Key Service page]]. == Technical Details You can find the concepts / technical details under WKDDetails. Trust and security considerations are outlined as part of the AutomatedEncryption concept. === Troubleshooting If you have arrived here after receiving an email saying: {{{ The web page https://gnupg.org/faq/wkd.html explains how you can process this message anyway in a few manual steps. }}} you can find further instructions at WKSManualConfirmation. |
| Line 43: | Line 108: |
| === GnuPG "modern" * WKD lookup experimental since v2.1.12 * WKS server and client experimental tools since v2.1.14, see //[[https://gnupg.org/blog/20160830-web-key-service.html|how to run them in GnuPG's blog vom 2016-08-30]]// or the [[WKS|Web Key Service page]]. |
=== GnuPG * WKD lookup is implemented in GnuPG since v2.1.12. It is enabled by default since 2.1.23.. |
| Line 48: | Line 111: |
| === Mail User Agents * planned Kontact Mail/KMail support (part of EasyGpg2016) * planned Thunderbird support (part of EasyGpg2016) |
* WKS server and client tools are part of GnuPG since v2.1.14 |
| Line 52: | Line 113: |
| === Mail Service Providers * (planned for Sep/Okt 2016) [[https://posteo.de/en/|Posteo]] offering full implementation of "web key service". Posteo already implemented provisioning of pubkeys via HT~TPS. * (gnupg.org) Testing accounts by request for developers implementing WKS in Free Software MUAs. |
=== Mail Clients |
| Line 58: | Line 115: |
| Any mail client which uses the {{{--locate-keys}}} option of GnuPG will automatically do WKD requests. |
|
| Line 59: | Line 118: |
| == Hosting a Web Key Directory | Known mail clients with WKD Support: * Desktop: ** Thunderbird/[[https://www.enigmail.net/index.php/en/download/changelog|Enigmail 2.0]] ** KMail since Version 5.6 ** Outlook with GpgOL since Version 2.2.0 ** Claws Mail since [[https://www.claws-mail.org/news.php|3.18.0 / 4.0.0]] ** Balsa has no official release - which is supporting WKD - yet but the feature was [[https://gitlab.gnome.org/GNOME/balsa/-/commit/03272a0e053002c7b5cf53d3dc8f87229b8552a4|merged]] into the main branch * Browser-Extensions: ** Mailvelope since Version 3.0.0 (Dez 2018) * Android: ** [[https://k9mail.app/|K9Mail]] with OpenKeyChain since Version 5.1 (Jun 2018) ** [[https://email.faircode.eu/|FairEmail]] with OpenKeyChain since OpenKeyChain 5.4 ([[https://github.com/M66B/FairEmail/blob/master/FAQ.md#user-content-faq12|FAQ, (12) How does encryption/decryption work?]]) |
| Line 61: | Line 131: |
| Ideally a Web Key Directory will be created and maintained through a Web Key Service but organisations or individuals may want to just host a Web Key Directory without a Web Key Service.: |
[[/DistributionOfWKD|Progress of WKD]] in different mail clients |
| Line 65: | Line 133: |
| === Requirements | Known mail clients with WKS Support: * Thunderbird/[[https://www.enigmail.net/index.php/en/download/changelog|Enigmail 2.0]] * KMail since Version 5.6 * Outlook with GpgOL (basic, pre-release) since Version 2.2.1 asyGpg2016) |
| Line 67: | Line 139: |
| * A web server that provides https with a trusted certificate. * A client machine with python and pyme installed (debian package python-pyme) * The script: [[attachment:generate-openpgpkey-hu|generate-openpgpkey-hu]] |
=== Self-hosted email setups offering WKD + WKS: * [[https://github.com/vedetta-com/caesonia/|caesonia - OpenBSD email service]]. * [[https://github.com/Excision-Mail/Excision-Mail/| Excision Mail - OpenBSD email service using ansible]]: Has multiple-domain WKS support. * [[https://github.com/systemli/userli|Userli - Web application to (self-) manage e-mail users and encrypt their mailboxes.]]. |
| Line 71: | Line 144: |
| === Usage | === Mail Service Providers offering WKD * [[https://posteo.de/en/|Posteo]] offers web key directory lookup and service for {{{@posteo.de}}}-addresses (**Since 2016-12**) ** [[https://posteo.de/en/help/publishing-public-pgp-key-for-posteo-email-address|How do I publish the public PGP key for my Posteo email address in the Posteo key directory?]] * [[https://protonmail.com|Protonmail]] supports web key directory lookup (**Since ~2018-11**) in [[https://protonmail.com/blog/security-updates-2019/|both ways]]. * [[https://netzguerilla.net|netzguerilla]] offers web key directory lookup. (**Since 2017-10-11**) * [[https://systemli.org|systemli.org]] offers web key directory lookup and service for all hosted domains (**Since 2020-10-15**) * [[https://mailbox.org/en/|mailbox.org]] **claims** to offer web key directory lookup ** See announcement https://mailbox.org/en/post/the-keyserver-is-dead-long-live-the-keyserver 2019 ** In the forum in 2021 a question (German) was asked when WKD would be offered. The thread was deleted but you can find it via the Internet Archive: https://web.archive.org/web/20211019060747/https://userforum.mailbox.org/topic/wann-wird-ein-web-key-directory-wkd-angeboten ** At least the Open~PGP key for the [[https://mailbox.org/de/impressum|privacy mail address]] of mailbox.org can be found via: *** Direct Method: https://mailbox.org/.well-known/openpgpkey/hu/15siaihjsf4kyfkzxrqe7r5gqqzr5f39?l=privacy *** Advanced Method: https://openpgpkey.mailbox.org/.well-known/openpgpkey/mailbox.org/hu/15siaihjsf4kyfkzxrqe7r5gqqzr5f39?l=privacy ** The command {{{ gpg-wks-client --with-colons --supported mailbox.org }}} also gives a positive result * [[https://mail.de/|mail.de]] maintains a WKD server (Screenshot: [[attachment:mailde_wkd.png]]) * [[https://mailfence.com/|Mailfence]] supports web key directory lookup (**Since ~2021-11-18**) in [[https://blog.mailfence.com/improving-security/|both ways]]. |
| Line 73: | Line 160: |
| You can either export all the keys in your keyring which belong to a domain or provide an explicit keyring containing the keys you want to publish. |
=== Organizations using WKD |
| Line 76: | Line 162: |
| The call: {{{ ./generate-openpgpkey-hu example.com hu }}} |
* [[https://www.c3s.cc|C3S]] * [[https://www.credativ.de/blog/aktuelles/credativde-pgp-schluessel-ueber-wkd-abrufen/|Credativ GmbH, DE]] * [[https://www.debian.org|debian.org]] * [[https://gentoo.org|gentoo.org]] * [[https://gnupg.org|gnupg.org]] (Testing accounts available for developers implementing WKD in ~MUAs.) * [[https://kdab.com|KDAB.com]] * [[https://kernel.org|kernel.org]] * [[https://nikkasystems.com|Nikka Systems]] * [[https://www.occrp.org|occrp.org]] * [[https://www.torproject.org|torproject.org]] * [[https://f-droid.org|f-droid.org]] * [[https://guardianproject.info|guardianproject.info]] * [[https://www.privacyguides.org|privacyguides.org]] * [[https://univention.de/wkd/|Univention GmbH]] * (Several unlisted organisations. And of course the main designers of WKD - g10code.com, intevation.de.) |
| Line 81: | Line 178: |
| Will create a directory called hu containing all the keys with @example.com mail addresses. |
(//Add yourself or let us know if you want to be publicly listed.//) |
| Line 84: | Line 180: |
| If there are multiple valid keys for a user in your keyring this command will error out. In that case you can prepare a keyring with only the keys you want to publish. e.g.: {{{ gpg --export 94A5C9A03C2FE5CA3B095D8E1FDF723CF462B6B1 | \ gpg --no-default-keyring --keyring ./wkd-keyring.gpg --import }}} And then provide that keyring to generate-openpgpkey-hu: {{{ ./generate-openpgpkey-hu example.com hu }}} === Publishing The hu directory you can then publish on your server under {{{.well-known/openpgpkey/hu}}} On your server cerate the according directory and set the permissions according to your system. This [[attachment:Makefile|Makefile]] automates the hu directory generation and publishing. Edit the variables at the top of the makefile to your {{{RSYNC_TARGET}}} The {{{KEYRING}}} variable is optional and can be empty. |
== Misc * [[/BachelorThesisIncreaseWKDUsage2021|Bachelor thesis: How to increase the usage of WKD? (2021, Christoph Klassen)]] |
Contents
What is a Web Key Directory?
A Web Key Directory (WKD) provides an easy way to provide and get the current public key for a given email address through HTTPS. Thus it is infrastructure to improve the user experience for exchanging secure emails and files.
Because the email address is needed to ask for a public key, using a Web Key Directory preserves the privacy of this address. If a public key is found, it can be used to encrypt to the email address right away.
for Users
How does an email client use WKD?
- A user selects a recipient for an email.
- The email client uses the domain part of the email address to construct which server to ask.
- HTTPS is used to get the current public key.
- The email client is ready to encrypt and send now.
An example: https://intevation.de/.well-known/openpgpkey/hu/it5sewh54rxz33fwmr8u6dy4bbz8itz4 is the direct method URL for "bernhard.reiter@intevation.de".
What does it mean for users?
A user just selects the recipients of a message and by default the encryption state of that mail will toggle if encryption keys can be found for all of them.
For a basic level of security the user does not need to check a fingerprint or do any key management manually.
How to set it up?
If you want to set up a Web Key Directory for your own server or your own server you only need access to a webserver for your domain. See: WKDHosting
For a larger organization it is recommended to set up a complete Web Key Service, which will help to automate Web Key Directory publishing.
Stopgap method - temporary central keyserver
Not recommended - but a temporary workaround - is to use "WKDaaS" and delegate delivery of your pubkey to a central service. Doing this you'll expose all people that want to use crypto when communication with you towards another party of the central service or monitoring the central service. This third party can then see the communication pattern.
However this maybe a temporary solution until you will convince your mail provider to enable at least the WKD serving part or to switch to a more privacy aware mail provider.
One service is keys.openpgp.org, where you can set the CNAME record of the "openpgpkey" subdomainto "wkd.keys.openpgp.org" the CNAME entry should look like this.
openpgpkey.example.org. 300 IN CNAME wkd.keys.openpgp.org.
In addition you need to register your pubkey with them.
Other drawbacks:
- As any WKD service, they'll be able to serve a different pubkey to some domains at some time, however opposed to your email provider you do not have a contractual relationship with them.
- Elder GnuPGs like the some on Debian Stretch do not offer the necessary modern WKD implementation for a successful request, so you are reaching less communication partners with this compared to real WKD.
- (For the overall ecosystem, we need more decentral services instead, it is at the core of OpenPGP security promise. So you are missing to set a good example. ;) )
Web Key Directory (WKD) / Web Key Service (WKS) what is the difference?
The Web Key Directory is the HTTPS directory from which keys can be fetched.
The Web Key Service is a tool / protocol to automatically publish and update keys in the Web Key Directory. It is optional to reduce the administrative effort of a Web Key Directory.
Documentation how to set up a Web Key Service can be found on the Web Key Service page.
Technical Details
You can find the concepts / technical details under WKDDetails.
Trust and security considerations are outlined as part of the AutomatedEncryption concept.
Troubleshooting
If you have arrived here after receiving an email saying:
The web page
https://gnupg.org/faq/wkd.html
explains how you can process this message anyway in
a few manual steps.you can find further instructions at WKSManualConfirmation.
Implementations
GnuPG
- WKD lookup is implemented in GnuPG since v2.1.12. It is enabled by default since 2.1.23..
- WKS server and client tools are part of GnuPG since v2.1.14
Mail Clients
Any mail client which uses the --locate-keys option of GnuPG will automatically do WKD requests.
Known mail clients with WKD Support:
- Desktop:
- Thunderbird/Enigmail 2.0
- KMail since Version 5.6
- Outlook with GpgOL since Version 2.2.0
- Claws Mail since 3.18.0 / 4.0.0
- Balsa has no official release - which is supporting WKD - yet but the feature was merged into the main branch
- Browser-Extensions:
- Mailvelope since Version 3.0.0 (Dez 2018)
- Android:
- K9Mail with OpenKeyChain since Version 5.1 (Jun 2018)
- FairEmail with OpenKeyChain since OpenKeyChain 5.4 (FAQ, (12) How does encryption/decryption work?)
Progress of WKD in different mail clients
Known mail clients with WKS Support:
- Thunderbird/Enigmail 2.0
- KMail since Version 5.6
- Outlook with GpgOL (basic, pre-release) since Version 2.2.1 asyGpg2016)
Self-hosted email setups offering WKD + WKS:
- caesonia - OpenBSD email service.
- Excision Mail - OpenBSD email service using ansible: Has multiple-domain WKS support.
- Userli - Web application to (self-) manage e-mail users and encrypt their mailboxes..
Mail Service Providers offering WKD
- Posteo offers web key directory lookup and service for @posteo.de-addresses (Since 2016-12)
- Protonmail supports web key directory lookup (Since 2018-11) in both ways.
- netzguerilla offers web key directory lookup. (Since 2017-10-11)
- systemli.org offers web key directory lookup and service for all hosted domains (Since 2020-10-15)
- mailbox.org claims to offer web key directory lookup
- See announcement https://mailbox.org/en/post/the-keyserver-is-dead-long-live-the-keyserver 2019
- In the forum in 2021 a question (German) was asked when WKD would be offered. The thread was deleted but you can find it via the Internet Archive: https://web.archive.org/web/20211019060747/https://userforum.mailbox.org/topic/wann-wird-ein-web-key-directory-wkd-angeboten
- At least the OpenPGP key for the privacy mail address of mailbox.org can be found via:
- The command gpg-wks-client --with-colons --supported mailbox.org also gives a positive result
- mail.de maintains a WKD server (Screenshot: attachment:mailde_wkd.png)
- Mailfence supports web key directory lookup (Since 2021-11-18) in both ways.
Organizations using WKD
- C3S
- Credativ GmbH, DE
- debian.org
- gentoo.org
- gnupg.org (Testing accounts available for developers implementing WKD in MUAs.)
- KDAB.com
- kernel.org
- Nikka Systems
- occrp.org
- torproject.org
- f-droid.org
- guardianproject.info
- privacyguides.org
- Univention GmbH
- (Several unlisted organisations. And of course the main designers of WKD - g10code.com, intevation.de.)
(Add yourself or let us know if you want to be publicly listed.)