NATS プロトコルゲートウェイ

EMQX 5.10.0 以降、EMQX は NATS プロトコルに基づく NATS プロトコルゲートウェイを導入しました。これにより、EMQX は NATS クライアントからの接続を受け入れ、MQTT とのメッセージ相互運用を実現します。本ドキュメントでは、その機能を説明し、NATS ゲートウェイの有効化および設定方法について案内します。

機能概要

NATS プロトコルゲートウェイは現在、以下の主要な機能をサポートしています。

プロトコルサポート

NATS プロトコルのメッセージタイプを完全サポート：
- 接続およびセッション管理：INFO、CONNECT
- メッセージのパブリッシュ／サブスクライブ：PUB、HPUB、SUB、UNSUB
- メッセージ配信および応答：MSG、HMSG
- ハートビートおよびステータス：PING、PONG、+OK、-ERR
冗長モード（Verbose mode）対応：クライアントが CONNECT verbose=true で接続した場合に応答確認を有効化。
豊富な認証方式をサポート：Token、NKey、JWT、およびユーザー名／パスワード認証に対応。

MQTT との相互運用

MQTT との双方向メッセージ相互運用：
- NATS クライアントからパブリッシュされたメッセージは MQTT パブリッシュに変換されます。
- MQTT メッセージは対応するトピックをサブスクライブしている NATS クライアントに転送されます。
NATS のワイルドカードサブスクリプションをサポートし、自動的に MQTT 互換のトピック形式に変換。
Queue Group の共有サブスクリプションをサポート：NATS の Queue Group サブスクリプションは MQTT の共有サブスクリプション形式に変換されます。
リクエスト／リプライモードをサポート：
- NATS クライアントからのリクエストは MQTT リクエストに変換されます。
- 対象トピックに MQTT サブスクライバーが存在しない場合は、EMQX が迅速にエラー応答を返します。

ネットワークおよび接続性

複数のトランスポートプロトコルをサポート：TCP、TLS、WebSocket（WS）、および TLS 上の WebSocket（WSS）。

NATS と MQTT 間のクロスプロトコルメッセージング

NATS プロトコルはパブリッシュ／サブスクライブメッセージングモデルに完全対応しており、NATS ゲートウェイを介して MQTT メッセージングと相互運用が可能です。変換ルールは以下の通りです。

PUB および HPUB メッセージはパブリッシュ操作として扱われます：
- トピックは PUB メッセージの subject フィールドから派生します。例：t.a は MQTT トピック t/a に変換されます。
- メッセージペイロードは PUB メッセージ本文から直接取得されます。
- クライアントが CONNECT verbose=1 で接続している場合、変換後の MQTT メッセージは QoS 1 を使用し、そうでなければ QoS 0 となります。
SUB メッセージはサブスクリプション要求として扱われます：
- トピックは SUB メッセージの subject フィールドから派生します。例：t.a は MQTT トピック t/a に変換されます。
- QoS は同様に、verbose=1 で QoS 1、それ以外は QoS 0 となります。
- ワイルドカードをサポートします。例：*.b.> は +/b/# に変換されます。
- Queue Group をサポートします。SUB メッセージの Queue Group 値は MQTT 共有サブスクリプションのグループ名に変換されます。
UNSUB メッセージはサブスクリプション解除要求として扱われ、サブスクリプション ID（sid）で解除対象を特定します。

TIP

NATS ゲートウェイはパブリッシュ／サブスクライブ操作に対して独自のアクセス制御を実装していません。トピック権限は統一された認可設定で管理してください。

NATS ゲートウェイの有効化

EMQX 5.10.0 以降、NATS ゲートウェイは以下の3つの方法で有効化できます。

ダッシュボードから
REST API を使用して
base.hocon 設定ファイルを編集して

TIP

クラスター環境では、ダッシュボードや REST API で行った設定は自動的に全ノードに適用されます。特定ノードのみに設定を反映したい場合は、そのノードの base.hocon 設定ファイルを使用してください。

ダッシュボードからの有効化

EMQX ダッシュボードから NATS ゲートウェイを素早く有効化する手順は以下の通りです。

