この TestRail スクリプトを使用すると、TestRail と LDAP ディレクトリ サービスを統合してシングル サインオンを実装し、新規 TestRail ユーザー アカウントを作成できます。以下のセクションでは、LDAP ディレクトリと統合、設定、およびカスタマイズする方法について説明します。TestRail 認証スクリプトの詳細については、詳細な実装ガイドを参照してください。
Microsoft Active Directory と統合する場合、代わりに専用の Active Directory 統合スクリプト を使用します。
注意： 認証は LDAP によって行いますが、さらに、各ユーザーには有効な TestRail ユーザー アカウントが必要です。TestRail 固有のユーザー設定を行ったりするために、TestRail のユーザー アカウントは依然として必要です。TestRail の認証モジュールを使用すると、必要に応じて、ユーザーの介入なしにスクリプトでユーザー アカウントを作成できます。この LDAP 用の認証スクリプトは、この機能を完全にサポートしています。
ダウンロード
LDAP 認証スクリプトの最新版は、次の場所からダウンロードできます。
要件
このスクリプトを使用するには、いくつかの要件を満たす必要があります。LDAP プロトコルを使用するので、PHP LDAP 拡張がインストールされている必要があります。Linux で TestRail をホストしている場合は、通常、パッケージ マネージャーを使用して LDAP パッケージをインストールできます。
Ubuntu の場合：
sudo apt-get install php7.2-ldap
Windwos Server を使用して TestRail をホストしている場合は、LDAP 拡張機能を手動でインストールする必要があります。PHP.net から必要な php_ldap.dll ファイルを取得できます。 (PHP7.x,VC9 x86 Non Thread Safe用のファイルが必要です) 拡張機能を PHP の ext ディレクトリに配置して PHP.ini に追加した後、IIS を再起動するのを忘れないでください。
あるいは、Microsoft の Web Platform Installer を使用して PHP をインストールした場合は、Windows のコントロール パネルから [プログラムと機能] を選択することもできます。PHPを 右クリックし、[変更] を選択して LDAP 拡張機能をインストールします。
TestRail はユーザーの電子メール アドレスを一意のアカウント ID として使用するため、TestRail は認証にユーザーの電子メール アドレスを必要とします。このスクリプトは、LDAP ユーザーの email address フィールドに有効な一意の電子メール アドレスがあることを想定しています。まだ電子メール アドレスのフィールドがない場合は、LDAP ディレクトリのユーザー オブジェクトに電子メール アドレスを追加してください。あるいは、このスクリプトを変更して、ログイン名に基づいて電子メール アドレスを自動的に生成することもできます。
設定
スクリプトをインストールする前に (インストール手順については次のセクションを参照してください)、LDAP の設定に合わせてスクリプトを設定する必要があります。それには、テキスト エディターでスクリプトを開き、ファイルの先頭にある設定を変更します。次の表に定数の説明を示します。
| 定数 | 説明 |
|---|---|
AUTH_HOST |
LDAP サーバーの完全修飾ドメイン名です。例: ldap://ldap.example.com |
AUTH_PORT |
ディレクトリ サーバーの LDAP ポートです。通常は 389 です。 |
AUTH_BIND_DN |
ディレクトリからユーザー オブジェクトを照会するために使用されるユーザーアカウントの LDAP 識別名です。 |
AUTH_BIND_PASSWORD |
ディレクトリからユーザー オブジェクトを照会するために使用されるユーザーアカウントのパスワードです。AUTH_BIND_DN と AUTH_BIND_PASSWORD の両方が空白の場合、TestRail は匿名認証を使用しようとします。 |
AUTH_DN |
ユーザーを検索して認証するためのベース LDAP 識別名です。少なくともトップ OU、CN および/または DC エントリが含まれていなければなりません。通常、組織名と組織単位 (OU) が含まれます。例 1: OU=people,DC=example,DC=com 例 2: DC=example,DC=com |
AUTH_FILTER |
認証されたユーザーのディレクトリ オブジェクトを検索して取得するために使用されるフィルター式です。式は一般的な LDAP フィルターの構文に従う必要があります。検索を実行すると、プレースホルダー ％name％ が TestRail のログイン ページで入力されたユーザー名に置き換えられます。例：(&(uid=%name%)(objectClass=posixAccount)) |
AUTH_CREATE_ACCOUNT |
この設定は、ユーザーが正常に認証された場合に、TestRail が新しいユーザー アカウントを自動的に作成するかどうかを指定します。これは、TestRail アカウントを手動で作成することなく、組織で必要なすべてのユーザー アカウントを作成する優れた方法です。このオプションを true に設定して、すべてのユーザーに TestRail の Web アドレスを含む電子メールを送信します。ユーザーのアカウントは、最初にログインしたときに自動的に作成されます。 |
AUTH_FALLBACK |
LDAP ログインに加えて、ユーザーが自分の TestRail 認証情報を使用してログインを続行できるようにします。有効になっている場合、電子メールアドレスが入力されると、TestRail 自体の 認証情報を使用してユーザーの認証が試みられます。ユーザー名が入力されると、TestRail は LDAP でユーザーを認証します。 |
AUTH_NAME_ATTRIBUTE |
ユーザーのフルネームを格納する属性の名前です。この属性は、新しい TestRail ユーザー アカウントを作成するときに使用されます。 |
AUTH_MAIL_ATTRIBUTE |
ユーザーの電子メール アドレスを格納する属性の名前です。この属性は、LDAP ユーザー レコードと TestRail ユーザー アカウントをリンクするために使用されます。 |
インストール
スクリプトのインストールは、TestRail インストールディレクトリ直下の /custom/auth/ にスクリプトを置くだけです。スクリプトが TestRail に追加されると、ユーザー認証に使用されます。TestRail の [管理] > [サイト設定] > [ログイン] で、認証スクリプトのパスとステータスを確認することもできます。
スクリプトを無効にするには、auth.php ファイルを削除するか名前を変更します。これでユーザーは自分の電子メール アドレスと TestRail パスワードでログインできるようになります。