この TestRail スクリプトを使用すると、TestRail と Active Directory サービスを統合してシングル サインオンを実装し、新規 TestRail ユーザー アカウントを作成できます。以下のセクションでは、Active Directory と統合、設定、およびカスタマイズする方法について説明します。TestRail 認証スクリプトの詳細については、詳細な実装ガイドを参照してください。
注意: 認証は Active Directory によって行いますが、さらに、各ユーザーには有効な TestRail ユーザー アカウントが必要です。TestRail 固有のユーザー設定を行ったりするために、TestRail のユーザー アカウントは依然として必要です。TestRail の認証モジュールを使用すると、必要に応じて、ユーザーの介入なしにスクリプトでユーザー アカウントを作成できます。この ActiveDirectory 用の認証スクリプトは、この機能を完全にサポートしています。
ダウンロード
Active Directory 認証スクリプトの最新版は、次の場所からダウンロードできます。
要件
このスクリプトを使用するには、いくつかの要件を満たす必要があります。Active Directory のディレクトリ サービスは LDAP プロトコルを使用して照会されるため、TestRail と Active Directory を統合するには、PHP LDAP 拡張機能が必要です。Linux で TestRail をホストしている場合は、通常、パッケージ マネージャーを使用して LDAP パッケージをインストールできます。
Ubuntu の場合:
$ sudo apt-get install php7.2-ldap
Windows Server を使用して TestRail をホストしている場合は、LDAP 拡張機能はすでに PHP と一緒にインストールされています。PHP.ini ファイルで拡張機能を有効にするだけです。それには、PHP.ini ファイルに次の行を追加します。
extension=php_ldap.dll
変更を有効にするために IIS を再起動することを忘れないでください。
最近のバージョンの PHP および Windows では、Windows のコントロールパネルから [プログラムと機能] を選択できます。PHPを 右クリックし、[変更] を選択して LDAP 拡張機能をインストールします。
Active Directory:TestRail はユーザーの電子メールアドレスを一意のアカウント ID として使用するため、TestRail は認証にユーザーの電子メールアドレスを必要とします。このスクリプトは、Active Directory ユーザーの Email Address フィールドに有効な一意の電子メールアドレスがあることを想定しています。まだ電子メール アドレスのフィールドがない場合は、Active Directory のユーザー オブジェクトに電子メール アドレスを追加してください。あるいは、このスクリプトを変更して、ログイン名に基づいて電子メールアドレスを自動的に生成することもできます。
設定
スクリプトをインストールする前に (インストール手順については次のセクションを参照してください)、Active Directory の設定に合わせてスクリプトを設定する必要があります。それには、テキスト エディターでスクリプトを開き、ファイルの先頭にある設定を変更します。
次の表に定数の説明を示します。
定数 | 説明 |
---|---|
AUTH_HOST |
Active Directory サーバーの完全修飾ドメイン名です。例:ad1.directory.example.com |
AUTH_PORT |
ディレクトリ サーバーの LDAP ポートです。通常は 389 です。 |
AUTH_DN |
ユーザーを検索して認証するためのベース LDAP 識別名です。少なくともトップ OU、CN および/または DC エントリが含まれていなければなりません。通常、ドメイン名、組織名、または Users グループが含まれます。例 1: CN=Users,DC=directory,DC=example,DC=com
例 2: OU=Example Inc,DC=directory,DC=example,DC=com 特定のユーザーに TestRail による認証を許可する場合は、特定のユーザー グループを指定することもできます。 |
AUTH_DOMAIN |
Windows で使用されるドメイン名 (directorybob など、ユーザー名の接頭辞としてよく使用される名前) です。例:directory |
AUTH_CREATE_ACCOUNT |
この設定は、ユーザーが正常に認証された場合に、TestRail が新しいユーザー アカウントを自動的に作成するかどうかを指定します。これは、TestRail アカウントを手動で作成することなく、組織で必要なすべてのユーザー アカウントを作成する優れた方法です。このオプションを true に設定して、すべてのユーザーに TestRail の Web アドレスを含む電子メールを送信します。ユーザーのアカウントは、最初にログインしたときに自動的に作成されます。 |
AUTH_FALLBACK |
Active Directory ログインに加えて、ユーザーが自分の TestRail 認証情報を使用してログインを続行できるようにします。有効になっている場合、電子メールアドレスが入力されると、TestRail 自体の 認証情報を使用してユーザーの認証が試みられます。ユーザー名が入力されると、TestRail は Active Directory でユーザーを認証します。 |
AUTH_MEMBERSHIP |
オプションとして、ユーザーが指定されたセキュリティ グループのメンバーであるかどうかを確認します。すべての memberOf 値と比較してチェックされる正規表現を指定する必要があります。エントリの 1 つが一致すると、ユーザーは認証されます。どの memberOf 値も一致しない場合、アクセスは拒否されます。例:/^CN=My Group,/ |
インストール
スクリプトのインストールは、TestRail インストールディレクトリ直下の custom/auth/ にスクリプトを置くだけです。スクリプトが TestRail に追加されると、ユーザー認証に使用されます。TestRail の [管理] > [サイト設定] > [ログイン] で、認証スクリプトのパスとステータスを確認することもできます。スクリプトを無効にするには、 auth.php ファイルを削除するか名前を変更します。これでユーザーは自分の電子メール アドレスと TestRail パスワードでログインできるようになります。