EMQX

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ

ExProto ゲートウェイ ​

Extension Protocol（ExProto）は、gRPC通信を用いて実装されたカスタムプロトコル解析ゲートウェイです。ユーザーはJava、Python、Goなどの好みのプログラミング言語でgRPCサービスを開発でき、これらのサービスはデバイスのネットワークプロトコルを解析し、デバイス接続、認証、メッセージ送信などの機能を実現します。

本ページでは、ExProtoゲートウェイの動作原理とEMQXにおけるExProtoゲートウェイの設定および利用方法を紹介します。

ExProtoゲートウェイとgRPCサービスの動作 ​

EMQXでExProtoゲートウェイを有効にすると、特定のポート（例：7993）でデバイス接続を待ち受けます。クライアントデバイスから接続があると、クライアントデバイスから生成されたバイトデータやイベントをユーザーのgRPCサービスに渡します。これはExProtoゲートウェイ内のgRPCクライアントが、ユーザーのgRPCサーバーで実装されたConnectionUnaryHandlerサービスのメソッドを呼び出すことで実現されます。

ユーザーのgRPCサーバーのgRPCサービスは、ExProtoゲートウェイから受け取ったバイトデータやイベントを解析し、クライアントのネットワークプロトコルを解釈してバイトデータやイベントをPub/Subリクエストに変換し、再びExProtoゲートウェイに送信します。ExProtoゲートウェイに実装されたConnectionAdapterサービスは、ユーザーのgRPCサーバーとやり取りするためのインターフェースを提供します。これにより、クライアントデバイスはEMQXにメッセージをパブリッシュしたり、トピックをサブスクライブしたり、クライアント接続を管理したりできます。

以下の図は、ExProtoゲートウェイとgRPCサービスの動作アーキテクチャを示しています。

exproto-gateway-architecture

exproto.proto ファイル ​

exproto.proto ファイルは、ExProtoゲートウェイとユーザーのgRPCサービス間のインターフェースを定義します。ファイルには以下の2つのサービスが指定されています。

  • ConnectionAdapter サービス：ExProtoゲートウェイが実装し、gRPCサーバーへのインターフェースを提供します。
  • ConnectionUnaryHandler サービス：ユーザーのgRPCサーバーが実装し、クライアントソケットの接続処理やバイト解析のメソッドを定義します。

ConnectionUnaryHandler サービス ​

ConnectionUnaryHandler サービスは、ユーザーのgRPCサーバーが実装し、クライアントソケットの接続処理やバイト解析を担当します。

このサービスには以下のメソッドが含まれます。

メソッド名説明
OnSocketCreated新しいソケットがExProtoゲートウェイに接続されるたびに呼び出されるコールバックです。
OnSocketClosedソケットが閉じられるたびに呼び出されるコールバックです。
OnReceivedBytesクライアントのソケットからデータを受信するたびに呼び出されるコールバックです。
OnTimerTimeoutタイマーがタイムアウトするたびに呼び出されるコールバックです。
OnReceivedMessagesサブスクライブしているトピックにメッセージが届くたびに呼び出されるコールバックです。

ExProtoゲートウェイがこれらのメソッドを呼び出す際、どのソケットがこのイベントを送信したかを識別するために、パラメータに一意の識別子connを渡します。例えば、OnSocketCreated関数のパラメータは以下のようになります。

message SocketCreatedRequest {
  string conn = 1;
  ConnInfo conninfo = 2;
}

TIP

ExProtoゲートウェイはプライベートプロトコルのメッセージフレームの開始と終了を認識できないため、TCPパケットのスティッキングや分割が発生した場合は、OnReceivedBytesコールバック内で処理する必要があります。

ConnectionAdapter サービス ​

ConnectionAdapter サービスはExProtoゲートウェイが実装し、gRPCサービスがサブスクライブ開始、メッセージパブリッシュ、タイマー開始、接続クローズなどの接続管理機能を呼び出せるようにします。以下のメソッドを含みます。

メソッド名説明
Send指定された接続にバイトデータを送信します。
Close指定された接続を閉じます。
AuthenticateクライアントをExProtoゲートウェイに登録し、認証を完了します。
StartTimer指定された接続のタイマーを開始します。通常はキープアライブ検出に使用します。
Publish指定された接続からEMQXにメッセージをパブリッシュします。
Subscribe指定された接続のサブスクリプションを作成します。
Unsubscribe指定された接続のサブスクリプションを削除します。
RawPublishEMQXにメッセージをパブリッシュします。

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

