eu.europa.esig.dss.cades.signature.CAdESLevelBaselineLTA.java Source code

Java tutorial

Introduction

Here is the source code for eu.europa.esig.dss.cades.signature.CAdESLevelBaselineLTA.java

Source

/**
 * 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.cades.signature;

import java.io.ByteArrayInputStream;
import java.io.InputStream;

import org.bouncycastle.asn1.ASN1Object;
import org.bouncycastle.asn1.cms.Attribute;
import org.bouncycastle.asn1.cms.AttributeTable;
import org.bouncycastle.cms.CMSSignedData;
import org.bouncycastle.cms.CMSTypedData;
import org.bouncycastle.cms.SignerInformation;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import eu.europa.esig.dss.DSSDocument;
import eu.europa.esig.dss.DSSException;
import eu.europa.esig.dss.DigestAlgorithm;
import eu.europa.esig.dss.OID;
import eu.europa.esig.dss.cades.CAdESSignatureParameters;
import eu.europa.esig.dss.cades.CMSUtils;
import eu.europa.esig.dss.cades.validation.CAdESSignature;
import eu.europa.esig.dss.validation.CertificateVerifier;
import eu.europa.esig.dss.x509.tsp.TSPSource;

/**
 * This class holds the CAdES-A signature profiles; it supports the later, over time _extension_ of a signature with
 * id-aa-ets-archiveTimestampV2 attributes as defined in ETSI TS 101 733 V1.8.1, clause 6.4.1.
 *
 * "If the certificate-values and revocation-values attributes are not present in the CAdES-BES or CAdES-EPES, then they
 * shall be added to the electronic signature prior to computing the archive time-stamp token." is the reason we extend
 * from the XL profile.
 *
 *
 */

public class CAdESLevelBaselineLTA extends CAdESSignatureExtension {

    private static final Logger LOG = LoggerFactory.getLogger(CAdESLevelBaselineLTA.class);

    private final CAdESLevelBaselineLT cadesProfileLT;
    private final CertificateVerifier certificateVerifier;

    public CAdESLevelBaselineLTA(TSPSource signatureTsa, CertificateVerifier certificateVerifier,
            boolean onlyLastSigner) {
        super(signatureTsa, onlyLastSigner);
        cadesProfileLT = new CAdESLevelBaselineLT(signatureTsa, certificateVerifier, onlyLastSigner);
        this.certificateVerifier = certificateVerifier;
    }

    @Override
    protected CMSSignedData preExtendCMSSignedData(CMSSignedData cmsSignedData,
            CAdESSignatureParameters parameters) {
        return cadesProfileLT.extendCMSSignatures(cmsSignedData, parameters);
    }

    @Override
    protected SignerInformation extendCMSSignature(final CMSSignedData cmsSignedData,
            SignerInformation signerInformation, final CAdESSignatureParameters parameters) throws DSSException {

        CAdESSignature cadesSignature = new CAdESSignature(cmsSignedData, signerInformation);
        cadesSignature.setDetachedContents(parameters.getDetachedContent());
        AttributeTable unsignedAttributes = CMSUtils.getUnsignedAttributes(signerInformation);
        unsignedAttributes = addArchiveTimestampV3Attribute(cadesSignature, cmsSignedData, signerInformation,
                parameters, unsignedAttributes);
        SignerInformation newSignerInformation = SignerInformation.replaceUnsignedAttributes(signerInformation,
                unsignedAttributes);
        return newSignerInformation;
    }

    /**
     * The input for the archive-time-stamp-v3s message imprint computation shall be the concatenation (in the
     * order shown by the list below) of the signed data hash (see bullet 2 below) and certain fields in their binary encoded
     * form without any modification and including the tag, length and value octets:
     * <ol>
     * <li>The SignedData.encapContentInfo.eContentType.
     * <li>The octets representing the hash of the signed data. The hash is computed on the same content that was used
     * for computing the hash value that is encapsulated within the message-digest signed attribute of the
     * CAdES signature being archive-time-stamped. The hash algorithm applied shall be the same as the hash
     * algorithm used for computing the archive time-stamps message imprint. The inclusion of the hash algorithm
     * in the SignedData.digestAlgorithms set is recommended.
     * <li>Fields version, sid, digestAlgorithm, signedAttrs, signatureAlgorithm, and
     * signature within the SignedData.signerInfoss item corresponding to the signature being archive
     * time-stamped, in their order of appearance.
     * <li>A single instance of ATSHashIndex type (created as specified in clause 6.4.2).
     * </ol>
     *
     * @param cadesSignature
     * @param cmsSignedData
     * @param signerInformation
     * @param parameters
     * @param unsignedAttributes
     * @throws eu.europa.esig.dss.DSSException
     */
    private AttributeTable addArchiveTimestampV3Attribute(CAdESSignature cadesSignature,
            CMSSignedData cmsSignedData, SignerInformation signerInformation, CAdESSignatureParameters parameters,
            AttributeTable unsignedAttributes) throws DSSException {

        final CadesLevelBaselineLTATimestampExtractor timestampExtractor = new CadesLevelBaselineLTATimestampExtractor(
                cadesSignature);
        final DigestAlgorithm timestampDigestAlgorithm = parameters.getSignatureTimestampParameters()
                .getDigestAlgorithm();
        final Attribute atsHashIndexAttribute = timestampExtractor.getAtsHashIndex(signerInformation,
                timestampDigestAlgorithm);

        final InputStream originalDocumentBytes = getOriginalDocumentBytes(cmsSignedData, parameters);

        final byte[] encodedToTimestamp = timestampExtractor.getArchiveTimestampDataV3(signerInformation,
                atsHashIndexAttribute, originalDocumentBytes, timestampDigestAlgorithm);

        final ASN1Object timeStampAttributeValue = getTimeStampAttributeValue(signatureTsa, encodedToTimestamp,
                timestampDigestAlgorithm, atsHashIndexAttribute);

        final AttributeTable newUnsignedAttributes = unsignedAttributes.add(OID.id_aa_ets_archiveTimestampV3,
                timeStampAttributeValue);
        return newUnsignedAttributes;
    }

    /**
     * Returns the original document which is signed, either from cmsSignedData if possible, or from {@code parameters.getDetachedContent()}
     *
     * @param cmsSignedData
     * @param parameters
     * @return
     * @throws eu.europa.esig.dss.DSSException
     */
    private InputStream getOriginalDocumentBytes(CMSSignedData cmsSignedData, CAdESSignatureParameters parameters)
            throws DSSException {

        final CMSTypedData signedContent = cmsSignedData.getSignedContent();
        if (signedContent != null) {
            return new ByteArrayInputStream(CMSUtils.getSignedContent(signedContent));
        }
        final DSSDocument detachedContent = parameters.getDetachedContent();
        if (detachedContent == null) {
            throw new DSSException("In the case of detached signature the detached content must be set!");
        }
        return detachedContent.openStream();
    }
}