Skip to content

Commit

Permalink
[SAFRAN-1026] Update Security Scheme edition documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vrichard12 committed Nov 24, 2022
1 parent 36767f4 commit 16361fe
Show file tree
Hide file tree
Showing 14 changed files with 28 additions and 23 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -1485,14 +1485,14 @@
<firstModelOperations xsi:type="tool_1:SetValue" featureName="type" valueExpression="aql:newValue.instance"/>
</initialOperation>
</controls>
<controls xsi:type="properties:TextAreaDescription" name="soa::SecurityScheme description" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('description')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('description'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('description').changeable" valueExpression="aql:self.description">
<controls xsi:type="properties:TextDescription" name="soa::SecurityScheme name" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('name')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('name'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('name').changeable" valueExpression="aql:self.name">
<initialOperation>
<firstModelOperations xsi:type="tool_1:SetValue" featureName="description" valueExpression="var:newValue"/>
<firstModelOperations xsi:type="tool_1:SetValue" featureName="name" valueExpression="var:newValue"/>
</initialOperation>
</controls>
<controls xsi:type="properties:TextDescription" name="soa::SecurityScheme name" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('name')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('name'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('name').changeable" valueExpression="aql:self.name">
<controls xsi:type="properties:TextAreaDescription" name="soa::SecurityScheme description" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('description')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('description'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('description').changeable" valueExpression="aql:self.description">
<initialOperation>
<firstModelOperations xsi:type="tool_1:SetValue" featureName="name" valueExpression="var:newValue"/>
<firstModelOperations xsi:type="tool_1:SetValue" featureName="description" valueExpression="var:newValue"/>
</initialOperation>
</controls>
</groups>
Expand Down Expand Up @@ -1788,7 +1788,7 @@
<firstModelOperations xsi:type="tool_1:ChangeContext">
<subModelOperations xsi:type="tool_1:Let" variableName="invocationContext" valueExpression="addButton"/>
<subModelOperations xsi:type="tool_1:CreateInstance" typeName="soa::SecurityScheme" referenceName="securitySchemes">
<subModelOperations xsi:type="properties:DialogModelOperation" titleExpression="Security scheme edition">
<subModelOperations xsi:type="properties:DialogModelOperation" titleExpression="Security scheme creation">
<buttons labelExpression="Cancel" closeDialogOnClick="true" rollbackChangesOnClose="true">
<initialOperation>
<firstModelOperations xsi:type="tool_1:RemoveElement">
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<p>
<code>Authors</code> Stéphane Thibaudeau, Vincent Richard
<br/>
<code>Contacts</code> stephane.thibaudeau@obeo.fr, vincent.richard@obeo.fr
<code>Contacts</code> vincent.richard@obeo.fr
</p>
<h1 id="ISDSOADesigner">ISD &#8211; SOA Designer</h1>
<p>
Expand Down Expand Up @@ -865,21 +865,25 @@ <h5 id="Modlisationdesschmasdescurit">Modélisation des schémas de sécurité</
<em>Component</em>.
</p>
<p>La création d&#8217;un
<em>Security Scheme</em> déclenche l&#8217;affichage d&#8217;une boîte de dialogue permettant de le spécifier.
<br/>Les données disponibles dans la boite du dialogue sont adaptées au type de
<em>Security Scheme</em>:
<em>Security Scheme</em> déclenche l&#8217;affichage d&#8217;une boîte de dialogue permettant de spécifier son type, son nom et sa description :
<br/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Creation.png"/>
</p>
<p>Un double clic sur un
<em>Security Scheme</em> déclenche l&#8217;affichge d&#8217;un dialogue d'édition permettant de spécifier les données spécifiques au type de
<em>Security Scheme</em>.
</p>
<p>-
<strong>Api Key:</strong>
<br/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_ApiKey.PNG"/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_ApiKey.png"/>
<br/>Un
<em>Security Scheme</em> de type Api key permet la définition d&#8217;une clé, ainsi que la spécification de sa localisation: dans le header, la requête, ou le cookie.
</p>
<p>-
<strong>HTTP:</strong>
<br/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_HTTP.PNG"/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_HTTP.png"/>
<br/>Un
<em>Security Scheme</em> de type HTTP défini un schéma d&#8217;authentification de type Basic, ou Bearer.
<br/>Dans le cas d&#8217;un schéma d&#8217;authentification de type Basic, le server attendra un mot de passe de type username:password, encodé en base-64.
Expand All @@ -888,19 +892,19 @@ <h5 id="Modlisationdesschmasdescurit">Modélisation des schémas de sécurité</
<p>-
<strong>OAuth2:</strong>
<br/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_OAuth2.PNG"/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_OAuth2.png"/>
</p>
<p>-
<strong>Open ID:</strong>
<br/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_OpenID.PNG"/>
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_OpenID.png"/>
</p>
<p>Les
<em>Security Scheme</em> de type OAuth2 et Open ID requièrent la spécification de
<em>Flows</em>, ainsi que leurs
<em>Scopes</em> respectifs:
<br/>
<img border="0" src="pics/securityschemes/Dialog_Flow.PNG"/>
<img border="0" src="pics/securityschemes/Dialog_Flow_Edition.png"/>
</p>
<p>Les
<em>Flows</em> représentent des scénarios que le client effectue afin d&#8217;obtenir l&#8217;accès à un token d&#8217;authentification.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
__Copyright (c) 2008, 2022 Obeo - All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0__

@Authors@ Stéphane Thibaudeau, Vincent Richard
@Contacts@ stephane.thibaudeau@obeo.fr, vincent.richard@obeo.fr
@Contacts@ vincent.richard@obeo.fr

h1. ISD - SOA Designer

Expand Down Expand Up @@ -396,31 +396,32 @@ Les schemas de sécurité sont définis sur l'onglet _Security Schemes_ de la vu

Cette vue permet de créer (!pics/etool16/add.gif!), supprimer (!pics/etool16/delete.gif!) et réordonner (!pics/etool16/up.gif!, !pics/etool16/down.gif!) les _Security Schemes_ du _Component_.

La création d'un _Security Scheme_ déclenche l'affichage d'une boîte de dialogue permettant de le spécifier.
Les données disponibles dans la boite du dialogue sont adaptées au type de _Security Scheme_:
La création d'un _Security Scheme_ déclenche l'affichage d'une boîte de dialogue permettant de spécifier son type, son nom et sa description :
!pics/securityschemes/Dialog_SecurityScheme_Creation.png!

Un double clic sur un _Security Scheme_ déclenche l'affichge d'un dialogue d'édition permettant de spécifier les données spécifiques au type de _Security Scheme_.

- *Api Key:*
!pics/securityschemes/Dialog_SecurityScheme_ApiKey.PNG!
!pics/securityschemes/Dialog_SecurityScheme_Edition_ApiKey.png!
Un _Security Scheme_ de type Api key permet la définition d'une clé, ainsi que la spécification de sa localisation: dans le header, la requête, ou le cookie.

- *HTTP:*
!pics/securityschemes/Dialog_SecurityScheme_HTTP.PNG!
!pics/securityschemes/Dialog_SecurityScheme_Edition_HTTP.png!
Un _Security Scheme_ de type HTTP défini un schéma d'authentification de type Basic, ou Bearer.
Dans le cas d'un schéma d'authentification de type Basic, le server attendra un mot de passe de type username:password, encodé en base-64.
Dans le cas d'un schéma d'authentification de type Bearer, le bearer-format définit la manière dont le token est stocké.

- *OAuth2:*
!pics/securityschemes/Dialog_SecurityScheme_OAuth2.PNG!
!pics/securityschemes/Dialog_SecurityScheme_Edition_OAuth2.png!

- *Open ID:*
!pics/securityschemes/Dialog_SecurityScheme_OpenID.PNG!
!pics/securityschemes/Dialog_SecurityScheme_Edition_OpenID.png!

Les _Security Scheme_ de type OAuth2 et Open ID requièrent la spécification de _Flows_, ainsi que leurs _Scopes_ respectifs:
!pics/securityschemes/Dialog_Flow.PNG!
!pics/securityschemes/Dialog_Flow_Edition.png!

Les _Flows_ représentent des scénarios que le client effectue afin d'obtenir l'accès à un token d'authentification.
Chaque flow propose des _Scopes_. Ces scopes définissent un droit d'accès (restreint) a une fonctionnalité prodiguée par le serveur.


L'édition des valeurs saisies est modifiable par la suite en double-cliquant sur un _SecurityScheme_ dans cette même vue de propriétés, ou bien dans la vue de propriétés d'un _SecurityScheme_ lorsque celui-ci est séléctionné dans la vue _Model Explorer_ :

Expand Down
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.

0 comments on commit 16361fe

Please sign in to comment.