Skip to content
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

Add more advice on file upload security #3657

Conversation

DoctorJohn
Copy link
Member

@DoctorJohn DoctorJohn commented Oct 6, 2024

Description

This is just a small addition to the file upload docs, mentioning that file upload support is disabled by default and that enabling it requires some security considerations.

This section will be expanded once I finished implementing Strawberry's built-in CSRF protection.

Types of Changes

  • Core
  • Bugfix
  • New feature
  • Enhancement/optimization
  • Documentation

Issues Fixed or Closed by This PR

Summary by Sourcery

Update the file upload documentation to include security advice, emphasizing the need for CSRF protection when enabling multipart file uploads.

Documentation:

  • Add a section on security considerations for file uploads, noting that multipart file upload support is disabled by default and requires enabling CSRF protection.

Copy link
Contributor

sourcery-ai bot commented Oct 6, 2024

Reviewer's Guide by Sourcery

This pull request adds important security information to the file upload documentation for Strawberry, a GraphQL library. It emphasizes that file upload support is disabled by default and provides guidance on enabling it securely.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Added a new 'Security' section to the file upload documentation
  • Mentioned that multipart file upload support is disabled by default
  • Advised addressing security implications before enabling file uploads
  • Recommended enabling CSRF protection in the server framework
  • Provided instructions on how to enable file upload support
docs/guides/file-upload.md
Updated links and references in the 'Upload Scalar' section
  • Updated Django documentation links to use 'dev' version instead of '3.2'
  • Updated Werkzeug documentation link to use 'latest' version instead of '2.0.x'
docs/guides/file-upload.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @DoctorJohn - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Copy link
Member

@patrick91 patrick91 left a comment

Choose a reason for hiding this comment

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

Thanks!

@patrick91 patrick91 merged commit ffdd85b into strawberry-graphql:main Oct 6, 2024
4 checks passed
@DoctorJohn DoctorJohn deleted the add-more-advice-on-file-upload-security branch November 20, 2024 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

multipart upload struggle
2 participants