title | keywords | description | |||||
---|---|---|---|---|---|---|---|
CSRF + Session |
|
Cross-Site Request Forgery (CSRF) protection with session management. |
Example GoFiber web app using Cross Site Request Forgery (CSRF) middleware with session.
This example impliments multiple best-practices for CSRF protection:
- CSRF Tokens are linked to the user's session.
- Pre-sessions are used, so that CSRF tokens are always available, even for anonymous users (eg for login forms).
- Cookies are set with a defense-in-depth approach:
- Secure: true
- HttpOnly: true
- SameSite: Lax
- Expiration: 30 minutes (of inactivity)
- Cookie names are prefixed with "__Host-" (see MDN-Set-Cookie for more information))
Like any golang project, you will need to download and install the required modules for the project to run. Change into the "csrf-with-session" directory:
cd csrf-with-session
And then:
go mod vendor && go mod download && go mod tidy
This command installs the golang dependencies needed to run the project in a new directory named vendor
.
Once the modules have finished installing, you can run the project like this:
go run main.go
You should see the following if everything is OK:
Server started and listening at 127.0.0.1:8443
Start the server by running:
go run main.go
Open your browser to and navigate to 127.0.0.1:8443.
In Chrome:
- Click on "Advanced"
- Click on "Proceed to 127.0.0.1:8443 (unsafe)"
In Firefox:
- Click on "Advanced"
- Click on "Accept the Risk and Continue"
In Safari:
- Click on "Show Details"
- Click on "visit this website"
Login using one of the test accounts:
- Username:
user1
- Password:
password1
OR - Username:
user2
- Password:
password2
Once logged in, you will be able to see the /protected page.
Once logged in, you will be able to see the /protected page. The /protected page contains a form that submits to the /protected page. If you try to submit the form without a valid CSRF token, you will get a 403 Forbidden error.
All methods except GET, HEAD, OPTIONS, and TRACE are checked for the CSRF token. If the token is not present or does not match the token in the session, the request is aborted with a 403 Forbidden error.
The CSRF token is generated when the user visits any page on the site. The token is stored in the session and is valid for until it expires, or the authorization scope changes (e.g. the user logs in, or logs out).
It is important that CSRF tokens do not persist beyond the scope of the user's session, that a new session is created when the user logs in, and that the session is destroyed when the user logs out.
The CSRF middleware has a SingleUseToken
configuration option that can be used to generate a new token for each request. This is useful for some applications, but is not used in this example. Single use tokens have usability implications in scenarios where the user has multiple tabs open, or when the user uses the back button in their browser.
Sessions are stored in memory for this example, but you can use any session store you like. See the Fiber session documentation for more information.
GoFiber's CSRF middleware will automatically create a session if one does not exist. That means that we always have pre-sessions when using the CSRF middleware. In this example we set a session variable loggedIn
to true
when the user logs in, in order to distinguish between logged in and logged out users.
Here are some useful links where you can learn more about this topic: