aboutsummaryrefslogtreecommitdiff
path: root/acmeman
blob: 7956dd2cfd77e9a50bbb9c9e43961ac5211d71f1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
#!/bin/sh
#! -*-perl-*-
eval 'exec perl -x -wS $0 ${1+"$@"}'
    if 0;

use strict;
use warnings;
use App::Acmeman;

App::Acmeman->new->run;

=head1 NAME

acmeman - manages ACME certificates

=head1 SYNOPSIS

B<acmeman>
[B<-Fadns>]
[B<-D> I<N>]
[B<-f> I<FILE>]    
[B<--alt-names>]
[B<--config-file=>I<FILE>]
[B<--debug>]
[B<--dry-run>]
[B<--force>]
[B<--stage>]    
[B<--time-delta=>I<N>]
[I<DOMAIN>...]
    
B<acmeman> B<--setup> | B<-S>
[B<-Fdn>]
[B<--config-file=>I<FILE>]
[B<--debug>]
[B<--dry-run>]
[B<--force>]

B<acmeman>
[B<-h>]
[B<--help>]
[B<--usage>]
    
=head1 DESCRIPTION

A tool for automatic creation and renewal of ACME (LetsEncrypt) SSL
certificates. The list of domains to handle can be obtained from
B<acmeman> or B<apache> configuration files, or from both. If the
default B<acmeman> configuration file doesn't exist, the program
scans B<apache> configuration files for a list of domains.

B<Acmeman> is normally run periodically as a cronjob.
    
If you plan to serve SSL protected domains using apache, you can skip
right to the B<apache> section.

The following is a short introduction to the B<acmeman> configuration. For
a detailed discussion, see the B<CONFIGURATION> section below.

The configuration file, B</etc/acmeman.conf>, consists of statements,
which have the form B<I<KW>=I<VAL>>, grouped into sections, declared
as B<[I<NAME>]> (square brackets are part of the syntax). Empty lines
and comments (introduced by a hash sign) are ignored.

Domains which require LetsEncrypt certificates are declared in B<domain>
section. Each section introduces a single domain. E.g.:

    [domain example.com]
        alt = www.example.com
        files = default
    
This section instructs B<acmeman> that a certificate is needed for
domain B<example.com>, using B<www.example.com> as its alternative name,
The B<files> statement identifies the name of a B<files> section containing
rules for creating certificate files for that domain. This section must be
defined elsewhere in the configuration file. For example:

    [files default]
        type = split
        certificate-file = /etc/ssl/acme/$domain/cert.pem
        key-file = /etc/ssl/acme/$domain/privkey.pem
        ca-file = /etc/ssl/acme/$domain/ca.pem
        argument = $domain
    
This definition tells B<acmeman> that it should store certificate, certficate
key, and certificate authority chain in three separate files. Names of these
files will be created by replacing the B<$domain> string in the corresponding
definition with the domain name from the B<domain> section,

In fact, the B<files> section above is the default one. It will be created
implicitly if no other B<files> section is defined in the configuration file.
Moreover, the string B<default> is the default identifier, which is used if
the B<domain> section lacks the B<files> keyword.

The special section B<[core]> contains basic settings that control the
program behavior. One of the important settings is B<source>, which declares
an external source from which domain settings must be obtained. As
of B<acmeman> version 1.05, the following sources are available:
B<null>, B<apache>, and B<file>.
    
Consider the following configuration:

    [core]
        source = apache

It instructs B<acmeman> to read domain settings from Apache configuration
files. This is basically the configuration that is used in the absense of
the configuration file. See the B<APACHE> section for a detailed discussion
of this operation mode.    
    
=head1 CONFIGURATION

Configuration file controls the operation of B<acmeman>. By default,
its name is B</etc/acmeman.conf>. If it is absent, B<acmeman> falls
back to the legacy operation mode, scanning Apache configuration files
for domains that use LetsEncrypt SSL certificates. See the B<APACHE>
section below for a detailed description.    

The configuration file has a traditional line-oriented syntax. Comments
are introduced with a hash sign. Empty lines are ignored. Leading and
trailing whitespace is removed prior to parsing. Long statements can be
split over several physical lines by ending each line excepting the last
one with a backslash immediately followed by a newline character.
    
Statements have the following syntax:

    KEYWORD = VALUES

where I<KEYWORD> stands for a symbolic name consisting of alphanumeric
characters, dashes and underscores, and I<VALUE> stands for any sequence
of characters.

Statements are grouped in sections. Each section is identified by its name
and optional arguments. The section begins with the construct

    [NAME]

or, if arguments are present:
    
    [NAME ARG1 ARG2 ...]

