Initial openvpn role commit
Change-Id: I091e7b198d852d5857f7b606cce2469c2f8ba9a7
diff --git a/.reuse/dep5 b/.reuse/dep5
new file mode 100644
index 0000000..a42b189
--- /dev/null
+++ b/.reuse/dep5
@@ -0,0 +1,5 @@
+Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+Files: VERSION README.md
+Copyright: 2022 Open Networking Foundation
+License: Apache-2.0
diff --git a/LICENSES/Apache-2.0.txt b/LICENSES/Apache-2.0.txt
new file mode 100644
index 0000000..d645695
--- /dev/null
+++ b/LICENSES/Apache-2.0.txt
@@ -0,0 +1,202 @@
+
+ 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.
diff --git a/Makefile b/Makefile
new file mode 100644
index 0000000..cc4dd6b
--- /dev/null
+++ b/Makefile
@@ -0,0 +1,42 @@
+# openvpn Makefile
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+SHELL = bash -eu -o pipefail
+
+.DEFAULT_GOAL := help
+.PHONY: test lint yamllint ansiblelint license help
+
+test: ## run tests on the playbook with molecule
+ molecule --version
+ molecule test
+
+lint: license yamllint ansiblelint ## run all lint checks
+
+# all YAML files
+YAML_FILES ?= $(shell find . -type f \( -name '*.yaml' -o -name '*.yml' \) -print )
+
+license: ## Check license with the reuse tool
+ reuse --version
+ reuse --root . lint
+
+yamllint: ## lint check with yamllint
+ yamllint --version
+ yamllint \
+ -d "{extends: default, rules: {line-length: {max: 99}}}" \
+ -s $(YAML_FILES)
+
+# List of molecule files, not including base molecule.yml which isn't ansible format
+MOLECULE_FILES ?= $(shell find molecule -type f -name '*.yml' \! -name 'molecule.yml' -print )
+
+ansiblelint: ## lint check with ansible-lint
+ ansible-lint --version
+ ansible-lint -v .
+ ansible-lint -v $(MOLECULE_FILES)
+
+help: ## Print help for each target
+ @echo openvpn test targets
+ @echo
+ @grep '^[[:alnum:]_-]*:.* ##' $(MAKEFILE_LIST) \
+ | sort | awk 'BEGIN {FS=":.* ## "}; {printf "%-25s %s\n", $$1, $$2};'
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..e32046a
--- /dev/null
+++ b/README.md
@@ -0,0 +1,26 @@
+# openvpn
+
+OpenVPN Server
+
+Configuration references:
+
+https://community.openvpn.net/openvpn/wiki/GettingStartedwithOVPN
+
+https://community.openvpn.net/openvpn/wiki/Using_Certificate_Chains
+
+https://build.openvpn.net/man/openvpn-2.5/openvpn.8.html
+
+
+## Example Playbook
+
+```yaml
+- hosts: all
+ roles:
+ - openvpn
+```
+
+## License and Author
+
+Copyright 2022 Open Networking Foundation <support@opennetworking.org>
+
+License: Apache-2.0
diff --git a/VERSION b/VERSION
new file mode 100644
index 0000000..c0ab82c
--- /dev/null
+++ b/VERSION
@@ -0,0 +1 @@
+0.0.1-dev
diff --git a/defaults/main.yml b/defaults/main.yml
new file mode 100644
index 0000000..f9fbdcd
--- /dev/null
+++ b/defaults/main.yml
@@ -0,0 +1,16 @@
+---
+# openvpn defaults/main.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+openvpn_listen_ip: "127.0.0.1"
+
+openvpn_subnet_cidr: "10.8.0.0/24"
+
+openvpn_dns_servers: []
+
+openvpn_routes: []
+
+# used per https://www.rfc-editor.org/rfc/rfc2606.html
+openvpn_server_name: "example.org"
diff --git a/handlers/main.yml b/handlers/main.yml
new file mode 100644
index 0000000..8e72cbf
--- /dev/null
+++ b/handlers/main.yml
@@ -0,0 +1,10 @@
+---
+# openvpn handlers/main.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: restart-openvpn
+ service:
+ name: "{{ openvpn_service }}"
+ state: restarted
diff --git a/meta/main.yml b/meta/main.yml
new file mode 100644
index 0000000..5788da2
--- /dev/null
+++ b/meta/main.yml
@@ -0,0 +1,32 @@
+---
+# openvpn meta/main.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+galaxy_info:
+ role_name: openvpn
+ namespace: onf
+
+ author: Open Networking Foundation
+ description: OpenVPN Server
+ company: Open Networking Foundation
+
+ issue_tracker_url: https://jira.opennetworking.org/
+
+ license: Apache-2.0
+
+ min_ansible_version: 2.10.7
+
+ platforms:
+ - name: Ubuntu
+ versions:
+ - bionic
+ - name: Debian
+ versions:
+ - bullseye
+
+ galaxy_tags:
+ - openvpn
+
+dependencies: []
diff --git a/molecule/default/converge.yml b/molecule/default/converge.yml
new file mode 100644
index 0000000..3cd5e8e
--- /dev/null
+++ b/molecule/default/converge.yml
@@ -0,0 +1,12 @@
+---
+# openvpn molecule/default/verify.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: Converge
+ hosts: all
+ tasks:
+ - name: "Include openvpn"
+ include_role:
+ name: "openvpn"
diff --git a/molecule/default/molecule.yml b/molecule/default/molecule.yml
new file mode 100644
index 0000000..51bb4fd
--- /dev/null
+++ b/molecule/default/molecule.yml
@@ -0,0 +1,31 @@
+---
+# openvpn molecule/default/molecule.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+dependency:
+ name: galaxy
+driver:
+ name: docker
+platforms:
+ - name: "ubuntu-18.04-priv"
+ image: "quay.io/paulfantom/molecule-systemd:ubuntu-18.04"
+ privileged: true
+ volumes:
+ - "/sys/fs/cgroup:/sys/fs/cgroup:ro"
+ - name: "debian-11-priv"
+ image: "onfinfra/molecule-systemd:debian-11"
+ privileged: true
+ volumes:
+ - "/sys/fs/cgroup:/sys/fs/cgroup:ro"
+provisioner:
+ name: ansible
+ inventory:
+ host_vars:
+ debian-11-priv:
+ ansible_python_interpreter: /usr/bin/python3
+ ubuntu-18.04-priv:
+ ansible_python_interpreter: /usr/bin/python3
+verifier:
+ name: ansible
diff --git a/molecule/default/verify.yml b/molecule/default/verify.yml
new file mode 100644
index 0000000..9af90f1
--- /dev/null
+++ b/molecule/default/verify.yml
@@ -0,0 +1,12 @@
+---
+# openvpn molecule/default/verify.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: Verify
+ hosts: all
+ tasks:
+ - name: example assertion
+ assert:
+ that: true
diff --git a/tasks/Debian.yml b/tasks/Debian.yml
new file mode 100644
index 0000000..6be3389
--- /dev/null
+++ b/tasks/Debian.yml
@@ -0,0 +1,13 @@
+---
+# openvpn tasks/Debian.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: Install openvpn apt packages
+ apt:
+ name:
+ - openvpn
+ install_recommends: false # don't install easy-rsa
+ update_cache: true
+ cache_valid_time: 3600
diff --git a/tasks/main.yml b/tasks/main.yml
new file mode 100644
index 0000000..29a3477
--- /dev/null
+++ b/tasks/main.yml
@@ -0,0 +1,43 @@
+---
+# openvpn tasks/main.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+
+- name: include OS-specific vars
+ include_vars: "{{ ansible_os_family }}.yml"
+
+- name: include OS-specific tasks
+ include_tasks: "{{ ansible_os_family }}.yml"
+
+- name: Copy certificate
+ copy:
+ src: "{{ item }}"
+ dest: "{{ openvpn_conf_dir }}/server/{{ item }}"
+ owner: root
+ group: root
+ mode: 0640
+ loop:
+ - chain.pem
+ - ca.crl
+ - openvpn_server.pem
+ - openvpn_server.key
+ - ta.key
+ - dh.pem
+
+- name: Create openvpn server config file
+ template:
+ src: server.conf.j2
+ dest: "{{ openvpn_conf_dir }}/server.conf"
+ backup: true
+ owner: root
+ group: "{{ openvpn_groupname }}"
+ mode: 0755
+ notify:
+ - restart-openvpn
+
+- name: start and enable openvpn
+ service:
+ name: "{{ openvpn_service }}"
+ state: started
+ enabled: true
diff --git a/templates/client.conf.j2 b/templates/client.conf.j2
new file mode 100644
index 0000000..6f11795
--- /dev/null
+++ b/templates/client.conf.j2
@@ -0,0 +1,49 @@
+# openvpn client.conf - {{ ansible_managed }}
+{#
+SPDX-FileCopyrightText: © 2022 Open Networking Foundation <support@opennetworking.org>
+SPDX-License-Identifier: Apache-2.0
+#}
+
+# security
+tls-client
+tls-version-min 1.3
+cipher AES-256-GCM
+auth SHA256
+
+# connection
+dev tun
+proto udp
+port 1194
+remote {{ openvpn_server_name }}
+
+# security
+remote-cert-tls server
+auth-nocache
+nobind
+persist-key
+persist-tun
+
+# logging
+verb 4
+mute 10
+
+# IP config
+topology subnet
+pull
+
+# CA certificates
+<ca>
+</ca>
+
+# TLS auth
+key-direction 1
+<tls-auth>
+</tls-auth>
+
+# client key
+<key>
+</key>
+
+# client cert
+<cert>
+</cert>
diff --git a/templates/server.conf.j2 b/templates/server.conf.j2
new file mode 100644
index 0000000..a47ca67
--- /dev/null
+++ b/templates/server.conf.j2
@@ -0,0 +1,69 @@
+# openvpn server.conf - {{ ansible_managed }}
+#
+{#
+SPDX-FileCopyrightText: © 2022 Open Networking Foundation <support@opennetworking.org>
+SPDX-License-Identifier: Apache-2.0
+#}
+
+# accounts and privilege dropping
+user nobody
+group {{ openvpn_groupname }}
+persist-key
+persist-tun
+
+# security
+tls-server
+tls-version-min 1.3
+cipher AES-256-GCM
+auth SHA256
+
+# CA
+ca {{ openvpn_conf_dir }}/server/chain.pem
+crl-verify {{ openvpn_conf_dir }}/server/ca.crl
+
+# openVPN server
+cert {{ openvpn_conf_dir }}/server/openvpn_server.pem
+key {{ openvpn_conf_dir }}/server/openvpn_server.key
+dh {{ openvpn_conf_dir }}/server/dh.pem
+
+# shared auth
+tls-auth {{ openvpn_conf_dir }}/server/ta.key 0
+
+# must connect with a verified client cert
+opt-verify
+remote-cert-tls client
+verify-client-cert require
+tls-cert-profile preferred
+
+# Connection
+dev openvpn
+dev-type tun
+local {{ openvpn_listen_ip }}
+port 1194
+proto udp
+keepalive 10 120
+max-clients 100
+opt-verify
+
+# IP config
+topology subnet
+server {{ openvpn_subnet_cidr | ipaddr('network') }} {{ openvpn_subnet_cidr | ipaddr('netmask') }}
+
+# DHCP config
+{% for dnsserv in openvpn_dns_servers %}
+push "dhcp-option DNS {{ dnsserv }}"
+{% endfor %}
+
+# routes
+{% for route in openvpn_routes %}
+push "route {{ route | ipaddr('network') }} {{ route | ipaddr('netmask') }}"
+{% endfor %}
+
+# notify clients on server restart
+explicit-exit-notify 1
+
+# logging
+verb 4
+mute 20
+status {{ openvpn_log_dir }}/status.log
+ifconfig-pool-persist {{ openvpn_log_dir }}/ipp.txt
diff --git a/vars/Debian.yml b/vars/Debian.yml
new file mode 100644
index 0000000..ac955a3
--- /dev/null
+++ b/vars/Debian.yml
@@ -0,0 +1,15 @@
+---
+# openvpn vars/Debian.yml
+#
+# SPDX-FileCopyrightText: 2022 Open Networking Foundation <support@opennetworking.org>
+# SPDX-License-Identifier: Apache-2.0
+#
+# NOTE: Only put platform/OS-specific variables in this file.
+# Put all other variables in the 'defaults/main.yml' file.
+
+openvpn_service: "openvpn@server"
+
+openvpn_conf_dir: "/etc/openvpn"
+openvpn_log_dir: "/var/log/openvpn"
+
+openvpn_groupname: nogroup