Merge pull request #32 from jambonz/feat/clients

feat: register client
2026-01-24 22:27:52 +00:00 · 2023-06-15 07:26:05 -04:00
parent 26a5ded625 ffcbab2448
commit 54804e1eee
5 changed files with 52 additions and 69 deletions
--- a/app.js
+++ b/app.js
@@ -44,7 +44,7 @@ const { initLocals, rejectIpv4, checkCache, checkAccountLimits } = require('./li
 const responseTime = require('drachtio-mw-response-time');
 const regParser = require('drachtio-mw-registration-parser');
 const Registrar = require('@jambonz/mw-registrar');
-const Emitter = require('events');
+const digestChallenge = require('@jambonz/digest-utils');
 const debug = require('debug')('jambonz:sbc-registrar');
 const {
  lookupAuthHook,
@@ -54,7 +54,8 @@ const {
  lookupAccountCapacitiesBySid,
  addSbcAddress,
  cleanSbcAddresses,
-  updateVoipCarriersRegisterStatus
+  updateVoipCarriersRegisterStatus,
+  lookupClientByAccountAndUsername
 } = require('@jambonz/db-helpers')({
  host: process.env.JAMBONES_MYSQL_HOST,
  user: process.env.JAMBONES_MYSQL_USER,
@@ -100,7 +101,8 @@ srf.locals = {
    lookupSipGatewaysByCarrier,
    lookupAccountBySipRealm,
    lookupAccountCapacitiesBySid,
-    updateVoipCarriersRegisterStatus
+    updateVoipCarriersRegisterStatus,
+    lookupClientByAccountAndUsername
  },
  realtimeDbHelpers: {
    addKey,
@@ -174,47 +176,6 @@ const rttMetric = (req, res, time) => {
  }
 };

-class RegOutcomeReporter extends Emitter {
-  constructor() {
-    super();
-    this
-      .on('regHookOutcome', ({ rtt, status }) => {
-        stats.histogram('app.hook.response_time', rtt, ['hook_type:auth', `status:${status}`]);
-        if (![200, 403].includes(status)) {
-          stats.increment('app.hook.error.count', ['hook_type:auth', `status:${status}`]);
-        }
-      })
-      .on('error', async(err, req) => {
-        logger.error({ err }, 'http webhook failed');
-        const { account_sid } = req.locals;
-        if (account_sid) {
-          let opts = { account_sid };
-          if (err.code === 'ECONNREFUSED') {
-            opts = { ...opts, alert_type: AlertType.WEBHOOK_CONNECTION_FAILURE, url: err.hook };
-          }
-          else if (err.code === 'ENOTFOUND') {
-            opts = { ...opts, alert_type: AlertType.WEBHOOK_CONNECTION_FAILURE, url: err.hook };
-          }
-          else if (err.name === 'StatusError') {
-            opts = { ...opts, alert_type: AlertType.WEBHOOK_STATUS_FAILURE, url: err.hook, status: err.statusCode };
-          }
-
-          if (opts.alert_type) {
-            try {
-              await writeAlerts(opts);
-            } catch (err) {
-              logger.error({ err, opts }, 'Error writing alert');
-            }
-          }
-        }
-      });
-  }
-}
-
-const authenticator = require('@jambonz/http-authenticator')(lookupAuthHook, logger, {
-  emitter: new RegOutcomeReporter()
-});
-
 // middleware
 srf.use('register', [
  initLocals,
@@ -223,7 +184,7 @@ srf.use('register', [
  regParser,
  checkCache,
  checkAccountLimits,
-  authenticator]);
+  digestChallenge]);

 srf.use('options', [
  initLocals
--- a/lib/middleware.js
+++ b/lib/middleware.js
@@ -67,7 +67,13 @@ const checkAccountLimits = async(req, res, next) => {
      req.locals = {
        ...req.locals,
        account_sid: account.account_sid,
-        webhook_secret: account.webhook_secret
+        webhook_secret: account.webhook_secret,
+        ...(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
+        })
      };
      debug(account, `checkAccountLimits: retrieved account for realm: ${realm}`);
    }
--- a/package-lock.json
+++ b/package-lock.json
@@ -9,8 +9,8 @@
      "version": "0.8.3",
      "license": "MIT",
      "dependencies": {
-        "@jambonz/db-helpers": "^0.9.0",
-        "@jambonz/http-authenticator": "^0.2.2",
+        "@jambonz/db-helpers": "^0.9.1",
+        "@jambonz/digest-utils": "^0.0.2",
        "@jambonz/mw-registrar": "^0.2.4",
        "@jambonz/realtimedb-helpers": "^0.8.6",
        "@jambonz/stats-collector": "^0.1.8",
@@ -629,9 +629,9 @@
      }
    },
    "node_modules/@jambonz/db-helpers": {
-      "version": "0.9.0",
-      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.9.0.tgz",
-      "integrity": "sha512-4fvwONj4jQNIHyG76WGdE7AuMt9vDl4sfHmHrY3PSgOh+kf2BCtBEYqoxyJ96/NH9OeUYkuXoM6fjSvpS7GYVw==",
+      "version": "0.9.1",
+      "resolved": "https://registry.npmjs.org/@jambonz/db-helpers/-/db-helpers-0.9.1.tgz",
+      "integrity": "sha512-asQQdeQEl1jCyQAxp2kMljZzExQbcG/mBxVYA2Jf0E1ReZctC206LWMWmY/rvbSHHXNZBzJlNxhD0dQB+FtJYA==",
      "dependencies": {
        "cidr-matcher": "^2.1.1",
        "debug": "^4.3.4",
@@ -640,14 +640,13 @@
        "uuid": "^8.3.2"
      }
    },
-    "node_modules/@jambonz/http-authenticator": {
-      "version": "0.2.2",
-      "resolved": "https://registry.npmjs.org/@jambonz/http-authenticator/-/http-authenticator-0.2.2.tgz",
-      "integrity": "sha512-yl6CajF8c8BOTrXEB/AbTXgqrT6XeymwVZbJWeJG8HZA21UXkKCcM26b8f0P9qqokSvFj0ObjCk22Ks2ytSLNg==",
+    "node_modules/@jambonz/digest-utils": {
+      "version": "0.0.2",
+      "resolved": "https://registry.npmjs.org/@jambonz/digest-utils/-/digest-utils-0.0.2.tgz",
+      "integrity": "sha512-TcUpHQZZ+69mnU6wA3pBcq17l9NbRZCQLJY7g/i9eaRONpAfw6vYkRWF7GtIaJat9Gu18tVs4idHvbfiqx40tA==",
      "dependencies": {
        "bent": "^7.3.12",
-        "debug": "^4.3.1",
-        "drachtio-srf": "^4.4.63",
+        "debug": "^4.3.4",
        "nonce": "^1.0.4",
        "qs": "^6.9.4"
      }
--- a/package.json
+++ b/package.json
@@ -27,12 +27,12 @@
  },
  "homepage": "https://github.com/jambonz/sbc-sip-sidecar#readme",
  "dependencies": {
-    "@jambonz/db-helpers": "^0.9.0",
-    "@jambonz/http-authenticator": "^0.2.2",
+    "@jambonz/db-helpers": "^0.9.1",
    "@jambonz/mw-registrar": "^0.2.4",
    "@jambonz/realtimedb-helpers": "^0.8.6",
    "@jambonz/stats-collector": "^0.1.8",
    "@jambonz/time-series": "^0.2.5",
+    "@jambonz/digest-utils": "^0.0.2",
    "debug": "^4.3.4",
    "drachtio-mw-registration-parser": "^0.1.0",
    "drachtio-mw-response-time": "^1.0.2",
--- a/test/db/jambones-sql.sql
+++ b/test/db/jambones-sql.sql
@@ -13,6 +13,8 @@ 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;
@@ -127,6 +129,16 @@ 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(64),
+PRIMARY KEY (client_sid)
+);
+
 CREATE TABLE dns_records
 (
 dns_record_sid CHAR(36) NOT NULL UNIQUE ,
@@ -411,7 +423,7 @@ PRIMARY KEY (smpp_gateway_sid)
 CREATE TABLE phone_numbers
 (
 phone_number_sid CHAR(36) UNIQUE ,
-number VARCHAR(132) NOT NULL UNIQUE ,
+number VARCHAR(132) NOT NULL,
 voip_carrier_sid CHAR(36),
 account_sid CHAR(36),
 application_sid CHAR(36),
@@ -530,8 +542,11 @@ 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 FOREIGN KEY account_sid_idxfk_4 (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 dns_records ADD FOREIGN KEY account_sid_idxfk_5 (account_sid) REFERENCES accounts (account_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);
@@ -560,14 +575,14 @@ ALTER TABLE account_products ADD FOREIGN KEY product_sid_idxfk (product_sid) REF

 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);
+ALTER TABLE account_offers ADD FOREIGN KEY account_sid_idxfk_6 (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 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_6 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE api_keys ADD FOREIGN KEY account_sid_idxfk_7 (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 (service_provider_sid) REFERENCES service_providers (service_provider_sid);
@@ -581,7 +596,7 @@ ALTER TABLE sbc_addresses ADD FOREIGN KEY service_provider_sid_idxfk_1 (service_
 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 account_sid_idxfk_8 (account_sid) REFERENCES accounts (account_sid);

 ALTER TABLE ms_teams_tenants ADD FOREIGN KEY application_sid_idxfk_1 (application_sid) REFERENCES applications (application_sid);

@@ -601,13 +616,13 @@ CREATE INDEX service_provider_sid_idx ON speech_credentials (service_provider_si
 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);
+ALTER TABLE speech_credentials ADD FOREIGN KEY account_sid_idxfk_9 (account_sid) REFERENCES accounts (account_sid);

 CREATE INDEX user_sid_idx ON users (user_sid);
 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);
+ALTER TABLE users ADD FOREIGN KEY account_sid_idxfk_10 (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);
@@ -615,7 +630,7 @@ ALTER TABLE users ADD FOREIGN KEY service_provider_sid_idxfk_6 (service_provider
 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 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);
+ALTER TABLE voip_carriers ADD FOREIGN KEY account_sid_idxfk_11 (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);
@@ -632,12 +647,14 @@ 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 account_sid_idxfk_12 (account_sid) REFERENCES accounts (account_sid);

 ALTER TABLE phone_numbers ADD FOREIGN KEY application_sid_idxfk_3 (application_sid) REFERENCES applications (application_sid);

@@ -661,7 +678,7 @@ 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_12 (account_sid) REFERENCES accounts (account_sid);
+ALTER TABLE applications ADD FOREIGN KEY account_sid_idxfk_13 (account_sid) REFERENCES accounts (account_sid);

 ALTER TABLE applications ADD FOREIGN KEY call_hook_sid_idxfk (call_hook_sid) REFERENCES webhooks (webhook_sid);