OpenSSOAgentConfiguration.template revision 504576c0cd21165cc879543ca89164d214acf996
22N/A# $Id: OpenSSOAgentConfiguration.template,v 1.3 2009/10/15 23:34:10 leiming Exp $
0N/A# com.sun.identity.agents.config.example[0] = value0
22N/A# com.sun.identity.agents.config.example[1] = value1
116N/A# com.sun.identity.agents.config.example[2] = value2
219N/A# com.sun.identity.agents.config.example[AL] = ALABAMA
221N/A# com.sun.identity.agents.config.example[AK] = ALASKA
221N/A# com.sun.identity.agents.config.example[AZ] = ARIZONA
219N/A# APPLICATION SPECIFIC/GLOBAL CONFIGURATION:
219N/A# com.sun.identity.agents.config.example[Portal] = value1
219N/A# com.sun.identity.agents.config.example[DefaultWebApp] = value2
219N/A# com.sun.identity.agents.config.example = value3
219N/A# com.sun.identity.agents.config.example[Portal] = value1
219N/A# com.sun.identity.agents.config.example[BankApp] = value2
219N/A# com.sun.identity.agents.config.example[DefaultWebApp] = value3
235N/A# com.sun.identity.agents.config.filter.mode[BankApp] = URL_POLICY
227N/A# - user.mapping.mode: Specifies the mechanism by which the user-ID
235N/A# - user.attribute.name: Specifies the name of the profile attribute,
235N/A# property is not used if the value of user.mapping.mode is set to
235N/A# - user.principal: A flag that indicates that the principal of the
235N/A# applicable if the user.mapping.mode is set to USER_ID.
222N/A# - user.token: Specifies a session property name which contains the
227N/A# com.sun.identity.agents.config.user.mapping.mode = PROFILE_ATTRIBUTE
227N/A# com.sun.identity.agents.config.user.attribute.name = employeenumber
235N/Acom.sun.identity.agents.config.user.attribute.name = employeenumber
227N/Acom.sun.identity.agents.config.user.token = UserToken
222N/A# - client.ip.header: Specifies a HTTP header name that holds the IP
222N/A# - client.hostname.header: Specifies a HTTP header name that holds the
227N/A# com.sun.identity.agents.config.client.ip.header = X-Proxy-Client-IP
235N/A# com.sun.identity.agents.config.client.hostname.header = X-Proxy-Client-Host
235N/A# - locale.language: Specifies the language code for identifying the Locale
235N/A# - locale.country: Specifies the country code for identifying the Locale of
222N/A# - audit.accesstype: Specifies the access type which will be logged by the
227N/A# - log.disposition: Specifies the audit log mode that the Agent will use
222N/A# - remote.logfile: Specifies the file name to be used on the remote server
222N/A# if the log.disposition is set to REMOTE or ALL.
172N/A# - local.log.rotate: A flag that indicates if the rotation of audit log
172N/A# - local.log.size: The size in bytes of the local audit log file, beyond
235N/Acom.sun.identity.agents.config.remote.logfile = @AUDIT_LOG_FILENAME@
172N/A# - webservice.enable: A flag that specifies if Web Service processing is
172N/A# - webservice.endpoint: A list of Web Application end points that represent
235N/A# - webservice.process.get.enable: A flag that indicates if the processing
172N/A# - webservice.authenticator: An implementation class that can be used to
235N/A# - webservice.internalerror.content: The name of file that contains content
172N/A# - webservice.autherror.content: The name of file that contains content
63N/A# - login.form: A LIST property used by the Agent to identify login
111N/A# - login.error.uri: A LIST property used by the Agent to identify
235N/A# - login.use.internal: A flag that specifies if the Agent should use
235N/A# - login.content.file: Specifies the name or complete path of the file
172N/A# the login.use.internal flag is set to true.
251N/A# - auth.handler: A MAP property that specifies application
0N/A# - logout.handler: A MAP property that specifies the application
235N/A# - verification.handler: A MAP property that specifies the application
66N/A# com.sun.identity.agents.config.auth.handler[BankApp] = BankAuthHandler
67N/A# com.sun.identity.agents.config.logout.handler[BankApp] = BankLogoutHandler
67N/A# com.sun.identity.agents.config.verification.handler[BankApp] = BankVerificationHandler
192N/Acom.sun.identity.agents.config.login.url[0] = @AM_SERVICES_PROTO@://@AM_SERVICES_HOST@:@AM_SERVICES_PORT@@AM_SERVICES_DEPLOY_URI@/UI/Login
66N/Acom.sun.identity.agents.config.logout.url[0] = @AM_SERVICES_PROTO@://@AM_SERVICES_HOST@:@AM_SERVICES_PORT@@AM_SERVICES_DEPLOY_URI@/UI/Logout
66N/A# - login.url.prioritized: specifies if the failover sequence for Login URLs
66N/A# - login.url.probe.enabled: specifies if agent will check the availability
219N/A# - login.url.probe.timeout: this is the connect timeout value in milliseconds
104N/A# when login.url.probe.enabled is set to true (or server will be checked).
14N/A# - logout.url.prioritized: specifies if the failover sequence for Logout
0N/A# - logout.url.probe.enabled: specifies if agent will check the availability
30N/A# - logout.url.probe.timeout: this is the connect timeout value in milliseconds
104N/A# when logout.url.probe.enabled is set to true (or server will be checked).
204N/A# - agent.host: The host name identifying the Agent protected server to
204N/A# - agent.port: The port number identifying the Agent protected server
204N/A# - cookie.reset.enable: A flag that specifies if cookie reset processing
204N/A# - cookie.reset.name: A list of cookie names that will be reset by the
204N/A# - cookie.reset.domain: A MAP property with the key being the cookie name
60N/A# specified in cookie.reset.name property and the value being the domain
162N/A# - cookie.reset.path: A MAP property with the key being the cookie name
172N/A# specified in cookie.reset.name property and the value being the path
162N/A# - cdsso.enable: A flag that specifies if CDSSO processing is
227N/A# - cdsso.redirect.uri: An intermediate URI that is used by the
162N/A# - cdsso.cdcservlet.url: A LIST of URLs of the available CDSSO controllers
235N/A# - cdsso.clock.skew: Specifies a time in seconds to be used by the
221N/A# - cdsso.trusted.id.providers: This property specifies the OpenAM
221N/A# the CDC Liberty Responses. Used when a Load Balancer/Firewall is between
221N/A# - cdsso.secure.enable: A flag that specifies if the SSO Token cookie
221N/A# - cdsso.domain: This property specifies the domains for which cookies have
162N/Acom.sun.identity.agents.config.cdsso.redirect.uri = @AGENT_APP_URI@/sunwCDSSORedirectURI
162N/Acom.sun.identity.agents.config.cdsso.cdcservlet.url[0] = @AM_SERVICES_PROTO@://@AM_SERVICES_HOST@:@AM_SERVICES_PORT@@AM_SERVICES_DEPLOY_URI@/cdcservlet
162N/Acom.sun.identity.agents.config.cdsso.trusted.id.provider[0] = @AM_SERVICES_PROTO@://@AM_SERVICES_HOST@:@AM_SERVICES_PORT@@AM_SERVICES_DEPLOY_URI@/cdcservlet
227N/A# - logout.application.handler: An application specific (MAP) property
162N/A# - logout.uri: An application specific (MAP) property that identifies
162N/A# - logout.request.param: An application specific (MAP) property that
162N/A# - logout.introspect.enabled: A flag that when set allows the Agent
162N/A# - logout.entry.uri: An application specific (MAP) property that identifies
221N/A# - fqdn.check.enable: A flag that indicates if FQDN checking is enabled
162N/A# - fqdn.default: A hostname that represents the default FQDN to be
195N/A# - fqdn.mapping: A MAP property that specifies a mapping from an invalid
221N/A# Examples of fqdn.mapping:
162N/Acom.sun.identity.agents.config.fqdn.default = @AGENT_HOST@
162N/A# - legacy.support.enable: A flag that specifies if legacy user agent
162N/A# - legacy.user.agent: A LIST of user agent header values that identify
235N/A# - legacy.redirect.uri: An intermediate URI used by the Agent to
221N/Acom.sun.identity.agents.config.legacy.user.agent[0] = Mozilla/4.7*
221N/Acom.sun.identity.agents.config.legacy.redirect.uri = @AGENT_APP_URI@/sunwLegacySupportURI
221N/A# com.sun.identity.agents.config.response.header[Cache-Control] = no-cache
162N/A# - port.check.enable: A flag that indicates if port check functionality
162N/A# - port.check.file: Specifies the name or complete path of a file that
219N/A# - port.check.setting: A MAP of port versus protocol entries with the
162N/A# Example of port.check.setting:
162N/A# com.sun.identity.agents.config.port.check.setting[443] = https
221N/Acom.sun.identity.agents.config.port.check.setting[@AGENT_PREF_PORT@] = @AGENT_PREF_PROTO@
162N/A# - notenforced.uri: A LIST of URIs for which protection is not enforced
162N/A# - notenforced.uri.invert: A flag that specifies if the list of URIs
162N/A# specified by the property notenforced.uri should be inverted. When
162N/A# - notenforced.uri.cache.enable: A flag that specifies if the caching of
162N/A# - notenforced.uri.cache.size: The size of the cache to be used if
162N/A# - notenforced.refresh.session.idletime: A flag that specifies if the OpenAM
162N/A# Example of notenforced.uri:
162N/A# com.sun.identity.agents.config.notenforced.uri[1]=/public/*
162N/A# com.sun.identity.agents.config.notenforced.uri[2]=/images/*
162N/A# - notenforced.ip: A LIST of client IP addresses for which protection is
162N/A# - notenforced.ip.invert: A flag that specifies if the list of client IP
162N/A# addresses specified by the property notenforced.ip should be inverted.
162N/A# - notenforced.ip.cache.enable: A flag that specifies if the caching of
162N/A# - notenforced.ip.cache.size: The size of the cache to be used if
162N/A# Example of notenforced.ip:
162N/A# com.sun.identity.agents.config.notenforced.ip[0]=192.18.145.*
162N/A# com.sun.identity.agents.config.notenforced.ip[1]=192.18.146.123
162N/A# - attribute.cookie.separator: A character that will be used to separate
162N/A# - attribute.cookie.encode: A flag that indicates if the value of the
162N/A# - attribute.date.format: The format of date attribute values to be used
162N/A# on the definition as provided in java.text.SimpleDateFormat.
221N/Acom.sun.identity.agents.config.attribute.date.format = EEE, d MMM yyyy hh:mm:ss z
221N/A# - profile.attribute.fetch.mode: The mode of fetching profile attributes.
221N/A# - profile.attribute.mapping: A MAP that specifies the profile attributes to
219N/A# Example of profile.attribute.mapping:
219N/A# com.sun.identity.agents.config.profile.attribute.mapping[cn]=CUSTOM-Common-Name
259N/A# com.sun.identity.agents.config.profile.attribute.mapping[mail]=CUSTOM-Email
259N/A# - session.attribute.fetch.mode: The mode of fetching session attributes.
259N/A# - session.attribute.mapping: A MAP that specifies the session attributes to
259N/A# Example of session.attribute.mapping:
259N/A# com.sun.identity.agents.config.session.attribute.mapping[UserToken]=CUSTOM-userid
259N/A# - response.attribute.fetch.mode: The mode of fetching policy response
259N/A# - response.attribute.mapping: A MAP that specifies the policy response
259N/A# com.sun.identity.agents.config.bypass.principal[1] = testuser
259N/A# - default.privileged.attribute: A list of privileged attributes that will
259N/A# - privileged.attribute.type: A list of privileged attribute types that will
259N/A# - privileged.attribute.tolowercase : A MAP property that specifies if the
172N/A# - privileged.session.attribute: A list of session property names which
116N/A# - privileged.attribute.mapping.enable: A flag to specify whether
116N/A# - privileged.attribute.mapping: A map property that specifies the above
104N/A# com.sun.identity.agents.config.default.privileged.attribute[0] = AUTHENTICATED_USERS
30N/A# com.sun.identity.agents.config.privileged.session.attribute[0] = UserToken
221N/A# com.sun.identity.agents.config.privileged.attribute.mapping[id\=manager,ou\=group,dc\=opensso,dc\=java,dc\=net] = am_manager_role
30N/A# com.sun.identity.agents.config.privileged.attribute.mapping[id\=employee,ou\=group,dc\=opensso,dc\=java,dc\=net] = am_employee_role
221N/Acom.sun.identity.agents.config.default.privileged.attribute[0] = AUTHENTICATED_USERS
285N/Acom.iplanet.am.cookie.name=iPlanetDirectoryPro
221N/A# - com.iplanet.am.session.client.polling.enable: A flag that specifies if
221N/A# - com.iplanet.am.session.client.polling.period: Specifies the time in
285N/A# notifications is com.sun.identity.client.notification.url
259N/A# - com.sun.identity.idm.remote.notification.enabled: A flag that is used to
259N/A# enable/disable the notifications for amsdk and IdRepo Caches. If set to
259N/A# - com.iplanet.am.sdk.remote.pollingTime: Cache update time in minutes for
259N/A# 'com.sun.identity.client.notification.url' or if notifications are
192N/A# - com.sun.identity.sm.notification.enabled: A flag that is used to
52N/A# enable/disable the notifications for service management caches. If set to
192N/A# - com.sun.identity.sm.cacheTime: Cache update time in minutes for service
22N/A# 'com.sun.identity.client.notification.url' or if notifications are
221N/Acom.iplanet.am.server.protocol=@AM_SERVICES_PROTO@
192N/Acom.iplanet.am.server.host=@AM_SERVICES_HOST@
192N/Acom.iplanet.am.server.port=@AM_SERVICES_PORT@
63N/A# - com.sun.identity.agents.notification.enabled: A flag that specifies
242N/A# - com.sun.identity.agents.polling.interval: The duration in minutes
242N/A# - com.sun.identity.policy.client.cacheMode: The mode of caching to be
242N/A# - com.sun.identity.policy.client.booleanActionValues : boolean action
242N/A# - com.sun.identity.policy.client.resourceComparators: Resource Comparators
192N/A# - com.sun.identity.policy.client.clockSkew: Specifies time in seconds
192N/Acom.sun.identity.policy.client.booleanActionValues=iPlanetAMWebAgentService|GET|allow|deny:iPlanetAMWebAgentService|POST|allow|deny
219N/Acom.sun.identity.policy.client.resourceComparators=serviceType=iPlanetAMWebAgentService|class=com.sun.identity.policy.plugins.HttpURLResourceName|wildcard=*|delimiter=/|caseSensitive=false
192N/A# - com.sun.identity.agents.config.policy.env.get.param: A list of HTTP GET
204N/A# - com.sun.identity.agents.config.policy.env.post.param: A list of HTTP POST
192N/A# com.sun.identity.agents.config.policy.env.get.param[1]=phonenumber
0N/A# com.sun.identity.agents.config.policy.env.jsession.param[0]=cardnumber
192N/A# GET.phonenumber => [1-800-123-4567]
192N/A# JSESSION.cardnumber => [12345678]
221N/A# -com.sun.identity.client.notification.url: URL for agent to receive
com.sun.identity.client.notification.url=@AGENT_PREF_PROTO@://@AGENT_HOST@:@AGENT_PREF_PORT@@AGENT_APP_URI@/notification
# - com.iplanet.services.debug.level: Specifies the debug level to be used.
com.iplanet.services.debug.level=@DEBUG_LEVEL@
# This property need to be set to true when the Agent is installed on JBoss-4.2.x.GA
# and it should be set to false when the Agent is installed on JBoss-4.0.5.GA