Field Encryption Enterprise examples

  • Rversion finale: Australia
  • Mis à jour 12 mars 2026
  • 7 minutes de lecture
  • These examples walk you through the encryption of fields and attachments using customer-supplied keys.

    Field Encryption Enterprise walkthrough

    This walkthrough shows you how to encrypt a field in your instance using Field Encryption Enterprise with the Key Management Framework (KMF). It also shows you how to use your own key.

    Avant de commencer

    Remarque :
    This procedure only applies to Field Encryption Enterprise functionality. See Activate Field Encryption for more information on obtaining Field Encryption Enterprise.

    Role required: security_admin  and sn_kmf.cryptographic_manager  or sn_kmf.admin

    Remarque :
    security_admin is a privileged role, for details on using privileged roles, see Elevate to a privileged role

    Pourquoi et quand exécuter cette tâche

    This walkthrough starts with an instance where you have already created and uploaded your personal cryptographic key. You could use the ServiceNow key, but this example uses a customer-supplied key.

    After the key has been stored in a cryptographic module, you can start configuring fields in your instance, such as salary or social security numbers that have limited access from certain users. In the Encrypted Field Configuration, specify which authorized personnel can access sensitive data.

    This task demonstrates two scenarios. One example encrypts the Short Description field in an Incident for users who are not authorized to view the sensitive data.

    Attachments can also be encrypted and only visible to users who are granted access, or is visible to all users that are not restricted from viewing the data. See Attachment encryption walkthrough to encrypt an attachment.

    Procédure

    1. Create a cryptographic module for column_level_encryption.
    2. Select View module details for the module you created.
    3. Select Encrypted Fields to set up the Encrypted Field Configurations (EFC).
    4. Select Configure.
    5. On the form, fill in the fields.
      Tableau 1. Encrypted field configuration form
      Field Description
      Table Table that stores the sensitive information. For this example, select Incident [incident].
      Type Column is required to use your personal key.
      Column Column, or specific information, that represents the sensitive date to be encrypted. For this example, select short_description.
      Active Option to mark Active to use the field configuration.
      Encrypt by default Enabled by default when creating an EFC from the Modules page. This encrypts records without matching row conditions using the selected Field Encryption Module. To create a configuration without this option selected, create the EFC from the Configurations page.
      Algorithm Equality Preserving The option is automatically selected.
      Method The Single Module option is used to apply the policies for one module. Multiple Modules is used to apply the policies across multiple modules.
      Figure 1. Encryption field configuration example
      Shows a completed Encrypted Field Configuration.
    6. Click Save.

      Establish a Module Access Policy (MAP) to assign access to the cryptographic module. See Create a module access policy for additional information.

    7. Select Access Policies to set up the MAP.
    8. Select Configure.
    9. On the form, fill in the fields.
      Tableau 2. Module access policy form
      Field Description
      Policy name Name for the policy, such, as short description.
      Type Type of access designation for the crypto policy. Use Role to grant access to the encrypted field to only those users that have the assigned role.
      Target Role The role that has access to the encrypted field. For this example, select Admin.
      Active Option to activate the Module Access Policy.
      Result The Trackoption enables the access to the field for the selected role. (To restrict access to that field for the selected role, select Reject orStrict Reject.)
      Impersonation Option to enable module access via impersonation.
      Figure 2. Module access policy example
      Shows the completed module access policy form.
    10. Select Save.
    11. As a user with the sn_kmf.admin role, navigate to All > Incidents > Create New.
      Figure 3. Example of encrypted field visible
      Shows the visible Short description data.
      You can now view the Short description field based on the module access policy configuration.
      Remarque :
      The sn_kmf.admin role was granted user access to the encrypted field, Short description, by setting the module access policy to Track. Notice the lock icon (Lock icon.) under the field name indicating that the field is an encrypted field.

      You can now access the Incidents module as an end user to test the encrypted field configuration.

    12. Log in as a user who has access to the table but doesn't have access to the configured encryption module.
      Figure 4. Encrypted field level data
      Shows no value in the Short description after encryption.
      When you access the incident number, the data in the Short description will not be visible.

    Résultats

    You have successfully used your symmetric key to control access to a specific field using Field Encryption Enterprise.

    Attachment encryption walkthrough

    This walkthrough shows you how to encrypt an attachment in your instance using Field Encryption Enterprise with the Key Management Framework (KMF). It also shows you how to use your own key.

    Avant de commencer

    Remarque :
    This procedure only applies to Field Encryption Enterprise functionality. See Activate Field Encryption for more information on obtaining Field Encryption Enterprise.

    Role required: sn_kmf.cryptographic_manager

    Pourquoi et quand exécuter cette tâche

    This walkthrough starts with an instance where you have already created and uploaded your customer-supplied cryptographic key. You could use the key, but this example uses a customer-supplied key.

    Upload confidential attachments in your instance and limit access from certain users. Use Encrypted Field Configuration to specify which authorized personnel can access sensitive data.

    We show you how to encrypt attachments to only be visible to users who are granted access, or be visible to all users that are not restricted from viewing the data. In this example, we restrict a certain role from being able to access an attachment in the Incidents module.

    Remarque :
    Although you can use multiple modules with Field Encryption Enterprise, attachment encryption must use single modules.

    Procédure

    1. Make sure that Field Encryption Enterprise is enabled.
    2. Create a cryptographic module.
    3. Navigate to All > System Security > Field Encryption > Field Encryption Experience.
    4. Select View module details from the Field Encryption overview to open the module record you want to configure.
    5. Select Encrypted Fields and Configure.
    6. Complete the form:
      Tableau 3. Encrypted field configuration fields
      Field Description
      Table Select the table to access the sensitive information. For this example, select Incident [incident].
      Type Select Attachment to use your personal key for encrypting an attachment from the selected Table For this example, select Incident.
      Active Mark Active to be able to use the field configuration.
      Important :
      When active, your instance is actively encrypting new data in the selected fields or attachments. Users won’t have access to this data unless they have permission via an associated Module Access Policy. Don’t select if the field isn’t ready to begin encrypting and enforcing Module Access Policies.

      To verify historical data is encrypted after an Encrypted Field Configuration is active, you’ll need to run a Mass Encryption Job on the column. For details, see “Schedule Mass Encryption, Decryption, or Rekeying”.

      Encrypt by default

      When selected, records that don’t match row conditions will be encrypted using the Field Encryption module selected in the field below.

      When not selected, these records will not be encrypted.

      Field Encryption module The field encryption module used by this encrypted field configuration.
      Column If you have chosen Column in the Type field, select the fields to be encrypted.
      Remarque :
      If the field you want to encrypt is not available, it isn’t a supported type. The supported field types are:
      • Date
      • Date/Time
      • URL
      • HTML
      • Journal
      • Translated
      • Email
      • Phone
      Algorithm Equality Preserving When selecting Field Encryption Enterprise, this field is visible based on the table selected. Displays whether Equality Preserving is enabled in the field encryption module selected in the Crypto Module field.
      Method The Single Module option is used to apply the policies for one module. Multiple Modules is used to apply the policies across multiple modules.
      Figure 5. Encrypted Field Configuration table
      Encrypted Field Configuration table
    7. Select Save.

      Establish a Module Access Policy (MAP) to assign access to the cryptographic module. Refer to Create a module access policy for additional information.

    8. Navigate to All > System Security > Field Encryption > Field Encryption Experience > Configurations > Access Policies.
    9. Click Create new.
    10. Select the Field Encryption (FE) module.
    11. Complete the form:
      Tableau 4. Module access policy fields
      Field Description
      Policy name Enter a name for the policy, such, as "Attachment policy."
      Type Select Role to restrict access to the encrypted field from users with the assigned role.
      Result Select Strict Reject to control the access to the attachment from the selected role. (To grant access for the selected role, select Track.)
      Crypto module Select the crypto module that you created to encrypt your key.
      Active Select this check box to be able to use the Module Access Policy.
      Target Role Select the role that will not have access to the encrypted field. For this example, select itil.
      Specify purpose Optional. Enable to display the Crypto Spec field on the form. Enable this option to configure granular operations, such as some users being able to encrypt, but not decrypt.
      Application The Application scope is auto-populated by your current scope.
      Figure 6. Module Access Policy form
      Module Access Policy form
    12. Click Submit.
    13. As user with access to the encryption module, navigate to Incidents and add an attachment to the form.

      Once the attachment is uploaded, it will be available from the Activities screen.

      Figure 7. Attachment available per role
      Attachment available per role
    14. Log in as a user that doesn't have access to the module.
    15. Open the incident and scroll to the Activities: section.
      The link to open the attachment isn't visible for users that don't have access to the module.

    Résultats

    You have successfully used your customer-supplied key to control access to a specific attachment using Field Encryption Enterprise.