EMQXのExProtoゲートウェイは、ダッシュボード、REST API、または設定ファイルbase.hoconを通じて設定および有効化できます。本節ではダッシュボードを使ったExProtoゲートウェイの有効化方法を説明します。

EMQXダッシュボードの左側ナビゲーションメニューから Management -> Gateways をクリックします。Gateways ページにはすべてのサポートされているゲートウェイが一覧表示されます。ExProto を見つけ、Actions 列の Setup をクリックします。すると Initialize ExProto ページに遷移します。

TIP

EMQXをクラスターで運用している場合、ダッシュボードやREST APIで行った設定はクラスター全体に影響します。特定のノードだけ設定を変更したい場合は、base.hoconでゲートウェイを設定してください。

設定を簡略化するため、EMQXはGatewaysページのすべての必須項目にデフォルト値を提供しています。大幅なカスタマイズが不要であれば、以下の3クリックでExProtoゲートウェイを有効化できます。

  1. Basic Configuration ステップページで Next をクリックし、すべてのデフォルト設定を受け入れます。
  2. 続いて表示される Listeners ステップページでは、EMQXがポート7993でTCPリスナーを事前設定しています。ここでも Next をクリックして設定を確定します。
  3. Enable ボタンをクリックしてExProtoゲートウェイを有効化します。

有効化が完了すると、Gateways ページに戻り、ExProtoゲートウェイのステータスが Enabled と表示されていることを確認できます。

Enabled ExProto gateway

上記の設定はREST APIでも可能です。

例:

bash
curl -X 'PUT' 'http://127.0.0.1:18083/api/v5/gateway/exproto' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "exproto",
  "enable": true,
  "mountpoint": "exproto/",
  "server": {
    "bind": "0.0.0.0:9100"
  }
  "handler": {
    "address": "http://127.0.0.1:9001"
    "ssl_options": {"enable": false}
  }
  "listeners": [
    {
      "type": "tcp",
      "bind": "7993",
      "name": "default",
      "max_conn_rate": 1000,
      "max_connections": 1024000
    }
  ]
}'

詳細なREST APIの説明はREST APIを参照してください。

カスタマイズが必要で、リスナーを追加したり認証ルールを設定したい場合は、Customize Your ExProto Gatewayをお読みください。

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

デフォルト設定に加え、EMQXはさまざまな設定オプションを提供し、特定のビジネス要件に柔軟に対応できます。本節ではGatewaysページで利用可能な設定オプションを詳しく解説します。

基本設定 ​

GatewaysページでExProtoを見つけ、Actions列のSettingsをクリックします。Settingsタブでは、ConnectionUnaryHandlerサービスのアドレス、ConnectionAdapterのリスニングポート、ゲートウェイのMountPoint文字列をカスタマイズできます。

Basic Configuration
  • Enable Statistics：ゲートウェイによる統計収集と報告を許可するか設定します。デフォルトはtrue、選択肢はtrueまたはfalseです。
  • Idle Timeout：接続されたクライアントが非アクティブとみなされ切断されるまでの秒数を設定します。デフォルトは30秒です。
  • MountPoint：パブリッシュやサブスクライブ時にすべてのトピックにプレフィックスとして付加される文字列を設定します。これにより異なるプロトコル間でのメッセージルーティングの分離が可能です（例：mqttsn/）。このトピックプレフィックスはゲートウェイ側で管理され、クライアントは明示的に付加する必要はありません。
  • gRPC ConnectionAdapter：ConnectionAdapterサービス起動のための設定を行います。
    • Bind：gRPCサーバーのリスニングアドレスとポート。デフォルトは0.0.0.0:9100です。
      • TLS Verify Client：ピア認証を有効または無効にします。デフォルトは無効。有効にすると、TLS Cert、TLS Key、CA Certの情報をファイルの内容入力またはファイル選択ボタンでアップロードして設定できます。詳細はEnable SSL/TLS Connectionを参照してください。
  • gRPC ConnectionHandler：ConnectionUnaryHandlerを実装したコールバックサーバーの設定を行います。
    • Server：コールバックgRPCサーバーのアドレス。
      • Enable TLS：gRPCサーバーのTLS接続を有効にします。デフォルトは無効。有効にすると以下の設定が可能です。
        • TLS Verify：ピア認証の有効/無効。デフォルトは無効。有効にすると、TLS Cert、TLS Key、CA Certの情報をファイル内容入力またはファイル選択ボタンでアップロードして設定可能です。
        • SNI：TLS Server Name Indication拡張で使用するホスト名を指定します。

リスナーの追加 ​

