@routr/common 2.0.8-alpha.0 → 2.0.8-alpha.10

package/dist/auth.d.ts

@@ -13,3 +13,42 @@ export declare const calculateAuthResponse: (res: AuthChallengeResponse, credent
     username: string;
     secret: string;
 }) => string;
+export declare const getCredentials: (username: string, users: {
+    username: string;
+    secret: string;
+}[]) => {
+    username: string;
+    secret: string;
+};
+export declare const createUnauthorizedResponse: (realm: string, params?: {
+    qop: string;
+    algorithm: string;
+}) => {
+    message: {
+        responseType: number;
+        wwwAuthenticate: {
+            scheme: string;
+            realm: string;
+            qop: string;
+            opaque: string;
+            stale: boolean;
+            nonce: string;
+            algorithm: string;
+        };
+    };
+};
+export declare const createUnauthorizedResponseWithoutChallenge: () => {
+    message: {
+        responseType: number;
+    };
+};
+export declare const createServerInternalErrorResponse: () => {
+    message: {
+        responseType: number;
+    };
+};
+export declare const createForbideenResponse: () => {
+    message: {
+        responseType: number;
+    };
+};

package/dist/auth.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.calculateAuthResponse = exports.buildAuthChallenge = exports.generateNonce = void 0;
+exports.createForbideenResponse = exports.createServerInternalErrorResponse = exports.createUnauthorizedResponseWithoutChallenge = exports.createUnauthorizedResponse = exports.getCredentials = exports.calculateAuthResponse = exports.buildAuthChallenge = exports.generateNonce = void 0;
 const crypto_1 = __importDefault(require("crypto"));
 const DEFAULT_ALGORITHM = "MD5";
 const md5hex = (str, algorithm = DEFAULT_ALGORITHM) => crypto_1.default.createHash(algorithm).update(str).digest("hex");
@@ -35,3 +35,50 @@ const calculateAuthResponse = (res, credentials) => {
         : md5hex(`${ha1}:${res.nonce}:${ha2}`);
 };
 exports.calculateAuthResponse = calculateAuthResponse;
+const getCredentials = (username, users) => users.find((user) => user.username === username);
+exports.getCredentials = getCredentials;
+const createUnauthorizedResponse = (realm, params = { qop: "auth", algorithm: "MD5" }) => {
+    return {
+        message: {
+            // Unauthorized Code
+            responseType: 17,
+            wwwAuthenticate: {
+                scheme: "Digest",
+                realm: realm,
+                qop: params.qop,
+                opaque: "",
+                stale: false,
+                nonce: (0, exports.generateNonce)(),
+                algorithm: params.algorithm
+            }
+        }
+    };
+};
+exports.createUnauthorizedResponse = createUnauthorizedResponse;
+const createUnauthorizedResponseWithoutChallenge = () => {
+    return {
+        message: {
+            // Unauthorized Code
+            responseType: 17
+        }
+    };
+};
+exports.createUnauthorizedResponseWithoutChallenge = createUnauthorizedResponseWithoutChallenge;
+const createServerInternalErrorResponse = () => {
+    return {
+        message: {
+            // Unauthorized Code
+            responseType: 46
+        }
+    };
+};
+exports.createServerInternalErrorResponse = createServerInternalErrorResponse;
+const createForbideenResponse = () => {
+    return {
+        message: {
+            // Forbideen Code
+            responseType: 19
+        }
+    };
+};
+exports.createForbideenResponse = createForbideenResponse;

package/dist/connect/data_api.js

