Category:Community Sandbox: Difference between revisions
Line 175: | Line 175: | ||
% wget -O - https://get.acme.sh | sh | % wget -O - https://get.acme.sh | sh | ||
</pre> | </pre> | ||
Subsequent renewals are performed like this (issue the cert and if successful then deploy the certificate): | Subsequent issues or renewals are performed like this (issue the cert and if successful then deploy the certificate): | ||
<pre> | <pre> | ||
% su - zimbra | % su - zimbra |
Revision as of 21:40, 4 April 2019
JDunphy Letsencrypt - Another Method Using acme.sh to Generate Certs
Introduction
Letsencrypt is a free, automated, and open Certificate Authority to generate all your PKI certificates so a browser can see & display that trusted green secure lock for your domains. Instead of installing a development environment like other Letsencrypt methods, this article describes a single bash script and can be installed and operated without being root. Here is how to get Zimbra up and running with your Letsencrypt certificate.
Requirements (1 time only)
- Install acme.sh bash script in your home directory. Ref: https://github.com/Neilpang/acme.sh
% curl https://get.acme.sh | sh Or: % wget -O - https://get.acme.sh | sh
Note: This will do three things.
- create a directory ~/.acme.sh
- update your .cshrc and .bashrc so that script is in your path
- create a cron job for the local user for automatic renewal
Issue Your Certificate
Letsencrypt needs to verify you have control of your domains before they will sign your certificate. To do that, we complete a challenge and prove we have control of the domains using their acme protocol. The acme.sh script supports all challenge methods but for this article we will focus on the Automatic DNS challenge. See https://github.com/Neilpang/acme.sh for other methods or my own documentation https://github.com/JimDunphy/deploy-zimbra-letsencrypt.sh/tree/master/Recipies/SingleServer which lists 3 different type of DNS methods. All challenge methods that acme.sh supports work with this article including --standalone/--tls if you prefer an alternative to the DNS method described here.
When using the Automatic DNS Method for the first time, you will need to update ~/.acme.sh/account.conf to contain your DNS provider api key. A list of supported DNS providers can be found at ~/.acme.sh/dnsapi. In this article we will use CloudFlare. Login to your CloudFlare account to get your API key before proceeding and then add these 2 lines to your ~/.acme.sh/account.conf file
- SAVED_CF_Key= '......Your API key..........'
- CF_EMAIL='XXXX@example.com'
From now on, anytime we need a certificate or renew a certificate we can do the following:
acme.sh --issue --dns dns_cf -d mail.example.com
If we have multiple domains associated with our Zimbra server, then it works like this:
acme.sh --issue --dns dns_cf -d mail.example.com -d mail.example.net -d mail.example.org
Wild card certs are supported with ACME v2 protocol
acme.sh --issue --dns dns_cf -d example.com -d '*.example.com'
Your certificates can be found at: ~/.acme.sh/mail.example.com ... It uses the first '-d' name to create a directory to store your certificates
Install Certificate With Zimbra
Regardless of which challenge method you used with the acme.sh bash script, the following commands will install it. Note: I have also created a script to perform these steps automatically at https://github.com/JimDunphy/deploy-zimbra-letsencrypt.sh and the forums have a thread on this method https://forums.zimbra.org/viewtopic.php?f=15&t=60781 for additional background information. For this article we walk through those steps.
Step 1 (Append IdentTrust CERT to fullchain)
cd ~/.acme.sh/mail.example.com echo '-----BEGIN CERTIFICATE----- MIIDSjCCAjKgAwIBAgIQRK+wgNajJ7qJMDmGLvhAazANBgkqhkiG9w0BAQUFADA/ MSQwIgYDVQQKExtEaWdpdGFsIFNpZ25hdHVyZSBUcnVzdCBDby4xFzAVBgNVBAMT DkRTVCBSb290IENBIFgzMB4XDTAwMDkzMDIxMTIxOVoXDTIxMDkzMDE0MDExNVow PzEkMCIGA1UEChMbRGlnaXRhbCBTaWduYXR1cmUgVHJ1c3QgQ28uMRcwFQYDVQQD Ew5EU1QgUm9vdCBDQSBYMzCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEB AN+v6ZdQCINXtMxiZfaQguzH0yxrMMpb7NnDfcdAwRgUi+DoM3ZJKuM/IUmTrE4O rz5Iy2Xu/NMhD2XSKtkyj4zl93ewEnu1lcCJo6m67XMuegwGMoOifooUMM0RoOEq OLl5CjH9UL2AZd+3UWODyOKIYepLYYHsUmu5ouJLGiifSKOeDNoJjj4XLh7dIN9b xiqKqy69cK3FCxolkHRyxXtqqzTWMIn/5WgTe1QLyNau7Fqckh49ZLOMxt+/yUFw 7BZy1SbsOFU5Q9D8/RhcQPGX69Wam40dutolucbY38EVAjqr2m7xPi71XAicPNaD aeQQmxkqtilX4+U9m5/wAl0CAwEAAaNCMEAwDwYDVR0TAQH/BAUwAwEB/zAOBgNV HQ8BAf8EBAMCAQYwHQYDVR0OBBYEFMSnsaR7LHH62+FLkHX/xBVghYkQMA0GCSqG SIb3DQEBBQUAA4IBAQCjGiybFwBcqR7uKGY3Or+Dxz9LwwmglSBd49lZRNI+DT69 ikugdB/OEIKcdBodfpga3csTS7MgROSR6cz8faXbauX+5v3gTt23ADq1cEmv8uXr AvHRAosZy5Q6XkjEGB5YGV8eAlrwDPGxrancWYaLbumR9YbK+rlmM6pZW87ipxZz R8srzJmwN0jP41ZL9c8PDHIyh8bwRLtTcm1D9SZImlJnt1ir/md2cXjbDaJWFBM5 JDGFoqgCWjBH4d1QB7wCCZAA62RjYJsWvIjJEubSfZGL+T0yjWW06XyxV3bqxbYo Ob8VZRzI9neWagqNdwvYkQsEjgfbKbYK7p2CNTUQ -----END CERTIFICATE-----' >> fullchain.cer
Because zmcertmgr will chdir during install which can abort when permissions are incorrect in some circumstances, we do the following.
% cd ~.acme.sh/mail.example.com % cp mail.example.com.key mail.example.com.cer fullchain.cer /tmp
Note: For version 8.7 and above, zmcertmgr runs as zimbra. For all earlier versions you will run zmcertmgr as root. Example below is for 8.7 and 8.8 versions.
Step 2 Verify your certificate
% su - zimbra % cd /tmp % /opt/zimbra/bin/zmcertmgr verifycrt comm mail.example.com.key mail.example.com.cer fullchain.cer
If there were no errors, you can install the certificate
Step 3 Install your certificate
% su - zimbra % cd /tmp % cp mail.example.key /opt/zimbra/ssl/zimbra/commercial/commercial.key % /opt/zimbra/bin/zmcertmgr deploycrt comm mail.example.cer fullchain.cer
If there were no errors, proceed to restart zimbra
Step 4 Restart Zimbra
% su - zimbra % zmcontrol restart
All in One Method (Simplest)
Once you understand how to issue your certificates and install acme.sh, you can use the --deploy and --deploy-hook options and have acme.sh perform the zimbra installation for you. This method requires you install and run the acme.sh bash script as the zimbra user and will also handle the identTrust intermediate certificate for you during your certificate installation to zimbra. Versions prior to 8.7, need to modify the hook script below so that the two zmcertmgr commands are run as root.
- Copy the hook script below to /opt/zimbra/.acme.sh/deploy/zimbra.sh
#!/bin/bash # Zimbra Assumptions: # 1) acme.sh is installed as Zimbra # 2) see: https://wiki.zimbra.com/wiki/index.php?curid=2441 ######## Public functions ##################### #domain keyfile certfile cafile fullchain zimbra_deploy() { _cdomain="$1" _ckey="$2" _ccert="$3" _cca="$4" _cfullchain="$5" _debug _cdomain "$_cdomain" _debug _ckey "$_ckey" _debug _ccert "$_ccert" _debug _cca "$_cca" _debug _cfullchain "$_cfullchain" # Zimbra's javastore still needs DST Root CA X3 to verify on some versions _IdentTrust="$(dirname "$_cca")/../IdentTrust.pem" _debug _IdentTrust "$_IdentTrust" # grab it if we don't have it if [ ! -f "$_IdentTrust" ]; then _debug No "$_IdentTrust" wget -q "https://ssl-tools.net/certificates/dac9024f54d8f6df94935fb1732638ca6ad77c13.pem" -O "$_IdentTrust" || return 1 fi # append Intermediate cat "$_cfullchain" "$(dirname "$_cca")/../IdentTrust.pem" > "${_cca}.real" /opt/zimbra/bin/zmcertmgr verifycrt comm "$_ckey" "$_ccert" "${_cca}.real" || return 1 #if it verifies we can deploy it cp -f "$_ckey" /opt/zimbra/ssl/zimbra/commercial/commercial.key /opt/zimbra/bin/zmcertmgr deploycrt comm "$_ccert" "${_cca}.real" || return 1 # %%% ldap wasn't being restarted leading to failed communication in the future if we hadn't done a restart. # Adding a ldap restart was not tested so perhaps. Reload is restart when not defined by zimbra with # exception of ldap which they didn't provide a reload. #/opt/zimbra/bin/ldap restart #/opt/zimbra/bin/zmmailboxdctl reload #/opt/zimbra/bin/zmproxyctl reload #/opt/zimbra/bin/zmmtactl reload /opt/zimbra/bin/zmcontrol restart return 0 }
Complete example:
% su - zimbra % wget -O - https://get.acme.sh | sh % cd .acme.sh % acme.sh --issue --dns dns_cf -d mail.example.com -d mail.example.net -d mail.example.org % acme.sh --issue --deploy --deploy-hook zimbra --dns dns_cf -d mail.example.com -d mail.example.net -d mail.example.org
Note: if you get an error attempting to install acme.sh as the zimbra user, do this as /opt/zimbra is owned by root. Switch to root before switching back to zimbra. Here is an example:
% su - # cd /opt/zimbra/ # mkdir .acme.sh # chown zimbra:zimbra .acme.sh # su - zimbra % cd .acme.sh % wget -O - https://get.acme.sh | sh
Subsequent issues or renewals are performed like this (issue the cert and if successful then deploy the certificate):
% su - zimbra % acme.sh --issue --dns dns_cf -d mail.example.com -d mail.example.net -d mail.example.org % acme.sh --issue --deploy --deploy-hook zimbra --dns dns_cf -d mail.example.com -d mail.example.net -d mail.example.org
Note: You don't need to worry about the IdentTrust.pem certificate described above as the deploy-hook handles this automatically including its fetch. The hook will be called on your successful certificate verification and restart/reload zimbra. If it fails to renew the certificate, the hook will not be called. While the automatic dns method is shown above, any of the challenge methods that acme.sh supports can be used.
Pro Tip: look into the --challenge-alias option with the automatic DNS method to further isolate/secure your zone updates with letsencrypt. You only require a CNAME entry for your trusted zimbra domains for the domains above. In other words, each letsencrypt secured zimbra domain would have this in their zone file. Same entry for every one.
_acme-challenge IN CNAME _acme-challenge.adifferentCFzone.com.
where adifferentCFzone.com is a completely different and managed zone and not a zimbra domain. It can be any of the supported automatic DNS providers including BIND directly.
Here is how this would look using the CNAME alias where example.com, example.net, and example.org are not managed by CF (cloudflare) but we want to secure for zimbra:
% su - zimbra % acme.sh --issue --dns dns_cf --challenge-alias adifferentCFzone.com -d mail.example.com -d mail.example.net -d mail.example.org % acme.sh --issue --deploy --deploy-hook zimbra --dns dns_cf -d mail.example.com -d mail.example.net -d mail.example.org
Notes
Zimbra has 4 major daemons that require certificates. nginx, ldap, postfix, and mailboxd... Below is where zmcertmgr installs the certificate. Because mailboxd is java based, it uses a keystore. Note: /opt/zimbra/ssl contains your certificates. The other locations are copies from here. Further: nginx, ldap, and postfix can reload those new certificates hot without shutting down the services so in theory we are performing a restart because mailboxd and taking an outage during certificate renewal.
% ls -lt /opt/zimbra/conf/slapd.* -rw-r----- 1 zimbra zimbra 7213 Aug 4 10:46 slapd.crt -rw-r----- 1 zimbra zimbra 1679 Aug 4 10:46 slapd.key % ls -lt /opt/zimbra/ssl/zimbra/commercial -rw-r----- 1 zimbra zimbra 5030 Aug 4 10:46 commercial_ca.crt -rw-r----- 1 zimbra zimbra 7213 Aug 4 10:46 commercial.crt -rw-r----- 1 zimbra zimbra 1679 Aug 4 10:46 commercial.key % ls -lt /opt/zimbra/conf/nginx.??? -rw-r----- 1 zimbra zimbra 7213 Aug 4 10:46 /opt/zimbra/conf/nginx.crt -rw-r----- 1 zimbra zimbra 1679 Aug 4 10:46 /opt/zimbra/conf/nginx.key % -l /opt/zimbra/conf/smtpd.??? -rw-r----- 1 zimbra zimbra 7213 Aug 4 10:46 /opt/zimbra/conf/smtpd.crt -rw-r----- 1 zimbra zimbra 1679 Aug 4 10:46 /opt/zimbra/conf/smtpd.key % ls -l /opt/zimbra/mailboxd/etc/keystore -rw-r----- 1 zimbra zimbra 4965 Aug 4 10:46 /opt/zimbra/mailboxd/etc/keystore % ls -l /opt/zimbra/ssl/zimbra/jetty.pkcs12 -rw-r----- 1 zimbra zimbra 6952 Aug 4 10:46 /opt/zimbra/ssl/zimbra/jetty.pkcs12
Bad Certificate Recovery
Should you receive an error with your new certificates because they were not validated correctly you can recover by re-issuing your certificate and then re-install to zimbra. Should zimbra not allow you to re-install the corrected certificates, issue a self signed as a quick workaround before proceeding to re-install your corrected letsencrypt certs. Ref: https://wiki.zimbra.com/wiki/Administration_Console_and_CLI_Certificate_Tools#Single-Node_Self-Signed_Certificate Ref: https://forums.zimbra.org/viewtopic.php?f=15&t=64882&p=285958&hilit=zmcertmgr+deploycrt#p285958
Confirm that your SSL certs are all valid and not-expired
% /opt/zimbra/bin/zmcertmgr viewdeployedcrt all - ldap: /opt/zimbra/conf/slapd.crt notBefore=Oct 27 18:10:32 2018 GMT notAfter=Jan 25 18:10:32 2019 GMT subject= /CN=mail.example.com issuer= /C=US/O=Let's Encrypt/CN=Let's Encrypt Authority X3 SubjectAltName=mail.example.com, mail.example.net, tmail.example.com - mailboxd: /opt/zimbra/mailboxd/etc/mailboxd.pem notBefore=Oct 27 18:10:32 2018 GMT notAfter=Jan 25 18:10:32 2019 GMT subject= /CN=mail.example.com issuer= /C=US/O=Let's Encrypt/CN=Let's Encrypt Authority X3 SubjectAltName=mail.example.com, mail.example.net, tmail.example.com - mta: /opt/zimbra/conf/smtpd.crt notBefore=Oct 27 18:10:32 2018 GMT notAfter=Jan 25 18:10:32 2019 GMT subject= /CN=mail.example.com issuer= /C=US/O=Let's Encrypt/CN=Let's Encrypt Authority X3 SubjectAltName=mail.example.com, mail.example.net, tmail.example.com - proxy: /opt/zimbra/conf/nginx.crt notBefore=Oct 27 18:10:32 2018 GMT notAfter=Jan 25 18:10:32 2019 GMT subject= /CN=mail.example.com issuer= /C=US/O=Let's Encrypt/CN=Let's Encrypt Authority X3 SubjectAltName=mail.example.com, mail.example.net, tmail.example.com
Subcategories
This category has the following 2 subcategories, out of 2 total.
Pages in category "Community Sandbox"
The following 200 pages are in the current category.
(previous page) (next page)A
- Ab5602-Notes
- Accessing Zimbra Collaboration Server with iCal and Calendar
- Accessing Zimbra Collaboration Suite with Apple Mail
- Account mailbox database structure
- Accounts created Report
- Adding new dictionaries to aspell
- Adeelarifbhatti-Notes
- Advanced Hacking Articles
- AGibanelBtactic-Zimbra80X-Postscreen
- Ajcody-Backup-Restore-Issues
- Ajcody-Ciphers-Outlook
- Ajcody-Ciphers-Outlook-Troubleshooting
- Ajcody-Client-Topics
- Ajcody-Clustering
- Ajcody-Disk-Full-Issues
- Ajcody-General-Notes
- Ajcody-Going-From-A-Single-ZCS-Server-To-Multi-Server-Configuration
- Ajcody-Hardlinks-And-Postfix-default destination recipient limit
- Ajcody-Hostname-DNS
- Ajcody-How-To-Setup-sendAs-Right-And-Persona-For-Internal-Users
- Ajcody-How-To-Setup-sendAsDistList-Right-And-Persona-For-A-Distribution-List
- Ajcody-How-To-Setup-sendOnBehalfOf-Right-And-Persona-For-Internal-Users
- Ajcody-HSM-Notes
- Ajcody-Instant-Messaging-Topics
- Ajcody-LDAP-Topics
- Ajcody-Logger-Issues
- Ajcody-Logging
- Ajcody-Lucene-Topics
- Ajcody-MailingLists-And-Mailman
- Ajcody-Migration-Notes
- Ajcody-Mobile-Topics
- Ajcody-MTA-Postfix-Topics
- Ajcody-Multi-Server-Installation-Notes
- Ajcody-Mysql-Topics
- Ajcody-Notes
- Ajcody-Notes-Archive-Discovery
- Ajcody-Notes-Archive-Discovery-Mailstore-Setup
- Ajcody-Notes-HA-Linux-How-To
- Ajcody-Notes-No-Such-Blob
- Ajcody-Notes-Of-Customer-Cluster-Upgrade
- Ajcody-Notes-OS-Upgrade-And-ZCS-Options
- Ajcody-Notes-Server-Move
- Ajcody-Notes-ServerGAL
- Ajcody-Notes-ServerPlanning
- Ajcody-Notes-SSLCerts
- Ajcody-Notes-Upgrade-Options
- Ajcody-Proxy-Config-Txt
- Ajcody-Proxy-Guide-Rewrite-Project
- Ajcody-Proxy-Notes
- Ajcody-Proxy-SETUP.TXT
- Ajcody-Server-Issues-Being-Investigated
- Ajcody-Server-Misc-Topics
- Ajcody-Server-Move-VM-Different-Image-OS
- Ajcody-Server-Plan-Move-Migration-Upgrade-DR
- Ajcody-Server-Topics
- Ajcody-System-Documentation-For-Rights-Included-In-ZCS-Install
- Ajcody-Testing-Debugging
- Ajcody-User-Management-Topics
- Ajcody-Virtualization
- Ajcody-Virtualization-Named-DNS
- Ajcody-WebDAV
- Ajcody-ZCA Appliance
- Ajcody-Zimlet-Notes
- Alexkirsch-Notes
- Allow only few users to send mails
- Anti-spam Strategies
- Antivirus
- Ashbc-Notes
- Authentication/Horizon
- Authentication/OpenIDConsumer
- Autodiscover
B
- Backing up and restoring Zimbra (Open Source Version)
- Bacula pre/post cold backup scripts
- Basic Zimlet Definition Tags
- Block mailsby Subject
- Block user to send email locally or externally
- Blocking the Outlook Mobile App for iOS and Android
- Bmw-Notes
- Bobby-Notes
- Briefcase
- Building the software yourself
- Bulk Provisioning
C
- CalDav and SunBird
- Calendar and Contacts Migration
- CASifying Zimbra 6.0
- Cassifying Zimbra 5
- Centralized Logs - VMware Log Insight
- Certificate errors
- Certificate Management FAQ
- Change font color of unread message
- Changing Backup directory and General Information
- Changing the Page Title
- ClamAV - Updating Version
- ClamAV Scan MailboxStore
- Clamav unofficial sigs
- Clearing the "don't inherit grants from parent folder"(i) flag
- Cluster troubleshooting
- Commercial Certificates
- Configuration Management Articles
- Configuring GAL via SOAP
- Configuring maxmessagesize
- Configuring Postfix to work with piped scripts
- Configuring Zimbra Using Chef Oracle Cloud
- Configuring-Logger-Host
- Configuring-Proxy-Server+Change-Zimbra-Hostname
- Connecting with SQLGrey
- Convertd Errors
- Convertd File Formats
- Copying distribution lists
- Crash Recover Specific Table
- Crayz9000-Notes
- Creating a Core Dump from a Running Process using WinDbg
- Creating Themes Long Version
- Customizing Themes and Adding Zimbra Powered Logo - Open Source Edition
D
E
- Email redirection
- Email Rules Migration
- EnableSharingAddin
- Enabling and administering the Zimbra milter
- Enabling Core Files
- Enabling Samesite Cookie
- Enforcing a match between the FROM address and the sasl username
- Errors Importing Appointments using Migration Wizard for Exchange
- Events
- Exchange 2013 Free/Busy Interop
- Extend MTA Queue Lifetime
- Extending Admin UI
F
G
H
- Hard links
- Harley77-Mysqld
- Harley77-Notes
- Historical CalDAV Support
- Hocky-Notes
- Hosting other sites with Zimbra
- Hosting static files on Zimbra Proxy
- HOT Backup and HOT Restore
- HOT Backup with rdiff-backup
- How to "fix" system's sendmail to use that of zimbra
- How to add X-Envelope-To header
- How to configure auto-provisioning with dynamic DL
- How To Create an Admin Account
- How To Create an User Account
- How to enable ldaps
- How To Link Remote iCal Calendar
- How to merge two independent ZCS servers into one
- How to move mail from one user's folder to another, or to send it for external delivery
- How to move ZCS to another server
- How to re-create self-signed certificate in a multiserver platform?
- How to re-create the Quarantine Account
- How-to for cbpolicyd
- HowZimletConfigWorks
- HSM
I
- IMAP and Outlook Spam training
- IMAP NIO
- Import and Export of Contacts
- Import Personal Distribution Lists from Outlook
- Importing LDAP data from master to replica 6.0
- Importing LDAP data from provider to replica
- Improving Anti-spam system
- Individual Mailbox Restore from Snapshot
- Inotabi-Notes
- Install Zimbra Collaboration and a DNS Server with Script
- Install Zimbra in Cloud-DigitalOcean
- Installation Issues
- Installing a Gandi Commercial Certificate on ZCS
- Installing a GeoTrust Commercial Certificate
- Installing a GlobalSign Commercial Certificate
- Installing Certificates from the Master LDAP to a LDAP Replica
- Installing custom ldap schema
- Installing IRONMAIDEN 8.0.3 on FreeBSD 9.1 amd64
- Installing Zimbra 4.5.x on Ubuntu 7.04 & 7.10 (Feisty Fawn & Gutsy Gibbon)
- Installing Zimbra Desktop on 64bit Linux
- Installing Zimbra Using Chef
- Integrating PWM password manager with Zimbra
- IntelliJ for Ajax
- IntroToZimlets
- IP Address whitelisting
- Ip spam scanner
- Irfan-Notes