@cerema/cadriciel 1.1.0 → 1.1.1

package/aaaa/api/aaaa-presentation/Readme.md

@@ -0,0 +1,98 @@
+# Module de gestion des contrôleurs de l'application
+
+Ce module est responsable du dialogue entre le Client et notre API. Nous utilisons des annotations springdoc pour
+générer un swagger de l'API.
+
+## Implémentation de l'authentification
+
+L'authentification se fait par l'intermédiaire d'Orion. Nous nous basons sur la réception d'un token JWT qui doit être
+présent dans les entêtes HTTP Authorization avec le nom Bearer. Ce qui donne :
+
+<code>
+Authorization: Bearer << jeton JWT encodé en Base64 >>
+</code>
+
+Ce jeton est signé numériquement par Orion, nous disposons de sa clé publique pour le valider. Les informations
+contenues dedans sont donc sûres :
+
+- orionId : l'id unique généré par Orion pour cet utilisateur qui peut être une personne ou une application. Il est
+  récupéré dans le champ "sub", qui correspond au Subject du token.
+- email : champ "email" du token
+
+On ajoute des rôles en consultant la base locale d'Aspro et en se basant sur l'id orion. Ceci est fait dans la classe :
+<code>fr.cerema.dsi.commons.security.auth.jwt.JwtAuthenticationProvider</code>
+
+### Sécurisation d'une API
+
+Pour activer l'authentification sur une partie de l'API, il faut faire deux choses :
+
+1. Ajouter l'url dans la variable protectedEndpointList de la méthode configure de la classe WebSecurityConfiguration.
+   par exemple : <code>"/protected/\*\*", "/interne/\*\*"</code>
+2. Ajouter le contrôle des rôles grâce aux annotations @Secured. Elles peuvent être placées soit sur les méthodes, soit
+   sur la classe, auquel cas, elle s'appliquera à toutes les méthodes. Par exemple : <code>@Secured("ROLE_ADMIN")</code>
+
+Si on se contente de l'étape 1, alors les urls sont protégées, mais uniquement par la présence d'un jeton Orion valide.
+Toute personne s'étant créé un compte sur Orion (n'importe qui peut le faire) aura accès à l'url. La protection est donc
+quasi inexistante. Il faut impérativement combiner avec le point 2, car les rôles sont ajoutés manuellement par un
+administrateur d'ASPRO dans sa base locale.
+
+Il est possible d'ajouter une icône cadenas dans le swagger pour faciliter l'expérimentation de l'API directement à
+partir de la documentation :
+
+```java
+@SecurityRequirement(name = ORION_AUTH)
+```
+
+ATTENTION : C'est purement de la documentation, la véritable authentification est assurée par les annotations @Secured
+comme vu ci-dessus
+
+### Récupération d'informations sur l'authentification
+
+En plus de la sécurisation par rôle comme vu ci-dessus, il est possible de récupérer les infos sur l'utilisateur
+contenues dans le token en ajoutant simplement un paramètre <code>Authentication authentication</code> dans le
+contrôleur concerné.
+
+### Autres possibilités pour une gestion fine des droits
+
+Il existe des annotations plus puissantes comme :
+
+- <code>@PreAuthorize</code> qui permet d'utiliser des expressions utilisant le langage de scripting spEL
+- <code>@PostAuthorize</code> qui permet en plus de vérifier le résultat de la fonction. Mais ATTENTION, elle sera
+  exécutée quoi qu'il arrive
+- <code>@PreFilter</code> qui permet de filtrer une collection
+
+Il faudrait au préalable les activer dans <code>WebSecurityConfiguration</code> avec l'ajout de :
+
+```java
+@EnableGlobalMethodSecurity(
+        prePostEnabled = true,
+)
+```
+
+Pour plus d'infos voir cet [article](https://www.baeldung.com/spring-security-method-security)
+
+## Gestion des erreurs
+
+La gestion des erreurs au sein de l'application est centralisée dans 3 classes :
+
+- AppAuthenticationFailureHandler : est dédié aux problèmes d'authentification (mais pas les autorisations)
+- RestResponseEntityExceptionHandler : contient une liste d'exceptions qui sont traitées de manière particulière
+- CustomErrorController : toutes les autres erreurs (les exceptions non interceptées dans l'ensemble du code de l'
+  application) passent ici.
+
+Le parti qui a été pris est de limiter le plus possible la possibilité d'une erreur pendant l'affichage d'une erreur,
+car en général ça se termine par de nombreux rebonds inutiles, voire des boucles infinies particulièrement difficiles à
+comprendre en production.
+
+Les erreurs sont encapsulées dans la classe JsonApiError. Nous n'utilisons pas ResponseEntity<JsonApiError> pour générer
+la réponse envoyée au client, car elle est source de trop d'erreurs, en particulier liées à la gestion de la négociation
+du format du contenu (json, xml, csv, text, etc...). En revanche, nous l'utilisons bien sûr pour le reste de l'
+application.
+
+L'envoi effectif est fait dans la classe : AbstractErrorHandler
+
+Nous disposons également d'Analyser pour certaines erreurs qui peuvent se produire au démarrage de l'application. Ils
+sont utilisés par Spring Boot pour donner des explications. Elle forme une sorte de documentation complémentaire :
+
+- JwtConfMalformedAnalyzer
+- SecretInterneNotDefinedAnalyzer

