Skip to content

Redisとの統合 ​

EMQXはパスワード認証のためにRedisとの統合をサポートしています。EMQXのRedis認証機能は現在、Single、Redis Sentinel、およびRedis Clusterの3つの異なるモードで動作するRedisへの接続をサポートしています。本セクションでは、サポートされているデータスキーマの詳細と、EMQXダッシュボードおよび設定ファイルでの設定方法について説明します。

前提条件:

EMQX認証の基本概念の知識

データスキーマとクエリ文 ​

Redis認証は、あらかじめ定義されたフィールド名を持つRedisハッシュとして保存された認証情報を使用します。

  • password_hash:必須。データベースに保存されるパスワード(プレーンテキストまたはハッシュ化済み)。
  • salt:任意。salt = "" またはこのフィールドを削除すると、ソルト値が追加されないことを示します。
  • is_superuser:任意。現在のクライアントがスーパーユーザーかどうかのフラグ。デフォルトは false。

例えば、ユーザー名 user123、パスワード secret、プレフィックスとしてのソルト salt、パスワードハッシュ sha256 を持つスーパーユーザー(is_superuser: true)のドキュメントを追加する場合、クエリ文は以下のようになります。

bash
>redis-cli
127.0.0.1:6379> HSET mqtt:user123 is_superuser 1 salt salt password_hash ac63a624e7074776d677dd61a003b8c803eb11db004d0ec6ae032a5d7c9c5caf
(integer) 3

対応する設定パラメータは以下の通りです。

password_hash_algorithm {
    name = sha256
    salt_position = prefix
}

cmd = "HMGET mqtt:${username} password_hash salt is_superuser"

TIP

password_hash という名前はハッシュ化されたパスワードを保存することを意図していますが、RedisにはMySQLのような as 構文がないため、EMQX 5.0では互換性を保つためにEMQX 4.xの password フィールドもサポートしています。

そのため、cmd を HMGET mqtt:${username} password salt is_superuser と設定することも可能です。

読み取り専用のデータベース権限を付与する

EMQXはクライアント認証時にRedisへの読み取りアクセスのみを必要とします。cmd で許可されるコマンドは HGET と HMGET のみであり、その他のコマンドは拒否されるため、認証時にRedisへの書き込みは行われません。

Redis 6.0以降では、EMQX用に専用ユーザーを設定し、EMQXが実行するヘルスチェックやクエリコマンド、および cmd で読み取るキーに対してのみ権限を制限してください。

bash
redis-cli ACL SETUSER emqx_auth reset on '>PASSWORD' '~mqtt:*' +ping +hget +hmget

Redis Clusterの場合、EMQXはハッシュスロットとRedisノード間のマッピングを取得・更新するために CLUSTER SLOTS を実行するため、+cluster|slots 権限も付与してください。

bash
redis-cli ACL SETUSER emqx_auth '+cluster|slots'

SingleまたはSentinelモードで database が0以外に設定されている場合、EMQXは接続後に SELECT を実行するため、Redisデータノードのユーザーに +select 権限を付与してください。デフォルトのデータベース0を使用している場合は不要です。

SentinelモードでSentinelノードに認証が有効な場合は、Sentinel接続用の認証情報を sentinel_username と sentinel_password で設定してください。これらはRedisデータノード接続時の username と password とは別の認証情報です。

ユーザーレコードの管理には別の管理ユーザーを使用してください。EMQX設定内のRedis認証情報が漏洩しても、読み取り専用ユーザーでは認証データの変更や削除はできません。

ダッシュボードでの設定 ​

EMQXダッシュボードを使ってRedisをパスワード認証に利用する設定が可能です。

  1. EMQXダッシュボードの左ナビゲーションメニューから アクセス制御 -> 認証 をクリックします。
  2. 認証 ページの右上にある 作成 をクリックします。
  3. メカニズム に パスワードベース を選択し、バックエンド に Redis を選択すると、以下のように 設定 タブが表示されます。
Redisを使った認証

以下の指示に従って認証の設定を行ってください。

接続:Redisへの接続情報を入力します。

  • Redisモード:Redisの展開形態を選択します。Single、Sentinel、Cluster のいずれかです。

  • サーバー:EMQXが接続するRedisサーバーのアドレスを指定します。Redisモード が Sentinel または Cluster の場合は、接続するすべてのRedisサーバーをカンマ(,)区切りで入力してください。

  • Sentinel名:使用するSentinelの名前を指定します。文字列型で、Redisモード が Sentinel の場合のみ必要です。

  • データベース:Redisのデータベース名を指定します。文字列型です。

  • ユーザー名:Redis接続に使用するユーザー名を指定します。Redis 6.0で導入されたRedis ACLを利用している場合は必須です。デフォルトユーザー(ACLが無効または適用されていない)を使用している場合は空欄のままで構いません。

    TIP

    username フィールドはEMQX 5.2.0以降でサポートされています。Redis ACLを利用する場合は、このバージョン以降でのデプロイを確認してください。

  • パスワード:Redisユーザーのパスワードを指定します。認証が有効なRedisインスタンスに接続する場合は必須です。

    • ユーザー名を入力した場合は、Redis ACL設定の認証情報と一致する必要があります。
    • ユーザー名がない場合は、default ユーザーとして認証されます(有効な場合)。

TLS設定:TLSを有効にする場合はトグルスイッチをオンにしてください。TLSの有効化方法については、ネットワークとTLSを参照してください。

接続設定:同時接続数を設定します。

  • プールサイズ(任意):EMQXノードからRedisサーバーへの同時接続数を指定します。デフォルトは 8 です。

認証設定:認証に関する設定を行います。

  • パスワードハッシュ:プレーンテキストのパスワードに適用され、データベースに保存される前に変換されるハッシュアルゴリズムを選択します。利用可能なオプションは plain、md5、sha、sha256、sha512、bcrypt、pbkdf2 です。選択したアルゴリズムに応じて追加設定があります。
    • md5、sha、sha256、sha512 の場合:
      • ソルト位置:ソルト(ランダムデータ)をパスワードにどのように混ぜるかを指定します。suffix、prefix、disable のいずれかです。外部ストレージからEMQX組み込みデータベースにユーザー認証情報を移行する場合を除き、デフォルト値のままで問題ありません。
      • ハッシュ結果は16進数文字列で表現され、大文字・小文字を区別せずに保存された認証情報と比較されます。
    • plain の場合:
      • ソルト位置 は disable にしてください。
    • bcrypt の場合:
      • ソルトラウンド数:ハッシュ関数の適用回数を定義します。値は 2^ソルトラウンド数 で表され、「コストファクター」とも呼ばれます。デフォルトは 10、許容範囲は 5 から 10 です。セキュリティ強化のためにはより高い値が推奨されます。コストファクターを1上げるごとに認証に要する時間が倍増します。
    • pbkdf2 の場合:
      • 疑似乱数関数:キー生成に使用するハッシュ関数を選択します(例:sha256)。
      • 反復回数:ハッシュ関数の実行回数を設定します。デフォルトは 4096 です。
      • 生成キー長(任意):生成されるキーのバイト長を指定します。空欄の場合は疑似乱数関数により決定される長さになります。
      • ハッシュ結果は16進数文字列で表現され、大文字・小文字を区別せずに保存された認証情報と比較されます。
  • CMD:Redisのクエリコマンドを指定します。

設定が完了したら、作成 をクリックしてください。

設定項目による設定 ​

EMQXの設定項目を使ってRedis認証を設定できます。

Redis認証は mechanism = password_based と backend = redis で識別されます。

EMQXは3種類のRedisインストール形態に対応しています。