| Name | domain-park JSON |
| Version |
0.4.0
JSON |
| download |
| home_page | None |
| Summary | DNS server for parking domains securely |
| upload_time | 2024-10-20 08:36:27 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2020 Nicholas Hairs 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. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Domain Park: Prevent abuse of parked domains
[](https://pypi.python.org/pypi/domain-park/)
[](https://github.com/nhairs/domain-park)
[](https://github.com/nhairs/domain-park/blob/master/LICENCE)
`domain-park` is an open-source DNS Name server that implements best practice `MX`, SPF, DKIM, and DMARC DNS records in order to prevent spoofing of registered but unused domain names (also known as parked domains).
**Features:**
- Implement best practice DNS records for SPF, DKIM, DMARC, MX compliance.
- Handle unlimited domains with little to no configuration.
- Setup receiving of DMARC aggregate reports.
`domain-park` is currently Alpha software and does not have complete documentation, testing, or implementation of certain features.
This page is for the domain-park software, you may be looking for the [domain-park.org](https://www.domain-park.org) public name servers.
## Installation
### Install via pip
```shell
pip3 install --user domain-park
```
## Usage
```
domain-park --help
usage: domain-park [-h] [--version] [--host HOST] [--port PORT]
[--tcp | --udp] -n NAMESERVER [--rua EMAIL] [--ruf EMAIL]
[--ips]
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--host HOST Host (IP) to bind to. Use --ips to see available.
Defaults to localhost.
--port PORT Port to bind to. Defaults to 9953.
--tcp Use TCPv4 socket for transport.
--udp Use UDPv4 socket for transport. (default)
-n NAMESERVER, --nameserver NAMESERVER
Add NameServer to list returned on NS lookups. This
should be equal to the NS records available publicly
running domain-park. Must be supplied at least once,
and has no limit. Reccomended to have 2-4 Name
Servers. Expected to be in the format of either
'FQDN:IP' or 'IP'
--rua EMAIL Email address to use for DMARC aggregate repots.
--ruf EMAIL Email address to use for DMARC forensic reports.
--ips Print available IPs and exit
```
Example:
```shell
domain-park -n ns1.domain-park.org -n ns2.domain-park.org
```
Once running, interact using `dig`:
```shell
dig -p 9953 @localhost NS example.com
dig -p 9953 @localhost TXT example.com
dig -p 9953 @localhost TXT foo.example.com
dig -p 9953 @localhost TXT _dmarc.example.com
dig -p 9953 @localhost TXT asdf._domainkey.example.com
dig -p 9953 @localhost TXT qwer._domainkey.foo.example.com
dig -p 9953 @localhost MX example.com
```
## Production Usage
In order to setup domain-park for use with publicly accessible domains, you will need a static IP address for the server running `domain-park` and a domain which you can set records on.
On your domain you will need to create an `A` for your name server using the static IP address. Once done you will then need to create a [glue record](https://en.wikipedia.org/wiki/Domain_Name_System#Circular_dependencies_and_glue_records) for the previously created `A` record.
## Bugs, Feature Requests etc
TLDR: Please [submit an issue on github](https://github.com/nhairs/domain-park/issues).
In the case of bug reports, please help me help you by following best practices [[1](https://marker.io/blog/write-bug-report/)] [[2](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)].
In the case of feature requests, please provide background to the problem you are trying to solve so to help find a solution that makes the most sense for the library as well as your usecase.
## Development
The only development dependency is bash and docker. All actions are run within docker for ease of use. See `./dev.sh help` for commands. Typical commands are `format`, `lint`, `test`, `repl`, `build`.
I am still working through open source licencing and contributing, so not taking PRs at this point in time. Instead raise and issue and I'll try get to it as soon a feasible.
## Licence
This project is licenced under the MIT Licence - see [`LICENCE`](https://github.com/nahirs/domain-park/blob/master/LICENCE).
This project includes other open source licenced software - see [`NOTICE`](https://github.com/nhairs/domain-park/blob/master/NOTICE).
## Authors
A project by Nicholas Hairs - [www.nicholashairs.com](https://www.nicholashairs.com).
Raw data
{
"_id": null,
"home_page": null,
"name": "domain-park",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Nicholas Hairs <info+domain-park@nicholashairs.com>",
"download_url": null,
"platform": null,
"description": "# Domain Park: Prevent abuse of parked domains\n\n[](https://pypi.python.org/pypi/domain-park/)\n[](https://github.com/nhairs/domain-park)\n[](https://github.com/nhairs/domain-park/blob/master/LICENCE)\n\n`domain-park` is an open-source DNS Name server that implements best practice `MX`, SPF, DKIM, and DMARC DNS records in order to prevent spoofing of registered but unused domain names (also known as parked domains).\n\n**Features:**\n- Implement best practice DNS records for SPF, DKIM, DMARC, MX compliance.\n- Handle unlimited domains with little to no configuration.\n- Setup receiving of DMARC aggregate reports.\n\n`domain-park` is currently Alpha software and does not have complete documentation, testing, or implementation of certain features.\n\nThis page is for the domain-park software, you may be looking for the [domain-park.org](https://www.domain-park.org) public name servers.\n\n## Installation\n### Install via pip\n```shell\npip3 install --user domain-park\n```\n\n## Usage\n```\ndomain-park --help\nusage: domain-park [-h] [--version] [--host HOST] [--port PORT]\n [--tcp | --udp] -n NAMESERVER [--rua EMAIL] [--ruf EMAIL]\n [--ips]\n\noptional arguments:\n -h, --help show this help message and exit\n --version show program's version number and exit\n --host HOST Host (IP) to bind to. Use --ips to see available.\n Defaults to localhost.\n --port PORT Port to bind to. Defaults to 9953.\n --tcp Use TCPv4 socket for transport.\n --udp Use UDPv4 socket for transport. (default)\n -n NAMESERVER, --nameserver NAMESERVER\n Add NameServer to list returned on NS lookups. This\n should be equal to the NS records available publicly\n running domain-park. Must be supplied at least once,\n and has no limit. Reccomended to have 2-4 Name\n Servers. Expected to be in the format of either\n 'FQDN:IP' or 'IP'\n --rua EMAIL Email address to use for DMARC aggregate repots.\n --ruf EMAIL Email address to use for DMARC forensic reports.\n --ips Print available IPs and exit\n```\n\nExample:\n```shell\ndomain-park -n ns1.domain-park.org -n ns2.domain-park.org\n```\n\nOnce running, interact using `dig`:\n\n```shell\ndig -p 9953 @localhost NS example.com\n\ndig -p 9953 @localhost TXT example.com\ndig -p 9953 @localhost TXT foo.example.com\n\ndig -p 9953 @localhost TXT _dmarc.example.com\n\ndig -p 9953 @localhost TXT asdf._domainkey.example.com\ndig -p 9953 @localhost TXT qwer._domainkey.foo.example.com\n\ndig -p 9953 @localhost MX example.com\n```\n\n## Production Usage\nIn order to setup domain-park for use with publicly accessible domains, you will need a static IP address for the server running `domain-park` and a domain which you can set records on.\n\nOn your domain you will need to create an `A` for your name server using the static IP address. Once done you will then need to create a [glue record](https://en.wikipedia.org/wiki/Domain_Name_System#Circular_dependencies_and_glue_records) for the previously created `A` record.\n\n\n## Bugs, Feature Requests etc\nTLDR: Please [submit an issue on github](https://github.com/nhairs/domain-park/issues).\n\nIn the case of bug reports, please help me help you by following best practices [[1](https://marker.io/blog/write-bug-report/)] [[2](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html)].\n\nIn the case of feature requests, please provide background to the problem you are trying to solve so to help find a solution that makes the most sense for the library as well as your usecase.\n\n## Development\nThe only development dependency is bash and docker. All actions are run within docker for ease of use. See `./dev.sh help` for commands. Typical commands are `format`, `lint`, `test`, `repl`, `build`.\n\nI am still working through open source licencing and contributing, so not taking PRs at this point in time. Instead raise and issue and I'll try get to it as soon a feasible.\n\n## Licence\nThis project is licenced under the MIT Licence - see [`LICENCE`](https://github.com/nahirs/domain-park/blob/master/LICENCE).\n\nThis project includes other open source licenced software - see [`NOTICE`](https://github.com/nhairs/domain-park/blob/master/NOTICE).\n\n## Authors\nA project by Nicholas Hairs - [www.nicholashairs.com](https://www.nicholashairs.com).\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 Nicholas Hairs 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. ",
"summary": "DNS server for parking domains securely",
"version": "0.4.0",
"project_urls": {
"homepage": "https://github.com/nhairs/domain-park"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2c1247f599ca65ec8372735f270a5b14ed042a4a8bc2926d0c9894697587d1da",
"md5": "5a6944c452f30aea55400bdd0ba8f09c",
"sha256": "52354ac48ac4e737bf636fa55780328f56ae9992f391f24fc3de06269a68569e"
},
"downloads": -1,
"filename": "domain_park-0.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5a6944c452f30aea55400bdd0ba8f09c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 9471,
"upload_time": "2024-10-20T08:36:27",
"upload_time_iso_8601": "2024-10-20T08:36:27.652165Z",
"url": "https://files.pythonhosted.org/packages/2c/12/47f599ca65ec8372735f270a5b14ed042a4a8bc2926d0c9894697587d1da/domain_park-0.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-20 08:36:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "nhairs",
"github_project": "domain-park",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "domain-park"
}
