EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

LDAPとの統合 ​

Lightweight Directory Access Protocol (LDAP) は、ディレクトリ情報にアクセスおよび管理するためのプロトコルです。EMQXは、パスワード認証のためにLDAPサーバーとの統合をサポートしています。この統合により、ユーザーはEMQXでの認証にLDAPの資格情報を使用できます。

前提条件

EMQX認証の基本概念に関する知識

パスワード認証方式 ​

EMQXのLDAP統合には、以下の2つの異なる認証方式があります。

  • LDAPバインド認証

    EMQXはLDAPバインドを直接使用してユーザー名とパスワードを認証します。クライアントが接続すると、EMQXは提供されたユーザー名とパスワードを受け取り、設定されたbase_dnとfilterを使って識別名（DN）を構築します。その後、これらの資格情報を用いてクライアントとしてLDAPサーバーにバインド（ログイン）を試みます。バインド操作が成功すれば認証が承認され、失敗すれば接続は拒否されます。

    この方式は既存のLDAPユーザーエントリのみに依存し、EMQXがパスワードハッシュなどの機密データを取得または処理する必要がありません。設定が簡単でLDAPスキーマの変更も不要です。

    以下のような場合に適しています。

    • ユーザーアカウントがすでにLDAPサーバーに存在している。
    • LDAPスキーマを変更または拡張できない。
    • 最小限の設定でLDAPサーバーに直接認証を任せたい。

  • ローカルパスワード比較

    EMQXはusernameとpasswordの設定オプションで指定されたバインドアカウント（バインドDN）を使ってLDAPサーバーに接続します。次にクライアントのLDAPエントリを検索し、特定の属性から保存されているパスワード（通常はハッシュ形式）を取得します。提供されたクライアントのパスワードと取得したハッシュをEMQX内でローカルに比較します。

    この方式は認証プロセスに対してより柔軟かつ詳細な制御を提供します。複雑な検証ロジックやセキュリティ戦略をサポートし、追加のユーザー属性も扱えます。例えば、EMQXはユーザーのisSuperUserフラグをパスワード照会時に取得できるため、認証時にユーザーがスーパーユーザー権限を持つかどうかを判定し、権限レベルに応じた異なるアクセスや操作を提供できます。

    以下のような場合に適しています。

    • カスタム認証属性（例：isSuperuser、ACLルール）を保存・処理する必要がある。
    • LDAPサーバーのスキーマやデータを設定する権限がある。
    • 単純なLDAPバインド以上の高度なセキュリティや検証ロジックが必要。

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

TIP

このセクションは「ローカルパスワード比較」認証方式に適用されます。「LDAPバインド認証」方式を使用する場合はこのセクションをスキップできます。

このセクションでは、LDAPスキーマの設定、LDAP資格情報の作成、およびパスワード認証用の資格情報の保存方法について説明します。

LDAPスキーマは、LDAPディレクトリ内で認証データを整理・保存するための構造とルールを定義します。LDAP認証機能はほぼすべてのLDAPスキーマをサポートしています。以下はOpenLDAPのスキーマ例です。

sql
attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.1.4 NAME 'isSuperuser'
	EQUALITY booleanMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.7
	SINGLE-VALUE
	USAGE userApplications )

objectclass ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4 NAME 'mqttUser'
	SUP top
	STRUCTURAL
	MAY ( isSuperuser )
    MUST ( uid $ userPassword ) )

上記のスキーマ例は、ユーザーがスーパーユーザーかどうかを示す属性isSuperuserを定義しています。また、ユーザーを表すオブジェクトクラスmqttUserを定義し、このオブジェクトクラスにはuserPassword属性が必須であることを示しています。

LDAP資格情報を作成するには、必要な属性名、ベースオブジェクトの識別名（dn）、およびLDAPクエリ用のフィルターを定義する必要があります。

以下は、OpenLDAP用のスキーマに基づいたLDAPデータ交換形式（LDIF）で指定されたLDAP資格情報のサンプルです。

