py-simple-nat-tunnel 0.1.0__tar.gz

py_simple_nat_tunnel-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 GGN_2015
+
+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.

py_simple_nat_tunnel-0.1.0/PKG-INFO

@@ -0,0 +1,193 @@
+Metadata-Version: 2.4
+Name: py-simple-nat-tunnel
+Version: 0.1.0
+Summary: A small Python TCP reverse tunnel compatible with common frp/rathole config subsets.
+Author: GGN_2015
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/GGN-2015/py-frp
+Project-URL: Repository, https://github.com/GGN-2015/py-frp
+Project-URL: Issues, https://github.com/GGN-2015/py-frp/issues
+Keywords: frp,rathole,reverse-proxy,tunnel,nat-traversal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: AsyncIO
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Topic :: Internet :: Proxy Servers
+Classifier: Topic :: System :: Networking
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: py-admin-launch>=0.1.3
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+Dynamic: license-file
+
+# py-frp
+
+一个小型 Python 生态内网穿透工具，设计上参考 frp/rathole 的“服务端公网监听 + 客户端反向拨入”模型。当前版本专注 TCP 端口映射，支持服务端、客户端、frp 常见 TOML/INI 配置子集，以及 rathole 常见 TOML 配置子集。
+
+## 安装
+
+从 PyPI 安装：
+
+```bash
+pip install py-simple-nat-tunnel
+```
+
+从源码安装：
+
+```bash
+pip install .
+```
+
+开发模式安装：
+
+```bash
+pip install -e .
+```
+
+安装后会得到这些命令：
+
+```bash
+py-frp --version
+py-frp server -c examples/frps.toml
+py-frp client -c examples/frpc.toml
+py-frps -c examples/frps.toml
+py-frpc -c examples/frpc.toml
+```
+
+Windows 上如果提示 scripts 目录不在 `PATH`，也可以直接用：
+
+```bash
+python -m py_frp server -c examples/frps.toml
+python -m py_frp client -c examples/frpc.toml
+```
+
+## 快速开始
+
+服务端公网机器：
+
+```bash
+py-frp server -c examples/frps.toml
+```
+
+客户端内网机器：
+
+```bash
+py-frp client -c examples/frpc.toml
+```
+
+`examples/frpc.toml` 默认把客户端的 `127.0.0.1:22` 暴露到服务端的 `0.0.0.0:6000`。启动后从外部访问：
+
+```bash
+ssh -p 6000 user@your-server
+```
+
+## frp 配置子集
+
+服务端 `frps.toml`：
+
+```toml
+bindPort = 7000
+
+[auth]
+token = "change-me"
+```
+
+客户端 `frpc.toml`：
+
+```toml
+serverAddr = "your-server"
+serverPort = 7000
+
+[auth]
+token = "change-me"
+
+[[proxies]]
+name = "ssh"
+type = "tcp"
+localIP = "127.0.0.1"
+localPort = 22
+remotePort = 6000
+```
+
+也支持旧版 frp INI 的 `[common]` 和 TCP proxy section：
+
+```ini
+[common]
+server_addr = your-server
+server_port = 7000
+token = change-me
+
+[ssh]
+type = tcp
+local_ip = 127.0.0.1
+local_port = 22
+remote_port = 6000
+```
+
+## rathole 配置子集
+
+服务端：
+
+```toml
+[server]
+bind_addr = "0.0.0.0:2333"
+default_token = "change-me"
+
+[server.services.ssh]
+bind_addr = "0.0.0.0:6000"
+```
+
+客户端：
+
+```toml
+[client]
+remote_addr = "your-server:2333"
+default_token = "change-me"
+
+[client.services.ssh]
+local_addr = "127.0.0.1:22"
+```
+
+## 提权
+
+服务端启动时如果配置里有小于 1024 的监听端口，默认会通过 `py-admin-launch` 尝试提权一次。也可以显式控制：
+
+```bash
+py-frp server -c frps.toml --elevate
+py-frp server -c frps.toml --no-auto-elevate
+```
+
+实现上会在重启命令后追加内部标记，保证最多只尝试一次，不会循环弹出提权请求。
+
+## 当前范围
+
+已支持：
+
+- TCP 反向端口映射
+- 多服务/多 proxy
+- token 鉴权
+- frp TOML 和 legacy INI 的常见 TCP 配置
+- rathole TOML 的常见 TCP 配置
+- `pip install .` 一键安装和 console scripts
+
+暂不支持：
+
+- UDP
+- HTTP/HTTPS vhost
+- frp 插件、负载均衡、STCP/XTCP
+- rathole Noise/TLS 加密传输
+- 多路复用；当前每个公网连接会建立一条独立 tunnel TCP
+
+## 测试
+
+```bash
+python -m unittest discover -s tests -v
+```

