Setup org metadata POST and audit log writing (#302)

Author: devksingh4

package.json

@@ -39,7 +39,7 @@
     "@eslint/eslintrc": "^3.3.1",
     "@eslint/js": "^9.33.0",
     "@playwright/test": "^1.54.2",
-    "@smithy/types": "^4.3.2",
+    "@smithy/types": "^4.5.0",
     "@tsconfig/node22": "^22.0.1",
     "@types/ioredis-mock": "^8.2.5",
     "@types/node": "^24.3.0",
@@ -94,4 +94,4 @@
     "pdfjs-dist": "^4.8.69",
     "form-data": "^4.0.4"
   }
-}
+}

src/api/components/index.ts

@@ -36,6 +36,7 @@ export type RoleSchema = {
 
 type RolesConfig = {
   disableApiKeyAuth: boolean;
+  notes?: string;
 };
 
 export function getCorrectJsonSchema<T, U>({
@@ -193,7 +194,7 @@ export const validationError = getCorrectJsonSchema({
 export function withRoles<T extends FastifyZodOpenApiSchema>(
   roles: AppRoles[],
   schema: T,
-  { disableApiKeyAuth }: RolesConfig = { disableApiKeyAuth: false },
+  { disableApiKeyAuth, notes }: RolesConfig = { disableApiKeyAuth: false },
 ): T & RoleSchema {
   const security = [{ httpBearer: [] }] as any;
   if (!disableApiKeyAuth) {
@@ -231,6 +232,8 @@ ${schema.description}
 #### Authorization
 <hr />
 ${roles.length > 0 ? `Requires any of the following roles:\n\n${roles.map((item) => `* ${AppRoleHumanMapper[item]} (<code>${item}</code>)`).join("\n")}` : "Requires valid authentication but no specific authorization."}
+
+${notes ? `${notes}\n` : ""}
   `,
     ...schema,
     response: responses,

src/api/functions/authorization.ts

@@ -1,12 +1,26 @@
 import { DynamoDBClient, GetItemCommand } from "@aws-sdk/client-dynamodb";
 import { unmarshall } from "@aws-sdk/util-dynamodb";
 import { genericConfig } from "../../common/config.js";
-import { DatabaseFetchError } from "../../common/errors/index.js";
-import { allAppRoles, AppRoles } from "../../common/roles.js";
+import {
+  BaseError,
+  DatabaseFetchError,
+  InternalServerError,
+} from "../../common/errors/index.js";
+import {
+  allAppRoles,
+  AppRoles,
+  OrgRoleDefinition,
+} from "../../common/roles.js";
 import type Redis from "ioredis";
 import { AUTH_CACHE_PREFIX } from "api/plugins/auth.js";
 import type pino from "pino";
-import { type FastifyBaseLogger } from "fastify";
+import {
+  FastifyInstance,
+  FastifyReply,
+  FastifyRequest,
+  type FastifyBaseLogger,
+} from "fastify";
+import { getUserOrgRoles } from "./organizations.js";
 
 export async function getUserRoles(
   dynamoClient: DynamoDBClient,
@@ -91,3 +105,59 @@ export async function clearAuthCache({
   logger.debug(`Cleared ${result} auth cache keys.`);
   return result;
 }
+
+type AuthConfig = {
+  validRoles: OrgRoleDefinition[];
+};
+
+/**
+ * Authorizes a request by checking if the user has at least one of the specified organization roles.
+ * This function can be used as a preHandler in Fastify routes.
+ *
+ * @param fastify The Fastify instance.
+ * @param request The Fastify request object.
+ * @param reply The Fastify reply object.
+ * @param config An object containing an array of valid OrgRoleDefinition instances.
+ */
+export async function authorizeByOrgRoleOrSchema(
+  fastify: FastifyInstance,
+  request: FastifyRequest,
+  reply: FastifyReply,
+  config: AuthConfig,
+) {
+  let originalError = new InternalServerError({
+    message: "You do not have permission to perform this action.",
+  });
+
+  try {
+    await fastify.authorizeFromSchema(request, reply);
+    return;
+  } catch (e) {
+    if (e instanceof BaseError) {
+      originalError = e;
+    } else {
+      throw e;
+    }
+  }
+
+  if (!request.username) {
+    throw originalError;
+  }
+
+  const userRoles = await getUserOrgRoles({
+    username: request.username,
+    dynamoClient: fastify.dynamoClient,
+    logger: request.log,
+  });
+
+  const isAuthorized = userRoles.some((userRole) =>
+    config.validRoles.some(
+      (validRole) =>
+        userRole.org === validRole.org && userRole.role === validRole.role,
+    ),
+  );
+
+  if (!isAuthorized) {
+    throw originalError;
+  }
+}

src/api/functions/entraId.ts

@@ -292,6 +292,14 @@ export async function modifyGroup(
       ) {
         return true;
       }
+      if (
+        action === EntraGroupActions.REMOVE &&
+        errorData?.error?.message?.includes(
+          "one of its queried reference-property objects are not present.",
+        )
+      ) {
+        return true;
+      }
       throw new EntraGroupError({
         message: errorData?.error?.message ?? response.statusText,
         group,

src/api/functions/membership.ts

@@ -355,3 +355,46 @@ export async function setPaidMembership({
 
   return { updated: true };
 }
+
+export async function checkPaidMembership({
+  netId,
+  redisClient,
+  dynamoClient,
+  logger,
+}: {
+  netId: string;
+  redisClient: Redis.Redis;
+  dynamoClient: DynamoDBClient;
+  logger: FastifyBaseLogger;
+}): Promise<boolean> {
+  // 1. Check Redis cache
+  const isMemberInCache = await checkPaidMembershipFromRedis(
+    netId,
+    redisClient,
+    logger,
+  );
+
+  if (isMemberInCache === true) {
+    return true;
+  }
+
+  // 2. If cache missed or was negative, query DynamoDB
+  const isMemberInDB = await checkPaidMembershipFromTable(netId, dynamoClient);
+
+  // 3. If membership is confirmed, update the cache
+  if (isMemberInDB) {
+    const cacheKey = `membership:${netId}:acmpaid`;
+    try {
+      await redisClient.set(
+        cacheKey,
+        JSON.stringify({ isMember: true }),
+        "EX",
+        MEMBER_CACHE_SECONDS,
+      );
+    } catch (error) {
+      logger.error({ err: error, netId }, "Failed to update membership cache");
+    }
+  }
+
+  return isMemberInDB;
+}