se.idsec.signservice.security.sign.pdf.impl.DefaultPDFSignatureValidationResult Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of signservice-pdf-commons Show documentation

SignService PDF Commons

There is a newer version: 2.1.1

Show newest version

/*
 * Copyright 2019-2024 IDsec Solutions AB
 *
 * Licensed 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.
 */
package se.idsec.signservice.security.sign.pdf.impl;

import org.apache.pdfbox.pdmodel.interactive.digitalsignature.PDSignature;
import se.idsec.signservice.security.sign.impl.DefaultSignatureValidationResult;
import se.idsec.signservice.security.sign.pdf.PDFSignatureValidationResult;

/**
 * Implementation of the {@link PDFSignatureValidationResult} interface.
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
public class DefaultPDFSignatureValidationResult extends DefaultSignatureValidationResult
    implements PDFSignatureValidationResult {

  /** The PDF signature. */
  private PDSignature pdfSignature;

  /** Tells if the signature has the CMS algorithm protection signed attribute set. */
  private boolean cmsAlgorithmProtection = false;

  /**
   * Constructor.
   */
  public DefaultPDFSignatureValidationResult() {
  }

  /** {@inheritDoc} */
  @Override
  public PDSignature getPdfSignature() {
    return this.pdfSignature;
  }

  /**
   * Assigns the PDF signature object (that was validated).
   *
   * @param pdfSignature the PDF signature object
   */
  public void setPdfSignature(final PDSignature pdfSignature) {
    this.pdfSignature = pdfSignature;
  }

  /** {@inheritDoc} */
  @Override
  public boolean isCmsAlgorithmProtection() {
    return this.cmsAlgorithmProtection;
  }

  /**
   * Assigns the flag that tells if the signature has the CMS algorithm protection signed attribute set. The default is
   * {@code false}.
   *
   * @param cmsAlgorithmProtection flag telling if the signature has the CMS algorithm protection signed attribute
   *     set
   */
  public void setCmsAlgorithmProtection(final boolean cmsAlgorithmProtection) {
    this.cmsAlgorithmProtection = cmsAlgorithmProtection;
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    return "%s, pdf-signature=<%s>, claimed-signing-time='%s', signature-aAlgorithm='%s', cms-algorithm-protection='%s', is-pades='%s'"
        .formatted(super.toString(), this.pdfSignature != null ? "set" : "not set", this.getClaimedSigningTime(),
            this.getSignatureAlgorithm(), this.cmsAlgorithmProtection, this.isEtsiAdes());
  }

}