dev.o1c.jcryptobox

Class JCryptoBox.Unseal

java.lang.Object

dev.o1c.jcryptobox.JCryptoBox.Unseal

Enclosing class:

JCryptoBox

public static class JCryptoBox.Unseal
extends Object

Provides functionality to unseal a sealed box.

See Also:

JCryptoBox.unsealing(KeyPair), JCryptoBox.Seal

Method Summary

Modifier and Type	Method and Description
byte[]	unseal(byte[] sealedBox) Decrypts the given sealed box and returns the plaintext message.
byte[]	unseal(byte[] sealedBox, int offset, int length) Decrypts the given sealed box slice and returns the plaintext message.
void	unseal(byte[] input, int inOffset, int inLength, byte[] output, int outOffset) Decrypts the sealed box slice of input data and writes the plaintext message to the provided output array at the given offset.

Methods inherited from class java.lang.Object

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

Method Detail

unseal

public void unseal(byte[] input,
                   int inOffset,
                   int inLength,
                   byte[] output,
                   int outOffset)

Decrypts the sealed box slice of input data and writes the plaintext message to the provided output array at the given offset.

Parameters:

input - array of bytes to read sealed box data to decrypt

inOffset - where in the input array to begin reading data to decrypt

inLength - length of the sealed box in bytes (includes encoded public key and authentication tag)

output - array of bytes to write decrypted message to

outOffset - where in the output array to begin writing decrypted data

Throws:

IllegalArgumentException - if the sealed box cannot be successfully decrypted or if the output buffer is too small

ArrayIndexOutOfBoundsException - if the offsets or length are out of range of their arrays

NullPointerException - if the input or output arrays are null

unseal

public byte[] unseal(byte[] sealedBox,
                     int offset,
                     int length)

Decrypts the given sealed box slice and returns the plaintext message.

Parameters:

sealedBox - array of bytes to read sealed box data to decrypt

offset - where in the array to begin reading data to decrypt

length - length of the sealed box in bytes (includes encoded public key and authentication tag)

Returns:

the decrypted message

Throws:

IllegalArgumentException - if the sealed box cannot be successfully decrypted

ArrayIndexOutOfBoundsException - if the offset or length are out of range for the given array

NullPointerException - if the given array is null

unseal

public byte[] unseal(byte[] sealedBox)

Decrypts the given sealed box and returns the plaintext message.

Parameters:

sealedBox - array of bytes containing sealed box data

Returns:

the decrypted message

Throws:

IllegalArgumentException - if the sealed box cannot be successfully decrypted

NullPointerException - if the given array is null