Thales Database Security Option Pack. for Microsoft SQL Server Integration Guide.

Transcription

1 Thales Database Security Option Pack for Microsoft SQL Server Integration Guide

2 Version: 2.0 Date: 4 May 2012 Copyright 2012 Thales e-security Limited. All rights reserved. Copyright in this document is the property of Thales e-security Limited. It is not to be reproduced, modified, adapted, published, translated in any material form (including storage in any medium by electronic means whether or not transiently or incidentally) in whole or in part nor disclosed to any third party without the prior written permission of Thales e-security Limited neither shall it be used otherwise than for the purpose for which it is supplied. Codesafe, Keysafe, the ncipher logo, nfast, nforce, nshield, Payshield, and Ultrasign are registered trademarks of Thales e-security Limited and/or ncipher Corporation Limited. CipherTools, CryptoStor, CryptoStor Tape, keyauthority, KeyVault, ncipher, ncore, nethsm, nfast Ultra, nforce Ultra, nshield Connect, ntoken, SAFEBUILDER, SEE, the SEE logo, and TRUST APPLIANCE are trademarks of Thales e-security Limited and/or ncipher Corporation Limited. Microsoft and SQL Server are registered trademarks of Microsoft Corporation in the United States and other countries. All other trademarks are the property of the respective trademark holders. Information in this document is subject to change without notice. Thales e-security Limited makes no warranty of any kind with regard to this information, including, but not limited to, the implied warranties of merchantability and fitness for a particular purpose. Thales e-security Limited shall not be liable for errors contained herein or for incidental or consequential damages concerned with the furnishing, performance or use of this material. Commercial Computer Software - proprietary This computer software and documentation is Commercial Computer Software and Computer Software Documentation, as defined in sub-paragraphs (a)(1) and (a)(5) of DFAR , Rights in Noncommercial Computer Software and Noncommercial Computer Software Documentation. Use, duplication or disclosure by the Government is subject to the Thales standard US Terms And Conditions for the Product. Patents UK Patent GB Corresponding patents/applications in USA, Canada, South Africa, Japan and International Patent Application PCT/GB98/ Other patents pending. Version: 2.0 Date: 04 May Thales e-security Limited. All rights reserved. Template: nshimar12 Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 2

3 Contents Chapter 1: About this guide 5 Read this guide if... 5 Terminology 5 Typographical conventions 6 Further Information 6 Contacting Support 6 Chapter 2: Overview 7 Cryptographic architecture 8 Querying encrypted data 9 Chapter 3: Installation and configuration 13 Supported platforms and environments 13 Installation 15 Configuration 16 Enabling the SQLEKM provider 16 Creating a credential 17 Checking the configuration 18 Disaster recovery 19 Encryption 20 Supported cryptographic algorithms 20 Creating and managing symmetric keys 21 Creating and managing asymmetric keys 22 Creating a symmetric wrapped key from an asymmetric wrapping key 23 TDE 23 Cell-level encryption 28 Troubleshooting 32 Chapter 4: Uninstalling and Upgrading 33 Turning off TDE and removing TDE setup 33 Uninstalling the Database Security Option Pack for SQL Server 36 Upgrading 38 Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 3

4 Addresses 39 Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 4

5 Chapter 1: About this guide Read this guide if... You want to install and then configure the Database Security Option Pack for Microsoft SQL Server, an SQLEKM provider for Microsoft SQL Server 2008, SQL Server 2008 R2 and Microsoft SQL Server 2012 Enterprise Edition that offloads encryption, decryption and key storage onto Thales nshield hardware security modules (HSMs). The guide also provides troubleshooting information, and instructions for uninstalling and upgrading the SQLEKM provider. You will find the installer and all the associated configuration files and executables for the Database Security Option Pack for SQL Server on the supplied installation disc. This guide assumes that: One or more Thales nshield HSMs are already installed. Security World for nshield, formerly named ncipher Support Software, V11.11 or higher is already installed with a Security World appropriately configured. An SQL Server service is already installed. You are familiar with the administration and configuration of Microsoft SQL Server. For more information about: Installing a Thales nshield HSM, see the Quick Start Guide or Hardware Installation Guide. Security World Software, see the appropriate User Guide. Microsoft SQL Server, visit the dedicated Microsoft web site at Terminology To make this guide more straightforward to read: Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 5

6 Further Information The Database Security Option Pack for SQL Server is also referred to as the SQLEKM provider. Microsoft SQL Server 2008, Microsoft SQL Server 2008 R2 and Microsoft SQL Server 2012 Enterprise Edition are referred to as simply Microsoft SQL Server. Typographical conventions Note The word Note in the margin indicates important supplemental information. Onscreen text from graphical user interfaces, and the names of files, command-line utilities, and other system items are presented in boldface text. Examples of onscreen display are presented in a form similar to the following: install Further Information This guide forms one part of the information and support provided by Thales. You can find additional documentation in the document directory of the installation disc for your product. Contacting Support To obtain support for your product, visit Before contacting the Support team, click Useful Information and use the subtopics to see the information that the team requires. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 6

