OAuth サービス・プロバイダーの定義
OAuth サービス・プロバイダーはプロバイダー構成ファイルで定義されます。 OAuthSampleConfig.xml ファイルを編集することによって OAuth サービス・プロバイダーを定義することができます。
OauthSampleConfig.xml は、WebSphere® Application Server インストールの下の properties ディレクトリーにあります。 このファイルをコピーし、編集して、OAuth サービス・プロバイダーを定義することができます。
各パラメーターは、カスタマイズ可能値 true (この変数がユーザーによって変更されることを意味します) またはカスタマイズ可能値 false (この変数が通常はユーザーによって更新されないことを意味します) のいずれかを持っています。
カスタマイズ可能パラメーターは、exportOAuthProps wsadmin タスクを使用してエクスポートされ、importOAuthProps wsadmin タスクを使用してインポートすることができます。
その他の場合、カスタマイズ可能属性はパラメーターに影響を及ぼしません。
カスタマイズ可能パラメーター値は、ご使用の環境に応じて必要なときに更新することができます。
トラブルの回避 (Avoid trouble): パラメーター・タイプ ws または cc は内部的に使用されるもので、パラメーターの更新時には無視することが可能です。gotcha

パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
oauth20.client.provider.classname | クライアント・プロバイダー実装クラス | メモリー内のクライアント・ストアの場合は、値 com.ibm.ws.security.oauth20.plugins.BaseClientProvider を使用します。 | False |
oauth20.token.cache.classname | トークン・キャッシュ実装クラス | メモリー内のトークン・ストアの場合は、値 com.ibm.ws.security.oauth20.plugins.BaseCache を使用します。 | False |
oauth20.token.cache.jndi.tokens | ID で索引付けされたトークンの動的キャッシュ・オブジェクトの Java™ Naming and Directory Interface (JNDI) 名 | デフォルト値は Services/cache/OAuth20MemTokenCache です。 使用法について詳しくは、動的キャッシング構成のセクションを参照してください。 | False |
oauth20.token.cache.jndi.users | ユーザーで索引付けされたトークンの動的キャッシュ・オブジェクトの JNDI 名 | デフォルト値は Services/cache/OAuth20MemTokenOwnerCache です。 使用法について詳しくは、動的キャッシング構成のセクションを参照してください。 | False |
パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
oauth20.client.provider.classname | クライアント・プロバイダー実装クラス名 | JDBC ベースのクライアント・ストアの場合は、値 com.ibm.ws.security.oauth20.plugins.db.CachedDBClientProvider を使用します。 データベース構成について詳しくは、DB 表のセクションを参照してください。 | False |
oauth20.token.cache.classname | トークン・キャッシュ実装クラス名 | JDBC ベースのトークン・ストアの場合は、値 com.ibm.ws.security.oauth20.plugins.db.CachedDBTokenStore を使用します。 データベース構成について詳しくは、DB 表のセクションを参照してください。 | False |
oauthjdbc.JDBCProvider | JDBC プロバイダー名 | この値を JDBC プロバイダーと一致する値 (例えば jdbc/oauthProvider) に設定します。 | False |
oauthjdbc.client.table | OAuth クライアントで使用される表名 | この値をデータベース表名と一致する値 (例えば OAuthDBSchema.OAUTH20CLIENTCONFIG) に設定します。 | False |
oauthjdbc.token.table | OAuth トークンで使用される表名 | この値をデータベース表名と一致する値 (例えば OAuthDBSchema.OAUTH20CACHE) に設定します。 | False |
oauthjdbc.CleanupInterval | 失効トークン・クリーンアップ間隔 (秒) | データベース・トークン表内の失効トークンのクリーンアップ間の遅延時間 (秒)。 | true |
oauthjdbc.LimitRefreshToken | 未使用 | 未使用 | true |
oauth20.db.token.cache.jndi.tokens | トークンの動的キャッシュ・オブジェクトの JNDI 名 | 指定された名前の動的キャッシュ (例えば services/cache/OAuth20DBTokenCache) によってデータ・ストアがバックアップされます。 使用法について詳しくは、動的キャッシング構成のセクションを参照してください。 | False |
oauth20.db.token.cache.jndi.client | クライアントの動的キャッシュ・オブジェクトの JNDI 名 | 指定された名前の動的キャッシュ (例えば services/cache/OAuth20DBClientCache) によってデータ・ストアがバックアップされます。 使用法について詳しくは、動的キャッシング構成のセクションを参照してください。 | False |
パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
oauth20.max.authorization.grant.lifetime.seconds | 許可付与存続時間 (秒) | 許可の付与が有効である持続時間 (秒)。例えば 604800 など。 | true |
oauth20.code.lifetime.seconds | 許可コード存続時間 (秒) | OAuth ダンス中において許可コードが有効である持続時間 (秒)。例えば 60 など。 | true |
oauth20.code.length | 整数 | 生成される OAuth 許可コードの長さ | true |
oauth20.token.lifetime.seconds | 整数 | OAuth アクセス・トークンが有効である時間 (秒)。よくカスタマイズされる値 | true |
oauth20.access.token.length | 整数 | 生成される OAuth アクセス・トークンの長さ | true |
oauth20.issue.refresh.token | true または false | 値 false は、OAuth プロバイダーでのリフレッシュ・トークンの使用および生成を使用不可にします。 | true |
oauth20.refresh.token.length | 有効な値は 50 以上です | デフォルト値は 50 です。 | true |
oauth20.access.tokentypehandler.classname | 任意の OAuth20 トークン・ハンドラーを指定することができます。 | デフォルト値は com.ibm.ws.security.oauth20.plugins.BaseTokenHandler です。 タイプは cc です。 | False |
oauth20.mediator.classnames | OAuth メディエーターのクラス名 (オプション) | 詳しくは、OAuth メディエーターのセクションを参照してください。 | False |
oauth20.allow.public.clients | true または false | 値 false は、OAuth 仕様に詳述されているように公開クライアントのアクセスを使用不可にします。 | true |
oauth20.grant.types.allowed | 有効な値は次のとおりです。authorization_code、password、refresh_tokens、client_credentials、または implicit | OAuth 仕様に詳述されている使用可能な OAuth フローのリスト。 | False |
oauth20.authorization.form.template | カスタマイズされた許可テンプレートへの URL (オプション) | カスタマイズされた許可フォームを使用している場合は、テンプレート・ロケーションを指定してください。 | true |
oauth20.authorization.error.template | カスタマイズされた許可エラー・ページ・テンプレートへの URL (オプション) | カスタマイズされた許可フォーム・エラー・ページを使用している場合は、テンプレート・ロケーションを指定してください。 | true |
oauth20.authorization.loginURL | カスタマイズされたログイン・ページ許可テンプレートへの URL (オプション) | カスタマイズされたログイン・ページを使用している場合は、ログイン URL を指定してください。 | true |
oauth20.audithandler.classname | OAuth 監査ハンドラーのクラス名 | 拡張ロギングおよび監査のための実装 (オプション)。 デフォルト値は com.ibm.oauth.core.api.audit.XMLFileOAuthAuditHandler です。 | true |
oauth20.template.lifetime.seconds | テンプレートの存続期間 (秒単位)。デフォルトは 600 です。 | テンプレートが、テンプレート・キャッシュ内に留まる時間。 oauth20.template.lifetime.seconds は、com.ibm.ws.security.oauth20.util.defaultTemplateLifetime と呼ばれる既存の JVM システム・プロパティーの設定をすべてオーバーライドします。 |
|
oauth20.template.waitTime | テンプレートの待ち時間 (秒単位)。デフォルトは 120 です。 | リモート・サーバーからのテンプレートのロードを待機する時間。 | |
oauth20.template.connectTime | テンプレートの接続時間 (秒単位)。デフォルトは 120 です。 | テンプレートをロードするためにサーバー接続を待機する時間。 | |
oauth20.template.readTime | テンプレートの読み取り時間 (秒単位)。デフォルトは 120 です。 | リモート・サーバーからのテンプレート文書の読み取りの完了までに許可される時間。 | |
oauth20.template.count | テンプレート・カウント。デフォルトは 3 です。 | 同時に取得するテンプレートの数。 | |
oauth20.grant.type.password.skip.validation | true または false。デフォルトは falseです。 | true の値は、パスワード付与タイプに対する、リソース所有者の妥当性検査を使用不可にします。 | |
xmlFileAuditHandler.filename | ファイル名 | デフォルト監査ハンドラーに対応するファイルの名前。 | true |
パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
Filter | 任意のフィルター条件を使用できます | 詳しくは、TAI 構成パラメーターおよび構文を参照してください。 | true |
oauthOnly | true または false | 認証を OAuthのみに制限する (true) か、あるいは他の有効な認証を使用する (false) かを指定するための TAI 構成プロパティーの例。 詳しくは、TAI 構成パラメーターを参照してください。 | true |
パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
oauth20.autoauthorize.param | 任意のストリング | 自動許可を使用するには、URL パラメーターとして autoauthorize パラメーターに値 true を指定して要求に付加する必要があります。 | False |
oauth20.autoauthorize.clients | 登録済みクライアント ID のリスト | このリスト内のクライアントが自動許可に参加することができます。 | true |
パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
oauth20.client.uri.substitutions | 未使用 | 未使用 | False |
パラメーター名 | 値 | 説明 | カスタマイズ可能 |
---|---|---|---|
oauth20.scope.preAuthorized | 任意のストリング | すべてのクライアントに与えられる有効範囲のリスト | true |