sql
## 組織作成: emqx.io
dn:dc=emqx,dc=io
objectclass: top
objectclass: dcobject
objectclass: organization
dc:emqx
o:emqx,Inc.

## 組織単位作成: testdevice.emqx.io
dn:ou=testdevice,dc=emqx,dc=io
objectClass: top
objectclass:organizationalUnit
ou:testdevice

## ユーザー作成: mqttuser0001,
#         パスワード=mqttuser0001,
#         パスワードハッシュ={SHA}mlb3fat40MKBTXUVZwCKmL73R/0=
#         base64passhash=e1NIQX1tbGIzZmF0NDBNS0JUWFVWWndDS21MNzNSLzA9
dn:uid=mqttuser0001,ou=testdevice,dc=emqx,dc=io
objectClass: top
objectClass: mqttUser
uid: mqttuser0001
userPassword:: e1NIQX1tbGIzZmF0NDBNS0JUWFVWWndDS21MNzNSLzA9

## ユーザー作成: mqttuser0002
#         パスワード=mqttuser0002,
#         パスワードハッシュ={SSHA}n9XdtoG4Q/TQ3TQF4Y+khJbMBH4qXj4M
#         base64passhash=e1NTSEF9bjlYZHRvRzRRL1RRM1RRRjRZK2toSmJNQkg0cVhqNE0=
dn:uid=mqttuser0002,ou=testdevice,dc=emqx,dc=io
objectClass: top
objectClass: mqttUser
uid: mqttuser0002
userPassword:: e1NTSEF9bjlYZHRvRzRRL1RRM1RRRjRZK2toSmJNQkg0cVhqNE0=

## スーパーユーザー作成: mqttuser0003
#         パスワード=mqttuser0003,
#         パスワードハッシュ={MD5}ybsPGoaK3nDyiQvveiCOIw==
#         base64passhash=e01ENX15YnNQR29hSzNuRHlpUXZ2ZWlDT0l3PT0=
dn:uid=mqttuser0003,ou=testdevice,dc=emqx,dc=io
objectClass: top
objectClass: mqttUser
uid: mqttuser0003
isSuperuser: TRUE
userPassword:: e01ENX15YnNQR29hSzNuRHlpUXZ2ZWlDT0l3PT0=

LDAP設定ファイルslapd.confを編集して、スキーマとLDIFファイルを含めるようにし、LDAPサーバー起動時に読み込まれるようにします。以下はslapd.confの例です。

TIP

LDAP資格情報の保存方法やアクセス方法は、ビジネスニーズに応じて決定してください。

sh
include         /usr/local/etc/openldap/schema/core.schema
include         /usr/local/etc/openldap/schema/cosine.schema
include         /usr/local/etc/openldap/schema/inetorgperson.schema
include         /usr/local/etc/openldap/schema/emqx.schema

TLSCACertificateFile  /usr/local/etc/openldap/cacert.pem
TLSCertificateFile    /usr/local/etc/openldap/cert.pem
TLSCertificateKeyFile /usr/local/etc/openldap/key.pem

database mdb
suffix "dc=emqx,dc=io"
rootdn "cn=root,dc=emqx,dc=io"
rootpw {SSHA}eoF7NhNrejVYYyGHqnt+MdKNBh4r1w3W

directory       /usr/local/etc/openldap/data

ダッシュボードからLDAP認証を設定する ​

