@thingsup/greenlock-sql-manager

A database-driven Greenlock storage plugin and manager.

This library is created and maintained by Thingsup

This library is compatible with Express Framework

Lot of codebase is taken from greenlock-store-sequelize

Features

• Many Supported SQL Databases
  • PostgreSQL (best)
  • SQLite3 (easiest)
  • Microsoft SQL Server (mssql)
  • MySQL, MariaDB
• Works on all platforms
  • Mac, Linux, VPS
  • AWS, Heroku, Akkeris, Docker
  • Windows

Installation

npm i @thingsup/greenlock-sql-manager

You also have to install the database ORM Library which you will be using.

# One of the following:
npm install pg pg-hstore # Postgres
npm install mysql2
npm install mariadb
npm install sqlite3
npm install tedious # Microsoft SQL Server

Usage

Running Express App

To use, with express.

constexpress=require("express");constapp=express();constglx=require("@thingsup/greenlock-sql-manager");glx.init({greenlockDefaults: {maintainerEmail: "test@example.com",cluster: false,packageRoot: __dirname,// Options passed to greenlock-express library init function// Most of the options are already pre-configured},managerDefaults: {subscriberEmail: "abc@abc.com",// Options passed to greenlock-manager or the options which are passed in config.json of greenlock-express library},storeDefaults: {prefix: "<CUSTOM_PREFIX>",storeDatabaseUrl: "<DB_URL>",},// Options passed to greenlock-sequelize with one additional argument prefix}).serve(app);

Manage Sites

We have created a handlers function to easily manage your sites stored in database.

conststoreOptions={// Pass the same objects that you have passed to storeDefaults};constglx=require("@thingsup/greenlock-sql-manager");const{ add, getCertificates, getDB, remove, removeAll, getAll }=glx.handles(storeOptions);// List of the functions that we currently support.

Get list of Domains Added

To get all sites,

try{console.log(awaitgetAll());// List of all domains which is currently added ie ['abc.com','abc2.com','abc3.com']}catch(err){console.log("Unable to get sites");}

Adding Sites

To add a site,

try{awaitadd({subject: "example.com",altnames: ["www.example.com","example.com"],});console.log("Site added");}catch(err){console.log("Unable to add sites");}

Remove a site

try{awaitremove("abc.com");// Remove this site from db.}catch(err){console.log("Unable to get sites");}

Remove all sites

try{awaitremoveAll();// Remove all the sites.}catch(err){console.log("Unable to get sites");}

Getting Certificates and keys of a site

Get keys and certificates necessary to run https server

try{constcertOpts=awaitgetCertificates("example.com");/* returns { ca: '....', key: '...', // Private Key cert: '...' } (certificate exist) || null (certicate not exist) */}catch(err){console.log("Error Occured");}

Get Sequelize DB Instance

try{constdb=awaitgetDB();}catch(err){console.log("Error Occured");}

Opening TCP/IP socket using TLS

constexpress=require("express");constapp=express();constglx=require("@thingsup/greenlock-sql-manager");letserver=null;conststoreOptions={prefix: "<CUSTOM_PREFIX>",storeDatabaseUrl: "<DB_URL>",};constPORT=8888;conststartServer=(certificates)=>{// Incase of renewal, we can either restart the whole process. or close the existing server and then start it with new certificate.if(server){server.close(()=>{server=require("tls").createServer(certificates,()=>{});server.listen(PORT);});}else{server=require("tls").createServer(certificates,()=>{});server.listen(PORT);}};constsiteHandles=glx.handles(storeOptions);constgetCertificateAndRunServer=()=>{siteHandles.getCertificate("yourdomain.com").then((certs)=>{if(certs){// Certificate existstartServer(certs);}else{}// certificate not exist. wait for the certificate issue.});};getCertificateAndRunServer();glx.init({greenlockDefaults: {maintainerEmail: "test@example.com",cluster: false,packageRoot: __dirname,notify: (ev)=>{if(ev.trim()==="cert_issue"||ev.trim()==="cert_renewal"){// Certificate is either issued or renewed now you have to change your socket's certificategetCertificateAndRunServer();}},},managerDefaults: {subscriberEmail: "abc@abc.com",},storeDefaults: storeOptions,}).serve(app);

Default Table Structure

This is the default table structure (Unless a prefix option is given) that's created.

CREATETABLE `Keypairs` (
`id`INTEGERPRIMARY KEY AUTOINCREMENT,
`xid`VARCHAR(255) UNIQUE,
`content`TEXT,
`createdAt` DATETIME NOT NULL,
`updatedAt` DATETIME NOT NULL);
CREATETABLE `Domains` (
`id`INTEGERPRIMARY KEY AUTOINCREMENT,
`subject`VARCHAR(255) UNIQUE,
`altnames`TEXT,
`renewAt`DATE,
`createdAt` DATETIME NOT NULL,
`updatedAt` DATETIME NOT NULL);
CREATETABLE `Certificates` (
`id`INTEGERPRIMARY KEY AUTOINCREMENT,
`subject`VARCHAR(255) UNIQUE,
`cert`TEXT,
`issuedAt` DATETIME,
`expiresAt` DATETIME,
`altnames`TEXT,
`chain`TEXT,
`createdAt` DATETIME NOT NULL,
`updatedAt` DATETIME NOT NULL);
CREATETABLE `Chains` (
`id`INTEGERPRIMARY KEY AUTOINCREMENT,
`xid`VARCHAR(255),
`content`TEXT,
`createdAt` DATETIME NOT NULL,
`updatedAt` DATETIME NOT NULL,
`CertificateId`INTEGERREFERENCES`Certificates` (`id`) ON DELETESETNULLONUPDATE CASCADE);