Package sonia.scm.security

Class DefaultCipherHandler

java.lang.Object

sonia.scm.security.DefaultCipherHandler

All Implemented Interfaces:

CipherHandler

public class DefaultCipherHandler
extends Object
implements CipherHandler

Default implementation of the CipherHandler, which uses AES for encryption and decryption.

Since:

1.7

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CIPHER_TYPE	used cipher type for format v2
static final String	DIGEST_TYPE
static final Charset	ENCODING
static final int	KEY_LENGTH
static final String	OLD_CIPHER_TYPE	Cipher type used before v2.
static final String	PREFIX_FORMAT_V2	prefix to detect new format
static final int	SALT_LENGTH

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DefaultCipherHandler(String key)	Constructs a new DefaultCipherHandler.
	DefaultCipherHandler(SCMContextProvider context, KeyGenerator keyGenerator)	Constructs a new instance and reads the default key from the scm home directory, if the key file does not exists it will be generated with the KeyGenerator.

Method Summary

Modifier and Type	Method	Description
String	decode(char[] plainKey, String value)	Decodes the given value with the provided key.
String	decode(String value)	Decrypts the given value.
String	encode(char[] plainKey, String value)	Encrypts the given value with the provided key.
String	encode(String value)	Encrypts the given value.

Methods inherited from class java.lang.Object

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

Methods inherited from interface sonia.scm.security.CipherHandler

decode, encode

Field Details

OLD_CIPHER_TYPE

public static final String OLD_CIPHER_TYPE

Cipher type used before v2.

See Also:

• Issue 1110
• Constant Field Values

CIPHER_TYPE

public static final String CIPHER_TYPE

used cipher type for format v2

See Also:

• Constant Field Values

PREFIX_FORMAT_V2

public static final String PREFIX_FORMAT_V2

prefix to detect new format

See Also:

• Constant Field Values

DIGEST_TYPE

public static final String DIGEST_TYPE

See Also:

• Constant Field Values

ENCODING

public static final Charset ENCODING

KEY_LENGTH

public static final int KEY_LENGTH

See Also:

• Constant Field Values

SALT_LENGTH

public static final int SALT_LENGTH

See Also:

• Constant Field Values

Constructor Details

DefaultCipherHandler

protected DefaultCipherHandler(String key)

Constructs a new DefaultCipherHandler. Note this constructor is only for unit tests.

Parameters:

key - default encryption key

Since:

1.38

DefaultCipherHandler

public DefaultCipherHandler(SCMContextProvider context,
 KeyGenerator keyGenerator)

Constructs a new instance and reads the default key from the scm home directory, if the key file does not exists it will be generated with the KeyGenerator.

Parameters:

context - SCM-Manager context provider

keyGenerator - key generator for default key generation

Method Details

decode

public String decode(String value)

Description copied from interface: CipherHandler

Decrypts the given value.

Specified by:

decode in interface CipherHandler

decode

public String decode(char[] plainKey,
 String value)

Decodes the given value with the provided key.

Parameters:

plainKey - key which is used for decoding

value - encrypted value

encode

public String encode(String value)

Description copied from interface: CipherHandler

Encrypts the given value.

Specified by:

encode in interface CipherHandler

encode

public String encode(char[] plainKey,
 String value)

Encrypts the given value with the provided key.

Parameters:

plainKey - key which is used for encoding

value - plain text value to encrypt