java.lang.Object
- com.adobe.internal.pdftoolkit.core.cos.CosEncryption

```
public class CosEncryption
extends java.lang.Object
```
Performs all encryption-related operations on a Cos Document

Constructor Summary

Constructors
Constructor Description

CosEncryption(CosDocument doc)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`boolean`	`authenticateDecryption(DecryptedState decryptedState)`
`InputByteStream`	`decryptStream(ASName cryptFilter, CosStream strObj, InputByteStream content)`	Get the decrypted contents of a stream.
`byte[]`	`decryptString(CosString strObj, byte[] content)`	Get the decrypted bytes for a string
`InputByteStream`	`encryptStream(ASName cryptFilter, CosStream strObj, InputByteStream content)`	Get the encrypted contents of a stream.
`byte[]`	`encryptString(CosString strObj, byte[] content)`	Get the encrypted bytes for a string
`java.util.Map`	`getDecryptionMap()`
`SecurityManager`	`getDecryptionSecurityManager()`
`SecurityHandler`	`getDefaultDecryptionHandler()`	Return the default decryption handler
`CosDictionary`	`getEncryption()`
`EnableEncryption`	`getEncryptionImpl()`	Return the encryption implementation
`java.util.Map`	`getEncryptionMap()`
`SecurityManager`	`getEncryptionSecurityManager()`
`boolean`	`getEncryptionState()`
`boolean`	`needsDecryption()`
`boolean`	`needsEncryption()`
`void`	`resetDecryptionSecurityManager()`
`void`	`resetEncryptionSecurityManager()`
`void`	`setDecryptionAsEncryption()`	Sets Security Manager for decryption equal to the Security Manager for encryption.
`void`	`setDecryptionSecurityManager(SecurityManager securityMgr)`
`void`	`setEncryptionSecurityManager(SecurityManager securityMgr, java.util.Map encryptParams)`
`boolean`	`setEncryptionState(boolean doIt)`
`boolean`	`setNeedsDecryption(boolean decrypt)`
`void`	`setupDecryption()`
`void`	`setupEncryption()`	Setup encryption

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CosEncryption

public CosEncryption(CosDocument doc)

Method Detail

setupDecryption

public void setupDecryption()
                     throws PDFCosParseException,
                            PDFIOException,
                            PDFSecurityException

Throws:: PDFCosParseException; PDFIOException; PDFSecurityException

needsDecryption
```
public boolean needsDecryption()
```

setNeedsDecryption

public boolean setNeedsDecryption(boolean decrypt)

needsEncryption
```
public boolean needsEncryption()
```

getEncryption
```
public CosDictionary getEncryption()
```

getDecryptionMap

public java.util.Map getDecryptionMap()
                               throws PDFCosParseException,
                                      PDFIOException,
                                      PDFSecurityException

Throws:: PDFCosParseException; PDFIOException; PDFSecurityException

getEncryptionMap

public java.util.Map getEncryptionMap()
                               throws PDFSecurityAuthorizationException

Throws:: PDFSecurityAuthorizationException

getDefaultDecryptionHandler

public SecurityHandler getDefaultDecryptionHandler()
                                            throws PDFCosParseException,
                                                   PDFSecurityException

Return the default decryption handler

Throws:: PDFCosParseException; PDFSecurityException

getEncryptionImpl
```
public EnableEncryption getEncryptionImpl()
                                   throws PDFUnsupportedFeatureException
```
Return the encryption implementation

Throws:

PDFUnsupportedFeatureException - if there is no encryption implementation This represents a "can't happen" situation

getDecryptionSecurityManager

public SecurityManager getDecryptionSecurityManager()

authenticateDecryption

public boolean authenticateDecryption(DecryptedState decryptedState)
                               throws PDFSecurityException

Throws:: PDFSecurityException

setDecryptionSecurityManager

public void setDecryptionSecurityManager(SecurityManager securityMgr)
                                  throws PDFSecurityException,
                                         PDFCosParseException,
                                         PDFIOException

Throws:: PDFSecurityException; PDFCosParseException; PDFIOException

getEncryptionSecurityManager

public SecurityManager getEncryptionSecurityManager()

setEncryptionSecurityManager

public void setEncryptionSecurityManager(SecurityManager securityMgr,
                                         java.util.Map encryptParams)

setDecryptionAsEncryption

public void setDecryptionAsEncryption()
                               throws PDFSecurityException,
                                      PDFCosParseException,
                                      PDFIOException

Sets Security Manager for decryption equal to the Security Manager for encryption. Resets Security Manager for decryption if the Security Manager for encryption is not set.

Throws:: PDFSecurityException; PDFCosParseException; PDFIOException

setupEncryption

public void setupEncryption()
                     throws PDFCosParseException,
                            PDFIOException,
                            PDFSecurityException

Setup encryption

Throws:: PDFCosParseException; PDFIOException; PDFSecurityException

resetEncryptionSecurityManager

public void resetEncryptionSecurityManager()

resetDecryptionSecurityManager

public void resetDecryptionSecurityManager()

encryptString
```
public byte[] encryptString(CosString strObj,
                            byte[] content)
                     throws PDFSecurityException
```
Get the encrypted bytes for a string

Throws:

PDFUnsupportedFeatureException - if no encryption implementation is in place

PDFSecurityException

decryptString
```
public byte[] decryptString(CosString strObj,
                            byte[] content)
                     throws PDFSecurityException
```
Get the decrypted bytes for a string

Throws:

PDFUnsupportedFeatureException

PDFSecurityException

PDFSecurityException

PDFUnsupportedFeatureException - if no encryption implementation is in place

decryptStream

public InputByteStream decryptStream(ASName cryptFilter,
                                     CosStream strObj,
                                     InputByteStream content)
                              throws PDFIOException,
                                     PDFSecurityException,
                                     PDFCosParseException

Get the decrypted contents of a stream. This stream becomes the property of the caller and must be closed by them.

Throws:: PDFIOException; PDFSecurityException; PDFCosParseException; PDFUnsupportedFeatureException - if no encryption implementation is in place

encryptStream

public InputByteStream encryptStream(ASName cryptFilter,
                                     CosStream strObj,
                                     InputByteStream content)
                              throws PDFCosParseException,
                                     PDFIOException,
                                     PDFSecurityException

Get the encrypted contents of a stream. This encrypts the entire contents of the InputByteStream. If the caller desires to enrypt only a portion of an InputByteStream they should slice the original InputByteStream. The returned encrypted stream becomes the property of the caller and must be closed by them.

Throws:: PDFCosParseException; PDFIOException; PDFSecurityException; PDFUnsupportedFeatureException - if no encryption implementation is in place

setEncryptionState

public boolean setEncryptionState(boolean doIt)

getEncryptionState
```
public boolean getEncryptionState()
```

Class CosEncryption

Constructor Summary