Merge pull request #43 from IdentityPython/develop

version 1.3.1
IdentityPython · Jan 19, 2023 · 15b96e0 · 15b96e0
2 parents 44f78f5 + b5402d7
commit 15b96e0
Show file tree

Hide file tree

Showing 123 changed files with 3,727 additions and 1,983 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ As OIDC OP Idpy implements the following standards:
 * [OpenID Connect Back-Channel Logout 1.0](https://openid.net/specs/openid-connect-backchannel-1_0.html)
 * [OpenID Connect Front-Channel Logout 1.0](https://openid.net/specs/openid-connect-frontchannel-1_0.html)
 * [OAuth2 Token introspection](https://tools.ietf.org/html/rfc7662)
+* [OAuth 2.0 Form Post Response Mode](https://openid.net/specs/oauth-v2-form-post-response-mode-1_0.html)
 
 It also comes with the following `add_on` modules.
 

diff --git a/doc/client/add_on/index.rst b/doc/client/add_on/index.rst
@@ -1,16 +1,8 @@
-OIDCRP add on documentation
+OAuth2 add on documentation
 ===========================
 
 .. toctree::
 
-   dpop.rst
-   pkce.rst
-   pushed_authorization.rst
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+    dpop.rst
+    pkce.rst
+    pushed_authorization.rst
diff --git a/doc/client/index.rst b/doc/client/index.rst
@@ -1,8 +1,7 @@
-.. oicrp documentation master file, created by
-   sphinx-quickstart on Fri Feb 23 13:32:06 2018.
+.. idpyoic documentation master file
 
-IdPyOIDC client documentation!
-==============================
+Client documentation!
+=====================
 
 .. image:: _images/oid-l-certification-mark-l-rgb-150dpi-90mm-300x157.png
   :width: 300
@@ -12,8 +11,9 @@ IdPyOIDC client documentation!
    :maxdepth: 2
 
    rp_handler.rst
-   oidcrp.rst
    add_on/index.rst
+   config.rst
+   service/index.rst
 
 Indices and tables
 ==================

diff --git a/doc/client/oidcrp.oauth2.rst b/doc/client/oidcrp.oauth2.rst
diff --git a/doc/client/oidcrp.oidc.rst b/doc/client/oidcrp.oidc.rst
diff --git a/doc/client/oidcrp.rst b/doc/client/oidcrp.rst
diff --git a/doc/client/service/index.rst b/doc/client/service/index.rst
@@ -0,0 +1,53 @@
+Client package
+==============
+
+service support
+----------------
+
+.. toctree::
+
+    oauth2/index.rst
+    oidc/index.rst
+
+Submodules
+----------
+
+idpyoidc\.server\.endpoint module
+---------------------------------
+
+.. automodule:: idpyoidc.server.endpoint
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+idpyoidc\.server\.endpoint_context module
+-----------------------------------------
+
+.. automodule:: idpyoidc.server.endpoint_context
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+idpyoidc\.server\.scopes module
+-------------------------------
+
+.. automodule:: idpyoidc.server.scopes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+idpyoidc\.server\.util module
+-----------------------------
+
+.. automodule:: idpyoidc.server.util
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: idpyoidc.server
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oauth2/access_token.rst b/doc/client/service/oauth2/access_token.rst
@@ -0,0 +1,7 @@
+Access Token Service
+--------------------
+
+.. automodule:: idpyoidc.client.oauth2.access_token
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oauth2/authorization.rst b/doc/client/service/oauth2/authorization.rst
@@ -0,0 +1,7 @@
+Authorization Endpoint
+----------------------
+
+.. automodule:: idpyoidc.client.oauth2.authorization
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oauth2/index.rst b/doc/client/service/oauth2/index.rst
@@ -0,0 +1,10 @@
+OAuth2 Client Services
+======================
+
+.. toctree::
+
+    access_token.rst
+    authorization.rst
+    refresh_access_token.rst
+    server_metadata.rst
+    token_exchange.rst
diff --git a/doc/client/service/oauth2/refresh_access_token.rst b/doc/client/service/oauth2/refresh_access_token.rst
@@ -0,0 +1,7 @@
+Refresh Access Token Service
+----------------------------
+
+.. automodule:: idpyoidc.client.oauth2.refresh_access_token
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oauth2/server_metadata.rst b/doc/client/service/oauth2/server_metadata.rst
@@ -0,0 +1,7 @@
+Server Metadata Endpoint
+------------------------
+
+.. automodule:: idpyoidc.client.oauth2.server_metadata
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oauth2/token_exchange.rst b/doc/client/service/oauth2/token_exchange.rst
@@ -0,0 +1,7 @@
+Token Helper
+--------------
+
+.. automodule:: idpyoidc.client.oauth2.token_exchange
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oidc/access_token.rst b/doc/client/service/oidc/access_token.rst
@@ -0,0 +1,8 @@
+Access Token Service
+--------------------
+
+.. automodule:: idpyoidc.client.oidc.access_token
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/authorization.rst b/doc/client/service/oidc/authorization.rst
@@ -0,0 +1,7 @@
+Authorization Service
+----------------------
+
+.. automodule:: idpyoidc.client.oidc.authorization
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oidc/backchannel_authentication.rst b/doc/client/service/oidc/backchannel_authentication.rst
@@ -0,0 +1,7 @@
+Backchannel Authentication
+--------------------------
+
+.. automodule:: idpyoidc.client.oidc.backchannel_authentication
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oidc/check_id.rst b/doc/client/service/oidc/check_id.rst
@@ -0,0 +1,8 @@
+Check ID Service
+----------------
+
+.. automodule:: idpyoidc.client.oidc.check_id
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/check_session.rst b/doc/client/service/oidc/check_session.rst
@@ -0,0 +1,8 @@
+Check Session Service
+---------------------
+
+.. automodule:: idpyoidc.client.oidc.check_session
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/end_session.rst b/doc/client/service/oidc/end_session.rst
@@ -0,0 +1,8 @@
+End Session Service
+-------------------
+
+.. automodule:: idpyoidc.client.oidc.end_session
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/index.rst b/doc/client/service/oidc/index.rst
@@ -0,0 +1,17 @@
+OIDC RP Services
+================
+
+.. toctree::
+
+    access_token.rst
+    authorization.rst
+    backchannel_authentication.rst
+    check_id.rst
+    check_session.rst
+    end_session.rst
+    provider_info_discovery.rst
+    read_registration.rst
+    refresh_access_token.rst
+    registration.rst
+    userinfo.rst
+    webfinger.rst
diff --git a/doc/client/service/oidc/provider_info_discovery.rst b/doc/client/service/oidc/provider_info_discovery.rst
@@ -0,0 +1,8 @@
+Provider Info Discovery
+-----------------------
+
+.. automodule:: idpyoidc.client.oidc.provider_info_discovery
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/read_registration.rst b/doc/client/service/oidc/read_registration.rst
@@ -0,0 +1,8 @@
+Read registration
+-----------------
+
+.. automodule:: idpyoidc.client.oidc.read_registration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/refresh_access_token.rst b/doc/client/service/oidc/refresh_access_token.rst
@@ -0,0 +1,8 @@
+Refresh Access Token Service
+----------------------------
+
+.. automodule:: idpyoidc.client.oidc.refresh_access_token
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/registration.rst b/doc/client/service/oidc/registration.rst
@@ -0,0 +1,8 @@
+Registration Service
+--------------------
+
+.. automodule:: idpyoidc.client.oidc.registration
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/client/service/oidc/userinfo.rst b/doc/client/service/oidc/userinfo.rst
@@ -0,0 +1,7 @@
+Userinfo
+--------
+
+.. automodule:: idpyoidc.client.oidc.userinfo
+    :members:
+    :undoc-members:
+    :show-inheritance:
diff --git a/doc/client/service/oidc/webfinger.rst b/doc/client/service/oidc/webfinger.rst
@@ -0,0 +1,8 @@
+Webfinger Service
+-----------------
+
+.. automodule:: idpyoidc.client.oidc.webfinger
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
diff --git a/doc/conf.py b/doc/conf.py
@@ -31,7 +31,8 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary', 'sphinx.ext.intersphinx']
+autosummary_generate = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -47,7 +48,7 @@
 
 # General information about the project.
 project = 'IdPyOIDC'
-copyright = '2017, Roland Hedberg'
+copyright = '2022, Roland Hedberg'
 author = 'Roland Hedberg'
 
 # The version info for the project you're documenting, acts as replacement for
@@ -64,12 +65,12 @@
 #
 # This is also used if you do content translation via gettext catalogs.
 # Usually you set "language" from the command line for these cases.
-language = None
+language = 'en'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '_templates']
 
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = 'sphinx'
@@ -83,7 +84,7 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'alabaster'
+html_theme = 'classic'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

diff --git a/doc/intro.rst b/doc/intro.rst
@@ -21,6 +21,7 @@ IdpyOIDC implements the following standards:
 * `OpenID Connect Front-Channel Logout 1.0 <https://openid.net/specs/openid-connect-frontchannel-1_0.html>`_
 * `OAuth2 Token introspection <https://tools.ietf.org/html/rfc7662>`_
 * `OAuth2 Token exchange <https://datatracker.ietf.org/doc/html/rfc8693>`_
+* `OAuth2 Resource Indicators <https://datatracker.ietf.org/doc/rfc8707/>`_
 * `The OAuth 2.0 Authorization Framework: JWT-Secured Authorization Request (JAR) <https://datatracker.ietf.org/doc/html/rfc9101>`_
 
 It also comes with the following `add_on` modules.