001/*
002 * $Id: TSAClient.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;
045
046/**
047 * Time Stamp Authority client (caller) interface.
048 * <p>
049 * Interface used by the PdfPKCS7 digital signature builder to call
050 * Time Stamp Authority providing RFC 3161 compliant time stamp token.
051 * @author Martin Brunecky, 07/17/2007
052 * @since       2.1.6
053 */
054public interface TSAClient {
055    /**
056     * Get the time stamp token size estimate.
057     * Implementation must return value large enough to accomodate the entire token
058     * returned by getTimeStampToken() _prior_ to actual getTimeStampToken() call.
059     * @return  an estimate of the token size
060     */
061    public int getTokenSizeEstimate();
062    
063    /**
064     * Get RFC 3161 timeStampToken.
065     * Method may return null indicating that timestamp should be skipped.
066     * @param caller PdfPKCS7 - calling PdfPKCS7 instance (in case caller needs it)
067     * @param imprint byte[] - data imprint to be time-stamped
068     * @return byte[] - encoded, TSA signed data of the timeStampToken
069     * @throws Exception - TSA request failed
070     */
071    public byte[] getTimeStampToken(PdfPKCS7 caller, byte[] imprint) throws Exception;
072    
073}