OAuth サービス・プロバイダーの作成

始める前に

このタスクは、OAuth 2.0 機能が使用可能なっていることを前提としています。

このタスクについて

WebSphere® Application Server を OAuth サービス・プロバイダーとして使用するには、その前に、1 つ以上の OAuth プロバイダーを作成しておく必要があります。OAuth サービス・プロバイダーには、許可サーバーとリソース・サーバーが含まれます。

手順

  1. OAuth プロバイダーを作成します。 OAuth プロバイダーを作成するには、OAuth プロバイダー構成ファイルが必要です。OAuth プロバイダーを作成する前に、このプロバイダー構成ファイルが存在している必要があります。 OAuth シナリオのプロバイダー構成ファイルを作成するためのテンプレートとして、app_server_root/properties ディレクトリー内の OauthConfigSample.xml サンプル・プロバイダー構成ファイルを使用できます。

    OAuth プロバイダーを作成する前に、プロバイダー構成ファイル内の filter パラメーターの値が、保護リソースの URL と一致していることを確認してください。

    OAuth プロバイダーを作成するには、wsadmin コマンド・ユーティリティーを使用するか、管理コンソールを使用します。

    • wsadmin ユーティリティーを使用して OAuth プロバイダーを作成します。
    1. WebSphere Application Server を始動します。
    2. コマンド wsadmin -lang jython を入力して、app_server_root/bin ディレクトリーから wsadmin コマンド行ユーティリティーを開始します。
    3. wsadmin プロンプトで、コマンド AdminTask.createOAuthProvider('[-providerName <OAuthProviderName> -fileName <ProviderConfigFile>]') を入力します。ここで、OAuthProviderName は OAuth プロバイダー名で、ProviderConfigFile は OAuth プロバイダー構成ファイルの絶対パス名です。 以下に例を示します。
      AdminTask.createOAuthProvider('[-providerName OAuthConfigSample -fileName
                                    c:/temp/OAuthConfigSample.xml]')
      注: 前のコマンドは、プロバイダー構成ファイルを <was_profile_root>/config/cells/<cell_name>/oauth20 ディレクトリーにコピーします。
    4. コマンド AdminConfig.save() を入力して、構成を保存します。
    5. コマンド quit を入力して、wsadmin コマンド・ユーティリティーを終了します。
    6. WebSphere Application Server を再始動します。
    • 管理コンソールを使用して OAuth プロバイダーを作成します。
    1. プロバイダー構成ファイルを <was_profile_home>/config/cells/<cell_name>/oauth20 ディレクトリーにコピーします。
    2. WebSphere Application Server 管理コンソールにログオンします。
    3. 「セキュリティー」 > 「グローバル・セキュリティー」をクリックします。
    4. 「Web および SIP セキュリティー」を展開します。
    5. トラスト・アソシエーション」をクリックします。
    6. インターセプター」をクリックします。
    7. com.ibm.ws.security.oauth20.tai.OAuthTAI をクリックします。
    8. 「カスタム・プロパティー」の下で、以下のプロパティーを追加します。

      名前: provider_1.name

      値: <OauthProviderName>

      トラブルの回避 (Avoid trouble) トラブルの回避 (Avoid trouble): プロバイダー名は、プロバイダー構成ファイル名と同じでなければなりません (ただし、ファイル拡張子なし)。例えば、プロバイダー構成ファイルが OauthConfigSample.xml の場合は、プロバイダー名として OauthConfigSample を指定する必要があります。gotcha

      名前: provider_1.filter

      値: <filter_condition>

      フィルター・プロパティーの値は、保護リソースのフィルター条件を指定します。以下に例を示します。
      request-url%=snoop, applicationNames==OAuthApplication
    9. OK」をクリックします。
    10. WebSphere Application Server を再始動します。
  2. OAuth クライアントを登録します。 OAuth クライアントが OAuth トラスト・アソシエーション・インターセプター (TAI) によって保護されたリソースにアクセスするには、その前に、クライアントを OAuth サービス・プロバイダーに登録しておく必要があります。以下の 2 つの方法のいずれかを使用して、クライアントを登録できます。
    • XML ファイルを使用してクライアントを登録する。

      登録されたクライアントを保管するために XML ファイルを使用できます。OauthConfigSample.xml テンプレート・プロバイダー構成ファイルには、登録されたクライアントを base.clients.xml ファイルに保管する com.ibm.ws.security.oauth20.plugins.BaseClientProvider クラスが用意されています。 base.clients.xml ファイルは、<was_profile_root>/config/cells/<cell_name>/oauth20 内のプロバイダー構成ファイルと同じディレクトリーに存在している必要があります。

      XML ファイルを使用してクライアントを登録する際に BaseClientProvider クラスを使用したい場合は、1 つ以上の OAuth クライアントを base.clients.xml ファイルに追加する必要があります。 登録されたクライアントを追加するためにテンプレートとして <app_server_root>/properties ディレクトリー内の base.clients.xml ファイルを使用できます。

    • JDBC データベース・ストアを使用してクライアントを登録する。

      OAuth クライアントを登録するために JDBC データベースを使用することもできます。OauthConfigSample.xml テンプレート・プロバイダー構成ファイルには、OAuth クライアントを登録するために JDBC データベース・ストアを構成するためのパラメーターの例が含まれています。クライアントを登録するために JDBC データベース・ストアを構成する詳細については、このトピックでは説明しません。

タスクの結果

WebSphere Application Server が、OAuth 2.0 用のサービス・プロバイダーとして構成されました。

次のタスク

サービス・プロバイダーの追加構成オプションについては、以下のトピックを参照してください。
  • OAuth TAI のカスタム・プロパティー
  • AdminTask オブジェクトの OAuth コマンド・グループ

トピックのタイプを示すアイコン タスク・トピック



タイム・スタンプ・アイコン 最終更新: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=twbs_oauthcreateprovider
ファイル名:twbs_oauthcreateprovider.html