SecureData 6.9.7 Installation
SecureData 6.9.7 Installation
SecureData 6.9.7 Installation
The only warranties for products and services of Micro Focus and its affiliates and licensors ("Micro Focus") are as may be set
forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained
herein. The information contained herein is subject to change without notice.
Except as specifically indicated otherwise, this document contains confidential information and a valid license is required for
possession, use or copying. If this work is provided to the U.S. Government, consistent with FAR 12.211 and 12.212,
Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to
the U.S. Government under vendor's standard commercial license.
Trademark notices
Third-party brand and product names (including logos and icons) mentioned in this manual may be trademarks or registered
trademarks of their respective companies and are the sole property of their respective owners.
The following table identifies changes to this guide for installing the SDA 6.9.7 release.
Location Description
Chapter 1, “Install SecureData Appliance” > “Hardware If you are installing on a VM, this release supports VMware
Requirements” on page 1-2 ESXi Server 7.0.
Chapter 1, “Install SecureData Appliance” > “Installing and This release supports the following HSMs for use with
Configuring the Appliance with an HSM” on page 1-6 SecureData Appliance:
Chapter 2, “Configure SecureData Appliance” > “Configuring The default Time Zone setting is Etc\UTC.
the Time Zone” on page 2-12
The System clock uses UTC option is enabled by default.
This setting configures the system to use RTC time in UTC
and to automatically maintain time zone changes and
daylight savings time adjustments.
These settings apply for new installations.
Chapter 2, “Configure SecureData Appliance” > “Post-Install This section provides links to information you can use to
Configuration Options” on page 2-25 configure additional functionality, as appropriate for your
environment and business needs.
Chapter 3, “Additional Configuration Options” > “Enable or SecureData supports caching of key requests from Simple
Disable Caching for Simple API Key Requests” on page 3-1 API. You can enable or disable the Simple API memory cache
in the config.py file. It is enabled by default.
Chapter 3, “Additional Configuration Options” > “Configure You can configure a Syslog client on the Appliance host with
Log Forwarding for Syslog Using TCP with TLS” on page 3-3 settings that will securely forward logs from SDA localhost to
a remote Syslog host by using TCP with TLS. Enable Syslog
logging settings for localhost in the Management Console
separately for the Key Management Service, Web Service,
PIE Service, and Console Service. The Syslog client and
Syslog logging are not configured by default.
Chapter 3, “Additional Configuration Options” > “Configure If the config.py file for an existing system had custom
SSL Protocols for TLS 1.3 and TLS 1.2” on page 3-12 settings for SSL protocols, the custom settings still apply
after upgrading the system. You can modify custom settings
in the config.py file to support TLS 1.3 and TLS 1.2 SSL
protocols.
Chapter 3, “Additional Configuration Options” > “Configure If the config.py file for an existing system had custom
Strong SSL Ciphers for TLS 1.3 and TLS 1.2” on page 3-14 settings for Strong SSL Ciphers, the custom settings still
apply after upgrading the system. You can modify custom
settings in the config.py file to support Strong SSL Ciphers
for TLS 1.3 and TLS 1.2.
Chapter 3, “Additional Configuration Options” > “Configure The Time Zone settings for an existing installation are not
Time Zone and System Clock to Use UTC” on page 3-17 modified during the upgrade. To use UTC and have
automatic time management provided on an appliance,
modify its values for Time Zone (Etc/UTC) and the "System
clock uses UTC" check box (enabled).
Chapter 4, “Appliance Operations” on page 4-1 This section provides steps for common operational tasks to
manage SecureData appliances.
Chapter 6, “Upgrade SecureData Appliance” > “Supported Voltage SecureData 6.9.7 supports direct upgrade from an
Upgrade Paths” on page 6-1 existing 6.8.2 or 6.9.x installation to Version 6.9.7. Interim
version-to-version upgrades might be required for releases
prior to 6.8.2.
Chapter 6, “Upgrade SecureData Appliance” > “Upgrade Before you run an upgrade script, ensure that your existing
Prerequisites” on page 6-1 SDA installation meets the prerequisites for upgrade in this
section.
Chapter 6, “Upgrade SecureData Appliance” > Blockers for During the upgrade process, Voltage SecureData checks for
Upgrade > “Blockers for Upgrades to SDA 6.9.7” on page 6-3 conditions in your existing system that are no longer
supported and blocks the upgrade, such as mixed common
names for key numbers in a key rotation group, regular
expression format Mask settings, and an Authorization
Token Secret for HMAC SHA1 authorization. Remove or
modify the settings for discovered issues before upgrading.
Chapter 6, “Upgrade SecureData Appliance” > “Upgrade During the upgrade to SecureData 6.9.7, new default
Notices” on page 6-6 settings will not replace customizations you have made to
the config.py file or time settings for the existing installation.
You can update your settings after the upgrade, according to
your business needs.
Chapter 6, “Upgrade SecureData Appliance” > “Upgrading After you back up your existing system, ensure that you
Version 6.8.2 or 6.9.x to Version 6.9.7” on page 6-8 close the Management Console before you run the upgrade
script. Closing the browser deletes the old CSRF (Cross-Site
Request Forgery) token, ensuring that a fresh token is
generated when you log in after upgrading.
Chapter 6, “Upgrade SecureData Appliance” > “Post- This section provides links to information you can use add
Upgrade Configuration Options” on page 6-9 additional functionality or to modify your custom settings
after upgrade, as appropriate for your environment and
business needs.
This section describes how to install the Voltage SecureData Appliance software. The software
can be installed on any server that meets the hardware requirements.
The installation process installs the following Voltage SecureData Appliance components:
Voltage SecureData Management Console
See the Voltage SecureData Administrator Guide or the Management Console Help for
information about this component.
Voltage SecureData Key Management Server
See “Key Management” in the Voltage SecureData Administrator Guide or the
Management Console Help for information about this component.
Voltage SecureData Web Service Server (REST API and SOAP API)
See “Web Service” in the Voltage SecureData Administrator Guide or the Management
Console Help for information about this component.
See the Voltage SecureData REST API Developer Guide for information about the REST
API interface.
See the Voltage SecureData SOAP API Developer Guide for information about the
SOAP API interface.
Voltage SecureData Web Front End Server (sometimes referred to as Page-Integrated
Encryption (PIE))
See “Page-Integrated Encryption” in the Voltage SecureData Administrator Guide or the
Management Console Help for information about this component.
See the Voltage SecureData Web Supplement in the Voltage SecureData Host SDK
documentation for additional information about PIE configuration and use. After you have
installed and configured the appliance, use the Voltage SecureData Management Console to
configure the server components. The Management Console Help and the Voltage SecureData
Administrator Guide contain information and instructions for configuring your system.
Voltage SecureData clients, such as the Voltage SecureData Simple API, are installed separately
on a client machine. Refer to the documentation for the specific product for details. For
information about supported SecureData clients, see “Voltage SecureData Clients” in the
Voltage SecureData Appliance Architecture Guide.
NOTE: If you purchased Voltage SecureData Appliance for AWS, see the Voltage SecureData for AWS
Installation Supplement for information on AMI instantiation.
If you purchased Voltage SecureData Appliance for Azure, see the Voltage SecureData for Azure Installation
Supplement for information on VHD Blob instantiation.
Hardware Requirements
Make sure that your server meets the following requirements before you install the Voltage
SecureData Appliance software.
Ability to load an ISO image containing the operating system, such as a physical or
virtual DVD-ROM drive.
If you are installing on hardware, use a DVD drive (internal or external).
If you are installing on a VM, use a real or virtual DVD-ROM or a mounted ISO image.
1G Ethernet Network Interface Card (NIC)
A hardened Linux-based operating system is loaded from the Voltage-provided ISO image file.
CAUTION: Installing the Voltage SecureData Appliance software from disk reformats the machine’s hard
drive, thus deleting all data and the operating system. There is no way to recover deleted data or software once
the installation begins.
1. Before installing the Voltage SecureData Appliance software, make sure that the
hardware time is set correctly on the machine.
2. Insert the Installation DVD into the drive and boot the system.
After the installation process is complete, the next step is to log in and change the Appliance
passwords for the root and admin users.
2. Use the arrow keys to scroll through and read the license agreement.
3. Navigate to the I agree button, and press Enter to accept the license agreement.
You are prompted to change the root password.
Type a new root password for the appliance, then press Enter. The SecureData
Appliance root user password must be 8 to 256 alphanumeric characters and contain a
combination of letters and numbers. The password is case-sensitive. Your passwords
serve as a security check to protect the appliance. Therefore, it is important to choose
passwords that are not easily guessed. Treat the root password with the highest level of
security.
4. Type the same password again, then press Enter to confirm the selection.
A message indicates that the password was successfully updated.
6. Type a new admin password for the appliance, and press Enter.
The SecureData Appliance admin user password must be 8 to 256 alphanumeric
characters and contain a combination of letters and numbers. The password is case-
sensitive. Your passwords serve as a security check to protect the appliance. Therefore,
it is important to choose passwords that are not easily guessed. Treat the admin
password with the highest level of security.
Refer to the appropriate HSMs Supplement to help ensure that you have configured
SecureData to work with your HSM properly. For information about how HSMs provide an
additional level of security in managing SecureData encryption keys, see the “HSMs and
SecureData” section in the supplement.
NOTE: You can use multiple HSMs of the same type in a cluster. You cannot configure a single cluster to use
both Atalla HSMs and nShield HSMs.
CAUTION: To fully secure access to the SecureData Appliance, you must use a CA signed certificate.
After you have staged the CA signed certificate, you apply it using the Appliance menu. See
Rebooting and Shutting Down Your Server (page 2-20) for instructions.
This chapter describes how to configure the initial settings on the Voltage SecureData
appliance, using the Voltage SecureData Appliance Menu. It also describes how to access the
Voltage SecureData Management Console in order to complete the configuration.
You must complete a set of configuration steps on the Appliance Menu in the following
sequence:
2. Set the default router IP address. See “Setting a Default Router IP Address (Required)”
on page 2-5.
3. Configure DNS and Hostname settings. See “Configuring the DNS and Hostname
Settings (Required)” on page 2-5.
4. Update the Splunk license. See “Configure Event Viewer License” on page 2-14.
5. Add the IP addresses of all of your servers to the /etc/hosts file. See “Editing the /etc/
hosts File” on page 2-5. Note that this step is only required if your host name does not
resolve in DNS.
6. Configure the time and date. See “Configuring the Time Zone and NTP Servers
(Required)” on page 2-10.
7. Initialize services for the Management Console. See “Initializing Services” on page 2-19
for instructions.
NOTE: If you are setting up a system with multiple servers, this step configures one of the servers
as the Management Console. The other servers must be set up as remote hosts. See Enabling a
Multi-host Configuration (page 2-15) for information about setting up remote hosts.
After you complete the required steps on the Appliance Menu, you can log in to the
Management Console to complete additional configuration steps and begin using the software.
See “Using the SecureData Management Console” on page 2-22 for details.
Use the Appliance admin account to log in to the Appliance directly or remotely through SSH,
after the port (10022 by default, but is configurable) has been enabled for SSH to allow remote
access. See “Enabling or Disabling SSH” on page 2-7 for details. If you access the Appliance
remotely, set the character set translation on your SSH client (such as PuTTY) to UTF-8.
The admin account is used to perform all administrator functions on the Voltage SecureData
Appliance. If you log in as the root user, a shell prompt displays instead of the Appliance Main
Menu.
CAUTION: Log in as the root user only if you are following instructions provided in a Voltage SecureData
document, or troubleshooting with the help from a representative of Voltage. Treat both the admin and root
passwords with the highest level of security.
To allow an additional Linux account to access the Appliance over SSL, edit the only line in the
/etc/security/access.conf file to include the new account name. Note that during a
future upgrade, it is possible that any change you make to this file might get overwritten.
1. Use the Up or Down arrow to highlight the menu option that you want to select, or type
the letter for the menu option that you want to select.
2. Press Enter or use the tab key to highlight OK, and then press Enter.
You can also use the following Voltage SecureData Appliance Menu navigation methods:
From a secondary menu, use the Tab key to highlight Back, or press F12 to return to
the previous menu.
Press F12 to quit and exit the Voltage SecureData Appliance Main Menu.
To configure the default router, choose d. Set Default Router IP Address, and press
Enter. See “Setting a Default Router IP Address (Required)” on page 2-5 for instructions.
To edit the /etc/hosts file directly, choose e. Edit /etc/hosts File, and press Enter. See
“Editing the /etc/hosts File” on page 2-5 for instructions.
To configure the firewall and remote access parameters, choose f. Configure Firewall/
Remote Access. See “Configuring Firewall and Remote Access” on page 2-6 for
instructions.
3. Enter the IP address associated with the host name that you entered in step 2 of
Configuring the DNS Settings.
By default, the Voltage SecureData Appliance listens for inbound and outbound
encryption requests on this IP address.
6. Press Enter to add another IP address or use the arrow key to highlight No, and press
Enter if you do not want to add another IP address.
A list of the IP addresses that you entered displays at the top of the IP Address
Configuration Menu.
NOTE: To change an IP address or netmask value, you must add the updated value for both, then
delete the existing value.
To delete an IP address:
1. From the IP Address Configuration Menu, use the arrow keys to highlight b. Delete
Existing IP Addresses and then press Enter.
2. Select the IP address you want to delete using the arrow keys, then press OK.
NOTE: If only one IP address is configured, you cannot delete it. You must add a new IP address so
that the one you want to delete is no longer the only one.
1. From the Network Configuration Menu, use the arrow keys to highlight d. Set Default
Router IP Address, and press Enter.
3. Press OK.
The Default Router IP Address is updated and the Network Configuration Menu displays.
1. From the Network Configuration Menu, use the down arrow key to highlight
c. Configure DNS and Hostname, and press Enter.
2. Enter the fully qualified host name, for example, voltage.<yourdomain>. Press the Tab
key to move the cursor to the Primary Name Server IP field.
3. Type the IP address of your Primary Name Server and then press Enter.
You can enter up to three Name Server IP addresses. Press Tab to skip the IP address.
4. When you have entered the IP addresses, press Enter to highlight OK.
Your changes are applied and you return to the Network Configuration Menu.
1. From the Network Configuration Menu, use the arrow keys to highlight e. Edit /etc/
hosts File, and press Enter.
2. When prompted to select the editor you want to use, press either Vi or Emacs to use
that editor.
1. From the Network Configuration Menu, use the arrow keys to highlight f. Configure
Firewall/Remote Access, and press Enter. The Firewall/Remote Access Menu
displays. From this menu you can set the following on your server:
Enable or disable SSH (SSH is disabled by default)
Enable or disable SSH Root Login (SSH for root login is disabled by default)
Enable or disable Single SSH Connection Per User
Enable or disable ICMP Ping
Enable or disable Remote Access to the Management Console
IMPORTANT: Effective in SecureData 6.9.6, less secure SSH algorithms are no longer supported. Connection
requests from clients using weak SSH algorithms may fail. For a list of deprecated algorithms, see the Voltage
SecureData 6.9.6 Release Notes.
1. From the Firewall/Remote Access Menu, use the arrow keys to highlight a. Enable/
Disable SSH, and press Enter.
3. If you enable SSH, enter the port you want to listen on, and press Enter.
1. From the Firewall/Remote Access Menu, use the arrow keys to highlight b. Enable/
Disable SSH Root Login, and press Enter.
The admin account connection using the Web Console or Remote Console (that is, not SSH
connections) is included in this count. For example, if the user admin has an open connection
through the Web Console, the user admin cannot concurrently SSH into the system.
NOTE: This setting applies to the current machine only. Enable on each remote host for system-wide
coverage.
1. From the Firewall/Remote Access Menu, use the arrow keys to highlight c. Enable/
Disable Single SSH Connection Per User, and press Enter.
If a connection timeout has been set previously, select Yes at the prompt shown below
to enable.
If a connection timeout has not been set previously, select Yes at the prompt shown
below to enable. A default timeout of 45 minutes is set for the connection. You can
change this timeout. See “Set SSH Connection Timeout” on page 2-8.
6. Verify the SSH connection timeout is enabled by running the following commands:
root@voltage-pp-0000 ~]# grep "ClientAliveInterval" \
/etc/ssh/sshd_config
ClientAliveInterval 300
ClientAliveCountMax 0
#ClientAliveInterval 300
#ClientAliveCountMax 0
export TMOUT=600
#export TMOUT=600
1. From the Firewall/Remote Access Menu, use the arrow keys to highlight d. Enable/
Disable ICMP Ping, and press Enter.
1. From the Firewall/Remote Access Menu, use the arrow keys to highlight e. Enable/
Disable Remote Access To Management Console, and press Enter.
2. Select Yes to enable or disable Management Console access, and press Enter.
All time configuration is done from the Time/Date Configuration Menu. To access this menu,
from the Main Menu, choose b. Configure Time/Date.
2. Enter the fully qualified host name or IP address for the NTP server. You can enter up to
three servers.
3. Press Tab twice to move to the OK button and then press Enter.
4. Use the Tab key to highlight Back and then press Enter to return to the Main Menu.
5. To have your server get its time from the NTP server, from the Time/Date
Configuration Menu, choose c. Set Time/Date from NTP Server.
CAUTION: If you disable (clear) the “System Clock uses UTC” check box, you are configuring the
system clock to use RTC time in the local time zone. You must use external facilities to maintain time
zone changes and daylight savings time adjustments.
2. Press Tab twice to move to the OK button, and press Enter to apply the settings.
Depending on whether services have been initialized for Single Server Deployment, you
see the following response:
If the services have not yet been initialized, you return to the Time/Date
Configuration Menu. If you disabled the “System Clock uses UTC” check box, a
Warning message displays about using RTC time in the local time zone. Read the
message, then press Enter to return to the Time/Date Configuration Menu.
Your Time Zone settings have been applied locally. The settings will be used during
the subsequent initialization of services and registration of remote hosts.
Skip Step 3, and continue with configuring your system.
If the services are already initialized, a message displays to identify additional steps
required to effect the changes in the Management Console and remote hosts. If you
disabled the “System Clock uses UTC” check box, the confirmation message
includes a Warning message about using RTC time in the local time zone. Read the
message, then press Enter to return to the Time/Date Configuration Menu.
Your Time Zone settings have been applied locally. Continue with Step 3 to
complete the changes for your Time Zone settings.
3. If services have already been initialized for Single Server Deployment, you must do the
following to effect the changes for the Management Console and remote hosts:
a. Restart the Management Console for the new Time Zone settings to take effect.
b. Re-register any remote hosts in your system. For information, see “Hosts Overview”
in the Voltage SecureData Services Administrator Guide.
Changing Passwords
To keep your server secure, you can change the password for the Management Console and for
access to the Appliance Menu.
1. Log in to the Voltage SecureData Appliance with the user name admin.
2. From the Voltage SecureData Appliance Main Menu, choose c. Configure Passwords.
The Password Configuration Menu displays, as shown in Figure 2-5.
If you are upgrading a version of SecureData purchased prior to Dec. 28, 2020, you can
continue to use your existing Splunk license and skip this step.
2. From the Voltage SecureData Appliance Main Menu, choose d. Configure Event
Viewer License.
While more flexible than a single-server system, a multi-host environment has additional issues
to consider:
Configuration files - See “Management Console Configuration Files” on page 2-16 for
details.
Clock skew - See “Clock Skew” on page 2-16 for details.
In a multi-host environment, the Management Console, Key Management Server, Web Service
Server, and SecureData Web (Page-Integrated Encryption (PIE)) Server can each be placed on
separate hardware. To allow for redundancy, you can have multiple instances of each type of
component, although only one instance of the Management Console component can be active
at any particular time. Servers that run the Key Management Server and/or the Web Service
Server and do not include a Management Console are called remote hosts.
1. Install the Voltage SecureData software on each server and complete the required steps
on the Appliance Menu for each server.
2. Choose one of the servers to host the Management Console, then Initialize that server
by following the procedure in “Initializing Services” on page 2-19.
3. Verify that the Management Console service is enabled and running on that server. See
“Initializing Services” on page 2-19 to learn how to view service status.
5. Log in to the Voltage SecureData Management Console to register each remote host.
See the section on “Adding Hosts” in the Voltage SecureData Administrator Guide for
details.
You can view the status of all of your servers on the Home page of the Management Console.
The server hosting the Management Console also acts as the event aggregator. This means
that you can view events for all servers in a multi-host configuration using the Events tab of
the Management Console.
NOTE: Even though events for all servers can only be viewed on the active Management Console, the Event
collection software is installed and running on all of the remote hosts.
The Management Console checks every 60 seconds for any servers that are waiting for their
access keys. During this time, the server appears unresponsive to the clients or a loadbalancer.
After the server has accessed its configuration file and is able to respond to requests, the ports
are opened and requests can be routed to the server.
Clock Skew
Clock skew can be an issue in a multi-host environment. Various machines in your environment
may have different clock settings. If you are using a self-signed certificate that is saved at one
time, it might not yet be valid on another machine in your node because its time is set
differently. In this case, a registration error is generated because the certificate is not yet valid.
For example, if the Management Console time is two hours ahead of the remote host time, you
might encounter registration errors. In this situation, if you attempt to register a remote host, a
registration error occurs. In this situation, you can de-register the remote host, reset the clocks
on both systems and re-register the remote hosts.
It is best practice to keep all servers in sync as closely as possible using NIST time servers
available on the Internet.
2. From the Voltage SecureData Appliance Main Menu, choose e. Host Registration. The
Host Registration Menu displays, as shown in Figure 2-6.
NOTE: Host registration passwords can be created only on servers where no districts are
configured, and there can be only one registration password at a time.
4. In the confirmation window, use the Tab key to highlight OK and then press Enter.
When you create the registration password, the Management Console on this server is
automatically disabled.
To view your current registration password, choose b. View Current Registration
Password.
5. To complete the registration configuration, you must log in to the active Management
Console, which is on a separate server.
For more information about logging into the Management Console, see Using the
SecureData Management Console (page 2-22).
6. On the Management Console, navigate to the System > Hosts tab, then click New Host
to add the host and provide its registration password to complete the host registration.
For instructions, see “Adding Hosts” in the Voltage SecureData Administrator Guide or
the Management Console Help.
4. In the confirmation window, use the Tab key to highlight Yes and then press Enter.
To enable, disable, or restart individual services on your server, see Enabling, Disabling, and
Restarting Services (page 2-20).
Initializing Services
To view the service status and initial services for a single-server configuration, or for the server
that hosts the Management Console in a multi-host configuration:
1. From the Main Menu, choose f. Configure Services. The Service Management Menu
displays, as shown in Figure 2-8.
2. To view the current service status on this server, choose a. View Service Status. The
service status displays.
5. Use the Tab key to highlight OK, and then press Enter.
At the prompt, enter the password to be used for the Management Console admin user,
then re-enter that password. The Management Console admin password must be 8 to
256 alphanumeric characters and contain a combination of letters and numbers. The
password is case-sensitive. Your password serves as a security check to protect the
SecureData deployment. Therefore, it is important to choose passwords that are not
easily guessed.
1. From the Main Menu, use the down arrow key to highlight f. Configure Services.
3. To enable disable or restart any services, use the down arrow key to highlight the
service you want to set.
4. Use the down arrow key to highlight the action you want to take.
5. Use the Tab key to highlight Yes and then press Enter.
1. From the Main Menu, choose g. Manage Appliance. The Appliance Configuration
Menu displays as shown in Figure 2-9.
Figure 2-9 Appliance Configuration Menu for Reboot or Shut Down Options
3. If you are applying a staged CA signed certificate for Management Console services,
choose c. Apply Management Console Certificate.
CAUTION: To fully secure access to the SecureData Appliance, you must use a CA signed
certificate.
See the Voltage SecureData Integration Supplement for Atalla AT1000 HSMs for information
about how to enable Atalla HSMs to work with the Voltage SecureData Appliance, as well as
configuration steps to be completed on both the Appliance and Management Console.
By default, remote access to the Management Console is enabled for all IP addresses. You can
connect from any machine using the instructions that follow. Once you are connected, you can
restrict access using the instructions in the following section.
1. Start a web browser and enter the URL, either the Voltage SecureData Appliance IP
address that you entered in Configuring the IP Addresses (Required) (page 2-4), or the
host name that you entered in Configuring the DNS and Hostname Settings (Required)
(page 2-5):
https://<Hostname>:8443/console
https://<IPaddress>:8443/console
2. Log in the first time with user name=admin and the password that you set in Initializing
Services (page 2-19).
After you log in to the Management Console, you can navigate to the Administration
tab to change the Management Console password and add other administrators.
See the Getting Started topic in the Management Console Help for instructions on completing
the configuration of your Voltage SecureData Appliance.
To allow only the machine with IP address, 172.16.5.14, enter the IP Address as
172.16.5.14.
4. Click Save.
Password Lockout
The Management Console is configured by default to lock out users when they fail at password
entry five times. They remain locked out for 30 minutes. You can change the defaults by editing
the settings.py file.
# Set variable for Maximum allowed invalid login attempts, value must be greater
than zero
MAX_ALLOWED_LOCKOUT_ATTEMPTS = 5
# Set variable to set lockout duration in seconds, value must be greater than
zero
LOCKOUT_DURATION = 1800
3. Restart the Management Console service. See “Enabling, Disabling, and Restarting
Services” on page 2-20.
This chapter describes additional configuration options for the Voltage SecureData Appliance.
Enable or Disable Caching for Simple API Key Requests
Configure Log Forwarding for Syslog Using TCP with TLS
Configure SSL Protocols for TLS 1.3 and TLS 1.2
Configure Strong SSL Ciphers for TLS 1.3 and TLS 1.2
Configure Time Zone and System Clock to Use UTC
In SecureData Appliance 6.9.7 (or later), you can enable or disable the Simple API memory
cache for key requests for an Appliance by adding the
"ENABLE_SIMPLE_API_MEMORY_CACHE" parameter in the config.py file. If this parameter is
missing, set to None, or set to a non-boolean value, the "enableSimpleAPIMemoryCache"
setting defaults to "true".
Example
The following example of the config.py file shows the
ENABLE_SIMPLE_API_MEMORY_CACHE parameter added and set to True:
# Enable/Disable Simple API Key Cache. Value must be either True or False.
ENABLE_SIMPLE_API_MEMORY_CACHE = True
4. In the Appliance Menu, restart the Management Console service to apply the change.
See “Enabling, Disabling, and Restarting Services” on page 2-20.
6. Verify that the change is in effect by verifying the value shown in the following locations:
Find the event "New_EnableSimpleAPIMemoryCache=" in the /opt/vssoa/
logs/audit.log file, and verify the value.
Example
YYYY-MM-DD HH:MM:SS, ms
CEF:0|Voltage|SOA|6.9.7|16|UpdateSettings|0|src=127.0.0.1 tenant=Default
Current_EnableSimpleAPIMemoryCache=false
New_EnableSimpleAPIMemoryCache=true shost=sdatest.int
Example Event
This usage requires a Syslog host in your environment to receive the forwarded events using
TCP. By default, the Syslog client directs events to /var/log/messages on the Server host.
NOTE: This section refers to Syslog running on the Appliance as the Syslog client. The Syslog host is the
target location for the forwarded logged events.
To enable SecureData to send files over TCP, you must configure the Syslog client with the IP
address (or FQDN) and port (default 6514) of the target Syslog host, and enable TCP mode for
communications to the host. In the Management Console, enable Syslog for each SecureData
service according to your needs: Key Management Service, Web Service, PIE Service, and
Console Service.
In the Management Console, you enable Syslog and specify “localhost” as the Syslog host. On
Appliances where the service is enabled, the service sends events by using UDP to the local /
var/log/messages location on the Appliance by default. If the Syslog client is configured and
running, the Syslog client forwards the service’s events to its configured target Syslog host by
using TCP. This configuration ensures secure and reliable transmission using the TCP protocol
with TLS over the network to the remote Syslog host.
CAUTION: By default, if you specify the remote Syslog host’s IP address (or its FQDN) directly in the
Management Console UI, SecureData sends the service events over the network using UDP (which is not
secure).
If multiple services are deployed on an Appliance, logs are forwarded for the Syslog-enabled
services where the Syslog host is set to “localhost”.
The RSyslog GnuTLS logging utility is pre-installed as the Syslog client for the Appliance:
rsyslog-gnutls-8.24.0-57.el7_9.3.x86_64.rpm
SecureData provides the following template file that provides a basic functional example to
configure the Syslog client for secure log forwarding:
/etc/rsyslog.d/client-tls.conf.template
Use the example to create a configuration file for the Syslog client that specifies configuration
values related to forwarding logs using TCP with TLS from SDA to your Syslog host. You can
also configure custom Syslog settings in the file. The Syslog client will forward logs to the
remote Syslog host and port that you specify in this file.
To set up log forwarding through TLS to a Syslog host, you must do the following:
Example
For a Syslog host running RSyslog, the location and filenames for certificate files might
be:
/etc/pki/rsyslog/ca.pem
/etc/pki/rsyslog/server-cert.pem
/etc/pki/rsyslog/server-key.pem
Obtain a copy of the CA certificate that you will use for server/client validation. You will
copy the CA certificate to each SDA that will send events to the Syslog host. Ensure that
the files are readable by the root user.
Example
To continue the example above, you will copy the certificate file /etc/pki/rsyslog/
ca.pem to the /etc/pki/rsyslog/ca.pem location on each SDA that will send
events to the Syslog host.
Modify permissions for the certificate file by running the following command to ensure it
is readable by the root user:
chmod 400 /etc/pki/rsyslog/*.pem
Ensure that the Syslog host software is running and working properly. The commands
you use depend on the software you use for the Syslog host.
Example
For a Syslog host running RSyslog, run the following commands as the user root on the
Syslog host.
To check status, run:
systemctl status rsyslog
When your Syslog host and network are configured and working properly, continue with Copy
CA Certificate from Syslog Host.
2. Obtain a copy of the CA certificate used by the target Syslog host server.
NOTE: The path and filename you use for the CA certificate from the Syslog host is configurable,
but it must use the .pem extension. Ensure that modify the value for the global parameter for the
CA file in the /etc/rsyslog.d/<your-syslog-client-name>.conf configuration file for
the Syslog client:
DefaultNetStreamDriverCAFile="/etc/pki/rsyslog/ca.pem"
Ensure that you adjust any related commands for managing the Syslog client, according to the path
and filename you use.
4. Modify permissions for the copied CA certificate file to make it readable by the root
user. Run the following command:
chmod 400 /etc/pki/rsyslog/ca.pem
NOTE: Repeat the instructions to configure a Syslog client on each SDA host where you want to enable
Syslog log forwarding using TCP with TLS.
1. On the Appliance acting as the root user, rename the Syslog configuration template file
(/etc/rsyslog.d/client-tls.conf.template) to /etc/rsyslog.d/client-
tls.conf.
There is no restriction on file name, other than the requirement to use the .conf file
extension. The .conf file must be located in the /etc/rsyslog.d/ folder to be read
by the Syslog client. The /etc/rsyslog.conf master configuration file imports its
settings from this file.
CAUTION: The basic configuration template can be used for testing and non-production, but
should not be used as-is for production. For production environments, Voltage recommends that you
configure a more secure authentication mode.
# The only warranties for products and services of Micro Focus and its affiliates
and licensors ("Micro Focus") are set forth in the express warranty statements
accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. Micro Focus shall not be liable for
technical or editorial errors or omissions contained herein. The information
contained herein is subject to change without notice.
global(
DefaultNetStreamDriverCAFile="/etc/pki/rsyslog/ca.pem"
)
*.* action(
type="omfwd"
StreamDriver="gtls"
StreamDriverMode="1" # run driver in TLS-only mode
StreamDriverAuthMode="anon" # "anon" is not recommended
# StreamDriverAuthMode="x509/name"
# StreamDriverPermittedPeers="<HOST CN>"
target="<HOST>" port="<PORT>" protocol="tcp"
)
3. Replace variables <HOST> and <PORT> with values for the target Syslog host. Port 6514
is the default TCP port for Syslog.
Example
The following example shows a host value of 10.10.10.214 and port value of 6514 for
the Syslog host server.
# The only warranties for products and services of Micro Focus and its affiliates
and licensors ("Micro Focus") are set forth in the express warranty statements
accompanying such products and services. Nothing herein should be construed as
constituting an additional warranty. Micro Focus shall not be liable for
technical or editorial errors or omissions contained herein. The information
contained herein is subject to change without notice.
global(
DefaultNetStreamDriverCAFile="/etc/pki/rsyslog/ca.pem"
)
*.* action(
type="omfwd"
StreamDriver="gtls"
StreamDriverMode="1" # run driver in TLS-only mode
StreamDriverAuthMode="anon" # "anon" is not recommended
# StreamDriverAuthMode="x509/name"
# StreamDriverPermittedPeers="<HOST CN>"
target="10.10.10.214" port="6514" protocol="tcp"
)
4. In the client-tls.conf file, customize the other settings to meet your needs. For
information, refer to official RSyslog Documentation here:
https://www.rsyslog.com/doc/v8-stable/configuration/modules/omfwd.html
If you used a custom path or file name for the CA certificate file in Copy CA
Certificate from Syslog Host, ensure that you modify the value for the global
parameter DefaultNetStreamDriverCAFile to match.
For more secure authentication, Voltage recommends that you modify the
StreamDriverAuthMode parameter from "anon" to a more secure authentication
mode, such as "x509/fingerprint" or "x509/name".
CAUTION: The anon option is typically used in testing or non-production environments, and
will not authenticate to connect. For production environments, Voltage recommends that you
configure a more secure authentication mode.
Ensure that the certificate with a CN matches how clients will access the Syslog host.
For example, if the client uses an IP address to reach the server, then the CN on the
certificate used by the server must be the same IP address. If the client uses DNS to
reach the server, then the CN on the certificate used by the server must be the same
DNS.
Example Output
In this output, the /etc/rsyslog.conf master configuration file imports its settings
from your custom configuration file that ends with .conf the /etc/rsyslog.d/
folder, such as /etc/rsyslog.d/client-tls.conf.
7. Check that Syslog is running by running the following command as user root:
systemctl status rsyslog
Example Output
8. Verify that logs are being forwarded to the right place. As the user root, run the
logger command to send a test event.
logger "this is a test"
9. Repeat these steps for each Appliance where you want to enable Syslog log forwarding
using TCP.
10. Continue with Configure SecureData Services for Syslog Log Forwarding.
To enable log forwarding for a service, go the service’s logging settings, configure Syslog
output for the Syslog host “localhost”, and then deploy the configuration.
2. Navigate to the logging configuration page for each SecureData service that you want
to send to Syslog.
Table 3-1 identifies pages in the Management Console where you can configure
logging for each service’s audit log and the Management Console’s console log. See the
specified section in the Voltage SecureData Appliance Administrator Guide or
Management Console Help for configuration details.
Key Management > System Settings See “Key Management System Settings”.
Web Service > System Settings See “Web Service System Settings”.
NOTE: If you select File and Syslog, events are also sent to a specified audit or console log file.
Events sent to the default log files are viewable in the Events tab.
b. In the Syslog host field, specify localhost as the target Syslog host.
For Appliances where this service is deployed, specifying localhost enables events
to be sent using UDP to the local /var/log/messages location on the Appliance.
When the Syslog client on the Appliance is configured and running, the client
securely forwards events to its specified target Syslog host by using TCP with TLS.
If the Syslog client on the Appliance is not configured or is not running, the events
are not forwarded to the remote Syslog host.
CAUTION: Do not specify the IP address of the remote Syslog host in this field. By default,
SecureData will send events over the network using UDP (which is not secure), even if the Syslog
client is configured and running on Appliances where the service is deployed.
4. On the Console Home page, deploy the modified settings. Wait until the deployment is
completed before continuing.
5. On the Syslog host, view the Syslog log output to verify events are being forwarded. Run
either of the following commands from the Syslog host as the root user:
tail -f /var/log/messages
tail /var/log/messages
Use the -f option to continue to monitor the file and display new messages as they come
in.
The following SDA services are configured to accept inbound (tomcat) TLS 1.3 and TLS 1.2
traffic by default on ports 443, 8181, and 8182:
Key Management Service server
Web Service server (REST and SOAP APIs)
PIE front-end server
TLS 1.3 is not supported for the Management Console service. The Console requires TLS 1.2
inbound (nginx, port 8443).
Outbound (Java) LDAP requests from SDA are configured to support TLS 1.3 and TLS 1.2
traffic by default.
A SecureData client must support the TLS 1.3 protocol to use it for its communications with
SecureData services. For information about SecureData client versions that support TLS 1.3 at
the time of this release, see "SecureData Support for TLS 1.3" in the Voltage SecureData
Appliance Architecture Guide.
The supported SSL protocol versions are configured by using the SSL_ENABLED_PROTOCOLS
and JAVA_SSL_ENABLED_PROTOCOLS variables in the settings.py file. You can override
the default value by modifying the settings for the variables in the /opt/vsmgmt/console/
config.py file, and putting different values for SSL_ENABLED_PROTOCOLS and
JAVA_SSL_ENABLED_PROTOCOLS variables.
CAUTION: Do not remove TLSv1.2 from the configuration. TLS 1.2 is required (by CentOS) for internal
communication between SDA services and between HSMs and SDA services.
Do not modify the settings.py file; it is overwritten with every software upgrade.
NOTE: If you enable TLS 1.3, ensure that you also add the supporting TLS 1.3 ciphers required to make TLS
1.3 connections.. Configure Strong SSL Ciphers for TLS 1.3 and TLS 1.2,
Example: Default Setting with TLS 1.3 and TLS 1.2 Enabled
By default, SecureData 6.9.7 enables both TLS 1.3 and TLS 1.2 for each of the TLS protocol
variables in the /opt/vsmgmt/console/settings.py file. The inbound (tomcat) traffic
supports TLS 1.3 and TLS 1.2. The outbound (Java) LDAP request supports TLS 1.3 and TLS
1.2.
SSL_ENABLED_PROTOCOLS = "TLSv1.3,TLSv1.2"
JAVA_SSL_ENABLED_PROTOCOLS = "TLSv1.3,TLSv1.2"
If you configure different settings for the two variables, the resulting TLS versions supported
for the outbound LDAP request will be the minimum set of the combination. With the following
settings, the inbound (tomcat) traffic supports TLS 1.3 and TLS 1.2, and the outbound (Java)
LDAP request supports TLS 1.3, TLS 1.2, and TLS 1.1.
SSL_ENABLED_PROTOCOLS=”TLSv1.3,TLSv1.2"
JAVA_SSL_ENABLED_PROTOCOLS ="TLSv1.2,TLSv1.1"
CAUTION: Do not disable TLS 1.2. It is required (by CentOS) for internal communications between
services and between HSMs and services.
For example, the following settings enable both TLS 1.3 and TLS 1.2 for external
inbound traffic and outbound LDAP requests:
SSL_ENABLED_PROTOCOLS = "TLSv1.3,TLSv1.2"
JAVA_SSL_ENABLED_PROTOCOLS = "TLSv1.3,TLSv1.2"
4. Ensure that you also configure strong SSL ciphers to support the TLS versions you
configure. See Configure Strong SSL Ciphers for TLS 1.3 and TLS 1.2.
In SecureData 6.9.7, the default strong SSL cipher settings for TLS 1.3 and TLS 1.2 support are:
STRONG_SSL_CIPHERS = "TLS_AES_128_GCM_SHA256," \
"TLS_AES_256_GCM_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
The following table lists the ciphers defined in a SecureData Appliance 6.9.7 in the order of
preference. The SecureData Appliance defines the cipher's name used by IANA (Internet
Assigned Numbers Authority). The table also shows each cipher's name used by OpenSSL,
which uses different names for the same ciphers.
NOTE: If you have custom cipher settings in the config.py file prior to an upgrade, the upgrade process
preserves your custom settings. To overwrite your existing custom settings from a prior release, you must
make changes in config.py file.
CAUTION: Do not remove all strong SSL ciphers for TLSv1.2 from the configuration. TLS 1.2 is required (by
CentOS) for internal communication between SDA services and between HSMs and SDA services.
Do not modify the settings.py file; it is overwritten with every software upgrade.
You can specify the ciphers for the STRONG_SSL_CIPHERS variable in a preferred order. Add
the USE_CIPHER_ORDER variable in the config.py file, and set it to true to enable Tomcat
to enforce the order. Set the variable to false to let Tomcat choose the first acceptable cipher
suite that is presented by the client that matches a cipher in your list.
# This setting forces Tomcat to honor the order the ciphers are listed in
(useServerCipherSuitesOrder)
USE_CIPHER_ORDER = True
To configure TLS 1.3 and TLS 1.2 cipher settings in your custom settings in the config.py
file:
3. Add the STRONG_SSL_CIPHERS variable, and list the ciphers you want to use. See the
example above of the default cipher settings for SecureData 6.9.7.
NOTE: If you disable (clear) the “System Clock uses UTC” check box, you are configuring the system clock
to use RTC time in the local time zone. You must use external facilities to maintain time zone changes and
daylight savings time adjustments.
These default settings apply only for new installations. System settings are not modified for
upgrades applied to existing systems. After upgrading to SecureData 6.9.7, you can modify
Time Zone settings to use the default values for Time Zone (Etc/UTC) and the "System clock
uses UTC" check box (selected).
CAUTION: If you disable (clear) the “System Clock uses UTC” check box, you are configuring
the system clock to use RTC time in the local time zone. You must use external facilities to
maintain time zone changes and daylight savings time adjustments.
d. Press Tab twice to move to the OK button, and press Enter to apply the settings.
A message displays to identify additional steps required to effect the changes in the
Management Console and remote hosts. Your Time Zone settings have been
applied locally.
e. Use the arrow keys to select Back to return to the Main Menu.
3. Restart the Management Console service for the new Time Zone settings to take effect.
5. Re-register any remote hosts in your system for this Management Console. For
information, see “Re-Register Remote Hosts” on page 4-10.
This chapter describes post-setup operational tasks for the Voltage SecureData Appliance,
using the Voltage SecureData Appliance Menu. To modify the configuration, use the
information in “Configure SecureData Appliance” on page 2-1.
Login for the Appliance
Change Passwords for admin Accounts
Enable, Disable, or Restart Services
Reboot or Shut Down Your Server
Apply Management Console Certificate
Enable or Disable Remote Access to the Management Console
View Host Registration Password
Re-Register Remote Hosts
When you log in to the Voltage SecureData Appliance using the admin user name, the Voltage
SecureData Appliance Main Menu displays.
1. Log in to the Voltage SecureData Appliance with the user name admin.
2. From the Voltage SecureData Appliance Main Menu, choose c. Configure Passwords.
The Password Configuration Menu displays, as shown in Figure 4-2.
For example, you might restart a service from the Appliance Menu if a restart from the
Management Console fails with error messages such as service notification errors or application
server restart errors. If restarting the service also fails from the Appliance Menu, you might need
to restart the appliance, as described in Reboot or Shut Down Your Server.
CAUTION: When you restart the services, it takes several seconds to restart the application server. This
causes a disruption in availability of the server components and may cause failures in client applications.
Accordingly, use the restart services operation only when absolutely necessary.
1. From the Main Menu, use the down arrow key to highlight f. Configure Services. Use
the down arrow to select OK, then press Enter.
The Service Management Menu displays, as shown in Figure 4-3.
2. Use the down arrow key to highlight c. Advanced Services Configuration. Use the Tab
key to highlight OK, and then press Enter.
3. To enable disable or restart any services, use the down arrow key to highlight the
service you want to set.
4. Use the down arrow key to highlight the action you want to take.
5. Use the Tab key to highlight Yes, and then press Enter.
1. From the Main Menu, choose g. Manage Appliance. Use the Tab key to highlight OK,
and then press Enter.
The Appliance Configuration Menu displays as shown in Figure 4-4.
Figure 4-4 Appliance Configuration Menu for Reboot or Shut Down Options
1. From the Main Menu, choose g. Manage Appliance. Use the Tab key to highlight OK,
and then press Enter.
The Appliance Configuration Menu displays as shown in Figure 4-4.
Figure 4-5 Appliance Configuration Menu for Apply Management Console Certificate
2. Use the arrow keys to highlight c. Apply Management Console Certificate to apply a
staged CA signed certificate for Management Console services.
CAUTION: To fully secure access to the SecureData Appliance, you must use a CA signed
certificate.
3. Use the Tab key to highlight OK, and then press Enter.
1. From the Main Menu, choose a. Configure Networking. Use the Tab key to highlight
OK, and then press Enter.
3. From the Firewall/Remote Access Menu, use the arrow keys to highlight e. Enable/
Disable Remote Access To Management Console, and press Enter.
4. Select Yes to enable or disable Management Console access, and press Enter.
2. From the Voltage SecureData Appliance Main Menu, choose e. Host Registration.
The Host Registration Menu displays, as shown in Figure 4-7.
1. Remove the registered host from the Hosts lists in the Management Console.
a. In the Management Console, navigate to System > Hosts tab.
b. On the host list, click Delete next to the registered host whose Time Zone and
System Clock settings you are changing.
6. Return to the Management Console where you want to register the host, and navigate
to the System > Hosts tab.
7. Click Add Host to re-add the remote host. Enter all of the information about the host
you want to add, including its newly generated registration password, and click Save.
By default, SecureData servers use a list of ciphers defined by OWASP Cipher String 'B'
supporting TLS 1.2. You can either edit the cipher list to enable older clients, or update your
clients.
CAUTION: This section describes how to restore less-secure TLS 1.2 SSL ciphers. Voltage recommends that
you upgrade older clients to resolve this issue.
NOTE: Do not edit the settings.py file for these changes. The settings.py values are
overwritten during a SecureData upgrade.
3. Update ciphers listed at the STRONG_SSL_CIPHERS variable, adding any ciphers you
want to use. See the examples below of cipher settings in prior releases.
NOTE: If you are upgrading from an earlier release, the config.py file may not include the
STRONG_SSL_CIPHERS variable. You can simply add the variable at the end of the file.
Example (6.9.7 default cipher settings for TLS 1.3 and TLS 1.2 support)
STRONG_SSL_CIPHERS = "TLS_AES_128_GCM_SHA256," \
"TLS_AES_256_GCM_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
STRONG_SSL_CIPHERS = "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA348," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA"
STRONG_SSL_CIPHERS = "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256," \
"TLS_RSA_WITH_AES_128_GCM_SHA256," \
"TLS_RSA_WITH_AES_256_GCM_SHA384," \
"TLS_RSA_WITH_AES_128_CBC_SHA256," \
"TLS_RSA_WITH_AES_256_CBC_SHA256," \
"TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA," \
"TLS_RSA_WITH_AES_128_CBC_SHA," \
"TLS_RSA_WITH_AES_256_CBC_SHA," \
"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384," \
"TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384"
CAUTION: This section describes how to restore weaker MAC and key exchange algorithms. Micro Focus
Voltage recommends that you upgrade older clients to resolve this issue.
Example result
MACs hmac-sha2-256-etm@openssh.com,hmac-sha2-512-etm@openssh.com,hmac-
sha1,hmac-sha2-256,hmac-sha2-512
Example result
KexAlgorithms diffie-hellman-group-exchange-sha256,ecdh-sha2-nistp256,ecdh-
sha2-nistp384,ecdh-sha2-nistp521,diffie-hellman-group14-sha1,diffie-hellman-
group-exchange-sha1
9. Launch a new SSH session to verify that you can now connect.
3. From the Appliance Configuration menu, navigate to Configure Services > Advanced
Service Configuration > Management Service > Restart Management Console and
select OK. See “Enabling, Disabling, and Restarting Services” on page 2-20.
An event is logged when IBE/SOA service is started to indicate whether certificate revocation
status check is turned on.
When certificate revocation status check is disabled:
This chapter describes how to upgrade the Voltage SecureData Appliance software from a
previous version.
Supported Upgrade Paths
Upgrade Prerequisites
Blockers for Upgrade
Upgrade Notices
Upgrading Version 6.8.2 or 6.9.x to Version 6.9.7
Post-Upgrade Configuration Options
Upgrade Prerequisites
All SecureData Appliances in the system must be running the same version.
Before you begin an upgrade, ensure that your SDA system is up and working properly.
The following are the minimum required configuration and tasks that must be
performed on an existing system before that system can be upgraded.
Ensure that all SecureData Appliance has been configured and initialized as
described in “Configure SecureData Appliance” on page 2-1.
Ensure that you perform the following post-initialization configuration tasks to have
a minimally functional Appliance that can be upgraded:
Table 6-1 Minimum Post-Initialization Configuration Tasks
Review the potential blockers to understand which issues might be relevant to your
existing installations. See “Blockers for Upgrade” on page 6-3.
Voltage recommends that you first upgrade the appliance hosting the Management
Console.
Voltage recommends that you re-register the remote hosts after they are upgraded. For
more information see, “Deleting or Resetting Host Registration” on page 2-18.
IMPORTANT: If you are using Atalla AT-1000 HSMs in your SecureData environment and have upgraded
to Atalla version 8.30, you MUST create an AES MFK (AMK) before you can upgrade Voltage SecureData to
version 6.7 and later. See the Voltage SecureData Integration Supplement for Atalla AT1000
HSMs more information.
Ensure that you understand potential blockers and the actions needed to resolve them.
Blockers for Upgrades to SDA 6.9 and Later
Blockers for Upgrades to SDA 6.9.7
Unsupported or Invalid Formats
If you are using data protection formats with either of these features, upgrading to SecureData
6.9 and later is blocked.
The upgrade process detects whether BIN mapping or database tokenization features are in
use, but it does not identify each instance. If you are using these features, modify or remove the
affected data protection formats, and make a new backup before upgrading to Version 6.9 or
later.
If you are using these features, upgrading to SecureData Version 6.9.7 is blocked. The upgrade
process checks for and reports on each of these issues before it blocks the upgrade with the
message:
Upgrade terminated due to above errors. Contact Voltage Support for additional
guidance.
Use the logged events to manually correct the issues in your prior release, and make a new
backup before upgrading to SecureData Version 6.9.7. The following sections contain
information about each unsupported feature.
The upgrade process checks key rotation group settings for mixed common names, displays
the following error message in the console screen, lists affected key rotation groups, and blocks
the upgrade.
One or more invalid Key Rotation Groups with mixed common names detected. All key
numbers in a key rotation group must have the same common name.
It lists the name of each affected key rotation group and the type of naming error. There are
three mixed name conditions:
Example: Mix of Non-Blank Common Names
To prepare your system for upgrade, modify common names for each identified key rotation
group to ensure they meet this new requirement. Use the logged events to manually correct
the issues in your prior release. Make a new backup before upgrading to SecureData Version
6.9.7.
The upgrade process checks format mask settings for regex masking, displays the following
error message in the console screen, lists affected formats, and blocks the upgrade:
One or more Formats with regular expression Mask Settings detected. Regex masking is no
longer supported.
It lists the name of each affected format and whether the regex Mask error is for the Default
Mask Setting or Custom Mask Setting.
Example: Default Mask Settings
To prepare your system for upgrade, modify the Default and Custom Mask Settings for the
format mask, or remove the format. Make a new backup before upgrading to SecureData
Version 6.9.7.
The upgrade process checks for the presence of an Authorization Token Secret setting,
displays the following error message in the console screen, and blocks the upgrade.
An 'Authorization Token Secret' has been configured, for use in the advanced
'AuthToken_HMAC_SHA1' auth method in the SOAP API. This auth method is no longer
supported.
To prepare for upgrade, remove the Authorization Token Secret values, clear the Enable
AuthToken Caching check box, and save the settings. Ensure that you configure a supported
authorization method to use for SOAP API operations. Make a new backup before upgrading to
SecureData Version 6.9.7.
Upgrade Notices
During the upgrade to SecureData 6.9.7, the new default settings described below will not
replace customizations you have made to the config.py file or time settings for the existing
installation. You can update your settings after the upgrade, according to your business needs.
CAUTION: Do not remove TLSv1.2 from the configuration. TLS 1.2 is required (by CentOS) for internal
communication between SDA services and between HSMs and SDA services.
The following SDA services are configured to accept inbound TLS 1.3 and TLS 1.2 traffic by
default for tomcat on ports 443, 8181, and 8182:
Key Management Service server
Web Service server (REST and SOAP APIs)
PIE front-end server
TLS 1.3 is not supported for the Management Console service. The Console requires TLS 1.2
inbound (tomcat, port 8443).
Outbound (Java) LDAP requests from SDA are configured to support TLS 1.3 and TLS 1.2
traffic by default.
A SecureData client must support the TLS 1.3 protocol to use it for its communications with
SecureData services. For information about SecureData client versions that support TLS 1.3 at
the time of this release, see "SecureData Support for TLS 1.3" in the Voltage SecureData
Appliance Architecture Guide.
Default Strong SSL Ciphers for TLS 1.3 and TLS 1.2
For new installations, SecureData servers use a list of Strong SSL Ciphers supporting TLS 1.3
(new in SDA 6.9.7) and TLS 1.2 by default in the settings.py file. If you have custom
settings in the config.py file, your settings will not be modified during an upgrade. After the
upgrade, you can modify your custom settings in the config.py file to add Strong SSL
Ciphers, according to the TLS protocols enabled for your system.
When upgrading from SDA 6.X to 6.9.7, the following default settings and their comments from
prior releases are removed from the config.py file. The default settings from the
settings.py file will apply after the upgrade.
ENABLE_STRONG_SSL_CIPHERS
STRONG_SSL_CIPHERS
CHECK_CERTIFICATE_REVOCATION
However, if you have set a custom list in the config.py file for the strong SSL ciphers, which may
not include the TLS 1.3 cipher (new in SDA 6.9.7), your settings will not be modified during an
upgrade. After the upgrade, you can update your cipher list in the config.py file to update
your strong SSL cipher settings, according to the TLS protocols enabled for your system.
NOTE: If you disable (clear) the “System Clock uses UTC” check box, you are configuring the system clock
to use RTC time in the local time zone. You must use external facilities to maintain time zone changes and
daylight savings time adjustments.
These default settings apply only for new installations. System settings are not modified for
upgrades applied to existing systems. After the upgrade, you can update your Time Zone and
System Clock settings for the appliance, as appropriate for your business needs.
IMPORTANT: If you are upgrading a SecureData version purchased after Dec. 28, 2020, you must install a
new Splunk license. See “Configure Event Viewer License” on page 2-14.
The following script upgrades an Appliance running version 6.8.2 or 6.9.x to 6.9.7:
sda_6.9.7_upgrade.run
2. Log out of the Management Console, and then close your browser before you upgrade
the software.
NOTE: The upgrade applies software updates to the Management Console. This action removes
the old CSRF (Cross-Site Request Forgery) token. After the upgrade, a fresh CSRF token will be
generated when you reopen the browser and log in again.
chmod +x /root/sda_upgrade/sda_6.9.7_upgrade.run
/root/sda_upgrade/sda_6.9.7_upgrade.run
9. Log in to the Management Console as an Administrative user, and deploy the system.
After the upgrade script successfully runs, the Appliance menu and Management
Console display Version 6.9.7, indicating that the upgrade was successful.
10. (Remote hosts) Re-register each remote host after it has been successfully upgraded.
For more information see, “Deleting or Resetting Host Registration” on page 2-18.
NOTE: (HSM) If the backup contains configuration for an HSM and HSM types of districts for
Utimaco Atalla HSMs or for Entrust nShield HSMs:
Before you restore the backup, ensure that you prepare the HSM to work with this
SecureData release, and install the corresponding HSM client software for your HSM on the
appliance. See the following for information about your HSM:
Voltage SecureData Integration Supplement for Utimaco Atalla HSMs
Voltage SecureData Integration Supplement for Entrust nShield HSMs
After you restore from backup and before you deploy the changes, you must reset (clear,
save, select, save) the restored HSM enabled setting in the Management Console on the
System > Advanced page. This is necessary to ensure that the Management Console uses
the HSM FEK.