AkkomaGang/akkoma
AkkomaGang/akkoma
17
70
Fork 117
Code Issues 148 Pull requests 15 Projects 2 Releases 24 Packages Wiki Activity
akkoma/FEDERATION.md

66 lines
3.1 KiB
Markdown
Raw Permalink Normal View History

Document AP and nodeinfo extensions And while add it point to this via a top-level FEDERATION.md document as standardised by FEP-67ff. Also add a few missing descriptions to the config cheatsheet and move the recently removed C2S extension into an appropiate subsection.
2024-05-16 21:05:01 +02:00
# Federation
## Supported federation protocols and standards
- [ActivityPub](https://www.w3.org/TR/activitypub/) (Server-to-Server)
- [WebFinger](https://webfinger.net/)
- [Http Signatures](https://datatracker.ietf.org/doc/html/draft-cavage-http-signatures)
- [NodeInfo](https://nodeinfo.diaspora.software/)
## Supported FEPs
- [FEP-67ff: FEDERATION](https://codeberg.org/fediverse/fep/src/branch/main/fep/67ff/fep-67ff.md)
fed/out: expose webfinger property in local actors (FEP-2c59) It makes discovery and validation of the desired webfinger address much easier. Future commits will actually use it for validation and nick change discovery.
2026-02-23 15:23:03 +00:00
- [FEP-2c59: Discovery of a Webfinger address from an ActivityPub actor](https://codeberg.org/fediverse/fep/src/branch/main/fep/2c59/fep-2c59.md)
federation.md: list FEP-dc88 formatting mathematics Implemented by https://akkoma.dev/AkkomaGang/akkoma/pulls/642
2025-01-09 21:00:18 +01:00
- [FEP-dc88: Formatting Mathematics](https://codeberg.org/fediverse/fep/src/branch/main/fep/dc88/fep-dc88.md)
Document AP and nodeinfo extensions And while add it point to this via a top-level FEDERATION.md document as standardised by FEP-67ff. Also add a few missing descriptions to the config cheatsheet and move the recently removed C2S extension into an appropiate subsection.
2024-05-16 21:05:01 +02:00
- [FEP-f1d5: NodeInfo in Fediverse Software](https://codeberg.org/fediverse/fep/src/branch/main/fep/f1d5/fep-f1d5.md)
- [FEP-fffd: Proxy Objects](https://codeberg.org/fediverse/fep/src/branch/main/fep/fffd/fep-fffd.md)
Add "FEP-c16b: Formatting MFM functions" to FEDERATION.md
2024-12-01 11:43:37 +01:00
- [FEP-c16b: Formatting MFM functions](https://codeberg.org/fediverse/fep/src/branch/main/fep/c16b/fep-c16b.md)
Document AP and nodeinfo extensions And while add it point to this via a top-level FEDERATION.md document as standardised by FEP-67ff. Also add a few missing descriptions to the config cheatsheet and move the recently removed C2S extension into an appropiate subsection.
2024-05-16 21:05:01 +02:00
## ActivityPub
Akkoma mostly follows the server-to-server parts of the ActivityPub standard,
but implements quirks for Mastodon compatibility as well as Mastodon-specific
and custom extensions.
See our documentation and Mastodon’s federation information
linked further below for details on these quirks and extensions.
Akkoma does not perform JSON-LD processing.
### Required extensions
#### HTTP Signatures
All AP S2S POST requests to Akkoma instances MUST be signed.
Depending on instance configuration the same may be true for GET requests.
Add "FEP-c16b: Formatting MFM functions" to FEDERATION.md
2024-12-01 11:43:37 +01:00
### FEP-c16b: Formatting MFM functions
Support htmlMfm term key for FEP-c16b compliance We now add the htmlMfm key when relevant, store this in the database, and we see it when fetching using e.g. curl -L -H 'Accept: application/activity+json' "$ap_id" The `@context` of the Activity Pub message now also contains `htmlMfm: https://w3id.org/fep/c16b#htmlMfm`. When an incomming post has `htmlMfm: true`, we will not re-parse the content. FEDERATION.md is adapted to show the `htmlMfm` term is used.
2025-03-09 20:13:27 +01:00
We set the optional extension term `htmlMfm: true` when using content type "text/x.misskeymarkdown".
Fix grammatical errors after code review
2025-04-30 11:52:07 +02:00
Incoming messages containing `htmlMfm: true` will not have their content re-parsed.
Add "FEP-c16b: Formatting MFM functions" to FEDERATION.md
2024-12-01 11:43:37 +01:00
federation.md: document our WebFinger behaviour
2026-03-13 00:00:00 +00:00
## WebFinger
Akkoma requires WebFinger implmentations to respond to queries about a given user both when
`acct:user@domain` or the canonical ActivityPub id of the actor is passed as the `resource`.
Akkoma strongly encourages ActivityPub implementations to include
a FEP-2c59-compliant WebFinger backlink in their actor documents.
Without FEP-2c59 and if different domains are used for ActivityPub and the Webfinger subject,
webfinger/finger: only accept authority of query domain And permit refetching once(!) unless initial query was already designated as the canonical authority. (Only once to not get stuck in loops) Fixes an oversight in c80aec05de435db43b1e257069f222fc600ebdc9. The argument for why subjects from both authorities can be accepted hinged on the assumption that only paths under direct control of the domain operator are involved since both webfinger and host-meta are /.well-known/ paths. However, HTTP redirects or the LRDD schema inside the initial domains host-meta may point at _any_ path on another domain, including e.g. paths containing user uploads, thus enabling third-parties to illegitimately claim handles from urelated domains, _if_ the victim domain can be made to serve attacker-prepared JSON (e.g. via user uploads or (media) proxies). With trust being limited to initial domain and refetches we do not need to make guesses about whether and when being redirected to indicates authorisation of the final domain. It requires more fetch requests in no-FEP-2c59 setups, but makes it more robust. As a side effect current FEP-less Mastodon setups should happen to work.
2026-03-21 00:00:00 +00:00
Akkoma relies on either the presence of an host-meta LRDD template on the ActivityPub domain
or a working WebFinger endpoint on the ActivityPub domain. Additionally all WebFinger endpoints
related to the ActivityPub and canonical WebFinger domain SHOULD also respond to queries about
an alternative acct URI constructed with the WebFinger domain passed as the resource.
federation.md: document our WebFinger behaviour
2026-03-13 00:00:00 +00:00
Without FEP-2c59 Akkoma may not become aware of changes to the
preferred WebFinger `subject` domain for already discovered users.
Document AP and nodeinfo extensions And while add it point to this via a top-level FEDERATION.md document as standardised by FEP-67ff. Also add a few missing descriptions to the config cheatsheet and move the recently removed C2S extension into an appropiate subsection.
2024-05-16 21:05:01 +02:00
## Nodeinfo
Akkoma provides many additional entries in its nodeinfo response,
see the documentation linked below for details.
## Additional documentation
- [Akkoma’s ActivityPub extensions](https://docs.akkoma.dev/develop/development/ap_extensions/)
- [Akkoma’s nodeinfo extensions](https://docs.akkoma.dev/develop/development/nodeinfo_extensions/)
- [Mastodon’s federation requirements](https://github.com/mastodon/mastodon/blob/main/FEDERATION.md)
Reference in a new issue Copy permalink