Node.js socket.remoteFamilyのエラーとトラブルシューティング：undefinedになる？

2025-05-01

socket.remoteFamily は、Node.js の net.Socket オブジェクトのプロパティの一つで、リモートソケットのアドレスファミリを表します。簡単に言うと、「接続してきた相手（クライアント）のインターネットの住所の種類」を示す情報です。

具体的には、以下のいずれかの文字列の値を取ります。

"IPv6": リモートソケットのアドレスが IPv6 (Internet Protocol version 6) アドレスであることを示します。これは、コロンで区切られた8つの16進数（例: 2001:0db8:85a3:0000:0000:8a2e:0370:7334）で表現される形式です。
"IPv4": リモートソケットのアドレスが IPv4 (Internet Protocol version 4) アドレスであることを示します。これは、ピリオドで区切られた4つの数字（例: 192.168.1.1）で表現される形式です。

このプロパティは読み取り専用 (read-only) です。 つまり、コードから値を変更することはできません。接続が確立された時点で、Node.js が自動的にリモートソケットのアドレスファミリを判別し、このプロパティに値を設定します。

どのような時に socket.remoteFamily を使うのでしょうか？

主に、接続してきたクライアントが IPv4 アドレスを使用しているのか、それとも IPv6 アドレスを使用しているのかを判別したい場合に利用します。例えば、以下のようなケースが考えられます。

統計情報の収集
IPv4 と IPv6 の接続数の割合を分析したい場合。
特定の処理の分岐
IPv6 アドレスからの接続に対して特別な処理を行いたい場合。
ログ出力
接続元の IP アドレスの種類をログに記録したい場合。

簡単なコード例

const net = require('net');

const server = net.createServer((socket) => {
  console.log('クライアントが接続しました。');
  console.log(`リモートアドレス: ${socket.remoteAddress}`);
  console.log(`リモートポート: ${socket.remotePort}`);
  console.log(`リモートアドレスファミリ: ${socket.remoteFamily}`); // ここで remoteFamily を確認

  socket.on('data', (data) => {
    console.log(`受信したデータ: ${data}`);
    socket.write('データを処理しました。\n');
  });

  socket.on('end', () => {
    console.log('クライアントとの接続が閉じられました。');
  });
});

server.listen(3000, () => {
  console.log('サーバーがポート 3000 で起動しました。');
});

このコードを実行してクライアントから接続すると、コンソールにリモートアドレス、リモートポートに加えて、socket.remoteFamily の値 ("IPv4" または "IPv6") が表示されます。

以下に、よく見られる状況とトラブルシューティングのヒントを挙げます。

socket.remoteFamily が undefined になる場合

トラブルシューティング
- socket.remoteFamily にアクセスする前に、必ず 'connect' イベントリスナーの中や、createServer のコールバック関数内でアクセスするようにしてください。
- サーバー側の connection イベントリスナー内でアクセスするのが一般的です。
原因
socket オブジェクトは、'connect' イベントや 'connection' イベントが発生した後、リモートの情報が完全に利用可能になります。
状況
接続が完全に確立される前に socket.remoteFamily にアクセスしようとすると、値が undefined になることがあります。

IPv6 環境での誤解

トラブルシューティング
- socket.remoteFamily の値（"IPv4" または "IPv6"）を正確に確認し、それに基づいて処理を分岐するように実装してください。
- IPv6 を利用する場合は、Node.js の起動オプションやネットワークインターフェースの設定が IPv6 をサポートしているか確認してください。
- 特定のアドレスファミリでのみ通信を行いたい場合は、net.createServer() や net.connect() のオプションで family を指定できます。
原因
IPv4 と IPv6 のアドレス形式の違いを正しく理解していない場合や、環境設定が適切でない場合に起こります。
状況
IPv6 環境で、意図せず IPv4 アドレスとして扱ってしまう、またはその逆の処理をしてしまう。

特定のアドレスファミリでの接続を期待しているのに異なるファミリで接続される

トラブルシューティング
- server.listen() の引数を確認し、特定のアドレスファミリでのみリッスンしたい場合は、IP アドレスを明示的に指定してください。例えば、IPv6 のすべてのアドレスでリッスンする場合は '::', IPv4 のすべてのアドレスでリッスンする場合は '0.0.0.0'、特定の IPv6 アドレスの場合はそのアドレス、特定の IPv4 アドレスの場合はそのアドレスを指定します。
- オプションで family: 4 または family: 6 を指定することもできます。
原因
サーバーの listen 設定 (net.createServer().listen()) が適切でない可能性があります。特に、ホスト名に '::' (IPv6 のすべてのアドレス) や '0.0.0.0' (IPv4 のすべてのアドレス) を指定している場合に注意が必要です。
状況
サーバー側で IPv6 のみをリッスンするように設定したのに、IPv4 クライアントからの接続を受け付けてしまう、またはその逆。

