From 1b5b5a253130d06d1e8d218be0c7801d59e8628f Mon Sep 17 00:00:00 2001 From: Jose Quintana Date: Fri, 22 Mar 2024 01:12:15 +0100 Subject: [PATCH] v0.0.1 --- .gitignore | 12 +++ Dockerfile | 78 +++++++++++++++++++ LICENSE-APACHE | 201 +++++++++++++++++++++++++++++++++++++++++++++++++ LICENSE-MIT | 23 ++++++ Makefile | 9 +++ README.md | 80 ++++++++++++++++++++ entrypoint.sh | 47 ++++++++++++ 7 files changed, 450 insertions(+) create mode 100644 .gitignore create mode 100644 Dockerfile create mode 100644 LICENSE-APACHE create mode 100644 LICENSE-MIT create mode 100644 Makefile create mode 100644 README.md create mode 100755 entrypoint.sh diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..faf9daa --- /dev/null +++ b/.gitignore @@ -0,0 +1,12 @@ +*.~ +**/*.tgz +**/*.gz +**/*.zip +**/*.gzip +**/*.log +**/*.tar +**/*.sql +**/.DS_Store +/*.html +/*.bin +*.env diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..7144354 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,78 @@ +FROM --platform=$BUILDPLATFORM debian:12.5-slim as build + +ARG TARGETPLATFORM +ARG VERSION=0.0.0 +ENV VERSION=${VERSION} + +ARG LEGO_VERSION=4.16.1 +ENV LEGO_VERSION=${LEGO_VERSION} + +RUN set -eux \ + && DEBIAN_FRONTEND=noninteractive apt-get update -qq \ + && DEBIAN_FRONTEND=noninteractive apt-get install -qq -y --no-install-recommends --no-install-suggests \ + ca-certificates \ + curl \ + file \ + tzdata \ + && true + +RUN set -ex \ + && case "$TARGETPLATFORM" in \ + "linux/amd64") target='linux_amd64' ;; \ + "linux/arm64") target='linux_arm64' ;; \ + "linux/386") target='linux_386' ;; \ + "linux/arm/v7") target='linux_armv7' ;; \ + "linux/arm/v6") target='linux_armv6' ;; \ + *) echo >&2 "error: unsupported $TARGETPLATFORM architecture"; exit 1 ;; \ + esac \ + && curl -Lo /tmp/lego.tar.gz \ + "https://github.com/go-acme/lego/releases/download/v${LEGO_VERSION}/lego_v${LEGO_VERSION}_${target}.tar.gz" \ + && tar xzvf /tmp/lego.tar.gz \ + && cp lego /usr/local/bin/ \ + && rm -rf /tmp/lego.tar.gz \ + && chmod +x /usr/local/bin/lego \ + && true + +RUN set -ex \ + && echo "Testing Docker image..." \ + && uname -a \ + && cat /etc/os-release \ + && echo VERSION_NUMBER=$(cat /etc/debian_version) \ + && file /usr/local/bin/lego \ + && lego --version \ + && lego --help \ + && true + +FROM debian:12.5-slim + +ARG VERSION=0.0.0 +ENV VERSION=${VERSION} + +LABEL version="${VERSION}" \ + description="A Let's Encrypt Docker image using Lego CLI client." \ + maintainer="Jose Quintana " + +RUN set -eux \ + && DEBIAN_FRONTEND=noninteractive apt-get update -qq \ + && DEBIAN_FRONTEND=noninteractive apt-get install -qq -y --no-install-recommends --no-install-suggests \ + ca-certificates \ + tzdata \ + # Clean up local repository of retrieved packages and remove the package lists + && apt-get clean \ + && rm -rf /var/lib/apt/lists/* \ + && true + +COPY --from=build /usr/local/bin/lego /usr/local/bin/ +COPY ./entrypoint.sh /usr/local/bin/ + +ENTRYPOINT ["entrypoint.sh"] + +CMD ["lego"] + +# Metadata +LABEL org.opencontainers.image.vendor="Jose Quintana" \ + org.opencontainers.image.url="https://github.com/joseluisq/docker-lets-encrypt" \ + org.opencontainers.image.title="Docker Let's Encrypt" \ + org.opencontainers.image.description="A Let's Encrypt Docker image using Lego CLI client." \ + org.opencontainers.image.version="${VERSION}" \ + org.opencontainers.image.documentation="https://github.com/joseluisq/docker-lets-encrypt" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..16fe87b --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,201 @@ + 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. diff --git a/LICENSE-MIT b/LICENSE-MIT new file mode 100644 index 0000000..31aa793 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..e89dd5b --- /dev/null +++ b/Makefile @@ -0,0 +1,9 @@ +build: + docker build \ + -t joseluisq/docker-lets-encrypt:latest \ + -f Dockerfile . +.PHONY: build + +run: + docker run -it --rm joseluisq/docker-lets-encrypt:latest bash +.PHONY: run diff --git a/README.md b/README.md new file mode 100644 index 0000000..eb82cdf --- /dev/null +++ b/README.md @@ -0,0 +1,80 @@ +# Docker Let's Encrypt + +> A [Let's Encrypt](https://letsencrypt.org/) Docker image using [Lego CLI](https://go-acme.github.io/lego/) client on top of the latest __Debian [12-slim](https://hub.docker.com/_/debian/tags?page=1&name=12-slim)__ ([Bookworm](https://www.debian.org/News/2023/20230610)). + +## Usage + +Run the Docker image + +```sh +# Run Lego CI directly with a particular argument +docker run --rm joseluisq/docker-lets-encrypt -v + +# Or run the Docker image in interactive mode +docker run -it --rm joseluisq/docker-lets-encrypt bash +``` + +Or extend it + +```Dockerfile +FROM joseluisq/docker-lets-encrypt +# your stuff... +``` + +## Environment variables + +The image provides environment variables support for several [Lego CLI](https://go-acme.github.io/lego/usage/cli/) arguments. + +Below are the environment variables supported and their default values. + +### Active environment variables support + +To activate the environment variables support, set `ENV_LEGO_ENABLE=true`. + +- `ENV_LEGO_ENABLE=false` + +### General options + +- `ENV_LEGO_EMAIL` +- `ENV_LEGO_DOMAINS` +- `ENV_LEGO_SERVER` +- `ENV_LEGO_CSR` +- `ENV_LEGO_RUN_HOOK` + +### Challenge types + +- `ENV_LEGO_HTTP=false` +- `ENV_LEGO_DNS` + +### Obtain a new certificate + +By default, the **Lego CLI** `run` subcomand will be executed, which will [obtain a new certificate](https://go-acme.github.io/lego/usage/cli/obtain-a-certificate/). + +### Renew existing certificate + +To [renew a certificate](https://go-acme.github.io/lego/usage/cli/renew-a-certificate/), use the following environment variables instead. + +- `ENV_LEGO_RENEW=false` +- `ENV_LEGO_RENEW_DAYS` + +### Additional arguments + +- `ENV_LEGO_ARGS` + +```sh +docker run --rm joseluisq/docker-lets-encrypt -h +``` + +For more details check out the [Lego CLI](https://go-acme.github.io/lego/usage/cli/) available options. + +## Contributions + +Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in current work by you, as defined in the Apache-2.0 license, shall be dual licensed as described below, without any additional terms or conditions. + +Feel free to send some [Pull request](https://github.com/joseluisq/docker-lets-encrypt/pulls) or file an [issue](https://github.com/joseluisq/docker-lets-encrypt/issues). + +## License + +This work is primarily distributed under the terms of both the [MIT license](LICENSE-MIT) and the [Apache License (Version 2.0)](LICENSE-APACHE). + +© 2024-present [Jose Quintana](https://joseluisq.net) diff --git a/entrypoint.sh b/entrypoint.sh new file mode 100755 index 0000000..d5e3ccb --- /dev/null +++ b/entrypoint.sh @@ -0,0 +1,47 @@ +#!/bin/bash + +# docs: https://go-acme.github.io/lego/usage/cli/ +# Path: /usr/local/bin/entrypoint.sh + +set -e + +# Check if incoming command contains flags +if [ "${1#-}" != "$1" ]; then + set -- lego "$@" +elif [[ -n "$ENV_LEGO_ENABLE" ]] && [[ "$ENV_LEGO_ENABLE" = "true" ]]; then + args="" + op="" + + # Operation types + if [[ -n "$ENV_LEGO_RENEW" ]] && [[ "$ENV_LEGO_RENEW" = "true" ]]; then + op=" renew" + if [[ -n "$ENV_LEGO_RENEW_DAYS" ]]; then + op="$op --days=\"$ENV_LEGO_RENEW_DAYS\"" + fi + else + op=" run" + fi + + # Challenge types + if [[ -n "$ENV_LEGO_HTTP" ]] && [[ "$ENV_LEGO_HTTP" = "true" ]]; then + args="$args --http" + fi + if [[ -n "$ENV_LEGO_DNS" ]]; then + args="$args --dns=\"$ENV_LEGO_DNS\"" + fi + + # General options + if [[ -n "$ENV_LEGO_EMAIL" ]]; then args="$args --email=\"$LEGO_ARG_EMAIL\""; fi + # TODO: add support for a domain list + if [[ -n "$ENV_LEGO_DOMAINS" ]]; then args="$args --domains=\"$ENV_LEGO_DOMAINS\""; fi + if [[ -n "$ENV_LEGO_SERVER" ]]; then args="$args --server=\"$ENV_LEGO_SERVER\""; fi + if [[ -n "$ENV_LEGO_CSR" ]]; then args="$args --csr=\"$ENV_LEGO_CSR\""; fi + if [[ -n "$ENV_LEGO_RUN_HOOK" ]]; then args="$args --run-hook=\"$ENV_LEGO_RUN_HOOK\""; fi + + # Additional arguments + if [[ -n "$ENV_LEGO_ARGS" ]]; then args="$args$ENV_LEGO_ARGS"; fi + + set -- lego "${args}${op}" +fi + +exec "$@"