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

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

@@ -1,12 +1,12 @@
 Metadata-Version: 2.1
 Name: oauth2-cli-auth
-Version: 1.3.0
+Version: 1.5.0
 Summary: Authenticate against OAuth2 Provider in Python CLIs
 Home-page: https://github.com/timo-reymann/python-oauth2-cli-auth
 License: MIT
 Author: Timo Reymann
 Author-email: mail@timo-reymann.de
-Requires-Python: >=3.9,<4.0
+Requires-Python: >=3.9
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Environment :: MacOS X
@@ -111,7 +111,7 @@ So I created this small library without any dependencies besides the python stan
 
 ## Documentation
 
-- [Library documentation](https://timo-reymann.github.io/python-oauth2-cli-auth/oauth2_cli_auth/)
+- [Library documentation](https://timo-reymann.github.io/python-oauth2-cli-auth)
 
 ## Contributing
 

{oauth2_cli_auth-1.3.0 → oauth2_cli_auth-1.5.0}/README.md

@@ -85,7 +85,7 @@ So I created this small library without any dependencies besides the python stan
 
 ## Documentation
 
-- [Library documentation](https://timo-reymann.github.io/python-oauth2-cli-auth/oauth2_cli_auth/)
+- [Library documentation](https://timo-reymann.github.io/python-oauth2-cli-auth)
 
 ## Contributing
 

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

@@ -1,3 +1,6 @@
+"""
+Functionality to work with OAuth2 code grant
+"""
 import base64
 import urllib.parse
 import urllib.request
@@ -15,15 +18,27 @@ class OAuth2ClientInfo:
     """
     authorization_url: str
     """Authorization URL to redirect the user to"""
+
     token_url: str
     """Token URL for fetching the access token"""
+
     client_id: str
     """Id of the client to request for"""
+
     scopes: list[str]
     """List of scopes to request"""
 
     @staticmethod
-    def from_oidc_endpoint(oidc_config_endpoint: str, client_id: str, scopes: list[str]):
+    def from_oidc_endpoint(oidc_config_endpoint: str, client_id: str, scopes: list[str]) -> "OAuth2ClientInfo":
+        """
+        Create client information object from well known endpoint in format as specified in
+        https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata
+
+        :param oidc_config_endpoint: Endpoint to load
+        :param client_id: Client ID to use
+        :param scopes: Scopes to add to OAuth2 authorization requests
+        :return: OAuth2ClientInfo containing parsed information from endpoint
+        """
         config = load_oidc_config(oidc_config_endpoint)
         return OAuth2ClientInfo(
             authorization_url=config.get("authorization_endpoint"),
@@ -34,6 +49,11 @@ class OAuth2ClientInfo:
 
 
 def load_oidc_config(odic_well_known_endpoint: str) -> dict:
+    """
+    Load OIDC configuration from the well known configuration endpoint
+
+    :param odic_well_known_endpoint: Endpoint to load configuration from
+    """
     config = _load_json(odic_well_known_endpoint)
     return config
 
@@ -41,6 +61,7 @@ def load_oidc_config(odic_well_known_endpoint: str) -> dict:
 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
@@ -76,8 +97,6 @@ def exchange_code_for_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: Response from OAuth2 endpoint
     """
     headers = {

oauth2_cli_auth-1.5.0/oauth2_cli_auth/http_server.py

@@ -0,0 +1,273 @@
+"""
+Local HTTP server logic
+"""
+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 TimeoutException, _method_with_timeout
+
+
+class CallbackPageTemplate:
+    """
+    Holder for callback page assets and template
+    """
+    SUCCESS_SVG = """
+    <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>
+    """
+    """SVG to display checkmark"""
+
+    ERROR_SVG = """
+    <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>
+    """
+    """SVG to display error icon"""
+
+    PAGE_TEMPLATE = Template(
+        """
+            <html lang="$lang">
+                <head>
+                    <title>$title</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";
+                        }
+        
+                        @media (prefers-color-scheme: dark) {
+                            body {
+                                background: rgb(34, 39, 46);
+                                color: rgb(173, 186, 199);
+                            }
+                        }
+        
+                        html, body {
+                            display: flex;
+                            align-items: center;
+                            justify-content: center;
+                            height: 100%;
+                        }
+        
+                        h1 {
+                            font-size: 4rem;
+                        }
+        
+                        p {
+                            font-size: 1.4rem;
+                            max-width: 70ch;
+                        }
+        
+                        .message {
+                            text-align: center;
+                        }
+        
+                        .animation-ctn {
+                            text-align: center;
+                        }
+        
+                        @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 {
+                            padding: 1rem;
+                        }
+        
+                        .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
+                        </div>
+                    </div>
+        
+                    <h1>$title</h1>
+                    <p>$message</p>
+                </div>
+                </body>
+                </html>
+                """
+    )
+    """Template for callback HTML page"""
+
+    def render(self, title: str, message: str, lang: str = "en", has_error: bool = False):
+        """
+        Render callback page
+
+        :param title: Page title
+        :param message: Message to display under the icon
+        :param lang: Langauge for HTML tag
+        :param has_error: Indicates weather checkmark (false) or cross (true) should be displayed
+        :return: Rendered HTML
+        """
+        return self.PAGE_TEMPLATE.substitute(
+            lang=lang,
+            title=title,
+            message=message,
+            svg=self.ERROR_SVG if has_error else self.SUCCESS_SVG,
+        )
+
+
+class OAuthRedirectHandler(BaseHTTPRequestHandler):
+    """
+    HTTPRequest Handler that is intended to be used as oauth2 callback page
+    """
+    _callback_template = CallbackPageTemplate()
+    LANGUAGE = "en"
+    """HTML language to render for callback page"""
+
+    def log_message(self, format, *args):
+        """
+        Disables logging for BaseHTTPRequestHandler
+        """
+        # silence the log messages
+        pass
+
+    def _serve_html(self, html: str):
+        self.send_header("Content-type", "text/html")
+        self.end_headers()
+        self.wfile.write(html.encode("utf-8"))
+
+    def _serve_callback_page(self, title: str, message: str, has_error: bool):
+        rendered_callback_page = self._callback_template.render(
+            lang=self.LANGUAGE,
+            title=title,
+            message=message,
+            has_error=has_error
+        )
+        self._serve_html(rendered_callback_page)
+
+    # noinspection PyPep8Naming
+    def do_GET(self) -> None:
+        """
+        Provides callback page for the oauth2 redirect
+        """
+        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:
+            self.send_response(400)
+            self._serve_callback_page(
+                title="Oh snap!",
+                message="Something went wrong trying to authenticate you. Please try going back in your browser, or restart the auth process.",
+                has_error=True,
+            )
+        else:
+            self.send_response(200)
+            self.server._code = params["code"][0]
+            self._serve_callback_page(
+                title="Success",
+                message="You have been authenticated successfully. You may close this browser window now and go back to the terminal",
+                has_error=False,
+            )
+
+
+class OAuthCallbackHttpServer(HTTPServer):
+    """
+    Simplistic HTTP Server to provide local callback URL for oauth2 provider
+    """
+
+    def __init__(self, port):
+        super().__init__(("", port), OAuthRedirectHandler)
+
+        self._code: str | None = None
+
+    def get_code(self) -> str | None:
+        """
+        This method should only be called after the request was done and might be None when no token is given.
+
+        :return: Authorization code or None if the request was not performed yet
+        """
+        return self._code
+
+    @property
+    def callback_url(self) -> str:
+        """
+        Callback URL for the HTTP-Server
+        """
+        return f"http://localhost:{self.server_port}"
+
+    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 _ in range(0, attempts):
+            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()
+
+        return None

{oauth2_cli_auth-1.3.0 → oauth2_cli_auth-1.5.0}/oauth2_cli_auth/simplified_flow.py

@@ -1,3 +1,6 @@
+"""
+Ready to use workflows
+"""
 from oauth2_cli_auth import OAuthCallbackHttpServer, get_auth_url, exchange_code_for_access_token, OAuth2ClientInfo, \
     open_browser
 
@@ -10,6 +13,7 @@ def get_access_token_with_browser_open(client_info: OAuth2ClientInfo, server_por
     - Open the browser with the authorization URL
     - Wait for the code to arrive
     - Get access token from code
+
     :param client_info: Client Info for Oauth2 Interaction
     :param server_port: Port of the local web server to spin up
     :return: Access Token

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

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "oauth2-cli-auth"
-version = "1.3.0"
+version = "1.5.0"
 description = "Authenticate against OAuth2 Provider in Python CLIs"
 authors = ["Timo Reymann <mail@timo-reymann.de>"]
 license = "MIT"
@@ -26,7 +26,7 @@ include = [
     "LICENSE"
 ]
 [tool.poetry.dependencies]
-python = "^3.9"
+python = ">=3.9"
 
 [tool.poetry.urls]
 "Bug Tracker" = "https://github.com/timo-reymann/python-oauth2-cli-auth/issues"
@@ -39,7 +39,8 @@ priority="explicit"
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.4.3"
 coverage = "^7.3.2"
-pdoc3 = "^0.10.0"
+setuptools = "^69.5.1"
+pydoctor = "^23.9.1"
 
 [tool.coverage.run]
 omit = [".*", "*/site-packages/*", "*/*_test.py"]
@@ -50,3 +51,22 @@ fail_under = 70
 [build-system]
 requires = ["poetry-core"]
 build-backend = "poetry.core.masonry.api"
+
+[tool.pydoctor]
+verbose = 0
+warnings-as-errors = true
+
+intersphinx = ["https://docs.python.org/3/objects.inv"]
+docformat = "restructuredtext"
+html-output = "gh-pages"
+
+add-package = ["oauth2_cli_auth"]
+project-name = "oauth2_cli_auth"
+project-url = "https://github.com/timo-reymann/python-oauth2-cli-auth"
+privacy = [
+    "HIDDEN:oauth2_cli_auth.*_test",
+    "HIDDEN:oauth2_cli_auth.conftest"
+]
+
+theme = "base"
+template-dir = "pydoctor-theme"

oauth2_cli_auth-1.3.0/oauth2_cli_auth/http_server.py

@@ -1,223 +0,0 @@
-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:
-    SUCCESS_SVG = """
-    <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>
-    """
-
-    ERROR_SVG = """
-    <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>
-    """
-
-    PAGE_TEMPLATE = Template("""
-    <html lang="$lang">
-        <head>
-            <title>$title</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";
-                }
-
-                @media (prefers-color-scheme: dark) {
-                    body {
-                        background: rgb(34, 39, 46);
-                        color: rgb(173, 186, 199);
-                    }
-                }
-
-                html, body {
-                    display: flex;
-                    align-items: center;
-                    justify-content: center;
-                    height: 100%;
-                }
-
-                h1 {
-                    font-size: 4rem;
-                }
-
-                p {
-                    font-size: 1.4rem;
-                    max-width: 70ch;
-                }
-
-                .message {
-                    text-align: center;
-                }
-
-                .animation-ctn {
-                    text-align: center;
-                }
-
-                @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 {
-                    padding: 1rem;
-                }
-
-                .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
-                </div>
-            </div>
-
-            <h1>$title</h1>
-            <p>$message</p>
-        </div>
-        </body>
-        </html>
-        """)
-
-    def render(self, title: str, message: str, lang: str = "en", has_error: bool = False):
-        return self.PAGE_TEMPLATE.substitute(
-            lang=lang,
-            title=title,
-            message=message,
-            svg=self.ERROR_SVG if has_error else self.SUCCESS_SVG,
-        )
-
-
-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:
-            self.send_response(400)
-            title = "Oh snap!"
-            message = "Something went wrong trying to authenticate you. Please try going back in your browser, or restart the auth process."
-        else:
-            self.send_response(200)
-            self.server._code = params["code"][0]
-            title = "Success"
-            message = "You have been authenticated successfully. You may close this browser window now and go back to the terminal"
-
-        self.send_header("Content-type", "text/html")
-        self.end_headers()
-        self.wfile.write(
-            self.callback_template
-            .render(
-                lang="en",
-                title=title,
-                message=message,
-                has_error=has_error
-            )
-            .encode("utf-8")
-        )
-
-
-class OAuthCallbackHttpServer(HTTPServer):
-    """
-    Simplistic HTTP Server to provide local callback URL for oauth2 provider
-    """
-
-    def __init__(self, port):
-        super().__init__(("", port), OAuthRedirectHandler)
-
-        self._code = None
-
-    def get_code(self):
-        return self._code
-
-    @property
-    def callback_url(self):
-        return f"http://localhost:{self.server_port}"
-
-    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):
-            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()
-
-        return None