Print TXT record values quoted, matching dig output

[toshi0806]

問題

tdig は TXT レコードの値を引用符なしで出力するため、dig と表示が食い違います。

$ dig +noall +answer google.com TXT @8.8.8.8
google.com.  300  IN  TXT  "v=spf1 include:_spf.google.com ~all"

$ ./tdig google.com TXT @8.8.8.8
google.com.  285  IN  TXT  v=spf1 include:_spf.google.com ~all

該当箇所は lib/tdig.ex の 1 行です。

def rdata_to_string(rdata, :txt), do: escape(rdata.txt)

dig は TXT の character-string を必ず " で囲んで出力します。tdig は dig 互換の出力フォーマットを掲げているため、この差異は解消すべきです。

対応

rdata_to_string(rdata, :txt) で値を " で囲む。値中の " および \ のエスケープも併せて実装する。

複数 character-string は連結して単一の引用符で表示する

dig は複数の character-string を個別に引用して表示します。

example.com.  300  IN  TXT  "abc" "def"

一方 tdig ではこれを

example.com.  300  IN  TXT  "abcdef"

と表示します。この差異は意図的に受け入れる方針です。

tenbin_dns の decode(rdata, :txt, _, _) は全 character-string を連結した単一バイナリを返し、境界情報を保持しません。

DNSpacket.parse_rdata(<<3, "abc", 3, "def">>, :txt, nil, nil)
#=> %{txt: "abcdef"}

これは smkwlab/tenbin_dns#95 で 3 案（binary のまま / リストに変更 / 別フィールド併設）を比較したうえで選択された設計で、境界を保持しないことは受容されたトレードオフとして記録されています（RFC 7208 §3.3 のとおり SPF 等では連結値が論理値であり、境界に意味を与えるプロトコルは稀）。tenbin_dns 側での再検討は smkwlab/tenbin_dns#134 で提起しましたが、この判断を覆すには至らないと結論し close しています。

したがって tdig 側だけで完結する対応とし、値そのものは連結された完全な形で表示されるため情報の欠落はありません。

ドキュメント

README の dig 比較表に、複数 character-string TXT の表示形式が dig と異なる旨を既知の制約として記載する。

補足: tenbin_dns 0.8.0 による退行ではありません

引用符が付かない件は 0.8.0 以前からの挙動です。また 0.7.1 では TXT の最初の character-string しか取得できておらず（残りは破棄されていた）、255 バイトを超える TXT（DKIM 公開鍵、長い SPF レコード等）は値が途中で切れて表示されていました。0.8.0 で全体が表示されるようになったのは改善です。

関連: smkwlab/tenbin_dns#95

[toshi0806]

着手します（branch: issue-82-quote-txt-rdata）。

方針

rdata_to_string(rdata, :txt) を引用符付き出力にします。実装上の注意点が 1 つあります。

既存の escape/1 は :ns / :ptr / :cname / :mx / :soa のドメイン名でも共用されており、dig はドメイン名を引用しません。そのため escape/1 自体は変更せず、TXT 専用の経路で " のエスケープと引用符の付与を行います。既存の escape_byte/1（\ → \\、非印字バイト → \DDD）には委譲し、重複実装は避けます。

TDD 計画（red → green）

test/tdig_test.exs に以下を先に書きます。

1. 既存の "rdata_to_string formats TXT records" を引用符付き期待値に更新（現状は引用符なしを assert しているため、これ自体が red になります）
2. 値中の " が \" にエスケープされる
3. 値中の \ が \\ として維持される（escape_byte/1 への委譲の確認）
4. 非印字バイトが \DDD になる
5. 空文字列が "" になる

スコープ

Issue に記載のとおり、複数 character-string の個別引用（"abc" "def"）は対象外です。tenbin_dns の decode(rdata, :txt, _, _) が連結済みの単一バイナリを返す設計（smkwlab/tenbin_dns#95 で決定、境界非保持は受容されたトレードオフ）のため、tdig 側では復元できません。連結して単一の引用符で表示する仕様とし、README の dig 比較表に既知の制約として記載します。値そのものは完全に表示されるため情報の欠落はありません。

[toshi0806]

実装完了、PR #83 を作成しました（merge 時に本 Issue が close されます）。

対応内容

rdata_to_string(rdata, :txt) を quote_character_string/1 経由に変更し、引用符の付与と " のエスケープを行うようにしました。

着手時の方針どおり escape/1 自体は変更していません。ドメイン名を扱う :ns / :ptr / :cname / :mx / :soa と共用されており、dig はドメイン名を引用しないためです。escape_character_string_byte/1 は " 以外を既存の escape_byte/1 に委譲するので、\ → \\ と非印字バイト → \DDD のルールは 1 箇所に保たれています。

TXT の引用がドメイン名側に漏れていないことを確認する回帰防止テスト（leaves domain names unquoted）も追加しました。

動作確認

実機で dig と比較し、単一 character-string のケースで出力が完全に一致することを確認しています。

$ dig +noall +answer google.com TXT @8.8.8.8 | sort | head -1
google.com.		300	IN	TXT	"apple-domain-verification=30afIBcvSuDV2PLX"

$ ./tdig google.com TXT @8.8.8.8 | grep 'IN	TXT' | sort | head -1
google.com.		300	IN	TXT	"apple-domain-verification=30afIBcvSuDV2PLX"

60 tests passed / credo --strict no issues / format OK / --warnings-as-errors 通過。

スコープ外の扱い

複数 character-string の個別引用（"abc" "def"）は Issue 記載のとおり対象外とし、連結して "abcdef" と表示します。README の dig 比較表に「Known difference: multi-string TXT records」として記載し、値そのものは失われない旨と smkwlab/tenbin_dns#95 の設計判断への参照を残しました。コード側にも同じ経緯をコメントで残しています。