@routr/simpleauth 2.0.5-alpha.14 → 2.0.5-alpha.16

package/dist/runner.js

@@ -22,22 +22,28 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const logger_1 = __importDefault(require("@fonoster/logger"));
+// eslint-disable-next-line @typescript-eslint/no-var-requires
+require("./tracer").init("simpleauth");
 const service_1 = __importDefault(require("./service"));
-if (!process.env.PATH_TO_AUTH) {
-    logger_1.default.error("environment variable PATH_TO_AUTH is required but was not found");
-    process.exit(1);
-}
-const whiteList = process.env.WHITELIST ? process.env.WHITELIST.split(',') : [];
+const common_1 = require("@routr/common");
+const logger_1 = require("@fonoster/logger");
+const logger = (0, logger_1.getLogger)({ service: "simpleauth", filePath: __filename });
+common_1.Assertions.assertEnvsAreSet(["PATH_TO_AUTH"]);
+const whiteList = process.env.WHITELIST ? process.env.WHITELIST.split(",") : [];
 try {
+    // eslint-disable-next-line @typescript-eslint/no-var-requires
     const users = require(process.env.PATH_TO_AUTH);
-    service_1.default({ bindAddr: process.env.BIND_ADDR || "0.0.0.0:51903", users, whiteList });
+    (0, service_1.default)({
+        bindAddr: process.env.BIND_ADDR || "0.0.0.0:51903",
+        users,
+        whiteList
+    });
 }
 catch (e) {
     if (e.code === "MODULE_NOT_FOUND") {
-        logger_1.default.error(`auth file not found [path = ${process.env.PATH_TO_AUTH}]`);
+        logger.error(`auth file not found [path = ${process.env.PATH_TO_AUTH}]`);
     }
     else {
-        logger_1.default.error(e);
+        logger.error(e);
     }
 }

package/dist/service.d.ts

@@ -1,6 +1,15 @@
 #!/usr/bin/env node
