RHEL agent configuration
Use the paa.conf and agent.properties files to manage the configuration of the PingAccess Agent for Apache (RHEL).
|
You can find more information about improving agent performance in the Performance tuning guide. |
Modifying the paa.conf file
The /etc/httpd/conf.d/paa.conf file contains the following parameters.
Parameters
| Parameter | Definition | Default Value | ||
|---|---|---|---|---|
PaaCertificateDir |
String value containing the path to the certificates extracted from the |
|
||
PaaEnabled |
Determines whether the agent is enabled or disabled for a specific server configuration. Valid values are This value can be set globally; set for individual virtual hosts, directories, locations, or files; or both. The agent follows the most specific value that you set.
For example, adding this text to an included configuration file enables PingAccess for the <VirtualHost *:81>
<Location /pa>
PaaEnabled on
</Location>
<Directory "/var/www/html/one">
PaaEnabled on
</Directory>
</VirtualHost>
Adding this text to an included configuration file disables PingAccess for all content in the <VirtualHost *:81>
<Directory "/var/www/html/two">
PaaEnabled off
<Files "page2.html">
PaaEnabled on
</Files>
</Directory>
</VirtualHost>
|
|
||
PaaPropertyFiles |
List of |
|
||
PaaEnabledNoteName |
An optional parameter that defines a note name. If a request includes a note with this name and a value of To use this feature, you must deploy a custom module to include this note with the correct value. |
|
Modifying the agent.properties file
The agent.properties file can contain the following properties.
|
Properties
| Property | Definition | Default Value | ||||
|---|---|---|---|---|---|---|
|
The Uniform Resource Identifier (URI) scheme the agent uses to connect to the PingAccess engine node. Acceptable values include:
|
|
||||
|
The PingAccess host name. |
The value in the agent node’s |
||||
|
The port that the agent connects to on the PingAccess host.
|
Defined in the PingAccess |
||||
|
The unique agent name that identifies the agent in PingAccess. |
Defined in the PingAccess admin console. This value corresponds with the Name you assign to the agent during creation. Learn more in the Name table entry. |
||||
|
The password the agent uses to authenticate with the engine. |
Generated by PingAccess when you click Save & Download after creating an agent in the admin console. Learn more in Adding agents. |
||||
|
The base64-encoded public certificate the agent uses to establish HTTPS trust with the PingAccess engine.
|
Generated by PingAccess. |
||||
|
The number of connections that a single web server worker process maintains to the PingAccess engine defined in the |
|
||||
|
The maximum amount of time, in milliseconds, that an agent request made to PingAccess can take.
If this time is exceeded, the client receives a generic |
|
||||
|
The maximum amount of time, in milliseconds, that the agent can take to connect to the PingAccess engine.
If this time is exceeded, the client receives a generic |
|
||||
|
The maximum amount of time (in milliseconds) that a web server worker process waits for a response to a policy cache request sent to other web server worker processes. |
|
||||
|
The network port that web server processes use to publish policy cache requests to other web server worker processes. This port is bound to the localhost network only. |
|
||||
|
The network port that web server processes use to receive policy cache requests from other web server worker processes. This port is bound to the localhost network only. |
|
||||
|
The maximum number of tokens that are stored in the policy cache for a single web server worker process. A value of |
|
||||
|
Determines whether policy decision caching is enabled or disabled. A value of You might want to use this option for custom rules created using the PingAccess SDK that involve data that changes with every request within a resource and session.
|
By default, this property isn’t included in the |
||||
|
The host name and port of the PingAccess server where the agent should send requests in the event of a failover from the PingAccess host. |
Defined in the PingAccess admin console. Learn more in the Failover Host table entry. |
||||
|
The number of milliseconds to wait before the agent should retry connecting to a failed PingAccess server. |
|
||||
|
The number of times to retry a connection to a PingAccess server after an unsuccessful attempt. If all retries fail, the agent marks the PingAccess server as failed for the duration of the |
|
||||
|
Controls the type of policy cache used by the agent. There are three acceptable values for this property:
|
|
||||
|
Determines whether the This header contains the following fields:
Learn more in Agent inventory logging. |
|
||||
|
Specifies additional values to include in the This property uses the following syntax: agent.inventory=exampleheader=TEST;exampleheader2=TEST2;
|
By default, this property isn’t included in the |
||||
|
If present, specifies a header that overrides the default |
By default, this property isn’t included in the |
||||
|
Determines which token type takes precedence when making an access decision if both a cookie and an authorization header token are included in a request. Acceptable values are
|
|
||||
|
If present, specifies a value (or values) that prompts PingAccess to block a request if it finds one or more of them in the request body. When defining these values, you can:
The following example demonstrates how to block some common XSS characters: agent.request.block.xss.characters=<,>,’,/\,\,%22,%0a,%0d
|
By default, this property isn’t included in the |
||||
|
If present, specifies a value (or values) that prompts PingAccess to block a request if it finds one or more of them in the request URI. When defining these values, follow the syntax established in the The following example demonstrates how to block some common URI characters: agent.request.block.uri.characters=//,./,/.,/,.,~,\,%00-%1f,%7f |
By default, this property isn’t included in the |
||||
|
If present, specifies a value (or values) that prompts PingAccess to block a request if it finds one or more of them in the request’s query parameters. When defining these values, follow the syntax established in the The following example demonstrates how to block some common query characters: agent.request.block.query.characters=<,>,&,%22,%27,%28,%29,%7b,%7d |
By default, this property isn’t included in the |
||||
|
If present, specifies a value (or values) that prompts PingAccess to block a request if it finds one or more of them in the request’s form parameters.
When defining these values, follow the syntax established in the The following example demonstrates how to block some common form characters: agent.request.block.form.characters=<,>,&,%22,%27,%28,%29,%7b,%7d |
By default, this property isn’t included in the |
||||
|
Specifies a custom status code to display when the agent blocks a request because of a bad XSS character.
The following example demonstrates how to set an XSS HTTP status code: agent.request.block.xss.http.status=400 |
By default, this property isn’t included in the |
||||
|
Specifies a custom status code to display when the agent blocks a request because of a bad URI character. The following example demonstrates how to set a URI HTTP status code: agent.request.block.uri.http.status=404 |
By default, this property isn’t included in the |
||||
|
Specifies a custom status code to display when the agent blocks a request because of a bad query character. The following example demonstrates how to set a query HTTP status code: agent.request.block.query.http.status=400 |
By default, this property isn’t included in the |
||||
|
Specifies a custom status code to display when the agent blocks a request because of a bad form character. The following example demonstrates how to set a form HTTP status code: agent.request.block.form.http.status=400 |
By default, this property isn’t included in the |