Each agent instance has a numbered directory, starting with
Agent_001 for the
first instance. The following directories are created under
config: For information, see Configuration files.
logs: During agent startup, the location of the logs is based on the container which is being used. For example, bootstrap logs for Tomcat agents are written to
catalina.out. The following log directories are created:
logs/audit/: Operational audit log directory, used only if remote logging to AM is disabled.
logs/debug/: The directory where the agent writes debug log files after startup.
After installation, configure an agent filter to intercept inbound client
requests and give them access to resources. The agent filter class is
com.sun.identity.agents.filter.AmAgentFilter. The agent filter gives access
based on the value of
Agent Filter Mode Map.
Configure the agent filter in the web application’s
For information about configuration options, see the documentation for your
web application. For example, see Oracle’s
Developing Web Applications for WebLogic Server.
Configure the agent filter first, before configuring other filters in
web.xml. If several web applications run in the same container,
configure an agent filter for each web application.
The following example protects every resource in the web application where it is configured:
<filter> <filter-name>Agent</filter-name> <display-name>AM Agent</display-name> <description>AM Agent Filter</description> <filter-class>com.sun.identity.agents.filter.AmAgentFilter</filter-class> </filter> <filter-mapping> <filter-name>Agent</filter-name> <url-pattern>/*</url-pattern> <dispatcher>REQUEST</dispatcher> <dispatcher>INCLUDE</dispatcher> <dispatcher>FORWARD</dispatcher> <dispatcher>ERROR</dispatcher> </filter-mapping>
The following example protects an application that processes requests asynchronously:
<filter> <filter-name>Agent</filter-name> <display-name>AM Agent</display-name> <description>AM Agent Filter</description> <filter-class>com.sun.identity.agents.filter.AmAgentFilter</filter-class> <async-supported>true</async-supported> </filter>
By default, the agent filter uses the filter mode
installation, you can change the filter mode with the property
Agent Filter Mode Map, or in the
In the AM console, go to REALMS > realm name > Applications > Agents > Java, and select your Java Agent.
On the Global tab, select Agent Filter Mode Map, and set the filter mode as follows:
URL_POLICYfor all web applications in the web container, do not change the setting; this is the default.
BankAppweb application, set these values:
(Optional) In Agent Filter Mode, override the global mode for a specific context path:
Value: Enter the mode name, for example
Click Add, and save your changes.
After installation, you can optionally configure secure communication between the agent and AM.
Configure AM to send cookies only when the communication channel is secure:
In the AM console, select REALMS > realm name > Applications > Agents > Java > agent name > SSO.
Enable Transmit Cookies Securely.
Import a CA certificate in the JDK truststore, usually at
$JAVA_HOME/jre/lib/security/cacerts. The certificate should be the one configured for HTTPS connections in the AM container, or signed with the same CA root certificate. For example:
$ keytool \ -import \ -trustcacerts \ -alias agentcert \ -file /path/to/cacert.pem \ -keystore $JAVA_HOME/jre/lib/security/cacerts
Make sure that all containers where AM is installed trust the certificate stored in the JDK truststore, and that the JDK trusts the certificates stored on the containers where AM is installed.
Add the following properties to the
javax.net.ssl.trustStore, to specify the full path to the JDK truststore.
javax.net.ssl.trustStorePassword, to specify the password of the truststore.
For backward-compatibility, you can also provide the truststore and the password to the agent by specifying them as Java properties in the container’s start-up sequence. For example, add them to Tomcat’s
$CATALINA_OPSvariable instead of specifying them in the
$ export CATALINA_OPTS="$CATALINA_OPTS \ -Djavax.net.ssl.trustStore=$JAVA_HOME/jre/lib/security/cacerts \ -Djavax.net.ssl.trustStorePassword=changeit"
Restart the agent.