httpie-asap-auth 0.4.0__py3-none-any.whl

httpie_asap_auth-0.4.0.dist-info/METADATA

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: httpie-asap-auth
+Version: 0.4.0
+Summary: ASAP Auth plugin for HTTPie.
+Author-email: Jason Friedland <jason@friedland.id.au>
+License: MIT License
+        
+        Copyright (c) 2017 Jason Friedland
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+        
+Project-URL: Homepage, https://github.com/jasonfriedland/httpie-asap-auth
+Project-URL: Download, https://github.com/jasonfriedland/httpie-asap-auth
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Environment :: Plugins
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Utilities
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: atlassian-jwt-auth>=10.1.0
+Requires-Dist: httpie>=3.1.0
+Dynamic: license-file
+
+httpie-asap-auth
+================
+
+[![PyPi Package](https://img.shields.io/pypi/v/httpie-asap-auth.svg)](https://pypi.python.org/pypi/httpie-asap-auth)
+[![PyPi Versions](https://img.shields.io/pypi/pyversions/httpie-asap-auth.svg)](https://pypi.python.org/pypi/httpie-asap-auth)
+[![Actions Status](https://github.com/jasonfriedland/httpie-asap-auth/workflows/test/badge.svg)](https://github.com/jasonfriedland/httpie-asap-auth/actions)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
+
+[ASAP](https://s2sauth.bitbucket.io/) Auth plugin for [HTTPie](https://httpie.org/).
+
+Installation
+------------
+
+    pip install httpie-asap-auth
+
+Python 3.8 through Python 3.14 are supported.
+
+You should now see `asap` and `asapenv` under `--auth-type` in the `$ http --help` output.
+
+Usage
+-----
+
+    http --auth-type=asap --auth=path/to/asap.config http://example.com/
+
+OR, to read from environment variables:
+
+    http --auth-type=asapenv --auth=audience[:subject] http://example.com/
+
+Separate multiple audiences with a comma.
+
+Example ASAP Config
+-------------------
+
+Store your ASAP config in a file following this format:
+
+```json
+{
+    "issuer": "webapp/admin",
+    "kid": "webapp/admin/dev.pem",
+    "audience": [
+        "webapp"
+    ],
+    "sub": "administration",
+    "privateKey": "-----BEGIN RSA PRIVATE KEY-----\n ... \n-----END RSA PRIVATE KEY-----"
+}
+```
+
+NB. the subject (`sub` field) is optional.
+
+Example Environment Variables
+-----------------------------
+
+    ASAP_PRIVATE_KEY=data:application/pkcs8;kid=webapp;base64,...
+    ASAP_ISSUER=webapp/admin
+
+Generate a Data URI
+-------------------
+
+Generate a data URI, with the key in PKCS8 from an RSA private key PEM file:
+
+    #!/bin/sh
+
+    # Usage: $0 privatekey.pem
+
+    KID=$(echo "$1" | sed 's|/|%2F|g')
+    KEY=$(openssl pkcs8 -topk8 -inform PEM -outform DER -in "$1" -nocrypt | base64 | tr '\n' ' ' | sed 's| ||g')
+
+    echo "data:application/pkcs8;kid=$KID;base64,$KEY"
+
+(thanks to Brian McKenna)
+
+Development
+-----------
+
+[Install uv](https://docs.astral.sh/uv/getting-started/installation/), then create
+the development environment from the committed lockfile:
+
+    make sync
+
+Run the test suite and formatter with the locked dependencies:
+
+    make test
+    make fmt
+
+The formatter runs on Python 3.14 while preserving Python 3.8-compatible
+syntax.
+
+Upgrade all dependencies and review the resulting lockfile with:
+
+    make upgrade
+
+Build the source and wheel distributions with:
+
+    make build
+
+Maintainers can publish the built distributions after configuring uv's PyPI
+credentials:
+
+    make publish

httpie_asap_auth-0.4.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+httpie_asap_auth.py,sha256=FtQEHPXhF1D69NztuU7n2S2HzYNmG32CMnY1yydk1GE,5172
+httpie_asap_auth-0.4.0.dist-info/licenses/LICENSE,sha256=INjQn-bycyKJ-XE5hKB0qz8lll-nZr0wQcvCtsa1J3w,1072
+httpie_asap_auth-0.4.0.dist-info/METADATA,sha256=dnpUY-KX_Etupwt8Qqv-gIr1QJfGyAdRvO0P7TidW4Y,5028
+httpie_asap_auth-0.4.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+httpie_asap_auth-0.4.0.dist-info/entry_points.txt,sha256=TP9D4dtttRPWYnKzoXcxLOgiEAO5efIrkY3oLG6OB0A,134
+httpie_asap_auth-0.4.0.dist-info/top_level.txt,sha256=qCXfxxUQYiHwPUqgmiIoGzHOxwh6SC-sjZ7rG_HJ7PE,17
+httpie_asap_auth-0.4.0.dist-info/RECORD,,

httpie_asap_auth-0.4.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.2.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

httpie_asap_auth-0.4.0.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[httpie.plugins.auth.v1]
+httpie_asap_auth = httpie_asap_auth:AsapAuthPlugin
+httpie_asap_auth_env = httpie_asap_auth:AsapAuthEnvPlugin

httpie_asap_auth-0.4.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jason Friedland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

httpie_asap_auth-0.4.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+httpie_asap_auth

httpie_asap_auth.py

@@ -0,0 +1,171 @@
+"""
+ASAP Auth plugin for HTTPie.
+"""
+
+from __future__ import print_function
+
+import json
+import sys
+import os
+
+import atlassian_jwt_auth
+import atlassian_jwt_auth.key
+import atlassian_jwt_auth.signer
+import atlassian_jwt_auth.contrib.requests
+
+from httpie.status import ExitStatus
+from httpie.plugins import AuthPlugin
+
+__author__ = "Jason Friedland"
+__licence__ = "MIT"
+
+
+def fatal_plugin_error(message):
+    print(message, file=sys.stderr)
+    sys.exit(ExitStatus.PLUGIN_ERROR)
+
+
+class AsapAuthPlugin(AuthPlugin):
+    """
+    ASAP Auth plugin for HTTPie, reading from config file.
+    """
+
+    name = "ASAP Auth"
+    auth_type = "asap"
+    description = "See: https://s2sauth.bitbucket.io/spec/ for details."
+
+    # Require but don't parse auth
+    auth_require = True
+    auth_parse = False
+    prompt_password = False
+
+    def get_auth(self, username=None, password=None):
+        """
+        Get ASAP Auth.
+
+        The --auth, -a option is used as the file path to the ASAP config
+        (in JSON form). We access this via self.raw_auth rather
+        than username/password.
+
+        :param str username: Unused.
+        :param str password: Unused.
+        :return: atlassian_jwt_auth.contrib.requests.JWTAuth
+        """
+        signer, audience, subject = self.parse_config_file(self.raw_auth)
+        return atlassian_jwt_auth.contrib.requests.JWTAuth(
+            signer, audience, additional_claims={"sub": subject} if subject else {}
+        )
+
+    @staticmethod
+    def parse_config_file(asap_config_file):
+        """
+        Parse ``asap_config_file`` JSON and return the signer.
+
+        :param str asap_config_file: Path to the ASAP config file.
+
+        :return: atlassian_jwt_auth.signer.JWTAuthSigner
+        :raises ExitStatus.PLUGIN_ERROR: Invalid config.
+        """
+        config = None
+
+        try:
+            with open(asap_config_file) as f:
+                config = json.load(f)
+        except IOError:
+            fatal_plugin_error("file not readable: {}".format(asap_config_file))
+        except ValueError:
+            fatal_plugin_error("invalid JSON config: {}".format(asap_config_file))
+
+        if config and not isinstance(config, dict):
+            fatal_plugin_error(
+                "invalid JSON config (expected dict): {}".format(asap_config_file)
+            )
+
+        try:
+            return (
+                atlassian_jwt_auth.create_signer(
+                    config["issuer"], config["kid"], config["privateKey"]
+                ),
+                config["audience"],
+                config.get("sub"),
+            )
+        except KeyError as e:
+            fatal_plugin_error("expected key in config file: {}".format(e))
+
+
+class AsapAuthEnvPlugin(AuthPlugin):
+    """
+    ASAP Auth plugin for HTTPie, reading from environment.
+    """
+
+    name = "ASAP Auth from environment"
+    auth_type = "asapenv"
+    description = "See: https://s2sauth.bitbucket.io/spec/ for details."
+
+    # Require but don't parse auth
+    auth_require = True
+    auth_parse = False
+    prompt_password = False
+
+    def get_auth(self, username=None, password=None):
+        """
+        Get ASAP Auth.
+
+        We use the environment variables ASAP_PRIVATE_KEY (data_uri form) and
+        ASAP_ISSUER for ASAP configuration, augmented by --auth, -a (which provides
+        audience1,audience2,...:subject). Subjects are optional.
+
+        :param str username: Unused.
+        :param str password: Unused.
+
+        :return: atlassian_jwt_auth.contrib.requests.JWTAuth
+        """
+        signer = self.construct_signer_from_env(os.environ)
+        audience, subject = self.parse_auth(self.raw_auth)
+        return atlassian_jwt_auth.contrib.requests.JWTAuth(
+            signer, audience, additional_claims={"sub": subject} if subject else {}
+        )
+
+    @staticmethod
+    def construct_signer_from_env(env):
+        """
+        Returns a new JWT signer initialised using values from the environment.
+
+        :param dict env: A dict holding the shell environment.
+
+        :return: atlassian_jwt_auth.signer.JWTAuthSigner
+        :raises ExitStatus.PLUGIN_ERROR: Invalid environment.
+        """
+        try:
+            provider = atlassian_jwt_auth.key.DataUriPrivateKeyRetriever(
+                env["ASAP_PRIVATE_KEY"]
+            )
+            return atlassian_jwt_auth.signer.JWTAuthSigner(env["ASAP_ISSUER"], provider)
+        except KeyError as e:
+            fatal_plugin_error("missing {} in environment".format(e))
+
+    @staticmethod
+    def parse_auth(auth):
+        """
+        Parse the ``auth`` arg and return the audience and subject.
+
+        >>> AsapAuthEnvPlugin.parse_auth("foo,bar:baz")
+        (['foo', 'bar'], 'baz')
+
+        >>> AsapAuthEnvPlugin.parse_auth(":baz")
+        ([''], 'baz')
+
+        >>> AsapAuthEnvPlugin.parse_auth("foo")
+        (['foo'], None)
+
+        :param str auth: The ``auth`` arg passed on the CLI. Contains the audience and subject.
+        :return: tuple(List[str], str)
+        """
+        auth = auth.split(":", 1)
+
+        if len(auth) == 1:
+            audience, subject = auth[0], None
+        else:
+            audience, subject = auth
+
+        return audience.split(","), subject