7 Chapter 2: Overview This chapter describes how the Database Security Option Pack for SQL Server enables you to manage encryption operations performed on Microsoft SQL Server Enterprise edition databases, using Thales nshield HSMs. It describes the cryptographic architecture which the SQLEKM provider enables, and the benefits of deploying such an architecture. A step-by-step guide to performing encryption operations on SQL Server using the provider is also provided. The provider supports the two types of encryption that are available through SQL Server: Transparent Data Encryption (TDE), which is used to encrypt an entire database in a way that does not require changes to existing queries and applications. Cell-level encryption, which uses one or more keys to encrypt individual cells or columns within database tables. You will find the installer and all the associated configuration files and executables for the Database Security Option Pack for SQL Server on the supplied installation disc. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 7

8 Cryptographic architecture Cryptographic architecture Figure 1 Cryptographic architecture SQL Server: Client Database 1 Database 2 SQLEKM provider HSM TDE Cell-level encryption Master database Card set abc Softcard Logic Off-site back-up storage: Disk storage Disk storage Disk storage A Microsoft SQL Server service permits the creation of: One or more databases. When a client request is made to SQL Server, it determines which of the databases are the subject of the query and may load the databases into memory from disk storage. One or more cryptographic keys. You can use these keys to perform encryption either across an entire database (transparent data encryption (TDE) mode) or across a user-specified set of fields within a database table (cell-level encryption mode). One or more SQLEKM providers. An SQLEKM provider, such as the Database Security Option Pack for SQL Server, is used in association with a HSM to perform cryptographic and key management operations. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 8

9 Cryptographic architecture The Database Security Option Pack for SQL Server implements the Extensible Key Management (EKM) API introduced in Microsoft SQL Server, designed to enable the integration of HSMs (such as nshield Connect and nshield Solo) into your existing database infrastructure. A set of smart cards or a softcard is used to control access to the secure environment of the HSM, where the cryptographic keys that are used to encrypt and decrypt your SQL Server databases are created, stored and managed. The smart cards or softcard protects the encrypted data stored on disk. If the smart cards or softcard (and the corresponding passphrase) are not available to an attacker, the attacker cannot reconstruct the original, unencrypted data from the data stored on the disk. In addition, if the encrypted data is stored elsewhere, on off-line back-up media, the attacker cannot reconstruct the data without access to a Thales nshield HSM with the same cryptographic key information as the HSM used by the SQL Server instance. You can configure the SQLEKM provider to perform TDE or cell level encryption. A database encrypted with TDE is automatically decrypted when SQL Server loads it into memory from disk storage, which means that a client can query the database within the server environment without having to perform any decryption operations. The database is encrypted again when saved to disk storage. Cell level encryption is the ability to apply fine grained access policy to the most sensitive data in a database. Although the client must specify in their query what encrypted data they would like to access, and what cryptographic key to use to decrypt that data, this mode of encryption can minimize data exposure within the database server and client applications. You can apply cell level encryption to database tables that are also encrypted using TDE. For more information about: Configuring the SQLEKM provider to perform encryption operations on SQL Server, see Configuration on page 16. Thales nshield HSMs, see the appropriate User Guide. Querying encrypted data When the client sends a query to SQL Server, the SQLEKM provider checks the level of encryption on the database that is the subject of the query. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 9

10 Cryptographic architecture Figure 2 Querying encrypted data: process diagram SQL Server query Is database loaded? No Load database into memory Is database encrypted with TDE? Yes Decrypt database Yes No Process query (performing any cell level encryption operations specified) Perform query When SQL Server loads a database encrypted with TDE into memory, the database is automatically decrypted. The form of the query does not have to specify any decryption operation, and the client does not need to be made aware of the encryption status of the database. However, if there is cell level encryption across the fields of the database the client wants to query (such as a particular column of data in a table), the query must specify: The fields to decrypt. The cryptographic key that is used for decrypting those fields. Example queries The following example queries use a database table of customer information that includes first names, second names and payment card numbers. The queries concern the details of customers whose first names are Joe. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 10

11 Cryptographic architecture Example 1: TDE encryption only In this example, the entire database is encrypted with TDE. Figure 3 TDE encryption only Database: TestDatabase Table: Customers TDE Cust First name Second name CardNumber ID 01 Joe Bloggs [16-dig credit card number] 02 Iain Hood [16-dig credit card number] 03 Joe Smith [16-dig credit card number] The database is decrypted when it is loaded into memory from disk storage. As this happens before the query is performed the query does not have to specify any decryption operation: SELECT * FROM Customers WHERE First name LIKE ('*Joe*'); Example 2: In this example, the database is encrypted with TDE and the column of credit card numbers in the table of customers is protected with cell-level encryption. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 11

