bin/certbot_authentication.sh

   1 #!/bin/bash
   2 ################################################################################
   3 #
   4 # File:         certbot_authentication.sh
   5 # Revision:     1.0
   6 # Description:  Perform domain validation by creating a TXT record on the domain
   7 #               from certbot. This script is designed to work with
   8 #               Dreamhost.com's API and certbot running on Ubuntu 20.04. Note
   9 #               that it has not been extended to handle multiple domains.
  10 #
  11 #               Domain validation is the process of validating you have control
  12 #               over a domain. Services like Let's Encrypt can then issue you
  13 #               domain validated TLS certificates for use to secure websites.
  14 #
  15 # See also:     https://help.dreamhost.com/hc/en-us/articles/217555707-DNS-API-commands
  16 #
  17 # Crontab:      0 0 1 * * certbot renew --manual-aacmeuth-hook /path/to/certbot_authentication.sh --manual-cleanup-hook /path/to/certbot_cleanup.sh
  18 #
  19 # Author:       Andrew@DeFaria.com
  20 # Created:      Fri 04 Jun 2021 11:20:16 PDT
  21 # Modified:
  22 # Language:     Bash
  23 #
  24 # (c) Copyright 2021, ClearSCM, Inc., all rights reserved
  25 #
  26 ################################################################################
  27 # The following are environment variables that certbot passes to us
  28 #
  29 # CERTBOT_DOMAIN:     Domain being authenticated. For example,
  30 #                     _acme-challenge.example.com for a wildcart cert or
  31 #                     _acme-challenge.subdomain.example.com for a subdomain
  32 #                     Note: Pass in $1 for testing or use the default of
  33 #                     CERTBOT_DOMAIN
  34 domain=${1:-$CERTBOT_DOMAIN}
  35
  36 # CERTBOT_VALIDATION: The validation string. Pass in $2 or use the default of
  37 #                     CERTBOT_VALIDATION
  38 value=${2:-$CERTBOT_VALIDATION}
  39
  40 logfile=/tmp/debug.log
  41 rm -f $logfile
  42
  43 function log {
  44   #echo $1
  45   echo $1 >> $logfile
  46 } # log
  47
  48 log "domain = $domain"
  49 log "value = $value"
  50
  51 # Dreamhost key - generate at https://panel.dreamhost.com/?tree=home.api
  52 key=KHY6UJQXD9MEJZHR
  53
  54 # URL where the REST endpoint is
  55 url="https://api.dreamhost.com/?key=$key"
  56
  57 # Add a TXT record to domain
  58 function addTXT {
  59   log "Adding TXT record $domain = $value" >> $logfile
  60   cmd="$url&unique_id=$(uuidgen)&cmd=dns-add_record&record=&type=TXT&value=_acme-challenge.$domain=$value"
  61
  62   log "cmd = $cmd" >> $logfile
  63
  64   response=$(wget -O- -q "$cmd")
  65
  66   log "Response = $response" >> $logfile
  67 } # addTXT
  68
  69 # Verifies that the TXT record has propogated. Note that this cannot be
  70 # likewise used for removal of the TXT record, which also needs to propagate.
  71 # However, we are not concerned with when the removal is propagated, it can
  72 # do so on its own time
  73 function verifyPropagation {
  74   log "Enter verifyPropagation" >> $logfile
  75   # We will try 4 times waiting 5 minutes in between
  76   max_attempts=4
  77   time_between_attempts=300
  78
  79   # Obviously it's not propagated immediately so first wait
  80   attempt=0
  81   while [ $attempt -lt 4 ]; do
  82     log "Waiting 5 minutes for TXT record $domain to propagate..." >> $logfile
  83     sleep $time_between_attempts
  84
  85     ((attempt++))
  86     log "Attempt #$attempt: Validating of propagation of TXT record $domain" >> $logfile
  87     TXT=$(nslookup -type=TXT $domain | grep -vi "can't find" | grep $domain)
  88
  89     if [ -n "$TXT" ]; then
  90       log "TXT record $name.$domain propagated" >> $logfile
  91       return
  92     else
  93       log "TXT record $name.$domain not propagated yet" >> $logfile
  94     fi
  95   done
  96
  97   log "ERROR: Unable to validate propagation" >> $logfile
  98   exit 1
  99 } # verifyPropagation
 100
 101 log "Calling addTXT" >> $logfile
 102 addTXT
 103 log "Returned from addTXT" >> $logfile
 104 log "calling verifyPropagation" >> $logfile
 105 verifyPropagation
 106 log "Returned from verifyPropagation" >> $logfile