org.wso2.carbon.crypto.api

Class CipherMetaDataHolder

java.lang.Object

org.wso2.carbon.crypto.api.CipherMetaDataHolder

public class CipherMetaDataHolder
extends Object

This the POJO class to hold metadata of the cipher.

Constructor Summary

Constructors

Constructor and Description
CipherMetaDataHolder()

Method Summary

Modifier and Type	Method and Description
byte[]	getCipherBase64Decoded()
String	getCipherText()
String	getIv() Method to return the initialization vector in AES/GCM/NoPadding transformation.
byte[]	getIvBase64Decoded() Method to return initialization vector as a byte array
byte[]	getSelfContainedCiphertextWithIv(byte[] originalCipher, byte[] iv)
String	getThumbPrint()
String	getThumbprintDigest()
String	getTransformation()
void	setCipherBase64Encoded(byte[] cipher) Function to base64 encode ciphertext and set ciphertext
void	setCipherText(String cipher)
void	setIv(String iv) Method to set the initialization vector in AES/GCM/NoPadding transformation.
void	setIvAndOriginalCipherText(byte[] cipherTextBytes) This method will extract the initialization vector and original ciphertext from input ciphertext and set them to metadata in CipherMetaDataHolder object.
void	setThumbPrint(String tp)
void	setThumbPrint(String tp, String digest) Function to set thumbprint
void	setThumbprintDigest(String digest)
void	setTransformation(String transformation)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

CipherMetaDataHolder

public CipherMetaDataHolder()

Method Detail

getTransformation

public String getTransformation()

setTransformation

public void setTransformation(String transformation)

getCipherText

public String getCipherText()

getCipherBase64Decoded

public byte[] getCipherBase64Decoded()

setCipherText

public void setCipherText(String cipher)

getThumbPrint

public String getThumbPrint()

setThumbPrint

public void setThumbPrint(String tp)

getThumbprintDigest

public String getThumbprintDigest()

setThumbprintDigest

public void setThumbprintDigest(String digest)

getIv

public String getIv()

Method to return the initialization vector in AES/GCM/NoPadding transformation.

Returns:

initialization vector value in String format.

setIv

public void setIv(String iv)

Method to set the initialization vector in AES/GCM/NoPadding transformation.

Parameters:

iv - initialization vector value in String format

getIvBase64Decoded

public byte[] getIvBase64Decoded()

Method to return initialization vector as a byte array

Returns:

byte array

setCipherBase64Encoded

public void setCipherBase64Encoded(byte[] cipher)

Function to base64 encode ciphertext and set ciphertext

Parameters:

cipher -

setThumbPrint

public void setThumbPrint(String tp,
                          String digest)

Function to set thumbprint

Parameters:

tp - thumb print

digest - digest (hash algorithm) used for to create thumb print

getSelfContainedCiphertextWithIv

public byte[] getSelfContainedCiphertextWithIv(byte[] originalCipher,
                                               byte[] iv)

setIvAndOriginalCipherText

public void setIvAndOriginalCipherText(byte[] cipherTextBytes)

This method will extract the initialization vector and original ciphertext from input ciphertext and set them to metadata in CipherMetaDataHolder object.

Parameters:

cipherTextBytes - This input cipher text contains both original cipher and iv.

toString

public String toString()

Overrides:

toString in class Object