-import { User } from './types';
-export default function SimpleAuthProcessor(config: {
+import { User } from "./types";
+/**
+ * A simple authentication middleware that authenticates users based on a list of users
+ * or whitelisted endpoints paths.
+ *
+ * @param {MiddlewareConfig} config - configuration for the middleware
+ * @param {string} config.bindAddr - address to bind to
+ * @param {User[]} config.users - list of users
+ * @param {string[]} config.whiteList - list of path that required no authentication
+ */
+export default function simpleAuthMiddleware(config: {
     bindAddr: string;
     users: User[];
     whiteList: string[];

package/dist/service.js

@@ -10,7 +10,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
  *
  * This file is part of Routr
  *
- * Licensed under the MIT License (the "License");
+ * 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
  *
@@ -22,28 +22,36 @@ Object.defineProperty(exports, "__esModule", { value: true });
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const common_1 = require("@routr/common");
-const tracer = common_1.Tracer.init("simpleauth");
 const api_1 = __importDefault(require("@opentelemetry/api"));
-const logger_1 = __importDefault(require("@fonoster/logger"));
-const common_2 = require("@routr/common");
+const common_1 = require("@routr/common");
 const utils_1 = require("./utils");
 const processor_1 = __importDefault(require("@routr/processor"));
-function SimpleAuthProcessor(config) {
+const logger_1 = require("@fonoster/logger");
+const logger = (0, logger_1.getLogger)({ service: "simpledata", filePath: __filename });
+/**
+ * A simple authentication middleware that authenticates users based on a list of users
+ * or whitelisted endpoints paths.
+ *
+ * @param {MiddlewareConfig} config - configuration for the middleware
+ * @param {string} config.bindAddr - address to bind to
+ * @param {User[]} config.users - list of users
+ * @param {string[]} config.whiteList - list of path that required no authentication
+ */
+function simpleAuthMiddleware(config) {
     const { bindAddr, users, whiteList } = config;
-    new processor_1.default({ bindAddr, name: "simpleauth" })
-        .listen((req, res) => {
-        logger_1.default.verbose(`authenticating ${req.message.from.address.uri.user} endpoint with simpleauth`);
-        logger_1.default.silly(JSON.stringify(req, null, ' '));
+    new processor_1.default({ bindAddr, name: "simpleauth" }).listen((req, res) => {
+        const tracer = api_1.default.trace.getTracer("routr-tracer");
         const currentSpan = api_1.default.trace.getSpan(api_1.default.context.active());
-        // display traceid in the terminal
-        logger_1.default.verbose(`traceid: ${currentSpan.spanContext().traceId}`);
-        const span = tracer.startSpan('server.js:sayHello()', {
-            kind: 1,
-            attributes: { key: 'value' },
-        });
-        span.addEvent(`invoking sayHello() to...`);
+        logger.silly(`authenticating ${req.message.from.address.uri.user} endpoint with simpleauth`, { traceId: currentSpan === null || currentSpan === void 0 ? void 0 : currentSpan.spanContext().traceId });
+        logger.silly(JSON.stringify(req, null, " "));
+        const span = tracer.startSpan("server.js:sayHello()", { kind: 1 });
+        // Consider extending the list to other message types
+        if (![common_1.CommonTypes.Method.INVITE, common_1.CommonTypes.Method.MESSAGE, common_1.CommonTypes.Method.REGISTER].includes(req.method)) {
+            return res.send(req);
+        }
         if (whiteList.includes(req.message.from.address.uri.user)) {
+            span.addEvent(`authenticated ${req.message.from.address.uri.user} from whitelist`);
+            span.end();
             return res.send(req);
         }
         // Calculate and return challenge
@@ -51,16 +59,22 @@ function SimpleAuthProcessor(config) {
             const auth = Object.assign({}, req.message.authorization);
             auth.method = req.method;
             // Calculate response and compare with the one send by the endpoint
-            const calcRes = common_2.calculateAuthResponse(auth, utils_1.getCredentials(auth.username, users));
+            const calcRes = (0, common_1.calculateAuthResponse)(auth, (0, utils_1.getCredentials)(auth.username, users));
             if (calcRes !== auth.response) {
-                return res.send(utils_1.createUnauthorizedResponse(auth.realm));
+                span.addEvent(`user ${req.message.from.address.uri.user} unauthorized to complete request`);
+                span.end();
+                return res.send((0, utils_1.createUnauthorizedResponse)(auth.realm));
             }
         }
         else {
-            return res.send(utils_1.createUnauthorizedResponse(req.message.requestUri.host));
+            span.addEvent(`authorization header not found for user ${req.message.from.address.uri.user}`);
+            span.end();
+            return res.send((0, utils_1.createUnauthorizedResponse)(req.message.requestUri.host));
         }
         // Forward request to next middleware
+        span.addEvent(`user ${req.message.from.address.uri.user} authorized`);
+        span.end();
         res.send(req);
     });
 }
-exports.default = SimpleAuthProcessor;
+exports.default = simpleAuthMiddleware;

package/dist/tracer.d.ts

@@ -0,0 +1,7 @@
+/**
+ * This function registers the instrumentations for the service.
+ *
+ * @param {string} serviceName - The name of the service.
+ * @return {Tracer} The tracer object.
+ */
+export declare function init(serviceName: string): import("@opentelemetry/api").Tracer;

package/dist/tracer.js

@@ -0,0 +1,53 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.init = 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 api_1 = __importDefault(require("@opentelemetry/api"));
+const instrumentation_1 = require("@opentelemetry/instrumentation");
+const sdk_trace_node_1 = require("@opentelemetry/sdk-trace-node");
+const resources_1 = require("@opentelemetry/resources");
+const semantic_conventions_1 = require("@opentelemetry/semantic-conventions");
+const sdk_trace_base_1 = require("@opentelemetry/sdk-trace-base");
+const exporter_jaeger_1 = require("@opentelemetry/exporter-jaeger");
+const instrumentation_grpc_1 = require("@opentelemetry/instrumentation-grpc");
+/**
+ * This function registers the instrumentations for the service.
+ *
+ * @param {string} serviceName - The name of the service.
+ * @return {Tracer} The tracer object.
+ */
+function init(serviceName) {
+    const provider = new sdk_trace_node_1.NodeTracerProvider({
+        resource: new resources_1.Resource({
+            [semantic_conventions_1.SemanticResourceAttributes.SERVICE_NAME]: serviceName
+        })
+    });
+    const exporter = new exporter_jaeger_1.JaegerExporter();
+    provider.addSpanProcessor(new sdk_trace_base_1.SimpleSpanProcessor(exporter));
+    provider.register();
+    (0, instrumentation_1.registerInstrumentations)({
+        instrumentations: [new instrumentation_grpc_1.GrpcInstrumentation()]
+    });
+    return api_1.default.trace.getTracer("routr-tracer");
+}
+exports.init = init;

package/dist/utils.js

@@ -20,7 +20,7 @@ exports.createUnauthorizedResponse = exports.getCredentials = void 0;
  * limitations under the License.
  */
 const common_1 = require("@routr/common");
-const getCredentials = (username, users) => users.find(user => user.username === username);
+const getCredentials = (username, users) => users.find((user) => user.username === username);
 exports.getCredentials = getCredentials;
 const createUnauthorizedResponse = (realm, params = { qop: "auth", algorithm: "MD5" }) => {
     return {
@@ -28,18 +28,18 @@ const createUnauthorizedResponse = (realm, params = { qop: "auth", algorithm: "M
             // UNAUTHORIZED CODE
             responseType: 17,
             wwwAuthenticate: {
-                scheme: 'Digest',
+                scheme: "Digest",
                 realm: realm,
                 qop: params.qop,
-                opaque: '',
+                opaque: "",
                 stale: false,
-                nonce: common_1.generateNonce(),
+                nonce: (0, common_1.generateNonce)(),
                 algorithm: params.algorithm
             },
             extensions: [
                 {
-                    "name": "Expires",
-                    "value": 0
+                    name: "Expires",
+                    value: 0
                 }
             ]
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@routr/simpleauth",
-  "version": "2.0.5-alpha.14",
+  "version": "2.0.5-alpha.16",
   "description": "This middleware delegates authentication to an external service",
   "author": "Pedro Sanders <psanders@fonoster.com>",
   "homepage": "https://github.com/fonoster/routr#readme",
@@ -19,19 +19,18 @@
     "run_simpleauth": "dist/runner.js"
   },
   "dependencies": {
-    "@fonoster/logger": "^0.3.3",
-    "@grpc/grpc-js": "^1.3.7",
-    "@opentelemetry/api": "^1.0.2",
-    "@opentelemetry/exporter-jaeger": "^1.0.1",
-    "@opentelemetry/exporter-zipkin": "^1.0.1",
+    "@fonoster/logger": "0.3.17-alpha.2",
+    "@grpc/grpc-js": "^1.5.9",
+    "@opentelemetry/api": "^1.0.4",
+    "@opentelemetry/exporter-jaeger": "^1.0.4",
     "@opentelemetry/instrumentation": "^0.27.0",
     "@opentelemetry/instrumentation-grpc": "^0.27.0",
-    "@opentelemetry/resources": "^1.0.1",
-    "@opentelemetry/sdk-trace-base": "^1.0.1",
-    "@opentelemetry/sdk-trace-node": "^1.0.1",
-    "@opentelemetry/semantic-conventions": "^1.0.1",
-    "@routr/common": "^2.0.5-alpha.14",
-    "@routr/processor": "^2.0.5-alpha.14",
+    "@opentelemetry/resources": "^1.0.4",
+    "@opentelemetry/sdk-trace-base": "^1.0.4",
+    "@opentelemetry/sdk-trace-node": "^1.0.4",
+    "@opentelemetry/semantic-conventions": "^1.0.4",
+    "@routr/common": "^2.0.5-alpha.16",
+    "@routr/processor": "^2.0.5-alpha.16",
     "google-protobuf": "^3.9.2"
   },
   "files": [
@@ -47,5 +46,5 @@
   "bugs": {
     "url": "https://github.com/fonoster/routr/issues"
   },
-  "gitHead": "6dd8fe8ce94c72a1d669c98466bead23400875ce"
+  "gitHead": "b40323ac18cc3872b168bf4e8273f5bdb3f7510a"
 }