@alanszp/express-common-fn 12.0.2 → 13.0.0

package/node_modules/@alanszp/express/src/middlewares/auditLog.ts

@@ -1,52 +0,0 @@
-import { NextFunction, Response, Request } from "express";
-import { AuditBody } from "@alanszp/audit";
-import { getIp } from "../helpers/getIp";
-import { GenericRequest } from "../types/GenericRequest";
-
-export type AuditBodyModifier = (
-  req: Request<Record<string, string>, unknown, unknown>,
-  res: Response
-) => Promise<Partial<AuditBody>> | Partial<AuditBody>;
-
-/**
- * Configures the audit log to execute AFTER the response is sent.
- */
-export function auditLog(action: string, bodyModifier?: AuditBodyModifier) {
-  return function writeAuditLogMiddleware(
-    req: GenericRequest,
-    res: Response,
-    next: NextFunction
-  ): void {
-    res.on("finish", async function writeAuditLog() {
-      try {
-        const audit = req.context.audit;
-
-        const partialBody = bodyModifier
-          ? await Promise.resolve(bodyModifier(req, res))
-          : ({} as Partial<AuditBody>);
-
-        if (req.context.jwtUser) {
-          partialBody.orgRef = req.context.jwtUser.organizationReference;
-          partialBody.actorRef = req.context.jwtUser.id;
-        }
-
-        partialBody.ip = getIp(req) || "no-ip";
-
-        audit.log({
-          succeed:
-            res.statusCode === 304 ||
-            (res.statusCode >= 200 && res.statusCode < 300),
-          ...partialBody,
-          lid: req.context.lifecycleId ?? undefined,
-          lch: req.context.lifecycleChain ?? undefined,
-          cid: req.context.contextId ?? undefined,
-          action,
-        });
-      } catch (error: unknown) {
-        req.context.log.error("auditLog.writeLog.error", { action, error });
-      }
-    });
-
-    next();
-  };
-}

package/node_modules/@alanszp/express/src/middlewares/authedForOrg.ts

@@ -1,50 +0,0 @@
-import { NextFunction, Response } from "express";
-import { getRequestLogger } from "../helpers/getRequestLogger";
-import { GenericRequest } from "../types/GenericRequest";
-import { render401Error, render404Error } from "../helpers/renderErrorJson";
-
-function response401(res: Response): void {
-  res.status(401).json(render401Error(["jwt"]));
-}
-
-export function authForOrg(
-  req: GenericRequest,
-  res: Response,
-  next: NextFunction
-): void {
-  const { orgReference } = req.params;
-  const logger = getRequestLogger(req).child({ org: orgReference });
-  try {
-    if (!orgReference) {
-      logger.error("middleware.authForOrg.error.noOrgReferenceInPath");
-      return response401(res);
-    }
-
-    if (!req.context?.jwtUser?.organizationReference) {
-      logger.info("middleware.authForOrg.error.noOrgInJwt", {
-        jwtUser: req.context?.jwtUser || null,
-      });
-      return response401(res);
-    }
-
-    const jwtOrg = req.context.jwtUser.organizationReference;
-    if (jwtOrg !== orgReference) {
-      if (jwtOrg === "lara") {
-        req.context.jwtUser.organizationReference = orgReference;
-        return next();
-      }
-
-      logger.info("middleware.authForOrg.error.nonMatch", {
-        jwtOrg,
-      });
-      return response401(res);
-    }
-
-    return next();
-  } catch (error: unknown) {
-    logger.info("middleware.authForOrg.error.noOrganization", {
-      error,
-    });
-    res.status(404).json(render404Error());
-  }
-}

package/node_modules/@alanszp/express/src/middlewares/authenticateUser.test.ts

