org.daveware.passwordmaker

Class Account

java.lang.Object

org.daveware.passwordmaker.Account

All Implemented Interfaces:

Comparable<Account>

public final class Account
extends Object
implements Comparable<Account>

Represents an account. This object also functions as a parent account for which it can have any number of child accounts.

Author:

Dave Marotti

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Account.UrlComponents

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_ACCOUNT_NAME
static String	DEFAULT_ACCOUNT_URI
static int	DEFAULT_LENGTH
static String	DEFAULT_USERNAME
static String	ROOT_ACCOUNT_URI

Constructor Summary

Constructors

Constructor and Description
Account()
Account(Account toClone)
Account(String name, boolean isFolder)
Account(String name, String url, String username)
Account(String name, String desc, String url, String username, AlgorithmType algorithm, boolean hmac, boolean trim, int length, String characterSet, LeetType leetType, LeetLevel leetLevel, String modifier, String prefix, String suffix, boolean sha256Bug) Constructor which allows all members to be defined except for the ID which will be constructed from a SHA-1 hash of the URL + username.
Account(String name, String desc, String url, String username, AlgorithmType algorithm, boolean hmac, boolean trim, int length, String characterSet, LeetType leetType, LeetLevel leetLevel, String modifier, String prefix, String suffix, boolean sha256Bug, String id) See the other constructor

Method Summary

Modifier and Type	Method and Description
void	addUrlComponent(Account.UrlComponents urlComponent)
void	clearUrlComponents() Clears the UrlComponents used with this account
int	compareTo(Account o) Implements the Comparable<Account> interface, this is based first on if the account is a folder or not.
void	copySettings(Account a) Copies the settings (not including children or ID) from another account.
static String	createId() Creates an random ID from a string.
static String	createId(Account acc) Creates and _returns_ an ID from data in an account.
static String	createId(String str) Creates an ID from a string.
boolean	equals(Object o) Determines if these are the same object or not.
AlgorithmType	getAlgorithm()
String	getCharacterSet()
Account	getChild(int index) Gets a specifically indexed child.
ArrayList<Account>	getChildren() Gets a list of the child accounts.
String	getDesc()
String	getId()
LeetLevel	getLeetLevel()
LeetType	getLeetType()
int	getLength()
String	getModifier()
String	getName()
int	getNestedChildCount() Gets the count of all children (of children of children...).
ArrayList<AccountPatternData>	getPatterns()
String	getPrefix()
String	getSuffix()
String	getUrl()
Set<Account.UrlComponents>	getUrlComponents() If the urlComponents field is empty then the entire getUrl field will be used.
String	getUsername()
boolean	hasChild(Account account) Tests if an account is a direct child of this account.
boolean	hasChildren()
int	hashCode()
boolean	isAutoPop()
boolean	isDefault() Determines if this is the default account.
boolean	isFolder()
boolean	isHmac()
boolean	isRoot() Determines if this is the root account.
boolean	isSha256Bug()
boolean	isTrim()
static Account	makeDefaultAccount()
void	removeUrlComponent(Account.UrlComponents urlComponent)
void	setAlgorithm(AlgorithmType algorithm)
void	setAutoPop(boolean b)
void	setCharacterSet(String characterSet)
void	setDesc(String s)
void	setHmac(boolean hmac)
void	setId(String id)
void	setIsFolder(boolean b)
void	setLeetLevel(LeetLevel leetLevel)
void	setLeetType(LeetType leetType)
void	setLength(int length)
void	setModifier(String modifier)
void	setName(String s)
void	setPatterns(Iterable<AccountPatternData> patterns) This will make a deep clone of the passed in Iterable.
void	setPrefix(String prefix)
void	setSha256Bug(boolean sha256Bug)
void	setSuffix(String suffix)
void	setTrim(boolean trim)
void	setUrl(String url)
void	setUrlComponents(Set<Account.UrlComponents> urlComponents)
void	setUsername(String username)
String	toDebugString()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

DEFAULT_ACCOUNT_NAME

public static final String DEFAULT_ACCOUNT_NAME

See Also:

Constant Field Values

DEFAULT_USERNAME

public static final String DEFAULT_USERNAME

See Also:

Constant Field Values

ROOT_ACCOUNT_URI

public static final String ROOT_ACCOUNT_URI

See Also:

Constant Field Values

DEFAULT_ACCOUNT_URI

public static final String DEFAULT_ACCOUNT_URI

See Also:

Constant Field Values

DEFAULT_LENGTH

