Package com.storedobject.core

Class Secret

java.lang.Object

com.storedobject.core.StoredObject

com.storedobject.core.Secret

All Implemented Interfaces:

Displayable, StringFiller, HasId

public final class Secret
extends StoredObject

Cipher keys used for encryption/decryption.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Secret.MasterKeyProvider	Definition of the Master Key supplier.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AES
static final String	UNKNOWN_ALG

Fields inherited from class com.storedobject.core.StoredObject

logger

Constructor Summary

Constructors

Constructor	Description
Secret()

Method Summary

Modifier and Type	Method	Description
static void	authenticate(HTTP http, String user, String password)
static Authenticator	authenticator(String user, String password)
static String[]	browseColumns()
static void	columns(Columns columns)
static byte[]	decrypt(byte[] encryptedData, SecretKey key, byte[] iv)
static InputStream	decrypt(InputStream encryptedStream, int keyIndex, SystemUser user)	Decrypt the encrypted stream.
static InputStream	decrypt(InputStream encryptedStream, int keyIndex, TransactionManager tm)	Decrypt the encrypted stream.
static void	decrypt(InputStream encryptedStream, OutputStream clearStream, int keyIndex, SystemUser user)	Decrypt an encrypted stream and write it to an output stream.
static void	decrypt(InputStream encryptedStream, OutputStream clearStream, int keyIndex, TransactionManager tm)	Decrypt an encrypted stream and write it to an output stream.
static String	decrypt(String data, int keyIndex, SystemUser user)	Decrypt data.
static String	decrypt(String data, int keyIndex, TransactionManager tm)	Decrypt data.
static void	encrypt(InputStream clearStream, OutputStream encryptedStream, int keyIndex, SystemUser user)	Encrypt a clear stream and write it to an output stream.
static void	encrypt(InputStream clearStream, OutputStream encryptedStream, int keyIndex, TransactionManager tm)	Encrypt a clear stream and write it to an output stream.
static OutputStream	encrypt(OutputStream clearStream, int keyIndex, SystemUser user)	Encrypt the encrypted stream.
static OutputStream	encrypt(OutputStream clearStream, int keyIndex, TransactionManager tm)	Encrypt the encrypted stream.
static String	encrypt(String data, int keyIndex, SystemUser user)	Encrypt data.
static String	encrypt(String data, int keyIndex, TransactionManager tm)	Encrypt data.
static String	generatePassword(int length)
static SecretKey	generateSecretKey()
String	getComment()
int	getKeyIndex()
int	getKeySerial()
String	getSeed()
String	getSeedChecker()
int	getType()
String	getTypeValue()
static String	getTypeValue(int type)
static String[]	getTypeValues()
String	getUniqueCondition()	Gets the unique index condition of this object.
static int	hints()
static void	indices(Indices indices)
static String[]	links()
static String	log(TransactionManager tm)
static void	migrateMasterKey(TransactionManager tm)	Migrate Master Keys.
static String	obfuscate(String value)
static String[]	protectedColumns()
void	setComment(String comment)
void	setKeyIndex(int keyIndex)
void	setKeySerial(int keySerial)
void	setSeed(String seed)
void	setSeedChecker(String seed)
void	setType(int type)
void	validateData(TransactionManager tm)	The system will invoke this whenever the object is saved to the DB.

Methods inherited from class com.storedobject.core.StoredObject

