pymasque 0.1.0__tar.gz

pymasque-0.1.0/LICENSE

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

pymasque-0.1.0/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: pymasque
+Version: 0.1.0
+Summary: A minimal implementation of a Cloudflare Warp MASQUE client in Python.
+Author: ading2210
+License-Expression: LGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/MercuryWorkshop/pymasque
+Project-URL: Issues, https://github.com/MercuryWorkshop/pymasque/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: niquests
+Requires-Dist: qh3
+Requires-Dist: cryptography
+Requires-Dist: platformdirs
+Provides-Extra: socks
+Requires-Dist: asyncio-socks-server; extra == "socks"
+Dynamic: license-file
+
+# pymasque
+
+pymasque is a minimal implementation of a Cloudflare Warp MASQUE client in Python, powered by [qh3](https://github.com/jawah/qh3).
+
+It only implements the [L4 mode of the MASQUE proxy](https://gist.github.com/ading2210/d146549760cac2e1e1b70db3b5805584). This is faster and does not require a userspace IP stack, but only supports TCP.
+
+## Installation
+
+Install it as a library:
+
+```
+pip3 install pymasque
+```
+
+Install it with a built-in SOCKS5 proxy:
+
+```
+pip3 install pymasque[socks]
+```
+
+## Usage
+
+### SOCKS5 Proxy Mode
+
+Use the SOCKS5 proxy mode to launch a SOCKS5 server that proxies all connections over Warp:
+```
+$ python3 -m pymasque.socks -h
+usage: pymasque.socks [-h] [--host HOST] [--port PORT] [--auth AUTH] [--log-level {DEBUG,INFO,WARNING,ERROR}]
+                      [--log-format {text,json}]
+
+SOCKS5 proxy routing through Cloudflare WARP/MASQUE
+
+options:
+  -h, --help            show this help message and exit
+  --host HOST           bind address
+  --port PORT           bind port
+  --auth AUTH           username:password
+  --log-level {DEBUG,INFO,WARNING,ERROR}
+  --log-format {text,json}
+```
+
+On first run, a new Cloudflare Warp account will be created, the details of which will be cached to the disk.
+
+### As a Library
+
+pymasque is easy to integrate into your asyncio applications.
+
+### Basic Example:
+
+```python
+import asyncio
+import pymasque
+
+async def main():
+  warp = pymasque.WarpConnection()
+  stream = await warp.open_stream("cloudflare.com", 80)
+
+  #send an http/1.1 payload
+  payload = "GET /cdn-cgi/trace HTTP/1.1\r\nHost: cloudflare.com\r\nConnection: keepalive\r\n\r\n"
+  await stream.send(payload.encode())
+  response = await stream.recv()
+  print(response.decode())
+
+asyncio.run(main())
+```
+
+`pymasque.WarpConnection` and `pymasque.WarpStream` contain all that you need for sending TCP traffic over Cloudflare workers.
+
+#### Creating New MASQUE Connections:
+
+Creating a new `pymasque.WarpConnection` object and calling `.connect()` on it will create a new MASQUE connection to Cloudflare Warp. 
+
+You don't need to explicitly call `.connect()`, it will automatically run when you create the first stream.
+
+```python
+warp = pymasque.WarpConnection()
+await warp.connect()
+```
+
+#### Creating New Streams:
+
+Streams can be created by calling `WarpConnection.open_stream(hostname, port)`. The hostname can be any domain name, IPv4 address, or IPv6 address. If a domain name is provided, it will be resolved locally using the system DNS resolver. This will return a `pymasque.WarpStream` object.
+
+```python
+warp = pymasque.WarpConnection()
+stream = await warp.open_stream("example.com", 1234)
+```
+
+Once you have your stream object, you may call `stream.recv()` or `stream.send(data)` to recieve or send data. The data sent must be a bytes object.
+
+```python
+await stream.send(b"hello world")
+response = await stream.recv()
+```
+
+## License
+
+This project is licensed under the [GNU LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.html).
+
+> This license is mainly applied to libraries. You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL, but applications that use the library don't have to be.
+> 
+> \- From [tldrlegal.com](https://www.tldrlegal.com/license/gnu-lesser-general-public-license-v3-lgpl-3)

pymasque-0.1.0/README.md

@@ -0,0 +1,102 @@
+# pymasque
+
+pymasque is a minimal implementation of a Cloudflare Warp MASQUE client in Python, powered by [qh3](https://github.com/jawah/qh3).
+
+It only implements the [L4 mode of the MASQUE proxy](https://gist.github.com/ading2210/d146549760cac2e1e1b70db3b5805584). This is faster and does not require a userspace IP stack, but only supports TCP.
+
+## Installation
+
+Install it as a library:
+
+```
+pip3 install pymasque
+```
+
+Install it with a built-in SOCKS5 proxy:
+
+```
+pip3 install pymasque[socks]
+```
+
+## Usage
+
+### SOCKS5 Proxy Mode
+
+Use the SOCKS5 proxy mode to launch a SOCKS5 server that proxies all connections over Warp:
+```
+$ python3 -m pymasque.socks -h
+usage: pymasque.socks [-h] [--host HOST] [--port PORT] [--auth AUTH] [--log-level {DEBUG,INFO,WARNING,ERROR}]
+                      [--log-format {text,json}]
+
+SOCKS5 proxy routing through Cloudflare WARP/MASQUE
+
+options:
+  -h, --help            show this help message and exit
+  --host HOST           bind address
+  --port PORT           bind port
+  --auth AUTH           username:password
+  --log-level {DEBUG,INFO,WARNING,ERROR}
+  --log-format {text,json}
+```
+
+On first run, a new Cloudflare Warp account will be created, the details of which will be cached to the disk.
+
+### As a Library
+
+pymasque is easy to integrate into your asyncio applications.
+
+### Basic Example:
+
+```python
+import asyncio
+import pymasque
+
+async def main():
+  warp = pymasque.WarpConnection()
+  stream = await warp.open_stream("cloudflare.com", 80)
+
+  #send an http/1.1 payload
+  payload = "GET /cdn-cgi/trace HTTP/1.1\r\nHost: cloudflare.com\r\nConnection: keepalive\r\n\r\n"
+  await stream.send(payload.encode())
+  response = await stream.recv()
+  print(response.decode())
+
+asyncio.run(main())
+```
+
+`pymasque.WarpConnection` and `pymasque.WarpStream` contain all that you need for sending TCP traffic over Cloudflare workers.
+
+#### Creating New MASQUE Connections:
+
+Creating a new `pymasque.WarpConnection` object and calling `.connect()` on it will create a new MASQUE connection to Cloudflare Warp. 
+
+You don't need to explicitly call `.connect()`, it will automatically run when you create the first stream.
+
+```python
+warp = pymasque.WarpConnection()
+await warp.connect()
+```
+
+#### Creating New Streams:
+
+Streams can be created by calling `WarpConnection.open_stream(hostname, port)`. The hostname can be any domain name, IPv4 address, or IPv6 address. If a domain name is provided, it will be resolved locally using the system DNS resolver. This will return a `pymasque.WarpStream` object.
+
+```python
+warp = pymasque.WarpConnection()
+stream = await warp.open_stream("example.com", 1234)
+```
+
+Once you have your stream object, you may call `stream.recv()` or `stream.send(data)` to recieve or send data. The data sent must be a bytes object.
+
+```python
+await stream.send(b"hello world")
+response = await stream.recv()
+```
+
+## License
+
+This project is licensed under the [GNU LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.html).
+
+> This license is mainly applied to libraries. You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL, but applications that use the library don't have to be.
+> 
+> \- From [tldrlegal.com](https://www.tldrlegal.com/license/gnu-lesser-general-public-license-v3-lgpl-3)

pymasque-0.1.0/pyproject.toml

@@ -0,0 +1,40 @@
+#run 'python3 -m build' to build the project
+#then run 'twine upload dist/*' to publish
+
+[build-system]
+requires = ["setuptools>=84.0", "toml"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["pymasque"]
+package-dir = {"" = "src"}
+
+[project]
+name = "pymasque"
+version = "0.1.0"
+license = "LGPL-3.0-or-later"
+authors = [
+  {name="ading2210"},
+]
+description = "A minimal implementation of a Cloudflare Warp MASQUE client in Python."
+readme = "README.md"
+requires-python = ">=3.9"
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Operating System :: OS Independent",
+]
+dependencies = [
+  "niquests",
+  "qh3",
+  "cryptography",
+  "platformdirs"
+]
+
+[project.optional-dependencies]
+socks = [
+  "asyncio-socks-server"
+]
+
+[project.urls]
+Homepage = "https://github.com/MercuryWorkshop/pymasque"
+Issues = "https://github.com/MercuryWorkshop/pymasque/issues"

pymasque-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

pymasque-0.1.0/src/pymasque/__init__.py

@@ -0,0 +1,342 @@
+import os
+import base64
+import logging
+import re
+import json
+import ssl
+import socket
+import asyncio
+import ipaddress
+from datetime import datetime, timezone, timedelta
+
+import platformdirs
+import niquests
+import qh3
+from cryptography import x509
+from cryptography.hazmat.primitives import hashes, serialization
+from cryptography.hazmat.primitives.asymmetric import ec
+from cryptography.hazmat.primitives.serialization import load_der_private_key, load_pem_public_key
+
+#a client for the cloudflare warp l4 proxy service
+#based on https://github.com/Diniboy1123/usque
+
+cf_api = "https://api.cloudflareclient.com/v0a4471"
+cf_headers = {
+  "User-Agent": "WARP for Android",
+  "CF-Client-Version": "a-6.35-4471"
+}
+cf_sni = "consumer-masque-proxy.cloudflareclient.com"
+
+dirs = platformdirs.PlatformDirs("pymasque")
+data_dir = dirs.user_data_path
+registration_file = data_dir / "warp_config.json"
+
+async def register():
+  reg_key = base64.b64encode(os.urandom(32)).decode()
+  tos_date = datetime.now().astimezone().isoformat(timespec="milliseconds")
+
+  reg_response = await niquests.apost(cf_api + "/reg", json={
+    "key": reg_key,
+    "install_id": "",
+    "fcm_token": "",
+    "tos": tos_date,
+    "model": "PC",
+    "serial_number": os.urandom(4).hex(),
+    "os_version": "",
+    "key_type": "curve25519",
+    "tunnel_type": "wireguard",
+    "locale": "en_US"
+  }, headers=cf_headers)
+  reg_response.raise_for_status()
+  registration = reg_response.json()
+
+  device_id = registration["id"]
+  token = registration["token"]
+  private_key = ec.generate_private_key(ec.SECP256R1())
+  private_key_der = private_key.private_bytes(serialization.Encoding.DER, serialization.PrivateFormat.TraditionalOpenSSL, serialization.NoEncryption())
+  private_key_str = base64.b64encode(private_key_der).decode()
+  public_key_der = private_key.public_key().public_bytes(serialization.Encoding.DER, serialization.PublicFormat.SubjectPublicKeyInfo)
+  public_key_str = base64.b64encode(public_key_der).decode()
+
+  enroll_response = await niquests.apatch(cf_api + f"/reg/{device_id}", json={
+    "key": public_key_str,
+    "key_type": "secp256r1",
+    "tunnel_type": "masque",
+    "name": ""
+  }, headers={**cf_headers, "Authorization": f"Bearer {token}"})
+  enroll_response.raise_for_status()
+  enrollment = enroll_response.json()
+
+  peer = enrollment["config"]["peers"][0]
+  endpoint_ipv4 = peer["endpoint"]["v4"].split(":")[0]
+  endpoint_ipv6 = re.findall(r"\[(.+)\]:0", peer["endpoint"]["v6"])[0]
+
+  warp_config = {
+    "id": device_id,
+    "token": token,
+    "private_key": private_key_str,
+    "endpoint_ipv4": endpoint_ipv4,
+    "endpoint_ipv6": endpoint_ipv6,
+    "endpoint_public_key": peer["public_key"]
+  }
+  return warp_config
+
+async def read_registration():
+  if registration_file.exists():
+    return json.loads(registration_file.read_text())
+  else:
+    logging.info("creating new cf warp registration")
+    registration = await register()
+    data_dir.mkdir(exist_ok=True, parents=True)
+    registration_file.write_text(json.dumps(registration, indent=2))
+    logging.info(f"saved cf warp registration data to {registration_file}")
+    return registration
+
+async def resolve_ip(hostname):
+  try:
+    infos = await asyncio.get_running_loop().getaddrinfo(hostname, None, type=socket.SOCK_STREAM)
+  except socket.gaierror as e:
+    raise ConnectionError(f"DNS resolution failed for {hostname}: {e}") from e
+  return str(ipaddress.ip_address(infos[0][4][0]))
+
+class WarpQuicProtocol(qh3.asyncio.QuicConnectionProtocol):
+  def __init__(self, *args, **kwargs):
+    super().__init__(*args, **kwargs)
+    self.h3 = qh3.H3Connection(self._quic)
+    self.streams = {}
+    self.send_waiters = set()
+
+  @property
+  def closed(self):
+    return self._closed.is_set()
+
+  @property
+  def peercert(self):
+    return self._quic.get_peercert()
+
+  def open_h3_stream_id(self):
+    return self._quic.get_next_available_stream_id(is_unidirectional=False)
+
+  def reset_h3_stream(self, stream_id):
+    try:
+      self._quic.reset_stream(stream_id, 0)
+      self.transmit()
+    except Exception:
+      pass
+
+  def notify_send_waiters(self):
+    for fut in list(self.send_waiters):
+      if not fut.done():
+        fut.set_result(None)
+
+  def transmit(self):
+    try:
+      super().transmit()
+    finally:
+      self.notify_send_waiters()
+
+  def quic_event_received(self, event):
+    if getattr(event, "stream_id", None) is None:
+      super().quic_event_received(event)
+    for h3_event in self.h3.handle_event(event):
+      if stream := self.streams.get(h3_event.stream_id):
+        stream.on_h3_event(h3_event)
+
+class WarpStream:
+  CONNECTING, OPEN, CLOSED = range(3)
+
+  def __init__(self, proto, stream_id, timeout=15, max_buffered=128*1024):
+    self.proto = proto
+    self.id = stream_id
+    self.timeout = timeout
+    self.max_buffered = max_buffered
+    self.headers = asyncio.get_running_loop().create_future()
+    self.incoming = asyncio.Queue()
+    self.state = WarpStream.CONNECTING
+    self.proto.streams[stream_id] = self
+
+  def on_h3_event(self, hev):
+    if isinstance(hev, qh3.h3_events.HeadersReceived):
+      if not self.headers.done():
+        self.headers.set_result((hev.headers, hev.stream_ended))
+      if hev.stream_ended:
+        self.incoming.put_nowait((b"", True))
+    elif isinstance(hev, qh3.h3_events.DataReceived):
+      self.incoming.put_nowait((hev.data, hev.stream_ended))
+    elif isinstance(hev, (qh3.h3_events.StreamReset, qh3.h3_events.StopSending)):
+      self.incoming.put_nowait((None, True))
+      if not self.headers.done():
+        self.headers.set_exception(ConnectionResetError(f"stream {self.id} reset"))
+      self.proto.notify_send_waiters()
+
+  async def ensure_response(self):
+    if self.state is WarpStream.OPEN:
+      return
+    try:
+      async with asyncio.timeout(self.timeout):
+        headers = (await self.headers)[0]
+    except TimeoutError:
+      raise ConnectionError("CONNECT timed out")
+    status = dict(headers).get(b":status", b"").decode()
+    if not status.startswith("2"):
+      raise ConnectionError(f"CONNECT rejected with status {status}")
+    self.state = WarpStream.OPEN
+
+  async def recv(self):
+    if self.state is WarpStream.CLOSED:
+      return None
+    try:
+      await self.ensure_response()
+    except ConnectionError:
+      self.state = WarpStream.CLOSED
+      return None
+    data, ended = await self.incoming.get()
+    if data is None or ended:
+      self.state = WarpStream.CLOSED
+      return None
+    return data
+
+  async def send(self, data, max_buffered=None):
+    if not data:
+      return
+    if self.state is WarpStream.CLOSED:
+      raise ConnectionResetError(f"stream {self.id} closed")
+    self.write(data)
+    await self.drain(max_buffered=max_buffered)
+
+  def write(self, data):
+    if not data or self.state is WarpStream.CLOSED:
+      return
+    try:
+      self.proto.h3.send_data(self.id, data, False)
+      self.proto.transmit()
+    except (ValueError, RuntimeError) as e:
+      raise ConnectionResetError(f"stream {self.id} closed") from e
+
+  async def drain(self, max_buffered=None):
+    if self.state is WarpStream.CLOSED:
+      return
+    limit = self.max_buffered if max_buffered is None else max_buffered
+    while limit is not None and self.proto._quic.get_send_buffer_size(self.id) > limit:
+      if self.state is WarpStream.CLOSED:
+        return
+      if self.proto.closed:
+        raise ConnectionError(f"stream {self.id} connection closed")
+      fut = asyncio.get_running_loop().create_future()
+      self.proto.send_waiters.add(fut)
+      try:
+        await fut
+      finally:
+        self.proto.send_waiters.discard(fut)
+
+  def close(self):
+    self.state = WarpStream.CLOSED
+    try:
+      self.incoming.put_nowait((None, True))
+    except Exception:
+      pass
+    self.proto.reset_h3_stream(self.id)
+    self.proto.streams.pop(self.id, None)
+    self.proto.notify_send_waiters()
+    if not self.headers.done():
+      self.headers.cancel()
+
+  async def read(self, n=-1):
+    return await self.recv() or b""
+
+  async def wait_closed(self):
+    return None
+
+class WarpConnection:
+  OPEN, CLOSING = range(2)
+
+  def __init__(self):
+    self.quic_context = None
+    self.quic_protocol = None
+    self.state = WarpConnection.OPEN
+    
+  async def connect(self):
+    if self.quic_protocol is not None and not self.quic_protocol.closed:
+      return self.quic_protocol
+    registration = await read_registration()
+
+    private_key_der = base64.b64decode(registration["private_key"])
+    private_key = load_der_private_key(private_key_der, password=None)
+    pkcs8_der = private_key.private_bytes(serialization.Encoding.DER, serialization.PrivateFormat.PKCS8, serialization.NoEncryption())
+    quic_private_key = qh3._hazmat.EcPrivateKey(pkcs8_der, 256, True)
+
+    now = datetime.now(timezone.utc)
+    cert_der = (
+      x509.CertificateBuilder()
+      .serial_number(1)
+      .issuer_name(x509.Name([]))
+      .subject_name(x509.Name([]))
+      .public_key(private_key.public_key())
+      .not_valid_before(now)
+      .not_valid_after(now + timedelta(hours=24))
+      .sign(private_key, hashes.SHA256())
+      .public_bytes(serialization.Encoding.DER)
+    )
+    quic_cert = qh3._hazmat.Certificate(cert_der)
+
+    quic_config = qh3.QuicConfiguration(
+      is_client=True, alpn_protocols=["h3"], server_name=cf_sni,
+      certificate=quic_cert, private_key=quic_private_key,
+      verify_mode=ssl.CERT_NONE, verify_hostname=False,
+      offer_ec_key_shares=True,
+    )
+    
+    logging.info("connecting to cloudflare warp server")
+    self.quic_context = qh3.asyncio.connect(registration["endpoint_ipv4"], 443, configuration=quic_config, create_protocol=WarpQuicProtocol)
+    self.quic_protocol = await self.quic_context.__aenter__()
+
+    peer_public_key = self.quic_protocol.peercert.public_key()
+    edge_key = load_pem_public_key(registration["endpoint_public_key"].encode())
+    edge_public_key = edge_key.public_bytes(serialization.Encoding.X962, serialization.PublicFormat.UncompressedPoint)
+    if peer_public_key != edge_public_key:
+      await self.close()
+      raise ssl.SSLCertVerificationError("edge public key does not match")
+    asyncio.create_task(self.keepalive())
+    return self.quic_protocol
+  
+  async def close(self):
+    if self.quic_context is not None:
+      await self.quic_context.__aexit__(None, None, None)
+    self.quic_context = None
+    self.quic_protocol = None
+
+  def close_all(self):
+    self.state = WarpConnection.CLOSING
+    proto = self.quic_protocol
+    if proto is None:
+      return
+    for stream in list(proto.streams.values()):
+      try:
+        stream.close()
+      except Exception:
+        pass
+
+  async def open_stream(self, hostname, port, timeout=15, max_buffered=128*1024):
+    if self.state is WarpConnection.CLOSING:
+      raise ConnectionError("server shutting down")
+    proto = await self.connect()
+    try:
+      ip = str(ipaddress.ip_address(hostname))
+    except ValueError:
+      ip = await resolve_ip(hostname)
+    authority = f"[{ip}]:{port}" if ":" in ip else f"{ip}:{port}"
+    stream = WarpStream(proto, proto.open_h3_stream_id(), timeout, max_buffered)
+    proto.h3.send_headers(stream.id, [
+      (b":method", b"CONNECT"),
+      (b":authority", authority.encode()),
+    ], end_stream=False)
+    proto.transmit()
+    return stream
+  
+  async def keepalive(self):
+    while self.quic_protocol:
+      await asyncio.sleep(15)
+      try:
+        await self.quic_protocol.ping()
+      except Exception:
+        continue

pymasque-0.1.0/src/pymasque/socks.py

@@ -0,0 +1,68 @@
+from pymasque import WarpConnection
+
+try:
+  from asyncio_socks_server import Addon, Address, Connection, Server
+except ImportError as e:
+  raise ImportError("asyncio-socks-server is required for pymasque.socks. Run \"pip install 'pymasque[socks]'\" to install it.")
+
+try:
+  import asyncio, uvloop
+  asyncio.set_event_loop_policy(uvloop.EventLoopPolicy())
+except ImportError as e:
+  pass
+
+class WarpAddon(Addon):
+  def __init__(self):
+    self.warp = WarpConnection()
+
+  async def on_connect(self, flow):
+    stream = await self.warp.open_stream(flow.dst.host, flow.dst.port)
+    await stream.ensure_response()
+    return Connection(
+      reader=stream,
+      writer=stream,
+      address=Address(flow.dst.host, flow.dst.port),
+    )
+
+  async def on_stop(self):
+    await self.warp.close()
+
+class WarpServer(Server):
+  def __init__(self, **kwargs):
+    addon = WarpAddon()
+    super().__init__(addons=[addon], **kwargs)
+    self.addon = addon
+
+  def request_shutdown(self):
+    try:
+      self.addon.warp.close_all()
+    except Exception:
+      pass
+    super().request_shutdown()
+
+def serve(**kwargs):
+  WarpServer(**kwargs).run()
+
+def main(argv=None):
+  import argparse
+
+  parser = argparse.ArgumentParser(
+    prog="pymasque.socks",
+    description="SOCKS5 proxy routing through Cloudflare WARP/MASQUE",
+  )
+  parser.add_argument("--host", default="127.0.0.1", help="bind address")
+  parser.add_argument("--port", type=int, default=1080, help="bind port")
+  parser.add_argument("--auth", default=None, help="username:password")
+  parser.add_argument("--log-level", default="INFO", choices=["DEBUG", "INFO", "WARNING", "ERROR"])
+  parser.add_argument("--log-format", default="text", choices=["text", "json"])
+  args = parser.parse_args(argv)
+  auth = None
+  if args.auth:
+    user, _, passwd = args.auth.partition(":")
+    auth = (user, passwd)
+  serve(host=args.host, port=args.port, auth=auth,
+    log_level=args.log_level, log_format=args.log_format)
+
+
+if __name__ == "__main__":
+  main()

pymasque-0.1.0/src/pymasque.egg-info/PKG-INFO

@@ -0,0 +1,123 @@
+Metadata-Version: 2.4
+Name: pymasque
+Version: 0.1.0
+Summary: A minimal implementation of a Cloudflare Warp MASQUE client in Python.
+Author: ading2210
+License-Expression: LGPL-3.0-or-later
+Project-URL: Homepage, https://github.com/MercuryWorkshop/pymasque
+Project-URL: Issues, https://github.com/MercuryWorkshop/pymasque/issues
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: niquests
+Requires-Dist: qh3
+Requires-Dist: cryptography
+Requires-Dist: platformdirs
+Provides-Extra: socks
+Requires-Dist: asyncio-socks-server; extra == "socks"
+Dynamic: license-file
+
+# pymasque
+
+pymasque is a minimal implementation of a Cloudflare Warp MASQUE client in Python, powered by [qh3](https://github.com/jawah/qh3).
+
+It only implements the [L4 mode of the MASQUE proxy](https://gist.github.com/ading2210/d146549760cac2e1e1b70db3b5805584). This is faster and does not require a userspace IP stack, but only supports TCP.
+
+## Installation
+
+Install it as a library:
+
+```
+pip3 install pymasque
+```
+
+Install it with a built-in SOCKS5 proxy:
+
+```
+pip3 install pymasque[socks]
+```
+
+## Usage
+
+### SOCKS5 Proxy Mode
+
+Use the SOCKS5 proxy mode to launch a SOCKS5 server that proxies all connections over Warp:
+```
+$ python3 -m pymasque.socks -h
+usage: pymasque.socks [-h] [--host HOST] [--port PORT] [--auth AUTH] [--log-level {DEBUG,INFO,WARNING,ERROR}]
+                      [--log-format {text,json}]
+
+SOCKS5 proxy routing through Cloudflare WARP/MASQUE
+
+options:
+  -h, --help            show this help message and exit
+  --host HOST           bind address
+  --port PORT           bind port
+  --auth AUTH           username:password
+  --log-level {DEBUG,INFO,WARNING,ERROR}
+  --log-format {text,json}
+```
+
+On first run, a new Cloudflare Warp account will be created, the details of which will be cached to the disk.
+
+### As a Library
+
+pymasque is easy to integrate into your asyncio applications.
+
+### Basic Example:
+
+```python
+import asyncio
+import pymasque
+
+async def main():
+  warp = pymasque.WarpConnection()
+  stream = await warp.open_stream("cloudflare.com", 80)
+
+  #send an http/1.1 payload
+  payload = "GET /cdn-cgi/trace HTTP/1.1\r\nHost: cloudflare.com\r\nConnection: keepalive\r\n\r\n"
+  await stream.send(payload.encode())
+  response = await stream.recv()
+  print(response.decode())
+
+asyncio.run(main())
+```
+
+`pymasque.WarpConnection` and `pymasque.WarpStream` contain all that you need for sending TCP traffic over Cloudflare workers.
+
+#### Creating New MASQUE Connections:
+
+Creating a new `pymasque.WarpConnection` object and calling `.connect()` on it will create a new MASQUE connection to Cloudflare Warp. 
+
+You don't need to explicitly call `.connect()`, it will automatically run when you create the first stream.
+
+```python
+warp = pymasque.WarpConnection()
+await warp.connect()
+```
+
+#### Creating New Streams:
+
+Streams can be created by calling `WarpConnection.open_stream(hostname, port)`. The hostname can be any domain name, IPv4 address, or IPv6 address. If a domain name is provided, it will be resolved locally using the system DNS resolver. This will return a `pymasque.WarpStream` object.
+
+```python
+warp = pymasque.WarpConnection()
+stream = await warp.open_stream("example.com", 1234)
+```
+
+Once you have your stream object, you may call `stream.recv()` or `stream.send(data)` to recieve or send data. The data sent must be a bytes object.
+
+```python
+await stream.send(b"hello world")
+response = await stream.recv()
+```
+
+## License
+
+This project is licensed under the [GNU LGPL v3](https://www.gnu.org/licenses/lgpl-3.0.html).
+
+> This license is mainly applied to libraries. You may copy, distribute and modify the software provided that modifications are described and licensed for free under LGPL. Derivatives works (including modifications or anything statically linked to the library) can only be redistributed under LGPL, but applications that use the library don't have to be.
+> 
+> \- From [tldrlegal.com](https://www.tldrlegal.com/license/gnu-lesser-general-public-license-v3-lgpl-3)

pymasque-0.1.0/src/pymasque.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+LICENSE
+README.md
+pyproject.toml
+src/pymasque/__init__.py
+src/pymasque/socks.py
+src/pymasque.egg-info/PKG-INFO
+src/pymasque.egg-info/SOURCES.txt
+src/pymasque.egg-info/dependency_links.txt
+src/pymasque.egg-info/requires.txt
+src/pymasque.egg-info/top_level.txt

pymasque-0.1.0/src/pymasque.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

pymasque-0.1.0/src/pymasque.egg-info/requires.txt

@@ -0,0 +1,7 @@
+niquests
+qh3
+cryptography
+platformdirs
+
+[socks]
+asyncio-socks-server

pymasque-0.1.0/src/pymasque.egg-info/top_level.txt

@@ -0,0 +1 @@
+pymasque