package/aaaa/api/aaaa-presentation/pom.xml

@@ -0,0 +1,385 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>fr.cerema.dsi</groupId>
+    <artifactId>aaaa-back</artifactId>
+    <version>0.0.1</version>
+  </parent>
+  <packaging>jar</packaging>
+
+  <artifactId>aaaa-presentation</artifactId>
+
+  <!-- Dépendances spécifiques à ce module -->
+  <dependencies>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-devtools</artifactId>
+      <optional>true</optional>
+    </dependency>
+    <!-- Dépendances avec les autres modules -->
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>aaaa-transverse</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>aaaa-metier</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <dependency>
+      <groupId>${project.groupId}</groupId>
+      <artifactId>aaaa-data</artifactId>
+      <version>${project.version}</version>
+    </dependency>
+
+    <!-- starter-web : pour lancer un tomcat -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-web</artifactId>
+    </dependency>
+
+    <!-- dépendance spring-security -->
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-security</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework.security</groupId>
+      <artifactId>spring-security-oauth2-resource-server</artifactId>
+    </dependency>
+
+    <dependency>
+      <groupId>org.springframework.security</groupId>
+      <artifactId>spring-security-oauth2-jose</artifactId>
+    </dependency>
+
+    <!-- dépendance librairies JWT -->
+    <!--    <dependency>-->
+    <!--      <groupId>io.jsonwebtoken</groupId>-->
+    <!--      <artifactId>jjwt-impl</artifactId>-->
+    <!--      <version>0.11.5</version>-->
+    <!--    </dependency>-->
+    <dependency>
+      <groupId>io.jsonwebtoken</groupId>
+      <artifactId>jjwt-impl</artifactId>
+      <version>0.11.5</version>
+    </dependency>
+    <dependency> <!-- Temporaire : dépendance manquante dans cette librairie...-->
+      <groupId>io.jsonwebtoken</groupId>
+      <artifactId>jjwt-jackson</artifactId>
+      <version>0.11.5</version>
+    </dependency>
+
+
+
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-starter-actuator</artifactId>
+    </dependency>
+
+
+    <dependency>
+      <groupId>org.aspectj</groupId>
+      <artifactId>aspectjweaver</artifactId>
+      <version>1.9.5</version>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework.boot</groupId>
+      <artifactId>spring-boot-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <!-- and the engine for surefire and failsafe -->
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-engine</artifactId>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.springframework</groupId>
+      <artifactId>spring-test</artifactId>
+      <scope>test</scope>
+    </dependency>
+
+    <dependency>
+      <groupId>org.jacoco</groupId>
+      <artifactId>jacoco-maven-plugin</artifactId>
+      <version>0.8.7</version>
+    </dependency>
+  </dependencies>
+
+  <!--  Cette étape du build est nécessaire uniquement sur les profils prod, preprod et ceremaRec.
+        Elle concerne la recopie des éléments du frontend dans les pages statiques servies par le back
+  -->
+  <profiles>
+    <profile>
+      <id>preprod</id>
+      <dependencies>
+        <dependency>
+          <groupId>${project.groupId}</groupId>
+          <artifactId>aaaa-front</artifactId>
+          <version>${project.version}</version>
+        </dependency>
+      </dependencies>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-dependency-plugin</artifactId>
+            <version>3.1.2</version>
+            <executions>
+              <execution>
+                <id>merge</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>unpack</goal>
+                </goals>
+                <configuration>
+                  <artifactItems>
+                    <artifactItem>
+                      <groupId>${project.groupId}</groupId>
+                      <artifactId>aaaa-front</artifactId>
+                      <version>${project.version}</version>
+                      <type>jar</type>
+                      <overWrite>true</overWrite>
+                      <outputDirectory>${project.build.directory}/classes/static</outputDirectory>
+                    </artifactItem>
+                  </artifactItems>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+    <profile>
+      <id>prod</id>
+      <dependencies>
+        <dependency>
+          <groupId>${project.groupId}</groupId>
+          <artifactId>aaaa-front</artifactId>
+          <version>${project.version}</version>
+        </dependency>
+      </dependencies>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-dependency-plugin</artifactId>
+            <version>3.1.2</version>
+            <executions>
+              <execution>
+                <id>merge</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>unpack</goal>
+                </goals>
+                <configuration>
+                  <artifactItems>
+                    <artifactItem>
+                      <groupId>${project.groupId}</groupId>
+                      <artifactId>aaaa-front</artifactId>
+                      <version>${project.version}</version>
+                      <type>jar</type>
+                      <overWrite>true</overWrite>
+                      <outputDirectory>${project.build.directory}/classes/static</outputDirectory>
+                    </artifactItem>
+                  </artifactItems>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+    <profile>
+      <id>ceremaRec</id>
+      <dependencies>
+        <dependency>
+          <groupId>${project.groupId}</groupId>
+          <artifactId>aaaa-front</artifactId>
+          <version>${project.version}</version>
+        </dependency>
+      </dependencies>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-dependency-plugin</artifactId>
+            <version>3.1.2</version>
+            <executions>
+              <execution>
+                <id>merge</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>unpack</goal>
+                </goals>
+                <configuration>
+                  <artifactItems>
+                    <artifactItem>
+                      <groupId>${project.groupId}</groupId>
+                      <artifactId>aaaa-front</artifactId>
+                      <version>${project.version}</version>
+                      <type>jar</type>
+                      <overWrite>true</overWrite>
+                      <outputDirectory>${project.build.directory}/classes/static</outputDirectory>
+                    </artifactItem>
+                  </artifactItems>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+    <profile>
+      <id>ci</id>
+      <dependencies>
+        <dependency>
+          <groupId>${project.groupId}</groupId>
+          <artifactId>aaaa-front</artifactId>
+          <version>${project.version}</version>
+        </dependency>
+      </dependencies>
+      <build>
+        <plugins>
+          <plugin>
+            <groupId>org.apache.maven.plugins</groupId>
+            <artifactId>maven-dependency-plugin</artifactId>
+            <version>3.1.2</version>
+            <executions>
+              <execution>
+                <id>merge</id>
+                <phase>prepare-package</phase>
+                <goals>
+                  <goal>unpack</goal>
+                </goals>
+                <configuration>
+                  <artifactItems>
+                    <artifactItem>
+                      <groupId>${project.groupId}</groupId>
+                      <artifactId>aaaa-front</artifactId>
+                      <version>${project.version}</version>
+                      <type>jar</type>
+                      <overWrite>true</overWrite>
+                      <outputDirectory>${project.build.directory}/classes/static</outputDirectory>
+                    </artifactItem>
+                  </artifactItems>
+                </configuration>
+              </execution>
+            </executions>
+          </plugin>
+        </plugins>
+      </build>
+    </profile>
+  </profiles>
+
+  <build>
+    <finalName>aaaa_${project.version}</finalName>
+    <resources>
+      <resource>
+        <directory>${basedir}/src/main/resources-filtered</directory>
+        <filtering>true</filtering>
+      </resource>
+      <resource>
+        <directory>${basedir}/src/main/resources</directory>
+        <filtering>false</filtering>
+      </resource>
+    </resources>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-war-plugin</artifactId>
+        <version>3.3.1</version>
+        <configuration>
+          <failOnMissingWebXml>false</failOnMissingWebXml>
+        </configuration>
+      </plugin>
+      <plugin>
+        <groupId>org.springframework.boot</groupId>
+        <artifactId>spring-boot-maven-plugin</artifactId>
+      </plugin>
+
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-failsafe-plugin</artifactId>
+        <version>${maven-failsafe-plugin.version}</version>
+        <configuration>
+          <!-- Due to spring-boot repackage, without adding this property test classes are not found
+               See https://github.com/spring-projects/spring-boot/issues/6254 -->
+          <classesDirectory>${project.build.outputDirectory}</classesDirectory>
+          <!-- Force alphabetical order to have a reproducible build -->
+          <runOrder>alphabetical</runOrder>
+          <includes>
+            <include>**/*IT*</include>
+            <include>**/*IntTest*</include>
+          </includes>
+        </configuration>
+        <executions>
+          <execution>
+            <id>integration-test</id>
+            <goals>
+              <goal>integration-test</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>verify</id>
+            <goals>
+              <goal>verify</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+      <plugin>
+        <groupId>org.jacoco</groupId>
+        <artifactId>jacoco-maven-plugin</artifactId>
+        <version>0.8.7</version>
+        <executions>
+          <execution>
+            <id>pre-unit-tests</id>
+            <goals>
+              <goal>prepare-agent</goal>
+            </goals>
+          </execution>
+          <!-- Ensures that the code coverage report for unit tests is created after unit tests have been run -->
+          <execution>
+            <id>post-unit-test</id>
+            <phase>test</phase>
+            <goals>
+              <goal>report</goal>
+            </goals>
+          </execution>
+          <execution>
+            <id>pre-integration-tests</id>
+            <goals>
+              <goal>prepare-agent-integration</goal>
+            </goals>
+          </execution>
+          <!-- Ensures that the code coverage report for integration tests is created after integration tests have been run -->
+          <execution>
+            <id>post-integration-tests</id>
+            <phase>post-integration-test</phase>
+            <goals>
+              <goal>report-integration</goal>
+            </goals>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+
+</project>

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/aaaa/App.java

