⚠️ DEPRECATED: This project has been moved to kemal-session and is no longer maintained as a separate package. Please use kemal-session for CSRF protection.
Adds CSRF protection to your Kemal application.
Requires a session middleware to be initialized first.
Note: This package is deprecated. Please use kemal-session instead, which now includes CSRF protection functionality.
For historical reference, this package was previously installed by adding to your application's shard.yml:
dependencies:
kemal-csrf:
github: kemalcr/kemal-csrfFor new projects, use kemal-session:
dependencies:
kemal-session:
github: kemalcr/kemal-sessionImportant: This package is deprecated. For current CSRF protection, please refer to the kemal-session documentation.
Basic Use
require "kemal-csrf"
add_handler CSRF.newTo access the CSRF token of the active session you can do the following in your .ecr form(s)
<input type="hidden" name="authenticity_token" value='<%= env.session.string("csrf") %>'>You can also change the name of the form field, header name, the methods which don't need csrf,error message and routes which you don't want csrf to apply. All of these are optional
require "kemal-csrf"
add_handler CSRF.new(
header: "X_CSRF_TOKEN",
allowed_methods: ["GET", "HEAD", "OPTIONS", "TRACE"],
allowed_routes: ["/api/somecallback", "/api/v1/**"],
parameter_name: "_csrf",
error: "CSRF Error",
http_only: false,
samesite: nil,
)If you need to have some logic within your error response, you can also pass it a proc (a pointer to a function)
require "kemal-csrf"
add_handler CSRF.new(
header: "X_CSRF_TOKEN",
allowed_methods: ["GET", "HEAD", "OPTIONS", "TRACE"],
allowed_routes: ["/api/somecallback", "/api/v1/**"],
parameter_name: "_csrf",
error: ->myerrorhandler(HTTP::Server::Context)
)
def myerrorhandler(env)
if env.request.headers["Content-Type"]? == "application/json"
{"error" => "csrf error"}.to_json
else
"<html><head><title>Error</title><body><h1>You cannot post to this route without a valid csrf token</h1></body></html>"
end
end- Fork it ( https://github.com/kemalcr/kemal-csrf/fork )
- Create your feature branch (git checkout -b my-new-feature)
- Commit your changes (git commit -am 'Add some feature')
- Push to the branch (git push origin my-new-feature)
- Create a new Pull Request
- sdogruyol Serdar Dogruyol - creator, maintainer