Encryption domains

Service Management supports the ability to encrypt specific record type fields via the creation of encryption domains. This enables you to restrict access to sensitive information to selected users.

You can assign groups to an encryption domain; the members of each assigned group will have access to the fields encrypted in that domain. For each user who accesses the encrypted fields, a passcode and a verification code are required.

You can create multiple encryption domains. Each one operates independently. For example, you may want to encrypt sensitive data for changes using Encryption domain 1 and employee data using Encryption domain 2. Each encryption domain requires a separate verification code. (One passcode is valid for all encryption domains.)

After you encrypt a field of a record type, you can add it to a form. The data in the field will be visible only to members of the encryption domain who have been verified. It is also possible to encrypt attachments to records.

Encrypted fields cannot be added to business rules and should not be selected in reports. Global search does not support encrypted fields and you cannot filter or sort record type data by encrypted fields.

Encryption domains are not supported in the Dev2Prod functionality. Any encryption domains defined in your development environment must be manually redefined in your production environment.

For information on the available APIs related to encryption domains, see Encryption domain API.

How to create an encryption domain

1. From the main menu, select Administration > Master Data > People > Encryption domains.
2. Click New.

3. If you have previously defined a passcode, enter it and click Get access.

   If you have not yet defined a passcode, enter a passcode 10 to 20 characters long containing at least one upper case character, at least one lower case character, and at least one number. Retype the passcode and click Create passcode.

4. In the Create encryption domain dialog box, enter a name and display label for the encryption domain, and click Create.

   Important When you define a new encryption domain, Service Management generates four encryption keys for backup purposes. Copy these keys and save them in a secure location. In the event of an emergency where the encryption domain becomes inaccessible, contact Support and provide the backup keys to gain access to the encryption domain. Micro Focus has no access to the generated keys.

5. You are set as the Default owner of the encryption domain. After creating the domain, you can select a different default owner from the drop-down list. The default owner must be verified for the encryption domain.

6. Select a Backup owner for the encryption domain from the drop-down list.

   Only the default owner and backup owner have permission to create verification codes for other users for this encryption domain.

7. In the Members list section, click Add and select a group from the drop-down list. You can add multiple groups.

   The members of the selected groups will have access to the fields encrypted via this domain.

   Note Encryption is supported for groups of up to 250 members only.

8. To access fields encrypted via this domain, the members need a verification code. To create verification codes for the encryption domain members, do one of the following:

   • Click Create verification code for all domain members on the toolbar. This generates a single verification code for all members of the encryption domain.
   • Click Create verification code next to the name of a group member. This generates a verification code for this user only.

   In either case, pass the verification code to the relevant user(s) securely.

   Caution Do not send a verification code by email.

9. Click Save to save the encryption domain.

How to update an encryption domain

1. From the main menu, select Administration > Master Data > People > Encryption domains.

2. Select the encryption domain you want to update, and make the required changes.

3. Click Save to save the encryption domain.

How to disable/enable an encryption domain

1. From the main menu, select Administration > Master Data > People > Encryption domains.

2. Select the encryption domain you want to disable and click Disable on the toolbar.

3. Click Save. The encryption domain is now disabled and cannot be used to encrypt new fields. The fields already encrypted using this encryption domain are still encrypted and can be decrypted by members of the encryption domain.
4. To re-enable the encryption domain, click Enable on the toolbar and click Save.

How to encrypt a field

1. From the main menu, select Administration > Configuration > Studio > Fields. Select the required record type.

2. Create a new custom field of type MEDIUM_TEXT, LARGE_TEXT, or RICH_TEXT.

3. Select the Encrypted check box. The Encryption domain property appears.
4. Select the encryption domain from the drop-down list.

5. (Optional) Click Set advanced options to open the encryption definition dialog box for the field. The default encryption domain you selected is displayed. Proceed as follows:

   1. Click Add condition to add a condition row.

   2. In the Condition box, enter an Expression Language phrase defining the required condition. For more information about the Expression Language, see Expression Language.

   3. In the Encryption domain box, select the alternate encryption domain to be used when the condition is satisfied. If you select Not encrypted, the field will remain unencrypted when the condition is satisfied.
   4. Optionally, click Add condition again to add another condition row. There is no limit to the number of conditions you can define for a field encryption.

   5. Click OK. All the encryption domains used in the definition appear in the Encryption domains field.

6. Click Save to save the field.

   Note The maximum length of encrypted fields is lower than the limit for unencrypted fields of the same type.

7. You can add the encrypted field to a form. When a user accesses a record of that type, the data in the field is hidden and the icon appears in its place. For information on adding a field to a form, see How to edit a form.

How to encrypt attachments

1. From the main menu, select Administration > Configuration > Studio > Fields. Select the required record type.

2. Select the out-of-the-box Attachments field.

3. Select the Encrypted check box. The Encryption domain property appears.
4. Select the encryption domain from the drop-down list.

5. Optionally, set the advanced options for the encryption, as you would for other encrypted fields.

6. Click Save to save the field.

7. When a user accesses a record of that type, a new button, Add encrypted attachments, appears next to the Add attachments button in the Attachments section of the records. The user can add both encrypted and unencrypted attachments.

How to view and edit encrypted data

1. If you expect to work with encrypted data, it is recommended to enter your credentials after you log in.

   1. Click your login name to open the Profile page.
   2. Click the Security Settings link to open a dialog box and enter your passcode.

   3. All of your encryption domains are displayed. You can enter a verification code for each one.

   Once you are verified for an encryption domain, all fields associated with that domain will appear decrypted. A icon appears next to each decrypted field.

   The system retains your passcode for a period of one hour while there is user activity. If you continue working beyond that period, or if there is no user activity for 10 minutes, you are prompted to re-enter your passcode. You only need to enter your verification code once per domain.

   Note If you enter an incorrect passcode 3 times, the passcode is locked for 15 minutes. After the next incorrect attempt, it is locked for 30 minutes, then for one hour, and so on.

2. If you did not enter your credentials at login, when you attempt to access record data, the data of an encrypted field is hidden and the icon appears in its place on the record page. When you click the icon, a dialog box pops up and prompts you to enter your credentials. Enter your passcode and verification code.

   If you are not a member of this encryption domain, the field data is hidden and the icon appears in its place. This indicates that you cannot access the field data.

3. If you forgot your passcode, click the Forgot your passcode? link to open a dialog box where you can create a new passcode.
4. You will be prompted to create a new passcode before the old one expires. If your passcode expires, you must create a new one and re-verify all of your encryption domains.
5. If you do not have a verification code for this encryption domain, click the Ask for verification code link. A message appears stating that a verification code request was sent to the encryption domain owner. The domain owner or backup owner will pass you the code securely.
6. If you want to change your passcode, click the Security Settings link on the Profile page and click the Change passcode link.

7. If an administrator made changes to an encryption domain before you saved changes to a record, you will be prompted to re-enter your credentials if you are still a member of the encryption domain. If you were removed from the domain, you will be unable to save your changes.

Related topics

• Users and contacts

• Roles

• Groups