Form Token Handling
JIRA 4.1 and later.
On this page:
Overview and Purpose
JIRA 4.1 and later employs a token authentication mechanism which is utilised whenever JIRA actions are performed either through link request or form submission. This provides JIRA with a means to validate the origin and intent of the request, thus adding an additional level of security against XSRF (Cross-site request forgery). While the core JIRA product and its bundled plugins use this token handling mechanism by default, non-bundled plugins or those developed by third parties may not.
This document provides instructions to JIRA plugin developers on how to incorporate this token handling mechanism into JIRA plugins.
JIRA 4.1 requires that WebWork actions possess tokens, which are then verified when the form is submitted back to the JIRA server. This is an "opt in" mechanism, whereby actions must declare that they require a token to be present in the request.
Instructions for Plugin Developers
The following subsections provide details on how to protect code against XSRF by implement form token handling into your JIRA plugin.
Please be aware that once form token handling has been implemented into a JIRA plugin:
- Any functions that use screen scraping, such as the 'create sub-task' function in FishEye, will be broken.
- REST API end points will not be affected unless they use form encoding.
JIRA WebWork Actions
To enable xsrf token checking for a particular Action class
- Locate the method that is called by the action execution (by default this method is called
- Add the
@com.atlassian.jira.security.xsrf.RequiresXsrfCheckannotation to this method
Providing the token in HTML Forms
The token is included by default when using a
The token can be included into your own JSPs that don't use jiraforms, by adding the following code:
The following code can be added to Velocity Templates:
Providing the token in HTML links
You can do the following in JSPs:
or Velocity Templates:
Accessing the token programatically
To get hold of the current user's token, you will need to make the following call:
Scripts that access JIRA remotely may have trouble acquiring or returning a security token, or maintaining an HTTP session with the server. There is a way for scripts to opt out of token checking by providing the following HTTP header in the request:
For more information, refer to the Open Web Application Security Project page.