com.mozilla.secops.authprofile

Class AuthProfile

java.lang.Object

com.mozilla.secops.authprofile.AuthProfile

All Implemented Interfaces:

Serializable

public class AuthProfile
extends Object
implements Serializable

AuthProfile implements analysis of normalized authentication events

This pipeline can make use of various methods for persistent state storage.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AuthProfile.AuthProfileOptions Runtime options for AuthProfile pipeline.
static class	AuthProfile.ExtractIdentity Extract subject user for each event in input PCollection
static class	AuthProfile.Parse Parse input strings returning applicable authentication events.
static class	AuthProfile.StateAnalyze Analyze grouped events associated with a particular user or identity against persistent user state

Constructor Summary

Constructors

Constructor and Description
AuthProfile()

Method Summary

Modifier and Type	Method and Description
static String	buildConfigurationTick(AuthProfile.AuthProfileOptions options) Build a configuration tick for Authprofile given pipeline options
static Alert	createBaseAlert(Event e, String contactEmail, String docLink) Create a base authprofile Alert using information from the event
static IdentityManager	getIdentityManager(String path) Load a process shared version of the identity manager
static void	insightsEnrichAlert(Alert a, Event e) Add minfraud insights data into alert metadata
static void	main(String[] args) Entry point for Beam pipeline.
static org.apache.beam.sdk.values.PCollection<Alert>	processInput(org.apache.beam.sdk.values.PCollection<String> input, AuthProfile.AuthProfileOptions options) Process input collection

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthProfile

public AuthProfile()

Method Detail

getIdentityManager

public static IdentityManager getIdentityManager(String path)
                                          throws IOException

Load a process shared version of the identity manager

Requests the current identity manager for use. In an attempt to be as consistent as possible across worker threads, the identity manager is shared. If the identity manager is more than 5 minutes old, a new version is requested from storage.

This function will pick up a mutex on entry which is released on return.

Parameters:

path - Identity manager path

Returns:

IdentityManager

Throws:

IOException - IOException

createBaseAlert

public static Alert createBaseAlert(Event e,
                                    String contactEmail,
                                    String docLink)

Create a base authprofile Alert using information from the event

Parameters:

e - Event

contactEmail - General contact email address to set in alert metadata

docLink - URL to documentation link to set in alert metadata

Returns:

Base alert object

insightsEnrichAlert

public static void insightsEnrichAlert(Alert a,
                                       Event e)

Add minfraud insights data into alert metadata

Parameters:

e - Event

a - Alert

buildConfigurationTick

public static String buildConfigurationTick(AuthProfile.AuthProfileOptions options)
                                     throws IOException

Build a configuration tick for Authprofile given pipeline options

Parameters:

options - Pipeline options

Returns:

String

Throws:

IOException - IOException

processInput

public static org.apache.beam.sdk.values.PCollection<Alert> processInput(org.apache.beam.sdk.values.PCollection<String> input,
                                                                         AuthProfile.AuthProfileOptions options)

Process input collection

Process collection of input events, returning a collection of alerts as required.

Parameters:

input - Input collection

options - Pipeline options

Returns:

Output collection

main

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

Entry point for Beam pipeline.

Parameters:

args - Runtime arguments.

Throws:

Exception - Exception