Directives

HUMANConfiguration

Interfaces

perimeterx-java-sdk can be tuned and set a different types of interfaces in order to make the module more flexible
Below you can find a list of available interfaces and their setter

The interfaces should be set after HUMAN instance has been initialized

        BlockHandler exampleBlockHandler = new ExampleBlockHandler();
        PXConfiguration pxConf = new PXConfiguration.Builder(exampleBlockHandler)
                  // This will set the blocking handler from the default one to
                  // the our custom block handler
                .blockHandler()
                .build();
        this.enforcer = new PerimeterX(pxConf)
        this.enforcer.setActivityHandler(new BlockingActivityHandler());

Configuration Examples

Basic Active And Blocking Configuration

PXConfiguration pxConf = new PXConfiguration.Builder()
   .appId("APP_ID")
   .cookieKey("AUTH_TOKEN") // Should copy from RiskCookie section in https://console.perimeterx.com/botDefender/admin?page=policiesmgmt
   .moduleMode(ModuleMode.BLOCKING)
   .authToken("AUTH_TOKEN") // PX Server request auth token to be copied from Token section in https://console.perimeterx.com/botDefender/admin?page=applicationsmgmt
   .build();

Module Enabled/Disabled

PXConfiguration pxConf = new PXConfiguration.Builder()
...
   .moduleEnabled(false) // default is true
...

Monitored routes

PXConfiguration pxConf = new PXConfiguration.Builder()
    ...
       .monitoredRoutes(new HashSet<String>(Arrays.asList("/profile", "/profile.*")));
    ...

Enforced routes

 PXConfiguration pxConf = new PXConfiguration.Builder()
    ...
       .enforcedRoutes(new HashSet<String>(Arrays.asList("/profile", "/profile.*")));
    ...

Tune Blocking Score Threshold

PXConfiguration pxConf = new PXConfiguration.Builder()
...
   .blockingScore(95)

Sensitive Headers

PXConfiguration pxConf = new PXConfiguration.Builder()
...
   .sensitiveHeaders(new HashSet<String>(Arrays.asList("cookie", "cookies")))
...

IP Headers

PXConfiguration pxConf = new PXConfiguration.Builder()
...
   .ipHeaders(new HashSet<String>(Arrays.asList("x-px-true-ip", "x-true-ip")))
...

Sensitive Routes

PXConfiguration pxConf = new PXConfiguration.Builder()
...
   .sensitiveRoutes(new HashSet<String>(Arrays.asList("/cartCheckout")))
...

Customizing Default Block Page

PXConfiguration pxConf = new PXConfiguration.Builder()
...
   .customLogo(URL_TO_LOGO)
   .cssRef(URL_TO_CSS)
   .jsRef(URL_TO_JS)
...

Custom Parameters Provider

Risk API requests can be enriched with custom parameters by implementing CustomParametersProvider and adding logic to extract the custom parameters from the request.
Before implementing the interface, please make sure to configure custom parameters on HUMAN portal.
Make sure that the custom parameters are NOT marked as query strings

public class PerimeterxCustomParamsProvider implements CustomParametersProvider {
        public CustomParameters buildCustomParameters(PXConfiguration pxConfiguration, PXContext pxContext) {
            ... Some logic ...
            String cp2 = "PerimeterX_Custom_param2";
            String cp5 = "PerimeterX_Custom_param5";
            customParameters.setCustomParam2(cp2);
            customParameters.setCustomParam5(cp5);
            ... Some logic ...

            return customParameters;
        }
    }
PXConfiguration pxConf = new PXConfiguration.Builder()
PerimeterxCustomParamsProvider perimeterxCustomParamsProvider = new PerimeterxCustomParamsProvider();
...
    .customParametersProvider(PerimeterxCustomParamsProvider)
...

Custom Sensitive Request

Example

PXConfiguration pxConfiguration = new PXConfiguration.Builder()
        ...
        .customIsSensitiveRequest((req) -> req.getHeader("example-header") == "example-value")
        .build();

Proxy Integration

Providing a proxy allows the communication between the Enforcer and our backend service via
proxy. You can set the proxy as a hostname (with a domain name), or as an ip port combination.
If you choose to use the proxy's domain, do not enter a port in the configuration.
Make sure you have the proxy's certificate installed on the machine that is running the Enforcer.

PXConfiguration config = new PXConfiguration.Builder()
        .appId("PXaBcDeFgH")
        .cookieKey("COOKIE_KEY")
        .authToken("AUTH_TOKEN")
        .useProxy(true)
        .proxyHost(127.0.0.1)
        .proxyPort(80)
        .build();
        
PXConfiguration config = new PXConfiguration.Builder()
        .appId("PXaBcDeFgH")
        .cookieKey("COOKIE_KEY")
        .authToken("AUTH_TOKEN")
        .useProxy(true)
        .proxyHost(yourdomain.com)
        .build();