com.itextpdf.kernel.pdf

Class EncryptionProperties

java.lang.Object

com.itextpdf.kernel.pdf.EncryptionProperties

All Implemented Interfaces:

Serializable

public class EncryptionProperties
extends Object
implements Serializable

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected int	encryptionAlgorithm
protected byte[]	ownerPassword
protected Certificate[]	publicCertificates PublicKeyEncryption properties
protected int[]	publicKeyEncryptPermissions
protected int	standardEncryptPermissions
protected byte[]	userPassword StandardEncryption properties

Constructor Summary

Constructors

Constructor and Description
EncryptionProperties()

Method Summary

Modifier and Type	Method and Description
EncryptionProperties	setPublicKeyEncryption(Certificate[] certs, int[] permissions, int encryptionAlgorithm) Sets the certificate encryption options for the document.
EncryptionProperties	setStandardEncryption(byte[] userPassword, byte[] ownerPassword, int permissions, int encryptionAlgorithm) Sets the encryption options for the document.

Methods inherited from class java.lang.Object

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

Field Detail

encryptionAlgorithm

protected int encryptionAlgorithm

userPassword

protected byte[] userPassword

StandardEncryption properties

ownerPassword

protected byte[] ownerPassword

standardEncryptPermissions

protected int standardEncryptPermissions

publicCertificates

protected Certificate[] publicCertificates

PublicKeyEncryption properties

publicKeyEncryptPermissions

protected int[] publicKeyEncryptPermissions

Constructor Detail

EncryptionProperties

public EncryptionProperties()

Method Detail

setStandardEncryption

public EncryptionProperties setStandardEncryption(byte[] userPassword,
                                                  byte[] ownerPassword,
                                                  int permissions,
                                                  int encryptionAlgorithm)

Sets the encryption options for the document. The userPassword and the ownerPassword can be null or have zero length. In this case the ownerPassword is replaced by a random string. The open permissions for the document can be ALLOW_PRINTING, ALLOW_MODIFY_CONTENTS, ALLOW_COPY, ALLOW_MODIFY_ANNOTATIONS, ALLOW_FILL_IN, ALLOW_SCREENREADERS, ALLOW_ASSEMBLY and ALLOW_DEGRADED_PRINTING. The permissions can be combined by ORing them. See EncryptionConstants.

Parameters:

userPassword - the user password. Can be null or empty

ownerPassword - the owner password. Can be null or empty

permissions - the user permissions

encryptionAlgorithm - the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128, ENCRYPTION_AES128 or ENCRYPTION_AES256 Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext

setPublicKeyEncryption

public EncryptionProperties setPublicKeyEncryption(Certificate[] certs,
                                                   int[] permissions,
                                                   int encryptionAlgorithm)

Sets the certificate encryption options for the document. An array of one or more public certificates must be provided together with an array of the same size for the permissions for each certificate. The open permissions for the document can be AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations, AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting. The permissions can be combined by ORing them. Optionally DO_NOT_ENCRYPT_METADATA can be ORed to output the metadata in cleartext See EncryptionConstants.

Parameters:

certs - the public certificates to be used for the encryption

permissions - the user permissions for each of the certificates

encryptionAlgorithm - the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128, ENCRYPTION_AES128 or ENCRYPTION_AES256.