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

package/dist/auth.d.ts

@@ -1,10 +1,10 @@
-import { AuthChallengeRequest, AuthChallengeResponse } from "./types";
+import { AuthChallengeRequest, AuthChallengeResponse, ResponseType } from "./types";
 export declare const generateNonce: (algorithm?: string) => string;
 export declare const buildAuthChallenge: (request: AuthChallengeRequest) => {
     realm: string;
-    scheme: string;
-    algorithm: string;
-    qop: string;
+    scheme: import("./types").AuthorizationScheme;
+    algorithm: import("./types").AuthorizationAlgorithm;
+    qop: import("./types").Qop;
     opaque: string;
     stale: boolean;
     nonce: string;
@@ -25,7 +25,7 @@ export declare const createUnauthorizedResponse: (realm: string, params?: {
     algorithm: string;
 }) => {
     message: {
-        responseType: number;
+        responseType: ResponseType;
         wwwAuthenticate: {
             scheme: string;
             realm: string;
@@ -39,16 +39,16 @@ export declare const createUnauthorizedResponse: (realm: string, params?: {
 };
 export declare const createUnauthorizedResponseWithoutChallenge: () => {
     message: {
-        responseType: number;
+        responseType: ResponseType;
     };
 };
 export declare const createServerInternalErrorResponse: () => {
     message: {
-        responseType: number;
+        responseType: ResponseType;
     };
 };
 export declare const createForbideenResponse: () => {
     message: {
-        responseType: number;
+        responseType: ResponseType;
     };
 };

package/dist/auth.js

@@ -4,6 +4,25 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createForbideenResponse = exports.createServerInternalErrorResponse = exports.createUnauthorizedResponseWithoutChallenge = exports.createUnauthorizedResponse = exports.getCredentials = exports.calculateAuthResponse = exports.buildAuthChallenge = exports.generateNonce = 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 types_1 = require("./types");
 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");
@@ -37,11 +56,10 @@ const calculateAuthResponse = (res, credentials) => {
 exports.calculateAuthResponse = calculateAuthResponse;
 const getCredentials = (username, users) => users.find((user) => user.username === username);
 exports.getCredentials = getCredentials;
-const createUnauthorizedResponse = (realm, params = { qop: "auth", algorithm: "MD5" }) => {
+const createUnauthorizedResponse = (realm, params = { qop: "auth", algorithm: DEFAULT_ALGORITHM }) => {
     return {
         message: {
-            // Unauthorized Code
-            responseType: 17,
+            responseType: types_1.ResponseType.UNAUTHORIZED,
             wwwAuthenticate: {
                 scheme: "Digest",
                 realm: realm,
@@ -58,8 +76,7 @@ exports.createUnauthorizedResponse = createUnauthorizedResponse;
 const createUnauthorizedResponseWithoutChallenge = () => {
     return {
         message: {
-            // Unauthorized Code
-            responseType: 17
+            responseType: types_1.ResponseType.UNAUTHORIZED
         }
     };
 };
@@ -67,8 +84,7 @@ exports.createUnauthorizedResponseWithoutChallenge = createUnauthorizedResponseW
 const createServerInternalErrorResponse = () => {
     return {
         message: {
-            // Unauthorized Code
-            responseType: 46
+            responseType: types_1.ResponseType.SERVER_INTERNAL_ERROR
         }
     };
 };
@@ -76,8 +92,7 @@ exports.createServerInternalErrorResponse = createServerInternalErrorResponse;
 const createForbideenResponse = () => {
     return {
         message: {
-            // Forbideen Code
-            responseType: 19
+            responseType: types_1.ResponseType.FORBIDDEN
         }
     };
 };

package/dist/connect/connect_error.d.ts

@@ -0,0 +1,21 @@
+import { HeaderModifier, ResponseType } from "../types";
+export declare const CodeToResponseTypeMap: {
+    401: ResponseType;
+    403: ResponseType;
+    500: ResponseType;
+};
+export interface ConnectError {
+    code: keyof typeof CodeToResponseTypeMap;
+    reason?: string;
+    headers: HeaderModifier[];
+}
+export declare const convertToErrorResponse: (connectError: ConnectError) => {
+    message: {
+        responseType: ResponseType;
+        reasonPhrase: string;
+        extensions: {
+            name: string;
+            value: string;
+        }[];
+    };
+};

package/dist/connect/connect_error.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.convertToErrorResponse = exports.CodeToResponseTypeMap = void 0;
+const types_1 = require("../types");
+/*
+ * Copyright (C) 2022 by Fonoster Inc (https://fonoster.com)
+ * http://github.com/fonoster
+ *
+ * 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.
+ */
+exports.CodeToResponseTypeMap = {
+    401: types_1.ResponseType.UNAUTHORIZED,
+    403: types_1.ResponseType.FORBIDDEN,
+    500: types_1.ResponseType.SERVER_ERROR
+};
+const convertToErrorResponse = (connectError) => {
+    return {
+        message: {
+            responseType: exports.CodeToResponseTypeMap[connectError.code],
+            reasonPhrase: connectError.reason,
+            extensions: connectError.headers.map((modifier) => {
+                if (modifier.action === types_1.HeaderModifierAction.ADD) {
+                    return {
+                        name: modifier.name,
+                        value: modifier.value
+                    };
+                }
+            })
+        }
+    };
+};
+exports.convertToErrorResponse = convertToErrorResponse;

package/dist/protos/location.proto

@@ -60,8 +60,10 @@ message AddRouteRequest {
 }
 
 message FindRoutesRequest {
-  string aor = 1;
-  map<string, string> labels = 2;
+  string call_id = 1;
+  string aor = 2;
+  string session_affinity_ref = 3;
+  map<string, string> labels = 4;
 }
 
 message FindRoutesResponse {

package/dist/protos/sipmessage.proto

@@ -207,4 +207,6 @@ message SIPMessage {
   repeated Via via = 13;
   repeated Route route = 14;
   repeated RecordRoute record_route = 15;
+  string reason_phrase = 16;
+  string body = 17;
 }

package/dist/types.d.ts

@@ -32,6 +32,17 @@ export declare enum Privacy {
     NONE = "none",
     PRIVATE = "id"
 }
+export declare enum AuthorizationAlgorithm {
+    MD5 = "MD5"
+}
+export declare enum AuthorizationScheme {
+    DIGEST = "Digest"
+}
+export declare enum Qop {
+    AUTH = "auth",
+    AUTH_INT = "auth-int",
+    NONE = ""
+}
 export interface NetInterface {
     host: string;
     port: number;
@@ -74,28 +85,28 @@ export interface ObjectProto {
 export interface AuthChallengeRequest {
     realm: string;
     domain: string;
-    scheme: string;
-    nonce: string;
-    algorithm: string;
-    qop: string;
     opaque: string;
     stale: boolean;
+    nonce: string;
+    scheme: AuthorizationScheme;
+    algorithm: AuthorizationAlgorithm;
+    qop: Qop;
 }
 export interface AuthChallengeResponse {
     realm: string;
     domain: string;
-    scheme: string;
     cNonce: string;
+    nonce: string;
     nonceCount: number;
     response: string;
     username: string;
-    nonce: string;
-    algorithm: string;
-    qop: string;
     opaque: string;
     stale: boolean;
     uri: string;
-    method: string;
+    method: Method;
+    scheme: AuthorizationScheme;
+    algorithm: AuthorizationAlgorithm;
+    qop: Qop;
 }
 export declare enum HeaderModifierAction {
     ADD = "add",
@@ -112,6 +123,13 @@ export interface Route {
     port: number;
     transport: Transport;
     registeredOn?: number;
+    /**
+     * Number of active sessions. This is used to determine if a route is
+     * overloaded and for load balancing.
+     *
+     * This value is reported by the endpoint during the REGISTER request,
+     * using the X-Session-Count header.
+     */
     sessionCount?: number;
     expires?: number;
     edgePortRef: string;
@@ -193,17 +211,17 @@ export interface WWWAuthenticate {
 }
 export interface Authorization {
     realm: string;
-    scheme: string;
+    scheme: AuthorizationScheme;
     nonce: string;
     cNonce: string;
     nonceCount: number;
     response: string;
     username: string;
     uri: string;
-    algorithm: string;
-    qop: string;
+    algorithm: AuthorizationAlgorithm;
+    qop: Qop;
     opaque: string;
-    method?: string;
+    method?: Method;
 }
 export interface CallID {
     callId: string;

package/dist/types.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Privacy = exports.ExtraHeader = exports.Transport = exports.Method = void 0;
+exports.MessageType = exports.ResponseType = exports.HeaderModifierAction = exports.Qop = exports.AuthorizationScheme = exports.AuthorizationAlgorithm = exports.Privacy = exports.ExtraHeader = exports.Transport = exports.Method = void 0;
 var Method;
 (function (Method) {
     Method["UNKNOWN"] = "UNKNOWN";
@@ -38,6 +38,20 @@ var Privacy;
     Privacy["NONE"] = "none";
     Privacy["PRIVATE"] = "id";
 })(Privacy = exports.Privacy || (exports.Privacy = {}));
+var AuthorizationAlgorithm;
+(function (AuthorizationAlgorithm) {
+    AuthorizationAlgorithm["MD5"] = "MD5";
+})(AuthorizationAlgorithm = exports.AuthorizationAlgorithm || (exports.AuthorizationAlgorithm = {}));
+var AuthorizationScheme;
+(function (AuthorizationScheme) {
+    AuthorizationScheme["DIGEST"] = "Digest";
+})(AuthorizationScheme = exports.AuthorizationScheme || (exports.AuthorizationScheme = {}));
+var Qop;
+(function (Qop) {
+    Qop["AUTH"] = "auth";
+    Qop["AUTH_INT"] = "auth-int";
+    Qop["NONE"] = "";
+})(Qop = exports.Qop || (exports.Qop = {}));
 var HeaderModifierAction;
 (function (HeaderModifierAction) {
     HeaderModifierAction["ADD"] = "add";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/common",
-  "version": "2.0.8-alpha.10",
+  "version": "2.0.8-alpha.11",
   "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": "5082233fb155ddb8535f934550fa4013da87468e"
+  "gitHead": "627659ac51d0814a3106bcaac31a15c581a5809f"
 }