From f8f340d5525a9281b01afd0e1c4eba06e0486dd5 Mon Sep 17 00:00:00 2001 From: Konstantin Demin Date: Wed, 12 Jun 2024 03:22:03 +0300 Subject: [PATCH] initial commit --- LICENSE | 175 ++++++++++++++++++ README.md | 23 +++ etc/letsencrypt/renewal-hooks/deploy/ocsp | 19 ++ etc/letsencrypt/renewal-hooks/post/angie | 2 + .../angie.service.d/certbot-ocsp-angie.conf | 2 + etc/systemd/system/certbot-ocsp-angie.service | 8 + etc/systemd/system/certbot-ocsp-angie.timer | 10 + etc/systemd/system/certbot.service | 9 + etc/systemd/system/certbot.timer | 10 + usr/local/lib/systemd/certbot-ocsp-angie.sh | 30 +++ usr/local/sbin/certbot | 3 + usr/local/sbin/certbot-full-update | 10 + usr/local/sbin/certbot-ocsp | 62 +++++++ usr/local/sbin/certbot-pycache | 20 ++ usr/local/sbin/certbot-venv | 14 ++ usr/local/sbin/openssl-ocsp | 73 ++++++++ 16 files changed, 470 insertions(+) create mode 100644 LICENSE create mode 100644 README.md create mode 100755 etc/letsencrypt/renewal-hooks/deploy/ocsp create mode 100755 etc/letsencrypt/renewal-hooks/post/angie create mode 100644 etc/systemd/system/angie.service.d/certbot-ocsp-angie.conf create mode 100644 etc/systemd/system/certbot-ocsp-angie.service create mode 100644 etc/systemd/system/certbot-ocsp-angie.timer create mode 100644 etc/systemd/system/certbot.service create mode 100644 etc/systemd/system/certbot.timer create mode 100755 usr/local/lib/systemd/certbot-ocsp-angie.sh create mode 100755 usr/local/sbin/certbot create mode 100755 usr/local/sbin/certbot-full-update create mode 100755 usr/local/sbin/certbot-ocsp create mode 100755 usr/local/sbin/certbot-pycache create mode 100755 usr/local/sbin/certbot-venv create mode 100755 usr/local/sbin/openssl-ocsp diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..67db858 --- /dev/null +++ b/LICENSE @@ -0,0 +1,175 @@ + + 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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..40d94d0 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# [PoC] Certbot + Angie + +## goals + +- improve Angie support [ssl_stapling_file](https://angie.software/en/configuration/modules/http_ssl/#ssl-stapling-file) + +## quick start + +```sh +# create venv for Certbot +certbot-venv pip install certbot + +# here goes your certbot configuration +# ref: https://eff-certbot.readthedocs.io/en/stable/intro.html + +# - discover new systemd units +# - enable override for angie.service +systemctl daemon-reload + +# enable new systemd units +systemctl enable certbot{,-ocsp-angie}.{service,timer} +systemctl start certbot{,-ocsp-angie}.timer +``` diff --git a/etc/letsencrypt/renewal-hooks/deploy/ocsp b/etc/letsencrypt/renewal-hooks/deploy/ocsp new file mode 100755 index 0000000..9a6a441 --- /dev/null +++ b/etc/letsencrypt/renewal-hooks/deploy/ocsp @@ -0,0 +1,19 @@ +#!/bin/sh +set -ef + +: "${RENEWED_LINEAGE:?}" +d="${RENEWED_LINEAGE}" + +[ -d "$d" ] || { + env printf '%s: not a directory: %q\n' "$0" "$d" >&2 + exit 1 +} + +chain="$d/chain.pem" +cert="$d/cert.pem" +ocsp="$d/ocsp.der" + +[ -s "${cert}" ] || exit 2 +[ -s "${chain}" ] || exit 3 + +exec openssl-ocsp "${chain}" "${cert}" "${ocsp}" diff --git a/etc/letsencrypt/renewal-hooks/post/angie b/etc/letsencrypt/renewal-hooks/post/angie new file mode 100755 index 0000000..4c0e209 --- /dev/null +++ b/etc/letsencrypt/renewal-hooks/post/angie @@ -0,0 +1,2 @@ +#!/bin/sh +exec systemctl --no-ask-password reload angie.service diff --git a/etc/systemd/system/angie.service.d/certbot-ocsp-angie.conf b/etc/systemd/system/angie.service.d/certbot-ocsp-angie.conf new file mode 100644 index 0000000..0e2e8b9 --- /dev/null +++ b/etc/systemd/system/angie.service.d/certbot-ocsp-angie.conf @@ -0,0 +1,2 @@ +[Service] +ExecStartPre=/usr/local/lib/systemd/certbot-ocsp-angie.sh diff --git a/etc/systemd/system/certbot-ocsp-angie.service b/etc/systemd/system/certbot-ocsp-angie.service new file mode 100644 index 0000000..b316296 --- /dev/null +++ b/etc/systemd/system/certbot-ocsp-angie.service @@ -0,0 +1,8 @@ +[Unit] +Description=Certbot - refresh OCSP responses for Angie +Documentation=https://angie.software/en/configuration/modules/http_ssl/#ssl-stapling-file + +[Service] +Type=oneshot +ExecStart=/usr/local/lib/systemd/certbot-ocsp-angie.sh +PrivateTmp=true diff --git a/etc/systemd/system/certbot-ocsp-angie.timer b/etc/systemd/system/certbot-ocsp-angie.timer new file mode 100644 index 0000000..3f2c27b --- /dev/null +++ b/etc/systemd/system/certbot-ocsp-angie.timer @@ -0,0 +1,10 @@ +[Unit] +Description=Run certbot-ocsp-angie.service twice daily + +[Timer] +OnCalendar=*-*-* 06,18:00:00 +RandomizedDelaySec=3600 +Persistent=true + +[Install] +WantedBy=timers.target diff --git a/etc/systemd/system/certbot.service b/etc/systemd/system/certbot.service new file mode 100644 index 0000000..7a7abe8 --- /dev/null +++ b/etc/systemd/system/certbot.service @@ -0,0 +1,9 @@ +[Unit] +Description=Certbot +Documentation=file:///usr/share/doc/python-certbot-doc/html/index.html +Documentation=https://certbot.eff.org/docs + +[Service] +Type=oneshot +ExecStart=/usr/local/sbin/certbot -q renew --no-random-sleep-on-renew +PrivateTmp=true diff --git a/etc/systemd/system/certbot.timer b/etc/systemd/system/certbot.timer new file mode 100644 index 0000000..050af30 --- /dev/null +++ b/etc/systemd/system/certbot.timer @@ -0,0 +1,10 @@ +[Unit] +Description=Run certbot.service twice daily + +[Timer] +OnCalendar=*-*-* 00,12:00:00 +RandomizedDelaySec=3600 +Persistent=true + +[Install] +WantedBy=timers.target diff --git a/usr/local/lib/systemd/certbot-ocsp-angie.sh b/usr/local/lib/systemd/certbot-ocsp-angie.sh new file mode 100755 index 0000000..fba3e5e --- /dev/null +++ b/usr/local/lib/systemd/certbot-ocsp-angie.sh @@ -0,0 +1,30 @@ +#!/bin/sh +# SPDX-License-Identifier: Apache-2.0 +# (c) 2024, Konstantin Demin + +set -ef + +reload_angie= +while read -r certdir ; do + [ -n "${certdir}" ] || continue + + chain="${certdir}/chain.pem" + cert="${certdir}/cert.pem" + ocsp="${certdir}/ocsp.der" + + [ -s "${cert}" ] || continue + [ -s "${chain}" ] || continue + + if certbot-ocsp "${chain}" "${cert}" "${ocsp}" ; then + reload_angie=1 + fi +done <&2 <<-EOF + # usage: ${0##*/} + EOF + exit "${1:-0}" +} +[ $# != 0 ] || usage + +arg_ok= +while : ; do + [ -n "$1" ] || break + [ -s "$1" ] || break + [ -n "$2" ] || break + [ -s "$2" ] || break + [ -n "$3" ] || break + arg_ok=1 +break ; done +[ -n "${arg_ok}" ] || usage 1 +unset arg_ok + +chain="$1" +cert="$2" +ocsp="$3" + +ossl_ocsp_read() { + openssl ocsp \ + -issuer "$1" -cert "$2" -respin "$3" -resp_text +} + +ossl_ocsp_next_update() { + sed -En '/^\s*[Nn]ext [Uu]pdate:\s*(\S.+\S)\s*$/{s//\1/;p;q}' +} + +need_update=1 +while : ; do + [ -s "${ocsp}" ] || break + ossl_ocsp_read "${chain}" "${cert}" "${ocsp}" >/dev/null || break + + next_update=$(ossl_ocsp_read "${chain}" "${cert}" "${ocsp}.new" 2>/dev/null | ossl_ocsp_next_update) + ts_now=$(date '+%s') + ts_next=$(date -d "${next_update}" '+%s') + + ts_diff=$((ts_next - ts_now)) + [ ${ts_diff} -le ${ocsp_valid_threshold} ] || need_update=0 + + unset next_update ts_now ts_next ts_diff +break ; done + +if [ ${need_update} = 0 ] ; then + env printf '%s: %q has valid and fresh OCSP response\n' "${0##*/}" "${cert}" >&2 + exit 1 +fi + +exec openssl-ocsp "${chain}" "${cert}" "${ocsp}" diff --git a/usr/local/sbin/certbot-pycache b/usr/local/sbin/certbot-pycache new file mode 100755 index 0000000..1a976c2 --- /dev/null +++ b/usr/local/sbin/certbot-pycache @@ -0,0 +1,20 @@ +#!/bin/sh +# SPDX-License-Identifier: Apache-2.0 +# (c) 2024, Konstantin Demin + +set -ef + +[ -n "${VIRTUAL_ENV}" ] || exec certbot-venv "$0" "$@" + +find "${VIRTUAL_ENV}/" -name __pycache__ -exec rm -rf {} + +find "${VIRTUAL_ENV}/" -name '*.pyc' -delete + +j=$(nproc) || j=0 +case "$j" in +[1-4] ) ;; +* ) j=1 ;; +esac +j=$(( j*2 + 1 )) + +unset SOURCE_DATE_EPOCH +"${PYTHON3:-python3}" -m compileall -q -j $j "${VIRTUAL_ENV}" diff --git a/usr/local/sbin/certbot-venv b/usr/local/sbin/certbot-venv new file mode 100755 index 0000000..cd152e6 --- /dev/null +++ b/usr/local/sbin/certbot-venv @@ -0,0 +1,14 @@ +#!/bin/sh +# SPDX-License-Identifier: Apache-2.0 +# (c) 2024, Konstantin Demin + +set -ef + +v=/usr/local/certbot + +[ -d "$v" ] || "${PYTHON3:-python3}" -m venv "$v" + +export VIRTUAL_ENV="$v" +export PATH="$v/bin:${PATH}" + +exec "$@" diff --git a/usr/local/sbin/openssl-ocsp b/usr/local/sbin/openssl-ocsp new file mode 100755 index 0000000..7268118 --- /dev/null +++ b/usr/local/sbin/openssl-ocsp @@ -0,0 +1,73 @@ +#!/bin/sh +# SPDX-License-Identifier: Apache-2.0 +# (c) 2024, Konstantin Demin + +set -ef + +usage() { + cat >&2 <<-EOF + # usage: ${0##*/} + EOF + exit "${1:-0}" +} +[ $# != 0 ] || usage + +arg_ok= +while : ; do + [ -n "$1" ] || break + [ -s "$1" ] || break + [ -n "$2" ] || break + [ -s "$2" ] || break + [ -n "$3" ] || break + arg_ok=1 +break ; done +[ -n "${arg_ok}" ] || usage 1 +unset arg_ok + +chain="$1" +cert="$2" +ocsp="$3" + +ocsp_uri=$(openssl x509 -in "${cert}" -noout -ocsp_uri | head -n 1) +[ -n "${ocsp_uri}" ] || exit 0 + +umask 0077 +t=$(mktemp) ; : "${t:?}" +umask 0022 + +ossl_ocsp_fetch() { + openssl ocsp \ + -timeout 5 -nonce \ + -issuer "$1" -cert "$2" -url "$3" -respout "$4" +} + +ossl_ocsp_read() { + openssl ocsp \ + -issuer "$1" -cert "$2" -respin "$3" -resp_text +} + +for i in $(seq 1 3) ; do + if ossl_ocsp_fetch "${chain}" "${cert}" "${ocsp_uri}" "$t" ; then + break + fi + : > "$t" + sleep 5 +done ; unset i + +if ! [ -s "$t" ] ; then + env printf '%s: unable to fetch OCSP response for %q via %q\n' "${0##*/}" "${cert}" "${ocsp_uri}" >&2 +fi + +resp_ok= +while : ; do + [ -s "$t" ] || break + ossl_ocsp_read "${chain}" "${cert}" "$t" >/dev/null || break + touch "${ocsp}" || break + tee "${ocsp}" < "$t" >/dev/null || break + chmod 0644 "${ocsp}" || : + resp_ok=1 +break ; done + +rm -rf "$t" +[ -n "${resp_ok}" ] || exit 1 +exit 0