12 Cryptographic architecture Figure 4 TDE and cell level encryption Database: TestDatabase Table: Customers Cell-level encryption TDE Cust First name Second name CardNumber ID 01 Joe Bloggs [16-dig credit card number] 02 Iain Hood [16-dig credit card number] 03 Joe Smith [16-dig credit card number] The query does not have to take account of TDE on the database because the database is decrypted on loading into memory from disk storage before the query is performed. However, the query must specify the decryption of the column of credit card numbers in the table of customers before the details of customers called Joe can be returned. SELECT [First name], [Second name], CAST(DecryptByKey('CardNumber') AS VARCHAR(MAX)) AS 'Decrypted card number' FROM Customers WHERE [First name] LIKE ('*Joe*'); Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 12

13 Chapter 3: Installation and configuration This chapter describes how to: Install and enable the Database Security Option Pack for SQL Server (also referred to as the SQLEKM provider) on SQL Server. Configure the SQLEKM provider for both TDE and cell level encryption on SQL Server databases. Note In the example T-SQL statements featured in the remaining part of this guide, the names used for cryptographic keys (such as AES256Key) and databases (such as TestDatabase) are example names only. The only exception to this rule is the master database, which is a real database. The example T-SQL statements are also listed in the examples.txt file, available from the document directory of your product CD-ROM. Supported platforms and environments The Database Security Option Pack for SQL Server is fully compatible with V11.11 or higher of the Security World Software and a range of Thales nshield HSMs. You must install the Security World Software and the HSM before you can install and configure the SQLEKM provider. The SQLEKM provider supports the following Thales nshield HSMs: nshield Solo 500, 2000, 4000, 500e, 6000e. nethsm 500, nshield Connect 500, 1500, The SQLEKM provider supports the Enterprise Edition of Microsoft SQL Server 2008 (with Service Pack 1 and Cumulative Update 1 patch) and Microsoft SQL Server 2008 R2 on the following platforms: Windows Server 2003 Enterprise Edition (32-bit and 64-bit configurations). Windows Server 2008 Enterprise Edition (32-bit and 64-bit configurations). Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 13

14 Supported platforms and environments Windows Server 2008 R2 Enterprise Edition (64-bit configuration). The integration between the HSM and the SQLEKM provider has been tested for the following combinations: Windows Server operating system version 2008 R2 SP2 64-bit Microsoft SQL Server version Security World Software version nshield Solo support nethsm support Yes Yes nshield Connect support 2008 R R Yes bit bit 2008 R Yes bit 2008 R Yes 2003 R2 32- bit 2008 R Yes bit 2008 R Yes bit Yes 2008 R R Yes bit 2008 R2 64- bit Yes bit 2008 R Yes bit 2008 R Yes 2003 R R Yes bit bit 2008 R Yes bit Yes Yes bit Yes bit Yes bit Yes bit Yes You can access the following ncipher functionality when you integrate an ncipher HSM with the MS SQL: Soft cards Yes Key Management Yes Strict FIPS support Yes Key Recovery Yes Module Only Key K of N Card Set Yes Key Generation Yes Key Import Fail Over Yes Load Balancing Yes Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 14

15 Installation Installation You will find the installer and all the associated configuration files and executables for the Database Security Option Pack for SQL Server on the supplied installation disc. To install the Database Security Option Pack for SQL Server on Microsoft SQL Server: 1 Ensure that %NFAST_HOME%\toolkits\pkcs11 is added to the PATH environment variable. 2 For a cluster configuration, you must: a b Copy the local subdirectory (of the Key Management Data directory) to a network share and set NFAST_KMLOCAL as a system environment variable to reference this location. Install the Security World Software on the additional nodes, setting NFAST_KMLOCAL as a system environment variable to point to the local subdirectory on the network share. 3 Place the SQLEKM provider installation disc in the optical disc drive. Launch setup.exe manually if the installer does not run automatically. Note If you are installing a version of the Security World Software other than V11.11 or V11.30, a message is displayed stating that those versions of software are not installed and asking if you wish to continue. It is safe to click Yes and continue with the installation. The Welcome screen of the InstallShield wizard is displayed. 4 Click Next. 5 To accept the license agreement, click Yes. Note You also have the option to print the license agreement. 6 A setup status screen is displayed, showing the progress of the installation. When the setup files finish installing, you are asked if you want to restart the machine now or later. You must restart the machine in order to use the SQLEKM provider. Click Finish while Yes, I want to restart my computer now is selected to restart the machine and complete setup. 7 In order for Thales SQLEKM to support multithreaded access to Microsoft SQL Server, a hotfix is required. Please contact Thales support to obtain this hotfix. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 15

16 Configuration Configuration The following procedure and sub-procedures assume that SQL Server Management Studio is open and that you are connected to the SQL Server instance. Open a query window to execute a query. Enabling the SQLEKM provider To enable the SQLEKM provider on SQL server for both TDE and cell level encryption: 1 Add the following line to the cknfastrc file (in NFAST_HOME): CKNFAST_LOADSHARING=1 Note For a cluster configuration, you must add this line to the cknfastrc file on all nodes within the cluster. 2 Enable support for SQLEKM providers within SQL Server by executing the following query: sp_configure 'show advanced options', 1; RECONFIGURE; sp_configure 'EKM provider enabled', 1; RECONFIGURE; Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 16