py_simple_nat_tunnel-0.1.0/README.md

@@ -0,0 +1,163 @@
+# py-frp
+
+一个小型 Python 生态内网穿透工具，设计上参考 frp/rathole 的“服务端公网监听 + 客户端反向拨入”模型。当前版本专注 TCP 端口映射，支持服务端、客户端、frp 常见 TOML/INI 配置子集，以及 rathole 常见 TOML 配置子集。
+
+## 安装
+
+从 PyPI 安装：
+
+```bash
+pip install py-simple-nat-tunnel
+```
+
+从源码安装：
+
+```bash
+pip install .
+```
+
+开发模式安装：
+
+```bash
+pip install -e .
+```
+
+安装后会得到这些命令：
+
+```bash
+py-frp --version
+py-frp server -c examples/frps.toml
+py-frp client -c examples/frpc.toml
+py-frps -c examples/frps.toml
+py-frpc -c examples/frpc.toml
+```
+
+Windows 上如果提示 scripts 目录不在 `PATH`，也可以直接用：
+
+```bash
+python -m py_frp server -c examples/frps.toml
+python -m py_frp client -c examples/frpc.toml
+```
+
+## 快速开始
+
+服务端公网机器：
+
+```bash
+py-frp server -c examples/frps.toml
+```
+
+客户端内网机器：
+
+```bash
+py-frp client -c examples/frpc.toml
+```
+
+`examples/frpc.toml` 默认把客户端的 `127.0.0.1:22` 暴露到服务端的 `0.0.0.0:6000`。启动后从外部访问：
+
+```bash
+ssh -p 6000 user@your-server
+```
+
+## frp 配置子集
+
+服务端 `frps.toml`：
+
+```toml
+bindPort = 7000
+
+[auth]
+token = "change-me"
+```
+
+客户端 `frpc.toml`：
+
+```toml
+serverAddr = "your-server"
+serverPort = 7000
+
+[auth]
+token = "change-me"
+
+[[proxies]]
+name = "ssh"
+type = "tcp"
+localIP = "127.0.0.1"
+localPort = 22
+remotePort = 6000
+```
+
+也支持旧版 frp INI 的 `[common]` 和 TCP proxy section：
+
+```ini
+[common]
+server_addr = your-server
+server_port = 7000
+token = change-me
+
+[ssh]
+type = tcp
+local_ip = 127.0.0.1
+local_port = 22
+remote_port = 6000
+```
+
+## rathole 配置子集
+
+服务端：
+
+```toml
+[server]
+bind_addr = "0.0.0.0:2333"
+default_token = "change-me"
+
+[server.services.ssh]
+bind_addr = "0.0.0.0:6000"
+```
+
+客户端：
+
+```toml
+[client]
+remote_addr = "your-server:2333"
+default_token = "change-me"
+
+[client.services.ssh]
+local_addr = "127.0.0.1:22"
+```
+
+## 提权
+
+服务端启动时如果配置里有小于 1024 的监听端口，默认会通过 `py-admin-launch` 尝试提权一次。也可以显式控制：
+
+```bash
+py-frp server -c frps.toml --elevate
+py-frp server -c frps.toml --no-auto-elevate
+```
+
+实现上会在重启命令后追加内部标记，保证最多只尝试一次，不会循环弹出提权请求。
+
+## 当前范围
+
+已支持：
+
+- TCP 反向端口映射
+- 多服务/多 proxy
+- token 鉴权
+- frp TOML 和 legacy INI 的常见 TCP 配置
+- rathole TOML 的常见 TCP 配置
+- `pip install .` 一键安装和 console scripts
+
+暂不支持：
+
+- UDP
+- HTTP/HTTPS vhost
+- frp 插件、负载均衡、STCP/XTCP
+- rathole Noise/TLS 加密传输
+- 多路复用；当前每个公网连接会建立一条独立 tunnel TCP
+
+## 测试
+
+```bash
+python -m unittest discover -s tests -v
+```

py_simple_nat_tunnel-0.1.0/pyproject.toml

