se.swedenconnect.opensaml.sweid.saml2.validation.SwedishEidAssertionValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of opensaml-swedish-eid Show documentation
OpenSAML 5.X extension library for the Swedish eID Framework
There is a newer version: 2.2.2
/*
 * 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.sweid.saml2.validation;

import java.net.InetAddress;
import java.util.Arrays;
import java.util.Collection;
import java.util.List;
import java.util.Optional;

import org.opensaml.saml.common.assertion.ValidationContext;
import org.opensaml.saml.common.assertion.ValidationResult;
import org.opensaml.saml.saml1.core.AttributeStatement;
import org.opensaml.saml.saml2.assertion.ConditionValidator;
import org.opensaml.saml.saml2.assertion.SAML2AssertionValidationParameters;
import org.opensaml.saml.saml2.assertion.StatementValidator;
import org.opensaml.saml.saml2.assertion.SubjectConfirmationValidator;
import org.opensaml.saml.saml2.assertion.impl.AudienceRestrictionConditionValidator;
import org.opensaml.saml.saml2.assertion.impl.BearerSubjectConfirmationValidator;
import org.opensaml.saml.saml2.assertion.impl.HolderOfKeySubjectConfirmationValidator;
import org.opensaml.saml.saml2.core.Assertion;
import org.opensaml.saml.saml2.core.AuthnStatement;
import org.opensaml.saml.saml2.core.NameID;
import org.opensaml.saml.saml2.core.SubjectConfirmation;
import org.opensaml.xmlsec.signature.support.SignaturePrevalidator;
import org.opensaml.xmlsec.signature.support.SignatureTrustEngine;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import se.swedenconnect.opensaml.saml2.assertion.validation.AssertionValidator;

/**
 * An assertion validator that makes checks based on what is required by the Swedish eID Framework.
 *
 * 
 * Apart from the validation parameters documented for {@link AssertionValidator}, the following static parameters are
 * handled:
 * 
 *
 * 
 * {@link SAML2AssertionValidationParameters#SC_VALID_ADDRESSES}: Optional. If the set of {@link InetAddress}
 * objects are given, the Address-attribute found in the Subject confirmation will be compared against these.
 * {@link SAML2AssertionValidationParameters#SC_VALID_RECIPIENTS}: Required. A set of valid recipient URL:s.
 * {@link SAML2AssertionValidationParameters#COND_VALID_AUDIENCES}: Required. A set of valid audiences of the
 * assertion.
 * 
 *
 * @author Martin Lindström ([email protected])
 */
public class SwedishEidAssertionValidator extends AssertionValidator {

  /** Class logger. */
  private final Logger log = LoggerFactory.getLogger(SwedishEidAssertionValidator.class);

  /**
   * Constructor setting up the validator with the following validators:
   * 
   * confirmationValidators: {@link BearerSubjectConfirmationValidator},
   * {@link HolderOfKeySubjectConfirmationValidator}
   * conditionValidators: {@link AudienceRestrictionConditionValidator}
   * statementValidators: {@link SwedishEidAuthnStatementValidator},
   * {@link SwedishEidAttributeStatementValidator}.
   * 
   *
   * @param trustEngine the trust used to validate the object's signature
   * @param signaturePrevalidator the signature pre-validator used to pre-validate the object's signature
   */
  public SwedishEidAssertionValidator(final SignatureTrustEngine trustEngine,
      final SignaturePrevalidator signaturePrevalidator) {
    this(trustEngine, signaturePrevalidator,
        Arrays.asList(new BearerSubjectConfirmationValidator(), new HolderOfKeySubjectConfirmationValidator()),
        Arrays.asList(new AudienceRestrictionConditionValidator()),
        Arrays.asList(new SwedishEidAuthnStatementValidator(), new SwedishEidAttributeStatementValidator()));
  }

  /**
   * Constructor.
   *
   * @param trustEngine the trust used to validate the object's signature
   * @param signaturePrevalidator the signature pre-validator used to pre-validate the object's signature
   * @param confirmationValidators validators used to validate SubjectConfirmation methods within the assertion
   * @param conditionValidators validators used to validate the Condition elements within the assertion
   * @param statementValidators validators used to validate Statements within the assertion
   */
  public SwedishEidAssertionValidator(
      final SignatureTrustEngine trustEngine,
      final SignaturePrevalidator signaturePrevalidator,
      final Collection confirmationValidators,
      final Collection conditionValidators,
      final Collection statementValidators) {

    super(trustEngine, signaturePrevalidator, confirmationValidators, conditionValidators, statementValidators);
  }