左メニューの管理 -> ゲートウェイ に移動します。
ゲートウェイ ページで NATS を見つけ、操作列の設定ボタンをクリックして NATS 初期設定 ウィザードを開きます。
ウィザードの手順に従います：
- 基本設定 ステップではデフォルト値を受け入れ、次へをクリック。
- リスナー ステップではリスナーを設定するかスキップして次へをクリック。（詳細なリスナー設定はリスナーの追加を参照してください。）
- 有効化 をクリックして NATS ゲートウェイを起動します。

有効化が完了すると、ゲートウェイ ページにリダイレクトされ、NATS ゲートウェイの状態が有効と表示されます。

REST API からの有効化

以下の例は REST API を使って NATS ゲートウェイを有効化する方法です。

bash

curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateway/nats' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "nats",
  "enable": true,
  "mountpoint": "nats/",
  "listeners": [
    {
      "type": "tcp",
      "name": "default",
      "bind": "4222",
      "max_conn_rate": 1000,
      "max_connections": 1024000
    }
  ]
}'

設定ファイルからの有効化

以下の設定例は base.hocon を使って NATS ゲートウェイを有効化する方法です。

properties

gateway.nats {

  mountpoint = "nats/"

  listeners.tcp.default {
    bind = 4222
    acceptors = 16
    max_connections = 1024000
    max_conn_rate = 1000
  }
}

NATS ゲートウェイは TCP、SSL、WS、WSS タイプリスナーをサポートします。設定可能なパラメータの完全なリストは、EMQX Enterprise 設定マニュアルのゲートウェイ設定 - リスナーセクションを参照してください。

NATS ゲートウェイのカスタマイズ

デフォルト設定に加え、EMQX は特定のビジネスニーズに合わせて柔軟に設定できるオプションを提供しています。本セクションでは、ゲートウェイ ページで利用可能な設定項目を詳述します。

基本設定

ゲートウェイ ページで NATS を見つけ、操作列の設定ボタンをクリックします。
設定タブで、ゲートウェイの接続パラメータ、マウントポイントプレフィックス、クライアント識別情報の上書きを設定できます。
- サーバー名：ゲートウェイの一意識別子で、内部参照用に使用されます。デフォルトは emq_nats_gateway です。
- マウントポイント：ゲートウェイを通過するすべてのトピックに自動的に付加される文字列プレフィックスです。これにより、プロトコル間のトピック分離が可能になります。例として nats/ を指定すると、クライアントが手動でプレフィックスを含めなくてもクロスプロトコルルーティングが可能です。
- デフォルトハートビート間隔：サーバーがクライアントの生存確認のために PING パケットを送信する間隔（秒）。デフォルトは 60 秒です。
- ハートビートタイムアウト閾値：クライアントがこの時間内に応答しない場合、切断と見なされます。
- 最大ペイロードサイズ：単一の PUB または HPUB メッセージペイロードの最大サイズ（バイト）。デフォルトは 1048576 バイトです。
- アイドルタイムアウト：非アクティブなクライアント接続が切断されるまでの秒数。デフォルトは 30 秒です。
- 統計情報の有効化：このゲートウェイの統計収集および報告を有効にするかどうか。デフォルトは有効です。
- クライアント情報の上書き：CONNECT パケットから認証情報を抽出する方法を定義します。
  TIP
  認証が有効な場合は、正しい username と password のフィールドマッピングを設定し、適切に資格情報が処理されるようにしてください。
  - ユーザー名：CONNECT パケットの user フィールドにマッピング。
  - パスワード：CONNECT パケットの pass フィールドにマッピング。
  - クライアント ID：${generated} を指定すると自動生成されます。カスタムロジックも設定可能です。
更新をクリックして変更を適用します。

リスナーの追加

リスナー タブでリスナーの編集、削除、新規追加が可能です。

