se.idsec.signservice.integration.process.SignResponseProcessingConfig Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of signservice-integration-impl Show documentation
SignService Integration API
The newest version!
/*
 * Copyright 2019-2022 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.integration.process;

import lombok.Getter;
import lombok.Setter;
import lombok.ToString;
import se.idsec.signservice.integration.SignResponseProcessingParameters;

/**
 * Configuration for processing a {@code SignResponse} message. This class represents the "static" configuration
 * settings. Also see the {@link SignResponseProcessingParameters} class that is parameters supplied by the caller.
 *
 * @author Martin Lindström ([email protected])
 * @author Stefan Santesson ([email protected])
 */
@ToString
public class SignResponseProcessingConfig {

  /** The default for the maximum allowed age for a response given in milliseconds. 3 minutes. */
  public final static long DEFAULT_MAXIMUM_ALLOWED_RESPONSE_AGE = 180000L;

  /**
   * The default for the allowed number of milliseconds that we allow our clock to differ from the SignService clock. 1
   * minute.
   */
  public static final long DEFAULT_ALLOWED_CLOCK_SKEW = 60000L;

  /** The default time we allow for processing at the server side. Default is 10 minutes. */
  public static final long DEFAULT_MAXIMUM_ALLOWED_PROCESSING_TIME = 600000L;

  /**
   * Flag that tells whether the processing and validation steps should be "extra" strict and look for every little
   * thing that deviates from the specifications. The default is {@code false}. Turning on this setting is mainly
   * intended for testing of a SignService, and should not be active in a production setup.
   */
  @Getter
  @Setter
  private boolean strictProcessing = false;

  /**
   * The maximum allowed age for a response given in milliseconds. The default is
   * {@value #DEFAULT_MAXIMUM_ALLOWED_RESPONSE_AGE}.
   */
  @Getter
  @Setter
  private long maximumAllowedResponseAge = DEFAULT_MAXIMUM_ALLOWED_RESPONSE_AGE;

  /**
   * The allowed number of milliseconds that we allow our clock to differ from the SignService clock. The default is
   * {@value #DEFAULT_ALLOWED_CLOCK_SKEW}.
   */
  @Getter
  @Setter
  private long allowedClockSkew = DEFAULT_ALLOWED_CLOCK_SKEW;

  /**
   * The allowed number of milliseconds that we allow processing at the server side to go on, that is, the time from
   * when we sent the request until we received the response.
   */
  @Getter
  @Setter
  private long maximumAllowedProcessingTime = DEFAULT_MAXIMUM_ALLOWED_PROCESSING_TIME;

  /**
   * Flag telling whether we require the assertion from where the user authenticated for signature to be present in the
   * sign response. The default is {@code false}.
   */
  @Getter
  @Setter
  private boolean requireAssertion = false;

  /**
   * A {@code SignResponseProcessingConfig} with default settings.
   *
   * @return default config settings
   */
  public static SignResponseProcessingConfig defaultSignResponseProcessingConfig() {
    return new SignResponseProcessingConfig();
  }

}