com.mozilla.secops.customs

Class Customs

java.lang.Object

com.mozilla.secops.customs.Customs

All Implemented Interfaces:

Serializable

public class Customs
extends Object
implements Serializable

Implements various analysis heuristics on FxaAuth streams

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Customs.CustomsOptions Runtime options for Customs pipeline.
static class	Customs.CustomsSummary Summarizes various events processed by Customs pipeline

Field Summary

Fields

Modifier and Type	Field and Description
static String	CATEGORY_ACCOUNT_CREATION_ABUSE
static String	CATEGORY_ACCOUNT_CREATION_ABUSE_DIST
static String	CATEGORY_ACCOUNT_ENUMERATION
static String	CATEGORY_ACTIVITY_MONITOR
static String	CATEGORY_LOGIN_FAILURE_AT_RISK_ACCOUNT
static String	CATEGORY_PASSWORD_RESET_ABUSE
static String	CATEGORY_PRIVATE_RELAY_FORWARD
static String	CATEGORY_SOURCE_LOGIN_FAILURE
static String	CATEGORY_SOURCE_LOGIN_FAILURE_DIST
static String	CATEGORY_STATUS_COMPARATOR
static String	CATEGORY_VELOCITY
static String	CATEGORY_VELOCITY_MONITOR_ONLY

Constructor Summary

Constructors

Constructor and Description
Customs()

Method Summary

Modifier and Type	Method and Description
static String	buildConfigurationTick(Customs.CustomsOptions options) Build a configuration tick for Customs given pipeline options
static org.apache.beam.sdk.values.PCollection<Alert>	executePipeline(org.apache.beam.sdk.Pipeline p, org.apache.beam.sdk.values.PCollection<String> input, Customs.CustomsOptions options) Analysis entry point for Customs pipeline
static ArrayList<FxaAuth.EventSummary>	featureSummaryRegistration() Return an array of EventSummary values that indicate which events should be stored during feature extraction and passed through the prefilter.
static void	main(String[] args) Entry point for Beam pipeline.

Methods inherited from class java.lang.Object

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

Field Detail

CATEGORY_SOURCE_LOGIN_FAILURE

public static final String CATEGORY_SOURCE_LOGIN_FAILURE

See Also:

Constant Field Values

CATEGORY_SOURCE_LOGIN_FAILURE_DIST

public static final String CATEGORY_SOURCE_LOGIN_FAILURE_DIST

See Also:

Constant Field Values

CATEGORY_ACCOUNT_CREATION_ABUSE

public static final String CATEGORY_ACCOUNT_CREATION_ABUSE

See Also:

Constant Field Values

CATEGORY_ACCOUNT_CREATION_ABUSE_DIST

public static final String CATEGORY_ACCOUNT_CREATION_ABUSE_DIST

See Also:

Constant Field Values

CATEGORY_VELOCITY

public static final String CATEGORY_VELOCITY

See Also:

Constant Field Values

CATEGORY_VELOCITY_MONITOR_ONLY

public static final String CATEGORY_VELOCITY_MONITOR_ONLY

See Also:

Constant Field Values

CATEGORY_PASSWORD_RESET_ABUSE

public static final String CATEGORY_PASSWORD_RESET_ABUSE

See Also:

Constant Field Values

CATEGORY_STATUS_COMPARATOR

public static final String CATEGORY_STATUS_COMPARATOR

See Also:

Constant Field Values

CATEGORY_LOGIN_FAILURE_AT_RISK_ACCOUNT

public static final String CATEGORY_LOGIN_FAILURE_AT_RISK_ACCOUNT

See Also:

Constant Field Values

CATEGORY_ACTIVITY_MONITOR

public static final String CATEGORY_ACTIVITY_MONITOR

See Also:

Constant Field Values

CATEGORY_PRIVATE_RELAY_FORWARD

public static final String CATEGORY_PRIVATE_RELAY_FORWARD

See Also:

Constant Field Values

CATEGORY_ACCOUNT_ENUMERATION

public static final String CATEGORY_ACCOUNT_ENUMERATION

See Also:

Constant Field Values

Constructor Detail

Customs

public Customs()

Method Detail

featureSummaryRegistration

public static ArrayList<FxaAuth.EventSummary> featureSummaryRegistration()

Return an array of EventSummary values that indicate which events should be stored during feature extraction and passed through the prefilter.

Any EventSummary values returned here will indicate that an event of that type should be stored during feature extraction. This is required if the underlying analysis transform needs to operate on the events themselves.

If a particular event type is not returned here, it will not be available to any analysis transforms.

Returns:

ArrayList

buildConfigurationTick

public static String buildConfigurationTick(Customs.CustomsOptions options)
                                     throws IOException

Build a configuration tick for Customs given pipeline options

Parameters:

options - Pipeline options

Returns:

String

Throws:

IOException - IOException

executePipeline

public static org.apache.beam.sdk.values.PCollection<Alert> executePipeline(org.apache.beam.sdk.Pipeline p,
                                                                            org.apache.beam.sdk.values.PCollection<String> input,
                                                                            Customs.CustomsOptions options)
                                                                     throws IOException

Analysis entry point for Customs pipeline

Parameters:

p - Pipeline

input - Input data

options - CustomsOptions

Returns:

PCollection containing Alert objects

Throws:

IOException - IOException

main

public static void main(String[] args)
                 throws IOException

Entry point for Beam pipeline.

Parameters:

args - Runtime arguments.

Throws:

IOException - IOException