first version

This commit is contained in:
Adrien Waksberg 2017-10-08 14:55:01 +02:00
parent 599300b73a
commit 216888000d
19 changed files with 696 additions and 0 deletions

38
.rubocop.yml Normal file
View file

@ -0,0 +1,38 @@
AllCops:
Exclude:
- db/**/*
- config/**/*
- Vagrantfile
TargetRubyVersion: 2.3
Naming/AccessorMethodName:
Enabled: false
Lint/RescueWithoutErrorClass:
Enabled: false
Metrics/LineLength:
Max: 120
Metrics/CyclomaticComplexity:
Enabled: false
Metrics/PerceivedComplexity:
Enabled: false
Metrics/MethodLength:
Enabled: false
Metrics/BlockLength:
Enabled: false
Metrics/ClassLength:
Enabled: false
Metrics/AbcSize:
Enabled: false
Style/NumericLiteralPrefix:
Enabled: false
Style/FrozenStringLiteralComment:
Enabled: false
Style/CommandLiteral:
Enabled: true
EnforcedStyle: percent_x
Style/Documentation:
Enabled: false

14
.travis.yml Normal file
View file

@ -0,0 +1,14 @@
sudo: required
language: ruby
services:
- docker
before_install:
- docker pull nishiki/ansible:stretch
script:
- rake
notifications:
webhooks: https://galaxy.ansible.com/api/v1/notifications/

7
Gemfile Normal file
View file

@ -0,0 +1,7 @@
source 'https://rubygems.org'
group :development do
gem 'rake'
gem 'rubocop', '0.50.0'
gem 'serverspec'
end

201
LICENSE Normal file
View file

@ -0,0 +1,201 @@
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.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright {yyyy} {name of copyright owner}
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.

49
README.md Normal file
View file

