-
Notifications
You must be signed in to change notification settings - Fork 21
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
SUSE Update Bot
committed
Dec 6, 2024
1 parent
6db7512
commit 0f252a4
Showing
7 changed files
with
181 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,58 @@ | ||
# SPDX-License-Identifier: MIT | ||
|
||
# Copyright (c) 2024 SUSE LLC | ||
|
||
# All modifications and additions to the file contributed by third parties | ||
# remain the property of their copyright owners, unless otherwise agreed | ||
# upon. | ||
|
||
# The content of THIS FILE IS AUTOGENERATED and should not be manually modified. | ||
# It is maintained by the BCI team and generated by | ||
# https://github.com/SUSE/BCI-dockerfile-generator | ||
|
||
# Please submit bugfixes or comments via https://bugs.opensuse.org/ | ||
# You can contact the BCI team via https://github.com/SUSE/bci/discussions | ||
|
||
#!UseOBSRepositories | ||
|
||
#!BuildTag: opensuse/stunnel:%%stunnel_re%%-%RELEASE% | ||
#!BuildTag: opensuse/stunnel:%%stunnel_re%% | ||
#!BuildTag: opensuse/stunnel:5 | ||
#!BuildTag: opensuse/stunnel:latest | ||
|
||
FROM opensuse/bci/bci-micro:latest AS target | ||
FROM opensuse/tumbleweed:latest AS builder | ||
COPY --from=target / /target | ||
|
||
RUN set -euo pipefail; \ | ||
zypper -n --installroot /target --gpg-auto-import-keys install --no-recommends stunnel; \ | ||
zypper -n clean; \ | ||
rm -rf {/target,}/var/log/{alternatives.log,lastlog,tallylog,zypper.log,zypp/history,YaST2} | ||
# sanity check that the version from the tag is equal to the version of stunnel that we expect | ||
RUN set -euo pipefail; \ | ||
[ "$(rpm --root /target -q --qf '%{version}' stunnel | \ | ||
cut -d '.' -f -1)" = "5" ] | ||
FROM opensuse/bci/bci-micro:latest | ||
COPY --from=builder /target / | ||
# Define labels according to https://en.opensuse.org/Building_derived_containers | ||
# labelprefix=org.opensuse.application.stunnel | ||
LABEL org.opencontainers.image.title="openSUSE Tumbleweed Stunnel" | ||
LABEL org.opencontainers.image.description="Stunnel container based on the openSUSE Tumbleweed Base Container Image." | ||
LABEL org.opencontainers.image.version="%%stunnel_re%%" | ||
LABEL org.opencontainers.image.url="https://www.opensuse.org" | ||
LABEL org.opencontainers.image.created="%BUILDTIME%" | ||
LABEL org.opencontainers.image.vendor="openSUSE Project" | ||
LABEL org.opencontainers.image.source="%SOURCEURL%" | ||
LABEL org.opencontainers.image.ref.name="%%stunnel_re%%-%RELEASE%" | ||
LABEL org.opensuse.reference="registry.opensuse.org/opensuse/stunnel:%%stunnel_re%%-%RELEASE%" | ||
LABEL org.openbuildservice.disturl="%DISTURL%" | ||
LABEL org.opensuse.lifecycle-url="https://en.opensuse.org/Lifetime#openSUSE_BCI" | ||
LABEL org.opensuse.release-stage="released" | ||
# endlabelprefix | ||
LABEL io.artifacthub.package.readme-url="https://raw.githubusercontent.com/SUSE/BCI-dockerfile-generator/Tumbleweed/stunnel-image/README.md" | ||
COPY entrypoint.sh /usr/local/bin/ | ||
COPY stunnel.conf /etc/stunnel/stunnel.conf | ||
RUN set -euo pipefail; chmod 0755 /usr/local/bin/entrypoint.sh; chown --recursive stunnel /etc/stunnel | ||
ENTRYPOINT ["/usr/local/bin/entrypoint.sh"] | ||
CMD ["/usr/sbin/stunnel"] | ||
USER stunnel |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,77 @@ | ||
# Stunnel Container Image | ||
|
||
![Redistributable](https://img.shields.io/badge/Redistributable-Yes-green) | ||
|
||
|
||
## Description | ||
|
||
Stunnel is an open-source multi-platform application that provides a universal | ||
TLS/SSL tunneling service. | ||
|
||
|
||
## How to use this image | ||
|
||
By default, the Stunnel container image launches `stunnel` using a minimal | ||
configuration file that specifies the following: | ||
- run in foreground | ||
- load further configuration files from `/etc/stunnel/conf.d` | ||
|
||
Custom configuration files must be placed into the directory | ||
`/etc/stunnel/conf.d`. | ||
|
||
The container entry point configures TLS/SSL automatically by setting the key | ||
and certificate to the values of the environment variables `STUNNEL_KEY` and | ||
`STUNNEL_CERT`. If one of the environment variables is unset, then the | ||
entrypoint defaults to `/etc/stunnel/stunnel.key` for `STUNNEL_KEY` and | ||
`/etc/stunnel/stunnel.pem` for `STUNNEL_CERT`. | ||
|
||
The entrypoint can set up a single service via environment variables, so that the | ||
user doesn't have to write and mount their own configuration file. This can be | ||
specified via the environment variables `STUNNEL_SERVICE_NAME`, `STUNNEL_ACCEPT` and | ||
`STUNNEL_CONNECT`: | ||
|
||
- `STUNNEL_SERVICE_NAME`: name or otherwise unique identifier of the service | ||
(used for documentation purpose only) | ||
|
||
- `STUNNEL_ACCEPT`: address on which new connections should be accepted. It can be | ||
either a hostname and a port number or just a port number (in which case, localhost is | ||
assumed to be the host) | ||
|
||
- `STUNNEL_CONNECT`: address on which the unencrypted service is listening and | ||
to which stunnel connects. It can be either a hostname and port number or just a | ||
port number (in which case, localhost is assumed to be the host) | ||
|
||
|
||
For example, to create an SSL endpoint for a webserver listening on port `8000` | ||
on localhost, run the following command: | ||
|
||
```bash | ||
podman run --rm -d \ | ||
-p 8443:8443 \ | ||
-e STUNNEL_SERVICE_NAME=webserver \ | ||
-e STUNNEL_ACCEPT=0.0.0.0:8443 \ | ||
-e STUNNEL_CONNECT=0.0.0.0:8000 \ | ||
-v=path/to/server.pem:/etc/stunnel/stunnel.pem:Z \ | ||
-v=path/to/server.crt:/etc/stunnel/stunnel.crt:Z \ | ||
registry.opensuse.org/opensuse/stunnel:5 | ||
``` | ||
|
||
|
||
### Pitfalls | ||
|
||
The Stunnel container image is configured to launch `stunnel` as the `stunnel` | ||
user. But by default, files mounted into a running container belong to the `root` user. Set the file permissions of mounted files accordingly, so that | ||
non-owners and non-group members can read them. | ||
|
||
Stunnel's `inetd` mode is not supported in the container image, and it does not ship a package manager for installing any services. | ||
|
||
|
||
## Licensing | ||
|
||
`SPDX-License-Identifier: MIT` | ||
|
||
This documentation and the build recipe are licensed as MIT. | ||
The container itself contains various software components under various open source licenses listed in the associated | ||
Software Bill of Materials (SBOM). | ||
|
||
This image is based on [openSUSE Tumbleweed](https://get.opensuse.org/tumbleweed/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
<services> | ||
<service mode="buildtime" name="docker_label_helper"/> | ||
<service mode="buildtime" name="kiwi_metainfo_helper"/> | ||
<service mode="buildtime" name="replace_using_package_version"> | ||
<param name="file">Dockerfile</param> | ||
<param name="regex">%%stunnel_re%%</param> | ||
<param name="package">stunnel</param> | ||
</service> | ||
</services> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
#!/bin/bash | ||
|
||
set -eo pipefail | ||
|
||
STUNNEL_CERT="${STUNNEL_CERT:-/etc/stunnel/stunnel.pem}" | ||
STUNNEL_KEY="${STUNNEL_KEY:-/etc/stunnel/stunnel.key}" | ||
|
||
if [[ -n ${STUNNEL_DEBUG} ]]; then | ||
echo "debug = ${STUNNEL_DEBUG}" > /etc/stunnel/conf.d/000debug.conf | ||
fi | ||
|
||
conf="/etc/stunnel/conf.d/container-ssl.conf" | ||
echo "cert = ${STUNNEL_CERT}" > $conf | ||
echo "key = ${STUNNEL_KEY}" >> $conf | ||
|
||
|
||
if [[ -n "${STUNNEL_SERVICE_NAME}" ]] && [[ -n "${STUNNEL_ACCEPT}" ]] && [[ -n "${STUNNEL_CONNECT}" ]]; then | ||
conf="/etc/stunnel/conf.d/container.conf" | ||
echo "[${STUNNEL_SERVICE_NAME}]" > $conf | ||
echo "accept = ${STUNNEL_ACCEPT}" >> $conf | ||
echo "connect = ${STUNNEL_CONNECT}" >> $conf | ||
fi | ||
|
||
exec "$@" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
------------------------------------------------------------------- | ||
Fri Dec 06 08:47:49 UTC 2024 - SUSE Update Bot <[email protected]> | ||
|
||
- First version of the Stunnel 5 BCI |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,2 @@ | ||
foreground = yes | ||
include = /etc/stunnel/conf.d |