keycloak-oauth-system 0.1.0a2__tar.gz

keycloak_oauth_system-0.1.0a2/AUTHORS

@@ -0,0 +1 @@
+Thomas Ward <teward@thomas-ward.net>

keycloak_oauth_system-0.1.0a2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

keycloak_oauth_system-0.1.0a2/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: keycloak-oauth-system
+Version: 0.1.0a2
+Summary: Keycloak OAuth handler library that uses programmatic evaluation of callback URLs without the need for a callback server
+Author-email: Thomas Ward <teward@thomas-ward.net>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/teward/KeycloakOAuth.git
+Keywords: oauth,oauth 2.0,keycloak
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3.16
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: requests
+Requires-Dist: pyqrcode
+Dynamic: license-file

keycloak_oauth_system-0.1.0a2/keycloak_oauth/__init__.py

@@ -0,0 +1,5 @@
+from .auth_code_flow import AuthCodeFlow
+from .client_credentials_flow import ClientCredentialsFlow
+from .device_code_flow import DeviceCodeFlow
+
+__version__ = "0.1.0-alpha2"

keycloak_oauth_system-0.1.0a2/keycloak_oauth/_base.py

@@ -0,0 +1,99 @@
+from urllib.parse import parse_qs, urljoin
+
+import requests
+
+from util import generate_random_string
+
+
+# noinspection HttpUrlsUsage
+class BaseAuthHandler:
+    def __init__(self, auth_server_base_url: str, realm: str, client_id: str, client_secret: str):
+        # Initialize a new HTTP requests Session for cookie integrity
+        self._session = requests.Session()
+
+        # Initialize certain static data values we'll need.
+        if (not auth_server_base_url.lower().startswith('http://')
+                and not auth_server_base_url.lower().startswith('https://')):
+            raise ValueError("You did not provide a proper base URL for the Keycloak server you "
+                             "wish to use. It must start with 'http://' or 'https://'")
+        self._auth_server = auth_server_base_url  # Keycloak URL
+        self._redirect_uri = "http://localhost/callback"
+
+        # Some values are from input
+        self._realm = realm  # auth realm in Keycloak
+        self.client_id = client_id
+        self.client_secret = client_secret
+
+        # And now we also provide some fetched and calculated items.
+        ## _oidc is used to get the OpenID Connect configuration which includes
+        ## requisite items for the auth flows.  This is stored in _openid_config if
+        ## the request returned a 200 OK response.
+        _oidc = self._session.get(
+            urljoin(self._auth_server, f'/realms/{self.realm}/.well-known/openid-configuration'),
+        )
+        if _oidc.status_code != 200:
+            raise RuntimeError("Could not get requisite information from specified auth server. "
+                               "Double check the realm you specified.")
+        ## We store the OpenID Configuration data here
+        self._openid_config = _oidc.json()
+
+        ## Only instantiate token endpoint which is common to all auth formats
+        self._token_endpoint = self._openid_config["token_endpoint"]
+
+        ## State is not used in every type of request, but it doesn't hurt to generate.
+        self._state = generate_random_string(32)
+
+    @property
+    def realm(self) -> str:
+        return self._realm
+
+    @property
+    def auth_server(self) -> str:
+        return self._auth_server
+
+    @property
+    def token_endpoint(self) -> str:
+        return self._token_endpoint
+
+    @property
+    def openid_configuration(self) -> dict:
+        return self._openid_config
+
+
+class BaseAuthParameterGenerator:
+    def __init__(self, auth_server: str, realm: str, client_id: str, client_secret: str):
+        # Initialize a new HTTP requests Session for cookie integrity
+        self._session = requests.Session()
+
+        # Initialize certain static data values we'll need.
+        self._auth_server = auth_server
+        self._redirect_uri = "http://localhost/callback"
+
+        # Some values are from input
+        self._realm = realm  # auth realm in Keycloak
+        self.client_id = client_id
+        self.client_secret = client_secret
+
+        # And now we also provide some fetched and calculated items.
+        ## _oidc is used to get the OpenID Connect configuration which includes
+        ## requisite items for the auth flows.  This is stored in _openid_config if
+        ## the request returned a 200 OK response.
+
+        ## Only instantiate token endpoint which is common to all auth formats
+        self._token_endpoint = urljoin(self._auth_server,
+                                       f"/realms/{self._realm}/protocol/openid-connect/token")
+
+        ## State is not used in every type of request, but it doesn't hurt to generate.
+        self._state = generate_random_string(32)
+
+    @property
+    def realm(self) -> str:
+        return self._realm
+
+    @property
+    def auth_server(self) -> str:
+        return self._auth_server
+
+    @property
+    def token_endpoint(self) -> str:
+        return self._token_endpoint

