【Node.js】dns.resolveSoa() の代替方法とDNSプログラミングの基礎

2025-05-16

dnsPromises.resolveSoa() は、Node.jsの dns モジュールの Promises API の一部であり、指定されたドメイン名の SOA (Start of Authority) レコード を解決（名前解決）するための非同期関数です。

SOAレコードとは？

SOAレコードは、DNSゾーンに関する権威ある情報を提供するDNSリソースレコードの一種です。各DNSゾーンには、必ず1つのSOAレコードが存在します。SOAレコードには、主に以下のような情報が含まれています。

最小TTL (Minimum TTL)
このゾーン内のリソースレコードがキャッシュされる最小時間（秒単位）。
有効期限 (Expire Limit)
セカンダリネームサーバーがプライマリネームサーバーから応答を得られなくなった場合に、そのゾーン情報を無効と見なすまでの時間（秒単位）。
再試行間隔 (Retry Interval)
セカンダリネームサーバーがプライマリネームサーバーへの接続に失敗した場合に、再試行するまでの待機時間（秒単位）。
リフレッシュ間隔 (Refresh Interval)
セカンダリネームサーバーがプライマリネームサーバーにゾーン情報の更新を確認する頻度（秒単位）。
シリアル番号 (Serial Number)
ゾーンファイルが更新されるたびに増加する番号。セカンダリネームサーバーがゾーン転送を行う際に、ゾーンが更新されたかどうかを判断するために使用されます。
責任者のメールアドレス (Responsible Person's Email Address)
ゾーンの管理者のメールアドレス（@は.に置き換えられています）。
プライマリネームサーバー (Primary Name Server)
そのゾーンの権威を持つ主要なDNSサーバーのホスト名。

dnsPromises.resolveSoa() の役割

dnsPromises.resolveSoa() 関数を使用すると、特定のドメイン名に関連付けられたSOAレコードのこれらの情報を非同期的に取得できます。これは、DNSゾーンの管理情報や状態を確認したい場合に役立ちます。

使用例

以下は、dnsPromises.resolveSoa() の基本的な使用例です。

const dns = require('node:dns').promises;

async function getSoaRecord(hostname) {
  try {
    const soaRecord = await dns.resolveSoa(hostname);
    console.log('SOAレコード:', soaRecord);
    console.log('プライマリネームサーバー:', soaRecord.nsname);
    console.log('責任者のメールアドレス:', soaRecord.hostmaster);
    console.log('シリアル番号:', soaRecord.serial);
    console.log('リフレッシュ間隔:', soaRecord.refresh);
    console.log('再試行間隔:', soaRecord.retry);
    console.log('有効期限:', soaRecord.expire);
    console.log('最小TTL:', soaRecord.minttl);
  } catch (error) {
    console.error('SOAレコードの解決に失敗しました:', error);
  }
}

getSoaRecord('example.com');

このコードでは、example.com のSOAレコードを解決し、その各フィールドの値をコンソールに出力しています。

一般的なエラー

- 原因
  指定されたホスト名 (<hostname>) がDNSサーバーによって解決できなかった場合に発生します。これは、ホスト名が存在しない、スペルミスがある、またはDNSサーバーが一時的に利用できないなどの理由で起こり得ます。
- トラブルシューティング
  - ホスト名が正しく入力されているか確認してください。
  - 他のDNS解決ツール（例えば ping コマンドや nslookup コマンド）を使用して、そのホスト名が正常に解決できるか試してみてください。
  - ネットワーク接続に問題がないか確認してください。
  - 使用しているDNSサーバーの設定を確認してください。
Error: queryA ENODATA <hostname> (または類似のエラー)
- 原因
  指定されたホスト名には A レコード（IPv4アドレス）が存在しない場合に発生することがあります。resolveSoa() は SOA レコードの解決を試みますが、前提として基本的なDNS解決が可能な状態を期待します。
- トラブルシューティング
  - ホスト名が実際に存在し、DNSに登録されているか確認してください。
  - 他のDNSレコード（例えば MX レコードなど）は存在するか確認してみてください。SOA レコードは通常、ゾーンに必ず存在するため、このエラーが直接 resolveSoa() で頻繁に発生するわけではありませんが、DNS設定の不備が根本原因である可能性があります。
Error: timeout (タイムアウト)
- 原因
  DNSサーバーへの問い合わせが指定された時間内に応答しなかった場合に発生します。ネットワークの遅延、DNSサーバーの負荷が高い、またはDNSサーバーがダウンしているなどの理由が考えられます。
- トラブルシューティング
  - ネットワーク接続が安定しているか確認してください。
  - 別のDNSサーバーを使用してみる（例えば、Google Public DNS の 8.8.8.8 や Cloudflare DNS の 1.1.1.1 など）ことで、問題が特定のDNSサーバーにあるかを切り分けることができます。
  - Node.js アプリケーションが動作している環境のファイアウォール設定で、DNS (ポート 53) の通信が許可されているか確認してください。
Unhandled Promise Rejection (未処理のPromiseの拒否)
- 原因
  async/await を使用している場合、try...catch ブロックで dns.resolveSoa() のエラーを適切に処理しないと、このエラーが発生し、アプリケーションがクラッシュする可能性があります。
- トラブルシューティング
  - dns.resolveSoa() を呼び出す際には、必ず try...catch ブロックで囲み、エラーが発生した場合の処理を記述してください（上記の例を参照）。

トラブルシューティングの一般的なヒント

Promiseの適切な処理
async/await を使用する場合は try...catch を、Promise の .then() と .catch() を使用する場合は .catch() でエラーを適切に処理してください。
ファイアウォールの確認
ファイアウォールがDNSクエリ（通常は UDP/TCP ポート 53）をブロックしていないか確認してください。
他のDNSツールを使用する
ping、nslookup、dig などのコマンドラインツールを使用して、DNSの基本的な解決ができるか確認することで、問題の切り分けに役立ちます。
DNSサーバーの確認
使用しているDNSサーバーが正常に動作しているか確認してください。別のDNSサーバーを試すことも有効です。
ネットワーク接続の確認
DNS解決はネットワークに依存するため、ネットワーク接続が正常であることを確認してください。
エラーメッセージをよく読む
エラーメッセージには、問題の原因に関する重要な情報が含まれています。

例1: 単一のホスト名の SOA レコードを取得する基本的な例

これは、以前にも示した基本的な例です。指定されたホスト名の SOA レコードを取得し、その内容をコンソールに出力します。

const dns = require('node:dns').promises;

async function getSoaRecord(hostname) {
  try {
    const soaRecord = await dns.resolveSoa(hostname);
    console.log(`${hostname} の SOA レコード:`, soaRecord);
    console.log('  プライマリネームサーバー:', soaRecord.nsname);
    console.log('  責任者のメールアドレス:', soaRecord.hostmaster);
    console.log('  シリアル番号:', soaRecord.serial);
    console.log('  リフレッシュ間隔:', soaRecord.refresh);
    console.log('  再試行間隔:', soaRecord.retry);
    console.log('  有効期限:', soaRecord.expire);
    console.log('  最小TTL:', soaRecord.minttl);
  } catch (error) {
    console.error(`${hostname} の SOA レコードの解決に失敗しました:`, error);
  }
}

getSoaRecord('example.com');
getSoaRecord('google.com');

例2: 複数のホスト名の SOA レコードを並行して取得する例

複数のホスト名の SOA レコードを効率的に取得するために、Promise.all() を使用して非同期処理を並行して実行する例です。

const dns = require('node:dns').promises;

async function getMultipleSoaRecords(hostnames) {
  try {
    const results = await Promise.all(
      hostnames.map(async (hostname) => {
        const soaRecord = await dns.resolveSoa(hostname);
        return { hostname, soaRecord };
      })
    );

    results.forEach(({ hostname, soaRecord }) => {
      console.log(`${hostname} の SOA レコード:`, soaRecord);
    });
  } catch (error) {
    console.error('複数の SOA レコードの解決に失敗しました:', error);
  }
}

const hostnames = ['example.com', 'google.com', 'invalid-domain-example'];
getMultipleSoaRecords(hostnames);

例3: エラーハンドリングをより詳細に行う例

特定のDNSエラーの種類に応じて異なる処理を行う方法を示す例です。

const dns = require('node:dns').promises;

async function getSoaRecordWithDetailedErrorHandling(hostname) {
  try {
    const soaRecord = await dns.resolveSoa(hostname);
    console.log(`${hostname} の SOA レコード:`, soaRecord);
  } catch (error) {
    if (error.code === 'ENOTFOUND') {
      console.error(`${hostname}: ホスト名が見つかりませんでした。`);
    } else if (error.code === 'TIMEOUT') {
      console.error(`${hostname}: DNS サーバーへの問い合わせがタイムアウトしました。`);
    } else {
      console.error(`${hostname} の SOA レコードの解決中に予期しないエラーが発生しました:`, error);
    }
  }
}

getSoaRecordWithDetailedErrorHandling('example.com');
getSoaRecordWithDetailedErrorHandling('nonexistent-domain.xyz');

この例では、catch ブロック内でエラーオブジェクトの code プロパティをチェックすることで、特定のエラータイプ（例えば ENOTFOUND や TIMEOUT）を識別し、それに応じたエラーメッセージを出力しています。

例4: SOA レコードの特定のフィールドにアクセスする例

取得した SOA レコードから、特定のフィールドの値だけを取り出して使用する例です。

const dns = require('node:dns').promises;

async function getPrimaryNameServer(hostname) {
  try {
    const soaRecord = await dns.resolveSoa(hostname);
    console.log(`${hostname} のプライマリネームサーバー:`, soaRecord.nsname);
  } catch (error) {
    console.error(`${hostname} の SOA レコードの解決に失敗しました:`, error);
  }
}

getPrimaryNameServer('example.com');

コールバックベースの dns モジュールを使用する
dnsPromises.resolveSoa() は Promises API ですが、従来のコールバックベースの API も存在します。
サードパーティの DNS クライアントライブラリを使用する
Node.js の標準 dns モジュール以外にも、より高機能な DNS クライアントライブラリが npm エコシステムに存在します。

コールバックベースの dns モジュールを使用する

Promises API が導入される以前から、Node.js の dns モジュールはコールバック関数を受け取る形式のAPIを提供していました。dns.resolveSoa() の代わりに、dns.resolve() 関数と 'SOA' タイプ指定を組み合わせて同様の機能を実現できます。

const dns = require('node:dns');

dns.resolve('example.com', 'SOA', (err, addresses) => {
  if (err) {
    console.error('SOA レコードの解決に失敗しました:', err);
    return;
  }
  // resolveSoa は SOA レコードを直接オブジェクトとして返しますが、
  // resolve('SOA', ...) は SOA レコードのフィールドを含むオブジェクトの配列を返します。
  // 通常、SOA レコードは1つしか存在しないため、最初の要素を取り出します。
  const soaRecord = addresses[0];
  console.log('example.com の SOA レコード:', soaRecord);
  console.log('  プライマリネームサーバー:', soaRecord.nsname);
  console.log('  責任者のメールアドレス:', soaRecord.hostmaster);
  console.log('  シリアル番号:', soaRecord.serial);
  console.log('  リフレッシュ間隔:', soaRecord.refresh);
  console.log('  再試行間隔:', soaRecord.retry);
  console.log('  有効期限:', soaRecord.expire);
  console.log('  最小TTL:', soaRecord.minttl);
});

注意点

PromiseベースのAPIと比較して、コールバックベースのコードは非同期処理のフローを管理するためにネストが深くなる可能性があり、可読性や保守性が低下することがあります（いわゆる「コールバック地獄」）。
dns.resolve('SOA', ...) は、SOAレコードのフィールドを含むオブジェクトの配列を返します。通常、SOAレコードは1つしか存在しないため、結果配列の最初の要素 (addresses[0]) を使用します。
コールバックベースのAPIは、エラーファーストコールバックパターン（最初の引数がエラーオブジェクト、2番目以降が結果）を使用します。

サードパーティの DNS クライアントライブラリを使用する

npm エコシステムには、Node.js の標準 dns モジュールよりも高機能で、より柔軟なAPIを提供するDNSクライアントライブラリがいくつか存在します。これらのライブラリは、より詳細なDNS制御、異なるDNSプロトコル（例えば DNS-over-HTTPS や DNS-over-TLS）、キャッシュ機能などを提供する場合があります。

一般的なサードパーティの DNS クライアントライブラリの例としては以下のようなものがあります。

dnscache
DNSルックアップの結果をキャッシュすることで、パフォーマンスを向上させるためのライブラリ。
node-dns
より多くのDNSレコードタイプをサポートし、DNSサーバーとのより低レベルなインタラクションを可能にします。
dns-query
シンプルで軽量な DNS クエリライブラリ。PromiseベースのAPIも提供しています。

これらのライブラリを使用することで、標準の dns モジュールでは提供されていない機能を利用したり、より使いやすいAPIで DNS 関連の処理を記述したりすることができます。

例 (dns-query を使用する場合)

まず、ライブラリをインストールします。

npm install dns-query

そして、以下のように dns-query を使用して SOA レコードを取得できます。

const dnsQuery = require('dns-query');

async function getSoaRecordWithDnsQuery(hostname) {
  try {
    const response = await dnsQuery({
      operation: 'query',
      flags: { rd: true }, // Recursion Desired
      question: [{ name: hostname, type: 'SOA' }],
    });

    if (response.answers && response.answers.length > 0 && response.answers[0].type === 'SOA') {
      const soaRecord = {
        nsname: response.answers[0].data.mname,
        hostmaster: response.answers[0].data.rname.replace(/\./g, '@'),
        serial: response.answers[0].data.serial,
        refresh: response.answers[0].data.refresh,
        retry: response.answers[0].data.retry,
        expire: response.answers[0].data.expire,
        minttl: response.answers[0].data.minimum,
      };
      console.log(`${hostname} の SOA レコード (dns-query 使用):`, soaRecord);
    } else {
      console.log(`${hostname} の SOA レコードが見つかりませんでした。`);
    }
  } catch (error) {
    console.error(`${hostname} の SOA レコードの解決に失敗しました (dns-query 使用):`, error);
  }
}

getSoaRecordWithDnsQuery('example.com');

これらのライブラリは、標準モジュールよりも多くの依存関係を持つ可能性があります。
サードパーティのライブラリは、それぞれ異なるAPIを提供しているため、使用するライブラリのドキュメントをよく読む必要があります。

Node.js dnsモジュール解説：lookupService() の引数とコールバック

callback (Function): 非同期処理が完了した後に呼び出されるコールバック関数です。このコールバック関数は3つの引数を受け取ります。 err (Error | null): エラーが発生した場合、エラーオブジェクトが渡されます。成功した場合は null が渡されます。 hostname (string): IPアドレスに対応するホスト名です。逆引きに失敗した場合や情報がない場合は、IPアドレスがそのまま返されることがあります。 service (string): ポート番号に対応するサービス名です。例えば、ポート 80 なら 'http'、ポート 443 なら 'https' のような文字列が返されます。サービス名が特定できない場合は、ポート番号が文字列として返されることがあります。