@routr/common 2.0.5-alpha.2 → 2.0.5-alpha.6

package/dist/auth.d.ts

@@ -0,0 +1,15 @@
+import { AuthChallengeRequest, AuthChallengeResponse } from "./types";
+export declare const generateNonce: (algorithm?: string) => string;
+export declare const buildAuthChallenge: (request: AuthChallengeRequest) => {
+    realm: string;
+    scheme: string;
+    algorithm: string;
+    qop: string;
+    opaque: string;
+    stale: boolean;
+    nonce: string;
+};
+export declare const calculateAuthResponse: (res: AuthChallengeResponse, credentials?: {
+    username: string;
+    secret: string;
+}) => string;

package/dist/auth.js

@@ -0,0 +1,29 @@
+"use strict";
+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;
+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');
+const decToHex = (dec) => (dec + Math.pow(16, 8)).toString(16).substr(-8);
+const generateNonce = (algorithm = DEFAULT_ALGORITHM) => md5hex(`${new Date().getTime()}${Math.random()}`, algorithm);
+exports.generateNonce = generateNonce;
+const buildAuthChallenge = (request) => {
+    const { realm, scheme, algorithm, qop, opaque, stale } = request;
+    return { realm, scheme, algorithm, qop, opaque, stale, nonce: exports.generateNonce(algorithm) };
+};
+exports.buildAuthChallenge = buildAuthChallenge;
+const calculateAuthResponse = (res, credentials) => {
+    if (!credentials)
+        return null;
+    const a1 = `${credentials.username}:${res.realm}:${credentials.secret}`;
+    const a2 = `${res.method.toUpperCase()}:${res.uri}`;
+    const ha1 = md5hex(a1);
+    const ha2 = md5hex(a2);
+    return res.qop === 'auth'
+        ? md5hex(`${ha1}:${res.nonce}:${decToHex(res.nonce_count)}:${res.c_nonce}:${res.qop}:${ha2}`)
+        : md5hex(`${ha1}:${res.nonce}:${ha2}`);
+};
+exports.calculateAuthResponse = calculateAuthResponse;

package/dist/errors.d.ts

@@ -1,3 +1,7 @@
 export declare class ServiceDefinitionNotFound extends Error {
     constructor(name: string, version: string);
 }
+export declare class ServiceUnavailableError extends Error {
+    code: number;
+    constructor(addr: string);
+}

package/dist/errors.js

@@ -1,21 +1,6 @@
 "use strict";
