Package com.adaptris.security.password

Class Password

java.lang.Object

com.adaptris.security.password.Password

public abstract class Password
extends Object

Handles simple encryption and decryption of passwords that may be stored in XML configuration.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MSCAPI_STYLE	Password obfuscation using Microsoft Crypto API which is only available on windows.
static final String	PORTABLE_PASSWORD	Standard password style which is portable across environments.
static final String	PORTABLE_PASSWORD_2	Standard password style which is portable across environments.
static final String	SEEDED_BATCH	Alternative password style which is portable across environments and machines if the seed file is present.

Constructor Summary

Constructors

Constructor	Description
Password()

Method Summary

Modifier and Type	Method	Description
static PasswordCodec	create(String type)	Create a password implementation of the specified type.
protected abstract PasswordCodec	createCodec(String type)
static String	decode(String encoded)	Convenience method to decrypt a password.
static String	encode(String plain, String type)	Convenience method to encode a password.
static void	main(String[] argv)

Methods inherited from class java.lang.Object

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

Field Details

MSCAPI_STYLE

public static final String MSCAPI_STYLE

Password obfuscation using Microsoft Crypto API which is only available on windows.

Use of this means that the password is encrypted with the current username's private key and certificate.

See Also:

• Constant Field Values

PORTABLE_PASSWORD

public static final String PORTABLE_PASSWORD

Standard password style which is portable across environments.

It is not considered especially secure, but is enough to stop casual interrogation

See Also:

• Constant Field Values

PORTABLE_PASSWORD_2

public static final String PORTABLE_PASSWORD_2

Standard password style which is portable across environments.

It uses the Advanced Encryption Standard (AES) algorithm in Galois/Counter Mode (GCM) to perform the encryption. GCM has the benefit of providing authenticity (integrity) in addition to confidentiality.

See Also:

• Constant Field Values

SEEDED_BATCH

public static final String SEEDED_BATCH

Alternative password style which is portable across environments and machines if the seed file is present. Uses a similar password based encryption scheme to the deprecated/removed non-portable PBEWithSHA1AndDESede. This uses the more up-to-date and secure PBEWithHmacSHA256AndAES_128.

See Also:

• Constant Field Values

Constructor Details

Password

public Password()

Method Details

create

public static PasswordCodec create(String type)
                            throws PasswordException

Create a password implementation of the specified type.

Parameters:

type - the type

Returns:

the password implementation

Throws:

PasswordException - wrapping other exceptions.

See Also:

• MSCAPI_STYLE
• SEEDED_BATCH
• PORTABLE_PASSWORD

createCodec

protected abstract PasswordCodec createCodec(String type)
                                      throws PasswordException

Throws:

PasswordException

decode

public static String decode(String encoded)
                     throws PasswordException

Convenience method to decrypt a password.

Parameters:

encoded - the encrypted password

Returns:

the decrypted password

Throws:

PasswordException

encode

public static String encode(String plain,
 String type)
                     throws PasswordException

Convenience method to encode a password.

Parameters:

plain - the plain password

type - the type of encryption to use.

Returns:

the encoded password

Throws:

PasswordException

See Also:

• MSCAPI_STYLE
• SEEDED_BATCH
• PORTABLE_PASSWORD

main

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

Throws:

Exception