Version information
released Sep 25th 2016
This version is compatible with:
- Archlinux, FreeBSD , , , ,
This module has been deprecated by its author since May 4th 2018.
The author has suggested puppet-openvpn as its replacement.
Start using this module
Documentation
luxflux/openvpn — version 4.0.1 Sep 25th 2016
OpenVPN Puppet module
Puppet module to manage OpenVPN servers
Features
- Client-specific rules and access policies
- Generated client configurations and SSL-Certificates
- Downloadable client configurations and SSL-Certificates for easy client configuration
- Support for multiple server instances
- Support for LDAP-Authentication
- Support for server instance in client mode
- Support for TLS
Supported OS
- Ubuntu
- Debian
- CentOS
- RedHat
- Amazon
Dependencies
Puppet
- Version >= 4
Example
# add a server instance
openvpn::server { 'winterthur':
country => 'CH',
province => 'ZH',
city => 'Winterthur',
organization => 'example.org',
email => 'root@example.org',
server => '10.200.200.0 255.255.255.0',
}
# define clients
openvpn::client { 'client1':
server => 'winterthur',
}
openvpn::client { 'client2':
server => 'winterthur',
}
openvpn::client_specific_config { 'client1':
server => 'winterthur',
ifconfig => '10.200.200.50 10.200.200.51',
}
# a revoked client
openvpn::client { 'client3':
server => 'winterthur',
}
openvpn::revoke { 'client3':
server => 'winterthur',
}
# a server in client mode
file {
'/etc/openvpn/zurich/keys/ca.crt':
source => 'puppet:///path/to/ca.crt';
'/etc/openvpn/zurich/keys/zurich.crt':
source => 'puppet:///path/to/zurich.crt';
'/etc/openvpn/zurich/keys/zurich.key':
source => 'puppet:///path/to/zurich.key';
}
openvpn::server { 'zurich':
remote => [ 'mgmtnet3.nine.ch 1197', 'mgmtnet2.nine.ch 1197' ],
require => [ File['/etc/openvpn/zurich/keys/ca.crt'],
File['/etc/openvpn/zurich/keys/zurich.crt'],
File['/etc/openvpn/zurich/keys/zurich.key'] ];
}
Example with hiera
---
classes:
- openvpn
openvpn::servers:
'winterthur':
country: 'CH'
province: 'ZH'
city: 'Winterthur'
organization: 'example.org'
email: 'root@example.org'
server: '10.200.200.0 255.255.255.0'
openvpn::client_defaults:
server: 'winterthur'
openvpn::clients:
'client1': {}
'client2': {}
'client3': {}
openvpn::client_specific_configs:
'client1':
server: 'winterthur'
ifconfig: '10.200.200.50 10.200.200.51'
openvpn::revokes:
'client3':
server: 'winterthur'
Don't forget the sysctl directive net.ipv4.ip_forward
!
Contributions
Pull requests are very welcome. Join these fine folks who already helped to get this far with this module.
To help guaranteeing the stability of the module, please make sure to add tests to your pull request.
Changelog
Next Version
4.0.1
- Fix namespecific_rclink warning for non BSD systems (#214)
4.0.0
- Workaround for MODULES-2874 (#201)
- Fix for external CA handling with exported resources (#201)
- Drop Support for Puppet 3.x (#212)
3.1.0
- Support for FreeBSD (#180)
- Support for port-share (#182/#185)
- Support for pre-shared keys (#186)
- Support LDAP anonymous binds (#189)
- Fix
.ovpn
files generation (#190) - Support for external CAs (#192)
- Small Typo fix (#192)
- Fix support for Amazon Linux (#194)
- Client
pull
option (#195) - Allow
remote_host
to be an array of servers (#195) - More robust Shared CA handling (#191, #196)
3.0.0
- Support for Ubuntu 15.04 (#168)
- Support for specifying TLS-Cipher (#169)
- Support for specifying custom certificate expiry (#169)
- Support for README in download configs (#169)
- Support for Tunnelblick configurations (#169)
- Fix certificate revocation in Ubuntu Precise (#169)
- Use concat for ovpn generation (#176)
2.9.0
This will be the last version of version 2.x with new features.
- Support to send ipv6 routes (#153, #154)
- Support for
nobind
param for server in client mode (#156) - Fixing autostart_all behaviour (#163)
- Add systemd support for Debian >= 8.0 (#161)
- Support for Archlinux (#162)
- Support to enable/disable service management(#158)
- Fix installation for older Redhat based systems (#165)
- Add ability to specify custom options for clients (#167)
2.8.0
- Support for systems without
lsb-release
package (#134) - Support for Amazon EC2 OS (#134)
- Move default log path for status log to
/var/log/openvpn
(#139) - Support for
format
parameter (#138) - Ability to configure autostart management on debian (#144)
- Fix ordering in
/etc/default/openvpn
with puppet future parser (#142 - Support for TLS auth when server acts as client (#147)
- Support for customer server options (#147)
- Allow disabling
ns-cert-type server
for server-clients (#147) - Fix pam plugin path on RedHat/CentOS (#148)
2.7.1
- Fix server in client mode (#137)
2.7.0
- Support for removing a client specific conf file (#115)
- Support for
rcvbuf
andsndbuf
(#116) - Fix RedHat and CentOS package selection (#97)
- Support for TLS and x509-name verification (#118)
- Fix unset client cipher producing invalid configs (#129)
- Support to share a CA between multiple server instances (#112)
- Support for systemd (#127)
2.6.0
- Support for setting
up
and/ordown
scripts for clients (#89) - Fixing the permissions of the created directories and files (#90, #92, #94, #102)
- Refactor templates to use instance variables instead of
scope.lookupvar
(#100) - Add client mode server (#100)
- Move CA management into its own defined type (#100)
- Fix LDAP-Support on Debian Wheezy (#103)
- Support for status-version (#108)
- Change layout of downloadable client config to prevent overriding other client configurations when extracting the tarball (#104)
- Add
ns-cert-type server
for server-clients (#109)
2.5.0
- Do not include deprecated
concat::setup
anymore (#71) - Only warn about pam deprecation if it's used (#72)
- Ability to specify a
down
script (#75) - Support for
client-cert-not-required
in server config (#76) - Support for
auth-retry
in client config (#76) - Support for
setenv
in client config (#79) - Support for
setenv_safe
in client config (#79) - Support for
cipher
in client config (#80) - Support for
push route
in client specific config (#80)
2.4.0
Bugfixes
- Fix Ubuntu Trusty support (#64)
New Features
- Basic support to hand out IPv6 addresses (#66)
- Ability to specify the common name of a server (#65)
- Options for KEY_EXPIRE, CA_EXPIRE, KEY_NAME, KEY_OU, KEY_CN easy-rsa vars. (#58, #70)
- Options for cipher, verb, persist-key, persist-tun server directives. (#58, #70)
Before
- A lot of stuff I don't know anymore :disappointed:
Dependencies
- puppetlabs/concat (>= 1.0.1 <3.0.0)
- puppetlabs/stdlib (>= 1.0.0 <5.0.0)
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