Breyta

Deila með

Access Control for Sensitive Data in Packages

  • Grein

Applies to: SQL Server SSIS Integration Runtime in Azure Data Factory

To protect the data in an Integration Services package, you can set a protection level that helps protect just sensitive data or all the data in the package. Furthermore, you can encrypt this data with a password or a user key, or rely on the database to encrypt the data. Also, the protection level that you use for a package is not necessarily static, but changes throughout the life cycle of the package. You often set one protection level during development and another as soon as you deploy the package.

Note

In addition to the protection levels described in this topic, you can use fixed database-level roles to protect packages that are saved to the Integration Services server.

Definition of Sensitive Information

In an Integration Services package, the following information is defined as sensitive:

  • The password part of a connection string. However, if you select an option that encrypts everything, the whole connection string will be considered sensitive.

  • The task-generated XML nodes that are tagged as sensitive. The tagging of XML nodes is controlled by Integration Services and cannot by changed by users.

  • Any variable that is marked as sensitive. The marking of variables is controlled by Integration Services.

Whether Integration Services considers a property sensitive depends on whether the developer of the Integration Services component, such as a connection manager or task, has designated the property as sensitive. Users cannot add properties to, nor can they remove properties from, the list of properties that are considered sensitive.

Encryption

Encryption, as used by package protection levels, is performed by using the Microsoft Data Protection API (DPAPI), which is part of the Cryptography API (CryptoAPI).

The package protection levels that encrypt packages by using passwords require that you provide a password also. If you change the protection level from a level that does not use a password to one that does, you will be prompted for a password.

Also, for the protection levels that use a password, Integration Services uses the Triple DES cipher algorithm with a key length of 192 bits, available in the .NET Framework Class Library (FCL).

Protection Levels

The following table describes the protection levels that Integration Services provides. The values in parentheses are values from the DTSProtectionLevel enumeration. These values appear in the Properties window that you use to configure the properties of the package when you work with packages in SQL Server Data Tools (SSDT).

Protection level Description
Do not save sensitive (DontSaveSensitive) Suppresses the values of sensitive properties in the package when the package is saved. This protection level does not encrypt, but instead it prevents properties that are marked sensitive from being saved with the package and therefore makes the sensitive data unavailable to other users. If a different user opens the package, the sensitive information is replaced with blanks and the user must provide the sensitive information.

When used with the dtutil utility (dtutil.exe), this protection level corresponds to the value of 0.
Encrypt all with password (EncryptAllWithPassword) Uses a password to encrypt the whole package. The package is encrypted by using a password that the user supplies when the package is created or exported. To open the package in SSIS Designer or run the package by using the dtexec command prompt utility, the user must provide the package password. Without the password the user cannot access or run the package.

When used with the dtutil utility, this protection level corresponds to the value of 3.
Encrypt all with user key (EncryptAllWithUserKey) Uses a key that is based on the current user profile to encrypt the whole package. Only the user who created or exported the package can open the package in SSIS Designer or run the package by using the dtexec command prompt utility.

When used with the dtutil utility, this protection level corresponds to the value of 4.

Note: For protection levels that use a user key, Integration Services uses DPAPI standards. For more information about DPAPI, see the MSDN Library at https://msdn.microsoft.com/library.
Encrypt sensitive with password (EncryptSensitiveWithPassword) Uses a password to encrypt only the values of sensitive properties in the package. DPAPI is used for this encryption. Sensitive data is saved as a part of the package, but that data is encrypted by using a password that the current user supplies when the package is created or exported. To open the package in SSIS Designer, the user must provide the package password. If the password is not provided, the package opens without the sensitive data and the current user must provide new values for sensitive data. If the user tries to execute the package without providing the password, package execution fails. For more information about passwords and command line execution, see dtexec Utility.

When used with the dtutil utility, this protection level corresponds to the value of 2.
Encrypt sensitive with user key (EncryptSensitiveWithUserKey) Uses a key that is based on the current user profile to encrypt only the values of sensitive properties in the package. Only the same user who uses the same profile can load the package. If a different user opens the package, the sensitive information is replaced with blanks and the current user must provide new values for the sensitive data. If the user attempts to execute the package, package execution fails. DPAPI is used for this encryption.

When used with the dtutil utility, this protection level corresponds to the value of 1.

Note: For protection levels that use a user key, Integration Services uses DPAPI standards. For more information about DPAPI, see the MSDN Library at https://msdn.microsoft.com/library.
Rely on server storage for encryption (ServerStorage) Protects the whole package using SQL Server database roles. This option is supported when a package is saved to the SQL Server msdb database. In addition, the SSISDB catalog uses the ServerStorage protection level

This option is not supported when a package is saved to the file system from SQL Server Data Tools (SSDT).

Protection Level Setting and the SSISDB Catalog

The SSISDB catalog uses the ServerStorage protection level. When you deploy an Integration Services project to the Integration Services server, the catalog automatically encrypts the package data and sensitive values. The catalog also automatically decrypts the data when you retrieve it.

