Keycloak シングルサインオン設定例¶
Keycloak は、最新のアプリケーションおよび分散型サービス向けの、オープンソースのID認証およびアクセス制御ソリューションです。
本書では、構築した Keycloak サーバーを使用して、SAML 2.0 プロトコルを用い、Keycloak ユーザーがGuance管理コンソールに SSO でログインする方法を説明します。
OpenID Connect プロトコルを用いて Keycloak ユーザーがGuance管理コンソールに SSO でログインする方法については、Keycloak シングルサインオン(デプロイメントプラン) を参照してください。
前提条件¶
Keycloak サーバーが構築済みで、Keycloak サーバーにログインして設定を変更できること。
Keycloak 環境がない場合は、以下の手順で構築します。
sudo yum update #更新
sudo yum install -y java-1.8.0-openjdk java-1.8.0-openjdk-devel #JDKのインストール
wget https://downloads.jboss.org/keycloak/11.0.2/keycloak-11.0.2.zip #Keycloakのダウンロード
yum install unzip #解凍パッケージのインストール
unzip keycloak-11.0.2.zip #ダウンロードしたKeycloakの解凍
cd keycloak-11.0.2/bin # bin ディレクトリに移動
./add-user-keycloak.sh -r master -u admin -p admin #サーバー管理者のログインアカウントとパスワードを作成
nohup bin/standalone.sh -b 0.0.0.0 & #bin ディレクトリに戻り、バックグラウンドで Keycloak サービスを起動
Keycloak 環境の構築が完了したら、ブラウザで https://IPアドレス:8443/auth にアクセスし、「Administration Console」をクリックして Keycloak 管理コンソールを開きます。
概念¶
以下は、Keycloak の設定プロセスにおける基本概念の説明です。
| フィールド | 説明 |
|---|---|
| Realm | レルム。ワークスペースに似ており、ユーザー、資格情報、ロール、ユーザーグループを管理するために使用され、レルム間は相互に分離されます。 |
| Clients | クライアントは、Keycloak にユーザー認証を要求できるアプリケーションまたはサービスです。 |
| Users | システムにログインできるユーザーアカウントです。ログイン用メールアドレスと Credentials の設定が必要です。 |
| Credentials | ユーザー ID を検証するための資格情報です。ユーザーアカウントのログインパスワードの設定に使用できます。 |
| Authentication | ユーザーを識別および検証するプロセスです。 |
| Authorization | ユーザーにアクセス権を付与するプロセスです。 |
| Roles | 管理者、一般ユーザーなど、ユーザーの ID タイプを識別するために使用されます。 |
| User role mapping | ユーザーとロール間のマッピング関係です。1 人のユーザーに複数のロールを関連付けることができます。 |
| Groups | ユーザーグループを管理し、ロールをグループにマッピングすることをサポートします。 |
設定手順¶
1、Keycloak レルムの作成¶
注意: Keycloak にはマスターレルム(Master)があります。新しいレルム(ワークスペースに類似)を作成する必要があります。
1)Keycloak 管理コンソールで、Master > Add realm をクリックします。
2)Add realm ページで、Name にレルム名(例:「gcy」)を入力し、Create をクリックすると、新しいレルムが作成されます。
2、Client の作成と SAML の設定¶
注意: この手順では、Keycloak クライアントを作成して SAML を設定し、Keycloak とGuanceの間に信頼関係を確立して、相互に信頼できるようにします。
1)作成した「gcy」レルムで、Client をクリックし、右側の Create をクリックします。
2)Add Client に以下の内容を入力し、Save をクリックします。
- Client ID(エンティティ ID): https://auth.guance.com/saml/metadata.xml;
- Client Protocol: SAML を選択;
- Client SAML Endpoint(アサーションアドレス)、仮設定: https://auth.guance.com/saml/assertion。
注意: この設定は、次の手順で使用するメタデータドキュメントを取得するためだけのものです。Guanceで SSO シングルサインオンを有効化した後、正しいエンティティ ID とアサーションアドレスを取得して、置き換える必要があります。
Client 作成後、Settings に前の手順で入力したエンティティ ID、プロトコル、アサーションアドレスが表示されます。以下のパラメータを設定して保存します。
- Sign Assertions: ON(IdP から送信されるデータの改ざんを防ぎ、IdP から SP に送信されるデータの安全性を保証します。)
- IDP Initiated SSO URL Name: 任意の値を入力できます(例:「gcy」)。入力すると、SSO シングルサインオンアドレスが生成されます。下図を参照してください。
- Base URL: 前のパラメータで生成された SSO シングルサインオンアドレスを入力します(例:
/auth/realms/gcy/protocol/saml/clients/gcy)。これは主に、Keycloak Clients でアクセスリンクを生成し、Guanceに直接シングルサインオンするために使用されます。
3)Clients の Mappers で、Create をクリックし、メールアドレスのマッピングを作成します。この部分は必須項目です。入力しない場合、SSO シングルサインオンを実現できません。
Create Protocol Mapper ページで、以下の内容を入力して保存します。
- Name: 任意の値を入力できます(例:「mail mapper」);
- Mapper Type:「User Property」を選択;
- Property: アイデンティティプロバイダーのサポートするルールに従って Email を入力;
- SAML Attribute Name: この例では Email を入力します。ユーザーのメールアドレスを渡すために使用されます。
注意: Guanceの SAML フィールドマッピング で、メールのマッピングに、ここで返される属性名(この例では Email)を入力します。同時に必須のユーザー名マッピングも設定し、携帯番号マッピングは必要に応じて入力します。
3、Keycloak メタデータドキュメントの取得¶
注意: この手順では、Guanceでアイデンティティプロバイダーを作成するためのメタデータドキュメントを取得できます。
1)Clients の Installation で、Mod Auth Mellon files を選択し、Download をクリックしてメタデータドキュメントをダウンロードします。
2)ダウンロードしたフォルダーで、idp-metadata.xml を選択します。
3)Keycloak のクラウドメタデータドキュメントはレルムレベルのため、メタデータドキュメント idp-metadata.xml 内のアクセスアドレスに、クライアントのパラメータ/clients/<IDP Initiated SSO URL Name>を追加する必要があります。このドキュメントでは、IDP Initiated SSO URL Name:gcy を設定しているため、xml ファイルに /clients/gcy を入力します。下図を参照してください。追加後、xml ファイルを保存します。
4、GuanceでSSOシングルサインオンを有効化¶
1)SSO シングルサインオンを有効化するには、Guanceワークスペースの管理 > メンバー管理 > SSO 管理で、有効化をクリックします。
ドキュメント SSO の作成 を参照してください。
注意: アカウントの安全性を考慮し、Guanceでは、ワークスペースごとに SSO を 1 つだけ設定できます。以前に SAML 2.0 を設定したことがある場合、最後に更新された SAML 2.0 設定が最終的なシングルサインオン検証エントリとみなされます。
2)ステップ3でダウンロードしたメタデータドキュメントをアップロードし、ドメイン(メールアドレスのサフィックスドメイン)を設定し、ロールを選択すると、そのアイデンティティプロバイダーのエンティティ IDとアサーションアドレスを取得できます。ログインアドレスを直接コピーしてログインすることもできます。
注意: ドメインは、Guanceがアイデンティティプロバイダーとメールアドレスのドメインマッピングを行いシングルサインオンを実現するために使用されます。つまり、ユーザーのメールアドレスのサフィックスドメインが、Guanceに追加されたドメインと一致している必要があります。
5、Keycloak で SAML アサーションアドレスを置き換え¶
1)Keycloak に戻り、ステップ2のエンティティ IDとアサーションアドレスを更新します。
注意: Guanceでシングルサインオンを設定する場合、アイデンティティプロバイダー SAML で設定されたアサーションアドレスは、Guanceのものと一致している必要があります。そうしないとシングルサインオンを実現できません。
6、Keycloak ユーザーの設定¶
注意: この手順では、Guanceでアイデンティティプロバイダーを作成するための、認可されたユーザーメールアカウントを設定します。設定した Keycloak ユーザーのメールアカウントを使用して、Guanceプラットフォームにシングルサインオンできます。
1)作成した gcy レルムで、User をクリックし、Add user をクリックします。
2)Username と Email を入力します。Email は必須項目であり、Guanceのアイデンティティプロバイダー設定で許可されたユーザーのメールアドレスと一致している必要があります。これは、メールマッピングによるGuanceへのログインを照合するために使用されます。
3)ユーザー作成後、Credentials でユーザーのパスワードを設定します。
7、Keycloak アカウントを使用してGuanceにシングルサインオン¶
すべての設定が完了すると、次の 2 つの方法でGuanceにシングルサインオンできます。
方法 1: Keycloak からGuanceにログイン¶
1)Keycloak の Clients で、右側のBase URLをクリックします。
2)設定したユーザーのメールアドレスとパスワードを入力します。
3)Guanceの対応するワークスペースにログインします。
注意: 複数のワークスペースで同じアイデンティティプロバイダーの SSO シングルサインオンが同時に設定されている場合、ユーザーは SSO シングルサインオンでワークスペースにログイン後、Guance左上隅のワークスペースオプションをクリックして、別のワークスペースに切り替えてデータを確認できます。
方法 2: Guanceで Keycloak アカウントを使用してシングルサインオン¶
1)SSO 設定完了後、Guance公式サイト または Guanceコンソール からログインし、ログインページでシングルサインオンを選択します。
2)SSO 作成時に使用したメールアドレスを入力し、ログインアドレスを取得をクリックします。
3)リンクをクリックして、企業アカウントのログインページを開きます。
4)企業共通メールアドレス(Keycloak とGuanceSSO 管理で設定した企業メールアドレス)とパスワードを入力します。
5)Guanceの対応するワークスペースにログインします。
注意: 複数のワークスペースで同じアイデンティティプロバイダーの SSO シングルサインオンが同時に設定されている場合、ユーザーは SSO シングルサインオンでワークスペースにログイン後、Guance左上隅のワークスペースオプションをクリックして、別のワークスペースに切り替えてデータを確認できます。
