The square brackets are part of the syntax.

The statements in the configuration file form a directed graph. Often
in this document we will identify the statement by its I<path>, i.e. a
list of section name, arguments and the keyword, separated by dots. For
example, the path B<files.apache.type> corresponds to the following
configuration file fragment:

    [files apache]
       type = single

The following describes the available sections and keywords

=head2 B<[core]>

This section defines the behavior of the program as a whole.

=over 4

=item B<rootdir=>I<DIR>

Defines the root directory to use instead of the default </var/www/acme>.
Root directory is the directory under which the
F<.well-known/acme-challenge> subdirectory is located.

=item B<time-delta=>I<SECONDS>
 
Sets the time window before the actual expiration time, when the certificate
becomes eligible for renewal.  I<N> is time in seconds.  The default
value is 86400, which means that B<acmeman> will attempt to renew any
certificate that expires within 24 hours.     

The command line option B<--time-delta> overrides this setting.

=item B<postrenew=>I<COMMAND>

Defines the command to be run at the end of the run if at least one
certificate has been updated. Normally this command reloads the httpd
server (or whatever server is using the certificates). If more than one
B<postrenew> statements are defined, they will be run in sequence, in the
same order as they appeared in the configuration file.

=item B<source=>I<ID> [I<ARG>...]

Defines additional source of information. B<App::Acmeman> version 1.05
is shipped with three sources: B<null>, B<apache>, and B<file>. 

The B<null> module is an empty source. Command line arguments are ignored.
Use this source if all domains are described in the configuration file.

The B<apache> source module is the default. It scans B<httpd> configuration
files as described in section B<apache>. One argument is allowed. If supplied,
it defines the apache configuration layout. Allowed values are: B<debian>,
B<slackware>, B<suse> and B<rh> (for Red Hat). Without arguments, the layout
will be autodetected.

The B<file> source reads domain names from one or more disk files. A
mandatory argument specifies the name of the directory where the files
are located. This mode is suitable for use with B<haproxy> pattern files.

Multiple B<source> statements can be defined. They will be processed
sequentially.    
    
=item B<files=>I<NAME>

Identifies the B<[files]> section which describes how to create certificate
files for domains which lack explicit B<files> keyword. Default I<NAME> is
B<default>. See the description of the B<files> statement in B<domain>
section.    

=item B<check-alt-names=>I<BOOL>

When set to B<true>, it instructs the program to compare the list of
alternative names of each certificate with the one gathered from the
Apache configuration, and reissue the certificate if the two lists
don't match.  This uses an ad-hoc logic, due to the deficiency of the
underlying X509 module, and therefore is not enabled by default.

Valid values for I<BOOL> are: B<1>, B<on>, B<true>, or B<yes>, for
true, and B<0>, B<off>, B<false>, or B<no> for false (all values
case-insensitive).    

=item B<check-dns=>I<BOOL>

When set to B<true> (the default), the program will check whether each
host name has an A DNS record pointing back to one of the IP addresses
of the server. Hostnames which don't satisfy this condition will be ignored.
The IP of the server is determined by looking up the A record for its
hostname. This can be overridden using the B<my-ip> configuration statement.
    
=item B<key-size=>I<N>

Size of the RSA key to use, in bits. Default is 4096.

=item B<my-ip>=I<IP> [I<IP>...]

Declares IP address (or addresses) of this server. Use this keyword if
the server IP cannot be reliably determined by resolving its hostname.
Special I<IP> B<$hostip> stands for the IP retreived by resolving the
hostname.
    
=back

=head2 B<[domain I<CN>]>

Declares the domain for which a certificate should be maintained. I<CN> is
the canonical name for the domain. Alternative names can be specified using
the B<alt> keyword.    
    
=over 4

=item B<files=>I<ID>

Identifies the B<[files]> section which describes how to create certificate
files for this domain. In the absense of this statement, the B<files>
statement from the B<[core]> section will be used.
    
=item B<alt=>I<NAME>

Defines alternative name for the certificate. Multiple B<alt> statements
are allowed.    

=item B<key-size=>I<N>

Size of the RSA key to use, in bits. If not set, the B<core.key-size>
setting is used.    

=item B<postrenew=>I<CMD>

Run I<CMD> after successful update. If not given, the B<core.postrenew>
commands will be run.    
    
=back
    
=head2 B<[files I<ID>]>

The B<files> section instructs B<acmeman> how to create certificate files.
It is applied to particular domains by placing the B<files=I<ID>> statement
in the coresponding domain sections.

