support incoming calls from registration trunks with ephemeral gateways (#216)

* support incoming calls from registration trunks with ephemeral gateways * fix bug with multiple ephemeral gateways * update to pino 10.1.0 * update eslint
2025-12-18 20:27:43 +00:00 · 2025-10-21 07:33:21 -04:00
parent 4f1b4815c4
commit b2868842ad
12 changed files with 882 additions and 710 deletions
--- a/.eslintignore
+++ b/.eslintignore
@@ -1 +0,0 @@
-test/*
--- a/.eslintrc.json
+++ b/.eslintrc.json
@@ -1,126 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "es6": true  
-  },
-  "parserOptions": {
-    "ecmaFeatures": {
-      "jsx": false,
-      "modules": false
-    },
-    "ecmaVersion": 2020
-  },
-  "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  
-  }
-}
--- a/app.js
+++ b/app.js
@@ -75,7 +75,10 @@ const {
  addToSet,
  removeFromSet,
  incrKey,
-  decrKey} = require('@jambonz/realtimedb-helpers')({}, logger);
+  decrKey,
+  createEphemeralGateway,
+  queryEphemeralGateways
+} = require('@jambonz/realtimedb-helpers')({}, logger);

 const ngProtocol = process.env.JAMBONES_NG_PROTOCOL || 'udp';
 const ngPort = process.env.RTPENGINE_PORT || ('udp' === ngProtocol ? 22222 : 8080);
@@ -117,7 +120,9 @@ srf.locals = {...srf.locals,
    createSet,
    incrKey,
    decrKey,
-    retrieveSet
+    retrieveSet,
+    createEphemeralGateway,
+    queryEphemeralGateways
  }
 };
 const {
--- a/eslint.config.js
+++ b/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
+    }
+  }
+];
--- a/lib/call-session.js
+++ b/lib/call-session.js
@@ -452,7 +452,7 @@ class CallSession extends Emitter {
            if (!IMMUTABLE_HEADERS.includes(h)) headers[h] = bye.headers[h];
          });
          await other.destroy({headers});
-        } catch (err) {}
+        } catch {}
        this.unsubscribeForDTMF();


--- a/lib/db-utils.js
+++ b/lib/db-utils.js
@@ -56,15 +56,23 @@ 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, 
+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
-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 = ? 
+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 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
+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) {
@@ -80,6 +88,7 @@ const gatewayMatchesSourceAddress = (logger, source_address, gw) => {

 module.exports = (srf, logger) => {
  const {pool}  = srf.locals.dbHelpers;
+  const {queryEphemeralGateways} = srf.locals.realtimeDbHelpers;
  const pp = pool.promise();

  const getApplicationBySid = async(application_sid) => {
@@ -202,6 +211,48 @@ module.exports = (srf, logger) => {
    }
  };

+  /**
+   * 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);
@@ -251,6 +302,32 @@ module.exports = (srf, logger) => {
        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,
+                pad_crypto: gw.pad_crypto
+              };
+            });
+            /* 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(',');
@@ -379,6 +456,31 @@ module.exports = (srf, logger) => {
    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
+          };
+        });
+        /* 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 */
--- a/package-lock.json
+++ b/package-lock.json
--- a/package.json
+++ b/package.json
@@ -32,7 +32,7 @@
    "@jambonz/db-helpers": "^0.9.18",
    "@jambonz/digest-utils": "^0.0.8",
    "@jambonz/http-health-check": "^0.0.1",
-    "@jambonz/realtimedb-helpers": "^0.8.13",
+    "@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",
@@ -43,13 +43,13 @@
    "drachtio-fn-b2b-sugar": "0.2.1",
    "drachtio-srf": "^5.0.5",
    "express": "^4.19.2",
-    "pino": "^8.20.0",
+    "pino": "^10.1.0",
    "verify-aws-sns-signature": "^0.1.0",
    "xml2js": "^0.6.2"
  },
  "devDependencies": {
-    "eslint": "^7.32.0",
-    "eslint-plugin-promise": "^6.1.1",
+    "eslint": "^9.17.0",
+    "eslint-plugin-promise": "^7.2.1",
    "nyc": "^15.1.0",
    "tape": "^5.7.5"
  }
--- a/test/db/jambones-sql.sql
+++ b/test/db/jambones-sql.sql
@@ -14,8 +14,6 @@ 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;
@@ -68,6 +66,8 @@ DROP TABLE IF EXISTS phone_numbers;

 DROP TABLE IF EXISTS sip_gateways;

