org.eclipse.kura.crypto

Interface CryptoService

@ProviderType
public interface CryptoService

The CryptoService is used to provide AES encrypt and decrypt functionality, Base64 encoding and decoding, and SHA1 hash generation.

Method Summary

Modifier and Type	Method and Description
java.lang.String	decodeBase64(java.lang.String encodedValue) Returns a decoded string based on the provided encodedValue.
char[]	decryptAes(char[] encryptedValue) Returns a char array based on the provided encrypted value.
java.lang.String	decryptAes(java.lang.String encryptedValue) Deprecated.
java.lang.String	encodeBase64(java.lang.String stringValue) Returns an encoded string based on the provided stringValue.
char[]	encryptAes(char[] value) Returns an AES encrypted char array based on the provided value.
java.lang.String	encryptAes(java.lang.String value) Deprecated.
char[]	getKeyStorePassword(java.lang.String keyStorePath) Takes a keystore path and returns the corresponding password that can be used to access to the data saved in the specified keystore.
boolean	isFrameworkSecure() Answers if the Kura framework is running in security mode.
void	setKeyStorePassword(java.lang.String keyStorePath, char[] password) Takes a keystore path as a String and a char array representing a password that has to be stored for the specified keystore.
void	setKeyStorePassword(java.lang.String keyStorePath, java.lang.String password) Deprecated.
java.lang.String	sha1Hash(java.lang.String s) Returns a SHA1 hashed value of the provided string s.

Method Detail

encryptAes

char[] encryptAes(char[] value)
           throws KuraException

Returns an AES encrypted char array based on the provided value.

Parameters:

value - A char array that will be encrypted.

Returns:

The char array representing the encrypted value.

Throws:

KuraException

decryptAes

char[] decryptAes(char[] encryptedValue)
           throws KuraException

Returns a char array based on the provided encrypted value.

Parameters:

encryptedValue - A char array representing the value to be decrypted.

Returns:

char[] that has been decrypted.

Throws:

KuraException

encryptAes

@Deprecated
java.lang.String encryptAes(java.lang.String value)
                                 throws java.security.NoSuchAlgorithmException,
                                        javax.crypto.NoSuchPaddingException,
                                        java.security.InvalidKeyException,
                                        javax.crypto.IllegalBlockSizeException,
                                        javax.crypto.BadPaddingException

Deprecated.

Returns an AES encrypted string based on the provided value.

Parameters:

value - A string that will be encrypted.

Returns:

String that has been encrypted.

Throws:

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

java.security.InvalidKeyException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

decryptAes

@Deprecated
java.lang.String decryptAes(java.lang.String encryptedValue)
                                 throws java.security.NoSuchAlgorithmException,
                                        javax.crypto.NoSuchPaddingException,
                                        java.security.InvalidKeyException,
                                        java.io.IOException,
                                        javax.crypto.IllegalBlockSizeException,
                                        javax.crypto.BadPaddingException

Deprecated.

Returns a plain text string based on the provided encrypted value.

Parameters:

encryptedValue - A string representing the value to be decrypted.

Returns:

String that has been decrypted.

Throws:

java.security.NoSuchAlgorithmException

javax.crypto.NoSuchPaddingException

java.security.InvalidKeyException

java.io.IOException

javax.crypto.IllegalBlockSizeException

javax.crypto.BadPaddingException

sha1Hash

java.lang.String sha1Hash(java.lang.String s)
                   throws java.security.NoSuchAlgorithmException,
                          java.io.UnsupportedEncodingException

Returns a SHA1 hashed value of the provided string s.

Parameters:

s - A string on which to run the SHA1 hasing algorithm.

Returns:

String that has been hashed.

Throws:

java.security.NoSuchAlgorithmException

java.io.UnsupportedEncodingException

encodeBase64

java.lang.String encodeBase64(java.lang.String stringValue)
                       throws java.security.NoSuchAlgorithmException,
                              java.io.UnsupportedEncodingException

Returns an encoded string based on the provided stringValue.

Parameters:

stringValue - A string to be encoded.

Returns:

String that has been encoded.

Throws:

java.security.NoSuchAlgorithmException

java.io.UnsupportedEncodingException

decodeBase64

java.lang.String decodeBase64(java.lang.String encodedValue)
                       throws java.security.NoSuchAlgorithmException,
                              java.io.UnsupportedEncodingException

Returns a decoded string based on the provided encodedValue.

Parameters:

encodedValue - A string to be decoded.

Returns:

String that has been decoded.

Throws:

java.security.NoSuchAlgorithmException

java.io.UnsupportedEncodingException

getKeyStorePassword

char[] getKeyStorePassword(java.lang.String keyStorePath)

Takes a keystore path and returns the corresponding password that can be used to access to the data saved in the specified keystore.

Parameters:

keyStorePath - A String that represents a unique identifier of the specified keystore.

Returns:

A char array that represents the password of the specified keystore.

setKeyStorePassword

void setKeyStorePassword(java.lang.String keyStorePath,
                         char[] password)
                  throws KuraException

Takes a keystore path as a String and a char array representing a password that has to be stored for the specified keystore.

Parameters:

keyStorePath - A String that represents a unique identifier of the specified keystore.

password - A char array that represents the password of the specified keystore.

Throws:

KuraException

setKeyStorePassword

@Deprecated
void setKeyStorePassword(java.lang.String keyStorePath,
                                     java.lang.String password)
                              throws java.io.IOException

Deprecated.

Takes a keystore path as a String and a char array representing a password that has to be stored for the specified keystore.

Parameters:

keyStorePath - A String that represents a unique identifier of the specified keystore.

password - A String that represents the password of the specified keystore.

Throws:

java.io.IOException

isFrameworkSecure

boolean isFrameworkSecure()

Answers if the Kura framework is running in security mode.

Returns:

true if the framework is running in security mode.