diff --git a/.gitignore b/.gitignore index 62d874c..3e91704 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ *.pyc *.pyo +*.jnl .bashrc .bash_history .lesshst diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..68c771a --- /dev/null +++ b/LICENSE @@ -0,0 +1,176 @@ + + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + diff --git a/README.md b/README.md index b181338..40b5997 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,25 @@ -GitNamed -======== +# GitNamed -GitNamed is a project that manage name server by git. you can clone -the git repo to any workstation, edit zone file, commit and push it. -the data will push to the master and slave name server on the fly. +GitNamed is a project that manage name server by git. -you don't need to touch name server any more, you have all your -data in git repo with a history of your zone file. +## Features -if you need add a new zone, just create a new file in zones directory, -zone file name should be the domain name: +* A frame to manage your DNS server(s) +* Put all your DNS data into git, and you have a revision from which you can backup and restore easily +* It's easy to manage your DNS resource records, just edit and commit +* DNS manager needs no OS account on the DNS server, only a git account +* Using hooks to validate syntax of zone file when commting +* Using hooks to auto increcement serial of SOA when commting + +## Overview + +GitNamed is a project that manages your name server(s) by git. You can clone +the git repo to any workstation, edit zone file, commit and push the changes. +The data will be pushed to the master and slave name server on the fly. + +You don't need to touch name server any more, you have all your dat in a git repo with a history of your changes. + +If you need add a new zone, just create a new file in zones directory, zone file name should be the domain name. ``` vi zones/example.com @@ -17,7 +27,7 @@ git add zones/example.com git commit -m "add example.com" ``` -here is a example zone file: +Here is a example zone file: ``` $TTL 3600 @@ -38,11 +48,10 @@ test IN A 61.160.235.200 * IN CNAME example.com. ``` -any one having the access right of git repo can manage the name -server now. +Any one whos has the access right of git repo can manage the name server now. -it's tested on CentOS 6.2 and Debian 6.0. +It's been tested on CentOS 6.2 and Debian 6.0. If you find any problems, please contact me: @@ -52,8 +61,7 @@ blog: http://www.pubyun.com/blog github: https://github.com/pubyun/gitnamed -Install Guide -------------- +## Install Guide ### enviroment @@ -64,6 +72,8 @@ CentOS: #yum -y install bind Debian: #aptitude -y install bind9 +Mac OS X: +$brew install bind ``` ### Setup master DNS server @@ -75,27 +85,14 @@ Debian: #cd /home/named ``` -* modify IP of domain name server in config file: +* modify IP of domain name server in config file, and generate +key to transfer zone from master to slave: ``` +#dnssec-keygen -a hmac-md5 -b 128 -n HOST master2slave #vi script/settings.py ``` -* modify trusted IP of your domain name server - -you should include ip of all your slave dns servers in the trusted -ip block, so they can transfer data from master dns server - -``` -#vi named.conf -acl trusted { - 127.0.0.1/32; - 192.168.0.0/16; - 172.16.0.0/16; - 61.160.235.0/24; -}; -``` - * runing setup file: ``` @@ -155,7 +152,7 @@ as master dns. * runing setup file: ``` -#./script/setup.py +#./script/setup.py slave ``` * start named @@ -217,6 +214,23 @@ $vi ~git/repositories/gitnamed.git/hooks/post-receive /usr/bin/ssh -i /home/git/.ssh/gitnamed named@ns1.pubyun.org sleep 1 ``` +### add pre-commit hook to check zone file and auto increment serial + +ln -s ../../script/check.sh .git/hooks/pre-commit + +you should put the serial of SOA in separated line and end it with +a comment "; serial": + +``` +$TTL 3600 +@ IN SOA ns1.example.com. sysadm.example.com. ( + 2012040812 ; serial + 7200 ; refresh + 1800 ; retry + 1209600 ; expire + 300 ) ; minimum +``` + ### it works now you can clone the git repo to any workstation, edit zone file, commit and push it. diff --git a/data/.gitignore b/data/.gitignore new file mode 100644 index 0000000..e69de29 diff --git a/dynamic/.gitignore b/dynamic/.gitignore new file mode 100644 index 0000000..5f06b05 --- /dev/null +++ b/dynamic/.gitignore @@ -0,0 +1 @@ +managed-keys.* diff --git a/dzones.key b/dzones.key new file mode 100644 index 0000000..f811647 --- /dev/null +++ b/dzones.key @@ -0,0 +1,10 @@ +key user1 { + algorithm hmac-md5; + secret "01D+SZmnV6YKXOeeGVVclQ=="; +}; + +key user2 { + algorithm hmac-md5; + secret "GiaDH8MbES+e0+r66qDFaw=="; +}; + diff --git a/named.conf b/named.conf index ef6d833..5f5b9b7 100644 --- a/named.conf +++ b/named.conf @@ -7,6 +7,7 @@ acl trusted { options { directory "/home/named"; + managed-keys-directory "dynamic"; dump-file "data/cache_dump.db"; statistics-file "data/named_stats.txt"; memstatistics-file "data/named_mem_stats.txt"; @@ -51,4 +52,7 @@ controls { allow { 127.0.0.1; } keys { "rndc-key"; }; }; +# key for dyndns update +include "dzones.key"; + include "named.rfc1912.zones"; diff --git a/script/check.sh b/script/check.sh index 3e994d4..38da755 100755 --- a/script/check.sh +++ b/script/check.sh @@ -29,10 +29,32 @@ git diff-index --cached --name-only HEAD | grep '^zones/' | git checkout-index --stdin --prefix=$tmpdir/ -find $tmpdir/zones -type f -type f | +find $tmpdir/zones -type f | while read zonefile; do zone=`echo $zonefile | sed -e "s/^${tmpdir}\/zones\/\(.*\)$/\1/"` - named-checkzone -q $zone $zonefile + git diff --cached HEAD zones/$zone | awk ' BEGIN { + serial_new=0 + serial_old=0 +} +/;[ \t]+serial/ { + if ($1 == "-") + serial_old = $2 + if ($1 == "+") + serial_new = $2 +} +END { + if (serial_old < serial_new) { + exit 0 + } else { + exit -1 + } +}' + if [ $? -ne 0 ]; then + perl -pi -e 'if (/^\s+(\d{10})\s+;\s+serial/i) { my $i = $1+1; s/$1/$i/;}' zones/$zone + git add zones/$zone +# echo "serial of zone $zone not valid!" >> $tmpfile1 + fi + named-checkzone -q -k fail -m fail -M fail -n fail $zone $zonefile # If named-checkzone reports an error, get some output: if [ $? -ne 0 ]; then named-checkzone $zone $zonefile | sed "s#$tmpdir/##" >> $tmpfile1 2>&1 diff --git a/script/settings.py b/script/settings.py index ea7936f..204ce47 100755 --- a/script/settings.py +++ b/script/settings.py @@ -1,5 +1,24 @@ #-*- coding: utf-8 -*- +# vim: tabstop=4 shiftwidth=4 softtabstop=4 + +# Copyright 2012 PubYun, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""settings for GitNamed.""" + + import os import sys import platform @@ -13,6 +32,10 @@ '61.10.35.200':'centos', } +# key to transfer zone from master to slave +# dnssec-keygen -a hmac-md5 -b 128 -n HOST master2slave +transfer_key_body = 'MFnphERTs7gnX+XHcWoEOA==' + # some dynamic updated zones dzones = { 'dynupdate.org':'user1', diff --git a/script/setup.py b/script/setup.py index 4fa7c63..2845f38 100755 --- a/script/setup.py +++ b/script/setup.py @@ -1,6 +1,25 @@ #!/usr/bin/env python #-*- coding: utf-8 -*- +# vim: tabstop=4 shiftwidth=4 softtabstop=4 + +# Copyright 2012 PubYun, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""Setup script for GitNamed.""" + + import os import sys import subprocess @@ -13,6 +32,9 @@ def main(dns_type): # delete /etc/rndc.conf, or rndc will use it if os.path.isfile('/etc/rndc.conf'): os.unlink('/etc/rndc.conf') + # debian + if os.path.isfile('/etc/bind/rndc.conf'): + os.unlink('/etc/bind/rndc.conf') # change user homedir and shell # usermod -d /home/named/ -s /bin/bash named diff --git a/script/syndns.py b/script/syndns.py index b975378..f4a640a 100755 --- a/script/syndns.py +++ b/script/syndns.py @@ -1,6 +1,24 @@ #!/usr/bin/env python #-*- coding: utf-8 -*- +# vim: tabstop=4 shiftwidth=4 softtabstop=4 + +# Copyright 2012 PubYun, LLC. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +"""Sync script for GitNamed.""" + import os import sys import subprocess @@ -10,9 +28,23 @@ named_conf_master = os.path.join(settings.named_path, 'named.conf.master') named_conf_slave = os.path.join(settings.named_path, 'named.conf.slave') +transfer_key_name = 'master2slave' + +transfer_key = u''' +key %s { + algorithm hmac-md5; + secret "%s"; +}; + +''' % (transfer_key_name, settings.transfer_key_body) + nameconf_master = u'''zone "%s" { type master; file "zones/%s"; + %s; + allow-transfer { + %s; + }; %s}; ''' @@ -23,17 +55,15 @@ %s; }; }; +''' +dyndns_update = u''' allow-update {key %s; };\n''' -''' +all_slave = ' '.join('%s;' % slave_ip + for (slave_ip, system) in settings.slave_ips.items()) + +notify_str = 'also-notify {%s}' % all_slave -dyndns_update = u''' - allow-update {key %s; }; - allow-transfer { - key %s; - trusted; - }; -''' def get_user(system): if system == 'centos': @@ -48,12 +78,14 @@ def is_file(name): return os.path.isfile(os.path.join(settings.zones_path, name)) def get_master(z): + transfer_key = 'key %s' % transfer_key_name; if z in settings.dzones: key = settings.dzones[z] - dstring = dyndns_update % (key, key) + dstring = dyndns_update % key + transfer_key += '; key %s' % key else: dstring = '' - return nameconf_master%(z, z, dstring) + return nameconf_master%(z, z, notify_str, transfer_key, dstring) def reload_slave(slave_ip, system): user = get_user(system) @@ -86,18 +118,23 @@ def main(): if code: sys.stderr.write('git pull code failed\n') - # get all zones - zones = [f for f in os.listdir(settings.zones_path) if is_file(f)] + # get all zones, exclude journal file + zones = [f for f in os.listdir(settings.zones_path) + if is_file(f) and not f.endswith('.jnl')] # create named.conf.master with open(named_conf_master, 'w') as f: f.write('include "%s/named.conf";\n\n' % settings.named_path) - f.write(''.join([get_master(z) for z in zones])) + f.write(transfer_key) + f.write('\n'.join([get_master(z) for z in zones])) # create named.conf.slave with open(named_conf_slave, 'w') as f: f.write('include "%s/named.conf";\n\n' % settings.named_path) - f.write(''.join([nameconf_slave%(z, z, + f.write(transfer_key) + f.write('server %s { keys %s; };\n\n' % + (settings.master_ip, transfer_key_name)) + f.write('\n'.join([nameconf_slave%(z, z, settings.master_ip) for z in zones])) # reload master dns