egress-proxy 0.1.0__tar.gz

egress_proxy-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

egress_proxy-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+egress-proxy
+Copyright 2026 botifyex
+
+This product includes software developed at
+https://github.com/botifyex/egress-proxy

egress_proxy-0.1.0/PKG-INFO

@@ -0,0 +1,312 @@
+Metadata-Version: 2.4
+Name: egress-proxy
+Version: 0.1.0
+Summary: Self-hosted egress proxy with drop-in integrations for Python HTTP clients and upstream HTTP/SOCKS rotation
+Keywords: httpx,aiohttp,proxy,egress,socks5,http-proxy,proxy-rotation
+Author: botifyex
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Intended Audience :: Developers
+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: Operating System :: OS Independent
+Classifier: Topic :: Internet :: Proxy Servers
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: egress-proxy[client,server] ; extra == 'all'
+Requires-Dist: egress-proxy[client-httpx,client-aiohttp] ; extra == 'client'
+Requires-Dist: aiohttp>=3.13.0 ; extra == 'client-aiohttp'
+Requires-Dist: yarl>=1.21.0 ; extra == 'client-aiohttp'
+Requires-Dist: httpx>=0.25.1,<1 ; extra == 'client-httpx'
+Requires-Dist: sniffio>=1.3.0 ; extra == 'client-httpx'
+Requires-Dist: aiohttp>=3.13.0 ; extra == 'server'
+Requires-Dist: aiohttp-socks>=0.11.0 ; extra == 'server'
+Requires-Dist: certifi>=2024.7.4 ; extra == 'server'
+Requires-Dist: httptools>=0.7.1 ; extra == 'server'
+Requires-Dist: pydantic-settings>=2.0.0 ; extra == 'server'
+Requires-Dist: uvicorn>=0.24.0 ; extra == 'server'
+Requires-Dist: yarl>=1.21.0 ; extra == 'server'
+Requires-Python: >=3.11
+Project-URL: Homepage, https://github.com/botifyex/egress-proxy
+Project-URL: Repository, https://github.com/botifyex/egress-proxy
+Project-URL: Issues, https://github.com/botifyex/egress-proxy/issues
+Project-URL: Changelog, https://github.com/botifyex/egress-proxy/blob/master/CHANGELOG.md
+Provides-Extra: all
+Provides-Extra: client
+Provides-Extra: client-aiohttp
+Provides-Extra: client-httpx
+Provides-Extra: server
+Description-Content-Type: text/markdown
+
+# egress-proxy
+
+[![PyPI](https://img.shields.io/pypi/v/egress-proxy)](https://pypi.org/project/egress-proxy/)
+[![Python](https://img.shields.io/pypi/pyversions/egress-proxy)](https://pypi.org/project/egress-proxy/)
+[![CI](https://github.com/botifyex/egress-proxy/actions/workflows/ci.yml/badge.svg)](https://github.com/botifyex/egress-proxy/actions/workflows/ci.yml)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue)](https://github.com/botifyex/egress-proxy/blob/master/LICENSE)
+
+Send the HTTP requests of your Python project through your own server with a drop-in integration
+for its HTTP client: they leave from the server's IP, or from upstream HTTP and SOCKS proxies it
+rotates through, with identifying headers removed.
+
+## Quick start
+
+**1. Start the server** on the machine whose IP the requests should come from:
+
+```sh
+pip install "egress-proxy[server]"
+python -c "import secrets; print('PROXY__KEY=' + secrets.token_urlsafe(32))" > .env
+egress-proxy --host 0.0.0.0 --port 8000
+```
+
+The generated key is in `.env`; the client needs it.
+
+**2. Use it in your project** with the HTTP client you already have:
+
+```sh
+pip install "egress-proxy[client-httpx]"     # httpx
+pip install "egress-proxy[client-aiohttp]"   # aiohttp
+pip install "egress-proxy[client]"           # both
+```
+
+```python
+import asyncio
+
+from egress_proxy.client.httpx import AsyncClient
+
+
+async def main() -> None:
+    async with AsyncClient(egress_url="http://SERVER_IP:8000", egress_key="PROXY_KEY") as client:
+        response = await client.get("https://api.ipify.org?format=json")
+        print(response.json())
+
+
+asyncio.run(main())
+```
+
+It prints the server's IP. The `egress_*` parameters configure the proxy; everything else goes to
+the HTTP client unchanged.
+
+## httpx
+
+**Replace the client class.** `Client` and `AsyncClient` are `httpx.Client` / `httpx.AsyncClient`
+subclasses and accept all of their options:
+
+```python
+from egress_proxy.client.httpx import AsyncClient, Client
+
+client = AsyncClient(
+    egress_url="http://SERVER_IP:8000",
+    egress_key="PROXY_KEY",
+    base_url="https://api.example.com",
+    timeout=10,
+)
+```
+
+**Keep your own client** and only swap its transport (`Transport` for `httpx.Client`):
+
+```python
+import httpx
+from egress_proxy.client.httpx import AsyncTransport
+
+client = httpx.AsyncClient(
+    transport=AsyncTransport(egress_url="http://SERVER_IP:8000", egress_key="PROXY_KEY"),
+)
+```
+
+**Subclass it** like any httpx client:
+
+```python
+class Api(AsyncClient):
+    def __init__(self) -> None:
+        super().__init__(
+            egress_url="http://SERVER_IP:8000",
+            egress_key="PROXY_KEY",
+            base_url="https://api.example.com",
+        )
+```
+
+To tune the connection to the proxy server, pass `egress_transport`, for example
+`egress_transport=httpx.AsyncHTTPTransport(http2=True, retries=2)`.
+
+| Situation | Raised |
+|---|---|
+| Wrong key or invalid target URL | `egress_proxy.client.httpx.Refused` (a `httpx.TransportError`) |
+| Target did not answer in time | `httpx.TimeoutException` |
+| Target or proxy server unreachable | `httpx.ConnectError` |
+
+## aiohttp
+
+**Create a session.** `session` returns a regular `aiohttp.ClientSession` and accepts all of its
+options:
+
+```python
+from egress_proxy.client.aiohttp import session
+
+client = session(
+    egress_url="http://SERVER_IP:8000",
+    egress_key="PROXY_KEY",
+    base_url="https://api.example.com/",
+)
+```
+
+**Keep your own session** and add the middleware; put it last so your own middlewares see the
+target URL:
+
+```python
+import aiohttp
+from egress_proxy.client.aiohttp import Middleware
+
+client = aiohttp.ClientSession(
+    middlewares=[Middleware(egress_url="http://SERVER_IP:8000", egress_key="PROXY_KEY")],
+)
+```
+
+`response.url`, redirects and cookies refer to the target, exactly as without the proxy.
+
+| Situation | Raised |
+|---|---|
+| Wrong key or invalid target URL | `egress_proxy.client.aiohttp.Refused` (an `aiohttp.ClientError`) |
+| Target did not answer in time | `aiohttp.ServerTimeoutError` (also a `TimeoutError`) |
+| Target unreachable | `aiohttp.ClientConnectionError` |
+| Proxy server unreachable | `aiohttp.ClientConnectorError` |
+
+With either client, errors are the library's own exceptions, so existing `except` blocks keep
+working, and responses with error statuses (404, 500, …) come back as normal responses.
+
+## Server configuration
+
+Settings are read from `.env` in the working directory or from environment variables, which take
+precedence. Template: [`.env.example`](https://github.com/botifyex/egress-proxy/blob/master/.env.example).
+
+| Variable | Default | Meaning |
+|---|---|---|
+| `PROXY__KEY` | required | Key every client must send |
+| `PROXY__TIMEOUT` | `30` | Seconds to wait for the target |
+| `PROXY__CONNECT` | `10` | Seconds to connect to the target |
+| `PROXY__UPSTREAMS_FILE` | none | File with upstream proxies, see below; `--upstreams-file` overrides it |
+| `PROXY__UPSTREAMS` | `[]` | Upstream proxies inline, as a JSON list |
+| `PROXY__COOLDOWN` | `30` | Seconds an unreachable upstream proxy is left out |
+| `PROXY__ATTEMPTS` | `3` | Upstream proxies tried per request before giving up |
+| `PROXY__ALLOW_LOCAL` | `false` | Allow targets on local and private networks, see below |
+| `SERVER__HOST` | `127.0.0.1` | Address to listen on |
+| `SERVER__PORT` | `8000` | Port to listen on |
+
+The client's own timeout still applies (httpx defaults to 5 seconds), so raise it as well for slow
+targets: `AsyncClient(..., timeout=60)`.
+
+`egress-proxy` accepts every [uvicorn option](https://uvicorn.dev/settings/), and command-line
+values override `.env`:
+
+```sh
+egress-proxy --host 0.0.0.0 --port 8000 --workers 4 --log-level warning
+```
+
+The access log is off by default, since every line would read `GET / 200`; enable it with
+`--access-log`.
+
+**Use HTTPS over the internet.** The key travels in a request header, so encrypt the connection,
+either directly or behind a TLS-terminating reverse proxy, and use `https://` in the client:
+
+```sh
+egress-proxy --host 0.0.0.0 --port 443 --ssl-keyfile key.pem --ssl-certfile cert.pem
+```
+
+## Local networks
+
+By default the server refuses targets that are not publicly routable, so a client cannot use it to
+reach services next to it: loopback, private networks (`10.0.0.0/8`, `172.16.0.0/12`,
+`192.168.0.0/16`, `fc00::/7`), link-local addresses including cloud metadata at
+`169.254.169.254`, shared and reserved ranges, multicast, and IPv6 forms that embed such an IPv4
+address. Host names are checked after DNS resolution and the connection uses only the checked
+addresses, so a name that points to a local address, or later starts to, is refused as well.
+Refused requests get a 400 with `x-egress-failure: invalid`.
+
+To proxy into local networks on purpose, set `PROXY__ALLOW_LOCAL=true`.
+
+Through upstream proxies, local IP addresses in the target are still refused, but host names are
+resolved by the proxy and reach whatever its network serves under that name.
+
+## Upstream proxies
+
+Without upstream proxies the server sends requests itself. List HTTP or SOCKS proxies and it spreads
+requests across them in turn instead, so they leave from the proxies' IPs:
+
+```sh
+cat > proxies.txt <<'EOF'
+socks5h://user:password@proxy-1.example.net:1080
+http://user:password@proxy-2.example.net:3128
+EOF
+echo "PROXY__UPSTREAMS_FILE=proxies.txt" >> .env
+```
+
+One proxy URL per line; blank lines and `#` comments are ignored. Template:
+[`proxies.example.txt`](https://github.com/botifyex/egress-proxy/blob/master/proxies.example.txt).
+
+| Scheme | Proxy |
+|---|---|
+| `http://`, `https://` | HTTP proxy (CONNECT), `https` reaches the proxy over TLS |
+| `socks5h://` | SOCKS5, host names resolved by the proxy |
+| `socks5://` | SOCKS5, host names resolved by the egress server |
+| `socks4://` | SOCKS4 |
+
+The file can also be given on the command line, which overrides `.env`:
+
+```sh
+egress-proxy --upstreams-file proxies.txt --host 0.0.0.0
+```
+
+A few proxies can go straight into `.env` instead: `PROXY__UPSTREAMS=["socks5h://host:1080"]`.
+Both sources can be combined; the file comes first.
+
+If a proxy cannot be reached, the request moves on to the next one and the unreachable proxy is
+left out for `PROXY__COOLDOWN` seconds. A proxy that refuses the tunnel, for example over a wrong
+password or a target it cannot reach, is skipped for that request only. The client gets a 502 once
+`PROXY__ATTEMPTS` proxies have failed. An invalid proxy URL stops the server at startup with its
+file and line.
+
+## How it works
+
+The client sends each request to the server with the target URL and the key in headers. The
+server checks the key, forwards the request over a pooled keep-alive connection and streams the
+response back unchanged. Redirects and cookies are handled by your client, never stored on the
+server.
+
+Before forwarding, the server removes every header that could reveal the client or the proxy,
+including those a load balancer or CDN in front of it adds:
+
+- client addresses: `X-Forwarded-For`, `Forwarded`, `X-Real-IP`, `X-Client-IP`, `Client-IP`,
+  `True-Client-IP`, `X-Originating-IP`, `X-Remote-Addr`, `CF-Connecting-IP`, `Fastly-Client-IP`,
+  `CloudFront-Viewer-Address`, `X-Azure-ClientIP` and any other name containing `forwarded`,
+  `client-ip`, `real-ip`, `remote-addr` or a similar fragment;
+- proxy and CDN markers: `Via`, `CF-Ray`, `CDN-Loop`, `X-Amzn-Trace-Id`, `X-Envoy-*`,
+  `CloudFront-Viewer-*` and similar;
+- hop-by-hop headers, including every header named in `Connection` (RFC 9110), and `Proxy`
+  (httpoxy).
+
+Names are compared case-insensitively with `_` treated as `-`, since many servers map both to the
+same variable. Credentials such as `Authorization`, `Cookie`, `CF-Access-Client-Id` or
+`Fastly-Key` pass through untouched.
+
+## Requirements
+
+Python 3.11+. The clients need httpx 0.25.1+ or aiohttp 3.13+; the server runs on uvicorn and
+aiohttp and handles about 13,000 requests per second on a single core.
+
+## License
+
+[Apache-2.0](https://github.com/botifyex/egress-proxy/blob/master/LICENSE): use, modify and
+distribute it freely, including commercially. Keep the license and the
+[NOTICE](https://github.com/botifyex/egress-proxy/blob/master/NOTICE) with every copy and mark the
+files you change.
+
+Contributing and releases:
+[CONTRIBUTING.md](https://github.com/botifyex/egress-proxy/blob/master/CONTRIBUTING.md).
+Security issues: [SECURITY.md](https://github.com/botifyex/egress-proxy/blob/master/SECURITY.md).