  /**
   * A {@code Subject} element in the Assertion is required by the Swedish eID Framework. We assert that and that it
   * holds a NameID value of the correct format. We also check that there is a {@code SubjectConfirmation} element for
   * the bearer method. After that, the base implementation may execute.
   */
  @Override
  protected ValidationResult validateSubject(final Assertion assertion, final ValidationContext context) {

    if (assertion.getSubject() == null) {
      context.getValidationFailureMessages().add("Missing Subject element in Assertion");
      return ValidationResult.INVALID;
    }

    // Assert that there is a NameID ...
    //
    if (assertion.getSubject().getNameID() == null) {
      context.getValidationFailureMessages().add("Missing NameID in Subject element of Assertion");
      return ValidationResult.INVALID;
    }
    // And that it holds a value ...
    //
    if (assertion.getSubject().getNameID().getValue() == null) {
      context.getValidationFailureMessages().add("Missing NameID value in Subject element of Assertion");
      return ValidationResult.INVALID;
    }
    // Also check that it is persistent or transient ...
    //
    if (assertion.getSubject().getNameID().getFormat() == null) {
      final String msg = "NameID element of Assertion/@Subject is missing Format attribute";
      if (isStrictValidation(context)) {
        context.getValidationFailureMessages().add(msg);
        return ValidationResult.INVALID;
      }
      else {
        log.info(msg);
      }
    }
    else {
      final String format = assertion.getSubject().getNameID().getFormat();
      if (!(format.equals(NameID.PERSISTENT) || format.equals(NameID.TRANSIENT))) {
        final String msg =
            String.format("NameID format in Subject of Assertion is not valid (%s) - '%s' or '%s' is required",
                format, NameID.PERSISTENT, NameID.TRANSIENT);
        if (isStrictValidation(context)) {
          context.getValidationFailureMessages().add(msg);
          return ValidationResult.INVALID;
        }
        else {
          log.info(msg);
        }
      }
    }

    final List confirmations = assertion.getSubject().getSubjectConfirmations();
    if (confirmations == null || confirmations.isEmpty()) {
      context.getValidationFailureMessages().add(
          "Assertion/@Subject element contains no SubjectConfirmation elements - invalid");
      return ValidationResult.INVALID;
    }

    // We require the bearer method ...
    //
    final boolean hokProfileActive = Optional.ofNullable(context.getDynamicParameters().get(HOK_PROFILE_ACTIVE))
        .map(Boolean.class::cast).orElse(Boolean.FALSE);

    if (!hokProfileActive) {
      boolean bearerFound = confirmations.stream()
          .filter(s -> SubjectConfirmation.METHOD_BEARER.equals(s.getMethod())).findFirst().isPresent();
      if (!bearerFound) {
        final String msg =
            String.format("No SubjectConfirmation with method '%s' is available under Assertion's Subject element",
                SubjectConfirmation.METHOD_BEARER);
        context.getValidationFailureMessages().add(msg);
        return ValidationResult.INVALID;
      }
    }

    return super.validateSubject(assertion, context);
  }

  /**
   * Extends the base implementation with requirements from the Swedish eID Framework.
   */
  @Override
  protected ValidationResult validateConditions(final Assertion assertion, final ValidationContext context) {

    if (assertion.getConditions() == null) {
      context.getValidationFailureMessages().add("Missing Conditions element in Assertion");
      return ValidationResult.INVALID;
    }

    // Assert that the NotBefore is there ...
    //
    if (assertion.getConditions().getNotBefore() == null) {
      context.getValidationFailureMessages().add("Missing NotBefore attribute of Conditions element in Assertion");
      return ValidationResult.INVALID;
    }

    // ... and NotOnOrAfter ...
    //
    if (assertion.getConditions().getNotOnOrAfter() == null) {
      context.getValidationFailureMessages().add("Missing NotOnOrAfter attribute of Conditions element in Assertion");
      return ValidationResult.INVALID;
    }

    // The Swedish eID Framework requires the AudienceRestriction to be there ...
    //
    if (assertion.getConditions().getAudienceRestrictions().isEmpty()) {
      context.getValidationFailureMessages().add(
          "Missing AudienceRestriction element of Conditions element in Assertion");
      return ValidationResult.INVALID;
    }

    return super.validateConditions(assertion, context);
  }

  /**
   * Overrides the default implementation with checks to ensure the the {@link AuthnStatement} and
   * {@link AttributeStatement} elements are in place.
   */
  @Override
  protected ValidationResult validateStatements(final Assertion assertion, final ValidationContext context) {

    if (assertion.getAuthnStatements() == null || assertion.getAuthnStatements().isEmpty()) {
      context.getValidationFailureMessages().add("No AuthnStatement in Assertion");
      return ValidationResult.INVALID;
    }
    if (assertion.getAttributeStatements() == null || assertion.getAttributeStatements().isEmpty()) {
      context.getValidationFailureMessages().add("No AttributeStatement in Assertion");
      return ValidationResult.INVALID;
    }

    return super.validateStatements(assertion, context);
  }

}