Encryption for Jira

Encrypting Custom Fields

Encrypting custom fields is another feature of Encryption for Jira.

Custom Text Field Encryption

You can encrypt a custom text field provided by Encryption for Jira. There are two types of text fields: single line text and multiline text. These custom fields are text type fields, and you can find them in the Jira Administration menu under Issues.

Creating a new custom field for encryption purposes is performed in the exact same way as any other custom field in Jira:

  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 a field type, for example, Encrypted Text Field (multi-line).

    encrypt customfields
  4. Enter a name and description for the custom field, then click Create.

  5. Choose the appropriate screen(s) where you want to see this newly created Encrypted Text Field using the Screen checkboxes, then click Update.

    encrypt textfield

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.

edit custom fields

Basic Filter

default filter

Advanced Filter

advanced filter
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.
caution

If this is a problem, you can unlink the field from the searcher by editing the field and selecting None from the Search Template dropdown menu.

caution edit customfields

In 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.