package at.gv.egiz.eid.authhandler.modules.sigverify.moasig.api;

import java.util.List;

import at.gv.egiz.eid.authhandler.modules.sigverify.moasig.api.data.ICmsSignatureVerificationResponse;
import at.gv.egiz.eid.authhandler.modules.sigverify.moasig.api.data.IXmlSignatureVerificationResponse;
import at.gv.egiz.eid.authhandler.modules.sigverify.moasig.exceptions.MoaSigServiceException;

public interface ISignatureVerificationService {

  /**
   * Verify a CAdES or CMS signature. <br>
   * <br>
   * <i>This method only validates the first CMS or CAdES signature if more than
   * one signature exists</i>
   *
   * @param signature      Enveloped CMS or CAdES signature
   * @param trustProfileID Id of the Trust-Profile from MOA-Sig configuration
   * @return @link {@link ICmsSignatureVerificationResponse}, or null if no
   *         signature was found
   * @throws MoaSigServiceException on signatue-verification error
   */
  ICmsSignatureVerificationResponse verifyCmsSignature(byte[] signature, String trustProfileID)
      throws MoaSigServiceException;

  /**
   * Verify a XML or XAdES signature. <br>
   * <br>
   * <i>This method only validates the first XML or XAdES signature if more than
   * one signature exists</i>
   *
   * @param signature      Serialized XML or XAdES signature
   * @param trustProfileID Id of the Trust-Profile from MOA-Sig configuration
   * @return @link {@link IXmlSignatureVerificationResponse}, or null if no
   *         signature was found
   * @throws MoaSigServiceException on signatue-verification error
   */
  IXmlSignatureVerificationResponse verifyXmlSignature(byte[] signature, String trustProfileID)
      throws MoaSigServiceException;

  /**
   * Verify a XML or XAdES signature. <br>
   * <br>
   * <i>This method only validates the first XML or XAdES signature if more than
   * one signature exists</i>
   *
   * @param signature                     Serialized XML or XAdES signature
   * @param trustProfileID                Id of the Trust-Profile from MOA-Sig
   *                                      configuration
   * @param verifyTransformsInfoProfileID {@link List} of XML Transformations that
   *                                      should be used for
   *                                      signature-verification
   * @return @link {@link IXmlSignatureVerificationResponse}, or null if no
   *         signature was found
   * @throws MoaSigServiceException on signatue-verification error
   */
  IXmlSignatureVerificationResponse verifyXmlSignature(byte[] signature, String trustProfileID,
      List<String> verifyTransformsInfoProfileID) throws MoaSigServiceException;

  /**
   * Verify a XML or XAdES signature. <br>
   * <br>
   * <i>This method only validates the first XML or XAdES signature if more than
   * one signature exists</i>
   *
   * @param signature              Serialized XML or XAdES signature
   * @param trustProfileID         Id of the Trust-Profile from MOA-Sig
   *                               configuration
   * @param signatureLocationXpath Xpath that points to location of Signature
   *                               element
   * @return @link {@link IXmlSignatureVerificationResponse}, or null if no
   *         signature was found
   * @throws MoaSigServiceException on signatue-verification error
   */
  IXmlSignatureVerificationResponse verifyXmlSignature(byte[] signature, String trustProfileID,
      String signatureLocationXpath) throws MoaSigServiceException;

  /**
   * Verify a XML or XAdES signature. <br>
   * <br>
   * <i>This method only validates the first XML or XAdES signature if more than
   * one signature exists</i>
   *
   * @param signature                     Serialized XML or XAdES signature
   * @param trustProfileID                Id of the Trust-Profile from MOA-Sig
   *                                      configuration
   * @param verifyTransformsInfoProfileID {@link List} of XML Transformations that
   *                                      should be used for
   *                                      signature-verification
   * @param signatureLocationXpath        Xpath that points to location of
   *                                      Signature element
   * @return @link {@link IXmlSignatureVerificationResponse}, or null if no
   *         signature was found
   * @throws MoaSigServiceException on signatue-verification error
   */
  IXmlSignatureVerificationResponse verifyXmlSignature(byte[] signature, String trustProfileID,
      List<String> verifyTransformsInfoProfileID, String signatureLocationXpath)
      throws MoaSigServiceException;

}