certificaat/docs/index.html at master · danielsz/certificaat · GitHub

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
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
<head>
<!-- 2023-09-28 Thu 08:43 -->
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Certificaat</title>
<meta name="author" content="Daniel Szmulewicz" />
<meta name="generator" content="Org Mode" />
<style>
  #content { max-width: 60em; margin: auto; }
  .title  { text-align: center;
             margin-bottom: .2em; }
  .subtitle { text-align: center;
              font-size: medium;
              font-weight: bold;
              margin-top:0; }
  .todo   { font-family: monospace; color: red; }
  .done   { font-family: monospace; color: green; }
  .priority { font-family: monospace; color: orange; }
  .tag    { background-color: #eee; font-family: monospace;
            padding: 2px; font-size: 80%; font-weight: normal; }
  .timestamp { color: #bebebe; }
  .timestamp-kwd { color: #5f9ea0; }
  .org-right  { margin-left: auto; margin-right: 0px;  text-align: right; }
  .org-left   { margin-left: 0px;  margin-right: auto; text-align: left; }
  .org-center { margin-left: auto; margin-right: auto; text-align: center; }
  .underline { text-decoration: underline; }
  #postamble p, #preamble p { font-size: 90%; margin: .2em; }
  p.verse { margin-left: 3%; }
  pre {
    border: 1px solid #e6e6e6;
    border-radius: 3px;
    background-color: #f2f2f2;
    padding: 8pt;
    font-family: monospace;
    overflow: auto;
    margin: 1.2em;
  }
  pre.src {
    position: relative;
    overflow: auto;
  }
  pre.src:before {
    display: none;
    position: absolute;
    top: -8px;
    right: 12px;
    padding: 3px;
    color: #555;
    background-color: #f2f2f299;
  }
  pre.src:hover:before { display: inline; margin-top: 14px;}
  /* Languages per Org manual */
  pre.src-asymptote:before { content: 'Asymptote'; }
  pre.src-awk:before { content: 'Awk'; }
  pre.src-authinfo::before { content: 'Authinfo'; }
  pre.src-C:before { content: 'C'; }
  /* pre.src-C++ doesn't work in CSS */
  pre.src-clojure:before { content: 'Clojure'; }
  pre.src-css:before { content: 'CSS'; }
  pre.src-D:before { content: 'D'; }
  pre.src-ditaa:before { content: 'ditaa'; }
  pre.src-dot:before { content: 'Graphviz'; }
  pre.src-calc:before { content: 'Emacs Calc'; }
  pre.src-emacs-lisp:before { content: 'Emacs Lisp'; }
  pre.src-fortran:before { content: 'Fortran'; }
  pre.src-gnuplot:before { content: 'gnuplot'; }
  pre.src-haskell:before { content: 'Haskell'; }
  pre.src-hledger:before { content: 'hledger'; }
  pre.src-java:before { content: 'Java'; }
  pre.src-js:before { content: 'Javascript'; }
  pre.src-latex:before { content: 'LaTeX'; }
  pre.src-ledger:before { content: 'Ledger'; }
  pre.src-lisp:before { content: 'Lisp'; }
  pre.src-lilypond:before { content: 'Lilypond'; }
  pre.src-lua:before { content: 'Lua'; }
  pre.src-matlab:before { content: 'MATLAB'; }
  pre.src-mscgen:before { content: 'Mscgen'; }
  pre.src-ocaml:before { content: 'Objective Caml'; }
  pre.src-octave:before { content: 'Octave'; }
  pre.src-org:before { content: 'Org mode'; }
  pre.src-oz:before { content: 'OZ'; }
  pre.src-plantuml:before { content: 'Plantuml'; }
  pre.src-processing:before { content: 'Processing.js'; }
  pre.src-python:before { content: 'Python'; }
  pre.src-R:before { content: 'R'; }
  pre.src-ruby:before { content: 'Ruby'; }
  pre.src-sass:before { content: 'Sass'; }
  pre.src-scheme:before { content: 'Scheme'; }
  pre.src-screen:before { content: 'Gnu Screen'; }
  pre.src-sed:before { content: 'Sed'; }
  pre.src-sh:before { content: 'shell'; }
  pre.src-sql:before { content: 'SQL'; }
  pre.src-sqlite:before { content: 'SQLite'; }
  /* additional languages in org.el's org-babel-load-languages alist */
  pre.src-forth:before { content: 'Forth'; }
  pre.src-io:before { content: 'IO'; }
  pre.src-J:before { content: 'J'; }
  pre.src-makefile:before { content: 'Makefile'; }
  pre.src-maxima:before { content: 'Maxima'; }
  pre.src-perl:before { content: 'Perl'; }
  pre.src-picolisp:before { content: 'Pico Lisp'; }
  pre.src-scala:before { content: 'Scala'; }
  pre.src-shell:before { content: 'Shell Script'; }
  pre.src-ebnf2ps:before { content: 'ebfn2ps'; }
  /* additional language identifiers per "defun org-babel-execute"
       in ob-*.el */
  pre.src-cpp:before  { content: 'C++'; }
  pre.src-abc:before  { content: 'ABC'; }
  pre.src-coq:before  { content: 'Coq'; }
  pre.src-groovy:before  { content: 'Groovy'; }
  /* additional language identifiers from org-babel-shell-names in
     ob-shell.el: ob-shell is the only babel language using a lambda to put
     the execution function name together. */
  pre.src-bash:before  { content: 'bash'; }
  pre.src-csh:before  { content: 'csh'; }
  pre.src-ash:before  { content: 'ash'; }
  pre.src-dash:before  { content: 'dash'; }
  pre.src-ksh:before  { content: 'ksh'; }
  pre.src-mksh:before  { content: 'mksh'; }
  pre.src-posh:before  { content: 'posh'; }
  /* Additional Emacs modes also supported by the LaTeX listings package */
  pre.src-ada:before { content: 'Ada'; }
  pre.src-asm:before { content: 'Assembler'; }
  pre.src-caml:before { content: 'Caml'; }
  pre.src-delphi:before { content: 'Delphi'; }
  pre.src-html:before { content: 'HTML'; }
  pre.src-idl:before { content: 'IDL'; }
  pre.src-mercury:before { content: 'Mercury'; }
  pre.src-metapost:before { content: 'MetaPost'; }
  pre.src-modula-2:before { content: 'Modula-2'; }
  pre.src-pascal:before { content: 'Pascal'; }
  pre.src-ps:before { content: 'PostScript'; }
  pre.src-prolog:before { content: 'Prolog'; }
  pre.src-simula:before { content: 'Simula'; }
  pre.src-tcl:before { content: 'tcl'; }
  pre.src-tex:before { content: 'TeX'; }
  pre.src-plain-tex:before { content: 'Plain TeX'; }
  pre.src-verilog:before { content: 'Verilog'; }
  pre.src-vhdl:before { content: 'VHDL'; }
  pre.src-xml:before { content: 'XML'; }
  pre.src-nxml:before { content: 'XML'; }
  /* add a generic configuration mode; LaTeX export needs an additional
     (add-to-list 'org-latex-listings-langs '(conf " ")) in .emacs */
  pre.src-conf:before { content: 'Configuration File'; }

  table { border-collapse:collapse; }
  caption.t-above { caption-side: top; }
  caption.t-bottom { caption-side: bottom; }
  td, th { vertical-align:top;  }
  th.org-right  { text-align: center;  }
  th.org-left   { text-align: center;   }
  th.org-center { text-align: center; }
  td.org-right  { text-align: right;  }
  td.org-left   { text-align: left;   }
  td.org-center { text-align: center; }
  dt { font-weight: bold; }
  .footpara { display: inline; }
  .footdef  { margin-bottom: 1em; }
  .figure { padding: 1em; }
  .figure p { text-align: center; }
  .equation-container {
    display: table;
    text-align: center;
    width: 100%;
  }
  .equation {
    vertical-align: middle;
  }
  .equation-label {
    display: table-cell;
    text-align: right;
    vertical-align: middle;
  }
  .inlinetask {
    padding: 10px;
    border: 2px solid gray;
    margin: 10px;
    background: #ffffcc;
  }
  #org-div-home-and-up
   { text-align: right; font-size: 70%; white-space: nowrap; }
  textarea { overflow-x: auto; }
  .linenr { font-size: smaller }
  .code-highlighted { background-color: #ffff00; }
  .org-info-js_info-navigation { border-style: none; }
  #org-info-js_console-label
    { font-size: 10px; font-weight: bold; white-space: nowrap; }
  .org-info-js_search-highlight
    { background-color: #ffff00; color: #000000; font-weight: bold; }
  .org-svg { }
</style>
<link rel="stylesheet" href="css/et-book.css" type="text/css" media="screen" />
<link href="https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,300i,400,600&display=swap" rel="stylesheet">
<link rel="stylesheet" href="css/main.css" type="text/css" media="screen" />
<link rel="stylesheet" href="css/post.css" type="text/css" media="screen" />
<script type="text/javascript" src="js/navigation.js"></script>
</head>
<body>
<div id="content" class="content">
<h1 class="title">Certificaat
<br />
<span class="subtitle">Yet another ACME client</span>
</h1>
<div id="table-of-contents" role="doc-toc">
<h2>Table of Contents</h2>
<div id="text-table-of-contents" role="doc-toc">
<ul>
<li><a href="#orgbac670e">Definition</a></li>
<li><a href="#orgedee975">Motivation</a></li>
<li><a href="#orgab911d5">Installation</a></li>
<li><a href="#orgc61eabb">Usage</a></li>
<li><a href="#org42542fd">Challenges</a></li>
<li><a href="#org4ae4df7">Wildcard domains</a></li>
<li><a href="#orgeb39226">Implementation</a></li>
<li><a href="#org5824de9">Contributions</a></li>
<li><a href="#org0351ba1">Credits</a></li>
<li><a href="#org212ab98">License</a></li>
</ul>
</div>
</div>

<div id="outline-container-orgbac670e" class="outline-2">
<h2 id="orgbac670e">Definition</h2>
<div class="outline-text-2" id="text-orgbac670e">
<p>
Certificaat is a general-purpose <a href="https://tools.ietf.org/html/draft-ietf-acme-acme-06">ACME</a> client, fully compatible with the <a href="https://letsencrypt.org/">Let’s Encrypt</a> certificate authority.
</p>
</div>
</div>
<div id="outline-container-orgedee975" class="outline-2">
<h2 id="orgedee975">Motivation</h2>
<div class="outline-text-2" id="text-orgedee975">
<p>
If <a href="https://certbot.eff.org/">certbot</a> does everything for everybody, Certificaat is narrower in scope, focusing on usability and automated renewals.
</p>

<p>
Certificaat is optimized for a specific workflow: retrieve a certificate for your domain, and subsequently set up a cron job and forget about it.
</p>
</div>
</div>

<div id="outline-container-orgab911d5" class="outline-2">
<h2 id="orgab911d5">Installation</h2>
<div class="outline-text-2" id="text-orgab911d5">
<p>
In your <code>deps.edn</code>, add an alias for <code>certificaat</code>.
</p>

<div class="org-src-container">
<pre class="src src-clojure"><span style="color: #008b8b;">:aliases</span> <span style="color: #707183;">{</span><span style="color: #008b8b;">:certificaat</span> <span style="color: #7388d6;">{</span><span style="color: #008b8b;">:extra-deps</span> <span style="color: #909183;">{</span><span style="color: #228b22;">org.danielsz</span>/certificaat <span style="color: #709870;">{</span><span style="color: #008b8b;">:</span><span style="color: #228b22;">mvn</span><span style="color: #000000; background-color: #ffffff;">/</span><span style="color: #008b8b;">version</span> <span style="color: #8b2252;">"2.1.8"</span><span style="color: #709870;">}</span><span style="color: #909183;">}</span>
                        <span style="color: #008b8b;">:extra-paths</span> <span style="color: #909183;">[</span><span style="color: #8b2252;">"resources"</span><span style="color: #909183;">]</span>
                        <span style="color: #008b8b;">:main-opts</span> <span style="color: #909183;">[</span><span style="color: #8b2252;">"-m"</span> <span style="color: #8b2252;">"certificaat.core"</span><span style="color: #909183;">]</span><span style="color: #7388d6;">}</span><span style="color: #707183;">}</span>
</pre>
</div>

<p>
You can now invoke it like this:
</p>

<div class="org-src-container">
<pre class="src src-sh">$ clj -M:certificaat
</pre>
</div>

<p>
It is recommended to create an executable file in your path for ease of use.
</p>

<div class="org-src-container">
<pre class="src src-sh">$ echo <span style="color: #8b2252;">'clj -M:certificaat  "$@"'</span> &gt; /usr/local/bin/certificaat
$ chmod u+x /usr/local/bin/certificaat
</pre>
</div>
</div>
</div>

<div id="outline-container-orgc61eabb" class="outline-2">
<h2 id="orgc61eabb">Usage</h2>
<div class="outline-text-2" id="text-orgc61eabb">
</div>
<div id="outline-container-org97952ac" class="outline-3">
<h3 id="org97952ac">Overview</h3>
<div class="outline-text-3" id="text-org97952ac">
<p>
To get a certificate for a domain, follow these steps:
</p>

<p>
a. Run <code>certificaat -m change.me run</code>
</p>

<p>
<code>certificaat</code> will display instructions pertaining to the challenge. This is the time to satisfy the requirements (for example, configuring DNS records or preparing your web server).
</p>

<p>
b. Review your settings in <code>config.edn</code>.
</p>

<p>
Make sure you can accept the challenge. With the <code>http01</code> challenge, you have the option to use the built-in server to respond to the requests, or you can instruct <code>certificaat</code> to put the authorization tokens in the right folder of your web server.
</p>

<p>
c. Run <code>certificaat -m change.me run</code>
</p>

<p>
When you are ready, simply repeat the operation and the challenges will be triggered and, if successfully completed, a certificate downloaded and saved to disk.
</p>

<p>
From then on, the certificate can be renewed in one pass with <code>certificaat -m change.me run</code>.
</p>
</div>
</div>

<div id="outline-container-org39153c0" class="outline-3">
<h3 id="org39153c0">Command line options</h3>
<div class="outline-text-3" id="text-org39153c0">
<div class="org-src-container">
<pre class="src src-shell">certificaat -m change.me run
</pre>
</div>

<p>
The <code>-m</code> option indicates the domain you want to authorize. It will feature in the Subject name of the final X.509 certificate.
</p>

<div class="org-src-container">
<pre class="src src-shell">certificaat -m change.me -n www.change.me run
</pre>
</div>

<p>
The <code>-n</code> option is for additional domain name you want to
authorize. It will feature in the Subject Alternative Name a(SAN) of
the certificate. Repeat this option for all required names. Caution:
there is a hard limit imposed by the CA.
</p>

<div class="org-src-container">
<pre class="src src-shell">certificaat -m example.com info
</pre>
</div>

<p>
Certificaat will display a summary of the certificate.
</p>

<p>
Specifying the <code>-v</code> option will enable verbose logging, useful in debugging operations.
</p>

<p>
Type <code>certificaat -h</code> to familiarize yourself with the input it expects.
</p>
</div>
</div>
<div id="outline-container-orgdad6799" class="outline-3">
<h3 id="orgdad6799">Configuration</h3>
<div class="outline-text-3" id="text-orgdad6799">
<p>
Certificaat is driven by its configuration files which are generated
with defaults that you can subsequently edit and customize.
</p>

<p>
Certificaat follows the <a href="https://specifications.freedesktop.org/basedir-spec/latest/">XDG Base Directory Specification</a>. The
configuration folder is determined by querying the value of
<code>XDG_CONFIG_HOME</code> in the environment, and if not set, will default to
<code>$HOME/.config/certificaat</code>.
</p>

<p>
Configuration files are in <a href="https://github.com/edn-format/edn">edn</a> format and can be edited in any text
editor.
</p>

<p>
The global configuration is stored in the root directory,
<code>$HOME/.config/certificaat/config.edn</code> and it looks like
this:
</p>

<div class="org-src-container">
<pre class="src src-clojure"><span style="color: #707183;">{</span><span style="color: #008b8b;">:key-size</span> 2048,
 <span style="color: #008b8b;">:key-type</span> <span style="color: #008b8b;">:rsa</span>,
 <span style="color: #008b8b;">:keypair-filename</span> <span style="color: #8b2252;">"account.key"</span><span style="color: #707183;">}</span>
</pre>
</div>

<p>
The local configuration file is stored in the per-domain directory,
<code>$HOME/.config/certificaat/change.me/config.edn</code> , and looks like
this:
</p>

<div class="org-src-container">
<pre class="src src-clojure"><span style="color: #707183;">{</span><span style="color: #008b8b;">:acme-uri</span> <span style="color: #8b2252;">"acme://letsencrypt.org/staging"</span>,
 <span style="color: #008b8b;">:challenges</span> <span style="color: #8b2252;">"http-01"</span>,
 <span style="color: #008b8b;">:contact</span> <span style="color: #8b2252;">"mailto:admin@change.me"</span>,
 <span style="color: #008b8b;">:domain</span> <span style="color: #8b2252;">"change.me"</span>,
 <span style="color: #008b8b;">:organisation</span> <span style="color: #8b2252;">"ChangeMe corporation"</span>,
 <span style="color: #008b8b;">:san</span> #<span style="color: #7388d6;">{</span><span style="color: #8b2252;">"www.change.me"</span><span style="color: #7388d6;">}</span>
 <span style="color: #008b8b;">:plugins</span> <span style="color: #7388d6;">{</span><span style="color: #008b8b;">:diffie-hellman</span> <span style="color: #909183;">{</span><span style="color: #008b8b;">:enabled</span> <span style="color: #008b8b;">false</span>,
                            <span style="color: #008b8b;">:filename</span> <span style="color: #8b2252;">"dhparam.pem"</span>,
                            <span style="color: #008b8b;">:group14</span> <span style="color: #008b8b;">true</span>,
                            <span style="color: #008b8b;">:modulus</span> 2048<span style="color: #909183;">}</span>,
           <span style="color: #008b8b;">:copy-to-path</span> <span style="color: #909183;">{</span><span style="color: #008b8b;">:enabled</span> <span style="color: #008b8b;">true</span>
                          <span style="color: #008b8b;">:path</span> <span style="color: #8b2252;">"/tmp"</span><span style="color: #909183;">}</span>
           <span style="color: #008b8b;">:httpd</span> <span style="color: #909183;">{</span><span style="color: #008b8b;">:enabled</span> <span style="color: #008b8b;">true</span>
                   <span style="color: #008b8b;">:port</span> 3010<span style="color: #909183;">}</span>
           <span style="color: #008b8b;">:email</span> <span style="color: #909183;">{</span><span style="color: #008b8b;">:enabled</span> <span style="color: #008b8b;">false</span>,
                   <span style="color: #008b8b;">:sendmail</span> <span style="color: #008b8b;">false</span>,
                   <span style="color: #008b8b;">:smtp</span> <span style="color: #709870;">{</span><span style="color: #008b8b;">:host</span> <span style="color: #8b2252;">"smtp.changeme.org"</span>,
                          <span style="color: #008b8b;">:pass</span> <span style="color: #8b2252;">"changeme"</span>,
                          <span style="color: #008b8b;">:port</span> 587,
                          <span style="color: #008b8b;">:user</span> <span style="color: #8b2252;">"changeme"</span><span style="color: #709870;">}</span><span style="color: #909183;">}</span>,
           <span style="color: #008b8b;">:webroot</span> <span style="color: #909183;">{</span><span style="color: #008b8b;">:enabled</span> <span style="color: #008b8b;">false</span>, <span style="color: #008b8b;">:path</span> <span style="color: #8b2252;">"/var/www/"</span><span style="color: #909183;">}</span><span style="color: #7388d6;">}</span><span style="color: #707183;">}</span>
</pre>
</div>

<ul class="org-ul">
<li>the email address used by the CA to send expiry reminders.</li>
<li>the challenge you want to complete.</li>
<li>the URI to the ACME CA. By default, Certificaat will talk to Let’s Encrypt’s staging server. The resulting certificates will be fake. This is so you can practice until you are ready to issue a production certificate.</li>
</ul>

<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">


<colgroup>
<col  class="org-left" />

<col  class="org-left" />
</colgroup>
<tbody>
<tr>
<td class="org-left">Staging URI</td>
<td class="org-left">Production URI</td>
</tr>

<tr>
<td class="org-left">acme://letsencrypt.org/staging</td>
<td class="org-left">acme://letsencrypt.org</td>
</tr>
</tbody>
</table>
</div>
</div>

<div id="outline-container-org08820a7" class="outline-3">
<h3 id="org08820a7">Plugins</h3>
<div class="outline-text-3" id="text-org08820a7">
<p>
Plugins are provided to perform additional functionality at key moments, namely before the challenges get triggered, or after a certificate has been acquired or renewed. The plugins need to be configured and enabled.
</p>

<p>
The plugin configuration resides in the per-domain directory, <code>$HOME/.config/certificaat/change.me/config.edn</code>
</p>
</div>

<div id="outline-container-org707139d" class="outline-4">
<h4 id="org707139d">Copy to path</h4>
<div class="outline-text-4" id="text-org707139d">
<p>
This will copy the certificate to a folder of your liking. If disabled, the certificate will be found in <code>$HOME/.config/certificaat/change.me/</code>.
</p>
</div>
</div>
<div id="outline-container-org1be039c" class="outline-4">
<h4 id="org1be039c">Webroot</h4>
<div class="outline-text-4" id="text-org1be039c">
<p>
This plugin copies the authorization tokens to your web server www directory.
</p>
</div>
</div>
<div id="outline-container-org706db51" class="outline-4">
<h4 id="org706db51">Email</h4>
<div class="outline-text-4" id="text-org706db51">
<p>
An email will be sent to the contact registered with the certificate after creating or renewing a certificate.
</p>
</div>
</div>
<div id="outline-container-org19ad346" class="outline-4">
<h4 id="org19ad346">Diffie-Helman parameters</h4>
<div class="outline-text-4" id="text-org19ad346">
<p>
This will save a Diffie-Helman parameters file along with the certificate, for further tuning the SSL setup.
</p>
</div>
</div>
<div id="outline-container-org767c975" class="outline-4">
<h4 id="org767c975">httpd</h4>
<div class="outline-text-4" id="text-org767c975">
<p>
When enabled, the built-in server will respond to the challenges. Letsencrypt directs its request to port 80 exclusively. The built-in server runs on then non-privileged ports so you will need to tunnel the requests from port 80 to the built-in server's port. This is easily achieved with:
</p>

<div class="org-src-container">
<pre class="src src-shell">$ sudo socat tcp-listen:80,reuseaddr,fork tcp:localhost:3010
</pre>
</div>

<p>
<code>httpd</code> and <code>webroot</code> are the plugins that enable you to acquire the certificate in a single pass. Thus amenable to integrate an automated workflow like a cron job.
</p>

<div class="org-src-container">
<pre class="src src-shell">5 8 1 * * certificaat -m change.me run &amp;&amp; /usr/sbin/service nginx reload
</pre>
</div>
</div>
</div>
</div>
</div>

<div id="outline-container-org42542fd" class="outline-2">
<h2 id="org42542fd">Challenges</h2>
<div class="outline-text-2" id="text-org42542fd">
<p>
Certificaat will honor all challenges defined in the ACME specification.
</p>

<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">


<colgroup>
<col  class="org-left" />

<col  class="org-left" />

<col  class="org-left" />

<col  class="org-left" />
</colgroup>
<tbody>
<tr>
<td class="org-left">Challenge</td>
<td class="org-left">Option identifier</td>
<td class="org-left">Let’s Encrypt</td>
<td class="org-left">Certificaat</td>
</tr>

<tr>
<td class="org-left">HTTP</td>
<td class="org-left">http-01</td>
<td class="org-left">✓</td>
<td class="org-left">✓</td>
</tr>

<tr>
<td class="org-left">DNS</td>
<td class="org-left">dns-01</td>
<td class="org-left">✓</td>
<td class="org-left">✓</td>
</tr>

<tr>
<td class="org-left">ALPN</td>
<td class="org-left">tls-alpn-01</td>
<td class="org-left">✓</td>
<td class="org-left">✓</td>
</tr>
</tbody>
</table>
</div>
</div>

<div id="outline-container-org4ae4df7" class="outline-2">
<h2 id="org4ae4df7">Wildcard domains</h2>
<div class="outline-text-2" id="text-org4ae4df7">
<p>
Wildcard domains are supported with the "dns01" challenge only. (as per the protocol)
</p>
</div>
</div>
<div id="outline-container-orgeb39226" class="outline-2">
<h2 id="orgeb39226">Implementation</h2>
<div class="outline-text-2" id="text-orgeb39226">
<p>
Certificaat is based on the ACME protocol, API version 2.
</p>
</div>
</div>

<div id="outline-container-org5824de9" class="outline-2">
<h2 id="org5824de9">Contributions</h2>
<div class="outline-text-2" id="text-org5824de9">
<p>
If you plan to submit enhancements beyond bug fixes, please coordinate with me beforehand in order to save everybody’s time and effort.
</p>
</div>
</div>
<div id="outline-container-org0351ba1" class="outline-2">
<h2 id="org0351ba1">Credits</h2>
<div class="outline-text-2" id="text-org0351ba1">
<p>
I wish to thank <a href="https://shredzone.org/maven/acme4j/">Richard Körber</a> who wrote the Java client for the ACME protocol, <a href="https://github.com/shred/acme4j">acme4j</a>, which serves as a foundation for Certificaat. Not only is it well written, it is also exquisitely <a href="https://shredzone.org/maven/acme4j/">documented</a>.
</p>
</div>
</div>
<div id="outline-container-org212ab98" class="outline-2">
<h2 id="org212ab98">License</h2>
<div class="outline-text-2" id="text-org212ab98">
<p>
Licensing terms will be revealed shortly. In the meantime, do what you want with it.
</p>
</div>
</div>
</div>
<div id="postamble" class="status">
<p class="author">Author: Daniel Szmulewicz</p>
<p class="date">Created: 2023-09-28 Thu 08:43</p>
<p class="validation"><a href="https://validator.w3.org/check?uri=referer">Validate</a></p>
</div>
</body>
</html>