A package to add protection to Vapor against CSRF attacks.
Switch branches/tags
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Sources Simplify defaultTokenRetrieval Jun 4, 2018
Tests Fix tests and valid syntax Jun 4, 2018
.gitignore Removed Package.pins from git Apr 7, 2018
Package.swift Update packages and add a multipart test May 5, 2018
README.md Update README for Vapor 3.0 Jun 5, 2018

README.md

CSRF

CSRF stands for cross-site request forgery; it is also called XSRF, a one-click attack, and session riding. It involves an attacker exploiting a user's established trust with some site in a browser. Attackers exploit the trust a site has for a user by sending unauthorized commands to the site on behalf of the user.

Typically, attackers trick users to send requests to the site in question. Perhaps the attacker is able to get the user to open a link on a page controlled by the attacker. This link could execute some action on behalf of the authenticated user unbeknownst to them.

Consider, for example, a case where a user is authenticated to their bank's website. The user could be fooled to click on a link that sends a transfer request to their bank's site. Since the user is authenticated, the bank site would presume that this transaction is safe. However, an attacker owning this malicious link would be able to direct the transfer to an account of their choosing.

This is a package is designed to protect against such attacks in Vapor.

Further Reading

Protecting Against CSRF Attacks

There are a few ways to protect against this sort of vulnerability. Since the attack exploits the site's trust of some user, most prevention techniques add authentication information to each request. Doing so helps the site to disambiguate between authorized and unauthorized requests.

The direction taken by this package is to use sessions. The session will hold a secret. The secret will be used to create a hashed token. The token will be sent back to clients in the response's header. Tokens will last as long as the session is viable.

For example, the server will generate a token and set the "csrf-token" key in the header like so:

response.http.headers.add(name: "csrf-token", value: "some-very-secret-token")

Clients are then responsible for sending this key and token with each request for the duration of their session.

The CSRF middleware will then guarantee three things:

  1. That there is a session
  2. That the request contains a key (there are a number of keys used for CSRF prevention)
  3. That the key's token matches the secret held by the session

If any of these conditions fail, then the CSRF middleware will throw an error describing the problem.

Using CSRF in Vapor

The following provides instructions on how to use this package on your site.

Usage

  1. Add the CSRF to your Package.swift
dependencies: [
    ...,
   .package(url: "https://github.com/vapor-community/CSRF.git", from: "2.0.0")
]
  1. Add SessionsMiddleware and CSRF middlware in configure.swift
services.register(CSRF())

var middlewares = MiddlewareConfig()
// ...
middlewares.use(SessionsMiddleware.self)
middlewares.use(CSRF.self)

services.register(middlewareConfig)
  1. Create an instance of CSRF

Create this instance somewhere useful - either as a property on some route controller, or somewhere where you can access it (via dependency injection, or whatever your preference is).

let csrf = CSRF()

This will create an instance with two important defaults:

  • ignoredMethods will be set to [.GET, .HEAD, .OPTIONS]. These methods will not be submitted to the checks mentioned above. This is fine because these methods are not used to change server state.
  • defaultTokenRetrieval will be set to ((Request) throws -> Future<String>). That is, it will be a function, provided by default, that will take in a Request and return a Future<String> holding the token if it is found; otherwise, the method will throw an error.

You can customize either of these properties on CSRF by passing your preferred values to this initializer.

  1. Create the token and set it in the response header
router.get("test-no-session") { request in
    let response = ...
    response.http.headers.add(name: "csrf-token", value: try self.csrf.createToken(from: request))
    return response
}