openvpn

This module installs, configures and manages the OpenVPN service.

Module Stats

15,969 downloads

7,204 latest version

5.0 quality score

Support the Puppet Community by contributing to this module

You are welcome to contribute to this module by suggesting new features, currency updates, or fixes. Every contribution is valuable to help ensure that the module remains compatible with the latest Puppet versions and continues to meet community needs. Complete the following steps:

Review the module’s contribution guidelines and any licenses. Ensure that your planned contribution aligns with the author’s standards and any legal requirements.
Fork the repository on GitHub, make changes on a branch of your fork, and submit a pull request. The pull request must clearly document your proposed change.

For questions about updating the module, contact the module’s author.

Version information

released Nov 30th 2016

This version is compatible with:

Puppet Enterprise >= 3.2.0
Puppet >= 3.2.0
,

Start using this module

Installation method

Add this module to your Puppetfile:

mod 'dhoppe-openvpn', '0.3.3'

Learn more about managing modules with a Puppetfile

Add this module to your Bolt project:

bolt module add dhoppe-openvpn

Learn more about using this module with an existing project

Manually install this module globally with Puppet module tool:

puppet module install dhoppe-openvpn --version 0.3.3

Tags: openvpn

Documentation

dhoppe/openvpn — version 0.3.3 Nov 30th 2016

openvpn

Overview
Module Description - What the module does and why it is useful
Setup - The basics of getting started with openvpn
Usage - Configuration options and additional functionality
Reference - An under-the-hood peek at what the module is doing and how
Limitations - OS compatibility, etc.
Development - Guide for contributing to the module

Overview

This module installs, configures and manages the OpenVPN service.

Module Description

This module handles installing, configuring and running OpenVPN across a range of operating systems and distributions.

Setup

What openvpn affects

openvpn package.
openvpn configuration file.
openvpn service.

Setup Requirements

Puppet >= 3.0
Facter >= 1.6
Extlib module
Stdlib module

Beginning with openvpn

Install openvpn with the default parameters (No configuration files will be changed).

    class { 'openvpn': }

Install openvpn with the recommended parameters.

    class { 'openvpn':
      config_file_template => 'openvpn/common/etc/openvpn/openvpn.conf.erb',
      config_file_hash     => {
        'openvpn' => {
          config_file_path     => '/etc/default/openvpn',
          config_file_template => 'openvpn/common/etc/default/openvpn.erb',
        },
      },
      key_country          => 'DE',
      key_province         => 'NRW',
      key_city             => 'Muenster',
      server_subnet        => '192.168.57.0 255.255.255.0',
    }

Usage

Update the openvpn package.

    class { 'openvpn':
      package_ensure => 'latest',
    }

Remove the openvpn package.

    class { 'openvpn':
      package_ensure => 'absent',
    }

Purge the openvpn package (All configuration files will be removed).

    class { 'openvpn':
      package_ensure => 'purged',
    }

Deploy the configuration files from source directory.

    class { 'openvpn':
      config_dir_source => 'puppet:///modules/openvpn/common/etc/openvpn',
    }

Deploy the configuration files from source directory (Unmanaged configuration files will be removed).

    class { 'openvpn':
      config_dir_purge  => true,
      config_dir_source => 'puppet:///modules/openvpn/common/etc/openvpn',
    }

Deploy the configuration file from source.

    class { 'openvpn':
      config_file_source => 'puppet:///modules/openvpn/common/etc/openvpn/openvpn.conf',
    }

Deploy the configuration file from string.

    class { 'openvpn':
      config_file_string => '# THIS FILE IS MANAGED BY PUPPET',
    }

Deploy the configuration file from template.

    class { 'openvpn':
      config_file_template => 'openvpn/common/etc/openvpn/openvpn.conf.erb',
    }

Deploy the configuration file from custom template (Additional parameters can be defined).

    class { 'openvpn':
      config_file_template     => 'openvpn/common/etc/openvpn/openvpn.conf.erb',
      config_file_options_hash => {
        'key' => 'value',
      },
    }

Deploy additional configuration files from source, string or template.

    class { 'openvpn':
      config_file_hash => {
        'openvpn.2nd.conf' => {
          config_file_path   => '/etc/openvpn/openvpn.2nd.conf',
          config_file_source => 'puppet:///modules/openvpn/common/etc/openvpn/openvpn.2nd.conf',
        },
        'openvpn.3rd.conf' => {
          config_file_path   => '/etc/openvpn/openvpn.3rd.conf',
          config_file_string => '# THIS FILE IS MANAGED BY PUPPET',
        },
        'openvpn.4th.conf' => {
          config_file_path     => '/etc/openvpn/openvpn.4th.conf',
          config_file_template => 'openvpn/common/etc/openvpn/openvpn.4th.conf.erb',
        },
      },
    }

Disable the openvpn service.

    class { 'openvpn':
      service_ensure => 'stopped',
    }

Reference

Classes

Public Classes

openvpn: Main class, includes all other classes.

Private Classes

