@cerema/cadriciel 1.0.8 → 1.1.1

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/beans/errors/JsonApiError.java

@@ -0,0 +1,308 @@
+/*
+ * Copyright 2017 - Alain CHARLES
+ *
+ * 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 fr.cerema.dsi.commons.beans.errors;
+
+import com.fasterxml.jackson.annotation.JsonFormat;
+import com.fasterxml.jackson.annotation.JsonIgnore;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonPropertyOrder;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlElementWrapper;
+import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlProperty;
+import org.springframework.http.HttpStatus;
+
+import java.time.LocalDateTime;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * This class holds the necessary fields of the error
+ * that has to be sent in case of API call failure.
+ * <p>
+ * Error fields are stored in an instance of an inner class {@link JsonApiError.ApiError}.
+ * The Json error is sent back as an array (one element in this case) as asked by the Json Api Specification V1.0
+ * See <a href="http://jsonapi.org/format/#errors">http://jsonapi.org/format/#errors</a>
+ * <p>
+ * Generally, your {@link org.springframework.web.bind.annotation.RestController} will
+ * throw an exception and you will instantiate {@link JsonApiError} in a exception handler
+ * as done for instance in {@link fr.cerema.dsi.commons.controllers.RestResponseEntityExceptionHandler}
+ *
+ * @author alain.charles
+ */
+public class JsonApiError {
+
+    private JsonApiError.ApiError error;
+
+    /**
+     * Returns the API Error as an array of one error in this case
+     * as aked by Json Api Specification V1.0
+     *
+     * @return the list of (one) error.
+     */
+    @JsonProperty
+    @JacksonXmlElementWrapper(localName = "errors")
+    @JacksonXmlProperty(localName = "error")
+    public List<JsonApiError.ApiError> getErrors() {
+        List<ApiError> returnValue = new ArrayList<>();
+        returnValue.add(this.error);
+        return returnValue;
+    }
+
+    private JsonApiError() {
+        this.error = new JsonApiError.ApiError();
+    }
+
+    /**
+     * Creates a new instance of {@link JsonApiError}
+     * using supplied {@link HttpStatus}
+     *
+     * @param status the HTTP status
+     */
+    public JsonApiError(HttpStatus status) {
+        this();
+        this.error.status = status;
+        this.error.message = status.getReasonPhrase();
+    }
+
+    /**
+     * Creates a new instance of {@link JsonApiError}
+     * using supplied {@link HttpStatus} and {@link Throwable}
+     *
+     * @param status the HTTP status
+     * @param ex     the Throwable whose message will be included in {@link JsonApiError#getDebugMessage()}
+     */
+    public JsonApiError(HttpStatus status, Throwable ex) {
+        this(status);
+        if (Objects.nonNull(ex)) this.error.debugMessage = ex.getLocalizedMessage();
+    }
+
+    /**
+     * Creates a new instance of {@link JsonApiError}
+     * using supplied {@link HttpStatus}, {@link String} and {@link Throwable}
+     *
+     * @param status  the HTTP status
+     * @param message the message that will be stored in {@link JsonApiError#getMessage()}
+     * @param ex      the Throwable whose message will be included in {@link JsonApiError#getDebugMessage()}
+     */
+    public JsonApiError(HttpStatus status, String message, Throwable ex) {
+        this(status, ex);
+        this.error.message = message;
+    }
+
+
+    /**
+     * Returns the error time stamp
+     *
+     * @return the timestamp
+     */
+    @JsonIgnore
+    public LocalDateTime getTimestamp() {
+        return error.timestamp;
+    }
+
+    /**
+     * Returns the Http Status Code value
+     *
+     * @return the status code value
+     */
+    @JsonIgnore
+    public int getHttpErrorCode() {
+        return error.status.value();
+    }
+
+    /**
+     * Returns the reason of Http Error
+     *
+     * <p>See <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html">
+     * https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html</a>
+     *
+     * @return the reason of error
+     */
+    @JsonIgnore
+    public String getStatusReasonPhrase() {
+        return error.status.getReasonPhrase();
+    }
+
+    /**
+     * Returns the error main message
+     *
+     * @return the main message
+     */
+    @JsonIgnore
+    public String getMessage() {
+        return error.message;
+    }
+
+    /**
+     * Returns the error debug message
+     *
+     * @return the debug message
+     */
+    @JsonIgnore
+    private String getDebugMessage() {
+        return error.debugMessage;
+    }
+
+    /**
+     * Returns the list of {@link ApiSubError} instances or {@code null}
+     *
+     * @return the list of subErrors
+     */
+    @JsonIgnore
+    public List<ApiSubError> getSubErrors() {
+        return error.subErrors;
+    }
+
+    /**
+     * Retourne the {@link HttpStatus} of the error
+     *
+     * @return the Http status
+     */
+    @JsonIgnore
+    public HttpStatus getStatus() {
+        return error.status;
+    }
+
+
+    @JsonIgnore
+    public List<ApiSubError> getApiSubErrors() {
+        return error.getSubErrors();
+    }
+
+    /**
+     * Minimalist output of the error contained in this instance
+     * Used when the json or xml serialization failed
+     */
+    @Override
+    public String toString() {
+        return error.toString();
+    }
+
+    /**
+     * This class holds the necessary fields of the error
+     * that has to be sent in case of API call failure.
+     *
+     * <p>Generally, you will instantiate {@link JsonApiError} in the
+     * {@link org.springframework.web.bind.annotation.RestController} if the API call raised an exception.
+     *
+     * @author alain.charles
+     */
+    @JsonPropertyOrder({"httpErrorCode", "reason", "timestamp", "message", "debugMessage", "subErrors"})
+    public class ApiError {
+
+        private HttpStatus status;
+
+        private LocalDateTime timestamp;
+
+        private String message;
+
+        private String debugMessage;
+
+        private List<ApiSubError> subErrors;
+
+        private ApiError() {
+            timestamp = LocalDateTime.now();
+        }
+
+
+        /**
+         * Returns the error time stamp
+         *
+         * @return the timestamp
+         */
+        @JsonProperty
+        @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "dd-MM-yyyy HH:mm:ss")
+        public LocalDateTime getTimestamp() {
+            return timestamp;
+        }
+
+        /**
+         * Returns the Http Status Code value
+         *
+         * @return the status code value
+         */
+        @JsonProperty
+        public int getHttpErrorCode() {
+            return status.value();
+        }
+
+        /**
+         * Returns the reason of Http Error
+         *
+         * <p>See <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html">
+         * https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html</a>
+         *
+         * @return the reason of error
+         */
+        @JsonProperty("reason")
+        public String getStatusReasonPhrase() {
+            return status.getReasonPhrase();
+        }
+
+        /**
+         * Returns the error main message
+         *
+         * @return the main message
+         */
+        @JsonProperty
+        public String getMessage() {
+            return message;
+        }
+
+        /**
+         * Returns the error debug message
+         *
+         * @return the debug message
+         */
+        @JsonProperty
+        public String getDebugMessage() {
+            return debugMessage;
+        }
+
+        /**
+         * Returns the list of {@link ApiSubError} instances or {@code null}
+         *
+         * @return the list of subErrors
+         */
+        @JsonProperty
+        List<ApiSubError> getSubErrors() {
+            return subErrors;
+        }
+
+        @Override
+        public String toString() {
+            final String UNKNOWN = "inconnu";
+
+            StringBuilder sb = new StringBuilder();
+
+            sb.append("httpErrorCode : ");
+            sb.append(error.status != null ? error.status.value() : UNKNOWN);
+            sb.append("\nreason : ");
+            sb.append(error.status != null ? error.status.getReasonPhrase() : UNKNOWN);
+            sb.append("\ntimestamp : ");
+            sb.append(error.timestamp != null ? error.timestamp : UNKNOWN);
+            sb.append("\nmessage : ");
+            sb.append(error.message != null ? error.message : UNKNOWN);
+            sb.append("\ndebugMessage : ");
+            sb.append(error.debugMessage != null ? error.debugMessage : UNKNOWN);
+            sb.append("\nsubErrors : ");
+            sb.append(error.subErrors != null ? error.subErrors : UNKNOWN);
+
+            return sb.toString();
+        }
+    }
+}

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/controllers/AbstractErrorHandler.java

