lint

Bumps [node-forge](https://github.com/digitalbazaar/forge) from 1.2.1 to 1.3.0.
- [Release notes](https://github.com/digitalbazaar/forge/releases)
- [Changelog](https://github.com/digitalbazaar/forge/blob/main/CHANGELOG.md)
- [Commits](https://github.com/digitalbazaar/forge/compare/v1.2.1...v1.3.0)

---
updated-dependencies:
- dependency-name: node-forge
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>

Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

.eslintrc.json

@@ -8,7 +8,7 @@
       "jsx": false,
       "modules": false
     },
-    "ecmaVersion": 2018
+    "ecmaVersion": 2020
   },
   "plugins": ["promise"],
   "rules": {

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run jslint

app.js

@@ -10,6 +10,7 @@ const logger = require('pino')(opts);
 const express = require('express');
 const app = express();
 const helmet = require('helmet');
+const rateLimit = require('express-rate-limit');
 const cors = require('cors');
 const passport = require('passport');
 const routes = require('./lib/routes');
@@ -89,6 +90,15 @@ const unless = (paths, middleware) => {
     return middleware(req, res, next);
   };
 };
+
+const limiter = rateLimit({
+  windowMs: (process.env.RATE_LIMIT_WINDOWS_MINS || 5) * 60 * 1000, // 5 minutes
+  max: process.env.RATE_LIMIT_MAX_PER_WINDOW || 600, // Limit each IP to 600 requests per `window`
+  standardHeaders: true, // Return rate limit info in the `RateLimit-*` headers
+  legacyHeaders: false, // Disable the `X-RateLimit-*` headers
+});
+
+app.use(limiter);
 app.use(helmet());
 app.use(helmet.hidePoweredBy());
 app.use(passport.initialize());

db/jambones-sql.sql

@@ -365,7 +365,7 @@ CREATE TABLE webhooks
 (
 webhook_sid CHAR(36) NOT NULL UNIQUE ,
 url VARCHAR(1024) NOT NULL,
-method ENUM("GET","POST") NOT NULL DEFAULT 'POST',
+method ENUM("GET","POST","WS") NOT NULL DEFAULT 'POST',
 username VARCHAR(255),
 password VARCHAR(255),
 PRIMARY KEY (webhook_sid)

lib/routes/api/accounts.js

@@ -19,6 +19,23 @@ const translator = short();
 
 let idx = 0;
 
+const getFsUrl = async(logger, retrieveSet, setName) => {
+  if (process.env.K8S) return `http://${process.env.K8S_FEATURE_SERVER_SERVICE_NAME}:3000/v1/createCall`;
+
+  try {
+    const fs = await retrieveSet(setName);
+    if (0 === fs.length) {
+      logger.info('No available feature servers to handle createCall API request');
+      return ;
+    }
+    const ip = stripPort(fs[idx++ % fs.length]);
+    logger.info({fs}, `feature servers available for createCall API request, selecting ${ip}`);
+    return `http://${ip}:3000/v1/createCall`;
+  } catch (err) {
+    logger.error({err}, 'getFsUrl: error retreving feature servers from redis');
+  }
+};
+
 const stripPort = (hostport) => {
   const arr = /^(.*):(.*)$/.exec(hostport);
   if (arr) return arr[1];
@@ -99,7 +116,9 @@ function validateUpdateCall(opts) {
     'listen_status',
     'conf_hold_status',
     'conf_mute_status',
-    'mute_status']
+    'mute_status',
+    'sip_request'
+  ]
     .reduce((acc, prop) => (opts[prop] ? ++acc : acc), 0);
 
   switch (count) {
@@ -133,6 +152,10 @@ function validateUpdateCall(opts) {
   if (opts.conf_mute_status && !['mute', 'unmute'].includes(opts.conf_mute_status)) {
     throw new DbErrorBadRequest('invalid conf_mute_status');
   }
+  if (opts.sip_request &&
+    (!opts.sip_request.method && !opts.sip_request.content_type ||  !opts.sip_request.content_type)) {
+    throw new DbErrorBadRequest('sip_request requires content_type and content properties');
+  }
 }
 
 function validateTo(to) {
@@ -567,18 +590,11 @@ router.post('/:sid/Calls', async(req, res) => {
   const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
   const {retrieveSet, logger} = req.app.locals;
 
+  const serviceUrl = await getFsUrl(logger, retrieveSet, setName);
+  if (!serviceUrl) res.json({msg: 'no available feature servers at this time'}).status(480);
   try {
-    const fs = await retrieveSet(setName);
-    if (0 === fs.length) {
-      logger.info('No available feature servers to handle createCall API request');
-      return res.json({msg: 'no available feature servers at this time'}).status(500);
-    }
-    const ip = stripPort(fs[idx++ % fs.length]);
-    logger.info({fs}, `feature servers available for createCall API request, selecting ${ip}`);
-    const serviceUrl = `http://${ip}:3000/v1/createCall`;
     await validateCreateCall(logger, sid, req);
 
-    logger.debug({payload: req.body}, `sending createCall API request to to ${ip}`);
     updateLastUsed(logger, sid, req).catch((err) => {});
     request({
       url: serviceUrl,
@@ -587,11 +603,11 @@ router.post('/:sid/Calls', async(req, res) => {
       body: Object.assign(req.body, {account_sid: sid})
     }, (err, response, body) => {
       if (err) {
-        logger.error(err, `Error sending createCall POST to ${ip}`);
+        logger.error(err, `Error sending createCall POST to ${serviceUrl}`);
         return res.sendStatus(500);
       }
       if (response.statusCode !== 201) {
-        logger.error({statusCode: response.statusCode}, `Non-success response returned by createCall ${ip}`);
+        logger.error({statusCode: response.statusCode}, `Non-success response returned by createCall ${serviceUrl}`);
         return res.sendStatus(500);
       }
       res.status(201).json(body);
@@ -714,14 +730,8 @@ router.post('/:sid/Messages', async(req, res) => {
   const {retrieveSet, logger} = req.app.locals;
 
   try {
-    const fs = await retrieveSet(setName);
-    if (0 === fs.length) {
-      logger.info('No available feature servers to handle createMessage API request');
-      return res.json({msg: 'no available feature servers at this time'}).status(500);
-    }
-    const ip = stripPort(fs[idx++ % fs.length]);
-    logger.info({fs}, `feature servers available for createMessage API request, selecting ${ip}`);
-    const serviceUrl = `http://${ip}:3000/v1/createMessage/${account_sid}`;
+    const serviceUrl = await getFsUrl(logger, retrieveSet, setName);
+    if (!serviceUrl) res.json({msg: 'no available feature servers at this time'}).status(480);
     await validateCreateMessage(logger, account_sid, req);
 
     const payload = {
@@ -729,7 +739,7 @@ router.post('/:sid/Messages', async(req, res) => {
       account_sid,
       ...req.body
     };
-    logger.debug({payload}, `sending createMessage API request to to ${ip}`);
+    logger.debug({payload}, `sending createMessage API request to to ${serviceUrl}`);
     updateLastUsed(logger, account_sid, req).catch(() => {});
     request({
       url: serviceUrl,
@@ -738,7 +748,7 @@ router.post('/:sid/Messages', async(req, res) => {
       body: payload
     }, (err, response, body) => {
       if (err) {
-        logger.error(err, `Error sending createMessage POST to ${ip}`);
+        logger.error(err, `Error sending createMessage POST to ${serviceUrl}`);
         return res.sendStatus(500);
       }
       if (response.statusCode !== 200) {

lib/routes/api/add-from-predefined-carrier.js

@@ -1,10 +1,10 @@
 const router = require('express').Router();
-const {DbErrorBadRequest} = require('../../utils/errors');
 const PredefinedCarrier = require('../../models/predefined-carrier');
 const VoipCarrier = require('../../models/voip-carrier');
 const SipGateway = require('../../models/sip-gateway');
 const SmppGateway = require('../../models/smpp-gateway');
 const {parseServiceProviderSid} = require('./utils');
+const short = require('short-uuid');
 const {promisePool} = require('../../db');
 const sysError = require('../error');
 
@@ -43,8 +43,7 @@ router.post('/:sid', async(req, res) => {
       await promisePool.query(sqlSelectCarrierByNameForSP, [service_provider_sid, template.name]);
 
     if (r2.length > 0) {
-      logger.info({account_sid}, `Failed to add carrier with name ${template.name}, carrier of that name exists`);
-      throw new DbErrorBadRequest(`A carrier with name ${template.name} already exists`);
+      template.name =  `${template.name}-${short.generate()}`;
     }
 
     /* retrieve all the sip gateways */

lib/routes/api/sms-inbound.js

@@ -5,15 +5,37 @@ const { v4: uuidv4 } = require('uuid');
 const sysError = require('../error');
 let idx = 0;
 
+const getFsUrl = async(logger, retrieveSet, setName, provider) => {
+  if (process.env.K8S) return `http://${process.env.K8S_FEATURE_SERVER_SERVICE_NAME}:3000/v1/messaging/${provider}`;
 
-async function doSendResponse(res, respondFn, body) {
+  try {
+    const fs = await retrieveSet(setName);
+    if (0 === fs.length) {
+      logger.info('No available feature servers to handle createCall API request');
+      return ;
+    }
+    const ip = stripPort(fs[idx++ % fs.length]);
+    logger.info({fs}, `feature servers available for createCall API request, selecting ${ip}`);
+    return `http://${ip}:3000/v1/messaging/${provider}`;
+  } catch (err) {
+    logger.error({err}, 'getFsUrl: error retreving feature servers from redis');
+  }
+};
+
+const stripPort = (hostport) => {
+  const arr = /^(.*):(.*)$/.exec(hostport);
+  if (arr) return arr[1];
+  return hostport;
+};
+
+const doSendResponse = async(res, respondFn, body) => {
   if (typeof respondFn === 'number') res.sendStatus(respondFn);
   else if (typeof respondFn !== 'function') res.sendStatus(200);
   else {
     const payload = await respondFn(body);
     res.status(200).json(payload);
   }
-}
+};
 
 router.post('/:provider', async(req, res) => {
   const provider = req.params.provider;
@@ -67,17 +89,8 @@ router.post('/:provider', async(req, res) => {
   }
 
   try {
-    const fs = await retrieveSet(setName);
-    if (0 === fs.length) {
-      logger.info('No available feature servers to handle createCall API request');
-      return res
-        .json({
-          msg: 'no available feature servers at this time'
-        })
-        .status(480);
-    }
-    const ip = fs[idx++ % fs.length];
-    const serviceUrl = `http://${ip}:3000/v1/messaging/${provider}`;
+    const serviceUrl = await getFsUrl(logger, retrieveSet, setName, provider);
+    if (!serviceUrl) res.json({msg: 'no available feature servers at this time'}).status(480);
     const messageSid = uuidv4();
     const payload = await Promise.resolve(filterFn({messageSid}, req.body));
 
@@ -113,7 +126,7 @@ router.post('/:provider', async(req, res) => {
 
     logger.debug({body: req.body, payload}, 'filtered incoming SMS');
 
-    logger.info({payload, url: serviceUrl}, `sending incomingSms API request to FS at ${ip}`);
+    logger.info({payload, url: serviceUrl}, `sending incomingSms API request to FS at ${serviceUrl}`);
 
     request({
       url: serviceUrl,
@@ -123,7 +136,7 @@ router.post('/:provider', async(req, res) => {
     },
     async(err, response, body) => {
       if (err) {
-        logger.error(err, `Error sending incomingSms POST to ${ip}`);
+        logger.error(err, `Error sending incomingSms POST to ${serviceUrl}`);
         return res.sendStatus(500);
       }
       if (200 === response.statusCode) {
@@ -131,7 +144,7 @@ router.post('/:provider', async(req, res) => {
         logger.info({body}, 'sending response to provider for incomingSMS');
         return doSendResponse(res, respondFn, body);
       }
-      logger.error({statusCode: response.statusCode}, `Non-success response returned by incomingSms ${ip}`);
+      logger.error({statusCode: response.statusCode}, `Non-success response returned by incomingSms ${serviceUrl}`);
       return res.sendStatus(500);
     });
   } catch (err) {

lib/routes/api/speech-credentials.js

@@ -1,9 +1,10 @@
 const router = require('express').Router();
+const assert = require('assert');
 const SpeechCredential = require('../../models/speech-credential');
 const sysError = require('../error');
 const {decrypt, encrypt} = require('../../utils/encrypt-decrypt');
 const {parseAccountSid, parseServiceProviderSid} = require('./utils');
-const {DbErrorUnprocessableRequest, DbErrorBadRequest} = require('../../utils/errors');
+const {DbErrorUnprocessableRequest} = require('../../utils/errors');
 const {
   testGoogleTts,
   testGoogleStt,
@@ -14,11 +15,9 @@ const {
   testWellSaidTts
 } = require('../../utils/speech-utils');
 
-router.post('/', async(req, res) => {
-  const logger = req.app.locals.logger;
+
+const encryptCredential = (obj) => {
   const {
-    use_for_stt,
-    use_for_tts,
     vendor,
     service_key,
     access_key_id,
@@ -26,6 +25,49 @@ router.post('/', async(req, res) => {
     aws_region,
     api_key,
     region
+  } = obj;
+
+  switch (vendor) {
+    case 'google':
+      assert(service_key, 'invalid json key: service_key is required');
+      try {
+        const o = JSON.parse(service_key);
+        assert(o.client_email && o.private_key, 'invalid google service account key');
+      }
+      catch (err) {
+        assert(false, 'invalid google service account key - not JSON');
+      }
+      return encrypt(service_key);
+
+    case 'aws':
+      assert(access_key_id, 'invalid aws speech credential: access_key_id is required');
+      assert(secret_access_key, 'invalid aws speech credential: secret_access_key is required');
+      assert(aws_region, 'invalid aws speech credential: aws_region is required');
+      const awsData = JSON.stringify({aws_region, access_key_id, secret_access_key});
+      return encrypt(awsData);
+
+    case 'microsoft':
+      assert(region, 'invalid azure speech credential: region is required');
+      assert(api_key, 'invalid azure speech credential: api_key is required');
+      const azureData = JSON.stringify({region, api_key});
+      return encrypt(azureData);
+
+    case 'wellsaid':
+      assert(api_key, 'invalid wellsaid speech credential: api_key is required');
+      const wsData = JSON.stringify({api_key});
+      return encrypt(wsData);
+
+    default:
+      assert(false, `invalid or missing vendor: ${vendor}`);
+  }
+};
+
+router.post('/', async(req, res) => {
+  const logger = req.app.locals.logger;
+  const {
+    use_for_stt,
+    use_for_tts,
+    vendor,
   } = req.body;
   const account_sid = req.user.account_sid || req.body.account_sid;
   let service_provider_sid;
@@ -37,43 +79,7 @@ router.post('/', async(req, res) => {
     service_provider_sid = parseServiceProviderSid(req);
   }
   try {
-    let encrypted_credential;
-    if (vendor === 'google') {
-      let obj;
-      if (!service_key) throw new DbErrorBadRequest('invalid json key: service_key is required');
-      try {
-        obj = JSON.parse(service_key);
-        if (!obj.client_email || !obj.private_key) {
-          throw new DbErrorBadRequest('invalid google service account key');
-        }
-      }
-      catch (err) {
-        throw new DbErrorBadRequest('invalid google service account key - not JSON');
-      }
-      encrypted_credential = encrypt(service_key);
-    }
-    else if (vendor === 'aws') {
-      const data = JSON.stringify({
-        aws_region: aws_region || 'us-east-1',
-        access_key_id,
-        secret_access_key
-      });
-      encrypted_credential = encrypt(data);
-    }
-    else if (vendor === 'microsoft') {
-      const data = JSON.stringify({
-        region,
-        api_key
-      });
-      encrypted_credential = encrypt(data);
-    }
-    else if (vendor === 'wellsaid') {
-      const data = JSON.stringify({
-        api_key
-      });
-      encrypted_credential = encrypt(data);
-    }
-    else throw new DbErrorBadRequest(`invalid speech vendor ${vendor}`);
+    const encrypted_credential = encryptCredential(req.body);
     const uuid = await SpeechCredential.make({
       account_sid,
       service_provider_sid,
@@ -104,20 +110,23 @@ router.get('/', async(req, res) => {
     res.status(200).json(creds.map((c) => {
       const {credential, ...obj} = c;
       if ('google' === obj.vendor) {
-        obj.service_key = decrypt(credential);
+        obj.service_key = JSON.parse(decrypt(credential));
       }
       else if ('aws' === obj.vendor) {
-        const o = decrypt(credential);
+        const o = JSON.parse(decrypt(credential));
         obj.access_key_id = o.access_key_id;
         obj.secret_access_key = o.secret_access_key;
+        obj.aws_region = o.aws_region;
+        logger.info({obj, o}, 'retrieving aws speech credential');
       }
       else if ('microsoft' === obj.vendor) {
-        const o = decrypt(credential);
+        const o = JSON.parse(decrypt(credential));
         obj.api_key = o.api_key;
         obj.region = o.region;
+        logger.info({obj, o}, 'retrieving azure speech credential');
       }
       else if ('wellsaid' === obj.vendor) {
-        const o = decrypt(credential);
+        const o = JSON.parse(decrypt(credential));
         obj.api_key = o.api_key;
       }
       return obj;
@@ -144,6 +153,7 @@ router.get('/:sid', async(req, res) => {
       const o = JSON.parse(decrypt(credential));
       obj.access_key_id = o.access_key_id;
       obj.secret_access_key = o.secret_access_key;
+      obj.aws_region = o.aws_region;
     }
     else if ('microsoft' === obj.vendor) {
       const o = JSON.parse(decrypt(credential));
@@ -191,6 +201,11 @@ router.put('/:sid', async(req, res) => {
       obj.use_for_stt = use_for_stt;
     }
 
+    /* update the credential if provided */
+    try {
+      obj.credential = encryptCredential(req.body);
+    } catch (err) {}
+
     const rowsAffected = await SpeechCredential.update(sid, obj);
     if (rowsAffected === 0) {
       return res.sendStatus(404);

lib/swagger/swagger.yaml

@@ -3102,9 +3102,12 @@ paths:
                   enum:
                     - completed
                     - no-answer
-                conf_mute:
-                  type: boolean
-                conf_status:
+                conf_mute_status:
+                  type: string
+                  enum:
+                    - mute
+                    - unmute
+                conf_hold_status:
                   type: string
                   enum:
                     - hold
@@ -3120,8 +3123,21 @@ paths:
                     - mute
                     - unmute
                 whisper:
-                  $ref: '#/components/schemas/Webhook'         
+                  $ref: '#/components/schemas/Webhook'
+                sip_request:
+                  type: object
+                  properties:
+                    method:
+                      type: string
+                    content_type:
+                      type: string
+                    content:
+                      type: string
+                    headers:
+                      type: object
       responses:
+        200:
+          description: Accepted
         202:
           description: Accepted
         400:

package.json

@@ -1,15 +1,16 @@
 {
   "name": "jambonz-api-server",
-  "version": "v0.7.2",
+  "version": "v0.7.5",
   "description": "",
   "main": "app.js",
   "scripts": {
     "start": "node app.js",
-    "test": "NODE_ENV=test APPLY_JAMBONZ_DB_LIMITS=1 JWT_SECRET=foobarbazzle JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=info JAMBONES_CREATE_CALL_URL=http://localhost/v1/createCall node test/ ",
+    "test": "NODE_ENV=test APPLY_JAMBONZ_DB_LIMITS=1 JWT_SECRET=foobarbazzle JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_LOGLEVEL=error JAMBONES_CREATE_CALL_URL=http://localhost/v1/createCall node test/ ",
     "integration-test": "NODE_ENV=test JAMBONES_TIME_SERIES_HOST=127.0.0.1 AWS_REGION='us-east-1' JAMBONES_CURRENCY=USD JWT_SECRET=foobarbazzle JAMBONES_MYSQL_HOST=127.0.0.1 JAMBONES_MYSQL_PORT=3360 JAMBONES_MYSQL_USER=jambones_test JAMBONES_MYSQL_PASSWORD=jambones_test JAMBONES_MYSQL_DATABASE=jambones_test JAMBONES_REDIS_HOST=localhost JAMBONES_REDIS_PORT=16379 JAMBONES_LOGLEVEL=debug JAMBONES_CREATE_CALL_URL=http://localhost/v1/createCall node test/serve-integration.js",
     "upgrade-db": "node ./db/upgrade-jambonz-db.js",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
-    "jslint": "eslint app.js lib"
+    "jslint": "eslint app.js lib",
+    "prepare": "husky install"
   },
   "author": "Dave Horton",
   "license": "MIT",
@@ -20,14 +21,15 @@
     "@google-cloud/speech": "^4.10.0",
     "@google-cloud/text-to-speech": "^3.4.0",
     "@jambonz/db-helpers": "^0.6.16",
-    "@jambonz/realtimedb-helpers": "^0.4.19",
+    "@jambonz/realtimedb-helpers": "^0.4.24",
     "@jambonz/time-series": "^0.1.6",
     "argon2-ffi": "^2.0.0",
-    "aws-sdk": "^2.1066.0",
+    "aws-sdk": "^2.1073.0",
     "bent": "^7.3.12",
     "cors": "^2.8.5",
     "debug": "^4.3.3",
     "express": "^4.17.2",
+    "express-rate-limit": "^6.3.0",
     "form-data": "^2.5.1",
     "form-urlencoded": "^6.0.5",
     "helmet": "^5.0.2",
@@ -48,6 +50,7 @@
   "devDependencies": {
     "eslint": "^7.17.0",
     "eslint-plugin-promise": "^4.2.1",
+    "husky": "7.0.4",
     "nyc": "^15.1.0",
     "request": "^2.88.2",
     "request-promise-native": "^1.0.9",