+DROP TABLE IF EXISTS clients;
+
 DROP TABLE IF EXISTS voip_carriers;

 DROP TABLE IF EXISTS accounts;
@@ -132,19 +132,6 @@ application_sid CHAR(36) NOT NULL,
 PRIMARY KEY (call_route_sid)
 ) 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 ,
@@ -162,7 +149,7 @@ regex VARCHAR(32) NOT NULL COMMENT 'regex-based pattern match against dialed num
 description VARCHAR(1024),
 priority INTEGER NOT NULL COMMENT 'lower priority routes are attempted first',
 PRIMARY KEY (lcr_route_sid)
-) COMMENT='An ordered list of  digit patterns in an LCR table.  The patterns are tested in sequence until one matches';
+) COMMENT='An ordered list of  digit patterns in an LCR table.  The pat';

 CREATE TABLE lcr
 (
@@ -173,7 +160,7 @@ default_carrier_set_entry_sid CHAR(36) COMMENT 'default carrier/route to use whe
 service_provider_sid CHAR(36),
 account_sid CHAR(36),
 PRIMARY KEY (lcr_sid)
-) COMMENT='An LCR (least cost routing) table that is used by a service provider or account to make decisions about routing outbound calls when multiple carriers are available.';
+) COMMENT='An LCR (least cost routing) table that is used by a service ';

 CREATE TABLE password_settings
 (
@@ -351,6 +338,8 @@ 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)
 );

@@ -414,6 +403,9 @@ 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','registration') NOT NULL DEFAULT 'static-ip',
 PRIMARY KEY (voip_carrier_sid)
 ) COMMENT='A Carrier or customer PBX that can send or receive calls';

@@ -487,6 +479,20 @@ password VARCHAR(255),
 PRIMARY KEY (webhook_sid)
 ) COMMENT='An HTTP callback';

+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,
+voip_carrier_sid CHAR(36),
+PRIMARY KEY (client_sid)
+);
+
 CREATE TABLE applications
 (
 application_sid CHAR(36) NOT NULL UNIQUE ,
@@ -512,6 +518,7 @@ 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)
@@ -575,9 +582,6 @@ ALTER TABLE call_routes ADD FOREIGN KEY account_sid_idxfk_3 (account_sid) REFERE

 ALTER TABLE call_routes ADD FOREIGN KEY application_sid_idxfk (application_sid) REFERENCES applications (application_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);
-
 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);

@@ -706,6 +710,11 @@ ALTER TABLE lcr_carrier_set_entry ADD FOREIGN KEY lcr_route_sid_idxfk (lcr_route
 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 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 clients ADD FOREIGN KEY voip_carrier_sid_idxfk_4 (voip_carrier_sid) REFERENCES voip_carriers (voip_carrier_sid);
+
 CREATE UNIQUE INDEX applications_idx_name ON applications (account_sid,name);

 CREATE INDEX application_sid_idx ON applications (application_sid);
@@ -739,4 +748,4 @@ ALTER TABLE accounts ADD FOREIGN KEY device_calling_application_sid_idxfk (devic

 ALTER TABLE accounts ADD FOREIGN KEY siprec_hook_sid_idxfk (siprec_hook_sid) REFERENCES applications (application_sid);

-SET FOREIGN_KEY_CHECKS=1;
+SET FOREIGN_KEY_CHECKS=0;
--- a/test/db/populate-test-data.sql
+++ b/test/db/populate-test-data.sql
@@ -124,3 +124,19 @@ values ('phone102', '\\dkjfhmdf\\', 'voip100', 'ee9d7d49-b3e4-4fdb-9d66-661149f7
 -- 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', 'registration', 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');
--- a/test/scenarios/uac-pcap-ephemeral-gateway-success.xml
+++ b/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>
+
--- a/test/sip-tests.js
+++ b/test/sip-tests.js
@@ -43,6 +43,12 @@ test('incoming call tests', async(t) => {
    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');
  
@@ -85,7 +91,7 @@ test('incoming call tests', async(t) => {
    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(7 === res.total, 'successfully wrote 8 cdrs for calls');
+    t.ok(8 === res.total, 'successfully wrote 8 cdrs for calls (including ephemeral gateway)');

    srf.disconnect();
    t.end();