Skip to content

Commit

Permalink
Merge pull request #419 from ietf-wg-gnap/aasvg
Browse files Browse the repository at this point in the history
Translate diagrams to SVG
  • Loading branch information
jricher committed May 12, 2022
2 parents bd00439 + e1c5550 commit ef06edf
Show file tree
Hide file tree
Showing 14 changed files with 402 additions and 335 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
.refcache
publish
node_modules
24 changes: 24 additions & 0 deletions diagram/async.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
+--------+ +--------+ .----.
| Client | | AS | | RO |
|Instance+--(1)--- Request Access --------->| | | |
| | | | | |
| |<-(2)-- Not Yet Granted (Wait) ---+ | | |
| | | |<==(3)==>| |
| | | | AuthN | |
| +--(6)--- Continue Request (A) --->| | | |
| | | |<==(4)==>| |
| |<-(7)-- Not Yet Granted (Wait) ---+ | AuthZ | |
| | | | | |
| | | |<==(5)==>| |
| | | |Completed| |
| | | | | |
| +--(8)--- Continue Request (B) --->| | `----`
| | | |
| |<-(9)------ Grant Access ---------+ |
| | | |
| | | | +--------+
| +--(10)-- Access API ---------------------------->| RS |
| | | | | |
| |<-(11)-- API Response ---------------------------+ |
| | | | +--------+
+--------+ +--------+
26 changes: 26 additions & 0 deletions diagram/hash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
.----. .------. +--------+ +--------+
| User | |Attacker| | Client | | AS |
| | | | |Instance| | |
| | | | | | | |
| | | +=(1)=>| | | |
| | | | | +-(2)->| |
| | | | | |<-(3)-+ |
| | | |<=(4)=+ | | |
| | | | | | | |
| | | +==(5)================>| |
| | | | | | | |
| | | |<================(6)==+ |
| | | | | | | |
| +==(A)================>| | | |
| | | | | +-(B)->| |
| | | | | |<-(C)-+ |
| |<=================(D)=+ | | |
| | | | | | | |
| +==(E)================================>| |
| | | | | | | |
| |<=(7)=+ | | | | |
| | | | | | | |
| +==(F)================>| | | |
| | | | | +-(G)->| |
| | | | | | | |
`----` `------` +--------+ +--------+
37 changes: 37 additions & 0 deletions diagram/overall.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
.----------. .----------.
| End user | ~ ~ ~ ~ | Resource |
| | | Owner (RO) |
`----+-----` `-----+----`
║ ║
║ ║
(A) (B)
║ ║
║ ║
+-----+--+ ║ +------------+
| Client | (1) ║ | Resource |
|Instance|| Server |
| | +-----------+---+ | (RS) |
| +--(2)-->| Authorization | | |
| |<-(3)---+ Server | | |
| | | (AS) | | |
| +--(4)-->| | | |
| |<-(5)---+ | | |
| | | | | |
| +---------------(6)------------->| |
| | | | (7) | |
| |<--------------(8)------------->| |
| | | | | |
| +--(9)-->| | | |
| |<-(10)--+ | | |
| | | | | |
| +---------------(11)------------>| |
| | | | (12) | |
| +--(13)->| | | |
| | | | | |
+--------+ +---------------+ +------------+