ファイアウォールやネットワーク設定による問題

トラブルシューティング
- ネットワーク管理者やインフラ担当者に、ファイアウォールやネットワーク機器の設定を確認してもらい、必要なプロトコルとポートが許可されているか確認してください。
- クライアントとサーバーが異なるネットワークセグメントにある場合、ルーティングが正しく設定されているか確認してください。
原因
ファイアウォールのルールやルーティング設定が、特定の IP プロトコル (IPv4 または IPv6) を許可していない可能性があります。
状況
クライアントとサーバー間で、意図したアドレスファミリでの通信がファイアウォールやネットワーク機器によってブロックされる。

DNS 解決の問題

トラブルシューティング
- dns.lookup() 関数などを使って、ホスト名がどのように IP アドレスに解決されているかを確認してください。
- 必要であれば、dns.lookup() のオプションで family を指定して、特定のアドレスファミリでの解決を強制することもできます。
原因
DNS サーバーの設定や、OS の DNS 解決順序によって、ホスト名が IPv4 アドレスまたは IPv6 アドレスのどちらに解決されるかが変わる場合があります。
状況
ホスト名を使って接続しようとした際に、意図しない IP アドレスファミリに解決されてしまう。

socket.remoteFamily 自体のエラーは少ないですが、その値に基づいて処理を行う際に、接続のタイミング、アドレスファミリの理解、サーバーの listen 設定、ネットワーク環境などが複雑に絡み合って問題が発生することがあります。

トラブルシューティングの際は、以下の点を意識すると良いでしょう。

DNS 解決
ホスト名を使っている場合、期待する IP アドレスファミリに解決されているか。
ネットワーク環境
ファイアウォールやルーティングは適切に設定されているか。
サーバーの設定
server.listen() の設定は意図通りになっているか。
アドレスファミリの確認
実際にどのような値 ("IPv4" または "IPv6") が socket.remoteFamily に入っているかログ出力などで確認する。
接続イベントのタイミング
socket.remoteFamily にアクセスするタイミングは適切か。

例1: 接続元のアドレスファミリに応じてログ出力内容を変える

この例では、サーバーに接続してきたクライアントのアドレスファミリ (socket.remoteFamily) を確認し、それに応じてログのメッセージを変えています。

const net = require('net');

const server = net.createServer((socket) => {
  const remoteAddress = socket.remoteAddress;
  const remoteFamily = socket.remoteFamily;

  console.log(`クライアントが接続しました: ${remoteAddress} (${remoteFamily})`);

  if (remoteFamily === 'IPv4') {
    console.log('IPv4 アドレスからの接続です。');
  } else if (remoteFamily === 'IPv6') {
    console.log('IPv6 アドレスからの接続です。');
  }

  socket.on('data', (data) => {
    console.log(`受信データ: ${data}`);
    socket.write('データを処理しました。\n');
  });

  socket.on('end', () => {
    console.log('クライアントとの接続が閉じられました。');
  });
});

server.listen(3000, () => {
  console.log('サーバーがポート 3000 で起動しました。');
});

このコードを実行し、IPv4 アドレスまたは IPv6 アドレスを持つクライアントから接続すると、コンソールに接続元のアドレスとアドレスファミリ、そしてそれに応じたメッセージが出力されます。

例2: 特定のアドレスファミリからの接続のみを受け付ける (サーバー側)

この例では、サーバーが特定のインターフェース (例えば IPv6 のみ) でリッスンするように設定し、接続してきたクライアントのアドレスファミリを確認して、意図しないファミリからの接続であれば切断します。

const net = require('net');
const ipv6Address = '::1'; // IPv6 ローカルループバックアドレス

const server = net.createServer((socket) => {
  const remoteFamily = socket.remoteFamily;
  console.log(`クライアントが接続しました (ファミリ: ${remoteFamily})`);

  if (remoteFamily !== 'IPv6') {
    console.log(`IPv6 アドレスからの接続のみを受け付けます。${remoteFamily} からの接続を切断します。`);
    socket.end('IPv6 connections only.\n');
  } else {
    socket.on('data', (data) => {
      console.log(`受信データ: ${data}`);
      socket.write('IPv6 経由でデータを受信しました。\n');
    });

    socket.on('end', () => {
      console.log('クライアントとの IPv6 接続が閉じられました。');
    });
  }
});

