Wildcard Certificates with acme.sh: Difference between revisions

From Run Your Own
Jump to navigation Jump to search
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<code>acme.sh</code> is a lightweight shell script based tool to handle Let's Encrypt certificates, etc.


== Using acme.sh ==
== Install the bash script ==
 
Since the certbot gandi dns plugin has been giving issues over the past months (no smooth renewal, leading to unavailability of sites) we started moving things to acme.sh. Seems to work better, easier to setup etc.
 
=== Install the bash script ===
 
  wget https://get.acme.sh  
  wget https://get.acme.sh  


Line 12: Line 8:
  sh acme.sh
  sh acme.sh


This will install the script to /root/ and add it to path  
This will install the script to <code>/root/.acme</code> and add it to path by sourcing a script from root's <code>.bashrc</code>


=== Request a wildcard cert for lurk.org ===
== Request a wildcard cert for lurk.org ==
We use wildcard certificates with DNS authentification, and we use the DNS server of our registrar, porkbun. It's not great (terrible UI for DNS editing), but it's cheap. Porkbun DNS support was added in recent versions of <code>acme.sh</code>. To make it work, we first need to find our Porkbun API keys and use them to set the following environment variables in root's <code>.bashrc</code>:


first find and export the gandi dns key:
export PORKBUN_API_KEY="..."
export PORKBUN_SECRET_API_KEY="..."


export GANDI_LIVEDNS_KEY="fdmlfsdklmfdkmqsdfk"
When ready and reloaded:


Then request a wildcard cert. (the dns key is added to a config file automatically for future renewals)
acme.sh --issue --dns dns_porkbun -d lurk.org -d *.lurk.org


acme.sh --issue --dns dns_gandi_livedns --nginx -d *.lurk.org
result:


Find the certs in:
* cert is in: <code>/root/.acme.sh/lurk.org_ecc/lurk.org.cer</code>
* cert key is in: <code>/root/.acme.sh/lurk.org_ecc/lurk.org.key</code>
* intermediate CA cert is in: <code>/root/.acme.sh/lurk.org_ecc/ca.cer</code>
* full-chain cert is in: <code>/root/.acme.sh/lurk.org_ecc/fullchain.cer</code>


/root/.acme.sh/\*.lurk.org/
== Install the certs for nginx ==
The following command will install the certs for nginx, assuming there is a <code>/etc/nginx/certs/</code> directory. Should be set and forget.
acme.sh --install-cert -d lurk.org -d *.lurk.org --key-file /etc/nginx/certs/key.pem --fullchain-file /etc/nginx/certs/cert.pem --reloadcmd "systemctl force-reload nginx"


== Migration status ==
== Deployment for other services ==
<code>acme.sh</code> can also support custom installs of the certificates. They call this deployment, and all the scripts provided by the project can be found in <code>/root/.acme.sh/deploy</code>.


Done:  
It's possible to make new deploy scripts quite easily, here is an example for <code>cooldaemon.sh</code>:
<pre>
# this makes accessible as variables all the necessary paths and files
cooldaemon_deploy() {
_cdomain="$1"
_ckey="$2"
_ccert="$3"
_cca="$4"
_cfullchain="$5"


* VMB (nginx, masto, icecast)
_debug _cdomain "$_cdomain"
_debug _ckey "$_ckey"
_debug _ccert "$_ccert"
_debug _cca "$_cca"
_debug _cfullchain "$_cfullchain"


To do:
# make a var for the target location
_ssl_path="/etc/cooldaemon/certs/"


* agnes (nginx, prosody, mm3)
# cooldaemon only needs the fullchain perm and the key so
* douglas (???)
# we only copy these
cp $_ckey $_ssl_path
cp $_cfullchain $_ssl_path


== Ref ==
# any extra commands can be added here for instance
# maybe cooldaemon is picky about cert ownership
chown -R cooldaemon:cooldaemon $_ssl_path


* https://forums.freebsd.org/threads/howto-ssl-tls-certificates-with-acme-sh.61231/ (FreeBSD)
# last but not least we reload cool daemon
# please note that some other daemons may need a restart instead
systemctl reload mumble-server


return 0
}
</pre>


= N.B. everything below is for archival reference =
To enable the deployment at every cert renewal:
 
  acme.sh --deploy -d lurk.org -d *.lurk.org --deploy-hook cooldaemon
 
 
== Base installation ==
 
  apt install python-pip
pip install wheel
pip install certbot
 
== DNS plugins ==
=== Gandi ===
'''NOTE: At time of writing, only an API key from the domain owner will work. So another account, even if listed technical contact, will not able to use the live DNS API, just the live DNS web interface. Since the writing of this HOWTO, there is now this as well https://github.com/obynio/certbot-plugin-gandi TODO'''


