| Sommaire |
|---|
...
Récupération des sources
Lorsque tous les Prérequis sont installés et PostgreSQL configuré, vous pouvez récupérer les sources.
...
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
cd /opt/ sudo mkdir esup-signature sudo chown esup:esup esup-signature/ -R git clone https://github.com/EsupPortail/esup-signature.git cd esup-signature |
| Info |
|---|
Le code est cloné dans le dossier ./esup-signature, le dépôt est positionné sur la branche master. Pour toutes les informations relative à l'exploitation et à la mise à jour du code voir le page dédié ici : Exploitation |
...
...
Fichiers de configuration
| Avertissement |
|---|
Le fichier application.yml présent dans les sources est un exemple de configuration basée sur environnement comportant un LDAP et un gestionnaire de groupes (grouper utiliser utilisé par l'Université de Rouen en l’occurrence). Les mentions de "for.esup-signature.xxxx" correspondent aux noms des groupes fournis par grouper. Cela ne veut pas dire que grouper soit obligatoire ni même que les noms de groupes doivent respecter ce format. Lorsque vous utiliser maven pour compiler ou lancer l'application c'est le fichier situer dans src/main/resources/application.yml qui est pris en compte. Il est possible de placer le fichier application.yml ailleurs sur le système de fichier en précisant son emplacement à l'aide de l'option -Dspring.config.location=/<DIR>/application.yml lors que de l'utilisation de la commen commande mvn |
application.yml
La configuration principale d' esup-signature se fait au travers application.yml
...
| Avertissement |
|---|
Il faut faire attention à l'indentation lors de la modification du fichier. Une mauvaise indentation peut faire échouer la compilation De pluis, le fichier doit impérativement être encodé en UTF-8 sinon la compilation peut échouer; Exemple d'erreur : [ERROR] Failed to execute goal org.apache.maven.plugins:maven-resources-plugin:3.2.0:resources (default-resources) on project esup-signature: Input length = 1 |
global
Dans la plupart des cas il s'agit ici de modifier root-url par l'adresse de votre esup-signature. Vous pouvez aussi configurer le système d'archivage et activer le switch user.
...
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
global:
root-url: https://esup-signature.univ-ville.fr # Adresse d'accès à votre instance
domain: univ-ville.fr
nexu-url: https://localhost:9895
nexu-version: 1.23-SNAPSHOT
nexu-download-url: /downloads/nexu-bundle.zip
hide-wizard: false # Désactiver le bouton "Assistant de création de demande"
hide-wizard-workflow: false # Désactiver le bouton "Assistant de création de circuit"
hide-auto-sign: false # Désactiver le bouton "Auto signature"
hide-send-sign-request: false # Désactiver le bouton "Demander une signature"
hide-wizard-except-roles: # Rôles faisant exception à la règle hide-wizard précédente
hide-auto-sign-except-roles: # Rôles faisant exception à la règle hide-auto-sign précédente
hide-send-sign-except-roles: # Rôles faisant exception à la règle hide-send-sign précédente
# archive-uri: smb://serveur_fichier/archives # Chemin pour l'archivage des documents
# delay-before-cleaning : 0 # Délai en jours après signature pour archivage et nettoyage des documents (désactivé si commenté)
enable-su: false # Activer ou non le switch user
enable-splash: true # Activer ou non le message d'accueil de la première connexion
application-email: esup.signature@univ-ville.fr # Adresse email du compte système et du support qui apparaitra dans l'aide
hours-before-refresh-notif: 24 . Il faut utiliser un alias pour éviter la correspondance avec un utilisateur
hours-before-refresh-notif: 24 # Nombre d'heures entre deux relances utilisateur
share-mode: 3 # Valeur de 0 à 3 : 0 = délégations désactivées, 1 = force le mode signature du délégué, 2 = force signature du mandant, 3 = choix du mode possible par l'utilisateur
return-to-home-after-sign: falsetrue # Forcer le retour à la page d'accueil après signature
infinite-scrolling: true # Activer l'infinite scrolling sur le tableau de bord, sinon bascule sur de la pagination
signed-suffix: "_signé" # suffix ajouté au fichiers signés
naming-template: "[title]" # Template de renommage des fichiers
enable-scheduled-cleanup: false # Activer ou non l’archivage et le nettoyage automatique. false par défaut
trash-keep-delay: -1 # Délai de conservation dans la corbeille en jours (-1 non actif)
disable-cert-storage: false # Activer/Désactiver la possibilité de stocker des certificats utilisateurs
nb-days-before-deleting: -1 # Nombre de jours après alerte pour suppression des demandes en attente (-1 non actif)
nb-days-before-warning: -1 # Nombre de jours avant alerte de suppression pour les demandes en attente (-1 non actif)
enable-captcha: false # Activer/Désactiver la detection de robot à la connexion ;-)
max-upload-size: 52428800 # Taille maximum des uploads de fichiers en bytes
pdf-only-pdf: false # True : restreindre l'upload aux seuls PDF
seal-certificat-driver: /lib/pkcs11/libIDPrimePKCS11.so export-attachements: true # Exporter Piloteles dupièces certificatjointes cachet(si dans le cas d'un PKCS11
seal-actif, l'export sera un dossier contenant le document signé ainsi que les PJ)
seal-certificat-driver: /lib/pkcs11/libIDPrimePKCS11.so # Pilote du certificat cachet dans le cas d'un PKCS11
seal-certificat-file: /opt/cert.p12 # Emplacement du certificat cachet dans le cas d'un PKCS12
seal seal-certificat-pin: ****** # Code pin du certificat cachet
seal-certificat-type: PKCS11 # Type du certificat PKCS11 ou PKCS12
sealAllDocsseal-all-docs: false # Appliquer le cachet sur toutes les demandes terminées
shib-users-domain-white-list: rest-ext-value-url: http://api.univ-ville.fr # # Adresse du web service de données externes
shib-users-domain-white-list: # Whitelist des domaines authorisés à obtenir le ROLE_USER pour les connexions Shibboleth
- univ-ville.fr
- inv-univ-ville.fr
sendPostitByEmail
# forced-externals-domain-list: # Liste permettant de forcer des domaines comme externes
send-postit-by-email: false # Envoyer un email au créateur de la demande lors de l’ajout d’un postit
sendCreationMailToViewers send-creation-mail-to-viewers: false # Envoyer un email aux observateurs à la création d’une demande
smsRequired sms-required: true # Imposer la double authentification par SMS pour les externes
|
Pour la gestion des rôles voir : Documentation administrateur#Gestiondesr%C3%B4les
| Info |
|---|
Détails concernant le système de renommage des fichiers : Le modèle est construit à l'aide d'attributs entre crochets. default : [title] Les attributs disponibles sont :
|
tomcat
Ce paramètre permet de spécifier le port ajp dans le cas ou l'application est démarrée directement (en lançant directement esup-signature.war ou en utilisant mvn springboot:run par exemple)
Par défaut ces lignes sont commentées, cela doit être ainsi lorsque l'application est démarrée par un serveur Tomcat.
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
tomcat:
ajp:
port: 6009 |
spring
session
À ne pas modifier. Permet l'activation de spring-session.
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
session:
jdbc:
initialize-schema: always
save-mode: always |
data, datasource
Activation de ldapRepository et configuration de la base de donnée :
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
data: ldap: repositories:file-name-spaces-replace-by: " " # Remplacer les espaces dans les noms de fichiers par le caractère suivant csv-quote: "\"" # Quote CSV csv-separator: ";" # Séparateur CSV otp-validity: 10 # Durée de validité des liens de OTP en minutes # authorized-sign-types: imagestamp, nexucert # Liste des types de signature autorisés (par défault tous les types). Les types possibles sont : autoCert, groupCert, imageStamp, nexuCert, openPkiCert, sealCert, userCert export-attachements: true # Exporter les pièces jointes (si actif, l'export sera un dossier contenant le document signé ainsi que les PJ) external-signature-params: # Configuration des signatures des externes add-watermark: false add-extra: true extra-type: false extra-name: false enabled: true datasourceextra-date: true driverextra-classon-nametop: org.postgresql.Drivertrue # url: jdbc:postgresql://localhost:5432/esupsignature password: esup username: esupsignature jdbc-url: ${spring.datasource.url} hikari: auto-commit: false |
jpa
Il faut prêter une attention particulière au paramètre ddl-auto. Mode update permet la création et la mise à jour de la base de donnée lors du démarrage de l'application ou des tests. Ce mode peut éventuellement être utilisé lors des mises à jour de l'application. Le reste du temps (en production par exemple) ce paramètre peut être positionné sur validate qui ne fera qu’exécuter un contrôle de la base de données.
| Avertissement |
|---|
Attention au mode create qui, lui, détruit et re-crée la base complète au moment du démarrage de l'application |
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
jpa:
hibernate:
ddl-auto: update
properties:
hibernate:
dialect: org.hibernate.dialect.PostgreSQLDialect
format_sql: true
jdbc:
lob:
non_contextual_creation: true
show-sql: false
open-in-view: false |
ldap
Configuration de l'accès ldap pour spring (obligatoire si l'authentification CAS est activée)
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
ldap:
base: dc=univ-ville,dc=fr
password: ********
urls: ldap://ldap.univ-ville.fr
username: cn=consult,dc=univ-ville,dc=fr |
extra-text: ""
french-phone-number-only: false # Activer la vérification des numéros de téléphone français pour l'OTP
external-can-edit: false # Activer les annotations pour les utilisateurs externes (pour les demandes hors circuit)
search-for-external-users: false # Faire apparaitre les users externes dans la recherche full texte
seal-for-externals: false # Autoriser les externes à signer avec le cachet
seal-authorized-for-signed-files: false # Autoriser automatiquement le certificat cachet pour les demandes internes déjà signés avec un certificat
hide-hidden-visa: false # Indique si les vérification (visas cachés) doivent être masqués dans l'interface utilisateur. |
Pour les types de signatures voir : Documentation administrateur#Lesmoyensdesignature
Pour la gestion des rôles voir : Documentation administrateur#Gestiondesr%C3%B4les
| Info |
|---|
Détails concernant le système de renommage des fichiers : Le modèle est construit à l'aide d'attributs entre crochets. default : [title] Les attributs disponibles sont :
|
tomcat
Ce paramètre permet de spécifier le port ajp dans le cas ou l'application est démarrée directement (en lançant directement esup-signature.war ou en utilisant mvn springboot:run par exemple)
Par défaut ces lignes sont commentées, cela doit être ainsi lorsque l'application est démarrée par un serveur Tomcat.Configuration du serveur de mail pour l'envoi des alertes
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
tomcat: mailajp: hostport: smtp.univ-ville.fr |
servlet, thymeleaf, web, mvc
6009 |
...
spring
session
À ne pas modifier. Permet l'activation de spring-session.Ne pas modifier, concerne la configuration web de spring
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
servletsession: multipartjdbc: enabledinitialize-schema: truealways save-mode: max-file-size: 1280KBalways |
data, datasource
Configuration de la base de donnée :
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
datasource: maxdriver-requestclass-sizename: 1280KBorg.postgresql.Driver resolve-lazilyurl: true thymeleaf: jdbc:postgresql://localhost:5432/esupsignature cache: false encodingpassword: UTF-8esup mode: HTML username: servlet: produce-partial-output-while-processing: false web: esupsignature jdbc-url: ${spring.datasource.url} hikari: resourcesauto-commit: cache: cachecontrol: max-age: 1d cache-public: true static-locations: classpath:/static mvc: static-path-pattern: /** |
security
Via le protocole oauth2 inclus dans spring-security il est possible de configurer l'authentification avec n'importe quel fournisseur d'identité compatible.
Voici un exemple de configuration via France Connect
false |
jpa
Il faut prêter une attention particulière au paramètre ddl-auto. Mode update permet la création et la mise à jour de la base de donnée lors du démarrage de l'application ou des tests. Ce mode peut éventuellement être utilisé lors des mises à jour de l'application. Le reste du temps (en production par exemple) ce paramètre peut être positionné sur validate qui ne fera qu’exécuter un contrôle de la base de données.
| Avertissement |
|---|
Attention au mode create qui, lui, détruit et re-crée la base complète au moment du démarrage de l'application |
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
jpa:
hibernate:
ddl-auto: update
properties:
hibernate:
dialect: org.hibernate.dialect.PostgreSQLDialect
| ||||
| Bloc de code | ||||
| ||||
security: oauth2format_sql: true clientjdbc: lob: registration: non_contextual_creation: true show-sql: false open-in-view: false |
ldap
Configuration de l'accès ldap pour spring (obligatoire si l'authentification CAS est activée)
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
franceconnectldap: base: dc=univ-ville,dc=fr password: ******** provider urls: franceconnect-idpldap://ldap.univ-ville.fr username: cn=consult,dc=univ-ville,dc=fr |
Configuration du serveur de mail pour l'envoi des alertes
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
authorization-grant-type: authorization_codemail: host: smtp.univ-ville.fr |
servlet, thymeleaf, web, mvc
Ne pas modifier, concerne la configuration web de spring
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
servlet: client-id: <client_id> multipart: enabled: true client-secret: <client_secret>max-file-size: 1280KB max-request-size: 1280KB resolve-lazily: true thymeleaf: client-authentication-methodcache: client_secret_postfalse encoding: UTF-8 mode: HTML servlet: redirect-uri: "{baseUrl}/login/oauth2/code/{registrationId}"produce-partial-output-while-processing: false web: resources: cache: scopecachecontrol: - openidmax-age: 1d cache-public: true static- family_namelocations: classpath:/static mvc: static-path-pattern: /** |
security
Via le protocole oauth2 inclus dans spring-security il est possible de configurer l'authentification avec n'importe quel fournisseur d'identité compatible.
| Avertissement |
|---|
Attention, depuis la version 1.24, les noms de fournisseur franceconnect et proconnect sont reservés pour l'authentification des externes... De plus la configuration a changée ; une page dédiée est disponible ici : Signature des extérieurs (ProConnect, FranceConnect, SMS...) |
Pour configuer l'accès à la route /ws-jwt vous devez ajouter l'url de votre fournisseur de jetons :
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
security: - given_name - email oauth2: providerclient: provider: franceconnect-idp: authorization-uri: https://fcp.integ01.dev-franceconnect.fr/api/v1/authorizecas: tokenissuer-uri: https://fcpcas.integ01.devuniv-franceconnect.fr/api/v1/token ville.fr/oidc |
...
ldap
La configuration ldap hors spring est spécifique à votre établissement, elle précise les modalités de recherche de vos utilisateur dans l'annuaire
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
ldap: search-base: ou=people # Base de recherche des utilisateurs, ex : ou=people user-infoobject-uri: https://fcp.integ01.dev-franceconnect.fr/api/v1/userinfo user-name-attribute: sub user-info-authentication-method: header |
ldap
La configuration ldap hors spring est spécifique à votre établissement, elle précise les modalités de recherche de vos utilisateur dans l'annuaire
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
ldap: search-base: ou=people classes: inetOrgPerson # Object classes correspondant aux utilisateurs (un "ou" est appliqué aux valeurs de cette liste) group-object-classes: groupOfNames # Object classes correspondant aux groupes (un "ou" est appliqué aux valeurs de cette liste) ou-object-classes: organizationalUnit # Object classes correspondant aux OU (un "ou" est appliqué aux valeurs de cette liste) alias-object-classes: nisMailAlias # Base de recherche des utilisateurs, ex : ou=people groupusers-search-base: ou=groups filter: ((&(|(displayName={0}*)(cn={0}*)(uid={0})(mail={0}*))(mail=*)) # Filtre de recherche des utilisateurs group-search-base: ou=groups # Base de recherche des groupes, ex : ou=groups group-search-filter: member={0} # Filtre utilisé pour rechercher les groupes d'un utilisateur, ex : member={0} all-groups-search-filter: mailcn=*{0} # Filtre utilisé pour rechercher des groupes, ex : mailcn=*{0} user all-idaliases-search-filter: (uidmail={0}) # LeFiltre champutilisé danspour lequelrechercher ondes trouvealiases le login des utilisateurs, ex : (uid={0}) member user-id-search-filter: (&(uid={0})({1})) # Le Filtrechamp pourdans contrôlerlequel l’appartenanceon d’untrouve utilisateurle àlogin undes groupeutilisateurs, ex : &(uid={0})({1})) membersuser-ofeppn-group-search-filter: memberOf=cn(eduPersonPrincipalName={0},ou=groups,dc=univ-ville,dc=fr) # FiltreLe utiliséchamp pourdans retrouver les membres d’un groupelequel on trouve l'eppn des utilisateurs c'est ce champ qui sera utilisé comme identifiant unique en base, ex : memberOf=cn(eduPersonPrincipalName={0},ou=groups,dc=univ-ville,dc=fr eppn-left-part) user-mail-search-filter: (uidmail={0}) # PermetLe dechamp gérerdans lelequel cason oùtrouve l'eppnemail n'estdes pasutilisateurs construit, avecex <uid>@<domain>. Il faut donc spécifer le champ dans lequel on trouve la partie gauche de votre eppn mapping-filters-groups: : (mail={0}) ou-search-filter: (supannCodeEntite={0}) # ListeRequete d'attributionpour detrouver groupeles enOU fonctiondes d'un filtre LDAP student : "(eduPersonAffiliation:=student)" staff : "(eduPersonAffiliation:=staff)" |
| Info |
|---|
On peut utiliser mapping-filters-groups pour attribuer des groupes à un utilisateur, par exemple : avec mes-users : "eduPersonAffiliation:=member", toutes les personnes issue de ce filtre se verront affectées au groupe "mes-users" Si dans mapping-groups-roles on a mes-users: ROLE_USER, l'utilisateur obtiendra le rôle ROLE_USER. |
| Avertissement |
|---|
Attention vos requetes LDAP doivent impérativement être mises entre parentheses. |
Pour la gestion des rôles voir : Documentation administrateur#Gestiondesr%C3%B4les
Dans la partie mail (hors spring) vous pouvez paramétrer l'adresse from pour l'envoi de mails
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
mail:
from: no-reply.esup-signature@univ-ville.fr |
sms
Cette partie permet de configurer un service d'envoi de sms pour l'utilisation de la fonction One Time Password à destination des personnes extérieures à l’établissement. Des implémentations pour SMSU et pour OVH sont disponibles. Il est possible d'en ajouter en implémentant la classe https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/service/interfaces/sms/SmsService.java
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
sms:
enable-sms : false
# service-name: SMSU
# url: https://smsu-api.univ-ville.fr/
# username: sms-account
# password: ******** |
dss
tsp-server : adresse url du serveur de temps utilisé pour les horodatages des signatures électroniques
ks-filename : par défaut le chemin est relatif. Comme dans la configuration logback, si vous voulez spécifier un chemin absolu, le dossier doit avoir été créé avant le premier lancement.
trusted-certificat-url-list : ici vous pouvez ajouter des liens vers les url des certificats non présents dans le journal officiel mais valide dans votre établissent :
...
utilisateurs (utile seulement pour le pré-remplissage de l'affectation dans les formulaires)
member-search-filter: (&(uid={0})({1})) # Filtre pour contrôler l’appartenance d’un utilisateur à un groupe, ex : &(uid={0})({1}))
members-of-group-search-filter: memberOf=cn={0},ou=groups,dc=univ-ville,dc=fr # Filtre utilisé pour retrouver les membres d’un groupe, ex : memberOf=cn={0},ou=groups,dc=univ-ville,dc=fr
eppn-left-part-search-filter: (uid={0}) # Permet de gérer le cas où l'eppn n'est pas construit avec <uid>@<domain>. Il faut donc spécifer le champ dans lequel on trouve la partie gauche de votre eppn
mapping-filters-groups: # Liste d'attribution de groupe en fonction d'un filtre LDAP
student : "(eduPersonAffiliation:=student)"
staff : "(eduPersonAffiliation:=staff)" |
| Info |
|---|
On peut utiliser mapping-filters-groups pour attribuer des groupes à un utilisateur, par exemple : avec mes-users : "eduPersonAffiliation:=member", toutes les personnes issue de ce filtre se verront affectées au groupe "mes-users" Si dans mapping-groups-roles on a mes-users: ROLE_USER, l'utilisateur obtiendra le rôle ROLE_USER. |
| Avertissement |
|---|
Attention vos requetes LDAP doivent impérativement être mises entre parentheses. De plus les objectClasses des éléments recherchés sont ecrits en dur dans les classes PersonLdap, PersonLightLdap, OrganizationalUnitLdap et AliasLdap. Pour élargir le champ de recherche il faut modifier ces classes directement. Elle sont situées dans le dossier : src/main/java/org/esupportail/esupsignature/service/ldap/entry |
Pour la gestion des rôles voir : Documentation administrateur#Gestiondesr%C3%B4les
...
Dans la partie mail (hors spring) vous pouvez paramétrer l'adresse from pour l'envoi de mails
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
dssmail: cache-data-source-driver-class-namefrom: org.hsqldb.jdbc.JDBCDriver cache-data-source-url: jdbc:hsqldb:mem:cachedb cache-password: cache-username: sa default-validation-policy: policy/sign-constraint.xml server-signing-keystore-filename: validate_service.p12 server-signing-keystore-password: password server-signing-keystore-type: PKCS12 tsp-server: http://timestamp.sectigo.com ks-filename: oj_keystore.p12 ks-password: dss-password ks-type: PKCS12 lotl-country-code: EU lotl-url: https://ec.europa.eu/tools/lotl/eu-lotl.xml oj-url: https://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv:OJ.C_.2019.276.01.0001.01.ENG trusted-certificat-url-list: |
...
no-reply.esup-signature@univ-ville.fr |
...
sms
Cette partie permet de configurer un service d'envoi de sms pour l'utilisation de la fonction One Time Password à destination des personnes extérieures à l’établissement. Des implémentations pour SMSU et pour OVH sont disponibles. Il est possible d'en ajouter en implémentant la classe https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/service/interfaces/sms/SmsService.java
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
sms:
enable-sms : false
# service-name: SMSU
# url: https://smsu-api.univ-ville.fr/
# username: sms-account
# password: ******** |
...
dss
tsp-servers : adresses url des serveurs de temps utilisé pour les horodatages des signatures électroniques
| Remarque |
|---|
Pour que la signature soit valable, le fournisseur du timestamp doit apparaitre dans la liste European Trusted List (EUTL). Sur cette page on trouve une liste de serveurs utilisables : https://gist.github.com/Manouchehri/fd754e402d98430243455713efada710. Il faut faire attention à ne prendre que des fourniseurs Adobe ou EUTL. Par défaut, DSS Signature propose d'utiliser http://tsa.belgium.be/connect cependant il semble que le serveur impose un nombre maximum de requetes. Depuis la version 1.28.9 il est possible de saisir plusieurs urls. Dans ce cas le système essai chaque adresse jusqu'a obtenir un timestamp. |
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
proxydss: httpEnabled: "true"cache-data-source-driver-class-name: org.hsqldb.jdbc.JDBCDriver httpHost: "proxy.univ-ville.fr"cache-data-source-url: jdbc:hsqldb:mem:cachedb httpPort: "3128"cache-password: httpUsercache-username: ""sa httpPassworddefault-validation-policy: ""policy/sign-constraint.xml httpsEnabled: "true"server-signing-keystore-filename: validate_service.p12 httpsHost: "proxy.univ-ville.fr"server-signing-keystore-password: password httpsPortserver-signing-keystore-type: "3128"PKCS12 httpsUsertsp-servers: "" - httpsPassword: ""http://timestamp.sectigo.com/qualified - http://tsa.belgium.be/connect httpExcludedHostslotl-country-code: ""EU httpsExcludedHosts: "" |
fs (file system)
La partie file system (fs) permet de configurer une source principale de donnée pour chaque type de stockage (smb, cmis, vfs). esup-signature ne prend en charge qu'une seule source par type.
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
fs:lotl-url: https://ec.europa.eu/tools/lotl/eu-lotl.xml smboj-loginurl: esup-signature # login du compte autorisé à acceder au partage SMB smb-password: ******** smb-uri-test: smb://smb.univ-ville.frhttps://eur-lex.europa.eu/legal-content/EN/TXT/?uri=uriserv:OJ.C_.2019.276.01.0001.01.ENG country: FR # Informations de localisation qui apparaîtront dans les signatures électroniques state-or-province: Région # chemin vers un partage Informations de test.localisation Pourqui smbapparaîtront ildans serales possible d'utiliser des chemins absolus vfs-test-uri: /tmpsignatures électroniques postal-code: XXXXX # cheminInformations versde unlocalisation repertoirequi localapparaîtront dedans test.les Poursignatures vfsélectroniques il sera possible d'utiliser des chemins absolus (FTP compris) cmis-uri-test: https://esup-signature.univ-ville.fr/nuxeo locality: Ville # Informations de localisation qui apparaîtront dans les signatures électroniques check-revocation-for-untrusted-chains: true # urlDébloque dula cheminpossibilité versde lesigner serveuravec CMISdes /!\certificats cenon chemineIDas sertsi pouron autantmet pourfalse les(ex tests: que comme reférence absolue du serveurSectigo Rénater) cmis-login: Administratormulti-thread-tl-validation: true # loginRécupération autorisédes àtrustlists accederen aumulti serveur CMIS cmis-password: Administrator cmis-respository-id: default cmis-root-path: /default-domain/workspacesthread accept-signature-field-overlap: false # Permet chemind'autoriser versla lesuperposition dossierdes accéssiblesignatures par esup-signature |
| Avertissement |
|---|
Il y a actuellement une confusion concernant la configuration des acces aux stockages externes. Pour les stockages utilisant de SMB ou VFS, il s'agit de configurer une url de test (pour les test d'intégration). Par la suite, au niveau du paramétrage dans esup-signature, il sera possible de mettre n'importe quel url absolue (pour smb, le compte configuré devra avoir les bons accès) Pour CMIS, l'attribut cmis-uri-test est mal nommé car il s'agit de l'adresse "fixe" du server CMIS (Nuxeo par ex). Au niveau de l'application il faudra configurer des adresses relatives. Pour plus d'information voir la page Gestion des circuits#D%C3%A9finirunesourcepourlesdocuments |
Paramètres de traitement des PDF
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
pdf:
convert-to-pdf-a: true
path-to-g-s: /usr/bin/gs
pdf-a-level: 2
pdf-to-image-dpi: 72 |
security
La sécurité est gérée par Spring Security. Il est possible d'activé 3 mécanismes de sécurité : OAuth, Shibboleth et/ou CAS. Pour désactiver une ou l'autre de ces méthodes, il suffit de commenter les lignes qui s'y réfèrent.
| Avertissement |
|---|
Pour une explication détaillée du fonctionnement de la sécurité, voir : Configuration de la sécurité |
| Info | ||
|---|---|---|
| ||
Pour CAS : url : l'adresse de votre serveur CAS service : l'url de votre esup-signature + /login/cas |
| Remarque |
|---|
CAS nécessite la configuration d'un LDAP. C'est la solution idéale pour une utilisation interne |
| Info | ||
|---|---|---|
| ||
Pour Shibboleth : credentials-request-header : attribut dans lequel on trouve les groupes de l'utilisateur idp -url : adresse de votre IDP Shibboleth principal-request-header : attribut dans lequel on trouve l'identifiant de l'utilisateur |
pades visuelles
|
Si votre serveur se trouve derrière un forward proxy, vous pouvez ajouter la configuration suivante directement à la racine du fichier de configuration. Cela permet à DSS d'aller chercher les certificats de confiance sur les serveurs européens
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
proxy:
http-enabled: true
http-host: localhost
http-port: 3128
http-user:
http-password:
http-excluded-hosts:
https-enabled: true
https-host: localhost
https-port: 3128
https-user:
https-password:
https-excluded-hosts: |
...
fs (file system)
La partie file system (fs) permet de configurer une source principale de donnée pour chaque type de stockage (smb, cmis, vfs). esup-signature ne prend en charge qu'une seule source par type.
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
fs:
smb-login: esup-signature # login du compte autorisé à acceder au partage SMB
smb-password: ********
smb-uri-test: smb://smb.univ-ville.fr # chemin vers un partage de test. Pour smb il sera possible d'utiliser des chemins absolus
vfs-test-uri: /tmp # chemin vers un repertoire local de test. Pour vfs il sera possible d'utiliser des chemins absolus (FTP compris)
cmis-uri-test | ||||
| Bloc de code | ||||
| ||||
security: cas: service: https://esup-signature.univ-ville.fr/login/cas title: Compte Université (CAS) url: https://cas.univ-ville.fr # shib: # credentials-request-header: MEMBER # idp-url: https://idp.univ-ville.fr # principal-request-header: REMOTE_USER # title: Compte d’un autre établissement (Shibboleth) # domains-white-list-url: https://eduspot.renater.fr/eduspot/whitelist-eduspot.txt web: group-to-role-filter-pattern: <pattern groupe esup-signature>(\w*) #ici on configure un pattern permettant de retrouver (discerner) vos groupes dédiés à esup-signature mapping-groups-roles:nuxeo # url du chemin vers le serveur CMIS /!\ ce chemin sert pour autant pour les tests que comme reférence absolue du serveur cmis-login: Administrator # login autorisé à acceder au serveur CMIS cmis-password: Administrator cmis-respository-id: default cmis-root-path: /default-domain/workspaces # chemin vers le dossier accéssible par esup-signature |
| Avertissement |
|---|
Il y a actuellement une confusion concernant la configuration des acces aux stockages externes. Pour les stockages utilisant de SMB ou VFS, il s'agit de configurer une url de test (pour les test d'intégration). Par la suite, au niveau du paramétrage dans esup-signature, il sera possible de mettre n'importe quel url absolue (pour smb, le compte configuré devra avoir les bons accès) Pour CMIS, l'attribut cmis-uri-test est mal nommé car il s'agit de l'adresse "fixe" du server CMIS (Nuxeo par ex). Au niveau de l'application il faudra configurer des adresses relatives. Pour plus d'information voir la page Gestion des circuits#D%C3%A9finirunesourcepourlesdocuments |
...
Paramètres de traitement des PDF
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
pdf: convert-to-pdf-a: true path-to-g-s: /usr/bin/gs pdf-a-level: 2 pdf-to-image-dpi: 72 auto-rotate: true # Corrige automatiquement la rotation des documents en portait <nomqui duont groupeété destournés administrateurs>: ROLE_ADMIN de 90° gs-command-params: -dSubsetFonts=true <nom du groupe utilisateur autorisés à accéder à l'application>: ROLE_USER ws-access-authorize-ips: 127.0.0.1 # group-mapping-spel: # for.esup-signature.user: "true" |
| Info |
|---|
group-to-role-filter-pattern: Ce pattern permet de donner automatiquement les rôles correspondants à la partie (\w*) du pattern. Prenons le pattern for.esup-signature.role.(\w*), si l'utilisateur est dans le groupe for.esup-signature.role.bondecommande, il obtiendra automatiquement le role ROLE_BONDECOMMANDE utilisable par la suite pour donner des droits au niveau des formulaires et des circuits. mapping-groups-roles: Permet de définir des rôles en fonction des groupes de l'utilisateur. Le ROLE_USER est maintenant obligatoire pour accéder à l'application. Si constituer un groupe d'utilisateur est difficile, vous pouvez utiliser mapping-filters-groups dans la conf ldap pour constituer des groupes à l'aide de requêtes ldap. ws-access-authorize-ips : permet de configurer les adresses autorisées à accéder aux web services d' esup-signature group-mapping-spel: Sert à outre passer les groupes obtenus via ldap. Ceci est utiles si vous n'avez pas de configuration LDAP (shibboleth seul par exemple). On utilise alors la syntaxe SePL (Spring Expression Language), avec seulement l'attribut #eppn pris en compte ainsi que la possibilité de mettre la valeur "true". Ex: pour ajouter à tout le monde le groupe "for.esup-signature.user" on peut mettre for.esup-signature.user: "true". On peut aussi utiliser la syntaxe suivante pour saisir "en dure" des personnes : for.esup-signature.admin: "#eppn == 'toto@univ-ville.fr' or #eppn == 'titi@univ-ville.fr' " |
server
Paramètre du serveur tomcat embarqué dans spring-boot
-dEmbedAllFonts=true -dAlignToPixels=0 -dGridFitTT=2 -dCompatibilityLevel=1.4 -sColorConversionStrategy=RGB -sDEVICE=pdfwrite -dPDFACompatibilityPolicy=1 |
Attention l'option -dPDFSTOPONERROR anciennement présente semble poser des problèmes lors de la convertion (en cas d'erreur le document est renvoyer même s'il n'est pas fini de convertir)
...
security
La sécurité est gérée par Spring Security. Il est possible d'activé 3 mécanismes de sécurité : OAuth, Shibboleth et/ou CAS. Pour désactiver une ou l'autre de ces méthodes, il suffit de commenter les lignes qui s'y réfèrent.
| Avertissement |
|---|
Pour une explication détaillée du fonctionnement de la sécurité, voir : Configuration de la sécurité |
| Info | ||
|---|---|---|
| ||
Pour CAS : url : l'adresse de votre serveur CAS service : l'url de votre esup-signature + /login/cas |
| Remarque |
|---|
CAS nécessite la configuration d'un LDAP. C'est la solution idéale pour une utilisation interne |
| Info | ||
|---|---|---|
| ||
Pour Shibboleth : credentials-request-header : attribut dans lequel on trouve les groupes de l'utilisateur idp -url : adresse de votre IDP Shibboleth principal-request-header : attribut dans lequel on trouve l'identifiant de l'utilisateur |
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
security:
cas:
service: https://esup-signature.univ-ville.fr/login/cas | ||||
| Bloc de code | ||||
| ||||
server: servlet: session: tracking-modestitle: COOKIE Compte error:Université (CAS) include-stacktraceurl: always port: 8080 https://cas.univ-ville.fr # tomcatshib: # mbeanregistry: credentials-request-header: MEMBER # enabled: true remoteip: remote-ip-header: X-Forwarded-For basedir: ./tem |
sign
idp-url: https://idp.univ-ville.fr
# principal-request-header: REMOTE_USER
# title: Compte d’un autre établissement (Shibboleth)
# domains-white-list-url: https://eduspot.renater.fr/eduspot/whitelist-eduspot.txt
web:
group-to-role-filter-pattern: <pattern groupe esup-signature>(\w*) #ici on configure un pattern permettant de retrouver (discerner) vos groupes dédiés à esup-signature
mapping-groups-roles:
<nom du groupe des administrateurs>: ROLE_ADMIN
<nom du groupe utilisateur autorisés à accéder à l'application>: ROLE_USER
ws-access-authorize-ips: 127.0.0.1
# group-mapping-spel:
# for.esup-signature.user: "true" |
| Info |
|---|
group-to-role-filter-pattern: Ce pattern permet de donner automatiquement les rôles correspondants à la partie (\w*) du pattern. Prenons le pattern for.esup-signature.role.(\w*), si l'utilisateur est dans le groupe for.esup-signature.role.bondecommande, il obtiendra automatiquement le role ROLE_BONDECOMMANDE utilisable par la suite pour donner des droits au niveau des formulaires et des circuits. mapping-groups-roles: Permet de définir des rôles en fonction des groupes de l'utilisateur. Le ROLE_USER est maintenant obligatoire pour accéder à l'application. Si constituer un groupe d'utilisateur est difficile, vous pouvez utiliser mapping-filters-groups dans la conf ldap pour constituer des groupes à l'aide de requêtes ldap. ws-access-authorize-ips : permet de configurer les adresses autorisées à accéder aux web services d' esup-signature. On peux mettre autant d'adresses que souhaité séparées par des virgules ainsi que des plages du genre 192.168.1.0/24. (Exemple : ws-access-authorize-ips : 127.0.0.1, 192.168.1.0/24, 10.54.20.11, etc. ) group-mapping-spel: Sert à outre passer les groupes obtenus via ldap. Ceci est utiles si vous n'avez pas de configuration LDAP (shibboleth seul par exemple). On utilise alors la syntaxe SePL (Spring Expression Language), avec seulement l'attribut #eppn pris en compte ainsi que la possibilité de mettre la valeur "true". Ex: pour ajouter à tout le monde le groupe "for.esup-signature.user" on peut mettre for.esup-signature.user: "true". On peut aussi utiliser la syntaxe suivante pour saisir "en dure" des personnes : for.esup-signature.admin: "#eppn == 'toto@univ-ville.fr' or #eppn == 'titi@univ-ville.fr' " |
...
server
Paramètre du serveur tomcat embarqué dans spring-boot
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
servlet:
session:
timeout: 1800 # Durée de session en secondes
tracking-modes: cookie
error:
include-stacktrace: always
port: 8080
tomcat:
mbeanregistry:
enabled: true
remoteip:
remote-ip-header: X-Forwarded-For
basedir: ./tem |
server.tomcat.remote-ip-header=X-Forwarded-For
Spécifie l'en-tête contenant l'IP du client réel (généralementX-Forwarded-For).server.tomcat.protocol-header=X-Forwarded-Proto
Indique l'en-tête à utiliser pour définir le protocole HTTP/HTTPS d'origine (X-Forwarded-Proto).server.tomcat.internal-proxies=192\\.168\\.\\d{1,3}\\.\\d{1,3}Spécifie une expression régulière pour définir les proxys internes de confiance. Cela permet de configurer quels proxys sont considérés comme dignes de confiance pour envoyer l'en-tête X-Forwarded-For.
Dans cet exemple, toute adresse IP correspondant au sous-réseau 192.168.x.x sera considérée comme un proxy interne.
Plus de détails sur cette page https://docs.spring.io/spring-boot/docs/2.0.x/reference/html/howto-embedded-web-servers.html#howto-customize-tomcat-behind-a-proxy-server
...
sign
Vous pouvez ajuster finement les paramètres de signature électronique en particuler le niveau défini par la norme ETSI EN 319 102-1.
| Info | ||
|---|---|---|
| ||
La norme ETSI EN 319 102-1 (cf. [R09] ) définit quatre classes de conformité pour répondre au besoin de protéger la validité de la signature dans le temps. Désormais, pour désigner la classe de la signature, on utilisera le mot « niveau ». Suit la liste des profils implémentant les quatre classes définies dans la norme :
|
Les ajustements sont à opérer ici Vous pouvez ajuster finement les paramètres de signature électronique en modifiant les lignes suivante :
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
sign:
cades-digest-algorithm: SHA256
cades-signature-level: CAdES_BASELINE_TLT
container-type: ASiC_E
default-signature-form: XAdES
pades-digest-algorithm: SHA256
pades-signature-level: PAdES_BASELINE_TLT
password-timeout: 60000
signature-packaging: ENVELOPED
xades-digest-algorithm: SHA256
xades-signature-level: XAdES_BASELINE_T-level: XAdES_BASELINE_LT
sign-with-expired-certificate: false #Débloque la possibilité de signer avec des certificats exprirés (pour les tests) |
...
logging
Permet de spécifier l'emplacement pour le fichier de logs ainsi que l'usage (facultatif) d'un fichier de configuration logback (voir chapitre suivant)
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
logging:
file:
name: logs/esup-signature.log
level:
root: info
org.esupportail.esupsignature: info
org.verapdf: error
org.apache.pdfbox: error
eu.europa.esig.dss: error
org.springframework.web.filter.CommonsRequestLoggingFilter: error
# config: classpath:logback-prod.xml # permet de configurer logback via un fichier xml |
...
springdoc
Active l'api-doc. Pour permettre l'usage des web service directement depuis swagger, il faut modifier supported-submit-methods avec ["get", "post", "put"]
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
springdoc:
api-docs:
enabled: true
swagger-ui:
enabled: true
supported-submit-methods: []
packages-to-scan: org.esupportail.esupsignature.web.ws, org.esupportail.esupsignature.web.wsjwt
|
...
| Avertissement | |||||||
|---|---|---|---|---|---|---|---|
Lorsque votre configuration sera terminée, vous devez creer un commit git, ceci afin d'éviter tout problème lors d'une prochaine mise à jour. Les commandes git à lancer:
|
logback.xml
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
<appender name="FILE" class="ch.qos.logback.core.FileAppender">
<file>logs/esup-signature.log</file>
<append>true</append>
<immediateFlush>true</immediateFlush>
<encoder>
<pattern>[%-5level] %date{dd/MM/yyyy HH:mm:ss} %logger{35} - %msg%n</pattern>
</encoder>
</appender>
- %msg%n</pattern>
</encoder>
</appender>
|
src/main/resources/i18n/messages.properties
Vous pouvez modifier les premières ligne du fichier messages.properties pour spécifier le texte du footer et le titre de l'application
| Bloc de code | ||||
|---|---|---|---|---|
| ||||
application.title = Esup Signature
application.footer=Université de Rouen Normandie |
...
Logos et filigrane
Vous avez la possibilité de modifier les logos et le filigrane de la signatire(watermark). Pour cela vous devez modifier les fichiers qui se trouvent dans le dossier src/main/resources/static/
...
Vous pouvez modifier les premières ligne du fichier messages.properties pour spécifier le texte du footer et le titre de l'application
...
| language | java |
|---|---|
| theme | RDark |
...
images/ :
- Le logo esup-signature correspond aux fichiers logo.png et logo.svg (le png doit faire maximun 45px de haut si vous ne voulez pas avoir à moddifier le css)
- Le logo de l'unviversité visible dans les emails correspond au fichier logo-univ.png
- Le filigrane correspond au fichier watermark.png. Ses dimenssions doivent être de 300*150 ou de 600*300
...
| Astuce |
|---|
La suite ici : Compilation et déploiement |
...