From bfb65b71a9eefa121e1cfa7d3cc3130d08ce9edc Mon Sep 17 00:00:00 2001 From: Bitnami Bot Date: Tue, 20 Feb 2024 16:38:44 +0100 Subject: [PATCH] [bitnami/harbor-portal] Release 2.10.0-debian-12-r6 (#62433) Signed-off-by: Bitnami Containers --- bitnami/harbor-portal/2/debian-12/Dockerfile | 64 ++ .../2/debian-12/config/core/app.conf | 6 + .../2/debian-12/config/core/private_key.pem | 51 ++ .../2/debian-12/config/jobservice/config.yml | 41 ++ .../2/debian-12/config/proxy/nginx.conf | 130 ++++ .../2/debian-12/config/registry/config.yml | 36 + .../2/debian-12/config/registry/passwd | 1 + .../2/debian-12/config/registry/root.crt | 35 + .../2/debian-12/config/registryctl/config.yml | 9 + .../2/debian-12/docker-compose.yml | 117 +++ .../opt/bitnami/.bitnami_components.json | 20 + .../opt/bitnami/licenses/licenses.txt | 2 + .../opt/bitnami/scripts/libbitnami.sh | 53 ++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 141 ++++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 193 +++++ .../prebuildfs/opt/bitnami/scripts/libhook.sh | 18 + .../prebuildfs/opt/bitnami/scripts/liblog.sh | 114 +++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 165 +++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 657 +++++++++++++++++ .../opt/bitnami/scripts/libpersistence.sh | 124 ++++ .../opt/bitnami/scripts/libservice.sh | 496 +++++++++++++ .../opt/bitnami/scripts/libvalidations.sh | 304 ++++++++ .../opt/bitnami/scripts/libversion.sh | 51 ++ .../opt/bitnami/scripts/libwebserver.sh | 476 +++++++++++++ .../prebuildfs/usr/sbin/install_packages | 27 + .../debian-12/prebuildfs/usr/sbin/run-script | 24 + .../conf/bitnami/protect-hidden-files.conf | 4 + .../rootfs/opt/bitnami/nginx/conf/nginx.conf | 60 ++ .../opt/bitnami/scripts/harbor-portal-env.sh | 33 + .../scripts/harbor-portal/entrypoint.sh | 29 + .../scripts/harbor-portal/postunpack.sh | 49 ++ .../bitnami/scripts/harbor-portal/setup.sh | 18 + .../rootfs/opt/bitnami/scripts/libharbor.sh | 492 +++++++++++++ .../rootfs/opt/bitnami/scripts/libnginx.sh | 669 ++++++++++++++++++ .../rootfs/opt/bitnami/scripts/nginx-env.sh | 80 +++ .../app-http-server-block.conf.tpl | 16 + .../app-https-server-block.conf.tpl | 19 + .../bitnami-templates/app-php-prefix.conf.tpl | 10 + .../bitnami-templates/app-prefix.conf.tpl | 9 + .../default-https-server-block.conf | 17 + .../opt/bitnami/scripts/nginx/entrypoint.sh | 28 + .../opt/bitnami/scripts/nginx/postunpack.sh | 74 ++ .../opt/bitnami/scripts/nginx/reload.sh | 20 + .../opt/bitnami/scripts/nginx/restart.sh | 19 + .../rootfs/opt/bitnami/scripts/nginx/run.sh | 20 + .../rootfs/opt/bitnami/scripts/nginx/setup.sh | 45 ++ .../rootfs/opt/bitnami/scripts/nginx/start.sh | 34 + .../opt/bitnami/scripts/nginx/status.sh | 23 + .../rootfs/opt/bitnami/scripts/nginx/stop.sh | 34 + .../harbor-portal/2/debian-12/tags-info.yaml | 5 + 50 files changed, 5162 insertions(+) create mode 100644 bitnami/harbor-portal/2/debian-12/Dockerfile create mode 100644 bitnami/harbor-portal/2/debian-12/config/core/app.conf create mode 100644 bitnami/harbor-portal/2/debian-12/config/core/private_key.pem create mode 100644 bitnami/harbor-portal/2/debian-12/config/jobservice/config.yml create mode 100644 bitnami/harbor-portal/2/debian-12/config/proxy/nginx.conf create mode 100644 bitnami/harbor-portal/2/debian-12/config/registry/config.yml create mode 100644 bitnami/harbor-portal/2/debian-12/config/registry/passwd create mode 100644 bitnami/harbor-portal/2/debian-12/config/registry/root.crt create mode 100644 bitnami/harbor-portal/2/debian-12/config/registryctl/config.yml create mode 100644 bitnami/harbor-portal/2/debian-12/docker-compose.yml create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh create mode 100755 bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/install_packages create mode 100755 bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/run-script create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/bitnami/protect-hidden-files.conf create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/nginx.conf create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal-env.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/entrypoint.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/postunpack.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/setup.sh create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libharbor.sh create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libnginx.sh create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx-env.sh create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-http-server-block.conf.tpl create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-https-server-block.conf.tpl create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-php-prefix.conf.tpl create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-prefix.conf.tpl create mode 100644 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/default-https-server-block.conf create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/entrypoint.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/postunpack.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/reload.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/restart.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/run.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/setup.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/start.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/status.sh create mode 100755 bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/stop.sh create mode 100644 bitnami/harbor-portal/2/debian-12/tags-info.yaml diff --git a/bitnami/harbor-portal/2/debian-12/Dockerfile b/bitnami/harbor-portal/2/debian-12/Dockerfile new file mode 100644 index 000000000000..1f37e066e885 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/Dockerfile @@ -0,0 +1,64 @@ +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +FROM docker.io/bitnami/minideb:bookworm + +ARG TARGETARCH + +LABEL com.vmware.cp.artifact.flavor="sha256:c50c90cfd9d12b445b011e6ad529f1ad3daea45c26d20b00732fae3cd71f6a83" \ + org.opencontainers.image.base.name="docker.io/bitnami/minideb:bookworm" \ + org.opencontainers.image.created="2024-02-11T02:06:56Z" \ + org.opencontainers.image.description="Application packaged by VMware, Inc" \ + org.opencontainers.image.licenses="Apache-2.0" \ + org.opencontainers.image.ref.name="2.10.0-debian-12-r6" \ + org.opencontainers.image.title="harbor-portal" \ + org.opencontainers.image.vendor="VMware, Inc." \ + org.opencontainers.image.version="2.10.0" + +ENV HOME="/" \ + OS_ARCH="${TARGETARCH:-amd64}" \ + OS_FLAVOUR="debian-12" \ + OS_NAME="linux" + +COPY prebuildfs / +SHELL ["/bin/bash", "-o", "errexit", "-o", "nounset", "-o", "pipefail", "-c"] +# Install required system packages and dependencies +RUN install_packages ca-certificates curl libcrypt1 libgeoip1 libpcre3 libssl3 openssl procps zlib1g +RUN mkdir -p /tmp/bitnami/pkg/cache/ ; cd /tmp/bitnami/pkg/cache/ ; \ + COMPONENTS=( \ + "render-template-1.0.6-7-linux-${OS_ARCH}-debian-12" \ + "nginx-1.25.3-4-linux-${OS_ARCH}-debian-12" \ + "harbor-2.10.0-2-linux-${OS_ARCH}-debian-12" \ + ) ; \ + for COMPONENT in "${COMPONENTS[@]}"; do \ + if [ ! -f "${COMPONENT}.tar.gz" ]; then \ + curl -SsLf "https://downloads.bitnami.com/files/stacksmith/${COMPONENT}.tar.gz" -O ; \ + curl -SsLf "https://downloads.bitnami.com/files/stacksmith/${COMPONENT}.tar.gz.sha256" -O ; \ + fi ; \ + sha256sum -c "${COMPONENT}.tar.gz.sha256" ; \ + tar -zxf "${COMPONENT}.tar.gz" -C /opt/bitnami --strip-components=2 --no-same-owner --wildcards '*/files' ; \ + rm -rf "${COMPONENT}".tar.gz{,.sha256} ; \ + done +RUN apt-get autoremove --purge -y curl && \ + apt-get update && apt-get upgrade -y && \ + apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives +RUN chmod g+rwX /opt/bitnami +RUN find / -perm /6000 -type f -exec chmod a-s {} \; || true +RUN ln -sf /dev/stdout /opt/bitnami/nginx/logs/access.log +RUN ln -sf /dev/stderr /opt/bitnami/nginx/logs/error.log + +COPY rootfs / +RUN /opt/bitnami/scripts/nginx/postunpack.sh +RUN /opt/bitnami/scripts/harbor-portal/postunpack.sh +ENV APP_VERSION="2.10.0" \ + BITNAMI_APP_NAME="harbor-portal" \ + NGINX_HTTPS_PORT_NUMBER="" \ + NGINX_HTTP_PORT_NUMBER="" \ + PATH="/opt/bitnami/common/bin:/opt/bitnami/nginx/sbin:$PATH" + +EXPOSE 8080 8443 + +WORKDIR /opt/bitnami/harbor +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/harbor-portal/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/nginx/run.sh" ] diff --git a/bitnami/harbor-portal/2/debian-12/config/core/app.conf b/bitnami/harbor-portal/2/debian-12/config/core/app.conf new file mode 100644 index 000000000000..6110364ca044 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/core/app.conf @@ -0,0 +1,6 @@ +appname = Harbor +runmode = dev +enablegzip = true + +[dev] +httpport = 8080 diff --git a/bitnami/harbor-portal/2/debian-12/config/core/private_key.pem b/bitnami/harbor-portal/2/debian-12/config/core/private_key.pem new file mode 100644 index 000000000000..d2dc85dd1c0c --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/core/private_key.pem @@ -0,0 +1,51 @@ +-----BEGIN RSA PRIVATE KEY----- +MIIJKAIBAAKCAgEAtpMvyv153iSmwm6TrFpUOzsIGBEDbGtOOEZMEm08D8IC2n1G +d6/XOZ5FxPAD6gIpE0EAcMojY5O0Hl4CDoyV3e/iKcBqFOgYtpogNtan7yT5J8gw +KsPbU/8nBkK75GOq56nfvq4t9GVAclIDtHbuvmlh6O2n+fxtR0M9LbuotbSBdXYU +hzXqiSsMclBvLyIk/z327VP5l0nUNOzPuKIwQjuxYKDkvq1oGy98oVlE6wl0ldh2 +ZYZLGAYbVhqBVUT1Un/PYqi9Nofa2RI5n1WOkUJQp87vb+PUPFhVOdvH/oAzV6/b +9dzyhA5paDM06lj2gsg9hQWxCgbFh1x39c6pSI8hmVe6x2d4tAtSyOm3Qwz+zO2l +bPDvkY8Svh5nxUYObrNreoO8wHr8MC6TGUQLnUt/RfdVKe5fYPFl6VYqJP/L3LDn +Xj771nFq6PKiYbhBwJw3TM49gpKNS/Of70TP2m7nVlyuyMdE5T1j3xyXNkixXqqn +JuSMqX/3Bmm0On9KEbemwn7KRYF/bqc50+RcGUdKNcOkN6vuMVZei4GbxALnVqac +s+/UQAiQP4212UO7iZFwMaCNJ3r/b4GOlyalI1yEA4odoZov7k5zVOzHu8O6QmCj +3R5TVOudpGiUh+lumRRpNqxDgjngLljvaWU6ttyIbjnAwCjnJoppZM2lkRkCAwEA +AQKCAgAvsvCPlf2a3fR7Y6xNISRUfS22K+u7DaXX6fXB8qv4afWY45Xfex89vG35 +78L2Bi55C0h0LztjrpkmPeVHq88TtrJduhl88M5UFpxH93jUb9JwZErBQX4xyb2G +UzUHjEqAT89W3+a9rR5TP74cDd59/MZJtp1mIF7keVqochi3sDsKVxkx4hIuWALe +csk5hTApRyUWCBRzRCSe1yfF0wnMpA/JcP+SGXfTcmqbNNlelo/Q/kaga59+3UmT +C0Wy41s8fIvP+MnGT2QLxkkrqYyfwrWTweqoTtuKEIHjpdnwUcoYJKfQ6jKp8aH0 +STyP5UIyFOKNuFjyh6ZfoPbuT1nGW+YKlUnK4hQ9N/GE0oMoecTaHTbqM+psQvbj +6+CG/1ukA5ZTQyogNyuOApArFBQ+RRmVudPKA3JYygIhwctuB2oItsVEOEZMELCn +g2aVFAVXGfGRDXvpa8oxs3Pc6RJEp/3tON6+w7cMCx0lwN/Jk2Ie6RgTzUycT3k6 +MoTQJRoO6/ZHcx3hTut/CfnrWiltyAUZOsefLuLg+Pwf9GHhOycLRI6gHfgSwdIV +S77UbbELWdscVr1EoPIasUm1uYWBBcFRTturRW+GHJ8TZX+mcWSBcWwBhp15LjEl +tJf+9U6lWMOSB2LvT+vFmR0M9q56fo7UeKFIR7mo7/GpiVu5AQKCAQEA6Qs7G9mw +N/JZOSeQO6xIQakC+sKApPyXO58fa7WQzri+l2UrLNp0DEQfZCujqDgwys6OOzR/ +xg8ZKQWVoad08Ind3ZwoJgnLn6QLENOcE6PpWxA/JjnVGP4JrXCYR98cP0sf9jEI +xkR1qT50GbeqU3RDFliI4kGRvbZ8cekzuWppfQcjstSBPdvuxqAcUVmTnTw83nvD +FmBbhlLiEgI3iKtJ97UB7480ivnWnOuusduk7FO4jF3hkrOa+YRidinTCi8JBo0Y +jx4Ci3Y5x6nvwkXhKzXapd7YmPNisUc5xA7/a+W71cyC0IKUwRc/8pYWLL3R3CpR +YiV8gf6gwzOckQKCAQEAyI9CSNoAQH4zpS8B9PF8zILqEEuun8m1f5JB3hQnfWzm +7uz/zg6I0TkcCE0AJVSKPHQm1V9+TRbF9+DiOWHEYYzPmK8h63SIufaWxZPqai4E +PUj6eQWykBUVJ96n6/AW0JHRZ+WrJ5RXBqCLuY7NP6wDhORrCJjBwaGMohNpbKPS +H3QewsoxCh+CEXKdKyy+/yU/f4E89PlHapkW1/bDJ5u7puSD+KvmiDDIXSBncdOO +uFT8n+XH5IwgjdXFSDim15rQ8jD2l2xLcwKboTpx5GeRl8oB1VGm0fUbBn1dvGPG +4WfHGyrp9VNZtP160WoHr+vRVPqvHNkoeAlCfEwQCQKCAQBN1dtzLN0HgqE8TrOE +ysEDdTCykj4nXNoiJr522hi4gsndhQPLolb6NdKKQW0S5Vmekyi8K4e1nhtYMS5N +5MFRCasZtmtOcR0af87WWucZRDjPmniNCunaxBZ1YFLsRl+H4E6Xir8UgY8O7PYY +FNkFsKIrl3x4nU/RHl8oKKyG9Dyxbq4Er6dPAuMYYiezIAkGjjUCVjHNindnQM2T +GDx2IEe/PSydV6ZD+LguhyU88FCAQmI0N7L8rZJIXmgIcWW0VAterceTHYHaFK2t +u1uB9pcDOKSDnA+Z3kiLT2/CxQOYhQ2clgbnH4YRi/Nm0awsW2X5dATklAKm5GXL +bLSRAoIBAQClaNnPQdTBXBR2IN3pSZ2XAkXPKMwdxvtk+phOc6raHA4eceLL7FrU +y9gd1HvRTfcwws8gXcDKDYU62gNaNhMELWEt2QsNqS/2x7Qzwbms1sTyUpUZaSSL +BohLOKyfv4ThgdIGcXoGi6Z2tcRnRqpq4BCK8uR/05TBgN5+8amaS0ZKYLfaCW4G +nlPk1fVgHWhtAChtnYZLuKg494fKmB7+NMfAbmmVlxjrq+gkPkxyqXvk9Vrg+V8y +VIuozu0Fkouv+GRpyw4ldtCHS1hV0eEK8ow2dwmqCMygDxm58X10mYn2b2PcOTl5 +9sNerUw1GNC8O66K+rGgBk4FKgXmg8kZAoIBABBcuisK250fXAfjAWXGqIMs2+Di +vqAdT041SNZEOJSGNFsLJbhd/3TtCLf29PN/YXtnvBmC37rqryTsqjSbx/YT2Jbr +Bk3jOr9JVbmcoSubXl8d/uzf7IGs91qaCgBwPZHgeH+kK13FCLexz+U9zYMZ78fF +/yO82CpoekT+rcl1jzYn43b6gIklHABQU1uCD6MMyMhJ9Op2WmbDk3X+py359jMc ++Cr2zfzdHAIVff2dOV3OL+ZHEWbwtnn3htKUdOmjoTJrciFx0xNZJS5Q7QYHMONj +yPqbajyhopiN01aBQpCSGF1F1uRpWeIjTrAZPbrwLl9YSYXz0AT05QeFEFk= +-----END RSA PRIVATE KEY----- diff --git a/bitnami/harbor-portal/2/debian-12/config/jobservice/config.yml b/bitnami/harbor-portal/2/debian-12/config/jobservice/config.yml new file mode 100644 index 000000000000..a575ce71ffea --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/jobservice/config.yml @@ -0,0 +1,41 @@ +--- +#Protocol used to serve +protocol: "http" + +#Config certification if use 'https' protocol +#https_config: +# cert: "server.crt" +# key: "server.key" + +#Server listening port +port: 8080 + +#Worker pool +worker_pool: + #Worker concurrency + workers: 10 + backend: "redis" + #Additional config if use 'redis' backend + redis_pool: + #redis://[arbitrary_username:password@]ipaddress:port/database_index + redis_url: redis://redis:6379/2 + namespace: "harbor_job_service_namespace" +#Loggers for the running job +job_loggers: + - name: "STD_OUTPUT" # logger backend name, only support "FILE" and "STD_OUTPUT" + level: "INFO" # INFO/DEBUG/WARNING/ERROR/FATAL + - name: "FILE" + level: "INFO" + settings: # Customized settings of logger + base_dir: "/var/log/jobs" + sweeper: + duration: 1 #days + settings: # Customized settings of sweeper + work_dir: "/var/log/jobs" + +#Loggers for the job service +loggers: + - name: "STD_OUTPUT" # Same with above + level: "INFO" +#Admin server endpoint +admin_server: "http://adminserver:8080/" diff --git a/bitnami/harbor-portal/2/debian-12/config/proxy/nginx.conf b/bitnami/harbor-portal/2/debian-12/config/proxy/nginx.conf new file mode 100644 index 000000000000..833c54cf4985 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/proxy/nginx.conf @@ -0,0 +1,130 @@ +worker_processes auto; +error_log "/opt/bitnami/nginx/logs/error.log"; +pid "/opt/bitnami/nginx/tmp/nginx.pid"; + +events { + worker_connections 1024; + use epoll; + multi_accept on; +} + +http { + tcp_nodelay on; + + # this is necessary for us to be able to disable request buffering in all cases + proxy_http_version 1.1; + + upstream core { + server core:8080; + } + + upstream portal { + server portal:8080; + } + + log_format timed_combined '$remote_addr - ' + '"$request" $status $body_bytes_sent ' + '"$http_referer" "$http_user_agent" ' + '$request_time $upstream_response_time $pipe'; + + client_body_temp_path "/opt/bitnami/nginx/tmp/client_body" 1 2; + proxy_temp_path "/opt/bitnami/nginx/tmp/proxy" 1 2; + fastcgi_temp_path "/opt/bitnami/nginx/tmp/fastcgi" 1 2; + scgi_temp_path "/opt/bitnami/nginx/tmp/scgi" 1 2; + uwsgi_temp_path "/opt/bitnami/nginx/tmp/uwsgi" 1 2; + + server { + listen 8080; + server_tokens off; + # disable any limits to avoid HTTP 413 for large image uploads + client_max_body_size 0; + + # costumized location config file can place to /opt/bitnami/nginx/conf with prefix harbor.http. and suffix .conf + include /opt/bitnami/conf/nginx/conf.d/harbor.http.*.conf; + + location / { + proxy_pass http://portal/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # When setting up Harbor behind other proxy, such as an Nginx instance, remove the below line if the proxy already has similar settings. + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_buffering off; + proxy_request_buffering off; + } + + location /c/ { + proxy_pass http://core/c/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # When setting up Harbor behind other proxy, such as an Nginx instance, remove the below line if the proxy already has similar settings. + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_buffering off; + proxy_request_buffering off; + } + + location /api/ { + proxy_pass http://core/api/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # When setting up Harbor behind other proxy, such as an Nginx instance, remove the below line if the proxy already has similar settings. + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_buffering off; + proxy_request_buffering off; + } + + location /chartrepo/ { + proxy_pass http://core/chartrepo/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # When setting up Harbor behind other proxy, such as an Nginx instance, remove the below line if the proxy already has similar settings. + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_buffering off; + proxy_request_buffering off; + } + + location /v1/ { + return 404; + } + + location /v2/ { + proxy_pass http://core/v2/; + proxy_set_header Host $http_host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # When setting up Harbor behind other proxy, such as an Nginx instance, remove the below line if the proxy already has similar settings. + proxy_set_header X-Forwarded-Proto $scheme; + proxy_buffering off; + proxy_request_buffering off; + } + + location /service/ { + proxy_pass http://core/service/; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # When setting up Harbor behind other proxy, such as an Nginx instance, remove the below line if the proxy already has similar settings. + proxy_set_header X-Forwarded-Proto $scheme; + + proxy_buffering off; + proxy_request_buffering off; + } + + location /service/notifications { + return 404; + } + } +} diff --git a/bitnami/harbor-portal/2/debian-12/config/registry/config.yml b/bitnami/harbor-portal/2/debian-12/config/registry/config.yml new file mode 100644 index 000000000000..e4e99a79e55c --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/registry/config.yml @@ -0,0 +1,36 @@ +version: 0.1 +log: + level: info + fields: + service: registry +storage: + cache: + layerinfo: redis + filesystem: + rootdirectory: /storage + maintenance: + uploadpurging: + enabled: false + delete: + enabled: true +redis: + addr: redis:6379 + password: + db: 1 +http: + addr: :5000 + secret: placeholder + debug: + addr: localhost:5001 +auth: + htpasswd: + realm: harbor-registry-basic-realm + path: /etc/registry/passwd +notifications: + endpoints: + - name: harbor + disabled: false + url: http://core:8080/service/notifications + timeout: 3000ms + threshold: 5 + backoff: 1s diff --git a/bitnami/harbor-portal/2/debian-12/config/registry/passwd b/bitnami/harbor-portal/2/debian-12/config/registry/passwd new file mode 100644 index 000000000000..bec5ef97dc00 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/registry/passwd @@ -0,0 +1 @@ +harbor_registry_user:$2y$10$9L4Tc0DJbFFMB6RdSCunrOpTHdwhid4ktBJmLD00bYgqkkGOvll3m \ No newline at end of file diff --git a/bitnami/harbor-portal/2/debian-12/config/registry/root.crt b/bitnami/harbor-portal/2/debian-12/config/registry/root.crt new file mode 100644 index 000000000000..c31b27de66d6 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/registry/root.crt @@ -0,0 +1,35 @@ +-----BEGIN CERTIFICATE----- +MIIGBzCCA++gAwIBAgIJAKB8CNqCxhr7MA0GCSqGSIb3DQEBCwUAMIGZMQswCQYD +VQQGEwJDTjEOMAwGA1UECAwFU3RhdGUxCzAJBgNVBAcMAkNOMRUwEwYDVQQKDAxv +cmdhbml6YXRpb24xHDAaBgNVBAsME29yZ2FuaXphdGlvbmFsIHVuaXQxFDASBgNV +BAMMC2V4YW1wbGUuY29tMSIwIAYJKoZIhvcNAQkBFhNleGFtcGxlQGV4YW1wbGUu +Y29tMB4XDTE2MDUxNjAyNDY1NVoXDTI2MDUxNDAyNDY1NVowgZkxCzAJBgNVBAYT +AkNOMQ4wDAYDVQQIDAVTdGF0ZTELMAkGA1UEBwwCQ04xFTATBgNVBAoMDG9yZ2Fu +aXphdGlvbjEcMBoGA1UECwwTb3JnYW5pemF0aW9uYWwgdW5pdDEUMBIGA1UEAwwL +ZXhhbXBsZS5jb20xIjAgBgkqhkiG9w0BCQEWE2V4YW1wbGVAZXhhbXBsZS5jb20w +ggIiMA0GCSqGSIb3DQEBAQUAA4ICDwAwggIKAoICAQC2ky/K/XneJKbCbpOsWlQ7 +OwgYEQNsa044RkwSbTwPwgLafUZ3r9c5nkXE8APqAikTQQBwyiNjk7QeXgIOjJXd +7+IpwGoU6Bi2miA21qfvJPknyDAqw9tT/ycGQrvkY6rnqd++ri30ZUByUgO0du6+ +aWHo7af5/G1HQz0tu6i1tIF1dhSHNeqJKwxyUG8vIiT/PfbtU/mXSdQ07M+4ojBC +O7FgoOS+rWgbL3yhWUTrCXSV2HZlhksYBhtWGoFVRPVSf89iqL02h9rZEjmfVY6R +QlCnzu9v49Q8WFU528f+gDNXr9v13PKEDmloMzTqWPaCyD2FBbEKBsWHXHf1zqlI +jyGZV7rHZ3i0C1LI6bdDDP7M7aVs8O+RjxK+HmfFRg5us2t6g7zAevwwLpMZRAud +S39F91Up7l9g8WXpViok/8vcsOdePvvWcWro8qJhuEHAnDdMzj2Cko1L85/vRM/a +budWXK7Ix0TlPWPfHJc2SLFeqqcm5Iypf/cGabQ6f0oRt6bCfspFgX9upznT5FwZ +R0o1w6Q3q+4xVl6LgZvEAudWppyz79RACJA/jbXZQ7uJkXAxoI0nev9vgY6XJqUj +XIQDih2hmi/uTnNU7Me7w7pCYKPdHlNU652kaJSH6W6ZFGk2rEOCOeAuWO9pZTq2 +3IhuOcDAKOcmimlkzaWRGQIDAQABo1AwTjAdBgNVHQ4EFgQUPJF++WMsv1OJvf7F +oCew37JTnfQwHwYDVR0jBBgwFoAUPJF++WMsv1OJvf7FoCew37JTnfQwDAYDVR0T +BAUwAwEB/zANBgkqhkiG9w0BAQsFAAOCAgEAb5LvqukMxWd5Zajbh3orfYsXmhWn +UWiwG176+bd3b5xMlG9iLd4vQ11lTZoIhFOfprRQzbizQ8BzR2JBQckpLcy+5hyA +D3M9vLL37OwA0wT6kxFnd6LtlFaH5gG++huw2ts2PDXFz0jqw+0YE/R8ov2+YdaZ +aPSEMunmAuEY1TbYWzz4u6PxycxhQzDQ34ZmJZ34Elvw1NYMfPMGTKp34PsxIcgT +ao5jqb9RMU6JAumfXrOvXRjjl573vX2hgMZzEU6OF2/+uyg95chn6nO1GUQrT2+F +/1xIqfHfFCm8+jujSDgqfBtGI+2C7No+Dq8LEyEINZe6wSQ81+ryt5jy5SZmAsnj +V4OsSIwlpR5fLUwrFStVoUWHEKl1DflkYki/cAC1TL0Om+ldJ219kcOnaXDNaq66 +3I75BvRY7/88MYLl4Fgt7sn05Mn3uNPrCrci8d0R1tlXIcwMdCowIHeZdWHX43f7 +NsVk/7VSOxJ343csgaQc+3WxEFK0tBxGO6GP+Xj0XmdVGLhalVBsEhPjnmx+Yyrn +oMsTA1Yrs88C8ItQn7zuO/30eKNGTnby0gptHiS6sa/c3O083Mpi8y33GPVZDvBl +l9PfSZT8LG7SvpjsdgdNZlyFvTY4vsB+Vd5Howh7gXYPVXdCs4k7HMyo7zvzliZS +ekCw9NGLoNqQqnA= +-----END CERTIFICATE----- diff --git a/bitnami/harbor-portal/2/debian-12/config/registryctl/config.yml b/bitnami/harbor-portal/2/debian-12/config/registryctl/config.yml new file mode 100644 index 000000000000..636f674b072a --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/config/registryctl/config.yml @@ -0,0 +1,9 @@ +--- +protocol: "http" +port: 8080 +log_level: "INFO" +registry_config: "/etc/registry/config.yml" + +#https_config: +# cert: "server.crt" +# key: "server.key" diff --git a/bitnami/harbor-portal/2/debian-12/docker-compose.yml b/bitnami/harbor-portal/2/debian-12/docker-compose.yml new file mode 100644 index 000000000000..917a4a76c30b --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/docker-compose.yml @@ -0,0 +1,117 @@ +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +version: '2' + +services: + registry: + image: docker.io/bitnami/harbor-registry:2 + environment: + - REGISTRY_HTTP_SECRET=CHANGEME + volumes: + - registry_data:/storage + - ./config/registry/:/etc/registry/:ro + registryctl: + image: docker.io/bitnami/harbor-registryctl:2 + environment: + - CORE_SECRET=CHANGEME + - JOBSERVICE_SECRET=CHANGEME + - REGISTRY_HTTP_SECRET=CHANGEME + volumes: + - registry_data:/storage + - ./config/registry/:/etc/registry/:ro + - ./config/registryctl/config.yml:/etc/registryctl/config.yml:ro + postgresql: + image: docker.io/bitnami/postgresql:13 + container_name: harbor-db + environment: + - POSTGRESQL_PASSWORD=bitnami + - POSTGRESQL_DATABASE=registry + volumes: + - postgresql_data:/bitnami/postgresql + core: + image: docker.io/bitnami/harbor-core:2 + container_name: harbor-core + depends_on: + - registry + environment: + - CORE_KEY=change-this-key + - _REDIS_URL_CORE=redis://redis:6379/0 + - SYNC_REGISTRY=false + - CHART_CACHE_DRIVER=redis + - _REDIS_URL_REG=redis://redis:6379/1 + - PORT=8080 + - LOG_LEVEL=info + - EXT_ENDPOINT=http://reg.mydomain.com + - DATABASE_TYPE=postgresql + - REGISTRY_CONTROLLER_URL=http://registryctl:8080 + - POSTGRESQL_HOST=postgresql + - POSTGRESQL_PORT=5432 + - POSTGRESQL_DATABASE=registry + - POSTGRESQL_USERNAME=postgres + - POSTGRESQL_PASSWORD=bitnami + - POSTGRESQL_SSLMODE=disable + - REGISTRY_URL=http://registry:5000 + - TOKEN_SERVICE_URL=http://core:8080/service/token + - HARBOR_ADMIN_PASSWORD=bitnami + - CORE_SECRET=CHANGEME + - JOBSERVICE_SECRET=CHANGEME + - ADMIRAL_URL= + - CORE_URL=http://core:8080 + - JOBSERVICE_URL=http://jobservice:8080 + - REGISTRY_STORAGE_PROVIDER_NAME=filesystem + - REGISTRY_CREDENTIAL_USERNAME=harbor_registry_user + - REGISTRY_CREDENTIAL_PASSWORD=harbor_registry_password + - READ_ONLY=false + - RELOAD_KEY= + volumes: + - core_data:/data + - ./config/core/app.conf:/etc/core/app.conf:ro + - ./config/core/private_key.pem:/etc/core/private_key.pem:ro + portal: + image: docker.io/bitnami/harbor-portal:2 + container_name: harbor-portal + depends_on: + - core + jobservice: + image: docker.io/bitnami/harbor-jobservice:2 + container_name: harbor-jobservice + depends_on: + - redis + - core + environment: + - CORE_SECRET=CHANGEME + - JOBSERVICE_SECRET=CHANGEME + - CORE_URL=http://core:8080 + - REGISTRY_CONTROLLER_URL=http://registryctl:8080 + - REGISTRY_CREDENTIAL_USERNAME=harbor_registry_user + - REGISTRY_CREDENTIAL_PASSWORD=harbor_registry_password + volumes: + - jobservice_data:/var/log/jobs + - ./config/jobservice/config.yml:/etc/jobservice/config.yml:ro + redis: + image: docker.io/bitnami/redis:7.0 + environment: + # ALLOW_EMPTY_PASSWORD is recommended only for development. + - ALLOW_EMPTY_PASSWORD=yes + harbor-nginx: + image: docker.io/bitnami/nginx:1.25 + container_name: nginx + volumes: + - ./config/proxy/nginx.conf:/opt/bitnami/nginx/conf/nginx.conf:ro + ports: + - '80:8080' + depends_on: + - postgresql + - registry + - core + - portal +volumes: + registry_data: + driver: local + core_data: + driver: local + jobservice_data: + driver: local + postgresql_data: + driver: local diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json new file mode 100644 index 000000000000..2460db30cf89 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/.bitnami_components.json @@ -0,0 +1,20 @@ +{ + "harbor": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "2.10.0-2" + }, + "nginx": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "1.25.3-4" + }, + "render-template": { + "arch": "amd64", + "distro": "debian-12", + "type": "NAMI", + "version": "1.0.6-7" + } +} \ No newline at end of file diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..76956b38e82c --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,2 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..3853c789b2ea --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,53 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami custom library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Constants +BOLD='\033[1m' + +# Functions + +######################## +# Print the welcome page +# Globals: +# DISABLE_WELCOME_MESSAGE +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_welcome_page() { + if [[ -z "${DISABLE_WELCOME_MESSAGE:-}" ]]; then + if [[ -n "$BITNAMI_APP_NAME" ]]; then + print_image_welcome_page + fi + fi +} + +######################## +# Print the welcome page for a Bitnami Docker image +# Globals: +# BITNAMI_APP_NAME +# Arguments: +# None +# Returns: +# None +######################### +print_image_welcome_page() { + local github_url="https://github.com/bitnami/containers" + + info "" + info "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + info "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + info "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + info "" +} + diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..63759c777f3b --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,141 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for managing files + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libos.sh + +# Functions + +######################## +# Replace a regex-matching string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# $4 - use POSIX regex. Default: true +# Returns: +# None +######################### +replace_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + local posix_regex=${4:-true} + + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + if [[ $posix_regex = true ]]; then + result="$(sed -E "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + else + result="$(sed "s${del}${match_regex}${del}${substitute_regex}${del}g" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Replace a regex-matching multiline string in a file +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - substitute regex +# Returns: +# None +######################### +replace_in_file_multiline() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local substitute_regex="${3:?substitute regex is required}" + + local result + local -r del=$'\001' # Use a non-printable character as a 'sed' delimiter to avoid issues + result="$(perl -pe "BEGIN{undef $/;} s${del}${match_regex}${del}${substitute_regex}${del}sg" "$filename")" + echo "$result" > "$filename" +} + +######################## +# Remove a line in a file based on a regex +# Arguments: +# $1 - filename +# $2 - match regex +# $3 - use POSIX regex. Default: true +# Returns: +# None +######################### +remove_in_file() { + local filename="${1:?filename is required}" + local match_regex="${2:?match regex is required}" + local posix_regex=${3:-true} + local result + + # We should avoid using 'sed in-place' substitutions + # 1) They are not compatible with files mounted from ConfigMap(s) + # 2) We found incompatibility issues with Debian10 and "in-place" substitutions + if [[ $posix_regex = true ]]; then + result="$(sed -E "/$match_regex/d" "$filename")" + else + result="$(sed "/$match_regex/d" "$filename")" + fi + echo "$result" > "$filename" +} + +######################## +# Appends text after the last line matching a pattern +# Arguments: +# $1 - file +# $2 - match regex +# $3 - contents to add +# Returns: +# None +######################### +append_file_after_last_match() { + local file="${1:?missing file}" + local match_regex="${2:?missing pattern}" + local value="${3:?missing value}" + + # We read the file in reverse, replace the first match (0,/pattern/s) and then reverse the results again + result="$(tac "$file" | sed -E "0,/($match_regex)/s||${value}\n\1|" | tac)" + echo "$result" > "$file" +} + +######################## +# Wait until certain entry is present in a log file +# Arguments: +# $1 - entry to look for +# $2 - log file +# $3 - max retries. Default: 12 +# $4 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +wait_for_log_entry() { + local -r entry="${1:-missing entry}" + local -r log_file="${2:-missing log file}" + local -r retries="${3:-12}" + local -r interval_time="${4:-5}" + local attempt=0 + + check_log_file_for_entry() { + if ! grep -qE "$entry" "$log_file"; then + debug "Entry \"${entry}\" still not present in ${log_file} (attempt $((++attempt))/${retries})" + return 1 + fi + } + debug "Checking that ${log_file} log file contains entry \"${entry}\"" + if retry_while check_log_file_for_entry "$retries" "$interval_time"; then + debug "Found entry \"${entry}\" in ${log_file}" + true + else + error "Could not find entry \"${entry}\" in ${log_file} after ${retries} retries" + debug_execute cat "$log_file" + return 1 + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..96b22f99710c --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,193 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for file system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Ensure a file/directory is owned (user and group) but the given user +# Arguments: +# $1 - filepath +# $2 - owner +# Returns: +# None +######################### +owned_by() { + local path="${1:?path is missing}" + local owner="${2:?owner is missing}" + local group="${3:-}" + + if [[ -n $group ]]; then + chown "$owner":"$group" "$path" + else + chown "$owner":"$owner" "$path" + fi +} + +######################## +# Ensure a directory exists and, optionally, is owned by the given user +# Arguments: +# $1 - directory +# $2 - owner +# Returns: +# None +######################### +ensure_dir_exists() { + local dir="${1:?directory is missing}" + local owner_user="${2:-}" + local owner_group="${3:-}" + + [ -d "${dir}" ] || mkdir -p "${dir}" + if [[ -n $owner_user ]]; then + owned_by "$dir" "$owner_user" "$owner_group" + fi +} + +######################## +# Checks whether a directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_dir_empty() { + local -r path="${1:?missing directory}" + # Calculate real path in order to avoid issues with symlinks + local -r dir="$(realpath "$path")" + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# Checks whether a mounted directory is empty or not +# arguments: +# $1 - directory +# returns: +# boolean +######################### +is_mounted_dir_empty() { + local dir="${1:?missing directory}" + + if is_dir_empty "$dir" || find "$dir" -mindepth 1 -maxdepth 1 -not -name ".snapshot" -not -name "lost+found" -exec false {} +; then + true + else + false + fi +} + +######################## +# Checks whether a file can be written to or not +# arguments: +# $1 - file +# returns: +# boolean +######################### +is_file_writable() { + local file="${1:?missing file}" + local dir + dir="$(dirname "$file")" + + if [[ (-f "$file" && -w "$file") || (! -f "$file" && -d "$dir" && -w "$dir") ]]; then + true + else + false + fi +} + +######################## +# Relativize a path +# arguments: +# $1 - path +# $2 - base +# returns: +# None +######################### +relativize() { + local -r path="${1:?missing path}" + local -r base="${2:?missing base}" + pushd "$base" >/dev/null || exit + realpath -q --no-symlinks --relative-base="$base" "$path" | sed -e 's|^/$|.|' -e 's|^/||' + popd >/dev/null || exit +} + +######################## +# Configure permisions and ownership recursively +# Globals: +# None +# Arguments: +# $1 - paths (as a string). +# Flags: +# -f|--file-mode - mode for directories. +# -d|--dir-mode - mode for files. +# -u|--user - user +# -g|--group - group +# Returns: +# None +######################### +configure_permissions_ownership() { + local -r paths="${1:?paths is missing}" + local dir_mode="" + local file_mode="" + local user="" + local group="" + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -f | --file-mode) + shift + file_mode="${1:?missing mode for files}" + ;; + -d | --dir-mode) + shift + dir_mode="${1:?missing mode for directories}" + ;; + -u | --user) + shift + user="${1:?missing user}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + read -r -a filepaths <<<"$paths" + for p in "${filepaths[@]}"; do + if [[ -e "$p" ]]; then + find -L "$p" -printf "" + if [[ -n $dir_mode ]]; then + find -L "$p" -type d ! -perm "$dir_mode" -print0 | xargs -r -0 chmod "$dir_mode" + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f ! -perm "$file_mode" -print0 | xargs -r -0 chmod "$file_mode" + fi + if [[ -n $user ]] && [[ -n $group ]]; then + find -L "$p" -print0 | xargs -r -0 chown "${user}:${group}" + elif [[ -n $user ]] && [[ -z $group ]]; then + find -L "$p" -print0 | xargs -r -0 chown "${user}" + elif [[ -z $user ]] && [[ -n $group ]]; then + find -L "$p" -print0 | xargs -r -0 chgrp "${group}" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh new file mode 100644 index 000000000000..dadd06149e00 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libhook.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library to use for scripts expected to be used as Kubernetes lifecycle hooks + +# shellcheck disable=SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh + +# Override functions that log to stdout/stderr of the current process, so they print to process 1 +for function_to_override in stderr_print debug_execute; do + # Output is sent to output of process 1 and thus end up in the container log + # The hook output in general isn't saved + eval "$(declare -f "$function_to_override") >/proc/1/fd/1 2>/proc/1/fd/2" +done diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..2a9e76a4d725 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,114 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for logging functions + +# Constants +RESET='\033[0m' +RED='\033[38;5;1m' +GREEN='\033[38;5;2m' +YELLOW='\033[38;5;3m' +MAGENTA='\033[38;5;5m' +CYAN='\033[38;5;6m' + +# Functions + +######################## +# Print to STDERR +# Arguments: +# Message to print +# Returns: +# None +######################### +stderr_print() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_QUIET:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if ! [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + printf "%b\\n" "${*}" >&2 + fi +} + +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +log() { + stderr_print "${CYAN}${MODULE:-} ${MAGENTA}$(date "+%T.%2N ")${RESET}${*}" +} +######################## +# Log an 'info' message +# Arguments: +# Message to log +# Returns: +# None +######################### +info() { + log "${GREEN}INFO ${RESET} ==> ${*}" +} +######################## +# Log message +# Arguments: +# Message to log +# Returns: +# None +######################### +warn() { + log "${YELLOW}WARN ${RESET} ==> ${*}" +} +######################## +# Log an 'error' message +# Arguments: +# Message to log +# Returns: +# None +######################### +error() { + log "${RED}ERROR${RESET} ==> ${*}" +} +######################## +# Log a 'debug' message +# Globals: +# BITNAMI_DEBUG +# Arguments: +# None +# Returns: +# None +######################### +debug() { + # 'is_boolean_yes' is defined in libvalidations.sh, but depends on this file so we cannot source it + local bool="${BITNAMI_DEBUG:-false}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + log "${MAGENTA}DEBUG${RESET} ==> ${*}" + fi +} + +######################## +# Indent a string +# Arguments: +# $1 - string +# $2 - number of indentation characters (default: 4) +# $3 - indentation character (default: " ") +# Returns: +# None +######################### +indent() { + local string="${1:-}" + local num="${2:?missing num}" + local char="${3:-" "}" + # Build the indentation unit string + local indent_unit="" + for ((i = 0; i < num; i++)); do + indent_unit="${indent_unit}${char}" + done + # shellcheck disable=SC2001 + # Complex regex, see https://github.com/koalaman/shellcheck/wiki/SC2001#exceptions + echo "$string" | sed "s/^/${indent_unit}/" +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..b47c69a56825 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,165 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve IP address for a host/domain (i.e. DNS lookup) +# Arguments: +# $1 - Hostname to resolve +# $2 - IP address version (v4, v6), leave empty for resolving to any version +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + local ip_version="${2:-}" + getent "ahosts${ip_version}" "$host" | awk '/STREAM/ {print $1 }' | head -n 1 +} + +######################### +# Wait for a hostname and return the IP +# Arguments: +# $1 - hostname +# $2 - number of retries +# $3 - seconds to wait between retries +# Returns: +# - IP address that corresponds to the hostname +######################### +wait_for_dns_lookup() { + local hostname="${1:?hostname is missing}" + local retries="${2:-5}" + local seconds="${3:-1}" + check_host() { + if [[ $(dns_lookup "$hostname") == "" ]]; then + false + else + true + fi + } + # Wait for the host to be ready + retry_while "check_host ${hostname}" "$retries" "$seconds" + dns_lookup "$hostname" +} + +######################## +# Get machine's IP +# Arguments: +# None +# Returns: +# Machine IP +######################### +get_machine_ip() { + local -a ip_addresses + local hostname + hostname="$(hostname)" + read -r -a ip_addresses <<< "$(dns_lookup "$hostname" | xargs echo)" + if [[ "${#ip_addresses[@]}" -gt 1 ]]; then + warn "Found more than one IP address associated to hostname ${hostname}: ${ip_addresses[*]}, will use ${ip_addresses[0]}" + elif [[ "${#ip_addresses[@]}" -lt 1 ]]; then + error "Could not find any IP address associated to hostname ${hostname}" + exit 1 + fi + echo "${ip_addresses[0]}" +} + +######################## +# Check if the provided argument is a resolved hostname +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_hostname_resolved() { + local -r host="${1:?missing value}" + if [[ -n "$(dns_lookup "$host")" ]]; then + true + else + false + fi +} + +######################## +# Parse URL +# Globals: +# None +# Arguments: +# $1 - uri - String +# $2 - component to obtain. Valid options (scheme, authority, userinfo, host, port, path, query or fragment) - String +# Returns: +# String +parse_uri() { + local uri="${1:?uri is missing}" + local component="${2:?component is missing}" + + # Solution based on https://tools.ietf.org/html/rfc3986#appendix-B with + # additional sub-expressions to split authority into userinfo, host and port + # Credits to Patryk Obara (see https://stackoverflow.com/a/45977232/6694969) + local -r URI_REGEX='^(([^:/?#]+):)?(//((([^@/?#]+)@)?([^:/?#]+)(:([0-9]+))?))?(/([^?#]*))?(\?([^#]*))?(#(.*))?' + # || | ||| | | | | | | | | | + # |2 scheme | ||6 userinfo 7 host | 9 port | 11 rpath | 13 query | 15 fragment + # 1 scheme: | |5 userinfo@ 8 :... 10 path 12 ?... 14 #... + # | 4 authority + # 3 //... + local index=0 + case "$component" in + scheme) + index=2 + ;; + authority) + index=4 + ;; + userinfo) + index=6 + ;; + host) + index=7 + ;; + port) + index=9 + ;; + path) + index=10 + ;; + query) + index=13 + ;; + fragment) + index=14 + ;; + *) + stderr_print "unrecognized component $component" + return 1 + ;; + esac + [[ "$uri" =~ $URI_REGEX ]] && echo "${BASH_REMATCH[${index}]}" +} + +######################## +# Wait for a HTTP connection to succeed +# Globals: +# * +# Arguments: +# $1 - URL to wait for +# $2 - Maximum amount of retries (optional) +# $3 - Time between retries (optional) +# Returns: +# true if the HTTP connection succeeded, false otherwise +######################### +wait_for_http_connection() { + local url="${1:?missing url}" + local retries="${2:-}" + local sleep_time="${3:-}" + if ! retry_while "debug_execute curl --silent ${url}" "$retries" "$sleep_time"; then + error "Could not connect to ${url}" + return 1 + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..c0500acee78d --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,657 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Check if an user exists in the system +# Arguments: +# $1 - user +# Returns: +# Boolean +######################### +user_exists() { + local user="${1:?user is missing}" + id "$user" >/dev/null 2>&1 +} + +######################## +# Check if a group exists in the system +# Arguments: +# $1 - group +# Returns: +# Boolean +######################### +group_exists() { + local group="${1:?group is missing}" + getent group "$group" >/dev/null 2>&1 +} + +######################## +# Create a group in the system if it does not exist already +# Arguments: +# $1 - group +# Flags: +# -i|--gid - the ID for the new group +# -s|--system - Whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + local gid="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --gid) + shift + gid="${1:?missing gid}" + ;; + -s | --system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! group_exists "$group"; then + local -a args=("$group") + if [[ -n "$gid" ]]; then + if group_exists "$gid"; then + error "The GID $gid is already in use." >&2 + return 1 + fi + args+=("--gid" "$gid") + fi + $is_system_user && args+=("--system") + groupadd "${args[@]}" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# Flags: +# -i|--uid - the ID for the new user +# -g|--group - the group the new user should belong to +# -a|--append-groups - comma-separated list of supplemental groups to append to the new user +# -h|--home - the home directory for the new user +# -s|--system - whether to create new user as system user (uid <= 999) +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local uid="" + local group="" + local append_groups="" + local home="" + local is_system_user=false + + # Validate arguments + shift 1 + while [ "$#" -gt 0 ]; do + case "$1" in + -i | --uid) + shift + uid="${1:?missing uid}" + ;; + -g | --group) + shift + group="${1:?missing group}" + ;; + -a | --append-groups) + shift + append_groups="${1:?missing append_groups}" + ;; + -h | --home) + shift + home="${1:?missing home directory}" + ;; + -s | --system) + is_system_user=true + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + if ! user_exists "$user"; then + local -a user_args=("-N" "$user") + if [[ -n "$uid" ]]; then + if user_exists "$uid"; then + error "The UID $uid is already in use." + return 1 + fi + user_args+=("--uid" "$uid") + else + $is_system_user && user_args+=("--system") + fi + useradd "${user_args[@]}" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + local -a group_args=("$group") + $is_system_user && group_args+=("--system") + ensure_group_exists "${group_args[@]}" + usermod -g "$group" "$user" >/dev/null 2>&1 + fi + + if [[ -n "$append_groups" ]]; then + local -a groups + read -ra groups <<<"$(tr ',;' ' ' <<<"$append_groups")" + for group in "${groups[@]}"; do + ensure_group_exists "$group" + usermod -aG "$group" "$user" >/dev/null 2>&1 + done + fi + + if [[ -n "$home" ]]; then + mkdir -p "$home" + usermod -d "$home" "$user" >/dev/null 2>&1 + configure_permissions_ownership "$home" -d "775" -f "664" -u "$user" -g "$group" + fi +} + +######################## +# Check if the script is currently running as root +# Arguments: +# $1 - user +# $2 - group +# Returns: +# Boolean +######################### +am_i_root() { + if [[ "$(id -u)" = "0" ]]; then + true + else + false + fi +} + +######################## +# Print OS metadata +# Arguments: +# $1 - Flag name +# Flags: +# --id - Distro ID +# --version - Distro version +# --branch - Distro branch +# --codename - Distro codename +# --name - Distro name +# --pretty-name - Distro pretty name +# Returns: +# String +######################### +get_os_metadata() { + local -r flag_name="${1:?missing flag}" + # Helper function + get_os_release_metadata() { + local -r env_name="${1:?missing environment variable name}" + ( + . /etc/os-release + echo "${!env_name}" + ) + } + case "$flag_name" in + --id) + get_os_release_metadata ID + ;; + --version) + get_os_release_metadata VERSION_ID + ;; + --branch) + get_os_release_metadata VERSION_ID | sed 's/\..*//' + ;; + --codename) + get_os_release_metadata VERSION_CODENAME + ;; + --name) + get_os_release_metadata NAME + ;; + --pretty-name) + get_os_release_metadata PRETTY_NAME + ;; + *) + error "Unknown flag ${flag_name}" + return 1 + ;; + esac +} + +######################## +# Get total memory available +# Arguments: +# None +# Returns: +# Memory in bytes +######################### +get_total_memory() { + echo $(($(grep MemTotal /proc/meminfo | awk '{print $2}') / 1024)) +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# None +# Flags: +# --memory - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="" + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + --memory) + shift + memory="${1:?missing memory}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + if [[ -z "$memory" ]]; then + debug "Memory was not specified, detecting available memory automatically" + memory="$(get_total_memory)" + fi + sanitized_memory=$(convert_to_mb "$memory") + if [[ "$sanitized_memory" -gt 26000 ]]; then + echo 2xlarge + elif [[ "$sanitized_memory" -gt 13000 ]]; then + echo xlarge + elif [[ "$sanitized_memory" -gt 6000 ]]; then + echo large + elif [[ "$sanitized_memory" -gt 3000 ]]; then + echo medium + elif [[ "$sanitized_memory" -gt 1500 ]]; then + echo small + else + echo micro + fi +} + +######################## +# Get machine size depending on specified memory +# Globals: +# None +# Arguments: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_supported_machine_sizes() { + echo micro small medium large xlarge 2xlarge +} + +######################## +# Convert memory size from string to amount of megabytes (i.e. 2G -> 2048) +# Globals: +# None +# Arguments: +# $1 - memory size +# Returns: +# Result of the conversion +######################### +convert_to_mb() { + local amount="${1:-}" + if [[ $amount =~ ^([0-9]+)(m|M|g|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$unit" = "g" || "$unit" = "G" ]]; then + amount="$((size * 1024))" + else + amount="$size" + fi + fi + echo "$amount" +} + +######################### +# Redirects output to /dev/null if debug mode is disabled +# Globals: +# BITNAMI_DEBUG +# Arguments: +# $@ - Command to execute +# Returns: +# None +######################### +debug_execute() { + if is_boolean_yes "${BITNAMI_DEBUG:-false}"; then + "$@" + else + "$@" >/dev/null 2>&1 + fi +} + +######################## +# Retries a command a given number of times +# Arguments: +# $1 - cmd (as a string) +# $2 - max retries. Default: 12 +# $3 - sleep between retries (in seconds). Default: 5 +# Returns: +# Boolean +######################### +retry_while() { + local cmd="${1:?cmd is missing}" + local retries="${2:-12}" + local sleep_time="${3:-5}" + local return_value=1 + + read -r -a command <<<"$cmd" + for ((i = 1; i <= retries; i += 1)); do + "${command[@]}" && return_value=0 && break + sleep "$sleep_time" + done + return $return_value +} + +######################## +# Generate a random string +# Arguments: +# -t|--type - String type (ascii, alphanumeric, numeric), defaults to ascii +# -c|--count - Number of characters, defaults to 32 +# Arguments: +# None +# Returns: +# None +# Returns: +# String +######################### +generate_random_string() { + local type="ascii" + local count="32" + local filter + local result + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + -t | --type) + shift + type="$1" + ;; + -c | --count) + shift + count="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Validate type + case "$type" in + ascii) + filter="[:print:]" + ;; + numeric) + filter="0-9" + ;; + alphanumeric) + filter="a-zA-Z0-9" + ;; + alphanumeric+special|special+alphanumeric) + # Limit variety of special characters, so there is a higher chance of containing more alphanumeric characters + # Special characters are harder to write, and it could impact the overall UX if most passwords are too complex + filter='a-zA-Z0-9:@.,/+!=' + ;; + *) + echo "Invalid type ${type}" >&2 + return 1 + ;; + esac + # Obtain count + 10 lines from /dev/urandom to ensure that the resulting string has the expected size + # Note there is a very small chance of strings starting with EOL character + # Therefore, the higher amount of lines read, this will happen less frequently + result="$(head -n "$((count + 10))" /dev/urandom | tr -dc "$filter" | head -c "$count")" + echo "$result" +} + +######################## +# Create md5 hash from a string +# Arguments: +# $1 - string +# Returns: +# md5 hash - string +######################### +generate_md5_hash() { + local -r str="${1:?missing input string}" + echo -n "$str" | md5sum | awk '{print $1}' +} + +######################## +# Create sha1 hash from a string +# Arguments: +# $1 - string +# $2 - algorithm - 1 (default), 224, 256, 384, 512 +# Returns: +# sha1 hash - string +######################### +generate_sha_hash() { + local -r str="${1:?missing input string}" + local -r algorithm="${2:-1}" + echo -n "$str" | "sha${algorithm}sum" | awk '{print $1}' +} + +######################## +# Converts a string to its hexadecimal representation +# Arguments: +# $1 - string +# Returns: +# hexadecimal representation of the string +######################### +convert_to_hex() { + local -r str=${1:?missing input string} + local -i iterator + local char + for ((iterator = 0; iterator < ${#str}; iterator++)); do + char=${str:iterator:1} + printf '%x' "'${char}" + done +} + +######################## +# Get boot time +# Globals: +# None +# Arguments: +# None +# Returns: +# Boot time metadata +######################### +get_boot_time() { + stat /proc --format=%Y +} + +######################## +# Get machine ID +# Globals: +# None +# Arguments: +# None +# Returns: +# Machine ID +######################### +get_machine_id() { + local machine_id + if [[ -f /etc/machine-id ]]; then + machine_id="$(cat /etc/machine-id)" + fi + if [[ -z "$machine_id" ]]; then + # Fallback to the boot-time, which will at least ensure a unique ID in the current session + machine_id="$(get_boot_time)" + fi + echo "$machine_id" +} + +######################## +# Get the root partition's disk device ID (e.g. /dev/sda1) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root partition disk ID +######################### +get_disk_device_id() { + local device_id="" + if grep -q ^/dev /proc/mounts; then + device_id="$(grep ^/dev /proc/mounts | awk '$2 == "/" { print $1 }' | tail -1)" + fi + # If it could not be autodetected, fallback to /dev/sda1 as a default + if [[ -z "$device_id" || ! -b "$device_id" ]]; then + device_id="/dev/sda1" + fi + echo "$device_id" +} + +######################## +# Get the root disk device ID (e.g. /dev/sda) +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk ID +######################### +get_root_disk_device_id() { + get_disk_device_id | sed -E 's/p?[0-9]+$//' +} + +######################## +# Get the root disk size in bytes +# Globals: +# None +# Arguments: +# None +# Returns: +# Root disk size in bytes +######################### +get_root_disk_size() { + fdisk -l "$(get_root_disk_device_id)" | grep 'Disk.*bytes' | sed -E 's/.*, ([0-9]+) bytes,.*/\1/' || true +} + +######################## +# Run command as a specific user and group (optional) +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +run_as_user() { + run_chroot "$@" +} + +######################## +# Execute command as a specific user and group (optional), +# replacing the current process image +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Returns: +# Exit code of the specified command +######################### +exec_as_user() { + run_chroot --replace-process "$@" +} + +######################## +# Run a command using chroot +# Arguments: +# $1 - USER(:GROUP) to switch to +# $2..$n - command to execute +# Flags: +# -r | --replace-process - Replace the current process image (optional) +# Returns: +# Exit code of the specified command +######################### +run_chroot() { + local userspec + local user + local homedir + local replace=false + local -r cwd="$(pwd)" + + # Parse and validate flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -r | --replace-process) + replace=true + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + # Parse and validate arguments + if [[ "$#" -lt 2 ]]; then + echo "expected at least 2 arguments" + return 1 + else + userspec=$1 + shift + + # userspec can optionally include the group, so we parse the user + user=$(echo "$userspec" | cut -d':' -f1) + fi + + if ! am_i_root; then + error "Could not switch to '${userspec}': Operation not permitted" + return 1 + fi + + # Get the HOME directory for the user to switch, as chroot does + # not properly update this env and some scripts rely on it + homedir=$(eval echo "~${user}") + if [[ ! -d $homedir ]]; then + homedir="${HOME:-/}" + fi + + # Obtaining value for "$@" indirectly in order to properly support shell parameter expansion + if [[ "$replace" = true ]]; then + exec chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + else + chroot --userspec="$userspec" / bash -c "cd ${cwd}; export HOME=${homedir}; exec \"\$@\"" -- "$@" + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh new file mode 100644 index 000000000000..af6af64d6dd0 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libpersistence.sh @@ -0,0 +1,124 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami persistence library +# Used for bringing persistence capabilities to applications that don't have clear separation of data and logic + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libversion.sh + +# Functions + +######################## +# Persist an application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# $2 - List of app files to persist +# Returns: +# true if all steps succeeded, false otherwise +######################### +persist_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_persist <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Persist the individual files + if [[ "${#files_to_persist[@]}" -le 0 ]]; then + warn "No files are configured to be persisted" + return + fi + pushd "$install_dir" >/dev/null || exit + local file_to_persist_relative file_to_persist_destination file_to_persist_destination_folder + local -r tmp_file="/tmp/perms.acl" + for file_to_persist in "${files_to_persist[@]}"; do + if [[ ! -f "$file_to_persist" && ! -d "$file_to_persist" ]]; then + error "Cannot persist '${file_to_persist}' because it does not exist" + return 1 + fi + file_to_persist_relative="$(relativize "$file_to_persist" "$install_dir")" + file_to_persist_destination="${persist_dir}/${file_to_persist_relative}" + file_to_persist_destination_folder="$(dirname "$file_to_persist_destination")" + # Get original permissions for existing files, which will be applied later + # Exclude the root directory with 'sed', to avoid issues when copying the entirety of it to a volume + getfacl -R "$file_to_persist_relative" | sed -E '/# file: (\..+|[^.])/,$!d' > "$tmp_file" + # Copy directories to the volume + ensure_dir_exists "$file_to_persist_destination_folder" + cp -Lr --preserve=links "$file_to_persist_relative" "$file_to_persist_destination_folder" + # Restore permissions + pushd "$persist_dir" >/dev/null || exit + if am_i_root; then + setfacl --restore="$tmp_file" + else + # When running as non-root, don't change ownership + setfacl --restore=<(grep -E -v '^# (owner|group):' "$tmp_file") + fi + popd >/dev/null || exit + done + popd >/dev/null || exit + rm -f "$tmp_file" + # Install the persisted files into the installation directory, via symlinks + restore_persisted_app "$@" +} + +######################## +# Restore a persisted application directory +# Globals: +# BITNAMI_ROOT_DIR +# BITNAMI_VOLUME_DIR +# FORCE_MAJOR_UPGRADE +# Arguments: +# $1 - App folder name +# $2 - List of app files to restore +# Returns: +# true if all steps succeeded, false otherwise +######################### +restore_persisted_app() { + local -r app="${1:?missing app}" + local -a files_to_restore + read -r -a files_to_restore <<< "$(tr ',;:' ' ' <<< "$2")" + local -r install_dir="${BITNAMI_ROOT_DIR}/${app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + # Restore the individual persisted files + if [[ "${#files_to_restore[@]}" -le 0 ]]; then + warn "No persisted files are configured to be restored" + return + fi + local file_to_restore_relative file_to_restore_origin file_to_restore_destination + for file_to_restore in "${files_to_restore[@]}"; do + file_to_restore_relative="$(relativize "$file_to_restore" "$install_dir")" + # We use 'realpath --no-symlinks' to ensure that the case of '.' is covered and the directory is removed + file_to_restore_origin="$(realpath --no-symlinks "${install_dir}/${file_to_restore_relative}")" + file_to_restore_destination="$(realpath --no-symlinks "${persist_dir}/${file_to_restore_relative}")" + rm -rf "$file_to_restore_origin" + ln -sfn "$file_to_restore_destination" "$file_to_restore_origin" + done +} + +######################## +# Check if an application directory was already persisted +# Globals: +# BITNAMI_VOLUME_DIR +# Arguments: +# $1 - App folder name +# Returns: +# true if all steps succeeded, false otherwise +######################### +is_app_initialized() { + local -r app="${1:?missing app}" + local -r persist_dir="${BITNAMI_VOLUME_DIR}/${app}" + if ! is_mounted_dir_empty "$persist_dir"; then + true + else + false + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..107f54e6b5c9 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,496 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for managing services + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libvalidations.sh +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Read the provided pid file and returns a PID +# Arguments: +# $1 - Pid file +# Returns: +# PID +######################### +get_pid_from_file() { + local pid_file="${1:?pid file is missing}" + + if [[ -f "$pid_file" ]]; then + if [[ -n "$(< "$pid_file")" ]] && [[ "$(< "$pid_file")" -gt 0 ]]; then + echo "$(< "$pid_file")" + fi + fi +} + +######################## +# Check if a provided PID corresponds to a running service +# Arguments: +# $1 - PID +# Returns: +# Boolean +######################### +is_service_running() { + local pid="${1:?pid is missing}" + + kill -0 "$pid" 2>/dev/null +} + +######################## +# Stop a service by sending a termination signal to its pid +# Arguments: +# $1 - Pid file +# $2 - Signal number (optional) +# Returns: +# None +######################### +stop_service_using_pid() { + local pid_file="${1:?pid file is missing}" + local signal="${2:-}" + local pid + + pid="$(get_pid_from_file "$pid_file")" + [[ -z "$pid" ]] || ! is_service_running "$pid" && return + + if [[ -n "$signal" ]]; then + kill "-${signal}" "$pid" + else + kill "$pid" + fi + + local counter=10 + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Start cron daemon +# Arguments: +# None +# Returns: +# true if started correctly, false otherwise +######################### +cron_start() { + if [[ -x "/usr/sbin/cron" ]]; then + /usr/sbin/cron + elif [[ -x "/usr/sbin/crond" ]]; then + /usr/sbin/crond + else + false + fi +} + +######################## +# Generate a cron configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Command +# Flags: +# --run-as - User to run as (default: root) +# --schedule - Cron schedule configuration (default: * * * * *) +# Returns: +# None +######################### +generate_cron_conf() { + local service_name="${1:?service name is missing}" + local cmd="${2:?command is missing}" + local run_as="root" + local schedule="* * * * *" + local clean="true" + + # Parse optional CLI flags + shift 2 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --run-as) + shift + run_as="$1" + ;; + --schedule) + shift + schedule="$1" + ;; + --no-clean) + clean="false" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + mkdir -p /etc/cron.d + if "$clean"; then + cat > "/etc/cron.d/${service_name}" <> /etc/cron.d/"$service_name" + fi +} + +######################## +# Remove a cron configuration file for a given service +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_cron_conf() { + local service_name="${1:?service name is missing}" + local cron_conf_dir="/etc/monit/conf.d" + rm -f "${cron_conf_dir}/${service_name}" +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Flags: +# --disable - Whether to disable the monit configuration +# Returns: +# None +######################### +generate_monit_conf() { + local service_name="${1:?service name is missing}" + local pid_file="${2:?pid file is missing}" + local start_command="${3:?start command is missing}" + local stop_command="${4:?stop command is missing}" + local monit_conf_dir="/etc/monit/conf.d" + local disabled="no" + + # Parse optional CLI flags + shift 4 + while [[ "$#" -gt 0 ]]; do + case "$1" in + --disable) + disabled="yes" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + + is_boolean_yes "$disabled" && conf_suffix=".disabled" + mkdir -p "$monit_conf_dir" + cat > "${monit_conf_dir}/${service_name}.conf${conf_suffix:-}" <&2 + return 1 + ;; + esac + shift + done + + mkdir -p "$logrotate_conf_dir" + cat < "${logrotate_conf_dir}/${service_name}" +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +${log_path} { + ${period} + rotate ${rotations} + dateext + compress + copytruncate + missingok +$(indent "$extra" 2) +} +EOF +} + +######################## +# Remove a logrotate configuration file +# Arguments: +# $1 - Service name +# Returns: +# None +######################### +remove_logrotate_conf() { + local service_name="${1:?service name is missing}" + local logrotate_conf_dir="/etc/logrotate.d" + rm -f "${logrotate_conf_dir}/${service_name}" +} + +######################## +# Generate a Systemd configuration file +# Arguments: +# $1 - Service name +# Flags: +# --custom-service-content - Custom content to add to the [service] block +# --environment - Environment variable to define (multiple --environment options may be passed) +# --environment-file - Text file with environment variables (multiple --environment-file options may be passed) +# --exec-start - Start command (required) +# --exec-start-pre - Pre-start command (optional) +# --exec-start-post - Post-start command (optional) +# --exec-stop - Stop command (optional) +# --exec-reload - Reload command (optional) +# --group - System group to start the service with +# --name - Service full name (e.g. Apache HTTP Server, defaults to $1) +# --restart - When to restart the Systemd service after being stopped (defaults to always) +# --pid-file - Service PID file +# --standard-output - File where to print stdout output +# --standard-error - File where to print stderr output +# --success-exit-status - Exit code that indicates a successful shutdown +# --type - Systemd unit type (defaults to forking) +# --user - System user to start the service with +# --working-directory - Working directory at which to start the service +# Returns: +# None +######################### +generate_systemd_conf() { + local -r service_name="${1:?service name is missing}" + local -r systemd_units_dir="/etc/systemd/system" + local -r service_file="${systemd_units_dir}/bitnami.${service_name}.service" + # Default values + local name="$service_name" + local type="forking" + local user="" + local group="" + local environment="" + local environment_file="" + local exec_start="" + local exec_start_pre="" + local exec_start_post="" + local exec_stop="" + local exec_reload="" + local restart="always" + local pid_file="" + local standard_output="journal" + local standard_error="" + local limits_content="" + local success_exit_status="" + local custom_service_content="" + local working_directory="" + # Parse CLI flags + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --name \ + | --type \ + | --user \ + | --group \ + | --exec-start \ + | --exec-stop \ + | --exec-reload \ + | --restart \ + | --pid-file \ + | --standard-output \ + | --standard-error \ + | --success-exit-status \ + | --custom-service-content \ + | --working-directory \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "$var_name"="${1:?"${var_name} value is missing"}" + ;; + --limit-*) + [[ -n "$limits_content" ]] && limits_content+=$'\n' + var_name="${1//--limit-}" + shift + limits_content+="Limit${var_name^^}=${1:?"--limit-${var_name} value is missing"}" + ;; + --exec-start-pre) + shift + [[ -n "$exec_start_pre" ]] && exec_start_pre+=$'\n' + exec_start_pre+="ExecStartPre=${1:?"--exec-start-pre value is missing"}" + ;; + --exec-start-post) + shift + [[ -n "$exec_start_post" ]] && exec_start_post+=$'\n' + exec_start_post+="ExecStartPost=${1:?"--exec-start-post value is missing"}" + ;; + --environment) + shift + # It is possible to add multiple environment lines + [[ -n "$environment" ]] && environment+=$'\n' + environment+="Environment=${1:?"--environment value is missing"}" + ;; + --environment-file) + shift + # It is possible to add multiple environment-file lines + [[ -n "$environment_file" ]] && environment_file+=$'\n' + environment_file+="EnvironmentFile=${1:?"--environment-file value is missing"}" + ;; + *) + echo "Invalid command line flag ${1}" >&2 + return 1 + ;; + esac + shift + done + # Validate inputs + local error="no" + if [[ -z "$exec_start" ]]; then + error "The --exec-start option is required" + error="yes" + fi + if [[ "$error" != "no" ]]; then + return 1 + fi + # Generate the Systemd unit + cat > "$service_file" <> "$service_file" <<< "WorkingDirectory=${working_directory}" + fi + if [[ -n "$exec_start_pre" ]]; then + # This variable may contain multiple ExecStartPre= directives + cat >> "$service_file" <<< "$exec_start_pre" + fi + if [[ -n "$exec_start" ]]; then + cat >> "$service_file" <<< "ExecStart=${exec_start}" + fi + if [[ -n "$exec_start_post" ]]; then + # This variable may contain multiple ExecStartPost= directives + cat >> "$service_file" <<< "$exec_start_post" + fi + # Optional stop and reload commands + if [[ -n "$exec_stop" ]]; then + cat >> "$service_file" <<< "ExecStop=${exec_stop}" + fi + if [[ -n "$exec_reload" ]]; then + cat >> "$service_file" <<< "ExecReload=${exec_reload}" + fi + # User and group + if [[ -n "$user" ]]; then + cat >> "$service_file" <<< "User=${user}" + fi + if [[ -n "$group" ]]; then + cat >> "$service_file" <<< "Group=${group}" + fi + # PID file allows to determine if the main process is running properly (for Restart=always) + if [[ -n "$pid_file" ]]; then + cat >> "$service_file" <<< "PIDFile=${pid_file}" + fi + if [[ -n "$restart" ]]; then + cat >> "$service_file" <<< "Restart=${restart}" + fi + # Environment flags + if [[ -n "$environment" ]]; then + # This variable may contain multiple Environment= directives + cat >> "$service_file" <<< "$environment" + fi + if [[ -n "$environment_file" ]]; then + # This variable may contain multiple EnvironmentFile= directives + cat >> "$service_file" <<< "$environment_file" + fi + # Logging + if [[ -n "$standard_output" ]]; then + cat >> "$service_file" <<< "StandardOutput=${standard_output}" + fi + if [[ -n "$standard_error" ]]; then + cat >> "$service_file" <<< "StandardError=${standard_error}" + fi + if [[ -n "$custom_service_content" ]]; then + # This variable may contain multiple miscellaneous directives + cat >> "$service_file" <<< "$custom_service_content" + fi + if [[ -n "$success_exit_status" ]]; then + cat >> "$service_file" <> "$service_file" <> "$service_file" <> "$service_file" <= 0 )); then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean or is the string 'yes/true' +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_boolean_yes() { + local -r bool="${1:-}" + # comparison is performed without regard to the case of alphabetic characters + shopt -s nocasematch + if [[ "$bool" = 1 || "$bool" =~ ^(yes|true)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean yes/no value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_yes_no_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(yes|no)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean true/false value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_true_false_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^(true|false)$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is a boolean 1/0 value +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_1_0_value() { + local -r bool="${1:-}" + if [[ "$bool" =~ ^[10]$ ]]; then + true + else + false + fi +} + +######################## +# Check if the provided argument is an empty string or not defined +# Arguments: +# $1 - Value to check +# Returns: +# Boolean +######################### +is_empty_value() { + local -r val="${1:-}" + if [[ -z "$val" ]]; then + true + else + false + fi +} + +######################## +# Validate if the provided argument is a valid port +# Arguments: +# $1 - Port to validate +# Returns: +# Boolean and error message +######################### +validate_port() { + local value + local unprivileged=0 + + # Parse flags + while [[ "$#" -gt 0 ]]; do + case "$1" in + -unprivileged) + unprivileged=1 + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [[ "$#" -gt 1 ]]; then + echo "too many arguments provided" + return 2 + elif [[ "$#" -eq 0 ]]; then + stderr_print "missing port argument" + return 1 + else + value=$1 + fi + + if [[ -z "$value" ]]; then + echo "the value is empty" + return 1 + else + if ! is_int "$value"; then + echo "value is not an integer" + return 2 + elif [[ "$value" -lt 0 ]]; then + echo "negative value provided" + return 2 + elif [[ "$value" -gt 65535 ]]; then + echo "requested port is greater than 65535" + return 2 + elif [[ "$unprivileged" = 1 && "$value" -lt 1024 ]]; then + echo "privileged port requested" + return 3 + fi + fi +} + +######################## +# Validate if the provided argument is a valid IPv6 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv6() { + local ip="${1:?ip is missing}" + local stat=1 + local full_address_regex='^([0-9a-fA-F]{1,4}:){7}[0-9a-fA-F]{1,4}$' + local short_address_regex='^((([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6}::(([0-9a-fA-F]{1,4}:){0,6}[0-9a-fA-F]{1,4}){0,6})$' + + if [[ $ip =~ $full_address_regex || $ip =~ $short_address_regex || $ip == "::" ]]; then + stat=0 + fi + return $stat +} + +######################## +# Validate if the provided argument is a valid IPv4 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ipv4() { + local ip="${1:?ip is missing}" + local stat=1 + + if [[ $ip =~ ^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then + read -r -a ip_array <<< "$(tr '.' ' ' <<< "$ip")" + [[ ${ip_array[0]} -le 255 && ${ip_array[1]} -le 255 \ + && ${ip_array[2]} -le 255 && ${ip_array[3]} -le 255 ]] + stat=$? + fi + return $stat +} + +######################## +# Validate if the provided argument is a valid IPv4 or IPv6 address +# Arguments: +# $1 - IP to validate +# Returns: +# Boolean +######################### +validate_ip() { + local ip="${1:?ip is missing}" + local stat=1 + + if validate_ipv4 "$ip"; then + stat=0 + else + stat=$(validate_ipv6 "$ip") + fi + return $stat +} + +######################## +# Validate a string format +# Arguments: +# $1 - String to validate +# Returns: +# Boolean +######################### +validate_string() { + local string + local min_length=-1 + local max_length=-1 + + # Parse flags + while [ "$#" -gt 0 ]; do + case "$1" in + -min-length) + shift + min_length=${1:-} + ;; + -max-length) + shift + max_length=${1:-} + ;; + --) + shift + break + ;; + -*) + stderr_print "unrecognized flag $1" + return 1 + ;; + *) + break + ;; + esac + shift + done + + if [ "$#" -gt 1 ]; then + stderr_print "too many arguments provided" + return 2 + elif [ "$#" -eq 0 ]; then + stderr_print "missing string" + return 1 + else + string=$1 + fi + + if [[ "$min_length" -ge 0 ]] && [[ "${#string}" -lt "$min_length" ]]; then + echo "string length is less than $min_length" + return 1 + fi + if [[ "$max_length" -ge 0 ]] && [[ "${#string}" -gt "$max_length" ]]; then + echo "string length is great than $max_length" + return 1 + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..6ca71ac7bdbb --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,51 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Library for managing versions strings + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions +######################## +# Gets semantic version +# Arguments: +# $1 - version: string to extract major.minor.patch +# $2 - section: 1 to extract major, 2 to extract minor, 3 to extract patch +# Returns: +# array with the major, minor and release +######################### +get_sematic_version () { + local version="${1:?version is required}" + local section="${2:?section is required}" + local -a version_sections + + #Regex to parse versions: x.y.z + local -r regex='([0-9]+)(\.([0-9]+)(\.([0-9]+))?)?' + + if [[ "$version" =~ $regex ]]; then + local i=1 + local j=1 + local n=${#BASH_REMATCH[*]} + + while [[ $i -lt $n ]]; do + if [[ -n "${BASH_REMATCH[$i]}" ]] && [[ "${BASH_REMATCH[$i]:0:1}" != '.' ]]; then + version_sections[j]="${BASH_REMATCH[$i]}" + ((j++)) + fi + ((i++)) + done + + local number_regex='^[0-9]+$' + if [[ "$section" =~ $number_regex ]] && (( section > 0 )) && (( section <= 3 )); then + echo "${version_sections[$section]}" + return + else + stderr_print "Section allowed values are: 1, 2, and 3" + return 1 + fi + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh new file mode 100644 index 000000000000..8023f9b0549a --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/opt/bitnami/scripts/libwebserver.sh @@ -0,0 +1,476 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami web server handler library + +# shellcheck disable=SC1090,SC1091 + +# Load generic libraries +. /opt/bitnami/scripts/liblog.sh + +######################## +# Execute a command (or list of commands) with the web server environment and library loaded +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_execute() { + local -r web_server="${1:?missing web server}" + shift + # Run program in sub-shell to avoid web server environment getting loaded when not necessary + ( + . "/opt/bitnami/scripts/lib${web_server}.sh" + . "/opt/bitnami/scripts/${web_server}-env.sh" + "$@" + ) +} + +######################## +# Prints the list of enabled web servers +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_list() { + local -r -a supported_web_servers=(apache nginx) + local -a existing_web_servers=() + for web_server in "${supported_web_servers[@]}"; do + [[ -f "/opt/bitnami/scripts/${web_server}-env.sh" ]] && existing_web_servers+=("$web_server") + done + echo "${existing_web_servers[@]:-}" +} + +######################## +# Prints the currently-enabled web server type (only one, in order of preference) +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_type() { + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + echo "${web_servers[0]:-}" +} + +######################## +# Validate that a supported web server is configured +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +web_server_validate() { + local error_code=0 + local supported_web_servers=("apache" "nginx") + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + + if [[ -z "$(web_server_type)" || ! " ${supported_web_servers[*]} " == *" $(web_server_type) "* ]]; then + print_validation_error "Could not detect any supported web servers. It must be one of: ${supported_web_servers[*]}" + elif ! web_server_execute "$(web_server_type)" type -t "is_$(web_server_type)_running" >/dev/null; then + print_validation_error "Could not load the $(web_server_type) web server library from /opt/bitnami/scripts. Check that it exists and is readable." + fi + + return "$error_code" +} + +######################## +# Check whether the web server is running +# Globals: +# * +# Arguments: +# None +# Returns: +# true if the web server is running, false otherwise +######################### +is_web_server_running() { + "is_$(web_server_type)_running" +} + +######################## +# Start web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_start() { + info "Starting $(web_server_type) in background" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl start "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/start.sh" + fi +} + +######################## +# Stop web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_stop() { + info "Stopping $(web_server_type)" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl stop "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/stop.sh" + fi +} + +######################## +# Restart web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_restart() { + info "Restarting $(web_server_type)" + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl restart "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/restart.sh" + fi +} + +######################## +# Reload web server +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_reload() { + if [[ "${BITNAMI_SERVICE_MANAGER:-}" = "systemd" ]]; then + systemctl reload "bitnami.$(web_server_type).service" + else + "${BITNAMI_ROOT_DIR}/scripts/$(web_server_type)/reload.sh" + fi +} + +######################## +# Ensure a web server application configuration exists (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on which configuration template to use +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disable - Whether to render server configurations with a .disabled prefix +# --disable-http - Whether to render the app's HTTP server configuration with a .disabled prefix +# --disable-https - Whether to render the app's HTTPS server configuration with a .disabled prefix +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --document-root - Path to document root directory +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-additional-http-configuration - Additional HTTP vhost configuration (no default) +# --apache-additional-https-configuration - Additional HTTPS vhost configuration (no default) +# --apache-before-vhost-configuration - Configuration to add before the directive (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no' and type is not defined) +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-proxy-address - Address where to proxy requests +# --apache-proxy-configuration - Extra configuration for the proxy +# --apache-proxy-http-configuration - Extra configuration for the proxy HTTP vhost +# --apache-proxy-https-configuration - Extra configuration for the proxy HTTPS vhost +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup (only allowed when type is not defined) +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# --nginx-external-configuration - Configuration external to server block (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_app_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --disable \ + | --disable-http \ + | --disable-https \ + ) + apache_args+=("$1") + nginx_args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --type \ + | --allow-remote-connections \ + | --http-port \ + | --https-port \ + | --document-root \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-additional-http-configuration \ + | --apache-additional-https-configuration \ + | --apache-before-vhost-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-proxy-address \ + | --apache-proxy-configuration \ + | --apache-proxy-http-configuration \ + | --apache-proxy-https-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "${2:?missing value}") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration \ + | --nginx-external-configuration) + nginx_args+=("${1//nginx-/}" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration does not exist anymore (i.e. Apache virtual host format or NGINX server block) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_web_server_app_configuration_not_exists() { + local app="${1:?missing app}" + local -a web_servers + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "ensure_${web_server}_app_configuration_not_exists" "$app" + done +} + +######################## +# Ensure the web server loads the configuration for an application in a URL prefix +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --document-root - Path to document root directory +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --type - Application type, which has an effect on what configuration template will be used +# Apache-specific flags: +# --apache-additional-configuration - Additional vhost configuration (no default) +# --apache-allow-override - Whether to allow .htaccess files (only allowed when --move-htaccess is set to 'no') +# --apache-extra-directory-configuration - Extra configuration for the document root directory +# --apache-move-htaccess - Move .htaccess files to a common place so they can be loaded during Apache startup +# NGINX-specific flags: +# --nginx-additional-configuration - Additional server block configuration (no default) +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_web_server_prefix_configuration_exists() { + local app="${1:?missing app}" + shift + local -a apache_args nginx_args web_servers args_var + apache_args=("$app") + nginx_args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --allow-remote-connections \ + | --document-root \ + | --prefix \ + | --type \ + ) + apache_args+=("$1" "${2:?missing value}") + nginx_args+=("$1" "${2:?missing value}") + shift + ;; + + # Specific Apache flags + --apache-additional-configuration \ + | --apache-allow-override \ + | --apache-extra-directory-configuration \ + | --apache-move-htaccess \ + ) + apache_args+=("${1//apache-/}" "$2") + shift + ;; + + # Specific NGINX flags + --nginx-additional-configuration) + nginx_args+=("${1//nginx-/}" "$2") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + args_var="${web_server}_args[@]" + web_server_execute "$web_server" "ensure_${web_server}_prefix_configuration_exists" "${!args_var}" + done +} + +######################## +# Ensure a web server application configuration is updated with the runtime configuration (i.e. ports) +# It serves as a wrapper for the specific web server function +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Host listen addresses +# --server-name - Server name +# --server-aliases - Server aliases +# --enable-http - Enable HTTP app configuration (if not enabled already) +# --enable-https - Enable HTTPS app configuration (if not enabled already) +# --disable-http - Disable HTTP app configuration (if not disabled already) +# --disable-https - Disable HTTPS app configuration (if not disabled already) +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +web_server_update_app_configuration() { + local app="${1:?missing app}" + shift + local -a args web_servers + args=("$app") + # Validate arguments + while [[ "$#" -gt 0 ]]; do + case "$1" in + # Common flags + --enable-http \ + | --enable-https \ + | --disable-http \ + | --disable-https \ + ) + args+=("$1") + ;; + --hosts \ + | --server-name \ + | --server-aliases \ + | --http-port \ + | --https-port \ + ) + args+=("$1" "${2:?missing value}") + shift + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + read -r -a web_servers <<< "$(web_server_list)" + for web_server in "${web_servers[@]}"; do + web_server_execute "$web_server" "${web_server}_update_app_configuration" "${args[@]}" + done +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_enable_loading_page() { + ensure_web_server_app_configuration_exists "__loading" --hosts "_default_" \ + --apache-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +RedirectMatch 503 ^/$ +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +ErrorDocument 404 /index.html +ErrorDocument 503 /index.html" \ + --nginx-additional-configuration " +# Show a HTTP 503 Service Unavailable page by default +location / { + return 503; +} +# Show index.html if server is answering with 404 Not Found or 503 Service Unavailable status codes +error_page 404 @installing; +error_page 503 @installing; +location @installing { + rewrite ^(.*)$ /index.html break; +}" + web_server_reload +} + +######################## +# Enable loading page, which shows users that the initialization process is not yet completed +# Globals: +# * +# Arguments: +# None +# Returns: +# None +######################### +web_server_disable_install_page() { + ensure_web_server_app_configuration_not_exists "__loading" + web_server_reload +} diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/install_packages b/bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/install_packages new file mode 100755 index 000000000000..acbc3173208c --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/install_packages @@ -0,0 +1,27 @@ +#!/bin/sh +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +set -eu + +n=0 +max=2 +export DEBIAN_FRONTEND=noninteractive + +until [ $n -gt $max ]; do + set +e + ( + apt-get update -qq && + apt-get install -y --no-install-recommends "$@" + ) + CODE=$? + set -e + if [ $CODE -eq 0 ]; then + break + fi + if [ $n -eq $max ]; then + exit $CODE + fi + echo "apt failed, retrying" + n=$(($n + 1)) +done +apt-get clean && rm -rf /var/lib/apt/lists /var/cache/apt/archives diff --git a/bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/run-script b/bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/run-script new file mode 100755 index 000000000000..4ca0f897277e --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/prebuildfs/usr/sbin/run-script @@ -0,0 +1,24 @@ +#!/bin/sh +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +set -u + +if [ $# -eq 0 ]; then + >&2 echo "No arguments provided" + exit 1 +fi + +script=$1 +exit_code="${2:-96}" +fail_if_not_present="${3:-n}" + +if test -f "$script"; then + sh $script + + if [ $? -ne 0 ]; then + exit $((exit_code)) + fi +elif [ "$fail_if_not_present" = "y" ]; then + >&2 echo "script not found: $script" + exit 127 +fi diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/bitnami/protect-hidden-files.conf b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/bitnami/protect-hidden-files.conf new file mode 100644 index 000000000000..2ddab8c9a1e0 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/bitnami/protect-hidden-files.conf @@ -0,0 +1,4 @@ +# Deny all attempts to access hidden files such as .htaccess or .htpasswd +location ~ /\. { + deny all; +} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/nginx.conf b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/nginx.conf new file mode 100644 index 000000000000..9833b1cfd043 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/nginx/conf/nginx.conf @@ -0,0 +1,60 @@ +# Based on https://www.nginx.com/resources/wiki/start/topics/examples/full/#nginx-conf +user www www; ## Default: nobody + +worker_processes auto; +error_log "/opt/bitnami/nginx/logs/error.log"; +pid "/opt/bitnami/nginx/tmp/nginx.pid"; + +events { + worker_connections 1024; +} + +http { + include mime.types; + default_type application/octet-stream; + log_format main '$remote_addr - $remote_user [$time_local] ' + '"$request" $status $body_bytes_sent "$http_referer" ' + '"$http_user_agent" "$http_x_forwarded_for"'; + access_log "/opt/bitnami/nginx/logs/access.log" main; + add_header X-Frame-Options SAMEORIGIN; + + client_body_temp_path "/opt/bitnami/nginx/tmp/client_body" 1 2; + proxy_temp_path "/opt/bitnami/nginx/tmp/proxy" 1 2; + fastcgi_temp_path "/opt/bitnami/nginx/tmp/fastcgi" 1 2; + scgi_temp_path "/opt/bitnami/nginx/tmp/scgi" 1 2; + uwsgi_temp_path "/opt/bitnami/nginx/tmp/uwsgi" 1 2; + + sendfile on; + tcp_nopush on; + tcp_nodelay off; + gzip on; + gzip_http_version 1.0; + gzip_comp_level 2; + gzip_proxied any; + gzip_types text/plain text/css application/javascript text/xml application/xml+rss; + keepalive_timeout 65; + ssl_protocols TLSv1.2 TLSv1.3; + ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384:DHE-RSA-CHACHA20-POLY1305; + client_max_body_size 80M; + server_tokens off; + + absolute_redirect off; + port_in_redirect off; + + include "/opt/bitnami/nginx/conf/server_blocks/*.conf"; + + # HTTP Server + server { + # Port to listen on, can also be set in IP:PORT format + listen 80; + + include "/opt/bitnami/nginx/conf/bitnami/*.conf"; + + location /status { + stub_status on; + access_log off; + allow 127.0.0.1; + deny all; + } + } +} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal-env.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal-env.sh new file mode 100644 index 000000000000..728af7ad9888 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal-env.sh @@ -0,0 +1,33 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Environment configuration for harbor-portal + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +# Load logging library +# shellcheck disable=SC1090,SC1091 +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-harbor-portal}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# Paths +export HARBOR_PORTAL_BASE_DIR="${BITNAMI_ROOT_DIR}/harbor" +export HARBOR_PORTAL_NGINX_CONF_DIR="${HARBOR_PORTAL_BASE_DIR}/nginx-conf" +export HARBOR_PORTAL_NGINX_CONF_FILE="${HARBOR_PORTAL_NGINX_CONF_DIR}/nginx.conf" + +# System users +export HARBOR_PORTAL_DAEMON_USER="harbor" +export HARBOR_PORTAL_DAEMON_GROUP="harbor" + +# Custom environment variables may be defined below diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/entrypoint.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/entrypoint.sh new file mode 100755 index 000000000000..d059665d2b7d --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/entrypoint.sh @@ -0,0 +1,29 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/libnginx.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +print_welcome_page + +if [[ "$1" = "/opt/bitnami/scripts/nginx/run.sh" ]]; then + info "** Starting harbor-portal setup **" + /opt/bitnami/scripts/nginx/setup.sh + /opt/bitnami/scripts/harbor-portal/setup.sh + info "** harbor-portal setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/postunpack.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/postunpack.sh new file mode 100755 index 000000000000..efb885576340 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/postunpack.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libnginx.sh +. /opt/bitnami/scripts/libharbor.sh + +# Load Nginx environment variables +. /opt/bitnami/scripts/nginx-env.sh + +# Load environment +. /opt/bitnami/scripts/harbor-portal-env.sh + +ensure_user_exists "$HARBOR_PORTAL_DAEMON_USER" --group "$HARBOR_PORTAL_DAEMON_GROUP" + +# Ensure NGINX temp folders exists +for dir in "${NGINX_BASE_DIR}/client_body_temp" "${NGINX_BASE_DIR}/proxy_temp" "${NGINX_BASE_DIR}/fastcgi_temp" "${NGINX_BASE_DIR}/scgi_temp" "${NGINX_BASE_DIR}/uwsgi_temp"; do + ensure_dir_exists "$dir" +done + +# Ensure permissions for Internal TLS +configure_permissions_system_certs "$HARBOR_PORTAL_DAEMON_USER" + +# Loading bitnami paths +replace_in_file "$HARBOR_PORTAL_NGINX_CONF_FILE" "/usr/share/nginx/html" "${HARBOR_PORTAL_BASE_DIR}" false +replace_in_file "$HARBOR_PORTAL_NGINX_CONF_FILE" "/etc/nginx/mime.types" "${NGINX_CONF_DIR}/mime.types" false + +cp -a "${HARBOR_PORTAL_NGINX_CONF_DIR}/." "$NGINX_CONF_DIR" +# Remove the folder, otherwise it will get exposed when accessing via browser +rm -rf "${HARBOR_PORTAL_NGINX_CONF_DIR}" + +# Ensure a set of directories exist and the non-root user has write privileges to them +read -r -a directories <<<"$(get_system_cert_paths)" +directories+=("$NGINX_CONF_DIR") +for dir in "${directories[@]}"; do + chmod -R g+rwX "$dir" + chown -R "$HARBOR_PORTAL_DAEMON_USER" "$dir" +done diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/setup.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/setup.sh new file mode 100755 index 000000000000..f148c23e6b54 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/harbor-portal/setup.sh @@ -0,0 +1,18 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1090,SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libharbor.sh + +# Load environment +. /opt/bitnami/scripts/harbor-portal-env.sh + +install_custom_certs diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libharbor.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libharbor.sh new file mode 100644 index 000000000000..d6134ff84dd5 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libharbor.sh @@ -0,0 +1,492 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami Harbor library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh + +######################## +# Get the paths relevant to CA certs depending +# on the OS +# Globals: +# None +# Arguments: +# None +# Returns: +# A series of paths relevant to CA certs +# depending on the OS. +######################### +get_system_cert_paths() { + local distro + distro="$(get_os_metadata --id)" + if [[ "$distro" =~ ^(debian|ubuntu)$ ]]; then + echo "/etc/ssl/certs/" + elif [[ "$distro" =~ ^photon$ ]]; then + echo "/etc/pki/tls/certs/" + else + # Check the existence of generic paths when OS_FLAVOR does + # not match + if [[ -d /etc/ssl/certs/ ]] ; then + echo "/etc/ssl/certs/" + elif [[ -d /etc/pki/tls/certs/ ]]; then + echo "/etc/pki/tls/certs/" + else + error "Could not determine relevant CA paths for this OS Flavour" + fi + fi +} + +######################## +# Ensure CA bundles allows users in root group install new certificate +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +configure_permissions_system_certs() { + local -r owner="${1:-}" + # Debian + set_permissions_ownership "/etc/pki/tls/certs/ca-bundle.crt" "$owner" + # Photon + set_permissions_ownership "/etc/pki/tls/certs/ca-bundle.trust.crt" "$owner" + set_permissions_ownership "/etc/ssl/certs/ca-certificates.crt" "$owner" +} + +######################## +# Grant group write permissions to the file provided and change ownership if a the owner argument is set. +# If the path is not a file, then do nothing. +# Globals: +# None +# Arguments: +# $1 - path +# $2 - owner +# Returns: +# None +######################### +set_permissions_ownership() { + local -r path="${1:?path is missing}" + local -r owner="${2:-}" + + if [[ -f "$path" ]]; then + chmod g+w "$path" + if [[ -n "$owner" ]]; then + chown "$owner" "$path" + fi + fi +} + +######################## +# Place a given certificate in the correct location for installation +# depending on the OS +# Globals: +# None +# Arguments: +# $1 - certificate to be installed +# Returns: +# None +######################### +install_cert() { + local -r cert="${1:?missing certificate}" + local distro + distro="$(get_os_metadata --id)" + + if [[ "$distro" =~ ^(debian|ubuntu)$ ]]; then + cat "$cert" >> /etc/ssl/certs/ca-certificates.crt + elif [[ "$distro" =~ ^photon$ ]]; then + cat "$cert" >> /etc/pki/tls/certs/ca-bundle.crt + else + # Check the existence of generic ca-bundles when OS_FLAVOR does + # not match + if [[ -f /etc/ssl/certs/ca-certificates.crt ]] ; then + cat "$cert" >> /etc/ssl/certs/ca-certificates.crt + elif [[ -f /etc/pki/tls/certs/ca-bundle.crt ]]; then + cat "$cert" >> /etc/pki/tls/certs/ca-bundle.crt + else + error "Could not install CA certificate ${cert} CA in this OS Flavour" + fi + fi +} + +######################## +# Install CA certificates found under the specific paths +# Globals: +# None +# Arguments: +# None +# Returns: +# None +######################### +install_custom_certs() { + local installed=false + + # Install any internalTLS CA authority certificate, found under + # /etc/harbor/ssl/{component}/ca.crt + if [[ -d /etc/harbor/ssl ]]; then + info "Appending internalTLS trust CA cert..." + while IFS= read -r -d '' caCert; do + install_cert "$caCert" + installed=true + debug "Internal tls trust CA $caCert copied" + done < <(find /etc/harbor/ssl -maxdepth 2 -name ca.crt -print0) + info "interalTLS CA certs appending done!" + fi + + # Install any other custom certificate provided by the end user under the path + # /harbor_cust_cert + if [[ -d /harbor_cust_cert ]]; then + info "Appending custom trust CA certs ..." + for certFile in /harbor_cust_cert/*; do + case ${certFile} in + *.crt | *.ca | *.ca-bundle | *.pem) + if [[ -d "$certFile" ]]; then + debug "$certFile is a directory, skipping it" + else + install_cert "$certFile" + installed=true + debug "Custom CA cert $certFile copied" + fi + ;; + *) debug "$certFile is not a CA cert file, skipping it" ;; + esac + done + fi + + if [[ "$installed" = true ]]; then + info "Custom certificates were installed in the system!" + else + info "No custom certificates were installed in the system" + fi +} + +######################## +# Generate an .env file contents given an input string containing all envvars +# Arguments: +# None +# Returns: +# String +######################### +harbor_generate_env_file_contents() { + local -r envvars_string="${1:-}" + [[ -z "$envvars_string" ]] && return + # For systemd, we will load it via EnvironmentFile=, so the shebang is not needed + [[ "$BITNAMI_SERVICE_MANAGER" != "systemd" ]] && echo "#!/bin/bash" + while IFS= read -r ENV_VAR_LINE; do + if [[ ! "$ENV_VAR_LINE" =~ ^[A-Z_] ]]; then + continue + fi + ENV_VAR_NAME="${ENV_VAR_LINE/=*}" + ENV_VAR_VALUE="${ENV_VAR_LINE#*=}" + # For systemd, we will load it via EnvironmentFile=, which does not allow 'export' + [[ "$BITNAMI_SERVICE_MANAGER" != "systemd" ]] && echo -n 'export ' + # Use single quotes to avoid shell expansion, and escape to be parsed properly (even if it contains quotes) + # Escape the value, so it can be parsed as a variable even with quotes set + echo "${ENV_VAR_NAME}='${ENV_VAR_VALUE//\'/\'\\\'\'}'" + done <<< "$envvars_string" +} + +######################## +# Print harbor-core runtime environment +# Arguments: +# None +# Returns: +# Boolean +######################### +harbor_core_print_env() { + # The CSRF key can only be up to 32 characters long + HARBOR_CORE_CFG_CSRF_KEY="${HARBOR_CORE_CFG_CSRF_KEY:0:32}" + for var in "${!HARBOR_CORE_CFG_@}"; do + echo "${var/HARBOR_CORE_CFG_/}=${!var}" + done +} + +######################## +# Check if harbor-core is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_core_running() { + # harbor-core does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + pgrep -f "$(command -v harbor_core)" > "$HARBOR_CORE_PID_FILE" + + pid="$(get_pid_from_file "$HARBOR_CORE_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if harbor-core is not running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_core_not_running() { + ! is_harbor_core_running +} + +######################## +# Stop harbor-core +# Arguments: +# None +# Returns: +# None +######################### +harbor_core_stop() { + ! is_harbor_core_running && return + stop_service_using_pid "$HARBOR_CORE_PID_FILE" +} + +######################## +# Print harbor-jobservice runtime environment +# Arguments: +# None +# Returns: +# Boolean +######################### +harbor_jobservice_print_env() { + for var in "${!HARBOR_JOBSERVICE_CFG_@}"; do + echo "${var/HARBOR_JOBSERVICE_CFG_/}=${!var}" + done +} + +######################## +# Check if harbor-jobservice is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_jobservice_running() { + # harbor-jobservice does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + pgrep -f "$(command -v harbor_jobservice)" > "$HARBOR_JOBSERVICE_PID_FILE" + + pid="$(get_pid_from_file "$HARBOR_JOBSERVICE_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if harbor-jobservice is not running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_jobservice_not_running() { + ! is_harbor_jobservice_running +} + +######################## +# Stop harbor-jobservice +# Arguments: +# None +# Returns: +# None +######################### +harbor_jobservice_stop() { + ! is_harbor_jobservice_running && return + stop_service_using_pid "$HARBOR_JOBSERVICE_PID_FILE" +} + +######################## +# Print harbor-registry runtime environment +# Arguments: +# None +# Returns: +# Boolean +######################### +harbor_registry_print_env() { + if [[ -n "$HARBOR_REGISTRY_USER" && -n "$HARBOR_REGISTRY_PASSWORD" ]]; then + HARBOR_REGISTRY_CFG_REGISTRY_HTPASSWD="$(htpasswd -nbBC10 "$HARBOR_REGISTRY_USER" "$HARBOR_REGISTRY_PASSWORD")" + # Update passwd file + echo "$HARBOR_REGISTRY_CFG_REGISTRY_HTPASSWD" >/etc/registry/passwd + fi + for var in "${!HARBOR_REGISTRY_CFG_@}"; do + echo "${var/HARBOR_REGISTRY_CFG_/}=${!var}" + done +} + +######################## +# Check if harbor-registry is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_registry_running() { + # harbor-registry does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + pgrep -f "$(command -v registry)" > "$HARBOR_REGISTRY_PID_FILE" + + pid="$(get_pid_from_file "$HARBOR_REGISTRY_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if harbor-registry is not running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_registry_not_running() { + ! is_harbor_registry_running +} + +######################## +# Stop harbor-registry +# Arguments: +# None +# Returns: +# None +######################### +harbor_registry_stop() { + ! is_harbor_registry_running && return + stop_service_using_pid "$HARBOR_REGISTRY_PID_FILE" +} + +######################## +# Print harbor-registryctl runtime environment +# Arguments: +# None +# Returns: +# Boolean +######################### +harbor_registryctl_print_env() { + if [[ -n "$HARBOR_REGISTRYCTL_USER" && -n "$HARBOR_REGISTRYCTL_PASSWORD" ]]; then + HARBOR_REGISTRYCTL_CFG_REGISTRY_HTPASSWD="$(htpasswd -nbBC10 "$HARBOR_REGISTRYCTL_USER" "$HARBOR_REGISTRYCTL_PASSWORD")" + # Update passwd file + echo "$HARBOR_REGISTRYCTL_CFG_REGISTRY_HTPASSWD" >/etc/registry/passwd + fi + for var in "${!HARBOR_REGISTRYCTL_CFG_@}"; do + echo "${var/HARBOR_REGISTRYCTL_CFG_/}=${!var}" + done +} + +######################## +# Check if harbor-registryctl is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_registryctl_running() { + # harbor-registryctl does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + pgrep -f "$(command -v harbor_registryctl)" > "$HARBOR_REGISTRYCTL_PID_FILE" + + pid="$(get_pid_from_file "$HARBOR_REGISTRYCTL_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if harbor-registryctl is not running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_registryctl_not_running() { + ! is_harbor_registryctl_running +} + +######################## +# Stop harbor-registryctl +# Arguments: +# None +# Returns: +# None +######################### +harbor_registryctl_stop() { + ! is_harbor_registryctl_running && return + stop_service_using_pid "$HARBOR_REGISTRYCTL_PID_FILE" + # The service may not respond properly to the default kill signal, so send a SIGKILL if it fails + local -r retries=5 + local -r sleep_time=1 + if ! retry_while "is_harbor_registryctl_not_running" "$retries" "$sleep_time"; then + stop_service_using_pid "$HARBOR_REGISTRYCTL_PID_FILE" SIGKILL + fi +} + +######################## +# Print harbor-adapter-trivy runtime environment +# Arguments: +# None +# Returns: +# Boolean +######################### +harbor_adapter_trivy_print_env() { + for var in "${!SCANNER_TRIVY_CFG_@}"; do + echo "${var/SCANNER_TRIVY_CFG_/}=${!var}" + done +} + +######################## +# Check if harbor-adapter-trivy is running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_adapter_trivy_running() { + # harbor-adapter-trivy does not create any PID file + # We regenerate the PID file for each time we query it to avoid getting outdated + pgrep -f "$(command -v scanner-trivy)" > "$SCANNER_TRIVY_PID_FILE" + + pid="$(get_pid_from_file "$SCANNER_TRIVY_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if harbor-adapter-trivy is not running +# Arguments: +# None +# Returns: +# Boolean +######################### +is_harbor_adapter_trivy_not_running() { + ! is_harbor_adapter_trivy_running +} + +######################## +# Stop harbor-adapter-trivy +# Arguments: +# None +# Returns: +# None +######################### +harbor_adapter_trivy_stop() { + ! is_harbor_adapter_trivy_running && return + stop_service_using_pid "$SCANNER_TRIVY_PID_FILE" +} + diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libnginx.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libnginx.sh new file mode 100644 index 000000000000..40f204ea4f7c --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/libnginx.sh @@ -0,0 +1,669 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Bitnami NGINX library + +# shellcheck disable=SC1090,SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh + +# Functions + +######################## +# Check if NGINX is running +# Globals: +# NGINX_TMP_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_nginx_running() { + local pid + pid="$(get_pid_from_file "$NGINX_PID_FILE")" + if [[ -n "$pid" ]]; then + is_service_running "$pid" + else + false + fi +} + +######################## +# Check if NGINX is not running +# Globals: +# NGINX_TMP_DIR +# Arguments: +# None +# Returns: +# Boolean +######################### +is_nginx_not_running() { + ! is_nginx_running +} + +######################## +# Stop NGINX +# Globals: +# NGINX_TMP_DIR +# Arguments: +# None +# Returns: +# None +######################### +nginx_stop() { + ! is_nginx_running && return + debug "Stopping NGINX" + stop_service_using_pid "$NGINX_PID_FILE" +} + +######################## +# Configure NGINX server block port +# Globals: +# NGINX_CONF_DIR +# Arguments: +# $1 - Port number +# $2 - (optional) Path to server block file +# Returns: +# None +######################### +nginx_configure_port() { + local port=${1:?missing port} + local file=${2:-"$NGINX_CONF_FILE"} + if is_file_writable "$file"; then + local nginx_configuration + debug "Setting port number to ${port} in '${file}'" + # TODO: find an appropriate NGINX parser to avoid 'sed calls' + nginx_configuration="$(sed -E "s/(listen\s+)[0-9]{1,5}(.*);/\1${port}\2;/g" "$file")" + echo "$nginx_configuration" >"$file" + fi +} + +######################## +# Configure NGINX directives +# Globals: +# NGINX_CONF_DIR +# Arguments: +# $1 - Directive to modify +# $2 - Value +# $3 - (optional) Path to server block file +# Returns: +# None +######################### +nginx_configure() { + local directive=${1:?missing directive} + local value=${2:?missing value} + local file=${3:-"$NGINX_CONF_FILE"} + if is_file_writable "$file"; then + local nginx_configuration + debug "Setting directive '${directive}' to '${value}' in '${file}'" + nginx_configuration="$(sed -E "s/(\s*${directive}\s+)(.+);/\1${value};/g" "$file")" + echo "$nginx_configuration" >"$file" + fi +} + +######################## +# Validate settings in NGINX_* env vars +# Globals: +# NGINX_* +# Arguments: +# None +# Returns: +# None +######################### +nginx_validate() { + info "Validating settings in NGINX_* env vars" + local error_code=0 + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + check_yes_no_value() { + if ! is_yes_no_value "${!1}" && ! is_true_false_value "${!1}"; then + print_validation_error "The allowed values for ${1} are: yes no" + fi + } + check_valid_port() { + local port_var="${1:?missing port variable}" + local validate_port_args=() + local err + ! am_i_root && validate_port_args+=("-unprivileged") + if ! err="$(validate_port "${validate_port_args[@]}" "${!port_var}")"; then + print_validation_error "An invalid port was specified in the environment variable ${port_var}: ${err}." + fi + } + + ! is_empty_value "$NGINX_ENABLE_ABSOLUTE_REDIRECT" && check_yes_no_value "NGINX_ENABLE_ABSOLUTE_REDIRECT" + ! is_empty_value "$NGINX_ENABLE_PORT_IN_REDIRECT" && check_yes_no_value "NGINX_ENABLE_PORT_IN_REDIRECT" + + ! is_empty_value "$NGINX_HTTP_PORT_NUMBER" && check_valid_port "NGINX_HTTP_PORT_NUMBER" + ! is_empty_value "$NGINX_HTTPS_PORT_NUMBER" && check_valid_port "NGINX_HTTPS_PORT_NUMBER" + + if ! is_file_writable "$NGINX_CONF_FILE"; then + warn "The NGINX configuration file '${NGINX_CONF_FILE}' is not writable by current user. Configurations based on environment variables will not be applied." + fi + return "$error_code" +} + +######################## +# Initialize NGINX +# Globals: +# NGINX_* +# Arguments: +# None +# Returns: +# None +######################### +nginx_initialize() { + info "Initializing NGINX" + + # This fixes an issue where the trap would kill the entrypoint.sh, if a PID was left over from a previous run + # Exec replaces the process without creating a new one, and when the container is restarted it may have the same PID + rm -f "${NGINX_TMP_DIR}/nginx.pid" + + # Persisted configuration files from old versions + if [[ -f "$NGINX_VOLUME_DIR/conf/nginx.conf" ]]; then + error "A 'nginx.conf' file was found inside '${NGINX_VOLUME_DIR}/conf'. This configuration is not supported anymore. Please mount the configuration file at '${NGINX_CONF_FILE}' instead." + exit 1 + fi + if ! is_dir_empty "$NGINX_VOLUME_DIR/conf/vhosts"; then + error "Custom server blocks files were found inside '$NGINX_VOLUME_DIR/conf/vhosts'. This configuration is not supported anymore. Please mount your custom server blocks config files at '${NGINX_SERVER_BLOCKS_DIR}' instead." + exit 1 + fi + + debug "Updating NGINX configuration based on environment variables" + local nginx_user_configuration + if am_i_root; then + debug "Ensuring NGINX daemon user/group exists" + ensure_user_exists "$NGINX_DAEMON_USER" --group "$NGINX_DAEMON_GROUP" + if [[ -n "${NGINX_DAEMON_USER:-}" ]]; then + chown -R "${NGINX_DAEMON_USER:-}" "$NGINX_TMP_DIR" + fi + nginx_configure "user" "${NGINX_DAEMON_USER:-} ${NGINX_DAEMON_GROUP:-}" + else + # The "user" directive makes sense only if the master process runs with super-user privileges + # TODO: find an appropriate NGINX parser to avoid 'sed calls' + nginx_user_configuration="$(sed -E "s/(^user)/# \1/g" "$NGINX_CONF_FILE")" + is_file_writable "$NGINX_CONF_FILE" && echo "$nginx_user_configuration" >"$NGINX_CONF_FILE" + fi + # Configure HTTP port number + if [[ -n "${NGINX_HTTP_PORT_NUMBER:-}" ]]; then + nginx_configure_port "$NGINX_HTTP_PORT_NUMBER" + fi + # Configure HTTPS port number + if [[ -n "${NGINX_HTTPS_PORT_NUMBER:-}" ]] && [[ -f "${NGINX_SERVER_BLOCKS_DIR}/default-https-server-block.conf" ]]; then + nginx_configure_port "$NGINX_HTTPS_PORT_NUMBER" "${NGINX_SERVER_BLOCKS_DIR}/default-https-server-block.conf" + fi + nginx_configure "absolute_redirect" "$(is_boolean_yes "$NGINX_ENABLE_ABSOLUTE_REDIRECT" && echo "on" || echo "off" )" + nginx_configure "port_in_redirect" "$(is_boolean_yes "$NGINX_ENABLE_PORT_IN_REDIRECT" && echo "on" || echo "off" )" +} + +######################## +# Ensure an NGINX application configuration exists (in server block format) +# Globals: +# NGINX_* +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty) +# --hosts - Host listen addresses +# --server-name - Server name (if not specified, a catch-all server block will be created) +# --server-aliases - Server aliases +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --disable - Whether to render the app's server blocks with a .disabled prefix +# --disable-http - Whether to render the app's HTTP server block with a .disabled prefix +# --disable-https - Whether to render the app's HTTPS server block with a .disabled prefix +# --http-port - HTTP port number +# --https-port - HTTPS port number +# --additional-configuration - Additional server block configuration (no default) +# --external-configuration - Configuration external to server block (no default) +# --document-root - Path to document root directory +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_nginx_app_configuration_exists() { + export app="${1:?missing app}" + # Default options + local type="" + local -a hosts=() + local server_name + local -a server_aliases=() + local allow_remote_connections="yes" + local disable="no" + local disable_http="no" + local disable_https="no" + # Template variables defaults + export additional_configuration="" + export external_configuration="" + export document_root="${BITNAMI_ROOT_DIR}/${app}" + export http_port="${NGINX_HTTP_PORT_NUMBER:-"$NGINX_DEFAULT_HTTP_PORT_NUMBER"}" + export https_port="${NGINX_HTTPS_PORT_NUMBER:-"$NGINX_DEFAULT_HTTPS_PORT_NUMBER"}" + # Validate arguments + local var_name + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --hosts | \ + --server-aliases) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + read -r -a "${var_name?}" <<<"$1" + ;; + --disable | \ + --disable-http | \ + --disable-https) + + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + export "${var_name?}=yes" + ;; + --type | \ + --server-name | \ + --allow-remote-connections | \ + --http-port | \ + --https-port | \ + --additional-configuration | \ + --external-configuration | \ + --document-root | \ + --extra-directory-configuration) + + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + export "${var_name?}"="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Construct host string in the format of "listen host1:port1", "listen host2:port2", ... + export http_listen_configuration="" + export https_listen_configuration="" + if [[ "${#hosts[@]}" -gt 0 ]]; then + for host in "${hosts[@]}"; do + http_listen=$'\n'"listen ${host}:${http_port};" + https_listen=$'\n'"listen ${host}:${https_port} ssl;" + [[ -z "${http_listen_configuration:-}" ]] && http_listen_configuration="$http_listen" || http_listen_configuration="${http_listen_configuration}${http_listen}" + [[ -z "${https_listen_configuration:-}" ]] && https_listen_configuration="$https_listen" || https_listen_configuration="${https_listen_configuration}${https_listen}" + done + else + http_listen_configuration=$'\n'"listen ${http_port} default_server;" + https_listen_configuration=$'\n'"listen ${https_port} ssl default_server;" + fi + # Construct server_name block + export server_name_configuration="" + if ! is_empty_value "${server_name:-}"; then + server_name_configuration="server_name ${server_name}" + if [[ "${#server_aliases[@]}" -gt 0 ]]; then + server_name_configuration+=" ${server_aliases[*]}" + fi + server_name_configuration+=";" + else + server_name_configuration=" +# Catch-all server block +# See: https://nginx.org/en/docs/http/server_names.html#miscellaneous_names +server_name _;" + fi + # ACL configuration + export acl_configuration="" + if ! is_boolean_yes "$allow_remote_connections"; then + acl_configuration=" +default_type text/html; +if (\$remote_addr != 127.0.0.1) { + return 403 'For security reasons, this URL is only accessible using localhost (127.0.0.1) as the hostname.'; +} +# Avoid absolute redirects when connecting through a SSH tunnel +absolute_redirect off;" + fi + # Indent configurations + server_name_configuration="$(indent $'\n'"$server_name_configuration" 4)" + acl_configuration="$(indent "$acl_configuration" 4)" + additional_configuration=$'\n'"$(indent "$additional_configuration" 4)" + external_configuration=$'\n'"$external_configuration" + http_listen_configuration="$(indent "$http_listen_configuration" 4)" + https_listen_configuration="$(indent "$https_listen_configuration" 4)" + # Render templates + # We remove lines that are empty or contain only newspaces with 'sed', so the resulting file looks better + local template_name="app" + [[ -n "$type" && "$type" != "php" ]] && template_name="app-${type}" + local template_dir="${BITNAMI_ROOT_DIR}/scripts/nginx/bitnami-templates" + local http_server_block="${NGINX_SERVER_BLOCKS_DIR}/${app}-server-block.conf" + local https_server_block="${NGINX_SERVER_BLOCKS_DIR}/${app}-https-server-block.conf" + local -r disable_suffix=".disabled" + (is_boolean_yes "$disable" || is_boolean_yes "$disable_http") && http_server_block+="$disable_suffix" + (is_boolean_yes "$disable" || is_boolean_yes "$disable_https") && https_server_block+="$disable_suffix" + if is_file_writable "$http_server_block"; then + # Create file with root group write privileges, so it can be modified in non-root containers + [[ ! -f "$http_server_block" ]] && touch "$http_server_block" && chmod g+rw "$http_server_block" + render-template "${template_dir}/${template_name}-http-server-block.conf.tpl" | sed '/^\s*$/d' >"$http_server_block" + elif [[ ! -f "$http_server_block" ]]; then + error "Could not create server block for ${app} at '${http_server_block}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} server block file '${http_server_block}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + if is_file_writable "$https_server_block"; then + # Create file with root group write privileges, so it can be modified in non-root containers + [[ ! -f "$https_server_block" ]] && touch "$https_server_block" && chmod g+rw "$https_server_block" + render-template "${template_dir}/${template_name}-https-server-block.conf.tpl" | sed '/^\s*$/d' >"$https_server_block" + elif [[ ! -f "$https_server_block" ]]; then + error "Could not create server block for ${app} at '${https_server_block}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} server block file '${https_server_block}' is not writable. Configurations based on environment variables will not be applied for this file." + fi +} + +######################## +# Ensure an NGINX application configuration does not exist anymore (in server block format) +# Globals: +# * +# Arguments: +# $1 - App name +# Returns: +# true if the configuration was disabled, false otherwise +######################## +ensure_nginx_app_configuration_not_exists() { + local app="${1:?missing app}" + local http_server_block="${NGINX_SERVER_BLOCKS_DIR}/${app}-server-block.conf" + local https_server_block="${NGINX_SERVER_BLOCKS_DIR}/${app}-https-server-block.conf" + local -r disable_suffix=".disabled" + # Note that 'rm -f' will not fail if the files don't exist + # However if we lack permissions to remove the file, it will result in a non-zero exit code, as expected by this function + rm -f "$http_server_block" "$https_server_block" "${http_server_block}${disable_suffix}" "${https_server_block}${disable_suffix}" +} + +######################## +# Ensure NGINX loads the configuration for an application in a URL prefix +# Globals: +# NGINX_* +# Arguments: +# $1 - App name +# Flags: +# --type - Application type, which has an effect on what configuration template will be used, allowed values: php, (empty) +# --allow-remote-connections - Whether to allow remote connections or to require local connections +# --prefix - URL prefix from where it will be accessible (i.e. /myapp) +# --additional-configuration - Additional server block configuration (no default) +# --document-root - Path to document root directory +# --extra-directory-configuration - Extra configuration for the document root directory +# Returns: +# true if the configuration was enabled, false otherwise +######################## +ensure_nginx_prefix_configuration_exists() { + local app="${1:?missing app}" + # Default options + local type="" + local allow_remote_connections="yes" + local prefix="/${app}" + # Template variables defaults + export additional_configuration="" + export document_root="${BITNAMI_ROOT_DIR}/${app}" + export extra_directory_configuration="" + # Validate arguments + local var_name + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --type | \ + --allow-remote-connections | \ + --additional-configuration | \ + --document-root | \ + --extra-directory-configuration | \ + --prefix) + + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "${var_name?}"="$1" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # ACL configuration + export acl_configuration="" + if ! is_boolean_yes "$allow_remote_connections"; then + acl_configuration=" +default_type text/html; +if (\$remote_addr != 127.0.0.1) { + return 403 'For security reasons, this URL is only accessible using localhost (127.0.0.1) as the hostname.'; +} +# Avoid absolute redirects when connecting through a SSH tunnel +absolute_redirect off;" + fi + # Prefix configuration + export location="$prefix" + # Indent configurations + acl_configuration="$(indent "$acl_configuration" 4)" + additional_configuration=$'\n'"$(indent "$additional_configuration" 4)" + # Render templates + # We remove lines that are empty or contain only newspaces with 'sed', so the resulting file looks better + local template_name="app" + [[ -n "$type" ]] && template_name="app-${type}" + local template_dir="${BITNAMI_ROOT_DIR}/scripts/nginx/bitnami-templates" + local prefix_file="${NGINX_CONF_DIR}/bitnami/${app}.conf" + if is_file_writable "$prefix_file"; then + # Create file with root group write privileges, so it can be modified in non-root containers + [[ ! -f "$prefix_file" ]] && touch "$prefix_file" && chmod g+rw "$prefix_file" + render-template "${template_dir}/${template_name}-prefix.conf.tpl" | sed '/^\s*$/d' >"$prefix_file" + elif [[ ! -f "$prefix_file" ]]; then + error "Could not create web server configuration file for ${app} at '${prefix_file}'. Check permissions and ownership for parent directories." + return 1 + else + warn "The ${app} web server configuration file '${prefix_file}' is not writable. Configurations based on environment variables will not be applied for this file." + fi +} + +######################## +# Ensure NGINX application configuration is updated with the runtime configuration (i.e. ports) +# Globals: +# * +# Arguments: +# $1 - App name +# Flags: +# --hosts - Hosts to enable +# --enable-http - Enable HTTP app configuration (if not enabled already) +# --enable-https - Enable HTTPS app configuration (if not enabled already) +# --disable-http - Disable HTTP app configuration (if not disabled already) +# --disable-https - Disable HTTPS app configuration (if not disabled already) +# --http-port - HTTP port number +# --https-port - HTTPS port number +# Returns: +# true if the configuration was updated, false otherwise +######################## +nginx_update_app_configuration() { + local -r app="${1:?missing app}" + # Default options + local -a hosts=() + local enable_http="no" + local enable_https="no" + local disable_http="no" + local disable_https="no" + local http_port="${NGINX_HTTP_PORT_NUMBER:-"$NGINX_DEFAULT_HTTP_PORT_NUMBER"}" + local https_port="${NGINX_HTTPS_PORT_NUMBER:-"$NGINX_DEFAULT_HTTPS_PORT_NUMBER"}" + # Validate arguments + local var_name + shift + while [[ "$#" -gt 0 ]]; do + case "$1" in + --hosts \ + | --server-aliases \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + read -r -a "${var_name?}" <<<"$1" + ;; + # Common flags + --enable-http \ + | --enable-https \ + | --disable-http \ + | --disable-https \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + declare "${var_name?}=yes" + ;; + --server-name \ + | --http-port \ + | --https-port \ + ) + var_name="$(echo "$1" | sed -e "s/^--//" -e "s/-/_/g")" + shift + declare "${var_name?}=${1}" + ;; + + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + # Construct host string in the format of "listen host1:port1", "listen host2:port2", ... + export http_listen_configuration="" + export https_listen_configuration="" + if [[ "${#hosts[@]}" -gt 0 ]]; then + for host in "${hosts[@]}"; do + http_listen="listen ${host}:${http_port};" + https_listen="listen ${host}:${https_port} ssl;" + [[ -z "${http_listen_configuration:-}" ]] && http_listen_configuration="$http_listen" || http_listen_configuration="${http_listen_configuration}"$'\\\n'"${http_listen}" + [[ -z "${https_listen_configuration:-}" ]] && https_listen_configuration="$https_listen" || https_listen_configuration="${https_listen_configuration}"$'\\\n'"${https_listen}" + done + else + http_listen_configuration="listen ${http_port} default_server;" + https_listen_configuration="listen ${https_port} ssl default_server;" + fi + # Indent configurations + http_listen_configuration="$(indent "$http_listen_configuration" 4)" + https_listen_configuration="$(indent "$https_listen_configuration" 4)" + # Update configuration + local -r http_server_block="${NGINX_SERVER_BLOCKS_DIR}/${app}-server-block.conf" + local -r https_server_block="${NGINX_SERVER_BLOCKS_DIR}/${app}-https-server-block.conf" + # Helper function to avoid duplicating code + update_common_server_block_config() { + local -r server_block_file="${1:?missing server block}" + # Update server_name + if ! is_empty_value "${server_name:-}"; then + local server_name_list="$server_name" + if [[ "${#server_aliases[@]}" -gt 0 ]]; then + server_name_list+=" ${server_aliases[*]}" + fi + replace_in_file "$server_block_file" "^(\s*server_name\s+)[^;]*" "\1${server_name_list}" + fi + } + # Disable and enable configuration files + rename_conf_file() { + local -r origin="$1" + local -r destination="$2" + if is_file_writable "$origin" && is_file_writable "$destination"; then + warn "Could not rename server block file '${origin}' to '${destination}' due to lack of permissions." + else + mv "$origin" "$destination" + fi + } + is_boolean_yes "$disable_http" && [[ -e "$http_server_block" ]] && rename_conf_file "${http_server_block}${disable_suffix}" "$http_server_block" + is_boolean_yes "$disable_https" && [[ -e "$https_server_block" ]] && rename_conf_file "${https_server_block}${disable_suffix}" "$https_server_block" + is_boolean_yes "$enable_http" && [[ -e "${http_server_block}${disable_suffix}" ]] && rename_conf_file "${http_server_block}${disable_suffix}" "$http_server_block" + is_boolean_yes "$enable_https" && [[ -e "${https_server_block}${disable_suffix}" ]] && rename_conf_file "${https_server_block}${disable_suffix}" "$https_server_block" + # Update only configuration files without the '.disabled' suffix + if [[ -e "$http_server_block" ]]; then + if is_file_writable "$http_server_block"; then + update_common_server_block_config "$http_server_block" + # Update specific server block config (listen addresses) + replace_in_file "$http_server_block" "^\s*listen\s.*;" "$http_listen_configuration" + else + warn "The ${app} server block file '${http_server_block}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + fi + if [[ -e "$https_server_block" ]]; then + if is_file_writable "$https_server_block"; then + update_common_server_block_config "$https_server_block" + # Update specific server block config (listen addresses) + replace_in_file "$https_server_block" "^\s*listen\s.*\sssl;" "$https_listen_configuration" + else + warn "The ${app} server block file '${https_server_block}' is not writable. Configurations based on environment variables will not be applied for this file." + fi + fi +} + +######################## +# Run custom initialization scripts +# Globals: +# NGINX_* +# Arguments: +# None +# Returns: +# None +######################### +nginx_custom_init_scripts() { + if [[ -n $(find "${NGINX_INITSCRIPTS_DIR}/" -type f -regex ".*\.sh") ]]; then + info "Loading user's custom files from $NGINX_INITSCRIPTS_DIR ..." + local -r tmp_file="/tmp/filelist" + find "${NGINX_INITSCRIPTS_DIR}/" -type f -regex ".*\.sh" | sort >"$tmp_file" + while read -r f; do + case "$f" in + *.sh) + if [[ -x "$f" ]]; then + debug "Executing $f" + "$f" + else + debug "Sourcing $f" + . "$f" + fi + ;; + *) + debug "Ignoring $f" + ;; + esac + done <$tmp_file + nginx_stop + rm -f "$tmp_file" + else + info "No custom scripts in $NGINX_INITSCRIPTS_DIR" + fi +} + +######################## +# Generate sample TLS certificates without passphrase for sample HTTPS server_block +# Globals: +# NGINX_* +# Arguments: +# None +# Returns: +# None +######################### +nginx_generate_sample_certs() { + local certs_dir="${NGINX_CONF_DIR}/bitnami/certs" + + if ! is_boolean_yes "$NGINX_SKIP_SAMPLE_CERTS" && [[ ! -f "${certs_dir}/server.crt" ]]; then + # Check certificates directory exists and is writable + if [[ -d "$certs_dir" && -w "$certs_dir" ]]; then + SSL_KEY_FILE="${certs_dir}/server.key" + SSL_CERT_FILE="${certs_dir}/server.crt" + SSL_CSR_FILE="${certs_dir}/server.csr" + SSL_SUBJ="/CN=example.com" + SSL_EXT="subjectAltName=DNS:example.com,DNS:www.example.com,IP:127.0.0.1" + rm -f "$SSL_KEY_FILE" "$SSL_CERT_FILE" + openssl genrsa -out "$SSL_KEY_FILE" 4096 + # OpenSSL version 1.0.x does not use the same parameters as OpenSSL >= 1.1.x + if [[ "$(openssl version | grep -oE "[0-9]+\.[0-9]+")" == "1.0" ]]; then + openssl req -new -sha256 -out "$SSL_CSR_FILE" -key "$SSL_KEY_FILE" -nodes -subj "$SSL_SUBJ" + else + openssl req -new -sha256 -out "$SSL_CSR_FILE" -key "$SSL_KEY_FILE" -nodes -subj "$SSL_SUBJ" -addext "$SSL_EXT" + fi + openssl x509 -req -sha256 -in "$SSL_CSR_FILE" -signkey "$SSL_KEY_FILE" -out "$SSL_CERT_FILE" -days 1825 -extfile <(echo -n "$SSL_EXT") + rm -f "$SSL_CSR_FILE" + else + warn "The certificates directories '${certs_dir}' does not exist or is not writable, skipping sample HTTPS certificates generation" + fi + fi +} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx-env.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx-env.sh new file mode 100644 index 000000000000..1d584e7b82c1 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx-env.sh @@ -0,0 +1,80 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 +# +# Environment configuration for nginx + +# The values for all environment variables will be set in the below order of precedence +# 1. Custom environment variables defined below after Bitnami defaults +# 2. Constants defined in this file (environment variables with no default), i.e. BITNAMI_ROOT_DIR +# 3. Environment variables overridden via external files using *_FILE variables (see below) +# 4. Environment variables set externally (i.e. current Bash context/Dockerfile/userdata) + +# Load logging library +# shellcheck disable=SC1090,SC1091 +. /opt/bitnami/scripts/liblog.sh + +export BITNAMI_ROOT_DIR="/opt/bitnami" +export BITNAMI_VOLUME_DIR="/bitnami" + +# Logging configuration +export MODULE="${MODULE:-nginx}" +export BITNAMI_DEBUG="${BITNAMI_DEBUG:-false}" + +# By setting an environment variable matching *_FILE to a file path, the prefixed environment +# variable will be overridden with the value specified in that file +nginx_env_vars=( + NGINX_HTTP_PORT_NUMBER + NGINX_HTTPS_PORT_NUMBER + NGINX_SKIP_SAMPLE_CERTS + NGINX_ENABLE_ABSOLUTE_REDIRECT + NGINX_ENABLE_PORT_IN_REDIRECT +) +for env_var in "${nginx_env_vars[@]}"; do + file_env_var="${env_var}_FILE" + if [[ -n "${!file_env_var:-}" ]]; then + if [[ -r "${!file_env_var:-}" ]]; then + export "${env_var}=$(< "${!file_env_var}")" + unset "${file_env_var}" + else + warn "Skipping export of '${env_var}'. '${!file_env_var:-}' is not readable." + fi + fi +done +unset nginx_env_vars +export WEB_SERVER_TYPE="nginx" + +# Paths +export NGINX_BASE_DIR="${BITNAMI_ROOT_DIR}/nginx" +export NGINX_VOLUME_DIR="${BITNAMI_VOLUME_DIR}/nginx" +export NGINX_SBIN_DIR="${NGINX_BASE_DIR}/sbin" +export NGINX_CONF_DIR="${NGINX_BASE_DIR}/conf" +export NGINX_HTDOCS_DIR="${NGINX_BASE_DIR}/html" +export NGINX_TMP_DIR="${NGINX_BASE_DIR}/tmp" +export NGINX_LOGS_DIR="${NGINX_BASE_DIR}/logs" +export NGINX_SERVER_BLOCKS_DIR="${NGINX_CONF_DIR}/server_blocks" +export NGINX_INITSCRIPTS_DIR="/docker-entrypoint-initdb.d" +export NGINX_CONF_FILE="${NGINX_CONF_DIR}/nginx.conf" +export NGINX_PID_FILE="${NGINX_TMP_DIR}/nginx.pid" +export PATH="${NGINX_SBIN_DIR}:${BITNAMI_ROOT_DIR}/common/bin:${PATH}" + +# System users (when running with a privileged user) +export NGINX_DAEMON_USER="daemon" +export WEB_SERVER_DAEMON_USER="$NGINX_DAEMON_USER" +export NGINX_DAEMON_GROUP="daemon" +export WEB_SERVER_DAEMON_GROUP="$NGINX_DAEMON_GROUP" +export NGINX_DEFAULT_HTTP_PORT_NUMBER="8080" +export WEB_SERVER_DEFAULT_HTTP_PORT_NUMBER="$NGINX_DEFAULT_HTTP_PORT_NUMBER" # only used at build time +export NGINX_DEFAULT_HTTPS_PORT_NUMBER="8443" +export WEB_SERVER_DEFAULT_HTTPS_PORT_NUMBER="$NGINX_DEFAULT_HTTPS_PORT_NUMBER" # only used at build time + +# NGINX configuration +export NGINX_HTTP_PORT_NUMBER="${NGINX_HTTP_PORT_NUMBER:-}" +export WEB_SERVER_HTTP_PORT_NUMBER="$NGINX_HTTP_PORT_NUMBER" +export NGINX_HTTPS_PORT_NUMBER="${NGINX_HTTPS_PORT_NUMBER:-}" +export WEB_SERVER_HTTPS_PORT_NUMBER="$NGINX_HTTPS_PORT_NUMBER" +export NGINX_SKIP_SAMPLE_CERTS="${NGINX_SKIP_SAMPLE_CERTS:-false}" +export NGINX_ENABLE_ABSOLUTE_REDIRECT="${NGINX_ENABLE_ABSOLUTE_REDIRECT:-no}" +export NGINX_ENABLE_PORT_IN_REDIRECT="${NGINX_ENABLE_PORT_IN_REDIRECT:-no}" + +# Custom environment variables may be defined below diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-http-server-block.conf.tpl b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-http-server-block.conf.tpl new file mode 100644 index 000000000000..4ebeed573889 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-http-server-block.conf.tpl @@ -0,0 +1,16 @@ +{{external_configuration}} + +server { + # Port to listen on, can also be set in IP:PORT format + {{http_listen_configuration}} + + root {{document_root}}; + + {{server_name_configuration}} + + {{acl_configuration}} + + {{additional_configuration}} + + include "/opt/bitnami/nginx/conf/bitnami/*.conf"; +} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-https-server-block.conf.tpl b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-https-server-block.conf.tpl new file mode 100644 index 000000000000..02acfbb055c6 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-https-server-block.conf.tpl @@ -0,0 +1,19 @@ +{{external_configuration}} + +server { + # Port to listen on, can also be set in IP:PORT format + {{https_listen_configuration}} + + root {{document_root}}; + + {{server_name_configuration}} + + ssl_certificate bitnami/certs/server.crt; + ssl_certificate_key bitnami/certs/server.key; + + {{acl_configuration}} + + {{additional_configuration}} + + include "/opt/bitnami/nginx/conf/bitnami/*.conf"; +} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-php-prefix.conf.tpl b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-php-prefix.conf.tpl new file mode 100644 index 000000000000..28bb0393aaa3 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-php-prefix.conf.tpl @@ -0,0 +1,10 @@ +location ^~ {{location}} { + alias "{{document_root}}"; + + {{acl_configuration}} + + include "/opt/bitnami/nginx/conf/bitnami/protect-hidden-files.conf"; + include "/opt/bitnami/nginx/conf/bitnami/php-fpm.conf"; +} + +{{additional_configuration}} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-prefix.conf.tpl b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-prefix.conf.tpl new file mode 100644 index 000000000000..b7d04e1e80f7 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/app-prefix.conf.tpl @@ -0,0 +1,9 @@ +location ^~ {{location}} { + alias "{{document_root}}"; + + {{acl_configuration}} + + include "/opt/bitnami/nginx/conf/bitnami/protect-hidden-files.conf"; +} + +{{additional_configuration}} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/default-https-server-block.conf b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/default-https-server-block.conf new file mode 100644 index 000000000000..27284a637c31 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/bitnami-templates/default-https-server-block.conf @@ -0,0 +1,17 @@ +# HTTPS Server +server { + # Port to listen on, can also be set in IP:PORT format + listen 443 ssl; + + ssl_certificate bitnami/certs/server.crt; + ssl_certificate_key bitnami/certs/server.key; + + include "/opt/bitnami/nginx/conf/bitnami/*.conf"; + + location /status { + stub_status on; + access_log off; + allow 127.0.0.1; + deny all; + } +} diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/entrypoint.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/entrypoint.sh new file mode 100755 index 000000000000..cce4b3e874a3 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/entrypoint.sh @@ -0,0 +1,28 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libbitnami.sh +. /opt/bitnami/scripts/libnginx.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +print_welcome_page + +if [[ "$1" = "/opt/bitnami/scripts/nginx/run.sh" ]]; then + info "** Starting NGINX setup **" + /opt/bitnami/scripts/nginx/setup.sh + info "** NGINX setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/postunpack.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/postunpack.sh new file mode 100755 index 000000000000..2ebe0fb36870 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/postunpack.sh @@ -0,0 +1,74 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libnginx.sh +. /opt/bitnami/scripts/libfs.sh + +# Auxiliar Functions + +######################## +# Unset HTTP_PROXY header to protect vs HTTPPOXY vulnerability +# Ref: https://www.digitalocean.com/community/tutorials/how-to-protect-your-server-against-the-httpoxy-vulnerability +# Globals: +# NGINX_* +# Arguments: +# None +# Returns: +# None +######################### +nginx_patch_httpoxy_vulnerability() { + debug "Unsetting HTTP_PROXY header..." + echo '# Unset the HTTP_PROXY header' >>"${NGINX_CONF_DIR}/fastcgi_params" + echo 'fastcgi_param HTTP_PROXY "";' >>"${NGINX_CONF_DIR}/fastcgi_params" +} + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +# Remove unnecessary directories that come with the tarball +rm -rf "${BITNAMI_ROOT_DIR}/certs" "${BITNAMI_ROOT_DIR}/server_blocks" + +# Ensure non-root user has write permissions on a set of directories +for dir in "$NGINX_VOLUME_DIR" "$NGINX_CONF_DIR" "$NGINX_INITSCRIPTS_DIR" "$NGINX_SERVER_BLOCKS_DIR" "${NGINX_CONF_DIR}/bitnami" "${NGINX_CONF_DIR}/bitnami/certs" "$NGINX_LOGS_DIR" "$NGINX_TMP_DIR"; do + ensure_dir_exists "$dir" + chmod -R g+rwX "$dir" +done + +# Unset HTTP_PROXY header to protect vs HTTPPOXY vulnerability +nginx_patch_httpoxy_vulnerability + +# Configure default HTTP port +nginx_configure_port "$NGINX_DEFAULT_HTTP_PORT_NUMBER" +# Configure default HTTPS port +nginx_configure_port "$NGINX_DEFAULT_HTTPS_PORT_NUMBER" "${BITNAMI_ROOT_DIR}/scripts/nginx/bitnami-templates/default-https-server-block.conf" + +# shellcheck disable=SC1091 + +# Load additional libraries +. /opt/bitnami/scripts/libfs.sh + +# Users can mount their html sites at /app +mv "${NGINX_BASE_DIR}/html" /app +ln -sf /app "${NGINX_BASE_DIR}/html" + +# Users can mount their certificates at /certs +mv "${NGINX_CONF_DIR}/bitnami/certs" /certs +ln -sf /certs "${NGINX_CONF_DIR}/bitnami/certs" + +ln -sf "/dev/stdout" "${NGINX_LOGS_DIR}/access.log" +ln -sf "/dev/stderr" "${NGINX_LOGS_DIR}/error.log" + +# This file is necessary for avoiding the error +# "unable to write random state" +# Source: https://stackoverflow.com/questions/94445/using-openssl-what-does-unable-to-write-random-state-mean + +touch /.rnd && chmod g+rw /.rnd diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/reload.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/reload.sh new file mode 100755 index 000000000000..1b18ed6d9637 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/reload.sh @@ -0,0 +1,20 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libnginx.sh +. /opt/bitnami/scripts/liblog.sh + +# Load NGINX environment +. /opt/bitnami/scripts/nginx-env.sh + +info "** Reloading NGINX configuration **" +exec "${NGINX_SBIN_DIR}/nginx" -s reload diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/restart.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/restart.sh new file mode 100755 index 000000000000..deaa515bac32 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/restart.sh @@ -0,0 +1,19 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libnginx.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +/opt/bitnami/scripts/nginx/stop.sh +/opt/bitnami/scripts/nginx/start.sh diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/run.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/run.sh new file mode 100755 index 000000000000..a2f3b57114d0 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/run.sh @@ -0,0 +1,20 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libnginx.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +info "** Starting NGINX **" +exec "${NGINX_SBIN_DIR}/nginx" -c "$NGINX_CONF_FILE" -g "daemon off;" diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/setup.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/setup.sh new file mode 100755 index 000000000000..084490b6ac83 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/setup.sh @@ -0,0 +1,45 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/libnginx.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +# Ensure NGINX environment variables settings are valid +nginx_validate + +# Ensure NGINX is stopped when this script ends +trap "nginx_stop" EXIT + +# Ensure NGINX daemon user exists when running as 'root' +am_i_root && ensure_user_exists "$NGINX_DAEMON_USER" --group "$NGINX_DAEMON_GROUP" + +# Configure HTTPS sample block using generated SSL certs +nginx_generate_sample_certs + +# Run init scripts +nginx_custom_init_scripts + +# Fix logging issue when running as root +! am_i_root || chmod o+w "$(readlink /dev/stdout)" "$(readlink /dev/stderr)" + +# Configure HTTPS port number +if [[ -f "${NGINX_CONF_DIR}/bitnami/certs/server.crt" ]] && [[ -n "${NGINX_HTTPS_PORT_NUMBER:-}" ]] && [[ ! -f "${NGINX_SERVER_BLOCKS_DIR}/default-https-server-block.conf" ]] && is_file_writable "${NGINX_SERVER_BLOCKS_DIR}/default-https-server-block.conf"; then + cp "${BITNAMI_ROOT_DIR}/scripts/nginx/bitnami-templates/default-https-server-block.conf" "${NGINX_SERVER_BLOCKS_DIR}/default-https-server-block.conf" +fi + +# Initialize NGINX +nginx_initialize + diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/start.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/start.sh new file mode 100755 index 000000000000..1dc8e8e746dd --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/start.sh @@ -0,0 +1,34 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libnginx.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +error_code=0 + +if is_nginx_not_running; then + "${NGINX_SBIN_DIR}/nginx" -c "$NGINX_CONF_FILE" + if ! retry_while "is_nginx_running"; then + error "nginx did not start" + error_code=1 + else + info "nginx started" + fi +else + info "nginx is already running" +fi + +exit "$error_code" diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/status.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/status.sh new file mode 100755 index 000000000000..16b35ef1b0e8 --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/status.sh @@ -0,0 +1,23 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libnginx.sh +. /opt/bitnami/scripts/liblog.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +if is_nginx_running; then + info "nginx is already running" +else + info "nginx is not running" +fi diff --git a/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/stop.sh b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/stop.sh new file mode 100755 index 000000000000..bc6f4f3fd8aa --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/rootfs/opt/bitnami/scripts/nginx/stop.sh @@ -0,0 +1,34 @@ +#!/bin/bash +# Copyright VMware, Inc. +# SPDX-License-Identifier: APACHE-2.0 + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail +# set -o xtrace # Uncomment this line for debugging purposes + +# Load libraries +. /opt/bitnami/scripts/libnginx.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/liblog.sh + +# Load NGINX environment variables +. /opt/bitnami/scripts/nginx-env.sh + +error_code=0 + +if is_nginx_running; then + BITNAMI_QUIET=1 nginx_stop + if ! retry_while "is_nginx_not_running"; then + error "nginx could not be stopped" + error_code=1 + else + info "nginx stopped" + fi +else + info "nginx is not running" +fi + +exit "$error_code" diff --git a/bitnami/harbor-portal/2/debian-12/tags-info.yaml b/bitnami/harbor-portal/2/debian-12/tags-info.yaml new file mode 100644 index 000000000000..d7a5c175698d --- /dev/null +++ b/bitnami/harbor-portal/2/debian-12/tags-info.yaml @@ -0,0 +1,5 @@ +rolling-tags: +- "2" +- 2-debian-12 +- 2.10.0 +- latest