* Get API key from Gandi (somewhere in account settings)
* install certbot-plugin-gandi
pip install 'git+https://gitlab.com/cspublic/certbot-plugin-gandi.git'
mkdir /etc/certbot-plugin-gandi
* create /etc/certbot-plugin-gandi/gandi.ini with the following:
certbot_plugin_gandi:dns_api_key=APIKEY
* a bit of paranoia
chmod 600 /etc/certbot-plugin-gandi/gandi.ini
* request certificate for both mydomain.blabla '''and''' *.mydomain.blabla
'''NOTE: At time of writing, the default sever end point used by cerbot (0.22) is not compatible with ACME v2, as a workaround --server must be passed manually. Next version of certbot should point to the right server'''
/usr/local/bin/certbot certonly -a certbot-plugin-gandi:dns --certbot-plugin-gandi:dns-credentials /etc/certbot-plugin-gandi/gandi.ini -d mydomain.blabla -d *.mydomain.blabla --server https://acme-v02.api.letsencrypt.org/directory
* If all goes well certs will be there:
'''NOTE: At time of writing, certbot-plugin-gandi seems to behave a bit funnily when asked to request a challenge for a wildcard cert (it works flawslessly for regular domains). It might be needed to run the command several times to get the infamous CONGRATULATION message from certbot.'''
/etc/letsencrypt/live/mydomain.blabla/fullchain.pem
/etc/letsencrypt/live/mydomain.blabla/privkey.pem
== Renewal ==
To non-interactively renew *all* of your certificates:
/usr/local/bin/certbot renew
=== douglas ===
=== agnes ===
'''TODO: hooks!'''
<pre>
service nginx restart
prosodyctl reload
</pre>


[[Category:Certificates]]
[[Category:Certificates]]

Latest revision as of 23:06, 12 October 2024

acme.sh is a lightweight shell script based tool to handle Let's Encrypt certificates, etc.

Install the bash script

wget https://get.acme.sh

As root: 

sh acme.sh

This will install the script to /root/.acme and add it to path by sourcing a script from root's .bashrc

Request a wildcard cert for lurk.org

We use wildcard certificates with DNS authentification, and we use the DNS server of our registrar, porkbun. It's not great (terrible UI for DNS editing), but it's cheap. Porkbun DNS support was added in recent versions of acme.sh. To make it work, we first need to find our Porkbun API keys and use them to set the following environment variables in root's .bashrc: 

export PORKBUN_API_KEY="..."
export PORKBUN_SECRET_API_KEY="..."

When ready and reloaded: 

acme.sh --issue --dns dns_porkbun -d lurk.org -d *.lurk.org

result:

  • cert is in: /root/.acme.sh/lurk.org_ecc/lurk.org.cer
  • cert key is in: /root/.acme.sh/lurk.org_ecc/lurk.org.key
  • intermediate CA cert is in: /root/.acme.sh/lurk.org_ecc/ca.cer
  • full-chain cert is in: /root/.acme.sh/lurk.org_ecc/fullchain.cer

Install the certs for nginx

The following command will install the certs for nginx, assuming there is a /etc/nginx/certs/ directory. Should be set and forget. 

acme.sh --install-cert -d lurk.org -d *.lurk.org --key-file /etc/nginx/certs/key.pem --fullchain-file /etc/nginx/certs/cert.pem --reloadcmd "systemctl force-reload nginx"

Deployment for other services

acme.sh can also support custom installs of the certificates. They call this deployment, and all the scripts provided by the project can be found in /root/.acme.sh/deploy.

It's possible to make new deploy scripts quite easily, here is an example for cooldaemon.sh: 

# this makes accessible as variables all the necessary paths and files
cooldaemon_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"

# make a var for the target location
_ssl_path="/etc/cooldaemon/certs/"

# cooldaemon only needs the fullchain perm and the key so
# we only copy these
cp $_ckey $_ssl_path
cp $_cfullchain $_ssl_path

# any extra commands can be added here for instance
# maybe cooldaemon is picky about cert ownership
chown -R cooldaemon:cooldaemon $_ssl_path

# last but not least we reload cool daemon
# please note that some other daemons may need a restart instead
systemctl reload mumble-server

return 0
}

To enable the deployment at every cert renewal: 

acme.sh --deploy -d lurk.org -d *.lurk.org --deploy-hook cooldaemon
Retrieved from "https://things.bleu255.com/runyourown/index.php?title=Wildcard_Certificates_with_acme.sh&oldid=635"