LDAPの利用

About LDAP authentication for GitHub Enterprise Server

LDAP is a popular application protocol for access and maintenance of directory information services, and is one of the most common protocols for integration of third-party software with large company user directories. For more information, see "Lightweight Directory Access Protocol" on Wikipedia.

If you use an LDAP directory for centralized authentication, you can configure LDAP authentication for the people who use GitHub Enterprise Serverインスタンス.

If you want to allow authentication for some people who don't have an account on your external authentication provider, you can allow fallback authentication to local accounts on GitHub Enterprise Serverインスタンス. For more information, see "Allowing built-in authentication for users outside your provider."

サポートされているLDAPサービス

GitHub Enterprise Server は、以下の LDAP サービスと統合できます:

• Active Directory
• FreeIPA
• Oracle Directory Server Enterprise Edition
• OpenLDAP
• Open Directory
• 389-ds

LDAPでのユーザ名についての考慮

GitHub Enterprise Server normalizes a value from your external authentication provider to determine the username for each new personal account on GitHub Enterprise Serverインスタンス. For more information, see "Username considerations for external authentication."

GitHub Enterprise ServerインスタンスとのLDAPの設定

LDAPを設定した後、ユーザは自分のLDAPクレデンシャルでインスタンスにサインインできるようになります。 ユーザが初めてサインインするときに、ディレクトリ内のLDAP属性を使ってプロフィール名、メールアドレス、SSHキーが設定されます。

Management Console経由でユーザのLDAPアクセスを設定した場合、インスタンスにユーザが初めてサインインするまで、ユーザライセンスは使われません。 ただし、サイト管理設定を使ってマニュアルでアカウントを作成した場合、ユーザライセンスはすぐに使われます。

1. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

2. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

3. 左のサイドバーでManagement Consoleをクリックしてください。

4. 左のサイドバーでAuthentication（認証）をクリックしてください。

5. "Authentication（認証）"の下でLDAPを選択してください。

6. Optionally, to allow people without an account on your external authentication system to sign in with built-in authentication, select Allow built-in authentication. For more information, see "Allowing built-in authentication for users outside your provider."

7. 設定を追加してください。

LDAPの属性

GitHub Enterprise ServerインスタンスのlDAPの設定を完了させるために、以下の属性を使ってください。

属性名	種類	説明
Host	必須	LDAP のホスト。例: ldap.example.com あるいは 10.0.0.30。 ホスト名が内部ネットワークからしか利用できないなら、まずGitHub Enterprise ServerインスタンスのDNSを設定してホスト名を内部のネームサーバを使って解決できるようにする必要があるかもしれません。
ポート	必須	ホストの LDAP サービスが待ち受けるポート。 例：389及び636（LDAPS用）。
Encryption	必須	LDAP サーバーとの通信をセキュアにするために使われる暗号化の方法。 例：plain（暗号化なし）、SSL/LDAPS（最初からの暗号化）、StartTLS（接続後に暗号化通信にアップグレード）。
Domain search user	任意	認証を許可するために、サインインする他のユーザを検索する LDAP ユーザ。 これは通常、サードパーティとのインテグレーションのために特に作成されるサービスアカウントです。 cn=Administrator,cn=Users,dc=Example,dc=comのような完全修飾名を使ってください。 Active Directoryでは、ドメイン検索ユーザとして [DOMAIN]\[USERNAME]という構文（例：WINDOWS\Administrator）を使うこともできます。
Domain search password	任意	ドメイン検索ユーザのためのパスワード。
Administrators group	任意	このグループ内のユーザは、アプライアンスへサインインしたときにサイト管理者に昇格します。 LDAPの管理者グループを設定しなければ、アプライアンスに最初にサインインしたLDAPユーザが自動的にサイト管理者に昇格します。
Domain base	必須	ユーザおよびグループの検索を行う LDAP サブツリーの完全修飾 Distinguished Name (DN)。 いくつでも追加できるが、それぞれのグループはユーザが属するのと同じドメインベースで定義されなければなりません。 制限されたユーザグループを指定したなら、それらのグループに属するユーザだけがスコープに入ります。 ドメインベースにはLDAPディレクトリツリーの最上位を指定し、制限されたユーザグループでアクセス制御することをおすすめします。
Restricted user groups	任意	指定された場合、このグループ内のユーザだけがログインできます。 指定が必要なのはグループのcommon name（CN）だけで、グループはいくつでも追加できます。 グループが指定されていなければ、指定されたドメインベースのスコープ内のすべてのユーザが GitHub Enterprise Server インスタンスにサインインできるようになります。
User ID	必須	認証を受けようとした LDAP ユーザを特定する LDAP 属性。 マッピングが確立されたら、ユーザは自分の GitHub Enterprise Server ユーザ名を変更できます。 このフィールドはほとんどのActive Directoryの環境ではsAMAccountNameにすべきですが、OpenLDAPなどの他のLDAPソリューションではuidになることがあります。 デフォルト値はuidです。
Profile name	任意	ユーザの GitHub Enterprise Server プロフィールページに表示される名前。 LDAP Syncが有効化されていなければ、ユーザは自分のプロフィール名を変更できます。
メール	任意	ユーザの GitHub Enterprise Server アカウントのメールアドレス。
SSH keys	任意	ユーザの GitHub Enterprise Server アカウントにアタッチされた公開 SSH キー。 キーはOpenSSH形式でなければなりません。
GPG keys	任意	ユーザの GitHub Enterprise Server アカウントにアタッチされたGPGキー。
Disable LDAP authentication for Git operations	任意	選択した場合、ユーザが LDAP パスワードで Git の操作の認証を受けるのがオフになります。
Enable LDAP certificate verification	任意	選択した場合、LDAP 証明書の検証がオンになります。
Synchronization	任意	選択した場合、LDAP Sync がオンになります。

