LetSyncrypt

LetSyncrypt is a Let's Encrypt client for Synchronet which uses the ACMEv2 protocol.

Let's Encrypt is an Internet Certificate Authority that issues free certificates that may be used with Synchronet TLS (e.g. HTTPS).

If you don't want to use the default generated and self-signed SSL/TLS certificate (ctrl/ssl.cert), use of this module is the solution.

LetSyncrypt should be added as a timed event.

Add the Timed Event in SCFG->External Programs->Timed Events:

Internal Code                   SYNCRYPT
Start-up Directory
Command Line                    ?letsyncrypt.js
Enabled                         Yes
Execution Node                  1
Execution Months                Any
Execution Days of Month         Any
Execution Days of Week          All
Execution Frequency             1 times a day
Requires Exclusive Execution    No
Force Users Off-line For Event  No
Native Executable               No
Use Shell to Execute            No
Background Execution            No
Always Run After Init/Re-init   Yes

LetSyncrypt is configured via the ctrl/letsyncrypt.ini file.

You must indicate that you agree to the Let's Encrypt Terms of Service by setting TOSAgreed = true in this file.

You can specify the ACMEv2 endpoint using the Host and Directory keys in the root section of this file. Host is the domain name of the ACMEv2 endpoint, and Directory is appended to it to generate the URL that is fetched for the Directory object.

Host = acme-v02.api.letsencrypt.org
Directory = /directory
TOSAgreed = true
GroupReadableKeyFile = false

Note that without setting TOSAgreed = true, you will likely never get a certificate, but the first few words in this file at present are “This Subscriber Agreement (“Agreement”) is a legally binding contract”.

Do not modify the [State] or [key_id] sections of this file.

If you have multiple domain names, you can have LetSyncrypt put them all in a single certificate, even if you have virtual hosts. Edit the ctrl/letsyncrypt.ini file and add a [Domains] section (if it doesn't already exist) and a key for each hostname with the value of the web root for that domain:

[Domains]
nix.synchro.net = /sbbs/web/root
home.bbsdev.net = /sbbs/web/root
gallery.bbsdev.net = /sbbs/web/root/gallery.bbsdev.net
pics.bbsdev.net = /sbbs/web/root/pics.bbsdev.net

This example has four domains (nix.synchro.net, home.bbsdev.net, gallery.bbsdev.net, and pics.bbsdev.net). The last two are virtual hosts, so have their web root as a subdirectory of the main web root.

You can also run the LetSyncrypt script using jsexec. It accepts a number of arguments:

--new-key Changes the account key

--force Forces a certificate renewal, ignoring the expiration date of the current certificate.

--revoke Revokes the current certificate, then obtains a new one.

--tos Prints the URL for the Terms of Service.

• Modules