feat(ext): added `ext/csrf` #46

cnlangzi · 2025-02-13T06:15:01Z

Changed

Fixed

Added

added ext/csrf extension

Tests

Tasks to complete before merging PR:

Ensure unit tests are passing. If not run make unit-test to check for any regressions 📋
Ensure lint tests are passing. if not run make lint to check for any issues
Ensure codecov/patch is passing for changes.

Summary by Sourcery

New Features:

Added a CSRF protection middleware to protect against unauthorized requests.

sourcery-ai · 2025-02-13T06:15:06Z

Reviewer's Guide by Sourcery

This PR introduces a new CSRF extension that implements middleware for generating, validating, and managing CSRF tokens, including JavaScript token support. The implementation adds new middleware components, configuration options, and tests, as well as updates to the documentation.

Sequence diagram for CSRF Middleware Request Handling

sequenceDiagram
    actor User
    participant Server
    participant "CSRF Middleware" as CSRF
    participant "Application Handler" as App

    User->>Server: HTTP Request
    Server->>CSRF: Process request
    alt Request Method is GET/HEAD/OPTIONS
        CSRF->>CSRF: Check for CSRF token cookie
        alt Token Absent
            CSRF->>Server: Set token cookie
        end
        CSRF->>App: Forward request
    else Request Method is POST/PUT/DELETE
        CSRF->>CSRF: verifyToken(token, request)
        alt Token Valid
            CSRF->>App: Forward request
        else Token Invalid
            CSRF->>Server: Respond with HTTP 418 (Teapot)
        end
    end
    App-->>Server: Application Response
    Server-->>User: HTTP Response

File-Level Changes

Change	Details	Files
Implemented CSRF middleware extension for token generation and validation	Added middleware logic to generate CSRF tokens and set cookies when missing Included token verification logic that supports both traditional and JavaScript tokens Implemented helper functions for token generation and cookie management	`ext/csrf/csrf.go` `ext/csrf/token.go`
Enabled JavaScript token integration for extra CSRF protection	Implemented a JavaScript file to automatically set a JS token cookie from the CSRF token Added option to enable JS token functionality via middleware configuration	`ext/csrf/csrf.js` `ext/csrf/option.go`
Added comprehensive tests for the CSRF extension	Created unit tests to verify token generation, cookie setting, and request handling in various scenarios Included tests for both standard CSRF token verification and JS token flows	`ext/csrf/csrf_test.go` `ext/csrf/token_test.go`
Updated documentation with usage examples for the CSRF extension	Added detailed instructions in the README on enabling CSRF middleware with Go examples Included code snippets for setting up CSRF protection and integrating JavaScript token functionality	`README.md`
Removed redundant visitor logging configuration from documentation	Eliminated the usage of the visitor logging option in the example code snippet to streamline configuration	`README.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. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

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

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

deepsource-io · 2025-02-13T06:15:53Z

Here's the code health analysis summary for commits d41aa17..a88bb6d. View details on DeepSource ↗.

Analysis Summary

Analyzer	Status	Summary	Link
Go	✅ Success		View Check ↗

💡 If you’re a repository administrator, you can configure the quality gates from the settings.

sourcery-ai

Hey @cnlangzi - I've reviewed your changes - here's some feedback:

Overall Comments:

Consider adding an example of how to use the CSRF middleware with a form in the README.
The csrf.js file should be served with a Cache-Control header to allow browsers to cache it.

Here's what I looked at during the review

🟡 General issues: 3 issues found
🟢 Security: all looks good
🟡 Testing: 1 issue found
🟢 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.}

ext/csrf/csrf.go

ext/csrf/token_test.go

README.md

codecov · 2025-02-13T06:16:33Z

Codecov Report

Attention: Patch coverage is 97.61905% with 3 lines in your changes missing coverage. Please review.

Project coverage is 93.02%. Comparing base (d41aa17) to head (a88bb6d).
Report is 1 commits behind head on main.

Files with missing lines	Patch %	Lines
ext/csrf/token.go	94.73%	2 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #46      +/-   ##
==========================================
+ Coverage   92.69%   93.02%   +0.32%     
==========================================
  Files          46       49       +3     
  Lines        1766     1892     +126     
==========================================
+ Hits         1637     1760     +123     
- Misses         96       98       +2     
- Partials       33       34       +1

Flag	Coverage Δ
Unit-Tests	`93.02% <97.61%> (+0.32%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

cnlangzi added 8 commits February 12, 2025 16:47

feat(csrf): added ext/csrf

84c36d5

feat(csrf): exposed VerifyToken

435821d

fix(crsf): fixed missed secert key in Options

87cfb66

fix(crsf): added expires on token

8290759

fix(crsf): added js token

20c3e1d

fix(crsf): added etag on csrf.js

6ed52e2

fix(crsf): added unit tests

cd198a0

chore(docs): added "CSRF Token" on README.md

796b542

sourcery-ai bot reviewed Feb 13, 2025

View reviewed changes

ext/csrf/csrf.go Show resolved Hide resolved

ext/csrf/token_test.go Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

cnlangzi added 2 commits February 13, 2025 14:19

chore(docs): fixed syntax issues

824369b

fix(crsf): added unit tests for token

a88bb6d

cnlangzi merged commit 0e69a1d into main Feb 13, 2025
7 checks passed

cnlangzi deleted the feat/csrf branch February 13, 2025 06:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(ext): added `ext/csrf` #46

feat(ext): added `ext/csrf` #46

Uh oh!

cnlangzi commented Feb 13, 2025 •

edited by sourcery-ai bot

Loading

Uh oh!

sourcery-ai bot commented Feb 13, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

deepsource-io bot commented Feb 13, 2025 •

edited

Loading

Analysis Summary

Uh oh!

sourcery-ai bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 13, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

feat(ext): added ext/csrf #46

feat(ext): added ext/csrf #46

Uh oh!

Conversation

cnlangzi commented Feb 13, 2025 • edited by sourcery-ai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changed

Fixed

Added

Tests

Summary by Sourcery

Uh oh!

sourcery-ai bot commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide by Sourcery

Sequence diagram for CSRF Middleware Request Handling

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

deepsource-io bot commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Analysis Summary

Uh oh!

sourcery-ai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

codecov bot commented Feb 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

feat(ext): added `ext/csrf` #46

feat(ext): added `ext/csrf` #46

cnlangzi commented Feb 13, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Feb 13, 2025 •

edited

Loading

deepsource-io bot commented Feb 13, 2025 •

edited

Loading

codecov bot commented Feb 13, 2025 •

edited

Loading