com.aquafold.openapi.crypto

Interface AQCrypto

public interface AQCrypto

This interface provides access to cryptographic functions. An object implementing this interface is available in aquascripts via aqua.crypto alias.

Method Summary

Modifier and Type	Method and Description
java.lang.String	computeHashMD2(java.lang.Object input) Generates an MD2 hash for the specified object.
java.lang.String	computeHashMD5(java.lang.Object input) Generates a MD5 hash for the specified object.
java.lang.String	computeHashSHA1(java.lang.Object input) Generates a SHA1 hash for the specified object.
java.lang.String	computeHashSHA256(java.lang.Object input) Generates a SHA-256 hash for the specified object.
java.lang.String	computeHashSHA384(java.lang.Object input) Generates a SHA-384 hash for the specified object.
java.lang.String	computeHashSHA512(java.lang.Object input) Generates a SHA-512 hash for the specified object.
void	decryptZipAES(java.lang.String sourceZipFile, java.lang.String destinationFolder, java.lang.Object password) Decrypts a zip file with the AES-256 cipher using the supplied password.
void	encryptZipAES(java.lang.String sourceZipFile, java.lang.String destinationZipFile, java.lang.Object password) Encrypts a zip file with the AES-256 cipher using the supplied password.
AQOpaqueObject	getSecureField(java.lang.String name) Retrieves an opaque value from a secure storage.
boolean	verifyHashMD2(java.lang.Object input, java.lang.String hash) Verify the hash value of the specified object using MD2.
boolean	verifyHashMD5(java.lang.Object input, java.lang.String hash) Verify the hash value of the specified object using MD5.
boolean	verifyHashSHA1(java.lang.Object input, java.lang.String hash) Verify the hash value of the specified object using SHA.
boolean	verifyHashSHA256(java.lang.Object input, java.lang.String hash) Verify the hash value of the specified object using SHA-256.
boolean	verifyHashSHA384(java.lang.Object input, java.lang.String hash) Verify the hash value of the specified object using SHA-384.
boolean	verifyHashSHA512(java.lang.Object input, java.lang.String hash) Verify the hash value of the specified object using SHA-512.

Method Detail

computeHashMD2

java.lang.String computeHashMD2(java.lang.Object input)
                         throws java.lang.Exception

Generates an MD2 hash for the specified object.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input object.

Returns:

the hash

Throws:

java.lang.Exception - On error

computeHashMD5

java.lang.String computeHashMD5(java.lang.Object input)
                         throws java.lang.Exception

Generates a MD5 hash for the specified object.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input object.

Returns:

the hash

Throws:

java.lang.Exception - On error

computeHashSHA1

java.lang.String computeHashSHA1(java.lang.Object input)
                          throws java.lang.Exception

Generates a SHA1 hash for the specified object.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input object.

Returns:

the hash

Throws:

java.lang.Exception - On error

computeHashSHA256

java.lang.String computeHashSHA256(java.lang.Object input)
                            throws java.lang.Exception

Generates a SHA-256 hash for the specified object.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input object.

Returns:

the hash

Throws:

java.lang.Exception - On error

computeHashSHA384

java.lang.String computeHashSHA384(java.lang.Object input)
                            throws java.lang.Exception

Generates a SHA-384 hash for the specified object.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input object.

Returns:

the hash

Throws:

java.lang.Exception - On error

computeHashSHA512

java.lang.String computeHashSHA512(java.lang.Object input)
                            throws java.lang.Exception

Generates a SHA-512 hash for the specified object.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input object.

Returns:

the hash

Throws:

java.lang.Exception - On error

verifyHashMD2

boolean verifyHashMD2(java.lang.Object input,
                      java.lang.String hash)

Verify the hash value of the specified object using MD2.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input Object

hash - Hash value

Returns:

TRUE if verified

verifyHashMD5

boolean verifyHashMD5(java.lang.Object input,
                      java.lang.String hash)

Verify the hash value of the specified object using MD5.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input Object

hash - Hash value

Returns:

TRUE if verified

verifyHashSHA1

boolean verifyHashSHA1(java.lang.Object input,
                       java.lang.String hash)

Verify the hash value of the specified object using SHA.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input Object

hash - Hash value

Returns:

TRUE if verified

verifyHashSHA256

boolean verifyHashSHA256(java.lang.Object input,
                         java.lang.String hash)

Verify the hash value of the specified object using SHA-256.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input Object

hash - Hash value

Returns:

TRUE if verified

verifyHashSHA384

boolean verifyHashSHA384(java.lang.Object input,
                         java.lang.String hash)

Verify the hash value of the specified object using SHA-384.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input Object

hash - Hash value

Returns:

TRUE if verified

verifyHashSHA512

boolean verifyHashSHA512(java.lang.Object input,
                         java.lang.String hash)

Verify the hash value of the specified object using SHA-512.

Acceptable object types are:

• byte[]
• File
• AQProjectFile
• String
• Object

The hash value of String and Object types is computed for the byte array obtained by converting the input object to UTF-8 string.

Parameters:

input - Input Object

hash - Hash value

Returns:

TRUE if verified

encryptZipAES

void encryptZipAES(java.lang.String sourceZipFile,
                   java.lang.String destinationZipFile,
                   java.lang.Object password)
            throws java.lang.Exception

Encrypts a zip file with the AES-256 cipher using the supplied password.

Parameters:

sourceZipFile - File name of the source zip file in the local file system.

destinationZipFile - File name of the destination zip file.

password - A string or AQOpaqueObject password.

Throws:

java.lang.Exception - On error

decryptZipAES

void decryptZipAES(java.lang.String sourceZipFile,
                   java.lang.String destinationFolder,
                   java.lang.Object password)
            throws java.lang.Exception

Decrypts a zip file with the AES-256 cipher using the supplied password.

Parameters:

sourceZipFile - File name of the source zip file in the local file system.

destinationFolder - Name of the destination folder

password - A string or AQOpaqueObject password.

Throws:

java.lang.Exception - On error

getSecureField

AQOpaqueObject getSecureField(java.lang.String name)

Retrieves an opaque value from a secure storage. This method allows user-specific values such as passwords, names, credentials and the like to be accessed by a script without revealing the actual value.

Aqua Data Studio: User specific values are determined by the Options->Secure Storage.
Aqua Data Server: User specific values are determined by the user executing the script.

When script is running in:

1. Dashboard: it uses the values from currently logged in user's Secure Storage.
2. View/Edit AquaScript: it uses the values from current logged in user's Secure Storage.
3. Scheduled Job: Started manually or by schedule it will use the values from the Secure Storage of the owner of the job.

Parameters:

name - Field name.

Returns:

the opaque value