SPNEGO TAI JVM configuration custom properties (deprecated)


JVM custom properties control the operation of the SPNEGO TAI.

Deprecated feature:

In WAS Version 6.1, a TAI that uses the SPNEGO to securely negotiate and authenticate HTTP requests for secured resources was introduced. In WAS 7.0, this function is now deprecated. SPNEGO Web authentication has taken its place to provide dynamic reload of the SPNEGO filters and to enable fallback to the application login method. depfeat

The following JVM custom properties control operation of the SPNEGO TAI. Different custom property values can be specified for each appserver.


Table 1. JVM configuration custom properties

Custom Property Name Required Value Type Default Value Recommended Value
com.ibm.ws.security.spnego.isEnabled No Boolean False True
com.ibm.ws.security.spnego.propertyReloadFile No String None For Windows

C:\temp\TAI.props
For UNIX

/tmp/TestTAI.Properties
com.ibm.ws.security.spnego.propertyReloadTimeout No Integer None 120

com.ibm.ws.security.spnego.isEnabled

Use this custom property to enable or disable operation of the SPNEGO TAI in a given appserver. When set to false, the SPNEGO TAI is disabled and not used by the Web authentication module for authenticating any Web requests. When set to true, the SPNEGO TAI is enabled and used by the Web authentication module for authenticating any Web requests.

com.ibm.ws.security.spnego.propertyReloadFile

Use this custom property to identify the file that contains configuration properties for the SPNEGO TAI, when it is not convenient to stop and restart the appserver. The properties contained in this file can be reloaded to configure the SPNEGO TAI.

The properties defined in the specified file override any properties defined using the admin console.

A sample of this reload file follows:

##########################################################
# Template properties files for SPNEGO TAI
#  
# Where possible defaults have been provided.
#
##########################################################

#---------------------------------------------------------
# Hostname
#---------------------------------------------------------
#
com.ibm.ws.spnego.SPN1.HostName=wsecurity.mpls.setgetweb.com 

#---------------------------------------------------------
# (Optional) SpnegoNotSupportedPage
#---------------------------------------------------------
#
com.ibm.ws.spnego.SPN1.SpnegoNotSupportedPage=

#---------------------------------------------------------
# (Optional) NTLMTokenReceivedPage
#---------------------------------------------------------
#
com.ibm.ws.spnego.SPN1.NTLMTokenReceivedPage=

#---------------------------------------------------------
# (Optional) FilterClass
#---------------------------------------------------------
#
com.ibm.ws.spnego.SPN1.FilterClass=com.ibm.ws.spnego.HTTPHeaderFilter

#---------------------------------------------------------
# (Optional) Filter
#---------------------------------------------------------
#
com.ibm.ws.spnego.SPN1.Filter=

If com.ibm.ws.security.spnego.propertyReloadFile custom property is set, but the com.ibm.ws.security.spnego.propertyReloadTimeout custom property is not, then the SPNEGO TAI is not initialized.

com.ibm.ws.security.spnego.propertyReloadTimeout

Specify a time interval in seconds that elapses after which the SPNEGO TAI reloads the configuration properties. Also, the SPNEGO TAI reloads the configuration properties if the file that is identified by the com.ibm.ws.security.spnego.propertyReloadFile custom property changed since the last time the configuration custom properties were retrieved. This time interval in seconds must be specified as a positive integer.

Remember: We can also use the wsadmin command for the AdminConfig scripting object to interactively set the com.ibm.ws.security.spnego.isEnabled custom property. See Enable the SPNEGO TAI as JVM custom property using scripting (deprecated) for more information.

The following custom properties are not used directly by the SPNEGO TAI; however, they affect the operation of the core security runtime and can also be used for problem determination.


Table 2. JVM configuration custom properties

Custom Property Name Required Value Type Default Value Recommended Value
java.security.properties No String None
com.ibm.security.jgss.debug No String None "off" or "all"
com.ibm.security.krb5.Krb5Debug No String None "off" or "all"
javax.security.auth.useSubjectCredsOnly Yes Boolean True False

java.security.properties

Is optional. It can be used when different appservers in a cell have different security requirements and it is not convenient to modify the global java.security file for the entire cell. In such situations, the java.security.properties custom property is used to specify the location of the java.security file used by the JVM for each appserver.

com.ibm.security.jgss.debug

This custom property is optional. It can be used to collect diagnostic trace information for problem determination in the Java Generic Security Service (JGSS) application programmer interface (API) implementation. The value can be set to all or off to enable or disable tracing, respectively. See Java Generic Security Service User's Guide for specific JGSS API information.

com.ibm.security.krb5.Krb5Debug

This custom property is optional. It can be used to collect additional diagnostic trace information for problem determination in the JGSS implementation. The value can be set to all or off to enable or disable tracing, respectively.

javax.security.auth.useSubjectCredsOnly

JGSS includes an optional JAAS login facility that saves Principal credentials and secret keys in the Subject of the application’s JAAS login context. JGSS retrieves credentials and secret keys from the Subject by default. This feature can be disabled by setting the Java property javax.security.auth.useSubjectCredsOnly to false.

The SPNEGO TAI does not use the optional JAAS login module. The javax.security.auth.useSubjectCredsOnly property must be set to false.






 

Related concepts


Single sign-on for HTTP requests using SPNEGO TAI (deprecated)

 

Related tasks


Set JVM custom properties, filtering HTTP requests, and enabling SPNEGO TAI in WAS (deprecated)

 

Related


Java Generic Security Service User's Guide