6 umask 077 # paranoid umask, we're creating private keys
8 # Get the directory in which this script is stored
9 SCRIPTDIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
11 # directory for config, private key and certificates
12 BASEDIR="${SCRIPTDIR}"
14 # Default config values
15 CA="https://acme-v01.api.letsencrypt.org/directory"
16 LICENSE="https://letsencrypt.org/documents/LE-SA-v1.0.1-July-27-2015.pdf"
22 PRIVATE_KEY_RENEW="no"
23 OPENSSL_CNF="$(openssl version -d | cut -d'"' -f2)/openssl.cnf"
27 # Default config variables depending on BASEDIR
28 if [[ -z "${PRIVATE_KEY}" ]]; then
29 PRIVATE_KEY="${BASEDIR}/private_key.pem"
31 if [[ -z "${WELLKNOWN}" ]]; then
32 WELLKNOWN="${BASEDIR}/.acme-challenges"
35 LOCKFILE="${BASEDIR}/lock"
39 # Check for config in various locations
40 if [[ -z "${CONFIG:-}" ]]; then
41 for check_config in "${HOME}/.letsencrypt.sh" "/etc/letsencrypt.sh" "/usr/local/etc/letsencrypt.sh" "${PWD}" "${SCRIPTDIR}"; do
42 if [[ -e "${check_config}/config.sh" ]]; then
43 BASEDIR="${check_config}"
44 CONFIG="${check_config}/config.sh"
50 if [[ -z "${CONFIG:-}" ]]; then
51 echo "WARNING: No config file found, using default config!" >&2
53 elif [[ -e "${CONFIG}" ]]; then
54 if [[ ! "${COMMAND}" = "env" ]]; then
55 echo "Using config file ${CONFIG}"
57 BASEDIR="$(dirname "${CONFIG}")"
58 # shellcheck disable=SC1090
61 echo "ERROR: Specified config file doesn't exist." >&2
65 # Remove slash from end of BASEDIR. Mostly for cleaner outputs, doesn't change functionality.
66 BASEDIR="${BASEDIR%%/}"
68 # Check BASEDIR and set default variables
69 if [[ ! -d "${BASEDIR}" ]]; then
70 echo "ERROR: BASEDIR does not exist: ${BASEDIR}" >&2
75 if [[ "${COMMAND}" = "env" ]]; then
79 # Lockfile handling (prevents concurrent access)
81 if ! { date > "${LOCKFILE}"; } 2>/dev/null; then
82 echo " + ERROR: Lock file '${LOCKFILE}' present, aborting." >&2
83 LOCKFILE="" # so remove_lock doesn't remove it
89 if [[ -n "${LOCKFILE}" ]]; then
93 trap 'remove_lock' EXIT
95 # Export some environment variables to be used in hook script
101 CA_DIRECTORY="$(_request get "${CA}")"
102 CA_NEW_CERT="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-cert)" &&
103 CA_NEW_AUTHZ="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-authz)" &&
104 CA_NEW_REG="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value new-reg)" &&
105 # shellcheck disable=SC2015
106 CA_REVOKE_CERT="$(printf "%s" "${CA_DIRECTORY}" | get_json_string_value revoke-cert)" ||
107 (echo "Error retrieving ACME/CA-URLs, check if your configured CA points to the directory entrypoint." >&2; exit 1)
110 # check private key ...
112 if [[ -n "${PARAM_PRIVATE_KEY:-}" ]]; then
113 # a private key was specified from the command line so use it for this run
114 echo "Using private key ${PARAM_PRIVATE_KEY} instead of account key"
115 PRIVATE_KEY="${PARAM_PRIVATE_KEY}"
116 if ! openssl rsa -in "${PRIVATE_KEY}" -check 2>/dev/null > /dev/null; then
117 echo " + ERROR: private key is not valid, can not continue" >&2
121 # Check if private account key exists, if it doesn't exist yet generate a new one (rsa key)
122 if [[ ! -e "${PRIVATE_KEY}" ]]; then
123 echo "+ Generating account key..."
124 _openssl genrsa -out "${PRIVATE_KEY}" "${KEYSIZE}"
129 # Get public components from private key and calculate thumbprint
130 pubExponent64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -text | grep publicExponent | grep -oE "0x[a-f0-9]+" | cut -d'x' -f2 | hex2bin | urlbase64)"
131 pubMod64="$(openssl rsa -in "${PRIVATE_KEY}" -noout -modulus | cut -d'=' -f2 | hex2bin | urlbase64)"
133 thumbprint="$(printf '{"e":"%s","kty":"RSA","n":"%s"}' "${pubExponent64}" "${pubMod64}" | openssl sha -sha256 -binary | urlbase64)"
135 # If we generated a new private key in the step above we have to register it with the acme-server
136 if [[ "${register}" = "1" ]]; then
137 echo "+ Registering account key with letsencrypt..."
138 if [ -z "${CA_NEW_REG}" ]; then
139 echo " + ERROR: Certificate authority doesn't allow registrations." >&2
142 # if an email for the contact has been provided then adding it to the registration request
143 if [[ -n "${CONTACT_EMAIL}" ]]; then
144 signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "contact":["mailto:'"${CONTACT_EMAIL}"'"], "agreement": "'"$LICENSE"'"}' > /dev/null
146 signed_request "${CA_NEW_REG}" '{"resource": "new-reg", "agreement": "'"$LICENSE"'"}' > /dev/null
150 if [[ -e "${BASEDIR}/domains.txt" ]]; then
151 DOMAINS_TXT="${BASEDIR}/domains.txt"
153 echo " + ERROR: domains.txt not found" >&2
157 if [[ ! -e "${WELLKNOWN}" ]]; then
158 echo " + ERROR: WELLKNOWN directory doesn't exist, please create ${WELLKNOWN} and set appropriate permissions." >&2
168 # urlbase64: base64 encoded string with '+' replaced with '-' and '/' replaced with '_'
169 openssl base64 -e | anti_newline | sed 's/=*$//g' | tr '+/' '-_'
173 # Store hex string from stdin
178 for ((i=0; i<${#tmphex}; i+=1)); do
179 test "${tmphex:$i:1}" == " " || hex="${hex}${tmphex:$i:1}"
183 test $((${#hex} & 1)) == 0 || hex="0${hex}"
185 # Convert to escaped string
187 for ((i=0; i<${#hex}; i+=2)); do
188 escapedhex=$escapedhex\\x${hex:$i:2}
191 # Convert to binary data
192 printf -- "${escapedhex}"
195 get_json_string_value() {
196 grep -Eo '"'"${1}"'":[[:space:]]*"[^"]*"' | cut -d'"' -f4
200 grep -Eo '"'"${1}"'":[^\[]*\[[^]]*]'
206 if [[ "${1}" = "head" ]]; then
207 statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -I)"
208 elif [[ "${1}" = "get" ]]; then
209 statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}")"
210 elif [[ "${1}" = "post" ]]; then
211 statuscode="$(curl -s -w "%{http_code}" -o "${tempcont}" "${2}" -d "${3}")"
214 if [[ ! "${statuscode:0:1}" = "2" ]]; then
215 echo " + ERROR: An error occurred while sending ${1}-request to ${2} (Status ${statuscode})" >&2
218 cat "${tempcont}" >&2
221 # Wait for hook script to clean the challenge if used
222 if [[ -n "${HOOK}" ]] && [[ -n "${challenge_token:+set}" ]]; then
223 ${HOOK} "clean_challenge" '' "${challenge_token}" "${keyauth}"
226 # remove temporary domains.txt file if used
227 if [[ -n "${PARAM_DOMAIN:-}" ]]; then
238 # OpenSSL writes to stderr/stdout even when there are no errors. So just
239 # display the output if the exit code was != 0 to simplify debugging.
242 out="$(openssl "${@}" 2>&1)"
245 if [[ $res -ne 0 ]]; then
246 echo " + ERROR: failed to run $* (Exitcode: $res)" >&2
255 # Encode payload as urlbase64
256 payload64="$(printf '%s' "${2}" | urlbase64)"
258 # Retrieve nonce from acme-server
259 nonce="$(_request head "${CA}" | grep Replay-Nonce: | awk -F ': ' '{print $2}' | anti_newline)"
261 # Build header with just our public key and algorithm information
262 header='{"alg": "RS256", "jwk": {"e": "'"${pubExponent64}"'", "kty": "RSA", "n": "'"${pubMod64}"'"}}'
264 # Build another header which also contains the previously received nonce and encode it as urlbase64
265 protected='{"alg": "RS256", "jwk": {"e": "'"${pubExponent64}"'", "kty": "RSA", "n": "'"${pubMod64}"'"}, "nonce": "'"${nonce}"'"}'
266 protected64="$(printf '%s' "${protected}" | urlbase64)"
268 # Sign header with nonce and our payload with our private key and encode signature as urlbase64
269 signed64="$(printf '%s' "${protected64}.${payload64}" | openssl dgst -sha256 -sign "${PRIVATE_KEY}" | urlbase64)"
271 # Send header + extended header + payload + signature to the acme-server
272 data='{"header": '"${header}"', "protected": "'"${protected64}"'", "payload": "'"${payload64}"'", "signature": "'"${signed64}"'"}'
274 _request post "${1}" "${data}"
281 echo " + Signing domains..."
282 if [[ -z "${CA_NEW_AUTHZ}" ]] || [[ -z "${CA_NEW_CERT}" ]]; then
283 echo " + ERROR: Certificate authority doesn't allow certificate signing" >&2
286 timestamp="$(date +%s)"
288 # If there is no existing certificate directory => make it
289 if [[ ! -e "${BASEDIR}/certs/${domain}" ]]; then
290 echo " + make directory ${BASEDIR}/certs/${domain} ..."
291 mkdir -p "${BASEDIR}/certs/${domain}"
294 privkey="privkey.pem"
295 # generate a new private key if we need or want one
296 if [[ ! -f "${BASEDIR}/certs/${domain}/privkey.pem" ]] || [[ "${PRIVATE_KEY_RENEW}" = "yes" ]]; then
297 echo " + Generating private key..."
298 privkey="privkey-${timestamp}.pem"
299 _openssl genrsa -out "${BASEDIR}/certs/${domain}/privkey-${timestamp}.pem" "${KEYSIZE}"
302 # Generate signing request config and the actual signing request
304 for altname in $altnames; do
305 SAN+="DNS:${altname}, "
308 echo " + Generating signing request..."
309 local tmp_openssl_cnf
310 tmp_openssl_cnf="$(mktemp)"
311 cat "${OPENSSL_CNF}" > "${tmp_openssl_cnf}"
312 printf "[SAN]\nsubjectAltName=%s" "${SAN}" >> "${tmp_openssl_cnf}"
313 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}"
314 rm -f "${tmp_openssl_cnf}"
316 # Request and respond to challenges
317 for altname in $altnames; do
318 # Ask the acme-server for new challenge token and extract them from the resulting json block
319 echo " + Requesting challenge for ${altname}..."
320 response="$(signed_request "${CA_NEW_AUTHZ}" '{"resource": "new-authz", "identifier": {"type": "dns", "value": "'"${altname}"'"}}')"
322 challenges="$(printf '%s\n' "${response}" | get_json_array challenges)"
323 repl=$'\n''{' # fix syntax highlighting in Vim
324 challenge="$(printf "%s" "${challenges//\{/${repl}}" | grep 'http-01')"
325 challenge_token="$(printf '%s' "${challenge}" | get_json_string_value token | sed 's/[^A-Za-z0-9_\-]/_/g')"
326 challenge_uri="$(printf '%s' "${challenge}" | get_json_string_value uri)"
328 if [[ -z "${challenge_token}" ]] || [[ -z "${challenge_uri}" ]]; then
329 echo " + Error: Can't retrieve challenges (${response})" >&2
333 # Challenge response consists of the challenge token and the thumbprint of our public certificate
334 keyauth="${challenge_token}.${thumbprint}"
336 # Store challenge response in well-known location and make world-readable (so that a webserver can access it)
337 printf '%s' "${keyauth}" > "${WELLKNOWN}/${challenge_token}"
338 chmod a+r "${WELLKNOWN}/${challenge_token}"
340 # Wait for hook script to deploy the challenge if used
341 if [[ -n "${HOOK}" ]]; then
342 ${HOOK} "deploy_challenge" "${altname}" "${challenge_token}" "${keyauth}"
345 # Ask the acme-server to verify our challenge and wait until it becomes valid
346 echo " + Responding to challenge for ${altname}..."
347 result="$(signed_request "${challenge_uri}" '{"resource": "challenge", "keyAuthorization": "'"${keyauth}"'"}')"
349 status="$(printf '%s\n' "${result}" | get_json_string_value status)"
351 # get status until a result is reached => not pending anymore
352 while [[ "${status}" = "pending" ]]; do
354 status="$(_request get "${challenge_uri}" | get_json_string_value status)"
357 rm -f "${WELLKNOWN}/${challenge_token}"
359 # Wait for hook script to clean the challenge if used
360 if [[ -n "${HOOK}" ]] && [[ -n "${challenge_token}" ]]; then
361 ${HOOK} "clean_challenge" "${altname}" "${challenge_token}" "${keyauth}"
364 if [[ "${status}" = "valid" ]]; then
365 echo " + Challenge is valid!"
367 echo " + Challenge is invalid! (returned: ${status})" >&2
373 # Finally request certificate from the acme-server and store it in cert-${timestamp}.pem and link from cert.pem
374 echo " + Requesting certificate..."
375 csr64="$(openssl req -in "${BASEDIR}/certs/${domain}/cert-${timestamp}.csr" -outform DER | urlbase64)"
376 crt64="$(signed_request "${CA_NEW_CERT}" '{"resource": "new-cert", "csr": "'"${csr64}"'"}' | openssl base64 -e)"
377 crt_path="${BASEDIR}/certs/${domain}/cert-${timestamp}.pem"
378 printf -- '-----BEGIN CERTIFICATE-----\n%s\n-----END CERTIFICATE-----\n' "${crt64}" > "${crt_path}"
379 # try to load the certificate to detect corruption
380 echo " + Checking certificate..."
381 _openssl x509 -text < "${crt_path}"
383 # Create fullchain.pem
384 echo " + Creating fullchain.pem..."
385 cat "${crt_path}" > "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
386 _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"
387 if ! grep "BEGIN CERTIFICATE" "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" > /dev/null 2>&1; then
388 openssl x509 -in "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" -inform DER -out "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" -outform PEM
390 ln -sf "chain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/chain.pem"
391 cat "${BASEDIR}/certs/${domain}/chain-${timestamp}.pem" >> "${BASEDIR}/certs/${domain}/fullchain-${timestamp}.pem"
392 ln -sf "fullchain-${timestamp}.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
394 # Update remaining symlinks
395 if [ ! "${privkey}" = "privkey.pem" ]; then
396 ln -sf "privkey-${timestamp}.pem" "${BASEDIR}/certs/${domain}/privkey.pem"
399 ln -sf "cert-${timestamp}.csr" "${BASEDIR}/certs/${domain}/cert.csr"
400 ln -sf "cert-${timestamp}.pem" "${BASEDIR}/certs/${domain}/cert.pem"
402 # Wait for hook script to clean the challenge and to deploy cert if used
403 if [[ -n "${HOOK}" ]]; then
404 ${HOOK} "deploy_cert" "${domain}" "${BASEDIR}/certs/${domain}/privkey.pem" "${BASEDIR}/certs/${domain}/cert.pem" "${BASEDIR}/certs/${domain}/fullchain.pem"
407 unset challenge_token
413 # Description: Sign/renew non-existant/changed/expiring certificates.
414 command_sign_domains() {
415 if [[ -n "${PARAM_DOMAIN:-}" ]]; then
416 # we are using a temporary domains.txt file so we don't need to duplicate any code
417 DOMAINS_TXT="$(mktemp)"
418 echo "${PARAM_DOMAIN}" > "${DOMAINS_TXT}"
420 # Generate certificates for all domains found in domains.txt. Check if existing certificate are about to expire
421 <"${DOMAINS_TXT}" sed 's/^[[:space:]]*//g;s/[[:space:]]*$//g' | grep -vE '^(#|$)' | while read -r line; do
422 domain="$(printf '%s\n' "${line}" | cut -d' ' -f1)"
423 morenames="$(printf '%s\n' "${line}" | cut -s -d' ' -f2-)"
424 cert="${BASEDIR}/certs/${domain}/cert.pem"
426 force_renew="${PARAM_FORCE:-no}"
428 if [[ -z "${morenames}" ]];then
429 echo "Processing ${domain}"
431 echo "Processing ${domain} with SAN: ${morenames}"
434 if [[ -e "${cert}" ]]; then
435 echo -n " + Checking domain name(s) of existing cert..."
437 certnames="$(openssl x509 -in "${cert}" -text -noout | grep DNS: | sed 's/DNS://g' | tr -d ' ' | tr ',' '\n' | sort -u | tr '\n' ' ' | sed 's/ $//')"
438 givennames="$(echo "${domain}" "${morenames}"| tr ' ' '\n' | sort -u | tr '\n' ' ' | sed 's/ $//' | sed 's/^ //')"
440 if [[ "${certnames}" = "${givennames}" ]]; then
444 echo " + Domain name(s) are not matching!"
445 echo " + Names in old certificate: ${certnames}"
446 echo " + Configured names: ${givennames}"
447 echo " + Forcing renew."
452 if [[ -e "${cert}" ]]; then
453 echo " + Checking expire date of existing cert..."
455 valid="$(openssl x509 -enddate -noout -in "${cert}" | cut -d= -f2- )"
457 echo -n " + Valid till ${valid} "
458 if openssl x509 -checkend $((RENEW_DAYS * 86400)) -noout -in "${cert}"; then
459 echo -n "(Longer than ${RENEW_DAYS} days). "
460 if [[ "${force_renew}" = "yes" ]]; then
461 echo "Ignoring because renew was forced!"
467 echo "(Less than ${RENEW_DAYS} days). Renewing!"
471 # shellcheck disable=SC2086
475 # remove temporary domains.txt file if used
476 if [[ -n "${PARAM_DOMAIN:-}" ]]; then
477 rm -f "${DOMAINS_TXT}"
481 # Usage: --revoke (-r) path/to/cert.pem
482 # Description: Revoke specified certificate
485 if [[ -L "${cert}" ]]; then
486 # follow symlink and use real certificate name (so we move the real file and not the symlink at the end)
488 link_target="$(readlink -n "${cert}")"
489 if [[ "${link_target}" =~ ^/ ]]; then
490 cert="${link_target}"
492 cert="$(dirname "${cert}")/${link_target}"
495 if [[ ! -f "${cert}" ]]; then
496 echo "ERROR: Could not find certificate ${cert}"
499 echo "Revoking ${cert}"
500 if [[ -z "${CA_REVOKE_CERT}" ]]; then
501 echo " + ERROR: Certificate authority doesn't allow certificate revocation." >&2
504 cert64="$(openssl x509 -in "${cert}" -inform PEM -outform DER | urlbase64)"
505 response="$(signed_request "${CA_REVOKE_CERT}" '{"resource": "revoke-cert", "certificate": "'"${cert64}"'"}')"
506 # if there is a problem with our revoke request _request (via signed_request) will report this and "exit 1" out
507 # so if we are here, it is safe to assume the request was successful
509 echo " + renaming certificate to ${cert}-revoked"
510 mv -f "${cert}" "${cert}-revoked"
514 # Description: Show help text
516 echo "Usage: ${0} [-h] [command [argument]] [parameter [argument]] [parameter [argument]] ..."
518 echo "Default command: help"
522 grep -e '^[[:space:]]*# Usage:' -e '^[[:space:]]*# Description:' -e '^command_.*()[[:space:]]*{' "${0}" | while read -r usage; read -r description; read -r command; do
523 if [[ ! "${usage}" =~ Usage ]] || [[ ! "${description}" =~ Description ]] || [[ ! "${command}" =~ ^command_ ]]; then
524 echo "Error generating help text." >&2
527 printf " %s\t%s\n" "${usage##"# Usage: "}" "${description##"# Description: "}"
531 grep -E -e '^[[:space:]]*# PARAM_Usage:' -e '^[[:space:]]*# PARAM_Description:' "${0}" | while read -r usage; read -r description; do
532 if [[ ! "${usage}" =~ Usage ]] || [[ ! "${description}" =~ Description ]]; then
533 echo "Error generating help text." >&2
536 printf " %s\t%s\n" "${usage##"# PARAM_Usage: "}" "${description##"# PARAM_Description: "}"
538 ) | column -t -s $'\t' | sed 's/^---$//g'
542 # Description: Output configuration variables for use in other scripts
544 echo "# letsencrypt.sh configuration"
546 typeset -p CA LICENSE BASEDIR WELLKNOWN PRIVATE_KEY KEYSIZE OPENSSL_CNF HOOK RENEW_DAYS PRIVATE_KEY_RENEW CONTACT_EMAIL
551 # change long args to short args
552 # inspired by http://kirk.webfinish.com/?p=45
555 --help) args="${args}-h ";;
556 --cron) args="${args}-c ";;
557 --domain) args="${args}-d ";;
558 --force ) args="${args}-x ";;
559 --revoke) args="${args}-r ";;
560 --privkey) args="${args}-p ";;
561 --config) args="${args}-f ";;
562 --env) args="${args}-e ";;
564 echo "Unknown parameter detected: ${arg}" >&2
569 # pass through anything else
570 *) args="${args}\"${arg}\" ";;
574 # Reset the positional parameters to the short options
575 eval set -- "${args}"
579 if [[ ! -z "${COMMAND}" ]]; then
580 echo "Only one command can be executed at a time." >&2
581 echo "See help (-h) for more information." >&2
588 if [[ -z "${@}" ]]; then
589 echo "The specified command requires additional parameters. See help:" >&2
596 while getopts ":hcer:d:xf:p:" option; do
603 set_command sign_domains
610 check_parameters "${OPTARG:-}"
611 revoke_me="${OPTARG}"
614 # PARAM_Usage: --domain (-d) domain.tld
615 # PARAM_Description: Use specified domain name instead of domains.txt, use multiple times for certificate with SAN names
616 check_parameters "${OPTARG:-}"
617 if [[ -z "${PARAM_DOMAIN:-}" ]]; then
618 PARAM_DOMAIN="${OPTARG}"
620 PARAM_DOMAIN="${PARAM_DOMAIN} ${OPTARG}"
624 # PARAM_Usage: --force (-x)
625 # PARAM_Description: force renew of certificate even if it is longer valid than value in RENEW_DAYS
629 # PARAM_Usage: --config (-f) path/to/config.sh
630 # PARAM_Description: Use specified config file
631 check_parameters "${OPTARG:-}"
635 # PARAM_Usage: --privkey (-p) path/to/key.pem
636 # PARAM_Description: Use specified private key instead of account key (useful for revocation)
637 check_parameters "${OPTARG:-}"
638 PARAM_PRIVATE_KEY="${OPTARG}"
641 echo "Unknown parameter detected: -${OPTARG}" >&2
649 if [[ -z "${COMMAND}" ]]; then
664 command_revoke "${revoke_me}"