@@ -1,403 +0,0 @@
-import { AuthMethods, createAuthContext } from "./authenticateUser";
-import { verifyJWT } from "@alanszp/jwt";
-import {
-  mockNext,
-  mockRequest,
-  mockResponse,
-} from "../test/mocks/expressMocks";
-import { laraJwtUserMock, userJwtUserMock } from "../test/mocks/jwtUserMocks";
-import {
-  apiKeyAuthOptions,
-  bothMethodsAuthOptions,
-  jwtAuthOptions,
-  verifyOptions,
-} from "../test/mocks/authOptionsMocks";
-
-jest.mock("@alanszp/jwt");
-
-describe("AuthenticateUser", () => {
-  describe("authentication with only JWT", () => {
-    describe("when jwt verifies correctly", () => {
-      it("should authenticate correctly and call next", async () => {
-        (verifyJWT as jest.Mock).mockResolvedValueOnce(userJwtUserMock);
-
-        const req = mockRequest("Bearer token");
-        const res = mockResponse();
-        const next = mockNext();
-
-        await createAuthContext(jwtAuthOptions)([AuthMethods.JWT])(
-          req,
-          res,
-          next
-        );
-
-        expect(verifyJWT).toBeCalledWith("publicKey", "token", verifyOptions);
-        expect(res.status).toHaveBeenCalledTimes(0);
-        expect(res.json).toHaveBeenCalledTimes(0);
-        expect(req.context.jwtUser).toMatchObject(userJwtUserMock);
-        expect(req.context.authenticated).toStrictEqual(["jwt"]);
-        expect(next).toBeCalledWith();
-      });
-    });
-
-    describe("when jwt verifies incorrectly", () => {
-      it("should not authenticate, should not call next, and it should return 401", async () => {
-        (verifyJWT as jest.Mock).mockResolvedValueOnce(undefined);
-
-        const req = mockRequest("Bearer token");
-        const res = mockResponse();
-        const next = mockNext();
-
-        await createAuthContext(jwtAuthOptions)([AuthMethods.JWT])(
-          req,
-          res,
-          next
-        );
-
-        expect(verifyJWT).toBeCalledWith("publicKey", "token", verifyOptions);
-        expect(res.status).toHaveBeenCalledWith(401);
-        expect(res.json).toHaveBeenCalledTimes(1);
-        expect(req.context.jwtUser).toBe(undefined);
-        expect(req.context.authenticated).toEqual([]);
-        expect(next).toHaveBeenCalledTimes(0);
-      });
-    });
-
-    describe("when jwt doesn't exist", () => {
-      it("should not verify JWT, should not authenticate, should not call next, and it should return 401", async () => {
-        const req = mockRequest("aa");
-        const res = mockResponse();
-        const next = mockNext();
-
-        await createAuthContext(jwtAuthOptions)([AuthMethods.JWT])(
-          req,
-          res,
-          next
-        );
-
-        expect(verifyJWT).toHaveBeenCalledTimes(0);
-        expect(res.status).toHaveBeenCalledWith(401);
-        expect(res.json).toHaveBeenCalledTimes(1);
-        expect(req.context.jwtUser).toBe(undefined);
-        expect(req.context.authenticated).toEqual([]);
-        expect(next).toHaveBeenCalledTimes(0);
-      });
-    });
-  });
-
-  describe("authentication with only API KEY", () => {
-    describe("when api key verifies correctly", () => {
-      it("should authenticate correctly and call next", async () => {
-        const req = mockRequest("token");
-        const res = mockResponse();
-        const next = mockNext();
-
-        await createAuthContext(apiKeyAuthOptions)([AuthMethods.API_KEY])(
-          req,
-          res,
-          next
-        );
-
-        expect(verifyJWT).toHaveBeenCalledTimes(0);
-        expect(res.status).toHaveBeenCalledTimes(0);
-        expect(res.json).toHaveBeenCalledTimes(0);
-        expect(req.context.jwtUser).toMatchObject(laraJwtUserMock);
-        expect(req.context.authenticated).toStrictEqual(["api_key"]);
-        expect(next).toBeCalledWith();
-      });
-    });
-
-    describe("when api key verifies incorrectly", () => {
-      it("should not authenticate, should not call next, and it should return 401", async () => {
-        const req = mockRequest("invalidToken");
-        const res = mockResponse();
-        const next = mockNext();
-
-        await createAuthContext(apiKeyAuthOptions)([AuthMethods.API_KEY])(
-          req,
-          res,
-          next
-        );
-
-        expect(verifyJWT).toHaveBeenCalledTimes(0);
-        expect(res.status).toHaveBeenCalledWith(401);
-        expect(res.json).toHaveBeenCalledTimes(1);
-        expect(req.context.jwtUser).toBe(undefined);
-        expect(req.context.authenticated).toEqual([]);
-        expect(next).toHaveBeenCalledTimes(0);
-      });
-    });
-
-    describe("when api key doesn't exist", () => {
-      it("should not verify api key, should not authenticate, should not call next, and it should return 401", async () => {
-        const req = mockRequest(undefined as any);
-        const res = mockResponse();
-        const next = mockNext();
-
-        await createAuthContext(apiKeyAuthOptions)([AuthMethods.API_KEY])(
-          req,
-          res,
-          next
-        );
-
-        expect(verifyJWT).toHaveBeenCalledTimes(0);
-        expect(res.status).toHaveBeenCalledWith(401);
-        expect(res.json).toHaveBeenCalledTimes(1);
-        expect(req.context.jwtUser).toBe(undefined);
-        expect(req.context.authenticated).toEqual([]);
-        expect(next).toHaveBeenCalledTimes(0);
-      });
-    });
-  });
-
-  describe("authentication with JWT and API KEY", () => {
-    describe("using both methods", () => {
-      describe("when api key verifies correctly", () => {
-        it("should authenticate correctly and call next", async () => {
-          const req = mockRequest("token");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-            AuthMethods.JWT,
-          ])(req, res, next);
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledTimes(0);
-          expect(res.json).toHaveBeenCalledTimes(0);
-          expect(req.context.jwtUser).toMatchObject(laraJwtUserMock);
-          expect(req.context.authenticated).toStrictEqual(["api_key"]);
-          expect(next).toHaveBeenCalledWith();
-        });
-      });
-
-      describe("when api key verifies incorrectly", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          const req = mockRequest("invalidToken");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-            AuthMethods.JWT,
-          ])(req, res, next);
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-
-      describe("when jwt verifies correctly", () => {
-        it("should authenticate correctly and call next", async () => {
-          (verifyJWT as jest.Mock).mockResolvedValueOnce(userJwtUserMock);
-
-          const req = mockRequest("Bearer token");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-            AuthMethods.JWT,
-          ])(req, res, next);
-
-          expect(verifyJWT).toBeCalledWith("publicKey", "token", {
-            issuer: "issuer",
-            audience: "audience",
-          });
-          expect(res.status).toHaveBeenCalledTimes(0);
-          expect(res.json).toHaveBeenCalledTimes(0);
-
-          expect(req.context.jwtUser).toMatchObject(userJwtUserMock);
-
-          expect(req.context.authenticated).toStrictEqual(["jwt"]);
-
-          expect(next).toHaveBeenCalledWith();
-        });
-      });
-
-      describe("when jwt verifies incorrectly", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          (verifyJWT as jest.Mock).mockResolvedValueOnce(undefined);
-
-          const req = mockRequest("Bearer token");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-            AuthMethods.JWT,
-          ])(req, res, next);
-
-          expect(verifyJWT).toBeCalledWith("publicKey", "token", {
-            issuer: "issuer",
-            audience: "audience",
-          });
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-
-      describe("when jwt doesnt exist", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          const req = mockRequest(undefined as any);
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-            AuthMethods.JWT,
-          ])(req, res, next);
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-    });
-
-    describe("using jwt method", () => {
-      describe("when jwt verifies correctly", () => {
-        it("should authenticate correctly and call next", async () => {
-          (verifyJWT as jest.Mock).mockResolvedValueOnce(userJwtUserMock);
-
-          const req = mockRequest("Bearer token");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([AuthMethods.JWT])(
-            req,
-            res,
-            next
-          );
-
-          expect(verifyJWT).toBeCalledWith("publicKey", "token", {
-            issuer: "issuer",
-            audience: "audience",
-          });
-          expect(res.status).toHaveBeenCalledTimes(0);
-          expect(res.json).toHaveBeenCalledTimes(0);
-          expect(req.context.jwtUser).toMatchObject(userJwtUserMock);
-          expect(req.context.authenticated).toStrictEqual(["jwt"]);
-          expect(next).toHaveBeenCalledWith();
-        });
-      });
-
-      describe("when jwt verifies incorrectly", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          (verifyJWT as jest.Mock).mockResolvedValueOnce(undefined);
-
-          const req = mockRequest("Bearer invalidToken");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([AuthMethods.JWT])(
-            req,
-            res,
-            next
-          );
-
-          expect(verifyJWT).toBeCalledWith("publicKey", "invalidToken", {
-            issuer: "issuer",
-            audience: "audience",
-          });
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-
-      describe("when api key verifies correctly", () => {
-        it("should authenticate correctly and call next", async () => {
-          const req = mockRequest("token");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-          ])(req, res, next);
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledTimes(0);
-          expect(res.json).toHaveBeenCalledTimes(0);
-
-          expect(req.context.jwtUser).toMatchObject(laraJwtUserMock);
-          expect(req.context.authenticated).toStrictEqual(["api_key"]);
-          expect(next).toHaveBeenCalledWith();
-        });
-      });
-
-      describe("when api key verifies incorrectly", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          const req = mockRequest("invalidToken");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-            AuthMethods.JWT,
-          ])(req, res, next);
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-
-      describe("when jwt doesnt exist", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          const req = mockRequest("aaa");
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([AuthMethods.JWT])(
-            req,
-            res,
-            next
-          );
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-
-      describe("when api key doesnt exist", () => {
-        it("should not authenticate, should not call next, and it should return 401", async () => {
-          const req = mockRequest(undefined as any);
-          const res = mockResponse();
-          const next = mockNext();
-
-          await createAuthContext(bothMethodsAuthOptions)([
-            AuthMethods.API_KEY,
-          ])(req, res, next);
-
-          expect(verifyJWT).toHaveBeenCalledTimes(0);
-          expect(res.status).toHaveBeenCalledWith(401);
-          expect(res.json).toHaveBeenCalledTimes(1);
-          expect(req.context.jwtUser).toBe(undefined);
-          expect(req.context.authenticated).toEqual([]);
-          expect(next).toHaveBeenCalledTimes(0);
-        });
-      });
-    });
-  });
-});

