eu.europa.esig.dss.validation.timestamp.DetachedTimestampValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of dss-document Show documentation
DSS Document contains the code for the creation and validation of XAdES, CAdES, PAdES and ASiC signatures.
The newest version!
/**
 * DSS - Digital Signature Services
 * Copyright (C) 2015 European Commission, provided under the CEF programme
 * 
 * This file is part of the "DSS - Digital Signature Services" project.
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */
package eu.europa.esig.dss.validation.timestamp;

import eu.europa.esig.dss.enumerations.TimestampType;
import eu.europa.esig.dss.model.DSSDocument;
import eu.europa.esig.dss.model.DSSException;
import eu.europa.esig.dss.model.scope.SignatureScope;
import eu.europa.esig.dss.spi.DSSASN1Utils;
import eu.europa.esig.dss.spi.DSSUtils;
import eu.europa.esig.dss.spi.x509.tsp.TimestampToken;
import eu.europa.esig.dss.utils.Utils;
import eu.europa.esig.dss.validation.AdvancedSignature;
import eu.europa.esig.dss.validation.SignedDocumentValidator;
import eu.europa.esig.dss.validation.executor.ValidationLevel;
import eu.europa.esig.dss.validation.scope.DetachedTimestampScopeFinder;
import org.bouncycastle.cms.CMSException;
import org.bouncycastle.tsp.TSPException;

import java.io.IOException;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;

/**
 * Detached CMS TimestampToken Validator
 *
 */
public class DetachedTimestampValidator extends SignedDocumentValidator implements TimestampValidator {

	/** The type of the timestamp */
	protected TimestampType timestampType;

	/** The TimestampToken to be validated */
	protected TimestampToken timestampToken;

	/**
	 * Empty constructor
	 */
	DetachedTimestampValidator() {
		// empty
	}

	/**
	 * The default constructor
	 *
	 * @param timestampFile {@link DSSDocument} timestamp document to validate
	 */
	public DetachedTimestampValidator(final DSSDocument timestampFile) {
		this(timestampFile, TimestampType.CONTENT_TIMESTAMP);
	}

	/**
	 * The default constructor with a type
	 *
	 * @param timestampFile {@link DSSDocument} timestamp document to validate
	 * @param timestampType {@link TimestampType}
	 */
	public DetachedTimestampValidator(final DSSDocument timestampFile, TimestampType timestampType) {
		this.document = timestampFile;
		this.timestampType = timestampType;
	}

	@Override
	public boolean isSupported(DSSDocument dssDocument) {
		byte firstByte = DSSUtils.readFirstByte(dssDocument);
		if (DSSASN1Utils.isASN1SequenceTag(firstByte)) {
			return DSSUtils.isTimestampToken(dssDocument);
		}
		return false;
	}

	@Override
	protected void assertConfigurationValid() {
		Objects.requireNonNull(certificateVerifier, "CertificateVerifier is not defined");
	}

	@Override
	protected List buildDetachedTimestamps() {
		return Collections.singletonList(getTimestamp());
	}

	@Override
	public TimestampToken getTimestamp() {
		if (timestampToken == null) {
			timestampToken = createTimestampToken();

			List timestampScopes = getTimestampScopes(timestampToken);
			timestampToken.setTimestampScopes(getTimestampScopes(timestampToken));
			timestampToken.getTimestampedReferences().addAll(getTimestampedReferences(timestampScopes));
		}
		return timestampToken;
	}

	/**
	 * This method creates a timestamp token from the validating document
	 *
	 * @return {@link TimestampToken}
	 */
	protected TimestampToken createTimestampToken() {
		Objects.requireNonNull(certificateVerifier, "CertificateVerifier is not defined");
		Objects.requireNonNull(document, "The timestampFile must be defined!");
		Objects.requireNonNull(timestampType, "The TimestampType must be defined!");
		try {
			final TimestampToken newTimestampToken = new TimestampToken(DSSUtils.toByteArray(document), timestampType);
			newTimestampToken.setFileName(document.getName());
			newTimestampToken.matchData(getTimestampedData());
			return newTimestampToken;

		} catch (CMSException | TSPException | IOException e) {
			throw new DSSException(String.format("Unable to create a TimestampToken. Reason : %s", e.getMessage()), e);

		}
	}

	@Override
	public void setValidationLevel(ValidationLevel validationLevel) {
		if (ValidationLevel.BASIC_SIGNATURES == validationLevel) {
			throw new IllegalArgumentException("Minimal level is " + ValidationLevel.TIMESTAMPS);
		}
		super.setValidationLevel(validationLevel);
	}

	/**
	 * Sets the data that has been timestamped
	 *
	 * @param document {@link DSSDocument} timestamped data
	 */
	public void setTimestampedData(DSSDocument document) {
		Objects.requireNonNull(document, "The document is null");
		setDetachedContents(Arrays.asList(document));
	}

	@Override
	public DSSDocument getTimestampedData() {
		int size = Utils.collectionSize(detachedContents);
		if (size == 0) {
			return null;
		} else if (size > 1) {
			throw new IllegalArgumentException("Only one detached document shall be provided for a timestamp validation!");
		}
		return detachedContents.iterator().next();
	}

	/**
	 * Finds timestamp scopes
	 *
	 * @param timestampToken {@link TimestampToken}
	 * @return a list of {@link SignatureScope}s
	 */
	protected List getTimestampScopes(TimestampToken timestampToken) {
		DetachedTimestampScopeFinder timestampScopeFinder = new DetachedTimestampScopeFinder();
		timestampScopeFinder.setTimestampedData(getTimestampedData());
		return timestampScopeFinder.findTimestampScope(timestampToken);
	}

	@Override
	public List getOriginalDocuments(String signatureId) {
		// TODO
		throw new UnsupportedOperationException();
	}

	@Override
	public List getOriginalDocuments(AdvancedSignature advancedSignature) {
		throw new UnsupportedOperationException("getOriginalDocuments(AdvancedSignature) is " +
				"not supported for DetachedTimestampValidator!");
	}

}