17 Configuration 3 Register the SQLEKM provider with the SQL Server by executing the following query: CREATE CRYPTOGRAPHIC PROVIDER <Name of provider> FROM FILE = '<Path to provider>'; Where: - <Name of provider> is the name that is used to refer to the SQLEKM provider in subsequent T-SQL statements. - <Path to provider> is the fully qualified path to the ncsqlekm.dll file in the installation directory. For example: CREATE CRYPTOGRAPHIC PROVIDER ncipher_provider FROM FILE = 'C:\Program Files (x86)\ncipher\nfast\bin\ncsqlekm.dll'; Note The SQLEKM provider installation wizard copies a 32-bit DLL into ncsqlekm.dll on 32-bit systems, and a 64-bit DLL into ncsqlekm.dll on 64-bit systems. The alternative bit length version is named either ncsqlekm32.dll or ncsqlekm64.dll, depending on the installation platform. 4 To check that the SQLEKM provider is listed: a b Open Object Explorer on the Management Studio. Go to Security > Cryptographic Providers. Creating a credential A credential represents the smart card set (or softcard) and passphrase that is used to access the keys protected by the SQLEKM provider. You must map a credential from an SQL login to the SQLEKM provider before you can use the SQLEKM provider. To create a credential and map that credential to the logged-in user (in this case, the user is TestLogin): 1 In Object Explorer, navigate to Security > Credentials. 2 Right click Credentials, then select New Credential. 3 Set Credential name to logincredential. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 17

18 Configuration 4 Set Identity to <OCS>, where <OCS> matches the name of the Operator Card Set (OCS) or softcard. 5 Set Password to <passphrase>, where <passphrase> matches the passphrase on the card set or softcard. 6 Set Use Encryption Provider to <Name of provider>, where <Name of provider> is the name that is used to refer to the SQLEKM provider. Click OK. 7 In Object Explorer, navigate to Security > Logins. 8 Right click to select the current logged in user, then select Properties. 9 Ensure Map to Credential is selected, then select logincredential from the drop down list. Click Add, then click OK. Checking the configuration To check that the SQLEKM provider was configured correctly on SQL server for both TDE and cell level encryption: 1 Check that the SQLEKM provider was registered correctly by executing the following query: SELECT * FROM sys.cryptographic_providers; A table is displayed with information about the registration of the SQLEKM provider. Check that: - The build version and the.dll path are correct. - The is_enabled column is set to 1. 2 Check the SQLEKM provider properties by executing the following query: SELECT * FROM sys.dm_cryptographic_provider_properties; A table is displayed with information about the properties of the SQLEKM provider. Check that: - The version of the SQLEKM provider is correct for the build. - The friendly_name is ncipher SQLEKM Provider. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 18

19 Disaster recovery 3 To check that the supported cryptographic algorithms can be queried, execute the following query: int; = (SELECT TOP(1) provider_id FROM sys.dm_cryptographic_provider_properties WHERE friendly_name LIKE 'ncipher SQLEKM Provider'); SELECT * FROM sys.dm_cryptographic_provider_algorithms(@providerid); Note If a strict FIPS Security World is used DES key type support is removed. A table is displayed with the supported cryptographic algorithms. For more information about the algorithms that should be displayed, see Supported cryptographic algorithms on page 20. Disaster recovery The Database Security Option Pack for Microsoft SQL Server builds on the Security World abstraction that is provided by the Security World Software. Correct management of the Security World data files and card sets is necessary to implement a disaster recovery procedure and to prevent irretrievable data loss. For more information about Security Worlds, see your HSM User Guide. The local subdirectory of the Key Management Data directory (referenced by the NFAST_KMDATA environment variable) contains the world, keys, cards, and softcard data, and must be backed up regularly. If set, the NFAST_KMLOCAL environment variable references an alternative location for this data, which should be backed up instead. You must perform regular database backups according to your corporate disaster recovery policy. A Security World card set consists of a group of N cards. An equal or smaller number of cards within this set, the quorum K, is required to authorize an action. Operator Card Sets used with SQL Server should have a quorum of 1 of N. For disaster recovery, a sufficient N must be chosen to allow for failure or loss of individual smart cards. You must retain some of these cards in a secure (off-site) location. The Administrator Card Set (ACS) is not used directly by the Database Security Option Pack for Microsoft SQL Server. This card set is used to manage the Security World and other card sets. You must always keep the ACS in a secure (off-site) location. The exact number of cards and quorum chosen depends on your corporate security policy. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 19

20 Encryption Encryption When you have completed the configuration of the SQLEKM provider, you can use the SQLEKM provider to: Manage cryptographic keys within the Thales nshield HSM. Encrypt or decrypt entire databases or fields within database tables within your SQL Server service. Supported cryptographic algorithms The algorithms that you can use for encryption can depend on whether or not the Thales nshield HSM operates at a strict or a non-strict level of compliance with the FIPS Level 3 security standard. For more information about cryptographic algorithms and FIPS Level 3, see the appropriate User Guide. The following table lists cryptographic algorithms that you can use with symmetric keys. Algorithm Non-strict FIPS Level 3 Strict FIPS Level 3 DES Yes No Triple_DES Yes Yes Triple_DES_3KEY Yes Yes AES_128 Yes Yes AES_192 Yes Yes AES_256 Yes Yes The following table lists cryptographic algorithms that you can use with asymmetric cryptographic keys. Algorithm Non-strict FIPS Level 3 Strict FIPS Level 3 RSA_512 Yes Yes RSA_1024 Yes Yes RSA_2048 Yes Yes Note DES and RSA_512 keys are not recommended for use with Thales nshield products. You must modify the PKCS #11 library configuration file to use these keys. For more information, contact Support. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 20

