socksscope 0.2.0__tar.gz

socksscope-0.2.0/.gitignore

@@ -0,0 +1,220 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#   Usually these files are written by a python script from a template
+#   before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+# Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+# poetry.lock
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#   JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#   be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#   and can be added to the global gitignore or merged into this file.  For a more nuclear
+#   option (not recommended) you can uncomment the following to ignore the entire idea folder.
+# .idea/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+# Temporary file for partial code execution
+tempCodeRunnerFile.py
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+CLAUDE.md
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

socksscope-0.2.0/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to **socksscope** are documented here.
+This project follows [Keep a Changelog](https://keepachangelog.com/) and
+[Semantic Versioning](https://semver.org/).
+
+## [0.2.0] - 2026-09-13
+
+Initial version published on GitHub and PyPI. The 0.1.x series was developed
+internally and never released.
+
+### Added
+
+- **A SOCKS5 front-end in a single file.** Wraps a SOCKS5 proxy that already exists
+  (`-u` / `--upstream`) or connects out on its own (`--local`), and opens its own
+  restricted SOCKS5 port (`-l` / `--listen`, default `127.0.0.1:1081`). Credentials on
+  both ends are optional (`--listen-auth`, `--upstream-auth`).
+- **A ruleset over domain names, addresses and ports.** `--allow` and `--block` are
+  repeatable and read a rule from its shape: `domain.tld`, `*.domain.tld`, `*`, `IP`,
+  `IP/NET`, `IP-IP`, `:PORT` and `:PORT-PORT`, with ranges including both ends. `@FILE`
+  loads a rules file (`#` comments, `!` inverts a rule). Name, address and port are
+  judged separately and all three have to pass. The most specific rule wins (deeper
+  subdomain, smaller subnet) and an exact tie goes to block.
+- **`--test-ruleset HOST[:PORT]`** prints how a target would be judged and exits, without
+  opening a listener, so a scope file can be checked before it is trusted.
+- **`--dns SIDE[:SERVER[:PORT][:tcp|udp]]`** decides which side of the tunnel resolves a
+  domain name and, optionally, which server answers it. `u`/`upstream` and `l`/`local`
+  select the side. Naming a `SERVER` makes socksscope query it itself.
+- **`--hosts`** static mappings that are answered before any DNS happens, as
+  `name=ADDRESS`, `'ADDRESS name [name ...]'` or `@FILE`.
+- **`--resolve-rules`** resolves every domain name rule and applies the addresses as
+  address rules too, so a blocked name also blocks the addresses behind it. Rules are
+  re-resolved every `--resolve-rules-every` seconds (default 300, `0` resolves once).
+  **It fails closed:** a rule that cannot be resolved at startup, or that stays
+  unconfirmable for three intervals, stops the tool. Because this produces repeating
+  queries, socksscope asks before the first ones; `--yes-resolve-rules` answers that prompt.
+- **Connection limits.** `--rate` is one byte/s budget shared by all connections,
+  `--rate-per-conn` gives each connection its own. `--max-conns` caps how many run at
+  once and queues the rest instead of failing them. A waiting client sits in the
+  SOCKS5 handshake until a slot frees up, bounded by `--queue-timeout` (default 60s,
+  `0` waits forever).
+- **Summarising connection logging.** Repeated connections to a host are counted rather
+  than logged, and each host is summarised and reset once it has been quiet for 10s.
+  `-v` logs every connection with more detail, `-q` logs warnings only.
+- **A two-tier help.** `-h` prints a short usage summary, `--help` the full reference.
+- **A pytest suite in `tests/`** (159 test functions)
+- **Packaging.** Installable from PyPI as `socksscope` with a `socksscope` console script.
+  Needs Python 3.10 or newer and has one runtime dependency, `dnspython`.

socksscope-0.2.0/LICENSE

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