Package org.wildfly.security.util

Class PasswordBasedEncryptionUtil

java.lang.Object

org.wildfly.security.util.PasswordBasedEncryptionUtil

public final class PasswordBasedEncryptionUtil
extends Object

Password Based Encryption utility class for tooling. It provides builder to build PBE masked strings for usage with org.wildfly.security.credential.store.CredentialStore.

Author:

Peter Skopek

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PasswordBasedEncryptionUtil.Builder	Builder class to build PasswordBasedEncryptionUtil class with all necessary parameters to support password based encryption algorithms.

Field Summary

Fields

Modifier and Type	Field	Description
static org.wildfly.common.codec.Base64Alphabet	PICKETBOX_COMPATIBILITY	The alphabet used by PicketBox project base 64 encoding.

Method Summary

Modifier and Type	Method	Description
char[]	decodeAndDecrypt(String encodedPayload)	Decode given payload and decrypt it to original.
String	encryptAndEncode(char[] payload)	Encrypt a payload and encode the result using Alphabet given to builder.
AlgorithmParameters	getAlgorithmParameters()	Returns algorithm parameters used in the process of encryption.
String	getEncodedIV()	Returns encrypted IV (initial vector) as generated by AES algorithm in the process of encryption.

Methods inherited from class java.lang.Object

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

Field Detail

PICKETBOX_COMPATIBILITY

public static final org.wildfly.common.codec.Base64Alphabet PICKETBOX_COMPATIBILITY

The alphabet used by PicketBox project base 64 encoding. 0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz./

Method Detail

encryptAndEncode

public String encryptAndEncode(char[] payload)
                        throws GeneralSecurityException

Encrypt a payload and encode the result using Alphabet given to builder. All necessary parameters are supplied through PasswordBasedEncryptionUtil.Builder.

Parameters:

payload - secret to encrypt

Returns:

String encrypted and encoded using given parameters

Throws:

GeneralSecurityException - when problem occurs like non-existent algorithm or similar problems

decodeAndDecrypt

public char[] decodeAndDecrypt(String encodedPayload)
                        throws GeneralSecurityException

Decode given payload and decrypt it to original. All necessary parameters are supplied through PasswordBasedEncryptionUtil.Builder.

Parameters:

encodedPayload - text to decode and decrypt

Returns:

decrypted secret

Throws:

GeneralSecurityException - when problem occurs like non-existent algorithm or similar problems

getAlgorithmParameters

public AlgorithmParameters getAlgorithmParameters()

Returns algorithm parameters used in the process of encryption. Might be useful to store them separately after encryption happened. It depends on used algorithm.

Returns:

AlgorithmParameters as generated by encryption process

getEncodedIV

public String getEncodedIV()

Returns encrypted IV (initial vector) as generated by AES algorithm in the process of encryption. Other algorithms are not using it. In case of no such data available it returns null. It uses already set Alphabet to encode it.

Returns:

encoded form of IV or null when not available