@@ -0,0 +1,67 @@
+package fr.cerema.dsi.commons.controllers;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.SerializationFeature;
+import com.fasterxml.jackson.datatype.jsr310.JavaTimeModule;
+import fr.cerema.dsi.commons.beans.errors.JsonApiError;
+import jakarta.servlet.http.HttpServletResponse;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.stereotype.Component;
+
+import java.io.PrintWriter;
+
+/**
+ * Permet d'afficher les erreurs en les présentant à l'utilisateur sous forme de json
+ * Si cela échoue, on affiche une version de secours en utilisant un toString()
+ * Le but est de limiter le plus possible la survenue d'erreur pendant ce processus : risque de boucle infinie.
+ */
+@Component
+public abstract class AbstractErrorHandler {
+    private static final Logger logger = LoggerFactory.getLogger(AbstractErrorHandler.class);
+
+    private final ObjectMapper mapper;
+
+    @Autowired
+    public AbstractErrorHandler(ObjectMapper mapper) {
+        this.mapper = mapper;
+        mapper.registerModule(new JavaTimeModule());
+        mapper.disable(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS);
+    }
+
+    public void sendError(JsonApiError error, HttpServletResponse response) {
+        response.setStatus(getStatusFromError(error));
+        response.setContentType(MediaType.APPLICATION_JSON_VALUE);
+        response.setCharacterEncoding("UTF-8");
+        try {
+            PrintWriter writer = response.getWriter();
+            try {
+                writer.write(mapper.writeValueAsString(error));
+            } catch (Exception e) {
+                logger.warn("Problème lors de l'envoi formaté en json de l'erreur : {}", error);
+                logger.warn(" Le problème était : {}", e.getLocalizedMessage());
+                logger.warn(" On envoie l'erreur en mode simple string");
+                writer.write(error.toString());
+            } finally {
+                writer.close();
+            }
+        } catch (Exception ex) {
+            logger.error("Impossible d'envoyer en simple mode texte l'erreur suivante : " + error, ex);
+        }
+    }
+
+    /**
+     * Si le statut n'est pas défini, on retourne par défaut une simple erreur 500 générique
+     */
+    private int getStatusFromError(JsonApiError error) {
+        if (error.getStatus() != null) {
+            return error.getStatus().value();
+        } else {
+            return HttpStatus.INTERNAL_SERVER_ERROR.value();
+        }
+    }
+
+}

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/controllers/ClientForwardController.java

