Package com.adobe.internal.pdftoolkit.core.securityframework.impl

Interface EnableEncryption

public interface EnableEncryption

Provides the interface to the internal implementation of encryption and security in PDF Java Toolkit.

Method Summary

Modifier and Type	Method	Description
boolean	authenticateSecurity(SecurityHandler handler, DecryptedState decryptedState)	Authenticates all security handlers specified by the encryption parameters associated with the stored security manager
boolean	authenticateSecurity(Map params, byte[] docID, SecurityHandler handler, DecryptedState decryptedState)	Authenticates specified security handler
void	decryptStream(String cryptFilter, InputByteStream src, OutputByteStream dest, byte[] addKey)	Decrypts CosStream's content
byte[]	decryptString(byte[] content, byte[] addKey)	Decrypts CosString's content
void	encryptStream(String cryptFilter, InputByteStream src, OutputByteStream dest, byte[] addKey)	Encrypts CosStream's content
byte[]	encryptString(byte[] content, byte[] addKey)	Encrypts CosString's content
Map	getDecryptionParameters()
SecurityManager	getDecryptionSecurityManager()
Map	getEncryptionParameters()
SecurityManager	getEncryptionSecurityManager()
SecurityHandler	getSecurityHandler()	Returns SecurityHandler which has been used to authenticate security.
EncryptionHandler	getStreamDecryptionHandler(String name)
EncryptionHandler	getStreamEncryptionHandler(String name)
EncryptionHandler	getStringDecryptionHandler()
EncryptionHandler	getStringEncryptionHandler()
void	resetDecryptionSecurityManager()
void	resetEncryptionSecurityManager()
void	setDecryptionSecurityManager(SecurityManager securityMgr, Map encryptParams, byte[] id)	Sets the Security Manager used for encryption-related actions
void	setEncryptionSecurityManager(SecurityManager securityMgr, Map encryptParams, byte[] id)

Method Details

setDecryptionSecurityManager

void setDecryptionSecurityManager(SecurityManager securityMgr,
 Map encryptParams,
 byte[] id)
                           throws PDFSecurityException

Sets the Security Manager used for encryption-related actions

Parameters:

securityMgr - - Security Manager

encryptParams - - Encryption Parameters

Throws:

PDFSecurityException

setEncryptionSecurityManager

void setEncryptionSecurityManager(SecurityManager securityMgr,
 Map encryptParams,
 byte[] id)

resetEncryptionSecurityManager

void resetEncryptionSecurityManager()

resetDecryptionSecurityManager

void resetDecryptionSecurityManager()

getEncryptionSecurityManager

SecurityManager getEncryptionSecurityManager()

getDecryptionSecurityManager

SecurityManager getDecryptionSecurityManager()

getEncryptionParameters

Map getEncryptionParameters()
                     throws PDFSecurityAuthorizationException

Throws:

PDFSecurityAuthorizationException

getDecryptionParameters

Map getDecryptionParameters()
                     throws PDFSecurityAuthorizationException

Throws:

PDFSecurityAuthorizationException

authenticateSecurity

boolean authenticateSecurity(SecurityHandler handler,
 DecryptedState decryptedState)
                      throws PDFSecurityAuthorizationException,
PDFSecurityConfigurationException

Authenticates all security handlers specified by the encryption parameters associated with the stored security manager

Parameters:

handler - SecurityHandler to authenticate

decryptedState - Set null if password or credentials are used for decryption, else set a valid decryption state.

Throws:

PDFSecurityAuthorizationException

PDFSecurityConfigurationException

authenticateSecurity

boolean authenticateSecurity(Map params,
 byte[] docID,
 SecurityHandler handler,
 DecryptedState decryptedState)
                      throws PDFSecurityAuthorizationException,
PDFSecurityConfigurationException

Authenticates specified security handler

Parameters:

params -

docID -

handler -

decryptedState -

Returns:

boolean

Throws:

PDFSecurityAuthorizationException

PDFSecurityConfigurationException

encryptString

byte[] encryptString(byte[] content,
 byte[] addKey)
              throws PDFSecurityException

Encrypts CosString's content

Parameters:

content - byte sequence of the CosString's content

addKey - CosString-object-specific addition to the encryption key associated with the particular security handler

Returns:

encrypted byte sequence

Throws:

PDFSecurityException

decryptString

byte[] decryptString(byte[] content,
 byte[] addKey)
              throws PDFSecurityException

Decrypts CosString's content

Parameters:

content - byte sequence of the CosString's content

addKey - CosString-object-specific addition to the encryption key associated with the particular security handler

Returns:

- decrypted byte sequence

Throws:

PDFSecurityException

decryptStream

void decryptStream(String cryptFilter,
 InputByteStream src,
 OutputByteStream dest,
 byte[] addKey)
            throws PDFSecurityException,
PDFIOException

Decrypts CosStream's content

Parameters:

src - source stream to decrypt

dest - destination for the decrypted stream

addKey - CosStream-object-specific addition to the encryption key associated with the particular security handler

Throws:

PDFIOException

PDFSecurityException

encryptStream

void encryptStream(String cryptFilter,
 InputByteStream src,
 OutputByteStream dest,
 byte[] addKey)
            throws PDFSecurityException,
PDFIOException

Encrypts CosStream's content

Parameters:

src - source stream to encrypt

dest - destination for the encrypted stream

addKey - CosStream-object-specific addition to the encryption key associated with the particular security handler

Throws:

PDFSecurityException

PDFIOException

getStreamEncryptionHandler

EncryptionHandler getStreamEncryptionHandler(String name)
                                      throws PDFSecurityConfigurationException,
PDFSecurityAuthorizationException

Parameters:

name -

Returns:

Encryption Handler for stream encryption with the specified name

Throws:

PDFSecurityConfigurationException

PDFSecurityAuthorizationException

getStringEncryptionHandler

EncryptionHandler getStringEncryptionHandler()
                                      throws PDFSecurityConfigurationException,
PDFSecurityAuthorizationException

Returns:

Encryption Handler for string encryption with the specified name

Throws:

PDFSecurityConfigurationException

PDFSecurityAuthorizationException

getStreamDecryptionHandler

EncryptionHandler getStreamDecryptionHandler(String name)
                                      throws PDFSecurityConfigurationException,
PDFSecurityAuthorizationException

Parameters:

name -

Returns:

Encryption Handler for stream decryption with the specified name

Throws:

PDFSecurityConfigurationException

PDFSecurityAuthorizationException

getStringDecryptionHandler

EncryptionHandler getStringDecryptionHandler()
                                      throws PDFSecurityConfigurationException,
PDFSecurityAuthorizationException

Returns:

Encryption Handler for string decryption with the specified name

Throws:

PDFSecurityConfigurationException

PDFSecurityAuthorizationException

getSecurityHandler

SecurityHandler getSecurityHandler()

Returns SecurityHandler which has been used to authenticate security. If this process is still not done, then this method returns null.

Returns:

SecurityHandler