Version information
This version is compatible with:
- Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x, 2017.2.x, 2016.4.x
- Puppet >= 4.10.0 < 7.0.0
- Debian,RedHat
Start using this module
Documentation
Table of Contents
- Overview
- Module Description - What the module does and why it is useful
- Setup - The basics of getting started with hitch
- 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 and configures the Hitch TLS proxy, and adds a define to add domains.
Module Description
This module installs the hitch package, and controls the hitch service and the configuration file.
There is a defined type to add domains with key, certificate, as well as an optional certificate chain and dh parameter. The TLS files are concatenated into one PEM file, and added to the configuration file.
Setup
What hitch affects
- Package "hitch"
- Service "hitch"
- Directory "/etc/hitch"
- Configuration file "/etc/hitch/hitch.conf"
- A PEM file inside /etc/hitch for each domain, with TLS key, certificate, ca certificate chain, and dh parameters.
Setup Requirements
The module requires that the "hitch" package is available in a reachable package repository.
-
If osfamily is RedHat, the module adds the epel-release package with ensure_packages
-
If osfamily is Debian, you are expected to provide a repository containing the "hitch" package.
Beginning with hitch
To start using hitch, you need to include the hitch class, and add at least one hitch::domain.
include ::hitch
hitch::domain { 'example.com':
key_source => '/tmp/key',
cert_source => '/tmp/cert.pem',
}
When configured with this module, hitch will listen by default on all interfaces, port 443/TCP for both IPv4 and IPv6, and forward TCP connections to localhost, port 80.
Usage
When using hitch with varnish or nginx, one can provide information about the connecting client, like the connecting IP Address and port, to varnish by using the PROXY protocol. The backend should be configured with an additional listening port for this protocol.
class { '::hitch':
write_proxy_v2 => 'on',
backend => '[::1]:6086'
}
In case of varnish, add an extra "-a" parameter for a separate listening port:
-a '[::1]:6086,PROXY'
…to have it listen on port 6086, using the PROXY protocol instead of the HTTP protocol.
For more information about the PROXY protocol, see http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt
Reference
class: hitch
This class installs hitch, and manages the service and configuration file. To start, hitch requires at least one hitch::domain.
Parameters
-
frontend: The listening port for hitch. (optional, default is the https port)
-
ciphers: The cipher list used for the encryption. (optional, default is strong ciphers with forward secrecy)
-
backend: The address and port for the backend. (optional, default is the http port on the local host)
-
write_proxy_v2: If set to "on", use the PROXY protocol instead of HTTP for the backend connection. (optional, default "off")
-
package_name: The name of the package to be installed (optional, default is osfamily specific)
-
service_name: The name of the service (optional, default is osfamily specific)
-
file_owner: The owner of the files and directories used to configure hitch. (optional, default "root")
-
config_file: Path to the hitch configuration file (optional, default is "/etc/hitch/hitch.conf")
-
config_root: Path to the root directory of the hitch configuration (optional, default is "/etc/hitch")
-
purge_config_root: If true, remove all unknown files in the config_root (optional, default false)
-
dhparams_file: Path the the dhparams file (optional, default is /etc/hitch/dhparams.pem)
-
dhparams_content: A string containing the default dhparams used in all domain PEM files. (optional. If not set, a dhparams file will be generated on the host.)
-
domains: A hash used to create hitch::domain resources, for use with hiera. (optional, default {})
-
manage_repo: If true, install installs the
epel-releasepackage on Red Hat OS family so Hitch can be installed. (optional, default true on RedHat, otherwise false)
define: hitch::domain
Configure a domain in hitch.conf, and generate the PEM file used to hold all the TLS keys, certificates and parameters.
Parameters
- ensure: set the desired state of the resource. (optional, valid values are absent or present, default is present)
One of key_content and key_source is required.
- key_content: a string containing the TLS key (no default)
- key_source: source to the TLS key, either a file, or a puppet uri (no default)
One of cert_content and cert_source is required.
- cert_content: a string containing the TLS certificate (no default)
- cert_source: source to the TLS certificate, either a file, or a puppet uri (no default)
No more than one of cacert_content and cacert_source must be specified.
- cacert_content: a string containing the ca certificate chain (optional, no default)
- cacert_source: source to the ca certificate chain, either a file, or a puppet uri (optional, no default)
No more than one of dhparams_content and dhparams_source must be specified. If not specified, the dhparams of the hitch class is used instead.
- dhparams_content: a string containing the ca certificate chain (optional, default is the dhparams of the hitch class)
- dhparams_source: source to the ca certificate chain, either a file, or a puppet uri (optional, default is the dhparams of the hitch class)
Limitations
You need to define at least one hitch::domain, or the hitch
service will not start.
Development
Please see CONTRIBUTING.md for contributing to the development of this module.
Changelog
All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
[0.1.5] - 2019-10-22
Fixed
- Fix generation of DH parameters (again).
Added
- Add manage_repo parameter. Defaults to true on RedHat OS family, which will install the "epel-repo" package.
Changed
- Update OS support metadata. Debian 9-10 and RedHat 7-8.
- Updated with PDK 1.14.0
- Depends on Puppet 4.10, puppetlabs/stdlib 4.12.0
- Module defaults are now in Hiera data
- Module parameters use Types for validation
[0.1.4] - 2015-12-18
Fixed
- bugfix: make sure intermediate ca certificates are correctly placed in bundle
- bugfix: make sure dh parameters are created
- bugfix: notify service if pem files change
[0.1.3] - 2015-12-18
Fixed
- bugfix: using multiple pem-files failed. Tests added.
[0.1.2] - 2015-12-18
Fixed
- relax too-strict validation of strings containing keys and certificates
[0.1.1] - 2015-12-11
Fixed
- fix versioned dependency on puppetlabs-stdlib in metadata
- fix documentation errors and nits
[0.1.0] - 2015-12-11
Added
- initial release
Dependencies
- puppetlabs-stdlib (>= 4.12.0 <= 7.0.0)
- puppetlabs-concat (>= 4.0.0 <= 7.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
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.