com.mozilla.secops.customs

Class PrivateRelayForward

java.lang.Object

org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<Event>,org.apache.beam.sdk.values.PCollection<Alert>>

com.mozilla.secops.customs.PrivateRelayForward

All Implemented Interfaces:

Serializable, org.apache.beam.sdk.transforms.display.HasDisplayData

public class PrivateRelayForward
extends org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<Event>,org.apache.beam.sdk.values.PCollection<Alert>>

Private relay forwarding analysis

This transform will analyze private relay forward notifications in addition to FxA RP callbacks indicating a change of the account email address. This information is used to populate a state cache that maps the UID to a hashed version of the forwarding address.

If a forwarding event is observed that shows a hashed real address that differs from the one the system knows about for a given UID, an alert will be generated.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PrivateRelayForward.PrivateRelayForwardState PrivateRelayForwardState describes the format of individual state entries

Field Summary

Fields

Modifier and Type	Field and Description
static String	DATASTORE_KIND Datastore kind for state
static String	DATASTORE_NAMESPACE Datastore namespace for state
static String	EXPERIMENTAL_TAG

Constructor Summary

Constructors

Constructor and Description
PrivateRelayForward(Customs.CustomsOptions options) Initialize new PrivateRelayForward

Method Summary

Modifier and Type	Method and Description
org.apache.beam.sdk.values.PCollection<Alert>	expand(org.apache.beam.sdk.values.PCollection<Event> col)
default String	getTransformDoc() Get documentation string from transform based on it's current configuration
String	getTransformDocDescription() Get documentation description from transform based on it's current configuration
boolean	isExperimental() Get whether the transform is experimental and won't be escalated

Methods inherited from class org.apache.beam.sdk.transforms.PTransform

compose, compose, getAdditionalInputs, getDefaultOutputCoder, getName, getResourceHints, populateDisplayData, setResourceHints, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

DATASTORE_NAMESPACE

public static final String DATASTORE_NAMESPACE

Datastore namespace for state

See Also:

Constant Field Values

DATASTORE_KIND

public static final String DATASTORE_KIND

Datastore kind for state

See Also:

Constant Field Values

EXPERIMENTAL_TAG

public static final String EXPERIMENTAL_TAG

See Also:

Constant Field Values

Constructor Detail

PrivateRelayForward

public PrivateRelayForward(Customs.CustomsOptions options)

Initialize new PrivateRelayForward

Parameters:

options - Pipeline options

Method Detail

getTransformDocDescription

public String getTransformDocDescription()

Get documentation description from transform based on it's current configuration

Returns:

String

expand

public org.apache.beam.sdk.values.PCollection<Alert> expand(org.apache.beam.sdk.values.PCollection<Event> col)

Specified by:

expand in class org.apache.beam.sdk.transforms.PTransform<org.apache.beam.sdk.values.PCollection<Event>,org.apache.beam.sdk.values.PCollection<Alert>>

isExperimental

public boolean isExperimental()

Get whether the transform is experimental and won't be escalated

Returns:

String

getTransformDoc

public String getTransformDoc()

Description copied from interface: DocumentingTransform

Get documentation string from transform based on it's current configuration

Specified by:

getTransformDoc in interface DocumentingTransform

Returns:

String