keycloak_oauth_system-0.1.0a2/keycloak_oauth/auth_code_flow.py

@@ -0,0 +1,214 @@
+from datetime import datetime, timezone
+import html
+import re
+from urllib.parse import urlparse, parse_qs
+
+from _base import BaseAuthHandler
+from util import generate_pkce, jwt_decode
+
+
+class AuthCodeFlow(BaseAuthHandler):
+    # noinspection PyTypeChecker
+    def __init__(self, auth_server: str, realm: str, client_id: str, client_secret: str,
+                 user_id: str, user_password: str, use_pkce: bool = False):
+        super().__init__(auth_server, realm, client_id, client_secret)
+
+        # Initialize certain properties as Empty
+        self._access_token: str = None
+        self._access_token_expiry: datetime = None
+        self._refresh_token: str = None
+        self._refresh_token_expiry: datetime = None
+
+        # Auth Code Flow uses the BaseAuthHandler but also has some extra bits we have to do.
+        # Namely, we need user credentials, and determine if we need PKCE or not.
+
+        # Auth Code Flow depends on the authorization endpoint, which is NOT
+        # instantiated as a property in the Base Auth handler
+        self._authorization_endpoint = self._openid_config["authorization_endpoint"]
+
+        # We only add PKCE data if it's needed
+        if use_pkce:
+            self._pkce = generate_pkce()
+        else:
+            self._pkce = {}
+
+        # We can now, however, set up dictionaries we'll need later.
+        self._user_credentials = {
+            "username": user_id,
+            "password": user_password
+        }
+
+        self._auth_login_parameters = {
+            "response_type": "code",
+            "client_id": self.client_id,
+            "scope": "openid",
+            "redirect_uri": self._redirect_uri,
+            "state": self._state
+        }
+
+        self._token_endpoint_base_data = {
+            "grant_type": "authorization_code",
+            "client_id": self.client_id,
+            "client_secret": self.client_secret,
+            "redirect_uri": self._redirect_uri,
+        }
+
+        if self._pkce:  # This will only work if the dictionary is not empty!
+            # If the self._pkce dict is NOT an empty dictionary, then we have to use PKCE
+            self._auth_login_parameters["code_challenge"] = self._pkce['challenge']
+            self._auth_login_parameters["code_challenge_method"] = "S256"
+            self._token_endpoint_base_data["code_verifier"] = self._pkce["verifier"]
+
+    def __repr__(self):
+        struct = ["<KeycloakOAuth.AuthCodeFlow",
+                  f"pkce={'yes' if self._pkce else 'no'}",
+                  f"realm={self._realm}",
+                  f"ClientID={self.client_id}"]
+        if self.access_token:
+            # noinspection PyUnresolvedReferences
+            if self.access_token_expiry < datetime.now(tz=timezone.utc):
+                struct.append("access_token=expired")
+            else:
+                struct.append("access_token=available")
+        else:
+            struct.append("access_token=empty")
+
+        if self.refresh_token:
+            # noinspection PyUnresolvedReferences
+            if self.refresh_token_expiry < datetime.now(tz=timezone.utc):
+                struct.append("refresh_token=expired")
+            else:
+                struct.append("refresh_token=available")
+        else:
+            struct.append("refresh_token=empty")
+
+        return " ".join(struct) + ">"
+
+    @property
+    def authorization_endpoint(self) -> str:
+        # This is added here because it is not part of the core BaseAuthHandler class
+        return self._authorization_endpoint
+
+    # noinspection PyUnresolvedReferences
+    @property
+    def access_token(self) -> str | None:
+        if self._access_token and self.access_token_expiry < datetime.now(tz=timezone.utc):
+            raise RuntimeWarning("WARNING: The retrieved access key is expired.")
+        return self._access_token
+
+    @property
+    def access_token_expiry(self) -> datetime | None:
+        return self._access_token_expiry
+
+    # noinspection PyUnresolvedReferences
+    @property
+    def refresh_token(self) -> str | None:
+        if self._refresh_token and self.refresh_token_expiry < datetime.now(tz=timezone.utc):
+            raise RuntimeWarning("WARNING: The retrieved refresh key is expired.")
+        return self._refresh_token
+
+    @property
+    def refresh_token_expiry(self) -> datetime | None:
+        return self._refresh_token_expiry
+
+    # noinspection PyUnresolvedReferences
+    def get_authorization_code(self) -> str:
+        login_page = self._session.get(
+            self.authorization_endpoint, params=self._auth_login_parameters, allow_redirects=False
+        )
+        if login_page.status_code != 200:
+            raise RuntimeError("Could not get login page or login endpoint URL, invalid response"
+                               f"code from server: {login_page.status_code}")
+
+        form_action = html.unescape(
+            re.search(r'<form\s+.*?\s+action="(.*?)"',
+                      login_page.text, re.DOTALL).group(1)
+        )
+
+        auth_resp = self._session.post(
+            form_action, data=self._user_credentials, allow_redirects=False
+        )
+        if auth_resp.status_code not in [300, 301, 302]:
+            raise RuntimeError("Unable to get an authorization code with provided login "
+                               "credentials; possible login failure or invalid creds.")
+
+        auth_redirect_params = parse_qs(urlparse(auth_resp.headers['Location']).query)
+        try:
+            auth_code = auth_redirect_params['code'][0]
+        except KeyError:
+            raise RuntimeError(f"No code in response.")
+
+        return auth_code
+
+    def get_tokens_from_code(self, code: str) -> dict:
+        data = dict(self._token_endpoint_base_data)
+        data['code'] = code
+
+        token_request = self._session.post(
+            self.token_endpoint, data=data, allow_redirects=False
+        )
+        if token_request.status_code != 200:
+            raise RuntimeError("Unable to exchange authorization code for token.")
+
+        # Store current access token and expiry in object
+        self._access_token = token_request.json()['access_token']
+        self._access_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self._access_token)['exp']), tz=timezone.utc
+        )
+
+        # Store current refresh token and expiry in object
+        self._refresh_token = token_request.json()['refresh_token']
+        self._refresh_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self._refresh_token)['exp']), tz=timezone.utc
+        )
+
+        return token_request.json()
+
+    # noinspection PyTypeChecker
+    def refresh_access_token(self, refresh_token: str):
+        # First we need to check the refresh token, which is a JWT,
+        # and its embedded 'exp' UNIX timestamp against now.
+        expiry = datetime.fromtimestamp(
+            int(jwt_decode(refresh_token)['exp']),
+            tz=timezone.utc
+            )
+        if expiry < datetime.now(tz=timezone.utc):
+            raise RuntimeError("Your refresh token has expired. You must start over with "
+                               "the entire OAuth flow from the beginning.")
+
+        data = {
+            "refresh_token": refresh_token,
+            "grant_type": "refresh_token",
+            "client_id": self.client_id,
+            "client_secret": self.client_secret
+        }
+
+        refresh_req = self._session.post(
+            self.token_endpoint, data=data, allow_redirects=False
+        )
+        if refresh_req.status_code != 200:
+            raise RuntimeError("Unable to refresh token.")
+
+        # Store current access token and expiry in object
+        self._access_token = refresh_req.json()['access_token']
+        self._access_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self.access_token)['exp']), tz=timezone.utc
+        )
+
+        # Store current refresh token and expiry in object
+        self._refresh_token = refresh_req.json()['refresh_token']
+        self._refresh_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self.refresh_token)['exp']), tz=timezone.utc
+        )
+
+        return refresh_req.json()
+
+    def run_auth_flow(self) -> dict:
+        auth_code = self.get_authorization_code()
+        tokens = self.get_tokens_from_code(auth_code)
+
+        return tokens
+
+    # noinspection PyTypeChecker
+    def run_refresh_flow(self) -> dict:
+        return self.refresh_access_token(self.refresh_token)

