summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJonathan Huot <JonathanHuot@users.noreply.github.com>2019-01-08 15:43:27 +0100
committerGitHub <noreply@github.com>2019-01-08 15:43:27 +0100
commit20d116c0db616285ca48ef1591a8a79796a76f5d (patch)
tree5e136ddfbda89dd623d25911c2f3fe8d7ec14439 /docs
parent9dfa40c3bdab3aa788e711283afdf36c2fbdd1de (diff)
downloadoauthlib-20d116c0db616285ca48ef1591a8a79796a76f5d.tar.gz
Fixed graphviz/dot graph & improved clarity (#642)
I fixed graphviz missing output to web responses (see image of https://github.com/oauthlib/oauthlib/pull/639), and I have added a fixed rank (`rank=same`) when functions are achieving an identical goal. E.g. `validate_client_id`, `validate_user`, `validate_bearer_token` are unique for each flows, or, e.g. `confirm_redirect_uri`, `validate_redirect_uri` together, and so on. ![graphviz-0cc58e8637b94d7402eda45a1fef6e68889bd8e1](https://user-images.githubusercontent.com/820496/50830407-042ad600-1348-11e9-936a-03d07f42494f.png)
Diffstat (limited to 'docs')
-rw-r--r--docs/oauth2/oauth2provider-legend.dot4
-rw-r--r--docs/oauth2/oauth2provider-server.dot103
2 files changed, 80 insertions, 27 deletions
diff --git a/docs/oauth2/oauth2provider-legend.dot b/docs/oauth2/oauth2provider-legend.dot
index 746ac2b..ad87d80 100644
--- a/docs/oauth2/oauth2provider-legend.dot
+++ b/docs/oauth2/oauth2provider-legend.dot
@@ -18,8 +18,8 @@ digraph oauthlib_legend {
flow_introspect [shape=none,label="Token Introspection"];
flow_revoke [shape=none,label="Token Revoke"];
flow_resource [shape=none,label="Resource Access"];
- flow_code_token -> a [style=bold,color=green];
- flow_code_auth -> b [style=bold,color=darkgreen];
+ flow_code_token -> a [style=bold,color=darkgreen];
+ flow_code_auth -> b [style=bold,color=green];
flow_implicit -> c [style=bold,color=orange];
flow_password -> d [style=bold,color=red];
flow_clicreds -> e [style=bold,color=blue];
diff --git a/docs/oauth2/oauth2provider-server.dot b/docs/oauth2/oauth2provider-server.dot
index bf7df75..ec24078 100644
--- a/docs/oauth2/oauth2provider-server.dot
+++ b/docs/oauth2/oauth2provider-server.dot
@@ -1,4 +1,11 @@
digraph oauthlib {
+ /* Naming conventions:
+ f_ : functions in shape=record
+ endpoint_ : endpoints in shape=record
+ webapi_ : oauthlib entry/exit points in shape=hexagon
+ if_ : internal conditions
+ r_ : used when returning from two functions into one for improving clarity
+ */
center="1"
edge [ style=bold ];
@@ -66,18 +73,58 @@ digraph oauthlib {
if_scopes [ label="if scopes"; ];
if_all [ label="all(request_scopes not in scopes)"; ];
+ /* OAuthlib functions returns helpers */
+ r_client_authenticated [ shape=none,label="client authenticated"; ];
+
/* OAuthlib errors */
e_normal [ shape=none,label="ERROR" ];
+ /* Ranking by functional roles */
+ {
+ rank = same;
+ f_validate_client_id;
+ f_validate_code;
+ /* f_validate_user; */
+ f_validate_bearer_token;
+ f_validate_refresh_token;
+ f_introspect_token;
+ f_revoke_token;
+ }
+ {
+ rank = same;
+ f_validate_redirect_uri;
+ f_confirm_redirect_uri;
+ }
+ {
+ rank = same;
+ f_save_bearer_token;
+ f_save_authorization_code;
+ }
+ {
+ rank = same;
+ f_invalidate_authorization_code;
+ }
+ {
+ rank = same;
+ f_validate_scopes;
+ f_get_original_scopes;
+ f_get_default_scopes;
+ }
+ {
+ rank = same;
+ f_is_within_original_scope;
+ }
+
/* Authorization Code - Access Token Request */
{
- edge [ color=green ];
+ edge [ color=darkgreen ];
endpoint_token:authorization_code:s -> f_client_authentication_required;
f_client_authentication_required:true:s -> f_authenticate_client;
- f_client_authentication_required:false -> f_authenticate_client_id;
- f_authenticate_client:true:s -> f_validate_grant_type;
- f_authenticate_client_id:true:s -> f_validate_grant_type;
+ f_client_authentication_required:false:s -> f_authenticate_client_id;
+ f_authenticate_client:true:s -> r_client_authenticated [ arrowhead=none ];
+ f_authenticate_client_id:true:s -> r_client_authenticated [ arrowhead=none ];
+ r_client_authenticated -> f_validate_grant_type;
f_validate_grant_type:true:s -> f_validate_code;
f_validate_code:true:s -> if_redirect_uri;
@@ -85,16 +132,15 @@ digraph oauthlib {
if_redirect_uri -> if_redirect_uri_missing [ arrowhead=none ];
if_redirect_uri_present -> f_confirm_redirect_uri;
if_redirect_uri_missing -> f_get_default_redirect_uri;
+ f_get_default_redirect_uri:redirect_uri:s -> f_confirm_redirect_uri;
f_confirm_redirect_uri:true:s -> f_save_bearer_token;
- f_get_default_redirect_uri -> f_save_bearer_token;
-
f_save_bearer_token -> f_invalidate_authorization_code;
f_invalidate_authorization_code -> webapi_response;
}
/* Authorization Code - Authorization Request */
{
- edge [ color=darkgreen ];
+ edge [ color=green ];
endpoint_authorize:code:s -> f_validate_client_id;
f_validate_client_id:true:s -> if_redirect_uri;
@@ -104,15 +150,16 @@ digraph oauthlib {
if_redirect_uri_missing -> f_get_default_redirect_uri;
f_validate_redirect_uri:true:s -> f_validate_response_type;
- f_get_default_redirect_uri -> f_validate_response_type;
+ f_get_default_redirect_uri:redirect_uri:s -> f_validate_response_type;
f_validate_response_type:true:s -> f_is_pkce_required;
f_is_pkce_required:true:s -> if_code_challenge;
- f_is_pkce_required:false -> f_validate_scopes;
+ f_is_pkce_required:false:s -> f_validate_scopes;
if_code_challenge -> f_validate_scopes [ label="present" ];
- if_code_challenge -> e_normal [ label="missing" ];
+ if_code_challenge -> e_normal [ label="missing",style=dashed ];
f_validate_scopes:true:s -> f_save_authorization_code;
+ f_save_authorization_code -> webapi_response;
}
/* Implicit */
@@ -127,9 +174,10 @@ digraph oauthlib {
if_redirect_uri_missing -> f_get_default_redirect_uri;
f_validate_redirect_uri:true:s -> f_validate_response_type;
- f_get_default_redirect_uri -> f_validate_response_type;
+ f_get_default_redirect_uri:redirect_uri:s -> f_validate_response_type;
f_validate_response_type:true:s -> f_validate_scopes;
f_validate_scopes:true:s -> f_save_bearer_token;
+ f_save_bearer_token -> webapi_response;
}
/* Resource Owner Password Grant */
@@ -138,9 +186,10 @@ digraph oauthlib {
endpoint_token:password:s -> f_client_authentication_required;
f_client_authentication_required:true:s -> f_authenticate_client;
- f_client_authentication_required:false -> f_authenticate_client_id;
- f_authenticate_client:true:s -> f_validate_user;
- f_authenticate_client_id:true:s -> f_validate_user;
+ f_client_authentication_required:false:s -> f_authenticate_client_id;
+ f_authenticate_client:true:s -> r_client_authenticated [ arrowhead=none ];
+ f_authenticate_client_id:true:s -> r_client_authenticated [ arrowhead=none ];
+ r_client_authenticated -> f_validate_user;
f_validate_user:true:s -> f_validate_grant_type;
f_validate_grant_type:true:s -> if_scopes;
@@ -157,7 +206,7 @@ digraph oauthlib {
edge [ color=blue ];
endpoint_token:client_credentials:s -> f_authenticate_client;
- f_authenticate_client -> f_validate_grant_type;
+ f_authenticate_client:true:s -> f_validate_grant_type;
f_validate_grant_type:true:s -> f_validate_scopes;
f_validate_scopes:true:s -> f_save_bearer_token;
f_save_bearer_token -> webapi_response;
@@ -169,9 +218,11 @@ digraph oauthlib {
endpoint_token:refresh_token:s -> f_client_authentication_required;
f_client_authentication_required:true:s -> f_authenticate_client;
- f_client_authentication_required:false -> f_authenticate_client_id;
- f_authenticate_client:true:s -> f_validate_grant_type;
- f_authenticate_client_id:true:s -> f_validate_grant_type;
+ f_client_authentication_required:false:s -> f_authenticate_client_id;
+ f_authenticate_client:true:s -> r_client_authenticated [ arrowhead=none ];
+ f_authenticate_client_id:true:s -> r_client_authenticated [ arrowhead=none ];
+ r_client_authenticated -> f_validate_grant_type;
+
f_validate_grant_type:true:s -> f_validate_refresh_token;
f_validate_refresh_token:true:s -> f_get_original_scopes;
f_get_original_scopes -> if_all;
@@ -185,11 +236,12 @@ digraph oauthlib {
{
edge [ color=yellow ];
- endpoint_introspect:s -> f_client_authentication_required [ label="" ];
+ endpoint_introspect:s -> f_client_authentication_required;
f_client_authentication_required:true:s -> f_authenticate_client;
- f_client_authentication_required:false -> f_authenticate_client_id;
- f_authenticate_client:true:s -> f_introspect_token;
- f_authenticate_client_id:true:s -> f_introspect_token;
+ f_client_authentication_required:false:s -> f_authenticate_client_id;
+ f_authenticate_client:true:s -> r_client_authenticated [ arrowhead=none ];
+ f_authenticate_client_id:true:s -> r_client_authenticated [ arrowhead=none ];
+ r_client_authenticated -> f_introspect_token;
f_introspect_token:claims -> webapi_response;
}
@@ -199,9 +251,10 @@ digraph oauthlib {
endpoint_revoke:s -> f_client_authentication_required;
f_client_authentication_required:true:s -> f_authenticate_client;
- f_client_authentication_required:false -> f_authenticate_client_id;
- f_authenticate_client:true:s -> f_revoke_token;
- f_authenticate_client_id:true:s -> f_revoke_token;
+ f_client_authentication_required:false:s -> f_authenticate_client_id;
+ f_authenticate_client:true:s -> r_client_authenticated [ arrowhead=none ];
+ f_authenticate_client_id:true:s -> r_client_authenticated [ arrowhead=none ];
+ r_client_authenticated -> f_revoke_token;
f_revoke_token:s -> webapi_response;
}