@routr/connect 2.0.8-alpha.36 → 2.0.8-alpha.39

package/dist/assertions.d.ts

@@ -0,0 +1 @@
+export declare const assertOnlyOneEnvIsSet: (envs: string[]) => void;

package/dist/assertions.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertOnlyOneEnvIsSet = void 0;
+/*
+ * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster/routr
+ *
+ * This file is part of Routr
+ *
+ * Licensed under the MIT License (the "License");
+ * you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ *    https://opensource.org/licenses/MIT
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+const logger_1 = require("@fonoster/logger");
+const logger = (0, logger_1.getLogger)({ service: "common", filePath: __filename });
+const assertOnlyOneEnvIsSet = (envs) => {
+    const envsSet = envs.filter((env) => process.env[env] != null);
+    if (envsSet.length > 1) {
+        logger.error(`only one of the following environment variables can be set: ${envs.join(", ")}.`);
+        process.exit(1);
+    }
+};
+exports.assertOnlyOneEnvIsSet = assertOnlyOneEnvIsSet;

package/dist/envs.d.ts

@@ -1,3 +1,6 @@
 export declare const BIND_ADDR: string;
 export declare const LOCATION_ADDR: string;
 export declare const API_ADDR: string;
+export declare const CONNECT_VERIFIER_ADDR: string;
+export declare const CONNECT_VERIFIER_PUBLIC_KEY_PATH: string;
+export declare const CONNECT_VERIFIER_OPTIONS: any;

package/dist/envs.js

@@ -1,7 +1,7 @@
 "use strict";
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.API_ADDR = exports.LOCATION_ADDR = exports.BIND_ADDR = void 0;
+exports.CONNECT_VERIFIER_OPTIONS = exports.CONNECT_VERIFIER_PUBLIC_KEY_PATH = exports.CONNECT_VERIFIER_ADDR = exports.API_ADDR = exports.LOCATION_ADDR = exports.BIND_ADDR = void 0;
 /*
  * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster
@@ -20,8 +20,13 @@ exports.API_ADDR = exports.LOCATION_ADDR = exports.BIND_ADDR = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const common_1 = require("@routr/common");
-common_1.Assertions.assertEnvsAreSet(["LOCATION_ADDR", "API_ADDR"]);
+const assertions_1 = require("./assertions");
+(0, assertions_1.assertOnlyOneEnvIsSet)(["CONNECT_VERIFIER_ADDR", "CONNECT_VERIFIER_PUBLIC_KEY"]);
 exports.BIND_ADDR = (_a = process.env.BIND_ADDR) !== null && _a !== void 0 ? _a : "0.0.0.0:51904";
 exports.LOCATION_ADDR = process.env.LOCATION_ADDR;
 exports.API_ADDR = process.env.API_ADDR;
+exports.CONNECT_VERIFIER_ADDR = process.env.CONNECT_VERIFIER_ADDR;
+exports.CONNECT_VERIFIER_PUBLIC_KEY_PATH = process.env.CONNECT_VERIFIER_PUBLIC_KEY_PATH;
+exports.CONNECT_VERIFIER_OPTIONS = process.env.CONNECT_VERIFIER_OPTIONS
+    ? JSON.parse(process.env.CONNECT_VERIFIER_OPTIONS)
+    : { expiresIn: "1h", algorithm: ["RS256"] };

package/dist/handlers.js

@@ -35,7 +35,10 @@ const function_1 = require("fp-ts/function");
 const router_1 = require("./router");
 const common_1 = require("@routr/common");
 const utils_1 = require("./utils");
+const logger_1 = require("@fonoster/logger");
+const logger = (0, logger_1.getLogger)({ service: "connect", filePath: __filename });
 const enforceE164 = processor_1.Alterations.enforceE164(common_1.Environment.ENFORCE_E164, common_1.Environment.ENFORCE_E164_WITH_MOBILE_PREFIX);
+const jwtVerifier = (0, utils_1.getVerifierImpl)();
 const handleRegister = (apiClient, location) => {
     return (request, res) => __awaiter(void 0, void 0, void 0, function* () {
         // Calculate and return challenge
@@ -63,8 +66,27 @@ const handleRegister = (apiClient, location) => {
             });
             res.sendOk();
         }
+        else if ((0, utils_1.hasXConnectObjectHeader)(request)) {
+            const connectToken = processor_1.Extensions.getHeaderValue(request, common_1.CommonTypes.ExtraHeader.CONNECT_TOKEN);
+            try {
+                const payload = yield jwtVerifier.verify(connectToken);
+                if (!payload.allowedMethods.includes(common_1.Method.REGISTER)) {
+                    return res.send(common_1.Auth.createForbideenResponse());
+                }
+                yield location.addRoute({
+                    aor: payload.aor,
+                    route: location_1.Helper.createRoute(request)
+                });
+            }
+            catch (e) {
+                logger.verbose("unable to validate connect token", {
+                    originalError: e.message
+                });
+                res.send(common_1.Auth.createForbideenResponse());
+            }
+        }
         else {
-            return res.send(common_1.Auth.createUnauthorizedResponse(request.message.requestUri.host));
+            res.send(common_1.Auth.createUnauthorizedResponse(request.message.requestUri.host));
         }
     });
 };
@@ -99,7 +121,9 @@ const handleRequest = (location, apiClient) => (request, res) => __awaiter(void
         }
     }
     catch (err) {
-        res.sendError(err);
+        res.sendInternalServerError();
+        logger.error(err);
+        // res.sendError(err)
     }
 });
 exports.handleRequest = handleRequest;

package/dist/router.js

@@ -32,18 +32,53 @@ const types_1 = require("./types");
 const common_1 = require("@routr/common");
 const utils_1 = require("./utils");
 const processor_1 = require("@routr/processor");
-const location_1 = require("@routr/location");
 const errors_1 = require("./errors");
 const logger_1 = require("@fonoster/logger");
 const access_1 = require("./access");
 const logger = (0, logger_1.getLogger)({ service: "connect", filePath: __filename });
+const jwtVerifier = (0, utils_1.getVerifierImpl)();
 // eslint-disable-next-line require-jsdoc
 function router(location, apiClient) {
     return (request) => __awaiter(this, void 0, void 0, function* () {
+        var _a;
         const fromURI = request.message.from.address.uri;
         const requestURI = request.message.requestUri;
-        const caller = yield (0, utils_1.findResource)(apiClient, fromURI.host, fromURI.user);
-        const callee = yield (0, utils_1.findResource)(apiClient, requestURI.host, requestURI.user);
+        let caller;
+        let callee;
+        if ((0, utils_1.hasXConnectObjectHeader)(request)) {
+            const connectToken = processor_1.Extensions.getHeaderValue(request, common_1.CommonTypes.ExtraHeader.CONNECT_TOKEN);
+            try {
+                const payload = yield jwtVerifier.verify(connectToken);
+                const domain = yield (0, utils_1.findDomain)(apiClient, payload.domain);
+                if (!payload.allowedMethods.includes(common_1.Method.INVITE)) {
+                    return common_1.Auth.createForbideenResponse();
+                }
+                caller = {
+                    apiVersion: common_1.CommonConnect.APIVersion.V2,
+                    ref: payload.ref,
+                    name: (_a = request.message.from.address.displayName) !== null && _a !== void 0 ? _a : common_1.CommonTypes.ANONYMOUS,
+                    domain: domain,
+                    domainRef: payload.domainRef,
+                    username: common_1.CommonTypes.ANONYMOUS,
+                    privacy: processor_1.Extensions.getHeaderValue(request, "Privacy"),
+                    enabled: true
+                };
+                callee = (yield apiClient.peers.findBy({
+                    fieldName: "aor",
+                    fieldValue: payload.aorLink
+                })).items[0];
+            }
+            catch (e) {
+                logger.verbose("unable to validate connect token", {
+                    originalError: e.message
+                });
+                return common_1.Auth.createForbideenResponse();
+            }
+        }
+        else {
+            caller = yield (0, utils_1.findResource)(apiClient, fromURI.host, fromURI.user);
+            callee = yield (0, utils_1.findResource)(apiClient, requestURI.host, requestURI.user);
+        }
         const routingDirection = (0, utils_1.getRoutingDirection)(caller, callee);
         logger.verbose("routing request from: " +
             (0, utils_1.getSIPURI)(fromURI) +
@@ -52,9 +87,9 @@ function router(location, apiClient) {
             fromURI: (0, utils_1.getSIPURI)(fromURI),
             requestURI: (0, utils_1.getSIPURI)(requestURI),
             routingDirection
-            // sessionAffinityHeader: callee?.spec.location?.sessionAffinityHeader
         });
-        if (request.method === common_1.CommonTypes.Method.INVITE) {
+        if (!(0, utils_1.hasXConnectObjectHeader)(request) &&
+            request.method === common_1.CommonTypes.Method.INVITE) {
             const failedCheck = yield (0, access_1.checkAccess)({
                 apiClient,
                 request,
@@ -69,6 +104,8 @@ function router(location, apiClient) {
         switch (routingDirection) {
             case types_1.RoutingDirection.AGENT_TO_AGENT:
                 return agentToAgent(location, request);
+            case types_1.RoutingDirection.AGENT_TO_PEER:
+                return yield agentToPeer(location, callee, request);
             case types_1.RoutingDirection.AGENT_TO_PSTN:
                 return yield agentToPSTN(request, caller, requestURI.user);
             case types_1.RoutingDirection.FROM_PSTN:
@@ -119,7 +156,7 @@ function fromPSTN(apiClient, location, callee, req) {
             backend
         }))[0];
         if (!route) {
-            throw new location_1.NotRoutesFoundForAOR(callee.aorLink);
+            return null;
         }
         if (!route.headers)
             route.headers = [];
@@ -183,6 +220,21 @@ function agentToPSTN(req, agent, calleeNumber) {
     });
 }
 // eslint-disable-next-line require-jsdoc
+function agentToPeer(location, callee, req) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const backend = {
+            ref: callee.ref,
+            balancingAlgorithm: callee.balancingAlgorithm,
+            withSessionAffinity: callee.withSessionAffinity
+        };
+        return (yield location.findRoutes({
+            aor: callee.aor,
+            callId: req.ref,
+            backend
+        }))[0];
+    });
+}
+// eslint-disable-next-line require-jsdoc
 function peerToPSTN(apiClient, req) {
     return __awaiter(this, void 0, void 0, function* () {
         const numberTel = processor_1.Extensions.getHeaderValue(req, common_1.CommonTypes.ExtraHeader.DOD_NUMBER);

package/dist/runner.js

@@ -25,7 +25,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 require("./tracer").init("dispatcher");
 const service_1 = __importDefault(require("./service"));
+const common_1 = require("@routr/common");
 const envs_1 = require("./envs");
+common_1.Assertions.assertEnvsAreSet(["LOCATION_ADDR", "API_ADDR"]);
 (0, service_1.default)({
     bindAddr: envs_1.BIND_ADDR,
     locationAddr: envs_1.LOCATION_ADDR,

package/dist/tailor.js

@@ -22,6 +22,5 @@ exports.tailor = void 0;
 const processor_1 = require("@routr/processor");
 const function_1 = require("fp-ts/function");
 // Q: Should we add support for strict routing?
-// TODO: Add updateContact for SIP.js support
-const tailor = (route, req) => (0, function_1.pipe)(req, processor_1.Alterations.decreaseMaxForwards, processor_1.Alterations.removeAuthorization, processor_1.Alterations.removeSelfRoutes, processor_1.Alterations.removeXEdgePortRef, processor_1.Alterations.fixNatedContact, processor_1.Alterations.addSelfVia(route), processor_1.Alterations.applyXHeaders(route), processor_1.Alterations.addSelfRecordRoute(route), processor_1.Alterations.addRouteToNextHop(route));
+const tailor = (route, req) => (0, function_1.pipe)(req, processor_1.Alterations.decreaseMaxForwards, processor_1.Alterations.removeAuthorization, processor_1.Alterations.removeSelfRoutes, processor_1.Alterations.removeXEdgePortRef, processor_1.Alterations.fixInvalidContact, processor_1.Alterations.addSelfVia(route), processor_1.Alterations.applyXHeaders(route), processor_1.Alterations.addSelfRecordRoute(route), processor_1.Alterations.addRouteToNextHop(route));
 exports.tailor = tailor;

package/dist/types.d.ts

@@ -3,6 +3,7 @@ export declare enum RoutingDirection {
     FROM_PSTN = "from-pstn",
     AGENT_TO_AGENT = "agent-to-agent",
     AGENT_TO_PSTN = "agent-to-pstn",
+    AGENT_TO_PEER = "agent-to-peer",
     PEER_TO_AGENT = "peer-to-agent",
     PEER_TO_PSTN = "peer-to-pstn",
     UNKNOWN = "unknown"

package/dist/types.js

@@ -6,6 +6,7 @@ var RoutingDirection;
     RoutingDirection["FROM_PSTN"] = "from-pstn";
     RoutingDirection["AGENT_TO_AGENT"] = "agent-to-agent";
     RoutingDirection["AGENT_TO_PSTN"] = "agent-to-pstn";
+    RoutingDirection["AGENT_TO_PEER"] = "agent-to-peer";
     // WARNING: This is not supported yet
     RoutingDirection["PEER_TO_AGENT"] = "peer-to-agent";
     RoutingDirection["PEER_TO_PSTN"] = "peer-to-pstn";

package/dist/utils.d.ts

@@ -1,4 +1,4 @@
-import { HeaderModifier, MessageRequest, Transport, CommonConnect as CC } from "@routr/common";
+import { HeaderModifier, MessageRequest, Transport, CommonConnect as CC, Method } from "@routr/common";
 import { RoutingDirection } from "./types";
 export declare const isKind: (res: CC.RoutableResourceUnion, kind: CC.Kind) => boolean;
 export declare const findDomain: (apiClient: CC.APIClient, domainUri: string) => Promise<CC.Domain>;
@@ -18,3 +18,15 @@ export declare const getSIPURI: (uri: {
     user?: string;
     host: string;
 }) => string;
+export declare const hasXConnectObjectHeader: (req: MessageRequest) => string;
+export declare const getVerifierImpl: () => {
+    verify: (token: string) => Promise<{
+        ref: string;
+        domain: string;
+        domainRef: string;
+        aor: string;
+        aorLink: string;
+        username: string;
+        allowedMethods: Method[];
+    }>;
+};

package/dist/utils.js

@@ -1,4 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
     function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
     return new (P || (P = Promise))(function (resolve, reject) {
@@ -8,8 +31,11 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSIPURI = exports.getTrunkURI = exports.createTrunkAuthentication = exports.createRemotePartyId = exports.createPAssertedIdentity = exports.getRoutingDirection = exports.findResource = exports.findNumberByTelUrl = exports.findDomain = exports.isKind = void 0;
+exports.getVerifierImpl = exports.hasXConnectObjectHeader = exports.getSIPURI = exports.getTrunkURI = exports.createTrunkAuthentication = exports.createRemotePartyId = exports.createPAssertedIdentity = exports.getRoutingDirection = exports.findResource = exports.findNumberByTelUrl = exports.findDomain = exports.isKind = void 0;
 /*
  * Copyright (C) 2023 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -28,8 +54,12 @@ exports.getSIPURI = exports.getTrunkURI = exports.createTrunkAuthentication = ex
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+const jwt = __importStar(require("jsonwebtoken"));
+const fs_1 = __importDefault(require("fs"));
 const common_1 = require("@routr/common");
+const processor_1 = require("@routr/processor");
 const types_1 = require("./types");
+const envs_1 = require("./envs");
 // OMG, this is so ugly and hacky
 const isKind = (res, kind) => {
     if (res == null && kind === common_1.CommonConnect.Kind.UNKNOWN) {
@@ -38,13 +68,13 @@ const isKind = (res, kind) => {
     else if (res == null) {
         return false;
     }
-    else if ("privacy" in res && kind === common_1.CommonConnect.Kind.AGENT) {
+    else if ("domainRef" in res && kind === common_1.CommonConnect.Kind.AGENT) {
         return true;
     }
     else if ("telUrl" in res && kind === common_1.CommonConnect.Kind.NUMBER) {
         return true;
     }
-    else if ("username" in res && kind === common_1.CommonConnect.Kind.PEER) {
+    else if ("aor" in res && kind === common_1.CommonConnect.Kind.PEER) {
         return true;
     }
 };
@@ -97,6 +127,9 @@ const getRoutingDirection = (caller, callee) => {
     if ((0, exports.isKind)(caller, common_1.CommonConnect.Kind.PEER) && (0, exports.isKind)(callee, common_1.CommonConnect.Kind.AGENT)) {
         return types_1.RoutingDirection.PEER_TO_AGENT;
     }
+    if ((0, exports.isKind)(caller, common_1.CommonConnect.Kind.AGENT) && (0, exports.isKind)(callee, common_1.CommonConnect.Kind.PEER)) {
+        return types_1.RoutingDirection.AGENT_TO_PEER;
+    }
     // All we know is that the Number is managed by this instance of Routr
     if ((0, exports.isKind)(callee, common_1.CommonConnect.Kind.NUMBER)) {
         return types_1.RoutingDirection.FROM_PSTN;
@@ -154,3 +187,18 @@ const getTrunkURI = (trunk) => {
 exports.getTrunkURI = getTrunkURI;
 const getSIPURI = (uri) => uri.user ? `sip:${uri.user}@${uri.host}` : `sip:${uri.host}`;
 exports.getSIPURI = getSIPURI;
+const hasXConnectObjectHeader = (req) => processor_1.Extensions.getHeaderValue(req, common_1.CommonTypes.ExtraHeader.CONNECT_TOKEN);
+exports.hasXConnectObjectHeader = hasXConnectObjectHeader;
+// TODO: Add support for GRPCVerifier
+const getVerifierImpl = () => {
+    if (envs_1.CONNECT_VERIFIER_PUBLIC_KEY_PATH) {
+        const publicKey = fs_1.default.readFileSync(envs_1.CONNECT_VERIFIER_PUBLIC_KEY_PATH, "utf8");
+        return {
+            verify: (token) => __awaiter(void 0, void 0, void 0, function* () {
+                return jwt.verify(token, publicKey, envs_1.CONNECT_VERIFIER_OPTIONS);
+            })
+        };
+    }
+    return null;
+};
+exports.getVerifierImpl = getVerifierImpl;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/connect",
-  "version": "2.0.8-alpha.36",
+  "version": "2.0.8-alpha.39",
   "description": "Default processor",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -29,9 +29,13 @@
     "@opentelemetry/sdk-trace-base": "^1.0.4",
     "@opentelemetry/sdk-trace-node": "^1.0.4",
     "@opentelemetry/semantic-conventions": "^1.0.4",
-    "@routr/common": "^2.0.8-alpha.33",
-    "@routr/location": "^2.0.8-alpha.36",
-    "@routr/processor": "^2.0.8-alpha.36"
+    "@routr/common": "^2.0.8-alpha.39",
+    "@routr/location": "^2.0.8-alpha.39",
+    "@routr/processor": "^2.0.8-alpha.39",
+    "jsonwebtoken": "^9.0.0"
+  },
+  "devDependencies": {
+    "@types/jsonwebtoken": "^9.0.1"
   },
   "files": [
     "dist"
@@ -46,5 +50,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "88b5c909892c32a5663ee3fee30910df2ecaf2aa"
+  "gitHead": "43d5cae0cb5a2c373ed7b219f5d73a42319b9ba5"
 }