IBM Db2® is a family of hybrid data management products offering a complete suite of AI-empowered capabilities designed to help you manage both structured and unstructured data on-premises as well as in private and public cloud environments. Db2 is built on an intelligent common SQL engine designed for scalability and flexibility.
1.1 Why use Fortanix Data Security Manager (DSM) with IBM DB2
Db2® native encryption uses a two-tier approach to data encryption. Data is encrypted with a Data Encryption Key (DEK), which is in turn encrypted with a Master Key (MK). The encrypted DEK is stored with the data while the MK is stored in a keystore external to Db2.
Db2 native encryption ensures that the DEK is never exposed outside of the encrypted database, transaction log, or backup file. There are no interfaces provided to access the DEK in either its clear text or encrypted forms. As the MK is stored in a different location from the encrypted data, the chance of the encrypted DEK being concurrently exposed with the MK used to encrypt it is very unlikely. Since the risk of the DEK being exposed is extremely low, the need to rotate it is negligible. The rotation of the MK, which is used to protect the DEK, can be done efficiently without the need to decrypt and re-encrypt the data.
The Db2 database system supports SSL, which means that a Db2 client application that also supports SSL can connect to a Db2 database by using an SSL socket. CLI, CLP, and .Net Data Provider client applications and applications that use the IBM® Data Server Driver for JDBC and SQLJ (type 4 connections) support SSL.
- Fortanix DSM
- IBM DB2
- Access to create a certificate for KMIP Server
3.0 Adding App in Fortanix Data Security Manager
- Add an app in the Fortanix DSM in an appropriate group or a new group. For instructions on how to add a group or app please refer to the DSM Getting Started Guide.
Figure 1: Create New App
- Once you have added the application, note down its App-ID by copying App UUID from the App table view by clicking the icon for “Copy UUID” as shown below. You will need this App-ID for the certificate
Figure 2: Copy UUID
If an App / Client needs to authenticate to Fortanix DSM using the only certificate, then the App ID needs to be embedded in the certificate in one of the following ways:
- Provided as the value of a custom OID in the certificate 188.8.131.52.4.1.496184.108.40.206
- Standard human-readable UUID encoding:
xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxprovided as the value of CN.
4.0 Configuration on IBM DB2
4.1 Create Folders for Certificates and Config File
- Log in to the IBM DB2 machine and log in as the DB user as shown in the following screenshot.
Figure 3: Login to IBM DB2 as a DB user
- Next, create folders so as to bifurcate the certificates and config file.
- KMIP (For Config file)
- SDKMS_Certs ( For all the certificates)
- Create a self-signed certificate and make sure that you should have the App-ID handy as we need to update the Common name for the self-signed certificate.
- Change directory to
SDKMS_Certsand run the following command.
openssl req -newkey rsa:2048 -nodes -keyout private.key -x509 -days 365 -out certificate.crt
Figure 4: Create self-signed certificate
Figure 5: Certificate generated
- Change directory to
- Now go back to the Fortanix DSM UI and change the application’s authentication method to Certificate and paste or upload the certificate that was generated in Step 3 above.
Figure 6: Upload certificate in Fortanix DSM
4.2 Updating the Certificate in Fortanix DSM
To update the certificate in the authentication method:
- Make sure you change the configuration to KMIP from default i.e. REST API.
- Now import the private key and certificate into the SSL key store, you need to combine the private key and certificate into one.
- The certificate created above is only valid for 365 days. To renew the certificate run the following command using the existing private key.
openssl req\ -key private.key \ -new \ -x509 -days 700 -out renewcertificate.crt
- Verify the private key matches the Certificate and CSR.
openssl x509 -noout -modulus -in certificate.crt | openssl md5 openssl x509 -noout -modulus -in renewcertificate.crt | openssl md5
- Once the certificate is renewed, update the certificate in the Fortanix DSM application.
4.3 Create the SDKMS-KMIP.P12 and Stashed File
Run the following command:
gsk8capicmd_64 -keydb -create -db "sdkms-kmip.p12" -pw "sdkms-kmip.pWd" -type pkcs12 -stash
In case you get an error that the
gsk8capicmd_64 command is not found; you need to export the libraries for
Re-run the above command to create
.p12 and stash file. In the following screenshot
sdkms-kmip.sth file is created.
Figure 8: Create .p12 and stash file
4.4 Add Client Cert and Key to SSL Keystore
- Add client cert and key to the SSL keystore by running the following command:
gsk8capicmd_64 -cert -add -db "sdkms-kmip.p12" -stashed -label "sdkms_app_cert" -file "sdkms.pem"
- Find the CA certificate from your Fortanix DSM installation and copy it into a file
CA.pem. Please note that if your CA certificate has a chain then the complete chain must be copied into this file. You can get the complete chain from your Fortanix DSM browser by going to your Fortanix DSM URL and then view certificates and download the certificate chain.
Since we are using https://sdkms.fortanix.com, let us get the CA Certificate from the UI.
- In the IBM shell, create the CA.pem file using the following command.
CA.pemand then paste the certificate information to give the following output.
CA.pemwill contain the intermediate+ root certificate.
Figure 9: Output of CA.pem
4.5 Import CA Certificate into SSL Keystore
Import CA Certificate into the SSL keystore by running the following command:
gsk8capicmd_64 -cert -add -db "sdkms-kmip.p12" -stashed -label "trustedCA" -file CA.pem
4.6 List Certificate in the Keystore
List certificate in your keystore to verify everything is fine by running the following command
gsk8capicmd_64 -cert -list -db sdkms-kmip.p12 -stashed
Figure 10: List certificates
Create a KMIP config file in the KMIP folder. In the following example, it is
--------------------------- VERSION=1 PRODUCT_NAME=OTHER ALLOW_KEY_INSERT_WITHOUT_KEYSTORE_BACKUP=true SSL_KEYDB=/database/config/db2inst1/SDKMS_Certs/sdkms-kmip.p12 SSL_KEYDB_STASH=/database/config/db2inst1/SDKMS_Certs/sdkms-kmip.sth SSL_KMIP_CLIENT_CERTIFICATE_LABEL=sdkms_app_cert MASTER_SERVER_HOST=sdkms.fortanix.com MASTER_SERVER_KMIP_PORT=5696 ------------------------------
Figure 11: Create a KMIP Config file
4.7 Configure a DB2 Instance to Use a Keystore
- To configure a Db2 instance to use a keystore for native encryption, you need to set two database manager configuration parameters:
- For a centralized keystore, where the key manager product uses the Key Management Interoperability Protocol (KMIP), set
KMIP", and set
keystore_locationto the absolute path and file name of the centralized keystore configuration file.
- To do this, run the following command:
db2 update dbm cfg using keystore_location /mnt/blumeta0/home/db2inst1/KMIP/kmip.cfg keystore_type kmip
Figure 12: Set keystone type and location
- To get the keystore changes to take effect, we need to restart the DB2 again.
The command to stop the DB2:
- The command to start the DB2:
Figure 13: Stop and start the DB2
- Verify that the
dbm cfgis set correctly by running the following command. Look at value of Keystore type and keystore location.
db2 get dbm cfg
Figure 14: Verify database manager configuration
4.8 Updating Certificate in IBM DB2 Keystore
- Verify the certificate in the IBM DB2 Keystore.
gsk8capicmd_64 -cert -list -db sdkms-kmip.p12 -stashed
db2inst1@2407b7a6943b SDKMS_Certs]$ gsk8capicmd_64 -cert - list -db sdkms-kmip.p12 -stashed Certificates found * default, - personal, ! trusted, # secret key ! CN=sdkms.fortanix.com ! "CN=R3,O=Let's Encrypt,C=US" ! trustedCA - sdkms_app_cert [db2inst1@2407b7a6943b SDKMS_Certs]$
- Create a new signed certificate.
gsk8capicmd_64 -certreq -recreate -db sdkms-kmip.p12 -stashed -label "sdkms_app_cert" -target new_cert_request.arm
- Sign: Send the resulting
new_cert_request.armto be signed by the original Certificate Authority (CA).
- Receive: After the signed certificate has been returned (assuming you got it back as
new_cert_signed.arm) then receive it back into your server keystore.
gsk8capicmd_64 -cert -receive -db sdkms-kmip.p12 -stashed -file new_cert_signed.arm
- Verify: Verify the new dates on the received certificate.
gsk8capicmd_64 -cert -details -label "sdkms_app_cert" -db sdkms- kmip.p12 -stashed
- Restart: For the new certificate to take effect, the Db2 server instance must be restarted.
4.9 Create an Encrypted Database
- Create an encrypted database using the following command:
db2 create db mydb1 encrypt
Figure 15: Create encrypted database
- Once you create the database you can find the Master key created in Fortanix DSM as shown below.
Figure 16: Master key created
- You can find the Activity logs in the Application tab as below.
Figure 17: Activity logs
In case you are getting any error in your environment. Then you need to troubleshoot the certificate and network-related issue so that we can communicate to the Fortanix DSM.
5.0 Rotating Master Keys in Fortanix Data Security Manager with IBM DB2
Rotating your encryption keys is part of a complete security policy. And as with passwords, how often is a controversial topic. This article is intended to give you information to make an informed decision about how and when to rotate your encryption keys. The focus is the keys that protect your data at rest and do not discuss SSL certificates.
IBM Db2 native encryption uses a 2-tier approach to data encryption where the data is encrypted with a Data Encryption Key (DEK) and the DEK itself is encrypted with a Master Key (MK). The encrypted DEK is stored with the data while the MK is stored in a keystore external to Db2.
As the master key is stored outside of the database manager, the requirement and frequency to rotate the master key depend on the type of keystore in use and the protections provided by the keystore. A local keystore file is protected by a password and operating system file permissions, however, it is owned by the Db2 Instance Owner, which is often a shared service account. In such an environment policy to rotate the master key on a regular basis would be natural. On the other extreme, master keys protected by Hardware Security Modules (HSM) require much less rotation if at all. Master keys protected by an HSM never leave the secure confines of the hardware device and strong controls exist to prevent the key from being extracted. Master keys accessed from a KMIP server fall somewhere in the middle. Strong controls exist within the KMIP server to authorize who has access to the master keys and audit their usage. However, these servers are often deployed as software running on a traditional operating system and servers and are only as secure as the environment in which they are deployed. On the other hand, there are secure HSMs offering KMIP interfaces. A key rotation schedule would be suggested by the security hardening of the KMIP server and the environment in which it is deployed.
Db2 provides routine SYSPROC.ADMIN_ROTATE_MASTER_KEY() to rotate the database master key to a new value. This operation decrypts the database DEK and re-encrypts it with the new master key.
The 2-tier approach ensures that the key used to encrypt the data, the DEK, is never exposed outside of the encrypted database, transaction log, or backup and no interfaces exist within Db2 to access the DEK. Since the MK is stored in a different location from the encrypted data, this makes concurrent exposure of the encrypted data and the MK much less likely again reducing risk. Finally, since the DEK is not exposed, there is little reason to rotate it, and rotation of the MK used to protect the DEK, can be done efficiently without the need to decrypt and re-encrypt the data itself.
5.1 Steps for Rotating Keys in DB2
- List your DB directory.
db2 list db directory
Figure 18: List DB directory
- Connect the DB to the same database.
db2 connect to MYDB1
Figure 19: Connect DB
- Check the encryption info from the below command.
db2 “select * from table(sysproc.admin_get_encryption_info())”
Figure 20: Check encryption info
- Now rotate the master key from DB2.
db2 “CALL SYSPROC.ADMIN_ROTATE_MASTER_KEY (NULL)”
Figure 21: Rotate master key
- Once the key is rotated, check on Fortanix DSM end if the Master Key is rotated.
Figure 22: Check in Fortanix DSM
You will find a new key created in Fortanix-DSM.
6.0 Backup and Restore Encrypted Database
- To take backup of the database run the following command:
db2 backup database mydb1
mydb1is the database that is encrypted with keys in Fortanix DSM.
- Move the backup file generated to the destination server.
- On the destination server, configure Fortanix DSM integration for the new db2 instance as previously described in this document from Section 3.0: “Adding App in Fortanix Data Security Manager” until Section 4.6: “Configure a DB2 Instance to Use a Keystore”
- This will be a new configuration with a new app.
- Run the following command to restore the backup of the encrypted database
db2 restore db mydb1 encrypt
- Verify that you can query the encrypted data in the restored database.
db2 list db directory
db2 connect to mydb1
db2 "select * from <table_name>"
- Run the following query to see the new master key used by the database.
db2 "select * from table(sysproc.admin_get_encryption_info())"
- Verify from the Fortanix DSM UI that the new db2 Key from the previous step is seen under the group’s security objects.
7.0 Migrating from a Local Keystore to a Centralized KMIP Keystore
If you want to migrate your Db2 local keystore to a centralized keystore that is configured for the Key Management Interoperability Protocol (KMIP), you can copy your master keys to the centralized keystore by issuing the
The following are the prerequisites:
- Create a KMIP keystore configuration file.
- Configure TLS between the DB2 instance and the centralized key manager.
The following is the procedure to migrate from a local keystore to a centralized KMIP keystore:
- Set up the centralized KMIP keystore.
- Set the
allow_key_insert_without_keystore_backupparameter to “TRUE” in the centralized KMIP keystore configuration file.
- Copy all master keys from the local keystore to the centralized KMIP by issuing the
Figure 23: Copy all Master keys
Here is an example:
db2p12tokmip -from /home/test/keystores/ne-keystore.p12 -to /database/config/db2inst1/KMIP/kmip.cfg
In the above example,
/home/test/keystores/ne-keystore.p12 is the .p12 file for the local keystore and
/database/config/db2inst1/KMIP/kmip.cfg is the config file for the KMIP Keystore.