AdminTask オブジェクトの JaspiManagement コマンド・グループ
JaspiManagement コマンド・グループ内のコマンドおよびパラメーターは、認証プロバイダーの構成を管理する場合に使用します。
JASPI は、Java Platform, Enterprise Edition 6 (Java EE 6) で導入された新仕様です。これにより、サード・パーティーのセキュリティー・プロバイダーが、特定のメッセージング・ランタイム環境のメッセージの認証を実行できるようになります。 JASPI は、Java Authentication and Authorization Service (JAAS) アーキテクチャーを標準化されたプログラミング・インターフェースで拡張し、認証プロバイダーがネットワーク・メッセージを処理できるようにします。
JASPI メッセージ認証サービスを使用したい場合は、JASPI 仕様に定義されているとおりに、 必要なインターフェースの実装を提供する必要があります。 これらのインターフェースについて詳しくは、 カスタム認証プロバイダーの作成に関する説明を参照してください。
JASPI 認証プロバイダーが構成されている場合、WebSphere Application Server が要求 メッセージを受け取ると、セキュリティー・ランタイム環境は、ターゲット・アプリケーション が JASPI 認証を使用するように構成されているかどうかを判別します。JASPI 認証を使用するように構成されている場合、ランタイム環境は、選択された認証プロバイダーを起動して、受信したメッセージを検証します。そうでない場合、メッセージ要求の認証は、 該当するメッセージング・レイヤーについて WebSphere Application Server が提供する認証メカニズムに従って行われます。
JaspiManagement コマンド・グループには、以下のコマンドがあります。
configureJaspi
configureJaspi コマンドは、Java Authentication SPI 処理を有効にするか無効にするかを指定するため、および特定のセキュリティー・ドメインまたはグローバル・セキュリティー構成に対してデフォルトの JASPI プロバイダーを設定するために使用します。
ターゲット・オブジェクト
なし。
必須パラメーター
なし。
オプション・パラメーター
- -enabled
- JASPI 構成を有効にする場合は true を、無効にする場合は false を指定します。
- -defaultProviderName
- セキュリティー・ドメインまたはグローバル・セキュリティー構成に対するデフォルトの JASPI プロバイダーとして使用される、構成済みの JASPI プロバイダーの名前を指定します。
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
このコマンドは、システムが作成する JASPI 構成 ID のオブジェクト名を返し、javax.management.ObjectName のインスタンスとなります。コンソールに表示される値は、JASPI 構成 ID です。
バッチ・モードの使用例
AdminTask.configureJaspi('[-enabled true -defaultProviderName testProvider]')
$AdminTask configureJaspi {-enabled true -defaultProviderName testProvider}
対話モードの使用例
AdminTask.configureJaspi('-interactive')
$AdminTask configureJaspi -interactive
defineJaspiProvider
defineJaspiProvider コマンドは、特定のセキュリティー・ドメインまたはグローバル・セキュリティー構成に対する新規の認証プロバイダーを構成します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -providerName
- 認証プロバイダーを一意的に識別する名前を指定します。
- -className
- 認証プロバイダー・インターフェース (javax.security.auth.message.config.AuthConfigProvider) を実装するクラスのパッケージ修飾名を指定します。
オプション・パラメーター
- -description
- 認証プロバイダーのテキスト説明を指定します。
- -properties
- 認証プロバイダーを初期化するために必要な追加カスタム構成プロパティーを指定します。このパラメーターはキー / 値のペアのリストです。
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
このコマンドは、認証プロバイダー構成属性とその値のマップを返し、これは、認証プロバイダー構成属性を含む java.util.Map<java.lang.String, java.lang.Object> のインスタンスになります。コンソールに表示される値は、マップの toString() メソッドの戻り値です。
バッチ・モードの使用例
AdminTask.defineJaspiProvider('-providerName jaspi_provider
-className com.ibm.sample.JaspiProvider -description "Sample authentication provider"
-properties [ [debug true] [user admin] ] ')
$AdminTask defineJaspiProvider { -providerName jaspi_provider
-className com.ibm.JASPIProvider -description "Sample authentication provider"
-properties { {debug true} {user admin} } }
対話モードの使用例
AdminTask.defineJaspiProvider('-interactive')
$AdminTask defineJaspiProvider -interactive
displayJaspiProvider
displayJaspiProvider コマンドは、特定のセキュリティー・ドメインまたはグローバル・セキュリティー構成に対する 1 つ以上の特定の認証プロバイダーの構成データを表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -providerName
- 表示される認証プロバイダーの固有名を指定します。
オプション・パラメーター
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
このコマンドは、指定されたプロバイダー、およびその構成属性と値を表示します。返されるデータは、java.util.Collection<java.util.Map<java.lang.String, java.lang.Object>> のインスタンスとして表示されます。各マップ・インスタンスには、認証プロバイダーの構成属性が含まれます。コンソールに表示される値は、コレクションの toString() メソッドの戻り値です。
バッチ・モードの使用例
AdminTask.displayJaspiProvider('-providerName jaspi_provider')
$AdminTask displayJaspiProvider {'-providerName jaspi_provider'}
対話モードの使用例
AdminTask.displayJaspiProvider('-interactive')
$AdminTask displayJaspiProvider -interactive
displayJaspiProviderNames
displayJaspiProviderNames コマンドは、セキュリティー構成内の認証プロバイダーの名前を表示します。securityDomainName パラメーターが指定されると、特定のセキュリティー・ドメイン内のプロバイダーだけが表示されます。securityDomainName パラメーターが指定されない場合は、グローバル・セキュリティー構成内のプロバイダー名だけが表示されます。
securityDomainName パラメーターが、getEffectiveProviderNames パラメーターを false に設定して指定された場合は、特定のセキュリティー・ドメインの認証プロバイダー名のリストだけが表示されます。getEffectiveProviderNames パラメーターが有効になるのは、securityDomainName パラメーターと共に使用された場合だけで、securityDomainName プロバイダーが指定されていない場合は、このパラメーターは無視されます。
ターゲット・オブジェクト
なし。
必須パラメーター
なし。
オプション・パラメーター
- -getEffectiveProviderNames
- 有効な認証プロバイダー名のリストを取得する場合は、true を、セキュリティー・ドメイン構成の認証プロバイダーのリストだけを取得する場合は、false を指定します。getEffectiveProviderName のデフォルト値は false です。
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
このコマンドは、JASPI プロバイダー名のリストを返します。返されるデータは、java.util.Collection<java.lang.String> のインスタンスとして表示されます。
バッチ・モードの使用例
AdminTask.displayJaspiProviderNames()
$AdminTask displayJaspiProviderNames
対話モードの使用例
AdminTask.displayJaspiProviderNames('-interactive')
$AdminTask displayJaspiProviderNames -interactive
getJaspiInfo
getJaspiInfo コマンドは、特定のセキュリティー・ドメインまたはグローバル・セキュリティー構成の JASPI 構成に関する情報を表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
なし。
オプション・パラメーター
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
このコマンドは、Java Authentication SPI 処理が使用可能になっているかどうかの指示を返します。このコマンドが特定のセキュリティー・ドメインに対して発行され、値がそのドメインに対してカスタマイズされていると、コマンドは JASPI 処理が使用可能になっているかどうかを示す値を返します。このコマンドが特定のセキュリティー・ドメインに対して発行され、値がそのドメインに対してカスタマイズされていないと、コマンドは、構成がグローバル・セキュリティー構成から継承されていることを示す空のリストを返します。返されるデータは、JASPI 構成属性を含む java.util.Map<java.lang.String, java.lang.Object> のインスタンスとして表示されます。 コンソールに表示される値は、マップの toString() メソッドの戻り値です。
wsadmin>$AdminTask getJaspiInfo
{defaultProviderName=null, enabled=false}
バッチ・モードの使用例
AdminTask.getJaspiInfo()
$AdminTask getJaspiInfo
対話モードの使用例
AdminTask.getJaspiInfo('-interactive')
$AdminTask getJaspiInfo -interactive
modifyJaspiProvider
modifyJaspiProvider コマンドは、特定のセキュリティー・ドメインまたはグローバル・セキュリティー構成に対する特定の認証プロバイダーの構成データを変更します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -providerName
- 認証プロバイダーを一意的に識別する名前を指定します。
オプション・パラメーター
- -className
- 認証プロバイダー・インターフェース (javax.security.auth.message.config.AuthConfigProvider) を実装するクラスのパッケージ修飾名を指定します。
- -description
- 認証プロバイダーのテキスト説明を指定します。
- -properties
- 認証プロバイダーを初期化するために必要な追加カスタム構成プロパティーを指定します。このパラメーターはキー / 値のペアのリストです。
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
特定の認証プロバイダーまたは関連認証モジュール内の変更されたあらゆる構成属性を含む java.util.Map<java.lang.String, java.lang.Object> のインスタンス。コンソールに表示される値は、マップの toString() メソッドの戻り値です。
バッチ・モードの使用例
AdminTask.modifyJaspiProvider('-providerName jaspi_provider
-properties [ [debug false] ] ')
$AdminTask modifyJaspiProvider { -providerName jaspi_provider
-properties { {debug false} } }
対話モードの使用例
AdminTask.modifyJaspiProvider('-interactive')
$AdminTask modifyJaspiProvider -interactive
removeJaspiProvider
removeJaspiProvider コマンドは、特定のセキュリティー・ドメインまたはグローバル・セキュリティー構成に対するセキュリティー構成から 1 つ以上の認証プロバイダーを除去します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -providerName
- 除去される認証プロバイダーの固有名を指定します。
オプション・パラメーター
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
戻り値
なし。
バッチ・モードの使用例
AdminTask.removeJaspiProvider('-providerName jaspi_provider')
AdminTask.removeJaspiProvider( '[-providerName [ Provider1;Provider2 ] ]' )
$AdminTask removeJaspiProvider {'-providerName jaspi_provider'}
$AdminTask removeJaspiProvider {-providerName {Provider1 Provider2 } }
対話モードの使用例
AdminTask.removeJaspiProvider('-interactive')
$AdminTask removeJaspiProvider -interactive
unconfigureJaspi
unconfigureJaspi コマンドは、JASPI 構成およびそのすべての関連プロバイダーをセキュリティー・ドメインから除去する場合に使用されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- セキュリティー・ドメインの名前を指定します。-securityDomainName パラメーターの値を指定しなかった場合は、このコマンドではグローバル・セキュリティー構成が使用されます。
オプション・パラメーター
なし。
戻り値
なし。
バッチ・モードの使用例
AdminTask.unconfigureJaspi('-securityDomainName domain1')
$AdminTask unconfigureJaspi {-securityDomainName domain1}
対話モードの使用例
AdminTask.unconfigureJaspi('-interactive')
$AdminTask unconfigureJaspi -interactive