21 Encryption Creating and managing symmetric keys The following procedures assume that SQL Server Management Studio is open and that you are connected to the SQL Server instance. Open a query window to execute a query. Note If you are using a card set (OCS), ensure that your card set is inserted in the card reader before attempting to create and manage symmetric keys. To create a symmetric key (AES256Key) using the SQLEKM provider, execute the following query: USE TestDatabase CREATE SYMMETRIC KEY AES256Key FROM PROVIDER <Name of provider> WITH PROVIDER_KEY_NAME= AES256Key, CREATION_DISPOSITION = CREATE_NEW, ALRITHM=AES_256; Where <Name of provider> is the name that is used to refer to the SQLEKM provider. To remove a symmetric key (AES256Key, created in the above procedure) from the database only (TestDatabase), execute the following query: USE TestDatabase DROP SYMMETRIC KEY AES256Key; To remove a symmetric key (AES256Key) from the database (TestDatabase) and the Thales nshield HSM, execute the following query: USE TestDatabase DROP SYMMETRIC KEY AES256Key REMOVE PROVIDER KEY; Note Refer to your security policies before considering deleting a provider key on the HSM. To import a symmetric key (AES256Key) into the database (TestDatabase), execute the following query: USE TestDatabase CREATE SYMMETRIC KEY AES256Key FROM PROVIDER <Name of provider> WITH PROVIDER_KEY_NAME='AES256Key', CREATION_DISPOSITION = OPEN_EXISTING; Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 21

22 Encryption Where <Name of provider> is the name that is used to refer to the SQLEKM provider. Note If you have removed a symmetric key from the database, you can import it into the database again using the above procedure. However, you cannot import a key into the database once you have deleted that key from the database and the HSM. To find out what symmetric keys have been created, complete the following steps: 1 Open Object Explorer on the Management Studio. 2 Go to Databases > TestDatabase > Security > Symmetric Keys. Creating and managing asymmetric keys The following procedures assume that SQL Server Management Studio is open and that you are connected to the SQL Server instance. Open a query window to execute a query. To create an asymmetric key (RSA2048Key) using the SQLEKM provider, execute the following query: USE TestDatabase CREATE ASYMMETRIC KEY RSA2048Key FROM PROVIDER <Name of provider> WITH PROVIDER_KEY_NAME= RSA2048Key, CREATION_DISPOSITION = CREATE_NEW, ALRITHM=RSA_2048; Where <Name of provider> is the name that is used to refer to the SQLEKM provider. To remove an asymmetric key (RSA2048Key, created in the above procedure) from the database only (TestDatabase), execute the following query: USE TestDatabase DROP ASYMMETRIC KEY RSA2048Key; To remove an asymmetric key (RSA2048Key) from the database (TestDatabase) and the Thales nshield HSM, execute the following query: USE TestDatabase DROP ASYMMETRIC KEY RSA2048Key REMOVE PROVIDER KEY; Note Refer to your security policies before considering deleting a provider key on the HSM. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 22

23 Encryption To import an asymmetric key (RSA2048Key) into the database (TestDatabase), execute the following query: USE TestDatabase CREATE ASYMMETRIC KEY RSA2048Key FROM PROVIDER <Name of provider> WITH PROVIDER_KEY_NAME='RSA2048Key', CREATION_DISPOSITION = OPEN_EXISTING; Where <Name of provider> is the name that is used to refer to the SQLEKM provider. Note If you have removed an asymmetric key from the database, you can import it into the database again using the above procedure. However, you cannot import a key into the database once you have deleted that key from the database and the HSM. To find out what asymmetric keys have been created, complete the following steps: 1 Open Object Explorer on the Management Studio. 2 Go to Databases > TestDatabase > Security > Asymmetric Keys. Creating a symmetric wrapped key from an asymmetric wrapping key The following procedure assumes that SQL Server Management Studio is open and that you are connected to the SQL Server instance. Open a query window to execute a query. To create a symmetric wrapped key (WrappedKey) from an asymmetric wrapping key (WrappingKey), execute the following query: USE TestDatabase CREATE ASYMMETRIC KEY WrappingKey FROM PROVIDER <Name of provider> WITH PROVIDER_KEY_NAME='RSA2048Key', CREATION_DISPOSITION = CREATE_NEW, ALRITHM=RSA_2048; CREATE SYMMETRIC KEY WrappedKey WITH ALRITHM = AES_256 ENCRYPTION BY ASYMMETRIC KEY WrappingKey; Where <Name of provider> is the name that is used to refer to the SQLEKM provider. TDE The following procedures assume that SQL Server Management Studio is open and that you are connected to the SQL Server. Open a query window to execute a query. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 23