public static final int DEFAULT_LENGTH

See Also:

Constant Field Values

Constructor Detail

Account

public Account()

Account

public Account(String name,
               boolean isFolder)

Account

public Account(String name,
               String url,
               String username)

Account

public Account(Account toClone)

Account

public Account(String name,
               String desc,
               String url,
               String username,
               AlgorithmType algorithm,
               boolean hmac,
               boolean trim,
               int length,
               String characterSet,
               LeetType leetType,
               LeetLevel leetLevel,
               String modifier,
               String prefix,
               String suffix,
               boolean sha256Bug)
        throws Exception

Constructor which allows all members to be defined except for the ID which will be constructed from a SHA-1 hash of the URL + username. This does not include autopop.

Parameters:

name - - name for the account

desc - - description for the account

url - - the url of the account

username - - the username for the account

algorithm - - the algorithm to use against the master password

hmac - - should you use the hmac version

trim - - the trim the input text

length - - the length of the generated password for account

characterSet - - the characterSet to use for generated password

leetType - - leet-ify the generated password

leetLevel - - How much leet to use

modifier - - this field is to allow for adjustment of the outputted password

prefix - - the prefix to put in front of every generated password

suffix - - the suffix to add behind every generated password

sha256Bug - - has the buggy firefox javascript sha256

Throws:

Exception - on exception.

Account

public Account(String name,
               String desc,
               String url,
               String username,
               AlgorithmType algorithm,
               boolean hmac,
               boolean trim,
               int length,
               String characterSet,
               LeetType leetType,
               LeetLevel leetLevel,
               String modifier,
               String prefix,
               String suffix,
               boolean sha256Bug,
               String id)

See the other constructor

Parameters:

name - - name for the account

desc - - description for the account

url - - the url of the account

username - - the username for the account

algorithm - - the algorithm to use against the master password

hmac - - should you use the hmac version

trim - - the trim the input text

length - - the length of the generated password for account

characterSet - - the characterSet to use for generated password

leetType - - leet-ify the generated password

leetLevel - - How much leet to use

modifier - - this field is to allow for adjustment of the outputted password

prefix - - the prefix to put in front of every generated password

suffix - - the suffix to add behind every generated password

sha256Bug - - has the buggy firefox javascript sha256

id - - the id for the account (required to be already generated)

See Also:

Account(String, String, String, String, AlgorithmType, boolean, boolean, int, String, LeetType, LeetLevel, String, String, String, boolean)

Method Detail

makeDefaultAccount

public static Account makeDefaultAccount()

createId

public static String createId()

Creates an random ID from a string.

This is used to create the ID of the account which should be unique. There's no way for this object to know if it is truly unique so the database or GUI should do a check for uniqueness and re-hash if needed.

Returns:

A hex string representing 20 random bytes.

createId

public static String createId(String str)
                       throws Exception

Creates an ID from a string.

This is used to create the ID of the account which should be unique. There's no way for this object to know if it is truly unique so the database or GUI should do a check for uniqueness and re-hash if needed.

Parameters:

str - The string to hash.

Returns:

A hashed (SHA1) version of the string.

Throws:

Exception - Upon hashing error.

createId

public static String createId(Account acc)
                       throws Exception

Creates and _returns_ an ID from data in an account.

Parameters:

acc - The account to base the data off.

Returns:

The new ID.

Throws:

Exception - on error.

copySettings

public void copySettings(Account a)

Copies the settings (not including children or ID) from another account.

LEAVE THIS FUNCTION HERE so it's easy to see if new members are ever added so I don't forget to update it.

Parameters:

a - The other account to copy from.

getName

public String getName()

setName

public void setName(String s)

getDesc

public String getDesc()

setDesc

public void setDesc(String s)

isFolder

public boolean isFolder()

isAutoPop

public boolean isAutoPop()

Returns:

if the firefox version auto populates the username and password fields of the page if the url is matching

setAutoPop

public void setAutoPop(boolean b)

isDefault

public boolean isDefault()

Determines if this is the default account. The default account has a special ID.

Returns:

true if it is.

isRoot

public boolean isRoot()

Determines if this is the root account. The root account has a special ID.

Returns:

true if it is.

setIsFolder

public void setIsFolder(boolean b)

getAlgorithm

public AlgorithmType getAlgorithm()

Returns:

the algorithm

setAlgorithm

public void setAlgorithm(AlgorithmType algorithm)

Parameters:

algorithm - the algorithm to set

isHmac

public boolean isHmac()

Returns:

