Refactor

Author: gyszalai

README.md

@@ -1,2 +1,27 @@
-# node-simple-keystore
-Simple keystore for Node.js
+# Simple filesystem based keystore for Node.js
+
+Simple filesystem keystore implementation
+
+# Usage
+
+```js
+// initializing keystore
+const debugNamePrefix = 'myproject' // name prefix used for the debug module
+const baseDir = <directory containing key files>
+const refreshIntervalMillis = 30 * 1000 // 30 secs
+const signingKeyPassphrases = { // an object containing passphrases for private keys
+  'key_id_1': 'passphrase1',
+  'key_id_2': 'passphrase2'
+}
+const keystore = require('@vanioinformatika/simple-keystore') (
+  debugNamePrefix, baseDir, refreshIntervalMillis, signingKeyPassphrases
+)
+
+...
+
+// publishing public keys with express.js
+router.route('/certs').get((req, res) => {
+  const certificateList = keystore.fny.getAllCertificatesAsJWKS()
+  res.status(HttpStatus.OK).json({keys: certificateList})
+})
+```

lib/index.js

@@ -1,9 +1,9 @@
 const { KeystoreError, PrivateKeyNotFoundError, CertificateNotFoundError } = require('./errors')
 
-module.exports = (debugName, baseDir, signingKeyPassphrases) => {
-  const keystoreReaderFs = require('./keystore.reader.fs')(baseDir)
+module.exports = (debugNamePrefix, baseDir, refreshIntervalMillis, signingKeyPassphrases) => {
+  const keystoreReader = require('./keystore.reader.fs')(baseDir)
   const keystore = require('./keystore')(
-    debugName, signingKeyPassphrases, keystoreReaderFs, 5 * 60 * 1000
+    debugNamePrefix, signingKeyPassphrases, keystoreReader, refreshIntervalMillis
   )
   return {
     getCurrentSigningKeyId: keystore.getCurrentSigningKeyId,

lib/keystore.js

@@ -30,13 +30,14 @@ const { PrivateKeyNotFoundError, CertificateNotFoundError } = require('./errors'
 
 /**
  * Creates a new keystore service
+ * @param {string} debugNamePrefix Name prefix used for the debug module
  * @param {Object} signingKeyPassphrases Stores passphrases for each signing keys. Key: key id, value: passphrase
  * @param {KeystoreService~keystoreReaderCallback} keystoreReader Keystore reader callback (sync or async)
  * @param {integer} refreshInterval Interval of the keystore refresh [millisec]
  */
-module.exports = (debugName, signingKeyPassphrases, keystoreReader, refreshInterval) => {
+module.exports = (debugNamePrefix, signingKeyPassphrases, keystoreReader, refreshInterval) => {
 
-  const debug = require('debug')(debugName)
+  const debug = require('debug')(debugNamePrefix + ':keystore')
 
   /** The current signing key ID */
   let currentSigningKeyId

lib/keystore.reader.fs.js

@@ -14,13 +14,13 @@ const verifySigningChainAsync = Promise.promisify(pem.verifySigningChain)
 
 /**
  * Creates a keystore reader function
- * @alias keystoreReaderFactory
+ * @param {string} debugNamePrefix Name prefix used for the debug module
  * @param {string} baseDir The keystore base directory
  * @return {keystoreReaderFactory~readKeys} A function to (re)load private keys and certificates
  */
-module.exports = function (debugName, baseDir) {
+module.exports = function (debugNamePrefix, baseDir) {
   //
-  const debug = require('debug')(`${debugName}:reader.fs`)
+  const debug = require('debug')(debugNamePrefix + ':keystore.reader')
   //
   const rootCACert = fs.readFileSync(path.join(baseDir, `rootCA.cert.pem`))
   debug('Root CA cert loaded: ' + rootCACert)