EMQXダッシュボードでLDAPをパスワード認証に使用する方法を設定できます。

  1. EMQXダッシュボードの左側ナビゲーションメニューから アクセス制御 -> 認証 をクリックします。

  2. EMQXダッシュボードの左側ナビゲーションメニューから アクセス制御 -> 認証 をクリックします。

  3. 認証 ページの右上にある 作成 をクリックします。

  4. メカニズムに Password-Based を、バックエンドに LDAP を選択し、設定タブに進みます。以下のように表示されます。

    authn-ldap

  5. 以下の指示に従って設定してください。

    • LDAPサーバーに接続するための情報を入力します。

      • サーバー：EMQXが接続するサーバーのアドレスを指定します（host:port形式）。

      • ユーザー名：EMQXがLDAPサーバーにバインドするために使用するアカウント名（バインドDN）を指定します。例：cn=root,dc=emqx,dc=io。このアカウントはユーザーエントリの読み取り権限を持っている必要があり、通常はLDAP設定ファイル（例：slapd.conf）で定義されたrootdnと同じです。

      • パスワード：上記ユーザー名に対応する平文パスワードで、バインド操作を完了するために使用します。この値はLDAP設定で定義されたrootpwの実際のパスワードと一致する必要があります。

      • ユーザー名: EMQXがLDAPサーバーにバインドするために使用するアカウント名（バインドDN）を指定します。例：cn=root,dc=emqx,dc=io。このアカウントはユーザーエントリの読み取り権限を持ち、通常はLDAP設定ファイル（例：slapd.conf）で定義されたrootdnと同じです。

      • パスワード認証方式：認証方式を選択します。LDAPバインド認証（デフォルト）またはローカルパスワード比較から選択可能です。

      • バインドパスワード：EMQXがLDAPサーバーに対して自身を認証するために使用するパスワードです。設定オプションのパスワードで定義された実際のパスワードに、プレースホルダー${password}を使って参照されます。

      • ベースDN：LDAP検索操作の開始点（ベースDN）を指定します。EMQXはこのDNから設定されたフィルターに合致するユーザーエントリの検索を開始します。${username}などのプレースホルダーを使ってクライアントIDを動的に構築することも可能です。詳細はRFC 4511 Search Requestを参照してください。

        TIP

        DNは識別名（Distinguished Name）を指します。これは各オブジェクトエントリの一意の識別子であり、情報ツリー内のエントリの位置も示します。

      • パスワードハッシュ属性：認証方式にローカルパスワード比較を選択した場合に適用される、ユーザーのパスワードを表す属性を指定します。この属性の値はRFC 3112に準拠している必要があり、サポートされるアルゴリズムはmd5、sha、sha256、sha384、sha512、sshaです。

      • スーパーユーザー属性：認証方式にローカルパスワード比較を選択した場合に適用される、ユーザーがスーパーユーザーかどうかを示す属性を指定します。この属性の値はブール値で表され、存在しない場合はfalseとみなされます。

      • クライアントID上書き属性：接続時にクライアントが提供したクライアントIDを上書きするために使用されるLDAP属性の名前を指定します。これにより認証データに基づいて一意のクライアントIDを割り当てられ、多様なテナント環境などでのセッション競合を防止できます。

      • 前提条件：Variform式を使って、このLDAP認証機能をクライアント接続に適用するかどうかを制御します。式はクライアントの属性（username、clientid、listenerなど）に対して評価され、結果が文字列の"true"の場合のみ認証機能が呼び出されます。そうでなければスキップされます。詳細は認証機能の前提条件を参照してください。

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

    • フィルター：LDAPクエリの条件を定義します。フィルターはエントリが条件を満たすかどうかを判定するための式で、構文はRFC 4515に準拠し、プレースホルダーもサポートします。

    • 詳細設定：同時接続数や接続タイムアウトまでの待機時間を設定します。

      • コネクションプールサイズ（任意）：EMQXノードからLDAPへの同時接続数を整数値で指定します。デフォルトは8です。
      • クエリタイムアウト（任意）：EMQXがクエリのタイムアウトとみなすまでの待機時間を秒単位で指定します。デフォルトは5秒です。

  6. 設定が完了したら、作成をクリックします。

設定項目によるLDAP認証の設定 ​

EMQXのLDAP認証機能は設定項目で構成可能です。

LDAP認証はmechanism = password_basedかつbackend = ldapで識別されます。

