Certbot: Difference between revisions

Latest revision as of 05:53, 17 December 2024

Certbot

Image shows:	Certbot
Summary
Title:	Certbot
Description:	Certbot, from the Let's Encrypt project of the EFF, provides free and automated SSL certificates.
More
Notes:	For non-public sites, we can still generate certificates using DNS
Test:	Test on SSL Labs.com
Example:	See File:Certificate grade.png

Certbot is a tool that allows you to manage the Transport Layer Security (TLS) of your Webserver.

Let's Encrypt[edit | edit source]

We used to run certificates from StartSSL because they offer free one-year certificates. However, today we upgraded to using 'LetsEncrypt' and our certificates are both more secure and easier to manage. Instead of a "B" grade, we now have "A" grade security. ^[1]

Certbot (code) is a fully-featured, extensible client for the Let's Encrypt CA (or any other CA that speaks the ACME protocol) that can automate the tasks of obtaining certificates and configuring web servers to use them. This client runs on Unix-based operating systems. It requires root access to manage yourself - but is built-in to many service providers today as it has become an industry standard.

Until May 2016, Certbot was named simply letsencrypt or letsencrypt-auto, depending on install method. Instructions on the Internet, and some pieces of the software, may still refer to this older name.

Certbot website at EFF.org (the Electronic Frontier Foundation).

Automation[edit | edit source]

Ansible has a ACME certificate module in the crypto' collection (community not core). However, using it is a two-step process. We opted instead to create an integration into the Meza platform that takes care of both installation and renewal.

With HAProxy[edit | edit source]

Like Lighttpd, Pound, Ejabberd and other servers, HAProxy expects a single .pem file that has the combined contents of the fullchain.pem and privkey.pem.

Fortunately, certbot offers a --pre-hook, a --post-hook and a --renew-hook that we can use. The hooks allow to stop and later restart the 'normal' services and also concatenate the generated certificate files into a .pem file for HAProxy.

Do not use the plugin.

On Amazon[edit | edit source]

If you're one of the millions of Amazon Web Services customers, you may be tempted to use their lookalike service called AWS Certificate Manager.

Don't.

AWS certificates can't even be copied between regions. AWS certificates can't be used on your own servers. AWS certificates have annoying limits. They use email in whois to validate (not going to work if you have domain privacy turned on)!!! Amazon should have just joined the rest of the world in supporting LetsEncrypt. Fortunately, LetsEncrypt can be used everywhere, including AWS.

On Cloudflare[edit | edit source]

Cloudflare offers "Keyless SSL" and "Universal SSL". Although these are excellent signs that Cloudflare is doing good work, it remains true that origin traffic may not be encrypted at all leading to a huge trust problem.^[2]

The best way for Cloudflare customers to encrypt fully, is to use Certbot. Cloudflare support echoes word-for-word what Let's Encrypt says in their community forum: How to get a Let's Encrypt certificate while using CloudFlare

tldr; Use the --webroot-path option with the certonly --preferred-challenges="dns", but you'll need to manually intervene. Optionally, if you just turn off the proxying while you issue the certificate, you can use TLS-SNI and HTTP-01 challenges (and then turn proxying back on.) For more advanced usage, check out the docs where they describe pre and post validation hooks

With the pre-hook and post-hook options, you can script the conditions needed to authenticate and renew. certbot renew --pre-hook "service nginx stop" --post-hook "service nginx start"

The --renew-hook only runs when a certificate has been successfully renewed, so use this script to do things like concatenate the fullchain and

Resources[edit | edit source]

https://letsencrypt.org/getinvolved/ Get Involved with Lets Encrypt
1. https://letsencrypt.org/getting-started/ Getting Started
2. https://github.com/letsencrypt/letsencrypt Code on GitHub
3. https://letsencrypt.readthedocs.org/en/latest/ Docs
Apache docs
Ubuntu Server Guide - Certificates and Security
Ansible role for LetsEncrypt

FAQ[edit | edit source]

How do I obtain a new certificate?

setup the SSL virtual host in Apache, and be sure to include some SSLCertificateFile and SSLCertificateKeyFile directives using the "snake-oil" certs.
e.g.
SSLCertificateFile /etc/ssl/certs/ssl-cert-snakeoil.pem
SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key
Then run certbot
/opt/certbot/certbot --apache -d example.org,www.example.org,wiki.example.org --dry-run
/opt/certbot/certbot --apache -d example.org,www.example.org,wiki.example.org

