3. Well-Known-URIs
3. Well-Known-URIs
Ein Well-Known-URI (well-known URI) ist ein URI [RFC3986], dessen Pfadkomponente mit den Zeichen /.well-known/ beginnt, vorausgesetzt, das Schema ist ausdrücklich zur Unterstützung von Well-Known-URIs definiert.
Wenn eine Anwendung beispielsweise den Namen example registriert, wäre der zugehörige Well-Known-URI auf http://www.example.com/ gleich http://www.example.com/.well-known/example.
Diese Spezifikation aktualisiert die Schemata http [RFC7230] und https [RFC7230], um Well-Known-URIs zu unterstützen. Andere bestehende Schemata können den geeigneten Prozess zur Aktualisierung ihrer Definitionen nutzen; beispielsweise tut dies [RFC8307] für die Schemata ws und wss. Das Register „Uniform Resource Identifier (URI) Schemes“ verzeichnet, welche Schemata Well-Known-URIs unterstützen; siehe Abschnitt 5.2.
Anwendungen, die neue Well-Known-URIs einführen wollen, MUST diese gemäß den Verfahren in Abschnitt 5.1 registrieren, vorbehaltlich der folgenden Anforderungen.
Registrierte Namen MUST der segment-nz-Produktion in [RFC3986] entsprechen. Das heißt, sie dürfen das Zeichen / nicht enthalten.
Registrierte Namen für eine bestimmte Anwendung SHOULD entsprechend präzise sein; das „Besetzen“ generischer Begriffe wird nicht empfohlen. Will die Beispiel-Anwendung (Example) etwa einen well-known Ort für Metadaten, könnten passende registrierte Namen example-metadata oder sogar example.com-metadata lauten, nicht metadata.
Mindestens verweist eine Registrierung auf eine Spezifikation, die das Format und die zugehörigen Medientypen (media types) definiert, die durch Dereferenzieren des Well-Known-URIs erhalten werden, sowie die URI-Schemata, mit denen der Well-Known-URI verwendet werden kann. Wenn keine URI-Schemata ausdrücklich angegeben sind, werden http und https angenommen.
In der Regel nutzen Anwendungen den Standardport für das jeweilige Schema; wird ein alternativer Port verwendet, MUST dies von der betreffenden Anwendung ausdrücklich angegeben werden.
Registrierungen MAY auch zusätzliche Informationen enthalten, etwa die Syntax weiterer Pfadkomponenten, Abfragestrings und/oder Fragment-Identifikatoren, die an den Well-Known-URI angehängt werden, oder protokollspezifische Details (z. B. Behandlung von HTTP-Methoden [RFC7231]).
Diese Spezifikation legt weder fest, wie der Hostname zu bestimmen ist, um den Well-Known-URI für eine bestimmte Anwendung zu finden, noch den Geltungsbereich der durch Dereferenzieren des Well-Known-URIs gefundenen Metadaten; beides sollte von der Anwendung selbst definiert werden.
Außerdem definiert diese Spezifikation kein Format oder keinen Medientyp für die Ressource unter /.well-known/, und Clients sollten nicht erwarten, dass dort eine Ressource existiert.
Well-Known-URIs sind an der Spitze der Pfadhierarchie verankert; in anderen Teilen des Pfads sind sie definitionsgemäß nicht „well-known“. Beispielsweise ist /.well-known/example ein Well-Known-URI, /foo/.well-known/example hingegen nicht.
Siehe auch Abschnitt 4 zu Sicherheitsüberlegungen bezüglich well-known locations.
3.1. Registrierung von Well-Known-URIs
Das Register „Well-Known URIs“ befindet sich unter https://www.iana.org/assignments/well-known-uris/. Registrierungsanträge können nach den dortigen Anweisungen gestellt oder per E-Mail an die Liste [email protected] gesendet werden.
Registrierungsanträge enthalten mindestens folgende Informationen:
URI suffix: Der für den Well-Known-URI angefragte Name relativ zu /.well-known/; z. B. example.
Change controller: Bei Standards-Track-RFCs „IETF“ angeben. Sonst den Namen der verantwortlichen Partei. Weitere Angaben (z. B. E-Mail-Adresse, Homepage-URI) können ergänzt werden.
Specification document(s): Verweis auf das Dokument, das das Feld spezifiziert, vorzugsweise mit einem URI, unter dem eine Kopie bezogen werden kann. Hinweise auf relevante Abschnitte können, müssen aber nicht enthalten sein.
Status: Entweder permanent oder provisional. Siehe die untenstehende Orientierung.
Related information: Optional Verweise auf weitere Dokumente mit zusätzlichen relevanten Informationen.
Allgemeine Anforderungen an registrierte Werte sind in Abschnitt 3 beschrieben.
Werte, die durch Standards-Track-RFCs und andere offene Standards (im Sinne von [RFC2026], Abschnitt 7.1.1) definiert sind, haben den Status permanent. Andere Werte können ebenfalls als permanent registriert werden, wenn die Experten nach Abstimmung mit der Gemeinschaft feststellen, dass sie in Gebrauch sind. Andere Werte sollten als provisional registriert werden.
Vorläufige Einträge können von den Experten entfernt werden, wenn sie – in Abstimmung mit der Gemeinschaft – feststellen, dass sie nicht genutzt werden. Die Experten können den Status eines vorläufigen Eintrags auf permanent ändern; dabei sollten sie die Verbreitung eines Werts berücksichtigen und die Gemeinschaft zuvor konsultieren.
„Die Gemeinschaft konsultieren“ bezieht sich hier auf die für die betreffenden URI-Schemata Verantwortlichen. Üblicherweise geschieht dies auf den Mailinglisten der zuständigen Arbeitsgruppen (möglicherweise bereits abgeschlossen) oder auf [email protected], falls es keine solche Liste gibt.
Well-Known-URIs können von Dritten (einschließlich der Experten) registriert werden, wenn die Experten feststellen, dass ein nicht registrierter Well-Known-URI weit verbreitet ist und sonst wahrscheinlich nicht rechtzeitig registriert würde. Solche Registrierungen unterliegen weiterhin den definierten Anforderungen, einschließlich des Verweises auf eine Spezifikation.