Web service /ws-jwt

Depuis la version 1.34, il existe une nouvelle route /ws-jwt sécurisée par JWT. Grâce au jwt, l'utilisateur signataire est authentifié, ce qui permet de signer directement le document que l'on upload.

Pour que cela fonctionne, il faut configurer l'adresse issuer du fournissuer de jeton (à l'université Rouen c'est CAS qui fourni les jetons) ici : Configuration#security

Lorsque le l'appel des web service de la route /ws-jwt, il faut transmettre le jwt soit via le header (bearer <token>), soit via un cookie nommé "jwt".

Sécurité des web services /ws

L'accès aux web services est filtré par IP. Pour autoriser l'accès il faut modifier la configuration en ajoutant l'IP de la machine concernée au niveau du paramètre ws-access-authorize-ips ici :

Configuration#security.1

Sécurisation par tokens

Depuis la version 1.29.x il est possible d'attribuer des tokens par workflows ou des tokens "wildcard" (donne accès à toutes les demandes). Mais si l'on utilise le système de tokens, il faut toujours autoriser L'IP du serveur distance dans ws-access-authorize-ips

Au niveau de l'interface admin il suffit d'ajouter des tokens dans "Token API": 

Image Added

On donne un nom au token est on selectionne le/les circuit(s) concerné(s)

Image Added

Ici on a deux type de token : "Tous les workflows" et un pour un circuit en particulier.

Lorsque d'un circuit est protégé par un token, l'IP ne suffit plus pour acceder aux demandes qu'il contient.

Il faut alors ajouter l'attribut X-API-Key contenant la clé, dans le header de la requête du client.

Voici un exemple de récupération d'une demande via curl:

curl --location --request GET 'http://dsi-7.univ-rouen.fr/ws/signrequests/23152' \
--header 'X-API-Key: ede824ef-7eea-4949-b9d3-427aa1b38baf'

Si vous utilisez une clé "wildcard", vous pourrez acceder à toutes les demandes quelque soit le circuit.

Tester les web services

Curl

...

Il est possible de tester les web services directement depuis voitre l'votre interface swagger https://<adresse esup signature>/swagger-ui.html . Pour cela il faut être admin et il faut modifier la valeur  supported-submit-methods dans application.yml

supported-submit-methods: ["get", "put", "post"]

...

...

Fonctionnement général

La première étape pour utiliser les web services est de créer un circuit au niveau de l'administration.

...

Enfin l'application métier pourra supprimer le document en faisant une requete DELETE sur l'adresse /ws/signrequests/{id}. Les éléments de vérification de la signature sont conservés dans esup-signature.

...

Le paramètre stepsJsonString

Depuis la version 1.28 vous pouvez passer une liste de "WorkflowStepDto" (https://github.com/EsupPortail/esup-signature/blob/master/src/main/java/org/esupportail/esupsignature/dto/WorkflowStepDto.java), dans tous les web services de création, pour configurer vos étapes.

Cela remplace les paramètres recipientEmails, signTypes, allSignToCompletes, etc., mais la rétrocompatibilité est maintenue.

Le JSON à transmettre doit représenter le même nombre d'étapes que celle présente dans le circuit configuré dans l'interface admin. La numérotation des steps (stepNumber) est obligatoire est démarre du chiffre 1.

[
{
  "title": "string",
  "stepNumber": 1,
  "description": "string",
  "recipientsCCEmails": [
    "string"
  ],
  "recipients": [
    {
      "email": "string",
      "phone": "string",
      "name": "string",
      "firstName": "string",
      "forceSms": true
    }
  ],
  "changeable": false,
  "signLevel": 0,
  "signType": "hiddenVisa",
  "repeatable": false,
  "repeatableSignType": "hiddenVisa",
  "allSignToComplete": true,
  "multiSign": true,
  "autoSign": false,
  "forceAllSign": true,
  "comment": "string",
  "attachmentRequire": true,
  "maxRecipients": 0
}
]

Exemple:

[{"title":"test1","stepNumber": 1,"description": "test1","recipients": [{"email": "toto@univ-ville.fr"}],"signLevel": 0,"signType": "pdfImageStamp", "allSignToComplete": true},{"title": "test2","stepNumber": 2,"description": "test2","recipients": [{"email": "titi@gmail.fr","phone": "0123456789","name":"Tata","firstName": "Titi"}],"signLevel": 0,"signType": "pdfImageStamp","allSignToComplete": true}]

...

Exemples

Démarrer un formulaire

Accès : https://<votre adresse>/ws/forms/{id}/new

Description : Ce web service va créer une nouvelle instance du formulaire désigné pas le paramètre "id" de l'url d'accès.

...

Exemple de commande curl :

curl -X 'POST' \
  'https-location --request POST 'http://esupdsi-signature7.univ-villerouen.fr/ws/formssignrequests/99999/new?eppn=esupd@univ-ville.fr&recipientEmails=2*toto@univ-ville.fr&recipientEmails=2*tata@univ-ville.fr&targetEmails=1*titi@univ-rouen.fr' \
  -H 'accept: */*' \
  -d 'new' \
--form 'multipartFiles=@"/home/lemaida3/Documents/sample.pdf"' \
--form 'createByEppn="test@univ-ville.fr"' \
--form 'stepsJsonString="[{\"signType\":\"pdfImageStamp\", \"recipients\": [{\"email\": \"david.lemaignent@univ-rouen.fr\"}, {\"email\": \"demo.esup@inv.univ-rouen.fr\"}]},
{\"recipients\": [{\"email\": \"david.lemaignent@univ-rouen.fr\"}, {\"email\": \"demo.esup@inv.univ-rouen.fr\"}]}]"'

Envoyer un document dans un circuit existant

Accès : https://<votre adresse>/ws/workwlosworkflows/{id}/new

Description : Ce web service va déposer d'un document dans une nouvelle instance d'un circuit

...

...

curl --vlocation -i -Xrequest POST 'https://esup-signature.univ-rouen.fr/ws/workflows/999999/new' \
	--Hform 'content-type: multipart/form-data;createByEppn="test@univ-rouen.fr"' \
--form 'title="TITRE"' \
	--Fform 'multipartFiles=@Document@"/home/lemaida3/Documents/esup-signature/sample.pdf"' \
	'https://esup-signature.univ-ville.fr/ws/workflows/99999/new?createByEppn=esup@univ-ville.fr&title=test--form 'recipientsJsonString="[{\"signType\":\"pdfImageStamp\", \"recipients\": [{\"email\": \"test.test@univ-ville.fr\"}, {\"email\": \"test2.test2@univ-ville.fr\"}]},
{\"signType\":\"certSign\", \"recipients\": [{\"email\": \"test.test@univ-ville.fr\"}, {\"email\": \"test2.test2@univ-ville.fr\"}]}]";type=application/json'