24 Encryption To create a TDE Key Encryption Key (TDEKEK) (WrappingKey) for database encryption, execute the following query: USE master CREATE ASYMMETRIC KEY WrappingKey FROM PROVIDER <Name of provider> WITH PROVIDER_KEY_NAME='WrappingKey', CREATION_DISPOSITION = CREATE_NEW, ALRITHM = RSA_2048; Where <Name of provider> is the name that is used to refer to the SQLEKM provider. Note The TDEKEK is the only key you must create in the master database. To find the TDEKEK, navigate to Databases > System Databases > master > Security > Asymmetric Keys. To set up the TDE login and credential: 1 In Object Explorer, navigate to Security > Credentials. 2 Right click Credentials, then select New Credential. 3 Set Credential name to tdecredential. 4 Set Identity to <OCS>, where <OCS> matches the name of the Operator Card Set (OCS) or softcard. 5 Set Password to <passphrase>, where <passphrase> matches the passphrase on the card set or softcard. 6 Set Use Encryption Provider to <Name of provider>, where <Name of provider> is the name that is used to refer to the SQLEKM provider. Click OK. 7 In Object Explorer, navigate to Security > Logins. 8 Right click Logins, then select New Login. 9 Set Login name to tde_login. 10 Ensure Mapped to asymmetric key is selected, then select WrappingKey (the TDEKEK created in the previous procedure) from the drop down list. 11 Ensure Map to Credential is selected, then select tdecredential from the drop down list. Click Add, then click OK. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 24

25 Encryption Figure 5 Creating the TDEDEK To create the TDE Database Encryption Key (TDEDEK) (using the TDEKEK created above (WrappingKey)) for database encryption, and enable TDE on the database (TestDatabase): 1 In Object Explorer, navigate to Databases > TestDatabase. 2 Right click TestDatabase, then select Tasks > Manage Database Encryption... 3 Set Encryption Algorithm to the AES 256 algorithm. 4 Ensure that Use server asymmetric key is selected, then select WrappingKey from the drop down list. 5 Ensure Set Database Encryption On is selected, then click OK. Note DES and TRIPLE_DES mechanisms are not supported by SQL Server 2008 for TDEDEKs. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 25

26 Encryption Figure 6 Checking that TDE has occurred To check that TDE has occurred successfully on the database (TestDatabase): 1 In Object Explorer, navigate to Databases > TestDatabase. 2 Right click TestDatabase, then select Tasks > Manage Database Encryption... 3 Select the Properties page. Ensure that EncryptionState is set to Encrypted, then click OK. To replace the TDEKEK (from WrappingKey to a new key): 1 Following the procedure above for WrappingKey, create a new asymmetric TDEKEK AnotherWrappingKey. 2 Following the procedure above for tde_login, create a new TDE login another_tde_login mapped to AnotherWrappingKey and mapped to a new anothertdecredential credential. 3 In Object Explorer, navigate to Databases > TestDatabase. 4 Right click TestDatabase, then select Tasks > Manage Database Encryption... Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 26

27 Encryption Figure 7 Replacing the TDEKEK 5 Ensure Re-Encrypt Database Encryption Key and Use server asymmetric key are selected. Select AnotherWrappingKey from the drop down list. 6 Ensure Regenerate Database Encryption Key is not selected. 7 Ensure Set Database Encryption On is selected, then click OK. To replace the TDEDEK: 1 In Object Explorer, navigate to Databases > TestDatabase. 2 Right click TestDatabase, then select Tasks > Manage Database Encryption... Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 27

28 Encryption Figure 8 Replacing the TDEDEK 3 Ensure Re-Encrypt Database Encryption Key is not selected. 4 Ensure Regenerate Database Encryption Key is selected, then select AES 256 from the drop down list. 5 Ensure Set Database Encryption On is selected, then click OK. Cell-level encryption The following procedures assume that SQL Server Management Studio is open and that you are connected to the SQL Server. Open a query window to execute a query. An example database table, called Customers, is referenced in the procedures. The database that contains the table is called TestDatabase. The table comprises: A first column called FirstName that contains the first name of payment card holders. A second column called SecondName that contains the second name of payment card holders. A third column called CardNumber that contains the payment card numbers of card holders. The encryption and decryption operations described in the procedures below are performed on CardNumber. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 28

