ai.nightfall.scan.model

Class ScanPolicy

java.lang.Object

ai.nightfall.scan.model.ScanPolicy

public class ScanPolicy
extends Object

An object containing configuration that describes how to scan a file. Since the file is scanned asynchronously, the results from the scan are delivered to the provided webhook URL. The scan configuration may contain both inline detection rule definitions and UUID's referring to existing detection rules (up to 10 of each).

Constructor Summary

Constructors

Constructor and Description
ScanPolicy(AlertConfig alertConfig, List<DetectionRule> detectionRules, List<UUID> detectionRuleUUIDs) Create a scan policy with the provided detection rules and detection rule UUIDs.
ScanPolicy(String webhookURL, List<DetectionRule> detectionRules, List<UUID> detectionRuleUUIDs) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ScanPolicy	fromDetectionRules(List<DetectionRule> detectionRules, String webhookURL) Create a scan policy with the provided detection rules.
static ScanPolicy	fromDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs, String webhookURL) Create a scan policy with the provided detection rules.
AlertConfig	getAlertConfig() Get the alert configuration that specifies where alerts should be delivered when findings are detected.
List<DetectionRule>	getDetectionRules() Get the list of detection rules.
List<UUID>	getDetectionRuleUUIDs() Get the detection rule UUIDs.
String	getWebhookURL() Deprecated.
void	setAlertConfig(AlertConfig alertConfig) Sets the alert configuration that specifies where alerts should be delivered when findings are detected.
void	setDetectionRules(List<DetectionRule> detectionRules) Set the detection rules.
void	setDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs) Set the detection rule UUIDs.
void	setWebhookURL(String webhookURL) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ScanPolicy

@Deprecated
public ScanPolicy(String webhookURL,
                              List<DetectionRule> detectionRules,
                              List<UUID> detectionRuleUUIDs)

Deprecated.

Create a scan policy with the provided detection rules and detection rule UUIDs.

Parameters:

webhookURL - the URL that Nightfall will use to deliver a webhook containing scan results

detectionRules - a list of detection rules to use to scan content. maximum length 10.

detectionRuleUUIDs - a list of detection rule UUIDs to use to scan content. maximum length 10.

ScanPolicy

public ScanPolicy(AlertConfig alertConfig,
                  List<DetectionRule> detectionRules,
                  List<UUID> detectionRuleUUIDs)

Create a scan policy with the provided detection rules and detection rule UUIDs.

Parameters:

alertConfig - the alert configuration that Nightfall will use to deliver findings to external sources.

detectionRules - a list of detection rules to use to scan content. maximum length 10.

detectionRuleUUIDs - a list of detection rule UUIDs to use to scan content. maximum length 10.

Method Detail

fromDetectionRules

public static ScanPolicy fromDetectionRules(List<DetectionRule> detectionRules,
                                            String webhookURL)

Create a scan policy with the provided detection rules.

Parameters:

detectionRules - a list of detection rules to use to scan content. maximum length 10.

webhookURL - the URL that Nightfall will use to deliver a webhook containing scan results

Returns:

the scan policy

fromDetectionRuleUUIDs

public static ScanPolicy fromDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs,
                                                String webhookURL)

Create a scan policy with the provided detection rules.

Parameters:

detectionRuleUUIDs - a list of detection rule UUIDs to use to scan content. maximum length 10.

webhookURL - the URL that Nightfall will use to deliver a webhook containing scan results

Returns:

the scan policy

getWebhookURL

@Deprecated
public String getWebhookURL()

Deprecated.

Get the webhook URL. Deprecated: use the alertConfig object instead.

Returns:

the webhook URL that Nightfall should deliver results to

setWebhookURL

@Deprecated
public void setWebhookURL(String webhookURL)

Deprecated.

Set the webhook URL.

Parameters:

webhookURL - the webhook URL that Nightfall should deliver results to

getDetectionRules

public List<DetectionRule> getDetectionRules()

Get the list of detection rules.

Returns:

the list of detection rules to use to scan the files

setDetectionRules

public void setDetectionRules(List<DetectionRule> detectionRules)

Set the detection rules.

Parameters:

detectionRules - a list of detection rules to scan against

getDetectionRuleUUIDs

public List<UUID> getDetectionRuleUUIDs()

Get the detection rule UUIDs.

Returns:

the list of detection rule UUIDs to scan against

setDetectionRuleUUIDs

public void setDetectionRuleUUIDs(List<UUID> detectionRuleUUIDs)

Set the detection rule UUIDs.

Parameters:

detectionRuleUUIDs - the list of detection rule UUIDs to scan against

getAlertConfig

public AlertConfig getAlertConfig()

Get the alert configuration that specifies where alerts should be delivered when findings are detected.

Returns:

the alert configuration

setAlertConfig

public void setAlertConfig(AlertConfig alertConfig)

Sets the alert configuration that specifies where alerts should be delivered when findings are detected.

Parameters:

alertConfig - the alert configuration