DTP を、OpenID Connect ID プロバイダーからの認証を受け入れるよう設定できます。  これにより、Parasoft の外部でユーザー認証を管理できます。OpenID Connect のサポートはデフォルトでは無効です。

このセクションの内容:

基本設定

DTP および OIDC サーバーでの設定が必要です。

OIDC サーバーでの設定

1. まだ登録していない場合は、  DTPを OpenID Connect ID プロバイダーで登録します。  oidc.json ファイルで使用されている属性の値を認証サーバーから取得できます (Keycloak、connect2id など)。

2. 必要なリダイレクト URI を登録して、認証後のユーザーのリダイレクト先を OIDC サーバーに設定します。 次のリダイレクト URI を登録する必要があります。

   必須: 

   • <dtp_server>/pst/login/oauth2/code/dtp
   • <dtp_server>/pstsec/login/oauth2/code/dtp (User Administration)
   • <dtp_server>/grs/login/oauth2/code/dtp (Required for Report Center/Enterprise Pack)

   任意。次のリダイレクト URI の登録は任意です。個々のアプリケーションから直接ログインできるようにする場合にだけ登録が必要です。

   • <dtp_server>/tcm/login/oauth2/code/dtp (Team Server)
   • <dtp_server>/licenseserver/login/oauth2/code/dtp (License Server)
   • <data_collector>/login/oauth2/code/dtp (Data Collector)

DTP の設定

<DTP_DATA_DIR>/conf ディレクトリにある oidc.json ファイルを開き、DTP が使用する OIDC プロバイダー プロパティを構成します。 

{
"enabled": false,
"issuerUri": "your issuer uri",
"clientId": "your client id",
"clientSecret": "your client secret",
"scopes": ["openid", "profile", "email"],
"claimMappings":
	{ 
		"username": "preferred_username", 
		"firstName": "given_name", 
		"lastName": "family_name", 
		"email": "email" 
	},
"adminUsers": []
}

oidc.json ファイルは、管理ユーザーが初めてログインする前に設定する必要があります。そうしないと、管理機能を実行するために必要な権限がない状態でユーザーがデータベースに追加されます。 

enabled 要素が true に設定されている場合、ファイル中のすべての属性が必須です。暗号化されているかどうかにかかわらず、クライアン トシークレット属性を定義する方法は 2 つあります。デフォルトでは暗号化されていないバージョン (clientSecret) が使用されますが、必要に応じて暗号化されたバージョン (encryptedClientSecret) に交換できます。次の表に、ファイル中のすべての要素を示します。

ファイルを設定したら、変更を保存して DTP サービスを再起動します。

DTP のログイン ページにアクセスすると、OpenID Connect 認証インターフェイスにリダイレクトされます。  資格情報を入力すると、ログインして DTP にリダイレクトされます。

設定の例

次の例は、DTP を ID アクセス管理システムに接続する方法を分かりやすくするためのものです。詳細については、ご使用のソフトウェアのドキュメントを参照してください。

Keycloak

以下は、この例で説明しているように、Keycloak 用に OpenID Connect を設定するための前提条件です。