デフォルトで、名前がdefaultのTCPリスナーがポート7993に設定されており、1秒あたり最大1,000接続、最大1,024,000同時接続をサポートしています。Listenersタブをクリックすると、リスナーの編集、削除、新規追加などのカスタマイズが可能です。

exproto-listener

+ Add ListenerをクリックするとAdd Listenerページが開き、以下の設定項目を入力できます。

基本設定

  • Name：リスナーの一意識別子を設定します。
  • Type：プロトコルタイプを選択します。ExProtoの場合はudpまたはdtlsが選択可能です。
  • Bind：リスナーが接続を受け付けるポート番号を設定します。
  • MountPoint（任意）：パブリッシュやサブスクライブ時にすべてのトピックに付加される文字列を設定し、異なるプロトコル間のメッセージルーティング分離を実現します。

リスナー設定

  • Acceptor：アクセプタープールのサイズを設定します。デフォルトは16です。
  • Max Connections：リスナーが処理可能な最大同時接続数を設定します。デフォルトは1024000です。
  • Max Connection Rate：リスナーが1秒あたり受け入れる新規接続の最大レートを設定します。デフォルトは1000です。
  • Proxy Protocol：EMQXクラスターがHAProxyやNGINXの背後にある場合、Proxy Protocol V1/V2を有効にします。デフォルトはfalseです。
  • Proxy Protocol Timeout：Proxy Protocolのタイムアウト時間。タイムアウト内にProxy Protocolパケットを受信できなければEMQXはTCP接続を切断します。デフォルトは3秒です。

TCP設定

  • ActiveN：ソケットの{active, N}オプションを設定します。これはソケットが能動的に処理可能な受信パケット数を意味します。詳細はErlang Documentation - setopts/2を参照してください。
  • Buffer：受信および送信パケットを格納するバッファサイズをKB単位で設定します。
  • TCP_NODELAY：接続に対してTCP_NODELAYフラグを設定します。デフォルトはfalseです。
  • SO_REUSEADDR：ローカルのポート番号の再利用を許可するか設定します。デフォルトはtrueです。
  • Send Timeout：接続のTCP送信タイムアウト時間を秒単位で設定します。デフォルトは15秒です。
  • Send Timeout Close：送信タイムアウト時に接続を閉じるか設定します。デフォルトはtrueです。

TLS設定（SSLリスナーのみ）

TLS Verifyの有効化はトグルスイッチで設定可能ですが、その前に関連するTLS Cert、TLS Key、CA Certの情報をファイル内容入力またはファイル選択ボタンでアップロードして設定する必要があります。詳細はEnable SSL/TLS Connectionを参照してください。

設定可能な項目は以下の通りです。

  • SSL Versions：サポートするTLSバージョンを設定します。デフォルトはtlsv1、tlsv1.1、tlsv1.2、tlsv1.3です。
  • SSL Fail If No Peer Cert：クライアントが空の証明書を送信した場合にEMQXが接続を拒否するか設定します。デフォルトはfalse、選択肢はtrueまたはfalseです。
  • CACert Depth：ピア証明書に続く有効な認証パスに含まれる自己署名でない中間証明書の最大数を設定します。デフォルトは10です。
  • Key File Passphrase：秘密鍵がパスワード保護されている場合に使用するパスワードを設定します。

認証の設定 ​

ExProtoゲートウェイは以下のような多様な認証方式をサポートしています。

クライアント情報のClient ID、Username、PasswordはすべてConnectionAdapterのAuthenticateメソッドで渡されるパラメータから取得されます。

本節ではダッシュボードを例に認証設定方法を説明します。

ExProtoページでAuthenticationタブをクリックします。

+ Create Authenticationをクリックし、MechanismにPassword-Basedを選択、BackendにHTTP Serverを選択してNextをクリックします。Configurationで認証ルールを設定します。各項目の詳細はHTTP Server Authenticationを参照してください。

mqttsn authentication

上記の設定はREST APIでも実施可能です。

例:

bash
curl -X 'POST' 'http://127.0.0.1:18083/api/v5/gateway/exproto/authentication' \
  -u <your-application-key>:<your-security-key> \
  -H 'Content-Type: application/json' \
  -d '{
  "method": "post",
  "url": "http://127.0.0.1:8080",
  "headers": {
    "content-type": "application/json"
  },
  "body": {
    "username": "${username}",
    "password": "${password}"
  },
  "pool_size": 8,
  "connect_timeout": "5s",
  "request_timeout": "5s",
  "enable_pipelining": 100,
  "ssl": {
    "enable": false,
    "verify": "verify_none"
  },
  "backend": "http",
  "mechanism": "password_based",
  "enable": true
}'

