All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Hat-tip.
- Support for Fedora (dnf package manager) when installing Certutils.
Once more, with documentation this time!
- Updated documentation to reflect how the module actually works now.
The hybrid approach.
Implements a hybrid approach to mkcert installation and certificate authority and certificate creation that combines the best parts of the methods used in 6.x and 7.x.
Specifically:
- mkcert is now installed at post-install (which removes the requirement for the graphical sudo prompt, which was using pkexec, which behaves differently to sudo and was creating the certificate material files with the wrong permissions on Linux).
- root certificate authority and TLS certificates are created as necessary at runtime (while this requires the person to enter their sudo password, the prompt is shown in the command-line as expected unlike the npm bug that was causing the prompt to be hidden when run in a lifecycle script).
Also, reduced unpacked size of the package from 83.2KB to 48.7KB by linking to the AGPL license instead of including the full text.
- Installation on macOS. This was failing because of differences in how the graphical sudo prompt affects file permissions between Linux and macOS.
- Re-implemented Windows support (tested/supported only on Windows 10, under Windows Terminal, with PowerShell).
- Screenshot of the graphical sudo prompt in 7.0.3 added to the readme.
- No longer fails on install on system accounts that don’t have passwordless sudo set up. Instead, shows a graphical password box to get the person’s sudo password. (Fixes https://source.small-tech.org/site.js/lib/auto-encrypt-localhost/-/issues/17. See npm/cli#2887 for the original npm bug.
- Removed old binary declaration from package file.
- Added missing bin folder to the npm package.
This version is optimised for use on development machines via npm install. It carries out the mkcert binary installation in a postinstall script. In version 6.x and earlier, all binaries for all platforms were bundled as the library also supported use from a binary install (see Site.js). The 6.x branch will still be updated with new mkcert versions but the 7.x and later versions will be used in Place.
- Uses ECMAScript Modules (ESM; es6 modules)
- Breaking change: mkcert binary is now downloaded during installation and the root certificate authority and TLS certificates are created at this time also.
- Breaking change: The settings path is no longer configurable and is shared by all installations of this package. This means whenever you install this package, it will update to the latest version of mkcert and recreate the root certificate authorities and local certificates and these will be used by all instances of Auto Encrypt Localhost on your dev machine (and this is most likely the behaviour you want).
- Breaking change: Removed command-line interface as it is no longer nececessary. Your local certificate authority and TLS certificates are ready to be used once your npm install is complete.
- Upgrade mkcert to version 1.4.2.
- Include separate mkcert arm64 build.
- Breaking change: Running multiple servers at different HTTPS ports no longer results in an error due to port 80 being unavailable for the HTTP Server. However, know that only the first server will get the HTTP Server at port 80 that redirects HTTP calls to HTTPS and also serves your local root certificate authority public key. (#14)
- Make the section on disabling privileged ports on Linux more prominent given that we now start a HTTP server and the tests will fail on Linux otherwise.
- arm64 support.
- Update readme to add missing content.
- Serves the local root certificate authority’s public key at route /.ca (you can hit this route from a device like an iPhone on your local area network to install the key and trust it on your device to test your local server with that device over your local area network).
- Redirects HTTP to HTTPS (#13).
- Update documentation to mention that the root certificate authority’s public key must be installed and trusted on any devices you want to access your local machine from via the local area network and link to the mkcert documentation for more details.
- Update documentation to mention the feature introduced in 5.2.0.
- Local server can how be accessed over external IPv4 address. This means that you can now test with other devices on your local area network without having to expose your server over the wide area network / Internet.
- Minor: Fix extraneous newlines in log statements.
- Minor: Log output now matches format of Site.js.
- Auto-upgrade feature: certificates are now automatically recreated following mkcert binary upgrades.
- Minor: add funding information; make package information consistent with related projects.
- Minor: documentation updates for consistency with related projects.
- Breaking change: New API to maintain consistency with Auto Encrypt.
- Updated readme.
New name. Now isomorphic with Auto Encrypt.
Breaking changes.
- Name change to Auto Encrypt Localhost.
- Package name change to auto-encrypt-localhost.
- Package namespace change to @small-tech.
- Binary name changed to auto-encrypt-localhost.
- Default certificate location changed to ~/.small-tech.org/auto-encrypt-localhost/.
- Function signature changed to accept parameter object.
- Main function now returns an object containing the generated private key and TLS certificate that can be passed as the options object to the
https.createServer()method.
- Support for QUIET=true environment variable to silence console output.
- Minor fixes to console output (cosmetic).
- Update bracket style in console output formatting to match what’s used in Site.js.
- Updated console output formatting to match what’s used in Site.js.
- Fix regression: Node.js once again recognises nodecert certificates.
- No longer crashes if multiple directories do not exist in the requested nodecert path.
- The configuration folder is now under ~/.small-tech.org namespace.
- The tests now actually check that local certificates are created at the custom directory instead of running the first set of tests again.
- Function now takes node certificate directory as its only parameter. Defaults to old default directory.
- Update from mkcert 1.3.0 binaries to 1.4.0. Adds macOS Catalina support.
- Cosmetic: remove newline after second success message so output looks better in Indie Web Server.
- Add nexe support. The mkcert binary is now copied to an external directory and executed from there as nexe cannot call execSync on bundled resources. You must still add the binaries to your list of resources when building your nexe executable. Bumping major version even though this isn’t a breaking change as it does add a tiny bit of processing overhead so if you were using version 2.x.x, you should make a decision about whether you want to update manually.
- Clean up output.
- Add pkg support.
- Cosmetic: capitalised Nodecert name in console logs and removed newlines.
- Capitalise app name in readme.
- Bump version to republish due to npm error:
"Unable to find a readme for @ind.ie/[email protected]"
- API: (Breaking change) You now have to execute the exported function to run Nodecert. This allows for conditional usage.
- Tested with pacman on Arch Linux. No longer displays warning/request for help.
- Tested to work on 64-bit Windows.
- Add certificates to Node.js so you can use them with, e.g., https.get(), etc. (Node.js does not use the system store.)
- Add progress indication
- Automatically install certutil (nss) dependency on macOS if you have MacPorts installed (untested).
- A failure to install optional dependency (nss/certutil) no longer kills process but it reflected as a warning with instructions for installing it manually.
- Updated instructions
- Automatically install certutil (nss) dependency on macOS if you have Homebrew installed.
- Cosmetic: minor formatting of output to match https-server
Initial release.