mirror of
https://github.com/NixOS/nixpkgs.git
synced 2024-11-22 05:31:22 +00:00
119 lines
3.6 KiB
XML
119 lines
3.6 KiB
XML
<chapter xmlns="http://docbook.org/ns/docbook"
|
|
xmlns:xlink="http://www.w3.org/1999/xlink"
|
|
xmlns:xi="http://www.w3.org/2001/XInclude"
|
|
version="5.0"
|
|
xml:id="module-security-acme">
|
|
|
|
<title>SSL/TLS Certificates with ACME</title>
|
|
|
|
<para>NixOS supports automatic domain validation & certificate
|
|
retrieval and renewal using the ACME protocol. This is currently only
|
|
implemented by and for Let's Encrypt. The alternative ACME client
|
|
<literal>simp_le</literal> is used under the hood.</para>
|
|
|
|
<section><title>Prerequisites</title>
|
|
|
|
<para>You need to have a running HTTP server for verification. The server must
|
|
have a webroot defined that can serve
|
|
<filename>.well-known/acme-challenge</filename>. This directory must be
|
|
writeable by the user that will run the ACME client.</para>
|
|
|
|
<para>For instance, this generic snippet could be used for Nginx:
|
|
|
|
<programlisting>
|
|
http {
|
|
server {
|
|
server_name _;
|
|
listen 80;
|
|
listen [::]:80;
|
|
|
|
location /.well-known/acme-challenge {
|
|
root /var/www/challenges;
|
|
}
|
|
|
|
location / {
|
|
return 301 https://$host$request_uri;
|
|
}
|
|
}
|
|
}
|
|
</programlisting>
|
|
</para>
|
|
|
|
</section>
|
|
|
|
<section><title>Configuring</title>
|
|
|
|
<para>To enable ACME certificate retrieval & renewal for a certificate for
|
|
<literal>foo.example.com</literal>, add the following in your
|
|
<filename>configuration.nix</filename>:
|
|
|
|
<programlisting>
|
|
security.acme.certs."foo.example.com" = {
|
|
webroot = "/var/www/challenges";
|
|
email = "foo@example.com";
|
|
};
|
|
</programlisting>
|
|
</para>
|
|
|
|
<para>The private key <filename>key.pem</filename> and certificate
|
|
<filename>fullchain.pem</filename> will be put into
|
|
<filename>/var/lib/acme/foo.example.com</filename>. The target directory can
|
|
be configured with the option <literal>security.acme.directory</literal>.
|
|
</para>
|
|
|
|
<para>Refer to <xref linkend="ch-options" /> for all available configuration
|
|
options for the <literal>security.acme</literal> module.</para>
|
|
|
|
</section>
|
|
|
|
<section><title>Using ACME certificates in Nginx</title>
|
|
<para>In practice ACME is mostly used for retrieval and renewal of
|
|
certificates that will be used in a webserver like Nginx. A configuration for
|
|
Nginx that uses the certificates from ACME for
|
|
<literal>foo.example.com</literal> will look similar to:
|
|
</para>
|
|
|
|
<programlisting>
|
|
security.acme.certs."foo.example.com" = {
|
|
webroot = config.security.acme.directory + "/acme-challenge";
|
|
email = "foo@example.com";
|
|
user = "nginx";
|
|
group = "nginx";
|
|
postRun = "systemctl restart nginx.service";
|
|
};
|
|
services.nginx.httpConfig = ''
|
|
server {
|
|
server_name foo.example.com;
|
|
listen 80;
|
|
listen [::]:80;
|
|
|
|
location /.well-known/acme-challenge {
|
|
root /var/www/challenges;
|
|
}
|
|
|
|
location / {
|
|
return 301 https://$host$request_uri;
|
|
}
|
|
}
|
|
|
|
server {
|
|
server_name foo.example.com;
|
|
listen 443 ssl;
|
|
ssl_certificate ${config.security.acme.directory}/foo.example.com/fullchain.pem;
|
|
ssl_certificate_key ${config.security.acme.directory}/foo.example.com/key.pem;
|
|
root /var/www/foo.example.com/;
|
|
}
|
|
'';
|
|
</programlisting>
|
|
|
|
<para>Now Nginx will try to use the certificates that will be retrieved by ACME.
|
|
ACME needs Nginx (or any other webserver) to function and Nginx needs
|
|
the certificates to actually start. For this reason the ACME module
|
|
automatically generates self-signed certificates that will be used by Nginx to
|
|
start. After that Nginx is used by ACME to retrieve the actual ACME
|
|
certificates. <literal>security.acme.preliminarySelfsigned</literal> can be
|
|
used to control whether to generate the self-signed certificates.
|
|
</para>
|
|
</section>
|
|
</chapter>
|