Generate LTPA Token (ltpa-generate)

概要

LTPA (Lightweight Third Party Authentication) は、WebSphere® Application Server で Cookie またはバイナリー・セキュリティー・トークン・ベースの認証メカニズムを提供する IBM プロトコルです。これは、シングル・サインオン (SSO) テクノロジーをサポートしており、分散された複数のアプリケーション・サーバーおよびマシンによる環境で使用することを意図しています。

Generate LTPA Token ポリシーをアセンブリーに適用すると、WebSphere Application Server にホストされたアプリケーションまたはサービスに安全に API を認証させることができます。実行時には、ポリシーによって生成された LTPA トークンが、HTTP Cookie ヘッダーで (デフォルトのオプション)、あるいは SOAP メッセージ内の WS-Security ヘッダーにラップして (SOAP ペイロードまたは XML ペイロードの場合) WebSphere Application Server バックエンド・サービスに送信されます。

前提条件

プロパティー

以下の表に、このポリシーのプロパティーをリストします。表には、プロパティーが必須かどうか、入力用の有効な値とデフォルト値、および値のデータ型が示されています。

表 1. Generate LTPA Token ポリシーのプロパティー

プロパティー・ラベル	プロパティー名	必須	説明	データ型
タイトル	title	はい	ポリシーのタイトル。 デフォルト値は、ltpa-generate です。	ストリング
説明	description	いいえ	ポリシーの説明。	ストリング
LTPA 鍵	key	はい	LTPA トークンの生成に使用する LTPA 鍵の名前。 以下のいずれかの構文オプションを使用して、LTPA 鍵の名前を入力します。 my-ltpa-key - バージョン番号を指定せずに名前を入力すると、実行時にポリシーによってバージョン 1.0.0 の LTPA 鍵が選択されます。 my-ltpa-key:2.0.0 - バージョン番号を指定して名前を入力すると、特定のバージョンの鍵が実行時に使用されます。 my-ltpa-key:latest - latest を指定して名前を入力すると、使用する最新バージョンの LTPA 鍵が、実行時にポリシーによって選択されます。 ドロップダウン・メニューから「LTPA 鍵」を選択します。各 LTPA 鍵には、バージョン固有でないオプション (例えば、my-ltpa-key、latest version) があります。使用する LTPA 鍵がポリシーによって実行時に選択されるようにする場合は、このオプションを選択してください。 それ以外の場合は、特定のバージョンを選択します。 注: バージョンの自動選択機能は、version.release.modification version というバージョン番号付け方式に従ったバージョン番号を指定して LTPA 鍵が構成されていることに依存します。	LTPAKey
認証済みユーザー名	authenticatedUserName	はい	認証済みユーザーの名前を保持するランタイム変数。LTPA トークンは、このプロパティーをユーザーに設定して生成されます。 例えば、API が基本認証セキュリティー定義で構成されている場合は、認証済みユーザー名を $(client.app.id) と指定できます。API が OAuth セキュリティー定義で構成されている場合は、認証済みユーザー名を $(oauth.resource-owner) と指定できます。あるいは、Generate LTPA Token ポリシーの前に set-variable ポリシーを構成して、ランタイム変数に特定のユーザー名を設定し、そのランタイム変数を認証済みユーザー名として指定することもできます。	ストリング
トークンのバージョン	tokenVersion	はい	LTPA トークンのバージョン。次の値から選択します。 WebSphereVersion1 WebSphereVersion1-FIPS WebSphereVersion2 WebSphere70Version2 デフォルト値は WebSphereVersion2 です。	ストリング
トークンの出力 (Token Output)	tokenOutput	はい	生成された LTPA トークンをポリシーが格納する出力ソース内の場所を定義します。次のオプションから選択します。 Cookie ヘッダー (In Cookie Header) WSSec ヘッダー (In WSSec Header)1 デフォルトのオプションは「Cookie ヘッダー (In Cookie Header)」です。 注: 「WSSec ヘッダー (In WSSec Header)」は、メッセージのメディア・タイプが XML または SOAP の場合にのみ選択してください。	enum
トークンの有効期限	tokenExpiry	はい	LTPA 鍵を有効と見なす期間として現在の日時に加算する時間の長さ (秒)。 デフォルト値は、600 です。	整数

例

- ltpa-generate:
    title: ltpa-generate
    tokenVersion: WebSphereVersion2
    tokenOutput: in-cookie-header
    tokenExpiry: 600
    key: 'my-first-ltpa-key:1.0.0'

エラー