Java Agents 2024.6

Pre-Authn and Post Data Preservation Cookie Signing Value

The key to sign pre-authentication cookies and POST data preservation cookies.

The key is set during installation, when the agent requests the path to a file containing the cookie signing key, and then uses the key to set the cookie signing value in the AgentKey.properties file. For information about how to set or change the key after installation, see Rotate cookie signing keys.

For security, you are recommended to configure cookie signing. The agent does not sign cookies when:

  • The path to the signing key is left blank during installation.

  • The signing key in the AgentKey.properties file is less than 64-characters long.

Property name

org.forgerock.agents.cookie.signing.value

Aliases

org.forgerock.agents.cookie.signing.value
  Introduced in Java Agent 5.10.0

Function

Cookie, POST data preservation, Pre-authentication

Type

String

Bootstrap property

No

Required property

No

Restart required

Yes - Restart the container after changing the property

Local configuration file

AgentKey.properties

Copyright © 2010-2024 ForgeRock, all rights reserved.