addLink, addLink, addLink, addLink, addLink, addLink, addLink, addLink, checkCurrency, checkCurrency, checkForDuplicate, checkForDuplicate, checkTimeZone, checkTransaction, clearObjectLinks, contemporary, copy, copy, count, count, count, count, count, count, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countLinks, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, countMasters, create, created, delete, delete, delete, deleted, directUpdate, equals, exists, exists, exists, exists, exists, existsFileData, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLink, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsLinks, existsMaster, existsMaster, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, existsMasters, family, family, family, family, fill, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, get, getActor, getAttachment, getAttachmentId, getChildren, getContemporaryOf, getDeleted, getDeleted, getExistsCondition, getExistsCondition, getFileData, getFileData, getHistorical, getId, getKeyIndex, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getMaster, getNotExistsCondition, getNotExistsCondition, getParent, getParent, getParent, getParentId, getParentId, getParentId, getRelated, getRelated, getTransaction, getTransactionId, getTransactionIP, getUnique, hashCode, inserted, isModified, isVirtual, list, list, list, list, list, list, list, list, list, list, list, list, list, listDeletedIds, listFileData, listFileData, listHistory, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listLinks, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listMasters, listTree, listTree, listTree, listTree, listViaQuery, listViaQuery, load, load, load, load, loadAttributesFrom, loaded, loading, makeNew, makeVirtual, migrate, moduleName, nextVersion, objectLink, objectLink, objectLink, objectLinks, objectLinks, old, person, previousVersion, previousVersion, query, query, query, query, query, query, query, query, query, query, query, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryLinks, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, queryMasters, reload, reload, reloaded, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeAllLinks, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeLink, removeReverseLinks, removeReverseLinks, save, save, save, save, save, save, save, save, save, save, save, save, save, save, save, saved, saving, setMaster, setRawValue, setTransaction, stringify, tableName, timestamp, toCode, toDisplay, toString, transacting, undelete, undelete, undeleted, updated, user, userId, validate, validateChildAttach, validateChildDetach, validateChildUpdate, validateDelete, validateInsert, validateParentAttach, validateParentDetach, validateParentUpdate, validateUndelete, validateUpdate, valueEquals

Methods inherited from class java.lang.Object

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

Field Details

AES

public static final String AES

See Also:

• Constant Field Values

UNKNOWN_ALG

public static final String UNKNOWN_ALG

See Also:

• Constant Field Values

Constructor Details

Secret

public Secret()

Method Details

columns

public static void columns(Columns columns)

browseColumns

public static String[] browseColumns()

protectedColumns

public static String[] protectedColumns()

indices

public static void indices(Indices indices)

getUniqueCondition

public String getUniqueCondition()

Description copied from class: StoredObject

Gets the unique index condition of this object.

Overrides:

getUniqueCondition in class StoredObject

Returns:

Unique index condition.

hints

public static int hints()

links

public static String[] links()

setKeyIndex

public void setKeyIndex(int keyIndex)

getKeyIndex

@SetNotAllowed
@Column(order=100)
public int getKeyIndex()

setSeed

public void setSeed(String seed)

getSeed

@SetNotAllowed
@Column(order=200)
public String getSeed()

setSeedChecker

public void setSeedChecker(String seed)

getSeedChecker

@SetNotAllowed
@Column(order=200)
public String getSeedChecker()

setType

public void setType(int type)

getType

@SetNotAllowed
@Column(order=300)
public int getType()

getTypeValues

public static String[] getTypeValues()

getTypeValue

public static String getTypeValue(int type)

getTypeValue

public String getTypeValue()

setKeySerial

public void setKeySerial(int keySerial)

getKeySerial

@SetNotAllowed
@Column(required=false,
        order=400)
public int getKeySerial()

setComment

public void setComment(String comment)

getComment

@Column(order=500)
public String getComment()

validateData

public void validateData(TransactionManager tm)
                  throws Exception

Description copied from class: StoredObject

The system will invoke this whenever the object is saved to the DB. It will be invoked in all cases while creating new objects and updating/deleting/undeleting existing objects. If any exception is raised by this method, the process of saving to the DB will be abandoned.

Note: This method is mainly used to validate the data of all attributes of the object, and it may be used by others for validating the object. For example, front-end data-entry systems can use this method for validating the object.

Overrides:

validateData in class StoredObject

Parameters:

tm - Current transaction manager.

Throws:

Exception - If data is invalid.

encrypt

public static String encrypt(String data,
 int keyIndex,
 TransactionManager tm)

Encrypt data.

Parameters:

data - Data to encrypt.

keyIndex - Index of the key to be used.

tm - Transaction manager.

Returns:

Encrypted text.

encrypt

public static String encrypt(String data,
 int keyIndex,
 SystemUser user)

Encrypt data.

Parameters:

data - Data to encrypt.

keyIndex - Index of the key to be used.

user - Verified system user

Returns:

Encrypted text.

decrypt

public static String decrypt(String data,
 int keyIndex,
 TransactionManager tm)

Decrypt data.

