Introduction
WebFinger (RFC 7033) lets a client ask a server what it knows about a resource: typically a person’s account, written as an acct: URI. The client sends a request to
/.well-known/webfinger with a resource parameter and gets a JSON Resource Descriptor (JRD) back, served as application/jrd+json. The answer is not a file at a fixed address but the response to a query, so a
saved copy is usually named webfinger, webfinger.json or webfinger.jrd. The JRD form was first introduced by RFC 6415 (host-meta) and is reused by NodeInfo and, in its host-wide form, by
host-meta.json. Servers must send Access-Control-Allow-Origin, and “SHOULD support the least restrictive setting” (*).
Structure
{
"subject": "acct:bob@example.com",
"aliases": [ "https://www.example.com/~bob/" ],
"properties": { "http://webfinger.example/ns/name": "Bob Smith" },
"links": [
{
"rel": "http://webfinger.example/rel/profile-page",
"href": "https://www.example.com/~bob/",
"titles": { "en": "Bob’s page", "und": "Bob" },
"properties": { "http://webfinger.example/mail/port": "993" }
}
]
}
| Member | Rule (RFC 7033 section 4.4) |
|---|---|
subject | A URI that identifies the entity the JRD describes. It may differ from the requested resource. It SHOULD be present. |
aliases | An array of zero or more URI strings that identify the same entity. Optional. |
properties | An object whose names are URIs and whose values are strings or null. Optional. |
links | An array of link relation objects, in order of preference. Optional. Each object: rel (MUST be present: a URI or a registered relation type, exactly one), type (a media type), href (a URI), titles (an object whose names are language tags or
und; a JRD SHOULD NOT hold two titles for one language) and properties (as above). All but rel are optional. |
| unknown members | “The client MUST ignore any unknown member and not treat the presence of an unknown member as an error.” |
In the explorer
A file named webfinger, webfinger.json or webfinger.jrd opens here when it is a JSON object with a subject that is a URI and at least one of links (whose items have a rel), aliases or
properties, and no issuer or m.homeserver (which belong to other formats). Any other file with these names opens as before. The tree labels each member; the Links tab lists the links. A problem is a rule above that is broken: a subject that is not a URI or is missing, an alias that
is not a string, a property name that is not a URI or a value that is neither a string nor null, a link with no rel or with white space in it, an href that is not an absolute URI, two titles for one language. Unknown members are labelled as ignorable, not called errors. Nothing is fetched. All 11 public
Fediverse instances tried were claimed.
Not described
Known, not yet covered
- Reference: the request side (the
resourceandrelparameters, status codes, redirects and hosted WebFinger services, RFC 7033 sections 4.1 to 4.3 and 7) and the registries of link relation types and property names are named, not described. - Viewer: the URIs are checked for having a scheme only, not against RFC 3986; language tags are not checked against BCP 47; a link relation is not compared with the IANA registry.
- Viewer: a JRD with no
subjectis not recognised (so a partial answer opens as before), though RFC 7033 only says a subject SHOULD be present.
Unknown
- Reference: none known beyond the above.