@@ -0,0 +1,19 @@
+package fr.cerema.dsi.commons.controllers;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+
+@Controller
+public class ClientForwardController {
+
+  /**
+   * Forwards any unmapped paths (except those containing a period) to the client
+   * {@code index.html}.
+   *
+   * @return forward to client {@code index.html}.
+   */
+  @GetMapping(value = "/**/{path:[^\\.]*}")
+  public String forward() {
+    return "forward:/";
+  }
+}

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/controllers/CustomErrorController.java

@@ -0,0 +1,57 @@
+package fr.cerema.dsi.commons.controllers;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import fr.cerema.dsi.commons.beans.errors.JsonApiError;
+import io.swagger.v3.oas.annotations.Hidden;
+import jakarta.servlet.http.HttpServletResponse;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.web.servlet.error.ErrorAttributes;
+import org.springframework.boot.web.servlet.error.ErrorController;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PostMapping;
+import org.springframework.web.bind.annotation.PutMapping;
+import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.context.request.WebRequest;
+
+// TODO Verifier API qui génére une erreur pour les tests.
+// surement redirection d'erreur
+
+@Hidden
+@RestController
+public class CustomErrorController extends AbstractErrorHandler implements ErrorController {
+
+    private static final String PATH = "/error";
+
+    private final ErrorAttributes errorAttributes;
+
+    @Autowired
+    public CustomErrorController(ObjectMapper mapper, ErrorAttributes errorAttributes) {
+        super(mapper);
+        this.errorAttributes = errorAttributes;
+    }
+
+    @GetMapping(value = PATH, produces = MediaType.ALL_VALUE)
+    public void getHandleError(WebRequest request, HttpServletResponse response) {
+        JsonApiError error = new JsonApiError(HttpStatus.resolve(response.getStatus()), errorAttributes.getError(request));
+
+        sendError(error, response);
+    }
+
+    @PostMapping(value = PATH, produces = MediaType.ALL_VALUE)
+    public void postHandleError(WebRequest request, HttpServletResponse response) {
+      JsonApiError error = new JsonApiError(HttpStatus.resolve(response.getStatus()), errorAttributes.getError(request));
+
+      sendError(error, response);
+    }
+
+  @PutMapping(value = PATH, produces = MediaType.ALL_VALUE)
+  public void putHandleError(WebRequest request, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.resolve(response.getStatus()), errorAttributes.getError(request));
+
+    sendError(error, response);
+  }
+
+}
+

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/controllers/RestResponseEntityExceptionHandler.java