What certs do I have?: sudo certbot certificates

How do I see more info about my certificates?

You can view the 'Security' pane in Chrome Developer Tools, but for quicker access from the command-line, use openssl

sudo openssl x509 -in /etc/haproxy/certs/demo.qualitybox.us.pem -text

Using keytool you can also quickly inspect the certificate of a host:

sudo keytool -printcert -sslserver equality-tech.com

How do I expand a cert to include some sub-domains?: Use the --expand option to put multiple domains in the same cert.; sudo /opt/certbot/certbot certonly --cert-name example.org --expand -d example.org,www.example.org,wiki.example.org,example.com,www.example.com,wiki.example.com

How do I create a wildcard certificate with LetsEncrypt?: See https://github.com/geerlingguy/ansible-role-certbot/pull/60#issuecomment-423919284

How do I cleanup my old/test certificates?: sudo /opt/certbot/certbot revoke --cert-path /etc/letsencrypt/live/baz.example.org/cert.pem; sudo /opt/certbot/certbot delete --cert-name baz.example.org

References[edit source]

[1] ttps://www.ssllabs.com/ssltest/analyze.html

[2] ttps://scotthelme.co.uk/cloudflares-great-new-features-and-why-i-wont-use-them/

[1]

[2]

@@ Line 2: / Line 2: @@
 |image=Electronic Frontier Foundation video conferencing background certbot-logo-1 (28343180089).png
 |imgdesc=Certbot