@ -0,0 +1,49 @@
# Ansible role: Bind
[![Version](https://img.shields.io/badge/latest_version-0.1.0-green.svg)](https://github.com/nishiki/ansible-role-bind/releases)
[![Build Status](https://travis-ci.org/nishiki/ansible-role-bind.svg?branch=master)](https://travis-ci.org/nishiki/ansible-role-bind)
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://github.com/nishiki/ansible-role-bind/blob/master/LICENSE)
Install and configure bind with dnssec
## Requirements
None
## Role variables
* `bind_role` - the role `master` or `slave`, don't generate dnssec key on `slave`
* `bind_zones` - the dns zones
## How to use
```
- hosts: dns-server
vars:
bind_role: master
bind_zones:
test.local:
ns_primary: ns1.test.local
mail: root@test.local
serial: 2017092202
dnssec: yes
entries:
- { name: '@', type: ns, value: localhost. }
- { name: hello, type: a, value: 1.2.3.4 }
hello.local:
ns_primary: ns1.hello.local
mail: root@hello.local
serial: 2017092201
dnssec: no
entries:
- { name: '@', type: ns, value: localhost. }
- { name: hello, type: a, value: 4.3.2.1 }
roles:
- bind
```
## Development
### Tests with docker
* install [docker](https://docs.docker.com/engine/installation/)
* install dependencies `bundle install`
* run the tests `rake`

31
Rakefile Normal file
View file

@ -0,0 +1,31 @@
require 'English'
ansible_role = 'bind'
def exec_cmd(cmd)
puts cmd
puts %x(#{cmd})
raise unless $CHILD_STATUS.success?
end
task :default do
exec_cmd(
"docker run -v $(pwd):/#{ansible_role}:ro -it nishiki/ansible:stretch bash -c " \
"'cd /#{ansible_role} && rake verify'"
)
end
task verify: %w[
install
]
task :install do
exec_cmd("ansible-playbook -i tests/inventory tests/#{ansible_role}.yml")
exec_cmd("ansible-playbook -i tests/inventory tests/#{ansible_role}.yml | grep changed=0")
exec_cmd("cd spec && rspec #{ansible_role}.rb")
end
#task :purge do
# exec_cmd('ansible-playbook -i tests/inventory tests/purge.yml')
# exec_cmd('cd spec && rspec purge.rb')
#end

4
handlers/main.yml Normal file
View file

@ -0,0 +1,4 @@
- name: restart bind
service:
name: bind9
state: restarted

17
meta/main.yml Normal file
View file

@ -0,0 +1,17 @@
galaxy_info:
author: Adrien Waksberg
description: Install and configure bind9 with dnssec
license: Apache2
min_ansible_version: 2.0
platforms:
- name: Debian
versions:
- jessie
- stretch
galaxy_tags:
- bind
- dns
dependencies: []

35
spec/bind.rb Normal file
View file

@ -0,0 +1,35 @@
require 'serverspec'
set :backend, :exec
%w[
bind9
cron
].each do |package|
describe package(package) do
it { should be_installed }
end
end
%w[
db.test.local
db.test.local.signed
db.hello.local
].each do |file|
describe file("/etc/bind/zones/#{file}") do
it { should be_file }
it { should be_mode 644 }
it { should be_owned_by 'root' }
it { should be_grouped_into 'root' }
end
end
describe command('host hello.test.local 127.0.0.1') do
its(:exit_status) { should eq 0 }
its(:stdout) { should contain('1.2.3.4') }
end
describe command('host hello.hello.local 127.0.0.1') do
its(:exit_status) { should eq 0 }
its(:stdout) { should contain('4.3.2.1') }
end

99
tasks/keys.yml Normal file
View file

@ -0,0 +1,99 @@
- name: check if key has been generated
stat:
path: '/etc/bind/keys/{{ item.key }}-ksk.key'
with_dict: '{{ bind_zones }}'
when: item.value.dnssec is defined and item.value.dnssec
register: st
tags: bind
- name: generated keys for dnssec 1/2
shell: 'dnssec-keygen -a RSASHA256 -b 2048 -r /dev/urandom -n ZONE {{ item.item.key }}'
args:
chdir: /tmp
with_items: '{{ st.results }}'
when: item.stat is defined and not item.stat.exists
register: stdout
tags: bind
- name: move key file 1/2
copy:
remote_src: true
src: '/tmp/{{ item[0].stdout }}.{{ item[1] }}'
dest: '/etc/bind/keys/{{ item[0].stdout }}.{{ item[1] }}'
owner: root
group: bind
mode: 0640
with_nested:
- '{{ stdout.results }}'
- ['key', 'private']
when: not item[0].skipped is defined
tags: bind
- name: link key file 1/2
file:
src: '/etc/bind/keys/{{ item[0].stdout }}.{{ item[1] }}'
dest: '/etc/bind/keys/{{ item[0].item.item.key }}.{{ item[1] }}'
owner: root
group: root
state: link
with_nested:
- '{{ stdout.results }}'
- ['key', 'private']
when: not item[0].skipped is defined
tags: bind
- name: remove old key file 1/2
file:
path: '{{ item[0].stdout }}.{{ item[1] }}'
state: absent
with_nested:
- '{{ stdout.results }}'
- ['key', 'private']
when: not item[0].skipped is defined
tags: bind
- name: generated keys for dnssec 2/2
shell: 'dnssec-keygen -f KSK -a RSASHA256 -b 4096 -r /dev/urandom -n ZONE {{ item.item.key }}'
args:
chdir: /tmp
with_items: '{{ st.results }}'
when: item.stat is defined and not item.stat.exists
register: stdout
tags: bind
- name: move key file 2/2
copy:
remote_src: true
src: '/tmp/{{ item[0].stdout }}.{{ item[1] }}'
dest: '/etc/bind/keys/{{ item[0].stdout }}.{{ item[1] }}'
owner: root
group: bind
mode: 0640
with_nested:
- '{{ stdout.results }}'
- ['key', 'private']
when: not item[0].skipped is defined
tags: bind
- name: link key file 2/2
file:
src: '/etc/bind/keys/{{ item[0].stdout }}.{{ item[1] }}'
dest: '/etc/bind/keys/{{ item[0].item.item.key }}-ksk.{{ item[1] }}'
owner: root
group: root
state: link
with_nested:
- '{{ stdout.results }}'
- ['key', 'private']
when: not item[0].skipped is defined
tags: bind
- name: remove old key file 2/2
file:
path: '{{ item[0].stdout }}.{{ item[1] }}'
state: absent
with_nested:
- '{{ stdout.results }}'
- ['key', 'private']
when: not item[0].skipped is defined
tags: bind

88
tasks/main.yml Normal file
View file

@ -0,0 +1,88 @@
- name: install packages for bind9
apt:
name: '{{ item }}'
state: present
with_items:
- bind9
- bind9-host
- cron
tags: bind
- name: create zone directory
file:
path: /etc/bind/zones
owner: bind
group: bind
mode: 0700
state: directory
tags: bind
- name: create log directory
file:
path: /var/log/named
owner: bind
group: bind
mode: 0700
state: directory
tags: bind
- name: copy bind configuration files
template:
src: '{{ item }}.j2'
dest: '/etc/bind/{{ item }}'
owner: root
group: root
mode: 0644
with_items:
- named.conf
- named.conf.options
- named.conf.local
notify: restart bind
tags: bind
- name: create keys directory
file:
path: /etc/bind/keys
owner: root
group: bind
mode: 0750
state: directory
tags: bind
- include: keys.yml
when: bind_role == 'master'
- name: copy zone files
template:
src: db.j2
dest: '/etc/bind/zones/db.{{ item.key }}'
owner: root
group: root
mode: 0644
with_dict: '{{ bind_zones }}'
register: zone
notify: restart bind
tags: bind
- name: dnssec sign
shell: 'cd /etc/bind/keys && dnssec-signzone -3 $(head -n 1000 /dev/urandom | sha1sum | cut -b 1-16) -A -N INCREMENT -o {{ item.item.key }} -t /etc/bind/zones/db.{{ item.item.key }}'
with_items: '{{ zone.results }}'
when: item.changed and item.item.value.dnssec is defined and item.item.value.dnssec
notify: restart bind
tags: bind
- name: add cron dnssec
template:
src: dnssec.j2
dest: /etc/cron.weekly/dnssec
owner: root
group: root
mode: 0700
tags: bind
- name: enable and start bind9
service:
name: bind9
enabled: yes
state: started
tags: bind

23
templates/db.j2 Normal file
View file

@ -0,0 +1,23 @@
; {{ ansible_managed }}
$TTL {{ item.value.ttl|default(3600) }}
@ IN SOA {{ item.value.ns_primary }}. {{ item.value.mail|replace('@', '.') }}. (
{{ item.value.serial }} ; Serial
{{ item.value.refresh|default(14400) }} ; Refresh
{{ item.value.retry|default(86400) }} ; Retry
{{ item.value.expire|default(2419200) }} ; Expire
{{ item.value.negative_cache|default(86400) }} ; Negative Cache TTL
)
{% for entry in item.value.entries %}
{% if entry.type|upper == 'MX' %}
{{ entry.name }}{% for i in range(0, 15 - entry.name|length) %} {% endfor %} IN MX {{ entry.priority }} {{ entry.value }}
{% else %}
{{ entry.name }}{% for i in range(0, 15 - entry.name|length) %} {% endfor %} IN {{ entry.type|upper }}{% for i in range(0, 9 - entry.type|length) %} {% endfor %} {{ entry.value }}
{% endif %}
{% endfor %}
{% if 'dnssec' in item.value and item.value.dnssec %}
$INCLUDE {{ item.key }}.key
$INCLUDE {{ item.key }}-ksk.key
{% endif %}

12
templates/dnssec.j2 Normal file
View file

@ -0,0 +1,12 @@
#!/bin/bash
# {{ ansible_managed }}
cd /etc/bind/keys
{% for zone, value in bind_zones.iteritems() %}
{% if 'dnssec' in value and value.dnssec %}
dnssec-signzone -3 $(head -n 1000 /dev/urandom | sha1sum | cut -b 1-16) -A -N INCREMENT -o {{ zone }} -t /etc/bind/zones/db.{{ zone }}
{% endif %}
{% endfor %}
systemctl restart bind9

16
templates/named.conf.j2 Normal file
View file

@ -0,0 +1,16 @@
# {{ ansible_managed }}
include "/etc/bind/named.conf.options";
include "/etc/bind/named.conf.default-zones";
include "/etc/bind/named.conf.local";
logging {
channel security_file {
file "/var/log/named/security.log" versions 3 size 30m;
severity dynamic;
print-time yes;
};
category security {
security_file;
};
};

View file

@ -0,0 +1,13 @@
# {{ ansible_managed }}
{% for zone, value in bind_zones.iteritems() %}
zone "{{ zone }}" IN {
type master;
{% if 'dnssec' in value and value.dnssec %}
file "/etc/bind/zones/db.{{ zone }}.signed";
{% else %}
file "/etc/bind/zones/db.{{ zone }}";
{% endif %}
allow-transfer { 217.70.177.40; };
};
{% endfor %}

View file

@ -0,0 +1,15 @@
# {{ ansible_managed }}
options {
directory "/var/cache/bind";
dnssec-enable yes;
dnssec-validation yes;
dnssec-lookaside auto;
auth-nxdomain no; # conform to RFC1035
listen-on { any; };
listen-on-v6 { none; };
version none;
};

1
tests/bind Symbolic link
View file

@ -0,0 +1 @@
..

32
tests/bind.yml Normal file
View file

@ -0,0 +1,32 @@
- hosts: localhost
connection: local
vars:
bind_role: master
bind_zones:
test.local:
ns_primary: ns1.test.local
mail: root@test.local
serial: 2017092202
ttl: 3600
refresh: 14400
retry: 86400
expire: 2419200
negative_cache: 86400
dnssec: yes
entries:
- { name: '@', type: mx, priority: 20, value: mail.test.local. }
- { name: '@', type: ns, value: localhost. }
- { name: hello, type: a, value: 1.2.3.4 }
hello.local:
ns_primary: ns1.hello.local
mail: root@hello.local
serial: 2017092201
dnssec: no
entries:
- { name: '@', type: mx, priority: 20, value: mail.test.local. }
- { name: '@', type: ns, value: localhost. }
- { name: hello, type: a, value: 4.3.2.1 }
roles:
- bind

1
tests/inventory Normal file
View file

@ -0,0 +1 @@
localhost