The I<FILENAME> arguments to the keywords below can contain references to
a I<meta-variable>, which will be replaced by the actual domain name when
handling this section for a particular domain. By default, this meta-variable
is B<$domain>.     
    
=over 4
    
=item B<type=>B<single>|B<split>

Type of the certificate to create. When set to B<single>, a single
certificate file will be created. Its name is determined by the
B<certificate-file> statement. The file will contain the certificate,
certificate chain and the signature, in this order.

When set to B<split>, the certificate, certificate chain and the signature
will be saved to three distinct files, whose names are defined by
B<certificate-file>, B<ca-file>, and B<key-file>, correspondingly. If     
B<ca-file> is not defined, only certificate and key files will be created.

The default is B<split>.
    
=item B<certificate-file=>I<FILENAME>

Defines the name of the certificate file for this domain. This statement
is mandatory.    
    
=item B<key-file=>I<FILENAME>

Defines the name of the certificate key file. This statement must be present
if B<type> is set to B<split>.    
    
=item B<ca-file=>I<FILENAME>

Defines the name of the certificate authority file. This statement may
be present if B<type> is set to B<split>.    
    
=item B<argument=>I<STRING>

Defines the name of the meta-variable in I<FILENAME> arguments, which will
be replaced with the actual domain name. Default is B<$domain>.    
    
=back

=head1 SOURCES

=head2 null

    [core]
        source = null

Declares empty source. This means that B<acmeman> will handle only domain
names explicitly declared in the configuration file using the B<domain>
setting.
    
=head2 apache

    [core]
        source = apache [--server-root=DIR] [LAYOUT]
    
This is the default source. It assumes Apache httpd, version 2.4 or later
(although only minor changes are necessary to make it work with version 2.2).
The optional I<LAYOUT> argument defines the layout of the apache configuration
files. Allowed layout values are: B<debian>, B<slackware>, B<suse> and
B<rh> (for Red Hat). If not supplied, the layout is determined automatically.

Use the B<--server-root> option to supply the name of the server root
directory, if for some reason the module is unable to determine it
automatically.

A special directory should be configured for receiving ACME challenges. 

The package provides two Apache macros: for serving ACME challenges and
declaring SSL virtual hosts.    
    
Upon startup the program scans Apache configuration for virtual hosts
that use ACME certificates, checks their expiration times, and renews those
of the certificates that are nearing their expiration times within a
predefined number of seconds (24 hours by default).  If any of the
certificates were updated during the run, B<acmeman> will restart the
B<httpd> server.    

=head3 Setup    

To set up the necessary infrastructure, run B<acmeman --setup>.  It will
create the configuration file B<httpd-letsencrypt.conf>, defining two
macros for SSL-enabled sites (B<mod_macro> is needed).  Finally, it will
create the directory B</var/www/acme>, which will be used for receiving
and serving ACME challenges.  If another directory is preferred, it can
be specified as an argument to B<acmeman --setup>.

The tool will try to determine the layout of the Apache configuration
files and place the created file accordingly, so that it will be included
into the main configuration file.  It will print the name of the created
file at the end of the run.  You are advised to ensure that the file is
included and that the module B<mod_macro> is loaded prior to it.  You
may also wish to revise B<httpd-letsencrypt.conf> and edit the paths to
SSL files configured there.  By default, the directory F</etc/acme/I<DOMAIN>>
will be created for each domain name needing SSL, and two files will be placed
there: F<cert.pem>, containing the leaf and intermediate certificates for that
domain, and F<privkey.pem>, containing the private key for that domain.    

The program will refuse to overwrite existing files B<httpd-letsencrypt.conf>,
unless given the B<--force> (B<-F>) option.

=head3 Configuring SSL
    
To declare that a virtual host needs SSL certificate, add the following
line to the Apache B<VirtualHost> block serving plain HTTP for that host:

    Use LetsEncryptChallenge

This will instruct B<acmeman> to request a certificate for that virtual
host.  The hostname declared with the B<ServerName> statement will be used
as the B<CN> for the certificate, and any names declared via B<ServerAlias>
statements will form the list of alternative names (obviously, wildcards are
not allowed).

If such a certificate doesn't exist, it will be requested and created when
B<acmeman> is run.

To use the created certificate, create a new B<VirtualHost> block that
contains the following statement:    

    Use LetsEncryptServer DOMAIN

where I<DOMAIN> is the name used in the B<ServerName> statement of the plain
HTTP configuration.  Copy the B<ServerAlias> statements (if any), and add the
rest of configuration statements.  Note, that you need not use the
B<ServerName> statement, as it will be included when the B<LetsEncryptServer>
macro is expanded.

