httpx2-negotiate-sspi 3.0.0__tar.gz

httpx2_negotiate_sspi-3.0.0/LICENSE.txt

@@ -0,0 +1,211 @@
+                                 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 2026 achapkowski
+
+    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.
+
+
+
+## Runtime Library Exception to the Apache 2.0 License: ##
+
+
+    As an exception, if you use this Software to compile your source code and
+    portions of this Software are embedded into the binary product as a result,
+    you may redistribute such product without providing attribution as would
+    otherwise be required by Sections 4(a), 4(b) and 4(d) of the License.

httpx2_negotiate_sspi-3.0.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include LICENSE.txt
+include README.md

httpx2_negotiate_sspi-3.0.0/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: httpx2-negotiate-sspi
+Version: 3.0.0
+Summary: HTTP Negotiate/Kerberos/NTLM authentication for httpx2 via pyspnego.
+Author-email: achapkowski <achapkowski@esri.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/achapkowski/httpx2_negotiate_sspi
+Project-URL: Documentation, https://achapkowski.github.io/httpx2_negotiate_sspi
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+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: Programming Language :: Python :: 3.15
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: cryptography>=50.0.0
+Requires-Dist: httpx2<3,>=2.16.0
+Requires-Dist: pyspnego>=0.12.4; platform_system == "Windows"
+Requires-Dist: pyspnego[kerberos]>=0.12.4; platform_system != "Windows"
+Requires-Dist: sspilib>=0.6.0; platform_system == "Windows"
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: coverage>=7; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: sphinx; extra == "doc"
+Requires-Dist: sphinx-rtd-theme; extra == "doc"
+Dynamic: license-file
+
+![PyPI Python Version](https://img.shields.io/pypi/pyversions/httpx2-negotiate-sspi)
+![Pepy Total Downloads](https://img.shields.io/pepy/dt/httpx2-negotiate-sspi)
+
+httpx2-negotiate-sspi
+=====================
+
+`httpx2-negotiate-sspi` provides HTTP Negotiate (Kerberos/NTLM) authentication
+for `httpx2` on **Windows, Linux and macOS** through the `pyspnego` library.
+
+The package name mentions `sspi` for historical reasons; it now uses
+`pyspnego` and works on all major platforms.
+
+It supports:
+
+- Kerberos single sign-on with SSPI (Windows) or the ticket cache (Linux/macOS)
+- NTLM with explicit credentials on all platforms
+- Extended Protection for Authentication via RFC 5929 TLS channel binding
+- Mutual authentication enforcement (CWE-295 mitigation)
+
+Platform support
+----------------
+
+| Platform    | Backend | Requirement                                    |
+|-------------|---------|------------------------------------------------|
+| Windows     | SSPI    | `sspilib` (installed automatically)            |
+| Linux/macOS | GSSAPI  | system Kerberos libs (installed automatically) |
+
+Installation
+------------
+
+```console
+pip install httpx2-negotiate-sspi
+```
+
+On Linux/macOS, system Kerberos libraries must also be present:
+
+```console
+# Ubuntu / Debian
+sudo apt install libkrb5-dev
+
+# macOS
+brew install krb5
+```
+
+Then obtain a ticket before making requests:
+
+```console
+kinit user@DOMAIN.COM
+```
+
+Quick start
+-----------
+
+Default use — single sign-on with the logged-in account:
+
+```python
+import httpx2
+from httpx2_negotiate_sspi import HttpNegotiateAuth
+
+with httpx2.Client(auth=HttpNegotiateAuth()) as client:
+    response = client.get("https://iis.contoso.com")
+    response.raise_for_status()
+```
+
+Async clients use the same auth object (SSPI/GSSAPI calls run in a worker
+thread so the event loop is not blocked):
+
+```python
+import asyncio
+import httpx2
+from httpx2_negotiate_sspi import HttpNegotiateAuth
+
+async def main() -> None:
+    async with httpx2.AsyncClient(auth=HttpNegotiateAuth()) as client:
+        response = await client.get("https://iis.contoso.com")
+        response.raise_for_status()
+
+asyncio.run(main())
+```
+
+NTLM with explicit credentials — set ``mutual_authentication=False`` because
+NTLM cannot prove the server's identity:
+
+```python
+import httpx2
+from httpx2_negotiate_sspi import HttpNegotiateAuth
+
+auth = HttpNegotiateAuth(
+    username="svc-http-client",
+    password="hunter2",
+    domain="CONTOSO",
+    mutual_authentication=False,
+)
+with httpx2.Client(auth=auth) as client:
+    response = client.get("https://intranet.contoso.com")
+```
+
+Explicit SPN host override:
+
+```python
+from httpx2_negotiate_sspi import HttpNegotiateAuth
+
+auth = HttpNegotiateAuth(host="adfs.contoso.com")
+```
+
+Enable DNS canonicalization when you need CNAME following:
+
+```python
+from httpx2_negotiate_sspi import HttpNegotiateAuth
+
+auth = HttpNegotiateAuth(canonicalize_hostname=True)
+```
+
+Security
+--------
+
+**Always use HTTPS.** HTTP Negotiate authenticates only the initial handshake;
+it does not protect the content of subsequent requests or responses. On plain
+HTTP there is also no TLS channel binding, which makes relay attacks easier.
+The library logs a warning when the request URL scheme is `http`.
+
+Mutual authentication
+---------------------
+
+By default, `mutual_authentication=True`. The auth flow raises
+`MutualAuthenticationError` (a subclass of `httpx2.HTTPError`) when the server
+does not send a valid final authentication token.
+
+**NTLM cannot prove the server's identity.** Set `mutual_authentication=False`
+when you know the endpoint only supports NTLM:
+
+```python
+auth = HttpNegotiateAuth(mutual_authentication=False)
+```
+
+SPN and hostname canonicalization
+----------------------------------
+
+The SPN is constructed as `<service>/<host>`, e.g. `HTTP/server.contoso.com`.
+
+- If `host=` is provided, it is always used as-is.
+- If `canonicalize_hostname=False` (the default), `request.url.host` is used
+  directly. This is safer: DNS canonicalization follows CNAME records, and an
+  attacker who controls DNS can choose the SPN.
+- If `canonicalize_hostname=True`, the host is resolved through
+  `socket.getaddrinfo(..., AI_CANONNAME)`. The original host is used as a
+  fallback if DNS fails.
+
+Channel binding
+---------------
+
+When the `httpx2` transport exposes an SSL object, the library automatically
+includes a `tls-server-end-point` channel binding token (RFC 5929). This
+prevents authentication relay attacks and is required by servers that enforce
+Extended Protection for Authentication.
+
+The hash algorithm follows RFC 5929 §4.1: use the hash of the certificate's
+signature algorithm, promoting MD5 and SHA-1 to SHA-256.
+
+Limitations
+-----------
+
+- **HTTPS required for content protection.** HTTP Negotiate authenticates only
+  the handshake. Content is not protected on plain HTTP, and channel binding
+  is not available.
+- **NTLM needs the same TCP connection.** The NTLM handshake is stateful.
+  If the connection is closed between the first and second request, the
+  authentication will fail.
+- **No fallback from Negotiate to NTLM.** The library tries `Negotiate` first
+  and then `NTLM` if the server advertises both. It does not fall back from
+  Negotiate to NTLM if Negotiate fails to start.
+- **Delegation risk.** Only enable `delegate=True` when the remote service is
+  trusted to act on the user's behalf (e.g., double-hop scenarios). Delegation
+  allows the server to impersonate the user to other services.
+- **CI tests NTLM and channel binding, not real Kerberos (IIS job).** The
+  Windows IIS job on GitHub-hosted runners is not domain-joined, so it tests
+  NTLM. The Linux job runs a real KDC and tests Kerberos.
+
+Configuration reference
+-----------------------
+
+| Parameter                 | Type     | Default | Description                                              |
+|---------------------------|----------|---------|----------------------------------------------------------|
+| `username`                | str      | None    | Username for explicit credentials                        |
+| `password`                | str      | None    | Password for explicit credentials                        |
+| `domain`                  | str      | `'.'`   | NT domain (`.` = local account). Prepended to username.  |
+| `service`                 | str      | `'HTTP'`| Kerberos service class for the SPN                       |
+| `host`                    | str      | None    | Explicit SPN host override                               |
+| `delegate`                | bool     | False   | Enable ISC_REQ_DELEGATE / GS2 delegation                 |
+| `mutual_authentication`   | bool     | **True**| Require the server to prove its identity (**BREAKING**)  |
+| `canonicalize_hostname`   | bool     | **False**| Follow CNAME records via DNS (**BREAKING**)             |
+
+Troubleshooting
+---------------
+
+- If you receive `401 Unauthorized`, confirm the server advertises `Negotiate`
+  or `NTLM` and the account has permission to access the service.
+- If `MutualAuthenticationError` is raised with an NTLM server, set
+  `mutual_authentication=False`.
+- If Kerberos works only with an explicit `host`, verify that the SPN
+  registered in Active Directory matches the host you are connecting to.
+- On Linux, run `kinit user@REALM` and confirm `klist` shows a valid ticket.
+- If a service requires Extended Protection, make sure you are using HTTPS and
+  the transport exposes the peer certificate to `httpx2`.
+- If `canonicalize_hostname=False` (the default) causes SPN mismatches,
+  consider setting `host=` explicitly or enabling `canonicalize_hostname=True`.
+
+Documentation and development
+-----------------------------
+
+- Documentation: https://achapkowski.github.io/httpx2_negotiate_sspi
+- Source: https://github.com/achapkowski/httpx2_negotiate_sspi
+- Issues: https://github.com/achapkowski/httpx2_negotiate_sspi/issues
+
+```console
+python -m pip install -e .[dev,doc]
+python -m coverage run -m unittest discover -s tests
+python -m coverage report -m --fail-under=90
+python -m sphinx -W -b html docs docs/_build/html
+```
+
+Credits
+-------
+
+This package was inspired by
+[`requests-negotiate-sspi`](https://github.com/brandond/requests-negotiate-sspi).