Keycloak シングルサインオン(SSO)(デプロイメントプラン)¶
概要¶
Guanceデプロイメントプランは、OpenID Connect と OAuth 2.0 の 2 つのプロトコルに基づく SSO 方式をサポートしています。この記事では、Keycloak ログインを例に説明します。
Keycloak は、モダンアプリケーションと分散サービス向けのオープンソースの ID 認証・アクセス制御ソリューションです。Guanceデプロイメントプランは OpenID Connect プロトコルに基づき、企業の Keycloak アカウントでGuanceプラットフォームに SSO ログインし、対応するワークスペースのリソースにアクセスできます。企業/チームのGuanceアカウントを別途作成する必要はありません。
注意:本記事は、OpenID Connect プロトコルを使用し、Keycloak が 18.0.2 以下のバージョンである場合に適用されます。
概念¶
| 用語 | 説明 |
|---|---|
| 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. クライアントの作成と openid-connect プロトコルの設定¶
注意:この手順では、Keycloak クライアントを作成し、openid-connect プロトコルを設定して、Keycloak とGuanceの間に信頼関係を確立し、相互に信頼できるようにします。
1)作成した「gcy」レルムで Client をクリックし、右側の Create をクリックします。
2)Add Client で以下の内容を入力し、Save をクリックします。
クライアントを作成したら、次のスクリーンショットに従って設定し、Save をクリックします。
- Client Protocol:openid-connect
- Access Type:confidential
- Standard Flow Enabled:ON
- Direct Access Grants Enabled:ON
- Service Accounts Enabled:ON
- Valid Redirect URIs:*
3. Keycloak ユーザーの設定¶
4. Guance Launcher の設定¶
1)Guance Launcher の名前空間:forethought-core > core で Keycloak の基本情報を設定します。
# OIDC クライアント設定(この設定で wellKnowURL を設定すると、KeyCloakPassSet 設定項目は自動的に無効になります)
OIDCClientSet:
# OIDC エンドポイント設定の URL。つまり完全な `https://xxx.xxx.com/xx/.well-known/openid-configuration` アドレスです。
wellKnowURL:
# 認証サービスによって提供されるクライアント ID
clientId:
# クライアントのシークレットキー
clientSecret:
# 認証方式。現時点では authorization_code のみサポート
grantType: authorization_code
verify: false
# データアクセス範囲
scope: "openid profile email address"
# 認証サーバーでの認証成功後のコールバックアドレス
innerUrl: "{}://{}/oidc/callback"
# 認証サービスの認証成功後に DF システムへコールバックし、DF システムがユーザー情報を取得した後、フロントエンドの中継ページへリダイレクトするアドレス
frontUrl: "{}://{}/tomiddlepage?uuid={}"
# 認証サービスから取得したアカウント情報と DF システムアカウントのマッピング設定。必須項目は username、email、exterId
mapping:
# 認証サービスにおけるログインアカウントのユーザー名。必須。値が存在しない場合は email を使用
username: preferred_username
# 認証サービスにおけるログインアカウントのメールアドレス。必須
email: email
# 認証サービスにおけるログインアカウントの携帯電話番号のフィールド名。任意
mobile: phone_number
# 認証サービスにおけるログインアカウントの一意の識別子。必須
exterId: sub
参考画像:
上記の例の「wellKnowURL:」は、Realm Settings > General > Endpoints で取得できます。
例の「clientSecret:」は、Client > Client ID(例:Guance) > Credentials で取得できます。
2)Guance Launcher の名前空間:forethought-webclient > frontNginx でリダイレクト情報を設定します。
# =========OIDC プロトコルのリダイレクト関連設定ここから=========
# リクエストを Inner API のインターフェースへ直接リダイレクトする設定 =========ここから=========
# このアドレスは、サードパーティログイン時のアクセスアドレスです。必要に応じて変更できますが、proxy_pass に対応するルーティングアドレスは変更できません。
location /oidc/login {
proxy_connect_timeout 5;
proxy_send_timeout 5;
proxy_read_timeout 300;
proxy_http_version 1.1;
proxy_set_header Connection "keep-alive";
add_header Access-Control-Allow-Origin *;
add_header Access-Control-Allow-Headers X-Requested-With;
add_header Access-Control-Allow-Methods GET,POST,OPTIONS;
proxy_pass http://inner.forethought-core:5000/api/v1/inner/oidc/login;
}
# このアドレスは、サードパーティサービスが OIDC プロトコルによる認証に成功した後に、本サービスの現在のアドレスへコールバックするためのものです。このアドレスは【3.2.1】の設定にある OIDCClientSet 設定項目の innerUrl に直接関連しています。変更する場合は innerUrl と同期して変更してください。proxy_pass の対応値は変更できません。
location /oidc/callback {
proxy_connect_timeout 5;
proxy_send_timeout 5;
proxy_read_timeout 300;
proxy_http_version 1.1;
proxy_set_header Connection "keep-alive";
add_header Access-Control-Allow-Origin *;
add_header Access-Control-Allow-Headers X-Requested-With;
add_header Access-Control-Allow-Methods GET,POST,OPTIONS;
proxy_pass http://inner.forethought-core:5000/api/v1/inner/oidc/callback;
}
# =========OIDC プロトコルのリダイレクト関連設定ここまで=========
参考画像:
3)Guance Launcher の名前空間:forethought-webclient > frontWeb で、Keycloak ユーザーがGuanceデプロイメントプランにログインするためのエントリアドレスを設定します。
window.DEPLOYCONFIG = {
......
paasCustomLoginInfo:[
{url:"http://Guance的部署域名/oidc/login",label:"Keycloak 登录"}
],
paasCustomLoginUrl: "https://<客户提供的注销登录地址>?redirect_url=https://GuanceWeb端登录域名地址/oidc/login"
......
};
参考画像:
4)設定が完了したら、更新の設定変更にチェックを入れ、再起動を確認します。
5. Keycloak アカウントでGuanceに SSO ログインする¶
すべての設定が完了すると、Guanceに SSO でログインできるようになります。
1)Guanceデプロイメントプランのログイン URL を開き、ログインページで Keycloak SSO を選択します。
2)Keycloak で設定したメールアドレスを入力します。
3)ログインパスワードを更新します。
4)Guanceの対応するワークスペースにログインします。
Warning
- 「現在のアカウントはどのワークスペースにも参加していません。管理コンソールに移動して、このアカウントをワークスペースに追加してください。」と表示された場合は、Guance管理コンソールにログインして、ユーザーにワークスペースを追加する必要があります。
詳細はドキュメント デプロイメントプランのワークスペース管理 を参照してください。
Guance管理コンソールでユーザーにワークスペースを追加すると、そのユーザーはGuanceを使用できるようになります。















