se.swedenconnect.signservice.protocol.SignRequestMessage Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signservice-core Show documentation
SignService Core Library
There is a newer version: 1.1.3
/*
 * Copyright 2022-2024 Sweden Connect
 *
 * 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.swedenconnect.signservice.protocol;

import java.io.Serializable;
import java.security.SignatureException;
import java.security.cert.X509Certificate;
import java.time.Instant;
import java.util.List;

import jakarta.annotation.Nonnull;
import se.swedenconnect.signservice.protocol.msg.AuthnRequirements;
import se.swedenconnect.signservice.protocol.msg.MessageConditions;
import se.swedenconnect.signservice.protocol.msg.SignMessage;
import se.swedenconnect.signservice.protocol.msg.SignatureRequirements;
import se.swedenconnect.signservice.protocol.msg.SigningCertificateRequirements;
import se.swedenconnect.signservice.signature.RequestedSignatureTask;

/**
 * A generic representation of a signature request message.
 */
public interface SignRequestMessage extends Serializable {

  /**
   * Gets the protocol processing requirements this type of message.
   *
   * @return processing requirements
   */
  ProtocolProcessingRequirements getProcessingRequirements();

  /**
   * Tells whether the message has been signed.
   *
   * @return true if the message is signed, and false otherwise
   */
  boolean isSigned();

  /**
   * Verifies the signature of the message.
   * 
   * Invoking this method on a message that is not signed will lead to an error.
   * 
   * 
   * Note that there is a direct trust regarding expected signing certificates. Thus, the validator does not perform any
   * certificate chain building to find a trusted certificate.
   * 
   *
   * @param certificates a list of certificates that are acceptable as signer certificates.
   * @throws SignatureException for signature validation errors
   */
  void verifySignature(final List certificates) throws SignatureException;

  /**
   * Gets the "relay state" parameter that is associated with the message.
   *
   * @return the relay state parameter, or null if not available
   */
  String getRelayState();

  /**
   * Gets the unique identifier for the request message.
   *
   * @return the request ID
   */
  String getRequestId();

  /**
   * Gets the issuance instant for the message.
   *
   * @return the issuance instant
   */
  Instant getIssuedAt();

  /**
   * Gets the unique identifier of the SignService client that sent this message.
   *
   * @return the client id
   */
  String getClientId();

  /**
   * Gets the URL where the client wants response messages to be sent. This information may also be configured at the
   * SignService.
   *
   * @return the URL, or null if the protocol implementation does not support this feature
   */
  String getResponseUrl();

  /**
   * Gets the SignService ID from the message. This is the ID of the receiving SignService.
   *
   * @return the SignService id
   */
  String getSignServiceId();

  /**
   * Gets the conditions for the message imposed by the issuer.
   *
   * @return conditions, or null if none are available
   */
  MessageConditions getConditions();

  /**
   * Gets the requirements the signature requester (client) puts on how the user should be authenticated during the
   * "authentication for signature" process.
   *
   * @return authentication requirements
   */
  AuthnRequirements getAuthnRequirements();

  /**
   * Gets the "sign message". The sign message is a protocol specific extension that will be passed on
   * to the authentication service.
   *
   * @return the sign message, or null if no sign message has been supplied
   */
  SignMessage getSignMessage();

  /**
   * Gets the specific signature requirements for this request.
   *
   * @return signature requirements
   */
  @Nonnull
  SignatureRequirements getSignatureRequirements();

  /**
   * Gets the requirements for how the generated signing certificate should be created.
   *
   * @return signing certificate requirements
   */
  SigningCertificateRequirements getSigningCertificateRequirements();

  /**
   * Gets the signature tasks, i.e., the to-be-signed data.
   *
   * @return a list of signature tasks
   */
  List getSignatureTasks();

}