3 # letsencrypt.sh by lukas2511
4 # Source: https://github.com/lukas2511/letsencrypt.sh
9 [[ -n "${ZSH_VERSION:-}" ]] && set -o SH_WORD_SPLIT && set +o FUNCTION_ARGZERO
10 umask 077 # paranoid umask, we're creating private keys
12 # duplicate scripts IO handles
15 # Find directory in which this script is stored by traversing all symbolic links
17 while [ -h "$SOURCE" ]; do # resolve $SOURCE until the file is no longer a symlink
18 DIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
19 SOURCE="$(readlink "$SOURCE")"
20 [[ $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
22 SCRIPTDIR="$( cd -P "$( dirname "$SOURCE" )" && pwd )"
24 BASEDIR="${SCRIPTDIR}"
26 # Check for script dependencies
27 check_dependencies() {
28 # just execute some dummy and/or version commands to see if required tools exist and are actually usable
29 openssl version > /dev/null 2>&1 || _exiterr "This script requires an openssl binary."
30 _sed "" < /dev/null > /dev/null 2>&1 || _exiterr "This script requires sed with support for extended (modern) regular expressions."
31 grep -V > /dev/null 2>&1 || _exiterr "This script requires grep."
32 mktemp -u -t XXXXXX > /dev/null 2>&1 || _exiterr "This script requires mktemp."
34 # curl returns with an error code in some ancient versions so we have to catch that
36 curl -V > /dev/null 2>&1
39 if [[ ! "${retcode}" = "0" ]] && [[ ! "${retcode}" = "2" ]]; then
40 _exiterr "This script requires curl."
44 # Setup default config values, search for and load configuration files
46 # Check for config in various locations
47 if [[ -z "${CONFIG:-}" ]]; then
48 for check_config in "/etc/letsencrypt.sh" "/usr/local/etc/letsencrypt.sh" "${PWD}" "${SCRIPTDIR}"; do
49 if [[ -e "${check_config}/config.sh" ]]; then
50 BASEDIR="${check_config}"
51 CONFIG="${check_config}/config.sh"
58 CA="https://acme-v01.api.letsencrypt.org/directory"
59 LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
60 CHALLENGETYPE="http-01"
68 PRIVATE_KEY_RENEW="no"
70 OPENSSL_CNF="$(openssl version -d | cut -d\" -f2)/openssl.cnf"
74 if [[ -z "${CONFIG:-}" ]]; then
76 echo "# !! WARNING !! No main config file found, using default config!" >&2
78 elif [[ -e "${CONFIG}" ]]; then
79 echo "# INFO: Using main config file ${CONFIG}"
80 BASEDIR="$(dirname "${CONFIG}")"
81 # shellcheck disable=SC1090
84 _exiterr "Specified config file doesn't exist."
87 if [[ -n "${CONFIG_D}" ]]; then
88 if [[ ! -d "${CONFIG_D}" ]]; then
89 _exiterr "The path ${CONFIG_D} specified for CONFIG_D does not point to a directory." >&2
92 for check_config_d in ${CONFIG_D}/*.sh; do
93 if [[ ! -e "${check_config_d}" ]]; then
94 echo "# !! WARNING !! Extra configuration directory ${CONFIG_D} exists, but no configuration found in it." >&2
96 elif [[ -f "${check_config_d}" ]] && [[ -r "${check_config_d}" ]]; then
97 echo "# INFO: Using additional config file ${check_config_d}"
100 _exiterr "Specified additional config ${check_config_d} is not readable or not a file at all." >&2
105 # Remove slash from end of BASEDIR. Mostly for cleaner outputs, doesn't change functionality.
106 BASEDIR="${BASEDIR%%/}"
108 # Check BASEDIR and set default variables
109 [[ -d "${BASEDIR}" ]] || _exiterr "BASEDIR does not exist: ${BASEDIR}"
111 [[ -z "${PRIVATE_KEY}" ]] && PRIVATE_KEY="${BASEDIR}/private_key.pem"
112 [[ -z "${WELLKNOWN}" ]] && WELLKNOWN="${BASEDIR}/.acme-challenges"
113 [[ -z "${LOCKFILE}" ]] && LOCKFILE="${BASEDIR}/lock"
115 [[ -n "${PARAM_HOOK:-}" ]] && HOOK="${PARAM_HOOK}"
116 [[ -n "${PARAM_CHALLENGETYPE:-}" ]] && CHALLENGETYPE="${PARAM_CHALLENGETYPE}"
117 [[ -n "${PARAM_KEY_ALGO:-}" ]] && KEY_ALGO="${PARAM_KEY_ALGO}"
119 [[ "${CHALLENGETYPE}" =~ (http-01|dns-01) ]] || _exiterr "Unknown challenge type ${CHALLENGETYPE}... can not continue."
120 if [[ "${CHALLENGETYPE}" = "dns-01" ]] && [[ -z "${HOOK}" ]]; then
121 _exiterr "Challenge type dns-01 needs a hook script for deployment... can not continue."
123 [[ "${KEY_ALGO}" =~ ^(rsa|prime256v1|secp384r1)$ ]] || _exiterr "Unknown public key algorithm ${KEY_ALGO}... can not continue."
130 # Lockfile handling (prevents concurrent access)
131 LOCKDIR="$(dirname "${LOCKFILE}")"
132 [[ -w "${LOCKDIR}" ]] || _exiterr "Directory ${LOCKDIR} for LOCKFILE ${LOCKFILE} is not writable, aborting."
133 ( set -C; date > "${LOCKFILE}" ) 2>/dev/null || _exiterr "Lock file '${LOCKFILE}' present, aborting."
134 remove_lock() { rm -f "${LOCKFILE}"; }
135 trap 'remove_lock' EXIT
138 CA_DIRECTORY="$(http_request get "${CA}")"
139 CA_NEW_CERT="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-cert)" &&
140 CA_NEW_AUTHZ="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-authz)" &&
141 CA_NEW_REG="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-reg)" &&
142 # shellcheck disable=SC2015
143 CA_REVOKE_CERT="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value revoke-cert)" ||
144 _exiterr "Problem retrieving ACME/CA-URLs, check if your configured CA points to the directory entrypoint."
146 # Export some environment variables to be used in hook script
147 export WELLKNOWN BASEDIR CONFIG
149 # Checking for private key ...
150 register_new_key="no"
151 if [[ -n "${PARAM_PRIVATE_KEY:-}" ]]; then
152 # a private key was specified from the command line so use it for this run
153 echo "Using private key ${PARAM_PRIVATE_KEY} instead of account key"
154 PRIVATE_KEY="${PARAM_PRIVATE_KEY}"
156 # Check if private account key exists, if it doesn't exist yet generate a new one (rsa key)
157 if [[ ! -e "${PRIVATE_KEY}" ]]; then
158 echo "+ Generating account key..."
159 _openssl genrsa -out "${PRIVATE_KEY}" "${KEYSIZE}"
160 register_new_key="yes"
163 openssl rsa -in "${PRIVATE_KEY}" -check 2>/dev/null > /dev/null || _exiterr "Private key is not valid, can not continue."
165 # Get public components from private key and calculate thumbprint
166 pubExponent64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -text | grep publicExponent | grep -oE "0x[a-f0-9]+" | cut -d'x' -f2 | hex2bin | urlbase64)"
167 pubMod64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -modulus | cut -d'=' -f2 | hex2bin | urlbase64)"
169 thumbprint="$(printf '{"e":"%s","kty":"RSA","n":"%s"}' "${pubExponent64}" "${pubMod64}" | openssl dgst -sha256 -binary | urlbase64)"
171 # If we generated a new private key in the step above we have to register it with the acme-server
172 if [[ "${register_new_key}" = "yes" ]]; then
173 echo "+ Registering account key with letsencrypt..."
174 [[ ! -z "${CA_NEW_REG}" ]] || _exiterr "Certificate authority doesn't allow registrations."
175 # If an email for the contact has been provided then adding it to the registration request
176 if [[ -n "${CONTACT_EMAIL}" ]]; then
177 signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "contact":["mailto:'"${CONTACT_EMAIL}"'"], "agreement": "'"$LICENSE"'"}' > /dev/null
179 signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "agreement": "'"$LICENSE"'"}' > /dev/null
183 if [[ "${CHALLENGETYPE}" = "http-01" && ! -d "${WELLKNOWN}" ]]; then
184 _exiterr "WELLKNOWN directory doesn't exist, please create ${WELLKNOWN} and set appropriate permissions."
188 # Different sed version for different os types...
190 if [[ "${OSTYPE}" = "Linux" ]]; then
197 # Print error message and exit with error
199 echo "ERROR: ${1}" >&2
203 # Encode data as url-safe formatted base64
205 # urlbase64: base64 encoded string with '+' replaced with '-' and '/' replaced with '_'
206 openssl base64 -e | tr -d '\n\r' | _sed -e 's:=*$::g' -e 'y:+/:-_:'
209 # Convert hex string to binary data
211 # Remove spaces, add leading zero, escape as hex string and parse with printf
212 printf -- "$(cat | _sed -e 's/[[:space:]]//g' -e 's/^(.(.{2})*)$/0\1/' -e 's/(.{2})/\\x\1/g')"
215 # Get string value from json dictionary
216 get_json_string_value() {
217 grep -Eo '"'"${1}"'":[[:space:]]*"[^"]*"' | cut -d'"' -f4
220 # OpenSSL writes to stderr/stdout even when there are no errors. So just
221 # display the output if the exit code was != 0 to simplify debugging.
224 out="$(openssl "${@}" 2>&1)"
227 if [[ ${res} -ne 0 ]]; then
228 echo " + ERROR: failed to run $* (Exitcode: ${res})" >&2
237 # Send http(s) request with specified method
239 tempcont="$(mktemp -t XXXXXX)"
242 if [[ "${1}" = "head" ]]; then
243 statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -I)"
245 elif [[ "${1}" = "get" ]]; then
246 statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}")"
248 elif [[ "${1}" = "post" ]]; then
249 statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -d "${3}")"
253 _exiterr "Unknown request method: ${1}"
257 if [[ ! "${curlret}" = "0" ]]; then
258 _exiterr "Problem connecting to server (curl returned with ${curlret})"
261 if [[ ! "${statuscode:0:1}" = "2" ]]; then
262 echo " + ERROR: An error occurred while sending ${1}-request to ${2} (Status ${statuscode})" >&2
265 cat "${tempcont}" >&2
268 # Wait for hook script to clean the challenge if used
269 if [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" != "yes" ]] && [[ -n "${challenge_token:+set}" ]]; then
270 "${HOOK}" "clean_challenge" '' "${challenge_token}" "${keyauth}"
273 # remove temporary domains.txt file if used
274 [[ -n "${PARAM_DOMAIN:-}" && -n "${DOMAINS_TXT:-}" ]] && rm "${DOMAINS_TXT}"
282 # Send signed request
284 # Encode payload as urlbase64
285 payload64="$(printf '%s' "${2}" | urlbase64)"
287 # Retrieve nonce from acme-server
288 nonce="$(http_request head "${CA}" | grep Replay-Nonce: | awk -F ': ' '{print $2}' | tr -d '\n\r')"
290 # Build header with just our public key and algorithm information
291 header='{"alg": "RS256", "jwk": {"e": "'"${pubExponent64}"'", "kty": "RSA", "n": "'"${pubMod64}"'"}}'
293 # Build another header which also contains the previously received nonce and encode it as urlbase64
294 protected='{"alg": "RS256", "jwk": {"e": "'"${pubExponent64}"'", "kty": "RSA", "n": "'"${pubMod64}"'"}, "nonce": "'"${nonce}"'"}'
295 protected64="$(printf '%s' "${protected}" | urlbase64)"
297 # Sign header with nonce and our payload with our private key and encode signature as urlbase64
298 signed64="$(printf '%s' "${protected64}.${payload64}" | openssl dgst -sha256 -sign "${PRIVATE_KEY}" | urlbase64)"
300 # Send header + extended header + payload + signature to the acme-server
301 data='{"header": '"${header}"', "protected": "'"${protected64}"'", "payload": "'"${payload64}"'", "signature": "'"${signed64}"'"}'
303 http_request post "${1}" "${data}"
306 # Extracts all subject names from a CSR
307 # Outputs either the CN, or the SANs, one per line
309 csr="${1}" # the CSR itself (not a file)
311 if ! <<<"${csr}" openssl req -verify -noout 2>/dev/null; then
312 _exiterr "Certificate signing request isn't valid"
315 reqtext="$( <<<"${csr}" openssl req -noout -text )"
316 if <<<"${reqtext}" grep -q '^[[:space:]]*X509v3 Subject Alternative Name:[[:space:]]*$'; then
317 # SANs used, extract these
318 altnames="$( <<<"${reqtext}" grep -A1 '^[[:space:]]*X509v3 Subject Alternative Name:[[:space:]]*$' | tail -n1 )"
319 # split to one per line:
320 altnames="$( <<<"${altnames}" _sed -e 's/^[[:space:]]*//; s/, /\'$'\n''/g' )"
321 # we can only get DNS: ones signed
322 if [ -n "$( <<<"${altnames}" grep -v '^DNS:' )" ]; then
323 _exiterr "Certificate signing request contains non-DNS Subject Alternative Names"
325 # strip away the DNS: prefix
326 altnames="$( <<<"${altnames}" _sed -e 's/^DNS://' )"
330 # No SANs, extract CN
331 altnames="$( <<<"${reqtext}" grep '^[[:space:]]*Subject:' | _sed -e 's/.* CN=([^ /,]*).*/\1/' )"
336 # Create certificate for domain(s) and outputs it FD 3
338 csr="${1}" # the CSR itself (not a file)
340 if { true >&3; } 2>/dev/null; then
343 _exiterr "sign_csr: FD 3 not open"
348 if [ -z "${altnames}" ]; then
349 altnames="$( extract_altnames "${csr}" )"
352 if [[ -z "${CA_NEW_AUTHZ}" ]] || [[ -z "${CA_NEW_CERT}" ]]; then
353 _exiterr "Certificate authority doesn't allow certificate signing"
357 if [[ -n "${ZSH_VERSION:-}" ]]; then
358 local -A challenge_uris challenge_tokens keyauths deploy_args
360 local -a challenge_uris challenge_tokens keyauths deploy_args
364 for altname in ${altnames}; do
365 # Ask the acme-server for new challenge token and extract them from the resulting json block
366 echo " + Requesting challenge for ${altname}..."
367 response="$(signed_request "${CA_NEW_AUTHZ}" '{"resource": "new-authz", "identifier": {"type": "dns", "value": "'"${altname}"'"}}')"
369 challenges="$(printf '%s\n' "${response}" | grep -Eo '"challenges":[^\[]*\[[^]]*]')"
370 repl=$'\n''{' # fix syntax highlighting in Vim
371 challenge="$(printf "%s" "${challenges//\{/${repl}}" | grep \""${CHALLENGETYPE}"\")"
372 challenge_token="$(printf '%s' "${challenge}" | get_json_string_value token | _sed 's/[^A-Za-z0-9_\-]/_/g')"
373 challenge_uri="$(printf '%s' "${challenge}" | get_json_string_value uri)"
375 if [[ -z "${challenge_token}" ]] || [[ -z "${challenge_uri}" ]]; then
376 _exiterr "Can't retrieve challenges (${response})"
379 # Challenge response consists of the challenge token and the thumbprint of our public certificate
380 keyauth="${challenge_token}.${thumbprint}"
382 case "${CHALLENGETYPE}" in
384 # Store challenge response in well-known location and make world-readable (so that a webserver can access it)
385 printf '%s' "${keyauth}" > "${WELLKNOWN}/${challenge_token}"
386 chmod a+r "${WELLKNOWN}/${challenge_token}"
387 keyauth_hook="${keyauth}"
390 # Generate DNS entry content for dns-01 validation
391 keyauth_hook="$(printf '%s' "${keyauth}" | openssl dgst -sha256 -binary | urlbase64)"
395 challenge_uris[${idx}]="${challenge_uri}"
396 keyauths[${idx}]="${keyauth}"
397 challenge_tokens[${idx}]="${challenge_token}"
398 # Note: assumes args will never have spaces!
399 deploy_args[${idx}]="${altname} ${challenge_token} ${keyauth_hook}"
403 # Wait for hook script to deploy the challenges if used
404 [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" = "yes" ]] && "${HOOK}" "deploy_challenge" ${deploy_args[@]}
406 # Respond to challenges
408 for altname in ${altnames}; do
409 challenge_token="${challenge_tokens[${idx}]}"
410 keyauth="${keyauths[${idx}]}"
412 # Wait for hook script to deploy the challenge if used
413 [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" != "yes" ]] && "${HOOK}" "deploy_challenge" ${deploy_args[${idx}]}
415 # Ask the acme-server to verify our challenge and wait until it is no longer pending
416 echo " + Responding to challenge for ${altname}..."
417 result="$(signed_request "${challenge_uris[${idx}]}" '{"resource": "challenge", "keyAuthorization": "'"${keyauth}"'"}')"
419 reqstatus="$(printf '%s\n' "${result}" | get_json_string_value status)"
421 while [[ "${reqstatus}" = "pending" ]]; do
423 result="$(http_request get "${challenge_uris[${idx}]}")"
424 reqstatus="$(printf '%s\n' "${result}" | get_json_string_value status)"
427 [[ "${CHALLENGETYPE}" = "http-01" ]] && rm -f "${WELLKNOWN}/${challenge_token}"
429 # Wait for hook script to clean the challenge if used
430 if [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" != "yes" ]] && [[ -n "${challenge_token}" ]]; then
431 "${HOOK}" "clean_challenge" ${deploy_args[${idx}]}
435 if [[ "${reqstatus}" = "valid" ]]; then
436 echo " + Challenge is valid!"
442 # Wait for hook script to clean the challenges if used
443 [[ -n "${HOOK}" ]] && [[ "${HOOK_CHAIN}" = "yes" ]] && "${HOOK}" "clean_challenge" ${deploy_args[@]}
445 if [[ "${reqstatus}" != "valid" ]]; then
446 # Clean up any remaining challenge_tokens if we stopped early
447 if [[ "${CHALLENGETYPE}" = "http-01" ]]; then
448 while [ ${idx} -lt ${#challenge_tokens[@]} ]; do
449 rm -f "${WELLKNOWN}/${challenge_tokens[${idx}]}"
454 _exiterr "Challenge is invalid! (returned: ${reqstatus}) (result: ${result})"
457 # Finally request certificate from the acme-server and store it in cert-${timestamp}.pem and link from cert.pem
458 echo " + Requesting certificate..."
459 csr64="$( <<<"${csr}" openssl req -outform DER | urlbase64)"
460 crt64="$(signed_request "${CA_NEW_CERT}" '{"resource": "new-cert", "csr": "'"${csr64}"'"}' | openssl base64 -e)"
461 crt="$( printf -- '-----BEGIN CERTIFICATE-----\n%s\n-----END CERTIFICATE-----\n' "${crt64}" )"
463 # Try to load the certificate to detect corruption
464 echo " + Checking certificate..."
465 _openssl x509 -text <<<"${crt}"
469 unset challenge_token
473 # Create certificate for domain(s)
477 timestamp="$(date +%s)"
479 echo " + Signing domains..."
480 if [[ -z "${CA_NEW_AUTHZ}" ]] || [[ -z "${CA_NEW_CERT}" ]]; then
481 _exiterr "Certificate authority doesn't allow certificate signing"
484 # If there is no existing certificate directory => make it
485 if [[ ! -e "${BASEDIR}/certs/${domain}" ]]; then
486 echo " + Creating new directory ${BASEDIR}/certs/${domain} ..."
487 mkdir -p "${BASEDIR}/certs/${domain}"
490 privkey="privkey.pem"
491 # generate a new private key if we need or want one
492 if [[ ! -r "${BASEDIR}/certs/${domain}/privkey.pem" ]] || [[ "${PRIVATE_KEY_RENEW}" = "yes" ]]; then
493 echo " + Generating private key..."
494 privkey="privkey-${timestamp}.pem"
495 case "${KEY_ALGO}" in
496 rsa) _openssl genrsa -out "${BASEDIR}/certs/${domain}/privkey-${timestamp}.pem" "${KEYSIZE}";;
497 prime256v1|secp384r1) _openssl ecparam -genkey -name "${KEY_ALGO}" -out "${BASEDIR}/certs/${domain}/privkey-${timestamp}.pem";;
501 # Generate signing request config and the actual signing request
502 echo " + Generating signing request..."
504 for altname in ${altnames}; do
505 SAN+="DNS:${altname}, "
508 local tmp_openssl_cnf
509 tmp_openssl_cnf="$(mktemp -t XXXXXX)"
510 cat "${OPENSSL_CNF}" > "${tmp_openssl_cnf}"
511 printf "[SAN]\nsubjectAltName=%s" "${SAN}" >> "${tmp_openssl_cnf}"
512 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}"
513 rm -f "${tmp_openssl_cnf}"
515 crt_path="${BASEDIR}/certs/${domain}/cert-${timestamp}.pem"
516 sign_csr "$(< "${BASEDIR}/certs/${domain}/cert-${timestamp}.csr" )" ${altnames} 3>"${crt_path}"
518 # Create fullchain.pem
519 echo " + Creating fullchain.pem..."
520 cat "${crt_path}" > "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
521 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"
522 if ! grep -q "BEGIN CERTIFICATE" "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem"; then
523 openssl x509 -in "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" -inform DER -out "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" -outform PEM
525 cat "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" >> "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
528 [[ "${privkey}" = "privkey.pem" ]] || ln -sf "privkey-${timestamp}.pem" "${BASEDIR}/certs/${domain}/privkey.pem"
530 ln -sf "chain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/chain.pem"
531 ln -sf "fullchain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
532 ln -sf "cert-${timestamp}.csr" "${BASEDIR}/certs/${domain}/cert.csr"
533 ln -sf "cert-${timestamp}.pem" "${BASEDIR}/certs/${domain}/cert.pem"
535 # Wait for hook script to clean the challenge and to deploy cert if used
536 [[ -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"
538 unset challenge_token
543 # Description: Sign/renew non-existant/changed/expiring certificates.
544 command_sign_domains() {
547 if [[ -n "${PARAM_DOMAIN:-}" ]]; then
548 DOMAINS_TXT="$(mktemp -t XXXXXX)"
549 printf -- "${PARAM_DOMAIN}" > "${DOMAINS_TXT}"
550 elif [[ -e "${BASEDIR}/domains.txt" ]]; then
551 DOMAINS_TXT="${BASEDIR}/domains.txt"
553 _exiterr "domains.txt not found and --domain not given"
556 # Generate certificates for all domains found in domains.txt. Check if existing certificate are about to expire
559 for line in $(cat "${DOMAINS_TXT}" | tr -d '\r' | _sed -e 's/^[[:space:]]*//g' -e 's/[[:space:]]*$//g' -e 's/[[:space:]]+/ /g' | (grep -vE '^(#|$)' || true)); do
561 domain="$(printf '%s\n' "${line}" | cut -d' ' -f1)"
562 morenames="$(printf '%s\n' "${line}" | cut -s -d' ' -f2-)"
563 cert="${BASEDIR}/certs/${domain}/cert.pem"
565 force_renew="${PARAM_FORCE:-no}"
567 if [[ -z "${morenames}" ]];then
568 echo "Processing ${domain}"
570 echo "Processing ${domain} with alternative names: ${morenames}"
573 if [[ -e "${cert}" ]]; then
574 printf " + Checking domain name(s) of existing cert..."
576 certnames="$(openssl x509 -in "${cert}" -text -noout | grep DNS: | _sed 's/DNS://g' | tr -d ' ' | tr ',' '\n' | sort -u | tr '\n' ' ' | _sed 's/ $//')"
577 givennames="$(echo "${domain}" "${morenames}"| tr ' ' '\n' | sort -u | tr '\n' ' ' | _sed 's/ $//' | _sed 's/^ //')"
579 if [[ "${certnames}" = "${givennames}" ]]; then
583 echo " + Domain name(s) are not matching!"
584 echo " + Names in old certificate: ${certnames}"
585 echo " + Configured names: ${givennames}"
586 echo " + Forcing renew."
591 if [[ -e "${cert}" ]]; then
592 echo " + Checking expire date of existing cert..."
593 valid="$(openssl x509 -enddate -noout -in "${cert}" | cut -d= -f2- )"
595 printf " + Valid till %s " "${valid}"
596 if openssl x509 -checkend $((RENEW_DAYS * 86400)) -noout -in "${cert}"; then
597 printf "(Longer than %d days). " "${RENEW_DAYS}"
598 if [[ "${force_renew}" = "yes" ]]; then
599 echo "Ignoring because renew was forced!"
601 # Certificate-Names unchanged and cert is still valid
602 echo "Skipping renew!"
603 [[ -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"
607 echo "(Less than ${RENEW_DAYS} days). Renewing!"
611 # shellcheck disable=SC2086
615 # remove temporary domains.txt file if used
616 [[ -n "${PARAM_DOMAIN:-}" ]] && rm -f "${DOMAINS_TXT}"
621 # Usage: --signcsr (-s) path/to/csr.pem
622 # Description: Sign a given CSR, output CRT on stdout (advanced usage)
624 # redirect stdout to stderr
625 # leave stdout over at fd 3 to output the cert
631 if [ ! -r "${csrfile}" ]; then
632 _exiterr "Could not read certificate signing request ${csrfile}"
635 sign_csr "$(< "${csrfile}" )"
640 # Usage: --revoke (-r) path/to/cert.pem
641 # Description: Revoke specified certificate
645 [[ -n "${CA_REVOKE_CERT}" ]] || _exiterr "Certificate authority doesn't allow certificate revocation."
648 if [[ -L "${cert}" ]]; then
649 # follow symlink and use real certificate name (so we move the real file and not the symlink at the end)
651 link_target="$(readlink -n "${cert}")"
652 if [[ "${link_target}" =~ ^/ ]]; then
653 cert="${link_target}"
655 cert="$(dirname "${cert}")/${link_target}"
658 [[ -f "${cert}" ]] || _exiterr "Could not find certificate ${cert}"
660 echo "Revoking ${cert}"
662 cert64="$(openssl x509 -in "${cert}" -inform PEM -outform DER | urlbase64)"
663 response="$(signed_request "${CA_REVOKE_CERT}" '{"resource": "revoke-cert", "certificate": "'"${cert64}"'"}')"
664 # if there is a problem with our revoke request _request (via signed_request) will report this and "exit 1" out
665 # so if we are here, it is safe to assume the request was successful
667 echo " + Renaming certificate to ${cert}-revoked"
668 mv -f "${cert}" "${cert}-revoked"
671 # Usage: --cleanup (-gc)
672 # Description: Move unused certificate files to archive directory
676 # Create global archive directory if not existant
677 if [[ ! -e "${BASEDIR}/archive" ]]; then
678 mkdir "${BASEDIR}/archive"
681 # Loop over all certificate directories
682 for certdir in "${BASEDIR}/certs/"*; do
683 # Skip if entry is not a folder
684 [[ -d "${certdir}" ]] || continue
686 # Get certificate name
687 certname="$(basename "${certdir}")"
689 # Create certitifaces archive directory if not existant
690 archivedir="${BASEDIR}/archive/${certname}"
691 if [[ ! -e "${archivedir}" ]]; then
692 mkdir "${archivedir}"
695 # Loop over file-types (certificates, keys, signing-requests, ...)
696 for filetype in cert.csr cert.pem chain.pem fullchain.pem privkey.pem; do
697 # Skip if symlink is broken
698 [[ -r "${certdir}/${filetype}" ]] || continue
700 # Look up current file in use
701 current="$(basename $(readlink "${certdir}/${filetype}"))"
703 # Split filetype into name and extension
704 filebase="$(echo "${filetype}" | cut -d. -f1)"
705 fileext="$(echo "${filetype}" | cut -d. -f2)"
707 # Loop over all files of this type
708 for file in "${certdir}/${filebase}-"*".${fileext}"; do
709 # Handle case where no files match the wildcard
710 [[ -f "${file}" ]] || break
712 # Check if current file is in use, if unused move to archive directory
713 filename="$(basename "${file}")"
714 if [[ ! "${filename}" = "${current}" ]]; then
715 echo "Moving unused file to archive directory: ${certname}/$filename"
716 mv "${certdir}/${filename}" "${archivedir}/${filename}"
726 # Description: Show help text
728 printf "Usage: %s [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ...\n\n" "${0}"
729 printf "Default command: help\n\n"
731 grep -e '^[[:space:]]*# Usage:' -e '^[[:space:]]*# Description:' -e '^command_.*()[[:space:]]*{' "${0}" | while read -r usage; read -r description; read -r command; do
732 if [[ ! "${usage}" =~ Usage ]] || [[ ! "${description}" =~ Description ]] || [[ ! "${command}" =~ ^command_ ]]; then
733 _exiterr "Error generating help text."
735 printf " %-32s %s\n" "${usage##"# Usage: "}" "${description##"# Description: "}"
737 printf -- "\nParameters:\n"
738 grep -E -e '^[[:space:]]*# PARAM_Usage:' -e '^[[:space:]]*# PARAM_Description:' "${0}" | while read -r usage; read -r description; do
739 if [[ ! "${usage}" =~ Usage ]] || [[ ! "${description}" =~ Description ]]; then
740 _exiterr "Error generating help text."
742 printf " %-32s %s\n" "${usage##"# PARAM_Usage: "}" "${description##"# PARAM_Description: "}"
747 # Description: Output configuration variables for use in other scripts
749 echo "# letsencrypt.sh configuration"
751 typeset -p CA LICENSE CHALLENGETYPE HOOK HOOK_CHAIN RENEW_DAYS PRIVATE_KEY KEYSIZE WELLKNOWN PRIVATE_KEY_RENEW OPENSSL_CNF CONTACT_EMAIL LOCKFILE
754 # Main method (parses script arguments and calls command_* methods)
758 [[ -z "${COMMAND}" ]] || _exiterr "Only one command can be executed at a time. See help (-h) for more information."
763 if [[ -z "${1:-}" ]]; then
764 echo "The specified command requires additional parameters. See help:" >&2
768 elif [[ "${1:0:1}" = "-" ]]; then
769 _exiterr "Invalid argument: ${1}"
773 [[ -z "${@}" ]] && eval set -- "--help"
787 set_command sign_domains
793 check_parameters "${1:-}"
800 check_parameters "${1:-}"
801 PARAM_REVOKECERT="${1}"
808 # PARAM_Usage: --domain (-d) domain.tld
809 # PARAM_Description: Use specified domain name(s) instead of domains.txt entry (one certificate!)
812 check_parameters "${1:-}"
813 if [[ -z "${PARAM_DOMAIN:-}" ]]; then
816 PARAM_DOMAIN="${PARAM_DOMAIN} ${1}"
821 # PARAM_Usage: --force (-x)
822 # PARAM_Description: Force renew of certificate even if it is longer valid than value in RENEW_DAYS
827 # PARAM_Usage: --privkey (-p) path/to/key.pem
828 # PARAM_Description: Use specified private key instead of account key (useful for revocation)
831 check_parameters "${1:-}"
832 PARAM_PRIVATE_KEY="${1}"
835 # PARAM_Usage: --config (-f) path/to/config.sh
836 # PARAM_Description: Use specified config file
839 check_parameters "${1:-}"
843 # PARAM_Usage: --hook (-k) path/to/hook.sh
844 # PARAM_Description: Use specified script for hooks
847 check_parameters "${1:-}"
851 # PARAM_Usage: --challenge (-t) http-01|dns-01
852 # PARAM_Description: Which challenge should be used? Currently http-01 and dns-01 are supported
855 check_parameters "${1:-}"
856 PARAM_CHALLENGETYPE="${1}"
859 # PARAM_Usage: --algo (-a) rsa|prime256v1|secp384r1
860 # PARAM_Description: Which public key algorithm should be used? Supported: rsa, prime256v1 and secp384r1
863 check_parameters "${1:-}"
864 PARAM_KEY_ALGO="${1}"
868 echo "Unknown parameter detected: ${1}" >&2
880 sign_domains) command_sign_domains;;
881 sign_csr) command_sign_csr "${PARAM_CSR}";;
882 revoke) command_revoke "${PARAM_REVOKECERT}";;
883 cleanup) command_cleanup;;
884 *) command_help; exit 1;;
891 # Check for missing dependencies