PerimeterX Bot Defender nodes for Identity Platform 7.1.0 and above. Combined, the nodes handle the PerimeterX request verification process and the display of the challenge page.
To deploy these nodes, download the jar from the releases tab on github here. Next, copy the jar into the ../web-container/webapps/openam/WEB-INF/lib directory where AM is deployed. Restart the web container to pick up the new node. The node will then appear in the authentication trees components palette.
Drag the node to your journey and connect it after the Data Store Decision node. Connect the true output to your success node and the false output to the pxChallengeNode in order to show the challenge page for a blocked request. Finally, connect pxChallengeNode to the red X:
Make sure to fill in the required node properties for the pxVerificationNode node. You can find all the required data on the PerimeterX Console.
When a request gets blocked, the default challenge page will be shown, as follows:
PerimeterX Bot Defender node for Identity Platform 7.1.0 and above. Handles the PerimeterX request verification process.
- PerimeterX Application ID - Application ID to be retrieved from the PerimeterX console.
- PerimeterX Auth Token - Auth Token to be retrieved from the PerimeterX console.
- PerimeterX Cookie Secret - Cookie Secret to be retrieved from the PerimeterX console.
- PerimeterX Allowlist for User-Agents - A list of User-Agents PerimeterX should always allow.
- PerimeterX Allowlist for IP addresses - A list of IP addresses PerimeterX should always allow.
- PerimeterX Blocking Score - The score of which PerimeterX module will block upon.
- PerimeterX Module Mode - Sets the mode for the module: 0 is monitor, 1 is blocking.
- PerimeterX Server Connection Timeout - The timeout (in ms) for connecting to PerimeterX servers.
- PerimeterX API Connection Timeout - The timeout (in ms) for connecting to PerimeterX APIs.
- PerimeterX Sensitive Routes - A list of route prefixes that are defined as sensitive.
- PerimeterX Bypass Monitor Header - A header name which if sent - bypasses monitor mode for the specific request it was sent for.
PerimeterX Bot Defender node for Identity Platform 7.1.0 and above. Display of the challenge page.
- PerimeterX CSS Referencing - An absolute URL to a custom CSS file to use when showing the challenge page.
- PerimeterX JavaScript Ref - An absolute URL to a custom JavaScript file to use when showing the challenge page. Can be used for customizing the challenge element look and feel.
The code in this repository has binary dependencies that live in the ForgeRock maven repository. Maven can be configured to authenticate to this repository by following the following ForgeRock Knowledge Base Article.
ForgeRock does not warrant, guarantee or make any representations regarding the use, results of use, accuracy, timeliness or completeness of any data or information relating to the sample code. ForgeRock disclaims all warranties, expressed or implied, and in particular, disclaims all warranties of merchantability, and warranties related to the code, or any service or software related thereto.
ForgeRock shall not be liable for any direct, indirect or consequential damages or costs of any type arising out of any action taken by you or others related to the sample code.