From 756c491e2895157746223be74c89868605e0bac4 Mon Sep 17 00:00:00 2001 From: Sven Luthi Date: Thu, 12 Mar 2026 10:58:31 +0100 Subject: [PATCH] Renaming Project and changing license --- .gitignore | 2 +- CHANGELOG.md | 6 + LICENSE.md | 349 +----------------- README.md | 94 +++-- docs/architecture-overview.drawio | 81 ++++ docs/architecture-overview.svg | 4 + .../__init__.py | 18 +- .../commands/dns-transfer-endpoint.py | 8 +- .../commands/export-all-dns-zones.py | 2 +- .../management/commands/export-dns-zone.py | 2 +- .../models.py | 0 .../service/endpoint}/__init__.py | 0 .../service/endpoint/catalog_zone_manager.py | 2 +- .../service/endpoint/dns_server.py | 0 .../service/endpoint/request_handler.py | 0 .../signals.py | 0 .../utils.py | 0 pyproject.toml | 10 +- .../migrations/0001_initial.py | 51 --- ...integerkeyvaluesetting_options_and_more.py | 33 -- .../0003_catalogzonememberidentifier.py | 26 -- ..._alter_catalogzonememberidentifier_zone.py | 20 - ..._alter_catalogzonememberidentifier_zone.py | 20 - .../service/endpoint/__init__.py | 0 24 files changed, 173 insertions(+), 555 deletions(-) create mode 100644 docs/architecture-overview.drawio create mode 100644 docs/architecture-overview.svg rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/__init__.py (65%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/management/commands/dns-transfer-endpoint.py (91%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/management/commands/export-all-dns-zones.py (95%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/management/commands/export-dns-zone.py (95%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/models.py (100%) rename {src/netbox_plugin_bind_provisioner/migrations => netbox_dns_bridge/service/endpoint}/__init__.py (100%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/service/endpoint/catalog_zone_manager.py (98%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/service/endpoint/dns_server.py (100%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/service/endpoint/request_handler.py (100%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/signals.py (100%) rename {src/netbox_plugin_bind_provisioner => netbox_dns_bridge}/utils.py (100%) delete mode 100644 src/netbox_plugin_bind_provisioner/migrations/0001_initial.py delete mode 100644 src/netbox_plugin_bind_provisioner/migrations/0002_alter_integerkeyvaluesetting_options_and_more.py delete mode 100644 src/netbox_plugin_bind_provisioner/migrations/0003_catalogzonememberidentifier.py delete mode 100644 src/netbox_plugin_bind_provisioner/migrations/0004_alter_catalogzonememberidentifier_zone.py delete mode 100644 src/netbox_plugin_bind_provisioner/migrations/0005_alter_catalogzonememberidentifier_zone.py delete mode 100644 src/netbox_plugin_bind_provisioner/service/endpoint/__init__.py diff --git a/.gitignore b/.gitignore index e64d473..eb75794 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -src/netbox_plugin_bind_provisioner.egg-info +netbox_dns_bridge.egg-info dist/ build/ __pycache__ diff --git a/CHANGELOG.md b/CHANGELOG.md index e5f2f90..7fbe7ed 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,2 +1,8 @@ ## 1.0.7 - 2026-03-02 README Change - Moving private keys to global scope since Bind 9.20 view scoped keys have become unreliable and sometimes wouldnt match. + +## 1.0.8 - 2026-03-12 +- Change License to MIT to match the netbox-plugin-dns License. This project rests on the netbox-plugin-dns so a matching + license makes more sense. +- Renaming Project from Netbox Plugin Bind Provisioner to Netbox DNS Bridge as new code will be contributed that allows + data to flow in both directions (Dynamic Updates), not just out of Netbox DNS. diff --git a/LICENSE.md b/LICENSE.md index d159169..e792965 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,339 +1,18 @@ - GNU GENERAL PUBLIC LICENSE - Version 2, June 1991 +MIT License - Copyright (C) 1989, 1991 Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. +Copyright (c) 2025-2026 Sven Luethi - Preamble +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 licenses for most software are designed to take away your -freedom to share and change it. By contrast, the GNU General Public -License is intended to guarantee your freedom to share and change free -software--to make sure the software is free for all its users. This -General Public License applies to most of the Free Software -Foundation's software and to any other program whose authors commit to -using it. (Some other Free Software Foundation software is covered by -the GNU Lesser General Public License instead.) You can apply it to -your programs, too. +The above copyright notice and this permission notice shall be included in all copies or substantial +portions of the Software. - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -this service if you wish), that you receive source code or can get it -if you want it, that you can change the software or use pieces of it -in new free programs; and that you know you can do these things. - - To protect your rights, we need to make restrictions that forbid -anyone to deny you these rights or to ask you to surrender the rights. -These restrictions translate to certain responsibilities for you if you -distribute copies of the software, or if you modify it. - - For example, if you distribute copies of such a program, whether -gratis or for a fee, you must give the recipients all the rights that -you have. You must make sure that they, too, receive or can get the -source code. And you must show them these terms so they know their -rights. - - We protect your rights with two steps: (1) copyright the software, and -(2) offer you this license which gives you legal permission to copy, -distribute and/or modify the software. - - Also, for each author's protection and ours, we want to make certain -that everyone understands that there is no warranty for this free -software. If the software is modified by someone else and passed on, we -want its recipients to know that what they have is not the original, so -that any problems introduced by others will not reflect on the original -authors' reputations. - - Finally, any free program is threatened constantly by software -patents. We wish to avoid the danger that redistributors of a free -program will individually obtain patent licenses, in effect making the -program proprietary. To prevent this, we have made it clear that any -patent must be licensed for everyone's free use or not licensed at all. - - The precise terms and conditions for copying, distribution and -modification follow. - - GNU GENERAL PUBLIC LICENSE - TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - - 0. This License applies to any program or other work which contains -a notice placed by the copyright holder saying it may be distributed -under the terms of this General Public License. The "Program", below, -refers to any such program or work, and a "work based on the Program" -means either the Program or any derivative work under copyright law: -that is to say, a work containing the Program or a portion of it, -either verbatim or with modifications and/or translated into another -language. (Hereinafter, translation is included without limitation in -the term "modification".) Each licensee is addressed as "you". - -Activities other than copying, distribution and modification are not -covered by this License; they are outside its scope. The act of -running the Program is not restricted, and the output from the Program -is covered only if its contents constitute a work based on the -Program (independent of having been made by running the Program). -Whether that is true depends on what the Program does. - - 1. You may copy and distribute verbatim copies of the Program's -source code as you receive it, in any medium, provided that you -conspicuously and appropriately publish on each copy an appropriate -copyright notice and disclaimer of warranty; keep intact all the -notices that refer to this License and to the absence of any warranty; -and give any other recipients of the Program a copy of this License -along with the Program. - -You may charge a fee for the physical act of transferring a copy, and -you may at your option offer warranty protection in exchange for a fee. - - 2. You may modify your copy or copies of the Program or any portion -of it, thus forming a work based on the Program, and copy and -distribute such modifications or work under the terms of Section 1 -above, provided that you also meet all of these conditions: - - a) You must cause the modified files to carry prominent notices - stating that you changed the files and the date of any change. - - b) You must cause any work that you distribute or publish, that in - whole or in part contains or is derived from the Program or any - part thereof, to be licensed as a whole at no charge to all third - parties under the terms of this License. - - c) If the modified program normally reads commands interactively - when run, you must cause it, when started running for such - interactive use in the most ordinary way, to print or display an - announcement including an appropriate copyright notice and a - notice that there is no warranty (or else, saying that you provide - a warranty) and that users may redistribute the program under - these conditions, and telling the user how to view a copy of this - License. (Exception: if the Program itself is interactive but - does not normally print such an announcement, your work based on - the Program is not required to print an announcement.) - -These requirements apply to the modified work as a whole. If -identifiable sections of that work are not derived from the Program, -and can be reasonably considered independent and separate works in -themselves, then this License, and its terms, do not apply to those -sections when you distribute them as separate works. But when you -distribute the same sections as part of a whole which is a work based -on the Program, the distribution of the whole must be on the terms of -this License, whose permissions for other licensees extend to the -entire whole, and thus to each and every part regardless of who wrote it. - -Thus, it is not the intent of this section to claim rights or contest -your rights to work written entirely by you; rather, the intent is to -exercise the right to control the distribution of derivative or -collective works based on the Program. - -In addition, mere aggregation of another work not based on the Program -with the Program (or with a work based on the Program) on a volume of -a storage or distribution medium does not bring the other work under -the scope of this License. - - 3. You may copy and distribute the Program (or a work based on it, -under Section 2) in object code or executable form under the terms of -Sections 1 and 2 above provided that you also do one of the following: - - a) Accompany it with the complete corresponding machine-readable - source code, which must be distributed under the terms of Sections - 1 and 2 above on a medium customarily used for software interchange; or, - - b) Accompany it with a written offer, valid for at least three - years, to give any third party, for a charge no more than your - cost of physically performing source distribution, a complete - machine-readable copy of the corresponding source code, to be - distributed under the terms of Sections 1 and 2 above on a medium - customarily used for software interchange; or, - - c) Accompany it with the information you received as to the offer - to distribute corresponding source code. (This alternative is - allowed only for noncommercial distribution and only if you - received the program in object code or executable form with such - an offer, in accord with Subsection b above.) - -The source code for a work means the preferred form of the work for -making modifications to it. For an executable work, complete source -code means all the source code for all modules it contains, plus any -associated interface definition files, plus the scripts used to -control compilation and installation of the executable. However, as a -special exception, the source code distributed need not include -anything that is normally distributed (in either source or binary -form) with the major components (compiler, kernel, and so on) of the -operating system on which the executable runs, unless that component -itself accompanies the executable. - -If distribution of executable or object code is made by offering -access to copy from a designated place, then offering equivalent -access to copy the source code from the same place counts as -distribution of the source code, even though third parties are not -compelled to copy the source along with the object code. - - 4. You may not copy, modify, sublicense, or distribute the Program -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense or distribute the Program is -void, and will automatically terminate your rights under this License. -However, parties who have received copies, or rights, from you under -this License will not have their licenses terminated so long as such -parties remain in full compliance. - - 5. You are not required to accept this License, since you have not -signed it. However, nothing else grants you permission to modify or -distribute the Program or its derivative works. These actions are -prohibited by law if you do not accept this License. Therefore, by -modifying or distributing the Program (or any work based on the -Program), you indicate your acceptance of this License to do so, and -all its terms and conditions for copying, distributing or modifying -the Program or works based on it. - - 6. Each time you redistribute the Program (or any work based on the -Program), the recipient automatically receives a license from the -original licensor to copy, distribute or modify the Program subject to -these terms and conditions. You may not impose any further -restrictions on the recipients' exercise of the rights granted herein. -You are not responsible for enforcing compliance by third parties to -this License. - - 7. If, as a consequence of a court judgment or allegation of patent -infringement or for any other reason (not limited to patent issues), -conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot -distribute so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you -may not distribute the Program at all. For example, if a patent -license would not permit royalty-free redistribution of the Program by -all those who receive copies directly or indirectly through you, then -the only way you could satisfy both it and this License would be to -refrain entirely from distribution of the Program. - -If any portion of this section is held invalid or unenforceable under -any particular circumstance, the balance of the section is intended to -apply and the section as a whole is intended to apply in other -circumstances. - -It is not the purpose of this section to induce you to infringe any -patents or other property right claims or to contest validity of any -such claims; this section has the sole purpose of protecting the -integrity of the free software distribution system, which is -implemented by public license practices. Many people have made -generous contributions to the wide range of software distributed -through that system in reliance on consistent application of that -system; it is up to the author/donor to decide if he or she is willing -to distribute software through any other system and a licensee cannot -impose that choice. - -This section is intended to make thoroughly clear what is believed to -be a consequence of the rest of this License. - - 8. If the distribution and/or use of the Program is restricted in -certain countries either by patents or by copyrighted interfaces, the -original copyright holder who places the Program under this License -may add an explicit geographical distribution limitation excluding -those countries, so that distribution is permitted only in or among -countries not thus excluded. In such case, this License incorporates -the limitation as if written in the body of this License. - - 9. The Free Software Foundation may publish revised and/or new versions -of the 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 Program -specifies a version number of this License which applies to it and "any -later version", you have the option of following the terms and conditions -either of that version or of any later version published by the Free -Software Foundation. If the Program does not specify a version number of -this License, you may choose any version ever published by the Free Software -Foundation. - - 10. If you wish to incorporate parts of the Program into other free -programs whose distribution conditions are different, write to the author -to ask for permission. For software which is copyrighted by the Free -Software Foundation, write to the Free Software Foundation; we sometimes -make exceptions for this. Our decision will be guided by the two goals -of preserving the free status of all derivatives of our free software and -of promoting the sharing and reuse of software generally. - - NO WARRANTY - - 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED -OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF -MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS -TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE -PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, -REPAIR OR CORRECTION. - - 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, -INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING -OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED -TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY -YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER -PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE -POSSIBILITY OF SUCH DAMAGES. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -convey the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software; you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation; either version 2 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. - - You should have received a copy of the GNU General Public License along - with this program; if not, write to the Free Software Foundation, Inc., - 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. - -Also add information on how to contact you by electronic and paper mail. - -If the program is interactive, make it output a short notice like this -when it starts in an interactive mode: - - Gnomovision version 69, Copyright (C) year name of author - Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. - This is free software, and you are welcome to redistribute it - under certain conditions; type `show c' for details. - -The hypothetical commands `show w' and `show c' should show the appropriate -parts of the General Public License. Of course, the commands you use may -be called something other than `show w' and `show c'; they could even be -mouse-clicks or menu items--whatever suits your program. - -You should also get your employer (if you work as a programmer) or your -school, if any, to sign a "copyright disclaimer" for the program, if -necessary. Here is a sample; alter the names: - - Yoyodyne, Inc., hereby disclaims all copyright interest in the program - `Gnomovision' (which makes passes at compilers) written by James Hacker. - - , 1 April 1989 - Ty Coon, President of Vice - -This General Public License does not permit incorporating your program into -proprietary programs. If your program is a subroutine library, you may -consider it more useful to permit linking proprietary applications with the -library. If this is what you want to do, use the GNU Lesser General -Public License instead of this License. +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. diff --git a/README.md b/README.md index 0213ef2..00f15e5 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,44 @@ -# Netbox Bind Provisioner -The Netbox Bind Provisioner plugin implements a lightweight DNS server inside -Netbox and builds a bridge for BIND and other DNS Servers implementing RFC9432 -to retrieve DNS Zones directly from Netbox using DNS native mechanisms. +# Netbox DNS Bridge (Formerly Netbox Bind Provisioner) +The Netbox DNS Bridge plugin implements a lightweight DNS server inside Netbox and builds a bridge +for BIND and other DNS Servers implementing RFC9432 to retrieve DNS Zones directly from Netbox +using DNS native mechanisms. -[![PyPi](https://img.shields.io/pypi/v/netbox-plugin-bind-provisioner)](https://pypi.org/project/netbox-plugin-bind-provisioner/) -[![Stars Badge](https://img.shields.io/github/stars/suraxius/netbox-plugin-bind-provisioner?style=flat)](https://github.com/suraxius/netbox-plugin-bind-provisioner/stargazers) -[![Forks Badge](https://img.shields.io/github/forks/suraxius/netbox-plugin-bind-provisioner?style=flat)](https://github.com/suraxius/netbox-plugin-bind-provisioner/network/members) -[![Issues Badge](https://img.shields.io/github/issues/suraxius/netbox-plugin-bind-provisioner)](https://github.com/suraxius/netbox-plugin-bind-provisioner/issues) -[![Pull Requests Badge](https://img.shields.io/github/issues-pr/suraxius/netbox-plugin-bind-provisioner)](https://github.com/suraxius/netbox-plugin-bind-provisioner/pulls) -[![GitHub contributors](https://img.shields.io/github/contributors/suraxius/netbox-plugin-bind-provisioner?color=2b9348)](https://github.com/suraxius/netbox-plugin-bind-provisioner/graphs/contributors) -[![License Badge](https://img.shields.io/github/license/suraxius/netbox-plugin-bind-provisioner?color=2b9348)](https://github.com/suraxius/netbox-plugin-bind-provisioner/blob/master/LICENSE) -[![Code Style Black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) -[![Downloads](https://static.pepy.tech/personalized-badge/netbox-plugin-bind-provisioner?period=total&left_color=BLACK&right_color=BLUE&left_text=Downloads)](https://pepy.tech/project/netbox-plugin-bind-provisioner) -[![Downloads/Week](https://static.pepy.tech/personalized-badge/netbox-plugin-bind-provisioner?period=monthly&left_color=BLACK&right_color=BLUE&left_text=Downloads%2fMonth)](https://pepy.tech/project/netbox-plugin-bind-provisioner) -[![Downloads/Month](https://static.pepy.tech/personalized-badge/netbox-plugin-bind-provisioner?period=weekly&left_color=BLACK&right_color=BLUE&left_text=Downloads%2fWeek)](https://pepy.tech/project/netbox-plugin-bind-provisioner) +PyPi +Stars Badge +Forks Badge +Issues Badge +Pull Requests Badge +GitHub contributors +License Badge +Code Style Black +Downloads +Downloads/Week +Downloads/Month + + + +![Architecture Overview](docs/architecture-overview.svg) ## Plugin configuration -While providing Zone transfers via AXFR, the Server also exposes specialized -catalog zones that BIND and other RFC9432 compliant DNS Servers use to -automatically discover newly created zones and remove deleted ones. The plugin -supports views and basic DNS security via TSIG. +While providing Zone transfers via AXFR, the Server also exposes specialized catalog zones that BIND +and other RFC9432 compliant DNS Servers use to automatically discover newly created zones and remove +deleted ones. The plugin supports views and basic DNS security via TSIG. -The plugin exposes one catalog zone per view. Each catalog zone is made available -under the special zone name **"catz"** and addtionally under **"[viewname].catz"** -and may be queried through the built-in DNS server just like any other dns zone. +The plugin exposes one catalog zone per view. Each catalog zone is made available under the special +zone name **"catz"** and addtionally under **"[viewname].catz"** and may be queried through the +built-in DNS server just like any other dns zone. -For proper operation, each view requires an installed TSIG key, and the -`dns-transfer-endpoint` must be running as a separate background service using -the `manage.py` command. Note that DNSSEC support will be added once BIND9 -provides a mechanism to configure it through the Catalog Zones system. +For proper operation, each view requires an installed TSIG key, and the `dns-transfer-endpoint` must +be running as a separate background service using the `manage.py` command. Note that DNSSEC support +will be added once BIND9 provides a mechanism to configure it through the Catalog Zones system. To start the service in the foreground: ``` manage.py dns-transfer-endpoint --port 5354 ``` -This process needs to be scheduled as a background service for the built-in DNS -Server to work correctly. For Linux users with Systemd (Ubuntu, etc), Matt Kollross -provides a startup unit and instructions [here](docs/install-systemd-service.md). +This process needs to be scheduled as a background service for the built-in DNS Server to work +correctly. For Linux users with Systemd (Ubuntu, etc), Matt Kollross provides a startup unit and +instructions [here](docs/install-systemd-service.md). ### Service parameters Parameter | Description @@ -55,10 +57,9 @@ Netbox | Netbox DNS | DNS Provisioner 4.5.0 | 1.5.0 | 1.0.7 ## Installation guide -This setup provisions a BIND9 server directly with DNS data from NetBox. -BIND9 can optionally run on a separate server. If so, any reference to -127.0.0.1 in step 6 must be replaced with the IP address of the NetBox host. -TCP and UDP traffic from the BIND9 server to the NetBox host must be allowed on +This setup provisions a BIND9 server directly with DNS data from NetBox. BIND9 can optionally run on +a separate server. If so, any reference to 127.0.0.1 in step 6 must be replaced with the IP address +of the NetBox host. TCP and UDP traffic from the BIND9 server to the NetBox host must be allowed on port 5354 (or the port you have configured). This guide assumes: @@ -88,10 +89,10 @@ This guide assumes: ``` to ``` - PLUGINS = ['netbox_dns', 'netbox_plugin_bind_provisioner'] + PLUGINS = ['netbox_dns', 'netbox_dns_bridge'] ``` - Configure the Bind Exporter Plugin using the PLUGINS_CONFIG dictionary. + Configure the DNS Bridge Plugin using the PLUGINS_CONFIG dictionary. Change ``` PLUGINS_CONFIG = {} @@ -99,7 +100,7 @@ This guide assumes: to ``` PLUGINS_CONFIG = { - "netbox_plugin_bind_provisioner": { + "netbox_dns_bridge": { "tsig_keys": { "public": { "keyname": "public_view_key", @@ -118,7 +119,7 @@ This guide assumes: Note that the tsig-key attributes keyname, algorithm and secret form a dictionary in following python structure path: ``` - PLUGINS_CONFIG.netbox_plugin_bind_provisioner.tsig_keys. + PLUGINS_CONFIG.netbox_dns_bridge.tsig_keys. ``` This allows the plugin to map requests to the right dns view using the tsig signature from each request. @@ -130,22 +131,19 @@ This guide assumes: 5. Start listener - This step runs the DNS endpoint used by bind to configure itself. You may want - to write a service wrapper that runs this in the background. - A guide for setting up a systemd service on Ubuntu is provided by Matt - Kollross [here](docs/install-systemd-service.md). Dont forget to activate - the venv if you do decide to run this service in the background. + This step runs the DNS endpoint used by bind to configure itself. You may want to write a + service wrapper that runs this in the background. A guide for setting up a systemd service on + Ubuntu is provided by Matt Kollross [here](docs/install-systemd-service.md). Dont forget to + activate the venv if you do decide to run this service in the background. - Note that `--port 5354` is optional. The listener will bind this port - by default. + Note that `--port 5354` is optional. The listener will bind this port by default. ``` python3 netbox/manage.py dns-transfer-endpoint --port 5354 ``` -6. Configuring a Bind9 to interact with Netbox via the dns-transfer-endpoint - endpoint. Note that its not possible to give all the correct details of the - `options` block as it is heavily dependent on the Operating System used. - Please dont forget to adjust as required. +6. Configuring a Bind9 to interact with Netbox via the dns-transfer-endpoint endpoint. Note that its + not possible to give all the correct details of the `options` block as it is heavily dependent + on the Operating System used. Please dont forget to adjust as required. ``` ########## OPTIONS ########## diff --git a/docs/architecture-overview.drawio b/docs/architecture-overview.drawio new file mode 100644 index 0000000..8ccc3ba --- /dev/null +++ b/docs/architecture-overview.drawio @@ -0,0 +1,81 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/architecture-overview.svg b/docs/architecture-overview.svg new file mode 100644 index 0000000..32abc8d --- /dev/null +++ b/docs/architecture-overview.svg @@ -0,0 +1,4 @@ + + + +
Netbox
DNS
IPAM
DHCP
Transfer
Endpoint
Dynamic Update
Endpoint
DNS Bridge
AXFR
DNS Server
Update
RFC2136 Client
 \ No newline at end of file diff --git a/src/netbox_plugin_bind_provisioner/__init__.py b/netbox_dns_bridge/__init__.py similarity index 65% rename from src/netbox_plugin_bind_provisioner/__init__.py rename to netbox_dns_bridge/__init__.py index 6c6f303..e14625e 100644 --- a/src/netbox_plugin_bind_provisioner/__init__.py +++ b/netbox_dns_bridge/__init__.py @@ -2,7 +2,7 @@ import logging from netbox.plugins import PluginConfig from django.conf import settings -__version__ = "1.0.7" +__version__ = "1.0.8" logger = logging.getLogger(__name__) @@ -13,14 +13,14 @@ logging.basicConfig( ) -class BindProvisionerConfig(PluginConfig): - name = "netbox_plugin_bind_provisioner" - verbose_name = "Netbox Bind Provisioner" - description = "Provisions Zones to a Bind Server configured as hidden master" +class DNSBridgeConfig(PluginConfig): + name = "netbox_dns_bridge" + verbose_name = "Netbox DNS Bridge" + description = "" version = __version__ author = "Sven Luethi" - author_email = "sven.luethi@everyware.ch" - base_url = "bind_provisioner" + author_email = "dev@sven.luethi.co" + base_url = "dns-bridge" def ready(self): self.settings = settings.PLUGINS_CONFIG.get(self.name, None) @@ -32,5 +32,5 @@ class BindProvisionerConfig(PluginConfig): from . import signals as signals -config = BindProvisionerConfig -default_app_config = ".apps.NetboxBindProvisionerConfig" +config = DNSBridgeConfig +default_app_config = ".apps.NetboxDNSBridgeConfig" diff --git a/src/netbox_plugin_bind_provisioner/management/commands/dns-transfer-endpoint.py b/netbox_dns_bridge/management/commands/dns-transfer-endpoint.py similarity index 91% rename from src/netbox_plugin_bind_provisioner/management/commands/dns-transfer-endpoint.py rename to netbox_dns_bridge/management/commands/dns-transfer-endpoint.py index 03f9be0..a50382f 100644 --- a/src/netbox_plugin_bind_provisioner/management/commands/dns-transfer-endpoint.py +++ b/netbox_dns_bridge/management/commands/dns-transfer-endpoint.py @@ -14,9 +14,9 @@ import dns.renderer from django.core.management.base import BaseCommand from django.conf import settings from netbox_dns.models import View -from netbox_plugin_bind_provisioner.service.endpoint.request_handler import UDPRequestHandler, TCPRequestHandler -from netbox_plugin_bind_provisioner.service.endpoint.dns_server import UDPDNSServer, TCPDNSServer -from netbox_plugin_bind_provisioner.service.endpoint import catalog_zone_manager as catzm +from netbox_dns_bridge.service.endpoint.request_handler import UDPRequestHandler, TCPRequestHandler +from netbox_dns_bridge.service.endpoint.dns_server import UDPDNSServer, TCPDNSServer +from netbox_dns_bridge.service.endpoint import catalog_zone_manager as catzm logger = logging.getLogger("dns-transfer-endpoint") @@ -25,7 +25,7 @@ class Command(BaseCommand): def load_settings(self): self.settings = settings.PLUGINS_CONFIG.get( - "netbox_plugin_bind_provisioner", None + "netbox_dns_bridge", None ) if not self.settings: raise RuntimeError( diff --git a/src/netbox_plugin_bind_provisioner/management/commands/export-all-dns-zones.py b/netbox_dns_bridge/management/commands/export-all-dns-zones.py similarity index 95% rename from src/netbox_plugin_bind_provisioner/management/commands/export-all-dns-zones.py rename to netbox_dns_bridge/management/commands/export-all-dns-zones.py index b97250a..2bd1705 100644 --- a/src/netbox_plugin_bind_provisioner/management/commands/export-all-dns-zones.py +++ b/netbox_dns_bridge/management/commands/export-all-dns-zones.py @@ -4,7 +4,7 @@ import dns.rdatatype import dns.rdataclass import dns.exception import netbox_dns.models -from netbox_plugin_bind_provisioner.utils import export_bind_zone_file +from netbox_dns_bridge.utils import export_bind_zone_file from django.core.management.base import BaseCommand, CommandError class Command(BaseCommand): diff --git a/src/netbox_plugin_bind_provisioner/management/commands/export-dns-zone.py b/netbox_dns_bridge/management/commands/export-dns-zone.py similarity index 95% rename from src/netbox_plugin_bind_provisioner/management/commands/export-dns-zone.py rename to netbox_dns_bridge/management/commands/export-dns-zone.py index 72a4944..4d6b8a4 100644 --- a/src/netbox_plugin_bind_provisioner/management/commands/export-dns-zone.py +++ b/netbox_dns_bridge/management/commands/export-dns-zone.py @@ -4,7 +4,7 @@ import dns.rdatatype import dns.rdataclass import dns.exception import netbox_dns.models -from netbox_plugin_bind_provisioner.utils import export_bind_zone_file +from netbox_dns_bridge.utils import export_bind_zone_file from django.core.management.base import BaseCommand, CommandError class Command(BaseCommand): diff --git a/src/netbox_plugin_bind_provisioner/models.py b/netbox_dns_bridge/models.py similarity index 100% rename from src/netbox_plugin_bind_provisioner/models.py rename to netbox_dns_bridge/models.py diff --git a/src/netbox_plugin_bind_provisioner/migrations/__init__.py b/netbox_dns_bridge/service/endpoint/__init__.py similarity index 100% rename from src/netbox_plugin_bind_provisioner/migrations/__init__.py rename to netbox_dns_bridge/service/endpoint/__init__.py diff --git a/src/netbox_plugin_bind_provisioner/service/endpoint/catalog_zone_manager.py b/netbox_dns_bridge/service/endpoint/catalog_zone_manager.py similarity index 98% rename from src/netbox_plugin_bind_provisioner/service/endpoint/catalog_zone_manager.py rename to netbox_dns_bridge/service/endpoint/catalog_zone_manager.py index d37c2b9..58330f6 100644 --- a/src/netbox_plugin_bind_provisioner/service/endpoint/catalog_zone_manager.py +++ b/netbox_dns_bridge/service/endpoint/catalog_zone_manager.py @@ -12,7 +12,7 @@ import dns.exception import dns.renderer from netbox_dns.models import Zone from netbox_dns.choices import ZoneStatusChoices -from netbox_plugin_bind_provisioner.models import IntegerKeyValueSetting, CatalogZoneMemberIdentifier +from netbox_dns_bridge.models import IntegerKeyValueSetting, CatalogZoneMemberIdentifier from uuid import uuid4 from base64 import b32encode diff --git a/src/netbox_plugin_bind_provisioner/service/endpoint/dns_server.py b/netbox_dns_bridge/service/endpoint/dns_server.py similarity index 100% rename from src/netbox_plugin_bind_provisioner/service/endpoint/dns_server.py rename to netbox_dns_bridge/service/endpoint/dns_server.py diff --git a/src/netbox_plugin_bind_provisioner/service/endpoint/request_handler.py b/netbox_dns_bridge/service/endpoint/request_handler.py similarity index 100% rename from src/netbox_plugin_bind_provisioner/service/endpoint/request_handler.py rename to netbox_dns_bridge/service/endpoint/request_handler.py diff --git a/src/netbox_plugin_bind_provisioner/signals.py b/netbox_dns_bridge/signals.py similarity index 100% rename from src/netbox_plugin_bind_provisioner/signals.py rename to netbox_dns_bridge/signals.py diff --git a/src/netbox_plugin_bind_provisioner/utils.py b/netbox_dns_bridge/utils.py similarity index 100% rename from src/netbox_plugin_bind_provisioner/utils.py rename to netbox_dns_bridge/utils.py diff --git a/pyproject.toml b/pyproject.toml index c096d78..6764a5a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,9 +3,9 @@ requires = ["setuptools>=61", "wheel"] build-backend = "setuptools.build_meta" [project] -name = "netbox-plugin-bind-provisioner" +name = "netbox-plugin-dns-bridge" dynamic = ["version"] -description = "A Bind provisioning plugin that uses netbox_dns for its data source" +description = "A bridge between netbox-plugin-dns and your DNS infrastructure." authors = [ { name = "Sven Luethi" }, ] @@ -20,13 +20,13 @@ dependencies = [ [tool.setuptools] include-package-data = true zip-safe = false -package-dir = { "" = "src" } +package-dir = { "" = "netbox_dns_bridge" } [tool.setuptools.packages.find] -where = ["src"] +where = ["netbox_dns_bridge"] [tool.setuptools.dynamic] -version = { attr = "netbox_plugin_bind_provisioner.__version__" } +version = { attr = "netbox_dns_bridge.__version__" } [project.urls] Homepage = "https://github.com/Suraxius/netbox-plugin-bind-provisioner" diff --git a/src/netbox_plugin_bind_provisioner/migrations/0001_initial.py b/src/netbox_plugin_bind_provisioner/migrations/0001_initial.py deleted file mode 100644 index 6196a18..0000000 --- a/src/netbox_plugin_bind_provisioner/migrations/0001_initial.py +++ /dev/null @@ -1,51 +0,0 @@ -# Generated by Django 5.2.8 on 2025-11-23 14:36 - -import netbox.models.deletion -import taggit.managers -import utilities.json -from django.db import migrations, models - - -class Migration(migrations.Migration): - - initial = True - - dependencies = [ - ("extras", "0133_make_cf_minmax_decimal"), - ] - - operations = [ - migrations.CreateModel( - name="IntegerKeyValueSetting", - fields=[ - ( - "id", - models.BigAutoField( - auto_created=True, primary_key=True, serialize=False - ), - ), - ("created", models.DateTimeField(auto_now_add=True, null=True)), - ("last_updated", models.DateTimeField(auto_now=True, null=True)), - ( - "custom_field_data", - models.JSONField( - blank=True, - default=dict, - encoder=utilities.json.CustomFieldJSONEncoder, - ), - ), - ("key", models.CharField(max_length=64)), - ("value", models.IntegerField()), - ( - "tags", - taggit.managers.TaggableManager( - through="extras.TaggedItem", to="extras.Tag" - ), - ), - ], - options={ - "abstract": False, - }, - bases=(netbox.models.deletion.DeleteMixin, models.Model), - ), - ] diff --git a/src/netbox_plugin_bind_provisioner/migrations/0002_alter_integerkeyvaluesetting_options_and_more.py b/src/netbox_plugin_bind_provisioner/migrations/0002_alter_integerkeyvaluesetting_options_and_more.py deleted file mode 100644 index b609286..0000000 --- a/src/netbox_plugin_bind_provisioner/migrations/0002_alter_integerkeyvaluesetting_options_and_more.py +++ /dev/null @@ -1,33 +0,0 @@ -# Generated by Django 5.2.6 on 2025-12-18 14:51 - -from django.db import migrations - - -class Migration(migrations.Migration): - - dependencies = [ - ('netbox_plugin_bind_provisioner', '0001_initial'), - ] - - operations = [ - migrations.AlterModelOptions( - name='integerkeyvaluesetting', - options={'default_permissions': ()}, - ), - migrations.RemoveField( - model_name='integerkeyvaluesetting', - name='created', - ), - migrations.RemoveField( - model_name='integerkeyvaluesetting', - name='custom_field_data', - ), - migrations.RemoveField( - model_name='integerkeyvaluesetting', - name='last_updated', - ), - migrations.RemoveField( - model_name='integerkeyvaluesetting', - name='tags', - ), - ] diff --git a/src/netbox_plugin_bind_provisioner/migrations/0003_catalogzonememberidentifier.py b/src/netbox_plugin_bind_provisioner/migrations/0003_catalogzonememberidentifier.py deleted file mode 100644 index 364310a..0000000 --- a/src/netbox_plugin_bind_provisioner/migrations/0003_catalogzonememberidentifier.py +++ /dev/null @@ -1,26 +0,0 @@ -# Generated by Django 5.2.9 on 2026-02-02 09:23 - -import django.db.models.deletion -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('netbox_dns', '0030_dnsseckeytemplate_comments_dnsseckeytemplate_owner_and_more'), - ('netbox_plugin_bind_provisioner', '0002_alter_integerkeyvaluesetting_options_and_more'), - ] - - operations = [ - migrations.CreateModel( - name='CatalogZoneMemberIdentifier', - fields=[ - ('id', models.BigAutoField(auto_created=True, primary_key=True, serialize=False)), - ('name', models.CharField(max_length=26, unique=True)), - ('zone', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='bind_provisioner_models', to='netbox_dns.zone')), - ], - options={ - 'ordering': ('name',), - }, - ), - ] diff --git a/src/netbox_plugin_bind_provisioner/migrations/0004_alter_catalogzonememberidentifier_zone.py b/src/netbox_plugin_bind_provisioner/migrations/0004_alter_catalogzonememberidentifier_zone.py deleted file mode 100644 index b6486e9..0000000 --- a/src/netbox_plugin_bind_provisioner/migrations/0004_alter_catalogzonememberidentifier_zone.py +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by Django 5.2.9 on 2026-02-02 10:53 - -import django.db.models.deletion -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('netbox_dns', '0030_dnsseckeytemplate_comments_dnsseckeytemplate_owner_and_more'), - ('netbox_plugin_bind_provisioner', '0003_catalogzonememberidentifier'), - ] - - operations = [ - migrations.AlterField( - model_name='catalogzonememberidentifier', - name='zone', - field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='bind_provisioner_catz_identifier', to='netbox_dns.zone'), - ), - ] diff --git a/src/netbox_plugin_bind_provisioner/migrations/0005_alter_catalogzonememberidentifier_zone.py b/src/netbox_plugin_bind_provisioner/migrations/0005_alter_catalogzonememberidentifier_zone.py deleted file mode 100644 index 3ab95dc..0000000 --- a/src/netbox_plugin_bind_provisioner/migrations/0005_alter_catalogzonememberidentifier_zone.py +++ /dev/null @@ -1,20 +0,0 @@ -# Generated by Django 5.2.9 on 2026-02-02 20:49 - -import django.db.models.deletion -from django.db import migrations, models - - -class Migration(migrations.Migration): - - dependencies = [ - ('netbox_dns', '0030_dnsseckeytemplate_comments_dnsseckeytemplate_owner_and_more'), - ('netbox_plugin_bind_provisioner', '0004_alter_catalogzonememberidentifier_zone'), - ] - - operations = [ - migrations.AlterField( - model_name='catalogzonememberidentifier', - name='zone', - field=models.OneToOneField(on_delete=django.db.models.deletion.CASCADE, related_name='catz_identifier', to='netbox_dns.zone'), - ), - ] diff --git a/src/netbox_plugin_bind_provisioner/service/endpoint/__init__.py b/src/netbox_plugin_bind_provisioner/service/endpoint/__init__.py deleted file mode 100644 index e69de29..0000000