From 580d95e65aa4f1a012520c3fee34f4b2102d13e5 Mon Sep 17 00:00:00 2001
From: peppelinux <giuseppe.demarco@unical.it>
Date: Mon, 17 May 2021 16:13:55 +0200
Subject: [PATCH] chore: documentation minor changements

---
 doc/source/contents/conf.rst | 137 +++++++++++++++++++++--------------
 doc/source/contents/setup.md |   8 +-
 doc/source/index.rst         |  12 ---
 3 files changed, 87 insertions(+), 70 deletions(-)

diff --git a/doc/source/contents/conf.rst b/doc/source/contents/conf.rst
index 0572aaa8..c3758ed9 100644
--- a/doc/source/contents/conf.rst
+++ b/doc/source/contents/conf.rst
@@ -279,6 +279,89 @@ Example ::
         "verify": false
       },
 
+
+------------------
+token_handler_args
+------------------
+
+An example::
+
+    "token_handler_args": {
+        "jwks_def": {
+          "private_path": "private/token_jwks.json",
+          "read_only": false,
+          "key_defs": [
+            {
+              "type": "oct",
+              "bytes": 24,
+              "use": [
+                "enc"
+              ],
+              "kid": "code"
+            },
+            {
+              "type": "oct",
+              "bytes": 24,
+              "use": [
+                "enc"
+              ],
+              "kid": "refresh"
+            }
+          ]
+        },
+        "code": {
+          "kwargs": {
+            "lifetime": 600
+          }
+        },
+        "token": {
+          "class": "oidcop.token.jwt_token.JWTToken",
+          "kwargs": {
+              "lifetime": 3600,
+              "add_claims": [
+                "email",
+                "email_verified",
+                "phone_number",
+                "phone_number_verified"
+              ],
+              "add_claim_by_scope": true,
+              "aud": ["https://example.org/appl"]
+           }
+        },
+        "refresh": {
+            "kwargs": {
+                "lifetime": 86400
+            }
+        }
+      }
+
+Another example::
+
+    {
+     'jwks_file': 'data/oidc_op/private/token_jwks.json',
+     'code': {'kwargs': {'lifetime': 600}},
+     'token': {
+      'class': 'oidcop.token.jwt_token.JWTToken',
+      'kwargs': {'lifetime': 3600}
+     },
+     'refresh': {'kwargs': {'lifetime': 86400}},
+     'id_token': {
+        'class': 'oidcop.token.id_token.IDToken',
+          'kwargs': {
+            'id_token_signing_alg_values_supported': [
+                'RS256', 'RS512', 'ES256', 'ES512', 'PS256', 'PS512'
+            ],
+           'id_token_encryption_alg_values_supported': [
+                'RSA-OAEP', 'RSA-OAEP-256', 'A192KW', 'A256KW', 'ECDH-ES',
+                'ECDH-ES+A128KW', 'ECDH-ES+A192KW', 'ECDH-ES+A256KW'
+            ],
+           'id_token_encryption_enc_values_supported': [
+                'A128CBC-HS256', 'A192CBC-HS384', 'A256CBC-HS512', 'A128GCM', 'A192GCM', 'A256GCM'
+            ]
+           }
+        }
+    }
+
 --------
 id_token
 --------
@@ -397,60 +480,6 @@ An example::
 
       "template_dir": "templates"
 
-------------------
-token_handler_args
-------------------
-
-An example::
-
-    "token_handler_args": {
-        "jwks_def": {
-          "private_path": "private/token_jwks.json",
-          "read_only": false,
-          "key_defs": [
-            {
-              "type": "oct",
-              "bytes": 24,
-              "use": [
-                "enc"
-              ],
-              "kid": "code"
-            },
-            {
-              "type": "oct",
-              "bytes": 24,
-              "use": [
-                "enc"
-              ],
-              "kid": "refresh"
-            }
-          ]
-        },
-        "code": {
-          "kwargs": {
-            "lifetime": 600
-          }
-        },
-        "token": {
-          "class": "oidcop.token.jwt_token.JWTToken",
-          "kwargs": {
-              "lifetime": 3600,
-              "add_claims": [
-                "email",
-                "email_verified",
-                "phone_number",
-                "phone_number_verified"
-              ],
-              "add_claim_by_scope": true,
-              "aud": ["https://example.org/appl"]
-           }
-        },
-        "refresh": {
-            "kwargs": {
-                "lifetime": 86400
-            }
-        }
-      }
 
 --------
 userinfo
diff --git a/doc/source/contents/setup.md b/doc/source/contents/setup.md
index b3a4db3b..ad78606a 100644
--- a/doc/source/contents/setup.md
+++ b/doc/source/contents/setup.md
@@ -12,8 +12,9 @@ Install
 
 Get the usage examples
 
-    git clone https://github.com/rohe/oidc-op.git
-    cd oidc-op/example/
+    git clone https://github.com/identitypython/oidc-op.git
+    cd oidc-op/example/flask_op/
+    bash run.sh
 
 
 To configure a standard OIDC Provider you have to edit the oidcop configuration file.
@@ -72,8 +73,7 @@ In genral configuration:
       "domain": DOMAIN,
       "server_name": SERVER_NAME,
       "base_url": f"https://{SERVER_NAME}",
-      "key_def": OIDC_KEY_DEFS,
-      "OIDC_KEYS": {
+      "keys": {
         "private_path": "data/oidc_op/private/jwks.json",
         "key_defs": OIDC_KEY_DEFS,
         "public_path": "data/static/jwks.json",
diff --git a/doc/source/index.rst b/doc/source/index.rst
index b59f944b..2f503fab 100644
--- a/doc/source/index.rst
+++ b/doc/source/index.rst
@@ -23,18 +23,6 @@ It also comes with the following `add_on` modules.
 * Custom scopes, that extends `[OIDC standard ScopeClaims] <https://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims>`_
 * `Proof Key for Code Exchange by OAuth Public Clients (PKCE) <https://tools.ietf.org/html/rfc7636>`_
 
-All these are services you can access at endpoints. The total set of endpoints
-that this package supports are
-
-- webfinger
-- provider_info
-- registration
-- authorization
-- token
-- refresh_token
-- userinfo
-- end_session
-
 The entire project code is open sourced and therefore licensed
 under the `Apache 2.0 <https://en.wikipedia.org/wiki/Apache_License>`_.