LDAP シングルサインオン¶
LDAP(Lightweight Directory Access Protocol)は、さまざまなディレクトリサービスを処理するためのアプリケーションプロトコルです。Microsoft Entra ID は、Microsoft Entra ドメイン サービス(AD DS)を通じてこのモードをサポートしています。
デプロイメントプランでは、LDAP サービスを利用中のユーザーが、このプロトコルを使用してワンクリックでログインできます。必要な設定フィールドは以下のとおりです。
| フィールド | 説明 |
|---|---|
host |
LDAP サーバーのホスト名。ドメイン名、ldap://ドメイン名:ポート、ldaps://ドメイン名:ポート をサポートします。ポートを指定する必要がある場合は、アドレスに直接記述してください。独立した server.port の設定は有効になりません。 |
baseDN |
基本ディレクトリの場所。【フィールドの補足説明】を参照 |
bindDN |
LDAP サービスへの接続時に認証に使用するユーザー名情報(DN インターフェース)。 |
searchAttribute |
他のアカウントを検索する際に、アカウントをフィルタリングするために使用するエントリ名。このエントリ名は、ユーザーが入力したユーザー名と組み合わせて DIT エントリ情報を構成します(この値により、ユーザー名から一意のユーザーを特定できます)。 |
bindPassword |
LDAP サービスへの接続時に認証に使用するパスワード情報。 |
mapping |
アカウント属性のうち、プラットフォームにマッピングする必要がある属性フィールドのマッピング情報。 LDAP で返されるアカウント属性の属性値は通常リストです。プラットフォーム側で属性値が配列・リスト構造の場合は、デフォルトで最初の要素を値として処理します。【フィールドの補足説明 > 2. アカウント属性フィールド】を参照 |
フィールドの補足説明
-
ディレクトリ情報ツリー(DIT):DIT はファイルシステムに似た階層構造です。エントリを識別するには、エントリを表すリーフからツリーの最上位までのパスを DIT 内で指定する必要があります。このパスはエントリの識別名(DN)と呼ばれます。
- エントリの識別名(DN):エントリの名前と値のキーと値のペア(カンマ区切り)で構成され、リーフからツリーの最上位までのパスを構成します。エントリの DN は DIT 全体で一意であり、エントリが DIT 内の別のコンテナに移動された場合にのみ変更されます。
-
アカウント属性フィールド:
| プラットフォーム上のアカウント属性 | プラットフォーム側のフィールド説明 | LDAP サービス側で提供されるアカウント属性を ldap3 で変換した後の属性(デフォルトフィールド) |
|---|---|---|
username |
ログインアカウントのユーザー名。未返却の場合はメールアドレスからユーザー名を生成します | uid |
email |
ログインアカウントのメールアドレス属性。空でない値が返された場合は、有効なメールアドレスである必要があります | mail |
mobile |
認証サービスにおけるログインアカウントの電話番号フィールド名(任意) | mobile |
exterId |
認証サービスにおけるログインアカウントの一意の識別子フィールド名(必須) | uid |
認証方式の拡張¶
- LDAP マルチドメインコントローラ認証(デプロイメントプラン):同じ ID ディレクトリに複数のコントローラを設定し、ルールに従って切り替えます。
- LDAP カスタム認証と Func による属性加工(デプロイメントプラン):お客様の Func を使用して認証を実行するか、認証後のユーザー属性を加工します。
既存の単一アドレスデプロイメントをアップグレードする場合は、元の設定を保持できます。拡張機能を有効にする前に、対応するドキュメントのバージョン、互換性、検収要件を確認してください。
設定の詳細¶
Launcher の名前空間 forethought-core > core に以下の設定を追加します。設定変数の値は状況に応じて調整してください。
# LDAP クライアント設定(設定の詳細は https://ldap3.readthedocs.io/en/latest/server.html を参照)
LDAPClientSet:
# LDAP を有効にするかどうか。デフォルトでは無効
enable: false
# server のパラメータ形式は https://ldap3.readthedocs.io/en/latest/server.html に従います
server:
# LDAP サーバーのホスト名。ドメイン名、ldap://xxx、ldaps://xxx のいずれかを指定できます
host: "ipa.demo1.freeipa.org"
# 接続タイムアウト時間
connect_timeout: 6
# SSL を有効にするかどうかを制御します
use_ssl: false
# サーバースキーマとサーバー固有情報を読み取る必要があるかどうかを指定します(デフォルトは SCHEMA)。選択可能な値については https://ldap3.readthedocs.io/en/latest/server.html#server-object を参照
get_info: "SCHEMA"
tls:
# デフォルト値なし。クライアントの秘密鍵を含むファイルのパス
local_private_key_file:
# デフォルト値なし。サーバー証明書のファイルパス
local_certificate_file:
# デフォルト値なし。認証局(CA)証明書を含むファイルのパス
ca_certs_file:
# デフォルト値なし。使用する必要がある暗号を指定する文字列。最新の Python インタープリタに適用され、SSLContext または wrap_socket() メソッド内の暗号を変更できます。旧バージョンでは無視されます。デフォルト値なし
ciphers:
# サーバー証明書を検証する必要があるかどうかを指定します。選択可能な値:CERT_NONE(証明書を無視)、CERT_OPTIONAL(必須ではないが、提供された場合は検証)、CERT_REQUIRED(必須かつ検証)
validate: "CERT_REQUIRED"
# 使用する SSL または TLS のバージョン。次のいずれか:SSLv2、SSLv3、SSLv23、TLSv1(Python 3.3 に基づきます。バージョンのリストは他の Python バージョンでは異なる場合があります)。現在のデフォルトは TLS 1.2
version: "PROTOCOL_TLSv1_2"
connection:
# デフォルト値なし。Active Directory にアクセスする場合:ldap3 を使用すると、NTLM v2 プロトコルでも Active Directory サーバーに接続できます。その場合はここで NTLM を設定できます
authentication:
# authentication、sasl_mechanism、sasl_credentials はここでは https://ldap3.readthedocs.io/en/latest/bind.html?highlight=Active%20Directory#digest-md5 に従う必要があります
# デフォルト値なし。Active Directory にアクセスする場合、sasl_mechanism には DIGEST_MD5 を指定できます。デフォルト値なし
sasl_mechanism:
# Active Directory にアクセスする場合は、次の設定が必要です
# DIGEST-MD5 メカニズムを使用するには、sasl_credentials として 4 値または 5 値のタプルを渡す必要があります:(realm、user、password、authz_id、enable_signing)。使用しない場合は、'realm'、'authz_id'、'enable_signing' に None を渡すことができます:
sasl_credentials:
# 標準の接続に加えて TLS を有効にするかどうか。true の場合、LDAP との接続確立後に TLS をチェックして有効にします
startTls: false
baseDN: "dc=demo1,dc=freeipa,dc=org"
bindDN: "uid=admin,cn=users,cn=accounts,dc=demo1,dc=freeipa,dc=org"
bindPassword: "Secret123"
# アカウント検索に使用する属性。方法 1:`searchAttribute: uid` のように属性フィールド名のみを指定。方法 2:`searchAttribute: "(uid={username})"` のようにカスタムフィルタ文を指定。この方法では、括弧と中括弧内の username が必須です。
# 注意:AD ユーザーの場合は、通常 sAMAccountName に設定します
searchAttribute: "uid"
# アカウント検索時に、アカウント情報に対応するクラス名。注意:接続先が Microsoft AD 上の LDAP の場合は、実際のディレクトリ構成に応じて設定してください。例:person
# 確認方法:`ldapsearch`(サードパーティの LDAP 接続ツール)をインストールし、コマンド `ldapsearch -x -H ldap://xxx.cn:389 -D "bindDN信息" -w "bindPassword信息" -b "baseDN内容" "(cn=目标用户)"` を実行します。返された結果の objectClass が選択可能なリストです
personObjectClass: "inetOrgPerson"
mapping:
# 認証サービスにおけるログインアカウントのユーザー名フィールド名。必須。値が存在しない場合は email を使用します
username: uid
# 認証サービスにおけるログインアカウントのメールアドレスフィールド名。必須
email: mail
# 認証サービスにおけるログインアカウントの電話番号フィールド名。任意
mobile: mobile
# 認証サービスにおけるログインアカウントの一意の識別子フィールド名。必須
exterId: uid
SSL を有効にしない場合、イントラネットから LDAP サービスにアクセスするための設定例:
# LDAP クライアント設定(設定の詳細は https://ldap3.readthedocs.io/en/latest/server.html を参照)
LDAPClientSet:
# LDAP を有効にするかどうか。デフォルトでは無効
enable: true
# server のパラメータ形式は https://ldap3.readthedocs.io/en/latest/server.html に従います
server:
# LDAP サーバーのホスト名。ドメイン名、ldap://xxx、ldaps://xxx のいずれかを指定できます
# ローカル開発用アドレス。hosts にバインド:172.16.211.111 openldap-server
host: "<ドメイン名、または プロトコル+ドメイン名+ポート>"
# サーバースキーマとサーバー固有情報を読み取る必要があるかどうかを指定します(デフォルトは SCHEMA)。選択可能な値については https://ldap3.readthedocs.io/en/latest/server.html#server-object を参照
get_info: "ALL"
# 基本 DN 情報
baseDN: "<基本 DN>"
# クライアントが接続を確立するときにバインドされる DN
bindDN: "<クライアントが接続を確立するときにバインドされる DN>"
# bindDN に対応するパスワード
bindPassword: "<bindDN に対応するパスワード>"
# アカウント検索に使用する属性
searchAttribute: cn
# アカウント検索時に、アカウント情報に対応するクラス名。注意:接続先が Microsoft AD 上の LDAP の場合は、実際のディレクトリ構成に応じて設定してください。例:person
# 確認方法:`ldapsearch`(サードパーティの LDAP 接続ツール)をインストールし、コマンド `ldapsearch -x -H ldap://xxx.cn:389 -D "bindDN信息" -w "bindPassword信息" -b "baseDN内容" "(cn=目标用户)"` を実行します。返された結果の objectClass が選択可能なリストです
personObjectClass: "inetOrgPerson"
# アカウント属性が以下の表と一致しない場合は調整が必要です
mapping:
# 認証サービスにおけるログインアカウントのユーザー名フィールド名。必須。値が存在しない場合は email を使用します
username: cn
# 認証サービスにおけるログインアカウントのメールアドレスフィールド名。必須
email: mail
# 認証サービスにおけるログインアカウントの電話番号フィールド名。任意
mobile: mobile
# 認証サービスにおけるログインアカウントの一意の識別子フィールド名。必須
exterId: cn
LDAP シングルサインオンの利用¶
上記の設定を追加すると、LDAP シングルサインオンを利用できます。
1)デプロイメントプランのログイン URL を開き、ログインページで LDAP ログイン を選択します。
2)LDAP サーバーで使用するユーザー名とパスワードを入力します。
3)対応するワークスペースにログインします。