Gitの操作のパスワード認証の無効化

LDAP 設定中の [Disable username and password authentication for Git operations（Git の操作でのユーザ名およびパスワード認証の無効化）] を選択し、Git アクセスでの個人アクセストークンあるいは SSH キーの使用を強制してください。そうすれば、サーバーが LDAP 認証のリクエストで過負荷になるのを防ぐのに役に立ちます。 特にポーリングによる大量のリクエストと組み合わさると、レスポンスの遅いLDAPサーバーは頻繁にパフォーマンス問題や障害の原因となるので、この設定をおすすめします。

このオプションが選択されると、ユーザがコマンドライン経由のGitの操作でパスワードを使おうとすると、次のようなエラーメッセージが返されます。Password authentication is not allowed for Git operations. You must use a personal access token.

LDAPの証明書検証の有効化

TLSと共に使うLDAPサーバの証明書を検証するには、LDAPの設定でEnable LDAP certificate verification（LDAPの証明書検証の有効化）を選択してください。

このオプションが選択されると、以下のことを確実にするために証明書が検証されます:

• 証明書にAlternative Name (SAN) が少なくとも1つ含まれている場合には、SANの1つがLDAPホスト名に一致し、 そうでない場合はコモンネーム (CN) がLDAPホスト名に一致すること。
• 証明書の期限が切れていないこと。
• 証明書が信頼されている認証局 (CA) によって署名されていること。

LDAP Syncの有効化

LDAP Sync を使うと、GitHub Enterprise Server のユーザおよび Team のメンバーシップを、確立された LDAP グループに対して同期できます。 そうすることで、GitHub Enterprise Server 内で手作業で行う代わりに、LDAP サーバからユーザのロールベースのアクセス制御を確立できます。 詳細は「チームを作成する」を参照してください。

LDAP Sync を有効化するには、[Synchronize Emails]、[Synchronize SSH Keys]、または [Synchronize GPG Keys] を選択します。

LDAP Sync を有効化すると、同期のジョブが指定された間隔で動作し、各ユーザアカウントに対して以下の操作を行います:

• アイデンティティプロバイダ外のユーザに対してビルトイン認証を許可し、ユーザがビルトイン認証を使っているなら、次のユーザに進みます。
• ユーザに LDAP のマッピングが存在しないなら、ユーザをディレクトリ中の LDAP エントリにマップしようとします。 ユーザが LDAP のエントリにマップできなかった場合、ユーザをサスペンドして次のユーザに進みます。
• LDAP マッピングが存在し、ディレクトリ中の対応する LDAP のエントリが欠けている場合、そのユーザをサスペンドして次のユーザに進みます。
• 対応する LDAP のエントリが無効としてマークされており、ユーザがまだサスペンドされていないなら、そのユーザをサスペンドして次のユーザに進みます。
• 対応する LDAP のエントリが無効としてマークされておらず、そのユーザがサスペンドされており、Admin center で [Reactivate suspended users（サスペンドされたユーザを再アクティベート] が有効化されているなら、ユーザのサスペンドを解除します。
• If one or more restricted user groups are configured on the instance and the corresponding LDAP entry is not in one of these groups, suspend the user.
• If one or more restricted user groups are configured on the instance, the corresponding LDAP entry is in one of these groups, and Reactivate suspended users is enabled in the Admin Center, unsuspend the user.
• 対応する LDAP エントリが name 属性を含んでいるなら、ユーザのプロフィール名を更新します。
• 対応する LDAP エントリが Administrators グループ内にあるなら、そのユーザをサイト管理者に昇格させます。
• 対応する LDAP エントリが Administrators グループ内にないなら、そのユーザを通常のアカウントに降格させます。
• LDAP の User フィールドがメール用に定義されているなら、ユーザのメール設定を LDAP のエントリと同期します。 最初の LDAP の mail エントリをプライマリのメールとして設定します。
• LDAP の User フィールドが公開 SSH キー用に定義されているなら、ユーザの公開 SSH キーを LDAP のエントリと同期します。
• LDAP の User フィールドが GPG キー用に定義されているなら、ユーザの GPG キーを LDAP のエントリと同期します。

