eu.europa.esig.dss.AbstractSignatureParametersBuilder 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;

import eu.europa.esig.dss.enumerations.DigestAlgorithm;
import eu.europa.esig.dss.enumerations.EncryptionAlgorithm;
import eu.europa.esig.dss.enumerations.MaskGenerationFunction;
import eu.europa.esig.dss.model.BLevelParameters;
import eu.europa.esig.dss.model.SignatureParametersBuilder;
import eu.europa.esig.dss.model.x509.CertificateToken;

import java.util.LinkedList;
import java.util.List;

/**
 * An abstract class to build a signature parameters instance
 *
 * @param  {@code AbstractSignatureParameters}
 */
@SuppressWarnings("rawtypes")
public abstract class AbstractSignatureParametersBuilder implements SignatureParametersBuilder {
	
	/**
	 * A signing certificate to be used for a signature creation
	 */
	private final CertificateToken signingCertificate;

	/**
	 * A certificate chain of the signing certificate
	 */
	private List certificateChain;

	/**
	 * The encryption algorithm used for a signature creation by the current signing-certificate
	 */
	private EncryptionAlgorithm encryptionAlgorithm;

	/**
	 * The digest algorithm used to hash signed data on signing
	 */
	private DigestAlgorithm digestAlgorithm;

	/**
	 * The mask generation function used on signing
	 */
	private MaskGenerationFunction maskGenerationFunction;
	
	/**
	 * BLevelParameters
	 */
	private BLevelParameters bLevelParams = new BLevelParameters();
	
	/**
	 * The default constructor
	 * 
	 * @param signingCertificate {@link CertificateToken}
	 */
	protected AbstractSignatureParametersBuilder(CertificateToken signingCertificate) {
		this(signingCertificate, new LinkedList<>());
	}

	/**
	 * A constructor with a certificateChain
	 * 
	 * @param signingCertificate {@link CertificateToken}
	 * @param certificateChain a list of {@link CertificateToken}s
	 */
	protected AbstractSignatureParametersBuilder(CertificateToken signingCertificate, List certificateChain) {
		this.signingCertificate = signingCertificate;
		this.certificateChain = certificateChain;
	}
	
	/**
	 * Initialize and return empty signature parameters
	 * 
	 * @return {@code SP} signature parameters
	 */
	protected abstract SP initParameters();
	
	/**
	 * Sets an encryption algorithm used by the signing-certificate's key pair.
	 *
	 * @param encryptionAlgorithm {@link EncryptionAlgorithm}
	 * @return this {@link AbstractSignatureParametersBuilder}
	 */
	public AbstractSignatureParametersBuilder setEncryptionAlgorithm(EncryptionAlgorithm encryptionAlgorithm) {
		this.encryptionAlgorithm = encryptionAlgorithm;
		return this;
	}

	/**
	 * Sets a digest algorithm to be used to hash the signed data
	 *
	 * @param digestAlgorithm {@link DigestAlgorithm}
	 * @return this {@link AbstractSignatureParametersBuilder}
	 */
	public AbstractSignatureParametersBuilder setDigestAlgorithm(DigestAlgorithm digestAlgorithm) {
		this.digestAlgorithm = digestAlgorithm;
		return this;
	}

	/**
	 * Sets a mask generation function, when required
	 *
	 * @param maskGenerationFunction {@link MaskGenerationFunction}
	 * @return this {@link AbstractSignatureParametersBuilder}
	 */
	public AbstractSignatureParametersBuilder setMaskGenerationFunction(MaskGenerationFunction maskGenerationFunction) {
		this.maskGenerationFunction = maskGenerationFunction;
		return this;
	}

	/**
	 * Returns {@code BLevelParameters}
	 * 
	 * @return {@link BLevelParameters}
	 */
	public BLevelParameters bLevel() {
		return bLevelParams;
	}

	/**
	 * Sets a BLevelParameters (e.g. a SigningDate)
	 * 
	 * @param bLevelParams {@link BLevelParameters} to be used
	 * @return the builder
	 */
	public AbstractSignatureParametersBuilder setBLevelParams(BLevelParameters bLevelParams) {
		this.bLevelParams = bLevelParams;
		return this;
	}
	
	@Override
	@SuppressWarnings("unchecked")
	public SP build() {
		final SP signatureParameters = initParameters();
		signatureParameters.setSigningCertificate(signingCertificate);
		signatureParameters.setCertificateChain(certificateChain);
		signatureParameters.setBLevelParams(bLevelParams);
		if (encryptionAlgorithm != null) {
			signatureParameters.setEncryptionAlgorithm(encryptionAlgorithm);
		}
		if (digestAlgorithm != null) {
			signatureParameters.setDigestAlgorithm(digestAlgorithm);
		}
		if (maskGenerationFunction != null) {
			signatureParameters.setMaskGenerationFunction(maskGenerationFunction);
		}
		return signatureParameters;
	}

}