Post-Installation Tasks

Configure Shared Runtime Resources and Memory

By default, agent instances share the Unix Apache and NGINX Plus agent shared memory, runtime resources, and installation files. For example, Agent_1 and Agent_2 instances write the same session log and audit files (even though each one writes to their own file), use the same agent policy cache, and run a single set of worker processes and background tasks.

Choose Whether to Share Resources

You can choose to configure several related agent instances to share resources, and configure others to be independent.

Despite sharing resources, agent instances can be started and stopped individually and can run as different users as long as the agent resources can be shared by their effective user and groups.

Choosing whether to share runtime resources and shared memory is an important decision that depends on your environment. Consider the information in the following table before configuring your agents:

Impact of Sharing Resources
Impact Advantage Caution

Shared agent policy and session cache

Potentially reduces overhead of requests to AM for authentication and authorization.

Cache may fill with irrelevant entries.

Reduced memory consumption.

Sharing the cache among different locations or virtual hosts may not be desirable.

-

Agent instances that are members of the same agent group must be configured in the same Apache or NGINX Plus installation.

Reduced number of background threads. (Single WebSocket connection to AM for notifications)

Reduced system resource usage.

Ensure the AM_MAX_AGENTS environment variable is set to, at least, the total number of agent instances in the installation.

Agent instances share runtime files and semaphores

Reduced system resource usage.

Must ensure files and resources can be accessed by all the agent instances.

For example, add the users running the instances to the same group and configure the resources to have 660 permissions. For more information, see AM_RESOURCE_PERMISSIONS in Environment Variables.

Configure Agent Groups

An agent group is a group of agent instances that share runtime resources and shared memory. Agent groups are defined by adding AmAgentID (Apache agent) and openam_agent_instance (NGINX Plus agent) directives to Apache and NGINX Plus configuration files.

Consider these constraints when configuring agent groups:

• Neither the Apache agent nor the NGINX Plus agent set the directives during installation.

• When not set, the AmAgentID directive defaults to 0, and the openam_agent_instance directive defaults to 1.

• The value of the directives must increase by one for each agent group configured. For example, if the default value of the AmAgentID directive is 0, the next agent group must be 1.

• Agent instances that are members of the same agent group must be part of the same Apache or NGINX Plus installation.

• By default, the maximum number of agent instances in a single installation is 32. For more information about changing this limit, see AM_MAX_AGENTS in Environment Variables.

The following table shows an example of six Apache agent instances split into three different agent groups:

Apache Agent Groups Example
Agent Instances Directive Configuration Description

Agent_1 and Agent_2

Not Set (defaults to 0)

The instances share runtime resources and policy cache.

Agent_3, Agent_4, and Agent_5

1

The instances share runtime resources and policy cache.

Agent_6

2

The instance does not share runtime resources and policy cache with any other instance.

To configure the agent group, set the AmAgentID or openam_agent_instance directives and their value along with the rest of the agent directives in the httpd.conf or nginx.conf files:

AmAgentID (Apache only)

The following is an example of a httpd.conf file with the AmAgentID directive configured:

<VirtualHost *:80>
ServerName www.site1.com
DocumentRoot /home/www/site1.com
AssignUserID site1 www-data
LoadModule amagent_module /web_agents/apache24_agent/lib/mod_openam.so
AmAgent On
AmAgentConf /web_agents/apache24_agent/bin/../instances/agent_1/config/agent.conf AmAgentID 1
…​
</VirtualHost>

<VirtualHost *:8080>
ServerName www.site2.com
DocumentRoot /home/www/site3.com
AssignUserID site2 www-data
LoadModule amagent_module /web_agents/apache24_agent/lib/mod_openam.so
AmAgent On
AmAgentConf /web_agents/apache24_agent/bin/../instances/agent_2/config/agent.conf AmAgentID 1
…​
</VirtualHost>

In this example, each virtual host is protected by a different instance of the agent, yet both agent instances belong to the agent group 1. They share runtime resources and shared memory.

openam_agent_instance (NGINX Plus only)

