fix: switch to using crypto random for boundary values - #28
fengmk2 merged 1 commit into
Conversation
Sorry, something went wrong.
WalkthroughThe updates include changes to the GitHub Actions CI workflow to support the merge_group event and test against Node.js 24, a simplification of the contributors section in the README, an internal improvement to multipart boundary string generation using cryptographic randomness, removal of contributor management tooling from package.json, and corresponding test updates to accept the new boundary format. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant FormStream
participant Crypto
User->>FormStream: Initiate multipart form
FormStream->>Crypto: Generate 12 random bytes
Crypto-->>FormStream: Return random bytes
FormStream->>FormStream: Create boundary using random hex string
FormStream-->>User: Use boundary in form-data content-type
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. 📜 Recent review details Configuration used: CodeRabbit UI Reviewing files that changed from the base of the PR and between 38b2623 and c503ab9. 📒 Files selected for processing (5)
package.json (1)✨ Finishing Touches
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. ❤️ Share 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (.coderabbit.yaml)
Documentation and Community
|
Sorry, something went wrong.
There was a problem hiding this comment.
Summary of Changes
Hello @fengmk2, 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 primarily focuses on enhancing the security and robustness of multipart form data boundary generation by switching from a basic Math.random() approach to using Node.js's crypto module. This change ensures that the boundaries are cryptographically strong and less predictable, aligning with modern security practices for data transmission. Additionally, it includes updates to the project's contributor display in the README and related build scripts.
Highlights
- Enhanced Boundary Generation: The method for generating multipart form data boundaries in lib/formstream.js has been updated to utilize crypto.randomBytes(12).toString('hex'). This replaces the previous Math.random() based approach, providing a more secure and unique boundary string, aligning with best practices from the form-data library.
- Test Suite Adjustments: The regular expressions in test/formstream.test.js used to validate content-type headers have been updated from matching only digits (\d{24}) to matching word characters (\w{24}) to correctly reflect the hexadecimal output of the new boundary generation method.
- Contributor Display Modernization: The README.md has been updated to use contrib.rocks for dynamically displaying contributors, replacing the static git-contributor generated list. Correspondingly, the git-contributor script and dependency have been removed from package.json.
The 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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| Feature | Command | Description |
|---|---|---|
| Code Review | /gemini review | Performs a code review for the current pull request in its current state. |
| Pull Request Summary | /gemini summary | Provides a summary of the current pull request in its current state. |
| Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
| Help | /gemini help | Displays a list of available commands. |
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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.
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 or fill out our survey to provide feedback.
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
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
Sorry, something went wrong.
There was a problem hiding this comment.
Pull Request Overview
This PR switches from using Math.random() to crypto.randomBytes() for generating multipart form-data boundary values, improving cryptographic security. It also includes some maintenance updates to the project.
- Replaces pseudo-random boundary generation with cryptographically secure random generation
- Updates test regex patterns to match the new hexadecimal boundary format
- Removes deprecated git-contributor dependency and updates contributor display
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.
Show a summary per file| File | Description |
|---|---|
| lib/formstream.js | Replaces Math.random() boundary generation with crypto.randomBytes() for security |
| test/formstream.test.js | Updates regex patterns from \d{24} to \w{24} to match hex boundary format |
| package.json | Removes git-contributor dependency and related npm script |
| README.md | Replaces git-contributor generated content with contrib.rocks badge |
| .github/workflows/ci.yml | Adds Node.js 24 to test matrix and merge_group trigger |
test/formstream.test.js:249
- The regex pattern \w{24} matches alphanumeric characters and underscores, but crypto.randomBytes(12).toString('hex') only generates hexadecimal characters (0-9, a-f). The pattern should be [0-9a-f]{24} to accurately match the actual boundary format.
.with.match(/multipart\/form-data; boundary=--------------------------\w{24}/);
test/formstream.test.js:291
- The regex pattern \w{24} matches alphanumeric characters and underscores, but crypto.randomBytes(12).toString('hex') only generates hexadecimal characters (0-9, a-f). The pattern should be [0-9a-f]{24} to accurately match the actual boundary format.
.with.match(/multipart\/form-data; boundary=--------------------------\w{24}/);
test/formstream.test.js:326
- The regex pattern \w{24} matches alphanumeric characters and underscores, but crypto.randomBytes(12).toString('hex') only generates hexadecimal characters (0-9, a-f). The pattern should be [0-9a-f]{24} to accurately match the actual boundary format.
.with.match(/^multipart\/form-data; boundary=--------------------------\w{24}$/);
test/formstream.test.js:354
- The regex pattern \w{24} matches alphanumeric characters and underscores, but crypto.randomBytes(12).toString('hex') only generates hexadecimal characters (0-9, a-f). The pattern should be [0-9a-f]{24} to accurately match the actual boundary format.
.with.match(/^multipart\/form-data; boundary=--------------------------\w{24}$/);
test/formstream.test.js:451
- The regex pattern \w{24} matches alphanumeric characters and underscores, but crypto.randomBytes(12).toString('hex') only generates hexadecimal characters (0-9, a-f). The pattern should be [0-9a-f]{24} to accurately match the actual boundary format.
headers['Content-Type'].should.match(/^multipart\/form-data; boundary=--------------------------\w{24}$/);
Sorry, something went wrong.
Codecov Report✅ All modified and coverable lines are covered by tests. @@ Coverage Diff @@
## master #28 +/- ##
==========================================
- Coverage 98.24% 98.21% -0.03%
==========================================
Files 1 1
Lines 399 393 -6
Branches 59 58 -1
==========================================
- Hits 392 386 -6
Misses 7 7 ☔ View full report in Codecov by Sentry.
|
Sorry, something went wrong.
There was a problem hiding this comment.
Code Review
This pull request enhances security by replacing Math.random() with crypto.randomBytes for generating multipart form boundaries. The test regular expressions could be more specific to improve their long-term robustness.
Sorry, something went wrong.
[skip ci] ## [1.5.2](v1.5.1...v1.5.2) (2025-07-29) ### Bug Fixes * switch to using crypto random for boundary values ([#28](#28)) ([ace05e0](ace05e0))
form-data/form-data@3d17230
Summary by CodeRabbit