Plug-in nevisAdapt
The nevisAdapt plug-in delivers three different kinds of risk scores:
- The NevisAdaptDeviceFingerprintrisk score is based on a so-called device fingerprint. This device fingerprint is computed by a JavaScript library on the user's device.
- The NevisAdaptGeolocationrisk score is based on the geolocation of the user. To calculate this risk score, the plug-in uses the user's IP address.
- The NevisAdaptDeviceRecognitionrisk score is based on a persistent cookie.
For more information about the nevisAdapt service, see the nevisAdapt Technical Documentation.
The next table describes the configuration attributes of the nevisAdapt plug-in.
| Name | Type/unit | Example | Description |
|---|---|---|---|
| name | string | NevisAdapt | Specifies the name of the plug-in. |
| url | URL | https://localhost:8888 | Defines the URL of the service. |
| colorCodes | list of string tuples | colorCodes=NevisAdaptDeviceFingerprint:#0B6623,NevisAdaptGeolocation:#3BB143,NevisAdaptDeviceRecognition:#C7EA46 | Defines the HTML color codes of plug-in's risk scores. The risk scores will be shown in these colors in the nevisDetect web application. |
| riskScores | list of strings | riskScores=NevisAdaptDeviceFingerprint,NevisAdaptGeolocation,NevisAdaptDeviceRecognition | Specifies a list of the risk scores delivered by the plug-in. |
| nevisadapt.cookie.name | string | device_cookie | Name of the device recognition cookie. This is the name set by nevisAuth in the AuthState DeviceCookieAuthState, attribute cookieName. See also DeviceCookieAuthState]". |
| nevisadapt.fingerprint.hash.backend | boolean | false | If set to "true", the fingerprint hash for the nevisAdapt plug-in is calculated on the backend. Note that this feature is not supported for FingerprintJS 3. If set to "false", the system uses the fingerprint hash generated by the FingerprintJS library. |
| nevisadapt.fingerprint.components | list of strings | addBehavior,platform,webgl | Defines a comma-separated list of components that are included in the fingerprint hash calculation, in case the fingerprint hash is calculated on the backend side. For a complete list of available components, see the chapter Fingerprint module in the nevisAdapt reference guide. Only FingerprintJS 2 keys are supported. |
| nevisadapt.cache.disabled | boolean | false | Enables or disables caching in the nevisAdapt plug-in. Caching is enabled by default. Set this attribute to "true" to disable caching. |
| nevisadapt.cache.eviction.max.size | number | 50000 | Maximum number of cached results and sessions. We recommend that you set this number slightly above the number of maximum parallel sessions in the system. |
| nevisadapt.cache.eviction.expiry.minutes | number | 180 | Maximum lifetime of the cached results. We recommend that you set this lifetime slightly above the maximum session lifetime in the system. |
| nevisadapt.httprequest.ignore | boolean | false | Specifies whether HTTP requests must be ignored. In this case, the plug-in will only process requests coming from nevisAuth. The default is "false". Set this attribute to "true" to ignore HTTP requests. If you turn off the caching we advise also turning off this feature, to not overload the service. |
| nevisadapt.httprequest.ignore.method | string | GET | Use this attribute to ignore requests with a specific HTTP method.For example, if you set this attribute to "GET", the nevisAdapt plug-in will ignore all requests with HTTP method GET. |
| nevisadapt.httprequest.ignore.without | string | bdata | Makes the nevisAdapt plug-in ignore all requests without the data specified in the attribute. |
| nevisadapt.httprequest.mimetypes | string (comma-separated) | application/behaviosec | Adds custom-supported MIME types. You can set more than one MIME type. Separate the types with a comma. |
| http.client.connectTimeout | int/msec | 500 | The timeout (in milliseconds) for establishing a TCP connection. |
| http.client.retryTimeout | int/msec | 5000 | The retry timeout (in milliseconds) in case of a connection error or an HTTP error code. |
| http.client.keyStore | file | file:/var/opt/neviskeybox/default/rdf/nevisAdapt truststore.jks | The Java keystore file used to establish the TLS connection. |
| http.client.keyStorePassword | string | file:/var/opt/neviskeybox/default/nevisdetect/nevisAdapt_keystore.jks | The passphrase for the keystore. |
| http.client.trustStore | file | The Java truststore file used to establish the TLS connection. | |
| http.client.trustStorePassword | string | The passphrase for the truststore. |