# letsencrypt.sh by lukas2511
# Source: https://github.com/lukas2511/letsencrypt.sh
+#
+# This script is licensed under The MIT License (see LICENSE for more information).
set -e
set -u
set -o pipefail
+[[ -n "${ZSH_VERSION:-}" ]] && set -o SH_WORD_SPLIT && set +o FUNCTION_ARGZERO
umask 077 # paranoid umask, we're creating private keys
-# duplicate scripts IO handles
-exec 4<&0 5>&1 6>&2
+# Find directory in which this script is stored by traversing all symbolic links
+SOURCE="${0}"
+while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
+ DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
+ SOURCE="$(readlink "$SOURCE")"
+ [[ $SOURCE != /* ]] && SOURCE="$DIR/$SOURCE" # if $SOURCE was a relative symlink, we need to resolve it relative to the path where the symlink file was located
+done
+SCRIPTDIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
-# Get the directory in which this script is stored
-SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
BASEDIR="${SCRIPTDIR}"
# Check for script dependencies
# just execute some dummy and/or version commands to see if required tools exist and are actually usable
openssl version > /dev/null 2>&1 || _exiterr "This script requires an openssl binary."
_sed "" < /dev/null > /dev/null 2>&1 || _exiterr "This script requires sed with support for extended (modern) regular expressions."
- grep -V > /dev/null 2>&1 || _exiterr "This script requires grep."
+ command -v grep > /dev/null 2>&1 || _exiterr "This script requires grep."
mktemp -u -t XXXXXX > /dev/null 2>&1 || _exiterr "This script requires mktemp."
# curl returns with an error code in some ancient versions so we have to catch that
set +e
curl -V > /dev/null 2>&1
- set -e
retcode="$?"
+ set -e
if [[ ! "${retcode}" = "0" ]] && [[ ! "${retcode}" = "2" ]]; then
_exiterr "This script requires curl."
fi
CHALLENGETYPE="http-01"
CONFIG_D=
HOOK=
+ HOOK_CHAIN="no"
RENEW_DAYS="30"
PRIVATE_KEY=
+ PRIVATE_KEY_JSON=
KEYSIZE="4096"
WELLKNOWN=
PRIVATE_KEY_RENEW="no"
_exiterr "The path ${CONFIG_D} specified for CONFIG_D does not point to a directory." >&2
fi
- for check_config_d in ${CONFIG_D}/*.sh; do
+ for check_config_d in "${CONFIG_D}"/*.sh; do
if [[ ! -e "${check_config_d}" ]]; then
echo "# !! WARNING !! Extra configuration directory ${CONFIG_D} exists, but no configuration found in it." >&2
break
elif [[ -f "${check_config_d}" ]] && [[ -r "${check_config_d}" ]]; then
echo "# INFO: Using additional config file ${check_config_d}"
- . ${check_config_d}
+ # shellcheck disable=SC1090
+ . "${check_config_d}"
else
_exiterr "Specified additional config ${check_config_d} is not readable or not a file at all." >&2
fi
[[ -d "${BASEDIR}" ]] || _exiterr "BASEDIR does not exist: ${BASEDIR}"
[[ -z "${PRIVATE_KEY}" ]] && PRIVATE_KEY="${BASEDIR}/private_key.pem"
+ [[ -z "${PRIVATE_KEY_JSON}" ]] && PRIVATE_KEY_JSON="${BASEDIR}/private_key.json"
[[ -z "${WELLKNOWN}" ]] && WELLKNOWN="${BASEDIR}/.acme-challenges"
[[ -z "${LOCKFILE}" ]] && LOCKFILE="${BASEDIR}/lock"
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="$(openssl rsa -in "${PRIVATE_KEY}" -noout -text | grep publicExponent | grep -oE "0x[a-f0-9]+" | cut -d'x' -f2 | hex2bin | urlbase64)"
+ pubExponent64="$(printf '%x' "$(openssl rsa -in "${PRIVATE_KEY}" -noout -text | awk '/publicExponent/ {print $2}')" | hex2bin | urlbase64)"
pubMod64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -modulus | cut -d'=' -f2 | hex2bin | urlbase64)"
- thumbprint="$(printf '{"e":"%s","kty":"RSA","n":"%s"}' "${pubExponent64}" "${pubMod64}" | openssl sha -sha256 -binary | urlbase64)"
+ thumbprint="$(printf '{"e":"%s","kty":"RSA","n":"%s"}' "${pubExponent64}" "${pubMod64}" | openssl dgst -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_new_key}" = "yes" ]]; then
[[ ! -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
+ signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "contact":["mailto:'"${CONTACT_EMAIL}"'"], "agreement": "'"$LICENSE"'"}' > "${PRIVATE_KEY_JSON}"
else
- signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "agreement": "'"$LICENSE"'"}' > /dev/null
+ signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "agreement": "'"$LICENSE"'"}' > "${PRIVATE_KEY_JSON}"
fi
fi
# Get string value from json dictionary
get_json_string_value() {
- grep -Eo '"'"${1}"'":[[:space:]]*"[^"]*"' | cut -d'"' -f4
+ local filter
+ filter=$(printf 's/.*"%s": *"\([^"]*\)".*/\\1/p' "$1")
+ sed -n "${filter}"
}
# OpenSSL writes to stderr/stdout even when there are no errors. So just
out="$(openssl "${@}" 2>&1)"
res=$?
set -e
- if [[ $res -ne 0 ]]; then
- echo " + ERROR: failed to run $* (Exitcode: $res)" >&2
+ if [[ ${res} -ne 0 ]]; then
+ echo " + ERROR: failed to run $* (Exitcode: ${res})" >&2
echo >&2
echo "Details:" >&2
- echo "$out" >&2
- exit $res
+ echo "${out}" >&2
+ echo >&2
+ exit ${res}
fi
}
http_request() {
tempcont="$(mktemp -t XXXXXX)"
+ set +e
if [[ "${1}" = "head" ]]; then
statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -I)"
+ curlret="${?}"
elif [[ "${1}" = "get" ]]; then
statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}")"
+ curlret="${?}"
elif [[ "${1}" = "post" ]]; then
statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -d "${3}")"
+ curlret="${?}"
else
+ set -e
_exiterr "Unknown request method: ${1}"
fi
+ set -e
+
+ if [[ ! "${curlret}" = "0" ]]; then
+ _exiterr "Problem connecting to server (curl returned with ${curlret})"
+ fi
if [[ ! "${statuscode:0:1}" = "2" ]]; then
echo " + ERROR: An error occurred while sending ${1}-request to ${2} (Status ${statuscode})" >&2
rm -f "${tempcont}"
# Wait for hook script to clean the challenge if used
- if [[ -n "${HOOK}" ]] && [[ -n "${challenge_token:+set}" ]]; then
- ${HOOK} "clean_challenge" '' "${challenge_token}" "${keyauth}" <&4 >&5 2>&6
+ if [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" != "yes" ]] && [[ -n "${challenge_token:+set}" ]]; then
+ "${HOOK}" "clean_challenge" '' "${challenge_token}" "${keyauth}"
fi
# remove temporary domains.txt file if used
- [[ -n "${PARAM_DOMAIN:-}" ]] && rm "${DOMAINS_TXT}"
+ [[ -n "${PARAM_DOMAIN:-}" && -n "${DOMAINS_TXT:-}" ]] && rm "${DOMAINS_TXT}"
exit 1
fi
fi
reqtext="$( <<<"${csr}" openssl req -noout -text )"
- if <<<"$reqtext" grep -q '^[[:space:]]*X509v3 Subject Alternative Name:[[:space:]]*$'; then
+ if <<<"${reqtext}" grep -q '^[[:space:]]*X509v3 Subject Alternative Name:[[:space:]]*$'; then
# SANs used, extract these
altnames="$( <<<"${reqtext}" grep -A1 '^[[:space:]]*X509v3 Subject Alternative Name:[[:space:]]*$' | tail -n1 )"
# split to one per line:
- altnames="$( <<<"${altnames}" _sed -e 's/^[[:space:]]*//; s/, /\'$'\n''/' )"
+ # shellcheck disable=SC1003
+ altnames="$( <<<"${altnames}" _sed -e 's/^[[:space:]]*//; s/, /\'$'\n''/g' )"
# we can only get DNS: ones signed
- if [ -n "$( <<<"${altnames}" grep -v '^DNS:' )" ]; then
+ if grep -qv '^DNS:' <<<"${altnames}"; then
_exiterr "Certificate signing request contains non-DNS Subject Alternative Names"
fi
# strip away the DNS: prefix
altnames="$( <<<"${altnames}" _sed -e 's/^DNS://' )"
- echo "$altnames"
+ echo "${altnames}"
else
# No SANs, extract CN
altnames="$( <<<"${reqtext}" grep '^[[:space:]]*Subject:' | _sed -e 's/.* CN=([^ /,]*).*/\1/' )"
- echo "$altnames"
+ echo "${altnames}"
fi
}
shift 1 || true
altnames="${*:-}"
- if [ -z "$altnames" ]; then
- altnames="$( extract_altnames "$csr" )"
+ if [ -z "${altnames}" ]; then
+ altnames="$( extract_altnames "${csr}" )"
fi
if [[ -z "${CA_NEW_AUTHZ}" ]] || [[ -z "${CA_NEW_CERT}" ]]; then
_exiterr "Certificate authority doesn't allow certificate signing"
fi
- # Request and respond to challenges
+ local idx=0
+ if [[ -n "${ZSH_VERSION:-}" ]]; then
+ local -A challenge_uris challenge_tokens keyauths deploy_args
+ else
+ local -a challenge_uris challenge_tokens keyauths deploy_args
+ fi
+
+ # Request challenges
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}" | grep -Eo '"challenges":[^\[]*\[[^]]*]')"
+ challenges="$(printf '%s\n' "${response}" | sed -n 's/.*\("challenges":[^\[]*\[[^]]*]\).*/\1/p')"
repl=$'\n''{' # fix syntax highlighting in Vim
challenge="$(printf "%s" "${challenges//\{/${repl}}" | grep \""${CHALLENGETYPE}"\")"
challenge_token="$(printf '%s' "${challenge}" | get_json_string_value token | _sed 's/[^A-Za-z0-9_\-]/_/g')"
;;
"dns-01")
# Generate DNS entry content for dns-01 validation
- keyauth_hook="$(printf '%s' "${keyauth}" | openssl sha -sha256 -binary | urlbase64)"
+ keyauth_hook="$(printf '%s' "${keyauth}" | openssl dgst -sha256 -binary | urlbase64)"
;;
esac
+ challenge_uris[${idx}]="${challenge_uri}"
+ keyauths[${idx}]="${keyauth}"
+ challenge_tokens[${idx}]="${challenge_token}"
+ # Note: assumes args will never have spaces!
+ deploy_args[${idx}]="${altname} ${challenge_token} ${keyauth_hook}"
+ idx=$((idx+1))
+ done
+
+ # Wait for hook script to deploy the challenges if used
+ # shellcheck disable=SC2068
+ [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" = "yes" ]] && "${HOOK}" "deploy_challenge" ${deploy_args[@]}
+
+ # Respond to challenges
+ idx=0
+ for altname in ${altnames}; do
+ challenge_token="${challenge_tokens[${idx}]}"
+ keyauth="${keyauths[${idx}]}"
+
# Wait for hook script to deploy the challenge if used
- [[ -n "${HOOK}" ]] && ${HOOK} "deploy_challenge" "${altname}" "${challenge_token}" "${keyauth_hook}" <&4 >&5 2>&6
+ # shellcheck disable=SC2086
+ [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" != "yes" ]] && "${HOOK}" "deploy_challenge" ${deploy_args[${idx}]}
# 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}"'"}')"
+ result="$(signed_request "${challenge_uris[${idx}]}" '{"resource": "challenge", "keyAuthorization": "'"${keyauth}"'"}')"
- status="$(printf '%s\n' "${result}" | get_json_string_value status)"
+ reqstatus="$(printf '%s\n' "${result}" | get_json_string_value status)"
- while [[ "${status}" = "pending" ]]; do
+ while [[ "${reqstatus}" = "pending" ]]; do
sleep 1
- result="$(http_request get "${challenge_uri}")"
- status="$(printf '%s\n' "${result}" | get_json_string_value status)"
+ result="$(http_request get "${challenge_uris[${idx}]}")"
+ reqstatus="$(printf '%s\n' "${result}" | get_json_string_value status)"
done
[[ "${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}" <&4 >&5 2>&6
+ if [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" != "yes" ]] && [[ -n "${challenge_token}" ]]; then
+ # shellcheck disable=SC2086
+ "${HOOK}" "clean_challenge" ${deploy_args[${idx}]}
fi
+ idx=$((idx+1))
- if [[ "${status}" = "valid" ]]; then
+ if [[ "${reqstatus}" = "valid" ]]; then
echo " + Challenge is valid!"
else
- _exiterr "Challenge is invalid! (returned: ${status}) (result: ${result})"
+ break
fi
done
+ # Wait for hook script to clean the challenges if used
+ # shellcheck disable=SC2068
+ [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" = "yes" ]] && "${HOOK}" "clean_challenge" ${deploy_args[@]}
+
+ if [[ "${reqstatus}" != "valid" ]]; then
+ # Clean up any remaining challenge_tokens if we stopped early
+ if [[ "${CHALLENGETYPE}" = "http-01" ]]; then
+ while [ ${idx} -lt ${#challenge_tokens[@]} ]; do
+ rm -f "${WELLKNOWN}/${challenge_tokens[${idx}]}"
+ idx=$((idx+1))
+ done
+ fi
+
+ _exiterr "Challenge is invalid! (returned: ${reqstatus}) (result: ${result})"
+ fi
+
# Finally request certificate from the acme-server and store it in cert-${timestamp}.pem and link from cert.pem
echo " + Requesting certificate..."
csr64="$( <<<"${csr}" openssl req -outform DER | urlbase64)"
privkey="privkey.pem"
# generate a new private key if we need or want one
- if [[ ! -f "${BASEDIR}/certs/${domain}/privkey.pem" ]] || [[ "${PRIVATE_KEY_RENEW}" = "yes" ]]; then
+ if [[ ! -r "${BASEDIR}/certs/${domain}/privkey.pem" ]] || [[ "${PRIVATE_KEY_RENEW}" = "yes" ]]; then
echo " + Generating private key..."
privkey="privkey-${timestamp}.pem"
case "${KEY_ALGO}" in
rm -f "${tmp_openssl_cnf}"
crt_path="${BASEDIR}/certs/${domain}/cert-${timestamp}.pem"
+ # shellcheck disable=SC2086
sign_csr "$(< "${BASEDIR}/certs/${domain}/cert-${timestamp}.csr" )" ${altnames} 3>"${crt_path}"
# Create fullchain.pem
ln -sf "cert-${timestamp}.pem" "${BASEDIR}/certs/${domain}/cert.pem"
# Wait for hook script to clean the challenge and to deploy cert if used
- [[ -n "${HOOK}" ]] && ${HOOK} "deploy_cert" "${domain}" "${BASEDIR}/certs/${domain}/privkey.pem" "${BASEDIR}/certs/${domain}/cert.pem" "${BASEDIR}/certs/${domain}/fullchain.pem" <&4 >&5 2>&6
+ [[ -n "${HOOK}" ]] && "${HOOK}" "deploy_cert" "${domain}" "${BASEDIR}/certs/${domain}/privkey.pem" "${BASEDIR}/certs/${domain}/cert.pem" "${BASEDIR}/certs/${domain}/fullchain.pem" "${BASEDIR}/certs/${domain}/chain.pem"
unset challenge_token
echo " + Done!"
fi
# Generate certificates for all domains found in domains.txt. Check if existing certificate are about to expire
- <"${DOMAINS_TXT}" _sed -e 's/^[[:space:]]*//g' -e 's/[[:space:]]*$//g' -e 's/[[:space:]]+/ /g' | (grep -vE '^(#|$)' || true) | while read -r line; do
+ ORIGIFS="${IFS}"
+ IFS=$'\n'
+ for line in $(<"${DOMAINS_TXT}" tr -d '\r' | _sed -e 's/^[[:space:]]*//g' -e 's/[[:space:]]*$//g' -e 's/[[:space:]]+/ /g' | (grep -vE '^(#|$)' || true)); do
+ IFS="${ORIGIFS}"
domain="$(printf '%s\n' "${line}" | cut -d' ' -f1)"
morenames="$(printf '%s\n' "${line}" | cut -s -d' ' -f2-)"
cert="${BASEDIR}/certs/${domain}/cert.pem"
if [[ "${force_renew}" = "yes" ]]; then
echo "Ignoring because renew was forced!"
else
- echo "Skipping!"
+ # Certificate-Names unchanged and cert is still valid
+ echo "Skipping renew!"
+ [[ -n "${HOOK}" ]] && "${HOOK}" "unchanged_cert" "${domain}" "${BASEDIR}/certs/${domain}/privkey.pem" "${BASEDIR}/certs/${domain}/cert.pem" "${BASEDIR}/certs/${domain}/fullchain.pem" "${BASEDIR}/certs/${domain}/chain.pem"
continue
fi
else
mv -f "${cert}" "${cert}-revoked"
}
+# Usage: --cleanup (-gc)
+# Description: Move unused certificate files to archive directory
+command_cleanup() {
+ load_config
+
+ # Create global archive directory if not existant
+ if [[ ! -e "${BASEDIR}/archive" ]]; then
+ mkdir "${BASEDIR}/archive"
+ fi
+
+ # Loop over all certificate directories
+ for certdir in "${BASEDIR}/certs/"*; do
+ # Skip if entry is not a folder
+ [[ -d "${certdir}" ]] || continue
+
+ # Get certificate name
+ certname="$(basename "${certdir}")"
+
+ # Create certitifaces archive directory if not existant
+ archivedir="${BASEDIR}/archive/${certname}"
+ if [[ ! -e "${archivedir}" ]]; then
+ mkdir "${archivedir}"
+ fi
+
+ # Loop over file-types (certificates, keys, signing-requests, ...)
+ for filetype in cert.csr cert.pem chain.pem fullchain.pem privkey.pem; do
+ # Skip if symlink is broken
+ [[ -r "${certdir}/${filetype}" ]] || continue
+
+ # Look up current file in use
+ current="$(basename "$(readlink "${certdir}/${filetype}")")"
+
+ # Split filetype into name and extension
+ filebase="$(echo "${filetype}" | cut -d. -f1)"
+ fileext="$(echo "${filetype}" | cut -d. -f2)"
+
+ # Loop over all files of this type
+ for file in "${certdir}/${filebase}-"*".${fileext}"; do
+ # Handle case where no files match the wildcard
+ [[ -f "${file}" ]] || break
+
+ # Check if current file is in use, if unused move to archive directory
+ filename="$(basename "${file}")"
+ if [[ ! "${filename}" = "${current}" ]]; then
+ echo "Moving unused file to archive directory: ${certname}/${filename}"
+ mv "${certdir}/${filename}" "${archivedir}/${filename}"
+ fi
+ done
+ done
+ done
+
+ exit 0
+}
+
# Usage: --help (-h)
# Description: Show help text
command_help() {
command_env() {
echo "# letsencrypt.sh configuration"
load_config
- typeset -p CA LICENSE CHALLENGETYPE HOOK RENEW_DAYS PRIVATE_KEY KEYSIZE WELLKNOWN PRIVATE_KEY_RENEW OPENSSL_CNF CONTACT_EMAIL LOCKFILE
+ typeset -p CA LICENSE CHALLENGETYPE HOOK HOOK_CHAIN RENEW_DAYS PRIVATE_KEY KEYSIZE WELLKNOWN PRIVATE_KEY_RENEW OPENSSL_CNF CONTACT_EMAIL LOCKFILE
}
# Main method (parses script arguments and calls command_* methods)
[[ -z "${@}" ]] && eval set -- "--help"
- while (( "${#}" )); do
+ while (( ${#} )); do
case "${1}" in
--help|-h)
command_help
PARAM_REVOKECERT="${1}"
;;
+ --cleanup|-gc)
+ set_command cleanup
+ ;;
+
# PARAM_Usage: --domain (-d) domain.tld
# PARAM_Description: Use specified domain name(s) instead of domains.txt entry (one certificate!)
--domain|-d)
sign_domains) command_sign_domains;;
sign_csr) command_sign_csr "${PARAM_CSR}";;
revoke) command_revoke "${PARAM_REVOKECERT}";;
+ cleanup) command_cleanup;;
*) command_help; exit 1;;
esac
}
projects / andy / dehydrated.git / blobdiff