-var __extends = (this && this.__extends) || (function () {
-    var extendStatics = function (d, b) {
-        extendStatics = Object.setPrototypeOf ||
-            ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
-            function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
-        return extendStatics(d, b);
-    };
-    return function (d, b) {
-        if (typeof b !== "function" && b !== null)
-            throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
-        extendStatics(d, b);
-        function __() { this.constructor = d; }
-        d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
-    };
-})();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ServiceDefinitionNotFound = void 0;
+exports.ServiceUnavailableError = exports.ServiceDefinitionNotFound = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -34,14 +19,20 @@ exports.ServiceDefinitionNotFound = void 0;
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var ServiceDefinitionNotFound = /** @class */ (function (_super) {
-    __extends(ServiceDefinitionNotFound, _super);
-    function ServiceDefinitionNotFound(name, version) {
-        var _this = _super.call(this, "Service definition for " + name + "/" + version + " not found") || this;
+const grpc = require("@grpc/grpc-js");
+class ServiceDefinitionNotFound extends Error {
+    constructor(name, version) {
+        super(`Service definition for ${name}/${version} not found`);
         // Set the prototype explicitly.
-        Object.setPrototypeOf(_this, ServiceDefinitionNotFound.prototype);
-        return _this;
+        Object.setPrototypeOf(this, ServiceDefinitionNotFound.prototype);
     }
-    return ServiceDefinitionNotFound;
-}(Error));
+}
 exports.ServiceDefinitionNotFound = ServiceDefinitionNotFound;
+class ServiceUnavailableError extends Error {
+    constructor(addr) {
+        super(`service unavailable [addr = ${addr}]`);
+        this.code = grpc.status.UNAVAILABLE;
+        Object.setPrototypeOf(this, ServiceUnavailableError.prototype);
+    }
+}
+exports.ServiceUnavailableError = ServiceUnavailableError;

package/dist/helper.d.ts

@@ -0,0 +1 @@
+export declare const deepCopy: <T>(source: T) => T;

package/dist/helper.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deepCopy = void 0;
+/*
+ * Copyright (C) 2022 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 deepCopy = (source) => {
+    return Array.isArray(source)
+        ? source.map(item => exports.deepCopy(item))
+        : source instanceof Date
+            ? new Date(source.getTime())
+            : source && typeof source === 'object'
+                ? Object.getOwnPropertyNames(source).reduce((o, prop) => {
+                    Object.defineProperty(o, prop, Object.getOwnPropertyDescriptor(source, prop));
+                    o[prop] = exports.deepCopy(source[prop]);
+                    return o;
+                }, Object.create(Object.getPrototypeOf(source)))
+                : source;
+};
+exports.deepCopy = deepCopy;

package/dist/index.d.ts

@@ -1,3 +1,6 @@
 import createService, { PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO, getObjectProto } from "./service";
-import { Transport, ProcessorConfig, MessageRequest, NetInterface, Method, Direction, ObjectProto, ServiceInfo } from "./types";
-export { createService, getObjectProto, Transport, ProcessorConfig, MessageRequest, NetInterface, Method, Direction, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+import { calculateAuthResponse, generateNonce } from "./auth";
+import { ServiceUnavailableError } from "./errors";
+import { Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, Route } from "./types";
+export { createService, getObjectProto, generateNonce, calculateAuthResponse, Route, ServiceUnavailableError, Transport, ProcessorConfig, MessageRequest, MessageResponse, NetInterface, Method, ObjectProto, ServiceInfo, PROCESSOR_OBJECT_PROTO, LOCATION_OBJECT_PROTO };
+export * as Helper from "./helper";

package/dist/index.js

@@ -19,7 +19,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.getObjectProto = exports.createService = void 0;
+exports.Helper = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.ServiceUnavailableError = exports.calculateAuthResponse = exports.generateNonce = exports.getObjectProto = exports.createService = void 0;
 /*
  * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
  * http://github.com/fonoster/routr
@@ -38,8 +38,14 @@ exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = exports.getObje
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-var service_1 = __importStar(require("./service"));
+const service_1 = __importStar(require("./service"));
 exports.createService = service_1.default;
 Object.defineProperty(exports, "PROCESSOR_OBJECT_PROTO", { enumerable: true, get: function () { return service_1.PROCESSOR_OBJECT_PROTO; } });
 Object.defineProperty(exports, "LOCATION_OBJECT_PROTO", { enumerable: true, get: function () { return service_1.LOCATION_OBJECT_PROTO; } });
 Object.defineProperty(exports, "getObjectProto", { enumerable: true, get: function () { return service_1.getObjectProto; } });
+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; } });
+exports.Helper = __importStar(require("./helper"));

package/dist/protos/processor.proto

@@ -33,13 +33,15 @@ message NetInterface {
 }
 
 message MessageRequest {
+  // Same as the Call-Id header 
   string ref = 1;
-  Method method = 2;
-  NetInterface sender = 3;
-  repeated NetInterface external_addrs = 4;
-  repeated string localnets = 5;
-  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 6;
-  // .google.protobuf.Struct metadata = 7;
+  string edge_port_ref = 2;
+  Method method = 3;
+  NetInterface sender = 4;
+  repeated NetInterface external_addrs = 5;
+  repeated string localnets = 6;
+  fonoster.routr.sipmessage.v2draft1.SIPMessage message = 7;
+  // .google.protobuf.Struct metadata = 8;
 }
 
 message MessageResponse {

package/dist/protos/sipmessage.proto

@@ -68,6 +68,31 @@ enum ResponseType {
   SESSION_NOT_ACCEPTABLE = 57;
 }
 
+message WWWAuthenticate {
+  string realm = 1;
+  string domain = 2;
+  string scheme = 3;
+  string nonce = 4;
+  string algorithm = 5;
+  string qop = 6;
+  string opaque = 7;
+  bool stale = 8;
+}
+
+message Authorization {
+  string realm = 1;
+  string scheme = 2;
+  string c_nonce = 3;
+  string nonce = 4;
+  string algorithm = 5;
+  string qop = 6;
+  string opaque = 7;
+  string response = 8;
+  string username = 9;
+  string uri = 10;
+  int32 nonce_count = 11;
+}
+
 message CallID {
   string call_id = 1;
 }
@@ -118,6 +143,12 @@ message To {
   string tag = 2;
 }
 
+message Contact {
+  Address address = 1;
+  int32 expires = 2;
+  float q_value = 3;
+}
+
 message Expires {
   int32 expires = 1;
 }
@@ -129,9 +160,12 @@ message SIPMessage {
   }
   From from = 3;
   To to = 4;
-  CallID call_id = 5;
-  ContentLength content_length = 6;
-  Expires expires = 7;
-  repeated Via via = 8;
-  repeated Extension extensions = 9;
+  Contact contact = 5;
+  CallID call_id = 6;
+  ContentLength content_length = 7;
+  Expires expires = 8;
+  repeated Via via = 9;
+  repeated Extension extensions = 10;
+  WWWAuthenticate www_authenticate = 11;
+  Authorization authorization = 12;
 }

package/dist/service.js

@@ -4,11 +4,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getObjectProto = exports.LOCATION_OBJECT_PROTO = exports.PROCESSOR_OBJECT_PROTO = void 0;
-var errors_1 = require("./errors");
-var logger_1 = __importDefault(require("@fonoster/logger"));
-var protoLoader = require('@grpc/proto-loader');
-var grpc = require('@grpc/grpc-js');
-var loadOptions = {
+const errors_1 = require("./errors");
+const logger_1 = __importDefault(require("@fonoster/logger"));
+const protoLoader = require('@grpc/proto-loader');
+const grpc = require('@grpc/grpc-js');
+const loadOptions = {
     keepCase: true,
     longs: String,
     enums: String,
@@ -28,20 +28,20 @@ exports.LOCATION_OBJECT_PROTO = getObjectProto({
 });
 function getObjectProto(objectProto) {
     var _a, _b;
-    var definitions = protoLoader.loadSync(objectProto.path, loadOptions);
-    var objProto = (_b = (_a = grpc.loadPackageDefinition(definitions)) === null || _a === void 0 ? void 0 : _a.fonoster) === null || _b === void 0 ? void 0 : _b.routr[objectProto.name];
+    const definitions = protoLoader.loadSync(objectProto.path, loadOptions);
+    const objProto = (_b = (_a = grpc.loadPackageDefinition(definitions)) === null || _a === void 0 ? void 0 : _a.fonoster) === null || _b === void 0 ? void 0 : _b.routr[objectProto.name];
     return objProto && objProto[objectProto.version]
         ? objProto[objectProto.version]
         : new errors_1.ServiceDefinitionNotFound(objectProto.name, objectProto.version);
 }
 exports.getObjectProto = getObjectProto;
 function createService(serviceInfo) {
-    var cb = function () {
-        logger_1.default.info("starting " + serviceInfo.name + " service at " + serviceInfo.bindAddr);
+    const cb = () => {
+        logger_1.default.info(`starting ${serviceInfo.name} service @ ${serviceInfo.bindAddr}`);
         server.start();
     };
-    var credentials = grpc.ServerCredentials.createInsecure();
-    var server = new grpc.Server();
+    const credentials = grpc.ServerCredentials.createInsecure();
+    const server = new grpc.Server();
     server.addService(serviceInfo.service, serviceInfo.handlers);
     server.bindAsync(serviceInfo.bindAddr, credentials, cb);
 }

package/dist/types.d.ts

@@ -1,4 +1,3 @@
-export declare type Direction = 'IN' | 'OUT';
 export declare type Method = 'UNKNOWN' | 'REGISTER' | 'INVITE' | 'MESSAGE' | 'PUBLISH' | 'NOTIFY' | 'SUBSCRIBE';
 export declare type Transport = 'TCP' | 'UDP' | 'TLS' | 'SCTP' | 'WS' | 'WSS';
 export interface NetInterface {
@@ -8,11 +7,15 @@ export interface NetInterface {
 }
 export interface MessageRequest {
     ref: string;
-    direction: Direction;
+    edge_port_ref: string;
     method: Method;
-    originInterface: NetInterface;
-    targetInterface: NetInterface;
-    sipMessage: Record<string, unknown>;
+    sender: NetInterface;
+    external_addrs: NetInterface[];
+    localnets: string[];
+    message: Record<string, unknown>;
+}
+export interface MessageResponse {
+    message: Record<string, unknown>;
 }
 export interface ProcessorConfig {
     ref: string;
@@ -21,6 +24,10 @@ export interface ProcessorConfig {
     isFallback?: boolean;
     matchFunc?: (request: MessageRequest) => boolean;
 }
+export interface MiddlewareConfig {
+    ref: string;
+    addr: string;
+}
 export interface ServiceInfo {
     name: string;
     bindAddr: string;
@@ -32,3 +39,40 @@ export interface ObjectProto {
     path: string;
     version: string;
 }
+export interface AuthChallengeRequest {
+    realm: string;
+    domain: string;
+    scheme: string;
+    nonce: string;
+    algorithm: string;
+    qop: string;
+    opaque: string;
+    stale: boolean;
+}
+export interface AuthChallengeResponse {
+    realm: string;
+    domain: string;
+    scheme: string;
+    c_nonce: string;
+    nonce_count: number;
+    response: string;
+    username: string;
+    nonce: string;
+    algorithm: string;
+    qop: string;
+    opaque: string;
+    stale: boolean;
+    uri: string;
+    method: string;
+}
+export interface Route {
+    user: string;
+    host: string;
+    port: number;
+    transport: string;
+    registeredOn: number;
+    sessionCount?: number;
+    expires: number;
+    edgePortRef: string;
+    labels?: Map<string, string>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.5-alpha.2",
+  "version": "2.0.5-alpha.6",
   "description": "Common package",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -14,7 +14,7 @@
   },
   "dependencies": {
     "@fonoster/logger": "^0.3.3",
-    "@grpc/grpc-js": "^1.5.5",
+    "@grpc/grpc-js": "^1.5.9",
     "@grpc/proto-loader": "^0.6.9",
     "fp-ts": "^2.11.8"
   },
@@ -35,5 +35,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "3570106be9a96cb6672de4a850a377bfa7d9bb3e"
+  "gitHead": "ac4963e735fbc4ad3045379463796137e650509c"
 }