oauth2-cli-auth 1.1.0__tar.gz → 1.3.0__tar.gz

{oauth2_cli_auth-1.1.0 → oauth2_cli_auth-1.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: oauth2-cli-auth
-Version: 1.1.0
+Version: 1.3.0
 Summary: Authenticate against OAuth2 Provider in Python CLIs
 Home-page: https://github.com/timo-reymann/python-oauth2-cli-auth
 License: MIT
@@ -19,6 +19,7 @@ Classifier: Programming Language :: Python :: 3
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
 Project-URL: Bug Tracker, https://github.com/timo-reymann/python-oauth2-cli-auth/issues
 Project-URL: Repository, https://github.com/timo-reymann/python-oauth2-cli-auth
 Description-Content-Type: text/markdown

oauth2_cli_auth-1.3.0/oauth2_cli_auth/_timeout.py

@@ -0,0 +1,23 @@
+import signal
+
+
+class TimeoutException(Exception):
+    pass
+
+
+def _timeout_handler(signum, frame):
+    raise TimeoutException("Operation timed out")
+
+
+def _method_with_timeout(your_method, timeout_seconds=5, *args, **kwargs):
+    signal.signal(signal.SIGALRM, _timeout_handler)
+    signal.alarm(timeout_seconds)
+
+    try:
+        result = your_method(*args, **kwargs)
+    except TimeoutException as te:
+        raise te
+    finally:
+        signal.alarm(0)  # Reset the alarm
+
+    return result

oauth2_cli_auth-1.3.0/oauth2_cli_auth/_urllib_util.py

@@ -0,0 +1,26 @@
+import json
+import time
+import urllib
+from urllib.error import URLError
+
+
+def _urlopen_with_backoff(url, max_retries=3, base_delay=1, timeout=15):
+    retries = 0
+
+    while retries < max_retries:
+        try:
+            response = urllib.request.urlopen(url, timeout=timeout)
+            return response
+        except Exception:
+            retries += 1
+            delay = base_delay * (2 ** retries)
+            time.sleep(delay)
+
+    raise URLError(f"Failed to open URL after {max_retries} retries")
+
+
+def _load_json(url_or_request: str | urllib.request.Request) -> dict:
+    with _urlopen_with_backoff(url_or_request) as response:
+        response_data = response.read().decode('utf-8')
+        json_response = json.loads(response_data)
+    return json_response

{oauth2_cli_auth-1.1.0 → oauth2_cli_auth-1.3.0}/oauth2_cli_auth/code_grant.py

@@ -1,9 +1,11 @@
+import base64
+import urllib.parse
+import urllib.request
 import webbrowser
+from collections.abc import Callable
 from dataclasses import dataclass
-import urllib.request
-import urllib.parse
-import base64
-import json
+
+from oauth2_cli_auth._urllib_util import _load_json
 
 
 @dataclass
@@ -31,25 +33,20 @@ class OAuth2ClientInfo:
         )
 
 
-def _load_json(url_or_request: str | urllib.request.Request) -> dict:
-    with urllib.request.urlopen(url_or_request) as response:
-        response_data = response.read().decode('utf-8')
-        json_response = json.loads(response_data)
-    return json_response
-
-
 def load_oidc_config(odic_well_known_endpoint: str) -> dict:
     config = _load_json(odic_well_known_endpoint)
     return config
 
 
-def open_browser(url: str) -> None:
+def open_browser(url: str, print_open_browser_instruction: Callable[[str], None] | None = print) -> None:
     """
     Open browser using webbrowser module and show message about URL open
+    :param print_open_browser_instruction: Callback to print the instructions to open the browser. Set to None in order to supress the output.
     :param url: URL to open and display
     :return: None
     """
-    print(f"Open your browser at\n{url}")
+    if print_open_browser_instruction is not None:
+        print_open_browser_instruction(f"Open your browser at\n{url}")
     webbrowser.open(url)
 
 
@@ -68,17 +65,20 @@ def get_auth_url(client_info: OAuth2ClientInfo, redirect_uri: str) -> str:
             f"&response_type=code")
 
 