@@ -0,0 +1,20 @@
+package fr.cerema.dsi.aaaa;
+
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+
+@SpringBootApplication(scanBasePackages = {"fr.cerema.dsi.commons", "fr.cerema.dsi.aaaa"})
+public class App {
+
+//    @Override
+//    protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
+//        return application.sources(App.class);
+//    }
+
+    public static void main(String[] args) {
+        SpringApplication.run(App.class, args);
+    }
+
+}
+
+

package/aaaa/api/aaaa-presentation/src/main/java/fr/cerema/dsi/aaaa/config/AspectJConfiguration.java

@@ -0,0 +1,58 @@
+package fr.cerema.dsi.aaaa.config;
+
+import fr.cerema.dsi.commons.exceptions.GenericServiceException;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Around;
+import org.aspectj.lang.annotation.Aspect;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.security.authentication.AuthenticationServiceException;
+import org.springframework.stereotype.Component;
+
+
+// TODO Voir au fur et a mesure de cet aspect
+
+@Component
+@Aspect
+public class AspectJConfiguration {
+
+    private static Logger logger = LoggerFactory.getLogger(AspectJConfiguration.class);
+
+
+    @Around("execution(* fr.cerema.dsi.commons.services.*Service+.*(..)) || " +
+            "execution(* fr.cerema.dsi.aaaa.services.*Service+.*(..)) ")
+    public Object executeService(final ProceedingJoinPoint joinPoint) throws Throwable {
+        Object returnValue = null;
+        logger.trace("Appel du service {}", joinPoint.getSignature().toShortString());
+        try {
+            returnValue = joinPoint.proceed();
+            logger.debug("Succès de l'appel à {}", joinPoint.getSignature().toShortString());
+        } catch (AuthenticationServiceException ase) {
+            logger.warn("Warn lors de l'appel au service d'authentification {}", joinPoint.getSignature().toShortString());
+            throw ase;
+        } catch (GenericServiceException gse) {
+            logger.warn("Warn lors de l'appel à {} : {}", joinPoint.getSignature().toShortString(), gse.getMessage());
+            throw gse;
+        } catch (RuntimeException rte) {
+            logger.error("Erreur lors de l'appel à {} : {}", joinPoint.getSignature().toShortString(), rte.getMessage());
+            throw rte;
+        }
+        return returnValue;
+    }
+
+
+    @Around("execution(* fr.cerema.dsi.commons.repositories.*Repository+.*(..)) || " +
+            "execution(* fr.cerema.dsi.aaaa.repositories.*Repository+.*(..))")
+    public Object executeRepository(final ProceedingJoinPoint joinPoint) throws Throwable {
+        logger.trace("Appel de {}", joinPoint.getSignature().toShortString());
+        try {
+            Object returnValue = joinPoint.proceed();
+            logger.debug("Succès de l'appel à {}", joinPoint.getSignature().toShortString());
+            return returnValue;
+        } catch (RuntimeException e) {
+            logger.error("L'appel à {} a provoqué une erreur : {}", joinPoint.getSignature().toShortString(), e.getMessage());
+            throw e;
+        }
+    }
+
+}