@@ -60,7 +60,7 @@ function dataAPI(apiAddr) {
         get: (ref) => new Promise((resolve, reject) => {
             client.get({ ref }, (err, response) => {
                 if (err) {
-                    return (err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE
+                    return err.code === grpc.status.UNAVAILABLE
                         ? reject(new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`))
                         : reject(err);
                 }
@@ -74,7 +74,7 @@ function dataAPI(apiAddr) {
             client.findBy(request, (err, response) => {
                 var _a;
                 if (err) {
-                    return (err === null || err === void 0 ? void 0 : err.code) === grpc.status.UNAVAILABLE
+                    return err.code === grpc.status.UNAVAILABLE
                         ? reject(new errors_1.ServiceUnavailableError(`api server at ${apiAddr} is unavailable`))
                         : reject(err);
                 }

package/dist/connect/types.d.ts

@@ -1,21 +1,24 @@
-export declare enum KIND {
+export declare enum Kind {
     AGENT = "agent",
     PEER = "peer",
     NUMBER = "number",
     TRUNK = "trunk",
     DOMAIN = "domain",
     UNKNOWN = "unknown",
-    CREDENTIAL = "credential"
+    CREDENTIAL = "credential",
+    ACL = "accesscontrollist"
 }
 export declare enum FindCriteria {
     FIND_AGENT_BY_USERNAME = "find_agent_by_username",
+    FIND_PEER_BY_USERNAME = "find_peer_by_username",
     FIND_CREDENTIAL_BY_REFERENCE = "find_credential_by_reference",
     FIND_DOMAIN_BY_DOMAINURI = "find_domain_by_domainuri",
     FIND_NUMBER_BY_TELURL = "find_number_by_telurl",
-    FIND_TRUNKS_WITH_SEND_REGISTER = "find_trunks_with_send_register"
+    FIND_TRUNKS_WITH_SEND_REGISTER = "find_trunks_with_send_register",
+    FIND_TRUNK_BY_REQUEST_URI = "find_trunk_by_request_uri"
 }
 export interface FindParameters {
-    kind: KIND;
+    kind: Kind;
     criteria: FindCriteria;
     parameters: Record<string, string>;
 }
@@ -25,7 +28,7 @@ export interface DataAPI {
 }
 export interface Resource {
     apiVersion: string;
-    kind: string;
+    kind: Kind;
     ref: string;
     metadata: {
         name: string;

package/dist/connect/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FindCriteria = exports.KIND = void 0;
+exports.FindCriteria = exports.Kind = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster
@@ -19,21 +19,24 @@ exports.FindCriteria = exports.KIND = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var KIND;
-(function (KIND) {
-    KIND["AGENT"] = "agent";
-    KIND["PEER"] = "peer";
-    KIND["NUMBER"] = "number";
-    KIND["TRUNK"] = "trunk";
-    KIND["DOMAIN"] = "domain";
-    KIND["UNKNOWN"] = "unknown";
-    KIND["CREDENTIAL"] = "credential";
-})(KIND = exports.KIND || (exports.KIND = {}));
+var Kind;
+(function (Kind) {
+    Kind["AGENT"] = "agent";
+    Kind["PEER"] = "peer";
+    Kind["NUMBER"] = "number";
+    Kind["TRUNK"] = "trunk";
+    Kind["DOMAIN"] = "domain";
+    Kind["UNKNOWN"] = "unknown";
+    Kind["CREDENTIAL"] = "credential";
+    Kind["ACL"] = "accesscontrollist";
+})(Kind = exports.Kind || (exports.Kind = {}));
 var FindCriteria;
 (function (FindCriteria) {
     FindCriteria["FIND_AGENT_BY_USERNAME"] = "find_agent_by_username";
+    FindCriteria["FIND_PEER_BY_USERNAME"] = "find_peer_by_username";
     FindCriteria["FIND_CREDENTIAL_BY_REFERENCE"] = "find_credential_by_reference";
     FindCriteria["FIND_DOMAIN_BY_DOMAINURI"] = "find_domain_by_domainuri";
     FindCriteria["FIND_NUMBER_BY_TELURL"] = "find_number_by_telurl";
     FindCriteria["FIND_TRUNKS_WITH_SEND_REGISTER"] = "find_trunks_with_send_register";
+    FindCriteria["FIND_TRUNK_BY_REQUEST_URI"] = "find_trunk_by_request_uri";
 })(FindCriteria = exports.FindCriteria || (exports.FindCriteria = {}));

package/dist/helper.d.ts

@@ -1,3 +1,4 @@
+import { NetInterface, Transport } from "./types";
 /**
  * Makes a deep copy of an object.
  *
@@ -5,3 +6,11 @@
  * @return {object} The deep copy of the source object.
  */
 export declare const deepCopy: <T>(source: T) => T;
+/**
+ * Gets a listening point from a request.
+ *
+ * @param {NetInterface[]} listeningPoints - The listening points.
+ * @param {Transport} transport - The transport.
+ * @return {NetInterface} transport The deep copy of the source object.
+ */
+export declare const getListeningPoint: (listeningPoints: NetInterface[], transport: Transport) => NetInterface;

package/dist/helper.js

@@ -1,4 +1,6 @@
 "use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getListeningPoint = exports.deepCopy = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -17,8 +19,7 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.deepCopy = void 0;
+const types_1 = require("./types");
 /**
  * Makes a deep copy of an object.
  *
@@ -40,3 +41,20 @@ const deepCopy = (source) => {
                 : source;
 };
 exports.deepCopy = deepCopy;
+/**
+ * Gets a listening point from a request.
+ *
+ * @param {NetInterface[]} listeningPoints - The listening points.
+ * @param {Transport} transport - The transport.
+ * @return {NetInterface} transport The deep copy of the source object.
+ */
+const getListeningPoint = (listeningPoints, transport) => {
+    const listeningPoint = transport
+        ? listeningPoints.find((lp) => lp.transport.toLowerCase() === transport.toLowerCase())
+        : listeningPoints.find((lp) => lp.transport.toLowerCase() === types_1.Transport.UDP);
+    if (!listeningPoint) {
+        throw new Error(`no listening point found for transport ${transport}`);
+    }
+    return listeningPoint;
+};
+exports.getListeningPoint = getListeningPoint;

package/dist/index.d.ts

@@ -1,8 +1,7 @@
-import { calculateAuthResponse, generateNonce } from "./auth";
 import { ServiceUnavailableError } from "./errors";
 import createService, { getObjectProto, LOCATION_OBJECT_PROTO, PROCESSOR_OBJECT_PROTO } from "./service";
 import { HeaderModifier, MessageRequest, MessageResponse, Method, NetInterface, ObjectProto, ProcessorConfig, Route, ServiceInfo, Transport } from "./types";
-export { createService, getObjectProto, generateNonce, calculateAuthResponse, HeaderModifier, Route, ServiceUnavailableError, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export { createService, getObjectProto, HeaderModifier, Route, ServiceUnavailableError, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
 export * as Redis from "./redis";
 export * as CommonTypes from "./types";
 export * as Helper from "./helper";
@@ -11,3 +10,4 @@ export * as Tracer from "./tracer";
 export * as Assertions from "./assertions";
 export * as CommonConnect from "./connect";
 export * as CommonRequester from "./requester";
+export * as Auth from "./auth";

package/dist/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.CommonTypes = exports.Redis = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.ServiceUnavailableError = exports.calculateAuthResponse = exports.generateNonce = exports.getObjectProto = exports.createService = void 0;
+exports.Auth = exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.Tracer = exports.IpUtils = exports.Helper = exports.CommonTypes = exports.Redis = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.Method = exports.Transport = exports.ServiceUnavailableError = exports.getObjectProto = exports.createService = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -42,9 +42,6 @@ exports.CommonRequester = exports.CommonConnect = exports.Assertions = exports.T
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const auth_1 = require("./auth");
-Object.defineProperty(exports, "calculateAuthResponse", { enumerable: true, get: function () { return auth_1.calculateAuthResponse; } });
-Object.defineProperty(exports, "generateNonce", { enumerable: true, get: function () { return auth_1.generateNonce; } });
 const errors_1 = require("./errors");
 Object.defineProperty(exports, "ServiceUnavailableError", { enumerable: true, get: function () { return errors_1.ServiceUnavailableError; } });
 const service_1 = __importStar(require("./service"));
@@ -63,3 +60,4 @@ exports.Tracer = __importStar(require("./tracer"));
 exports.Assertions = __importStar(require("./assertions"));
 exports.CommonConnect = __importStar(require("./connect"));
 exports.CommonRequester = __importStar(require("./requester"));
+exports.Auth = __importStar(require("./auth"));

package/dist/ip_utils.d.ts

@@ -2,3 +2,4 @@ export declare const formatNet: (net: string) => string;
 export declare const hasIp: (net: string, addr: string) => boolean;
 export declare const addressCount: (net: string) => number;
 export declare const isLocalnet: (nets: string[], addr: string) => boolean;
+export declare const getLocalnetIp: (nets: string[], addr: string) => string;

package/dist/ip_utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLocalnet = exports.addressCount = exports.hasIp = exports.formatNet = void 0;
+exports.getLocalnetIp = exports.isLocalnet = exports.addressCount = exports.hasIp = exports.formatNet = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -39,5 +39,7 @@ const hasIp = (net, addr) => (0, ip_utils_1.subnet)((0, exports.formatNet)(net))
 exports.hasIp = hasIp;
 const addressCount = (net) => (0, ip_utils_1.cidrInfo)((0, exports.formatNet)(net)).inclusiveNumberHosts;
 exports.addressCount = addressCount;
-const isLocalnet = (nets, addr) => nets && nets.length > 0 && nets.filter((net) => (0, exports.hasIp)(net, addr)).length > 0;
+const isLocalnet = (nets, addr) => (nets === null || nets === void 0 ? void 0 : nets.filter((net) => (0, exports.hasIp)(net, addr)).length) > 0;
 exports.isLocalnet = isLocalnet;
+const getLocalnetIp = (nets, addr) => { var _a; return (_a = nets === null || nets === void 0 ? void 0 : nets.filter((net) => (0, exports.hasIp)(net, addr))[0]) === null || _a === void 0 ? void 0 : _a.split("/")[0]; };
+exports.getLocalnetIp = getLocalnetIp;

package/dist/protos/location.proto

@@ -34,7 +34,7 @@ service Location {
   rpc RemoveRoutes (RemoveRoutesRequest) returns (fonoster.routr.common.v2draft1.Empty) {}
 }
 
-// A binding create by an actual endpoint (Softphone, PBX, Conference System, etc.)
+// A binding created by an actual endpoint (Softphone, PBX, Conference System, etc.)
 message Route {
   string user = 1;
   string host = 2;
@@ -44,11 +44,13 @@ message Route {
   int32 expires = 6;
   int32 session_count = 7;
   string edge_port_ref = 8;
-  fonoster.routr.processor.v2draft1.NetInterface listening_point = 9;
+  repeated fonoster.routr.processor.v2draft1.NetInterface listening_points = 9;
+  repeated string localnets = 10;
+  repeated string external_addrs = 11;
   // During route creation, an endpoint can request to add labels than can later be
   // used as selectors. For example, a Softphone can add a label `priority=1` to indicate
   // that it is the prefered endpoint for the given AOR.
-  map<string, string> labels = 10;
+  map<string, string> labels = 12;
 }
 
 message AddRouteRequest {

package/dist/protos/processor.proto

@@ -78,11 +78,11 @@ message MessageRequest {
   string edge_port_ref = 2;
   Method method = 3;
   NetInterface sender = 4;
-  NetInterface listening_point = 5;
+  repeated NetInterface listening_points = 5;
   repeated string external_addrs = 6;
   repeated string localnets = 7;
   fonoster.routr.sipmessage.v2draft1.SIPMessage message = 8;
-  // .google.protobuf.Struct metadata = 8;
+  // .google.protobuf.Struct metadata = 9;
 }
 
 message MessageResponse {

package/dist/types.d.ts

@@ -13,18 +13,20 @@ export declare enum Method {
     OPTIONS = "OPTIONS"
 }
 export declare enum Transport {
-    TCP = "TCP",
-    UDP = "UDP",
-    TLS = "TLS",
-    SCTP = "SCTP",
-    WS = "WS",
-    WSS = "WSS"
+    TCP = "tcp",
+    UDP = "udp",
+    TLS = "tls",
+    SCTP = "sctp",
+    WS = "ws",
+    WSS = "wss"
 }
 export declare enum ExtraHeader {
     REQUEST_URI = "X-Request-Uri",
     GATEWAY_AUTH = "X-Gateway-Auth",
     EDGEPORT_REF = "X-Edgeport-Ref",
-    SESSION_COUNT = "X-Session-Count"
+    SESSION_COUNT = "X-Session-Count",
+    DOD_NUMBER = "X-DOD-Number",
+    DOD_PRIVACY = "X-DOD-Privacy"
 }
 export declare enum Privacy {
     NONE = "none",
@@ -40,7 +42,7 @@ export interface MessageRequest {
     edgePortRef: string;
     method: Method;
     sender: NetInterface;
-    listeningPoint: NetInterface;
+    listeningPoints: NetInterface[];
     externalAddrs: string[];
     localnets: string[];
     message: SIPMessage;
@@ -113,7 +115,9 @@ export interface Route {
     sessionCount?: number;
     expires?: number;
     edgePortRef: string;
-    listeningPoint: NetInterface;
+    listeningPoints: NetInterface[];
+    localnets: string[];
+    externalAddrs: string[];
     labels?: Map<string, string>;
     headers?: HeaderModifier[];
 }
@@ -281,10 +285,10 @@ export interface SIPMessage {
     wwwAuthenticate?: WWWAuthenticate;
     maxForwards: MaxForwards;
     authorization?: Authorization;
-    extensions?: Extension[];
-    via?: Via[];
-    route?: RouteHeader[];
-    recordRoute?: RecordRoute[];
+    extensions: Extension[];
+    via: Via[];
+    route: RouteHeader[];
+    recordRoute: RecordRoute[];
 }
 export interface GrpcCallback {
     (error: Error | {

package/dist/types.js

@@ -17,12 +17,12 @@ var Method;
 })(Method = exports.Method || (exports.Method = {}));
 var Transport;
 (function (Transport) {
-    Transport["TCP"] = "TCP";
-    Transport["UDP"] = "UDP";
-    Transport["TLS"] = "TLS";
-    Transport["SCTP"] = "SCTP";
-    Transport["WS"] = "WS";
-    Transport["WSS"] = "WSS";
+    Transport["TCP"] = "tcp";
+    Transport["UDP"] = "udp";
+    Transport["TLS"] = "tls";
+    Transport["SCTP"] = "sctp";
+    Transport["WS"] = "ws";
+    Transport["WSS"] = "wss";
 })(Transport = exports.Transport || (exports.Transport = {}));
 var ExtraHeader;
 (function (ExtraHeader) {
@@ -30,6 +30,8 @@ var ExtraHeader;
     ExtraHeader["GATEWAY_AUTH"] = "X-Gateway-Auth";
     ExtraHeader["EDGEPORT_REF"] = "X-Edgeport-Ref";
     ExtraHeader["SESSION_COUNT"] = "X-Session-Count";
+    ExtraHeader["DOD_NUMBER"] = "X-DOD-Number";
+    ExtraHeader["DOD_PRIVACY"] = "X-DOD-Privacy";
 })(ExtraHeader = exports.ExtraHeader || (exports.ExtraHeader = {}));
 var Privacy;
 (function (Privacy) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.8-alpha.0",
+  "version": "2.0.8-alpha.10",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -45,5 +45,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "69c60f113c27bc00cbadb62dbdbbb70960ef0f4d"
+  "gitHead": "5082233fb155ddb8535f934550fa4013da87468e"
 }