テスト用のサンプルgRPCサービスの起動 ​

本節では、ExProtoゲートウェイとgRPCサービスがどのように連携するかを示すため、サンプルgRPCサービスを起動する手順を紹介します。

この例では、telnetコマンドを使い、TCPプロトコルを用いてメッセージの送受信を行うクライアントをシミュレートします。実際の環境では、カスタムプライベートプロトコルを実装したデバイスがポート7993のTCPリスナーに接続します。ExProtoゲートウェイはポート7993でクライアント接続を受け付け、ポート9100でexproto.protoファイルで定義されたConnectionAdapterサービスを提供します。

emqx-extension-examplesには様々な言語で書かれたサンプルgRPCサービスがあります。本例ではPythonで実装されたエコープログラムexproto-svr-pythonを使い、ConnectionUnaryHandlerサービスを実装します。このプログラムはTCPクライアントから受け取ったデータをそのまま返します。実際の環境では、これらのアップストリームメッセージをEMQXにパブリッシュしたり、トピックをサブスクライブしてEMQXからのメッセージをクライアント接続に配信したりします。

以下はexproto-svr-pythonを例にした手順です。

前提条件

開始前に以下を完了していることを確認してください。

  • EMQX 5.1.0以上を起動し、デフォルト設定でExProtoゲートウェイを有効化していること。

  • Python 3.7以上をインストールし、以下の依存パッケージをインストールしていること。

    python -m pip install grpcio
python -m pip install grpcio-tools

  1. EMQXが動作している同じマシンで、サンプルコードをクローンしexproto-svr-pythonディレクトリに移動します。

    bash
    git clone https://github.com/emqx/emqx-extension-examples
cd exproto-svr-python

  2. 以下のコマンドでgRPCサーバーを起動します。

    python exproto_server.py

    正常に起動すると、以下のような出力が表示されます。

    ConnectionUnaryHandler started successfully, listening on 9001

Tips: If the Listener of EMQX ExProto gateway listen on 7993:
      You can use the telnet to test the server, for example:

      telnet 127.0.0.1 7993

Waiting for client connections...

  3. telnetコマンドでExProtoゲートウェイが待ち受けているポート7993にアクセスし、Hi, this is tcp client!と入力してgRPCサーバーが正常に動作しているかテストします。例：

    $ telnet 127.0.0.1 7993
Trying 127.0.0.1...
Connected to 127.0.0.1.
Escape character is '^]'.
Hi, this is tcp client!
Hi, this is tcp client!

  4. EMQXダッシュボードで左側ナビゲーションメニューから Management -> Gateways をクリックし、ExProtoのClientsをクリックします。ExProtoページで、telnetで接続したクライアントが表示されていることを確認できます。

    Connected ExProto Client

サンプルのシーケンス図 ​

以下の図は、本例における接続とメッセージ配信のシーケンスを示しています。

exproto-sequence-diagram> exproto-svr-python: Succeed

exproto-svr-python ->> ExProto Gateway: Call 'Subscribe' to subscribe 'test/echo' ExProto Gateway -->> exproto-svr-python: Succeed exproto-svr-python ->> ExProto Gateway: Call 'StartTimer' to start keepalive timer ExProto Gateway -->> exproto-svr-python: Succeed exproto-svr-python -->> ExProto Gateway: OnSocketCreated return end Telnet ->> ExProto Gateway: Send 'Hi, this is...' rect rgb(100,150, 240) ExProto Gateway ->> exproto-svr-python: Call OnReceivedBytes exproto-svr-python --> exproto-svr-python: Use 'Hi, this is...' to create a message exproto-svr-python ->> ExProto Gateway: Call Publish to publish message to 'test/echo' ExProto Gateway -->> ExProto Gateway: Route the message ExProto Gateway -->> exproto-svr-python: Succeed exproto-svr-python -->> ExProto Gateway: OnReceivedBytes return end rect rgb(100, 150, 200) ExProto Gateway ->> exproto-svr-python: Call OnReceivedMessages exproto-svr-python -->> exproto-svr-python: Use message payload exproto-svr-python ->> ExProto Gateway: Call Send to deliver bytes 'Hi, this is ...' ExProto Gateway -->> exproto-svr-python: Succeed ExProto Gateway ->> Telnet: Deliver 'Hi, this is...' exproto-svr-python -->> ExProto Gateway: OnReceivedMessages return end ```-->