NetBackup™ Security and Encryption Guide
- Read this first for secure communications in NetBackup
- Communication failure scenarios
- Increasing NetBackup security
- Security deployment models
- Auditing NetBackup operations
- About audit events
- Section I. Identity and access management
- About identity and access management
- AD and LDAP domains
- Access keys
- API keys
- Auth.conf file
- Role-based access control
- Default RBAC roles
- NetBackup interface access for OS Administrators
- Smart card or digital certificate
- Single Sign-On (SSO)
- NetBackup Access Control Security (NBAC)
- Configuring NetBackup Access Control (NBAC)
- Configuring Access Control host properties for the primary and media server
- Access Control host properties dialog for the client
- Troubleshooting Access Management
- Windows verification points
- UNIX verification points
- Verification points in a mixed environment with a UNIX primary server
- Verification points in a mixed environment with a Windows primary server
- About determining who can access NetBackup
- Viewing specific user permissions for NetBackup user groups
- Minimizing security configuration risk
- Configuring multifactor authentication
- Configuring multi-person authorization
- Section II. Encryption of data-in-transit
- NetBackup CA and NetBackup certificates
- About the Security Management utilities
- About host management
- Adding shared or cluster mappings
- Allowing or disallowing automatic certificate reissue
- About global security settings
- About host name-based certificates
- About host ID-based certificates
- Using the Certificate Management utility to issue and deploy host ID-based certificates
- About NetBackup certificate deployment security levels
- Setting up trust with the primary server (Certificate Authority)
- About reissuing host ID-based certificates
- About Token Management for host ID-based certificates
- About the host ID-based certificate revocation list
- About revoking host ID-based certificates
- Host ID-based certificate deployment in a clustered setup
- About deployment of a host ID-based certificate on a clustered NetBackup host
- Migrating NetBackup CA
- Configuring data-in-transit encryption (DTE)
- Configure the DTE mode on a client
- Modify the DTE mode on a backup image
- How DTE configuration settings work in various NetBackup operations
- External CA and external certificates
- About external CA support in NetBackup
- Configuration options for external CA-signed certificates
- ECA_CERT_PATH for NetBackup servers and clients
- About certificate revocation lists for external CA
- About certificate enrollment
- Configure an external certificate for the NetBackup web server
- About external certificate configuration for a clustered primary server
- Regenerating keys and certificates
- NetBackup CA and NetBackup certificates
- Section III. Encryption of data at rest
- Data at rest encryption security
- About NetBackup client encryption
- Configuring standard encryption on clients
- About configuring standard encryption from the server
- Configuring legacy encryption on clients
- About configuring legacy encryption from the client
- About configuring legacy encryption from the server
- Additional legacy key file security for UNIX clients
- NetBackup key management service
- About FIPS enabled KMS
- Installing KMS
- Configuring KMS
- About key groups and key records
- Overview of key record states
- Configuring NetBackup to work with KMS
- About using KMS for encryption
- KMS database constituents
- KMS operations using command-line interface (CLI)
- About exporting and importing keys from the KMS database
- Troubleshooting KMS
- External key management service
- Configuring KMS credentials
- Configuring KMS
- Creating keys in an external KMS
- Working with multiple KMS servers
- Data at rest encryption security
- Ciphers used in NetBackup for secure communication
- FIPS compliance in NetBackup
- Disable FIPS mode for NetBackup
- NetBackup web services account
- Running NetBackup services with non-privileged user (service user) account
- Running NetBackup commands with non-privileged user account
- Immutability and indelibility of data in NetBackup
- Anomaly detection
- Section IV. Malware scanning
- Introduction
- How to setup Malware scanning
- Instant Access configurations
- Malware tools configurations
- Scan host configurations
- Prerequisites for a scan host
- Configuring scan host
- Configuring a scan host pool
- Managing a scan host
- Performing malware scan
- Managing scan tasks
- Malware scan configuration parameters
- Troubleshooting
Troubleshooting issues with malware scanning
(Applicable on scan host RHEL 8.x and NFS version 4.x) When scanning large size backup (~ 200 million files), following error is displayed on the Web UI for failed job:
Failed to get response from NetBackup malware utility.
While scan is in progress on scan host, NFS mount points are not accessible from scan host. Scan job remains in progress and timeout after two days. NFS exports on storage server are accessible.
/etc/nfsmount.conf
file on scan host:
# grep Defaultvers /etc/nfsmount.conf Defaultvers=3
SSH connection to scan host from media server failed.
: Verify the following scan host credentials:
RSA (SHA256) key
User name
Password
Refer to NetBackup Web UI Administrator's Guide for the scan host configuration.
Error can be due to unsupported scan host.
: For a complete list of supported platforms for the scan host, refer to the Software Compatibility list document.
Not enough space is available on the scan host.
SSH user does not have access to the required directories on the scan host.
On a Windows scan host, check for space availability in
C:\
folder.On a Linux scan host, check for space availability in
/tmp
folder.
Media server is not able to fetch the credentials to access scan host from the Primary.
: Check that credentials for scan host are specified.
Default scan operation time out is two days. Time to scan may vary depending on the factors sch as workload type, network bandwidth, backup size.
: Scan time-out is configurable and can be changed by setting the configuration key.
Minimum value: 1 hour
Maximum value: 30 days
Mismatch between nbmalwareutil
binary and the ScanManager
:
Contact NetBackup support.
Malware scanner-specific failure message.
nbmalwarescanner
logs on the media server.
IA share is not accessible from the scan host.
: Check IA configuration on storage server. Verify on activity monitor that IA job is successful.
IA share is busy or not accessible.
nbmalwarescanner
logs on the media server.
Generic failure during the scan of a backup image.
nbmalwarescanner
logs on the media server.
Generic failure during the scan of a backup image.
:
Verify if any scan is in progress.
If no scan is in progress, then obtain the list of such instant access mounts with ID's of the instant access mount created using the GET IA API from the following directory:
/netbackup/recovery/workloads/{workload}/instant-access-mounts
Using the DELETE API, delete the instant access mount:
/netbackup/recovery/workloads/{workload}/instant-access-mounts/{mounId}
Only five backup images can be mounted at the same time on windows scan host.
:
Ensure that scan host is not part of multiple NetBackup domains.
Check if there are any Stale mounts on the scan host by running net use.
Following drive letters are used for mounting the IA shares on the windows scan host. Ensure that they are not in use.
L:\ M:\ N:\ O:\ P:\
Microsoft Windows Defender is not installed on the scan host or not configured properly.
: Ensure that Microsoft Windows Defender is installed on scan host.
Refer NetBackup Web UI Administrator's Guide for the scan host configuration.
Symantec Protection Engine is not installed on the scan host or not configured properly.
: Ensure that Symantec Protection Engine is installed on scan host.
Refer NetBackup Web UI Administrator's Guide for the scan host configuration.
Generic error for Scan failure.
: Contact NetBackup support.
Storage server host name cannot be more than 15 characters for the SMB share support.
If Windows Server 2016 is used to set up Active Directory domain, then it does not allow a connection to a storage server with host name of length more than 15 characters.
: Ensure that the character limit is not more than 15 characters.
Generic failure during scanning backup image.
: Check for the following errors:
Refer to
nbmalwarescanner
logs on the media server.Check for space on media server storage.
Check for NFS service failure on media server.
Review the nbmalwarescanner
to view the infected files list for the backup images in the selected date range.
: Update the date range or recovery files and folders selection to reduce the number of infected files. Retry the operation. You can also perform one of the following:
Select the
option which can be used to recover selective clean files.Skip that backup image from recovery.
There are too many infected files in the selected scan result. If the scan result has infected files greater than 5000, the following message is displayed:
Large number of infected files. To view the complete list of infected files, export the list.
: Export the infected file list in.csv
format and download it to view it.There are many infected files in the selected scan result or the infected file paths are long to be captured in the database. Following error message is displayed:
Large number of infected files.
: This result cannot be exported or viewed.
: As the results cannot be exported or viewed, review the scan logs to view a detailed list of the infected files for the selected scan result.
For large size backup, scan operation is divided into parts. For example, if total number of files in the backup are 1,000,000, the scan operation will be divided into two parts of 500,000 files each.
Each part would be created and scanned separately. Each part can be assigned with different scan host. The Malware detection UI displays only single entry for backup.
: Each divided part details can be obtained by using the REST API.
When performing a malware scan operation with the NetBackup Malware Scanner installed on the scan host, it fails with the following error message:
Missing environment variable NB_MALWARE_SCANNER_PATH
: Ensure that NetBackup Malware Scanner is installed. Note the install location.
Login on the scan host as user using the same user credentials that were provided during scan host configuration on the primary server. Add the following lines to ~/.bashrc
:
export NB_MALWARE_SCANNER_PATH=<installLocation>/savapi-sdk-linux64/bin
export PATH=$PATH:$NB_MALWARE_SCANNER_PATH
Malware scanning on Windows scan host may fail if there are cygwin mks toolkit installed.
: UNIX utilities are installed, however, defined scanuser cannot have those UNIX utilities in the PATH variable.
Error/Issue | Description | Workaround |
---|---|---|
|
|
|
When upgrading NetBackup from previous version to NetBackup version 10.2.1 or later with the following options selected, the No images match the search criteria
message is displayed:
Options | Fields |
---|---|
: Backup images | : NAS-Data-Protection : Copy2 : Not scanned (Default) |
: Assets by policy type | : NAS-Data-Protection : Copy2 : Select the required scanner host pool. : Not scanned (Default) |
Workaround
To view the images that are backed up, ensure that you select the
option as to scan the NAS-Data-Protection backup images created on earlier version of NetBackup media server.When using Instant Access mount points for malware scan (traditional malware scan) in NetBackup versions prior to 10.3, performance issues were observed.
Workaround: Upgrade to NetBackup media and storage server 10.3 or later. NetBackup 10.3 introduces the feature. This improves the instant access time as well as the scan performance.
The following table provides the differences between the traditional malware scan and dynamic scan:
Key scanning procedure | Traditional malware scan using Instant Access mount points | Dynamic scan |
---|---|---|
Instant access stage. | Analyzes the tar stream and builds each file's header and extent map file (LMDB database), which is time consuming for large number of files in the backup. | Restores TIR (catalog database) and IM (image metadata) information from fragment. |
Instant access share (NFS/SMB) is mounted and user tries to list or access the file. | Accesses it's header file and reads the attribute from it. | Query's the directory from catalog database to get all the files and directories which are under this directory. It can also query each files and directories attribute to the output. |
Scan host opens a file | Opens and loads the LMDB database. | Builds the index in memory and reads directly from data container.
|
Scan host reads a file | Searches from LMDB database and reads from data container. | If storage server is 3rd party storage vendor, it reads data through OST interface directly. If storage server is PureDisk, it searches from mapping table and reads data from data container. |
The following table provides the details for the respective log files to be viewed depending on the use case:
Table: Log file locations
Use case | Components on primary server | Components on media server | Log file path |
---|---|---|---|
Configurations | nbwebservice | ncfnbcs | For primary server:
For media server:
|
Scan process | nbwebservice bprd | ncfnbcs nbmalwarescanner | |
Recovery | nbwebservice bprd |
For VMWare VM backup scan, ensure that you use scan user with uid=0. SSH login is disabled by default and user may not enable it for security reasons.
Workaround
In above scenario, perform the following:
If SSH login is disabled for the root user, then non-root scan user can be added to group 0 (root) to be able to scan all the files.
For example, uid=1001(scanuser) gid=1001(scanuser) groups=1001(scanuser),0(root)