se.swedenconnect.opensaml.saml2.response.validation.ResponseValidationSettings Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-addons Show documentation
OpenSAML 5.X utility extension library
The newest version!
/*
 * Copyright 2016-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.opensaml.saml2.response.validation;

import java.time.Duration;
import java.util.Optional;

/**
 * Configuration settings for response and assertion validation.
 *
 * @author Martin Lindström ([email protected])
 */
public class ResponseValidationSettings {

  /** The default allowed clock skew (in milliseconds) - 30 seconds. */
  public static final Duration DEFAULT_ALLOWED_CLOCK_SKEW = Duration.ofSeconds(30);

  /** The default age for a response message that we allow (in milliseconds) - 3 minutes. */
  public static final Duration DEFAULT_MAX_AGE_RESPONSE = Duration.ofMinutes(3);

  /** Default max session age (in milliseconds) - 1 hour. */
  public static final Duration DEFAULT_MAX_SESSION_AGE = Duration.ofHours(1);

  /** The allowed clock skew (in milliseconds). */
  private Duration allowedClockSkew;

  /** Maximum allowed "age" of a response message (in milliseconds). */
  private Duration maxAgeResponse;

  /** Maximum session age allowed for SSO (in milliseconds). */
  private Duration maxSessionAge;

  /** Should validation be strict? Default is false. */
  private boolean strictValidation = false;

  /** Is signed assertions required? */
  private boolean requireSignedAssertions = false;

  /**
   * Returns the allowed clock skew.
   * 
   * The default is {@link #DEFAULT_ALLOWED_CLOCK_SKEW}.
   * 
   *
   * @return the allowed clock skew
   */
  public Duration getAllowedClockSkew() {
    return Optional.ofNullable(this.allowedClockSkew).orElse(DEFAULT_ALLOWED_CLOCK_SKEW);
  }

  /**
   * Assigns the allowed clock skew.
   * 
   * The default is {@link #DEFAULT_ALLOWED_CLOCK_SKEW}.
   * 
   *
   * @param allowedClockSkew the allowed clock skew
   */
  public void setAllowedClockSkew(final Duration allowedClockSkew) {
    this.allowedClockSkew = allowedClockSkew;
  }

  /**
   * Returns the maximum allowed "age" of a response message.
   * 
   * The default is {@link #DEFAULT_MAX_AGE_RESPONSE}.
   * 
   *
   * @return the maximum allowed "age" of a response message
   */
  public Duration getMaxAgeResponse() {
    return Optional.ofNullable(this.maxAgeResponse).orElse(DEFAULT_MAX_AGE_RESPONSE);
  }

  /**
   * Assigns the maximum allowed "age" of a response message
   * 
   * The default is {@link #DEFAULT_MAX_AGE_RESPONSE}.
   * 
   *
   * @param maxAgeResponse the maximum allowed "age" of a response message
   */
  public void setMaxAgeResponse(final Duration maxAgeResponse) {
    this.maxAgeResponse = maxAgeResponse;
  }

  /**
   * Returns the maximum session age allowed for SSO.
   * 
   * The default is {@link #DEFAULT_MAX_SESSION_AGE}.
   * 
   *
   * @return the maximum session age allowed for SSO
   */
  public Duration getMaxSessionAge() {
    return Optional.ofNullable(this.maxSessionAge).orElse(DEFAULT_MAX_SESSION_AGE);
  }

  /**
   * Assigns the maximum session age allowed for SSO.
   * 
   * The default is {@link #DEFAULT_MAX_SESSION_AGE}.
   * 
   *
   * @param maxSessionAge the maximum session age allowed for SSO
   */
  public void setMaxSessionAge(final Duration maxSessionAge) {
    this.maxSessionAge = maxSessionAge;
  }

  /**
   * Predicate telling whether strict validation should be performed.
   * 
   * The default is {@code false}.
   * 
   *
   * @return whether strict validation should be performed
   */
  public boolean isStrictValidation() {
    return this.strictValidation;
  }

  /**
   * Assigns telling whether strict validation should be performed.
   * 
   * The default is {@code false}.
   * 
   *
   * @param strictValidation whether strict validation should be performed
   */
  public void setStrictValidation(final boolean strictValidation) {
    this.strictValidation = strictValidation;
  }

  /**
   * Do we require signed assertions?
   * 
   * Should correspond the {@code WantAssertionsSigned} of the SP metadata.
   * 
   *
   * @return do we require signed assertions?
   */
  public boolean isRequireSignedAssertions() {
    return this.requireSignedAssertions;
  }

  /**
   * Assigns whether we require signed assertions.
   * 
   * Should correspond the {@code WantAssertionsSigned} of the SP metadata.
   * 
   *
   * @param requireSignedAssertions whether we require signed assertions?
   */
  public void setRequireSignedAssertions(final boolean requireSignedAssertions) {
    this.requireSignedAssertions = requireSignedAssertions;
  }

  /** {@inheritDoc} */
  @Override
  public String toString() {
    return String.format(
        "allowedClockSkew=%s, maxAgeResponse=%s, maxSessionAge=%s, strictValidation=%s, requireSignedAssertions=%s",
        this.allowedClockSkew, this.maxAgeResponse, this.maxSessionAge, this.strictValidation,
        this.requireSignedAssertions);
  }

}