:bulb: [Feature] Provide common `.well-known` URIs

[fmigneault]

Description

Well-Known URIs (https://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml, https://www.rfc-editor.org/rfc/rfc8615.html) is a common approach for servers to advertise multiple relevant information such as provided services, authentication methods, etc.

Similar to the custom endpoints that we defined (/services, /components, /version), we should populate the contents that can be known in advance based on enabled components.

The component should allow extension and overrides, such that the developer enabling it can customize specific configurations if they provide additional services and capabilities on top of auto-configured ones. Furthermore, the component's definition should probably integrate similarly to the following definitions, since some information can be reused.

• https://github.com/bird-house/birdhouse-deploy/blob/master/birdhouse/components/proxy/pre-docker-compose-up
• https://github.com/bird-house/birdhouse-deploy/blob/master/birdhouse/scripts/get-services-json.include.sh
• https://github.com/bird-house/birdhouse-deploy/blob/master/birdhouse/scripts/get-components-json.include.sh

Candidate URIs

• /.well-known/landing-page:

  {
    "value": [
      {
        "name": "Weaver",
        "url": "https://HOSTNAME/weaver"
      },
    ],
    "serverSettings": {
      "conformance": [
        "https://HOSTNAME/weaver/conformance/..."
      ],
      "moreSettings": "..."
    }
  }

  example: https://ogc.demo.secure-dimensions.de/.well-known/landing-page

• /.well-known/api-catalog (https://datatracker.ietf.org/doc/draft-ietf-httpapi-api-catalog/08/)
  (i.e.: our /services, but simplified)

• /.well-known/oauth-protected-resource (i.e.: https://datatracker.ietf.org/doc/rfc9728/)
  /.well-known/oauth-protected-resource/{SERVICE} (i.e.: https://www.rfc-editor.org/rfc/rfc9728.html#section-3.1)

  List of resources protected by Magpie and their relevant endpoints/services

• /.well-known/oauth-authorization-server (https://www.iana.org/go/rfc8414)
  /.well-known/oauth-authorization-server/twitcher (https://www.rfc-editor.org/rfc/rfc8414.html#section-3.1)

• /.well-known/host-meta (i.e.: rel=service-doc)
  /.well-known/host-meta.json (i.e.: rel=service-meta)
  (https://www.rfc-editor.org/rfc/rfc6415.html)

Note

There is most probably other applicable Well-Known URIs, but above are the most obvious ones we should consider.

References

• https://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml
• https://www.rfc-editor.org/rfc/rfc8615.html

Concerned Organizations

all