リスナー タブで + リスナー追加 をクリックします。
リスナー追加 ダイアログで以下のオプションを設定します。
基本設定
- 名前：リスナーを識別する一意の名前。
- タイプ：リスナーの種類を選択。NATS でサポートされるのは tcp、ssl、ws、wss です。
- バインド：リスナーが接続を受け付けるポート番号。
リスナー設定
- 最大接続数：同時接続の最大数。デフォルトは 1024000。
- 最大接続レート（リスナー）：1秒あたりに受け入れる新規接続の最大数。デフォルトは 1000。
- プロキシプロトコル：Proxy Protocol v1/v2 の有効化。デフォルトは false。
- プロキシプロトコルタイムアウト：Proxy Protocol ヘッダー受信のタイムアウト。指定時間内にヘッダーが受信できない場合、接続を切断。デフォルトは 3 秒。
ピア検証設定（SSL および WSS リスナーのみ適用）
相互 TLS はデフォルトで有効です。TLS 証明書、秘密鍵、CA 証明書を設定する必要があります。これらはアップロードまたは直接フォームに貼り付け可能です。詳細は SSL/TLS 接続の有効化を参照してください。
- TLS 証明書：TLS 証明書のファイルパスまたは内容。
- TLS キー：TLS 秘密鍵のファイルパスまたは内容。
- CA 証明書：CA 証明書のファイルパスまたは内容。
- ピア証明書の強制検証：クライアント証明書検証の有無。デフォルトは true。
追加をクリックしてリスナー作成を完了します。

認証の設定

NATS ゲートウェイは以下の2種類の認証方式をサポートします。

ゲートウェイ認証（authentication）：EMQX ゲートウェイ認証機構で、主にユーザー名／パスワード形式のバックエンドに使用。
内部ゲートウェイ認証（internal_authn）：NATS ネイティブのユーザー名／パスワード以外の認証。

両方が有効な場合、EMQX は以下の順序で認証を評価します。

internal_authn のメソッドを上から順に評価。
必要な資格情報が不足している場合は次のメソッドを試行。
資格情報が存在するが検証に失敗した場合は即座に接続拒否。
すべての内部メソッドがスキップされ、かつ authentication が設定されていればゲートウェイ認証にフォールバック。
内部メソッドもゲートウェイ認証も設定されていなければ、すべての NATS クライアントの接続を許可。

ゲートウェイ認証の設定

他のゲートウェイ同様、NATS ゲートウェイは標準の EMQX 認証機構と統合可能です。以下の認証バックエンドをサポートします。

ゲートウェイ認証では、NATS の CONNECT パケットから以下のフィールドを抽出します。

クライアント ID：デフォルトで自動生成。
ユーザー名：user フィールドの値。
パスワード：pass フィールドの値。

MQTT プロトコルとは異なり、ゲートウェイ認証は単一の認証機構のみをサポートし、複数の認証機構のリスト（チェーン）はサポートしません。

ダッシュボードからの設定例

以下は HTTP サーバーを使ったパスワード認証の設定例です。

NATS ゲートウェイ設定の認証タブに移動。
+ 認証作成 をクリックし、メカニズムに パスワードベース を選択、データソースに HTTP サーバー を選択して次へをクリック。
設定パラメータを入力します。詳細は HTTP パスワード認証を参照してください。
作成をクリックし、設定内容を確認して更新をクリック。

REST API からの設定例

以下は組み込みデータベース認証を REST API で設定する例です。

bash

curl -X 'POST' \
  'http://127.0.0.1:18083/api/v5/gateway/nats/authentication' \
  -u <your-application-key>:<your-security-key> \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "backend": "built_in_database",
  "mechanism": "password_based",
  "password_hash_algorithm": {
    "name": "sha256",
    "salt_position": "suffix"
  },
  "user_id_type": "username"
}'

設定ファイルからの設定例

以下は設定ファイルで組み込みデータベース認証を設定する例です。

properties

gateway.nats {

  authentication {
    backend = built_in_database
    mechanism = password_based
    password_hash_algorithm {
      name = sha256
      salt_position = suffix
    }
    user_id_type = username
  }
}

その他の認証タイプについては、EMQX 認証機構のドキュメントを参照してください。

内部認証（`internal_authn`）の設定

これは NATS ゲートウェイ固有の認証機能で、NATS サーバーの標準的な3つの認証方式をサポートします。

トークン認証

NATS の CONNECT パケットの auth_token フィールドを使用。
プレーンなトークンと bcrypt ハッシュ（ $2a$ 、 $2b$ 、 $2y$ ）をサポート。
NATS リファレンス：Token authentication

ダッシュボード設定例：

nats-auth-token

設定ファイル例：

properties

