JaspiManagement command group for the AdminTask object

Use the commands and parameters in the JaspiManagement command group to manage the configuration of authentication providers.

Note: WebSphere® Application Server supports integration of message authentication providers that are compliant with the JASPI for Containers Version 1.0 specification. Use the Jython or JACL scripting languages to configure Java™ Authentication Service Provider Interface (JASPI) providers with the wsadmin tool.

JASPI is a new specification introduced in Java Platform, Enterprise Edition 6 (Java EE 6). It enables third-party security providers to perform authentication of messages for specific messaging runtime environments. JASPI extends the Java Authentication and Authorization Service (JAAS) architecture with standardized programming interfaces to make network messages available for processing by authentication providers.

If you want to use JASPI message authentication services, you must supply an implementation of the required interfaces as defined in the JASPI specification. Read about Developing a custom authentication provider for more information on these interfaces.

Note: WebSphere Application Server Version 8.5 supports only the Servlet Profile as defined in the JASPI specification.

When JASPI authentication providers are configured, and WebSphere Application Server receives a request message, the security runtime environment determines if the target application is configured to use JASPI authentication. If so, the runtime environment invokes the selected authentication provider to validate the received message. Otherwise, authentication of the message request is done according to the authentication mechanism provided by WebSphere Application Server for the appropriate messaging layer.

The JaspiManagement command group includes the following commands:

configureJaspi
defineJaspiProvider
displayJaspiProvider
displayJaspiProviderNames
getJaspiInfo
modifyJaspiProvider
removeJaspiProvider
unconfigureJaspi

configureJaspi

The configureJaspi command is used to specify whether the Java Authentication SPI processing is to be enabled or disabled, and to set the default JASPI provider for a given security domain or the global security configuration.

Target object

None.

Required parameters

None.

Optional parameters

-enabled: Specify true to enable the JASPI configuration and false to disable the configuration.
-defaultProviderName: Specifies the name of an already configured JASPI provider that is to be used as the default JASPI provider for the security domain or global security configuration.
-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

The command returns the object name of the JASPI configuration ID that the system creates, and is an instance of javax.management.ObjectName. The value displayed in the console is the JASPI configuration ID.

Batch mode example usage

Using Jython:

AdminTask.configureJaspi('[-enabled true -defaultProviderName testProvider]')

Using Jacl:

$AdminTask configureJaspi {-enabled true -defaultProviderName testProvider}

Interactive mode example usage

Using Jython:

AdminTask.configureJaspi('-interactive')

Using Jacl:

$AdminTask configureJaspi -interactive

defineJaspiProvider

The defineJaspiProvider command configures a new authentication provider for the given security domain or the global security configuration.

Target object

None.

Required parameters

-providerName: Specifies a name that uniquely identifies the authentication provider.
-className: Specifies the package-qualified name of the class that implements the authentication provider interface (javax.security.auth.message.config.AuthConfigProvider).

Optional parameters

-description: Specifies a textual description of the authentication provider.
-properties: Specifies additional custom configuration properties needed to initialize the authentication provider. This parameter is a list of key/value pairs.
-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

The command returns a map of the authentication provider configuration attributes and their values, and is an instance of java.util.Map<java.lang.String, java.lang.Object> that contains the authentication provider configuration attributes. The value displayed in the console is the return value of the Map's toString() method.

Batch mode example usage

Note: For clarity, the command is shown in multiple lines; it must be entered on a single line.

Using Jython:

