created_at
updated_at
tags
toc

RFC の URL はどのドメインで貼るのが良いか

Intro

IETF の RFC は、いくつかの場所で同じものが公開されている。

どの URL が最適なのか、という話。

結論は www.rfc-editor.org だ。

RFC Hosting Site

例えば RFC 9110 - HTTP Semantics で言うと、以下の 4 つがある。

まずは、これらの違いを簡単に解説する。

tools.ietf.org

IETF がホストする RFC は、tools.ietf.org だった。

tools.ietf.org

しかし、2021 年 tools と xml2rfc/bibxml をメンテしていた Henrik 氏が引退し、それを機に刷新が行われることになった。

既存のページはマイグレーションされて、URL は datatracker.ietf.org にリダイレクトされている。

datatracker.ietf.org

tools.ietf からのリダイレクト先は datatracker だ。

tools の持っていた機能は RFC 本文の表示だけではなく、そのメタ情報の表示でもあった。

特に、RFC がどのような変遷を経てきたのか、Author は誰であるか、Errata はどこにあるか、Internet Standard なのか Informational なのかなどが含まれていた。

昔はディスプレイも小さかったため、サイドバーは存在せず、ヘッダと別ページに記載されていたが、datatracker はこれをサイドバーに踏襲している。

datatracker.ietf.org

このように、最も情報量が豊富なのは datatracker であると言える。

rfc-editor.org

最近よく見かけるのが rfc-editor.org だ。

気がついたらあったが、いつどのようにできたのかは追いきれなかった。

www.rfc-editor.org

ヘッダ部分にメタデータはあるが、デザインはシンプルで、サイドバーには ToC がある。

見た目が良くなったサイトだ、と言いたいところだが、これはサイトが新しいからではなく、RFC の生成ツールが刷新されているからだ。

従って、古い RFC はそのまま古いスタイルで表示される。

また、ヘッダ部分から datatracker に飛べる。

datatracker へのリンク

httpwg.org

もう一つ最近見るようになったのがこのドメインだ。

httpwg.org

名前の通り、これは HTTPWG が独自に管理しているものであり、リポジトリの GitHub Pages で配信されている。

HTTPWG は、策定活動に GitHub をかなり多用する WG であり、仕様も全て GitHub のリポジトリで管理されている。

そのリソースを、策定段階から独自の読みやすいスタイル(CSS)で出してくれているものだ。

つまり、IETF 公式といえるかというと微妙だ。

RFC の読みにくさ

tools から datatracker に移行するのと同時期くらいに、RFC 自体のフォーマットをなんとかしようという動きがあった。

以前の RFC は、本文が ASCII 固定文字数で折り返し、HTML では全体が <pre> というフォーマットだった。

RFC の古いスタイル

これはそもそも RFC は固定長折り返しのテキスト形式がもとで、そこから HTML や PDF へとバリエーションが増えていき、そこで Text と同じスタイルが保たれたからと思われる。

文の途中でも固定長で折り返しているため、例えば読み上げも途切れるし、自動翻訳も意味がつながらずうまく動かない。左寄せでセンタリングもされてない。

ディスプレイが小さかったころに、安定したテキストフォーマットとしては良かったかもしれないが、全くアクセシブルでないこのフォーマットには筆者も不信感があった。

HTTPWG が独自に HTML を生成してホストしていたのも、このあたりの理由から読みやすいものを独自に公開していたように思う。

その後 RFC 8650 あたりから、RFC を生成するツールも刷新され、それを用いて現在のモダンな HTML が吐かれるようになった。

RFC の新しいスタイル

先ほど言った、新しい/古いフォーマットどちらかは、ドメインによるものではない。例えば以下の二つは見た目が違うように見えるが、HTML のソース自体は同じだ。

しかし、ソースを見るとどちらも <pre> であることは変わらず、センタリングがされているか程度の違いしか実際はない。過渡期であるがゆえの微妙な差と言える。

どれを使うべきかの議論

以下に、Stack Exchange で不具合があった際に IETF 担当者とやりとりしたログが残っている。

rfc-editor.org is the canonical location for RFC documents, and will remain the correct destination for now. The RFC document locations at the various IETF URLs aren't canonical repositories, even though they do ultimately point to the same documents. I gather (but could be wrong) that these are more so 'working repositories' than the reference documents themselves.

rfc-editor.org は RFC の正規の場所であり、今のところ正しい保存先と言える。複数の IETF URL にある RFC 文書の場所は、最終的に同じ文書を指しているとはいえ、正規のリポジトリではない。私は(間違っているかもしれないが)、これらは参照文書そのものというよりも、「作業用リポジトリ」だと考えている。

つまり、文書としての RFC の Canonical URL は rfc-editor であり、そのリポジトリが datatracker ということになる。

類似する議論として WHATWG HTML の仕様の URL はどうするかという議論もあった。