keycloak_oauth_system-0.1.0a2/keycloak_oauth/client_credentials_flow.py

@@ -0,0 +1,133 @@
+from datetime import datetime, timezone
+
+from _base import BaseAuthHandler
+from util import jwt_decode
+
+
+class ClientCredentialsFlow(BaseAuthHandler):
+    # noinspection PyTypeChecker
+    def __init__(self, auth_server: str, realm: str, client_id: str, client_secret: str):
+        super().__init__(auth_server, realm, client_id, client_secret)
+
+        # Initialize certain properties
+        self._access_token: str = None
+        self._access_token_expiry: datetime = None
+        self._refresh_token: str = None
+        self._refresh_token_expiry: datetime = None
+
+        # Get the token endpoint.
+        self._token_endpoint = self._openid_config["token_endpoint"]
+
+        self._auth_parameters = {
+            "grant_type": "client_credentials",
+            "client_id": client_id,
+            "client_secret": client_secret
+        }
+
+    def __repr__(self):
+        struct = ["<KeycloakOAuth.ClientCredentialFlow",
+                  f"realm={self._realm}",
+                  f"ClientID={self.client_id}"]
+        if self._access_token:
+            if self._access_token_expiry < datetime.now(tz=timezone.utc):
+                struct.append("access_token=expired")
+            else:
+                struct.append("access_token=available")
+        else:
+            struct.append("access_token=empty")
+
+        if self._refresh_token:
+            if self._refresh_token_expiry < datetime.now(tz=timezone.utc):
+                struct.append("refresh_token=expired")
+            else:
+                struct.append("refresh_token=available")
+        else:
+            struct.append("refresh_token=empty")
+
+        return " ".join(struct) + ">"
+
+    @property
+    def token_endpoint(self) -> str:
+        return self._token_endpoint
+
+    # noinspection PyUnresolvedReferences
+    @property
+    def access_token(self) -> str | None:
+        if self._access_token and self._access_token_expiry < datetime.now(tz=timezone.utc):
+            raise RuntimeWarning("WARNING: The retrieved access key is expired.")
+        return self._access_token
+
+    @property
+    def access_token_expiry(self) -> datetime | None:
+        return self._access_token_expiry
+
+    # noinspection PyUnresolvedReferences
+    @property
+    def refresh_token(self) -> str | None:
+        if self._refresh_token and self.refresh_token_expiry < datetime.now(tz=timezone.utc):
+            raise RuntimeWarning("WARNING: The retrieved refresh key is expired.")
+        return self._refresh_token
+
+    @property
+    def refresh_token_expiry(self) -> datetime | None:
+        return self._refresh_token_expiry
+
+    def get_tokens(self) -> dict:
+        data = dict(self._auth_parameters)
+        token_request = self._session.post(
+            self.token_endpoint, data=data, allow_redirects=False
+        )
+
+        # Store current access token and expiry in object
+        self._access_token = token_request.json()['access_token']
+        self._access_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self._access_token)['exp']), tz=timezone.utc
+        )
+
+        # Store current refresh token and expiry in object
+        self._refresh_token = token_request.json()['refresh_token']
+        self._refresh_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self._refresh_token)['exp']), tz=timezone.utc
+        )
+
+        return token_request.json()
+
+    # noinspection PyTypeChecker
+    def _refresh_access_token(self, refresh_token: str) -> dict:
+        if not self._access_token:
+            raise RuntimeError("You do not have a refresh token. Have you run through "
+                               "the client credentials flow yet?")
+
+        if self._refresh_token_expiry < datetime.now(tz=timezone.utc):
+            raise RuntimeError("Your refresh token has expired. You must start over with "
+                               "the entire OAuth flow from the beginning.")
+
+        data = {
+            "refresh_token": refresh_token,
+            "grant_type": "refresh_token",
+            "client_id": self.client_id,
+            "client_secret": self.client_secret
+        }
+
+        refresh_req = self._session.post(self.token_endpoint, data=data, allow_redirects=False)
+
+        if refresh_req.status_code != 200:
+            raise RuntimeError("Unable to refresh token.")
+
+        # Store current access token and expiry.
+        self._access_token = refresh_token.json()["access_token"]
+        self._access_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self.access_token)['exp']), tz=timezone.utc
+        )
+
+        # Store current refresh token and expiry in object
+        self._refresh_token = refresh_req.json()['refresh_token']
+        self._refresh_token_expiry = datetime.fromtimestamp(
+            int(jwt_decode(self.refresh_token)['exp']), tz=timezone.utc
+        )
+
+        return refresh_req.json()
+
+    # noinspection PyTypeChecker
+    def refresh_access_token(self):
+        return self._refresh_access_token(self.refresh_token)