29 Encryption Figure 9 Example table: Customers Database: TestDatabase Table: Customers Cell-level encryption Cust First name Second name CardNumber ID 01 Joe Bloggs [16-dig credit card number] 02 Iain Hood [16-dig credit card number] 03 Joe Smith [16-dig credit card number] Creating a table with cells of encrypted data To create a database table with data (Customers), where individual cells of data held in the third column (CardNumber) are encrypted with a symmetric key (SymmetricKey), execute the following query: USE TestDatabase CREATE TABLE Customers (FirstName varchar(max), SecondName varchar(max), CardNumber varbinary(max)); INSERT INTO Customers (FirstName, SecondName, CardNumber) VALUES ('Joe', 'Bloggs', ENCRYPTBYKEY(KEY_GUID('SymmetricKey'), '16-Dig Card Number')); Where 16-Dig Card Number is the 16-digit payment card number to be encrypted. Note To prevent corruption or truncation of the stored encrypted data, the column or field where the encrypted data is stored must be of the type 'varbinary(max)'. If an asymmetric key (AsymmetricKey) is used, the INSERT INTO statement has the following form: INSERT INTO Customers (FirstName, SecondName, CardNumber) VALUES ('Iain', 'Hood', ENCRYPTBYASYMKEY(ASYMKEY_ID('AsymmetricKey'), '16-Dig Card Number')); Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 29

30 Encryption Where 16-Dig Card Number is the 16-digit payment card number to be encrypted. Listing cell-encrypted data in a table To list all the data in a database table (Customers, created in the previous section), showing just the plain text names and encrypted payment card numbers: 1 In Object Explorer, navigate to Databases > TestDatabase > Tables > dbo.customers. 2 Right click dbo.customers, then select Select Top 1000 Rows. To list the first names (FirstName), second names (SecondName) and the decrypted payment card numbers (which were encrypted with a symmetric key) in an existing table (Customers), execute the following query: USE TestDatabase SELECT FirstName, SecondName, CONVERT(varchar, DECRYPTBYKEY(CardNumber)) AS 'CardNumber' FROM Customers; If an asymmetric key (AsymmetricKey) was used to encrypt the payment card numbers, the statement has the following form: USE TestDatabase SELECT FirstName, SecondName, CONVERT(varchar, DECRYPTBYASYMKEY(ASYMKEY_ID('AsymmetricKey'), CardNumber)) AS 'CardNumber' FROM Customers; Note DECRYPTBYASYMKEY in the asymmetric key decryption operation requires the name of the key (AsymmetricKey), whereas DECRYPTBYKEY in the symmetric key decryption operation does not. Encrypting and decrypting columns of data As well as performing encryption operations on data within individual table cells, you can also choose to encrypt and decrypt entire columns of data. To encrypt a column of data (CardNumber) in an existing table (Customers) with a symmetric key (SymmetricKey), execute the following query: USE TestDatabase UPDATE Customers SET CardNumber = ENCRYPTBYKEY(Key_GUID('SymmetricKey'), CardNumber); Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 30

31 Encryption If an asymmetric key (AsymmetricKey) is used to encrypt a column of data (CardNumber), the statement has the following form: USE TestDatabase UPDATE Customers SET CardNumber = ENCRYPTBYASYMKEY(AsymKey_ID('AsymmetricKey'), CardNumber); To decrypt a column of data (CardNumber) encrypted by a symmetric key in an existing table (Customers), execute the following query: USE TestDatabase UPDATE Customers SET CardNumber = DECRYPTBYKEY(CardNumber); If a column of data (CardNumber) encrypted by an asymmetric key (AsymmetricKey) is being decrypted, the statement has the following form: USE TestDatabase UPDATE Customers SET CardNumber = DECRYPTBYASYMKEY(AsymKey_ID( AsymmetricKey ), CardNumber); Note DECRYPTBYASYMKEY in the asymmetric key decryption operation requires the name of the key (AsymmetricKey), whereas DECRYPTBYKEY in the symmetric key decryption operation does not. Viewing tables in Object Explorer To check that data in a table (Customers) was either encrypted or decrypted successfully, complete the following steps: 1 Open Object Explorer on the Management Studio. 2 Go to Databases > TestDatabase > Tables. 3 Right click dbo.customers and select Select Top 1000 Rows to view the encrypted or decrypted data. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 31

32 Troubleshooting Troubleshooting Issue An error message is outputted in Microsoft SQL Server Management Studio that states that a session could not be opened for the SQLEKM provider. An error message is outputted in Microsoft SQL Server Management Studio that states that a DES key could not be created. An error message is outputted in Microsoft SQL Server Management Studio that states that the key type property of the key returned by the SQLEKM provider does not match the expected value. Diagnosis There is either no smart card in the card reader, or an incorrect smart card in the card reader. Alternatively, the wrong OCS name or passphrase has been entered into the credentials. The DES key cannot be created because the Thales nshield HSM is operating at a strict level of compliance with the FIPS Level 3 security standard. DES keys can only be created where the Thales nshield HSM is operating at a non-strict level of compliance. An attempt was made to create an asymmetric or a symmetric key with an unsupported algorithm. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 32

33 Chapter 4: Uninstalling and Upgrading The following procedures assume that SQL Server Management Studio is open and that you are connected to SQL Server. Turning off TDE and removing TDE setup Remember to turn off TDE on all your databases and remove TDE setup before you uninstall the Database Security Option Pack for SQL Server. If you do not do so before uninstalling the SQLEKM provider, you will not be able to decrypt any databases encrypted with TDE. Figure 10 Turning off TDE To turn off TDE on a database (TestDatabase): 1 In Object Explorer, navigate to Databases > TestDatabase. 2 Right click TestDatabase, then select Tasks > Manage Database Encryption... 3 Ensure that Set Database Encryption On is not selected, then click OK. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 33