package/node_modules/@alanszp/express/src/middlewares/authenticateUser.ts

@@ -1,171 +0,0 @@
-import { JWTUser, verifyJWT, VerifyOptions } from "@alanszp/jwt";
-import { NextFunction, Response } from "express";
-import { getRequestLogger } from "../helpers/getRequestLogger";
-import { GenericRequest } from "../types/GenericRequest";
-import { ILogger } from "@alanszp/logger";
-import { compact, isEmpty, omit } from "lodash";
-import { render401Error } from "../helpers/renderErrorJson";
-
-function parseAuthorizationHeader(
-  authorization: string | undefined
-): string | undefined {
-  if (!authorization) return undefined;
-  const [bearer, jwt, ...other] = authorization.split(" ");
-
-  if (bearer !== "Bearer" || other.length > 0) return undefined;
-
-  return jwt;
-}
-
-export enum AuthMethods {
-  JWT = "JWT",
-  API_KEY = "API_KEY",
-}
-
-export interface JWTVerifyOptions extends Partial<VerifyOptions> {
-  publicKey: string;
-}
-
-export interface JWTOptions {
-  jwtVerifyOptions: JWTVerifyOptions;
-  types: [AuthMethods.JWT];
-}
-
-export interface ApiKeyOptions {
-  validApiKeys: string[];
-  types: [AuthMethods.API_KEY];
-}
-
-export interface BothMethodsOptions {
-  jwtVerifyOptions: JWTVerifyOptions;
-  validApiKeys: string[];
-  types:
-    | [AuthMethods.JWT, AuthMethods.API_KEY]
-    | [AuthMethods.API_KEY, AuthMethods.JWT];
-}
-
-export type AuthOptions = JWTOptions | ApiKeyOptions | BothMethodsOptions;
-
-const middlewareGetterByAuthType: Record<
-  AuthMethods,
-  (
-    tokenOrJwt: string | null | undefined,
-    options: AuthOptions,
-    logger: ILogger
-  ) => Promise<JWTUser | null | undefined>
-> = {
-  [AuthMethods.JWT]: async (
-    jwt: string | null | undefined,
-    options: Exclude<AuthOptions, ApiKeyOptions>,
-    logger: ILogger
-  ) => {
-    try {
-      if (!jwt) return undefined;
-      const jwtUser = await verifyJWT(
-        options.jwtVerifyOptions.publicKey,
-        jwt,
-        omit(options.jwtVerifyOptions, "publicKey")
-      );
-      logger.debug("auth.authWithJwt.authed", {
-        user: jwtUser.id,
-        org: jwtUser.organizationReference,
-      });
-      return jwtUser;
-    } catch (error: unknown) {
-      logger.info("auth.authWithJwt.invalidJwt", { jwt, error });
-      return null;
-    }
-  },
-  [AuthMethods.API_KEY]: async (
-    token: string | null | undefined,
-    options: Exclude<AuthOptions, JWTOptions>,
-    logger: ILogger
-  ): Promise<JWTUser | null | undefined> => {
-    try {
-      if (!token) return undefined;
-      if (options.validApiKeys.includes(token)) {
-        logger.debug("auth.authWithApiKey.authed", {
-          user: "0",
-          org: "lara",
-        });
-        return Promise.resolve(
-          new JWTUser({
-            id: "0",
-            employeeReference: "0",
-            organizationReference: "lara",
-            roles: [],
-            segmentReference: null,
-            // This will be changed in the near future to grab all permissions.
-            permissions: "MA==", // 0 in base64
-          })
-        );
-      } else {
-        return null;
-      }
-    } catch (error: unknown) {
-      logger.info("auth.authWithApiKey.invalidApiKey", { token, error });
-      return null;
-    }
-  },
-};
-
-export function createAuthContext<Options extends AuthOptions>(
-  options: Options
-) {
-  return function getMiddlewareForMethods(
-    authMethods: Options["types"][number][]
-  ) {
-    return async function authWithGivenMethods(
-      req: GenericRequest,
-      res: Response,
-      next: NextFunction
-    ): Promise<void> {
-      const logger = getRequestLogger(req);
-      const cookies = (req.cookies as Record<string, string | undefined>) || {};
-      const jwt =
-        cookies.jwt || parseAuthorizationHeader(req.headers.authorization);
-
-      try {
-        const authAttempts = await Promise.all(
-          authMethods.map((method) =>
-            middlewareGetterByAuthType[method](
-              method === AuthMethods.JWT ? jwt : req.headers.authorization,
-              options,
-              logger
-            )
-          )
-        );
-
-        const successfulAuthAttempts = compact(authAttempts);
-
-        if (isEmpty(successfulAuthAttempts)) {
-          res
-            .status(401)
-            .json(
-              render401Error([
-                authAttempts.includes(null)
-                  ? `Token invalid for methods ${authMethods}`
-                  : `Token not set for methods ${authMethods}`,
-              ])
-            );
-          return;
-        }
-
-        const jwtUser: JWTUser = successfulAuthAttempts[0];
-        req.context.jwtUser = jwtUser;
-        req.context.authenticated.push(
-          jwtUser.employeeReference !== "0" ? "jwt" : "api_key"
-        );
-        next();
-      } catch (error: unknown) {
-        logger.info("auth.authenticateUser.error", {
-          jwt,
-          token: req.headers.authorization,
-          methods: AuthMethods,
-          error,
-        });
-        res.status(401).json(render401Error(authMethods));
-      }
-    };
-  };
-}