Apache Module mod_md

Available Languages: en | + fr

+ + + + +

Description:	Managing domains across virtual hosts, certificate provisioning + via the ACME protocol +
Status:	Experimental
Module Identifier:	md_module
Source File:	mod_md.c
Compatibility:	Available in version 2.4.30 and later

Summary

+ +

+ This module manages common properties of domains for one or more virtual hosts. + Its serves two main purposes: for one, supervise/renew TLS certificates via the + ACME protocol (RFC 8555). + Certificates will be renewed by the module ahead of their expiration to account + for disruption in internet services. There are ways to monitor the status of all + certififcates managed this way and configurations that will run your own + notification commands on renewal, expiration and errors. +

+ Second, mod_md offers an alternate OCSP Stapling implementation. This works with + managed certificates as well as with certificates you configure yourself. OCSP + Stapling is a necessary component for any https: site, influencing page load + times and, depending on other setups, page availability. More in the + stapling section below. +

+ The default ACME Authority for managing certificates is + Let's Encrypt, but it is possible + to configure another CA that supports the protocol. +

+ +

Simple configuration example:

+ +

TLS in a VirtualHost context

MDomain example.org
+
+<VirtualHost *:443>
+    ServerName example.org
+    DocumentRoot htdocs/a
+
+    SSLEngine on
+    # no certificates specification
+</VirtualHost>

+ +

+ This setup will, on server start, contact + Let's Encrypt + to request a certificate for the domain. If Let's Encrypt can verify the ownership + of the domain, the module will retrieve the certificate and its chain, store it + in the local file system (see MDStoreDir) + and provide it, on next restart, to mod_ssl. +

+ This happens while the server is already running. All other hosts will continue + to work as before. While a certificate is not available, requests for the managed + domain will be answered with a '503 Service Unavailable'. +

+ +

Prerequisites

+ This module requires mod_watchdog to be loaded as well. +

+ Certificate sign-up and renewal with Let's Encrypt requires your server to be + reachable on port 80 (http:) and/or port 443 (https:) from the public internet. + (Unless your server is configured to use DNS for challenges - more on that under + 'wildcard certificates') +

+ The module will select from the methods offered by Let's Encrypt. Usually LE offers + challenges on both ports and DNS and Apache chooses a method available. +

+ To determine which one is available, the module looks at the ports + Apache httpd listens on. If those include port 80, it assumes that the + http: challenge (named http-01) is available. If the server listens + on port 443, the https: challenge (named tls-alpn-01) is also added to + the list. (And if MDChallengeDns01 + is configured, the challenge dns-01 is added as well.) +

+ If your setup is not so straight forward, there are two methods available + to influence this. First, look at MDPortMap + if the server is behind a portmapper, such as a firewall. Second, you may + override the module's guesswork completely by configuring + MDCAChallenges directly. +

+ +

https: Challenges

+ For domain verification via the TLS protocol `tls-alpn-01` is the name + of the challenge type. It requires the Apache server to listen on port 443 + (see MDPortMap if you map that port + to something else). +

+ Let's Encrypt will open a TLS connection to Apache using the special indicator + `acme-tls/1` (this indication part of TLS is called ALPN, therefore the name + of the challenge. ALPN is also used by browsers to request a HTTP/2 connection). +

+ As with the HTTP/2 protocol, to allow this, you configure: +

Protocols h2 http/1.1 acme-tls/1

+ +

+ And the `tls-alpn-01` challenge type is available. +

+ +

Wildcard Certificates

+ Wildcard certificates are possible, but not straight-forward to use out of + the box. Let's Encrypt requires the `dns-01` challenge verification + for those. No other is considered good enough. +

+ The difficulty here is that Apache cannot do that on its own. As the name implies, `dns-01` + requires you to show some specific DNS records for your domain that contain + some challenge data. So you need to _write_ your domain's DNS records. +

+ If you know how to do that, you can integrated this with mod_md. Let's + say you have a script for that in `/usr/bin/acme-setup-dns` you configure + Apache with: +

MDChallengeDns01 /usr/bin/acme-setup-dns

+ +

+ and Apache will call this script when it needs to setup/teardown a DNS challenge + record for a domain. +

+ Assuming you want a certificate for `*.mydomain.com`, mod_md will call: +

/usr/bin/acme-setup-dns setup mydomain.com challenge-data
+# this needs to remove all existing DNS TXT records for 
+# _acme-challenge.mydomain.com and create a new one with 
+# content "challenge-data"

+ +

+ and afterwards it will call +

/usr/bin/acme-setup-dns teardown mydomain.com
+# this needs to remove all existing DNS TXT records for 
+# _acme-challenge.mydomain.com

+ +

Monitoring

+ Apache has a standard module for monitoring: mod_status. + mod_md contributes a section and makes monitoring your + domains easy. +

+ You see all your MDs listed alphabetically, the domain names they contain, + an overall status, expiration times and specific settings. The settings + show your selection of renewal times (or the default), the CA that is used, + etc. +

+ The 'Renewal' column will show activity and error descriptions for certificate + renewals. This should make life easier for people to find out if everything + is all right or what went wrong. +

+ If there is an error with an MD it will be shown here as well. This let's + you assess problems without digging through your server logs. +

+ There is also a new 'md-status' handler available to give you the MD information + from 'server-status' in JSON format. You configure it as +

<Location "/md-status">
+  SetHandler md-status
+</Location>

+ +

+ on your server. As with 'server-status' you will want to add + authorization for this. +

+ If you just want to check the JSON status of a specific domain, simply append + that to your status url: +

> curl https://<yourhost>/md-status/another-domain.org
+{
+  "name": "another-domain.org",
+  "domains": [
+    "another-domain.org",
+    "www.another-domain.org"
+  ],
+  ...

+ +

+ This JSON status also shows a log of activities when domains are renewed: +

{
+"when": "Wed, 19 Jun 2019 14:45:58 GMT",
+"type": "progress", "detail": "The certificate for the managed domain has been renewed successfully and can be used. A graceful server restart now is recommended."
+},{
+"when": "Wed, 19 Jun 2019 14:45:58 GMT",
+"type": "progress", "detail": "Retrieving certificate chain for test-901-003-1560955549.org"
+},{
+"when": "Wed, 19 Jun 2019 14:45:58 GMT",
+"type": "progress", "detail": "Waiting for finalized order to become valid"
+},{
+"when": "Wed, 19 Jun 2019 14:45:50 GMT",
+"type": "progress", "detail": "Submitting CSR to CA for test-901-003-1560955549.org"
+},
+...

+ +

+ You will also find this information in the file `job.json` in your staging and, + when activated, domains directory. This allows you to inspect these at + any later point in time as well. +

+ In addition, there is MDCertificateStatus which + gives access to relevant certificate information in JSON format. +

+ +

Stapling

+ If you want to try the stapling in one Managed Domain alone at first, + configure: +

<MDomain mydomain.net>
+  MDStapling on
+</MDomain>

+ +

+ and use the 'server-status' and/or MDMessageCmd to see how it operates. You will + see if Stapling information is there, how long it is valid, from where it came and + when it will be refreshed. +

+ If this all works to your satisfaction, you can switch it on for all your + certificates or just your managed ones. +

+ The existing stapling implementation by mod_ssl is used by many sites + for years. There are two main differences between the mod_ssl and mod_md + one: +

On demand vs. scheduled: mod_ssl retrieves the stapling information + when it is requested, e.g. on a new connection. mod_md retrieves it + right at server start and after 2/3rds of its lifetime.
In memory vs. persisted: mod_ssl can persist this + information, but most example configurations use a memory cache. mod_md + always stores in the file system.

+ If you are unlucky and restart your server during an outage of your CA's + OCSP service, your users may no longer reach your sites. Without persistence + your server cannot provide the client with the data and the client browser + cannot get it as well, since the OCSP service is not responding. +

+ The implementation in mod_md will have persisted it, load it again after + restart and have it available for incoming connections. A day or two before + this information expires, it will renew it, making it able to cope with + a long OCSP service downtime. +

+ Due to backward compatibility, the existing implementation in mod_ssl could + not be changed drastically. For example, mod_ssl is unable to add a dependency + to mod_watchdog without braking many existing installations (that do not load it). +

+ +

tailscale

+ Since version 2.4.14 of the module, you can use it to get certificates + for your tailscale domains. +

<MDomain mydomain.some-thing.ts.net>
+  MDCertificateProtocol tailscale
+  MDCertificateAuthority file://localhost/var/run/tailscale/tailscaled.sock",
+</MDomain>

+ +

+ Tailscale provides secure networking between your machines, where ever + they are, and can provide domain names in the *.ts.net space for them. + For those, it will then provide Let's Encrypt certificates as well, so + you can open these domains in your browser securely. +

+ The directives listed above tell Apache to contact the local tailscale + demon for obtaining and renewing certificates. This will only work for + the domain name that tailscale assigns to your machine. +

+ Otherwise, these certificates work exactly like the ones retrieved + via the ACME protocol from Lets Encrypt. You see them in status reporting + and MDMessageCmd directives are executed for them as well. +

+ More details are + available at the mod_md github documentation. +

+ Note that this feature only works on machines where the tailscale + demon provides a unix domain socket. This, so far, seems only the + case on *nix systems. +

+ +

Directives

+ +

Bugfix checklist

MDActivationDelay Directive

+ + + + + + + +

Description:
Syntax:	`MDActivationDelay duration`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ +

MDBaseServer Directive

+ + + + + + + +

Description:	Control if base server may be managed or only virtual hosts.
Syntax:	`MDBaseServer on\|off`
Default:	`MDBaseServer off`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Controls if the base server, the one outside all VirtualHosts should be managed by + mod_md or not. By default, it will not. For the very reason that + it may have confusing side-effects. It is recommended that you have virtual hosts + for all managed domains and do not rely on the global, fallback server configuration. +

+ +

MDCAChallenges Directive

+ + + + + + + +

Description:	Type of ACME challenge used to prove domain ownership.
Syntax:	`MDCAChallenges name [ name ... ]`
Default:	`MDCAChallenges tls-alpn-01 http-01 dns-01`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Sets challenge types (in order of preference) when proving domain ownership. + Supported by the module are the challenge methods 'tls-alpn-01', 'dns-01' + and 'http-01'. The module will look at the overall configuration of the server + to find out which methods can be used. +

+ If the server listens on port 80, for example, the 'http-01' method is available. + The prerequisite for 'dns-01' is a configured MDChallengeDns01 command. + 'tls-alpn-01' is described above in 'https: Challenges'. +

+ This auto selection works for most setups. But since Apache is a very powerful + server with many configuration options, the situation is not clear for all + possible cases. For example: it may listen on multiple IP addresses where some + are reachable on `https:` and some not. +

+ If you configure MDCAChallenges directly, this auto selection is disabled. + Instead, the module will use the configured challenge list when talking to + the ACME server (a challenge type must be offered by the server as well). + This challenges are examined in the order specified. +

+ +

MDCertificateAgreement Directive

+ + + + + + +

Description:	You confirm that you accepted the Terms of Service of the Certificate + Authority.
Syntax:	`MDCertificateAgreement accepted`
Context:	server config
Status:	Experimental
Module:	mod_md

When you use mod_md to obtain a certificate, you become a customer of the CA (e.g. Let's Encrypt). That means you need to read and agree to their Terms of Service, + so that you understand what they offer and what they might exclude or require from you. + mod_md cannot, by itself, agree to such a thing. +

+ +

MDCertificateAuthority Directive

+ + + + + + + +

Description:	The URL(s) of the ACME Certificate Authority to use.
Syntax:	`MDCertificateAuthority url`
Default:	`MDCertificateAuthority letsencrypt`
Context:	server config
Status:	Experimental
Module:	mod_md

+ The URL(s) where the CA offers its service. + Instead of the actual URL, you may use 'letsencrypt' or 'buypass'. +

+ If you configure more than one URL, each one is tried in a round-robin + fashion after a number of failures. You can configure how quickly or + delayed that happens via the MDRetryDelay and + MDRetryFailover directives. The default setting + makes a failover after about half a day of trying. +

+ All other settings apply to each of these URLs. It is therefore + not possible to have two with different + MDExternalAccountBindings, for example. +

+ For testing, CAs commonly offer a second service URL. + The 'test' service does not give certificates valid in a browser, + but are more relaxed in regard to rate limits. + This allows for verfication of your own setup before switching + to the production service URL. +

LE Test Setup

MDCertificateAuthority https://acme-staging-v02.api.letsencrypt.org/directory

+ +

MDCertificateCheck Directive

+ + + + + + + +

Description:
Syntax:	`MDCertificateCheck name url`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ +

MDCertificateFile Directive

+ + + + + + +

Description:	Specify a static certificate file for the MD.
Syntax:	`MDCertificateFile path-to-pem-file`
Context:	server config
Status:	Experimental
Module:	mod_md

+ This is used inside a MDomainSet and specifies + the file holding the certificate chain for the Managed Domain. The matching + key is specified via MDCertificateKeyFile. +

Example

<MDomain mydomain.com>
+  MDCertificateFile /etc/ssl/my.cert
+  MDCertificateKeyFile /etc/ssl/my.key
+</MDomain>

+ +

+ This is that equivalent of the mod_ssl + SSLCertificateFile directive. It + has several uses. +

+ If you want to migrate an existing domain, using static files, to + automated Let's Encrypt certificates, for one. You define the + MDomainSet, add the files here and remove + the SSLCertificateFile from + your VirtualHosts. +

+ This will give you the same as before, with maybe less repeating lines + in your configuration. Then you can add MDRenewMode + 'always' to it and the module will get a new certificate before + the one from the file expires. When it has done so, you remove the + MDCertificateFile and reload the server. +

+ Another use case is that you renew your Let's Encrypt certificates with + another ACME clients, for example the excellent + certbot. Then let your MDs point + to the files from certbot and have both working together. +

+ +

MDCertificateKeyFile Directive

+ + + + + + +

Description:	Specify a static private key for for the static cerrtificate.
Syntax:	`MDCertificateKeyFile path-to-file`
Context:	server config
Status:	Experimental
Module:	mod_md

+ This is used inside a MDomainSet and specifies + the file holding the private key for the Managed Domain. The matching + certificate is specified via MDCertificateFile. +

+ This is that equivalent of the mod_ssl + SSLCertificateKeyFile directive. +

+ +

MDCertificateMonitor Directive

+ + + + + + + +

Description:	The URL of a certificate log monitor.
Syntax:	`MDCertificateMonitor name url`
Default:	`MDCertificateMonitor crt.sh https://crt.sh?q=`
Context:	server config
Status:	Experimental
Module:	mod_md

+ This is part of the 'server-status' HTML user interface and has nothing to + do with the core functioning itself. It defines the link offered on that + page for easy checking of a certificate monitor. The SHA256 fingerprint + of the certificate is appended to the configured url. +

+ Certificate Monitors offer supervision of Certificate Transparency (CT) + Logs to track the use of certificates for domains. The least you may see + is that Let's Encrypt (or whichever CA you have configured) has entered + your certificates into the CTLogs. +

+ Caveat: certificate logs update and monitor's intakes of those + updates suffer some delay. This varies between logs and monitors. A + brand new certificate will not be known immediately. +

+ +

MDCertificateProtocol Directive

+ + + + + + + +

Description:	The protocol to use with the Certificate Authority.
Syntax:	`MDCertificateProtocol protocol`
Default:	`MDCertificateProtocol ACME`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Specifies the protocol to use. Currently, only ACME is supported. +

+ +

MDCertificateStatus Directive

+ + + + + + + +

Description:	Exposes public certificate information in JSON.
Syntax:	`MDCertificateStatus on\|off`
Default:	`MDCertificateStatus on`
Context:	server config
Status:	Experimental
Module:	mod_md

+ When enabled, a resources is available in Managed Domains at + 'https://domain/.httpd/certificate-status' that returns a JSON + document list key properties of the current and of a renewed + certificate - when available. +

Example

{
+  "valid-until": "Thu, 29 Aug 2019 16:06:35 GMT",
+  "valid-from": "Fri, 31 May 2019 16:06:35 GMT",
+  "serial": "03039C464D454EDE79FCD2CAE859F668F269",
+  "sha256-fingerprint": "1ff3bfd2c7c199489ed04df6e29a9b4ea6c015fe8a1b0ce3deb88afc751e352d"
+  "renewal" : { ...renewed cert information... }
+}

+ +

MDChallengeDns01 Directive

+ + + + + + +

Description:
Syntax:	`MDChallengeDns01 path-to-command`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Define a program to be called when the `dns-01` challenge needs to be setup/torn down. + The program is given the argument `setup` or `teardown` followed by the domain name. + For `setup` the challenge content is additionally given. +

+ You do not need to specify this, as long as a 'http:' or 'https:' challenge + method is possible. However, Let's Encrypt makes 'dns-01' the only + challenge available for wildcard certificates. If you require + one of those, you need to configure this. +

+ It is now possible to use this directive inside a MDomain + section to specify a specific command for that domain. This allows to configure + a script specific for the particular DNS provider involved. +

+ See the section about wildcard certificates above for more details. +

+ +

MDContactEmail Directive

+ + + + + + + +

Description:
Syntax:	`MDContactEmail address`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ The ACME protocol requires you to give a contact url when you sign up. Currently, + Let's Encrypt wants an email address (and it will use it to inform you about renewals + or changed terms of service). mod_md uses the MDContactEmail directive email in + your Apache configuration, so please specify the correct address there. + If MDContactEmail is not present, mod_md will use the + ServerAdmin directive. +

+ +

MDDriveMode Directive

+ + + + + + + +

Description:	former name of MDRenewMode.
Syntax:	`MDDriveMode always\|auto\|manual`
Default:	`MDDriveMode auto`
Context:	server config
Status:	Experimental
Module:	mod_md

This directive exists for backward compatibility as the old name for + MDRenewMode. +

+ +

MDExternalAccountBinding Directive

+ + + + + + + + +

Description:
Syntax:	`MDExternalAccountBinding key-id hmac-64 \| none \| file`
Default:	`MDExternalAccountBinding none`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.52 and later

+ Configure values for ACME "External Account Binding", a feature + of the ACME standard that allows clients to bind registrations + to an existing customer account on ACME servers. +

+ Let's Encrypt does not require those, but other ACME CAs do. + Check with your ACME CA if you need those and how to obtain the + values. They are two strings, a key identifier and a base64 encoded + 'hmac' value. +

+ You can configure those globally or for a specific MDomain. Since + these values allow anyone to register under the same account, it is + adivsable to give the configuration file restricted permissions, + e.g. root only. +

+ The value can also be taken from a JSON file, to keep more open + permissions on the server configuration and restrict the ones on that + file. The JSON itself is: +

EAB JSON Example file

{"kid": "kid-1", "hmac": "zWND..."}

+ If you change EAB values, the new ones will be used when the next + certificate renewal is due. +

+ +

MDHttpProxy Directive

+ + + + + + +

Description:	Define a proxy for outgoing connections.
Syntax:	`MDHttpProxy url`
Context:	server config
Status:	Experimental
Module:	mod_md

Use a http proxy to connect to the MDCertificateAuthority. Define this + if your webserver can only reach the internet with a forward proxy. +

+ +

MDMember Directive

+ + + + + + +

Description:	Additional hostname for the managed domain.
Syntax:	`MDMember hostname`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Instead of listing all dns names on the same line, you may use + MDMember to add such names + to a managed domain. +

Example

<MDomain example.org>
+    MDMember www.example.org
+    MDMember mail.example.org
+</MDomain>

+ If you use it in the global context, outside a specific MD, you can only + specify one value, 'auto' or 'manual' as the default for all other MDs. See + MDomain for a + description of these special values. +

+ +

MDMembers Directive

+ + + + + + + +

Description:	Control if the alias domain names are automatically added.
Syntax:	`MDMembers auto\|manual`
Default:	`MDMembers auto`
Context:	server config
Status:	Experimental
Module:	mod_md

Defines if the ServerName and + ServerAlias values of a VirtualHost + are automatically added to the members of a Managed Domain or not. +

+ +

MDMessageCmd Directive

+ + + + + + +

Description:	Handle events for Manage Domains
Syntax:	`MDMessageCmd path-to-cmd optional-args`
Context:	server config
Status:	Experimental
Module:	mod_md

+ This command gets called when one of the following events happen for + a Managed Domain: "renewed", "installed", "expiring", "errored". The command may + be invoked for more than these in the future and ignore events + it is not prepared to handle. +

+ This is the more flexible companion to MDNotifyCmd. +

Example

MDMessageCmd /etc/apache/md-message

+ +# will be invoked when a new certificate for mydomain.org is available as: +/etc/apache/md-message renewed mydomain.com +

+ The program should not block, as the module will wait for it to finish. A + return code other than 0 is regarded as an error. +

+ 'errored' is no immediate cause for concern since renewal is attempted + early enough to allow the internet to come back. This is reported at most + once per hour. +

+ 'expiring' should be taken serious. It is issued when the + MDWarnWindow is reached. By default this is + 10% of the certificate lifetime, so for Let's Encrypt this currently + means 9 days before it expires. The warning is repeated at most once + a day. +

+ 'renewed' means that a new certificate has been obtained and is stored + in the 'staging' area in the MD store. It will be activated on the next + server restart/reload. +

+ 'installed' is triggered when a new certificate has been transferred from + staging into the domains location in MD store. This happens at server + startup/reload. Different to all other invocations, MDMessageCmd is run + with root permissions (on *nix systems) and has access to the certificate + files (and keys). Certificates needed for other applications or + in different formats can be processed on this event. +

+ 'renewing' event is triggered before starting renew process for the managed + domain. Should the command return != 0 for this reason, renew will be + aborted and repeated on next cycle. Some cluster setups use this to + allow renewals to run only on a single node. +

+ 'challenge-setup:type:domain' event is triggered when the challenge data for a domain has + been created. This is invoked before the ACME server is told to check for it. + The type is one of the ACME challenge types. This is invoked for every + DNS name in a MDomain. Cluster setups may use this event to distribute + challenge files to all nodes in a cluster. +

+ ocsp-errored happens when MDStapling + is enabled for a domain, this indicates + that an error was encountered retrieving the OCSP response from the + Certificate Authority. mod_md will continue trying. +

+ +

MDMustStaple Directive

+ + + + + + + +

Description:	Control if new certificates carry the OCSP Must Staple flag.
Syntax:	`MDMustStaple on\|off`
Default:	`MDMustStaple off`
Context:	server config
Status:	Experimental
Module:	mod_md

Defines if newly requested certificate should have the OCSP Must Staple flag + set or not. If a certificate has this flag, the server is required to send a + OCSP stapling response to every client. This only works if you configure + mod_ssl to generate this (see SSLUseStapling + and friends). +

+ +

MDNotifyCmd Directive

+ + + + + + +

Description:	Run a program when a Managed Domain is ready.
Syntax:	`MDNotifyCmd path [ args ]`
Context:	server config
Status:	Experimental
Module:	mod_md

+ The configured executable is run when a Managed Domain has signed up or + renewed its certificate. It is given the name of the processed MD as + additional arguments (after the parameters specified here). It should + return status code 0 to indicate that it has run successfully. +

+ +

MDomain Directive

+ + + + + + +

Description:	Define list of domain names that belong to one group.
Syntax:	`MDomain dns-name [ other-dns-name... ] [auto\|manual]`
Context:	server config
Status:	Experimental
Module:	mod_md

+ All the names in the list are managed as one Managed Domain (MD). + mod_md will request one single certificate that is valid for all these names. This + directive uses the global settings (see other MD directives below). If you + need specific settings for one MD, use + the <MDomainSet>. +

+ There are 2 additional settings that are necessary for a Managed Domain: + a contact Email address (via MDContactEmail or ServerAdmin) + and MDCertificateAgreement. + The mail address of ServerAdmin + is used to register at the CA (Let's Encrypt by default). + The CA may use it to notify you about + changes in its service or status of your certificates. +

+ The second setting, MDCertificateAgreement, + should have the value "accepted". By specifying this, you confirm that your + accept the Terms of Service of the CA. +

Example

MDContactEmail admin@example.org
+MDCertificateAgreement accepted
+MDomain example.org www.example.org
+
+<VirtualHost *:443>
+    ServerName example.org
+    DocumentRoot htdocs/root
+
+    SSLEngine on
+</VirtualHost>
+
+<VirtualHost *:443>
+    ServerName www.example.org
+    DocumentRoot htdocs/www
+
+    SSLEngine on
+</VirtualHost>

+ There are two special names that you may use in this directive: 'manual' + and 'auto'. This determines if a Managed Domain shall have exactly the + name list as is configured ('manual') or offer more convenience. With 'auto' + all names of a virtual host are added to a MD. Conveniently, 'auto' is also + the default. +

Example

MDomain example.org
+
+<VirtualHost *:443>
+    ServerName example.org
+    ServerAlias www.example.org
+    DocumentRoot htdocs/root
+
+    SSLEngine on
+</VirtualHost>
+
+MDomain example2.org auto
+
+<VirtualHost *:443>
+    ServerName example2.org
+    ServerAlias www.example2.org
+    ...
+</VirtualHost>

+ In this example, the domain 'www.example.org' is automatically added to + the MD 'example.org'. Similarly for 'example2.org' where 'auto' is configured + explicitly. Whenever you add more ServerAlias names to this + virtual host, they will be added as well to the Managed Domain. +

+ If you prefer to explicitly declare all the domain names, use 'manual' mode. + An error will be logged if the names do not match with the expected ones. +

+ +

<MDomainSet> Directive

+ + + + + + +

Description:	Container for directives applied to the same managed domains.
Syntax:	`<MDomainSet dns-name [ other-dns-name... ]>...</MDomainSet>`
Context:	server config
Status:	Experimental
Module:	mod_md

+ This is the directive MDomain + with the added possibility to add setting just for this MD. In fact, + you may also use "<MDomain ..>" as a shortcut. +

+ This allows you to configure an MD that uses another Certificate Authority, + have other renewal requirements, etc. +

Example

<MDomain sandbox.example.org>
+    MDCertificateAuthority   https://someotherca.com/ACME
+</MDomain>

+ A common use case is to configure https: requirements separately for + your domains. +

Example

<MDomain example.org>
+    MDRequireHttps temporary
+</MDomain>

+ +

MDPortMap Directive

+ + + + + + + +

Description:	Map external to internal ports for domain ownership verification.
Syntax:	`MDPortMap map1 [ map2 ]`
Default:	`MDPortMap http:80 https:443`
Context:	server config
Status:	Experimental
Module:	mod_md

+ The ACME protocol provides two methods to verify domain ownership via + HTTP: one that uses 'http:' urls (port 80) and one for 'https:' urls + (port 443). If your server is not reachable by at least one + of the two, ACME may only work by configuring your DNS server, + see MDChallengeDns01. +

+ On most public facing servers, 'http:' arrives on port 80 and + 'https:' on port 443. The module checks the ports your Apache server + is listening on and assumes those are available. This means that + when your server does not listen on port 80, it assumes that + 'http:' requests from the internet will not work. +

+ This is a good guess, but it may be wrong. For example, your Apache + might listen to port 80, but your firewall might block it. 'http:' + is only available in your intranet. So, the module will falsely assume + that Let's Encrypt can use 'http:' challenges with your server. This + will then fail, because your firewall will drop those. +

Example

MDPortMap http:- https:8433

+ The above example shows how you can specify that 'http:' requests from + the internet will never arrive. In addition it says that 'https:' requests + will arrive on local port 8433. +

+ This is necessary if you have port forwarding in place, your server may be + reachable from the Internet on port 443, but the local port that httpd uses is + another one. Your server might only listen on ports 8443 and 8000, but be reached + on ports 443 and 80 (from the internet). +

+ +

MDPrivateKeys Directive

+ + + + + + + +

Description:	Set type and size of the private keys generated.
Syntax:	`MDPrivateKeys type [ params... ]`
Default:	`MDPrivateKeys RSA 2048`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Defines what kind of private keys are generated for a managed domain and with + what parameters. You can have more than one private key type configured and + the module will obtain a certificate for each key. +

+ For example, you may configure an RSA and an Elliptic Curve (EC) key, so + that 2 certificates are created for a domain. On a client connection, the first + one supported by the client will then be used. +

+ Since EC keys and certificates are smaller, you might want to offer + them first for all compatible (modern) clients. This can enable + faster handshakes. Add an RSA key type to support older clients. +

Example

MDPrivateKeys secp256r1 rsa3072

+ The EC types supported depend on the CA you use. For Let's encrypt + the supported curves include 'secp256r1' and 'secp384r1'. +

+ Each key and certificate type is stored in its own file in the + MD store. The key type is part of the file name with some backward + compatible naming for RSA certificates. So you may continue sharing + these files with other applications. +

+ Please note that this setting only has an effect on new keys. Any existing + private key you have remains unaffected. Also, this only affects private keys + generated for certificates. ACME account keys are unaffected by this. +

+ +

MDRenewMode Directive

+ + + + + + + +

Description:	Controls if certificates shall be renewed.
Syntax:	`MDRenewMode always\|auto\|manual`
Default:	`MDRenewMode auto`
Context:	server config
Status:	Experimental
Module:	mod_md

+ In the default 'auto' mode, the module will do what makes most sense + of each Managed Domain. For a domain without any certificates, it will + obtain them from the Certificate Authority. +

+ However, if you have defined an MD that is not used by any of Apache's + VirtualHosts, it will not bother. And for MDs with static certificate + files (see MDCertificateFile), + it assumes that you have your own source, and will not renew them either. +

+ You can override this default in either way. If you specify 'always', + the module will renew certificates for an MD, regardless if the + domains are in use or if there are static files. +

+ For the opposite effect, configure 'manual' and no renewal will + be attempted. +

+ +

MDRenewWindow Directive

+ + + + + + + +

Description:	Control when a certificate will be renewed.
Syntax:	`MDRenewWindow duration`
Default:	`MDRenewWindow 33%`
Context:	server config
Status:	Experimental
Module:	mod_md

+ If the validity of the certificate falls below duration, mod_md + will get a new signed certificate. +

+ Normally, certificates are valid for around 90 days and mod_md will renew + them the earliest 33% of their complete lifetime before they expire (so for + 90 days validity, 30 days before it expires). If you think this is not what + you need, you can specify either the exact time, as in: +

Example

# 21 days before expiry
+MDRenewWindow 21d 
+# 30 seconds (might be close)
+MDRenewWindow 30s
+# 10% of the cert lifetime
+MDRenewWindow 10%

When in auto drive mode, the module will check every 12 hours at least + what the status of the managed domains is and if it needs to do something. + On errors, for example when the CA is unreachable, it will initially retry + after some seconds. Should that continue to fail, it will back off to a + maximum interval of hourly checks. +

+ +

MDRequireHttps Directive

+ + + + + + + +

Description:	Redirects http: traffic to https: for Managed Domains.
Syntax:	`MDRequireHttps off\|temporary\|permanent`
Default:	`MDRequireHttps off`
Context:	server config
Status:	Experimental
Module:	mod_md

This is a convenience directive to ease http: to https: migration of + your Managed Domains. With: +

Example

MDRequireHttps temporary

you announce that you want all traffic via http: URLs to be redirected + to the https: ones, for now. This is safe and you can remove this again at + any time. +

+ The following has consequences: if you want client to no longer use the + http: URLs, configure: +

Permanent (for at least half a year!)

MDRequireHttps permanent

This does two things: +

All request to the http: resources are redirected to the + same url with the https: scheme using the 301 + status code. This tells clients that this is intended to be forever and + the should update any links they have accordingly. +
All answers to https: requests will carry the header + Strict-Transport-Security with a life time of half a year. + This tells the browser that it never (for half a year) shall use http: + when talking to this domain name. Browsers will, after having seen this, refuse + to contact your unencrypted site. This prevents malicious middleware to + downgrade connections and listen/manipulate the traffic. Which is good. But + you cannot simply take it back again. +

You can achieve the same with mod_alias and some + Redirect configuration, + basically. If you do it yourself, please make sure to exclude the paths + /.well-known/* from your redirection, otherwise mod_md + might have trouble signing on new certificates. +

If you set this globally, it applies to all managed domains. If you want + it for a specific domain only, use: +

Example

<MDomain xxx.yyy>
+  MDRequireHttps temporary
+</MDomain>

+ +

MDRetryDelay Directive

+ + + + + + + + +

Description:
Syntax:	`MDRetryDelay duration`
Default:	`MDRetryDelay 5s`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.54 and later

+ The amount of time to wait after an error before trying + to renew a certificate again. This duration is doubled after + each consecutive error with a maximum of 24 hours. +

+ It is kept separate for each certificate renewal. Meaning an error + on one MDomain does not delay the renewals of other domains. +

+ +

MDRetryFailover Directive

+ + + + + + + + +

Description:
Syntax:	`MDRetryFailover number`
Default:	`MDRetryFailover 13`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.54 and later

+ The number of consecutive errors on renewing a certificate before + another CA is selected. This only applies to configurations that + have more than one MDCertificateAuthority + specified. +

+ +

MDServerStatus Directive

+ + + + + + + +

Description:	Control if Managed Domain information is added to server-status.
Syntax:	`MDServerStatus on\|off`
Default:	`MDServerStatus on`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Apaches 'server-status' handler allows you configure a resource to monitor + what is going on. This includes now a section listing all Managed Domains + with the DNS names, renewal status, lifetimes and main properties. +

+ You can switch that off using this directive. +

+ +

MDStapleOthers Directive

+ + + + + + + + +

Description:	Enable stapling for certificates not managed by mod_md.
Syntax:	`MDStapleOthers on\|off`
Default:	`MDStapleOthers on`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ This setting only takes effect when MDStapling is enabled. It controls + if mod_md should also provide stapling information for certificates + that are not directly controlled by it, e.g. renewed via an ACME CA. +

+ +

MDStapling Directive

+ + + + + + + + +

Description:	Enable stapling for all or a particular MDomain.
Syntax:	`MDStapling on\|off`
Default:	`MDStapling off`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ mod_md offers an implementation for providing OCSP stapling information. + This is an alternative to the one provided by mod_ssl. For backward + compatibility, this is disabled by default. +

+ The stapling can be switched on for all certificates on the server or + for an individual MDomain. + This will replace any stapling configuration + in mod_ssl for these hosts. When disabled, the mod_ssl stapling + will do the work (if it is itself enabled, of course). This allows for + a gradual shift over from one implementation to the other. +

+ The stapling of mod_md will also work for domains where the certificates + are not managed by this module (see MDStapleOthers for how to control this). + This allows use of the new stapling without using any ACME certificate + management. +

+ +

MDStaplingKeepResponse Directive

+ + + + + + + + +

Description:	Controls when old responses should be removed.
Syntax:	`MDStaplingKeepResponse duration`
Default:	`MDStaplingKeepResponse 7d`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ This time window specifies when OCSP response data used in stapling + shall be removed from the store again. Response information older than + 7 days (default) is deleted on server restart/reload. This keeps the store + from growing when certificates are renewed/reconfigured frequently. +

+ +

MDStaplingRenewWindow Directive

+ + + + + + + + +

Description:	Control when the stapling responses will be renewed.
Syntax:	`MDStaplingRenewWindow duration`
Default:	`MDStaplingRenewWindow 33%`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.42 and later

+ If the validity of the OCSP response used in stapling falls below duration, + mod_md will obtain a new OCSP response. +

+ The CA issuing a certificate commonly also operates the OCSP responder + service and determines how long its signed response about the validity + of a certificate are itself valid. The longer a response is valid, the longer + it can be cached which mean better overall performance for everyone. + The shorter the life time, the more rapidly certificate revocations + spread to clients. Also, service reliability is a consideration. +

+ By adjusting the stapling renew window you can control parts of this yourself. + If you make the renew time short (e.g. a short time before the current + information expires), you gain maximum cache time. But a service outage + (down for maintenance, for example) will affect you. If you renew a long + time before expiry, updates will be made more frequent, cause more load + on the CA server infrastructure and also more coordination between + the child processes of your server. +

+ The default is chosen as 33%, which means renewal is started when only + a third of the response lifetime is left. For a CA that issues OCSP + responses with lifetime of 3 days, this means 2 days of caching and 1 day + for renewal attempts. A service outage would have to last full 24 hours + to affect your domains. +

+ Setting an absolute renew window, like `2d` (2 days), is also possible. +

+ +

MDStoreDir Directive

+ + + + + + + +

Description:	Path on the local file system to store the Managed Domains data.
Syntax:	`MDStoreDir path`
Default:	`MDStoreDir md`
Context:	server config
Status:	Experimental
Module:	mod_md

+ Defines where on the local file system the Managed Domain data is stored. This is + an absolute path or interpreted relative to the server root. The default will create + a directory 'md' in your server root. +

+ If you move this and have already data, be sure to move/copy the data first to + the new location, reconfigure and then restart the server. If you reconfigure + and restart first, the server will try to get new certificates that it thinks + are missing. +

+ +

MDStoreLocks Directive

+ + + + + + + + +

Description:
Syntax:	`MDStoreLocks on\|off\|duration`
Default:	`MDStoreLocks off`
Context:	server config
Status:	Experimental
Module:	mod_md
Compatibility:	Available in version 2.4.55 and later

+ Enable this to use a lock file on server startup when + MDStoreDir is synchronized with the server + configuration and renewed certificates are activated. +

+ Locking is intended for setups in a cluster that have a shared + file system for MDStoreDir. It will protect the activation of + renewed certificates when cluster nodes are restarted/reloaded + at the same time. Under the condition that the shared file + system does support file locking. +

+ The default duration to obtain the lock is 5 seconds. If the log + cannot be obtained, an error is logged and the server startup will + continue. This may result in a cluster node to still use the + previous certificate afterwards. +

+ A higher timeout will reduce that likelihood, but may delay server + startups/reloads in case the locks are not properly handled in + the underlying file system. A lock should only be held by a + httpd instance for a short duration. +

+ +

MDWarnWindow Directive

+ + + + + + + +

Description:	Define the time window when you want to be warned about an expiring certificate.
Syntax:	`MDWarnWindow duration`
Default:	`MDWarnWindow 10%`
Context:	server config
Status:	Experimental
Module:	mod_md

+ See MDRenewWindow for a description on + how you can specify the time. +

+ The modules checks the remaining lifetime of certificates and invokes + MDMessageCmd when there is less than the warn + window left. With the default, this mean 9 days for certificates from + Let's Encrypt. +

+ It also applies to Managed Domains with static certificate files ( + see MDCertificateFile). +

+ +

Apache Module mod_md

Summary

TLS in a VirtualHost context

Prerequisites

https: Challenges

Wildcard Certificates

Monitoring

Stapling

tailscale

Directives

Bugfix checklist

See also

LE Test Setup

Example

Example

EAB JSON Example file

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Permanent (for at least half a year!)

Example