acme-mock

 1# acme-mock
 2
 3An [ACME][RFC 8555] server implementation performing no validations.
 4
 5## Motivation
 6
 7I make heavy use of ACME in [ansible][ansible homepage] playbooks.
 8Occasionally, I test these playbooks in virtual machines. Unfortunately,
 9these virtual machines are incapable of completing ACME challenges and
10therefore don't receive any certificates from configured ACME servers.
11Without these certificates many daemons will refuse to start causing
12failures of ansible tasks. For this reason, I implemented a simple ACME
13server which doesn't perform any validations and always signs the given
14certificate signing requests.
15
16## Status
17
18Horrible hack, didn't read the RFC and only implemented the parts needed
19to make [acme-tiny][acme-tiny github] work.
20
21## Usage
22
23This software has no external dependencies and can be installed using:
24
25	$ go get github.com/nmeum/acme-mock
26
27Since ACME requires HTTPS, a TLS certificate is needed. A bogus
28certificate can be generated with `openssl`:
29
30	$ yes "" | openssl req -x509 -nodes -newkey rsa:4096 \
31		-keyout key.pem -out cert.pem
32
33The generated TLS certificate and key need to be passed to `acme-mock`.
34Additionally, the certificate needs to be added to the certificate store
35of the virtual machine. Afterwards, the ACME client needs to be
36configured to use the `acme-mock` directory. The URL of the directory
37resource depends on the address parameter, it defaults to
38`https://localhost/directory`. The certificate, used for processing
39certificate signing requests, is generated on startup.
40
41### Certbot
42
43Certbot can be used against this ACME mock to retrieve mock certificates.
44
45```
46certbot certonly --standalone -d <your_domain> --server https://localhost/directory --register-unsafely-without-email
47```
48
49## License
50
51This program is free software: you can redistribute it and/or modify it
52under the terms of the GNU Affero General Public License as published by
53the Free Software Foundation, either version 3 of the License, or (at
54your option) any later version.
55
56This program is distributed in the hope that it will be useful, but
57WITHOUT ANY WARRANTY; without even the implied warranty of
58MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero
59General Public License for more details.
60
61You should have received a copy of the GNU Affero General Public License
62along with this program. If not, see <https://www.gnu.org/licenses/>.
63
64[RFC 8555]: https://tools.ietf.org/html/rfc8555
65[ansible homepage]: https://ansible.com/
66[acme-tiny github]: https://github.com/diafygi/acme-tiny