Legend
===== indicates a possible interaction with a human
----- indicates an interaction between protocol roles
~ ~ ~ indicates a potential equivalence or out-of-band
communication between roles
29 changes: 29 additions & 0 deletions diagram/redirect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
+--------+ +--------+ .----.
| Client | | AS | | User |
|Instance| | | | |
| |<=(1)== Start Session ===============================+ |
| | | | | |
| +--(2)--- Request Access --------->| | | |
| | | | | |
| |<-(3)-- Interaction Needed -------+ | | |
| | | | | |
| +=(4)== Redirect for Interaction ====================>| |
| | | | | |
| | | |<==(5)==>| |
| | | | AuthN | |
| | | | | |
| | | |<==(6)==>| |
| | | | AuthZ | |
| | | | | |
| |<=(7)== Redirect for Continuation ===================+ |
| | | | `----`
| +--(8)--- Continue Request ------->| |
| | | |
| |<-(9)----- Grant Access ----------+ |
| | | |
| | | | +--------+
| +--(10)-- Access API ---------------------------->| RS |
| | | | | |
| |<-(11)-- API Response ---------------------------| |
| | | | +--------+
+--------+ +--------+
23 changes: 23 additions & 0 deletions diagram/refresh.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
+--------+ +--------+
| Client | | AS |
|Instance+--(1)--- Request Access ----------------->| |
| | | |
| |<-(2)--- Grant Access --------------------+ |
| | | |
| | +--------+ | |
| +--(3)--- Access Resource --->| RS | | |
| | | | | |
| |<-(4)--- Success Response ---+ | | |
| | | | | |
| | | | | |
| | | | | |
| +--(5)--- Access Resource --->| | | |
| | | | | |
| |<-(6)--- Error Response -----+ | | |
| | +--------+ | |
| | | |
| +--(7)--- Rotate Token ------------------->| |
| | | |
| |<-(8)--- Rotated Token -------------------+ |
| | | |
+--------+ +--------+
31 changes: 31 additions & 0 deletions diagram/roles.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
+-------------+ +------------+
| | | |
|Authorization| | Resource |
| Server | | Server |
| |<--+ +--->| |
+-----+-------+ | | +------------+
║ | |
║ | |
║ | |
║ | |
║ | |
║ +--+---+---+
║ | Client |
║ | Instance |
║ +----+-----+
║ ║
║ ║
║ ║
.----+----. ║ .----------.
| | +=====+ |
| Resource | | End |
| Owner | ~ ~ ~ ~ ~ ~ | User |
| | | |
`---------` `----------`

Legend

===== indicates interaction between a human and computer
----- indicates interaction between two pieces of software
~ ~ ~ indicates a potential equivalence or out-of-band
communication between roles
11 changes: 11 additions & 0 deletions diagram/software.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
+--------+ +--------+
| Client | | AS |
|Instance+--(1)--- Request Access --->| |
| | | |
| |<-(2)---- Grant Access -----+ |
| | | | +--------+
| +--(3)--- Access API ------------------->| RS |
| | | | | |
| |<-(4)--- API Response ------------------+ |
| | | | +--------+
+--------+ +--------+
22 changes: 22 additions & 0 deletions diagram/subject.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
+--------+ +--------+ .----.
| Client | | AS | | User |
|Instance| | | | |
| +--(1)--- Request Access --------->| | | |
| | | | | |
| |<-(2)-- Interaction Needed -------+ | | |
| | | | | |
| +==(3)== Facilitate Interaction =====================>| |
| | | | | |
| | | |<==(4)==>| |
| | | | AuthN | |
| | | | | |
| | | |<==(5)==>| |
| | | | AuthZ | |
| | | | | |
| |<=(6)== Signal Continuation =========================+ |
| | | | `----`
| +--(7)--- Continue Request ------->| |
| | | |
| |<-(8)----- Grant Access ----------+ |
| | | |
+--------+ +--------+
33 changes: 33 additions & 0 deletions diagram/usercode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
+--------+ +--------+ .----.
| Client | | AS | | User |
|Instance+--(1)--- Request Access --------->| | | |
| | | | | |
| |<-(2)-- Interaction Needed -------+ | | |
| | | | | |
| +==(3)==== Display User Code ========================>| |
| | | | | |
| | | |<==(4)===+ |
| | | |Open URI | |
| | | | | |
| | | |<==(5)==>| |
| | | | AuthN | |
| +--(9)--- Continue Request (A) --->| | | |
| | | |<==(6)==>| |
| |<-(10)-- Not Yet Granted (Wait) --+ | Code | |
| | | | | |
| | | |<==(7)==>| |
| | | | AuthZ | |
| | | | | |
| | | |<==(8)==>| |
| | | |Completed| |
| | | | | |
| +--(11)-- Continue Request (B) --->| | `----`
| | | |
| |<-(12)----- Grant Access ---------+ |
| | | |
| | | | +--------+
| +--(13)-- Access API ---------------------------->| RS |
| | | | | |
| |<-(14)-- API Response ---------------------------+ |
| | | | +--------+
+--------+ +--------+

0 comments on commit ef06edf

Please sign in to comment.