keycloak_oauth_system-0.1.0a2/keycloak_oauth/device_code_flow.py

@@ -0,0 +1,78 @@
+from datetime import datetime, timezone
+
+import pyqrcode
+
+from _base import BaseAuthHandler
+from util import jwt_decode, max_seconds
+
+
+class DeviceCodeFlow(BaseAuthHandler):
+    # noinspection PyTypeChecker
+    def __init__(self, auth_server: str, realm: str, client_id: str, client_secret: str):
+        super().__init__(auth_server, realm, client_id, client_secret)
+
+        # Initialize certain properties as Empty
+        self._access_token: str = None
+        self._access_token_expiry: datetime = None
+        self._refresh_token: str = None
+        self._refresh_token_expiry: datetime = None
+
+        self._device_code_endpoint = self._openid_config['device_authorization_endpoint']
+
+    def _get_user_code(self) -> dict:
+        req = self._session.post(
+            self._device_code_endpoint,
+            data={"client_id": self.client_id, "client_secret": self.client_secret},
+            allow_redirects=False
+        )
+
+        # self._device_code = req.json()["device_code"]
+        # self._user_code = req.json()["user_code"]
+        # self._verification_uri = req.json()["verification_uri"]
+        # self._verification_uri_complete = req.json()["verification_uri_complete"]
+        # self._expires_in = req.json()["expires_in"]
+        # self._poll_interval = req.json()["interval"]
+
+        return req.json()
+
+    def authenticate(self) -> dict:
+        print("To finish authentication, please scan the QR code (or use the link)")
+        print("and the specified device code to complete login on the next screen.\n")
+        input("Press Enter to generate the QR code, URL, and device code.")
+
+        user_code = self._get_user_code()
+        qr = pyqrcode.create(user_code["verification_uri_complete"])
+        print(qr.terminal(quiet_zone=1))
+        print(f"URL: {user_code["verification_uri_complete"]}")
+        print(f"Device code: {user_code["device_code"]}\n")
+
+        print("Waiting for authentication to complete...")
+
+        for _ in max_seconds(max_seconds=user_code["expires_in"], interval=user_code["interval"]):
+            token_request = self._session.post(
+                self._token_endpoint,
+                data={"device_code": user_code["device_code"],
+                      "client_id": self.client_id,
+                      "client_secret": self.client_secret,
+                      "grant_type": "urn:ietf:params:oauth:grant-type:device_code"},
+                allow_redirects=False)
+
+            if 'error' in token_request.keys():
+                continue
+            elif 'access_token' in token_request.keys():
+                # Store current access token and expiry in object
+                self._access_token = token_request.json()['access_token']
+                self._access_token_expiry = datetime.fromtimestamp(
+                    int(jwt_decode(self._access_token)['exp']), tz=timezone.utc
+                )
+
+                # Store current refresh token and expiry in object
+                self._refresh_token = token_request.json()['refresh_token']
+                self._refresh_token_expiry = datetime.fromtimestamp(
+                    int(jwt_decode(self._refresh_token)['exp']), tz=timezone.utc
+                )
+                return token_request.json()
+            else:
+                raise RuntimeError("Unable to authenticate, unknown error.")
+
+        raise RuntimeError("Device login timed out, restart auth process.")

