commit e55b4e9da7959de6f90422ae8c34b6db0584e311 Author: Chris Snijder Date: Tue Jul 26 18:41:07 2016 +0200 Initial commit for new LE HAProxy diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..dd78c12 --- /dev/null +++ b/.gitignore @@ -0,0 +1,41 @@ +*.py[co] + +# Packages +*.egg +*.egg-info +dist +build +eggs +parts +bin +var +sdist +develop-eggs +.installed.cfg + +# Installer logs +pip-log.txt + +# Unit test / coverage reports +.coverage +.tox + +# Translations +*.mo + +# Virtualenv +venv +virtualenv +include +lib +local +man +share +Scripts +.Python + +# MacOSX +.DS_Store + +# LE HAProxy dev stuff +working diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..981c46c --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,190 @@ + Copyright 2015 Electronic Frontier Foundation and others + + 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. + + 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 diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..0e79cc7 --- /dev/null +++ b/README.rst @@ -0,0 +1,15 @@ +HAProxy plugin for Certbot +========================== + + + +Contributing +------------ + +You need to create a virtual environment and start it, then install this plugin +as a editable package using Python setuptools. I abstracted this in the +`dev_vars` script, which you should source: + +``` +source dev_vars +``` diff --git a/dev_vars b/dev_vars new file mode 100755 index 0000000..9e4687a --- /dev/null +++ b/dev_vars @@ -0,0 +1,71 @@ +#!/bin/bash +if [[ "${BASH_SOURCE[0]}" == "${0}" ]]; then + echo "ERROR: You need to source this script, not run it." + echo "Please run like this: \`source $0\`" + exit 255 +fi + +VERBOSE=0 +for arg in "$@"; do + if [ "${arg}" = "-v" -o "${arg}" = "--verbose" ]; then + VERBOSE=1 + echo "Verbose mode enabled" + fi +done + +commands_exist () { + DEPS_MISSING=0 + for cmd in $1; do + if ! type "${cmd}" &> /dev/null; then + DEPS_MISSING=1 + echo "Dependency '${cmd}' is not installed." + fi + done + return $DEPS_MISSING +} + +function_defined() { + type "$1" &> /dev/null; +} + +please_install () { + if [ -f /etc/redhat-release ] ; then + PKMGR=$(which yum) + elif [ -f /etc/debian_version ] ; then + PKMGR=$(which apt-get) + fi + echo + echo "Before running this script, please run:" + echo "${PKMGR} install $1" +} + +log () { + if [ $VERBOSE -eq 1 ]; then + echo "$1" + fi +} + +CMDS="virtualenv python2.7 pip" +DEPS="virtualenv python2.7 python-setuptools" + +if [ ! -d "${PWD}/venv/" ]; then + log "Virtual environment is not present." + log "Checking for dependencies." + if ! commands_exist "${CMDS}"; then + log "Missing one or more dependencies." + please_install "${DEPS}" + exit 1 + fi + log "Creating virtual environment." + virtualenv "${PWD}/venv" +fi + +if function_defined deactivate; then + log "Deactivating activated virtual environment." + deactivate +fi + +log "Checking for dependencies." +source "$PWD/venv/bin/activate" + +pip install -e . diff --git a/provisioning_script.sh b/provisioning_script.sh new file mode 100644 index 0000000..e9703b2 --- /dev/null +++ b/provisioning_script.sh @@ -0,0 +1,44 @@ +#!/bin/bash -x +echo "deb http://ftp.debian.org/debian jessie-backports main" >> /etc/apt/sources.list +apt-get update +apt-get upgrade -y +apt-get install -y \ + sudo htop net-tools tcpdump ufw git haproxy\ + openssl ca-certificates \ + python python-setuptools virtualenv +apt-get install -y -t jessie-backports certbot + +ufw allow ssh +ufw allow http +ufw allow https +ufw default deny incoming + +# echo HOSTNAME > /etc/hostname +# hostname -F /etc/hostname + +cat < /etc/systemd/system/letsencrypt.timer +[Unit] +Description=Run Let's Encrypt every 12 hours + +[Timer] +# Time to wait after booting before we run first time +OnBootSec=2min +# Time between running each consecutive time +OnUnitActiveSec=12h +Unit=letsencrypt.service + +[Install] +WantedBy=timers.target +EOF + +cat < /etc/systemd/system/letsencrypt.service +[Unit] +Description=Renew Let's Encrypt Certificate + +[Service] +Type=simple +ExecStart=certbot renew q +EOF + +systemctl start letsencrypt.timer +systemctl enable letsencrypt.timer diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..14a059c --- /dev/null +++ b/setup.py @@ -0,0 +1,79 @@ +import sys + +from setuptools import setup +from setuptools import find_packages + + +certbot_version = '0.9.0.dev0' + +# Please update tox.ini when modifying dependency version requirements +install_requires = [ + 'acme~={0}'.format(certbot_version), + 'certbot~={0}'.format(certbot_version), + # For pkg_resources. >=1.0 so pip resolves it to a version cryptography + # will tolerate; see #2599: + 'setuptools>=1.0', + 'zope.component', + 'zope.interface', +] + +if sys.version_info < (2, 7): + install_requires.append('mock<1.1.0') +else: + install_requires.append('mock') + +docs_extras = [ + 'Sphinx>=1.0', # autodoc_member_order = 'bysource', autodoc_default_flags + 'sphinx_rtd_theme', +] + +long_description = ( + "This is a plugin for Certbot, it enables automatically authenticating " + "domains ans retrieving certificates. It can also restart HAProxy after " + "new certificates are installed. However, it will not configure HAProxy " + "because. HAProxy is unlikely to be used for small/simple setups like what" + " Apache or NGiNX are more likely to be used for. HAProxy configurations " + "vary greatly, any configuration this plugin could define is most likely " + "not applicable in your environment." +) + +setup( + name='certbot-haproxy', + version=certbot_version, + description="HAProxy plugin for Certbot", + long_description=long_description, + url='https://code.greenhost.net/open/certbot-haproxy', + author="Greenhost BV", + author_email='lehaproxy@greenhost.net', + license='Apache License 2.0', + classifiers=[ + 'Development Status :: 3 - Alpha', + 'Environment :: Plugins', + 'Intended Audience :: System Administrators', + 'License :: OSI Approved :: Apache Software License', + 'Operating System :: POSIX :: Linux', + 'Programming Language :: Python', + 'Programming Language :: Python :: 2', + 'Programming Language :: Python :: 2.6', + 'Programming Language :: Python :: 2.7', + 'Topic :: Internet :: WWW/HTTP', + 'Topic :: Security', + 'Topic :: System :: Installation/Setup', + 'Topic :: System :: Networking', + 'Topic :: System :: Systems Administration', + 'Topic :: Utilities', + ], + + packages=find_packages(), + include_package_data=True, + install_requires=install_requires, + extras_require={ + 'docs': docs_extras, + }, + entry_points={ + 'certbot.plugins': [ + 'haproxy = certbot_haproxy.configurator:HAProxyConfigurator', + ], + }, + test_suite='certbot_haproxy', +)