If you export the project (.ispac file) from the Integration Services server to the file system, the system automatically changes the protection level to EncryptSensitiveWithUserKey. If you import the project by using the Integration Services Import Project Wizard in SQL Server Data Tools (SSDT), the ProtectionLevel property in the Properties window shows a value of EncryptSensitiveWithUserKey.

Protection Level Setting Based on Package Life Cycle

You set the protection level of a SQL Server Integration Services package when you first develop it in SQL Server Data Tools (SSDT). Later, when the package is deployed, imported or exported from Integration Services in SQL Server Management Studio, or copied from SQL Server Data Tools (SSDT) to SQL Server, the SSIS Package Store, or the file system, you can update the package protection level. For example, if you create and save packages on your computer with one of the user key protection level options, you likely would want to change the protection level when you give the package to other users; otherwise they cannot open the package.

Typically, you change the protection level as listed in the following steps:

  1. During development, leave the protection level of packages set to the default value, EncryptSensitiveWithUserKey. This setting helps ensure that only the developer sees sensitive values in the package. Or, you can consider using EncryptAllWithUserKey, or DontSaveSensitive.

  2. When it is time to deploy the packages, you have to change the protection level to one that does not depend on the developer's user key. Therefore you typically have to select EncryptSensitiveWithPassword, or EncryptAllWithPassword. Encrypt the packages by assigning a temporary strong password that is also known to the operations team in the production environment.

  3. After the packages have been deployed to the production environment, the operations team can re-encrypt the deployed packages by assigning a strong password that is known only to them. Or, they can encrypt the deployed packages by selecting EncryptSensitiveWithUserKey or EncryptAllWithUserKey, and using the local credentials of the account that will run the packages.

Set or Change the Protection Level of Packages

To control access to the contents of packages and to the sensitive values that they contain, such as passwords, set the value of the ProtectionLevel property. The packages contained in a project need to have the same protection level as the project, to build the project. If you change the ProtectionLevel property setting on the project, you need to manually update the property setting for the packages.

For an overview of security features in Integration Services, see Security Overview (Integration Services).

The procedures in this topic describe how to use either SQL Server Data Tools (SSDT) or the dtutil command prompt utility to change the ProtectionLevel property.

Note

In addition to the procedures in this topic, you can typically set or change the ProtectionLevel property of a package when you import or export the package. You can also change the ProtectionLevel property of a package when you use the SQL Server Import and Export Wizard to save a package.

To set or change the protection level of a package in SQL Server Data Tools

  1. Review the available values for the ProtectionLevel property in the section, Protection Levels, and determine the appropriate value for your package.

  2. In SQL Server Data Tools (SSDT), open the Integration Services project that contains the package.

  3. Open the package in the SSIS designer.

  4. If the Properties window does not show the properties of the package, click the design surface.

  5. In the Properties window, in the Security group, select the appropriate value for the ProtectionLevel property.

    If you select a protection level that requires a password, enter the password as the value of the PackagePassword property.

  6. On the File menu, select Save Selected Items to save the modified package.

To set or change the protection level of packages at the command prompt

  1. Review the available values for the ProtectionLevel property in the section, Protection Levels, and determine the appropriate value for your package.

  2. Review the mappings for the Encrypt option in the topic, dtutil Utility, and determine the appropriate integer to use as the value of the selected ProtectionLevel property.

  3. Open a Command Prompt window.

  4. At the command prompt, navigate to the folder that contains the package or packages for which you want to set the ProtectionLevel property.

    The syntax examples shown in the following step assume that this folder is the current folder.

  5. Set or change the protection level of the package or packages by using a command similar to the one of the following examples:

    • The following command sets the ProtectionLevel property of an individual package in the file system to level 2, "Encrypt sensitive with password", with the password, "strongpassword":

      dtutil.exe /file "C:\Package.dtsx" /encrypt file;"C:\Package.dtsx";2;strongpassword

    • The following command sets the ProtectionLevel property of all packages in a particular folder in the file system to level 2, "Encrypt sensitive with password", with the password, "strongpassword":

      for %f in (*.dtsx) do dtutil.exe /file %f /encrypt file;%f;2;strongpassword

      If you use a similar command in a batch file, enter the file placeholder, "%f", as "%%f" in the batch file.

Package Project Protection Level Dialog Box

Use the Package Protection Level dialog box to update the protection level of a package. The protection level determines the protection method, the password or user key, and the scope of package protection. Protection can include all data or sensitive data only.

To understand the requirements and options for package security, you may find it useful to see Security Overview (Integration Services).

Options

Package protection level
Select a protection level from the list.

Password
If using the Encrypt sensitive data with password or Encrypt all data with password protection level, type a password.

Retype password
Type the password again.

Package Password Dialog Box

Use the Package Password dialog box to provide the package password for a package that is encrypted with a password. You must provide a password if the package uses the Encrypt sensitive with password or Encrypt all with password protection level.

Options

Password
Enter the password.

See Also

Integration Services (SSIS) Packages
Security Overview (Integration Services)
dtutil Utility