-|title=
 }}
 {{#set:feature title = {{PAGENAME}} }}
-{{#set:feature description = Certbot, from the Let's Encrypt project of the EFF, provides free and automated SSL certificates for QualityBox. }}
+{{#set:feature description = Certbot, from the Let's Encrypt project of the EFF, provides free and automated SSL certificates. }}
 {{#set:feature notes = For non-public sites, we can still generate certificates using DNS }}
 {{#set:feature tests =  [https://www.ssllabs.com/ssltest/analyze.html?d={{SERVERNAME}} Test on SSL Labs.com] }}
@@ Line 11: / Line 10: @@
 Certbot is a tool that allows you to manage the Transport Layer Security ([[TLS]]) of your Webserver.
+{{ambox|
+|type = content
+|text =
+I recently added Certbot automation to the freephile Meza fork ([https://github.com/freephile/meza/blob/qb/src/roles/ansible-role-certbot-meza/README.md README]), so you can have automatic TLS certificates with your [[MediaWiki]] platform.
+[[User:Admin|freephile]] ([[User talk:Admin|talk]]) 17:05, 16 December 2024 (EST)
+<br />
+}}
 == Let's Encrypt ==
 We used to run certificates from StartSSL because they offer free one-year certificates.  However, today we upgraded to using 'LetsEncrypt' and our certificates are both more secure and easier to manage.  Instead of a "B" grade, we now have "A" grade security. <ref>https://www.ssllabs.com/ssltest/analyze.html</ref>
-[[File:AGrade.png|left|500px]] [[File:BGrade.png|right|500px]]
+[[File:Certificate grade.png|left|500px]]
-'''Certbot''' ([https://github.com/certbot/certbot code]) is a fully-featured, extensible client for the Let's Encrypt CA (or any other CA that speaks the ACME protocol) that can automate the tasks of obtaining certificates and configuring web servers to use them. This client runs on Unix-based operating systems. It '''requires''' root access and is '''beta''' software.
+'''Certbot''' ([https://github.com/certbot/certbot code]) is a fully-featured, extensible client for the Let's Encrypt CA (or any other CA that speaks the ACME protocol) that can automate the tasks of obtaining certificates and configuring web servers to use them. This client runs on Unix-based operating systems. It '''requires''' root access to manage yourself - but is built-in to many service providers today as it has become an industry standard.
 Until May 2016, Certbot was named simply <code>letsencrypt</code> or <code>letsencrypt-auto</code>, depending on install method. Instructions on the Internet, and some pieces of the software, may still refer to this older name.
@@ Line 22: / Line 30: @@
 [https://certbot.eff.org/#pip-apache Certbot website] at EFF.org (the Electronic Frontier Foundation).
-== Service ==
+== Automation ==
-Using our [[Ansible]] role, we can install the certbot client.  Then we can install as many certificates as needed; plus setup an automated job which will renew them.
-Ansible has a [https://docs.ansible.com/ansible/latest/letsencrypt_module.html letsencrypt module] however, using it is a two-step process.  We opted instead to create a more robust Ansible playbook to install and automate certificates.
+Ansible has a [https://docs.ansible.com/ansible/latest/collections/community/crypto/acme_certificate_module.html ACME certificate module] in the '''crypto'''' collection (community not core). However, using it is a two-step process.  We opted instead to create an integration into the Meza platform that takes care of both installation and renewal.
-=== Current Setup for Meza ===
-<source lang="bash">
-cd ~/src/ansible-certbot
-# edit host file as needed, setup DNS as needed
-# check if the user you expect to use can SSH to the host
-ssh centos@demo.qualitybox.us
-# activate ansible
-source ~/bin/ansible/hacking/env-setup
-ansible --version
-# edit letsencrypt.yml as needed to identify the host for the play
-ansible-playbook -i hosts letsencrypt.yml
-# or if you need to use a different user for SSH
-ansible-playbook -i hosts letsencrypt.yml --user=root
-# if installing by package (default), then certbot is installed "normally". If by source, it's in /opt/certbot
-## on the target host
-# see if there are any certificates
-certbot certificates
-# stop HAProxy to make sure the host is accessible, but don't install into Apache, just use standalone
-systemctl stop haproxy
-certbot certonly --standalone -d demo.qualitybox.us
-# then run meza deploy to concatenate the cert files into a .pem file installed into HAproxy
-# or if you have to do it manually
-rm -f /etc/haproxy/certs/meza.key
-rm -f /etc/haproxy/certs/meza.crt
-DOMAIN='demo.qualitybox.us' sudo -E bash -c 'cat /etc/letsencrypt/live/$DOMAIN/fullchain.pem /etc/letsencrypt/live/$DOMAIN/privkey.pem > /etc/haproxy/certs/$DOMAIN.pem'
-# edit HAProxy to use the certificate
-vim /etc/haproxy/haproxy.cfg
-systemctl restart haproxy
-systemctl status haproxy
-# Now you should be able to access $DOMAIN with a green lock icon
-</source>
 == With HAProxy ==
@@ Line 64: / Line 40: @@
 Like [https://www.lighttpd.net/ Lighttpd], [http://www.apsis.ch/pound/ Pound], [https://www.ejabberd.im/ Ejabberd] and other servers, [[Load balancer|HAProxy]] expects a single <code>.pem</code> file that has the combined contents of the <code>fullchain.pem</code> and <code>privkey.pem</code>.
-Fortunately, certbot offers a --pre-hook, a --post-hook and a --renew-hook that we can use.
+Fortunately, certbot offers a --pre-hook, a --post-hook and a --renew-hook that we can use. The hooks allow to stop and later restart the 'normal' services and also concatenate the generated certificate files into a .pem file for HAProxy.
-There is even an experimental [https://github.com/greenhost/certbot-haproxy plugin] if you want to go that route, but it's not necessary.
-Although a cron like <code>certbot renew --quiet --no-self-upgrade</code> will work to renew certs, it's not going to install them. So, a better approach is to modify haproxy and also setup a renewal script.
-We have to modify the certbot configuration for (each) certificate. Notice how we specified the port at 54321, which we'll use in Haproxy:
-<code>cat /etc/letsencrypt/renewal/demo.qualitybox.us.conf</code>
-<pre>
-# renew_before_expiry = 30 days
-version = 0.25.1
-archive_dir = /etc/letsencrypt/archive/demo.qualitybox.us
-cert = /etc/letsencrypt/live/demo.qualitybox.us/cert.pem
-privkey = /etc/letsencrypt/live/demo.qualitybox.us/privkey.pem
-chain = /etc/letsencrypt/live/demo.qualitybox.us/chain.pem
-fullchain = /etc/letsencrypt/live/demo.qualitybox.us/fullchain.pem
-# Options used in the renewal process
-[renewalparams]
-account = f47c655802900ba026fb42e0bef8acd7
-http01_port = 54321
-authenticator = standalone
-installer = None
-pref_challs = http-01,
-</pre>
-Important parts of the Haproxy configuration. [https://www.digitalocean.com/community/tutorials/how-to-secure-haproxy-with-let-s-encrypt-on-centos-7 More detail]
-<pre>
-frontend www-https
-        bind *:443 ssl crt /etc/haproxy/certs
-        reqadd X-Forwarded-Proto:\ https
-        acl letsencrypt-acl path_beg /.well-known/acme-challenge/
-        use_backend letsencrypt-backend if letsencrypt-acl
-[snip]
+Do not use the [https://github.com/greenhost/certbot-haproxy plugin].
-backend letsencrypt-backend
-        server letsencrypt 127.0.0.1:54321
-</pre>
-<source lang="bash">
-#!/bin/sh
-# instead of manually creating a list like this
-# declare -a arr=("demo.qualitybox.us" "freephile.qualitybox.us")
-# loop through a dynamic list of directories in 'live'
-for SITE in $(ls -D /etc/letsencrypt/live)
-do
-        # move to correct let's encrypt directory
-        cd /etc/letsencrypt/live/$SITE
-#       echo -e "working in the /etc/letsencrypt/live/$SITE directory\n"
-        # cat files to make combined .pem for haproxy
-        cat fullchain.pem privkey.pem > /etc/haproxy/certs/$SITE.pem
-#       echo -e "created /etc/haproxy/certs/$SITE.pem\n"
-done
-# reload haproxy
-systemctl reload haproxy
-# echo -e "reloaded haproxy\n"
-</source>
- # use crontab -e as 'root' to setup cron to renew expiring certificates
-2 * * * /usr/bin/certbot renew --renew-hook "/root/bin/renew.sh" >> /var/log/certbot.log
 == On Amazon ==
@@ Line 161: / Line 76: @@
 == FAQ ==
 ; How do I obtain a new certificate?:
-:<ol><li>setup the SSL virtual host in Apache, and be sure to include some <code>SSLCertificateFile</code> and <code>SSLCertificateKeyFile</code> directives using the "snake-oil" certs.<br /> e.g. <br />               SSLCertificateFile      /etc/ssl/certs/ssl-cert-snakeoil.pem <br />               SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key<br /><li>Then run certbot<br />/opt/certbot/certbot-auto --apache -d example.org,www.example.org,wiki.example.org --dry-run<br />/opt/certbot/certbot-auto --apache -d example.org,www.example.org,wiki.example.org</ol>
+:<ol><li>setup the SSL virtual host in Apache, and be sure to include some <code>SSLCertificateFile</code> and <code>SSLCertificateKeyFile</code> directives using the "snake-oil" certs.<br /> e.g. <br />               SSLCertificateFile      /etc/ssl/certs/ssl-cert-snakeoil.pem <br />               SSLCertificateKeyFile /etc/ssl/private/ssl-cert-snakeoil.key<br /><li>Then run certbot<br />/opt/certbot/certbot --apache -d example.org,www.example.org,wiki.example.org --dry-run<br />/opt/certbot/certbot --apache -d example.org,www.example.org,wiki.example.org</ol>
 ; What certs do I have?:
-: sudo /opt/certbot/certbot-auto certificates
+: sudo certbot certificates
 ; How do I see more info about my certificates?
@@ Line 172: / Line 87: @@
 : <source lang="bash">sudo keytool -printcert -sslserver equality-tech.com</source>
-; How do I expand a cert to include some sub-domains? (wildcard certs are not supported):
+; How do I expand a cert to include some sub-domains?
-: sudo /opt/certbot/certbot-auto certonly --cert-name example.org --expand -d example.org,www.example.org,wiki.example.org,example.com,www.example.com,wiki.example.com
+: Use the <code>--expand</code> option to put multiple domains in the same cert.
+: sudo /opt/certbot/certbot certonly --cert-name example.org --expand -d example.org,www.example.org,wiki.example.org,example.com,www.example.com,wiki.example.com
+; How do I create a wildcard certificate with LetsEncrypt?
+: See https://github.com/geerlingguy/ansible-role-certbot/pull/60#issuecomment-423919284
 ; How do I cleanup my old/test certificates?:
-: sudo /opt/certbot/certbot-auto revoke --cert-path /etc/letsencrypt/live/baz.example.org/cert.pem
+: sudo /opt/certbot/certbot revoke --cert-path /etc/letsencrypt/live/baz.example.org/cert.pem
-: sudo /opt/certbot/certbot-auto delete --cert-name baz.example.org
+: sudo /opt/certbot/certbot delete --cert-name baz.example.org
 {{References}}