以下はローカルパスワード比較方式の設定例です。

bash
{
  backend = "ldap"
  mechanism = "password_based"
  method {
    type = hash
    password_attribute = "userPassword"
    is_superuser_attribute = "isSuperuser"
  }
  server = "127.0.0.1:389"
  query_timeout = "5s"
  username = "root"
  password = "root password"
  pool_size = 8
  base_dn = "uid=${username},ou=testdevice,dc=emqx,dc=io"
  filter = "(objectClass=mqttUser)"
}

以下はLDAPバインド認証方式の設定例です。

bash
{
  backend = "ldap"
  mechanism = "password_based"
  method {
    type = bind
    bind_password = "${password}"
  }
  server = "127.0.0.1:389"
  query_timeout = "5s"
  username = "root"
  password = "root password"
  pool_size = 8
  base_dn = "uid=${username},ou=testdevice,dc=emqx,dc=io"
  filter = "(objectClass=mqttUser)"
}

LDAPからACLルールを取得する ​

クライアントの認証に加えて、EMQXは認証時に使用した同じLDAPエントリからユーザーごとのACL（アクセス制御リスト）ルールを取得できます。これにより、認証と認可をLDAPで一元管理できます。

認証処理中に、EMQXは設定されたbase_dnとfilterを使ってユーザーのLDAPエントリを検索します。ACL関連の属性が見つかれば、それらを取得してクライアントのセッションにキャッシュします。このルールを使ってパブリッシュやサブスクライブの権限チェックを行い、LDAPへの繰り返しクエリを不要にします。

サポートされるACL属性 ​

LDAPからACLルールを取得する機能を有効にするには、LDAPスキーマに以下のいずれかの属性を定義する必要があります。

  • mqttPublishTopic：クライアントがパブリッシュを許可されているトピックのホワイトリスト。
  • mqttSubscriptionTopic：クライアントがサブスクライブを許可されているトピックのホワイトリスト。
  • mqttPubSubTopic：クライアントがパブリッシュおよびサブスクライブの両方を許可されているトピック。
  • mqttAclRule：JSON形式で定義された詳細なACLルール。アクション（パブリッシュまたはサブスクライブ）、許可（許可または拒否）、トピックフィルターなどを細かく制御可能。
  • mqttAclTtl：オプションの属性で、クライアントセッション内でACLルールが有効な期間（TTL）を指定。

上記の属性名はあくまで例です。LDAP認証機能の設定で適切なフィールドを使い、カスタマイズ可能です。

これらの属性の動作や意味はLDAPオーソライザーで定義されたものと同じですが、mqttAclTtlはLDAP認証機能固有の属性です。この属性により、取得したACLルールをクライアントのセッション内でどのくらいの期間キャッシュするかを制御できます。値は秒数の数値文字列（例：60）または1s、15m、1h、1dなどの時間単位付きの期間を指定可能です。

指定したTTLが経過すると、EMQXはキャッシュされたルールを使用せず、デフォルトの認可設定に戻ります。ただし、その後の認証やセッションで新しいルールが取得されれば再度キャッシュされます。

ACLルール用LDAPスキーマ例 ​

以下はACLルール用の属性を定義したスキーマ例です。

attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.1.4 NAME 'isSuperuser'
	EQUALITY booleanMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.7
	SINGLE-VALUE
	USAGE userApplications )
attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4.1 NAME ( 'mqttPublishTopic' 'mpt' )
	EQUALITY caseExactMatch
	SUBSTR caseExactSubstringsMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
	USAGE userApplications )
attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4.2 NAME ( 'mqttSubscriptionTopic' 'mst' )
	EQUALITY caseExactMatch
	SUBSTR caseExactSubstringsMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
	USAGE userApplications )
attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4.3 NAME ( 'mqttPubSubTopic' 'mpst' )
	EQUALITY caseExactMatch
	SUBSTR caseExactSubstringsMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
	USAGE userApplications )
attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4.4 NAME ( 'mqttAclRule' 'mar' )
	EQUALITY caseExactMatch
	SUBSTR caseExactSubstringsMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
	USAGE userApplications )
attributetype ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4.5 NAME ( 'mqttAclTtl' 'mat' )
	EQUALITY caseExactMatch
	SUBSTR caseExactSubstringsMatch
	SYNTAX 1.3.6.1.4.1.1466.115.121.1.15
	USAGE userApplications )
objectclass ( 1.3.6.1.4.1.11.2.53.2.2.3.1.2.3.4 NAME 'mqttUser'
	SUP top
	STRUCTURAL
	MAY ( isSuperuser $ mqttPublishTopic $ mqttSubscriptionTopic $ mqttPubSubTopic $ mqttAclRule $ mqttAclTtl )
  MUST ( uid $ userPassword ))

ACL属性を含むLDIFエントリ例 ​

以下は上記スキーマに基づくACL属性を含むLDAP認証データのLDAPデータ交換形式（LDIF）の例です。

sql
dn:dc=emqx,dc=io
objectclass: top
objectclass: dcobject
objectclass: organization
dc:emqx
o:emqx,Inc.

# testdevice.emqx.io作成
dn:ou=testdevice,dc=emqx,dc=io
objectClass: top
objectclass:organizationalUnit
ou:testdevice

## ユーザー作成: mqttuser0002
#         パスワード=mqttuser0002,
#         パスワードハッシュ={SSHA}n9XdtoG4Q/TQ3TQF4Y+khJbMBH4qXj4M
#         base64passhash=e1NTSEF9bjlYZHRvRzRRL1RRM1RRRjRZK2toSmJNQkg0cVhqNE0=
dn:uid=mqttuser0002,ou=testdevice,dc=emqx,dc=io
objectClass: top
objectClass: mqttUser
objectClass: mqttDevice
objectClass: mqttSecurity
uid: mqttuser0002
isEnabled: TRUE
mqttAccountName: user2
mqttPublishTopic: mqttuser0002/pub/1
mqttPublishTopic: mqttuser0002/pub/+
mqttPublishTopic: mqttuser0002/pub/#
mqttSubscriptionTopic: mqttuser0002/sub/1
mqttSubscriptionTopic: mqttuser0002/sub/+
mqttSubscriptionTopic: mqttuser0002/sub/#
mqttPubSubTopic: mqttuser0002/pubsub/1
mqttPubSubTopic: mqttuser0002/pubsub/+
mqttPubSubTopic: mqttuser0002/pubsub/#
mqttAclRule: [{"permission": "allow", "action": "pub", "topic": "mqttuser0002/complexrule1/1"}]
mqttAclRule: {"permission": "allow", "action": "pub", "topic": "mqttuser0002/complexrule2/#"}
mqttAclTtl: 1s
userPassword:: e1NTSEF9bjlYZHRvRzRRL1RRM1RRRjRZK2toSmJNQkg0cVhqNE0=

LDAP認証機能設定例 ​

ACLルールの取得とキャッシュを有効にするには、LDAP認証機能の設定で属性名を明示的に指定する必要があります。

bash
{
  backend = "ldap"
  mechanism = "password_based"
  method {
    type = hash
    password_attribute = "userPassword"
    is_superuser_attribute = "isSuperuser"
  }
  server = "127.0.0.1:389"
  query_timeout = "5s"
  username = "root"
  password = "root password"
  pool_size = 8
  base_dn = "uid=${username},ou=testdevice,dc=emqx,dc=io"
  filter = "(objectClass=mqttUser)"
  publish_attribute = "mqttPublishTopic"
  subscribe_attribute = "mqttSubscriptionTopic"
  all_attribute = "mqttPubSubTopic"
  acl_attribute = "mqttAclRule"
  acl_ttl_attribute = "mqttAclTtl"
}