se.swedenconnect.eid.sp.controller.SpController Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of test-my-eid Show documentation
Sweden Connect - Test my eID
The newest version!
/*
 * Copyright 2018-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.eid.sp.controller;

import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import jakarta.servlet.http.HttpSession;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.i18n.LocaleContextHolder;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.servlet.ModelAndView;
import se.swedenconnect.eid.sp.config.EntityID;
import se.swedenconnect.eid.sp.model.LastAuthentication;
import se.swedenconnect.eid.sp.saml.IdpList;

import java.util.Objects;
import java.util.stream.Collectors;

/**
 * Main controller.
 *
 * @author Martin Lindström ([email protected])
 */
@Controller
@Slf4j
@RequestMapping("/")
public class SpController extends BaseController {

  /** Holds the IdPs to display for the user. */
  @Autowired
  private IdpList idpListConfiguration;

  /** The entityID for the eIDAS connector. */
  @Autowired
  @Qualifier("eidasConnectorEntityID")
  private EntityID eidasConnectorEntityId;

  /** Needed so that we can configure paths. For overloading this app. */
  @Value("${sp.sign-path:/saml2/request/next}")
  protected String signPath;

  /**
   * Controller method for the home endpoint.
   *
   * @param request the HTTP servlet request
   * @return a model and view object
   */
  @GetMapping
  public ModelAndView home(final HttpServletRequest request) {
    final ModelAndView mav = new ModelAndView("home");
    mav.addObject("idpList", this.idpListConfiguration.getIdps()
        .stream()
        .map(i -> i.getIdpModel(LocaleContextHolder.getLocale()))
        .collect(Collectors.toList()));

    log.trace("Adding IdPs {}", this.idpListConfiguration.getIdps());
    return mav;
  }

  /**
   * Controller that by-passes the discovery page and goes directly to the eIDAS connector.
   *
   * @return a redirect string to the SAML request endpoint
   */
  @GetMapping("/eidas")
  public ModelAndView eidas() {
    return new ModelAndView(
        String.format("redirect:/saml2/request?selectedIdp=%s", this.eidasConnectorEntityId.getEntityID()));
  }

  /**
   * Controller that by-passes the discovery page and goes directly to the eIDAS connector with a pre-selected country.
   *
   * @param country the two-letter country code for the country to send the request from the connector to
   * @return a redirect string to the SAML request endpoint
   */
  @GetMapping("/eidas/{country}")
  public ModelAndView eidasCountry(
      @PathVariable(value = "country", required = true) final String country) {

    if ("ping".equalsIgnoreCase(country)) {
      return new ModelAndView(String.format("redirect:/saml2/request?selectedIdp=%s&ping=true",
          this.eidasConnectorEntityId.getEntityID()));
    }
    else {
      return new ModelAndView(String.format("redirect:/saml2/request?selectedIdp=%s&country=%s",
          this.eidasConnectorEntityId.getEntityID(), country));
    }
  }

  /**
   * Controller that by-passes the discovery page and goes directly to the eIDAS connector with a pre-selected country
   * and sends an authentication request for an eIDAS ping authentication request.
   *
   * @param country the two-letter country code for the country to send the request from the connector to
   * @return a redirect string to the SAML request endpoint
   */
  @GetMapping("/eidas/ping/{country}")
  public ModelAndView eidasPingCountry(
      @PathVariable(value = "country", required = true) final String country) {

    return new ModelAndView(String.format("redirect:/saml2/request?selectedIdp=%s&ping=true&country=%s",
        this.eidasConnectorEntityId.getEntityID(), country));
  }

  /**
   * Displays the result of an authentication.
   *
   * @param request the HTTP request
   * @param response the HTTP response
   * @return a model and view object
   */
  @GetMapping("/result")
  public ModelAndView displayResult(final HttpServletRequest request, final HttpServletResponse response) {

    final HttpSession session = request.getSession();
    final ModelAndView mav = (ModelAndView) session.getAttribute("sp-result");
    if (mav == null) {
      log.warn("No session for user, directing to start page [client-ip-address='{}']", request.getRemoteAddr());
      return new ModelAndView("redirect:/");
    }

    final LastAuthentication lastAuthentication = (LastAuthentication) session.getAttribute("last-authentication");
    if (lastAuthentication != null) {
      this.idpListConfiguration.getIdps()
          .stream()
          .filter(idp -> Objects.equals(idp.getEntityID(), lastAuthentication.getIdp()))
          .map(idp -> idp.getIdpModel(LocaleContextHolder.getLocale()))
          .findFirst().ifPresent(idpModel -> mav.addObject("signIdp", idpModel));
    }
    mav.addObject("pathSign", this.signPath);

    return mav;
  }

}