openvpn::install: Handles the packages.
openvpn::config: Handles the configuration file.
openvpn::service: Handles the service.

Parameters

`package_ensure`

Determines if the package should be installed. Valid values are 'present', 'latest', 'absent' and 'purged'. Defaults to 'present'.

`package_name`

Determines the name of package to manage. Defaults to 'openvpn'.

`package_list`

Determines if additional packages should be managed. Defaults to 'undef'.

`config_dir_ensure`

Determines if the configuration directory should be present. Valid values are 'absent' and 'directory'. Defaults to 'directory'.

`config_dir_path`

Determines if the configuration directory should be managed. Defaults to '/etc/openvpn'

`config_dir_purge`

Determines if unmanaged configuration files should be removed. Valid values are 'true' and 'false'. Defaults to 'false'.

`config_dir_recurse`

Determines if the configuration directory should be recursively managed. Valid values are 'true' and 'false'. Defaults to 'true'.

`config_dir_source`

Determines the source of a configuration directory. Defaults to 'undef'.

`config_file_ensure`

Determines if the configuration file should be present. Valid values are 'absent' and 'present'. Defaults to 'present'.

`config_file_path`

Determines if the configuration file should be managed. Defaults to '/etc/openvpn/openvpn.conf'

`config_file_owner`

Determines which user should own the configuration file. Defaults to 'root'.

`config_file_group`

Determines which group should own the configuration file. Defaults to 'root'.

`config_file_mode`

Determines the desired permissions mode of the configuration file. Defaults to '0644'.

`config_file_source`

Determines the source of a configuration file. Defaults to 'undef'.

`config_file_string`

Determines the content of a configuration file. Defaults to 'undef'.

`config_file_template`

Determines the content of a configuration file. Defaults to 'undef'.

`config_file_notify`

Determines if the service should be restarted after configuration changes. Defaults to 'Service[openvpn]'.

`config_file_require`

Determines which package a configuration file depends on. Defaults to 'Package[openvpn]'.

`config_file_hash`

Determines which configuration files should be managed via openvpn::define. Defaults to '{}'.

`config_file_options_hash`

Determines which parameters should be passed to an ERB template. Defaults to '{}'.

`service_ensure`

Determines if the service should be running or not. Valid values are 'running' and 'stopped'. Defaults to 'running'.

`service_name`

Determines the name of service to manage. Defaults to 'openvpn'.

`service_enable`

Determines if the service should be enabled at boot. Valid values are 'true' and 'false'. Defaults to 'true'.

`ca_expire`

Determines the number of days to certify the CA certificate for. Defaults to '3650'.

`key_expire`

Determines the number of days to certify the server certificate for. Defaults to '3650'.

`key_size`

Determines the length of SSL keys (in bits) generated by this module. Defaults to '1024'.

`key_country`

Determines the country to be used for the SSL certificate, mandatory for server mode. Defaults to 'undef'.

`key_province`

Determines the province to be used for the SSL certificate, mandatory for server mode. Defaults to 'undef'.

`key_city`

Determines the city to be used for the SSL certificate, mandatory for server mode. Defaults to 'undef'.

`key_organization`

Determines the organization to be used for the SSL certificate, mandatory for server mode. Defaults to "$::domain".

`key_email`

Determines the email to be used for the SSL certificate, mandatory for server mode. Defaults to "admin@${::domain}".

`key_cn`

Determines the value for commonName_default variable in openssl.cnf and KEY_CN in vars. Defaults to ''.

`key_name`

Determines the value for name_default variable in openssl.cnf and KEY_NAME in vars. Defaults to ''.

`key_ou`

Determines the value for organizationalUnitName_default variable in openssl.cnf and KEY_OU in vars. Defaults to ''.

`server_port`

Determines the port the openvpn server service is running on. Defaults to '1194'.

`server_proto`

Determines which IP protocol should be used. Defaults to 'udp'.

`server_dev`

Determines which virtual network device should be used. Defaults to 'tun'.

`server_subnet`

Determines the network to assign client addresses out of. Defaults to 'undef'.

`server_push`

Determines options to push out to the client. For example routes, DNS servers, DNS search domains and many more. Defaults to 'undef'.

`server_compression`

Determines if compression should be enabled. Defaults to 'true'.

`server_user`

Determines if privileges should be dropped to user 'nobody' after startup. Defaults to 'true'.

`server_group`

Determines if privileges should be dropped to group 'nogroup' after startup. Defaults to 'true'.

Parameters within `openvpn::client`

`mute`

Determines the log mute level. Defaults to 'undef'.

`mute_replay_warning`

Determines if duplicate packet warnings should be silenced. Valid values are 'true' and 'false'. Defaults to 'false'.

Limitations

This module has been tested on:

Debian 6/7/8
Ubuntu 12.04/14.04

Development

Bug Report

If you find a bug, have trouble following the documentation or have a question about this module - please create an issue.

Pull Request

If you are able to patch the bug or add the feature yourself - please make a pull request.

Contributors

The list of contributors can be found at: https://github.com/dhoppe/puppet-openvpn/graphs/contributors