AdminTask.defineJaspiProvider('-providerName jaspi_provider  
-className com.ibm.sample.JaspiProvider -description "Sample authentication provider"  
-properties [ [debug true] [user admin] ] ')

Using Jacl:

$AdminTask defineJaspiProvider {  -providerName jaspi_provider 
-className com.ibm.JASPIProvider  -description "Sample authentication provider" 
-properties {  {debug true} {user admin}  } }

Interactive mode example usage

Using Jython:

AdminTask.defineJaspiProvider('-interactive')

Using Jacl:

$AdminTask defineJaspiProvider -interactive

displayJaspiProvider

The displayJaspiProvider command displays the configuration data for one or more given authentication providers for the given security domain or the global security configuration.

Target object

None.

Required parameters

-providerName: Specifies the unique name(s) of the authentication provider(s) to be displayed.

Optional parameters

-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

The command displays the specified provider(s) along with their configuration attributes and values. The data returned is displayed as an instance of java.util.Collection<java.util.Map<java.lang.String, java.lang.Object>>. Each Map instance contains the configuration attributes of an authentication provider. The value displayed in the console is the return value of the Collection's toString() method.

Batch mode example usage

Using Jython:

AdminTask.displayJaspiProvider('-providerName jaspi_provider')

Using Jacl:

$AdminTask displayJaspiProvider {'-providerName jaspi_provider'}

Interactive mode example usage

Using Jython:

AdminTask.displayJaspiProvider('-interactive')

Using Jacl:

$AdminTask displayJaspiProvider -interactive

displayJaspiProviderNames

The displayJaspiProviderNames command displays the names of authentication providers in the security configuration. When the securityDomainName parameter is provided, only those providers in the given security domain are displayed. When the securityDomainName parameter is not provided, only the names of the providers in the global security configuration are displayed.

When the securityDomainName parameter is provided with the getEffectiveProviderNames parameter set to true, the list of authentication provider names from the given security domain and from the global security configuration are displayed as long as JASPI support is enabled.

Note: The combined list does not include duplicate provider names. For example, if the given security domain configuration has provider names of p1, p2 and p3, and the global security configuration has provider names of p3, p4 and p5, the combined list of provider names contains p1, p2, p3, p4 and p5.

When the securityDomainName parameter is provided with the getEffectiveProviderNames parameter set to false, only the list of authentication providers for the given security domain are displayed. The getEffectiveProviderNames parameter only has an effect when used with the securityDomainName parameter; it is ignored if the securityDomainName provider is not provided.

Target object

None.

Required parameters

None.

Optional parameters

-getEffectiveProviderNames: Specify true to get the list of effective authentication provider names or false to get just the list of authentication providers for the security domain configuration. The default value for getEffectiveProviderName is false.
-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

The command returns a list of JASPI provider names. The data returned is displayed as an instance of java.util.Collection<java.lang.String>.

Batch mode example usage

Using Jython:

AdminTask.displayJaspiProviderNames()

Using Jacl:

$AdminTask displayJaspiProviderNames

Interactive mode example usage

Using Jython:

AdminTask.displayJaspiProviderNames('-interactive')

Using Jacl:

$AdminTask displayJaspiProviderNames -interactive

getJaspiInfo

The getJaspiInfo command displays information about the JASPI configuration for the given security domain or the global security configuration.

Target object

None.

Required parameters

None.

Optional parameters

-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

The command returns an indication of whether Java Authentication SPI processing is enabled. If the command is issued for a specific security domain and a value is customized for the domain, the command returns a value to indicate whether JASPI processing is enabled. If the command is issued for a specific domain and a value is not customized for the domain, it returns an empty list to indicate that the configuration is inherited from the global security configuration. The data returned is displayed as an instance of java.util.Map<java.lang.String, java.lang.Object> that contains the JASPI configuration attributes. The value displayed in the console is the return value of the Map's toString() method.

In addition, this command returns the value configured for the default provider. For example:

wsadmin>$AdminTask getJaspiInfo
{defaultProviderName=null, enabled=false}

Batch mode example usage

Using Jython:

AdminTask.getJaspiInfo()

Using Jacl:

$AdminTask getJaspiInfo

Interactive mode example usage

Using Jython:

AdminTask.getJaspiInfo('-interactive')

Using Jacl:

$AdminTask getJaspiInfo -interactive

modifyJaspiProvider

The modifyJaspiProvider command modifies configuration data for a given authentication provider for the given security domain or the global security configuration.

Target object

None.

Required parameters

-providerName: Specifies a name that uniquely identifies the authentication provider.

Optional parameters

-className: Specifies the package-qualified name of the class that implements the authentication provider interface (javax.security.auth.message.config.AuthConfigProvider).
-description: Specifies a textual description of the authentication provider.
-properties: Specifies additional custom configuration properties needed to initialize the authentication provider. This parameter is a list of key/value pairs.
-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

An instance of java.util.Map<java.lang.String, java.lang.Object> that contains any modified configuration attributes in the given authentication provider or any given associated authentication modules. The value displayed in the console is the return value of the Map's toString() method.

Batch mode example usage

Using Jython:

AdminTask.modifyJaspiProvider('-providerName jaspi_provider 
-properties [ [debug false] ] 	')

Using Jacl:

$AdminTask modifyJaspiProvider { -providerName jaspi_provider  
-properties { {debug false} } }

Interactive mode example usage

Using Jython:

AdminTask.modifyJaspiProvider('-interactive')

Using Jacl:

$AdminTask modifyJaspiProvider -interactive

removeJaspiProvider

The removeJaspiProvider command removes one or more authentication providers from the security configuration for the given security domain or the global security configuration.

Target object

None.

Required parameters

-providerName: Specifies the unique name(s) of the authentication provider(s) to be removed.

Optional parameters

-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Return value

None.

Batch mode example usage

To remove a single provider using Jython:

AdminTask.removeJaspiProvider('-providerName jaspi_provider')

To remove multiple providers using Jython:

AdminTask.removeJaspiProvider( '[-providerName [ Provider1;Provider2 ] ]' )

To remove a single user using Jacl:

$AdminTask removeJaspiProvider {'-providerName jaspi_provider'}

To remove multiple providers using Jacl:

$AdminTask removeJaspiProvider {-providerName {Provider1 Provider2 } }

Interactive mode example usage

Using Jython:

AdminTask.removeJaspiProvider('-interactive')

Using Jacl:

$AdminTask removeJaspiProvider -interactive

unconfigureJaspi

The unconfigureJaspi command is used to remove the JASPI configuration and all of its associated providers from a security domain.

Target object

None.

Required parameters

-securityDomainName: Specifies the name of the security domain. The command uses the global security configuration if you do not specify a value for the -securityDomainName parameter.

Optional parameters

None.

Return value

None.

Batch mode example usage

Using Jython:

AdminTask.unconfigureJaspi('-securityDomainName domain1')

Using Jacl:

$AdminTask unconfigureJaspi {-securityDomainName domain1}

Interactive mode example usage

Using Jython:

AdminTask.unconfigureJaspi('-interactive')

Using Jacl:

$AdminTask unconfigureJaspi -interactive