001: /*
002: * $Id: PdfEncryptionSettings.java 2730 2007-04-28 12:52:49Z blowagie $
003: *
004: * Copyright 2006 Bruno Lowagie
005: *
006: * The contents of this file are subject to the Mozilla Public License Version 1.1
007: * (the "License"); you may not use this file except in compliance with the License.
008: * You may obtain a copy of the License at http://www.mozilla.org/MPL/
009: *
010: * Software distributed under the License is distributed on an "AS IS" basis,
011: * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
012: * for the specific language governing rights and limitations under the License.
013: *
014: * The Original Code is 'iText, a free JAVA-PDF library'.
015: *
016: * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by
017: * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie.
018: * All Rights Reserved.
019: * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer
020: * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved.
021: *
022: * Contributor(s): all the names of the contributors are added in the source code
023: * where applicable.
024: *
025: * Alternatively, the contents of this file may be used under the terms of the
026: * LGPL license (the "GNU LIBRARY GENERAL PUBLIC LICENSE"), in which case the
027: * provisions of LGPL are applicable instead of those above. If you wish to
028: * allow use of your version of this file only under the terms of the LGPL
029: * License and not to allow others to use your version of this file under
030: * the MPL, indicate your decision by deleting the provisions above and
031: * replace them with the notice and other provisions required by the LGPL.
032: * If you do not delete the provisions above, a recipient may use your version
033: * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE.
034: *
035: * This library is free software; you can redistribute it and/or modify it
036: * under the terms of the MPL as stated above or under the terms of the GNU
037: * Library General Public License as published by the Free Software Foundation;
038: * either version 2 of the License, or any later version.
039: *
040: * This library is distributed in the hope that it will be useful, but WITHOUT
041: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
042: * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more
043: * details.
044: *
045: * If you didn't download this code from the following link, you should check if
046: * you aren't using an obsolete version:
047: * http://www.lowagie.com/iText/
048: */
049:
050: package com.lowagie.text.pdf.interfaces;
051:
052: import java.security.cert.Certificate;
053:
054: import com.lowagie.text.DocumentException;
055:
056: /**
057: * Encryption settings are described in section 3.5 (more specifically
058: * section 3.5.2) of the PDF Reference 1.7.
059: * They are explained in section 3.3.3 of the book 'iText in Action'.
060: * The values of the different preferences were originally stored
061: * in class PdfWriter, but they have been moved to this separate interface
062: * for reasons of convenience.
063: */
064:
065: public interface PdfEncryptionSettings {
066:
067: /**
068: * Sets the encryption options for this document. The userPassword and the
069: * ownerPassword can be null or have zero length. In this case the ownerPassword
070: * is replaced by a random string. The open permissions for the document can be
071: * AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
072: * AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
073: * The permissions can be combined by ORing them.
074: * @param userPassword the user password. Can be null or empty
075: * @param ownerPassword the owner password. Can be null or empty
076: * @param permissions the user permissions
077: * @param encryptionType the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
078: * Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
079: * @throws DocumentException if the document is already open
080: */
081: public void setEncryption(byte userPassword[],
082: byte ownerPassword[], int permissions, int encryptionType)
083: throws DocumentException;
084:
085: /**
086: * Sets the certificate encryption options for this document. An array of one or more public certificates
087: * must be provided together with an array of the same size for the permissions for each certificate.
088: * The open permissions for the document can be
089: * AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
090: * AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
091: * The permissions can be combined by ORing them.
092: * Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
093: * @param certs the public certificates to be used for the encryption
094: * @param permissions the user permissions for each of the certicates
095: * @param encryptionType the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
096: * @throws DocumentException if the document is already open
097: */
098: public void setEncryption(Certificate[] certs, int[] permissions,
099: int encryptionType) throws DocumentException;
100: }
|