2016-11-30 Release 0.3.3

Summary

[Beaker] Add missing dependency for Beaker tests

2016-11-06 Release 0.3.2

Summary

[Rubocop] Fix several Rubocop issues
[Puppet] Fix version of module puppet/extlib

2016-11-06 Release 0.3.1

Summary

[General] Update based on dhoppe/modulesync_config

2016-11-05 Release 0.3.0

Summary

[General] Update based on dhoppe/modulesync_config
[Rubocop] Fix several Rubocop issues
[RSpec] Migrate to rspec-puppet-facts
[Puppet] Use module puppet/extlib instead of local function default_content
[Markdown] Fix several Markdown issues
[Readme] Add missing badges

2016-02-07 Release 0.2.1

Summary

[Travis CI] Fix matrix of tested Puppet and RVM versions (travis-ci/travis-ci #5580)

2016-02-05 Release 0.2.0

Summary

[Puppet] Add support for Puppet Enterprise
[Puppet] Switch to scope syntax of Puppet 3
[RSpec] Update rspec tests for better code coverage
[Puppet Forge] Add statistics for downloads, modules and releases
[Travis CI] Add configuration for coverage reports
[Rubocop] Resolve several rubocop issues
[Travis CI] Update matrix of tested Puppet and RVM versions
[Beaker] Update configuration for beaker
[RSpec] Update configuration for rspec
[Rubocop] Add configuration for rubocop
[RSpec] Add configuration for rspec
[Rake] Update list of rake tasks
[Gem] Update list of required gems
[Git] Update list of ignored files/directories
[Beaker] Update box/box_url because of new point release

2015-08-13 Release 0.1.7

Summary

[Beaker] Update Beaker environment
[RSpec] Update RSpec environment
[Travis CI] Update Travis CI environment
[Puppet Forge] Update license, version requirement

2015-02-25 Release 0.1.6

Summary

[Beaker] Update Beaker environment
[Travis CI] Update Travis CI environment

2015-02-25 Release 0.1.5

Summary

[Beaker] Update Beaker environment
[Puppet] Add support for Debian 8.x (Jessie)

2014-12-11 Release 0.1.4

Summary

[Puppet] Add missing quotes

2014-12-10 Release 0.1.3

Summary

[Puppet] Fix rebuilding .tar.gz and .ovpn
[Puppet] Add support for pushing parameters like route etc.
[Puppet] Fix default parameters and syntax of the .yaml file

2014-12-10 Release 0.1.2

Summary

[Puppet] Change fact for ipaddress

2014-12-10 Release 0.1.1

Summary

[Puppet] Add a custom fact because the value of ipaddress gets messed up if you use Docker
[Puppet] Force rebuilding .tar.gz and .ovpn in case of config changes

2014-12-08 Release 0.1.0

Summary

Generated from https://github.com/dhoppe/puppet-skeleton-standard


                                 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 2014 Dennis Hoppe

   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.

Modules

Discover

Contribute

Puppet

Premium features

Downloads

Resources

About Forge

Getting Started

openvpn

Support the Puppet Community by contributing to this module

Version information

This version is compatible with:

Start using this module

Documentation

openvpn

Table of Contents

Overview

Module Description

Setup

What openvpn affects

Setup Requirements

Beginning with openvpn

Usage

Reference

Classes

Public Classes

Private Classes

Parameters

package_ensure

package_name

package_list

config_dir_ensure

config_dir_path

config_dir_purge

config_dir_recurse

config_dir_source

config_file_ensure

config_file_path

config_file_owner

config_file_group

config_file_mode

config_file_source

config_file_string

config_file_template

config_file_notify

config_file_require

config_file_hash

config_file_options_hash

service_ensure

service_name

service_enable

ca_expire

key_expire

key_size

key_country

key_province

key_city

key_organization

key_email

key_cn

key_name

key_ou

server_port

server_proto

server_dev

server_subnet

server_push

server_compression

server_user

server_group

Parameters within openvpn::client

mute

mute_replay_warning

Limitations

Development

Bug Report

Pull Request

Contributors

2016-11-30 Release 0.3.3

`package_ensure`

`package_name`

`package_list`

`config_dir_ensure`

`config_dir_path`

`config_dir_purge`

`config_dir_recurse`

`config_dir_source`

`config_file_ensure`

`config_file_path`

`config_file_owner`

`config_file_group`

`config_file_mode`

`config_file_source`

`config_file_string`

`config_file_template`

`config_file_notify`

`config_file_require`

`config_file_hash`

`config_file_options_hash`

`service_ensure`

`service_name`

`service_enable`

`ca_expire`

`key_expire`

`key_size`

`key_country`

`key_province`

`key_city`

`key_organization`

`key_email`

`key_cn`

`key_name`

`key_ou`

`server_port`

`server_proto`

`server_dev`

`server_subnet`

`server_push`

`server_compression`

`server_user`

`server_group`

Parameters within `openvpn::client`

`mute`

`mute_replay_warning`