first version

This commit is contained in:
Adrien Waksberg 2021-09-11 18:52:14 +02:00
parent 112538929b
commit 0b5c1754ad
14 changed files with 481 additions and 0 deletions

2
.gitignore vendored Normal file
View file

@ -0,0 +1,2 @@
.kitchen/*
*.pyc

12
.yamllint Normal file
View file

@ -0,0 +1,12 @@
---
extends: default
ignore: |
.kitchen/*
vendor/
rules:
line-length:
max: 120
level: warning
truthy: false

8
CHANGELOG.md Normal file
View file

@ -0,0 +1,8 @@
# CHANGELOG
This project adheres to [Semantic Versioning](http://semver.org/).
Which is based on [Keep A Changelog](http://keepachangelog.com/)
## [Unreleased]
- first version

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 2021 Adrien Waksberg
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.

74
README.md Normal file
View file

@ -0,0 +1,74 @@
# Ansible role: Strongswan
[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](https://git.yaegashi.fr/nishiki/ansible-role-strongswan/src/branch/master/LICENSE)
Install and configure a IPSEC server with strongswan
## Requirements
* Ansible >= 2.9
* Debian
* Buster
* Bullseye
## Role variables
- `strongswan_default_config` - set the default connection config
```
type: tunnel
auto: start
keyexchange: ikev1
authby: secret
ike: aes256-sha256-modp2048
esp: aes256-sha256-modp2048
ikelifetime: 10800s
lifetime: 3600s
aggressive: false
```
`strongswan_connections` - hash with the IPSEC connections
```
test-ipsec:
left: 192.168.0.1
leftsubnet: 10.0.0.0/24
right: 192.168.0.2
rightsubnet: 10.1.0.0/24
psk: secret
```
## How to use
```
- hosts: server
roles:
- strongswan
```
## Development
### Test with molecule and docker
* install [docker](https://docs.docker.com/engine/installation/)
* install `python3` and `python3-pip`
* install molecule and dependencies `pip3 install molecule molecule-docker docker ansible-lint pytest-testinfra yamllint`
* run `molecule test`
## License
```
Copyright (c) 2021 Adrien Waksberg
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.
```

12
defaults/main.yml Normal file
View file

@ -0,0 +1,12 @@
---
strongswan_default_config:
type: tunnel
auto: start
keyexchange: ikev1
authby: secret
ike: aes256-sha256-modp2048
esp: aes256-sha256-modp2048
ikelifetime: 10800s
lifetime: 3600s
aggressive: false
strongswan_connections: {}

5
handlers/main.yml Normal file
View file

@ -0,0 +1,5 @@
---
- name: restart strongswan
ansible.builtin.service:
name: ipsec
state: restarted

22
meta/main.yml Normal file
View file

@ -0,0 +1,22 @@
---
galaxy_info:
role_name: strongswan
author: Adrien Waksberg
company: Adrien Waksberg
description: Install and configure an IPSEC server with strongswan
license: nolicense
min_ansible_version: 2.10
platforms:
- name: Debian
versions:
- buster
- bullseye
galaxy_tags:
- strongswan
- ipsec
- tunnel
- vpn
dependencies: []

View file

@ -0,0 +1,17 @@
---
- name: Converge
hosts: all
roles:
- ansible-role-strongswan
vars:
strongswan_connections:
test-ipsec:
left: '{{ ansible_all_ipv4_addresses[0] }}'
leftsubnet: 10.0.0.0/24
right: 192.168.0.2
rightsubnet: 10.1.0.0/24
psk: secret
pre_tasks:
- name: update apt cache
ansible.builtin.apt:
update_cache: true

View file

@ -0,0 +1,26 @@
---
driver:
name: docker
platforms:
- name: debian11
image: nishiki/debian11:molecule
privileged: true
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:ro
command: /lib/systemd/systemd
capabilities:
- SYS_ADMIN
- name: debian10
image: nishiki/debian10:molecule
privileged: true
volumes:
- /sys/fs/cgroup:/sys/fs/cgroup:ro
command: /lib/systemd/systemd
capabilities:
- SYS_ADMIN
lint: |
set -e
yamllint .
ansible-lint .
verifier:
name: testinfra

View file

@ -0,0 +1,40 @@
import testinfra.utils.ansible_runner
def test_packages(host):
package = host.package('strongswan')
assert package.is_installed
def test_config_file(host):
config = host.file('/etc/ipsec.conf')
assert config.exists
assert config.is_file
assert config.user == 'root'
assert config.group == 'root'
assert config.mode == 0o644
assert config.contains('aggressive=no')
assert config.contains('ikelifetime=10800s')
assert config.contains('conn test-ipsec')
assert config.contains('right=192.168.0.2')
def test_secret_file(host):
config = host.file('/etc/ipsec.secrets')
assert config.exists
assert config.is_file
assert config.user == 'root'
assert config.group == 'root'
assert config.mode == 0o600
assert config.contains(' 192.168.0.2 : PSK "secret"')
def test_service(host):
service = host.service('ipsec')
assert service.is_running
assert service.is_enabled
def test_socket(host):
socket = host.socket('udp://0.0.0.0:500')
assert socket.is_listening
def test_ipsec(host):
cmd = host.run('ipsec status test-ipsec')
assert cmd.succeeded
assert 'no match' not in cmd.stdout

33
tasks/main.yml Normal file
View file

@ -0,0 +1,33 @@
---
- name: install package
ansible.builtin.package:
name:
- strongswan
tags: strongswan
- name: copy configuration
ansible.builtin.template:
src: ipsec.conf.j2
dest: /etc/ipsec.conf
owner: root
group: root
mode: 0644
notify: restart strongswan
tags: strongswan
- name: copy secret configuration
ansible.builtin.template:
src: ipsec.secrets.j2
dest: /etc/ipsec.secrets
owner: root
group: root
mode: 0600
notify: restart strongswan
tags: strongswan
- name: enable and start service
ansible.builtin.service:
name: ipsec
enabled: true
state: started
tags: strongswan

24
templates/ipsec.conf.j2 Normal file
View file

@ -0,0 +1,24 @@
# {{ ansible_managed }}
config setup
charondebug=all
conn %default
{% for default_option, default_value in strongswan_default_config.items() %}
{{ default_option }}={% if default_value is sameas true %}yes
{% elif default_value is sameas false %}no
{% else %}{{ default_value }}
{% endif %}
{% endfor %}
{% for conn_name, conn_options in strongswan_connections.items() %}
conn {{ conn_name }}
{% for conn_option, conn_value in conn_options.items() %}
{% if conn_option != 'psk' %}
{{ conn_option }}={% if conn_value is sameas true %}yes
{% elif conn_value is sameas false %}no
{% else %}{{ conn_value }}
{% endif %}
{% endif %}
{% endfor %}
{% endfor %}

View file

@ -0,0 +1,5 @@
# {{ ansible_managed }}
{% for conn_value in strongswan_connections.values() %}
{{ conn_value.left }} {{ conn_value.right }} : PSK "{{ conn_value.psk }}"
{% endfor %}