org.apache.poi.poifs.crypt.dsig.services.TimeStampService Maven / Gradle / Ivy

/* ====================================================================
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
==================================================================== */

/* ====================================================================
   This product contains an ASLv2 licensed version of the OOXML signer
   package from the eID Applet project
   http://code.google.com/p/eid-applet/source/browse/trunk/README.txt  
   Copyright (C) 2008-2014 FedICT.
   ================================================================= */ 

package org.apache.poi.poifs.crypt.dsig.services;

import org.apache.poi.poifs.crypt.dsig.SignatureConfig.SignatureConfigurable;


/**
 * Interface for a time-stamp service.
 * 
 * @author Frank Cornelis
 * 
 */
public interface TimeStampService extends SignatureConfigurable {

    /**
     * Gives back the encoded time-stamp token for the given array of data
     * bytes. We assume that the time-stamp token itself contains its full
     * certificate chain required for proper validation.
     * 
     * @param data
     *            the data to be time-stamped.
     * @param revocationData
     *            the optional container that needs to be filled up with the
     *            revocation data used to validate the TSA certificate chain.
     * @return the DER encoded time-stamp token.
     * @throws Exception
     *             in case something went wrong.
     */
    byte[] timeStamp(byte[] data, RevocationData revocationData)
            throws Exception;
}