keycloak_oauth_system-0.1.0a2/keycloak_oauth/util.py

@@ -0,0 +1,69 @@
+import base64
+import time
+from datetime import datetime, timezone
+import hashlib
+import json
+import secrets
+
+from string import ascii_letters, digits
+
+
+def generate_random_string(length: int = 32) -> str:
+    """
+    Helper function used to generate random cryptographically-safe strings
+    :param length: (int) length of string to generate, defaults to 32
+    :return: random string of letters and numbers of specified length.
+    """
+    return "".join(secrets.choice(ascii_letters + digits) for _ in range(length))
+
+
+def generate_pkce(length: int = 64) -> dict[str, str]:
+    """
+    Helper function that can generate PKCE parameters.
+    :param length:
+    :return:
+    """
+    verifier = generate_random_string(length)
+    challenge = base64.urlsafe_b64encode(
+        hashlib.sha256(
+            verifier.encode('utf-8')
+        ).digest()).decode('utf-8').replace('=', '')
+    return {
+        'verifier': verifier,
+        'challenge': challenge
+    }
+
+
+def jwt_decode(jwt: str) -> dict:
+    _, payload, _ = jwt.split('.')
+    data = payload + "=" * (4 - len(jwt) % 4)
+    decoded = base64.b64decode(data).decode('utf-8')
+    return json.loads(decoded)
+
+
+def token_is_valid(token: str) -> tuple[bool, str | None]:
+    # noinspection PyBroadException
+    try:
+        jwt = jwt_decode(token)
+    except Exception:
+        return False, "Token could not be decoded"
+    expiry = datetime.fromtimestamp(int(jwt['exp']), tz=timezone.utc)
+    if expiry < datetime.now(tz=timezone.utc):
+        return False, "Expired"
+
+    return True, "Presumed valid, but can only be confirmed against the auth server."
+
+
+def max_seconds(max_seconds: int, interval: int = 5):
+    start_time = time.time()
+    end_time = start_time + max_seconds
+    yield 0
+    while time.time() < end_time:
+        if interval > 0:
+            next_time = start_time
+            while next_time < time.time():
+                next_time += interval
+            time.sleep(int(round(next_time - time.time())))
+        yield int(round(time.time() - start_time))
+        if int(round(time.time() + interval)) > int(round(end_time)):
+            return