同期ジョブは、LDAP グループにマップされなかった各 Team に対して以下の操作を行うためにも、指定された間隔で動作します。

• Team に対応する LDAP グループが削除された場合、すべてのメンバーを Team から削除します。
• LDAP グループから LDAP のメンバーエントリが削除された場合、対応するユーザを Team から削除します。 If the user is no longer a member of any team in the organization, remove the user from the organization. その結果、ユーザがリポジトリへのアクセスを失った場合、それらのリポジトリでユーザが持っていたプライベートなフォークを削除します。
• LDAP グループに LDAP のメンバーエントリが追加された場合、対応するユーザを Team に追加します。 その結果、ユーザがリポジトリへのアクセスを再度得ることになった場合、過去 90 日以内にユーザがアクセスを失ったために削除されたリポジトリのプライベートフォークがリストアされます。

LDAP同期は、最適化設定の一部として、入れ子チームの構造を転送しません。 親子Teamの関係を作りたい場合は、入れ子チームの構造を手動で再作成し、対応するLDAPグループに同期させなければなりません。 詳しい情報については「Teamの作成」を参照してください。

サポートされるLDAPグループのオブジェクトクラス

GitHub Enterprise Server は、以下の LDAP グループオブジェクトクラスをサポートします。 グループは入れ子にできます。

• group
• groupOfNames
• groupOfUniqueNames
• posixGroup

LDAPユーザの表示と作成

インスタンスにアクセスできる LDAP ユーザの完全なリストを表示し、新しいユーザをプロビジョニングできます。

1. http(s)://HOSTNAME/loginでGitHub Enterprise Serverインスタンスにサインインしてください。

2. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

3. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

4. 左のサイドバーでLDAP users（LDAPユーザ）をクリックしてください。

5. ユーザを検索するには、完全なユーザ名もしくはユーザ名の一部を入力し、Search（検索）をクリックしてください。 検索結果に該当するユーザが表示されます。 該当するユーザがいなければ、Create（作成）をクリックして新しいユーザアカウントをプロビジョニングできます。

LDAPアカウントの更新

LDAP Sync が有効化されていない限り、LDAP アカウントへの変更は自動的には GitHub Enterprise Server に同期されません。

• 新しい LDAP 管理者グループを使うには、LDAP 内での変更を反映させるためにユーザを GitHub Enterprise Server 上で手動で昇格および降格させなければなりません。
• LDAP 管理者グループに LDAP アカウントを追加あるいは削除するには、GitHub Enterprise Server 上でそのアカウントを昇格もしくは降格させてください。
• LDAP アカウントを削除するには、GitHub Enterprise Server アカウントをサスペンドしてください。

手動でのLDAPアカウントの同期

1. http(s)://HOSTNAME/loginでGitHub Enterprise Serverインスタンスにサインインしてください。

2. From an administrative account on GitHub Enterprise Server, in the upper-right corner of any page, click .

   

3. If you're not already on the "Site admin" page, in the upper-left corner, click Site admin.

   

4. 検索フィールドでユーザ名を入力し、Search（検索）をクリックしてください。

5. 検索結果で、ユーザ名をクリックしてください。

6. ページの右上から Admin（管理）をクリックしてください。

7. 左のサイドバーで Admn（管理）をクリックしてください。

8. "LDAP"の下でSync now（即時同期）をクリックして、LDAPサーバからのデータでアカウントを手動更新してください。

API を使用して手動同期をトリガーすることもできます。

GitHub Enterprise Serverインスタンスへのアクセスの削除

LDAP Sync が有効化されているなら、ユーザの LDAP のクレデンシャルを削除すれば、次の同期が行われた後にそのユーザのアカウントはサスペンドされます。

LDAP Sync が有効化されていないなら、LDAP のクレデンシャルの削除後に GitHub Enterprise Server アカウントを手動でサスペンドしなければなりません。 詳しい情報についてはユーザのサスペンドとサスペンドの解除を参照してください。