-def exchange_code_for_access_token(client_info: OAuth2ClientInfo, redirect_uri: str, code: str,
-                                   access_token_field: str = "access_token") -> str:
+def exchange_code_for_response(
+        client_info: OAuth2ClientInfo,
+        redirect_uri: str,
+        code: str,
+) -> dict:
     """
-    Exchange a code for an access token using the endpoints from client info
+    Exchange a code for an access token using the endpoints from client info and return the entire response
 
     :param client_info: Info about oauth2 client
     :param redirect_uri: Callback URL
     :param code: Code to redeem
     :param access_token_field: Name of the field containing the access token to use. This might differ depending on
-                               the provider you are using. For example for Auth0 you have to set this to id_token
-    :return: Extracted access token from response
+                              the provider you are using. For example for Auth0 you have to set this to id_token
+    :return: Response from OAuth2 endpoint
     """
     headers = {
         "Content-Type": "application/x-www-form-urlencoded",
@@ -95,4 +95,25 @@ def exchange_code_for_access_token(client_info: OAuth2ClientInfo, redirect_uri:
     request = urllib.request.Request(client_info.token_url, data=encoded_data, headers=headers)
     json_response = _load_json(request)
 
+    return json_response
+
+
+def exchange_code_for_access_token(
+        client_info: OAuth2ClientInfo,
+        redirect_uri: str,
+        code: str,
+        access_token_field: str = "access_token"
+) -> str:
+    """
+    Exchange a code for an access token using the endpoints from client info
+
+    :param client_info: Info about oauth2 client
+    :param redirect_uri: Callback URL
+    :param code: Code to redeem
+    :param access_token_field: Name of the field containing the access token to use. This might differ depending on
+                               the provider you are using. For example for Auth0 you have to set this to id_token
+    :return: Extracted access token from response
+    """
+    json_response = exchange_code_for_response(client_info, redirect_uri, code)
+
     return json_response.get(access_token_field)

oauth2_cli_auth-1.3.0/oauth2_cli_auth/conftest.py

@@ -0,0 +1,12 @@
+import urllib
+from unittest.mock import patch
+
+import pytest
+
+
+@pytest.fixture
+def create_urlopen_mock():
+    def mock(buffer):
+        return patch.object(urllib.request, 'urlopen', return_value=buffer)
+
+    return mock

{oauth2_cli_auth-1.1.0 → oauth2_cli_auth-1.3.0}/oauth2_cli_auth/http_server.py

@@ -2,6 +2,7 @@ from http.server import BaseHTTPRequestHandler, HTTPServer
 from string import Template
 from typing import Optional
 from urllib.parse import parse_qs, urlparse
+from oauth2_cli_auth._timeout import _method_with_timeout, TimeoutException
 
 
 class CallbackPageTemplate:
@@ -150,10 +151,13 @@ class CallbackPageTemplate:
 class OAuthRedirectHandler(BaseHTTPRequestHandler):
     callback_template = CallbackPageTemplate()
 
+    def log_message(self, format, *args):
+        # silence the log messages
+        pass
+
     def do_GET(self):
         params = parse_qs(urlparse(self.path).query)
 
-
         has_error = "code" not in params or len(params['code']) != 1 or params['code'][0].strip() == ""
 
         if has_error:
@@ -197,9 +201,22 @@ class OAuthCallbackHttpServer(HTTPServer):
     def callback_url(self):
         return f"http://localhost:{self.server_port}"
 
-    def wait_for_code(self, attempts: int = 3) -> Optional[int]:
+    def wait_for_code(self, attempts: int = 3, timeout_per_attempt=10) -> Optional[str]:
+        """
+        Wait for the server to open the callback page containing the code query parameter.
+
+        It tries for #attempts with a timeout of #timeout_per_attempts for each attempt.
+        This prevents the CLI from getting stuck by unsolved callback URls
+
+        :param attempts: Amount of attempts
+        :param timeout_per_attempt: Timeout for each attempt to be successful
+        :return: Code from callback page or None if the callback page is not called successfully
+        """
         for i in range(0, attempts):
-            self.handle_request()
+            try:
+                _method_with_timeout(self.handle_request, timeout_seconds=timeout_per_attempt)
+            except TimeoutException:
+                continue
             if self.get_code() is not None:
                 return self.get_code()
 

{oauth2_cli_auth-1.1.0 → oauth2_cli_auth-1.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oauth2-cli-auth"
-version = "1.1.0"
+version = "1.3.0"
 description = "Authenticate against OAuth2 Provider in Python CLIs"
 authors = ["Timo Reymann <mail@timo-reymann.de>"]
 license = "MIT"
@@ -34,8 +34,7 @@ python = "^3.9"
 [[tool.poetry.source]]
 name = "testpypi"
 url = "https://test.pypi.org/legacy/"
-default = false
-secondary = false
+priority="explicit"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"

oauth2_cli_auth-1.1.0/oauth2_cli_auth/success.html

@@ -1,118 +0,0 @@
-<html lang="en">
-
-<head>
-    <title>bcs</title>
-    <meta name="viewport" content="width=device-width, initial-scale=1.0"/>
-    <meta name="charset" content="utf-8">
-    <style>
-        * {
-            margin: 0;
-            padding: 0;
-        }
-
-        body {
-            font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol";
-        }
-
-        html, body {
-            display: flex;
-            align-items: center;
-            justify-content: center;
-            height: 100%;
-        }
-
-        .message {
-            text-align: center;
-            padding: 40px;
-        }
-
-        .animation-ctn {
-            text-align: center;
-            margin-top: 5em;
-        }
-
-        @keyframes checkmark {
-            0% {
-                stroke-dashoffset: 100px
-            }
-
-            100% {
-                stroke-dashoffset: 0px
-            }
-        }
-
-        @keyframes checkmark-circle {
-            0% {
-                stroke-dashoffset: 480px
-            }
-
-            100% {
-                stroke-dashoffset: 960px
-            }
-        }
-
-        @keyframes colored-circle {
-            0% {
-                opacity: 0
-            }
-
-            100% {
-                opacity: 100
-            }
-        }
-
-
-        .icon svg polyline {
-            -webkit-animation: checkmark 0.25s ease-in-out 0.7s backwards;
-            animation: checkmark 0.25s ease-in-out 0.7s backwards
-        }
-
-        .icon svg circle {
-            -webkit-animation: checkmark-circle 0.6s ease-in-out backwards;
-            animation: checkmark-circle 0.6s ease-in-out backwards;
-        }
-
-        .icon svg circle#colored {
-            -webkit-animation: colored-circle 0.6s ease-in-out 0.7s backwards;
-            animation: colored-circle 0.6s ease-in-out 0.7s backwards;
-        }
-    </style>
-</head>
-
-<body>
-<div class="message">
-    <div class="animation-ctn">
-        <div class="icon">
-            <svg xmlns="http://www.w3.org/2000/svg" width="154px" height="154px">
-                <g fill="none" stroke="#22AE73" stroke-width="2">
-                    <circle cx="77" cy="77" r="72"
-                            style="stroke-dasharray:480px, 480px; stroke-dashoffset: 960px;"></circle>
-                    <circle id="colored" fill="#22AE73" cx="77" cy="77" r="72"
-                            style="stroke-dasharray:480px, 480px; stroke-dashoffset: 960px;"></circle>
-                    <polyline class="st0" stroke="#fff" stroke-width="10" points="43.5,77.8 63.7,97.9 112.2,49.4 "
-                              style="stroke-dasharray:100px, 100px; stroke-dashoffset: 200px;"/>
-                </g>
-            </svg>
-        </div>
-    </div>
-
-    <div class="animation-ctn">
-        <div class="icon">
-            <svg xmlns="http://www.w3.org/2000/svg" width="154px" height="154px">
-                <g fill="none" stroke="#F44812" stroke-width="2">
-                    <circle cx="77" cy="77" r="72"
-                            style="stroke-dasharray:480px, 480px; stroke-dashoffset: 960px;"></circle>
-                    <circle id="colored" fill="#F44812" cx="77" cy="77" r="72"
-                            style="stroke-dasharray:480px, 480px; stroke-dashoffset: 960px;"></circle>
-                    <polyline class="st0" stroke="#fff" stroke-width="10" points="43.5,77.8  112.2,77.8 "
-                              style="stroke-dasharray:100px, 100px; stroke-dashoffset: 200px;"/>
-                </g>
-            </svg>
-        </div>
-    </div>
-
-    <h1>$title</h1>
-    <p>$message</p>
-</div>
-</body>
-</html>