gateway.nats {
  internal_authn = [
    {
      type = token
      token = "nats_token"
    }
  ]
}

NKey 認証

NATS の CONNECT パケットの nkey と sig チャレンジ／レスポンスを使用。
nkeys は有効な NATS ユーザーパブリックキー（U...）である必要があります。
NATS リファレンス：NKey authentication

ダッシュボード設定例：

nats-auth-nkey

設定ファイル例：

properties

gateway.nats {
  internal_authn = [
    {
      type = nkey
      nkeys = [
        "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
      ]
    }
  ]
}

JWT 認証（ACL サポート付き）

NATS の CONNECT パケットの jwt と sig（およびオプションの nkey）を使用。
信頼されたオペレーターリストと JWT プリロードリストの両方が必要。
リゾルバータイプは現在 memory のみサポートし、有効なアカウント JWT を設定で事前ロードします。
NATS リファレンス：JWT authentication

ダッシュボード設定例：

nats-auth-jwt

設定ファイル例：

properties

gateway.nats {
  internal_authn = [
    {
      type = jwt
      trusted_operators = [
        "Oxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
      ]
      resolver {
        type = memory
        resolver_preload = [
          {
            pubkey = "Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
            jwt = "<your-account-jwt>"
          }
        ]
      }
    }
  ]
}

JWT ユーザークレームは ACL ルールも保持可能です。EMQX は permissions および nats.pub / nats.sub クレームをサポートし、最終的な認可結果は JWT ACL と EMQX 認可ルールの積集合となります。

JWT ACL クレームの例：

json

{
  "sub": "Uxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "iss": "Axxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "nats": {
    "pub": {
      "allow": ["sensors.>"],
      "deny": ["sensors.secret.>"]
    },
    "sub": {
      "allow": ["alerts.>"],
      "deny": ["alerts.internal.>"]
    }
  }
}

ユーザーレベルインターフェースの設定

設定の完全なリファレンスは以下を参照してください： NATS ゲートウェイ設定
REST API の詳細は以下を参照してください：ゲートウェイ REST API ドキュメント

さらに詳しく

NATS プロトコルゲートウェイとそのユースケースについて詳しく知りたい場合は、以下のブログ記事をご覧ください： EMQX NATS Gateway: MQTT-NATS 双方向相互運用の実現。

Kubernetes

EMQX Operator

EMQX クラスター管理

API リファレンス

パスワード認証

監視

アクセスコントロール

統合

管理

OpenTelemetry との統合

エンドツーエンドトレース

プラグインカタログ

JT/T 808 ゲートウェイ

GB/T 32960 ゲートウェイ

Volcengine RTC

シナリオ

GPT-Realtime

NATS プロトコルゲートウェイ ​

機能概要 ​

プロトコルサポート ​

MQTT との相互運用 ​

ネットワークおよび接続性 ​

NATS と MQTT 間のクロスプロトコルメッセージング ​

NATS ゲートウェイの有効化 ​

ダッシュボードからの有効化 ​

REST API からの有効化 ​

設定ファイルからの有効化 ​

NATS ゲートウェイのカスタマイズ ​

基本設定 ​

リスナーの追加 ​

認証の設定 ​

ゲートウェイ認証の設定 ​

ダッシュボードからの設定例 ​

REST API からの設定例 ​

設定ファイルからの設定例 ​

内部認証（internal_authn）の設定 ​

トークン認証 ​

NKey 認証 ​

JWT 認証（ACL サポート付き） ​

ユーザーレベルインターフェースの設定 ​

さらに詳しく ​

NATS プロトコルゲートウェイ

機能概要

プロトコルサポート

MQTT との相互運用

ネットワークおよび接続性

NATS と MQTT 間のクロスプロトコルメッセージング

NATS ゲートウェイの有効化

ダッシュボードからの有効化

REST API からの有効化

設定ファイルからの有効化

NATS ゲートウェイのカスタマイズ

基本設定

リスナーの追加

認証の設定

ゲートウェイ認証の設定

ダッシュボードからの設定例

REST API からの設定例

設定ファイルからの設定例

内部認証（`internal_authn`）の設定

トークン認証

NKey 認証

JWT 認証（ACL サポート付き）

ユーザーレベルインターフェースの設定

さらに詳しく