IDaaS は、OpenID Connect (OIDC) の認可コードフローを使用して、カスタムアプリケーション向けのシングルサインオン (SSO) を実装します。アプリケーションは、認可エンドポイントとトークンエンドポイントという 2 つのエンドポイントと連携して、SSO フロー全体を完了します。認証プロセス全体は IDaaS がホストし、アプリケーション側で必要なのは結果の処理のみです。
仕組み
次の手順は、アプリケーション、ユーザーのブラウザー、IDaaS の間で実行される OIDC 認可コードフローの概要です:
アプリケーションがブラウザーを IDaaS の認可エンドポイントへリダイレクトします。
IDaaS がサインインページを表示します。ユーザーが認証します。
IDaaS は、認可
codeを付与して、ブラウザーをredirect_uriにリダイレクトします。アプリケーションが IDaaS のトークンエンドポイントを呼び出し、
codeをトークンに交換します。アプリケーションが ID トークンを検証し、ユーザーのセッションを確立します。
OIDC 1.0 は OAuth 2.0 の上にユーザーのアイデンティティレイヤーを追加し、OAuth 2.0 の認可コードフローと後方互換性があります。主な違いは、トークンエンドポイントがユーザーのアイデンティティのクレームを含む ID トークンも返す点です。
前提条件
開始する前に、次の項目を用意してください:
IDaaS インスタンス
IDaaS で作成済みのカスタムアプリケーションまたは OIDC ベースのアプリケーション (「Custom applications」をご参照ください)
アプリケーションの
client_idとclient_secret([アプリケーション] ページの [一般] タブで入手可能です)
OIDC による SSO の統合
手順 1:アプリケーションの認証情報の取得
[アプリケーション] ページで、対象のアプリケーションをクリックして [全般] タブを開きます。後続のすべての API リクエストで必要になるため、client_id と client_secret をメモしておいてください。
認証情報のローテーションまたは管理については、「General configurations」をご参照ください。
手順 2:認可エンドポイントへのリクエスト送信
ユーザーがアクティブなセッションなしでアプリケーションにアクセスした場合、次のパラメータを付けてブラウザーを IDaaS の認可エンドポイントへリダイレクトします。
[アプリケーション] ページで認証エンドポイント URL を探します。対象のアプリケーションをクリックし、[サインイン] タブを開き、[アプリケーション設定] セクションを確認します。
リダイレクト URL を次のように構成します:
{{Authorization Endpoint}}?
client_id=app_***&
redirect_uri=http%3A%2F%2Flocalhost%3A3000%2F***&
response_type=code&
scope=openid&
state=525f49cc-***パラメータ | 必須 | 例 | 説明 |
| はい |
| [一般] タブのクライアント ID。 |
| はい |
| 返されるユーザー属性を制御します。カスタムアプリケーションのデフォルトは |
| はい |
| 認可コードフローを使用するには、 |
| はい |
| ユーザーのサインイン後に、IDaaS が認可コードを送信する URL です。 |
| いいえ (推奨) |
| アプリケーションが生成するランダムな文字列です。IDaaS はこの値を変更せずに返します。同一セッションからのレスポンスであることを検証し、クロスサイトリクエストフォージェリ (CSRF) 攻撃を防ぐために使用します。32 文字以上を使用してください。 |
IDaaS がアプリケーションへリダイレクトしてきた際は、必ず state の値を検証してください。返された state が送信した値と一致しないレスポンスは拒否してください。
手順 3:サインインコールバックの処理
ユーザーの認証後、IDaaS は redirect_uri に対して 302 リダイレクトを実行します:
{{redirect_uri}}?
code=CO***&
state=525f49cc-***パラメータ | 例 | 説明 |
|
| 認可コードです。次の手順でトークンをリクエストする際に使用します。 |
|
| 続行する前に、この値が手順 2 で送信した値と一致することを検証してください。 |
IDaaS は、DingTalk の QR コードや SMS など、複数の認証方法をサポートしています。全一覧については「General configuration」をご参照ください。
手順 4:認可コードのトークンへの交換
state 値を検証した後、トークンエンドポイントに POST リクエストを送信して認証コードをトークンと交換します。トークンエンドポイントの URL は、認証エンドポイントと同じ [アプリケーション設定] セクションにあります。
POST /v2/<instance_id>/<app_id>/oauth2/token HTTP/1.0
Host: eiam-api-cn-hangzhou.aliyuncs.com
Content-Type: application/x-www-form-urlencoded
grant_type=authorization_code
&code=n0esc3N*****5acc3f0ogp4
&client_id=s6BhdR*****kqt3
&client_secret=7Fjfp0ZBr1*****KtDRbnfVdmIw
&redirect_uri=http%3A%2F%2Fwww.example.com%2Fsso%2Fcallback成功レスポンスには、アクセストークンと ID トークンの両方が含まれます:
{
"token_type": "Bearer",
"access_token": "ATM4SoVDqWgUq***********wk3ZS5mtn6fcSp8NH8",
"expires_in": 1200,
"expires_at": 1644843164,
"id_token": "eyJraWQiOiJLRVkyV************gRIadj-frOIRFChA"
}トークンで利用できるユーザー属性は、手順 2 でリクエストした scope の値によって決まります。
ユーザーのセッションを確立するには、次のいずれかの方法を使用します:
ID トークンを解析する:
id_tokenの JWT をデコードして署名を検証し、クレームからユーザーのアイデンティティを抽出します。「手順 5:ID トークンの解析と検証」をご参照ください。UserInfo エンドポイントを呼び出す:
access_tokenを使用して UserInfo エンドポイントを呼び出し、ユーザー属性を取得します。「手順 6:UserInfo エンドポイントからユーザー情報を取得」をご参照ください。
手順 5:ID トークンの解析と検証
ID トークンは、RS256 で署名された JSON Web Token (JWT) です。ユーザーのアイデンティティのクレームが平文で含まれており、内容を信頼する前に署名を検証する必要があります。
署名検証は必須です。署名を検証する前に、ID トークンのクレームを使用しないでください。
トークンの元の構造を確認するには、id_token の値を jwt.io に貼り付けます。デコード後のトークンは次のようになります:
{
"kid": "KEY2Ty1qL6u21NGKmccv3jwfd2ndmgtQPnag",
"alg": "RS256"
}.{
"sub": "user_uyvefotjn7kpbejfmxoos3rtmm",
"jti": "jwt_aaaac7xyhclac6aqkgtjaxsthw5yotn5d77pmki",
"iss": "https://pre-eiam-api-cn-hangzhou.aliyun-inc.com/v2/********/oidc",
"iat": 1644841965,
"nbf": 1644841965,
"exp": 1644842265,
"aud": "app_mhylgo3iairjqjdx5eop6uaf34",
"at_hash": "XHEaGpMooM9zvQXaMzCNEA",
"name": "testuser",
"preferred_username": "testuser"
}.[Signature]署名検証に使用する公開鍵の取得
署名を検証する前に、IDaaS から JSON Web Key (JWK) 公開鍵を取得します。公開鍵エンドポイント URL は、[アプリケーション設定] (他のエンドポイントと同じ場所) にあります。
エンドポイントを呼び出すと、キーセットが返されます:
{
"keys": [
{
"kty": "RSA",
"e": "AQAB",
"use": "sig",
"kid": "KEYkYnc55G********CTvT7So44RGDYdbfs",
"n": "pXmYkIpy1vaNjTMclU86BQjfmDhjlqMAX8ySVvh9gO-nae4ayvG_*********-v4gP27T7u6bUy0GXTlh3eKE0v1LYB81nfqjF2uazlPwPR5yYOhhWcK-gMNByLfE3CnkDc1YGwA3dZmIz-ZjOCKy8xLaBuqjrvwn5tpMpAoYEEaH4jIm7unTdhbKEKspNR-UXKD8q9RppMh5Tn2sB6oPHlQANudJDgqSwEOevIrdmHU0Zqxrb9cscGH9hH0QjmYEu72yI8BVeliPo3jK6JIoqCIcj5K_t8BJlFQ9QLJ8_o9tmd3BFv5_LVsh4BKGw"
}
]
}署名の検証
jwt.io のライブラリ一覧に掲載されている JWT ライブラリを使用して、ID トークンを解析し、署名を検証します。次の例では、Java ライブラリ org.bitbucket.b_c:jose4j を使用します。
Maven 依存関係を追加します:
<dependency>
<groupId>org.bitbucket.b_c</groupId>
<artifactId>jose4j</artifactId>
<version>0.7.12</version>
</dependency>実行前に、issuer、appId、jwkJson、jwt を、IDaaS アプリケーションの実際の値に置き換えてください:
import org.jose4j.jwk.JsonWebKey;
import org.jose4j.jwk.JsonWebKeySet;
import org.jose4j.jwt.JwtClaims;
import org.jose4j.jwt.consumer.JwtConsumer;
import org.jose4j.jwt.consumer.JwtConsumerBuilder;
public class IdTokenTest {
public static void main(String[] args) throws Exception {
// EIAM の発行者識別子 (OIDC 発行者 URL)
String issuer = "https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_padyrlux3mphrlsex4uonyqhxu/**********/oidc";
// 現在のアプリケーションの一意識別子 (EIAM から取得)
String appId = "app_mkif4*****pxpzbasqmu";
// JWT の署名検証に使用するアプリケーションの公開鍵 (JSON 形式)
String jwkJson = "{\n" + " \"keys\": [\n" + " {\n" + " \"kty\": \"RSA\",\n" + " \"e\": \"AQAB\",\n" + " \"use\": \"sig\",\n" + " \"kid\": \"KEY2H82C2at57itnW4onT3p1ySjwH4nirjCk\",\n" + " \"n\": \"w7Jl3fAUJp_9GuxV*****QsOA4lnXR5OD4kF4QbIeBiDiH8_MThrFi9k2MB6YMkSzf5JfIkpAS3JCqZ7k6Wooydp4pzaZNZAk3SGzdsa022RmAT" + "-Iayi4Yj6J9tSdTQCjwh2XkzzsIxA_Hla8rWiQ8Vhw1" +
"-7QArgObfe67nSR7LxD55MFLxk9FU0*****RlGhrQGE_0LUuGWtCJG1r1e6aKquyswfxxAr3Rvj8QGIeJrG0R1Pv8m8d1_5OdULhB7149VqjM6D98WFjab0U2SNv0UlREZXTcS4p-2QNm_1egYRRpJEY_00FZqNSYsmErMGepYhO_61KoGqd8cphWQ\"\n" + " }\n" + " ]\n" + "}";
String jwt = "eyJraWQiOiJLRVkySDgyQzJhdD*****uaXJqQ2siLCJhbGciOiJSUzI1NiJ9.eyJzdWIiOiJ1c2Vy*****lmNjRjZjR3amFrbnBieGpjd3V1IiwianRpIjoiand0X2FhYWFkYWllYTc2eWg1cW0zcm11bnoyeGg0eHd5aTJzZHBoNjR6aSIsImlzcyI6Imh0dHBzOi8vZWlhbS1hcGktY24taGFuZ3pob3UuYWxpeXVuY3MuY29tL3YyL2lkYWFzX3BhZHlybHV4M21waHJsc2V4NHVvbnlxaHh1L2FwcF9ta2lmNGR3bHBlaDZkbnM0cHhwemJhc3FtdS9vaWRjIiwiaWF0IjoxNjUzNjMwMDQxLCJuYmYiOjE2NTM2MzAwNDEsImV4cCI6MTY1MzYzMDM0MSwiYXVkIjoiYXBwX21raWY0ZHdscGVoNmRuczRweHB6YmFzcW11IiwibmFtZSI6InRlc3QiLCJwcmVmZXJyZWRfdXNlcm5hbWUiOiJ0ZXN0IiwidXBkYXRlZF9hdCI6MTY1MzYyODU5MH0.pAsUNB8OkdpIxJMZRfLJ7Pa31tsJyl44a1jVIlvdQxwOtPULAwrFxnB0X3eQx89hUGCdvYWl9FO9o-5kT7L-RER0wJYz9YNKqrVNBnaRwINRZyeYLRVurWMMzODQz-V0ULd9raM1M_i2f_SoWFs1gPFtYh_ijUARHISi7Q3q93ZfAuY8Lq2Nq07QunmDbosvioUd5wJG7WCxW5XXZYDUQe9p5IEYd1MSvnWuTOLbg7rKn0Vm4dNYGWjz1WuoAyCsc_QxOCqpmQ_2czoqPeN-SvPJAQ2CykLk7DSnGpABw1aNrjDidLS9Beqsga9VDCth86sk_0lyTZOaORtUrfVTtQ";
// JWK 公開鍵セットを解析
JsonWebKeySet jsonWebKeySet = new JsonWebKeySet(jwkJson);
// JWT バリデーターを作成
JwtConsumer jwtConsumer = createJwtConsumer(jsonWebKeySet, issuer, appId);
// 署名検証を実行し、クレームを解析
JwtClaims jwtClaims = jwtConsumer.processToClaims(jwt);
// ID トークンから取得したユーザー情報を出力
System.out.println(jwtClaims);
}
public static JwtConsumer createJwtConsumer(JsonWebKeySet jsonWebKeySet, String issuer, String appId) {
// ビルダーパターンで JWT バリデーターを設定
final JwtConsumerBuilder jwtConsumerBuilder = new JwtConsumerBuilder();
jwtConsumerBuilder.setExpectedIssuer(issuer);
jwtConsumerBuilder.setRequireIssuedAt();
jwtConsumerBuilder.setRequireExpirationTime();
jwtConsumerBuilder.setAllowedClockSkewInSeconds(60);
jwtConsumerBuilder.setExpectedAudience(appId);
// 公開鍵リゾルバーを設定 (kid で JWK を照合)
jwtConsumerBuilder.setVerificationKeyResolver((jws, nestingContext) -> {
// JWT ヘッダーから kid を取得
final String signKeyId = jws.getKeyIdHeaderValue();
// JWK セットから一致するキーを検索
for (JsonWebKey jsonWebKey : jsonWebKeySet.getJsonWebKeys()) {
if (signKeyId.equals(jsonWebKey.getKeyId())) {
return jsonWebKey.getKey();
}
}
throw new RuntimeException("Cannot find verification key: " + signKeyId);
});
return jwtConsumerBuilder.build();
}
}正常に実行されると、検証済みのクレームが出力されます:
JWT Claims Set:{sub=user_dt6kj6yf64cf4wjaknpbxjcwuu,
jti=jwt_aaaadaiea76yh5qm3rmunz2xh4xwyi2sdph64zi,
iss=https://eiam-api-cn-hangzhou.aliyuncs.com/v2/idaas_padyrlux3mphrlsex4uonyqhxu/app_**********/oidc,
iat=1653630041,
nbf=1653630041,
exp=1653630341,
aud=app_**********,
name=test,
preferred_username=test,
updated_at=1653628590
}手順 6:UserInfo エンドポイントからユーザー情報を取得
ID トークンを解析する代わりに、アクセストークンを使用して UserInfo エンドポイントを呼び出すこともできます。このエンドポイントは RFC6750 に準拠しています。
[アプリケーション設定]で UserInfo エンドポイント URL を確認します。
GET /v2/<instance_id>/<app_id>/oauth2/userinfo HTTP/1.0
Host: eiam-api-cn-hangzhou.aliyuncs.com
Authorization: Bearer <AccessToken>レスポンス例:
{
"sub": "user_dt6kj6yf64cf4wjaknpbxjcwuu",
"name": "test",
"preferred_username": "test",
"updated_at": 1653899948
}UserInfo エンドポイントは、アプリケーション用に設定された拡張クレームを含め、ID トークンと同じフィールドを返します。
高度な設定
OIDC ディスカバリーエンドポイント
IDaaS は OpenID Connect Discovery 1.0 標準をサポートしています。アプリケーションの発行者 URL は次の形式になります:
https://<idaas-api-domain>/v2/<instance_id>/<application_id>/oidcパラメータ | 説明 | 例 |
| ユーザーポータルのドメイン |
|
| インスタンス ID |
|
| アプリケーション ID |
|
発行者 URL に /.well-known/openid-configuration を付加すると、ディスカバリーエンドポイントになります。呼び出すと、利用可能なすべてのエンドポイントが返されます:
エンドポイント | 説明 |
| 認可エンドポイント |
| トークンエンドポイント |
| UserInfo エンドポイント |
| トークン失効エンドポイント |
| JWK 公開鍵エンドポイント |
| デバイス認可エンドポイント (OIDC ベースのアプリケーションのみ。現時点では、カスタムアプリケーションはデバイスコードフローによるログインをサポートしていません) |
すべてのエンドポイント URL は、[アプリケーション設定] でも直接確認できます。
スコープとフィールドマッピング
次の表は、各 scope の値に対して返される ID トークンのクレームを示します。
フィールド | スコープ | 説明 |
|
| ユーザー ID |
|
| JWT ID (補助) |
|
| トークンの発行者 (補助) |
|
| トークン発行時刻 (補助) |
|
| トークン有効開始時刻 (補助) |
|
| トークン有効期限 (補助) |
|
| アプリケーションのクライアント ID (補助) |
|
| アクセストークンハッシュ (補助) |
|
| 電話番号 (例: |
|
| 電話番号が検証済みかどうか。デフォルトでは検証済みとなります。 |
|
| メールアドレス (例: |
|
| メールアドレスが検証済みかどうか。デフォルトでは検証済みとなります。 |
|
| 表示名 |
|
| ユーザー名 |
|
| プロファイルの最終更新時刻 |
トークンエンドポイントの認証方式
IDaaS は、ディスカバリーエンドポイントの token_endpoint_auth_methods_supported フィールドで指定されているように、トークンエンドポイント用に 4 つの認証方式をサポートしています。
方式 | 説明 |
| パブリッククライアント用です。 |
| RFC 6749 に準拠します。 |
| RFC 6749 に準拠します。 |
| OpenID Connect Core 1.0 に準拠します。 |
次の例は、client_secret_basic を使用したトークンエンドポイントリクエストです:
POST /token HTTP/1.0
Host: api.aliyunidaas.com
Authorization: Basic YXBwX21pY2hzN3I0*******cHllOkNTKioqKioq
grant_type=authorization_code&
code=COE59pkCTm4J*******arGEaiShj7NCzLCYu9クライアントシークレットのローテーション
「General configurations」のシークレットのローテーションのセクションをご参照ください。
次のステップ
基本的な OIDC 統合を完了した後は、次の作業も検討してください:
サインイン体験のカスタマイズ:認証方法とブランディングを「General configuration」で設定します。
アプリケーションの認証情報の管理:クライアントシークレットを「General configurations」でローテーションまたは更新します。