Example:

    <VirtualHost *:80>
        ServerName example.org
        ServerAlias www.example.com
        Use LetsEncryptChallenge
        ...
    </VirtualHost>

    <VirtualHost *:443>
        Use LetsEncryptServer example.org
        ServerAlias www.example.com
        ...
    </VirtualHost>

Alternatively, you can use the B<LetsEncryptSSL> macro, which differs from
B<LetsEncryptServer> in that it configures only SSL settings, without the
B<ServerName> statement, which therefore must be included explicitly:    
    
    <VirtualHost *:443>
        ServerName example.org
        ServerAlias www.example.com
        Use LetsEncryptSSL example.org
        ...
    </VirtualHost>

LetsEncrypt limits the number of certificates requested for a single
registered domain per week (at the time of this writing - 20).  To avoid
hitting that limit, you may wish to use the same certificate for different
virtual hosts.  The special macro B<LetsEncryptReference> is provided for
that purpose.  Suppose, for example, that you wish to configure server
name B<git.example.org> to use the same certificate as B<example.org>
(configured in the example above).  You then declare the virtual host
for the plain HTTP as follows:    

    <VirtualHost *:80>
        ServerName git.example.org
        Use LetsEncryptReference example.org
        ...
    </VirtualHost>

The argument to the B<LetsEncryptReference> macro indicates the CN name of
the certificate to which the current server name (and aliases, if any) are
to be added as alternative names.  The corresponding virtual host for SSL
will use the B<LetsEncryptSSL> macro to configure the correct certificate:    

    <VirtualHost *:80>
        ServerName git.example.org
        Use LetsEncryptSSL example.org
        ...
    </VirtualHost>

=head2 file

    [core]
        source = file PATTERN [--ignore=RX] [--host=HOST]

Domain names will be read from files matching I<PATTERN>. The argument
can be a single file or directory name, or a valid globbing pattern.
If I<PATTERN> is a directory name, the module will read all files from
that directory, except those matching the following perl regexp:
C<^\.|~$|\.bak$|^#.*#$>. The default regexp can be overridden using the
B<--ignore> (B<-i>) option. 

The input files must contain exactly one domain name per line. No empty
lines or comments are allowed. The first domain name will become the B<CN>
of the issued certificate. The rest of domain names will form alternative
names.

If the B<--host> (B<-h>) option is used, only one certificate will be
issued. The I<HOST> will be used as its B<CN>. All the domain names read
from the input files will form the list of its alternative names.    
    
=head1 OPTIONS

=over 4

=item B<-D>, B<--time-delta=>I<N>

Sets the time window before the actual expiration time, when the certificate
becomes eligible for renewal.  I<N> is time in seconds.  The default
value is 86400, which means that B<acmeman> will attempt to renew any
certificate that expires within 24 hours.     

This option overrides the B<core.time-delta> configuration setting.
    
=item B<-F>, B<--force>

Force renewal of certificates, no matter their expire date.  With B<--setup>,
force installing the B<httpd-letsencrypt.conf> file even if it already
exists.    

=item B<-a>, B<--alt-names>

Compare the list of alternative names of each certificate with the one
gathered from the Apache configuration, and reissue the certificate 
if the two lists don't match.  This uses an ad-hoc logic, due to the
deficiency of the underlying X509 module, and therefore is not enabled
by default.    

This option overrides the B<core.check-alt-names> configuration setting.
    
=item B<-d>, B<--debug>

Increase debugging level.  Multiple options accumulate.  Three debugging
levels are implemented:

=over 8

=item B<-d>

List certificates being renewed.
    
=item B<-dd>

List files being created.  Show basic information about ACME transactions for
each certificate.    

=item B<-ddd>

Verbosely report parsing of Apache configuration files.  Show detailed
debugging information about ACME transactions for each certificate.    
    
=back    
    
=item B<-f>, B<--config-file=>I<FILE>

Read configuration from I<FILE>, instead of the default F</etc/acmeman.conf>.
    
=item B<-n>, B<--dry-run>

Don't modify any files, just print what would have been done.
Implies B<--debug>. 

=item B<-S>, B<--setup>

Set up the B<acmeman> infrastructure files.
    
=item B<-s>, B<--stage>
    
Use LetsEncrypt staging server.
 
=back

The following options are informational:

=over 4

=item B<-h>

Prints a short usage summary.
    
=item B<--help>

Prints detailed user manual.    

=item B<--usage>

Outputs a terse reminder of the command line syntax along with a
list of available options.

=back    
    
=head1 AUTHOR

Sergey Poznyakoff <gray@gnu.org>    
    
=cut    




    

Return to:

Send suggestions and report system problems to the System administrator.