@@ -0,0 +1,75 @@
+package fr.cerema.dsi.commons.controllers;
+
+import com.fasterxml.jackson.databind.ObjectMapper;
+import fr.cerema.dsi.commons.beans.errors.JsonApiError;
+import fr.cerema.dsi.commons.exceptions.EntityNotFoundException;
+import fr.cerema.dsi.commons.exceptions.UserNotFoundException;
+import jakarta.servlet.http.HttpServletResponse;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.http.HttpStatus;
+import org.springframework.security.access.AccessDeniedException;
+import org.springframework.security.authentication.AuthenticationServiceException;
+import org.springframework.web.HttpMediaTypeNotAcceptableException;
+import org.springframework.web.bind.annotation.ExceptionHandler;
+import org.springframework.web.bind.annotation.RestControllerAdvice;
+import org.springframework.web.servlet.NoHandlerFoundException;
+
+@RestControllerAdvice
+public class RestResponseEntityExceptionHandler extends AbstractErrorHandler {
+
+  @Autowired
+  public RestResponseEntityExceptionHandler(ObjectMapper mapper) {
+    super(mapper);
+  }
+
+  @ExceptionHandler(NoHandlerFoundException.class)
+  public void handleNoHandlerFound(NoHandlerFoundException ex, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.NOT_FOUND,
+      "La requête ne correspond pas à un service existant.", ex);
+    sendError(error, response);
+  }
+
+  @ExceptionHandler({AccessDeniedException.class})
+  public void handleAccessDeniedException(AccessDeniedException ex, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.FORBIDDEN,
+      "Accès refusé, vous n'avez pas les droits suffisants", ex);
+    sendError(error, response);
+  }
+
+  @ExceptionHandler(HttpMediaTypeNotAcceptableException.class)
+  public void handleError(HttpMediaTypeNotAcceptableException ex, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.NOT_ACCEPTABLE,
+      "Le serveur ne sait pas générer une réponse avec le mediaType demandé.", ex);
+    sendError(error, response);
+  }
+
+  @ExceptionHandler(value = EntityNotFoundException.class)
+  public void handleNotFound(EntityNotFoundException ex, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.NOT_FOUND,
+      "Entité recherchée non trouvée", ex);
+    sendError(error, response);
+  }
+
+  @ExceptionHandler(value = UserNotFoundException.class)
+  public void handleUserNotFound(UserNotFoundException ex, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.UNAUTHORIZED,
+      "Utilisateur recherché non trouvé", ex);
+    sendError(error, response);
+  }
+
+  @ExceptionHandler(value = IllegalArgumentException.class)
+  public void handleIllegalArgument(IllegalArgumentException ex, HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.BAD_REQUEST,
+      "Un argument de la requête est incorrect", ex);
+    sendError(error, response);
+  }
+
+  @ExceptionHandler(value = AuthenticationServiceException.class)
+  public void handleAuthenticationServiceException(AuthenticationServiceException ex,
+    HttpServletResponse response) {
+    JsonApiError error = new JsonApiError(HttpStatus.UNAUTHORIZED,
+      "Authentification incorrecte.", ex);
+    sendError(error, response);
+  }
+
+}

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/security/auth/jwt/exceptions/InvalidTokenException.java