server.listen(3000, ipv6Address, () => {
  console.log(`サーバーが ${ipv6Address} のポート 3000 で起動しました (IPv6 のみ)。`);
});

この例では、server.listen() の第二引数に IPv6 のアドレス (::1) を指定することで、IPv6 経由の接続のみを待ち受けます。接続してきたクライアントのアドレスファミリが "IPv6" でなければ、接続を切断します。

例3: クライアント側で接続するアドレスファミリを指定する

クライアント側で net.connect() または net.createConnection() を使用する際に、オプションで family を指定することで、接続を試みるアドレスファミリを限定できます。

const net = require('net');

// IPv4 アドレスへの接続を試みる
net.connect({ host: 'localhost', port: 3000, family: 4 }, (socket) => {
  console.log('IPv4 経由でサーバーに接続しました。');
  socket.write('IPv4 からのメッセージです。\n');
  socket.on('data', (data) => {
    console.log(`サーバーからの応答: ${data}`);
    socket.end();
  });
  socket.on('end', () => {
    console.log('IPv4 接続を閉じました。');
  });
  console.log(`リモートアドレスファミリ (クライアント側): ${socket.remoteFamily}`); // 接続確立後に確認
});

// IPv6 アドレスへの接続を試みる
net.connect({ host: '::1', port: 3000, family: 6 }, (socket) => {
  console.log('IPv6 経由でサーバーに接続しました。');
  socket.write('IPv6 からのメッセージです。\n');
  socket.on('data', (data) => {
    console.log(`サーバーからの応答: ${data}`);
    socket.end();
  });
  socket.on('end', () => {
    console.log('IPv6 接続を閉じました。');
  });
  console.log(`リモートアドレスファミリ (クライアント側): ${socket.remoteFamily}`); // 接続確立後に確認
});

この例では、net.connect() のオプションで family: 4 を指定すると IPv4 経由での接続を試み、family: 6 を指定すると IPv6 経由での接続を試みます。ただし、サーバー側が対応していないアドレスファミリを指定した場合、接続は失敗する可能性があります。また、クライアント側の socket.remoteFamily は、接続が確立した後にリモートサーバーのアドレスファミリを示す値になります。

socket.remoteAddress の形式から判断する

socket.remoteAddress プロパティには、接続してきたクライアントの IP アドレスが文字列として格納されています。この文字列の形式を調べることで、アドレスファミリを推測できます。

IPv6 アドレスの形式
コロン(:) で区切られた8つの16進数のグループ (例: 2001:0db8:85a3:0000:0000:8a2e:0370:7334)
IPv4 アドレスの形式
ピリオド(.) で区切られた4つの数字 (例: 192.168.1.1)

正規表現などを用いて socket.remoteAddress の形式をチェックすることで、アドレスファミリを判別できます。

const net = require('net');

