com.mozilla.secops.authstate

Class AuthStateModel

java.lang.Object

com.mozilla.secops.authstate.AuthStateModel

public class AuthStateModel
extends Object

Manages and stores authentication state information for a given user identity.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AuthStateModel.GeoVelocityResponse Response to AuthStateModel GeoVelocity analysis request
static class	AuthStateModel.ModelEntry Represents a single known source for authentication for a given user
static class	AuthStateModel.ModelEntryUpdate Information used in a model update request

Constructor Summary

Constructors

Constructor and Description
AuthStateModel(String subject) Create new state model for user

Method Summary

Modifier and Type	Method and Description
AuthStateModel.GeoVelocityResponse	geoVelocityAnalyzeLatest(Double maxKmPerSecond) Perform geo-velocity analysis using the latest entries in the model
static AuthStateModel	get(String user, StateCursor<AuthStateModel> s, PruningStrategy ps) Retrieve state object for user
Map<String,AuthStateModel.ModelEntry>	getEntries() Get entries associated with model
String	getSubject() Get subject associated with model
void	set(StateCursor<AuthStateModel> s, PruningStrategy ps) Persist state using state interface
void	setEntries(Map<String,AuthStateModel.ModelEntry> entries) Set entries associated with model
void	setSubject(String subject) Set subject associated with model
ArrayList<AbstractMap.SimpleEntry<String,AuthStateModel.ModelEntry>>	timeSortedEntries() Return all entries in AuthStateModel as an array list, sorted by timestamp
Boolean	updateEntry(AuthStateModel.ModelEntryUpdate request) Update state entry for user to indicate authentication from address setting specified timestamp on the entry
Boolean	updateEntry(String ipaddr, org.joda.time.DateTime timestamp, Double latitude, Double longitude) Update state entry for user to indicate authentication from address setting specified timestamp on the entry
Boolean	updateEntry(String ipaddr, Double latitude, Double longitude) Update state entry for user to indicate authentication from address

Methods inherited from class java.lang.Object

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

Constructor Detail

AuthStateModel

public AuthStateModel(String subject)

Create new state model for user

Parameters:

subject - Subject user name

Method Detail

updateEntry

public Boolean updateEntry(String ipaddr,
                           Double latitude,
                           Double longitude)

Update state entry for user to indicate authentication from address

Note this function does not write the new state, set must be called to make changes permanent.

This variant of the method will use the current time as the timestamp for the authentication event, instead of accepting a parameter indicating the timestamp to associate with the event.

This variant of updateEntry does not support including a user agent with the update, pass ModelEntryUpdate for that.

Parameters:

ipaddr - IP address to update state with

latitude - IP address's latitude

longitude - IP address's longitude

Returns:

True if the IP address was unknown, otherwise false

updateEntry

public Boolean updateEntry(String ipaddr,
                           org.joda.time.DateTime timestamp,
                           Double latitude,
                           Double longitude)

Update state entry for user to indicate authentication from address setting specified timestamp on the entry

Note this function does not write the new state, set must be called to make changes permanent.

This variant of updateEntry does not support including a user agent with the update, pass ModelEntryUpdate for that.

Parameters:

ipaddr - IP address to update state with

timestamp - Timestamp to associate with update

latitude - IP address's latitude

longitude - IP address's longitude

Returns:

True if the IP address was unknown, otherwise false

updateEntry

public Boolean updateEntry(AuthStateModel.ModelEntryUpdate request)

Update state entry for user to indicate authentication from address setting specified timestamp on the entry

Note this function does not write the new state, set must be called to make changes permanent.

Parameters:

request - ModelEntryUpdate

Returns:

True if the IP address was unknown, otherwise false

getEntries

public Map<String,AuthStateModel.ModelEntry> getEntries()

Get entries associated with model

Returns:

Map of model entries

setEntries

public void setEntries(Map<String,AuthStateModel.ModelEntry> entries)

Set entries associated with model

Parameters:

entries - Map

getSubject

public String getSubject()

Get subject associated with model

Returns:

Subject string

setSubject

public void setSubject(String subject)

Set subject associated with model

Parameters:

subject - Subject string

get

public static AuthStateModel get(String user,
                                 StateCursor<AuthStateModel> s,
                                 PruningStrategy ps)
                          throws StateException

Retrieve state object for user

Parameters:

user - Subject name to retrieve state for

s - Initialized state cursor for request

ps - Pruning strategy

Returns:

User AuthStateModel or null if it does not exist

Throws:

StateException - StateException

set

public void set(StateCursor<AuthStateModel> s,
                PruningStrategy ps)
         throws StateException

Persist state using state interface

Calling set will also commit and close the cursor.

Parameters:

s - Initialized state cursor for request

ps - Pruning strategy

Throws:

StateException - StateException

geoVelocityAnalyzeLatest

public AuthStateModel.GeoVelocityResponse geoVelocityAnalyzeLatest(Double maxKmPerSecond)

Perform geo-velocity analysis using the latest entries in the model

The latest entry in the model (e.g., last known authentication event) is compared against the entry that precedes it. If long/lat information is available, this information is used to calculate the distance between the events and the amount of time that passed between the events.

If geo-velocity analysis was possible, a GeoVelocityResponse is returned, null if not.

Parameters:

maxKmPerSecond - The maximum KM per second to use for the analysis

Returns:

GeoVelocityResponse or null

timeSortedEntries

public ArrayList<AbstractMap.SimpleEntry<String,AuthStateModel.ModelEntry>> timeSortedEntries()

Return all entries in AuthStateModel as an array list, sorted by timestamp

Returns:

ArrayList