the hmac

setHmac

public void setHmac(boolean hmac)

Parameters:

hmac - the hmac to set

isTrim

public boolean isTrim()

Returns:

the trim

setTrim

public void setTrim(boolean trim)

Parameters:

trim - the trim to set

getUrl

public String getUrl()

Returns:

the url

setUrl

public void setUrl(String url)

Parameters:

url - the url to set

getLength

public int getLength()

Returns:

the length

setLength

public void setLength(int length)

Parameters:

length - the length to set

getCharacterSet

public String getCharacterSet()

Returns:

the characterSet

setCharacterSet

public void setCharacterSet(String characterSet)

Parameters:

characterSet - the characterSet to set

getLeetType

public LeetType getLeetType()

Returns:

the leetType

setLeetType

public void setLeetType(LeetType leetType)

Parameters:

leetType - the leetType to set

getLeetLevel

public LeetLevel getLeetLevel()

Returns:

the leetLevel

setLeetLevel

public void setLeetLevel(LeetLevel leetLevel)

Parameters:

leetLevel - the leetLevel to set

getUsername

public String getUsername()

Returns:

the username

setUsername

public void setUsername(String username)

Parameters:

username - the username to set

getModifier

public String getModifier()

Returns:

the modifier

setModifier

public void setModifier(String modifier)

Parameters:

modifier - the modifier to set

getPrefix

public String getPrefix()

Returns:

the prefix

setPrefix

public void setPrefix(String prefix)

Parameters:

prefix - the prefix to set

getSuffix

public String getSuffix()

Returns:

the suffix

setSuffix

public void setSuffix(String suffix)

Parameters:

suffix - the suffix to set

isSha256Bug

public boolean isSha256Bug()

Returns:

the sha256Bug

setSha256Bug

public void setSha256Bug(boolean sha256Bug)

Parameters:

sha256Bug - the sha256Bug to set

getId

public String getId()

Returns:

the id

setId

public void setId(String id)

Parameters:

id - the id to set

clearUrlComponents

public final void clearUrlComponents()

Clears the UrlComponents used with this account

addUrlComponent

public final void addUrlComponent(Account.UrlComponents urlComponent)

Parameters:

urlComponent - - Add a component of the url to be used as the input text for the generated password

removeUrlComponent

public final void removeUrlComponent(Account.UrlComponents urlComponent)

Parameters:

urlComponent - - Add a component of the url to be used as the input text for the generated password

getUrlComponents

public final Set<Account.UrlComponents> getUrlComponents()

If the urlComponents field is empty then the entire getUrl field will be used. This set is unmodifiable. Use the helper functions to set or modify the set.

Returns:

the url components specified for this account (may be empty)

setUrlComponents

public final void setUrlComponents(Set<Account.UrlComponents> urlComponents)

Parameters:

urlComponents - - the Components to use of the url as the input text for the generated password

getChildren

public ArrayList<Account> getChildren()

Gets a list of the child accounts. This list is modifiable.

Returns:

The list of accounts (may be empty).

getNestedChildCount

public int getNestedChildCount()

Gets the count of all children (of children of children...).

Returns:

The total number of all descendants.

getChild

public Account getChild(int index)
                 throws IndexOutOfBoundsException

Gets a specifically indexed child.

Parameters:

index - The index of the child to get.

Returns:

The child at the index.

Throws:

IndexOutOfBoundsException - upon invalid index.

hasChildren

public boolean hasChildren()

hasChild

public boolean hasChild(Account account)

Tests if an account is a direct child of this account.

Parameters:

account - check if the passed in account is a child of 'this' account

Returns:

true if given account is a child of 'this' account

compareTo

public int compareTo(Account o)

Implements the Comparable<Account> interface, this is based first on if the account is a folder or not. This is so that during sorting, all folders are first in the list. Finally, it is based on the name.

Specified by:

compareTo in interface Comparable<Account>

Parameters:

o - The other account to compare to.

Returns:

this.name.compareTo(otherAccount.name);

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object o)

Determines if these are the same object or not. "Same objects" are those that have identical IDs.

Overrides:

equals in class Object

getPatterns

public ArrayList<AccountPatternData> getPatterns()

Returns:

the patterns

setPatterns

public void setPatterns(Iterable<AccountPatternData> patterns)

This will make a deep clone of the passed in Iterable. This will also replace any patterns already set.

Parameters:

patterns - the patterns to set

toString

public String toString()

Overrides:

toString in class Object

toDebugString

public String toDebugString()