34 Turning off TDE and removing TDE setup Figure 11 Checking that decryption is complete To check that the database (TestDatabase) decrypted successfully, following the above procedure: 1 In Object Explorer, navigate to Databases > TestDatabase. 2 Right click TestDatabase, then select Tasks > Manage Database Encryption... 3 Select the Properties page. Ensure that EncryptionState is set to Unencrypted, then click OK. Provided that the database (TestDatabase) was successfully decrypted, remove the TDE Database Encryption Key (TDEDEK) that was created in the database by executing the following query: USE TestDatabase DROP DATABASE ENCRYPTION KEY; Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 34

35 Turning off TDE and removing TDE setup Figure 12 Logins screen To remove the tdecredential from tde_login: 1 In Object Explorer, navigate to Security > Logins and open the properties of tde_login. 2 Select tdecredential then click Remove. 3 Click OK. To delete the tde_login: 1 In Object Explorer, navigate to Security > Logins. 2 Delete the tde_login. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 35

36 Uninstalling the Database Security Option Pack for SQL Server Figure 13 Credentials screen To delete the tdecredential: 1 In Object Explorer, navigate to Security > Credentials. 2 Delete the tdecredential. To remove the TDE Key Encryption Key (TDEKEK), execute the following query: USE master DROP ASYMMETRIC KEY WrappingKey REMOVE PROVIDER KEY; Uninstalling the Database Security Option Pack for SQL Server Note Depending on your version of Windows, you may be asked for your permission to continue with an action. If asked, click Continue. Before starting the uninstall procedure, ensure that you have decrypted any data encrypted using the SQLEKM provider on all your databases. For more information about turning off TDE on your databases and removing TDE setup, see the previous section. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 36

37 Uninstalling the Database Security Option Pack for SQL Server To uninstall the Database Security Option Pack for SQL Server from Microsoft SQL Server: 1 Remove the logincredential from the logged-in user: a b In Object Explorer, navigate to Security > Logins and open up the properties of the loggedin user. Select the logincredential then click Remove, then OK. 2 Navigate to Security > Credentials and delete the logincredential. 3 Disable and remove the SQLEKM provider: a b c d Navigate to Security > Cryptographic Providers. Right click to select the SQLEKM provider and click Disable Provider. A dialog is displayed which shows that this action was successful. Click Close. Right click to select the disabled SQLEKM provider then click Delete, then OK. 4 Navigate to Start > Control Panel > Administrative Tools > Services (or Start > Administrative Tools > Services, depending on your version of Windows). Select SQL Server (MSQLSERVER) and click Action > Stop. 5 Navigate to Start > Control Panel > Add/Remove programs (or Uninstall program, depending on your version of Windows). Select Database Security Option Pack for SQL Server then click Uninstall. 6 A dialog is displayed that asks if you want to continue with uninstalling the Database Security Option Pack for SQL Server. Click Yes. 7 A setup status screen is displayed while the Database Security Option Pack for SQL Server is uninstalled. When InstallShield has finished uninstalling the program, click Finish to complete the removal of the program from your system. 8 Navigate to Start > Control Panel > Administrative Tools > Services (or Start > Administrative Tools > Services, depending on your version of Windows). Select SQL Server (MSQLSERVER) then click Action > Start. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 37

38 Upgrading Upgrading Enhancements will be made to the Database Security Option Pack for SQL Server over time, and product upgrades made available to customers. When the time comes to upgrade your product: 1 In Object explorer, navigate to Start > Control Panel > Administrative Tools > Services (or Start > Administrative Tools > Services, depending on your version of Windows). Select SQL Server (MSQLSERVER) and click Action > Stop. 2 Uninstall the existing Database Security Option Pack for SQL Server, using the procedure described in Uninstalling the Database Security Option Pack for SQL Server on page Install the upgraded version of the Database Security Option Pack for SQL Server, using the procedure described in Installation on page 15. Note You must install the upgraded SQLEKM provider to the same directory as the previous installation. This ensures that the replacement provider files are found automatically when the Microsoft SQL Server instances are started. 4 Navigate to Start > Control Panel > Administrative Tools > Services (or Start > Administrative Tools > Services, depending on your version of Windows). Select SQL Server (MSQLSERVER) and click Action > Start. Thales Database Security Option Pack: for Microsoft SQL Server Integration Guide 38

39 Addresses Americas 2200 North Commerce Parkway, Suite 200, Weston, Florida 33326, USA Tel: or [email protected] Europe, Middle East, Africa Meadow View House, Long Crendon, Aylesbury, Buckinghamshire HP18 9EQ, UK Tel: + 44 (0) [email protected] Asia Pacific Units 4101, 41/F. 248 Queen s Road East, Wanchai, Hong Kong, PRC Tel: [email protected] Internet addresses Web site: Support: Online documentation: International sales offices: