#!/usr/bin/env bash
-
set -e
set -u
set -o pipefail
# Get the directory in which this script is stored
SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-
-# directory for config, private key and certificates
BASEDIR="${SCRIPTDIR}"
-# Default config values
-CA="https://acme-v01.api.letsencrypt.org/directory"
-LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
-HOOK=
-RENEW_DAYS="14"
-PRIVATE_KEY=
-KEYSIZE="4096"
-WELLKNOWN=
-PRIVATE_KEY_RENEW="no"
-OPENSSL_CNF="$(openssl version -d | cut -d'"' -f2)/openssl.cnf"
-CONTACT_EMAIL=
-
-set_defaults() {
- # Default config variables depending on BASEDIR
- if [[ -z "${PRIVATE_KEY}" ]]; then
- PRIVATE_KEY="${BASEDIR}/private_key.pem"
- fi
- if [[ -z "${WELLKNOWN}" ]]; then
- WELLKNOWN="${BASEDIR}/.acme-challenges"
- fi
-
- LOCKFILE="${BASEDIR}/lock"
+# Check for script dependencies
+check_dependencies() {
+ curl -V > /dev/null 2>&1 || _exiterr "This script requires curl."
+ openssl version > /dev/null 2>&1 || _exiterr "This script requres an openssl binary."
+ sed -E "" < /dev/null > /dev/null 2>&1 || _exiterr "This script requres sed with support for extended (modern) regular expressions."
+ grep -V > /dev/null 2>&1 || _exiterr "This script requres grep."
+ mktemp -u -t XXXXXX > /dev/null 2>&1 || _exiterr "This script requires mktemp."
}
-init_system() {
+# Setup default config values, search for and load configuration files
+load_config() {
# Check for config in various locations
if [[ -z "${CONFIG:-}" ]]; then
- for check_config in "${HOME}/.letsencrypt.sh" "/etc/letsencrypt.sh" "/usr/local/etc/letsencrypt.sh" "${PWD}" "${SCRIPTDIR}"; do
+ for check_config in "/etc/letsencrypt.sh" "/usr/local/etc/letsencrypt.sh" "${PWD}" "${SCRIPTDIR}"; do
if [[ -e "${check_config}/config.sh" ]]; then
BASEDIR="${check_config}"
CONFIG="${check_config}/config.sh"
done
fi
+ # Default values
+ CA="https://acme-v01.api.letsencrypt.org/directory"
+ LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
+ CHALLENGETYPE="http-01"
+ HOOK=
+ RENEW_DAYS="30"
+ PRIVATE_KEY="${BASEDIR}/private_key.pem"
+ KEYSIZE="4096"
+ WELLKNOWN="${BASEDIR}/.acme-challenges"
+ PRIVATE_KEY_RENEW="no"
+ OPENSSL_CNF="$(openssl version -d | cut -d'"' -f2)/openssl.cnf"
+ CONTACT_EMAIL=
+ LOCKFILE="${BASEDIR}/lock"
+
if [[ -z "${CONFIG:-}" ]]; then
- echo "WARNING: No config file found, using default config!"
- sleep 2
+ echo "#" >&2
+ echo "# !! WARNING !! No config file found, using default config!" >&2
+ echo "#" >&2
elif [[ -e "${CONFIG}" ]]; then
- if [[ ! "${COMMAND}" = "env" ]]; then
- echo "Using config file ${CONFIG}"
- fi
+ echo "# INFO: Using config file ${CONFIG}"
BASEDIR="$(dirname "${CONFIG}")"
# shellcheck disable=SC1090
. "${CONFIG}"
else
- echo "ERROR: Specified config file doesn't exist."
- exit 1
+ _exiterr "Specified config file doesn't exist."
fi
# Remove slash from end of BASEDIR. Mostly for cleaner outputs, doesn't change functionality.
BASEDIR="${BASEDIR%%/}"
# Check BASEDIR and set default variables
- if [[ ! -d "${BASEDIR}" ]]; then
- echo "ERROR: BASEDIR does not exist: ${BASEDIR}"
- exit 1
- fi
- set_defaults
+ [[ -d "${BASEDIR}" ]] || _exiterr "BASEDIR does not exist: ${BASEDIR}"
- if [[ "${COMMAND}" = "env" ]]; then
- return
- fi
+ [[ -n "${PARAM_HOOK:-}" ]] && HOOK="${PARAM_HOOK}"
+ [[ -n "${PARAM_CHALLENGETYPE:-}" ]] && CHALLENGETYPE="${PARAM_CHALLENGETYPE}"
- # Lockfile handling (prevents concurrent access)
- set -o noclobber
- if ! { date > "${LOCKFILE}"; } 2>/dev/null; then
- echo " + ERROR: Lock file '${LOCKFILE}' present, aborting." >&2
- LOCKFILE="" # so remove_lock doesn't remove it
- exit 1
+ [[ "${CHALLENGETYPE}" =~ (http-01|dns-01) ]] || _exiterr "Unknown challenge type ${CHALLENGETYPE}... can not continue."
+ if [[ "${CHALLENGETYPE}" = "dns-01" ]] && [[ -z "${HOOK}" ]]; then
+ _exiterr "Challenge type dns-01 needs a hook script for deployment... can not continue."
fi
- set +o noclobber
+}
- remove_lock() {
- if [[ -n "${LOCKFILE}" ]]; then
- rm -f "${LOCKFILE}"
- fi
- }
- trap 'remove_lock' EXIT
+# Initialize system
+init_system() {
+ load_config
- # Export some environment variables to be used in hook script
- export WELLKNOWN
- export BASEDIR
- export CONFIG
+ # Lockfile handling (prevents concurrent access)
+ LOCKDIR="$(dirname "${LOCKFILE}")"
+ [[ -w "${LOCKDIR}" ]] || _exiterr "Directory ${LOCKDIR} for LOCKFILE ${LOCKFILE} is not writable, aborting."
+ ( set -C; date > "${LOCKFILE}" ) 2>/dev/null || _exiterr "Lock file '${LOCKFILE}' present, aborting."
+ remove_lock() { rm -f "${LOCKFILE}"; }
+ trap 'remove_lock' EXIT
# Get CA URLs
- CA_DIRECTORY="$(_request get "${CA}")"
+ CA_DIRECTORY="$(http_request get "${CA}")"
CA_NEW_CERT="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-cert)" &&
CA_NEW_AUTHZ="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-authz)" &&
CA_NEW_REG="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-reg)" &&
# shellcheck disable=SC2015
CA_REVOKE_CERT="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value revoke-cert)" ||
- (echo "Error retrieving ACME/CA-URLs, check if your configured CA points to the directory entrypoint."; exit 1)
+ _exiterr "Problem retrieving ACME/CA-URLs, check if your configured CA points to the directory entrypoint."
+ # Export some environment variables to be used in hook script
+ export WELLKNOWN BASEDIR CONFIG
- # check private key ...
- register="0"
+ # Checking for private key ...
+ register_new_key="no"
if [[ -n "${PARAM_PRIVATE_KEY:-}" ]]; then
# a private key was specified from the command line so use it for this run
echo "Using private key ${PARAM_PRIVATE_KEY} instead of account key"
PRIVATE_KEY="${PARAM_PRIVATE_KEY}"
- if ! openssl rsa -in "${PRIVATE_KEY}" -check 2>/dev/null > /dev/null; then
- echo " + ERROR: private key is not valid, can not continue"
- exit 1
- fi
else
# Check if private account key exists, if it doesn't exist yet generate a new one (rsa key)
if [[ ! -e "${PRIVATE_KEY}" ]]; then
echo "+ Generating account key..."
_openssl genrsa -out "${PRIVATE_KEY}" "${KEYSIZE}"
- register="1"
+ register_new_key="yes"
fi
fi
+ openssl rsa -in "${PRIVATE_KEY}" -check 2>/dev/null > /dev/null || _exiterr "Private key is not valid, can not continue."
# Get public components from private key and calculate thumbprint
- pubExponent64="$(printf "%06x" "$(openssl rsa -in "${PRIVATE_KEY}" -noout -text | grep publicExponent | head -1 | cut -d' ' -f2)" | hex2bin | urlbase64)"
- pubMod64="$(printf '%s' "$(openssl rsa -in "${PRIVATE_KEY}" -noout -modulus | cut -d'=' -f2)" | hex2bin | urlbase64)"
+ pubExponent64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -text | grep publicExponent | grep -oE "0x[a-f0-9]+" | cut -d'x' -f2 | hex2bin | urlbase64)"
+ pubMod64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -modulus | cut -d'=' -f2 | hex2bin | urlbase64)"
- thumbprint="$(printf '%s' '{"e":"'"${pubExponent64}"'","kty":"RSA","n":"'"${pubMod64}"'"}' | openssl sha -sha256 -binary | urlbase64)"
+ thumbprint="$(printf '{"e":"%s","kty":"RSA","n":"%s"}' "${pubExponent64}" "${pubMod64}" | openssl sha -sha256 -binary | urlbase64)"
# If we generated a new private key in the step above we have to register it with the acme-server
- if [[ "${register}" = "1" ]]; then
+ if [[ "${register_new_key}" = "yes" ]]; then
echo "+ Registering account key with letsencrypt..."
- if [ -z "${CA_NEW_REG}" ]; then
- echo " + ERROR: Certificate authority doesn't allow registrations."
- exit 1
- fi
- # if an email for the contact has been provided then adding it to the registration request
+ [[ ! -z "${CA_NEW_REG}" ]] || _exiterr "Certificate authority doesn't allow registrations."
+ # If an email for the contact has been provided then adding it to the registration request
if [[ -n "${CONTACT_EMAIL}" ]]; then
signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "contact":["mailto:'"${CONTACT_EMAIL}"'"], "agreement": "'"$LICENSE"'"}' > /dev/null
else
fi
fi
- if [[ -e "${BASEDIR}/domains.txt" ]]; then
- DOMAINS_TXT="${BASEDIR}/domains.txt"
- else
- echo "You have to create a domains.txt file listing the domains you want certificates for. Have a look at domains.txt.example."
- exit 1
- fi
-
- if [[ ! -e "${WELLKNOWN}" ]]; then
- mkdir -p "${WELLKNOWN}"
- fi
+ [[ -d "${WELLKNOWN}" ]] || _exiterr "WELLKNOWN directory doesn't exist, please create ${WELLKNOWN} and set appropriate permissions."
}
-anti_newline() {
- tr -d '\n\r'
+# Print error message and exit with error
+_exiterr() {
+ echo "ERROR: ${1}" >&2
+ exit 1
}
+# Encode data as url-safe formatted base64
urlbase64() {
# urlbase64: base64 encoded string with '+' replaced with '-' and '/' replaced with '_'
- openssl base64 -e | anti_newline | sed 's/=*$//g' | tr '+/' '-_'
+ openssl base64 -e | tr -d '\n\r' | sed -e 's:=*$::g' -e 'y:+/:-_:'
}
+# Convert hex string to binary data
hex2bin() {
- # Store hex string from stdin
- tmphex="$(cat)"
-
- # Remove spaces
- hex=''
- for ((i=0; i<${#tmphex}; i+=1)); do
- test "${tmphex:$i:1}" == " " || hex="${hex}${tmphex:$i:1}"
- done
-
- # Add leading zero
- test $((${#hex} & 1)) == 0 || hex="0${hex}"
-
- # Convert to escaped string
- escapedhex=''
- for ((i=0; i<${#hex}; i+=2)); do
- escapedhex=$escapedhex\\x${hex:$i:2}
- done
-
- # Convert to binary data
- printf -- "${escapedhex}"
+ # Remove spaces, add leading zero, escape as hex string and parse with printf
+ printf -- "$(cat | sed -E -e 's/[[:space:]]//g' -e 's/^(.(.{2})*)$/0\1/' -e 's/(.{2})/\\x\1/g')"
}
+# Get string value from json dictionary
get_json_string_value() {
- grep -Eo '"'"${1}"'":\s*"[^"]*"' | cut -d'"' -f4
+ grep -Eo '"'"${1}"'":[[:space:]]*"[^"]*"' | cut -d'"' -f4
}
-get_json_array() {
- grep -Eo '"'"${1}"'":[^\[]*\[[^]]*]'
+# OpenSSL writes to stderr/stdout even when there are no errors. So just
+# display the output if the exit code was != 0 to simplify debugging.
+_openssl() {
+ set +e
+ out="$(openssl "${@}" 2>&1)"
+ res=$?
+ set -e
+ if [[ $res -ne 0 ]]; then
+ echo " + ERROR: failed to run $* (Exitcode: $res)" >&2
+ echo >&2
+ echo "Details:" >&2
+ echo "$out" >&2
+ exit $res
+ fi
}
-_request() {
- tempcont="$(mktemp)"
+# Send http(s) request with specified method
+http_request() {
+ tempcont="$(mktemp -t XXXXXX)"
if [[ "${1}" = "head" ]]; then
statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -I)"
statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}")"
elif [[ "${1}" = "post" ]]; then
statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -d "${3}")"
+ else
+ _exiterr "Unknown request method: ${1}"
fi
if [[ ! "${statuscode:0:1}" = "2" ]]; then
echo " + ERROR: An error occurred while sending ${1}-request to ${2} (Status ${statuscode})" >&2
echo >&2
echo "Details:" >&2
- echo "$(<"${tempcont}"))" >&2
+ cat "${tempcont}" >&2
rm -f "${tempcont}"
# Wait for hook script to clean the challenge if used
- if [[ -n "${HOOK}" ]] && [[ -n "${challenge_token:+set}" ]]; then
+ if [[ -n "${HOOK}" ]] && [[ -n "${challenge_token:+set}" ]]; then
${HOOK} "clean_challenge" '' "${challenge_token}" "${keyauth}"
fi
# remove temporary domains.txt file if used
- if [[ -n "${PARAM_DOMAIN:-}" ]]; then
- rm "${DOMAINS_TXT}"
- fi
-
+ [[ -n "${PARAM_DOMAIN:-}" ]] && rm "${DOMAINS_TXT}"
exit 1
fi
- cat "${tempcont}"
+ cat "${tempcont}"
rm -f "${tempcont}"
}
-# OpenSSL writes to stderr/stdout even when there are no errors. So just
-# display the output if the exit code was != 0 to simplify debugging.
-_openssl() {
- set +e
- out="$(openssl "${@}" 2>&1)"
- res=$?
- set -e
- if [[ $res -ne 0 ]]; then
- echo " + ERROR: failed to run $* (Exitcode: $res)" >&2
- echo >&2
- echo "Details:" >&2
- echo "$out" >&2
- exit $res
- fi
-}
-
+# Send signed request
signed_request() {
# Encode payload as urlbase64
payload64="$(printf '%s' "${2}" | urlbase64)"
# Retrieve nonce from acme-server
- nonce="$(_request head "${CA}" | grep Replay-Nonce: | awk -F ': ' '{print $2}' | anti_newline)"
+ nonce="$(http_request head "${CA}" | grep Replay-Nonce: | awk -F ': ' '{print $2}' | tr -d '\n\r')"
# Build header with just our public key and algorithm information
header='{"alg": "RS256", "jwk": {"e": "'"${pubExponent64}"'", "kty": "RSA", "n": "'"${pubMod64}"'"}}'
# Send header + extended header + payload + signature to the acme-server
data='{"header": '"${header}"', "protected": "'"${protected64}"'", "payload": "'"${payload64}"'", "signature": "'"${signed64}"'"}'
- _request post "${1}" "${data}"
+ http_request post "${1}" "${data}"
}
+# Create certificate for domain(s)
sign_domain() {
domain="${1}"
altnames="${*}"
+ timestamp="$(date +%s)"
echo " + Signing domains..."
if [[ -z "${CA_NEW_AUTHZ}" ]] || [[ -z "${CA_NEW_CERT}" ]]; then
- echo " + ERROR: Certificate authority doesn't allow certificate signing"
- exit 1
+ _exiterr "Certificate authority doesn't allow certificate signing"
fi
- timestamp="$(date +%s)"
# If there is no existing certificate directory => make it
if [[ ! -e "${BASEDIR}/certs/${domain}" ]]; then
- echo " + make directory ${BASEDIR}/certs/${domain} ..."
+ echo " + Creating new directory ${BASEDIR}/certs/${domain} ..."
mkdir -p "${BASEDIR}/certs/${domain}"
fi
fi
# Generate signing request config and the actual signing request
+ echo " + Generating signing request..."
SAN=""
- for altname in $altnames; do
+ for altname in ${altnames}; do
SAN+="DNS:${altname}, "
done
SAN="${SAN%%, }"
- echo " + Generating signing request..."
- openssl req -new -sha256 -key "${BASEDIR}/certs/${domain}/${privkey}" -out "${BASEDIR}/certs/${domain}/cert-${timestamp}.csr" -subj "/CN=${domain}/" -reqexts SAN -config <(cat "${OPENSSL_CNF}" <(printf "[SAN]\nsubjectAltName=%s" "${SAN}"))
+ local tmp_openssl_cnf
+ tmp_openssl_cnf="$(mktemp -t XXXXXX)"
+ cat "${OPENSSL_CNF}" > "${tmp_openssl_cnf}"
+ printf "[SAN]\nsubjectAltName=%s" "${SAN}" >> "${tmp_openssl_cnf}"
+ openssl req -new -sha256 -key "${BASEDIR}/certs/${domain}/${privkey}" -out "${BASEDIR}/certs/${domain}/cert-${timestamp}.csr" -subj "/CN=${domain}/" -reqexts SAN -config "${tmp_openssl_cnf}"
+ rm -f "${tmp_openssl_cnf}"
# Request and respond to challenges
- for altname in $altnames; do
+ for altname in ${altnames}; do
# Ask the acme-server for new challenge token and extract them from the resulting json block
echo " + Requesting challenge for ${altname}..."
response="$(signed_request "${CA_NEW_AUTHZ}" '{"resource": "new-authz", "identifier": {"type": "dns", "value": "'"${altname}"'"}}')"
- challenges="$(printf '%s\n' "${response}" | get_json_array challenges)"
+ challenges="$(printf '%s\n' "${response}" | grep -Eo '"challenges":[^\[]*\[[^]]*]')"
repl=$'\n''{' # fix syntax highlighting in Vim
- challenge="$(printf "%s" "${challenges//\{/${repl}}" | grep 'http-01')"
+ challenge="$(printf "%s" "${challenges//\{/${repl}}" | grep \""${CHALLENGETYPE}"\")"
challenge_token="$(printf '%s' "${challenge}" | get_json_string_value token | sed 's/[^A-Za-z0-9_\-]/_/g')"
challenge_uri="$(printf '%s' "${challenge}" | get_json_string_value uri)"
if [[ -z "${challenge_token}" ]] || [[ -z "${challenge_uri}" ]]; then
- echo " + Error: Can't retrieve challenges (${response})"
- exit 1
+ _exiterr "Can't retrieve challenges (${response})"
fi
# Challenge response consists of the challenge token and the thumbprint of our public certificate
keyauth="${challenge_token}.${thumbprint}"
- # Store challenge response in well-known location and make world-readable (so that a webserver can access it)
- printf '%s' "${keyauth}" > "${WELLKNOWN}/${challenge_token}"
- chmod a+r "${WELLKNOWN}/${challenge_token}"
+ case "${CHALLENGETYPE}" in
+ "http-01")
+ # Store challenge response in well-known location and make world-readable (so that a webserver can access it)
+ printf '%s' "${keyauth}" > "${WELLKNOWN}/${challenge_token}"
+ chmod a+r "${WELLKNOWN}/${challenge_token}"
+ keyauth_hook="${keyauth}"
+ ;;
+ "dns-01")
+ # Generate DNS entry content for dns-01 validation
+ keyauth_hook="$(printf '%s' "${keyauth}" | openssl sha -sha256 -binary | urlbase64)"
+ ;;
+ esac
# Wait for hook script to deploy the challenge if used
- if [[ -n "${HOOK}" ]]; then
- ${HOOK} "deploy_challenge" "${altname}" "${challenge_token}" "${keyauth}"
- fi
+ [[ -n "${HOOK}" ]] && ${HOOK} "deploy_challenge" "${altname}" "${challenge_token}" "${keyauth_hook}"
- # Ask the acme-server to verify our challenge and wait until it becomes valid
+ # Ask the acme-server to verify our challenge and wait until it is no longer pending
echo " + Responding to challenge for ${altname}..."
result="$(signed_request "${challenge_uri}" '{"resource": "challenge", "keyAuthorization": "'"${keyauth}"'"}')"
status="$(printf '%s\n' "${result}" | get_json_string_value status)"
- # get status until a result is reached => not pending anymore
while [[ "${status}" = "pending" ]]; do
sleep 1
- status="$(_request get "${challenge_uri}" | get_json_string_value status)"
+ status="$(http_request get "${challenge_uri}" | get_json_string_value status)"
done
- rm -f "${WELLKNOWN}/${challenge_token}"
+ [[ "${CHALLENGETYPE}" = "http-01" ]] && rm -f "${WELLKNOWN}/${challenge_token}"
# Wait for hook script to clean the challenge if used
if [[ -n "${HOOK}" ]] && [[ -n "${challenge_token}" ]]; then
- ${HOOK} "clean_challenge" "${altname}" "${challenge_token}" "${keyauth}"
+ ${HOOK} "clean_challenge" "${altname}" "${challenge_token}" "${keyauth_hook}"
fi
if [[ "${status}" = "valid" ]]; then
echo " + Challenge is valid!"
else
- echo " + Challenge is invalid! (returned: ${status})"
- exit 1
+ _exiterr "Challenge is invalid! (returned: ${status})"
fi
-
done
# Finally request certificate from the acme-server and store it in cert-${timestamp}.pem and link from cert.pem
crt64="$(signed_request "${CA_NEW_CERT}" '{"resource": "new-cert", "csr": "'"${csr64}"'"}' | openssl base64 -e)"
crt_path="${BASEDIR}/certs/${domain}/cert-${timestamp}.pem"
printf -- '-----BEGIN CERTIFICATE-----\n%s\n-----END CERTIFICATE-----\n' "${crt64}" > "${crt_path}"
- # try to load the certificate to detect corruption
- echo " + Checking certificate..." >&2
+
+ # Try to load the certificate to detect corruption
+ echo " + Checking certificate..."
_openssl x509 -text < "${crt_path}"
# Create fullchain.pem
echo " + Creating fullchain.pem..."
cat "${crt_path}" > "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
- _request get "$(openssl x509 -in "${BASEDIR}/certs/${domain}/cert-${timestamp}.pem" -noout -text | grep 'CA Issuers - URI:' | cut -d':' -f2-)" >> "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
- ln -sf "fullchain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
-
- # Update remaining symlinks
- if [ ! "${privkey}" = "privkey.pem" ]; then
- ln -sf "privkey-${timestamp}.pem" "${BASEDIR}/certs/${domain}/privkey.pem"
+ http_request get "$(openssl x509 -in "${BASEDIR}/certs/${domain}/cert-${timestamp}.pem" -noout -text | grep 'CA Issuers - URI:' | cut -d':' -f2-)" > "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem"
+ if ! grep -q "BEGIN CERTIFICATE" "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem"; then
+ openssl x509 -in "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" -inform DER -out "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" -outform PEM
fi
+ cat "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" >> "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
+
+ # Update symlinks
+ [[ "${privkey}" = "privkey.pem" ]] || ln -sf "privkey-${timestamp}.pem" "${BASEDIR}/certs/${domain}/privkey.pem"
+ ln -sf "chain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/chain.pem"
+ ln -sf "fullchain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
ln -sf "cert-${timestamp}.csr" "${BASEDIR}/certs/${domain}/cert.csr"
ln -sf "cert-${timestamp}.pem" "${BASEDIR}/certs/${domain}/cert.pem"
# Wait for hook script to clean the challenge and to deploy cert if used
- if [[ -n "${HOOK}" ]]; then
- ${HOOK} "deploy_cert" "${domain}" "${BASEDIR}/certs/${domain}/privkey.pem" "${BASEDIR}/certs/${domain}/cert.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
- fi
+ [[ -n "${HOOK}" ]] && ${HOOK} "deploy_cert" "${domain}" "${BASEDIR}/certs/${domain}/privkey.pem" "${BASEDIR}/certs/${domain}/cert.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
unset challenge_token
echo " + Done!"
}
-
# Usage: --cron (-c)
-# Description: Sign/renew non-existant/changed(TODO)/expiring certificates.
+# Description: Sign/renew non-existant/changed/expiring certificates.
command_sign_domains() {
+ init_system
+
if [[ -n "${PARAM_DOMAIN:-}" ]]; then
- # we are using a temporary domains.txt file so we don't need to duplicate any code
- DOMAINS_TXT="$(mktemp)"
- echo "${PARAM_DOMAIN}" > "${DOMAINS_TXT}"
+ DOMAINS_TXT="$(mktemp -t XXXXXX)"
+ printf -- "${PARAM_DOMAIN}" > "${DOMAINS_TXT}"
+ elif [[ -e "${BASEDIR}/domains.txt" ]]; then
+ DOMAINS_TXT="${BASEDIR}/domains.txt"
+ else
+ _exiterr "domains.txt not found and --domain not given"
fi
+
# Generate certificates for all domains found in domains.txt. Check if existing certificate are about to expire
- <"${DOMAINS_TXT}" sed 's/^[ ]*//g;s/[ ]*$//g' | grep -v '^#' | grep -v '^$' | while read -r line; do
+ <"${DOMAINS_TXT}" sed -E -e 's/^[[:space:]]*//g' -e 's/[[:space:]]*$//g' -e 's/[[:space:]]+/ /g' | (grep -vE '^(#|$)' || true) | while read -r line; do
domain="$(printf '%s\n' "${line}" | cut -d' ' -f1)"
morenames="$(printf '%s\n' "${line}" | cut -s -d' ' -f2-)"
cert="${BASEDIR}/certs/${domain}/cert.pem"
+ force_renew="${PARAM_FORCE:-no}"
+
if [[ -z "${morenames}" ]];then
echo "Processing ${domain}"
else
- echo "Processing ${domain} with SAN: ${morenames}"
+ echo "Processing ${domain} with alternative names: ${morenames}"
fi
if [[ -e "${cert}" ]]; then
- echo " + Found existing cert..."
+ printf " + Checking domain name(s) of existing cert..."
+
+ certnames="$(openssl x509 -in "${cert}" -text -noout | grep DNS: | sed 's/DNS://g' | tr -d ' ' | tr ',' '\n' | sort -u | tr '\n' ' ' | sed 's/ $//')"
+ givennames="$(echo "${domain}" "${morenames}"| tr ' ' '\n' | sort -u | tr '\n' ' ' | sed 's/ $//' | sed 's/^ //')"
+
+ if [[ "${certnames}" = "${givennames}" ]]; then
+ echo " unchanged."
+ else
+ echo " changed!"
+ echo " + Domain name(s) are not matching!"
+ echo " + Names in old certificate: ${certnames}"
+ echo " + Configured names: ${givennames}"
+ echo " + Forcing renew."
+ force_renew="yes"
+ fi
+ fi
+ if [[ -e "${cert}" ]]; then
+ echo " + Checking expire date of existing cert..."
valid="$(openssl x509 -enddate -noout -in "${cert}" | cut -d= -f2- )"
- echo -n " + Valid till ${valid} "
+ printf " + Valid till %s " "${valid}"
if openssl x509 -checkend $((RENEW_DAYS * 86400)) -noout -in "${cert}"; then
- echo -n "(Longer than ${RENEW_DAYS} days). "
- if [[ "${PARAM_FORCE:-}" = "yes" ]]; then
- echo "Ignoring because --force was specified!"
+ printf "(Longer than %d days). " "${RENEW_DAYS}"
+ if [[ "${force_renew}" = "yes" ]]; then
+ echo "Ignoring because renew was forced!"
else
echo "Skipping!"
continue
fi
# shellcheck disable=SC2086
- sign_domain $line
+ sign_domain ${line}
done
# remove temporary domains.txt file if used
- if [[ -n "${PARAM_DOMAIN:-}" ]]; then
- rm "${DOMAINS_TXT}"
- fi
+ [[ -n "${PARAM_DOMAIN:-}" ]] && rm -f "${DOMAINS_TXT}"
+
+ exit 0
}
# Usage: --revoke (-r) path/to/cert.pem
# Description: Revoke specified certificate
command_revoke() {
+ init_system
+
+ [[ -n "${CA_REVOKE_CERT}" ]] || _exiterr "Certificate authority doesn't allow certificate revocation."
+
cert="${1}"
- echo "Revoking ${cert}"
- if [ -z "${CA_REVOKE_CERT}" ]; then
- echo " + ERROR: Certificate authority doesn't allow certificate revocation."
- exit 1
+ if [[ -L "${cert}" ]]; then
+ # follow symlink and use real certificate name (so we move the real file and not the symlink at the end)
+ local link_target
+ link_target="$(readlink -n "${cert}")"
+ if [[ "${link_target}" =~ ^/ ]]; then
+ cert="${link_target}"
+ else
+ cert="$(dirname "${cert}")/${link_target}"
+ fi
fi
+ [[ -f "${cert}" ]] || _exiterr "Could not find certificate ${cert}"
+
+ echo "Revoking ${cert}"
+
cert64="$(openssl x509 -in "${cert}" -inform PEM -outform DER | urlbase64)"
response="$(signed_request "${CA_REVOKE_CERT}" '{"resource": "revoke-cert", "certificate": "'"${cert64}"'"}')"
# if there is a problem with our revoke request _request (via signed_request) will report this and "exit 1" out
# so if we are here, it is safe to assume the request was successful
- echo " + SUCCESS"
- echo " + renaming certificate to ${cert}-revoked"
+ echo " + Done."
+ echo " + Renaming certificate to ${cert}-revoked"
mv -f "${cert}" "${cert}-revoked"
}
# Usage: --help (-h)
# Description: Show help text
command_help() {
- echo "Usage: ${0} [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ..."
- echo
- echo "Default command: cron"
- echo
- (
+ printf "Usage: %s [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...\n\n" "${0}"
+ printf "Default command: help\n\n"
echo "Commands:"
- grep -e '^\s*# Usage:' -e '^\s*# Description:' -e '^command_.*()\s*{' "${0}" | while read -r usage; read -r description; read -r command; do
- if [[ ! "${usage}" =~ Usage ]]; then
- echo "Error generating help text."
- exit 1
- elif [[ ! "${description}" =~ Description ]]; then
- echo "Error generating help text."
- exit 1
- elif [[ ! "${command}" =~ ^command_ ]]; then
- echo "Error generating help text."
- exit 1
+ grep -e '^[[:space:]]*# Usage:' -e '^[[:space:]]*# Description:' -e '^command_.*()[[:space:]]*{' "${0}" | while read -r usage; read -r description; read -r command; do
+ if [[ ! "${usage}" =~ Usage ]] || [[ ! "${description}" =~ Description ]] || [[ ! "${command}" =~ ^command_ ]]; then
+ _exiterr "Error generating help text."
fi
- printf " %s\t%s\n" "${usage##"# Usage: "}" "${description##"# Description: "}"
+ printf " %-32s %s\n" "${usage##"# Usage: "}" "${description##"# Description: "}"
done
- echo "---"
- echo "Parameters:"
- grep -E -e '^\s*# PARAM_Usage:' -e '^\s*# PARAM_Description:' "${0}" | while read -r usage; read -r description; do
- if [[ ! "${usage}" =~ Usage ]]; then
- echo "Error generating help text."
- exit 1
- elif [[ ! "${description}" =~ Description ]]; then
- echo "Error generating help text."
- exit 1
+ printf -- "\nParameters:\n"
+ grep -E -e '^[[:space:]]*# PARAM_Usage:' -e '^[[:space:]]*# PARAM_Description:' "${0}" | while read -r usage; read -r description; do
+ if [[ ! "${usage}" =~ Usage ]] || [[ ! "${description}" =~ Description ]]; then
+ _exiterr "Error generating help text."
fi
- printf " %s\t%s\n" "${usage##"# PARAM_Usage: "}" "${description##"# PARAM_Description: "}"
+ printf " %-32s %s\n" "${usage##"# PARAM_Usage: "}" "${description##"# PARAM_Description: "}"
done
- ) | column -t -s $'\t' | sed 's/^---$//g'
}
# Usage: --env (-e)
# Description: Output configuration variables for use in other scripts
command_env() {
echo "# letsencrypt.sh configuration"
- typeset -p CONFIG
- typeset -p CA LICENSE BASEDIR WELLKNOWN PRIVATE_KEY KEYSIZE OPENSSL_CNF HOOK RENEW_DAYS PRIVATE_KEY_RENEW CONTACT_EMAIL
- exit 0
+ load_config
+ typeset -p CA LICENSE CHALLENGETYPE HOOK RENEW_DAYS PRIVATE_KEY KEYSIZE WELLKNOWN PRIVATE_KEY_RENEW OPENSSL_CNF CONTACT_EMAIL LOCKFILE
}
-args=""
-# change long args to short args
-# inspired by http://kirk.webfinish.com/?p=45
-for arg; do
- case "${arg}" in
- --help) args="${args}-h ";;
- --cron) args="${args}-c ";;
- --domain) args="${args}-d ";;
- --force ) args="${args}-x ";;
- --revoke) args="${args}-r ";;
- --privkey) args="${args}-p ";;
- --config) args="${args}-f ";;
- --env) args="${args}-e ";;
- --*)
- echo "Unknown parameter detected: ${arg}"
- echo
- command_help
+# Main method (parses script arguments and calls command_* methods)
+main() {
+ COMMAND=""
+ set_command() {
+ [[ -z "${COMMAND}" ]] || _exiterr "Only one command can be executed at a time. See help (-h) for more information."
+ COMMAND="${1}"
+ }
+
+ check_parameters() {
+ if [[ -z "${1:-}" ]]; then
+ echo "The specified command requires additional parameters. See help:" >&2
+ echo >&2
+ command_help >&2
exit 1
- ;;
- # pass through anything else
- *) args="${args}\"${arg}\" ";;
- esac
-done
+ elif [[ "${1:0:1}" = "-" ]]; then
+ _exiterr "Invalid argument: ${1}"
+ fi
+ }
-# Reset the positional parameters to the short options
-eval set -- "${args}"
+ [[ -z "${@}" ]] && eval set -- "--help"
-COMMAND=""
-set_command() {
- if [[ ! -z "${COMMAND}" ]]; then
- echo "Only one command can be executed at a time."
- echo "See help (-h) for more information."
- exit 1
- fi
- COMMAND="${1}"
-}
+ while (( "${#}" )); do
+ case "${1}" in
+ --help|-h)
+ command_help
+ exit 0
+ ;;
-check_parameters() {
- if [[ -z "${@}" ]]; then
- echo "The specified command requires additional parameters. See help:"
- echo
- command_help
- exit 1
- fi
-}
+ --env|-e)
+ set_command env
+ ;;
+
+ --cron|-c)
+ set_command sign_domains
+ ;;
+
+ --revoke|-r)
+ shift 1
+ set_command revoke
+ check_parameters "${1:-}"
+ PARAM_REVOKECERT="${1}"
+ ;;
-while getopts ":hcer:d:xf:p:" option; do
- case "${option}" in
- h)
- command_help
- exit 0
- ;;
- c)
- set_command cron
- ;;
- e)
- set_command env
- ;;
- r)
- set_command revoke
- check_parameters "${OPTARG:-}"
- revoke_me="${OPTARG}"
- ;;
- d)
# PARAM_Usage: --domain (-d) domain.tld
- # PARAM_Description: Use specified domain name instead of domains.txt, use multiple times for certificate with SAN names
- check_parameters "${OPTARG:-}"
- if [[ -z "${PARAM_DOMAIN:-}" ]]; then
- PARAM_DOMAIN="${OPTARG}"
- else
- PARAM_DOMAIN="${PARAM_DOMAIN} ${OPTARG}"
- fi
- ;;
- x)
+ # PARAM_Description: Use specified domain name(s) instead of domains.txt entry (one certificate!)
+ --domain|-d)
+ shift 1
+ check_parameters "${1:-}"
+ if [[ -z "${PARAM_DOMAIN:-}" ]]; then
+ PARAM_DOMAIN="${1}"
+ else
+ PARAM_DOMAIN="${PARAM_DOMAIN} ${1}"
+ fi
+ ;;
+
+
# PARAM_Usage: --force (-x)
- # PARAM_Description: force renew of certificate even if it is longer valid than value in RENEW_DAYS
- PARAM_FORCE="yes"
- ;;
- f)
- # PARAM_Usage: --config (-f) path/to/config.sh
- # PARAM_Description: Use specified config file
- check_parameters "${OPTARG:-}"
- CONFIG="${OPTARG}"
- ;;
- p)
+ # PARAM_Description: Force renew of certificate even if it is longer valid than value in RENEW_DAYS
+ --force|-x)
+ PARAM_FORCE="yes"
+ ;;
+
# PARAM_Usage: --privkey (-p) path/to/key.pem
# PARAM_Description: Use specified private key instead of account key (useful for revocation)
- check_parameters "${OPTARG:-}"
- PARAM_PRIVATE_KEY="${OPTARG}"
- ;;
- *)
- echo "Unknown parameter detected: -${OPTARG}"
- echo
- command_help
- exit 1
- ;;
+ --privkey|-p)
+ shift 1
+ check_parameters "${1:-}"
+ PARAM_PRIVATE_KEY="${1}"
+ ;;
+
+ # PARAM_Usage: --config (-f) path/to/config.sh
+ # PARAM_Description: Use specified config file
+ --config|-f)
+ shift 1
+ check_parameters "${1:-}"
+ CONFIG="${1}"
+ ;;
+
+ # PARAM_Usage: --hook (-k) path/to/hook.sh
+ # PARAM_Description: Use specified script for hooks
+ --hook|-k)
+ shift 1
+ check_parameters "${1:-}"
+ PARAM_HOOK="${1}"
+ ;;
+
+ # PARAM_Usage: --challenge (-t) http-01|dns-01
+ # PARAM_Description: Which challenge should be used? Currently http-01 and dns-01 are supported
+ --challenge|-t)
+ shift 1
+ check_parameters "${1:-}"
+ PARAM_CHALLENGETYPE="${1}"
+ ;;
+
+ *)
+ echo "Unknown parameter detected: ${1}" >&2
+ echo >&2
+ command_help >&2
+ exit 1
+ ;;
+ esac
+
+ shift 1
+ done
+
+ case "${COMMAND}" in
+ env) command_env;;
+ sign_domains) command_sign_domains;;
+ revoke) command_revoke "${PARAM_REVOKECERT}";;
+ *) command_help; exit 1;;
esac
-done
-
-if [[ -z "${COMMAND}" ]]; then
- COMMAND="cron"
-fi
-
-init_system
-
-case "${COMMAND}" in
- cron)
- command_sign_domains
- ;;
- env)
- command_env
- ;;
- revoke)
- command_revoke "${revoke_me}"
- ;;
-esac
+}
+
+# Check for missing dependencies
+check_dependencies
+
+# Run script
+main "${@:-}"