この中で MDN のとっているルールを採用することになり、そのルールは以下だ。

  • If an httpwg version exists, use that
  • Otherwise, if an rfc-editor version exists, use that
  • Otherwise, use the datatracker version

これは、あくまで読みやすいことを優先している。また HTTPWG のスペックしか httpwg.org にはない。

聞いてみた。

公式見解を探そうにも、そもそも datatracker や rfc-editor での検索が RFC 自体に引っかかりまくるので、検索が困難だった。

そこで、IETF の discussion で聞いてみた。

答えは以下のドキュメントに書かれていた。

For RFCs the official site is rfc-editor.org. The information page for each RFC has a link to the BibXML file.

— https://authors.ietf.org/en/references-in-rfcxml

このことからも、ドメインは rfc-editor.org が正しいようだ。

ではパスはどうかというと、以下に言及がある。

The Digital Object Identifier (DOI) is now listed in each reference to an RFC. The first example in Section 4.8.6.2 of RFC 7322 is updated as follows.

For one author or editor:

[RFCXXXX] Last name, First initial., Ed. (if applicable), "RFC Title", Sub-series number (if applicable), RFC number, DOI, Date of publication, https://www.rfc-editor.org/info/rfc#.

— https://www.rfc-editor.org/styleguide/part2/#ref_rfcs

Digital Object Identifier (DOI) は、その対象物に振られる一意な識別子で、例えば RFC 9110 であれば以下のように参照できる。 

10.17487/RFC9110

これを DOI を解するサービスを経由すれば、リダイレクトされる。 

https://doi.org/10.17487/RFC9110

これにより、IETF がドメインを変えたり構成が変わっても、リダイレクト先を登録しなおせば参照が切れないという仕組みだ。

そして、その DOI に登録されている(つまりリダイレクトされる先)は以下だ。 

https://www.rfc-editor.org/info/rfc9110

RFC Info

本文ではなく、メタデータ部分のページであり、複数のリンクから好きなフォーマットで見ることができる。

そして、RFC の引用ルールではこのページを貼るように指定されているのだ。

ここにコンテンツを含まないでいいのかは、IETF の中でも議論があるようだ。

ただし、これはあくまで「RFC を書く場合」のルールであり、RFC へのリンクを外部から貼る人にも求められる要件とは読めなさそうだ。

おまけ

RFC の正式表記

RFC の表記について、以下のスタイルガイドに言及がある。

A citation/reference tag must not contain spaces.

Example: "[RFC2119]" rather than "[RFC 2119]"

However, the proper textual naming of an RFC contains a space.

Example: "See RFC 2119 [BCP14] for more information."

— https://datatracker.ietf.org/doc/html/rfc7322#section-3.5

要約すると。

  • RFC 内に参考文献を貼る場合はカッコで囲み、スペース入れない
    • つまり [RFC2119]
  • しかし、文章中に RFC を書く場合、数字との間にスペースが入る
    • つまり RFC 2119

とはいえ、これは「RFC を書く人」が守るべきルールなので、他の文書もそうであるべきかは文書側のルールになるだろう。

しかし、RFC を書く場合にスペースを入れるのが "proper" とされているのは、注目したい。

Draft

rfc-editor は RFC はホストしているが、RFC になる前の draft については datatracker にしかない。

したがって、RFC と Draft が並ぶ場合は、統一のために datatracker に寄せるのもありかもしれない。

Inline Errata

RFC 発行後に報告された問題は Errata と呼ばれる。

Errata があったとしても、一度発行した RFC は内容を変えることができないため、マージするには改訂を行い新たな RFC を出す必要がある。

しかし、RFC を出すのは一定の労力がかかるため、Errata が存在するままの RFC は多く存在する。実装時などに「なにかがおかしい?」と思ったら実は Errata があったということはよく起こるため、最初に Errata の存在を確認するのは重要だった。

RFC では、ひっそりと Errata Exsists と書かれたリンクから見ることができる。

Errata exists

ところが、最近では受理された Errata をインラインにマージした RFC のフォーマットがあることに気づいた。(いつからあるのかはよくわからない)

inline errata

これは rfc-editor に別パスで公開されている。

実装をする場合などはこちらを見ると良いだろう。

まとめ

RFC へのリンクを貼る場合、公式の、統一された、安定的な URL を求めるのであれば、ドメインは rfc-editor を用いるのが良いだろう。

そして RFC を書く場合や、論文や出版で DOI を意識したのであれば、/info を貼る必要がある。

しかし、一般的な文書や書籍では、/info である必要はないだろうし、必要なら DOI そのものを併記すれば良い場合がほとんどと思われる。

従って、以下を用いるのが良いだろう。

PDF や TEXT フォーマットが良い場合は、拡張子だけ変えれば良い。

Outro

本ブログや、筆者が書く文書では、RFC へのリンクは rfc-editor の HTML リンクを採用することとする。