| ... |
... |
@@ -18,42
+18,8 @@ |
| 18 |
18 |
|
| 19 |
19 |
== Plugin-Konfiguration == |
| 20 |
20 |
|
| 21 |
|
-Am Plugin selber kann konfiguriert werden, ob das Deploy-Servlet durch ein Passwort geschützt werden soll. Dieses Passwort muss dann im Klartext beim HTTP-POST-Request mit angegeben werden. |
|
21 |
+== HTTP-Request-Aufbau == |
| 22 |
22 |
|
| 23 |
|
-Zur Konfiguration des Passworts gibt es die eine Plugin-Eigenschaft //token//, diese hat das folgende Format |
| 24 |
|
- |
| 25 |
|
-{{code language="none"}} |
| 26 |
|
-hash_method:hashed_value |
| 27 |
|
-{{/code}} |
| 28 |
|
- |
| 29 |
|
-Folgende Hash-Methoden stehen zur Verfügung: |
| 30 |
|
- |
| 31 |
|
-; plain |
| 32 |
|
-: Identitätsfunktion, das Passwort im Klartext angegeben. |
| 33 |
|
-; sha256 |
| 34 |
|
-: SHA-256-Algorithmus. |
| 35 |
|
-; sha384 |
| 36 |
|
-: SHA-384-Algorithmus. |
| 37 |
|
-; sha512 |
| 38 |
|
-: SHA-512-Algorithmus. |
| 39 |
|
- |
| 40 |
|
-Um das Passwort im Klartext beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben: |
| 41 |
|
- |
| 42 |
|
-{{code language="none"}} |
| 43 |
|
-plain:admin |
| 44 |
|
-{{/code}} |
| 45 |
|
- |
| 46 |
|
-Um das Passwort mit SHA-256 beispielsweise auf //admin// festzulegen, wird der folgende Wert für die Plugin-Eigenschaft //token// eingegeben: |
| 47 |
|
- |
| 48 |
|
-{{code language="none"}} |
| 49 |
|
-sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7 |
| 50 |
|
-{{/code}} |
| 51 |
|
- |
| 52 |
|
-Der Hash ist gesalzen. Ein gültiger Hash für ein bestimmtes Passwort kann mit dem //create-token//-Servlet erzeugt werden, siehe unten. |
| 53 |
|
- |
| 54 |
|
- |
| 55 |
|
-== Deploy-Servlet == |
| 56 |
|
- |
| 57 |
57 |
Im Folgenden wird der Aufbau des HTTP-Requests beschrieben, um ein Plugin zu installieren, zu aktualisieren oder zu löschen. |
| 58 |
58 |
|
| 59 |
59 |
Es muss immer ein HTTP-Post-Request verwendet werden und [[sich an folgende URL richten>>doc:Formcycle.PluginDevelopment.Types.IPluginServletAction]] (Namen des FORMCYCLE-Servers entsprechend anpassen): |
| ... |
... |
@@ -341,37
+341,4 @@ |
| 341 |
341 |
{{/code}} |
| 342 |
342 |
|
| 343 |
343 |
|
| 344 |
|
-== Create-Token-Servlet == |
| 345 |
|
- |
| 346 |
|
-Mit diesem Servlet kann ein Hash für ein bestimmtes Klartextpasswort erzeugt werden, welcher dann in der Plugin-Eigenschaft //token// hinterlegt werden kann. Es muss hierbei ein HTTP-GET-Request verwendet werden (Pfad auf den FORMCYCLE-Servet und die Mandant-ID entsprechend ersetzen): |
| 347 |
|
- |
| 348 |
|
-{{code language="none"}} |
| 349 |
|
-http://localhost:8080/formcycle/plugin?client-id=1&name=create-token&token=<PASSWORT>&method=<METHOD> |
| 350 |
|
-{{/code}} |
| 351 |
|
- |
| 352 |
|
-; token |
| 353 |
|
-: Der Klartext des Passwort, zu dem ein Hash ermittelt werden soll. |
| 354 |
|
-; method |
| 355 |
|
-: Methode zum Berechnen des Hashes. Erlaubte Werte sind //plain//, //sha256//, //sha384// und //sha512//. Optional, Standardwert ist //sha256//. |
| 356 |
|
- |
| 357 |
|
-Als Antwort wird ein JSON zurückgeliefert, welches das gleiche Format wie die Antwort des Deploy-Plugins hat. Beispiel für eine Antwort: |
| 358 |
|
- |
| 359 |
|
-{{code language="json"}} |
| 360 |
|
-{ |
| 361 |
|
- "success": true, |
| 362 |
|
- "requestParameters": { |
| 363 |
|
- "name": ["create-token"], |
| 364 |
|
- "client-id": ["1"], |
| 365 |
|
- "token": ["admin"] |
| 366 |
|
- }, |
| 367 |
|
- "details": { |
| 368 |
|
- "method": "sha256", |
| 369 |
|
- "token": "sha256:S+32GI3fWXwHHulUMtWmjpQ15EqMvgVYguuO9SKxfNw+ckAGQljP6tKlf1EITnU7" |
| 370 |
|
- }, |
| 371 |
|
- "message": "Hash token created successfully", |
| 372 |
|
- "statusCode": 200 |
| 373 |
|
-} |
| 374 |
|
-{{/code}} |
| 375 |
|
- |
| 376 |
376 |
== Beispiel für Maven == |
| 377 |
|
- |