Technical Report NSE Preinstallation Requirements and Procedures For IBM
Technical Report NSE Preinstallation Requirements and Procedures For IBM
3.2 GENERATE AND EXPORT THE KMIP SERVER PUBLIC CERTIFICATE .............................................................. 10
3.3 GENERATE A PRIVATE AND PUBLIC KEY PAIR FOR NSE ................................................................................. 11
NetApp Storage Encryption has a number of preinstallation steps that must be completed before
configuration in Data ONTAP can begin. These steps can be broken into the following main categories:
Upon completion of these preinstallation steps, refer to the storage encryption section of the document
“Data ONTAP 8.1 7-Mode Software Setup Guide” to complete setup of NSE.
BOOTARG.STORAGEENCRYPTION.SUPPORT
This bootarg is typically set during the manufacturing process. However, if the encrypted disks are not
showing up at boot time, verify the preceding bootarg is set to true.
Halt Data ONTAP and stop at the LOADER-(A,B)> prompt.
Syntax to set the variable:
LOADER-A> setenv bootarg.storageencryption.support true
kmip.init.interface is set to the Data ONTAP network interface you want to use. This interface must
be dedicated for NSE use and cannot participate in network trunking or VIF configuration.
kmip.init.ipaddr is set to the IP address of the interface in kmip.init.interface. Note that this will be
the same IP address you assigned during Data ONTAP setup.
kmip.init.netmask is the netmask for kmip.init.interface. This is the same netmask used in Data
ONTAP setup.
kmip.init.gateway is the gateway for kmip.init.interface. This is the same gateway used in Data
ONTAP setup.
Once the bootloader variables have been configured, you are ready to start Data ONTAP. The
subsequent sections provide guidance on creating SSL certificates to establish a secure communications
channel between NSE and the key manager.
Make sure to select Base-64 encoded X.509. This is the PEM format required by NSE.
You have now successfully created the public certificate from the certificate authority. This file will be
The resulting file can be found at \<tklm install root>\tivoli\tiptklmV2\products\tklm\. This file will be sent to
the CA for signing.
This step needs to be done external to the NSE system. A public and private key pair can be generated in
either Windows or UNIX using OpenSSL, but the following example shows how it’s done using OpenSSL
in Linux.
root@core-vm30:~# ls
client_private.key
Generate a certificate signing request (.csr) file from the private key. The file must be named client.csr.
The result will be a .csr file, which needs to be sent to the CA for signing. Note the preceding common
name; we will refer to it later in our steps.
You now have two files: (1) a .csr file, which is the signing request for the public certificate for NSE, and
(2) the client_private.key, which is the private key for NSE.
root@core-vm30:~# ls
client.csr client_private.key
You should now have two .csr files: one from the TKLM server (in this example the file name is
100831213458-tklm_server.csr) and one generated using OpenSSL for NSE (in this example the file
name is client.csr).
An important note for SSL certificates: Note the expiration time for all SSL certificates generated and
make sure these are in line with your certificate expiration policies. When SSL certificates expire, new
certificates will need to be generated and installed according to the procedures outlined in the following
section. Failure to replace SSL certificates before expiration could result in an inability to retrieve data off
the encrypted disks. For further information, refer to Appendix B: SSL Certificate Replacement.
Select Pending Requests and sign the .csr file by selecting the “Issue” option.
Confirm the TKLM server name under “Issued to:” This should match the common name during the CSR
request from the TLKM server. In this case we used the IP address as the common name.
Make sure to select Base-64 encoded X.509. This is the PEM format required by NSE.
Make sure the chosen certificate matches the common name specified during the creation of the csr in
OpenSSL.
Make sure to select Base-64 encoded X.509. This is the PEM format required by NSE.
5.1 IMPORT THE SIGNED TKLM CERTIFICATE BACK INTO THE TKLM SERVER
The TKLM server does not require the signed server certificate to have a specific file name format or
extension. It does not need to be renamed prior to import.
Log back into the TKLM portal and select the Welcome page.
Next we need to import the CA certificate used to sign the NSE public certificate into the TKLM server.
This might or might not be from the same CA used to sign the TKLM public certificate. In this example, we
are using the same CA to sign both certificates.
Next you need to create the client_private.pem file, which is the PEM format of the NSE private key. This
file is needed by NSE to complete the setup.
Remove the passphrase used to protect the private key (this step is optional, but is shown for
convenience).
Create the client_private.pem file by concatenating the contents of the client.pem file into the
client_private.key file.
You have now successfully created all the necessary keys and certificate files needed by NSE.
Once all files have been properly signed and created, the following three files need to be copied onto the
FAS platform, which has NSE drives installed. Make note of the path for these files. In this example
\\172.17.45.65\c$ corresponds to 172.17.45.65:/vol/vol0/.
client.pem: This file is the NSE client signed public key in PEM format. This file was generated earlier
using OpenSSL and signed by the CA.
client_private.pem: This file is the NSE client private key in PEM format. This file was generated as
one of the last steps after the client.pem file was generated.
172.17.45.116_CA.pem: This is the exported CA certificate used to sign the TKLM server public
certificate. This might or might not be the same file used to sign the NSE public certificate. In this
example, we used a single CA to sign both files.
Once you have completed this guide, you are ready to run through the NSE setup. Refer to the document
“Data ONTAP 8.1 7-Mode Software Setup Guide” and turn to the section on storage encryption to
complete the initialization and configuration of NSE.
APPENDIXES
Note: If you are running clustered Data ONTAP 8.2, the above NSE commands should be executed
at the nodeshell level. They are not available in clustershell. You can access the nodeshell in
clustered Data ONTAP by running “system node run –node nodename” at the clustershell level.
Once you are into the nodeshell, you can execute the corresponding 7-Mode NSE command.
Note: If you are running clustered Data ONTAP 8.2, the above NSE commands should be executed
at the nodeshell level. They are not available in clustershell. You can access the nodeshell in
clustered Data ONTAP by running “system node run –node nodename” at the clustershell level.
Once you are into the nodeshell, you can execute the corresponding 7-Mode NSE command.
The certificate description here (common name) is not critical. In this example, we are using the IP
address of the KMIP server, but it can also be the hostname of the KMIP server.
uuid = CERTIFICATE-a3f9ba28-ef1d-4509-b973-66f0a2ba6222
alias = tklm_server
key store name = defaultKeyStore
key state = ACTIVE
issuer name = CN=CORE-VM47-CA
subject name = CN=172.17.45.116
creation date = 8/31/10 9:34:59 PM PDT
expiration date = 8/31/11 10:06:32 PM PDT
serial number = 458389915494073329778690
uuid = CERTIFICATE-d8ec8612-5091-4611-8418-4d504e670870
alias = tklm_self_signed
key store name = defaultKeyStore
key state = ACTIVE
issuer name = CN=172.17.45.116
subject name = CN=172.17.45.116
creation date = 9/23/10 11:14:41 AM PDT
expiration date = 9/22/13 11:14:40 AM PDT
Note that the export command needs to specify the UUID and the base64 format. The output file created
is “tklm_self_signed.pem." Remember that you will need to rename this file to
<IP_Address_KMIP_SERVER.pem> prior to copying it to the NSE system.
Instead of sending the NSE CSR file to the CA, the CSR can be self-signed using the following:
core-vm30:~ # openssl x509 -req -days 365 -in client.csr -signkey
client_private.key -out client.pem
Signature ok
subject=/C=Your Country/ST=Your State/L=Your City/O=Your Company/OU=Your
OU/CN=fas2040c-
svl04.iops.eng.netapp.com/emailAddress=your_name@your_company.com
Getting Private key
core-vm30:~ #
Note that the CSR is signed using the client_private.key generated earlier and the output file is
client.pem.
Begin by selecting Server Manager from the Windows 2008 Start menu.
Select the Active Directory Certificate Services to install the CA services. You can optionally install the
Web Server (IIS) services here, but this step is optional if you want to enable Web management of the CA
server.
Install the Windows TKLM server using default settings and log into the main portal.
Finish configuring the TKLM server. The next step tells you to configure the communication ports, but it
actually will take you to the TKLM server certificate generation page.
All ports should be left at defaults. In this example, the KMIP SSL port has been changed to 6001, but the
default port of 5696 can be used as long as this value is set during “key_manager setup” during the NSE
setup process. Refer to the document “Data ONTAP 8.1 7-Mode Software Setup Guide” and locate the
section on storage encryption for further guidance.
NSE KMIP
Storage Server
System
A key exchange needs to occur between two entities, and a CA helps ensure trust between the key
exchanges. Each party creates a public (dark blue) key and a private (light blue) key to establish a secure
session for communication. The public keys are sent to the CA for signing and then exchanged between
the two parties. The CA provides a root of trust to make sure the corresponding public keys are valid and
haven’t been tampered with.
© Copyright 2013 NetApp, Inc. All rights reserved. No portions of this document may be reproduced without prior written consent of
NetApp, Inc. Specifications are subject to change without notice. NetApp, the NetApp logo, Go further, faster, and Data ONTAP are
46 NetApp Storage Encryption:
trademarks Pre-installation
or registered trademarks ofRequirements
NetApp, Inc. inand
the Procedures
United States and/or other countries. Microsoft and Windows are
registered trademarks of Microsoft Corporation. UNIX is a registered trademark of The Open Group. Linux is a registered trademark
of Linus Torvalds. All other brands or products are trademarks or registered trademarks of their respective holders and should be
treated as such.TR-3954-0811