aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-auth-saml/src/main/java/org/sonar/auth/saml/SonarqubeSaml2ResponseValidator.java
blob: 96538b58e15822bb3fca79d95d0cb4d9dfe54b25 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/*
 * SonarQube
 * Copyright (C) 2009-2025 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 3 of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
package org.sonar.auth.saml;

import com.google.common.annotations.VisibleForTesting;
import jakarta.inject.Inject;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.function.Supplier;
import javax.annotation.CheckForNull;
import javax.annotation.Nullable;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.core.convert.converter.Converter;
import org.springframework.security.saml2.core.Saml2Error;
import org.springframework.security.saml2.core.Saml2ResponseValidatorResult;

import static org.springframework.security.saml2.core.Saml2ErrorCodes.INVALID_IN_RESPONSE_TO;
import static org.springframework.security.saml2.provider.service.authentication.OpenSaml4AuthenticationProvider.ResponseToken;
import static org.springframework.security.saml2.provider.service.authentication.OpenSaml4AuthenticationProvider.createDefaultResponseValidator;

class SonarqubeSaml2ResponseValidator implements Converter<ResponseToken, Saml2ResponseValidatorResult> {

  private static final Logger LOGGER = LoggerFactory.getLogger(SonarqubeSaml2ResponseValidator.class);

  private final Converter<ResponseToken, Saml2ResponseValidatorResult> delegate;
  private final SamlMessageIdChecker samlMessageIdChecker;

  private Supplier<String> validInResponseToSupplier;

  @Inject
  SonarqubeSaml2ResponseValidator(SamlMessageIdChecker samlMessageIdChecker) {
    this(samlMessageIdChecker, createDefaultResponseValidator());
  }

  @VisibleForTesting
  SonarqubeSaml2ResponseValidator(SamlMessageIdChecker samlMessageIdChecker, Converter<ResponseToken, Saml2ResponseValidatorResult> delegate) {
    this.samlMessageIdChecker = samlMessageIdChecker;
    this.delegate = delegate;
  }

  @Override
  @CheckForNull
  public Saml2ResponseValidatorResult convert(ResponseToken responseToken) {
    Saml2ResponseValidatorResult validationResults = delegate.convert(responseToken);

    List<Saml2Error> errors = new ArrayList<>(getValidationErrorsWithoutInResponseTo(responseToken, validationResults));
    samlMessageIdChecker.validateMessageIdWasNotAlreadyUsed(responseToken.getResponse().getID()).ifPresent(errors::add);

    LOGGER.debug("Saml validation errors: {}", errors);
    return Saml2ResponseValidatorResult.failure(errors);
  }

  private Collection<Saml2Error> getValidationErrorsWithoutInResponseTo(ResponseToken responseToken, @Nullable Saml2ResponseValidatorResult validationResults) {
    if (validationResults == null) {
      return List.of();
    }
    String inResponseTo = responseToken.getResponse().getInResponseTo();
    validInResponseToSupplier = () -> inResponseTo;
    return removeInResponseToError(validationResults);
  }

  private static Collection<Saml2Error> removeInResponseToError(Saml2ResponseValidatorResult result) {
    return result.getErrors().stream()
      .filter(error -> !INVALID_IN_RESPONSE_TO.equals(error.getErrorCode()))
      .toList();
  }

  public Supplier<String> getValidInResponseToSupplier() {
    return validInResponseToSupplier;
  }
}