Encrypting Custom Fields

Encryption for Jira allows you to create three types of custom fields specifically for encryption: single line and multi-line encrypted text field, and encrypted password field. Once you have created these fields you can set the permissions using the visibility restrictions in Encryption for Jira.

Create New Custom Fields for Encryption

Creating a new custom field for encryption purposes is performed in the same way as any other custom fields in Jira. These custom fields are text and password type fields, and you can find them in the Jira Administration menu under Issues.

  1. Select Issues from the Jira Administration menu.

  2. Select Custom Fields under Fields in the left sidebar.

  3. Click Add Custom Field, then select one of the encrypted field types, for example, Encrypted Text Field (single line).

    The Add Custom Field screen, with the Encrypted Text Field (single line) option highlighted.

  4. Enter a name and description for the custom field.

  5. Select Next.
  6. Choose whether to apply the field to all issues in your instance or just ones in specified projects. It's recommended to choose selected projects to reduce the impact on indexing time. 
  7. Select Create.

  8. Choose the Jira screen(s) where you want to use this newly created Encrypted Text Field using the corresponding screen Select checkboxes, then click Update.

    The Associate Field screen for the newly created field. It shows the screens the field can now be used with.

    Once created, the value of the text field is encrypted within the Jira database.

Filtering Encrypted Custom Fields

By default, encrypted custom fields have the Encrypted Custom Field Searcher template.

Users can search for texts in the same way as they do with Jira’s native text custom fields.

The Edit Custom Field Details screen for an Encrypted Custom Field Searcher template.

Basic Filter

A rendered example of a basic Encrypted Text Field Searcher.

Advanced Filter

A rendered example of an Advanced Encrypted Text Field Searcher.

To be able to index the fields, Lucene stores the decrypted values. Therefore, a user with access to the file system could access the Lucene indexes and see the values of the fields. If this is a problem, you can unlink the field from the searcher by selecting None from the Search Template dropdown menu in the Edit Custom Field Details screen. This way, Lucene will not store any decrypted value, but neither will any user be able to search by this custom field in a filter.

On this page