Parameters:

data - Data to decrypt.

keyIndex - Index of the key to be used.

tm - Transaction manager.

Returns:

Decrypted text.

decrypt

public static String decrypt(String data,
 int keyIndex,
 SystemUser user)

Decrypt data.

Parameters:

data - Data to decrypt.

keyIndex - Index of the key to be used.

user - Verified system user

Returns:

Decrypted text.

decrypt

public static InputStream decrypt(InputStream encryptedStream,
 int keyIndex,
 TransactionManager tm)
                           throws IOException

Decrypt the encrypted stream.

Parameters:

encryptedStream - Stream to decrypt.

keyIndex - Index of the key to be used.

tm - Transaction manager.

Returns:

Decrypted stream.

Throws:

IOException

decrypt

public static InputStream decrypt(InputStream encryptedStream,
 int keyIndex,
 SystemUser user)
                           throws IOException

Decrypt the encrypted stream.

Parameters:

encryptedStream - Stream to decrypt.

keyIndex - Index of the key to be used.

user - Verified system user

Returns:

Decrypted stream.

Throws:

IOException

encrypt

public static OutputStream encrypt(OutputStream clearStream,
 int keyIndex,
 TransactionManager tm)
                            throws IOException

Encrypt the encrypted stream.

Parameters:

clearStream - Stream to encrypt.

keyIndex - Index of the key to be used.

tm - Transaction manager.

Returns:

Encrypted stream.

Throws:

IOException

encrypt

public static OutputStream encrypt(OutputStream clearStream,
 int keyIndex,
 SystemUser user)
                            throws IOException

Encrypt the encrypted stream.

Parameters:

clearStream - Stream to encrypt.

keyIndex - Index of the key to be used.

user - Verified system user

Returns:

Encrypted stream.

Throws:

IOException

encrypt

public static void encrypt(InputStream clearStream,
 OutputStream encryptedStream,
 int keyIndex,
 TransactionManager tm)
                    throws IOException

Encrypt a clear stream and write it to an output stream.

Parameters:

clearStream - Clear stream to read from.

encryptedStream - Encrypted output stream.

keyIndex - Index of the key to be used.

tm - Transaction manager.

Throws:

IOException - If any IO exception occurs.

encrypt

public static void encrypt(InputStream clearStream,
 OutputStream encryptedStream,
 int keyIndex,
 SystemUser user)
                    throws IOException

Encrypt a clear stream and write it to an output stream.

Parameters:

clearStream - Clear stream to read from.

encryptedStream - Encrypted output stream.

keyIndex - Index of the key to be used.

user - Verified system user

Throws:

IOException - If any IO exception occurs.

decrypt

public static void decrypt(InputStream encryptedStream,
 OutputStream clearStream,
 int keyIndex,
 TransactionManager tm)
                    throws IOException

Decrypt an encrypted stream and write it to an output stream.

Parameters:

encryptedStream - Encrypted stream to read from.

clearStream - Clear output stream.

keyIndex - Index of the key to be used.

tm - Transaction manager.

Throws:

IOException - If any IO exception occurs.

decrypt

public static void decrypt(InputStream encryptedStream,
 OutputStream clearStream,
 int keyIndex,
 SystemUser user)
                    throws IOException

Decrypt an encrypted stream and write it to an output stream.

Parameters:

encryptedStream - Encrypted stream to read from.

clearStream - Clear output stream.

keyIndex - Index of the key to be used.

user - Verified system user

Throws:

IOException - If any IO exception occurs.

decrypt

public static byte[] decrypt(byte[] encryptedData,
 SecretKey key,
 byte[] iv)
                      throws Exception

Throws:

Exception

migrateMasterKey

public static void migrateMasterKey(TransactionManager tm)
                             throws Exception

Migrate Master Keys.

Parameters:

tm - Transaction manager.

Throws:

Exception - If any error occurs.

generateSecretKey

public static SecretKey generateSecretKey()

obfuscate

public static String obfuscate(String value)

authenticate

public static void authenticate(HTTP http,
 String user,
 String password)

authenticator

public static Authenticator authenticator(String user,
 String password)

log

public static String log(TransactionManager tm)

generatePassword

public static String generatePassword(int length)