update to drachtio-srf latest (#239)

* Add STRAIGHT_JOIN to CIDR gateway query to prevent MySQL optimizer from choosing inefficient full table scan on voip_carriers table.

* update tests with latest schema

* fix test data

* security issues

* update workflow actions

.eslintignore

@@ -1 +0,0 @@
-test/*

.eslintrc.json

@@ -1,126 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "es6": true  
-  },
-  "parserOptions": {
-    "ecmaFeatures": {
-      "jsx": false,
-      "modules": false
-    },
-    "ecmaVersion": 2017 
-  },
-  "plugins": ["promise"],
-  "rules": {
-    "promise/always-return": "error",
-    "promise/no-return-wrap": "error",
-    "promise/param-names": "error",
-    "promise/catch-or-return": "error",
-    "promise/no-native": "off",
-    "promise/no-nesting": "warn",
-    "promise/no-promise-in-callback": "warn",
-    "promise/no-callback-in-promise": "warn",
-    "promise/no-return-in-finally": "warn",
-
-    // Possible Errors
-    // http://eslint.org/docs/rules/#possible-errors
-    "comma-dangle": [2, "only-multiline"],
-    "no-control-regex": 2,
-    "no-debugger": 2,
-    "no-dupe-args": 2,
-    "no-dupe-keys": 2,
-    "no-duplicate-case": 2,
-    "no-empty-character-class": 2,
-    "no-ex-assign": 2,
-    "no-extra-boolean-cast" : 2,
-    "no-extra-parens": [2, "functions"],
-    "no-extra-semi": 2,
-    "no-func-assign": 2,
-    "no-invalid-regexp": 2,
-    "no-irregular-whitespace": 2,
-    "no-negated-in-lhs": 2,
-    "no-obj-calls": 2,
-    "no-proto": 2,
-    "no-unexpected-multiline": 2,
-    "no-unreachable": 2,
-    "use-isnan": 2,
-    "valid-typeof": 2,
-
-    // Best Practices
-    // http://eslint.org/docs/rules/#best-practices
-    "no-fallthrough": 2,
-    "no-octal": 2,
-    "no-redeclare": 2,
-    "no-self-assign": 2,
-    "no-unused-labels": 2,
-
-    // Strict Mode
-    // http://eslint.org/docs/rules/#strict-mode
-    "strict": [2, "never"],
-
-    // Variables
-    // http://eslint.org/docs/rules/#variables
-    "no-delete-var": 2,
-    "no-undef": 2,
-    "no-unused-vars": [2, {"args": "none"}],
-
-    // Node.js and CommonJS
-    // http://eslint.org/docs/rules/#nodejs-and-commonjs
-    "no-mixed-requires": 2,
-    "no-new-require": 2,
-    "no-path-concat": 2,
-    "no-restricted-modules": [2, "sys", "_linklist"],
-
-    // Stylistic Issues
-    // http://eslint.org/docs/rules/#stylistic-issues
-    "comma-spacing": 2,
-    "eol-last": 2,
-    "indent": [2, 2, {"SwitchCase": 1}],
-    "keyword-spacing": 2,
-    "max-len": [2, 120, 2],
-    "new-parens": 2,
-    "no-mixed-spaces-and-tabs": 2,
-    "no-multiple-empty-lines": [2, {"max": 2}],
-    "no-trailing-spaces": [2, {"skipBlankLines": false }],
-    "quotes": [2, "single", "avoid-escape"],
-    "semi": 2,
-    "space-before-blocks": [2, "always"],
-    "space-before-function-paren": [2, "never"],
-    "space-in-parens": [2, "never"],
-    "space-infix-ops": 2,
-    "space-unary-ops": 2,
-
-    // ECMAScript 6
-    // http://eslint.org/docs/rules/#ecmascript-6
-    "arrow-parens": [2, "always"],
-    "arrow-spacing": [2, {"before": true, "after": true}],
-    "constructor-super": 2,
-    "no-class-assign": 2,
-    "no-confusing-arrow": 2,
-    "no-const-assign": 2,
-    "no-dupe-class-members": 2,
-    "no-new-symbol": 2,
-    "no-this-before-super": 2,
-    "prefer-const": 2
-  },
-  "globals": {
-    "DTRACE_HTTP_CLIENT_REQUEST"           : false,
-    "LTTNG_HTTP_CLIENT_REQUEST"            : false,
-    "COUNTER_HTTP_CLIENT_REQUEST"          : false,
-    "DTRACE_HTTP_CLIENT_RESPONSE"          : false,
-    "LTTNG_HTTP_CLIENT_RESPONSE"           : false,
-    "COUNTER_HTTP_CLIENT_RESPONSE"         : false,
-    "DTRACE_HTTP_SERVER_REQUEST"           : false,
-    "LTTNG_HTTP_SERVER_REQUEST"            : false,
-    "COUNTER_HTTP_SERVER_REQUEST"          : false,
-    "DTRACE_HTTP_SERVER_RESPONSE"          : false,
-    "LTTNG_HTTP_SERVER_RESPONSE"           : false,
-    "COUNTER_HTTP_SERVER_RESPONSE"         : false,
-    "DTRACE_NET_STREAM_END"                : false,
-    "LTTNG_NET_STREAM_END"                 : false,
-    "COUNTER_NET_SERVER_CONNECTION_CLOSE"  : false,
-    "DTRACE_NET_SERVER_CONNECTION"         : false,
-    "LTTNG_NET_SERVER_CONNECTION"          : false,
-    "COUNTER_NET_SERVER_CONNECTION"        : false  
-  }
-}

.github/workflows/docker-publish.yml

@@ -0,0 +1,54 @@
+name: Docker
+
+on:
+  push:
+    branches:
+      - main
+    tags:
+      - '*'
+
+jobs:
+  push:
+
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: prepare tag 
+        id: prepare_tag
+        run: |
+            IMAGE_ID=jambonz/sbc-inbound
+
+            # Strip git ref prefix from version
+            VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
+
+            # Strip "v" prefix from tag name
+            [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
+
+            # Use Docker `latest` tag convention
+            [ "$VERSION" == "main" ] && VERSION=latest
+
+            echo IMAGE_ID=$IMAGE_ID
+            echo VERSION=$VERSION
+
+            echo "image_id=$IMAGE_ID" >> $GITHUB_OUTPUT
+            echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.prepare_tag.outputs.image_id }}:${{ steps.prepare_tag.outputs.version }}
+          build-args: |
+            GITHUB_REPOSITORY=$GITHUB_REPOSITORY
+            GITHUB_REF=$GITHUB_REF

.github/workflows/npm-ci.yml

@@ -0,0 +1,20 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+      - run: npm install
+      - run: npm run jslint
+      - name: Install Docker Compose
+        run: |
+          sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
+          sudo chmod +x /usr/local/bin/docker-compose
+          docker-compose --version
+      - run: npm test

.gitignore

@@ -1,7 +1,7 @@
 # Logs
 logs
 *.log
-
+.vscode/
 # Runtime data
 pids
 *.pid

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# npm audit fix || true
+# npm run jslint

.travis.yml

@@ -1,9 +0,0 @@
-sudo: required
-language: node_js
-node_js:
-  - "lts/*"
-services:
-  - docker
-  - mysql
-script:
-  - npm test

Dockerfile

@@ -1,13 +1,23 @@
-FROM node:lts-alpine
+FROM --platform=linux/amd64 node:24-alpine AS base
 
-RUN mkdir -p /usr/src/app
-WORKDIR /usr/src/app
+RUN apk --update --no-cache add --virtual .builds-deps build-base python3
+
+WORKDIR /opt/app/
+
+FROM base AS build
+
+COPY package.json package-lock.json ./
+
+RUN npm ci
+
+COPY . .
+
+FROM base
+
+COPY --from=build /opt/app /opt/app/
 
 ARG NODE_ENV
-ENV NODE_ENV $NODE_ENV
 
-COPY package.json /usr/src/app/
-RUN npm install
-COPY . /usr/src/app
+ENV NODE_ENV=$NODE_ENV
 
-CMD [ "npm", "start" ]
+CMD [ "node", "app.js" ]

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2019 jambonz
+Copyright (c) 2021 Drachtio Communications Services, LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,10 +1,41 @@
-# sbc-inbound [![Build Status](https://secure.travis-ci.org/jambonz/sbc-inbound.png)](http://travis-ci.org/jambonz/sbc-inbound)
+# sbc-inbound ![Build Status](https://github.com/jambonz/sbc-inbound/workflows/CI/badge.svg)
 
-This application provides a part of the SBC (Session Border Controller) functionality of jambonz.  It handles incoming INVITE requests from carrier sip trunks or from sip devices and webrtc applications. SIP INVITEs from known carriers are allowed in, while INVITEs from sip devices are challenged to authenticate.  SIP traffic that is allowed in is sent on to a jambonz application server in a private subnet.
+This application provides a part of the SBC (Session Border Controller) functionality of jambonz platform. It handles incoming INVITE requests from carrier sip trunks or from sip devices and webrtc applications. SIP INVITEs from known carriers are allowed in, while INVITEs from sip devices are challenged to authenticate.  SIP traffic that is allowed in is sent on to a jambonz application server in a private subnet.
 
 ## Configuration
 
-Configuration is provided via the [npmjs config](https://www.npmjs.com/package/config) package.  The following elements make up the configuration for the application:
+Configuration is provided via environment variables:
+
+| variable | meaning | required?|
+|----------|----------|---------|
+|DRACHTIO_HOST| ip address of drachtio server (typically '127.0.0.1')|yes|
+|DRACHTIO_PORT| listening port of drachtio server for control connections (typically 9022)|yes|
+|DRACHTIO_SECRET| shared secret|yes|
+|HTTP_PORT| http listen port |no|
+|JAMBONES_LOGLEVEL| log level for application, 'info' or 'debug'|no|
+|JAMBONES_MYSQL_HOST| mysql host|yes|
+|JAMBONES_MYSQL_PORT| mysql port |no|
+|JAMBONES_MYSQL_USER| mysql username|yes|
+|JAMBONES_MYSQL_PASSWORD| mysql password|yes|
+|JAMBONES_MYSQL_DATABASE| mysql data|yes|
+|JAMBONES_MYSQL_CONNECTION_LIMIT| mysql connection limit |no|
+|DTMF_LISTEN_PORT| DTMF listening port |no|
+|JAMBONES_NG_PROTOCOL| rtpengine NG protocol |no|
+|RTPENGINE_PORT| rtpengine port |no|
+|JAMBONES_CLUSTER_ID| cluster id |no|
+|JAMBONES_NETWORK_CIDR| CIDR of private network that feature server is running in (e.g. '172.31.0.0/16')|yes|
+|JAMBONES_REDIS_HOST| redis host|yes|
+|JAMBONES_REDIS_PORT|redis port|no|
+|JAMBONES_RTPENGINES| commas-separated list of ip:ng-port for rtpengines (e.g. '172.31.32.10:22222')|no|
+|JAMBONES_TIME_SERIES_HOST| influxdb host |yes|
+|JAMBONES_TIME_SERIES_PORT| influxdb port |no|
+|JAMBONES_RECORD_ALL_CALLS| enable auto record calls, 'yes' or 'no' |no|
+|K8S| service running as kubernetes service |no|
+|K8S_RTPENGINE_SERVICE_NAME| rtpengine service name(required for K8S) |no|
+|K8S_FEATURE_SERVER_SERVICE_NAME| feature server service name(required for K8S) |no|
+|JWT_SECRET| secret for signing JWT token |yes|
+|ENCRYPTION_SECRET| secret for credential encryption(JWT_SECRET is deprecated) |yes|
+
 ##### drachtio server location
 ```
 {

app.js

@@ -3,9 +3,16 @@ assert.ok(process.env.JAMBONES_MYSQL_HOST &&
   process.env.JAMBONES_MYSQL_USER &&
   process.env.JAMBONES_MYSQL_PASSWORD &&
   process.env.JAMBONES_MYSQL_DATABASE, 'missing JAMBONES_MYSQL_XXX env vars');
-assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env var');
+if (process.env.JAMBONES_REDIS_SENTINELS) {
+  assert.ok(process.env.JAMBONES_REDIS_SENTINEL_MASTER_NAME,
+    'missing JAMBONES_REDIS_SENTINEL_MASTER_NAME env var, JAMBONES_REDIS_SENTINEL_PASSWORD env var is optional');
+} else {
+  assert.ok(process.env.JAMBONES_REDIS_HOST, 'missing JAMBONES_REDIS_HOST env var');
+}
+assert.ok(process.env.DRACHTIO_PORT || process.env.DRACHTIO_HOST, 'missing DRACHTIO_PORT env vars');
 assert.ok(process.env.DRACHTIO_SECRET, 'missing DRACHTIO_SECRET env var');
-assert.ok(process.env.JAMBONES_RTPENGINES, 'missing DRACHTIO_SECRET env var');
+assert.ok(process.env.JAMBONES_TIME_SERIES_HOST, 'missing JAMBONES_TIME_SERIES_HOST env var');
+assert.ok(process.env.JAMBONES_NETWORK_CIDR || process.env.K8S, 'missing JAMBONES_NETWORK_CIDR env var');
 
 const Srf = require('drachtio-srf');
 const srf = new Srf('sbc-inbound');
@@ -13,46 +20,222 @@ const opts = Object.assign({
   timestamp: () => {return `, "time": "${new Date().toISOString()}"`;}
 }, {level: process.env.JAMBONES_LOGLEVEL || 'info'});
 const logger = require('pino')(opts);
-const StatsCollector = require('jambonz-stats-collector');
-const stats = srf.locals.stats = new StatsCollector(logger);
-srf.locals.getFeatureServer = require('./lib/fs-tracking')(srf, logger);
-const {getRtpEngine} = require('jambonz-rtpengine-utils')(process.env.JAMBONES_RTPENGINES.split(','), logger, {
-  emitter: srf.locals.stats
+const {
+  writeCallCount,
+  writeCallCountSP,
+  writeCallCountApp,
+  queryCdrs,
+  writeCdrs,
+  writeAlerts,
+  AlertType
+} = require('@jambonz/time-series')(logger, {
+  host: process.env.JAMBONES_TIME_SERIES_HOST,
+  port: process.env.JAMBONES_TIME_SERIES_PORT || 8086,
+  commitSize: 50,
+  commitInterval: 'test' === process.env.NODE_ENV ? 7 : 20
 });
-srf.locals.getRtpEngine = getRtpEngine;
-const activeCallIds = srf.locals.activeCallIds = new Map();
-logger.info('starting..');
+const StatsCollector = require('@jambonz/stats-collector');
+const CIDRMatcher = require('cidr-matcher');
+const stats = new StatsCollector(logger);
+const {equalsIgnoreOrder, createHealthCheckApp, systemHealth, parseHostPorts} = require('./lib/utils');
+const {LifeCycleEvents} = require('./lib/constants');
+const setNameRtp = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-rtp`;
+const rtpServers = [];
+const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-sip`;
 
 const {
+  pool,
+  ping,
   lookupAuthHook,
   lookupSipGatewayBySignalingAddress,
-  addSbcAddress
+  addSbcAddress,
+  lookupAccountByPhoneNumber,
+  lookupAppByTeamsTenant,
+  lookupAccountBySipRealm,
+  lookupAccountBySid,
+  lookupAccountCapacitiesBySid,
+  queryCallLimits,
+  lookupClientByAccountAndUsername,
+  lookupSystemInformation
 } = require('@jambonz/db-helpers')({
   host: process.env.JAMBONES_MYSQL_HOST,
+  port: process.env.JAMBONES_MYSQL_PORT || 3306,
   user: process.env.JAMBONES_MYSQL_USER,
   password: process.env.JAMBONES_MYSQL_PASSWORD,
   database: process.env.JAMBONES_MYSQL_DATABASE,
   connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
-}, logger);
+}, logger, process.env.JAMBONES_MYSQL_WRITE_HOST && process.env.JAMBONES_MYSQL_WRITE_USER &&
+  process.env.JAMBONES_MYSQL_WRITE_PASSWORD && process.env.JAMBONES_MYSQL_WRITE_DATABASE ? {
+    host: process.env.JAMBONES_MYSQL_WRITE_HOST,
+    port: process.env.JAMBONES_MYSQL_WRITE_PORT || 3306,
+    user: process.env.JAMBONES_MYSQL_WRITE_USER,
+    password: process.env.JAMBONES_MYSQL_WRITE_PASSWORD,
+    database: process.env.JAMBONES_MYSQL_WRITE_DATABASE,
+    connectionLimit: process.env.JAMBONES_MYSQL_CONNECTION_LIMIT || 10
+  } : null);
+const {
+  client: redisClient,
+  addKey,
+  deleteKey,
+  retrieveKey,
+  retrieveHash,
+  createSet,
+  retrieveSet,
+  addToSet,
+  removeFromSet,
+  incrKey,
+  decrKey,
+  createEphemeralGateway,
+  queryEphemeralGateways
+} = require('@jambonz/realtimedb-helpers')({}, logger);
 
-srf.locals.dbHelpers = {
-  lookupAuthHook,
-  lookupSipGatewayBySignalingAddress
+const ngProtocol = process.env.JAMBONES_NG_PROTOCOL || 'udp';
+const ngPort = process.env.RTPENGINE_PORT || ('udp' === ngProtocol ? 22222 : 8080);
+const {getRtpEngine, setRtpEngines} = require('@jambonz/rtpengine-utils')([], logger, {
+  //emitter: stats,
+  dtmfListenPort: process.env.DTMF_LISTEN_PORT || 22224,
+  protocol: ngProtocol
+});
+srf.locals = {...srf.locals,
+  stats,
+  writeCallCount,
+  writeCallCountSP,
+  writeCallCountApp,
+  queryCdrs,
+  writeCdrs,
+  writeAlerts,
+  AlertType,
+  activeCallIds: new Map(),
+  getRtpEngine,
+  privateNetworkCidr: process.env.PRIVATE_VOIP_NETWORK_CIDR || null,
+  dbHelpers: {
+    pool,
+    ping,
+    lookupAuthHook,
+    lookupSipGatewayBySignalingAddress,
+    lookupAccountByPhoneNumber,
+    lookupAppByTeamsTenant,
+    lookupAccountBySid,
+    lookupAccountBySipRealm,
+    lookupAccountCapacitiesBySid,
+    queryCallLimits,
+    lookupClientByAccountAndUsername,
+    lookupSystemInformation
+  },
+  realtimeDbHelpers: {
+    addKey,
+    deleteKey,
+    retrieveKey,
+    retrieveHash,
+    createSet,
+    incrKey,
+    decrKey,
+    retrieveSet,
+    createEphemeralGateway,
+    queryEphemeralGateways
+  }
 };
-const {challengeDeviceCalls, initLocals} = require('./lib/middleware')(srf, logger);
+const {
+  getSPForAccount,
+  wasOriginatedFromCarrier,
+  getApplicationForDidAndCarrier,
+  getOutboundGatewayForRefer,
+  getApplicationBySid,
+  lookupAuthCarriersForAccountAndSP
+} = require('./lib/db-utils')(srf, logger);
+srf.locals = {
+  ...srf.locals,
+  getSPForAccount,
+  wasOriginatedFromCarrier,
+  getApplicationForDidAndCarrier,
+  getOutboundGatewayForRefer,
+  getFeatureServer: require('./lib/fs-tracking')(srf, logger),
+  getApplicationBySid,
+  lookupAuthCarriersForAccountAndSP
+};
+const activeCallIds = srf.locals.activeCallIds;
+
+const {
+  initLocals,
+  handleSipRec,
+  identifyAccount,
+  checkLimits,
+  challengeDeviceCalls,
+  identifyAuthTrunk
+} = require('./lib/middleware')(srf, logger);
 const CallSession = require('./lib/call-session');
 
-if (process.env.DRACHTIO_HOST) {
+if (process.env.DRACHTIO_HOST && !process.env.K8S) {
+  const cidrs = process.env.JAMBONES_NETWORK_CIDR
+    .split(',')
+    .map((s) => s.trim());
+  const matcher = new CIDRMatcher(cidrs);
+
   srf.connect({host: process.env.DRACHTIO_HOST, port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET });
-  srf.on('connect', (err, hp) => {
-    const last = hp.split(',').pop();
-    const arr = /^(.*)\/(.*):(\d+)$/.exec(last);
-    logger.info(`connected to drachtio listening on ${hp}: adding ${arr[2]} to sbc_addresses table`);
-    addSbcAddress(arr[2]);
+  srf.on('connect', (err, hp, version, localHostports) => {
+    if (err) return this.logger.error({err}, 'Error connecting to drachtio server');
+    let addedPrivateIp = false;
+    logger.info(`connected to drachtio ${version} listening on ${hp}, local hostports: ${localHostports}`);
+
+    const hostports = hp.split(',');
+
+    if (localHostports) {
+      const locals = localHostports.split(',');
+      for (const hp of locals) {
+        const arr = /^(.*)\/(.*):(\d+)$/.exec(hp);
+        if (arr && 'tcp' === arr[1] && matcher.contains(arr[2])) {
+          const hostport = `${arr[2]}:${arr[3]}`;
+          logger.info(`adding sbc private address to redis: ${hostport}`);
+          srf.locals.privateSipAddress = hostport;
+          srf.locals.addToRedis = () => addToSet(setName, hostport);
+          srf.locals.removeFromRedis = () => removeFromSet(setName, hostport);
+          srf.locals.addToRedis();
+          addedPrivateIp = true;
+        }
+      }
+    }
+    for (const hp of hostports) {
+      const arr = /^(.*)\/(.*):(\d+)$/.exec(hp);
+      if (arr && 'udp' === arr[1] && !matcher.contains(arr[2])) {
+        logger.info(`adding sbc public address to database: ${arr[2]}`);
+        srf.locals.sipAddress = arr[2];
+        if (!process.env.SBC_ACCOUNT_SID) addSbcAddress(arr[2]);
+      }
+      else if (!addedPrivateIp && arr && 'tcp' === arr[1] && matcher.contains(arr[2])) {
+        const hostport = `${arr[2]}:${arr[3]}`;
+        logger.info(`adding sbc private address to redis: ${hostport}`);
+        srf.locals.privateSipAddress = hostport;
+        srf.locals.addToRedis = () => addToSet(setName, hostport);
+        srf.locals.removeFromRedis = () => removeFromSet(setName, hostport);
+        srf.locals.addToRedis();
+      }
+    }
+    srf.locals.sbcPublicIpAddress = parseHostPorts(logger, hostports, srf);
   });
 }
 else {
+  srf.on('listening', () => {
+    logger.info(`listening in outbound mode on port ${process.env.DRACHTIO_PORT}`);
+  });
   srf.listen({port: process.env.DRACHTIO_PORT, secret: process.env.DRACHTIO_SECRET});
+  srf.on('connect', (err, hp, version, localHostports) => {
+    if (err) return this.logger.error({err}, 'Error connecting to drachtio server');
+    logger.info(`connected to drachtio ${version} listening on ${hp}, local hostports: ${localHostports}`);
+
+    if (process.env.K8S_FEATURE_SERVER_TRANSPORT === 'tcp') {
+      const matcher = new CIDRMatcher(['192.168.0.0/24', '172.16.0.0/16', '10.0.0.0/8']);
+      const hostports = localHostports ? localHostports.split(',') : hp.split(',');
+      for (const hp of hostports) {
+        const arr = /^(.*)\/(.*):(\d+)$/.exec(hp);
+        if (arr && matcher.contains(arr[2])) {
+          const hostport = `${arr[2]}:${arr[3]}`;
+          logger.info(`using sbc private address when sending to feature-server: ${hostport}`);
+          srf.locals.privateSipAddress = hostport;
+        }
+      }
+    }
+    srf.locals.sbcPublicIpAddress = parseHostPorts(logger, hp, srf);
+  });
 }
 if (process.env.NODE_ENV === 'test') {
   srf.on('error', (err) => {
@@ -60,8 +243,16 @@ if (process.env.NODE_ENV === 'test') {
   });
 }
 
-// challenge calls from devices, let calls from sip gateways through
-srf.use('invite', [initLocals, challengeDeviceCalls]);
+/* install middleware */
+srf.use('invite', [
+  initLocals,
+  handleSipRec,
+  identifyAccount,
+  checkLimits,
+  challengeDeviceCalls,
+  // challengeDeviceCalls will detect auth_trunk or device calls, identifyAuthTrunk have to be after that
+  identifyAuthTrunk
+]);
 
 srf.invite((req, res) => {
   if (req.has('Replaces')) {
@@ -84,8 +275,133 @@ srf.use((req, res, next, err) => {
   res.send(500);
 });
 
-setInterval(() => {
-  stats.gauge('sbc.sip.calls.count', activeCallIds.size, ['direction:inbound']);
+if (process.env.K8S || process.env.HTTP_PORT) {
+  const PORT = process.env.HTTP_PORT || 3000;
+  const healthCheck = require('@jambonz/http-health-check');
+
+  const getCount = () => srf.locals.activeCallIds.size;
+
+  createHealthCheckApp(PORT, logger)
+    .then((app) => {
+      healthCheck({
+        app,
+        logger,
+        path: '/',
+        fn: getCount
+      });
+      healthCheck({
+        app,
+        logger,
+        path: '/system-health',
+        fn: systemHealth.bind(null, redisClient, ping, getCount)
+      });
+      return;
+    })
+    .catch((err) => {
+      logger.error({err}, 'Error creating health check server');
+    });
+}
+if ('test' !== process.env.NODE_ENV) {
+  /* update call stats periodically as well as definition of private network cidr */
+  setInterval(async() => {
+    stats.gauge('sbc.sip.calls.count', activeCallIds.size,
+      ['direction:inbound', `instance_id:${process.env.INSTANCE_ID || 0}`]);
+
+    const r = await lookupSystemInformation();
+    if (r) {
+      if (r.private_network_cidr !== srf.locals.privateNetworkCidr) {
+        logger.info(`updating private network cidr from ${srf.locals.privateNetworkCidr} to ${r.private_network_cidr}`);
+        srf.locals.privateNetworkCidr = r.private_network_cidr;
+      }
+      if (r.log_level) {
+        logger.level = r.log_level;
+      }
+    }
+  }, 20000);
+}
+
+const lookupRtpServiceEndpoints = (lookup, serviceName) => {
+  lookup(serviceName, {family: 4, all: true}, (err, addresses) => {
+    if (err) {
+      logger.error({err}, `Error looking up ${serviceName}`);
+      return;
+    }
+    logger.debug({addresses, rtpServers}, `dns lookup for ${serviceName} returned`);
+    const addrs = addresses.map((a) => a.address);
+    if (!equalsIgnoreOrder(addrs, rtpServers)) {
+      rtpServers.length = 0;
+      Array.prototype.push.apply(rtpServers, addrs);
+      logger.info({rtpServers}, 'rtpserver endpoints have been updated');
+      setRtpEngines(rtpServers.map((a) => `${a}:${ngPort}`));
+    }
+  });
+};
+
+if (process.env.K8S_RTPENGINE_SERVICE_NAME) {
+  /* poll dns for endpoints every so often */
+  const arr = /^(.*):(\d+)$/.exec(process.env.K8S_RTPENGINE_SERVICE_NAME);
+  const svc = arr[1];
+  logger.info(`rtpengine(s) will be found at dns name: ${svc}`);
+  const {lookup} = require('dns');
+  lookupRtpServiceEndpoints(lookup, svc);
+  setInterval(lookupRtpServiceEndpoints.bind(null, lookup, svc), process.env.RTPENGINE_DNS_POLL_INTERVAL || 10000);
+}
+else if (process.env.JAMBONES_RTPENGINES) {
+  /* static list of rtpengines */
+  setRtpEngines([process.env.JAMBONES_RTPENGINES]);
+}
+else {
+  /* poll redis periodically for rtpengines that have registered via OPTIONS ping */
+  const getActiveRtpServers = async() => {
+    try {
+      const set = await retrieveSet(setNameRtp);
+      const newArray = Array.from(set);
+      logger.debug({newArray, rtpServers}, 'getActiveRtpServers');
+      if (!equalsIgnoreOrder(newArray, rtpServers)) {
+        logger.info({newArray}, 'resetting active rtpengines');
+        setRtpEngines(newArray.map((a) => `${a}:${ngPort}`));
+        rtpServers.length = 0;
+        Array.prototype.push.apply(rtpServers, newArray);
+      }
+    } catch (err) {
+      logger.error({err}, 'Error setting new rtpengines');
+    }
+  };
+  setInterval(() => {
+    getActiveRtpServers();
+  }, 30000);
+  getActiveRtpServers();
+
+}
+
+const {lifecycleEmitter} = require('./lib/autoscale-manager')(logger);
+
+/* if we are scaling in, check every so often if call count has gone to zero */
+setInterval(async() => {
+  if (lifecycleEmitter.operationalState === LifeCycleEvents.ScaleIn) {
+    if (0 === activeCallIds.size) {
+      logger.info('scale-in complete now that calls have dried up');
+      lifecycleEmitter.scaleIn();
+    }
+  }
 }, 20000);
 
+process.on('SIGUSR2', handle.bind(null, removeFromSet, setName));
+process.on('SIGTERM', handle.bind(null, removeFromSet, setName));
+
+function handle(removeFromSet, setName, signal) {
+  logger.info(`got signal ${signal}`);
+  if (srf.locals.privateSipAddress && setName) {
+    logger.info(`removing ${srf.locals.privateSipAddress} from set ${setName}`);
+    removeFromSet(setName, srf.locals.privateSipAddress);
+  }
+  if (process.env.K8S) {
+    lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
+    if (0 === activeCallIds.size) {
+      logger.info('exiting immediately since we have no calls in progress');
+      process.exit(0);
+    }
+  }
+}
+
 module.exports = {srf, logger};

bin/k8s-pre-stop-hook.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+const bent = require('bent');
+const getJSON = bent('json');
+const PORT = process.env.HTTP_PORT || 3000;
+
+const sleep = (ms) => {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+};
+
+(async function() {
+
+  try {
+    do {
+      const obj = await getJSON(`http://127.0.0.1:${PORT}/`);
+      const {calls} = obj;
+      if (calls === 0) {
+        console.log('no calls on the system, we can exit');
+        process.exit(0);
+      }
+      else {
+        console.log(`waiting for ${calls} to exit..`);
+      }
+      await sleep(10000);
+    } while (1);
+  } catch (err) {
+    console.error(err, 'Error querying health endpoint');
+    process.exit(-1);
+  }
+})();

data/rtp-transcoding.json

@@ -3,6 +3,6 @@
   "DTLS": "off",
   "SDES": "off",
   "ICE": "remove",
-  "flags": ["media handover"],
+  "flags": ["port latching"],
   "rtcp-mux": ["accept"]
 }

data/srtp-transcoding.json

@@ -1,16 +1,16 @@
 {
   "default": {
     "transport-protocol": "UDP/TLS/RTP/SAVPF",
-    "ICE": "force",
+    "ICE": "default",
     "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover"],
+    "flags": ["generate mid", "SDES-no", "port latching"],
     "rtcp-mux": ["require"]  
   },
   "teams": {
     "transport-protocol": "RTP/SAVP",
-    "ICE": "force",
+    "ICE": "default",
     "SDES": "off",
-    "flags": ["generate mid", "SDES-no", "media handover"],
+    "flags": ["generate mid", "SDES-no", "port latching"],
     "rtcp-mux": ["accept"]
   }
 }

eslint.config.js

@@ -0,0 +1,137 @@
+const promisePlugin = require('eslint-plugin-promise');
+
+module.exports = [
+  {
+    ignores: ['test/*']
+  },
+  {
+    files: ['**/*.js'],
+    languageOptions: {
+      ecmaVersion: 2020,
+      sourceType: 'commonjs',
+      globals: {
+        // Node.js globals
+        console: 'readonly',
+        process: 'readonly',
+        Buffer: 'readonly',
+        __dirname: 'readonly',
+        __filename: 'readonly',
+        module: 'readonly',
+        require: 'readonly',
+        exports: 'readonly',
+        setTimeout: 'readonly',
+        clearTimeout: 'readonly',
+        setInterval: 'readonly',
+        clearInterval: 'readonly',
+        setImmediate: 'readonly',
+        clearImmediate: 'readonly',
+        // DTrace/LTTNG globals
+        DTRACE_HTTP_CLIENT_REQUEST: false,
+        LTTNG_HTTP_CLIENT_REQUEST: false,
+        COUNTER_HTTP_CLIENT_REQUEST: false,
+        DTRACE_HTTP_CLIENT_RESPONSE: false,
+        LTTNG_HTTP_CLIENT_RESPONSE: false,
+        COUNTER_HTTP_CLIENT_RESPONSE: false,
+        DTRACE_HTTP_SERVER_REQUEST: false,
+        LTTNG_HTTP_SERVER_REQUEST: false,
+        COUNTER_HTTP_SERVER_REQUEST: false,
+        DTRACE_HTTP_SERVER_RESPONSE: false,
+        LTTNG_HTTP_SERVER_RESPONSE: false,
+        COUNTER_HTTP_SERVER_RESPONSE: false,
+        DTRACE_NET_STREAM_END: false,
+        LTTNG_NET_STREAM_END: false,
+        COUNTER_NET_SERVER_CONNECTION_CLOSE: false,
+        DTRACE_NET_SERVER_CONNECTION: false,
+        LTTNG_NET_SERVER_CONNECTION: false,
+        COUNTER_NET_SERVER_CONNECTION: false
+      }
+    },
+    plugins: {
+      promise: promisePlugin
+    },
+    rules: {
+      // Promise plugin rules
+      'promise/always-return': 'error',
+      'promise/no-return-wrap': 'error',
+      'promise/param-names': 'error',
+      'promise/catch-or-return': 'error',
+      'promise/no-native': 'off',
+      'promise/no-nesting': 'warn',
+      'promise/no-promise-in-callback': 'warn',
+      'promise/no-callback-in-promise': 'warn',
+      'promise/no-return-in-finally': 'warn',
+
+      // Possible Errors
+      'comma-dangle': [2, 'only-multiline'],
+      'no-control-regex': 2,
+      'no-debugger': 2,
+      'no-dupe-args': 2,
+      'no-dupe-keys': 2,
+      'no-duplicate-case': 2,
+      'no-empty-character-class': 2,
+      'no-ex-assign': 2,
+      'no-extra-boolean-cast': 2,
+      'no-extra-parens': [2, 'functions'],
+      'no-extra-semi': 2,
+      'no-func-assign': 2,
+      'no-invalid-regexp': 2,
+      'no-irregular-whitespace': 2,
+      'no-obj-calls': 2,
+      'no-proto': 2,
+      'no-unexpected-multiline': 2,
+      'no-unreachable': 2,
+      'use-isnan': 2,
+      'valid-typeof': 2,
+
+      // Best Practices
+      'no-fallthrough': 2,
+      'no-octal': 2,
+      'no-redeclare': 2,
+      'no-self-assign': 2,
+      'no-unused-labels': 2,
+
+      // Strict Mode
+      'strict': [2, 'never'],
+
+      // Variables
+      'no-delete-var': 2,
+      'no-undef': 2,
+      'no-unused-vars': [2, {args: 'none'}],
+
+      // Node.js and CommonJS
+      'no-mixed-requires': 2,
+      'no-new-require': 2,
+      'no-path-concat': 2,
+
+      // Stylistic Issues
+      'comma-spacing': 2,
+      'eol-last': 2,
+      'indent': [2, 2, {SwitchCase: 1}],
+      'keyword-spacing': 2,
+      'max-len': [2, 120, 2],
+      'new-parens': 2,
+      'no-mixed-spaces-and-tabs': 2,
+      'no-multiple-empty-lines': [2, {max: 2}],
+      'no-trailing-spaces': [2, {skipBlankLines: false}],
+      'quotes': [2, 'single', 'avoid-escape'],
+      'semi': 2,
+      'space-before-blocks': [2, 'always'],
+      'space-before-function-paren': [2, 'never'],
+      'space-in-parens': [2, 'never'],
+      'space-infix-ops': 2,
+      'space-unary-ops': 2,
+
+      // ECMAScript 6
+      'arrow-parens': [2, 'always'],
+      'arrow-spacing': [2, {before: true, after: true}],
+      'constructor-super': 2,
+      'no-class-assign': 2,
+      'no-confusing-arrow': 2,
+      'no-const-assign': 2,
+      'no-dupe-class-members': 2,
+      'no-new-symbol': 2,
+      'no-this-before-super': 2,
+      'prefer-const': 2
+    }
+  }
+];

lib/autoscale-manager.js

@@ -0,0 +1,66 @@
+const noopLogger = {info: () => {}, error: () => {}};
+const {LifeCycleEvents} = require('./constants');
+const Emitter = require('events');
+
+module.exports = (logger) => {
+  logger = logger || noopLogger;
+
+  // listen for SNS lifecycle changes
+  let lifecycleEmitter = new Emitter();
+  lifecycleEmitter.dryUpCalls = false;
+  if (process.env.AWS_SNS_TOPIC_ARN) {
+
+    (async function() {
+      try {
+        lifecycleEmitter = await require('./aws-sns-lifecycle')(logger);
+
+        lifecycleEmitter
+          .on(LifeCycleEvents.ScaleIn, async() => {
+            logger.info('AWS scale-in notification: begin drying up calls');
+            lifecycleEmitter.dryUpCalls = true;
+            lifecycleEmitter.operationalState = LifeCycleEvents.ScaleIn;
+
+            const {srf} = require('..');
+            const {activeCallIds, removeFromRedis} = srf.locals;
+
+            /* remove our private IP from the set of active SBCs so rtp and fs know we are gone */
+            removeFromRedis();
+
+            /* if we have zero calls, we can complete the scale-in right now */
+            const calls = activeCallIds.size;
+            if (0 === calls) {
+              logger.info('scale-in can complete immediately as we have no calls in progress');
+              lifecycleEmitter.completeScaleIn();
+            }
+            else {
+              logger.info(`${calls} calls in progress; scale-in will complete when they are done`);
+            }
+          })
+          .on(LifeCycleEvents.StandbyEnter, () => {
+            lifecycleEmitter.dryUpCalls = true;
+            const {srf} = require('..');
+            const {removeFromRedis} = srf.locals;
+            removeFromRedis();
+
+            logger.info('AWS enter pending state notification: begin drying up calls');
+          })
+          .on(LifeCycleEvents.StandbyExit, () => {
+            lifecycleEmitter.dryUpCalls = false;
+            const {srf} = require('..');
+            const {addToRedis} = srf.locals;
+            addToRedis();
+
+            logger.info('AWS exit pending state notification: re-enable calls');
+          });
+      } catch (err) {
+        logger.error({err}, 'Failure creating SNS notifier, lifecycle events will be disabled');
+      }
+    })();
+  }
+  else if (process.env.K8S) {
+    lifecycleEmitter.scaleIn = () => process.exit(0);
+  }
+
+  return {lifecycleEmitter};
+};
+

lib/aws-sns-lifecycle.js

@@ -0,0 +1,228 @@
+const Emitter = require('events');
+const bent = require('bent');
+const assert = require('assert');
+const PORT = process.env.AWS_SNS_PORT || 3010;
+const {LifeCycleEvents} = require('./constants');
+const express = require('express');
+const app = express();
+const getString = bent('string');
+const {
+  SNSClient,
+  SubscribeCommand,
+  UnsubscribeCommand } = require('@aws-sdk/client-sns');
+const snsClient = new SNSClient({ region: process.env.AWS_REGION, apiVersion: '2010-03-31' });
+const {
+  AutoScalingClient,
+  DescribeAutoScalingGroupsCommand,
+  CompleteLifecycleActionCommand } = require('@aws-sdk/client-auto-scaling');
+const autoScalingClient = new AutoScalingClient({ region: process.env.AWS_REGION, apiVersion: '2011-01-01' });
+const {Parser} = require('xml2js');
+const parser = new Parser();
+const {validatePayload} = require('verify-aws-sns-signature');
+
+class SnsNotifier extends Emitter {
+  constructor(logger) {
+    super();
+
+    this.logger = logger;
+  }
+  _doListen(logger, app, port, resolve) {
+    return app.listen(port, () => {
+      this.snsEndpoint = `http://${this.publicIp}:${port}`;
+      logger.info(`SNS lifecycle server listening on http://localhost:${port}`);
+      resolve(app);
+    });
+  }
+
+  _handleErrors(logger, app, resolve, reject, e) {
+    if (e.code === 'EADDRINUSE' &&
+      process.env.AWS_SNS_PORT_MAX &&
+      e.port < process.env.AWS_SNS_PORT_MAX) {
+
+      logger.info(`SNS lifecycle server failed to bind port on ${e.port}, will try next port`);
+      const server = this._doListen(logger, app, ++e.port, resolve);
+      server.on('error', this._handleErrors.bind(this, logger, app, resolve, reject));
+      return;
+    }
+    reject(e);
+  }
+
+  async _handlePost(req, res) {
+    try {
+      const parsedBody = JSON.parse(req.body);
+      this.logger.debug({headers: req.headers, body: parsedBody}, 'Received HTTP POST from AWS');
+      if (!validatePayload(parsedBody)) {
+        this.logger.info('incoming AWS SNS HTTP POST failed signature validation');
+        return res.sendStatus(403);
+      }
+      this.logger.debug('incoming HTTP POST passed validation');
+      res.sendStatus(200);
+
+      switch (parsedBody.Type) {
+        case 'SubscriptionConfirmation':
+          const response = await getString(parsedBody.SubscribeURL);
+          const result = await parser.parseStringPromise(response);
+          this.subscriptionArn = result.ConfirmSubscriptionResponse.ConfirmSubscriptionResult[0].SubscriptionArn[0];
+          this.subscriptionRequestId = result.ConfirmSubscriptionResponse.ResponseMetadata[0].RequestId[0];
+          this.logger.info({
+            subscriptionArn: this.subscriptionArn,
+            subscriptionRequestId: this.subscriptionRequestId
+          }, 'response from SNS SubscribeURL');
+          const data = await this.describeInstance();
+
+          const group = data.AutoScalingGroups.find((group) =>
+            group.Instances && group.Instances.some((instance) => instance.InstanceId === this.instanceId)
+          );
+          if (!group) {
+            this.logger.error('Current instance not found in any Auto Scaling group', data);
+          } else {
+            const instance = group.Instances.find((instance) => instance.InstanceId === this.instanceId);
+            this.lifecycleState = instance.LifecycleState;
+          }
+
+          this.emit('SubscriptionConfirmation', {publicIp: this.publicIp});
+          break;
+
+        case 'Notification':
+          if (parsedBody.Subject.startsWith('Auto Scaling:  Lifecycle action \'TERMINATING\'')) {
+            const msg = JSON.parse(parsedBody.Message);
+            if (msg.EC2InstanceId === this.instanceId) {
+              this.logger.info('SnsNotifier - begin scale-in operation');
+              this.scaleInParams = {
+                AutoScalingGroupName: msg.AutoScalingGroupName,
+                LifecycleActionResult: 'CONTINUE',
+                LifecycleActionToken: msg.LifecycleActionToken,
+                LifecycleHookName: msg.LifecycleHookName
+              };
+              this.operationalState = LifeCycleEvents.ScaleIn;
+              this.emit(LifeCycleEvents.ScaleIn);
+              this.unsubscribe();
+            }
+            else {
+              this.logger.debug(`SnsNotifier - instance ${msg.EC2InstanceId} is scaling in (not us)`);
+            }
+          }
+          break;
+
+        default:
+          this.logger.info(`unhandled SNS Post Type: ${parsedBody.Type}`);
+      }
+
+    } catch (err) {
+      this.logger.error({err}, 'Error processing SNS POST request');
+      if (!res.headersSent) res.sendStatus(500);
+    }
+  }
+
+  async init() {
+    try {
+      this.logger.debug('SnsNotifier: retrieving instance data');
+      this.instanceId = await getString('http://169.254.169.254/latest/meta-data/instance-id');
+      this.publicIp = await getString('http://169.254.169.254/latest/meta-data/public-ipv4');
+      this.logger.info({
+        instanceId: this.instanceId,
+        publicIp: this.publicIp
+      }, 'retrieved AWS instance data');
+
+      // start listening
+      app.use(express.urlencoded({ extended: true }));
+      app.use(express.json());
+      app.use(express.text());
+      app.post('/', this._handlePost.bind(this));
+      app.use((err, req, res, next) => {
+        this.logger.error(err, 'burped error');
+        res.status(err.status || 500).json({msg: err.message});
+      });
+      return new Promise((resolve, reject) => {
+        const server = this._doListen(this.logger, app, PORT, resolve);
+        server.on('error', this._handleErrors.bind(this, this.logger, app, resolve, reject));
+      });
+
+    } catch (err) {
+      this.logger.error({err}, 'Error retrieving AWS instance metadata');
+    }
+  }
+
+  async subscribe() {
+    try {
+      const params = {
+        Protocol: 'http',
+        TopicArn: process.env.AWS_SNS_TOPIC_ARN,
+        Endpoint: this.snsEndpoint
+      };
+      const response = await snsClient.send(new SubscribeCommand(params));
+      this.logger.info({response}, `response to SNS subscribe to ${process.env.AWS_SNS_TOPIC_ARN}`);
+    } catch (err) {
+      this.logger.error({err}, `Error subscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARN}`);
+    }
+  }
+
+  async unsubscribe() {
+    if (!this.subscriptionArn) throw new Error('SnsNotifier#unsubscribe called without an active subscription');
+    try {
+      const params = {
+        SubscriptionArn: this.subscriptionArn
+      };
+      const response = await snsClient.send(new UnsubscribeCommand(params));
+      this.logger.info({response}, `response to SNS unsubscribe to ${process.env.AWS_SNS_TOPIC_ARN}`);
+    } catch (err) {
+      this.logger.error({err}, `Error unsubscribing to SNS topic arn ${process.env.AWS_SNS_TOPIC_ARN}`);
+    }
+  }
+
+  completeScaleIn() {
+    assert(this.scaleInParams);
+    autoScalingClient.send(new CompleteLifecycleActionCommand(this.scaleInParams))
+      .then((data) => {
+        return this.logger.info({data}, 'Successfully completed scale-in action');
+      })
+      .catch((err) => {
+        this.logger.error({err}, 'Error completing scale-in');
+      });
+  }
+
+  describeInstance() {
+    return new Promise((resolve, reject) => {
+      if (!this.instanceId) return reject('instance-id unknown');
+      autoScalingClient.send(new DescribeAutoScalingGroupsCommand({
+        InstanceIds: [this.instanceId]
+      }))
+        .then((data) => {
+          this.logger.info({data}, 'SnsNotifier: describeInstance');
+          return resolve(data);
+        })
+        .catch((err) => {
+          this.logger.error({err}, 'Error describing instances');
+          reject(err);
+        });
+    });
+  }
+
+}
+
+module.exports = async function(logger) {
+  const notifier = new SnsNotifier(logger);
+  await notifier.init();
+  await notifier.subscribe();
+
+  process.on('SIGHUP', async() => {
+    try {
+      const data = await notifier.describeInstance();
+      const state = data.AutoScalingGroups[0].Instances[0].LifecycleState;
+      if (state !== notifier.lifecycleState) {
+        notifier.lifecycleState = state;
+        switch (state) {
+          case 'Standby':
+            notifier.emit(LifeCycleEvents.StandbyEnter);
+            break;
+          case 'InService':
+            notifier.emit(LifeCycleEvents.StandbyExit);
+            break;
+        }
+      }
+    } catch (err) {
+      console.error(err);
+    }
+  });
+  return notifier;
+};

lib/constants.json

@@ -0,0 +1,12 @@
+{
+  "LifeCycleEvents" : {
+    "ScaleIn": "scale-in",
+    "StandbyEnter": "standby-enter",
+    "StandbyExit": "standby-exit"
+  },
+  "MediaPath": {
+    "NoMedia": "no-media",
+    "PartialMedia": "partial-media",
+    "FullMedia": "full-media"
+  }
+}

lib/db-utils.js

@@ -0,0 +1,657 @@
+const assert = require('assert');
+const CIDRMatcher = require('cidr-matcher');
+const {parseUri} = require('drachtio-srf');
+const {normalizeDID} = require('./utils');
+
+const sqlSelectSPForAccount = 'SELECT service_provider_sid FROM accounts WHERE account_sid = ?';
+
+const sqlSelectAllCarriersForAccountByRealm =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto,
+vc.register_username, vc.register_password
+FROM sip_gateways sg, voip_carriers vc, accounts acc 
+WHERE acc.sip_realm = ? 
+AND vc.account_sid = acc.account_sid 
+AND vc.is_active = 1 
+AND sg.inbound = 1 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid`;
+
+const sqlSelectAllCarriersForSPByRealm =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.account_sid,  
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto,
+vc.register_username, vc.register_password
+FROM sip_gateways sg, voip_carriers vc, accounts acc 
+WHERE acc.sip_realm = ? 
+AND vc.service_provider_sid = acc.service_provider_sid  
+AND vc.account_sid IS NULL 
+AND vc.is_active = 1 
+AND sg.inbound = 1 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid`;
+
+const sqlSelectExactGatewayForSP =
+`SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid,
+vc.account_sid, vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto,
+vc.register_username, vc.register_password
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid = vc.voip_carrier_sid
+AND vc.service_provider_sid IS NOT NULL
+AND vc.is_active = 1
+AND sg.inbound = 1
+AND sg.netmask = 32
+AND sg.ipv4 = ?
+ORDER BY vc.account_sid IS NOT NULL DESC`;
+
+const sqlSelectCIDRGatewaysForSP =
+`SELECT STRAIGHT_JOIN sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid,
+vc.account_sid, vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto,
+vc.register_username, vc.register_password
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid = vc.voip_carrier_sid
+AND vc.service_provider_sid IS NOT NULL
+AND vc.is_active = 1
+AND sg.inbound = 1
+AND sg.netmask < 32
+ORDER BY sg.netmask DESC`;
+
+const sqlAccountByRealm = 'SELECT * from accounts WHERE sip_realm = ? AND is_active = 1';
+const sqlAccountBySid = 'SELECT * from accounts WHERE account_sid = ?';
+const sqlApplicationBySid = 'SELECT * from applications WHERE application_sid = ?';
+
+const sqlQueryApplicationByDid = `
+SELECT * FROM phone_numbers 
+WHERE number = ? 
+AND voip_carrier_sid = ?`;
+
+const sqlQueryAllDidsForCarrier = `
+SELECT * FROM phone_numbers 
+WHERE voip_carrier_sid = ?`;
+
+const sqlSelectOutboundGatewayForCarrier = `
+SELECT ipv4, port, e164_leading_plus  
+FROM sip_gateways sg, voip_carriers vc 
+WHERE sg.voip_carrier_sid = ? 
+AND sg.voip_carrier_sid = vc.voip_carrier_sid 
+AND outbound = 1`;
+
+const sqlSelectCarrierRequiringRegistration = `
+SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid, vc.account_sid,
+vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto,
+vc.register_username, vc.register_password
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid = vc.voip_carrier_sid
+AND vc.requires_register = 1
+AND vc.is_active = 1
+AND vc.register_sip_realm = ?
+AND vc.register_username = ?`;
+
+const sqlSelectAuthCarriersForAccountAndSP = `
+SELECT * FROM voip_carriers 
+WHERE trunk_type = 'auth' 
+AND is_active = 1 
+AND (
+  (account_sid = ?) 
+  OR 
+  (service_provider_sid = ? AND account_sid IS NULL)
+)`;
+
+const sqlSelectGatewaysByVoipCarrierSids = `
+SELECT sg.sip_gateway_sid, sg.voip_carrier_sid, vc.name, vc.service_provider_sid,
+vc.account_sid, vc.application_sid, sg.inbound, sg.outbound, sg.is_active, sg.ipv4, sg.netmask, sg.pad_crypto,
+vc.register_username, vc.register_password
+FROM sip_gateways sg, voip_carriers vc
+WHERE sg.voip_carrier_sid IN (?)
+AND sg.voip_carrier_sid = vc.voip_carrier_sid
+AND vc.is_active = 1`;
+
+const gatewayMatchesSourceAddress = (logger, source_address, gw) => {
+  if (32 === gw.netmask && gw.ipv4 === source_address) return true;
+  if (gw.netmask < 32) {
+    try {
+      const matcher = new CIDRMatcher([`${gw.ipv4}/${gw.netmask}`]);
+      return matcher.contains(source_address);
+    } catch (err) {
+      logger.info({err, gw}, 'gatewayMatchesSourceAddress: Error parsing netmask');
+    }
+  }
+  return false;
+};
+
+module.exports = (srf, logger) => {
+  const {pool}  = srf.locals.dbHelpers;
+  const {queryEphemeralGateways} = srf.locals.realtimeDbHelpers;
+  const pp = pool.promise();
+
+  const getApplicationBySid = async(application_sid) => {
+    const [r] = await pp.query(sqlApplicationBySid, [application_sid]);
+    if (0 === r.length) return null;
+    return r[0];
+  };
+
+  const getSPForAccount = async(account_sid) => {
+    const [r] = await pp.query(sqlSelectSPForAccount, [account_sid]);
+    if (0 === r.length) return null;
+    return r[0].service_provider_sid;
+  };
+
+  const getOutboundGatewayForRefer = async(voip_carrier_sid) => {
+    try {
+      const [r] = await pp.query(sqlSelectOutboundGatewayForCarrier, [voip_carrier_sid]);
+      if (0 === r.length) return null;
+
+      /* if multiple, prefer a DNS name */
+      const hasDns = r.find((row) => row.ipv4.match(/^[A-Za-z]/));
+      return hasDns /* || r[0] */;
+    } catch (err) {
+      logger.error({err}, 'getOutboundGatewayForRefer');
+    }
+  };
+
+  /**
+   * Retrieves the application for a given DID (phone number) and carrier combination.
+   * First attempts an exact DID match, then falls back to pattern/wildcard matching
+   * if no exact match is found. Pattern matching is done in order of pattern length
+   * (longest/most specific first) and handles both regex and wildcard (*) patterns.
+   *
+   * @param {Object} req - The request object containing the called number
+   * @param {string} voip_carrier_sid - The SID of the VoIP carrier
+   * @returns {Promise<(string|Object|null)>} Returns either:
+   *   - application_sid (string) if appObject is false
+   *   - full application object if appObject is true
+   *   - null if no matching application is found
+   * @throws {Error} Database errors or other unexpected errors
+   */
+  // Refactored to handle invalid regular expressions gracefully as part of
+  // https://github.com/jambonz/sbc-inbound/issues/201
+  const getApplicationForDidAndCarrier = async(req, voip_carrier_sid) => {
+    const did = normalizeDID(req.calledNumber) || 'anonymous';
+
+    try {
+      /* straight DID match */
+      const [r] = await pp.query(sqlQueryApplicationByDid, [did, voip_carrier_sid]);
+      if (r.length) return r[0].application_sid;
+
+      /* wildcard / regex match */
+      const [r2] = await pp.query(sqlQueryAllDidsForCarrier, [voip_carrier_sid]);
+      const patterns = r2
+        .filter((o) => o.number.match(/\D/))                  // look at anything with non-digit characters
+        .sort((a, b) => b.number.length - a.number.length);
+      for (const pattern of patterns) {
+        try {
+          const regexPattern = pattern.number.endsWith('*') ?
+            `${pattern.number.slice(0, -1)}\\d*` :
+            pattern.number;
+          if (did.match(new RegExp(regexPattern))) {
+            logger.debug({voip_carrier_sid, 'pattern':pattern.number, 'did':did}, 'Found a matching pattern');
+            return pattern.application_sid;
+          }
+        } catch (err) {
+          logger.warn({err, voip_carrier_sid, pattern: pattern.number}, 'Invalid regex pattern encountered - skipping');
+          continue;
+        }
+      }
+      logger.debug({voip_carrier_sid, did}, 'No matching pattern found');
+      return null;
+    } catch (err) {
+      logger.error({err}, 'getApplicationForDidAndCarrier');
+    }
+  };
+
+  /**
+   * Searches for a matching application across multiple carriers using pattern/wildcard matching.
+   * This function is similar to getApplicationForDidAndCarrier but operates on multiple carriers
+   * simultaneously for better performance. It searches through all patterns from the specified
+   * carriers, ordered by pattern length (longest/most specific first).
+   *
+   * @param {Object} req - The request object containing the called number
+   * @param {string} voip_carrier_sids - Comma-separated string of carrier SIDs, formatted for SQL IN clause
+   *                                     (e.g., "'carrier1','carrier2'")
+   * @returns {Promise<Object|null>} Returns either:
+   *   - The matching phone_numbers record containing application_sid, voip_carrier_sid, and account_sid
+   *   - null if no matching pattern is found
+   * @throws {Error} Database errors or other unexpected errors
+   */
+  const getApplicationForDidAndCarriers = async(req, voip_carrier_sids) => {
+    const did = normalizeDID(req.calledNumber) || 'anonymous';
+    const sql = `SELECT * FROM phone_numbers WHERE voip_carrier_sid IN (${voip_carrier_sids})`;
+
+    try {
+      /* wildcard / regex match */
+      const [r2] = await pp.query(sql);
+      const patterns = r2
+        .filter((o) => o.number.match(/\D/))                  // look at anything with non-digit characters
+        .sort((a, b) => b.number.length - a.number.length);
+      for (const pattern of patterns) {
+        try {
+          const regexPattern = pattern.number.endsWith('*') ?
+            `${pattern.number.slice(0, -1)}\\d*` :
+            pattern.number;
+          if (did.match(new RegExp(regexPattern))) {
+            logger.debug({'pattern':pattern.number, 'did':did}, 'Found a matching pattern');
+            return pattern;
+          }
+        } catch (err) {
+          logger.warn({err, pattern: pattern.number}, 'Invalid regex pattern encountered - skipping');
+          continue;
+        }
+      }
+      logger.debug('No matching pattern found');
+      return null;
+    } catch (err) {
+      logger.error({err}, 'getApplicationForDidAndCarriers');
+    }
+  };
+
+  /**
+   * Queries ephemeral gateways in Redis for the given source IP address.
+   * Returns an array of active voip_carrier_sid values.
+   *
+   * @param {string} source_address - The source IP address to query
+   * @returns {Promise<Array<string>>} Array of voip_carrier_sid values, or empty array on error
+   */
+  const lookupEphemeralGatewayCarriers = async(source_address) => {
+    try {
+      logger.debug({source_address}, 'querying ephemeral gateways');
+      const carriers = await queryEphemeralGateways(source_address);
+      if (carriers.length > 0) {
+        logger.info({source_address, count: carriers.length, carriers},
+          'found ephemeral gateway carriers');
+      }
+      return carriers;
+    } catch (err) {
+      logger.error({err, source_address}, 'Error querying ephemeral gateways');
+      return [];
+    }
+  };
+
+  /**
+   * Retrieves full gateway details (with carrier info) for the given voip_carrier_sid array.
+   * Returns gateway records (joined with carrier data) matching the structure of other gateway queries.
+   *
+   * @param {Array<string>} voipCarrierSids - Array of voip_carrier_sid values
+   * @returns {Promise<Array<Object>>} Array of gateway objects (with carrier fields included)
+   */
+  const lookupGatewaysByCarrierSids = async(voipCarrierSids) => {
+    if (!voipCarrierSids || voipCarrierSids.length === 0) return [];
+
+    try {
+      const [r] = await pp.query(sqlSelectGatewaysByVoipCarrierSids, [voipCarrierSids]);
+      logger.debug({count: r.length, voipCarrierSids}, 'retrieved gateway details for ephemeral gateways');
+      return r;
+    } catch (err) {
+      logger.error({err, voipCarrierSids}, 'Error retrieving gateway details by carrier IDs');
+      return [];
+    }
+  };
+
+  const wasOriginatedFromCarrier = async(req) => {
+    const failure = {fromCarrier: false};
+    const uri = parseUri(req.uri);
+    const isDotDecimal = /^(?:[0-9]{1,3}\.){3}[0-9]{1,3}$/.test(uri.host);
+    const did = normalizeDID(req.calledNumber) || 'anonymous';
+    if (!isDotDecimal) {
+      /**
+       * The host part of the SIP URI is not a dot-decimal IP address,
+       * so this can be one of two things:
+       * (1) a sip realm value associate with an account, or
+       * (2) a carrier name for a carrier that we send outbound registrations to
+       *
+       * Let's look for case #1 first...
+       */
+
+      /* does anyone own this sip realm? */
+      const [a] = await pp.query(sqlAccountByRealm, [uri.host]);
+      if (a.length) {
+        assert(a.length === 1);
+
+        /* yes they do */
+        logger.debug(`sip realm is associated with account_sid: ${a[0].account_sid}`);
+
+        /**
+         * We have one of two cases:
+         * (1a). The user configured his or her carrier to send to their sip realm, or
+         * (1b). The user is making a call from a sip device.
+         */
+
+        /* get all the carriers and gateways for the account owning this sip realm */
+        const [gwAcc] = await pp.query(sqlSelectAllCarriersForAccountByRealm, [uri.host]);
+        const [gwSP] = await pp.query(sqlSelectAllCarriersForSPByRealm, uri.host);
+        const gw = gwAcc
+          .concat(gwSP)
+          .sort((a, b) => b.netmask - a.netmask);
+        const gateways = gw.filter(gatewayMatchesSourceAddress.bind(null, logger, req.source_address));
+        let voip_carriers = gateways.map((gw) => {
+          return {
+            voip_carrier_sid: gw.voip_carrier_sid,
+            name: gw.name,
+            service_provider_sid: gw.service_provider_sid,
+            account_sid: gw.account_sid,
+            application_sid: gw.application_sid,
+            register_username: gw.register_username,
+            register_password: gw.register_password
+          };
+        });
+        /* remove duplicates, winnow down to voip_carriers, not gateways */
+        if (voip_carriers.length > 1) {
+          voip_carriers = [...new Set(voip_carriers.map(JSON.stringify))].map(JSON.parse);
+        }
+
+        /* if no static gateway matches, check ephemeral gateways in Redis */
+        if (voip_carriers.length === 0 && gateways.length === 0) {
+          const ephemeralCarrierSids = await lookupEphemeralGatewayCarriers(req.source_address);
+          if (ephemeralCarrierSids.length > 0) {
+            const ephemeralGateways = await lookupGatewaysByCarrierSids(ephemeralCarrierSids);
+            gateways.push(...ephemeralGateways);
+            voip_carriers = ephemeralGateways.map((gw) => {
+              return {
+                voip_carrier_sid: gw.voip_carrier_sid,
+                name: gw.name,
+                service_provider_sid: gw.service_provider_sid,
+                account_sid: gw.account_sid,
+                application_sid: gw.application_sid,
+                register_username: gw.register_username,
+                register_password: gw.register_password
+              };
+            });
+            /* remove duplicates */
+            if (voip_carriers.length > 1) {
+              voip_carriers = [...new Set(voip_carriers.map(JSON.stringify))].map(JSON.parse);
+            }
+            logger.info({source_address: req.source_address, count: voip_carriers.length},
+              'matched call to ephemeral gateway(s) from registration trunk');
+          }
+        }
+
+        if (voip_carriers.length) {
+          /* we have one or more matches.  Now check for one with a provisioned phone number matching the DID */
+          const vc_sids = voip_carriers.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+          const sql =
+            `SELECT * FROM phone_numbers WHERE number = '${did}'
+            AND voip_carrier_sid IN (${vc_sids})
+            AND account_sid = '${a[0].account_sid}'`;
+          //logger.debug({voip_carriers, sql, did}, 'looking up DID');
+
+          const [r] = await pp.query(sql);
+          if (r.length === 0) {
+            // if no matching phone number is found, find whether there are any applications having phone numbers
+            // matching the regex pattern or wild card
+            logger.debug({isDotDecimal},
+              'Did not find a matching phone number, checking for applications with Regex or wildcard');
+            const vc_sids = voip_carriers.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+            const application = await getApplicationForDidAndCarriers(req, vc_sids);
+            if (application) {
+              logger.debug({application}, 'sip_realm looking up DID: found application with Regex or wildcard ');
+              const gateway = gateways.find((m) => m.voip_carrier_sid === application.voip_carrier_sid);
+              // the gateway may belong to "all accounts", so we need to use the account_sid of the application
+              gateway.account_sid = gateway.account_sid ? gateway.account_sid : application.account_sid;
+              return {
+                fromCarrier: true,
+                gateway: gateway,
+                service_provider_sid: a[0].service_provider_sid,
+                account_sid: gateway.account_sid,
+                application_sid: application.application_sid,
+                account: a[0]
+              };
+            }
+          }
+          if (r.length > 1) {
+            logger.info({r},
+              'multiple carriers with the same gateway have the same number provisioned for the same account'
+              + ' -- cannot determine which one to use');
+            return {
+              fromCarrier: true,
+              error: 'Multiple carriers with the same gateway are attempting to route the same number for this account'
+            };
+          }
+
+          /**
+           * We have one or no routes for this phone number, carrier and account combination
+           * Either take the matching gateway, or if no route has matched, the first gateway of the ones available.
+          */
+          const gateway = r[0] ? gateways.find((m) => m.voip_carrier_sid === r[0]?.voip_carrier_sid) : gateways[0];
+          return {
+            fromCarrier: true,
+            gateway: gateway,
+            service_provider_sid: a[0].service_provider_sid,
+            account_sid: a[0].account_sid,
+            application_sid: r[0]?.application_sid || gateway.application_sid,
+            account: a[0]
+          };
+        }
+        return failure;
+      }
+
+
+      /* no match, so let's look for case #2 */
+      try {
+        logger.info({
+          host: uri.host,
+          user: uri.user
+        }, 'sip realm is not associated with an account, checking carriers');
+        const [gw] = await pp.query(sqlSelectCarrierRequiringRegistration, [uri.host, uri.user]);
+        const matches = gw
+          .sort((a, b) => b.netmask - a.netmask)
+          .filter(gatewayMatchesSourceAddress.bind(null, logger, req.source_address));
+        if (1 === matches.length) {
+          // bingo
+          //TODO: this assumes the carrier is associate to an account, not an SP
+          //if the carrier is associated with an SP (which would mean we
+          //must see a dialed number in the To header, not the register username),
+          //then we need to look up the account based on the dialed number in the To header
+          const [a] = await pp.query(sqlAccountBySid, [[matches[0].account_sid]]);
+          if (0 === a.length) return failure;
+          logger.debug({matches}, `found registration carrier using ${uri.host} and ${uri.user}`);
+          const sql =
+            `SELECT application_sid FROM phone_numbers WHERE number = '${did}'
+            AND voip_carrier_sid = '${matches[0].voip_carrier_sid}'
+            AND account_sid = '${matches[0].account_sid}'`;
+          //logger.debug({matches: matches[0], sql, did}, 'looking up DID');
+
+          const [r] = await pp.query(sql);
+          return {
+            fromCarrier: true,
+            gateway: matches[0],
+            service_provider_sid: a[0].service_provider_sid,
+            account_sid: a[0].account_sid,
+            application_sid: r[0]?.application_sid || matches[0].application_sid,
+            account: a[0]
+          };
+        }
+        else if (matches.length > 1) {
+          logger.warn({matches, source_address: req.source_address}, 'multiple gateways match source address');
+          return {
+            fromCarrier: true,
+            error: 'Multiple gateways match registration carrier source address'
+          };
+        }
+      } catch (err) {
+        logger.info({err, host: uri.host, user: uri.user}, 'Error looking up carrier by host and user');
+      }
+      /* no match, so fall through  */
+    }
+
+    /* find all carrier entries that have an inbound gateway matching the source IP */
+    /* Query both exact IP matches AND CIDR ranges in parallel to handle the case where
+       multiple accounts have configured the same carrier with different netmasks.
+       The phone number lookup will disambiguate which account owns the call. */
+    const [[gwExact], [gwCidr]] = await Promise.all([
+      pp.query(sqlSelectExactGatewayForSP, [req.source_address]),
+      pp.query(sqlSelectCIDRGatewaysForSP)
+    ]);
+
+    /* Merge both result sets - exact matches first, then CIDR ranges (already sorted by netmask DESC) */
+    const gw = [...gwExact, ...gwCidr];
+
+    //logger.debug({gw}, `checking gateways for source address ${req.source_address}`);
+    let matches = gw
+      .filter(gatewayMatchesSourceAddress.bind(null, logger, req.source_address))
+      .map((gw) => {
+        return {
+          voip_carrier_sid: gw.voip_carrier_sid,
+          name: gw.name,
+          service_provider_sid: gw.service_provider_sid,
+          account_sid: gw.account_sid,
+          application_sid: gw.application_sid,
+          pad_crypto: gw.pad_crypto,
+          register_username: gw.register_username,
+          register_password: gw.register_password
+        };
+      });
+    /* remove duplicates, winnow down to voip_carriers, not gateways */
+    if (matches.length > 1) {
+      matches = [...new Set(matches.map(JSON.stringify))].map(JSON.parse);
+    }
+
+    /* if no static gateway matches, check ephemeral gateways in Redis */
+    if (matches.length === 0) {
+      const ephemeralCarrierSids = await lookupEphemeralGatewayCarriers(req.source_address);
+      if (ephemeralCarrierSids.length > 0) {
+        const ephemeralGateways = await lookupGatewaysByCarrierSids(ephemeralCarrierSids);
+        matches = ephemeralGateways.map((gw) => {
+          return {
+            voip_carrier_sid: gw.voip_carrier_sid,
+            name: gw.name,
+            service_provider_sid: gw.service_provider_sid,
+            account_sid: gw.account_sid,
+            application_sid: gw.application_sid,
+            pad_crypto: gw.pad_crypto,
+            register_username: gw.register_username,
+            register_password: gw.register_password
+          };
+        });
+        /* remove duplicates */
+        if (matches.length > 1) {
+          matches = [...new Set(matches.map(JSON.stringify))].map(JSON.parse);
+        }
+        logger.info({source_address: req.source_address, count: matches.length},
+          'matched call to ephemeral gateway(s) from registration trunk');
+      }
+    }
+
+    //logger.debug({matches}, `matches for source address ${req.source_address}`);
+    if (matches.length) {
+      /* we have one or more matches.  Now check for one with a provisioned phone number matching the DID */
+      const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+      const sql =  `SELECT * FROM phone_numbers WHERE number = '${did}' AND voip_carrier_sid IN (${vc_sids})`;
+      logger.debug({matches, sql, did, vc_sids}, 'looking up DID');
+      const [r] = await pp.query(sql);
+      if (0 === r.length) {
+        // if no matching phone number is found, find whether there are any applications having phone numbers
+        // matching the regex pattern or wild card
+        logger.debug({isDotDecimal},
+          'Did not find a matching phone number, checking for applications with Regex or wildcard');
+        const vc_sids = matches.map((m) => `'${m.voip_carrier_sid}'`).join(',');
+        const application = await getApplicationForDidAndCarriers(req, vc_sids);
+        if (application) {
+          logger.debug({application}, 'looking up DID: found application with Regex or wildcard');
+          const gateway = matches.find((m) => m.voip_carrier_sid === application.voip_carrier_sid);
+          // the gateway may belong to "all accounts", so we need to use the account_sid of the application
+          const [a] = await pp.query(sqlAccountBySid, [application.account_sid]);
+          return {
+            fromCarrier: true,
+            gateway: gateway,
+            service_provider_sid: gateway.service_provider_sid,
+            account_sid: application.account_sid,
+            application_sid: application.application_sid,
+            account: a[0],
+          };
+        }
+
+        /* came from a provisioned carrier, but the dialed number is not provisioned.
+            check if we have an account with default routing of that carrier to an application
+        */
+        const accountLevelGateways = matches.filter((m) => m.account_sid && m.application_sid);
+        if (accountLevelGateways.length > 1) {
+          logger.info({accounts: accountLevelGateways.map((m) => m.account_sid)},
+            'multiple accounts have added this carrier with default routing -- cannot determine which to use');
+          return {
+            fromCarrier: true,
+            error: 'Multiple accounts are attempting to default route this carrier'
+          };
+        }
+        else if (accountLevelGateways.length === 1) {
+          const [accounts] = await pp.query('SELECT * from accounts where account_sid = ?',
+            [accountLevelGateways[0].account_sid]);
+          return {
+            fromCarrier: true,
+            gateway: accountLevelGateways[0],
+            service_provider_sid: accountLevelGateways[0].service_provider_sid,
+            account_sid: accountLevelGateways[0].account_sid,
+            application_sid: accountLevelGateways[0].application_sid,
+            account: accounts[0]
+          };
+        }
+        else {
+          /* check if we only have a single account, otherwise we have no
+-               way of knowing which account this is for
+          */
+          const [r] = await pp.query('SELECT count(*) as count from accounts where service_provider_sid = ?',
+            [matches[0].service_provider_sid]);
+          if (r[0].count === 0 || r[0].count > 1) return {fromCarrier: true};
+          else {
+            const [accounts] = await pp.query('SELECT * from accounts where service_provider_sid = ?',
+              [matches[0].service_provider_sid]);
+            return {
+              fromCarrier: true,
+              gateway: matches[0],
+              service_provider_sid: accounts[0].service_provider_sid,
+              account_sid: accounts[0].account_sid,
+              account: accounts[0]
+            };
+          }
+        }
+      }
+      else if (r.length > 1) {
+        logger.info({r},
+          'multiple accounts have added this carrier with default routing -- cannot determine which to use');
+        return {
+          fromCarrier: true,
+          error: 'Multiple accounts are attempting to route the same phone number from the same carrier'
+        };
+      }
+
+      /* we have a route for this phone number and carrier combination */
+      const gateway = matches.find((m) => m.voip_carrier_sid === r[0].voip_carrier_sid);
+      const [accounts] = await pp.query(sqlAccountBySid, [r[0].account_sid]);
+      assert(accounts.length);
+      return {
+        fromCarrier: true,
+        gateway,
+        service_provider_sid: accounts[0].service_provider_sid,
+        account_sid: r[0].account_sid,
+        application_sid: r[0].application_sid,
+        account: accounts[0]
+      };
+    }
+    return failure;
+  };
+
+  /**
+   * Retrieves voip_carriers with trunk_type 'auth' that belong to either:
+   * 1. The specified account (account_sid matches), OR
+   * 2. The service provider but with null account_sid (shared across service provider)
+   *
+   * @param {string} account_sid - The SID of the account
+   * @param {string} service_provider_sid - The SID of the service provider
+   * @returns {Promise<Array>} Array of voip_carrier records matching the criteria
+   * @throws {Error} Database errors or other unexpected errors
+   */
+  const lookupAuthCarriersForAccountAndSP = async(account_sid, service_provider_sid) => {
+    try {
+      const [rows] = await pp.query(sqlSelectAuthCarriersForAccountAndSP, [account_sid, service_provider_sid]);
+      return rows;
+    } catch (err) {
+      logger.error({err, account_sid, service_provider_sid}, 'lookupAuthCarriersForAccountAndSP');
+      throw err;
+    }
+  };
+
+  return {
+    wasOriginatedFromCarrier,
+    getApplicationForDidAndCarrier,
+    getApplicationForDidAndCarriers,
+    getOutboundGatewayForRefer,
+    getSPForAccount,
+    getApplicationBySid,
+    lookupAuthCarriersForAccountAndSP
+  };
+};

lib/fs-tracking.js

@@ -1,100 +1,35 @@
-const contacts = new Map();
-const noopLogger = {info: () => {}, error: () => {}};
-const debug = require('debug')('jambonz:sbc-inbound');
+const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
+const assert = require('assert');
+
+assert.ok(!process.env.K8S || process.env.K8S_FEATURE_SERVER_SERVICE_NAME,
+  'when running in Kubernetes, an env var K8S_FEATURE_SERVER_SERVICE_NAME is required');
 
 module.exports = (srf, logger) => {
-  logger = logger || noopLogger;
-  let dynamic = true;
+  const {retrieveSet, createSet} = srf.locals.realtimeDbHelpers;
   let idx = 0;
-  const stats = srf.locals.stats;
-  const setName = `${(process.env.JAMBONES_CLUSTER_ID || 'default')}:active-fs`;
 
-  const {createSet} = require('jambonz-realtimedb-helpers')({
-    host: process.env.JAMBONES_REDIS_HOST || 'localhost',
-    port: process.env.JAMBONES_REDIS_PORT || 6379
-  }, logger);
+  if ('test' === process.env.NODE_ENV) {
+    createSet(setName, [process.env.JAMBONES_FEATURE_SERVERS]);
+  }
 
-  srf.options((req, res) => {
-    res.send(200);
-    if (req.has('X-FS-Status')) {
-      const uri = `${req.source_address}:${req.source_port}`;
-      const status = req.get('X-FS-Status');
-      const calls = req.has('X-FS-Calls') ? parseInt(req.get('X-FS-Calls')) : 0;
-      if (status === 'open') {
-        const adding = !contacts.has(uri);
-        debug(`Feature server at ${uri} has ${calls} calls`);
-        contacts.set(uri, {pingTime: new Date(), calls: calls});
-        if (adding) {
-          logger.info(`adding feature server at ${uri}: ${[...contacts.keys()]}`);
-          stats.gauge('sbc.featureservers.count', contacts.size);
-          const featureServerIps = [...contacts.keys()].map((u) => {
-            const arr = /^(.*):\d+$/.exec(u);
-            return arr[1];
-          });
-          createSet(setName, new Set(featureServerIps));
-        }
+  return async() => {
+    try {
+      if (process.env.K8S) {
+        return process.env.K8S_FEATURE_SERVER_TRANSPORT ?
+          `${process.env.K8S_FEATURE_SERVER_SERVICE_NAME};transport=${process.env.K8S_FEATURE_SERVER_TRANSPORT}` :
+          process.env.K8S_FEATURE_SERVER_SERVICE_NAME;
       }
       else {
-        if (contacts.has(uri)) {
-          contacts.delete(uri);
-          logger.info(`removing feature server at ${uri}, leaving ${[...contacts.keys()]}`);
-          stats.gauge('sbc.featureservers.count', contacts.size);
-          const featureServerIps = [...contacts.keys()].map((u) => {
-            const arr = /^(.*):\d+$/.exec(u);
-            return arr[1];
-          });
-          createSet(setName, new Set(featureServerIps));
+        const fs = await retrieveSet(setName);
+        if (0 === fs.length) {
+          logger.info('No available feature servers to handle incoming call');
+          return;
         }
+        logger.debug({fs}, `retrieved ${setName}`);
+        return fs[idx++ % fs.length];
       }
+    } catch (err) {
+      logger.error({err}, `Error retrieving ${setName}`);
     }
-  });
-
-  // NB: this should only be used for test suite at this point
-  // in actual scenario OPTIONS pings from feature servers are used
-  if (process.env.NODE_ENV === 'test' && process.env.JAMBONES_FEATURE_SERVERS) {
-    dynamic = false;
-    process.env.JAMBONES_FEATURE_SERVERS
-      .split(',')
-      .map((hp) => hp.trim())
-      .forEach((uri) => contacts.set(uri, {active: 0, calls: 0}));
-    debug(`using static list of feature servers: ${[ ...contacts]}`);
-  }
-
-  if (dynamic) {
-    const CHECK_INTERVAL = 35;
-    setInterval(() => {
-      const dead = [];
-      const deadline = Date.now() - 90000;
-      for (const obj of contacts) {
-        if (obj[1].pingTime.getTime() < deadline) dead.push(obj[0]);
-      }
-      dead.forEach((uri) => {
-        logger.info(`removing feature server at ${uri} due to lack of OPTIONS ping`);
-        contacts.delete(uri);
-      });
-
-      const keys = [ ...contacts.keys() ];
-      debug({keys}, `there are ${keys.length} feature servers online`);
-      stats.gauge('sbc.featureservers.count', contacts.size);
-    }, CHECK_INTERVAL * 1000);
-  }
-
-  return () => {
-    let selectedUri;
-
-    if (dynamic) {
-      const featureServers = [ ...contacts].map((o) => Object.assign({}, {uri: o[0]}, o[1]));
-      debug({featureServers}, 'selecting feature servers with least calls');
-      const fs = featureServers.sort((a, b) => (a.calls - b.calls)).shift();
-      if (!fs) logger.info('No available feature servers!');
-      else selectedUri = fs.uri;
-    }
-    else {
-      const featureServers = [ ...contacts].map((o) => o[0]);
-      debug({featureServers}, 'selecting feature servers from static list');
-      selectedUri = featureServers[idx++ % featureServers.length];
-      debug(`selected ${selectedUri}`);
-    }
-    return selectedUri;
   };
 };

lib/middleware.js

@@ -1,28 +1,53 @@
 const debug = require('debug')('jambonz:sbc-inbound');
-const Emitter = require('events');
+const assert = require('assert');
 const parseUri = require('drachtio-srf').parseUri;
-const msProxyIps = process.env.MS_TEAMS_SIP_PROXY_IPS ? process.env.MS_TEAMS_SIP_PROXY_IPS.split(',').map((i) => i.trim()) : [];
+const {nudgeCallCounts, roundTripTime, isMSTeamsCIDR} = require('./utils');
+const digestChallenge = require('@jambonz/digest-utils');
+const msProxyIps = process.env.MS_TEAMS_SIP_PROXY_IPS ?
+  process.env.MS_TEAMS_SIP_PROXY_IPS.split(',').map((i) => i.trim()) :
+  [];
 
-class AuthOutcomeReporter extends Emitter {
-  constructor(stats) {
-    super();
-    this.on('regHookOutcome', ({rtt, status}) => {
-      stats.histogram('app.hook.response_time', rtt, ['hook_type:auth', `status:${status}`]);
-    });
-  }
-}
+const initCdr = (req) => {
+  return {
+    from: req.callingNumber,
+    to: req.calledNumber,
+    sip_callid: req.get('Call-ID'),
+    duration: 0,
+    attempted_at: Date.now(),
+    direction: 'inbound',
+    host: req.srf.locals.sipAddress,
+    remote_host: req.source_address,
+    answered: false
+  };
+};
 
 module.exports = function(srf, logger) {
-  const {lookupSipGatewayBySignalingAddress, lookupAuthHook}  = srf.locals.dbHelpers;
-  const {stats} = srf.locals;
-  const authenticator = require('jambonz-http-authenticator')(lookupAuthHook, logger, {
-    blacklistUnknownRealms: true,
-    emitter: new AuthOutcomeReporter(stats)
-  });
 
-  function initLocals(req, res, next) {
-    req.locals = req.locals || {};
+  const {
+    lookupAppByTeamsTenant,
+    lookupAccountBySipRealm,
+    lookupAccountBySid,
+    lookupAccountCapacitiesBySid,
+    queryCallLimits,
+  }  = srf.locals.dbHelpers;
+  const {stats, writeCdrs, lookupAuthCarriersForAccountAndSP, getApplicationForDidAndCarrier} = srf.locals;
+
+  const initLocals = (req, res, next) => {
     const callId = req.get('Call-ID');
+    req.locals = req.locals || {callId};
+    req.locals.nudge = 0;
+
+    /* check if forwarded by a proxy that applied an X-Forwarded-For Header */
+    if (req.has('X-Forwarded-For') || req.has('X-Subspace-Forwarded-For')) {
+      const original_source_address = req.get('X-Forwarded-For') || req.get('X-Subspace-Forwarded-For');
+      logger.info({
+        callId: req.get('Call-ID'),
+        original_source_address,
+        proxy_source_address: req.source_address,
+      }, 'overwriting source address for proxied SIP INVITE');
+      req.source_address = original_source_address;
+    }
+    req.locals.cdr = initCdr(req);
     req.on('cancel', () => {
       logger.info({callId}, 'caller hungup before connecting to feature server');
       req.canceled = true;
@@ -31,38 +56,371 @@ module.exports = function(srf, logger) {
       stats.increment('sbc.terminations', tags);
     });
     stats.increment('sbc.invites', ['direction:inbound']);
-    next();
-  }
 
-  async function challengeDeviceCalls(req, res, next) {
+    /* write cdr for non-success response here */
+    res.once('end', ({status}) => {
+      if (req.locals.cdr && req.locals.cdr.account_sid && status > 200  && 401 !== status) {
+        const trunk = ['trunk', 'teams'].includes(req.locals.originator) ? req.locals.carrier : req.locals.originator;
+        writeCdrs({...req.locals.cdr,
+          terminated_at: Date.now(),
+          termination_reason: status === 487 === status ? 'caller abandoned' : 'failed',
+          sip_status: status,
+          trunk
+        }).catch((err) => logger.error({err}, 'Error writing cdr for call failure'));
+      }
+    });
+
+    next();
+  };
+
+  const handleSipRec = async(req, res, next) => {
+    const {callId} = req.locals;
+    if (Array.isArray(req.payload) && req.payload.length > 1) {
+      const sdp = req.payload
+        .find((p) => p.type === 'application/sdp')
+        .content;
+      if (!sdp) {
+        logger.error({callId}, 'No SDP in multipart sdp');
+        return res.send(503);
+      }
+      const xml = req.payload.find((p) => p.type !== 'application/sdp');
+      const endPos = xml.content.indexOf('</recording>');
+      xml.content = endPos !== -1 ?
+        `${xml.content.substring(0, endPos + 12)}` :
+        xml.content;
+      logger.debug({callId, xml}, 'incoming call with SIPREC body');
+      req.locals = {...req.locals, sdp, siprec: true, xml};
+    }
+    else req.locals = {...req.locals, sdp: req.body};
+    next();
+  };
+
+  const identifyAccount = async(req, res, next) => {
     try {
-      const gateway = await lookupSipGatewayBySignalingAddress(req.source_address, req.source_port);
-      if (gateway) {
-        debug(`challengeDeviceCalls: call came from gateway: ${JSON.stringify(gateway)}`);
-        req.locals.originator = 'trunk';
-        req.locals.carrier = gateway.name;
-        if (gateway.application_sid) req.locals.application_sid = gateway.application_sid;
-        return next();
+      const {siprec, callId} = req.locals;
+      const {getSPForAccount, wasOriginatedFromCarrier, getApplicationForDidAndCarrier, stats} = req.srf.locals;
+      const startAt = process.hrtime();
+      const {
+        fromCarrier,
+        gateway,
+        account_sid,
+        application_sid,
+        service_provider_sid,
+        account,
+        error
+      } = await wasOriginatedFromCarrier(req);
+      const rtt = roundTripTime(startAt);
+      stats.histogram('app.mysql.response_time', rtt, [
+        'query:wasOriginatedFromCarrier', 'app:sbc-inbound']);
+      /**
+       * calls come from 3 sources:
+       * (1) A carrier
+       * (2) Microsoft Teams
+       * (3) A SIP user
+       */
+      if (fromCarrier) {
+        if (error) {
+          return res.send(503, {
+            headers: {
+              'X-Reason': error
+            }
+          });
+        }
+        if (!gateway) {
+          logger.info('identifyAccount: rejecting call from carrier because DID has not been provisioned');
+          return res.send(404, 'Number Not Provisioned');
+        }
+        logger.info({gateway}, 'identifyAccount: incoming call from gateway');
+        const appSidHeader = req.get('x-application-sid');
+        if (appSidHeader && appSidHeader == application_sid) {
+          logger.info({callId}, 'Loop Detected, x-application-sid header on incoming call matches applicationSid');
+          return res.send(482, 'Loop Detected on x-application-sid');
+        }
+        let sid;
+        if (siprec) {
+          if (!account.siprec_hook_sid) {
+            logger.info({callId}, 'identifyAccount: rejecting call because SIPREC hook has not been provisioned');
+            return res.send(404);
+          }
+          sid = account.siprec_hook_sid;
+        }
+        else {
+          /* check for phone number level routing */
+          sid = application_sid || await getApplicationForDidAndCarrier(req, gateway.voip_carrier_sid);
+        }
+        req.locals = {
+          originator: 'trunk',
+          carrier: gateway.name,
+          gateway,
+          voip_carrier_sid: gateway.voip_carrier_sid,
+          application_sid: sid || gateway.application_sid,
+          service_provider_sid,
+          account_sid,
+          account,
+          ...req.locals
+        };
       }
-      if (msProxyIps.includes(req.source_address)) {
-        logger.debug({source_address: req.source_address}, 'challengeDeviceCalls: incoming call from Microsoft Teams');
+      else if (msProxyIps.includes(req.source_address) || isMSTeamsCIDR(req.source_address)) {
+        logger.info({source_address: req.source_address}, 'identifyAccount: incoming call from Microsoft Teams');
         const uri = parseUri(req.uri);
-        req.locals.originator = 'teams';
-        req.locals.carrier = 'Microsoft Teams';
-        req.locals.msTeamsTenantFqdn = uri.host;
-        return next();
+
+        const app = await lookupAppByTeamsTenant(uri.host);
+        if (!app) {
+          stats.increment('sbc.terminations', ['sipStatus:404']);
+          res.send(404, {headers: {'X-Reason': 'no configured application'}});
+          return req.srf.endSession(req);
+        }
+        const service_provider_sid = await getSPForAccount(app.account_sid);
+        req.locals = {
+          originator: 'teams',
+          carrier: 'Microsoft Teams',
+          msTeamsTenantFqdn: uri.host,
+          account_sid: app.account_sid,
+          service_provider_sid,
+          ...req.locals
+        };
       }
-      req.locals.originator = 'device';
-      return authenticator(req, res, next);
+      else {
+        req.locals.originator = 'user';
+        const uri = parseUri(req.uri);
+        logger.info({source_address: req.source_address, realm: uri.host},
+          'identifyAccount: incoming user call');
+        const account = await lookupAccountBySipRealm(uri.host);
+        if (!account) {
+          stats.increment('sbc.terminations', ['sipStatus:404']);
+          res.send(404);
+          return req.srf.endSession(req);
+        }
+        const auth_trunks = await lookupAuthCarriersForAccountAndSP(
+          account.account_sid,
+          account.service_provider_sid
+        );
+
+        /* if this is a dedicated SBC (static IP) only take calls for that account's sip realm */
+        if (process.env.SBC_ACCOUNT_SID && account.account_sid !== process.env.SBC_ACCOUNT_SID) {
+          logger.info(
+            `identifyAccount: static IP for ${process.env.SBC_ACCOUNT_SID} but call for ${account.account_sid}`);
+          stats.increment('sbc.terminations', ['sipStatus:404']);
+          delete req.locals.cdr;
+          res.send(404);
+          return req.srf.endSession(req);
+        }
+        req.locals = {
+          service_provider_sid: account.service_provider_sid,
+          account_sid: account.account_sid,
+          account,
+          application_sid: account.device_calling_application_sid,
+          webhook_secret: account.webhook_secret,
+          realm: uri.host,
+          ...(account.registration_hook && {
+            registration_hook_url: account.registration_hook.url,
+            registration_hook_method: account.registration_hook.method,
+            registration_hook_username: account.registration_hook.username,
+            registration_hook_password: account.registration_hook.password
+          }),
+          ...(auth_trunks?.length && {auth_trunks}),
+          ...req.locals
+        };
+      }
+      assert(req.locals.service_provider_sid);
+      assert(req.locals.account_sid);
+      req.locals.cdr.account_sid = req.locals.account_sid;
+
+      if (!req.locals.account) {
+        req.locals.account = await lookupAccountBySid(req.locals.account_sid);
+      }
+      req.locals.cdr.service_provider_sid = req.locals.account?.service_provider_sid;
+
+      if (!req.locals.account.is_active) {
+        stats.increment('sbc.terminations', ['sipStatus:503']);
+        return res.send(503, {headers: {'X-Reason': 'Account exists but is inactive'}});
+      }
+
+      if (req.locals.account.disable_cdrs) {
+        logger.info({account_sid: req.locals.account_sid}, 'Not writing CDRs for this account');
+        delete req.locals.cdr;
+      }
+
+      req.locals.logger = logger.child({
+        callId: req.get('Call-ID'),
+        service_provider_sid: req.locals.service_provider_sid,
+        account_sid: req.locals.account_sid
+      }, {
+        ...(req.locals.account.enable_debug_log && {level: 'debug'})
+      });
+
+      next();
+    } catch (err) {
+      stats.increment('sbc.terminations', ['sipStatus:500']);
+      logger.error(err, `${req.get('Call-ID')} database error for inbound call`);
+      res.send(500);
+    }
+  };
+
+  const checkLimits = async(req, res, next) => {
+    const trackingOn = process.env.JAMBONES_TRACK_ACCOUNT_CALLS ||
+    process.env.JAMBONES_TRACK_SP_CALLS ||
+    process.env.JAMBONES_TRACK_APP_CALLS;
+    if (!process.env.JAMBONES_HOSTING && !trackingOn) return next(); // skip
+
+    const {incrKey, decrKey} = req.srf.locals.realtimeDbHelpers;
+    const {logger, account_sid, account, service_provider_sid, application_sid} = req.locals;
+    const {writeCallCount, writeCallCountSP, writeCallCountApp, writeAlerts, AlertType} = req.srf.locals;
+    assert(account_sid);
+    assert(service_provider_sid);
+
+    /* if quick cancel then we are done */
+    if (req.canceled) {
+      logger.info('checkLimits: call was immediately canceled, no need to increment call count as we are done');
+      return;
+    }
+
+    /* decrement count if INVITE is later rejected */
+    res.once('end', async({status}) => {
+      if (status > 200) {
+        nudgeCallCounts(req, 'failure', {
+          service_provider_sid,
+          account_sid,
+          application_sid,
+          callId: req.locals.callId
+        }, decrKey, {writeCallCountSP, writeCallCount, writeCallCountApp})
+          .catch((err) => logger.error(err, 'Error decrementing call counts'));
+      }
+    });
+
+    try {
+      /* increment the call count */
+      const  {callsSP, calls} = await nudgeCallCounts(req, 'init', {
+        service_provider_sid,
+        account_sid,
+        application_sid,
+        callId: req.locals.callId
+      }, incrKey, {writeCallCountSP, writeCallCount, writeCallCountApp});
+
+      /* compare to account's limit, though avoid db hit when call count is low */
+      const minLimit = process.env.MIN_CALL_LIMIT ?
+        parseInt(process.env.MIN_CALL_LIMIT) :
+        0;
+      logger.debug(`checkLimits: call count is now ${calls}, limit is ${minLimit}`);
+      if (calls <= minLimit) return next();
+
+      const accountCapacities = await lookupAccountCapacitiesBySid(account_sid);
+      const accountLimit = accountCapacities.find((c) => c.category == 'voice_call_session');
+      if (accountLimit) {
+        /* check account limit */
+        const limit_sessions = accountLimit.quantity;
+        if (calls > limit_sessions) {
+          debug(`checkLimits: limits exceeded: call count ${calls}, limit ${limit_sessions}`);
+          logger.info({calls, limit_sessions}, 'checkLimits: limits exceeded');
+          writeAlerts({
+            alert_type: AlertType.ACCOUNT_CALL_LIMIT,
+            service_provider_sid: account.service_provider_sid,
+            account_sid,
+            count: limit_sessions
+          }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+          res.send(503, 'Maximum Calls In Progress');
+          return req.srf.endSession(req);
+        }
+      }
+      else if (trackingOn) {
+        const {account_limit, sp_limit} = await queryCallLimits(service_provider_sid, account_sid);
+        if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS && account_limit > 0 && calls > account_limit) {
+          logger.info({calls, account_limit}, 'checkLimits: account limits exceeded');
+          writeAlerts({
+            alert_type: AlertType.ACCOUNT_CALL_LIMIT,
+            service_provider_sid: service_provider_sid,
+            account_sid,
+            count: account_limit
+          }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+          res.send(503, 'Max Account Calls In Progress', {
+            headers: {
+              'X-Account-Sid': account_sid,
+              'X-Call-Limit': account_limit
+            }
+          });
+          return req.srf.endSession(req);
+        }
+        if (!account_limit && !sp_limit && process.env.JAMBONES_HOSTING) {
+          logger.info(`checkLimits: no active subscription found for account ${account_sid}, rejecting call`);
+          res.send(503, 'No Active Subscription');
+          return req.srf.endSession(req);
+        }
+        if (process.env.JAMBONES_TRACK_SP_CALLS && sp_limit > 0 && callsSP > sp_limit) {
+          logger.info({callsSP, sp_limit}, 'checkLimits: service provider limits exceeded');
+          writeAlerts({
+            alert_type: AlertType.SP_CALL_LIMIT,
+            service_provider_sid: service_provider_sid,
+            count: sp_limit
+          }).catch((err) => logger.info({err}, 'checkLimits: error writing alert'));
+          res.send(503, 'Max Service Provider Calls In Progress', {
+            headers: {
+              'X-Service-Provider-Sid': service_provider_sid,
+              'X-Call-Limit': sp_limit
+            }
+          });
+          return req.srf.endSession(req);
+        }
+      }
+      next();
+    } catch (err) {
+      stats.increment('sbc.terminations', ['sipStatus:500']);
+      logger.error({err}, 'error checking limits error for inbound call');
+      res.send(500);
+      req.srf.endSession(req);
+    }
+  };
+
+  const identifyAuthTrunk = async(req, res, next) => {
+    try {
+      if (req.authorization) {
+        const {grant} = req.authorization;
+        if (grant && grant.status === 'ok' && grant.auth_trunk) {
+          // we have successfully authenticated the call for an auth_trunk
+          const application_sid = await getApplicationForDidAndCarrier(req, grant.auth_trunk.voip_carrier_sid);
+
+          req.locals = {
+            ...req.locals,
+            originator: 'trunk',
+            carrier: grant.auth_trunk.name,
+            gateway: grant.auth_trunk,
+            voip_carrier_sid: grant.auth_trunk.voip_carrier_sid,
+            application_sid: application_sid || grant.auth_trunk.application_sid,
+          };
+          // as call from auth carrier, clean req.authorization that impact on legacy logic for authenticated user
+          delete req.authorization;
+
+          logger.debug({callId: req.locals.callId, auth_trunk: grant.auth_trunk.name},
+            'identifyAuthTrunk: call authenticated for auth trunk');
+        }
+      }
+      next();
+    } catch (err) {
+      stats.increment('sbc.terminations', ['sipStatus:500']);
+      logger.error(err, `${req.get('Call-ID')} Error challenging auth trunk`);
+      res.send(500);
+      req.srf.endSession(req);
+    }
+  };
+
+  const challengeDeviceCalls = async(req, res, next) => {
+    try {
+      /* TODO: check if this is a gateway that we have an ACL for */
+      if (req.locals.originator !== 'user') return next();
+      return digestChallenge(req, res, next);
     } catch (err) {
       stats.increment('sbc.terminations', ['sipStatus:500']);
       logger.error(err, `${req.get('Call-ID')} Error looking up related info for inbound call`);
       res.send(500);
+      req.srf.endSession(req);
     }
-  }
+  };
 
   return {
     initLocals,
-    challengeDeviceCalls
+    handleSipRec,
+    challengeDeviceCalls,
+    identifyAccount,
+    identifyAuthTrunk,
+    checkLimits
   };
 };

lib/utils.js

@@ -1,40 +1,365 @@
+const CIDRMatcher = require('cidr-matcher');
+const express = require('express');
 const rtpCharacteristics = require('../data/rtp-transcoding');
 const srtpCharacteristics = require('../data/srtp-transcoding');
+
 let idx = 0;
 
-function isWSS(req) {
+const isWSS = (req) => {
   return req.getParsedHeader('Via')[0].protocol.toLowerCase().startsWith('ws');
-}
+};
 
-function getAppserver(srf) {
+const getAppserver = (srf) => {
   const len = srf.locals.featureServers.length;
-  return srf.locals.featureServers[ idx++ % len];
-}
+  return srf.locals.featureServers[idx++ % len];
+};
 
 function makeRtpEngineOpts(req, srcIsUsingSrtp, dstIsUsingSrtp, teams = false) {
-  const srtpOpts = teams ? srtpCharacteristics['teams'] : srtpCharacteristics['default'];
+  const rtpCopy = JSON.parse(JSON.stringify(rtpCharacteristics));
+  const srtpCopy = JSON.parse(JSON.stringify(srtpCharacteristics));
   const from = req.getParsedHeader('from');
-  const common = {'call-id': req.get('Call-ID'), 'from-tag': from.params.tag};
+  const srtpOpts = teams ? srtpCopy['teams'] : srtpCopy['default'];
+  if ((req.locals.gateway?.pad_crypto || 0) > 0) {
+    srtpOpts.flags.push('pad crypto');
+  }
+  const dstOpts = dstIsUsingSrtp ? srtpOpts : rtpCopy;
+  const srcOpts = srcIsUsingSrtp ? srtpOpts : rtpCopy;
+
+  /* Allow Feature server to inject DTMF to both leg except call from Teams */
+  if (!teams) {
+    dstOpts.flags.push('inject DTMF');
+    srcOpts.flags.push('inject DTMF');
+  }
+
+  /** By default, and for backwards compatibility, use media handover
+   * set env var to true to use strict source instead (needed for rtpbleed vulnerability)
+   */
+  const enableStrictSource = !!process.env.RTPENGINE_ENABLE_STRICT_SOURCE;
+  dstOpts.flags.push(enableStrictSource ? 'strict source' : 'media handover');
+  srcOpts.flags.push(enableStrictSource ?  'strict source' : 'media handover');
+  const acceptCodecs = process.env.JAMBONES_ACCEPT_AND_TRANSCODE ?
+    process.env.JAMBONES_ACCEPT_AND_TRANSCODE :
+    process.env.JAMBONES_ACCEPT_G729 ? 'g729' : '';
+  const common = {
+    'call-id': req.get('Call-ID'),
+    'replace': ['origin', 'session-connection'],
+    'record call': process.env.JAMBONES_RECORD_ALL_CALLS ? 'yes' : 'no',
+    ...(acceptCodecs && { codec: { mask: acceptCodecs, transcode: 'pcmu,pcma' } })
+  };
   return {
     common,
-    offer: Object.assign(
-      {'sdp': req.body, 'replace': ['origin', 'session-connection']},
-      common,
-      dstIsUsingSrtp ? srtpOpts : rtpCharacteristics),
-    answer: Object.assign(
-      {'replace': ['origin', 'session-connection']},
-      common,
-      srcIsUsingSrtp ? srtpOpts : rtpCharacteristics)
+    uas: {
+      tag: from.params.tag,
+      mediaOpts: srcOpts
+    },
+    uac: {
+      tag: null,
+      mediaOpts: dstOpts
+    }
   };
 }
 
-function SdpWantsSrtp(sdp) {
+const SdpWantsSDES = (sdp) => {
+  return /m=audio.*\s+RTP\/SAVP/.test(sdp);
+};
+const SdpWantsSrtp = (sdp) => {
   return /m=audio.*SAVP/.test(sdp);
-}
+};
+
+const makeAccountCallCountKey = (sid) => `incalls:account:${sid}`;
+const makeSPCallCountKey = (sid) => `incalls:sp:${sid}:`;
+const makeAppCallCountKey = (sid) => `incalls:app${sid}:`;
+
+const normalizeDID = (tel) => {
+  const regex = /^\+(\d+)$/;
+  const arr = regex.exec(tel);
+  return arr ? arr[1] : tel;
+};
+
+const equalsIgnoreOrder = (a, b) => {
+  if (a.length !== b.length) return false;
+  const uniqueValues = new Set([...a, ...b]);
+  for (const v of uniqueValues) {
+    const aCount = a.filter((e) => e === v).length;
+    const bCount = b.filter((e) => e === v).length;
+    if (aCount !== bCount) return false;
+  }
+  return true;
+};
+
+const systemHealth = async(redisClient, ping, getCount) => {
+  await Promise.all([redisClient.ping(), ping()]);
+  return getCount();
+};
+
+const doListen = (logger, app, port, resolve) => {
+  return app.listen(port, () => {
+    logger.info(`Health check server listening on http://localhost:${port}`);
+    resolve(app);
+  });
+};
+const handleErrors = (logger, app, resolve, reject, e) => {
+  if (e.code === 'EADDRINUSE' &&
+    process.env.HTTP_PORT_MAX &&
+    e.port < process.env.HTTP_PORT_MAX) {
+
+    logger.info(`Health check server failed to bind port on ${e.port}, will try next port`);
+    const server = doListen(logger, app, ++e.port, resolve);
+    server.on('error', handleErrors.bind(null, logger, app, resolve, reject));
+    return;
+  }
+  reject(e);
+};
+
+
+const createHealthCheckApp = (port, logger) => {
+  const app = express();
+
+  app.use(express.urlencoded({ extended: true }));
+  app.use(express.json());
+
+  return new Promise((resolve, reject) => {
+    const server = doListen(logger, app, port, resolve);
+    server.on('error', handleErrors.bind(null, logger, app, resolve, reject));
+  });
+};
+
+/**
+ * nudgeCallCounts - increment or decrement call counts in redis
+ *
+ *              current nudge value
+ * -----------------------------------------
+ *  why    |     -1     |    0    |    1    |
+ * -----------------------------------------
+ *  init   |    no-op   |    +1   |    N/A  |
+ * failure |    N/A     |    -1   |    -1   |
+ * complete|    N/A     |    N/A  |    -1   |
+ *
+ *
+ */
+
+const shouldNudge = (why, req) => {
+  const {nudge, logger} = req.locals;
+  let modifyCount = false;
+  const originalNudge = nudge;
+
+  switch (why) {
+    case 'init':
+      if (nudge === 0) {
+        // normal case: new call, increment call count
+        req.locals.nudge = 1;
+        modifyCount = true;
+      }
+      else if (nudge === -1) {
+        // extremely quick cancel, don't increment call count
+        req.locals.nudge = 0;
+      }
+      else {
+        logger.info(`shouldNudge: unexpected nudge value ${nudge} for ${why}`);
+      }
+      break;
+    case 'failure':
+      if (nudge === 1) {
+        // normal case of call failed for any reason, decrement call count
+        req.locals.nudge = 0;
+        modifyCount = true;
+      }
+      else if (nudge === 0) {
+        // very quick failure dont decrement call count
+        req.locals.nudge = -1;
+      }
+      else {
+        logger.info(`shouldNudge: unexpected nudge value ${nudge} for ${why}`);
+      }
+      break;
+    case 'complete':
+      if (nudge === 1) {
+        // normal case of call completed, decrement call count
+        req.locals.nudge = 0;
+        modifyCount = true;
+      }
+      else {
+        logger.info(`shouldNudge: unexpected nudge value ${nudge} for ${why}`);
+      }
+      break;
+    default:
+      logger.info(`shouldNudge: unexpected why value ${why}`);
+      break;
+  }
+
+  logger.info(`shouldNudge: '${why}': updating count: ${modifyCount}, nudge: ${originalNudge} -> ${req.locals.nudge}`);
+  return modifyCount;
+};
+
+const nudgeCallCounts = async(req, why, sids, nudgeOperator, writers) => {
+  const {logger} = req.locals;
+  const {service_provider_sid, account_sid, application_sid, callId} = sids;
+  const {writeCallCount, writeCallCountSP, writeCallCountApp} = writers;
+  const nudges = [];
+  const writes = [];
+
+  if (!shouldNudge(why, req)) {
+    return {callsSP: null, calls: null, callsApp: null};
+  }
+
+  if (process.env.JAMBONES_DEBUG_CALL_COUNTS) {
+    const {srf} = require('..');
+    const {addKey, deleteKey} = srf.locals.realtimeDbHelpers;
+
+    if (why === 'init') {
+      // save for 3 days
+      await addKey(`debug:incalls:${account_sid}:${callId}`, new Date().toISOString(), 259200);
+    }
+    else {
+      await deleteKey(`debug:incalls:${account_sid}:${callId}`);
+    }
+  }
+
+  if (process.env.JAMBONES_TRACK_SP_CALLS) {
+    const key = makeSPCallCountKey(service_provider_sid);
+    nudges.push(nudgeOperator(key));
+  }
+  else {
+    nudges.push(() => Promise.resolve(null));
+  }
+
+  if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS || process.env.JAMBONES_HOSTING) {
+    const key = makeAccountCallCountKey(account_sid);
+    nudges.push(nudgeOperator(key));
+  }
+  else {
+    nudges.push(() => Promise.resolve(null));
+  }
+
+  if (process.env.JAMBONES_TRACK_APP_CALLS && application_sid) {
+    const key = makeAppCallCountKey(application_sid);
+    nudges.push(nudgeOperator(key));
+  }
+  else {
+    nudges.push(() => Promise.resolve(null));
+  }
+
+  try {
+    const [callsSP, calls, callsApp] = await Promise.all(nudges);
+    logger.debug({
+      calls, callsSP, callsApp,
+      service_provider_sid, account_sid, application_sid}, 'call counts after adjustment');
+    if (process.env.JAMBONES_TRACK_SP_CALLS) {
+      writes.push(writeCallCountSP({service_provider_sid, calls_in_progress: callsSP}));
+    }
+
+    if (process.env.JAMBONES_TRACK_ACCOUNT_CALLS || process.env.JAMBONES_HOSTING) {
+      writes.push(writeCallCount({service_provider_sid, account_sid, calls_in_progress: calls}));
+    }
+
+    if (process.env.JAMBONES_TRACK_APP_CALLS && application_sid) {
+      writes.push(writeCallCountApp({service_provider_sid, account_sid, application_sid, calls_in_progress: callsApp}));
+    }
+
+    /* write the call counts to the database */
+    Promise.all(writes).catch((err) => logger.error({err}, 'Error writing call counts'));
+
+    return {callsSP, calls, callsApp};
+  } catch (err) {
+    logger.error(err, 'error incrementing call counts');
+  }
+
+  return {callsSP: null, calls: null, callsApp: null};
+};
+
+const roundTripTime = (startAt) => {
+  const diff = process.hrtime(startAt);
+  const time = diff[0] * 1e3 + diff[1] * 1e-6;
+  return time.toFixed(0);
+};
+
+const parseConnectionIp = (sdp) => {
+  const regex = /c=IN IP4 ([0-9.]+)/;
+  const arr = regex.exec(sdp);
+  return arr ? arr[1] : null;
+};
+
+/**
+ * Checks if ip is one of MS Teams sip signalling ips
+ * https://learn.microsoft.com/en-us/azure/communication-services/concepts
+ * /telephony/direct-routing-infrastructure#sip-signaling-fqdns
+ * @param ip IP address, example 172.31.0.1
+ * */
+const isMSTeamsCIDR = (ip) => {
+  const cidrs = [
+    '52.112.0.0/14',
+    '52.120.0.0/14'
+  ];
+  const matcher = new CIDRMatcher(cidrs);
+  return matcher.contains(ip);
+};
+
+const isPrivateVoipNetwork = (ip) => {
+  const {srf, logger} = require('..');
+  const {privateNetworkCidr} = srf.locals;
+  if (privateNetworkCidr) {
+    try {
+      const matcher = new CIDRMatcher(privateNetworkCidr.split(','));
+      return matcher.contains(ip);
+    } catch (err) {
+      logger.info({err, privateNetworkCidr},
+        'Error checking private network CIDR, probably misconfigured must be a comma separated list of CIDRs');
+    }
+  }
+  return false;
+};
+
+/**
+ * @param hostports can be a string or an array of hostports
+ */
+const parseHostPorts = (logger, hostports, srf) => {
+  typeof hostports === 'string' && (hostports = hostports.split(','));
+  const obj = {};
+  for (const hp of hostports) {
+    const [, protocol, ipv4, port] = hp.match(/^(.*)\/(.*):(\d+)$/);
+    if (protocol && ipv4 && port) {
+      obj[protocol] = `${ipv4}:${port}`;
+    }
+  }
+  if (!obj.tls) {
+    obj.tls = `${srf.locals.sipAddress}:5061`;
+  }
+
+  if (!obj.tcp) {
+    obj.tcp = `${srf.locals.sipAddress}:5060`;
+  }
+
+  logger.info({ obj }, 'sip endpoints');
+  return obj;
+};
+
+const makeFullMediaReleaseKey = (callId) => {
+  return `a_sdp:${callId}`;
+};
+const makePartnerFullMediaReleaseKey = (callId) => {
+  return `b_sdp:${callId}`;
+};
 
 module.exports = {
   isWSS,
   SdpWantsSrtp,
+  SdpWantsSDES,
   getAppserver,
-  makeRtpEngineOpts
+  makeRtpEngineOpts,
+  makeAccountCallCountKey,
+  makeSPCallCountKey,
+  makeAppCallCountKey,
+  normalizeDID,
+  equalsIgnoreOrder,
+  systemHealth,
+  createHealthCheckApp,
+  nudgeCallCounts,
+  roundTripTime,
+  parseConnectionIp,
+  isMSTeamsCIDR,
+  isPrivateVoipNetwork,
+  parseHostPorts,
+  makeFullMediaReleaseKey,
+  makePartnerFullMediaReleaseKey
 };
+

liveness.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+TCP_SERVER_PORT="${DRACHTIO_PORT:-4000}"
+nc -v -z localhost $TCP_SERVER_PORT
+
+# if last command exited with non zero
+if [ $? != 0 ]
+then
+    exit 1
+fi
+
+HTTP_SERVER_PORT="${HTTP_PORT:-3000}"
+
+printf 'GET /system-health HTTP/1.1\r\nHost: localhost\r\n\r\n' | nc -v localhost 3000 | grep calls
+
+# grep will automatically exit with 1 if string is not matched, however, will leave that call there in case 
+# we pivot to pipe to dev/null
+
+if [ $? != 0 ]
+then
+    exit 1
+fi
+
+exit 0

package.json

@@ -1,9 +1,9 @@
 {
   "name": "sbc-inbound",
-  "version": "0.3.2",
+  "version": "0.9.5",
   "main": "app.js",
   "engines": {
-    "node": ">= 10.16.0"
+    "node": ">= 20.0.0"
   },
   "keywords": [
     "sip",
@@ -20,28 +20,37 @@
   },
   "scripts": {
     "start": "node app",
-    "test": "NODE_ENV=test JAMBONES_MYSQL_HOST=localhost 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=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 JAMBONES_FEATURE_SERVERS=172.38.0.11 node test/ | ./node_modules/.bin/tap-spec",
+    "test": "NODE_ENV=test HTTP_PORT=3050 JAMBONES_NETWORK_CIDR='127.0.0.1/32' JAMBONES_HOSTING=1 JWT_SECRET=foobarbazzle SBC_ACCOUNT_SID=ed649e33-e771-403a-8c99-1780eabbc803 JAMBONES_TIME_SERIES_HOST=127.0.0.1 JAMBONES_MYSQL_HOST=127.0.0.1 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=error DRACHTIO_SECRET=cymru DRACHTIO_HOST=127.0.0.1 DRACHTIO_PORT=9060 JAMBONES_RTPENGINES=127.0.0.1:12222 JAMBONES_FEATURE_SERVERS=172.38.0.11 node test/ ",
     "coverage": "./node_modules/.bin/nyc --reporter html --report-dir ./coverage npm run test",
-    "jslint": "eslint app.js lib"
+    "jslint": "eslint app.js lib",
+    "jslint:fix": "npm run jslint --fix"
   },
   "dependencies": {
-    "debug": "^4.1.1",
-    "drachtio-fn-b2b-sugar": "0.0.12",
-    "drachtio-srf": "^4.4.33",
-    "@jambonz/db-helpers": "^0.3.6",
-    "jambonz-http-authenticator": "0.1.5",
-    "jambonz-realtimedb-helpers": "^0.2.4",
-    "jambonz-rtpengine-utils": "0.1.1",
-    "jambonz-stats-collector": "0.0.3",
-    "pino": "^5.14.0",
-    "rtpengine-client": "^0.0.8"
+    "@aws-sdk/client-auto-scaling": "^3.549.0",
+    "@aws-sdk/client-sns": "^3.549.0",
+    "@babel/helpers": "^7.26.10",
+    "@jambonz/db-helpers": "^0.9.18",
+    "@jambonz/digest-utils": "^0.0.9",
+    "@jambonz/http-health-check": "^0.0.1",
+    "@jambonz/realtimedb-helpers": "^0.8.18",
+    "@jambonz/rtpengine-utils": "^0.4.4",
+    "@jambonz/siprec-client-utils": "^0.2.10",
+    "@jambonz/stats-collector": "^0.1.10",
+    "@jambonz/time-series": "^0.2.10",
+    "bent": "^7.3.12",
+    "cidr-matcher": "^2.1.1",
+    "debug": "^4.4.3",
+    "drachtio-fn-b2b-sugar": "0.2.1",
+    "drachtio-srf": "^5.0.20",
+    "express": "^4.21.2",
+    "pino": "^10.1.0",
+    "verify-aws-sns-signature": "^0.1.0",
+    "xml2js": "^0.6.2"
   },
   "devDependencies": {
-    "blue-tape": "^1.0.0",
-    "clear-module": "^4.1.1",
-    "eslint": "^6.8.0",
-    "eslint-plugin-promise": "^4.2.1",
-    "nyc": "^15.0.1",
-    "tap-spec": "^5.0.0"
+    "eslint": "^9.17.0",
+    "eslint-plugin-promise": "^7.2.1",
+    "nyc": "^15.1.0",
+    "tape": "^5.7.5"
   }
 }

test/create-test-db.js

@@ -1,9 +1,8 @@
-const test = require('tape').test ;
+const test = require('tape') ;
 const exec = require('child_process').exec ;
-const pwd = process.env.TRAVIS ? '' : '-p$MYSQL_ROOT_PASSWORD';
 
 test('creating jambones_test database', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp  < ${__dirname}/db/create_test_db.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('database successfully created');
     t.end();
@@ -11,7 +10,7 @@ test('creating jambones_test database', (t) => {
 });
 
 test('creating schema', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} -D jambones_test < ${__dirname}/db/jambones-sql.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp  -D jambones_test < ${__dirname}/db/jambones-sql.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('schema successfully created');
     t.end();
@@ -19,7 +18,7 @@ test('creating schema', (t) => {
 });
 
 test('populating test case data', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} -D jambones_test < ${__dirname}/db/populate-test-data.sql`, (err, stdout, stderr) => {
+  exec(`mysql -h 127.0.0.1 -u root --protocol=tcp  -D jambones_test < ${__dirname}/db/populate-test-data.sql`, (err, stdout, stderr) => {
     if (err) return t.end(err);
     t.pass('test data set created');
     t.end();

test/db/create_test_db.sql

@@ -1,3 +1,3 @@
 create database jambones_test;
-create user jambones_test@localhost IDENTIFIED WITH mysql_native_password by 'jambones_test';
-grant all on jambones_test.* to jambones_test@localhost;
+create user jambones_test@'%' IDENTIFIED WITH mysql_native_password by 'jambones_test';
+grant all on jambones_test.* to jambones_test@'%';

test/db/jambones-sql.sql

@@ -1,36 +1,126 @@
 /* SQLEditor (MySQL (2))*/
 
-SET FOREIGN_KEY_CHECKS = 0;
+SET FOREIGN_KEY_CHECKS=0;
+
+DROP TABLE IF EXISTS account_static_ips;
+
+DROP TABLE IF EXISTS account_limits;
+
+DROP TABLE IF EXISTS account_products;
+
+DROP TABLE IF EXISTS account_subscriptions;
+
+DROP TABLE IF EXISTS beta_invite_codes;
 
 DROP TABLE IF EXISTS call_routes;
 
+DROP TABLE IF EXISTS clients;
+
+DROP TABLE IF EXISTS dns_records;
+
+DROP TABLE IF EXISTS lcr;
+
 DROP TABLE IF EXISTS lcr_carrier_set_entry;
 
 DROP TABLE IF EXISTS lcr_routes;
 
-DROP TABLE IF EXISTS ms_teams_tenants;
+DROP TABLE IF EXISTS password_settings;
+
+DROP TABLE IF EXISTS user_permissions;
+
+DROP TABLE IF EXISTS permissions;
+
+DROP TABLE IF EXISTS predefined_sip_gateways;
+
+DROP TABLE IF EXISTS predefined_smpp_gateways;
+
+DROP TABLE IF EXISTS predefined_carriers;
+
+DROP TABLE IF EXISTS account_offers;
+
+DROP TABLE IF EXISTS products;
+
+DROP TABLE IF EXISTS schema_version;
 
 DROP TABLE IF EXISTS api_keys;
 
 DROP TABLE IF EXISTS sbc_addresses;
 
+DROP TABLE IF EXISTS ms_teams_tenants;
+
+DROP TABLE IF EXISTS service_provider_limits;
+
+DROP TABLE IF EXISTS signup_history;
+
+DROP TABLE IF EXISTS smpp_addresses;
+
+DROP TABLE IF EXISTS google_custom_voices;
+
+DROP TABLE IF EXISTS speech_credentials;
+
+DROP TABLE IF EXISTS system_information;
+
 DROP TABLE IF EXISTS users;
 
+DROP TABLE IF EXISTS smpp_gateways;
+
 DROP TABLE IF EXISTS phone_numbers;
 
 DROP TABLE IF EXISTS sip_gateways;
 
 DROP TABLE IF EXISTS voip_carriers;
 
-DROP TABLE IF EXISTS applications;
-
 DROP TABLE IF EXISTS accounts;
 
+DROP TABLE IF EXISTS applications;
+
 DROP TABLE IF EXISTS service_providers;
 
 DROP TABLE IF EXISTS webhooks;
 
-SET FOREIGN_KEY_CHECKS = 1;
+CREATE TABLE account_static_ips
+(
+account_static_ip_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+public_ipv4 VARCHAR(16) NOT NULL UNIQUE ,
+private_ipv4 VARBINARY(16) NOT NULL UNIQUE ,
+PRIMARY KEY (account_static_ip_sid)
+);
+
+CREATE TABLE account_limits
+(
+account_limits_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device','voice_call_minutes','voice_call_session_license', 'voice_call_minutes_license') NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (account_limits_sid)
+);
+
+CREATE TABLE account_subscriptions
+(
+account_subscription_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+pending BOOLEAN NOT NULL DEFAULT false,
+effective_start_date DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+effective_end_date DATETIME,
+change_reason VARCHAR(255),
+stripe_subscription_id VARCHAR(56),
+stripe_payment_method_id VARCHAR(56),
+stripe_statement_descriptor VARCHAR(255),
+last4 VARCHAR(512),
+exp_month INTEGER,
+exp_year INTEGER,
+card_type VARCHAR(16),
+pending_reason VARBINARY(52),
+PRIMARY KEY (account_subscription_sid)
+);
+
+CREATE TABLE beta_invite_codes
+(
+invite_code CHAR(6) NOT NULL UNIQUE ,
+in_use BOOLEAN NOT NULL DEFAULT false,
+PRIMARY KEY (invite_code)
+);
 
 CREATE TABLE call_routes
 (
@@ -40,26 +130,140 @@ account_sid CHAR(36) NOT NULL,
 regex VARCHAR(255) NOT NULL,
 application_sid CHAR(36) NOT NULL,
 PRIMARY KEY (call_route_sid)
-) ENGINE=InnoDB COMMENT='a regex-based pattern match for call routing';
+) COMMENT='a regex-based pattern match for call routing';
+
+CREATE TABLE clients
+(
+client_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+is_active BOOLEAN NOT NULL DEFAULT 1,
+username VARCHAR(64),
+password VARCHAR(1024),
+allow_direct_app_calling BOOLEAN NOT NULL DEFAULT 1,
+allow_direct_queue_calling BOOLEAN NOT NULL DEFAULT 1,
+allow_direct_user_calling BOOLEAN NOT NULL DEFAULT 1,
+PRIMARY KEY (client_sid)
+);
+
+CREATE TABLE dns_records
+(
+dns_record_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+record_type VARCHAR(6) NOT NULL,
+record_id INTEGER NOT NULL,
+PRIMARY KEY (dns_record_sid)
+);
 
 CREATE TABLE lcr_routes
 (
 lcr_route_sid CHAR(36),
+lcr_sid CHAR(36) NOT NULL,
 regex VARCHAR(32) NOT NULL COMMENT 'regex-based pattern match against dialed number, used for LCR routing of PSTN calls',
 description VARCHAR(1024),
-priority INTEGER NOT NULL UNIQUE  COMMENT 'lower priority routes are attempted first',
+priority INTEGER NOT NULL COMMENT 'lower priority routes are attempted first',
 PRIMARY KEY (lcr_route_sid)
-) COMMENT='Least cost routing table';
+) COMMENT='An ordered list of  digit patterns in an LCR table.  The pat';
 
-CREATE TABLE ms_teams_tenants
+CREATE TABLE lcr
 (
-ms_teams_tenant_sid CHAR(36) NOT NULL UNIQUE ,
-service_provider_sid CHAR(36) NOT NULL,
+lcr_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) COMMENT 'User-assigned name for this LCR table',
+is_active BOOLEAN NOT NULL DEFAULT 1,
+default_carrier_set_entry_sid CHAR(36) COMMENT 'default carrier/route to use when no digit match based results are found.',
+service_provider_sid CHAR(36),
 account_sid CHAR(36),
-application_sid CHAR(36),
-tenant_fqdn VARCHAR(255) NOT NULL UNIQUE ,
-PRIMARY KEY (ms_teams_tenant_sid)
-) COMMENT='A Microsoft Teams customer tenant';
+PRIMARY KEY (lcr_sid)
+) COMMENT='An LCR (least cost routing) table that is used by a service ';
+
+CREATE TABLE password_settings
+(
+min_password_length INTEGER NOT NULL DEFAULT 8,
+require_digit BOOLEAN NOT NULL DEFAULT false,
+require_special_character BOOLEAN NOT NULL DEFAULT false
+);
+
+CREATE TABLE permissions
+(
+permission_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(32) NOT NULL UNIQUE ,
+description VARCHAR(255),
+PRIMARY KEY (permission_sid)
+);
+
+CREATE TABLE predefined_carriers
+(
+predefined_carrier_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
+requires_static_ip BOOLEAN NOT NULL DEFAULT false,
+e164_leading_plus BOOLEAN NOT NULL DEFAULT false COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
+tech_prefix VARCHAR(16) COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+inbound_auth_username VARCHAR(64),
+inbound_auth_password VARCHAR(64),
+diversion VARCHAR(32),
+trunk_type ENUM('static_ip','auth','reg') NOT NULL DEFAULT 'static_ip',
+PRIMARY KEY (predefined_carrier_sid)
+);
+
+CREATE TABLE predefined_sip_gateways
+(
+predefined_sip_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
+port INTEGER NOT NULL DEFAULT 5060 COMMENT 'sip signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+netmask INTEGER NOT NULL DEFAULT 32,
+predefined_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (predefined_sip_gateway_sid)
+);
+
+CREATE TABLE predefined_smpp_gateways
+(
+predefined_smpp_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway. ',
+port INTEGER NOT NULL DEFAULT 2775 COMMENT 'smpp signaling port',
+inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound SMS from the gateway',
+outbound BOOLEAN NOT NULL COMMENT 'i',
+netmask INTEGER NOT NULL DEFAULT 32,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+use_tls BOOLEAN DEFAULT 0,
+predefined_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (predefined_smpp_gateway_sid)
+);
+
+CREATE TABLE products
+(
+product_sid CHAR(36) NOT NULL UNIQUE ,
+name VARCHAR(32) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device') NOT NULL,
+PRIMARY KEY (product_sid)
+);
+
+CREATE TABLE account_products
+(
+account_product_sid CHAR(36) NOT NULL UNIQUE ,
+account_subscription_sid CHAR(36) NOT NULL,
+product_sid CHAR(36) NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (account_product_sid)
+);
+
+CREATE TABLE account_offers
+(
+account_offer_sid CHAR(36) NOT NULL UNIQUE ,
+account_sid CHAR(36) NOT NULL,
+product_sid CHAR(36) NOT NULL,
+stripe_product_id VARCHAR(56) NOT NULL,
+PRIMARY KEY (account_offer_sid)
+);
+
+CREATE TABLE schema_version
+(
+version VARCHAR(16)
+);
 
 CREATE TABLE api_keys
 (
@@ -67,68 +271,205 @@ api_key_sid CHAR(36) NOT NULL UNIQUE ,
 token CHAR(36) NOT NULL UNIQUE ,
 account_sid CHAR(36),
 service_provider_sid CHAR(36),
-expires_at TIMESTAMP,
+expires_at TIMESTAMP NULL  DEFAULT NULL,
+last_used TIMESTAMP NULL  DEFAULT NULL,
+created_at TIMESTAMP DEFAULT CURRENT_TIMESTAMP,
 PRIMARY KEY (api_key_sid)
-) ENGINE=InnoDB COMMENT='An authorization token that is used to access the REST api';
+) COMMENT='An authorization token that is used to access the REST api';
 
 CREATE TABLE sbc_addresses
 (
 sbc_address_sid CHAR(36) NOT NULL UNIQUE ,
 ipv4 VARCHAR(255) NOT NULL,
 port INTEGER NOT NULL DEFAULT 5060,
+tls_port INTEGER,
+wss_port INTEGER,
 service_provider_sid CHAR(36),
+last_updated DATETIME,
 PRIMARY KEY (sbc_address_sid)
 );
 
+CREATE TABLE ms_teams_tenants
+(
+ms_teams_tenant_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36) NOT NULL,
+account_sid CHAR(36) NOT NULL,
+application_sid CHAR(36),
+tenant_fqdn VARCHAR(255) NOT NULL UNIQUE ,
+PRIMARY KEY (ms_teams_tenant_sid)
+) COMMENT='A Microsoft Teams customer tenant';
+
+CREATE TABLE service_provider_limits
+(
+service_provider_limits_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36) NOT NULL,
+category ENUM('api_rate','voice_call_session', 'device','voice_call_minutes','voice_call_session_license', 'voice_call_minutes_license') NOT NULL,
+quantity INTEGER NOT NULL,
+PRIMARY KEY (service_provider_limits_sid)
+);
+
+CREATE TABLE signup_history
+(
+email VARCHAR(255) NOT NULL,
+name VARCHAR(255),
+signed_up_at DATETIME DEFAULT CURRENT_TIMESTAMP,
+PRIMARY KEY (email)
+);
+
+CREATE TABLE smpp_addresses
+(
+smpp_address_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(255) NOT NULL,
+port INTEGER NOT NULL DEFAULT 5060,
+use_tls BOOLEAN NOT NULL DEFAULT 0,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+service_provider_sid CHAR(36),
+PRIMARY KEY (smpp_address_sid)
+);
+
+CREATE TABLE speech_credentials
+(
+speech_credential_sid CHAR(36) NOT NULL UNIQUE ,
+service_provider_sid CHAR(36),
+account_sid CHAR(36),
+vendor VARCHAR(32) NOT NULL,
+credential VARCHAR(8192) NOT NULL,
+use_for_tts BOOLEAN DEFAULT true,
+use_for_stt BOOLEAN DEFAULT true,
+last_used DATETIME,
+last_tested DATETIME,
+tts_tested_ok BOOLEAN,
+stt_tested_ok BOOLEAN,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+label VARCHAR(64),
+PRIMARY KEY (speech_credential_sid)
+);
+
+CREATE TABLE google_custom_voices
+(
+google_custom_voice_sid CHAR(36) NOT NULL UNIQUE ,
+speech_credential_sid CHAR(36) NOT NULL,
+model VARCHAR(512) NOT NULL,
+reported_usage ENUM('REPORTED_USAGE_UNSPECIFIED','REALTIME','OFFLINE') DEFAULT 'REALTIME',
+name VARCHAR(64) NOT NULL,
+voice_cloning_key MEDIUMTEXT,
+use_voice_cloning_key BOOLEAN DEFAULT false,
+PRIMARY KEY (google_custom_voice_sid)
+);
+
+CREATE TABLE system_information
+(
+domain_name VARCHAR(255),
+sip_domain_name VARCHAR(255),
+monitoring_domain_name VARCHAR(255),
+private_network_cidr VARCHAR(8192),
+log_level ENUM('info', 'debug') NOT NULL DEFAULT 'info'
+);
+
 CREATE TABLE users
 (
 user_sid CHAR(36) NOT NULL UNIQUE ,
-name CHAR(36) NOT NULL UNIQUE ,
-hashed_password VARCHAR(1024) NOT NULL,
-salt CHAR(16) NOT NULL,
-force_change BOOLEAN NOT NULL DEFAULT TRUE,
+name VARCHAR(255) NOT NULL,
+email VARCHAR(255) NOT NULL,
+pending_email VARCHAR(255),
+phone VARCHAR(20) UNIQUE ,
+hashed_password VARCHAR(1024),
+account_sid CHAR(36),
+service_provider_sid CHAR(36),
+force_change BOOLEAN NOT NULL DEFAULT FALSE,
+provider VARCHAR(255) NOT NULL,
+provider_userid VARCHAR(255),
+scope VARCHAR(16) NOT NULL DEFAULT 'read-write',
+phone_activation_code VARCHAR(16),
+email_activation_code VARCHAR(16),
+email_validated BOOLEAN NOT NULL DEFAULT false,
+phone_validated BOOLEAN NOT NULL DEFAULT false,
+email_content_opt_out BOOLEAN NOT NULL DEFAULT false,
+is_active BOOLEAN NOT NULL DEFAULT true,
 PRIMARY KEY (user_sid)
 );
 
 CREATE TABLE voip_carriers
 (
 voip_carrier_sid CHAR(36) NOT NULL UNIQUE ,
-name VARCHAR(64) NOT NULL UNIQUE ,
+name VARCHAR(64) NOT NULL,
 description VARCHAR(255),
-account_sid CHAR(36) COMMENT 'if provided, indicates this entity represents a customer PBX that is associated with a specific account',
+account_sid CHAR(36) COMMENT 'if provided, indicates this entity represents a sip trunk that is associated with a specific account',
+service_provider_sid CHAR(36),
 application_sid CHAR(36) COMMENT 'If provided, all incoming calls from this source will be routed to the associated application',
+e164_leading_plus BOOLEAN NOT NULL DEFAULT false COMMENT 'if true, a leading plus should be prepended to outbound phone numbers',
+requires_register BOOLEAN NOT NULL DEFAULT false,
+register_username VARCHAR(64),
+register_sip_realm VARCHAR(64),
+register_password VARCHAR(64),
+tech_prefix VARCHAR(16) COMMENT 'tech prefix to prepend to outbound calls to this carrier',
+inbound_auth_username VARCHAR(64),
+inbound_auth_password VARCHAR(64),
+diversion VARCHAR(32),
+is_active BOOLEAN NOT NULL DEFAULT true,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+smpp_system_id VARCHAR(255),
+smpp_password VARCHAR(64),
+smpp_enquire_link_interval INTEGER DEFAULT 0,
+smpp_inbound_system_id VARCHAR(255),
+smpp_inbound_password VARCHAR(64),
+register_from_user VARCHAR(128),
+register_from_domain VARCHAR(255),
+register_public_ip_in_contact BOOLEAN NOT NULL DEFAULT false,
+register_status VARCHAR(4096),
+dtmf_type ENUM('rfc2833','tones','info') NOT NULL DEFAULT 'rfc2833',
+outbound_sip_proxy VARCHAR(255),
+trunk_type ENUM('static_ip','auth','reg') NOT NULL DEFAULT 'static_ip',
 PRIMARY KEY (voip_carrier_sid)
-) ENGINE=InnoDB COMMENT='A Carrier or customer PBX that can send or receive calls';
+) COMMENT='A Carrier or customer PBX that can send or receive calls';
+
+CREATE TABLE user_permissions
+(
+user_permissions_sid CHAR(36) NOT NULL UNIQUE ,
+user_sid CHAR(36) NOT NULL,
+permission_sid CHAR(36) NOT NULL,
+PRIMARY KEY (user_permissions_sid)
+);
+
+CREATE TABLE smpp_gateways
+(
+smpp_gateway_sid CHAR(36) NOT NULL UNIQUE ,
+ipv4 VARCHAR(128) NOT NULL,
+port INTEGER NOT NULL DEFAULT 2775,
+netmask INTEGER NOT NULL DEFAULT 32,
+is_primary BOOLEAN NOT NULL DEFAULT 1,
+inbound BOOLEAN NOT NULL DEFAULT 0 COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
+outbound BOOLEAN NOT NULL DEFAULT 1 COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
+use_tls BOOLEAN DEFAULT 0,
+voip_carrier_sid CHAR(36) NOT NULL,
+PRIMARY KEY (smpp_gateway_sid)
+);
 
 CREATE TABLE phone_numbers
 (
 phone_number_sid CHAR(36) UNIQUE ,
-number VARCHAR(32) NOT NULL UNIQUE ,
-voip_carrier_sid CHAR(36) NOT NULL,
+number VARCHAR(132) NOT NULL,
+voip_carrier_sid CHAR(36),
 account_sid CHAR(36),
 application_sid CHAR(36),
+service_provider_sid CHAR(36) COMMENT 'if not null, this number is a test number for the associated service provider',
 PRIMARY KEY (phone_number_sid)
-) ENGINE=InnoDB COMMENT='A phone number that has been assigned to an account';
-
-CREATE TABLE webhooks
-(
-webhook_sid CHAR(36) NOT NULL UNIQUE ,
-url VARCHAR(1024) NOT NULL,
-method ENUM("GET","POST") NOT NULL DEFAULT 'POST',
-username VARCHAR(255),
-password VARCHAR(255),
-PRIMARY KEY (webhook_sid)
-) COMMENT='An HTTP callback';
+) COMMENT='A phone number that has been assigned to an account';
 
 CREATE TABLE sip_gateways
 (
 sip_gateway_sid CHAR(36),
 ipv4 VARCHAR(128) NOT NULL COMMENT 'ip address or DNS name of the gateway.  For gateways providing inbound calling service, ip address is required.',
-port INTEGER NOT NULL DEFAULT 5060 COMMENT 'sip signaling port',
+netmask INTEGER NOT NULL DEFAULT 32,
+port INTEGER COMMENT 'sip signaling port',
 inbound BOOLEAN NOT NULL COMMENT 'if true, whitelist this IP to allow inbound calls from the gateway',
 outbound BOOLEAN NOT NULL COMMENT 'if true, include in least-cost routing when placing calls to the PSTN',
 voip_carrier_sid CHAR(36) NOT NULL,
 is_active BOOLEAN NOT NULL DEFAULT 1,
+send_options_ping BOOLEAN NOT NULL DEFAULT 0,
+use_sips_scheme BOOLEAN NOT NULL DEFAULT 0,
+pad_crypto BOOLEAN NOT NULL DEFAULT 0,
+protocol ENUM('udp','tcp','tls', 'tls/srtp') DEFAULT 'udp' COMMENT 'Outbound call protocol',
 PRIMARY KEY (sip_gateway_sid)
 ) COMMENT='A whitelisted sip gateway used for origination/termination';
 
@@ -142,20 +483,46 @@ priority INTEGER NOT NULL DEFAULT 0 COMMENT 'lower priority carriers are attempt
 PRIMARY KEY (lcr_carrier_set_entry_sid)
 ) COMMENT='An entry in the LCR routing list';
 
+CREATE TABLE webhooks
+(
+webhook_sid CHAR(36) NOT NULL UNIQUE ,
+url VARCHAR(1024) NOT NULL,
+method ENUM("GET","POST") NOT NULL DEFAULT 'POST',
+username VARCHAR(255),
+password VARCHAR(255),
+PRIMARY KEY (webhook_sid)
+) COMMENT='An HTTP callback';
+
 CREATE TABLE applications
 (
 application_sid CHAR(36) NOT NULL UNIQUE ,
 name VARCHAR(64) NOT NULL,
-account_sid CHAR(36) NOT NULL COMMENT 'account that this application belongs to',
-call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls to phone numbers owned by this account',
+service_provider_sid CHAR(36) COMMENT 'if non-null, this application is a test application that can be used by any account under the associated service provider',
+account_sid CHAR(36) COMMENT 'account that this application belongs to (if null, this is a service provider test application)',
+call_hook_sid CHAR(36) COMMENT 'webhook to call for inbound calls ',
 call_status_hook_sid CHAR(36) COMMENT 'webhook to call for call status events',
+messaging_hook_sid CHAR(36) COMMENT 'webhook to call for inbound SMS/MMS ',
+app_json TEXT,
 speech_synthesis_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_synthesis_language VARCHAR(12) NOT NULL DEFAULT 'en-US',
-speech_synthesis_voice VARCHAR(64),
+speech_synthesis_voice VARCHAR(256) DEFAULT 'en-US-Standard-C',
+speech_synthesis_label VARCHAR(64),
 speech_recognizer_vendor VARCHAR(64) NOT NULL DEFAULT 'google',
 speech_recognizer_language VARCHAR(64) NOT NULL DEFAULT 'en-US',
+speech_recognizer_label VARCHAR(64),
+use_for_fallback_speech BOOLEAN DEFAULT false,
+fallback_speech_synthesis_vendor VARCHAR(64),
+fallback_speech_synthesis_language VARCHAR(12),
+fallback_speech_synthesis_voice VARCHAR(256),
+fallback_speech_synthesis_label VARCHAR(64),
+fallback_speech_recognizer_vendor VARCHAR(64),
+fallback_speech_recognizer_language VARCHAR(64),
+fallback_speech_recognizer_label VARCHAR(64),
+env_vars TEXT,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+record_all_calls BOOLEAN NOT NULL DEFAULT false,
 PRIMARY KEY (application_sid)
-) ENGINE=InnoDB COMMENT='A defined set of behaviors to be applied to phone calls ';
+) COMMENT='A defined set of behaviors to be applied to phone calls ';
 
 CREATE TABLE service_providers
 (
@@ -166,7 +533,7 @@ root_domain VARCHAR(128) UNIQUE ,
 registration_hook_sid CHAR(36),
 ms_teams_fqdn VARCHAR(255),
 PRIMARY KEY (service_provider_sid)
-) ENGINE=InnoDB COMMENT='A partition of the platform used by one service provider';
+) COMMENT='A partition of the platform used by one service provider';
 
 CREATE TABLE accounts
 (
@@ -175,72 +542,198 @@ name VARCHAR(64) NOT NULL,
 sip_realm VARCHAR(132) UNIQUE  COMMENT 'sip domain that will be used for devices registering under this account',
 service_provider_sid CHAR(36) NOT NULL COMMENT 'service provider that owns the customer relationship with this account',
 registration_hook_sid CHAR(36) COMMENT 'webhook to call when devices underr this account attempt to register',
+queue_event_hook_sid CHAR(36),
 device_calling_application_sid CHAR(36) COMMENT 'application to use for outbound calling from an account',
 is_active BOOLEAN NOT NULL DEFAULT true,
+created_at DATETIME NOT NULL DEFAULT CURRENT_TIMESTAMP,
+plan_type ENUM('trial','free','paid') NOT NULL DEFAULT 'trial',
+stripe_customer_id VARCHAR(56),
+webhook_secret VARCHAR(36) NOT NULL,
+disable_cdrs BOOLEAN NOT NULL DEFAULT 0,
+trial_end_date DATETIME,
+deactivated_reason VARCHAR(255),
+device_to_call_ratio INTEGER NOT NULL DEFAULT 5,
+subspace_client_id VARCHAR(255),
+subspace_client_secret VARCHAR(255),
+subspace_sip_teleport_id VARCHAR(255),
+subspace_sip_teleport_destinations VARCHAR(255),
+siprec_hook_sid CHAR(36),
+record_all_calls BOOLEAN NOT NULL DEFAULT false,
+record_format VARCHAR(16) NOT NULL DEFAULT 'mp3',
+bucket_credential VARCHAR(8192) COMMENT 'credential used to authenticate with storage service',
+enable_debug_log BOOLEAN NOT NULL DEFAULT false,
 PRIMARY KEY (account_sid)
-) ENGINE=InnoDB COMMENT='An enterprise that uses the platform for comm services';
+) COMMENT='An enterprise that uses the platform for comm services';
 
+CREATE INDEX account_static_ip_sid_idx ON account_static_ips (account_static_ip_sid);
+CREATE INDEX account_sid_idx ON account_static_ips (account_sid);
+ALTER TABLE account_static_ips ADD FOREIGN KEY account_sid_idxfk (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX account_sid_idx ON account_limits (account_sid);
+ALTER TABLE account_limits ADD FOREIGN KEY account_sid_idxfk_1 (account_sid) REFERENCES accounts (account_sid) ON DELETE CASCADE;
+
+CREATE INDEX account_subscription_sid_idx ON account_subscriptions (account_subscription_sid);
+CREATE INDEX account_sid_idx ON account_subscriptions (account_sid);
+ALTER TABLE account_subscriptions ADD FOREIGN KEY account_sid_idxfk_2 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX invite_code_idx ON beta_invite_codes (invite_code);
 CREATE INDEX call_route_sid_idx ON call_routes (call_route_sid);
-ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE call_routes ADD FOREIGN KEY application_sid_idxfk (application_sid) REFERENCES applications (application_sid);
 
-CREATE INDEX ms_teams_tenant_sid_idx ON ms_teams_tenants (ms_teams_tenant_sid);
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY service_provider_sid_idxfk (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+CREATE INDEX client_sid_idx ON clients (client_sid);
+ALTER TABLE clients ADD CONSTRAINT account_sid_idxfk_13 FOREIGN KEY account_sid_idxfk_13 (account_sid) REFERENCES accounts (account_sid);
 
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY account_sid_idxfk_1 (account_sid) REFERENCES accounts (account_sid);
+CREATE INDEX dns_record_sid_idx ON dns_records (dns_record_sid);
+ALTER TABLE dns_records ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
 
-ALTER TABLE ms_teams_tenants ADD FOREIGN KEY application_sid_idxfk_1 (application_sid) REFERENCES applications (application_sid);
+CREATE INDEX lcr_sid_idx ON lcr_routes (lcr_sid);
+ALTER TABLE lcr_routes ADD FOREIGN KEY lcr_sid_idxfk (lcr_sid) REFERENCES lcr (lcr_sid);
+
+CREATE INDEX lcr_sid_idx ON lcr (lcr_sid);
+ALTER TABLE lcr ADD FOREIGN KEY default_carrier_set_entry_sid_idxfk (default_carrier_set_entry_sid) REFERENCES lcr_carrier_set_entry (lcr_carrier_set_entry_sid);
+
+CREATE INDEX service_provider_sid_idx ON lcr (service_provider_sid);
+CREATE INDEX account_sid_idx ON lcr (account_sid);
+CREATE INDEX permission_sid_idx ON permissions (permission_sid);
+CREATE INDEX predefined_carrier_sid_idx ON predefined_carriers (predefined_carrier_sid);
+CREATE INDEX predefined_sip_gateway_sid_idx ON predefined_sip_gateways (predefined_sip_gateway_sid);
+CREATE INDEX predefined_carrier_sid_idx ON predefined_sip_gateways (predefined_carrier_sid);
+ALTER TABLE predefined_sip_gateways ADD FOREIGN KEY predefined_carrier_sid_idxfk (predefined_carrier_sid) REFERENCES predefined_carriers (predefined_carrier_sid);
+
+CREATE INDEX predefined_smpp_gateway_sid_idx ON predefined_smpp_gateways (predefined_smpp_gateway_sid);
+CREATE INDEX predefined_carrier_sid_idx ON predefined_smpp_gateways (predefined_carrier_sid);
+ALTER TABLE predefined_smpp_gateways ADD FOREIGN KEY predefined_carrier_sid_idxfk_1 (predefined_carrier_sid) REFERENCES predefined_carriers (predefined_carrier_sid);
+
+CREATE INDEX product_sid_idx ON products (product_sid);
+CREATE INDEX account_product_sid_idx ON account_products (account_product_sid);
+CREATE INDEX account_subscription_sid_idx ON account_products (account_subscription_sid);
+ALTER TABLE account_products ADD FOREIGN KEY account_subscription_sid_idxfk (account_subscription_sid) REFERENCES account_subscriptions (account_subscription_sid);
+
+ALTER TABLE account_products ADD FOREIGN KEY product_sid_idxfk (product_sid) REFERENCES products (product_sid);
+
+CREATE INDEX account_offer_sid_idx ON account_offers (account_offer_sid);
+CREATE INDEX account_sid_idx ON account_offers (account_sid);
+ALTER TABLE account_offers ADD FOREIGN KEY account_sid_idxfk_5 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX product_sid_idx ON account_offers (product_sid);
+ALTER TABLE account_offers ADD FOREIGN KEY product_sid_idxfk_1 (product_sid) REFERENCES products (product_sid);
 
-CREATE INDEX tenant_fqdn_idx ON ms_teams_tenants (tenant_fqdn);
 CREATE INDEX api_key_sid_idx ON api_keys (api_key_sid);
 CREATE INDEX account_sid_idx ON api_keys (account_sid);
-ALTER TABLE api_keys ADD FOREIGN KEY account_sid_idxfk_2 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE api_keys ADD FOREIGN KEY account_sid_idxfk_6 (account_sid) REFERENCES accounts (account_sid);
 
 CREATE INDEX service_provider_sid_idx ON api_keys (service_provider_sid);
-ALTER TABLE api_keys ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+ALTER TABLE api_keys ADD FOREIGN KEY service_provider_sid_idxfk (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
 CREATE INDEX sbc_addresses_idx_host_port ON sbc_addresses (ipv4,port);
 
 CREATE INDEX sbc_address_sid_idx ON sbc_addresses (sbc_address_sid);
 CREATE INDEX service_provider_sid_idx ON sbc_addresses (service_provider_sid);
-ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_2 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX ms_teams_tenant_sid_idx ON ms_teams_tenants (ms_teams_tenant_sid);
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY service_provider_sid_idxfk_2 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY account_sid_idxfk_7 (account_sid) REFERENCES accounts (account_sid);
+
+ALTER TABLE ms_teams_tenants ADD FOREIGN KEY application_sid_idxfk_1 (application_sid) REFERENCES applications (application_sid);
+
+CREATE INDEX tenant_fqdn_idx ON ms_teams_tenants (tenant_fqdn);
+CREATE INDEX service_provider_sid_idx ON service_provider_limits (service_provider_sid);
+ALTER TABLE service_provider_limits ADD FOREIGN KEY service_provider_sid_idxfk_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid) ON DELETE CASCADE;
+
+CREATE INDEX email_idx ON signup_history (email);
+CREATE INDEX smpp_address_sid_idx ON smpp_addresses (smpp_address_sid);
+CREATE INDEX service_provider_sid_idx ON smpp_addresses (service_provider_sid);
+ALTER TABLE smpp_addresses ADD FOREIGN KEY service_provider_sid_idxfk_4 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX speech_credential_sid_idx ON speech_credentials (speech_credential_sid);
+CREATE INDEX service_provider_sid_idx ON speech_credentials (service_provider_sid);
+ALTER TABLE speech_credentials ADD FOREIGN KEY service_provider_sid_idxfk_5 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX account_sid_idx ON speech_credentials (account_sid);
+ALTER TABLE speech_credentials ADD FOREIGN KEY account_sid_idxfk_8 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX google_custom_voice_sid_idx ON google_custom_voices (google_custom_voice_sid);
+CREATE INDEX speech_credential_sid_idx ON google_custom_voices (speech_credential_sid);
+ALTER TABLE google_custom_voices ADD FOREIGN KEY speech_credential_sid_idxfk (speech_credential_sid) REFERENCES speech_credentials (speech_credential_sid) ON DELETE CASCADE;
 
 CREATE INDEX user_sid_idx ON users (user_sid);
-CREATE INDEX name_idx ON users (name);
+CREATE INDEX email_idx ON users (email);
+CREATE INDEX phone_idx ON users (phone);
+CREATE INDEX account_sid_idx ON users (account_sid);
+ALTER TABLE users ADD FOREIGN KEY account_sid_idxfk_9 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON users (service_provider_sid);
+ALTER TABLE users ADD FOREIGN KEY service_provider_sid_idxfk_6 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
+CREATE INDEX email_activation_code_idx ON users (email_activation_code);
 CREATE INDEX voip_carrier_sid_idx ON voip_carriers (voip_carrier_sid);
-CREATE INDEX name_idx ON voip_carriers (name);
-ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERENCES accounts (account_sid);
+CREATE INDEX account_sid_idx ON voip_carriers (account_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_10 (account_sid) REFERENCES accounts (account_sid);
+
+CREATE INDEX service_provider_sid_idx ON voip_carriers (service_provider_sid);
+ALTER TABLE voip_carriers ADD FOREIGN KEY service_provider_sid_idxfk_7 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
 ALTER TABLE voip_carriers ADD FOREIGN KEY application_sid_idxfk_2 (application_sid) REFERENCES applications (application_sid);
 
-CREATE INDEX phone_number_sid_idx ON phone_numbers (phone_number_sid);
-CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
-ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+CREATE INDEX user_permissions_sid_idx ON user_permissions (user_permissions_sid);
+CREATE INDEX user_sid_idx ON user_permissions (user_sid);
+ALTER TABLE user_permissions ADD FOREIGN KEY user_sid_idxfk (user_sid) REFERENCES users (user_sid) ON DELETE CASCADE;
 
-ALTER TABLE phone_numbers ADD FOREIGN KEY account_sid_idxfk_4 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE user_permissions ADD FOREIGN KEY permission_sid_idxfk (permission_sid) REFERENCES permissions (permission_sid);
+
+CREATE INDEX smpp_gateway_sid_idx ON smpp_gateways (smpp_gateway_sid);
+CREATE INDEX voip_carrier_sid_idx ON smpp_gateways (voip_carrier_sid);
+ALTER TABLE smpp_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+CREATE UNIQUE INDEX phone_numbers_unique_idx_voip_carrier_number ON phone_numbers (number,voip_carrier_sid);
+
+CREATE INDEX phone_number_sid_idx ON phone_numbers (phone_number_sid);
+CREATE INDEX number_idx ON phone_numbers (number);
+CREATE INDEX voip_carrier_sid_idx ON phone_numbers (voip_carrier_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
+ALTER TABLE phone_numbers ADD FOREIGN KEY account_sid_idxfk_11 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE phone_numbers ADD FOREIGN KEY application_sid_idxfk_3 (application_sid) REFERENCES applications (application_sid);
 
-CREATE INDEX webhook_sid_idx ON webhooks (webhook_sid);
-CREATE UNIQUE INDEX sip_gateway_idx_hostport ON sip_gateways (ipv4,port);
+CREATE INDEX service_provider_sid_idx ON phone_numbers (service_provider_sid);
+ALTER TABLE phone_numbers ADD FOREIGN KEY service_provider_sid_idxfk_8 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
-ALTER TABLE sip_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk_1 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+CREATE INDEX sip_gateway_idx_hostport ON sip_gateways (ipv4,port);
+
+CREATE INDEX idx_sip_gateways_inbound_carrier ON sip_gateways (inbound,voip_carrier_sid);
+
+CREATE INDEX idx_sip_gateways_inbound_lookup ON sip_gateways (inbound,netmask,ipv4);
+
+CREATE INDEX idx_sip_gateways_inbound_netmask ON sip_gateways (inbound,netmask);
+
+CREATE INDEX voip_carrier_sid_idx ON sip_gateways (voip_carrier_sid);
+ALTER TABLE sip_gateways ADD FOREIGN KEY voip_carrier_sid_idxfk_2 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
 ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY lcr_route_sid_idxfk (lcr_route_sid) REFERENCES lcr_routes (lcr_route_sid);
 
-ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY voip_carrier_sid_idxfk_2 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY voip_carrier_sid_idxfk_3 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
 
+CREATE INDEX webhook_sid_idx ON webhooks (webhook_sid);
 CREATE UNIQUE INDEX applications_idx_name ON applications (account_sid,name);
 
 CREATE INDEX application_sid_idx ON applications (application_sid);
+CREATE INDEX service_provider_sid_idx ON applications (service_provider_sid);
+ALTER TABLE applications ADD FOREIGN KEY service_provider_sid_idxfk_9 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+
 CREATE INDEX account_sid_idx ON applications (account_sid);
-ALTER TABLE applications ADD FOREIGN KEY account_sid_idxfk_5 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE applications ADD FOREIGN KEY account_sid_idxfk_12 (account_sid) REFERENCES accounts (account_sid);
 
 ALTER TABLE applications ADD FOREIGN KEY call_hook_sid_idxfk (call_hook_sid) REFERENCES webhooks (webhook_sid);
 
 ALTER TABLE applications ADD FOREIGN KEY call_status_hook_sid_idxfk (call_status_hook_sid) REFERENCES webhooks (webhook_sid);
 
+ALTER TABLE applications ADD FOREIGN KEY messaging_hook_sid_idxfk (messaging_hook_sid) REFERENCES webhooks (webhook_sid);
+
 CREATE INDEX service_provider_sid_idx ON service_providers (service_provider_sid);
 CREATE INDEX name_idx ON service_providers (name);
 CREATE INDEX root_domain_idx ON service_providers (root_domain);
@@ -249,8 +742,14 @@ ALTER TABLE service_providers ADD FOREIGN KEY registration_hook_sid_idxfk (regis
 CREATE INDEX account_sid_idx ON accounts (account_sid);
 CREATE INDEX sip_realm_idx ON accounts (sip_realm);
 CREATE INDEX service_provider_sid_idx ON accounts (service_provider_sid);
-ALTER TABLE accounts ADD FOREIGN KEY service_provider_sid_idxfk_3 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
+ALTER TABLE accounts ADD FOREIGN KEY service_provider_sid_idxfk_10 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
 
 ALTER TABLE accounts ADD FOREIGN KEY registration_hook_sid_idxfk_1 (registration_hook_sid) REFERENCES webhooks (webhook_sid);
 
+ALTER TABLE accounts ADD FOREIGN KEY queue_event_hook_sid_idxfk (queue_event_hook_sid) REFERENCES webhooks (webhook_sid);
+
 ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (device_calling_application_sid) REFERENCES applications (application_sid);
+
+ALTER TABLE accounts ADD FOREIGN KEY siprec_hook_sid_idxfk (siprec_hook_sid) REFERENCES applications (application_sid);
+
+SET FOREIGN_KEY_CHECKS=0;

test/db/populate-test-data.sql

@@ -1,22 +1,142 @@
+-- create our products
+insert into products (product_sid, name, category)
+values
+('c4403cdb-8e75-4b27-9726-7d8315e3216d', 'concurrent call session', 'voice_call_session'),
+('2c815913-5c26-4004-b748-183b459329df', 'registered device', 'device'),
+('35a9fb10-233d-4eb9-aada-78de5814d680', 'api call', 'api_rate');
+
 insert into webhooks(webhook_sid, url, username, password) values('90dda62e-0ea2-47d1-8164-5bd49003476c', 'http://127.0.0.1:4000/auth', 'foo', 'bar');
 
 insert into service_providers (service_provider_sid, name, root_domain, registration_hook_sid) 
 values ('3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'SP A', 'jambonz.org', '90dda62e-0ea2-47d1-8164-5bd49003476c');
-insert into accounts(account_sid, service_provider_sid, name, sip_realm, registration_hook_sid)
-values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'sip.example.com', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+insert into service_provider_limits (service_provider_limits_sid, service_provider_sid, category, quantity) 
+values ('a79d3ade-e0da-4461-80f3-7c73f01e18b4', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'voice_call_session', 1);
 
-insert into voip_carriers (voip_carrier_sid, name) values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco');
+insert into accounts(account_sid, service_provider_sid, name, sip_realm, registration_hook_sid, webhook_secret)
+values ('ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'test account', 'jambonz.org', '90dda62e-0ea2-47d1-8164-5bd49003476c', 'foobar');
+insert into account_subscriptions(account_subscription_sid, account_sid, pending)
+values ('f4e1848d-3ff8-40eb-b9c1-30e1ef053f94','ed649e33-e771-403a-8c99-1780eabbc803',0);
+insert into account_products(account_product_sid, account_subscription_sid, product_sid,quantity)
+values ('f23ff996-6534-4aba-8666-4b347391eca2', 'f4e1848d-3ff8-40eb-b9c1-30e1ef053f94', 'c4403cdb-8e75-4b27-9726-7d8315e3216d', 10);
+
+insert into voip_carriers (voip_carrier_sid, name, account_sid, service_provider_sid) 
+values ('287c1452-620d-4195-9f19-c9814ef90d78', 'westco', 'ed649e33-e771-403a-8c99-1780eabbc803', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('124a5339-c62c-4075-9e19-f4de70a96597', '287c1452-620d-4195-9f19-c9814ef90d78', '172.38.0.20', true, true);
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, port, inbound, outbound) 
 values ('efbc4830-57cd-4c78-a56f-d64fdf210fe8', '287c1452-620d-4195-9f19-c9814ef90d78', '3.3.3.3', 5062, false, true);
 
 insert into webhooks(webhook_sid, url) values('4d7ce0aa-5ead-4e61-9a6b-3daa732218b1', 'http://example.com/status');
-insert into accounts (account_sid, name, service_provider_sid)
-values ('ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account A1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account A1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'delta.sip.jambonz.org');
+insert into account_subscriptions(account_subscription_sid, account_sid, pending)
+values ('4f3853e6-d8b0-43de-ba62-d9279801695d','ee9d7d49-b3e4-4fdb-9d66-661149f717e8',0);
+insert into account_products(account_product_sid, account_subscription_sid, product_sid,quantity)
+values ('61840638-ccde-4bc5-b645-5d32718c68a5', '4f3853e6-d8b0-43de-ba62-d9279801695d', 'c4403cdb-8e75-4b27-9726-7d8315e3216d', 10);
+
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('d7cc37cb-d152-49ef-a51b-485f6e917089', 'Account A1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'echo.sip.jambonz.org');
+insert into account_subscriptions(account_subscription_sid, account_sid, pending)
+values ('73bbcc5d-512f-4cea-8535-9a6e3d2bd19d','d7cc37cb-d152-49ef-a51b-485f6e917089',0);
+insert into account_products(account_product_sid, account_subscription_sid, product_sid,quantity)
+values ('92f137f7-4bc3-4157-b096-6817e54b1874', '73bbcc5d-512f-4cea-8535-9a6e3d2bd19d', 'c4403cdb-8e75-4b27-9726-7d8315e3216d', 0);
+insert into account_limits(account_limits_sid, account_sid, category, quantity) values('a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d', 'd7cc37cb-d152-49ef-a51b-485f6e917089', 'voice_call_session', 0);
+
+insert into voip_carriers (voip_carrier_sid, name, account_sid, service_provider_sid) 
+values ('9b1abdc7-0220-4964-bc66-32b5c70cd9ab', 'westco', 'd7cc37cb-d152-49ef-a51b-485f6e917089', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('12f401d9-cbb1-49e5-bd33-cefbca0badc3', '9b1abdc7-0220-4964-bc66-32b5c70cd9ab', '172.38.0.20', true, true);
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, port, inbound, outbound) 
+values ('1401eb72-0daf-4471-aba6-038a0a2587b3', '9b1abdc7-0220-4964-bc66-32b5c70cd9ab', '3.3.3.3', 5062, false, true);
+
+
 insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
 values ('3b43e39f-4346-4218-8434-a53130e8be49', 'test', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '4d7ce0aa-5ead-4e61-9a6b-3daa732218b1');
 
-insert into voip_carriers (voip_carrier_sid, name, account_sid, application_sid) values ('999c1452-620d-4195-9f19-c9814ef90d78', 'customer PBX', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '3b43e39f-4346-4218-8434-a53130e8be49');
+insert into voip_carriers (voip_carrier_sid, name, account_sid, application_sid, service_provider_sid) 
+values ('999c1452-620d-4195-9f19-c9814ef90d78', 'customer PBX', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '3b43e39f-4346-4218-8434-a53130e8be49', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
 insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
 values ('888a5339-c62c-4075-9e19-f4de70a96597', '999c1452-620d-4195-9f19-c9814ef90d78', '172.38.0.21', true, false);
+ 
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('999a5339-c62c-4075-9e19-f4de70a96597', '16173333456', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('29543d4e-d959-4a25-836a-cde7161cd7d5', '1508222*', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('dddd5c34-feae-4d70-98af-bb4d1f8dc965', '1508*', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('d458bf7a-bcea-47b2-ac96-66dfc9c5c220', '150822233*', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803');
+
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid)
+values ('f7ad205d-b92f-4363-8160-f8b5216b40d3', '15083871234', '287c1452-620d-4195-9f19-c9814ef90d78', 'd7cc37cb-d152-49ef-a51b-485f6e917089');
+
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('c17d5a7d-9328-4663-92c0-f65aa8381264', '12125551212', '287c1452-620d-4195-9f19-c9814ef90d78', 'ed649e33-e771-403a-8c99-1780eabbc803', '3b43e39f-4346-4218-8434-a53130e8be49');
+
+-- two accounts that both have the same carrier with default routing (ambiguity test)
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('239d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account B1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'echo2.sip.jambonz.org');
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('909d7d49-b3e4-4fdb-9d66-661149f717e8', 'Account B2', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'foxtrot.sip.jambonz.org');
+
+insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
+values ('8843e39f-4346-4218-8434-a53130e8be49', 'test', '239d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '4d7ce0aa-5ead-4e61-9a6b-3daa732218b1');
+insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
+values ('7743e39f-4346-4218-8434-a53130e8be49', 'test', '909d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '4d7ce0aa-5ead-4e61-9a6b-3daa732218b1');
+
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid, account_sid, application_sid) 
+values ('731abdc7-0220-4964-bc66-32b5c70cd9ab', 'twilio-1', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', '239d7d49-b3e4-4fdb-9d66-661149f717e8', '8843e39f-4346-4218-8434-a53130e8be49');
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid, account_sid, application_sid) 
+values ('987abdc7-0220-4964-bc66-32b5c70cd9ab', 'twilio-2', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', '909d7d49-b3e4-4fdb-9d66-661149f717e8', '7743e39f-4346-4218-8434-a53130e8be49');
+
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('664a5339-c62c-4075-9e19-f4de70a96597', '731abdc7-0220-4964-bc66-32b5c70cd9ab', '172.38.0.40', true, false);
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('554a5339-c62c-4075-9e19-f4de70a96597', '987abdc7-0220-4964-bc66-32b5c70cd9ab', '172.38.0.40', true, false);
+
+-- voip carrier belonging to all accounts
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) 
+values ('voip100', 'test-voip-carrier', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('sip100', 'voip100', '172.38.0.50', true, false);
+
+insert into voip_carriers (voip_carrier_sid, name, service_provider_sid) 
+values ('voip101', 'test-voip-carrier-101', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0');
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('sip101', 'voip101', '172.38.0.50', true, false);
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound) 
+values ('sip102', 'voip101', '172.38.0.51', true, false);
+
+insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
+values ('app100', 'app100', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+insert into applications (application_sid, name, account_sid, call_hook_sid, call_status_hook_sid)
+values ('app101', 'app101', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', '90dda62e-0ea2-47d1-8164-5bd49003476c', '90dda62e-0ea2-47d1-8164-5bd49003476c');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('phone100', '^100', 'voip101', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'app100');
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('phone101', '^10012', 'voip100', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'app101');
+-- insert an invalid regex pattern, the below pattern should be ignored during pattern
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('phone102', '\\dkjfhmdf\\', 'voip100', 'ee9d7d49-b3e4-4fdb-9d66-661149f717e8', 'app101');
+
+-- account with a sip realm that is not associated with any voip carriers
+insert into accounts (account_sid, name, service_provider_sid, webhook_secret, sip_realm)
+values ('acct-100', 'Account 100', '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'foobar', 'ram.sip.jambonz.org');
+
+-- registration trunk carrier for ephemeral gateway testing
+insert into voip_carriers (voip_carrier_sid, name, account_sid, service_provider_sid, trunk_type,
+    requires_register, register_username, register_sip_realm, register_password, is_active)
+values ('4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', 'test-registration-trunk', 'ed649e33-e771-403a-8c99-1780eabbc803',
+    '3f35518f-5a0d-4c2e-90a5-2407bb3b36f0', 'reg', true, 'testuser',
+    'sip.carrier.example.com', 'testpass', true);
+
+-- sip_gateway for outbound only (inbound will use ephemeral gateway from Redis)
+insert into sip_gateways (sip_gateway_sid, voip_carrier_sid, ipv4, inbound, outbound)
+values ('8b3e5f9a-2c1d-4e7b-9a6c-3d8f1e5a7b2c', '4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', '3.3.3.3', false, true);
+
+-- phone number for ephemeral gateway test
+insert into phone_numbers (phone_number_sid, number, voip_carrier_sid, account_sid, application_sid)
+values ('7c2d4e6f-8a1b-4c9d-7e5f-2a8b3c6d9e1f', '16175551000', '4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', 'ed649e33-e771-403a-8c99-1780eabbc803',
+    '3b43e39f-4346-4218-8434-a53130e8be49');

test/docker-compose-testbed.yaml

@@ -7,15 +7,32 @@ networks:
       config:
         - subnet: 172.38.0.0/16
 
-services:
+services:  
+  mysql:
+    image: mysql:5.7
+    platform: linux/x86_64
+    ports:
+      - "3306:3306"
+    environment: 
+      MYSQL_ALLOW_EMPTY_PASSWORD: "yes"
+    healthcheck:
+      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost", "--protocol", "tcp"]
+      timeout: 5s
+      retries: 15    
+    networks:
+      sbc-inbound:
+        ipv4_address: 172.38.0.2
   sbc:
-    image: drachtio/drachtio-server:latest
+    image: drachtio/drachtio-server:0.8.26
     command: drachtio --contact "sip:*;transport=udp" --loglevel debug --sofia-loglevel 9
     ports:
       - "9060:9022/tcp"
     networks:
       sbc-inbound:
         ipv4_address: 172.38.0.10
+    depends_on:
+      mysql:
+        condition: service_healthy
 
   appserver:
     image: drachtio/sipp:latest
@@ -47,9 +64,17 @@ services:
 
   rtpengine:
     image: drachtio/rtpengine:latest
+    command: rtpengine --interface private/172.38.0.14 --interface public/172.38.0.14!172.38.0.14
     ports:
       - "12222:22222/udp"
     networks:
       sbc-inbound:
         ipv4_address: 172.38.0.14
 
+  influxdb:
+    image: influxdb:1.8
+    ports:
+      - "8086:8086"
+    networks:
+      sbc-inbound:
+        ipv4_address: 172.38.0.90

test/docker_start.js

@@ -1,9 +1,9 @@
 const test = require('tape').test ;
 const exec = require('child_process').exec ;
-const async = require('async');
 
 test('starting docker network..', (t) => {
   exec(`docker-compose -f ${__dirname}/docker-compose-testbed.yaml up -d`, (err, stdout, stderr) => {
+    t.pass('docker is up');
     t.end(err);
   });
   

test/index.js

@@ -1,5 +1,5 @@
 require('./docker_start');
 require('./create-test-db');
 require('./sip-tests');
-require('./remove-test-db');
 require('./docker_stop');
+require('./utils');

test/remove-test-db.js

@@ -1,11 +0,0 @@
-const test = require('tape').test ;
-const exec = require('child_process').exec ;
-const pwd = process.env.TRAVIS ? '' : '-p$MYSQL_ROOT_PASSWORD';
-
-test('dropping jambones_test database', (t) => {
-  exec(`mysql -h localhost -u root ${pwd} < ${__dirname}/db/remove_test_db.sql`, (err, stdout, stderr) => {
-    if (err) return t.end(err);
-    t.pass('database successfully dropped');
-    t.end();
-  });
-});

test/scenarios/uac-device-unknown-realm.xml

@@ -53,7 +53,7 @@
   <recv response="100" optional="true">
   </recv>
 
-  <recv response="403">
+  <recv response="404">
   </recv>
 
   <send>

test/scenarios/uac-did-applicationsid-loop.xml

@@ -0,0 +1,36 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+<scenario name="UAC with x-application-sid header">
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+12125551212@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:12125551212@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+      X-Application-Sid: 3b43e39f-4346-4218-8434-a53130e8be49
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[media_ip_type] [media_ip]
+      t=0 0
+      m=audio [media_port] RTP/AVP 0
+      a=rtpmap:0 PCMU/8000
+]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+                
+  <recv response="482" rtd="true" >
+  </recv>
+
+</scenario>

test/scenarios/uac-did-regex-match-vc-all-accts-nosiprealm.xml

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:100678@172.38.0.10:5060 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@172.38.0.10:5060>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:100678@172.38.0.10:5060 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@172.38.0.10:5060>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:100678@172.38.0.10:5060 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@172.38.0.10:5060>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-did-regex-match-vc-all-accts.xml

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+100678@ram.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@ram.sip.jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:100678@ram.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@ram.sip.jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:100678@ram.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:100678@ram.sip.jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-did-regex-match.xml

@@ -0,0 +1,118 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+15082223333@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15082223333@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:15082223333@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15082223333@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:15082223333@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15082223333@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-carrier-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-late-media.xml

@@ -0,0 +1,120 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+16173333456@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16173333456@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-late-media
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16173333456@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16173333456@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-late-media
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:16173333456@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16173333456@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-late-media
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>
+

test/scenarios/uac-pcap-carrier-fail-ambiguous.xml

@@ -0,0 +1,70 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+15083871234@172.38.0.10 SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15083871234@172.38.0.10>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-fail-ambiguous
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="503" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:15083871234@172.38.0.10 SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15083871234@172.38.0.10>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-fail-ambiguous
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>

test/scenarios/uac-pcap-carrier-max-call-limit.xml

@@ -0,0 +1,71 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+15083871234@echo.sip.jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15083871234@echo.sip.jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-max-call-limit
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="503" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:15083871234@echo.sip.jambonz.org SIP/2.0
+      [last_Via]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:15083871234@echo.sip.jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-carrier-max-call-limit
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>
+

test/scenarios/uac-pcap-carrier-success.xml

@@ -25,10 +25,10 @@
   <send retrans="500">
     <![CDATA[
 
-      INVITE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      INVITE sip:+16173333456@jambonz.org SIP/2.0
       Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
       From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
-      To: [service] <sip:[service]@[remote_ip]:[remote_port]>
+      To: <sip:16173333456@jambonz.org>
       Call-ID: [call_id]
       CSeq: 1 INVITE
       Contact: sip:sipp@[local_ip]:[local_port]
@@ -67,10 +67,10 @@
   <send>
     <![CDATA[
 
-      ACK sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      ACK sip:16173333456@jambonz.org SIP/2.0
       Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
       From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
-      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      To: <sip:16173333456@jambonz.org>[peer_tag_param]
       Call-ID: [call_id]
       CSeq: 1 ACK
       Max-Forwards: 70
@@ -94,10 +94,10 @@
   <send retrans="500">
     <![CDATA[
 
-      BYE sip:[service]@[remote_ip]:[remote_port] SIP/2.0
+      BYE sip:16173333456@jambonz.org SIP/2.0
       Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
       From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
-      To: [service] <sip:[service]@[remote_ip]:[remote_port]>[peer_tag_param]
+      To: <sip:16173333456@jambonz.org>[peer_tag_param]
       Call-ID: [call_id]
       CSeq: 2 BYE
       Subject: uac-pcap-carrier-success

test/scenarios/uac-pcap-ephemeral-gateway-success.xml

@@ -0,0 +1,119 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE scenario SYSTEM "sipp.dtd">
+
+<!-- This program is free software; you can redistribute it and/or      -->
+<!-- modify it under the terms of the GNU General Public License as     -->
+<!-- published by the Free Software Foundation; either version 2 of the -->
+<!-- License, or (at your option) any later version.                    -->
+<!--                                                                    -->
+<!-- This program is distributed in the hope that it will be useful,    -->
+<!-- but WITHOUT ANY WARRANTY; without even the implied warranty of     -->
+<!-- MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the      -->
+<!-- GNU General Public License for more details.                       -->
+<!--                                                                    -->
+<!-- You should have received a copy of the GNU General Public License  -->
+<!-- along with this program; if not, write to the                      -->
+<!-- Free Software Foundation, Inc.,                                    -->
+<!-- 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA             -->
+<!--                                                                    -->
+<!--                 Sipp 'uac' scenario with pcap (rtp) play           -->
+<!--                                                                    -->
+
+<scenario name="UAC with media">
+  <!-- In client mode (sipp placing calls), the Call-ID MUST be         -->
+  <!-- generated by sipp. To do so, use [call_id] keyword.                -->
+  <send retrans="500">
+    <![CDATA[
+
+      INVITE sip:+16175551000@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16175551000@jambonz.org>
+      Call-ID: [call_id]
+      CSeq: 1 INVITE
+      Contact: sip:sipp@[local_ip]:[local_port]
+      Max-Forwards: 70
+      Subject: uac-pcap-ephemeral-gateway-success
+      Content-Type: application/sdp
+      Content-Length: [len]
+
+      v=0
+      o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]
+      s=-
+      c=IN IP[local_ip_type] [local_ip]
+      t=0 0
+      m=audio [auto_media_port] RTP/AVP 8 101
+      a=rtpmap:8 PCMA/8000
+      a=rtpmap:101 telephone-event/8000
+      a=fmtp:101 0-11,16
+
+    ]]>
+  </send>
+
+  <recv response="100" optional="true">
+  </recv>
+
+  <recv response="180" optional="true">
+  </recv>
+
+  <!-- By adding rrs="true" (Record Route Sets), the route sets         -->
+  <!-- are saved and used for following messages sent. Useful to test   -->
+  <!-- against stateful SIP proxies/B2BUAs.                             -->
+  <recv response="200" rtd="true" crlf="true">
+  </recv>
+
+  <!-- Packet lost can be simulated in any send/recv message by         -->
+  <!-- by adding the 'lost = "10"'. Value can be [1-100] percent.       -->
+  <send>
+    <![CDATA[
+
+      ACK sip:16175551000@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16175551000@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 1 ACK
+      Max-Forwards: 70
+      Subject: uac-pcap-ephemeral-gateway-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <!-- Play a pre-recorded PCAP file (RTP stream)                       -->
+  <nop>
+    <action>
+      <exec play_pcap_audio="pcap/g711a.pcap"/>
+    </action>
+  </nop>
+
+  <!-- Pause briefly      -->
+  <pause milliseconds="3000"/>
+
+  <!-- The 'crlf' option inserts a blank line in the statistics report. -->
+  <send retrans="500">
+    <![CDATA[
+
+      BYE sip:16175551000@jambonz.org SIP/2.0
+      Via: SIP/2.0/[transport] [local_ip]:[local_port];branch=[branch]
+      From: sipp <sip:sipp@[local_ip]:[local_port]>;tag=[pid]SIPpTag09[call_number]
+      To: <sip:16175551000@jambonz.org>[peer_tag_param]
+      Call-ID: [call_id]
+      CSeq: 2 BYE
+      Subject: uac-pcap-ephemeral-gateway-success
+      Content-Length: 0
+
+    ]]>
+  </send>
+
+  <recv response="200" crlf="true">
+  </recv>
+
+  <!-- definition of the response time repartition table (unit is ms)   -->
+  <ResponseTimeRepartition value="10, 20, 30, 40, 50, 100, 150, 200"/>
+
+  <!-- definition of the call length repartition table (unit is ms)     -->
+  <CallLengthRepartition value="10, 50, 100, 500, 1000, 5000, 10000"/>
+
+</scenario>
+

test/scenarios/uac-pcap-pbx-success.xml

@@ -36,6 +36,8 @@
       Subject: uac-pcap-carrier-success
       Content-Type: application/sdp
       Content-Length: [len]
+      X-Authenticated-User: xhoaluu@jambonz.org
+      X-Application-Sid: APP_ID_1
 
       v=0
       o=user1 53655765 2353687637 IN IP[local_ip_type] [local_ip]

test/scenarios/uas.xml

@@ -124,7 +124,24 @@
   ]]>
 </send>
 
+<recv request="BYE">
+</recv>
+
+<send next="2">
+  <![CDATA[
+
+    SIP/2.0 200 OK
+    [last_Via:]
+    [last_From:]
+    [last_To:]
+    [last_Call-ID:]
+    [last_CSeq:]
+    Contact: <sip:[local_ip]:[local_port];transport=[transport]>
+    Content-Length: 0
+
+  ]]>
+</send>
+
 <label id="2"/>
 
 </scenario>
-

test/sip-tests.js

@@ -1,7 +1,7 @@
-const test = require('blue-tape');
-const { output, sippUac } = require('./sipp')('test_sbc-inbound');
-const debug = require('debug')('drachtio:sbc-inbound');
-const clearModule = require('clear-module');
+const test = require('tape');
+const { sippUac } = require('./sipp')('test_sbc-inbound');
+const bent = require('bent');
+const getJSON = bent('json');
 
 process.on('unhandledRejection', (reason, p) => {
   console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
@@ -15,60 +15,89 @@ function connect(connectable) {
   });
 }
 
-test('incoming call tests', (t) => {
-  const {srf} = require('../app');
+function waitFor(ms) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms * 1000);
+  });
+}
 
-  connect(srf)
-    .then(() => {
-      return sippUac('uac-pcap-carrier-success.xml', '172.38.0.20');
-    })
-    .then(() => {
-      return t.pass('incoming call from carrier completed successfully');
-    })
-    .then(() => {
-      return sippUac('uac-pcap-pbx-success.xml', '172.38.0.21');
-    })
-    .then(() => {
-      return t.pass('incoming call from customer PBX completed successfully');
-    })
-    .then(() => {
-      return sippUac('uac-pcap-device-success.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('incoming call from authenticated device completed successfully');
-    })
-    .then(() => {
-      return sippUac('uac-device-unknown-user.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('unknown user is rejected with a 403');
-    })
-    .then(() => {
-      return sippUac('uac-device-unknown-realm.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('unknown realm is rejected with a 403');
-    })
-    .then(() => {
-      return sippUac('uac-device-invalid-password.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('invalid password for valid user is rejected with a 403');
-    })
-    .then(() => {
-      return sippUac('uac-pcap-device-success-in-dialog-request.xml', '172.38.0.30');
-    })
-    .then(() => {
-      return t.pass('handles in-dialog requests');
-    })
-    .then(() => {
-      srf.disconnect();
-      t.end();
-      return;
-    })
-    .catch((err) => {
-      console.log(`error received: ${err}`);
-      if (srf) srf.disconnect();
-      t.error(err);
-    });
+test('incoming call tests', async(t) => {
+  const {srf} = require('../app');
+  const { queryCdrs } = srf.locals;
+  let res;
+  
+  try {
+    await connect(srf);
+
+    let obj = await getJSON('http://127.0.0.1:3050/');
+    t.ok(obj.calls === 0, 'HTTP GET / works (current call count)')
+    obj = await getJSON('http://127.0.0.1:3050/system-health');
+    t.ok(obj.calls === 0, 'HTTP GET /system-health works (health check)')
+
+    await sippUac('uac-late-media.xml', '172.38.0.20');
+    t.pass('incoming call with no SDP packet is rejected with a 488');
+
+    await sippUac('uac-did-applicationsid-loop.xml', '172.38.0.20');
+    t.pass('incoming call with x-application-sid header is rejected with 482');
+
+    await sippUac('uac-pcap-carrier-success.xml', '172.38.0.20');
+    t.pass('incoming call from carrier completed successfully');
+
+    // Test ephemeral gateway (registration trunk)
+    const { createEphemeralGateway } = srf.locals.realtimeDbHelpers;
+    await createEphemeralGateway('172.38.0.60', '4a7d1c8e-5f2b-4d9a-8e3c-6b5a9f1e4c7d', 3600);
+    await sippUac('uac-pcap-ephemeral-gateway-success.xml', '172.38.0.60');
+    t.pass('incoming call from ephemeral gateway (registration trunk) completed successfully');
+
+    await sippUac('uac-pcap-pbx-success.xml', '172.38.0.21');
+    t.pass('incoming call from account-level carrier completed successfully');
+  
+    await sippUac('uac-did-regex-match.xml', '172.38.0.20');
+    t.pass('incoming call matched by trailing wildcard *');
+  
+    await sippUac('uac-pcap-device-success.xml', '172.38.0.30');
+    t.pass('incoming call from authenticated device completed successfully');
+  
+    await sippUac('uac-device-unknown-user.xml', '172.38.0.30');
+    t.pass('unknown user is rejected with a 403');
+  
+    await sippUac('uac-device-unknown-realm.xml', '172.38.0.30');
+    t.pass('unknown realm is rejected with a 404');
+  
+    await sippUac('uac-device-invalid-password.xml', '172.38.0.30');
+    t.pass('invalid password for valid user is rejected with a 403');
+  
+    await sippUac('uac-pcap-device-success-in-dialog-request.xml', '172.38.0.30');
+    t.pass('handles in-dialog requests');
+  
+    await sippUac('uac-pcap-carrier-max-call-limit.xml', '172.38.0.20');
+    t.pass('rejects incoming call with 503 when max calls per account reached');
+
+    await sippUac('uac-did-regex-match-vc-all-accts.xml', '172.38.0.50');
+    t.pass('incoming call matched by trailing wildcard *, voice gateway belongs to all accounts, with sip realm');
+
+    await sippUac('uac-did-regex-match-vc-all-accts-nosiprealm.xml', '172.38.0.51');
+    t.pass('incoming call matched by trailing wildcard *, voice gateway belongs to all accounts, without sip realm');
+
+    await sippUac('uac-did-regex-match-vc-all-accts-nosiprealm.xml', '172.38.0.50');
+    t.pass('incoming call matched by trailing wildcard *, voice gateway belongs to all accounts, without sip realm');
+
+    /* switch off this env for remaining tests (JAMBONES_HOSTING is for Saas sts) */
+    delete process.env.JAMBONES_HOSTING;
+    await sippUac('uac-pcap-carrier-fail-ambiguous.xml', '172.38.0.40');
+    t.pass('rejects incoming call with 503 when multiple accounts have same carrier witrh default routing')
+  
+    await waitFor(12);
+    const res = await queryCdrs({account_sid: 'ed649e33-e771-403a-8c99-1780eabbc803'});
+    console.log(`cdrs res.total: ${res.total}`);
+    //console.log(`cdrs: ${JSON.stringify(res)}`);
+    t.ok(8 === res.total, 'successfully wrote 8 cdrs for calls (including ephemeral gateway)');
+
+    srf.disconnect();
+    t.end();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    if (srf) srf.disconnect();
+    t.error(err);
+  }
 });

test/sipp.js

@@ -1,5 +1,5 @@
 const { spawn } = require('child_process');
-const debug = require('debug')('test:sipp');
+const debug = require('debug')('jambonz:ci');
 let network;
 const obj = {};
 let output = '';
@@ -27,7 +27,7 @@ obj.output = () => {
 obj.sippUac = (file, bindAddress) => {
   const cmd = 'docker';
   const args = [
-    'run', '-ti', '--rm', '--net', `${network}`,
+    'run', '--rm', '--net', `${network}`,
     '-v', `${__dirname}/scenarios:/tmp/scenarios`,
     'drachtio/sipp', 'sipp', '-sf', `/tmp/scenarios/${file}`,
     '-m', '1',
@@ -37,7 +37,7 @@ obj.sippUac = (file, bindAddress) => {
     'sbc'
   ];
 
-  if (bindAddress) args.splice(5, 0, '--ip', bindAddress);
+  if (bindAddress) args.splice(4, 0, '--ip', bindAddress);
 
   //console.log(args.join(' '));
   clearOutput();
@@ -57,11 +57,11 @@ obj.sippUac = (file, bindAddress) => {
     });
 
     child_process.stdout.on('data', (data) => {
-      //debug(`stdout: ${data}`);
+      debug(`stderr: ${data}`);
       addOutput(data.toString());
     });
-    child_process.stdout.on('data', (data) => {
-      //debug(`stdout: ${data}`);
+    child_process.stderr.on('data', (data) => {
+      debug(`stderr: ${data}`);
       addOutput(data.toString());
     });
   });

test/utils.js

@@ -0,0 +1,89 @@
+const test = require('tape');
+const { parseHostPorts } = require('../lib/utils');
+const { parseUri } = require('drachtio-srf');
+
+process.on('unhandledRejection', (reason, p) => {
+  console.log('Unhandled Rejection at: Promise', p, 'reason:', reason);
+});
+
+const hostports = "tls/3.70.141.74:5061,wss/3.70.141.74:8443,tcp/3.70.141.74:5060,udp/3.70.141.74:5060";
+const hostportsNoTls = "wss/3.70.141.74:8443,tcp/3.70.141.74:5060,udp/3.70.141.74:5060";
+const logger = { info: (args) => console.log(args) };
+
+const srf = {
+  locals: {
+    sipAddress: '127.0.0.1'
+  }
+};
+
+test('utils tests - parseHostPorts', async (t) => {
+  try {
+    let obj = parseHostPorts(logger, hostports, srf);
+
+    const expected = {
+      tls: '3.70.141.74:5061',
+      wss: '3.70.141.74:8443',
+      tcp: '3.70.141.74:5060',
+      udp: '3.70.141.74:5060'
+    };
+
+    t.ok(obj.tls === expected.tls, 'sip endpoint tls');
+    t.ok(obj.wss === expected.wss, 'sip endpoint wss');
+    t.ok(obj.tcp === expected.tcp, 'sip endpoint tcp');
+    t.ok(obj.udp === expected.udp, 'sip endpoint udp');
+
+    obj = parseHostPorts(logger, hostportsNoTls.split(','), srf);
+
+    t.ok(obj.tls === '127.0.0.1:5061', 'sip endpoint tls');
+
+    t.end();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    t.error(err);
+  }
+});
+
+
+test('utils tests - parse URI user', async (t) => {
+  try {
+    let invalidUri = "sip:@202660.tenios.com";
+    const req = {
+      getParsedHeader: () => ({ uri: invalidUri })
+    };
+
+    const referTo = req.getParsedHeader('Refer-To');
+    let uri = parseUri(referTo.uri);
+    
+    const expected = {
+      family: "ipv4",
+      scheme: "sip",
+      user: "",
+      password: undefined,
+      host: "202660.tenios.com",
+      port: NaN,
+      params: {},
+      headers: {},
+    }
+
+    t.ok(uri.family === expected.family, 'family eq ipv4');
+    t.ok(uri.scheme === expected.scheme, 'scheme eq sip');
+    t.ok(uri.password === expected.password, 'pw eq undefined');
+    t.ok(uri.host === expected.host, 'host eq 202660.tenios.com');
+    t.ok(uri.user === "", 'user eq empty string');
+    t.ok(isNaN(uri.port), 'port eq NaN');
+    t.ok(typeof uri.params === 'object', 'params eq object');
+    t.ok(typeof uri.headers === 'object', 'headers eq object');
+
+    invalidUri = "<sip:@202660.tenios.com>";    
+    uri = parseUri(invalidUri);
+    /* TODO: uri can be undefined - check these conditions in call-session */
+    t.ok(uri === undefined, 'uri is undefined');
+
+    const validUri = "<sip:+49221578952870@202660.tenios.com>";
+
+    t.end();
+  } catch (err) {
+    console.log(`error received: ${err}`);
+    t.error(err);
+  }
+});