const server = net.createServer((socket) => {
  const remoteAddress = socket.remoteAddress;
  let addressFamily;

  if (/^(\d{1,3}\.){3}\d{1,3}$/.test(remoteAddress)) {
    addressFamily = 'IPv4';
  } else if (/^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$|^::([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}$|^[0-9a-fA-F]{1,4}::([0-9a-fA-F]{1,4}:){0,5}[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){2}::([0-9a-fA-F]{1,4}:){0,4}[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){3}::([0-9a-fA-F]{1,4}:){0,3}[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){4}::([0-9a-fA-F]{1,4}:){0,2}[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){5}::([0-9a-fA-F]{1,4}:){0,1}[0-9a-fA-F]{1,4}$|^([0-9a-fA-F]{1,4}:){6}::[0-9a-fA-F]{1,4}$/.test(remoteAddress)) {
    addressFamily = 'IPv6';
  } else {
    addressFamily = '不明';
  }

  console.log(`接続元アドレス: ${remoteAddress} (推測されたアドレスファミリ: ${addressFamily})`);

  socket.on('data', (data) => {
    socket.write('データを処理しました。\n');
  });

  socket.on('end', () => {
    console.log('クライアントとの接続が閉じられました。');
  });
});

server.listen(3000, () => {
  console.log('サーバーがポート 3000 で起動しました。');
});

注意点
IPv6 の正規表現は複雑になるため、完全に網羅するには注意が必要です。また、この方法はあくまで文字列の形式から推測するものであり、socket.remoteFamily ほど直接的ではありません。

サーバーの listen アドレスに基づいて判断する

サーバーが特定のアドレスファミリでリッスンしている場合、そのサーバーに接続してきたクライアントのアドレスファミリも、通常はそのサーバーがリッスンしているファミリと一致します。

例えば、サーバーが IPv6 のすべてのアドレス (::) でリッスンしている場合、接続してくるクライアントも IPv6 アドレスを使用している可能性が高いです。同様に、IPv4 のすべてのアドレス (0.0.0.0) でリッスンしている場合は、IPv4 アドレスからの接続が多いと考えられます。

ただし、これはあくまで傾向であり、異なるアドレスファミリからの接続を完全に防ぐものではありません。

const net = require('net');
const listenAddressIPv6 = '::';
const listenAddressIPv4 = '0.0.0.0';

// IPv6 でリッスンするサーバー
const serverIPv6 = net.createServer((socket) => {
  console.log(`IPv6 サーバーに接続がありました。リモートアドレス: ${socket.remoteAddress}`);
  // ここでは IPv6 アドレスからの接続を前提とした処理を行う
  socket.end('IPv6 Server Response\n');
});

serverIPv6.listen(3001, listenAddressIPv6, () => {
  console.log(`IPv6 サーバーが ${listenAddressIPv6}:3001 で起動しました。`);
});

// IPv4 でリッスンするサーバー
const serverIPv4 = net.createServer((socket) => {
  console.log(`IPv4 サーバーに接続がありました。リモートアドレス: ${socket.remoteAddress}`);
  // ここでは IPv4 アドレスからの接続を前提とした処理を行う
  socket.end('IPv4 Server Response\n');
});

serverIPv4.listen(3000, listenAddressIPv4, () => {
  console.log(`IPv4 サーバーが ${listenAddressIPv4}:3000 で起動しました。`);
});

この例では、IPv6 用と IPv4 用のサーバーを別々に起動し、それぞれのアドレスファミリでの接続を前提とした処理を行っています。

dns.lookup() を使用して明示的にアドレスファミリを指定する (クライアント側)

クライアント側で接続先のホスト名を IP アドレスに解決する際に、dns.lookup() 関数のオプションで family を指定することで、特定のアドレスファミリの IP アドレスを取得できます。これにより、接続を試みる前にアドレスファミリを制御できます。

const net = require('net');
const dns = require('dns').promises;

async function connectIPv6() {
  try {
    const result = await dns.lookup('localhost', { family: 6 });
    const ipv6Address = result.address;
    const socket = net.connect({ host: ipv6Address, port: 3000 }, () => {
      console.log(`IPv6 経由でサーバー (${ipv6Address}) に接続しました。`);
      socket.write('IPv6 からのメッセージです。\n');
      socket.on('data', (data) => {
        console.log(`サーバーからの応答: ${data}`);
        socket.end();
      });
      socket.on('end', () => {
        console.log('IPv6 接続を閉じました。');
      });
    });
  } catch (error) {
    console.error('IPv6 アドレスの解決に失敗しました:', error);
  }
}

async function connectIPv4() {
  try {
    const result = await dns.lookup('localhost', { family: 4 });
    const ipv4Address = result.address;
    const socket = net.connect({ host: ipv4Address, port: 3000 }, () => {
      console.log(`IPv4 経由でサーバー (${ipv4Address}) に接続しました。`);
      socket.write('IPv4 からのメッセージです。\n');
      socket.on('data', (data) => {
        console.log(`サーバーからの応答: ${data}`);
        socket.end();
      });
      socket.on('end', () => {
        console.log('IPv4 接続を閉じました。');
      });
    });
  } catch (error) {
    console.error('IPv4 アドレスの解決に失敗しました:', error);
  }
}

connectIPv6();
connectIPv4();

この例では、dns.lookup() を使用して localhost の IPv6 アドレスと IPv4 アドレスをそれぞれ取得し、それらを使って明示的に特定のアドレスファミリでサーバーに接続を試みています。

socket.remoteFamily はリモートアドレスファミリを直接知るための最も簡単な方法ですが、代替手段として以下の方法があります。

dns.lookup() でアドレスファミリを指定する (クライアント側)
接続前に特定のアドレスファミリの IP アドレスを取得します。
サーバーの listen アドレスに基づいて判断する
サーバーがリッスンしているアドレスファミリを考慮します。
socket.remoteAddress の形式から推測する
正規表現などでアドレス文字列の形式をチェックします。