@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2018 - Alain CHARLES
+ *
+ *  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 fr.cerema.dsi.commons.security.auth.jwt.exceptions;
+
+import org.springframework.security.core.AuthenticationException;
+
+public class InvalidTokenException extends AuthenticationException {
+    public InvalidTokenException(String msg, Throwable t) {
+        super(msg, t);
+    }
+
+    public InvalidTokenException(String msg) {
+        super(msg);
+    }
+}

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/commons/security/filters/AppCorsFilter.java

@@ -0,0 +1,45 @@
+/*
+ * Copyright (c) 2018 - Alain CHARLES
+ *
+ *  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 fr.cerema.dsi.commons.security.filters;
+
+import org.springframework.web.cors.CorsConfiguration;
+import org.springframework.web.cors.CorsConfigurationSource;
+import org.springframework.web.cors.UrlBasedCorsConfigurationSource;
+import org.springframework.web.filter.CorsFilter;
+
+import java.util.Arrays;
+
+public class AppCorsFilter extends CorsFilter {
+
+    public AppCorsFilter() {
+        super(configurationSource());
+    }
+
+    private static CorsConfigurationSource configurationSource() {
+        CorsConfiguration config = new CorsConfiguration();
+        config.setAllowCredentials(true);
+        //config.addAllowedOriginPattern("*");
+        config.addAllowedOrigin("*");
+        config.addAllowedHeader("*");
+        config.setMaxAge(36000L);
+        config.setAllowedMethods(Arrays.asList("GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS"));
+        UrlBasedCorsConfigurationSource source = new UrlBasedCorsConfigurationSource();
+        source.registerCorsConfiguration("/**", config);
+        return source;
+    }
+}

package/aaaa/api/aaaa-presentation/src/main/resources/META-INF/spring.factories

@@ -0,0 +1,2 @@
+org.springframework.boot.diagnostics.FailureAnalyzer=\
+  fr.cerema.dsi.aaaa.config.analyzer.JwtConfMalformedAnalyzer

package/aaaa/api/aaaa-presentation/src/main/resources/banner.txt

@@ -0,0 +1,3 @@
+${AnsiColor.GREEN}§§projectNS§§ ${AnsiColor.BLUE}${info.app.version}
+${AnsiColor.CYAN}POC gestion de données spatiales
+${AnsiColor.DEFAULT}

package/aaaa/api/aaaa-presentation/src/main/resources/logback-spring-ci.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+  <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
+  <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
+
+  <logger name="org.springframework" level="ERROR"/>
+  <logger name="org.springframework.web" level="ERROR"/>
+  <logger name="org.hibernate" level="ERROR"/>
+  <logger name="fr.cerema.dsi.aaaa" level="ERROR"/>
+
+  <root level="ERROR">
+    <appender-ref ref="CONSOLE"/>
+  </root>
+
+</configuration>

package/aaaa/api/aaaa-presentation/src/main/resources/logback-spring.xml

@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<configuration>
+  <include resource="org/springframework/boot/logging/logback/defaults.xml"/>
+  <include resource="org/springframework/boot/logging/logback/console-appender.xml"/>
+
+  <logger name="org.springframework" level="ERROR"/>
+  <logger name="org.springframework.web" level="ERROR"/>
+  <logger name="org.hibernate" level="ERROR"/>
+  <logger name="fr.cerema.dsi.aaaa" level="INFO"/>
+
+  <root level="INFO">
+    <appender-ref ref="CONSOLE"/>
+  </root>
+
+</configuration>