Let's Encrypt used for..

I'm currently using LE for WebAdmin and UserPortal.  Just curious if anyone else is using LE for anything else besides WebAdmin and User Portal?  What other configurations can we use Let's Encrypt?

 

Thanks

Parents
  • I'm using it for

    • Webserver Protection
    • SMTP Proxy TLS encryption
    • HotSpot Page via HTTPS
    • internal webservers (bash script, that fetches the LE certificate from UTM via the built-in API)
    • WebAdmin and UserPortal

    ----------
    Sophos user, admin and reseller.
    Private Setup:

    • XG: HPE DL20 Gen9 (Core i3-7300, 8GB RAM, 120GB SSD) | XG 18.0 (Home License) with: Web Protection, Site-to-Site-VPN (IPSec, RED-Tunnel), Remote Access (SSL, HTML5)
    • UTM: 2 vCPUs, 2GB RAM, 50GB vHDD, 2 vNICs on vServer (KVM) | UTM 9.7 (Home License) with: Email Protection, Webserver Protection, RED-Tunnel (server)
  • scorpionking said:

     

    • internal webservers (bash script, that fetches the LE certificate from UTM via the built-in API
     

     

    Hey Scorpionking,

    would you share your bash script, this would solve the problem I m having?

  • Yeah, but that's a quick and dirty one suitable for my home lab. Use at your own risk!

    Source (German): www.matthiaskind.de/.../41-let-s-encrypt-zertifkat-einer-sophos-utm-automatisiert-weiterverarbeiten-bash-script.html


    #!/bin/bash

    # Fetch Let'sEncrypt cert from UTM and check if different to local.
    # If yes, overwrite and reload affected services # Needs curl, jq and mailutils installed log="/usr/bin/logger -i -p local0.info -t getcert_utm.sh" log_dbg="/usr/bin/logger -i -p local0.debug -t getcert_utm.sh" log_err="/usr/bin/logger -i -p local0.warning -t getcert_utm.sh" #debug=true $log "Starting getcert_utm.sh" utmapiurl="https://<myutm.mydomain.de>:4444/api/objects/ca/host_key_cert/<REF-ID of LE-cert>" utmapikey="<your API key here>" # do not use whitespaces or special characters in paths! curloutfile="/tmp/utm-le-cert_all" tmpkeyfile="/tmp/utm-le-cert.key" tmpcertfile="/tmp/utm-le-cert.pem" # must match the path and certificate name in your apache, dovecot, etc. config dstkeyfile="/etc/ssl/private/mydomain.de_SAN_LE.key" dstcertfile="/etc/ssl/mydomain.de_SAN_LE.pem" # false (if can be used separately) or path to intermediate intermediateca="/etc/ssl/lets-encrypt-x3-cross-signed.pem" tmpmailtext="/tmp/mailtext.txt" mailsubject="LE-Cert-Fetcher on "$(hostname)": " mailto="<your email address>" mailresult="Nothing changed" restartservices=false # services to restart after certificate change services="dovecot.service postfix.service nginx.service" errtext="" errdetected=false certsubject=$(/usr/bin/openssl x509 -text -noout -in $dstcertfile |grep -oP '(?<=Subject: )[^,]+') certvalidity=$(/usr/bin/openssl x509 -text -noout -in $dstcertfile |grep -oP '(?<=Not After : )[^,]+') echo -e "Hello!\n" > $tmpmailtext echo -e "This is to inform you about recent changes in our Let's Encrypt certificate with $certsubject:\nValid until: $certvalidity\n" >> $tmpmailtext $log "Downloading cert from UTM API." curl -k -X GET --header "Accept: application/json" --header "Authorization: Basic ${utmapikey}" "${utmapiurl}" -o "$curloutfile" > /tmp/getcert_utm_curl 2>&1 if [ $? -eq 0 ]; then $log "Extracting key and certificate from output." jq -r '.key' $curloutfile > $tmpkeyfile res1=$? jq -r '.certificate' $curloutfile > $tmpcertfile res2=$? if [ $res1 -eq 0 ] && [ $res2 -eq 0 ]; then $log "Comparing new and old files." diff $tmpkeyfile $dstkeyfile if [ $? -eq 0 ]; then $log "Key has not changed." echo "Key has not changed." >> $tmpmailtext else $log "Key has changed. Copying new key." cp $tmpkeyfile $dstkeyfile if [ $? -eq 0 ]; then restartservices=true mailresult="Key changed" echo "Key has been exchanged by a newer version." >> $tmpmailtext else errdetected=true errtext=$errtext"Error copying key to destination. " mailresult="Error" echo "ERROR copying key to destination" >> $tmpmailtext fi fi if [ $intermediateca != false ]; then $log "Appending intermediate ca to certificate." cat $intermediateca >> $tmpcertfile fi diff $tmpcertfile $dstcertfile if [ $? -eq 0 ]; then $log "Certificate has not changed." echo "Certificate has not changed." >> $tmpmailtext else $log "Certificate has changed. Copying new key." cp $tmpcertfile $dstcertfile if [ $? -eq 0 ]; then restartservices=true mailresult="Certificate changed" echo "Certificate has been exchanged by a newer version." >> $tmpmailtext else errdetected=true errtext=$errtext"Error copying certificate to destination. " mailresult="Error" echo "ERROR copying certificate to destination" >> $tmpmailtext fi fi if [ "$errdetected" = true ]; then mailresult="Error" $log_err "Failure in setting certs: $errtext" fi else mailresult="Error extracting cert" echo "Could not extract cert or key from output. Check format of output, should be JSON containing .key and .certificate section." >> $tmpmailtext $log_err "Could not extract cert or key from output. Check format of output, should be JSON containing .key and .certificate section." fi else mailresult="Error getting cert" echo "Could not connect to $utmapiurl or error in authentication. Check connection and URL settings." >> $tmpmailtext $log_err "Could not connect to $utmapiurl or error in authentication. Check connection and URL settings." fi certdetails=$(/usr/bin/openssl x509 -text -noout -in $dstcertfile) echo -e "\nBest regards,\nroot\n\n----------\n\nCertificate details:\n\n$certdetails" >> $tmpmailtext mail -s "${mailsubject}${mailresult}" $mailto < "${tmpmailtext}" rm "${curloutfile}" "${tmpkeyfile}" "${tmpcertfile}" "${tmpmailtext}" if [ "$restartservices" = true ]; then $log "Reloading \"$services\" as some data has changed" systemctl reload $services fi $log "Finished." #Finished

    ----------
    Sophos user, admin and reseller.
    Private Setup:

    • XG: HPE DL20 Gen9 (Core i3-7300, 8GB RAM, 120GB SSD) | XG 18.0 (Home License) with: Web Protection, Site-to-Site-VPN (IPSec, RED-Tunnel), Remote Access (SSL, HTML5)
    • UTM: 2 vCPUs, 2GB RAM, 50GB vHDD, 2 vNICs on vServer (KVM) | UTM 9.7 (Home License) with: Email Protection, Webserver Protection, RED-Tunnel (server)
  • Well, thank you so much!

    I will give it a try also in my home Lab. If you call this a quick and dirty one, then I wouldn't know what to say when you would doing it "right"!?

     

    Looks amazing at a first glance! Keep it rolling, thanks again!

  • Hi,

    Great script! I have one problem though that stops me and that is that the reply to the RestAPI call:
    /api/objects/ca/host_key_cert/<REF>

    For me does not result in a reply that includes the private key field: 'key', the only fields I get back is:

    {
    "_locked": "",
    "_ref": "REF_...",
    "_type": "ca/host_key_cert",
    "ca": "",
    "certificate": ...
    "comment": "",
    "encrypted": false,
    "meta": "REF_...",
    "name": "..."
    }
     
    Do you have any idea what I may be doing wrong? Thanks! I am running release: 9.600-5.
     
     
     
  • Did you replace <REF> with the current REF ID of your Let's Encrypt certificate? You can find it by logging in to the REST API with your admin user and then searching for the appropriate _ref in the section "ca/host_key_cert" (choose "ca" in the dropdown menu at the top right).

    And have you created an API key in WebAdmin for this script?

    Also try the full URL in a browser to verify the result. It should look like this one:

    {
      "_locked": "",
      "_ref": "REF_XxxYyyzZZ",
      "_type": "ca/host_key_cert",
      "ca": "",
      "certificate": "<your cert meta data here>-----BEGIN CERTIFICATE-----<your cert here>-----END CERTIFICATE-----",
      "comment": "",
      "encrypted": false,
      "key": "-----BEGIN PRIVATE KEY-----<private key here>-----END PRIVATE KEY-----",
      "meta": "REF_aaAbBBcCC",
      "name": "<cert name like in UTM Web Admin>"
    }

    ----------
    Sophos user, admin and reseller.
    Private Setup:

    • XG: HPE DL20 Gen9 (Core i3-7300, 8GB RAM, 120GB SSD) | XG 18.0 (Home License) with: Web Protection, Site-to-Site-VPN (IPSec, RED-Tunnel), Remote Access (SSL, HTML5)
    • UTM: 2 vCPUs, 2GB RAM, 50GB vHDD, 2 vNICs on vServer (KVM) | UTM 9.7 (Home License) with: Email Protection, Webserver Protection, RED-Tunnel (server)
  • Yes, I use the corresponding ref as the: REF_XxxYyyzZZ in your example.

    All other fields are there and correct. It is only the 'key'-field that does not show up. It does not show up for any of the certificates. I wonder if there is something with regards to permissions or similar.

  • It is an access problem. If I am using the admin user/password instead when login to https://<sophos>:4444/api/ then I also get access to the key field. I was using a user that was not part of the SuperAdmins-groups. I was reading the UTM-RESTful-API manual and it stated: "Note – This cannot be the admin user. We recommend mapping the token to a user with reduced permissions." So I assumed that one should not be using an accounts in the SuperAdmins-group, but that seems to be the only way forward to get access to the private keys.

  • Update:

    Only way to get access to the key-field (private key) is that the user is added to the SuperAdmin-group. Also I have to delete and create a new API-token after adding the user to the group. Doing these two steps and I finally have access to the key-field. If you know a different way then to use a SuperAdmin-account, please let me know. Thanks again for a great script!

  • Halloj and welcome to the UTM Community!

    Thanks for contributing that important piece of information!

    Cheers - Bob

     
    Sophos UTM Community Moderator
    Sophos Certified Architect - UTM
    Sophos Certified Engineer - XG
    Gold Solution Partner since 2005
    MediaSoft, Inc. USA
Reply Children
No Data