The following is an example of the nginx.conf file with the openam_agent_instance directive configured:

server {
listen       80 default_server;
server_name  localhost;
openam_agent on;
openam_agent_configuration /web_agents/nginx17_agent/bin/../instances/agent_3/config/agent.conf; openam_agent_instance 2
…​
location /customers {
openam_agent on;
openam_agent_configuration /web_agents/nginx17_agent/bin/../instances/agent_4/config/agent.conf; openam_agent_instance 2
root   /www/customers
index  index.html
}
…​

In this example, agent_1 protects the server context while agent_2 protects a location. Both instances belong to agent group 1, and share runtime resources and shared memory.

Configure SSL Communication Between the Agent and AM

Your environment may require that the WebSocket communication between AM and the agents happens over SSL. You can configure the agent to validate server certificates (installed in the container where AM runs), or to present a client certificate to AM, or both.

To facilitate integration and testing, Web Agent is configured by default to trust any server certificate. Test client certificates are not provided or configured.

To send cookies only when the communication channel is secure, set Enable Cookie Security to true.

Secure Internal Communication with OpenSSL

Unix-based agents support only OpenSSL libraries. Windows-based agents can use OpenSSL or Secure Communication with the Windows Secure Channel API.

For information about supported versions of OpenSSL, and where to locate related libraries, see Secure Communication Between Web Agent and AM.

Configure Server-Side and Client-Side Validation using OpenSSL

Perform the following steps to configure the agent to validate AM’s server certificate chain and to present client certificates if requested:

1. Open the /web_agents/agent_type/instances/Agent_nnn/config/agent.conf configuration file.

2. (For IIS or the Apache for Windows Web Agent) Configure the agent to use OpenSSL.

1. Set the bootstrap property Enable OpenSSL to Secure Internal Communications to true.

2. Ensure that the OpenSSL libraries are in the appropriate place, as specified in OpenSSL Library Location by Operating System.

3. (Optional) Configure the agent to validate AM’s server certificate:

1. Create a Privacy-Enhanced Mail (PEM) file that contains the certificates required to validate AM’s server certificate. For example, ca.pem .

2. Set the bootstrap property Server Certificate Trust to false.

3. Set the bootstrap property CA Certificate File Name to the PEM file previously created. For example:

• Unix

• Windows

com.forgerock.agents.config.cert.ca.file = /opt/certificates/ca.pem
com.forgerock.agents.config.cert.ca.file = C:\Certificates\ca.pem
4. Set the bootstrap property OpenSSL Certificate Verification Depth to the level of certificate validation required in your environment.

4. (Optional) To configure the agent to present its client certificate when AM is configured to perform client authentication, perform the following steps:

1. Create a PEM file that contains the certificate chain for the agent. For example, client-cert.pem .

2. Create a PEM file that contains the private key corresponding to the certificate. For example, client-private-key.pem .

3. Set the bootstrap property Public Client Certificate File Name to the file containing the certificate chain. For example:

• Unix

• Windows

com.forgerock.agents.config.cert.file = /opt/certificates/client-cert.pem
com.forgerock.agents.config.cert.file = C:\Certificates\client-cert.pem
4. Set the bootstrap property Private Client Certificate File Name to the file containing the client certificate private key. For example:

• Unix

• Windows

com.forgerock.agents.config.cert.key = /opt/certificates/client-private-key.pem
com.forgerock.agents.config.cert.key = C:\Certificates\client-private-key.pem
5. If the private key is password-protected, obfuscate the password by using the agentadmin --p command and configure it in the bootstrap property Private Key Password. For example:

• Unix

• Windows

\$ /path/to/web_agents/agent_type/bin/> agentadmin --p "Encryption Key" “cat certificate_password.file”
Encrypted password value: zck+6RKqjtc=com.forgerock.agents.config.cert.key.password = zck+6RKqjtc=
C:\path\to\web_agents\agent_type\bin> agentadmin.exe --p "Encryption_Key" "Certificate_File_Password"
Encrypted password value: zck+6RKqjtc=com.forgerock.agents.config.cert.key.password = zck+6RKqjtc=

Encryption Key is the value of the bootstrap property Agent Profile Password Encryption Key.

5. Review your configuration. It should look similar to the following:

• Unix

• Windows

//Server-side
com.sun.identity.agents.config.trust.server.certs = false
com.forgerock.agents.config.cert.ca.file = /opt/certificates/ca.pem
//Client-side
com.forgerock.agents.config.cert.file = /opt/certificates/client-cert.pem
com.forgerock.agents.config.cert.key = /opt/certificates/client-private-key.pem
com.forgerock.agents.config.cert.key.password = zck+6RKqjtc=
//General
org.forgerock.agents.config.secure.channel.disable=true
//Server-side
com.sun.identity.agents.config.trust.server.certs = false
com.forgerock.agents.config.cert.ca.file = C:\Certificates\ca.pem
//Client-side
com.forgerock.agents.config.cert.file = C:\Certificates\client-cert.pem
com.forgerock.agents.config.cert.key = C:\Certificates\client-private-key.pem
com.forgerock.agents.config.cert.key.password = zck+6RKqjtc=
6. Restart the agent or the container where it runs.

Secure Communication with the Windows Secure Channel API

By default, the IIS and Apache for Windows Web Agent uses the Windows built-in Secure Channel API. To use OpenSSL, see Securing Internal Communication with OpenSSL.

Configure Server-Side and Client-Side Validation using the Windows built-in Secure Channel API

Perform the following steps to configure the agent to validate AM’s certificate chain and to present client certificates if requested:

1. Open the /web_agents/agent_type/instances/Agent_nnn/config/agent.conf configuration file.

2. Configure the agent to use the Windows built-in Secure Channel API:

1. If this is a new installation, continue to the next step. Windows-based agents use the Windows built-in Secure Channel API by default.

2. If you ever configured the IIS or Apache for Windows web agent to use OpenSSL libraries, set the bootstrap property Enable OpenSSL to Secure Internal Communications to false.

3. (Optional) To configure the agent to validate AM certificate chain, perform the following steps:

1. Add the certificates required to validate AM’s server certificate to the Windows certificate store. For example, to use PowerShell, add root certificates to the Cert:\LocalMachine\Root location, and CA certificates to the Cert:\LocalMachine\Ca location.

2. Set the bootstrap property Server Certificate Trust to false.

4. (Optional) When AM’s container is configured to perform client authentication, configure the agent to present client certificates:

1. Import the client certificate chain and private key into the Windows certificate store. For example, for PowerShell, import them to Cert:\LocalMachine\My.

2. Set the bootstrap property Public Client Certificate File Name to the friendly name of the client certificate chain. For example:

com.forgerock.agents.config.cert.file = agent.example.com
 For compatibility, the agent supports an alternative configuration that does not use the Windows certificate store. Create a Personal Information Exchange (PFX) file containing the certificate chain for the agent and its private key. For example, client.pfx . Set the bootstrap property Public Client Certificate File Name to the previously created PFX file. For example: com.forgerock.agents.config.cert.file = C:\Certificates\client.pfx Obfuscate the certificate password by using the agentadmin --p command. For example: C:\path\to\web_agents\agent_type\bin> agentadmin.exe --p "Encryption_Key" "Certificate_File_Password" Encrypted password value: zck+6RKqjtc= Encryption_Key is the value of the Agent Profile Password Encryption Key bootstrap property. Set the bootstrap property Private Key Password to the value of the encrypted password. For example: com.forgerock.agents.config.cert.key.password = zck+6RKqjtc= Restart the agent or the container where it runs.
5. Review your configuration. It should look similar to the following:

• Windows Cert Store

• Windows PFX / PCKS12 File

//Server-side
com.sun.identity.agents.config.trust.server.certs = false
//Client-side
com.forgerock.agents.config.cert.file = agent.example.com
//Server-side
com.sun.identity.agents.config.trust.server.certs = false
//Client-side
com.forgerock.agents.config.cert.file = C:\Certificates\client.pfx
com.forgerock.agents.config.cert.key.password = zck+6RKqjtc=
6. Restart the agent or the container where it runs.

Support Load Balancers and Reverse Proxies Between Clients and Agents

When your environment has reverse proxies or load balancers configured between agents and clients, you must perform additional configuration in the agents to account for the anonymization of both the clients and the agents.

Failure to do so may cause policy evaluation and other agent features to fail.

Configure Audit Logging

Web Agent supports the logging of audit events for security, troubleshooting, and regulatory compliance. Store agent audit event logs in the following ways:

Remotely

Log audit events to the audit event handler configured in the AM realm. In a site comprised of several AM servers, agents write audit logs to the AM server that satisfies the agent request for client authentication or resource authorization.

Web agents cannot log audit events remotely if:

• AM’s Audit Logging Service is disabled.

• No audit event handler is configured in the realm where the web agent is configured.

• All audit event handlers configured in the realm where the web agent is configured are disabled.

For more information about audit logging in AM, see Setting Up Audit Logging in AM’s Security Guide.

Locally

Log audit events in JSON format to a file in the agent installation directory, /web_agents/agent_type/logs/audit/ .

Locally and remotely

Log audit events:

• To a file in the agent installation directory.

• To the audit event handler configured in the AM realm in which the agent profile is configured.

The example is an agent log record:

{
"timestamp":"2017-10-30T11:56:57Z",
"eventName":"AM-ACCESS-OUTCOME",
"transactionId":"608831c4-7351-4277-8a5f-b1a83fe2277e",
"userId":"id=demo,ou=user,dc=openam,dc=forgerock,dc=org",
"trackingIds":[
"fd5c8ccf-7d97-49ba-a775-76c3c06eb933-82095",
"fd5c8ccf-7d97-49ba-a775-76c3c06eb933-82177"
],
"component":"Web Policy Agent",
"realm":"/",
"server":{
"ip":"127.0.0.1",
"port":8020
},
"request":{
"protocol":"HTTP/1.1",
"operation":"GET"
},
"http":{
"request":{
"secure":false,
"method":"GET",
"path":"http://my.example.com:8020/examples/",
"cookies":{
"am-auth-jwt":"eyJ0eXAiOiJKV1QiLCJhbGciOi[...]"
"i18next":"en",
"amlbcookie":"01",
"iPlanetDirectoryPro":"Ts2zDkGUqgtkoxR[...]"
}
}
},
"response":{
"status":"DENIED"
},
"_id":"fd5c8ccf-7d97-49ba-a775-76c3c06eb933-81703"
}
 Local audit logs do not have an _id attribute, which is an internal AM id.

The audit log format adheres to the log structure shared across the ForgeRock Identity Platform. For more information about the audit log format, see Audit Log Format in AM’s Security Guide.

Web Agent supports propagation of the transaction ID across the ForgeRock platform using the HTTP header X-ForgeRock-TransactionId. For more information about configuring the header, see Configuring the Trust Transaction Header System Property in AM’s Security Guide.

By default, Web Agent does not write audit log records. To configure audit logging, perform the following procedure:

To Configure Audit Logging

This procedure assumes that Web Agent is in centralized configuration mode. Property names are provided for local configuration mode.

1. In the AM console, go to Realms > Realm Name > Applications > Agents > Web > Agent Name > Global > Audit.

2. In the Audit Access Type property (com.sun.identity.agents.config.audit.accesstype), select the type of messages to log. For example, select LOG_ALL to log access allowed and access denied events.

3. In the Audit Log Location property (com.sun.identity.agents.config.log.disposition), select whether to write the audit logs locally to the agent installation (LOCAL), remotely to AM (REMOTE), or to both places (ALL). For example, keep REMOTE to log audit events to the AM instances.

4. In the Local Audit Log Rotation Size property (com.sun.identity.agents.config.local.log.size), specify the maximum size, in bytes, of the audit log files.

This is a bootstrap property. After changing this property, restart the web server where the agent runs.