From 53db7ea3965f1e8e3464dde5b8918fe360028fb7 Mon Sep 17 00:00:00 2001 From: Bitnami Bot Date: Wed, 15 Apr 2020 14:40:11 +0000 Subject: [PATCH] 2.4.49-debian-10-r0 release --- bitnami/openldap/2/debian-10/Dockerfile | 27 ++ .../openldap/2/debian-10/docker-compose.yml | 19 + .../opt/bitnami/licenses/licenses.txt | 3 + .../opt/bitnami/scripts/libbitnami.sh | 52 +++ .../opt/bitnami/scripts/libcomponent.sh | 64 ++++ .../prebuildfs/opt/bitnami/scripts/libfile.sh | 60 ++++ .../prebuildfs/opt/bitnami/scripts/libfs.sh | 131 +++++++ .../prebuildfs/opt/bitnami/scripts/liblog.sh | 89 +++++ .../prebuildfs/opt/bitnami/scripts/libnet.sh | 130 +++++++ .../prebuildfs/opt/bitnami/scripts/libos.sh | 206 +++++++++++ .../opt/bitnami/scripts/libservice.sh | 115 ++++++ .../opt/bitnami/scripts/libvalidations.sh | 248 +++++++++++++ .../opt/bitnami/scripts/libversion.sh | 49 +++ .../rootfs/opt/bitnami/scripts/libopenldap.sh | 336 ++++++++++++++++++ .../bitnami/scripts/openldap/entrypoint.sh | 19 + .../bitnami/scripts/openldap/postunpack.sh | 25 ++ .../opt/bitnami/scripts/openldap/run.sh | 21 ++ .../opt/bitnami/scripts/openldap/setup.sh | 21 ++ bitnami/openldap/README.md | 256 ++++++++++++- bitnami/openldap/docker-compose.yml | 19 + 20 files changed, 1889 insertions(+), 1 deletion(-) create mode 100644 bitnami/openldap/2/debian-10/Dockerfile create mode 100644 bitnami/openldap/2/debian-10/docker-compose.yml create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libvalidations.sh create mode 100644 bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh create mode 100644 bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/libopenldap.sh create mode 100755 bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/entrypoint.sh create mode 100755 bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/postunpack.sh create mode 100755 bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/run.sh create mode 100755 bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/setup.sh create mode 100644 bitnami/openldap/docker-compose.yml diff --git a/bitnami/openldap/2/debian-10/Dockerfile b/bitnami/openldap/2/debian-10/Dockerfile new file mode 100644 index 000000000000..7d2b4932ca35 --- /dev/null +++ b/bitnami/openldap/2/debian-10/Dockerfile @@ -0,0 +1,27 @@ +FROM docker.io/bitnami/minideb:buster +LABEL maintainer "Bitnami " + +ENV HOME="/" \ + OS_ARCH="amd64" \ + OS_FLAVOUR="debian-10" \ + OS_NAME="linux" + +COPY prebuildfs / +# Install required system packages and dependencies +RUN install_packages ca-certificates curl libc6 libdb5.3 libltdl7 libnss3-tools libodbc1 libperl5.28 libsasl2-2 libssl1.1 libwrap0 mdbtools procps sudo unzip +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "openldap" "2.4.49-0" --checksum 63ddad37aaffbc20e26b5db363dec787aa142d16f47a097b072bdb709d9d1260 +RUN . /opt/bitnami/scripts/libcomponent.sh && component_unpack "gosu" "1.11.0-3" --checksum c18bb8bcc95aa2494793ed5a506c4d03acc82c8c60ad061d5702e0b4048f0cb1 +RUN apt-get update && apt-get upgrade -y && \ + rm -r /var/lib/apt/lists /var/cache/apt/archives + +COPY rootfs / +RUN /opt/bitnami/scripts/openldap/postunpack.sh +ENV BITNAMI_APP_NAME="openldap" \ + BITNAMI_IMAGE_VERSION="2.4.49-debian-10-r0" \ + PATH="/opt/bitnami/openldap/bin:/opt/bitnami/common/bin:/opt/bitnami/openldap/sbin:$PATH" + +EXPOSE 1389 1636 + +USER 1001 +ENTRYPOINT [ "/opt/bitnami/scripts/openldap/entrypoint.sh" ] +CMD [ "/opt/bitnami/scripts/openldap/run.sh" ] diff --git a/bitnami/openldap/2/debian-10/docker-compose.yml b/bitnami/openldap/2/debian-10/docker-compose.yml new file mode 100644 index 000000000000..ee523247433f --- /dev/null +++ b/bitnami/openldap/2/debian-10/docker-compose.yml @@ -0,0 +1,19 @@ +version: '2' + +services: + openldap: + image: bitnami/openldap:2 + ports: + - '1389:1389' + - '1636:1636' + environment: + - LDAP_ADMIN_USERNAME=admin + - LDAP_ADMIN_PASSWORD=adminpassword + - LDAP_USERS=user01,user02 + - LDAP_PASSWORDS=password1,password2 + volumes: + - 'openldap_data:/bitnami/openldap' + +volumes: + openldap_data: + driver: local diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt new file mode 100644 index 000000000000..c76ba31f3b8a --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/licenses/licenses.txt @@ -0,0 +1,3 @@ +Bitnami containers ship with software bundles. You can find the licenses under: +/opt/bitnami/nami/COPYING +/opt/bitnami/[name-of-bundle]/licenses/[bundle-version].txt diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh new file mode 100644 index 000000000000..2160b50559cf --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libbitnami.sh @@ -0,0 +1,52 @@ +#!/bin/bash +# +# 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/bitnami-docker-${BITNAMI_APP_NAME}" + + log "" + log "${BOLD}Welcome to the Bitnami ${BITNAMI_APP_NAME} container${RESET}" + log "Subscribe to project updates by watching ${BOLD}${github_url}${RESET}" + log "Submit issues and feature requests at ${BOLD}${github_url}/issues${RESET}" + log "Send us your feedback at ${BOLD}containers@bitnami.com${RESET}" + log "" +} + diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh new file mode 100644 index 000000000000..025288664f69 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libcomponent.sh @@ -0,0 +1,64 @@ +#!/bin/bash +# +# Library for managing Bitnami components + +# Constants +CACHE_ROOT="/tmp/bitnami/pkg/cache" +DOWNLOAD_URL="https://downloads.bitnami.com/files/stacksmith" + +# Functions + +######################## +# Download and unpack a Bitnami package +# Globals: +# OS_NAME +# OS_ARCH +# OS_FLAVOUR +# Arguments: +# $1 - component's name +# $2 - component's version +# Returns: +# None +######################### +component_unpack() { + local name="${1:?name is required}" + local version="${2:?version is required}" + local base_name="${name}-${version}-${OS_NAME}-${OS_ARCH}-${OS_FLAVOUR}" + local package_sha256="" + + # Validate arguments + shift 2 + while [ "$#" -gt 0 ]; do + case "$1" in + -c|--checksum) + shift + package_sha256="${1:?missing package checksum}" + ;; + *) + echo "Invalid command line flag $1" >&2 + return 1 + ;; + esac + shift + done + + echo "Downloading $base_name package" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz" ]; then + echo "${CACHE_ROOT}/${base_name}.tar.gz already exists, skipping download." + cp "${CACHE_ROOT}/${base_name}.tar.gz" . + rm "${CACHE_ROOT}/${base_name}.tar.gz" + if [ -f "${CACHE_ROOT}/${base_name}.tar.gz.sha256" ]; then + echo "Using the local sha256 from ${CACHE_ROOT}/${base_name}.tar.gz.sha256" + package_sha256="$(< "${CACHE_ROOT}/${base_name}.tar.gz.sha256")" + rm "${CACHE_ROOT}/${base_name}.tar.gz.sha256" + fi + else + curl --remote-name --silent "${DOWNLOAD_URL}/${base_name}.tar.gz" + fi + if [ -n "$package_sha256" ]; then + echo "Verifying package integrity" + echo "$package_sha256 ${base_name}.tar.gz" | sha256sum --check - + fi + tar --directory /opt/bitnami --extract --gunzip --file "${base_name}.tar.gz" --no-same-owner --strip-components=2 "${base_name}/files/" + rm "${base_name}.tar.gz" +} diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh new file mode 100644 index 000000000000..337e2e779701 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfile.sh @@ -0,0 +1,60 @@ +#!/bin/bash +# +# Library for managing files + +# Functions + +######################## +# Replace a regex 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 + if [[ $posix_regex = true ]]; then + result="$(sed -E "s@$match_regex@$substitute_regex@g" "$filename")" + else + result="$(sed "s@$match_regex@$substitute_regex@g" "$filename")" + fi + 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" +} diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh new file mode 100644 index 000000000000..fac947bc44f2 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libfs.sh @@ -0,0 +1,131 @@ +#!/bin/bash +# +# 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}" + + chown "$owner":"$owner" "$path" +} + +######################## +# 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="${2:-}" + + mkdir -p "${dir}" + if [[ -n $owner ]]; then + owned_by "$dir" "$owner" + fi +} + +######################## +# Checks whether a directory is empty or not +# Arguments: +# $1 - directory +# Returns: +# Boolean +######################### +is_dir_empty() { + local dir="${1:?missing directory}" + + if [[ ! -e "$dir" ]] || [[ -z "$(ls -A "$dir")" ]]; then + true + else + false + fi +} + +######################## +# 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 + if [[ -n $dir_mode ]]; then + find -L "$p" -type d -exec chmod "$dir_mode" {} \; + fi + if [[ -n $file_mode ]]; then + find -L "$p" -type f -exec chmod "$file_mode" {} \; + fi + if [[ -n $user ]] && [[ -n $group ]]; then + chown -LR "$user":"$group" "$p" + elif [[ -n $user ]] && [[ -z $group ]]; then + chown -LR "$user" "$p" + elif [[ -z $user ]] && [[ -n $group ]]; then + chgrp -LR "$group" "$p" + fi + else + stderr_print "$p does not exist" + fi + done +} diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh new file mode 100644 index 000000000000..1285b05ba344 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/liblog.sh @@ -0,0 +1,89 @@ +#!/bin/bash +# +# 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 -r 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 -r 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 +} diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh new file mode 100644 index 000000000000..6cb749858648 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libnet.sh @@ -0,0 +1,130 @@ +#!/bin/bash +# +# Library for network functions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.sh + +# Functions + +######################## +# Resolve dns +# Arguments: +# $1 - Hostname to resolve +# Returns: +# IP +######################### +dns_lookup() { + local host="${1:?host is missing}" + getent ahosts "$host" | awk '/STREAM/ {print $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 10 minutes 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() { + dns_lookup "$(hostname)" +} + +######################## +# 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}]}" +} diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh new file mode 100644 index 000000000000..b6fc10db1518 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libos.sh @@ -0,0 +1,206 @@ +#!/bin/bash +# +# Library for operating system actions + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/liblog.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 +# Returns: +# None +######################### +ensure_group_exists() { + local group="${1:?group is missing}" + + if ! group_exists "$group"; then + groupadd "$group" >/dev/null 2>&1 + fi +} + +######################## +# Create an user in the system if it does not exist already +# Arguments: +# $1 - user +# $2 - group +# Returns: +# None +######################### +ensure_user_exists() { + local user="${1:?user is missing}" + local group="${2:-}" + + if ! user_exists "$user"; then + useradd "$user" >/dev/null 2>&1 + fi + + if [[ -n "$group" ]]; then + ensure_group_exists "$group" + usermod -a -G "$group" "$user" >/dev/null 2>&1 + 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 +} + +######################## +# 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: +# $1 - memory size (optional) +# Returns: +# Detected instance size +######################### +get_machine_size() { + local memory="${1:-}" + 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|G) ]]; then + size="${BASH_REMATCH[1]}" + unit="${BASH_REMATCH[2]}" + if [[ "$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 ${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 -r cmd="${1:?cmd is missing}" + local -r retries="${2:-12}" + local -r 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 +} diff --git a/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh new file mode 100644 index 000000000000..35c0163a9ef1 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libservice.sh @@ -0,0 +1,115 @@ +#!/bin/bash +# +# Library for managing services + +# 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 +# Returns: +# None +######################### +stop_service_using_pid() { + local pid_file="${1:?pid file is missing}" + local pid + + pid="$(get_pid_from_file "$pid_file")" + [[ -z "$pid" ]] || ! is_service_running "$pid" && return + + kill "$pid" + local counter=10 + while [[ "$counter" -ne 0 ]] && is_service_running "$pid"; do + sleep 1 + counter=$((counter - 1)) + done +} + +######################## +# Generate a monit configuration file for a given service +# Arguments: +# $1 - Service name +# $2 - Pid file +# $3 - Start command +# $4 - Stop command +# Returns: +# None +######################### +generate_monit_conf() { + local -r service_name="${1:?service name is missing}" + local -r pid_file="${2:?pid file is missing}" + local -r start_command="${3:?start command is missing}" + local -r stop_command="${4:?stop command is missing}" + local -r monit_conf_dir="/etc/monit/conf.d" + + mkdir -p "$monit_conf_dir" + cat >"${monit_conf_dir}/${service_name}.conf" <"${logrotate_conf_dir}/${service_name}" <= 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 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 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 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/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh new file mode 100644 index 000000000000..66d4f457bdd2 --- /dev/null +++ b/bitnami/openldap/2/debian-10/prebuildfs/opt/bitnami/scripts/libversion.sh @@ -0,0 +1,49 @@ +#!/bin/bash +# +# 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/openldap/2/debian-10/rootfs/opt/bitnami/scripts/libopenldap.sh b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/libopenldap.sh new file mode 100644 index 000000000000..e7a6ae0f64de --- /dev/null +++ b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/libopenldap.sh @@ -0,0 +1,336 @@ +#!/bin/bash +# +# Bitnami OpenLDAP library + +# shellcheck disable=SC1091 + +# Load Generic Libraries +. /opt/bitnami/scripts/libfile.sh +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libservice.sh +. /opt/bitnami/scripts/libvalidations.sh + +######################## +# Load global variables used on OpenLDAP configuration +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# Series of exports to be used as 'eval' arguments +######################### +ldap_env() { + cat << "EOF" +# Paths +export LDAP_BASE_DIR="/opt/bitnami/openldap" +export LDAP_BIN_DIR="${LDAP_BASE_DIR}/bin" +export LDAP_SBIN_DIR="${LDAP_BASE_DIR}/sbin" +export LDAP_CONF_DIR="${LDAP_BASE_DIR}/etc" +export LDAP_SHARE_DIR="${LDAP_BASE_DIR}/share" +export LDAP_VOLUME_DIR="/bitnami/openldap" +export LDAP_DATA_DIR="${LDAP_VOLUME_DIR}/data" +export LDAP_ONLINE_CONF_DIR="${LDAP_VOLUME_DIR}/slapd.d" +export LDAP_PID_FILE="${LDAP_BASE_DIR}/var/run/slapd.pid" +export PATH="${LDAP_BIN_DIR}:${LDAP_SBIN_DIR}:$PATH" +# Users +export LDAP_DAEMON_USER="slapd" +export LDAP_DAEMON_GROUP="slapd" +# Settings +export LDAP_PORT_NUMBER="${LDAP_PORT_NUMBER:-1389}" +export LDAP_LDAPS_PORT_NUMBER="${LDAP_LDAPS_PORT_NUMBER:-1636}" +export LDAP_ROOT="${LDAP_ROOT:-dc=example,dc=org}" +export LDAP_ADMIN_USERNAME="${LDAP_ADMIN_USERNAME:-admin}" +export LDAP_ADMIN_DN="${LDAP_ADMIN_USERNAME/#/cn=},${LDAP_ROOT}" +export LDAP_ADMIN_PASSWORD="${LDAP_ADMIN_PASSWORD:-adminpassword}" +export LDAP_ENCRYPTED_ADMIN_PASSWORD="$(echo -n $LDAP_ADMIN_PASSWORD | slappasswd -n -T /dev/stdin)" +export LDAP_SKIP_DEFAULT_TREE="${LDAP_SKIP_DEFAULT_TREE:-no}" +export LDAP_USERS="${LDAP_USERS:-user01,user02}" +export LDAP_PASSWORDS="${LDAP_PASSWORDS:-bitnami1,bitnami2}" +export LDAP_USER_DC="${LDAP_USER_DC:-users}" +export LDAP_GROUP="${LDAP_GROUP:-readers}" +EOF +} + +######################## +# Validate settings in LDAP_* environment variables +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# None +######################### +ldap_validate() { + info "Validating settings in LDAP_* env vars" + local error_code=0 + + # Auxiliary functions + print_validation_error() { + error "$1" + error_code=1 + } + check_allowed_port() { + local port_var="${1:?missing port variable}" + local validate_port_args=() + ! 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 + } + + if ! is_yes_no_value "$LDAP_SKIP_DEFAULT_TREE"; then + print_validation_error "The values allowed for LDAP_SKIP_DEFAULT_TREE are: yes or no" + fi + + read -r -a users <<< "$(tr ',;' ' ' <<< "${LDAP_USERS}")" + read -r -a passwords <<< "$(tr ',;' ' ' <<< "${LDAP_PASSWORDS}")" + if [[ "${#users[@]}" -ne "${#passwords[@]}" ]]; then + print_validation_error "Specify the same number of passwords on LDAP_PASSWORDS as the number of users on LDAP_USERS!" + fi + + if [[ -n "$LDAP_PORT_NUMBER" ]] && [[ -n "$LDAP_LDAPS_PORT_NUMBER" ]]; then + if [[ "$LDAP_PORT_NUMBER" -eq "$LDAP_LDAPS_PORT_NUMBER" ]]; then + print_validation_error "LDAP_PORT_NUMBER and LDAP_LDAPS_PORT_NUMBER are bound to the same port!" + fi + fi + [[ -n "$LDAP_PORT_NUMBER" ]] && check_allowed_port LDAP_PORT_NUMBER + [[ -n "$LDAP_LDAPS_PORT_NUMBER" ]] && check_allowed_port LDAP_LDAPS_PORT_NUMBER + + [[ "$error_code" -eq 0 ]] || exit "$error_code" +} + +######################## +# Check if OpenLDAP is running +# Globals: +# LDAP_PID_FILE +# Arguments: +# None +# Returns: +# Whether slapd is running +######################### +is_ldap_running() { + local pid + pid="$(get_pid_from_file "${LDAP_PID_FILE}")" + if [[ -n "${pid}" ]]; then + is_service_running "${pid}" + else + false + fi +} + +######################## +# Check if OpenLDAP is not running +# Arguments: +# None +# Returns: +# Whether slapd is not running +######################### +is_ldap_not_running() { + ! is_ldap_running +} + +######################## +# Start OpenLDAP server in background +# Arguments: +# None +# Returns: +# None +######################### +ldap_start_bg() { + local -a flags=("-h" "ldap://:${LDAP_PORT_NUMBER}/ ldapi:/// " "-F" "${LDAP_CONF_DIR}/slapd.d") + if is_ldap_not_running; then + info "Starting OpenLDAP server in background" + am_i_root && flags=("-u" "$LDAP_DAEMON_USER" "${flags[@]}") + debug_execute slapd "${flags[@]}" + fi +} + +######################## +# Stop OpenLDAP server +# Arguments: +# None +# Returns: +# None +######################### +ldap_stop() { + local pid + pid="$(get_pid_from_file "${LDAP_PID_FILE}")" + if is_ldap_running; then + kill "${pid}" 2>/dev/null + fi +} + +######################## +# Create LDAP online configuration +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# None +######################### +ldap_create_online_configuration() { + info "Creating LDAP online configuration" + + ! am_i_root && replace_in_file "${LDAP_SHARE_DIR}/slapd.ldif" "uidNumber=0" "uidNumber=$(id -u)" + debug_execute slapadd -F "$LDAP_ONLINE_CONF_DIR" -n 0 -l "${LDAP_SHARE_DIR}/slapd.ldif" +} + +######################## +# Configure LDAP credentials for admin user +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# None +######################### +ldap_admin_credentials() { + info "Configure LDAP credentials for admin user" + cat > "${LDAP_SHARE_DIR}/admin.ldif" << EOF +dn: olcDatabase={2}hdb,cn=config +changetype: modify +replace: olcSuffix +olcSuffix: $LDAP_ROOT + +dn: olcDatabase={2}hdb,cn=config +changetype: modify +replace: olcRootDN +olcRootDN: $LDAP_ADMIN_DN + +dn: olcDatabase={2}hdb,cn=config +changeType: modify +add: olcRootPW +olcRootPW: $LDAP_ENCRYPTED_ADMIN_PASSWORD + +dn: olcDatabase={1}monitor,cn=config +changetype: modify +replace: olcAccess +olcAccess: {0}to * by dn.base="gidNumber=0+uidNumber=0,cn=peercred,cn=external, cn=auth" read by dn.base="${LDAP_ADMIN_DN}" read by * none +EOF + debug_execute ldapmodify -Y EXTERNAL -H "ldapi:///" -f "${LDAP_SHARE_DIR}/admin.ldif" +} + +######################## +# Add LDAP schemas +# Globals: +# LDAP_* +# Arguments: +# None +# Returns +# None +######################### +ldap_add_schemas() { + info "Adding LDAP extra schemas" + debug_execute ldapadd -Y EXTERNAL -H "ldapi:///" -f "${LDAP_CONF_DIR}/schema/cosine.ldif" + debug_execute ldapadd -Y EXTERNAL -H "ldapi:///" -f "${LDAP_CONF_DIR}/schema/inetorgperson.ldif" + debug_execute ldapadd -Y EXTERNAL -H "ldapi:///" -f "${LDAP_CONF_DIR}/schema/nis.ldif" +} + +######################## +# Create LDAP tree +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# None +######################### +ldap_create_tree() { + info "Creating LDAP default tree" + cat > "${LDAP_SHARE_DIR}/tree.ldif" << EOF +# Root creation +dn: $LDAP_ROOT +objectClass: dcObject +objectClass: organization +dc: example +o: example + +dn: ${LDAP_USER_DC/#/ou=},${LDAP_ROOT} +objectClass: organizationalUnit +ou: users + +EOF + read -r -a users <<< "$(tr ',;' ' ' <<< "${LDAP_USERS}")" + read -r -a passwords <<< "$(tr ',;' ' ' <<< "${LDAP_PASSWORDS}")" + local index=0 + for user in "${users[@]}"; do + cat >> "${LDAP_SHARE_DIR}/tree.ldif" << EOF +# User $user creation +dn: ${user/#/cn=},${LDAP_USER_DC/#/ou=},${LDAP_ROOT} +cn: User$((index + 1 )) +sn: Bar$((index + 1 )) +objectClass: inetOrgPerson +objectClass: posixAccount +objectClass: shadowAccount +userPassword: ${passwords[$index]} +uid: $user +uidNumber: $((index + 1000 )) +gidNumber: $((index + 1000 )) +homeDirectory: /home/${user} + +EOF + index=$((index + 1 )) + done + cat >> "${LDAP_SHARE_DIR}/tree.ldif" << EOF +# Group creation +dn: ${LDAP_GROUP/#/ou=},${LDAP_USER_DC/#/ou=},${LDAP_ROOT} +cn: $LDAP_GROUP +objectClass: groupOfNames +member: ${users[@]/#/cn=},${LDAP_USER_DC/#/ou=},${LDAP_ROOT} + +EOF + debug_execute ldapadd -f "${LDAP_SHARE_DIR}/tree.ldif" -H "ldapi:///" -D "$LDAP_ADMIN_DN" -w "$LDAP_ADMIN_PASSWORD" +} + +######################## +# OpenLDAP configure perissions +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# None +######################### +ldap_configure_permissions() { + debug "Ensuring expected directories/files exist..." + for dir in "$LDAP_SHARE_DIR" "$LDAP_DATA_DIR" "$LDAP_ONLINE_CONF_DIR"; do + ensure_dir_exists "$dir" + if am_i_root; then + chown -R "$LDAP_DAEMON_USER:$LDAP_DAEMON_GROUP" "$dir" + fi + done +} + +######################## +# Initialize OpenLDAP server +# Globals: +# LDAP_* +# Arguments: +# None +# Returns: +# None +######################### +ldap_initialize() { + info "Initializing OpenLDAP..." + + ldap_configure_permissions + if ! is_dir_empty "$LDAP_DATA_DIR"; then + info "Using persisted data" + else + # Create OpenLDAP online configuration + ldap_create_online_configuration + ldap_start_bg + ldap_admin_credentials + if is_boolean_yes "$LDAP_SKIP_DEFAULT_TREE"; then + info "Skipping default schemas/tree structure" + else + # Initialize OpenLDAP with schemas/tree structure + ldap_add_schemas + ldap_create_tree + fi + ldap_stop + fi +} diff --git a/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/entrypoint.sh b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/entrypoint.sh new file mode 100755 index 000000000000..d8ee02cc9eed --- /dev/null +++ b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/entrypoint.sh @@ -0,0 +1,19 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail + +# Load libraries +. /opt/bitnami/scripts/liblog.sh + +if [[ "$*" = "/opt/bitnami/scripts/openldap/run.sh" ]]; then + info "** Starting LDAP setup **" + /opt/bitnami/scripts/openldap/setup.sh + info "** LDAP setup finished! **" +fi + +echo "" +exec "$@" diff --git a/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/postunpack.sh b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/postunpack.sh new file mode 100755 index 000000000000..61dc6e5dbd7e --- /dev/null +++ b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/postunpack.sh @@ -0,0 +1,25 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail + +# Load libraries +. /opt/bitnami/scripts/libfs.sh +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libopenldap.sh + +# Load LDAP environment variables +eval "$(ldap_env)" + +# Ensure non-root user has write permissions on a set of directories +for dir in "$LDAP_SHARE_DIR" "$LDAP_DATA_DIR" "$LDAP_ONLINE_CONF_DIR" "${LDAP_BASE_DIR}/var"; do + ensure_dir_exists "$dir" + chmod -R g+rwX "$dir" +done + +# Symlinks to normalize directories +ln -sf "$LDAP_ONLINE_CONF_DIR" "${LDAP_CONF_DIR}/slapd.d" +ln -sf "$LDAP_DATA_DIR" "${LDAP_BASE_DIR}/var/data" diff --git a/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/run.sh b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/run.sh new file mode 100755 index 000000000000..c65288294ebf --- /dev/null +++ b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/run.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +set -o errexit +set -o nounset +set -o pipefail + +# Load libraries +. /opt/bitnami/scripts/liblog.sh +. /opt/bitnami/scripts/libopenldap.sh + +# Load LDAP environment variables +eval "$(ldap_env)" + +readonly command="$(command -v slapd)" +# Add "@" so users can add extra command line flags +flags=("-h" "ldap://:${LDAP_PORT_NUMBER}/ ldapi:///" "-F" "${LDAP_CONF_DIR}/slapd.d" "-d" "256" "$@") + +info "** Starting slapd **" +am_i_root && flags=("-u" "$LDAP_DAEMON_USER" "${flags[@]}") +exec "${command}" "${flags[@]}" + diff --git a/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/setup.sh b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/setup.sh new file mode 100755 index 000000000000..0915a0ac7642 --- /dev/null +++ b/bitnami/openldap/2/debian-10/rootfs/opt/bitnami/scripts/openldap/setup.sh @@ -0,0 +1,21 @@ +#!/bin/bash + +# shellcheck disable=SC1091 + +set -o errexit +set -o nounset +set -o pipefail + +# Load libraries +. /opt/bitnami/scripts/libos.sh +. /opt/bitnami/scripts/libopenldap.sh + +# Load LDAP environment variables +eval "$(ldap_env)" + +# Ensure Open LDAP environment variables are valid +ldap_validate +# Ensure 'daemon' user exists when running as 'root' +am_i_root && ensure_user_exists "$LDAP_DAEMON_USER" "$LDAP_DAEMON_GROUP" +# Ensure Open LDAP server is initialize +ldap_initialize diff --git a/bitnami/openldap/README.md b/bitnami/openldap/README.md index 1333ed77b7e1..e5c8982ddf1a 100644 --- a/bitnami/openldap/README.md +++ b/bitnami/openldap/README.md @@ -1 +1,255 @@ -TODO +# What is OpenLDAP? + +> [OpenLDAP](https://openldap.org/) is the open-source solution for LDAP (Lightweight Directory Access Protocol). It is a protocol used to store and retrieve data from a hierarchical directory structure such as in databases. + +# TL;DR; + +```console +$ docker run --name openldap bitnami/openldap:latest +``` + +## Docker Compose + +```console +$ curl -sSL https://raw.githubusercontent.com/bitnami/bitnami-docker-openldap/master/docker-compose.yml > docker-compose.yml +$ docker-compose up -d +``` + +# Why use Bitnami Images? + +* Bitnami closely tracks upstream source changes and promptly publishes new versions of this image using our automated systems. +* With Bitnami images the latest bug fixes and features are available as soon as possible. +* Bitnami containers, virtual machines and cloud images use the same components and configuration approach - making it easy to switch between formats based on your project needs. +* All our images are based on [minideb](https://github.com/bitnami/minideb) a minimalist Debian based container image which gives you a small base container image and the familiarity of a leading linux distribution. +* All Bitnami images available in Docker Hub are signed with [Docker Content Trust (DTC)](https://docs.docker.com/engine/security/trust/content_trust/). You can use `DOCKER_CONTENT_TRUST=1` to verify the integrity of the images. +* Bitnami container images are released daily with the latest distribution packages available. + +> This [CVE scan report](https://quay.io/repository/bitnami/openldap?tab=tags) contains a security report with all open CVEs. To get the list of actionable security issues, find the "latest" tag, click the vulnerability report link under the corresponding "Security scan" field and then select the "Only show fixable" filter on the next page. + +# Why use a non-root container? + +Non-root container images add an extra layer of security and are generally recommended for production environments. However, because they run as a non-root user, privileged tasks are typically off-limits. Learn more about non-root containers [in our docs](https://docs.bitnami.com/containers/how-to/work-with-non-root-containers/). + +# Supported tags and respective `Dockerfile` links + +Learn more about the Bitnami tagging policy and the difference between rolling tags and immutable tags [in our documentation page](https://docs.bitnami.com/containers/how-to/understand-rolling-tags-containers/). + + +* [`2-debian-10`, `2.4.49-debian-10-r0`, `2`, `2.4.49`, `latest` (2/debian-10/Dockerfile)](https://github.com/bitnami/bitnami-docker-openldap/blob/2.4.49-debian-10-r0/2/debian-10/Dockerfile) + +Subscribe to project updates by watching the [bitnami/openldap GitHub repo](https://github.com/bitnami/bitnami-docker-openldap). + +# Get this image + +The recommended way to get the Bitnami OpenLDAP Docker Image is to pull the prebuilt image from the [Docker Hub Registry](https://hub.docker.com/r/bitnami/openldap). + +```console +$ docker pull bitnami/openldap:latest +``` + +To use a specific version, you can pull a versioned tag. You can view the [list of available versions](https://hub.docker.com/r/bitnami/openldap/tags/) in the Docker Hub Registry. + +```console +$ docker pull bitnami/openldap:[TAG] +``` + +If you wish, you can also build the image yourself. + +```console +$ docker build -t bitnami/openldap:latest 'https://github.com/bitnami/bitnami-docker-openldap.git#master:2/debian-10' +``` + +# Connecting to other containers + +Using [Docker container networking](https://docs.docker.com/engine/userguide/networking/), a different server running inside a container can easily be accessed by your application containers and vice-versa. + +Containers attached to the same network can communicate with each other using the container name as the hostname. + +## Using the Command Line + +In this example, we will use a MariaDB Galera instance that will use a OpenLDAP instance that is running on the same docker network to manage authentication. + +### Step 1: Create a network + +```console +$ docker network create my-network --driver bridge +``` + +### Step 2: Launch the OpenLDAP server instance + +Use the `--network ` argument to the `docker run` command to attach the container to the `my-network` network. + +```console +$ docker run --detach --rm --name openldap \ + --network my-network \ + --env LDAP_ADMIN_USERNAME=admin \ + --env LDAP_ADMIN_PASSWORD=adminpassword \ + --env LDAP_USERS=customuser \ + --env LDAP_PASSWORDS=custompassword \ + bitnami/openldap:latest +``` + +### Step 3: Launch the MariaDB Galera server instance + +Use the `--network ` argument to the `docker run` command to attach the container to the `my-network` network. + +```console +$ docker run --detach --rm --name mariadb-galera \ + --network my-network \ + --env MARIADB_ROOT_PASSWORD=root-password \ + --env MARIADB_GALERA_MARIABACKUP_PASSWORD=backup-password \ + --env MARIADB_USER=customuser \ + --env MARIADB_DATABASE=customdatabase \ + --env MARIADB_ENABLE_LDAP=yes \ + --env LDAP_URI=ldap://openldap:1389 \ + --env LDAP_BASE=dc=example,dc=org \ + --env LDAP_BIND_DN=cn=admin,dc=example,dc=org \ + --env LDAP_BIND_PASSWORD=adminpassword \ + bitnami/mariadb-galera:latest +``` + +### Step 4: Launch the MariaDB client and test you can authenticate using LDAP credentials + +Finally we create a new container instance to launch the MariaDB client and connect to the server created in the previous step: + +```console +$ docker run -it --rm --name mariadb-client \ + --network my-network \ + bitnami/mariadb-galera:latest mysql -h mariadb-galera -u customuser -D customdatabase -pcustompassword +``` + +## Using Docker Compose + +When not specified, Docker Compose automatically sets up a new network and attaches all deployed services to that network. However, we will explicitly define a new `bridge` network named `my-network`. In this example we assume that you want to connect to the OpenLDAP server from your own custom application image which is identified in the following snippet by the service name `myapp`. + +```yaml +version: '2' + +networks: + my-network: + driver: bridge +services: + openldap: + image: bitnami/openldap:2 + ports: + - '1389:1389' + - '1636:1636' + environment: + - LDAP_ADMIN_USERNAME=admin + - LDAP_ADMIN_PASSWORD=adminpassword + - LDAP_USERS=user01,user02 + - LDAP_PASSWORDS=password1,password2 + networks: + - my-network + volumes: + - 'openldap_data:/bitnami/openldap' + myapp: + image: 'YOUR_APPLICATION_IMAGE' + networks: + - my-network +volumes: + openldap_data: + driver: local +``` + +> **IMPORTANT**: +> +> 1. Please update the **YOUR_APPLICATION_IMAGE_** placeholder in the above snippet with your application image +> 2. In your application container, use the hostname `openldap` to connect to the OpenLDAP server + +Launch the containers using: + +```console +$ docker-compose up -d +``` + +# Configuration + +The Bitnami Docker OpenLDAP can be easily setup with the following environment variables: + +- `LDAP_PORT_NUMBER`: The port OpenLDAP is listening for requests. Default: **1389** (non privileged port) +- `LDAP_ROOT`: LDAP database root node of the LDAP tree. Default: **dc=example,dc=org** +- `LDAP_ADMIN_USERNAME`: LDAP database admin user. Default: **admin** +- `LDAP_ADMIN_PASSWORD`: LDAP database admin password. Default: **adminpassword** +- `LDAP_USERS`: Comma separated list of LDAP users to create in the default LDAP tree. Default: **user01,user02** +- `LDAP_PASSWORDS`: Comma separated list of passwords to use for LDAP users. Default: **bitnami1,bitnami2** +- `LDAP_USER_DC`: DC for the users' organizational unit. Default: **users** +- `LDAP_GROUP`: Group used to group created users. Default: **readers** +- `LDAP_SKIP_DEFAULT_TREE`: Whether to skip creating the default LDAP tree based on `LDAP_USERS`, `LDAP_PASSWORDS`, `LDAP_USER_DC` and `LDAP_GROUP`. Default: **no** + +Check the official [OpenLDAP Configuration Reference](https://www.openldap.org/doc/admin24/guide.html) for more information about how to configure OpenLDAP. + +# Logging + +The Bitnami OpenLDAP Docker image sends the container logs to `stdout`. To view the logs: + +```console +$ docker logs openldap +``` + +You can configure the containers [logging driver](https://docs.docker.com/engine/admin/logging/overview/) using the `--log-driver` option if you wish to consume the container logs differently. In the default configuration docker uses the `json-file` driver. + +# Maintenance + +## Upgrade this image + +Bitnami provides up-to-date versions of OpenLDAP, including security patches, soon after they are made upstream. We recommend that you follow these steps to upgrade your container. + +### Step 1: Get the updated image + +```console +$ docker pull bitnami/openldap:latest +``` + +### Step 2: Stop the running container + +Stop the currently running container using the command + +```console +$ docker stop openldap +``` + +### Step 3: Remove the currently running container + +```console +$ docker rm -v openldap +``` + +### Step 4: Run the new image + +Re-create your container from the new image. + +```console +$ docker run --name openldap bitnami/openldap:latest +``` + + +# Contributing + +We'd love for you to contribute to this container. You can request new features by creating an [issue](https://github.com/bitnami/bitnami-docker-openldap/issues), or submit a [pull request](https://github.com/bitnami/bitnami-docker-openldap/pulls) with your contribution. + +# Issues + +If you encountered a problem running this container, you can file an [issue](https://github.com/bitnami/bitnami-docker-openldap/issues/new). For us to provide better support, be sure to include the following information in your issue: + +- Host OS and version +- Docker version (`docker version`) +- Output of `docker info` +- Version of this container +- The command you used to run the container, and any relevant output you saw (masking any sensitive information) + +# License + +Copyright 2020 Bitnami + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/bitnami/openldap/docker-compose.yml b/bitnami/openldap/docker-compose.yml new file mode 100644 index 000000000000..ee523247433f --- /dev/null +++ b/bitnami/openldap/docker-compose.yml @@ -0,0 +1,19 @@ +version: '2' + +services: + openldap: + image: bitnami/openldap:2 + ports: + - '1389:1389' + - '1636:1636' + environment: + - LDAP_ADMIN_USERNAME=admin + - LDAP_ADMIN_PASSWORD=adminpassword + - LDAP_USERS=user01,user02 + - LDAP_PASSWORDS=password1,password2 + volumes: + - 'openldap_data:/bitnami/openldap' + +volumes: + openldap_data: + driver: local