Package org.spincast.plugins.crypto

Interface SpincastCryptoUtils

All Known Implementing Classes:

SpincastCryptoUtilsDefault

public interface SpincastCryptoUtils

Spincast Crypto utils

Method Summary

Modifier and Type	Method	Description
String	decrypt(String payload, String secretKey)	Decrypts a string that was encrypted using encrypt(String, String).
String	encrypt(String toEncrypt, String secretKey)	Encrypts a string, using the given secret key and the AES algorithm.
String	generateNewHashSecureSalt()	Will generate a new secure salt that can be used with hashSecure(String, String).
String	hashSecure(String toHash, String salt)	Will hash a string using BCrypt.
boolean	isRestrictedCryptographyJavaVersion()	Is the current Java version cryptography restricted?
void	removeCryptographyRestrictions()	Tries to remove the Java cryptography restrictions.

Method Details

encrypt

String encrypt(String toEncrypt,
 String secretKey)

Encrypts a string, using the given secret key and the AES algorithm.

The generated encrypted payload is a string which is also base64 encoded so it can be used in urls, emails, etc.

You must use the associated decrypt(String, String) method to decrypt the resultind payload.

IMPORTANT!: For this method to work, JCE policy files may be installed first, security must be configured properly, or security policy must be disabled using the SpincastCryptoConfig.removeJavaCryptoRestrictionsOnInit() configuration.

more info

decrypt

String decrypt(String payload,
 String secretKey)

Decrypts a string that was encrypted using encrypt(String, String).

IMPORTANT!: For this method to work, JCE policy files may be installed first, security must be configured properly, or security policy must be disabled using the SpincastCryptoConfig.removeJavaCryptoRestrictionsOnInit() configuration.

more info

hashSecure

String hashSecure(String toHash,
 String salt)

Will hash a string using BCrypt. This is currently a good way to hash passwords so they can be stored in a database.

You can use generateNewHashSecureSalt() to generate a new salt.

generateNewHashSecureSalt

String generateNewHashSecureSalt()

Will generate a new secure salt that can be used with hashSecure(String, String).

removeCryptographyRestrictions

void removeCryptographyRestrictions()
                             throws RuntimeException

Tries to remove the Java cryptography restrictions.

Throws:

an - Exception is the restrictions can't be removed.

RuntimeException

isRestrictedCryptographyJavaVersion

boolean isRestrictedCryptographyJavaVersion()

Is the current Java version cryptography restricted?