@@ -0,0 +1,51 @@
+[build-system]
+requires = ["setuptools>=68", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "py-simple-nat-tunnel"
+version = "0.1.0"
+description = "A small Python TCP reverse tunnel compatible with common frp/rathole config subsets."
+readme = "README.md"
+requires-python = ">=3.9"
+license = "MIT"
+authors = [
+  { name = "GGN_2015" }
+]
+keywords = ["frp", "rathole", "reverse-proxy", "tunnel", "nat-traversal"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Environment :: Console",
+  "Framework :: AsyncIO",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.9",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: Internet :: Proxy Servers",
+  "Topic :: System :: Networking"
+]
+dependencies = [
+  "py-admin-launch>=0.1.3",
+  "tomli>=2.0.1; python_version < '3.11'"
+]
+
+[project.urls]
+Homepage = "https://github.com/GGN-2015/py-frp"
+Repository = "https://github.com/GGN-2015/py-frp"
+Issues = "https://github.com/GGN-2015/py-frp/issues"
+
+[project.scripts]
+py-frp = "py_frp.cli:main"
+pyfrp = "py_frp.cli:main"
+py-frps = "py_frp.cli:server_main"
+py-frpc = "py_frp.cli:client_main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+py_frp = ["py.typed"]

py_simple_nat_tunnel-0.1.0/setup.cfg

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

py_simple_nat_tunnel-0.1.0/src/py_frp/__init__.py

@@ -0,0 +1,7 @@
+"""A small asyncio-based TCP reverse tunnel."""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+__all__ = ["__version__"]

py_simple_nat_tunnel-0.1.0/src/py_frp/__main__.py

@@ -0,0 +1,7 @@
+from __future__ import annotations
+
+from .cli import main
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

py_simple_nat_tunnel-0.1.0/src/py_frp/cli.py

@@ -0,0 +1,115 @@
+from __future__ import annotations
+
+import argparse
+import asyncio
+import logging
+import sys
+from collections.abc import Sequence
+
+from . import __version__
+from .client import Client
+from .config import (
+    ConfigError,
+    describe_client_config,
+    describe_server_config,
+    load_client_config,
+    load_server_config,
+)
+from .elevate import ElevationError, is_admin, relaunch_once, should_elevate_server
+from .server import Server
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    effective_argv = list(sys.argv[1:] if argv is None else argv)
+    parser = build_parser()
+    args = parser.parse_args(effective_argv)
+    _configure_logging(args.log_level)
+
+    try:
+        if args.command == "server":
+            return _run_server_command(args, effective_argv)
+        if args.command == "client":
+            return _run_client_command(args)
+    except KeyboardInterrupt:
+        return 130
+    except ConfigError as exc:
+        LOGGER.error("configuration error: %s", exc)
+        return 2
+    except ElevationError as exc:
+        LOGGER.error("elevation failed: %s", exc)
+        return 1
+    return 2
+
+
+def server_main(argv: Sequence[str] | None = None) -> int:
+    return main(["server", *(sys.argv[1:] if argv is None else argv)])
+
+
+def client_main(argv: Sequence[str] | None = None) -> int:
+    return main(["client", *(sys.argv[1:] if argv is None else argv)])
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="py-frp",
+        description="A small Python TCP reverse tunnel.",
+    )
+    parser.add_argument("--version", action="version", version=f"py-frp {__version__}")
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    server = subparsers.add_parser("server", aliases=["frps"], help="run the public server")
+    _add_runtime_options(server)
+    server.add_argument("-c", "--config", required=True, help="server config path")
+    server.add_argument(
+        "--elevate",
+        action="store_true",
+        help="relaunch as administrator/root once before binding ports",
+    )
+    server.add_argument(
+        "--auto-elevate",
+        action=argparse.BooleanOptionalAction,
+        default=True,
+        help="auto elevate once when configured listen ports are privileged",
+    )
+    server.add_argument("--elevation-attempted", action="store_true", help=argparse.SUPPRESS)
+
+    client = subparsers.add_parser("client", aliases=["frpc"], help="run the private client")
+    _add_runtime_options(client)
+    client.add_argument("-c", "--config", required=True, help="client config path")
+
+    return parser
+
+
+def _add_runtime_options(parser: argparse.ArgumentParser) -> None:
+    parser.add_argument(
+        "--log-level",
+        default="INFO",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        help="logging level",
+    )
+
+
+def _run_server_command(args: argparse.Namespace, effective_argv: Sequence[str]) -> int:
+    config = load_server_config(args.config)
+    LOGGER.info("loaded server config: %s", describe_server_config(config))
+    needs_elevation = args.elevate or (args.auto_elevate and should_elevate_server(config))
+    if needs_elevation and not args.elevation_attempted and not is_admin():
+        LOGGER.info("relaunching with administrator/root privileges")
+        return relaunch_once(effective_argv)
+    return asyncio.run(Server(config).serve_forever())
+
+
+def _run_client_command(args: argparse.Namespace) -> int:
+    config = load_client_config(args.config)
+    LOGGER.info("loaded client config: %s", describe_client_config(config))
+    return asyncio.run(Client(config).run())
+
+
+def _configure_logging(level: str) -> None:
+    logging.basicConfig(
+        level=getattr(logging, level),
+        format="%(asctime)s %(levelname)s %(name)s: %(message)s",
+    )