@vladmandic/piacme - npm Package Compare versions

Comparing version 0.1.4 to 0.1.5

package.json

		{
		"name": "@vladmandic/piacme",
		"version": "0.1.4",
		"version": "0.1.5",
		"description": "Simple ACME/LetsEncrypt HTTP/SSL Certificate Management",
		@@ -5,0 +5,0 @@ "main": "piacme.js",

README.md

		@@ -5,2 +5,7 @@ # piacme

		## Why

		Because out of all of the existing modules, I couldn't find one that does what I needed and doesn't carry large number of unnecessary dependencies.
		This module is written in pure ES6 and requires only several low-level crypto management dependencies.

		## Usage
		@@ -25,26 +30,40 @@

		Now you're free to use server key and certificate.
		For example to start a secure http2 server:
		That's it!
		Account registration, server key creation, certificate issuance, taget validation, and certificate renwal - are all handled automatically.
		Now you can use server key and certificate.
		For example to start a secure http2 server:

		const http2 = require('http2');
		const opts = {
		const fs = require('fs');
		const options = {
		key = fs.readFileSync(Key);
		cert = fs.readFileSync(Crt);
		};
		const server = http2.createSecureServer(opts);
		const server = http2.createSecureServer(options);
		server.listen(443);

		Or https server:

		const http2 = require('https');
		const fs = require('fs');
		const options = {
		key = fs.readFileSync(Key);
		cert = fs.readFileSync(Crt);
		};
		const server = https.createServer(options);
		server.listen(443);

		## Internal workflow

		All functions use same object passed during `init()` call.
		Core function is getCert() and it will either return existing valid certificate, issue a new one or trigger a certificate renewal.
		Core function is `getCert()` and it will either return existing valid certificate, issue a new one or trigger a certificate renewal.

		Internally, it calls `piacme.checkCert()` to verify if server key and certificate specified in config object already exists and are valid.
		Internally, it calls `checkCert()` to verify if server key and certificate specified in config object already exists and are valid.
		If yes, it will just return those objects: `config.ServerKeyFile` and `config.fullChain`.
		If not, if calls:

		- `piacme.createKeys()`
		- `createKeys()`
		Which is used only once per server lifetime.
		It initialize LetsEncrypt account using maintainer info and generate server private key.
		- `piacme.createCert()`
		- `createCert()`
		Which is used to genrates new certificate if one doesn't exist or is about to expire.
		@@ -60,10 +79,19 @@ Interally it temporarily starts a http server on port 80 to listen for LetsEncrypt validation callbacks and then shuts down the server.

		To get certificate details, call `parseCert()` and it will parse certificate from the initial object used during `init()` call.
		piacme.monitorCert();

		const ssl = await parseCert();
		ssl: {
		account: { error?, contact, createdAt },
		serverKey: { error? },
		accountKey: { error? },
		fullChain: { error?, subject, issuer, notBefore, notAfter }
		}
		(RFE: Implement monitoring callback that can be used to automatically restart web server as needed)

		To get certificate details, call `parseCert()` and it will parse certificate from the initial object used during `init()` call.

		- `contact` and `subject` are values provided during certificate creation
		- `error` in all cases is optional property and will be set if case of an error.
		- `issuer` will always be LetsEncrypt authority.
		- `createdAt`, `notBefore` and `notAfter` are date objects specifying certificate issue date and validity (start and end date).

		const ssl = await piacme.parseCert();
		ssl: {
		account: { error?, contact, createdAt },
		serverKey: { error? },
		accountKey: { error? },
		fullChain: { error?, subject, issuer, notBefore, notAfter }
		}

@vladmandic/piacme - npm Package Compare versions

Improved metrics