www/apache
1
0
Fork 0
mirror of https://github.com/apache/httpd.git synced 2025-10-27 09:35:38 +03:00
Code Activity
Files
dc30e34b3146fac78d75b080f55fae34d73a72b9
apache/docs/manual/mod/mod_md.xml

1001 lines
44 KiB
XML
Raw Blame History

<?xml version="1.0"?>
<!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
<?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
<!-- $LastChangedRevision$ -->
<!--
Licensed to the Apache Software Foundation (ASF) under one or more
contributor license agreements. See the NOTICE file distributed with
this work for additional information regarding copyright ownership.
The ASF licenses this file to You under the Apache License, Version 2.0
(the "License"); you may not use this file except in compliance with
the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<modulesynopsis metafile="mod_md.xml.meta">
<name>mod_md</name>
<description>Managing domains across virtual hosts, certificate provisioning
via the ACME protocol
</description>
<status>Experimental</status>
<sourcefile>mod_md.c</sourcefile>
<identifier>md_module</identifier>
<compatibility>Available in version 2.4.30 and later</compatibility>
<summary>
<p>
This module manages common properties of domains for one or more virtual hosts.
Its main feature is the use of the ACME protocol
(<a href="https://tools.ietf.org/html/rfc8555">RFC 8555</a>)
to automate certificate provisioning. 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 Managed Domains
and configurations that will run your own notification commands on renewal,
expiration and errors.
</p>
<p>
The default ACME Certificate Authority is
<a href="https://letsencrypt.org/">Let's Encrypt</a>, but it is possible
to configure another CA that supports the protocol.
</p>
<note type="warning"><title>Warning</title>
<p>This module is experimental. Its behaviors, directives, and
defaults are subject to more change from release to
release relative to other standard modules. Users are encouraged to
consult the "CHANGES" file for potential updates.</p>
</note>
<p>Simple configuration example:</p>
<note><title>TLS in a VirtualHost context</title>
<highlight language="config">
MDomain example.org
&lt;VirtualHost *:443&gt;
ServerName example.org
DocumentRoot htdocs/a
SSLEngine on
# no certificates specification
&lt;/VirtualHost&gt;
</highlight>
<p>
This setup will, on server start, contact
<a href="https://letsencrypt.org/">Let's Encrypt</a>
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 <directive module="mod_md">MDStoreDir</directive>)
and provide it, on next restart, to <module>mod_ssl</module>.
</p><p>
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'.
</p>
</note>
<note><title>Prerequisites</title>
<p>
This module requires <module>mod_watchdog</module> to be loaded as well.
</p><p>
Certificate sign-up and renewal with Let's Encrypt requires your server to be
reachable on port 80 (http:) from the outside. The alternative method over
port 443 (https:) is currently disabled for security reasons (status from
2018-01-14).
</p><p>
The module will select from the methods offered by Let's Encrypt. If LE decides
at one point in the future, to re-enable it again, mod_md will
use it when suitable.
</p><p>
But for now, only the port 80 variant is available (termed "http-01"). Only
when LE can reach your server on port 80 will mod_md work for
you. For now, at least.
</p><p>
If you do not want to offer any sites on port 80 any more, you may leave it open
and redirect all requests to your https: sites instead. Use the
<directive module="mod_md">MDRequireHttps</directive> described below to do
that in a convenient fashion. This will continue to answer http: challenges
from Let's Encrypt.
</p>
</note>
<note><title>Wildcard Certificates</title>
<p>
Wildcard certificates are possible with version 2.x of `mod_md``. But they are
not straight-forward. Let's Encrypt requires the `dns-01` challenge verification
for those. No other is considered good enough.
</p><p>
The difficulty here is that Apache cannot do that on its own. (which is also
a security benefit, since corrupting a web server or the communication path to
it is the scenario `dns-01` protects against). 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.
</p><p>
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:
</p>
<highlight language="config">
MDChallengeDns01 /usr/bin/acme-setup-dns
</highlight>
<p>
and Apache will call this script when it needs to setup/teardown a DNS challenge
record for a domain.
</p><p>
Assuming you want a certificate for `*.mydomain.com`, mod_md will call:
</p>
<highlight language="config">
/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"
</highlight>
<p>
and afterwards it will call
</p>
<highlight language="config">
/usr/bin/acme-setup-dns teardown mydomain.com
# this needs to remove all existing DNS TXT records for
# _acme-challenge.mydomain.com
</highlight>
</note>
<note><title>Monitoring</title>
<p>
Apache has a standard module for monitoring: <module>mod_status</module>.
mod_md contributes a section and makes monitoring your
domains easy.
</p><p>
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.
</p><p>
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.
</p><p>
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.
</p><p>
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
</p>
<highlight language="config">
&lt;Location "/md-status">
SetHandler md-status
&lt;/Location>
</highlight>
<p>
on your server. As with 'server-status' you will want to add
authorization for this.
</p><p>
If you just want to check the JSON status of a specific domain, simply append
that to your status url:
</p>
<highlight language="config">
> curl https://&lt;yourhost>/md-status/another-domain.org
{
"name": "another-domain.org",
"domains": [
"another-domain.org",
"www.another-domain.org"
],
...
</highlight>
<p>
This JSON status also shows a log of activities when domains are renewed:
</p>
<highlight language="config">
{
"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"
},
...
</highlight>
<p>
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.
</p><p>
In addition, there is <directive module="mod_md">MDCertificateStatus</directive> which
gives access to relevant certificate information in JSON format.
</p>
</note>
</summary>
<directivesynopsis>
<name>MDomain</name>
<description>Define list of domain names that belong to one group.</description>
<syntax>MDomain <var>dns-name</var> [ <var>other-dns-name</var>... ] [auto|manual]</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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 <directive module="mod_md" type="section">MDomainSet</directive>.
</p><p>
There are 2 additional settings that are necessary for a Managed Domain:
<directive module="core">ServerAdmin</directive>
and <directive module="mod_md">MDCertificateAgreement</directive>.
The mail address of <directive module="core">ServerAdmin</directive>
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.
</p><p>
The second setting, <directive module="mod_md">MDCertificateAgreement</directive>,
should have the value "accepted". By specifying this, you confirm that your
accept the Terms of Service of the CA.
</p>
<example><title>Example</title>
<highlight language="config">
ServerAdmin mailto:admin@example.org
MDCertificateAgreement accepted
MDomain example.org www.example.org
&lt;VirtualHost *:443&gt;
ServerName example.org
DocumentRoot htdocs/root
SSLEngine on
&lt;/VirtualHost&gt;
&lt;VirtualHost *:443&gt;
ServerName www.example.org
DocumentRoot htdocs/www
SSLEngine on
&lt;/VirtualHost&gt;
</highlight>
</example>
<p>
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.
</p>
<example><title>Example</title>
<highlight language="config">
MDomain example.org
&lt;VirtualHost *:443&gt;
ServerName example.org
ServerAlias www.example.org
DocumentRoot htdocs/root
SSLEngine on
&lt;/VirtualHost&gt;
MDomain example2.org auto
&lt;VirtualHost *:443&gt;
ServerName example2.org
ServerAlias www.example2.org
...
&lt;/VirtualHost&gt;
</highlight>
</example>
<p>
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.
</p><p>
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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis type="section" idtype="section">
<name>MDomainSet</name>
<description>Container for directives applied to the same managed domains.</description>
<syntax>&lt;MDomainSet <var>dns-name</var> [ <var>other-dns-name</var>... ]&gt;...&lt;/MDomainSet&gt;</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
This is the directive <directive module="mod_md">MDomain</directive>
with the added possibility to add setting just for this MD. In fact,
you may also use "&lt;MDomain ..>" as a shortcut.
</p>
<p>
This allows you to configure an MD that uses another Certificate Authority,
have other renewal requirements, etc.
</p>
<example><title>Example</title>
<highlight language="config">
&lt;MDomain sandbox.example.org&gt;
MDCertificateAuthority https://someotherca.com/ACME
&lt;/MDomain&gt;
</highlight>
</example>
<p>
A common use case is to configure https: requirements separately for
your domains.
</p>
<example><title>Example</title>
<highlight language="config">
&lt;MDomain example.org&gt;
MDRequireHttps temporary
&lt;/MDomain&gt;
</highlight>
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCertificateAgreement</name>
<description>You confirm that you accepted the Terms of Service of the Certificate
Authority.</description>
<syntax>MDCertificateAgreement accepted</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCertificateAuthority</name>
<description>The URL of the ACME Certificate Authority service.</description>
<syntax>MDCertificateAuthority <var>url</var></syntax>
<default>MDCertificateAuthority https://acme-v02.api.letsencrypt.org/directory</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
The URL where the CA offers its service.
</p><p>
Let's Encrypt offers, right now, four such URLs. Two for
the own legacy version of the ACME protocol, commonly named ACMEv1.
And two for the RFC 8555 version, named ACMEv2.
</p><p>
Each version has 2 endpoints, as their is a production endpoint and a
"staging" endpoint for testing. The testing endpoint works the same, but will
not give you certificates recognized by browsers. However, it also has
very relaxed rate limits. This allows testing of the service repeatedly
without you blocking yourself.
</p>
<example><title>LE Staging Setup</title>
<highlight language="config">
MDCertificateAuthority https://acme-staging-v02.api.letsencrypt.org/directory
</highlight>
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCertificateProtocol</name>
<description>The protocol to use with the Certificate Authority.</description>
<syntax>MDCertificateProtocol <var>protocol</var></syntax>
<default>MDCertificateProtocol ACME</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
Specifies the protocol to use. Currently, only <code>ACME</code> is supported.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDDriveMode</name>
<description>former name of MDRenewMode.</description>
<syntax>MDDriveMode always|auto|manual</syntax>
<default>MDDriveMode auto</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>This directive exists for backward compatibility as the old name for
<directive module="mod_md">MDRenewMode</directive>.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDRenewMode</name>
<description>Controls if certificates shall be renewed.</description>
<syntax>MDRenewMode always|auto|manual</syntax>
<default>MDRenewMode auto</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p>
<p>
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 <directive module="mod_md">MDCertificateFile</directive>),
it assumes that you have your own source, and will not renew them either.
</p>
<p>
You can override this default in either way. If you specify 'always',
the module will renew certificates for an MD, irregardless if the
domains are in use or if there are static files.
</p>
<p>
For the opposite effect, configure 'manual' and no renewal will
be attempted.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDHttpProxy</name>
<description>Define a proxy for outgoing connections.</description>
<syntax>MDHttpProxy <var>url</var></syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>Use a http proxy to connect to the MDCertificateAuthority. Define this
if your webserver can only reach the internet with a forward proxy.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDMember</name>
<description>Additional hostname for the managed domain.</description>
<syntax>MDMember <var>hostname</var></syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
Instead of listing all dns names on the same line, you may use
<directive module="mod_md">MDMember</directive> to add such names
to a managed domain.
</p>
<example><title>Example</title>
<highlight language="config">
&lt;MDomain example.org&gt;
MDMember www.example.org
MDMember mail.example.org
&lt;/MDomain&gt;
</highlight>
</example>
<p>
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
<directive module="mod_md">MDomain</directive> for a
description of these special values.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDMembers</name>
<description>Control if the alias domain names are automatically added.</description>
<syntax>MDMembers auto|manual</syntax>
<default>MDMembers auto</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>Defines if the <directive module="core">ServerName</directive> and
<directive module="core">ServerAlias</directive> values of a VirtualHost
are automatically added to the members of a Managed Domain or not.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDMustStaple</name>
<description>Control if new certificates carry the OCSP Must Staple flag.</description>
<syntax>MDMustStaple on|off</syntax>
<default>MDMustStaple off</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>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
<module>mod_ssl</module> to generate this (see <directive module="mod_ssl">SSLUseStapling</directive>
and friends).
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDNotifyCmd</name>
<description>Run a program when a Managed Domain is ready.</description>
<syntax>MDNotifyCmd <var>path</var> [ <var>args</var> ]</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDPortMap</name>
<description>Map external to internal ports for domain ownership verification.</description>
<syntax>MDPortMap <var>map1</var> [ <var>map2</var> ]</syntax>
<default>MDPortMap http:80 https:443</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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 <directive module="mod_md">MDChallengeDns01</directive>.
</p><p>
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.
</p><p>
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.
</p>
<example><title>Example</title>
<highlight language="config">
MDPortMap http:- https:8433
</highlight>
</example>
<p>
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.
</p><p>
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).
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDPrivateKeys</name>
<description>Set type and size of the private keys generated.</description>
<syntax>MDPrivateKeys <var>type</var> [ <var>params</var>... ]</syntax>
<default>MDPrivateKeys RSA 2048</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
Defines what kind of private keys are generated for a managed domain and with
what parameters. The only supported type right now is 'RSA' and the only parameter
it takes is the number of bits used for the key.
</p><p>
The current (2017) recommendation is at least 2048 bits and a smaller number is
not accepted here. Higher numbers offer longer security, but are computationally more
expensive, e.g. increase the load on your server. That might or might not be an
issue for you.
</p><p>
Other key types will be defined in the future.
</p>
<example><title>Example</title>
<highlight language="config">
MDPrivateKeys RSA 3072
</highlight>
</example>
<p>
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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDRenewWindow</name>
<description>Control when a certificate will be renewed.</description>
<syntax>MDRenewWindow <var>duration</var></syntax>
<default>MDRenewWindow 33%</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
If the validity of the certificate falls below duration, mod_md
will get a new signed certificate.
</p><p>
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:
</p>
<example><title>Example</title>
<highlight language="config">
# 21 days before expiry
MDRenewWindow 21d
# 30 seconds (might be close)
MDRenewWindow 30s
# 10% of the cert lifetime
MDRenewWindow 10%
</highlight>
</example>
<p>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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDRequireHttps</name>
<description>Redirects http: traffic to https: for Managed Domains.</description>
<syntax>MDRequireHttps off|temporary|permanent</syntax>
<default>MDRequireHttps off</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>This is a convenience directive to ease http: to https: migration of
your Managed Domains. With:
</p>
<example><title>Example</title>
<highlight language="config">
MDRequireHttps temporary
</highlight>
</example>
<p>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.
</p><p>
<strong>The following has consequences: </strong>if you want client to <strong>no longer</strong> use the
http: URLs, configure:
</p>
<example><title>Permanent (for at least half a year!)</title>
<highlight language="config">
MDRequireHttps permanent
</highlight>
</example>
<p>This does two things:
</p>
<ol>
<li>All request to the <code>http:</code> resources are redirected to the
same url with the <code>https:</code> scheme using the <code>301</code>
status code. This tells clients that this is intended to be forever and
the should update any links they have accordingly.
</li>
<li>All answers to <code>https:</code> requests will carry the header
<code>Strict-Transport-Security</code> with a life time of half a year.
This tells the browser that it <strong>never</strong> (for half a year) shall use <code>http:</code>
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.
</li>
</ol>
<p>You can achieve the same with <module>mod_alias</module> and some
<directive module="mod_alias">Redirect</directive> 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.
</p>
<p>If you set this globally, it applies to all managed domains. If you want
it for a specific domain only, use:
</p>
<example><title>Example</title>
<highlight language="config">
&lt;MDomain xxx.yyy&gt;
MDRequireHttps temporary
&lt;/MDomain&gt;
</highlight>
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDStoreDir</name>
<description>Path on the local file system to store the Managed Domains data.</description>
<syntax>MDStoreDir path</syntax>
<default>MDStoreDir md</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p><p>
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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCAChallenges</name>
<description>Type of ACME challenge used to prove domain ownership.</description>
<syntax>MDCAChallenges <var>name</var> [ <var>name</var> ... ]</syntax>
<default>MDCAChallenges tls-alpn-01 http-01 dns-01</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
Sets challenge types and their execution order when proving domain ownership.
The names are protocol specific.
The current ACME protocol version implemented by Let's Encrypt defines three challenge
types that are supported by mod_md. By default, it will try
the one on port 443 when available.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDBaseServer</name>
<description>Control if base server may be managed or only virtual hosts.</description>
<syntax>MDBaseServer on|off</syntax>
<default>MDBaseServer off</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCertificateFile</name>
<description>Specify a static certificate file for the MD.</description>
<syntax>MDCertificateFile path-to-pem-file</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
This is used inside a <directive module="mod_md">MDomainSet</directive> and specifies
the file holding the certificate chain for the Managed Domain. The matching
key is specified via <directive module="mod_md">MDCertificateKeyFile</directive>.
</p>
<example><title>Example</title>
<highlight language="config">
&lt;MDomain mydomain.com>
MDCertificateFile /etc/ssl/my.cert
MDCertificateKeyFile /etc/ssl/my.key
&lt;/MDomain>
</highlight>
</example>
<p>
This is that equivalent of the mod_ssl
<directive module="mod_ssl">SSLCertificateFile</directive> directive. It
has several uses.
</p><p>
If you want to migrate an existing domain, using static files, to
automated Let's Encrypt certificates, for one. You define the
<directive module="mod_md">MDomainSet</directive>, add the files here and remove
the <directive module="mod_ssl">SSLCertificateFile</directive> from
your VirtualHosts.
</p><p>
This will give you the same as before, with maybe less repeating lines
in your configuration. Then you can add <directive module="mod_md">MDRenewMode</directive>
'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
<directive module="mod_md">MDCertificateFile</directive> and reload the server.
</p><p>
Another use case is that you renew your Let's Encrypt certificates with
another ACME clients, for example the excellent
<a href="https://certbot.eff.org">certbot</a>. Then let your MDs point
to the files from certbot and have both working together.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCertificateKeyFile</name>
<description>Specify a static private key for for the static cerrtificate.</description>
<syntax>MDCertificateKeyFile path-to-file</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
This is used inside a <directive module="mod_md">MDomainSet</directive> and specifies
the file holding the private key for the Managed Domain. The matching
certificate is specified via <directive module="mod_md">MDCertificateFile</directive>.
</p><p>
This is that equivalent of the mod_ssl
<directive module="mod_ssl">SSLCertificateKeyFile</directive> directive.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDCertificateStatus</name>
<description>Exposes public certificate information in JSON.</description>
<syntax>MDCertificateStatus on|off</syntax>
<default>MDCertificateStatus on</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p>
<example><title>Example</title>
<highlight language="config">
{
"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... }
}
</highlight>
</example>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDChallengeDns01</name>
<description></description>
<syntax>MDChallengeDns01 path-to-command</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p><p>
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.
</p><p>
See the section about wildcard certificates above for more details.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDMessageCmd</name>
<description>Handle events for Manage Domains</description>
<syntax>MDMessageCmd path-to-cmd optional-args</syntax>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
This command gets called when one of the following events happen for
a Managed Domain: "renewed", "expiring", "errored". The command may
be invoked for more than these in the future and ignore events
it is not prepared to handle.
</p><p>
This is the more flexible companion to <directive module="mod_md">MDNotifyCmd</directive>.
</p>
<example><title>Example</title>
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
<highlight language="config">
</highlight>
</example>
<p>
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.
</p><p>
'errored' is no immediate cause for concern since renewal is attempted
early enough to allow the internet to come back.
</p><p>
'expiring' should be taken serious. It is issued when the
<directive module="mod_md">MDWarnWindow</directive> 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.
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDWarnWindow</name>
<description>Define the time window when you want to be warned about an expiring certificate.</description>
<syntax>MDWarnWindow duration</syntax>
<default>MDWarnWindow 10%</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
See <directive module="mod_md">MDRenewWindow</directive> for a description on
how you can specify the time.
</p><p>
The modules checks the remaining lifetime of certificates and invokes
<directive module="mod_md">MDMessageCmd</directive> when there is less than the warn
window left. With the default, this mean 9 days for certificates from
Let's Encrypt.
</p><p>
It also applies to Managed Domains with static certificate files (
see <directive module="mod_md">MDCertificateFile</directive>).
</p>
</usage>
</directivesynopsis>
<directivesynopsis>
<name>MDServerStatus</name>
<description>Control if Managed Domain information is added to server-status.</description>
<syntax>MDServerStatus on|off</syntax>
<default>MDServerStatus on</default>
<contextlist>
<context>server config</context>
</contextlist>
<usage>
<p>
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.
</p><p>
You can switch that off using this directive.
</p>
</usage>
</directivesynopsis>
</modulesynopsis>
View Git Blame Copy Permalink