001/*
002 * $Id: PdfEncryptionSettings.java 4784 2011-03-15 08:33:00Z blowagie $
003 *
004 * This file is part of the iText (R) project.
005 * Copyright (c) 1998-2011 1T3XT BVBA
006 * Authors: Bruno Lowagie, Paulo Soares, et al.
007 *
008 * This program is free software; you can redistribute it and/or modify
009 * it under the terms of the GNU Affero General Public License version 3
010 * as published by the Free Software Foundation with the addition of the
011 * following permission added to Section 15 as permitted in Section 7(a):
012 * FOR ANY PART OF THE COVERED WORK IN WHICH THE COPYRIGHT IS OWNED BY 1T3XT,
013 * 1T3XT DISCLAIMS THE WARRANTY OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
014 *
015 * This program is distributed in the hope that it will be useful, but
016 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
017 * or FITNESS FOR A PARTICULAR PURPOSE.
018 * See the GNU Affero General Public License for more details.
019 * You should have received a copy of the GNU Affero General Public License
020 * along with this program; if not, see http://www.gnu.org/licenses or write to
021 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
022 * Boston, MA, 02110-1301 USA, or download the license from the following URL:
023 * http://itextpdf.com/terms-of-use/
024 *
025 * The interactive user interfaces in modified source and object code versions
026 * of this program must display Appropriate Legal Notices, as required under
027 * Section 5 of the GNU Affero General Public License.
028 *
029 * In accordance with Section 7(b) of the GNU Affero General Public License,
030 * a covered work must retain the producer line in every PDF that is created
031 * or manipulated using iText.
032 *
033 * You can be released from the requirements of the license by purchasing
034 * a commercial license. Buying such a license is mandatory as soon as you
035 * develop commercial activities involving the iText software without
036 * disclosing the source code of your own applications.
037 * These activities include: offering paid services to customers as an ASP,
038 * serving PDFs on the fly in a web application, shipping iText with a closed
039 * source product.
040 *
041 * For more information, please contact iText Software Corp. at this
042 * address: sales@itextpdf.com
043 */
044package com.itextpdf.text.pdf.interfaces;
045
046import java.security.cert.Certificate;
047
048import com.itextpdf.text.DocumentException;
049
050/**
051 * Encryption settings are described in section 3.5 (more specifically
052 * section 3.5.2) of the PDF Reference 1.7.
053 * They are explained in section 3.3.3 of the book 'iText in Action'.
054 * The values of the different  preferences were originally stored
055 * in class PdfWriter, but they have been moved to this separate interface
056 * for reasons of convenience.
057 */
058
059public interface PdfEncryptionSettings {
060
061    
062    /**
063     * Sets the encryption options for this document. The userPassword and the
064     * ownerPassword can be null or have zero length. In this case the ownerPassword
065     * is replaced by a random string. The open permissions for the document can be
066     * AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
067     * AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
068     * The permissions can be combined by ORing them.
069     * @param userPassword the user password. Can be null or empty
070     * @param ownerPassword the owner password. Can be null or empty
071     * @param permissions the user permissions
072     * @param encryptionType the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
073     * Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
074     * @throws DocumentException if the document is already open
075     */
076    public void setEncryption(byte userPassword[], byte ownerPassword[], int permissions, int encryptionType) throws DocumentException;
077
078    /**
079     * Sets the certificate encryption options for this document. An array of one or more public certificates
080     * must be provided together with an array of the same size for the permissions for each certificate.
081     *  The open permissions for the document can be
082     *  AllowPrinting, AllowModifyContents, AllowCopy, AllowModifyAnnotations,
083     *  AllowFillIn, AllowScreenReaders, AllowAssembly and AllowDegradedPrinting.
084     *  The permissions can be combined by ORing them.
085     * Optionally DO_NOT_ENCRYPT_METADATA can be ored to output the metadata in cleartext
086     * @param certs the public certificates to be used for the encryption
087     * @param permissions the user permissions for each of the certificates
088     * @param encryptionType the type of encryption. It can be one of STANDARD_ENCRYPTION_40, STANDARD_ENCRYPTION_128 or ENCRYPTION_AES128.
089     * @throws DocumentException if the document is already open
090     */
091    public void setEncryption(Certificate[] certs, int[] permissions, int encryptionType) throws DocumentException;
092}