-
-
Notifications
You must be signed in to change notification settings - Fork 23.6k
Fix Mass Assignments in Leads Endpoint #5668
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.
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
base: main
Are you sure you want to change the base?
Conversation
Summary of ChangesHello @christopherholland-workday, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a critical security fix to the Leads endpoint by preventing mass assignment. It refactors the lead creation logic to explicitly whitelist which fields from the incoming request body can be used to populate a new Lead entity. This change safeguards against malicious or accidental overwriting of system-controlled attributes, thereby enhancing the application's data integrity and security posture. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request correctly resolves a critical mass assignment vulnerability in the leads endpoint by introducing a whitelist of permissible fields. The approach is sound and effectively prevents attackers from overwriting system-generated fields. My review includes a minor suggestion for improving code style and maintainability. The provided rule regarding authorization checks for internal/external APIs does not apply to this specific comment.
| const allowedFields: (keyof ILead)[] = ['chatflowid', 'name', 'email', 'phone'] | ||
| for (const field of allowedFields) { | ||
| if (body[field] !== undefined) { | ||
| newLead[field] = body[field] as any | ||
| } | ||
| } |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This logic correctly filters the properties from the request body, fixing the vulnerability. For improved performance and code organization, consider defining allowedFields as a constant at the module level, outside the createLead function. This prevents the array from being recreated on every function call.
Additionally, while the for...of loop is perfectly fine, I'm suggesting a minor refactor to use forEach and a more common type assertion style, which can be slightly more declarative.
| const allowedFields: (keyof ILead)[] = ['chatflowid', 'name', 'email', 'phone'] | |
| for (const field of allowedFields) { | |
| if (body[field] !== undefined) { | |
| newLead[field] = body[field] as any | |
| } | |
| } | |
| const allowedFields: (keyof ILead)[] = ['chatflowid', 'name', 'email', 'phone']; | |
| allowedFields.forEach(field => { | |
| if (body[field] !== undefined) { | |
| (newLead as any)[field] = body[field]; | |
| } | |
| }); |
Overview
The endpoint uses
Object.assign()to copy all properties from the request body to the Lead entity without any input validation or field filtering. This allows attackers to bypass auto-generated fields and inject arbitrary values.This PR allows only the fields that are user controlled to be user controlled ('chatflowid', 'name', 'email', 'phone').
Testing
Ran the same
curlrequests that exposed the issue and ensured that the fields likeidandcreatedDatewere generated by the code and not overridden by the request.Example 1:
idExample 2:
createdDatePreviously, the
idandcreatedDatevalue would've been taken from the requests