• Keycloak は、デフォルトの署名アルゴリズムとして RS256 を使用する必要があります。
• Keycloak からのアクセス トークンには、Keycloak userinfo API エンドポイントから取得できるユーザー情報が含まれている必要があります。
• 次のリダイレクト URI を登録する必要があります。
  
  • host:port/* (default windows port is 80, linux port is 8080)
  • host:8314/*
  • host:8082/* (Data Collector アップロード フォーム用) 
  ワイルドカードを使用しない場合は、Report Center、User Administration、Team Server、License Administration の個々の URI を追加する必要があります。リダイレクト URI の登録に関する追加情報については「OIDC Server Configuration」を参照してください。

この例では、demo がレルムの名前であり、2 人の管理者ユーザー (admin1 および admin2) が作成されます。

"enabled": true,
"issuerUri": "https://host:8095/auth/realms/demo/",
"clientId": "pstsec",
"clientSecret": "4d35ef23-aec5-44d7-9c59-18092bd619e8",
"scopes": ["opened","profile","email"],
"claimMappings":
	{ 
		"username": "preferred_name", 
		"firstName": "given_name", 
		"lastName": "family_name", 
		"email": "email" 
	}
"adminUsers": ["admin1","admin2"]

詳細については Keycloak のドキュメント を参照してください。

Google

次の例は、Google 用に OpenID Connect を設定する方法を示しています。この例では、2 人の管理者ユーザー (admin1 および admin2) を作成します。

"enabled": true,
"issuerUri": "https://accounts.google.com",
"clientId": "<clientId-from-google>",
"clientSecret": "<clientSecret-from-google>",
"scopes": ["opened","profile","email"],
"claimMappings":
	{ 
		"username": "given_name", 
		"firstName": "given_name", 
		"lastName": "family_name", 
		"email": "email" 
	}
"adminUsers": ["admin1","admin2"] 

詳細については Google のドキュメント を参照してください。 

Connect2id

次の例は、connect2id 用に OpenID Connect を設定する方法を示しています。 Connect2id を OpenID Connect プロバイダーとして使用する場合、ユーザーは HTTPS 経由で DTP にアクセスする必要があります。

この例では c2id が realm の名前です。2人の管理者ユーザー (admin1 および admin2) が作成されます。 

"enabled": true,
"issuerUri": "https://host:port/c2id",
"clientId": "<clientId-from-c2id>",
"clientSecret": "<clientSecret-from-c2id>",
"scopes": ["opened","profile","email"],
"claimMappings":
	{ 
		"username": "sub", 
		"firstName": "given_name", 
		"lastName": "family_name", 
		"email": "email" 
	}
"adminUsers": ["admin1","admin2"] 

詳細については connect2id のドキュメント を参照してください。

既知の制限事項

connect2id を介して DTP に初めてログインすると、"Invalid Request” エラーが表示される場合があります。このエラーを解決するには、別のブラウザーを使用するか、現在のブラウザーのキャッシュをクリアします。 

Azure

前提条件として、Azure アプリの認証を設定し、以下のリダイレクト URI を許可しておく必要があります。

• https://<DTP host and port>/grs/login/oauth2/code/dtp
• https://<DTP host and port>/licenseserver/login/oauth2/code/dtp
• https://<DTP host and port>/pst/login/oauth2/code/dtp
• https://<DTP host and port>/pstsec/login/oauth2/code/dtp
• https://<DTP host and port>/tcm/login/oauth2/code/dtp

ホストがデフォルトの HTTPS ポート 443 を使用する場合、ポートの指定は必要ありません。

次の例は、Azure 用に OpenID Connect を設定する方法を示しています。この例では、2 人の管理者ユーザー ([email protected] および [email protected]) を作成します。

{
    "enabled": true,
    "issuerUri": "https://login.microsoftonline.com/<tenantId>/v2.0",
    "clientId": "<clientId-from-Azure>",
    "clientSecret": "<clientSecret-from-Azure>",
    "scopes": ["openid", "profile", "email"],
    "claimMappings": {
        "username": "email",
        "firstName": "given_name",
        "lastName": "family_name",
        "email": "email"
    },
    "adminUsers": [
        "[email protected]",
        "[email protected]"
    ]
} 

ClaimMappings は、https://graph.microsoft.com/oidc/userinfo へのレスポンスからのフィールドを使用します。これには、限られたフィールドのセットが含まれています。  以下は、電子メール アドレスが [email protected] のユーザーに対するレスポンスの例です。

{
  "sub": "<unique value for user>",
  "name": "Jane Jones",
  "given_name": "Jane",
  "family_name": "Jones",
  "picture": "https://graph.microsoft.com/v1.0/me/photo/$value",
  "email": "[email protected]"
}  

詳細については Microsoft のドキュメント を参照してください。

OpenID Connect モードでの API の使用

DTP が OpenID Connectモードの場合、基本認証を使用して DTP または Enterprise Pack API にアクセスすることはできません。代わりに、Authorization プロパティを使用して、リクエスト ヘッダーで API エンドポイントにアクセス トークンを渡す必要があります。トークンは次の形式で渡されます。

Authorization: Bearer <access token>

アクセス トークンを取得する方法については、ID アクセス管理ソフトウェアのドキュメントを参照してください。

方法に関係なく、API 呼び出しごとにトークンを渡す必要があります。次の例では、値 "1234567890" のトークンが DTP ビルド API エンドポイントに渡されます。

curl -X GET -H "Authorization: Bearer 1234567890" http://dtp.host.com/grs/api/v1.7/builds?limit=1000&offset=0