keycloak_oauth_system-0.1.0a2/keycloak_oauth_system.egg-info/PKG-INFO

@@ -0,0 +1,24 @@
+Metadata-Version: 2.4
+Name: keycloak-oauth-system
+Version: 0.1.0a2
+Summary: Keycloak OAuth handler library that uses programmatic evaluation of callback URLs without the need for a callback server
+Author-email: Thomas Ward <teward@thomas-ward.net>
+License-Expression: Apache-2.0
+Project-URL: Repository, https://github.com/teward/KeycloakOAuth.git
+Keywords: oauth,oauth 2.0,keycloak
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: 3.16
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+License-File: LICENSE
+License-File: AUTHORS
+Requires-Dist: requests
+Requires-Dist: pyqrcode
+Dynamic: license-file

keycloak_oauth_system-0.1.0a2/keycloak_oauth_system.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+AUTHORS
+LICENSE
+pyproject.toml
+keycloak_oauth/__init__.py
+keycloak_oauth/_base.py
+keycloak_oauth/auth_code_flow.py
+keycloak_oauth/client_credentials_flow.py
+keycloak_oauth/device_code_flow.py
+keycloak_oauth/util.py
+keycloak_oauth_system.egg-info/PKG-INFO
+keycloak_oauth_system.egg-info/SOURCES.txt
+keycloak_oauth_system.egg-info/dependency_links.txt
+keycloak_oauth_system.egg-info/requires.txt
+keycloak_oauth_system.egg-info/top_level.txt

keycloak_oauth_system-0.1.0a2/keycloak_oauth_system.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

keycloak_oauth_system-0.1.0a2/keycloak_oauth_system.egg-info/requires.txt

@@ -0,0 +1,2 @@
+requests
+pyqrcode

keycloak_oauth_system-0.1.0a2/keycloak_oauth_system.egg-info/top_level.txt

@@ -0,0 +1 @@
+keycloak_oauth

keycloak_oauth_system-0.1.0a2/pyproject.toml

@@ -0,0 +1,41 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "keycloak-oauth-system"
+dynamic = ["version"]
+dependencies = [
+    "requests",
+    "pyqrcode"
+]
+requires-python = ">= 3.12"
+authors = [
+    {name = "Thomas Ward", email = "teward@thomas-ward.net"},
+]
+description = "Keycloak OAuth handler library that uses programmatic evaluation of callback URLs without the need for a callback server"
+license = "Apache-2.0"
+license-files = ["LICEN[CS]E*", "AUTHORS"]
+keywords = [
+    "oauth",
+    "oauth 2.0",
+    "keycloak"
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
+    "Programming Language :: Python :: 3.16",
+    "Typing :: Typed"
+]
+
+[project.urls]
+Repository = "https://github.com/teward/KeycloakOAuth.git"
+
+[tool.setuptools.dynamic]
+version = {attr = "keycloak_oauth.__version__"}

keycloak_oauth_system-0.1.0a2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+