-
Notifications
You must be signed in to change notification settings - Fork 437
MSC4439: Encryption key URIs in /.well-known/matrix/support
#4439
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
thetayloredman
wants to merge
6
commits into
matrix-org:main
Choose a base branch
from
thetayloredman:msc4439
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
e529d54
MSC4439: Encryption key URIs in `/.well-known/matrix/support`
thetayloredman e5585d0
remove unreferenced link, wrap lines
thetayloredman eaf6281
tighten wording, specify relationship to email_address
thetayloredman 7bb7cb9
update alternatives section to include simply using security.txt
thetayloredman 46f09bb
Update 4439-support-contact-encryption.md
thetayloredman f0e4412
clarify that support contacts must not contain fingerprints, must use…
thetayloredman File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| # MSC4439: Encryption key URIs in `/.well-known/matrix/support` | ||
|
|
||
| The [`/.well-known/matrix/support`] endpoint provides an [`email_address`] property for reaching server contacts, | ||
| including those intended for sensitive security disclosures (the `m.role.security` role). [RFC9116] \(commonly known | ||
| as `security.txt`\) serves a similar purpose and defines an `Encryption` field (§2.5.4) allowing operators to | ||
| advertise a key URI for encrypted communication with security researchers. | ||
|
|
||
| This proposal adds a similar `pgp_key` field to the [`Contact`] entry on [`/.well-known/matrix/support`], enabling | ||
| homeserver operators to indicate a key that senders may use when communicating sensitive information over email or | ||
| other insecure channels. | ||
|
|
||
| ## Proposal | ||
|
|
||
| A new optional property `pgp_key` (unstable prefix: `dev.zirco.msc4439.pgp_key`) is added to the [`Contact`] | ||
|
thetayloredman marked this conversation as resolved.
|
||
| response from [`/.well-known/matrix/support`]. This field indicates a PGP key that may be used for encrypted | ||
| communication to that particular contact. If the field is used, the `email_address` field SHOULD also be present. | ||
|
|
||
| The value of this field MUST be a URI pointing to a location where the key may be retrieved. Raw key material MUST | ||
| NOT appear as the value of this field. If a key fingerprint is to be used as this field, it MUST be prefixed with | ||
| the `openpgp4fpr:` URI scheme. As with [RFC9116], it is always the responsibility of the sender to ensure they | ||
| trust the key provided. | ||
|
|
||
| Example of an OpenPGP key available from a web URI: | ||
|
|
||
| ``` | ||
| { | ||
| "contacts": [ | ||
| { | ||
| "email_address": "logan@zirco.dev", | ||
| "pgp_key": "https://zirco.dev/pgp/logn.pub", | ||
| "role": "m.role.admin" | ||
| } | ||
| ] | ||
| } | ||
| ``` | ||
|
|
||
| Other URI schemes other than `https` may also be used, common examples include, but are not limited to: | ||
| - `openpgp4fpr:67FAAA655DBD691E7957E0951594E544D8F8F21E` (key fingerprint) | ||
| - `dns:HASH._openpgpkey.zirco.dev?type=OPENPGPKEY` (`OPENPGPKEY` DNS record) ([RFC7929]) | ||
|
|
||
| ## Potential issues | ||
|
|
||
| None identified. | ||
|
|
||
| ## Alternatives | ||
|
thetayloredman marked this conversation as resolved.
|
||
|
|
||
| Sensitive communications may instead be conducted over Matrix, where E2EE is native. However, some researchers prefer | ||
| or mandate out-of-band channels, which this MSC accommodates. | ||
|
|
||
| Sensitive information may simply be encrypted to the key already listed in a site's security.txt file, however, at | ||
| larger organizations this does not provide the same per-contact granularity (and may not even reference someone | ||
| responsible for hosting the Matrix homeserver at all). A homeserver is unlikely to be the only service running on a | ||
| domain. Especially for larger organizations, where the single key that security.txt provides may not actually represent | ||
| anyone responsible for the Matrix homeserver itself. This is a tool to aid in discovery alongside WKD or key servers. | ||
|
|
||
| Additionally, this helps obtain per-contact granularity in contrast to just one "this is our security team's key." | ||
|
|
||
| ## Unstable prefix | ||
|
|
||
| While this proposal is unstable, `pgp_key` should be referred to as `dev.zirco.msc4439.pgp_key`. | ||
|
|
||
| [`/.well-known/matrix/support`]: https://spec.matrix.org/unstable/client-server-api/#getwell-knownmatrixsupport | ||
| [`email_address`]: https://spec.matrix.org/unstable/client-server-api/#getwell-knownmatrixsupport_response-200_contact | ||
| [`Contact`]: https://spec.matrix.org/unstable/client-server-api/#getwell-knownmatrixsupport_response-200_contact | ||
| [RFC9116]: https://www.rfc-editor.org/info/rfc9116 | ||
| [RFC7929]: https://www.rfc-editor.org/info/rfc7929 | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Implementation requirements:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
another Server publishing the Changes: https://hnvn.de/.well-known/matrix/support