Skip to content

feat(backend): add security check #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2025
Merged

feat(backend): add security check #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 57 additions & 0 deletions backend/src/common/security/file_check.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
import { BadRequestException } from '@nestjs/common';
import { FileUpload } from 'graphql-upload-minimal';
import path from 'path';

/** Maximum allowed file size (5MB) */
const MAX_FILE_SIZE = 5 * 1024 * 1024; // 5MB

/** Allowed image MIME types */
const ALLOWED_MIME_TYPES = ['image/jpeg', 'image/png', 'image/webp'];

/** Allowed file extensions */
const ALLOWED_EXTENSIONS = ['.jpg', '.jpeg', '.png', '.webp'];

/**
* Validates a file upload (size, type) and returns a Buffer.
* @param file - FileUpload object from GraphQL
* @returns Promise<Buffer> - The file data in buffer format
* @throws BadRequestException - If validation fails
*/
export async function validateAndBufferFile(
file: FileUpload,
): Promise<{ buffer: Buffer; mimetype: string }> {
const { filename, createReadStream, mimetype } = await file;

// Extract the file extension
const extension = path.extname(filename).toLowerCase();

// Validate MIME type
if (!ALLOWED_MIME_TYPES.includes(mimetype)) {
throw new BadRequestException(
`Invalid file type: ${mimetype}. Only JPEG, PNG, and WebP are allowed.`,
);
}

// Validate file extension
if (!ALLOWED_EXTENSIONS.includes(extension)) {
throw new BadRequestException(
`Invalid file extension: ${extension}. Only .jpg, .jpeg, .png, and .webp are allowed.`,
);
}

const chunks: Buffer[] = [];
let fileSize = 0;

// Read file stream and check size
for await (const chunk of createReadStream()) {
fileSize += chunk.length;
if (fileSize > MAX_FILE_SIZE) {
throw new BadRequestException(
'File size exceeds the maximum allowed limit (5MB).',
);
}
chunks.push(chunk);
}
Comment on lines +42 to +54
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ Refactor suggestion

Add error handling for stream operations.

The file stream reading code should have appropriate error handling to prevent unhandled exceptions.

Add a try/catch block around the stream processing:

 const chunks: Buffer[] = [];
 let fileSize = 0;

 // Read file stream and check size
+try {
   for await (const chunk of createReadStream()) {
     fileSize += chunk.length;
     if (fileSize > MAX_FILE_SIZE) {
       throw new BadRequestException(
         'File size exceeds the maximum allowed limit (5MB).',
       );
     }
     chunks.push(chunk);
   }
+} catch (error) {
+  if (error instanceof BadRequestException) {
+    throw error;
+  }
+  throw new BadRequestException(
+    'File upload failed: ' + (error.message || 'Unknown error')
+  );
+}
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const chunks: Buffer[] = [];
let fileSize = 0;
// Read file stream and check size
for await (const chunk of createReadStream()) {
fileSize += chunk.length;
if (fileSize > MAX_FILE_SIZE) {
throw new BadRequestException(
'File size exceeds the maximum allowed limit (5MB).',
);
}
chunks.push(chunk);
}
const chunks: Buffer[] = [];
let fileSize = 0;
// Read file stream and check size
try {
for await (const chunk of createReadStream()) {
fileSize += chunk.length;
if (fileSize > MAX_FILE_SIZE) {
throw new BadRequestException(
'File size exceeds the maximum allowed limit (5MB).',
);
}
chunks.push(chunk);
}
} catch (error) {
if (error instanceof BadRequestException) {
throw error;
}
throw new BadRequestException(
'File upload failed: ' + (error.message || 'Unknown error')
);
}


return { buffer: Buffer.concat(chunks), mimetype };
}
12 changes: 4 additions & 8 deletions backend/src/project/project.resolver.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import { ProjectGuard } from '../guard/project.guard';
import { GetUserIdFromToken } from '../decorator/get-auth-token.decorator';
import { Chat } from 'src/chat/chat.model';
import { User } from 'src/user/user.model';
import { validateAndBufferFile } from 'src/common/security/file_check';

@Resolver(() => Project)
export class ProjectsResolver {
Expand Down Expand Up @@ -98,14 +99,8 @@ export class ProjectsResolver {
this.logger.log(`User ${userId} uploading photo for project ${projectId}`);

// Extract the file data
const { createReadStream, mimetype } = await file;

// Buffer the file content
const chunks = [];
for await (const chunk of createReadStream()) {
chunks.push(chunk);
}
const buffer = Buffer.concat(chunks);
// Validate file and convert it to buffer
const { buffer, mimetype } = await validateAndBufferFile(file);

// Call the service with the extracted buffer and mimetype
return this.projectService.updateProjectPhotoUrl(
Expand All @@ -115,6 +110,7 @@ export class ProjectsResolver {
mimetype,
);
}

@Mutation(() => Project)
async updateProjectPublicStatus(
@GetUserIdFromToken() userId: string,
Expand Down
Loading