se.swedenconnect.opensaml.saml2.response.validation.AbstractResponseValidationParametersBuilder 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 org.opensaml.saml.common.assertion.ValidationContext;
import org.opensaml.saml.saml2.assertion.SAML2AssertionValidationParameters;
import org.opensaml.saml.saml2.core.AuthnRequest;
import se.swedenconnect.opensaml.common.validation.AbstractValidationParametersBuilder;
import se.swedenconnect.opensaml.common.validation.CoreValidatorParameters;

import java.util.Collections;

/**
 * Abstract builder class for building the {@link ValidationContext} object for use as validation input to the
 * {@link ResponseValidator}.
 *
 * 
 * The reason for all fiddling with generics is that we want to be able to subclass the builder classes.
 * 
 *
 * @author Martin Lindström ([email protected])
 */
public abstract class AbstractResponseValidationParametersBuilder>
    extends AbstractValidationParametersBuilder {

  /**
   * Assigns the URL on which the message was received.
   *
   * @param receiveUrl the URL
   * @return the builder
   */
  public T receiveUrl(final String receiveUrl) {
    return this.staticParameter(CoreValidatorParameters.RECEIVE_URL, receiveUrl);
  }

  /**
   * Assigns the expected issuer to be used when checking the issuer of an element.
   *
   * @param expectedIssuer the issuer entityID
   * @return the builder
   */
  public T expectedIssuer(final String expectedIssuer) {
    if (expectedIssuer != null) {
      this.addStaticParameterIfMissing(
          SAML2AssertionValidationParameters.VALID_ISSUERS, Collections.singleton(expectedIssuer));
    }
    return this.staticParameter(CoreValidatorParameters.EXPECTED_ISSUER, expectedIssuer);
  }

  /**
   * Assigns the {@code AuthnRequest} that was sent to give the message we are validating.
   *
   * @param authnRequest an AuthnRequest message
   * @return the builder
   */
  public T authnRequest(final AuthnRequest authnRequest) {
    if (authnRequest != null && authnRequest.getID() != null) {
      this.authnRequestID(authnRequest.getID());
    }
    return this.staticParameter(CoreValidatorParameters.AUTHN_REQUEST, authnRequest);
  }

  /**
   * Assigns the ID of the {@code AuthnRequest} that was sent to give the message we are validating.
   *
   * @param authnRequestID ID
   * @return the builder
   */
  public T authnRequestID(final String authnRequestID) {
    if (authnRequestID != null) {
      this.addStaticParameter(SAML2AssertionValidationParameters.SC_VALID_IN_RESPONSE_TO, authnRequestID);
      this.addStaticParameter(SAML2AssertionValidationParameters.SC_IN_RESPONSE_TO_REQUIRED, Boolean.TRUE);
    }

    return this.staticParameter(CoreValidatorParameters.AUTHN_REQUEST_ID, authnRequestID);
  }

}