Metadata-Version: 2.5
Name: lupaxa-zone-transfer
Version: 0.1.0
Summary: Test whether a domain's nameservers allow DNS zone transfer (AXFR).
Project-URL: Homepage, https://zone-transfer.thelupaxaproject.org/
Project-URL: Documentation, https://zone-transfer.thelupaxaproject.org/
Project-URL: Repository, https://github.com/lupaxa-security-toolbox/zone-transfer
Project-URL: Issues, https://github.com/lupaxa-security-toolbox/zone-transfer/issues
Author: The Lupaxa Project
License: MIT License
        
        Copyright (c) The Lupaxa Project
        
        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.
License-File: LICENCE
Keywords: axfr,cli,dns,security,zone-transfer
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.14
Classifier: Topic :: Security
Classifier: Topic :: System :: Networking
Classifier: Topic :: Utilities
Requires-Python: >=3.10
Requires-Dist: colored>=2.2
Requires-Dist: dnspython>=2.6
Requires-Dist: prettytable>=3.10
Provides-Extra: dev
Requires-Dist: bump-my-version>=1.2.0; extra == 'dev'
Requires-Dist: hatch>=1.12.0; extra == 'dev'
Requires-Dist: mkdocs-material==9.7.7; extra == 'dev'
Requires-Dist: mkdocs==1.6.1; extra == 'dev'
Requires-Dist: mypy>=1.12.0; extra == 'dev'
Requires-Dist: pip-audit>=2.7.0; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.0; extra == 'dev'
Requires-Dist: ruff>=0.6.0; extra == 'dev'
Provides-Extra: test
Requires-Dist: pytest-cov>=5.0; extra == 'test'
Requires-Dist: pytest>=8.0; extra == 'test'
Description-Content-Type: text/markdown

<!-- markdownlint-disable -->
<p align="center">
  <a href="https://github.com/lupaxa-security-toolbox">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/organisations/security-toolbox/readme-logo.png" alt="Project Logo" width="256"/><br/>
  </a>
</p>
<h3 align="center">
  The Lupaxa Security Toolbox<br />
  Part of The Lupaxa Project
</h3>

<br />

# lupaxa-zone-transfer

Test whether a domain's nameservers allow DNS zone transfer (AXFR),
and show the zone contents when they do.

> **Warning — authorised use only.** This tool contacts nameservers and
> can expose a full zone. Use it only on systems you are allowed to test.

## Features

- Discover authoritative `NS` records or use repeatable `--nameserver` values
- Sort nameservers by name; for each host, try IPv4 before IPv6
- Resolve every IPv4 and IPv6 address for nameserver hostnames
- Try AXFR against every discovered endpoint
- Report `allowed`, `refused`, and `error` outcomes
- Print transferred records with name, type, TTL, and rdata
- Human-readable table (colour on a TTY; `--no-color` or `NO_COLOR` to disable), or JSON
- Spinner on stderr while nameserver lookup and AXFR run (TTY only)
- Optional `--fail-open` exit status for CI-style security findings
- Library API (`inspect_domain` / `inspect_many`) and CLI (`zone-transfer`)
- Fully typed, linted, formatted, and tested

## Installation

### From PyPI

```bash
pip install lupaxa-zone-transfer
```

### From source (development mode)

```bash
pip install -e ".[dev]"
```

Requires Python 3.10+. Runtime dependencies: `dnspython`, `prettytable`,
and `colored`.

## Library quick start

```python
from lupaxa.zone_transfer import inspect_domain

report = inspect_domain("example.com")
print(report.attempts[0].status)
```

## CLI quick start

```bash
zone-transfer --help
zone-transfer example.com
zone-transfer example.com example.org
zone-transfer example.com --nameserver ns1.example.net --nameserver 203.0.113.10
zone-transfer example.com --format json
zone-transfer example.com --fail-open
zone-transfer example.com --timeout 10 --no-color
```

You can also run the CLI as a module:

```bash
python -m lupaxa.zone_transfer --help
python -m lupaxa.zone_transfer --version
```

## Documentation

Online documentation:

[Documentation](https://zone-transfer.thelupaxaproject.org/)

Source repository:

[GitHub](https://github.com/lupaxa-security-toolbox/zone-transfer)

### Serve docs locally

From a clone of the repository:

```bash
make mkdocs-serve
```

Then open the local URL printed by MkDocs in your browser.

## Development

Clone the repository and install with Make:

```bash
make init                # first-time makefile-skills checkout
make python-install-dev  # editable install with [dev]
make python-check        # lint, type-check, and test
```

<a href="https://github.com/the-lupaxa-project">
    <img src="https://raw.githubusercontent.com/the-lupaxa-project/brand-assets/master/logos/components/footer-for-child-orgs.svg" alt="The Lupaxa Project Footer" width="100%" />
</a>
