Hardening Guide
This guide lists the settings and host steps that harden a QSDA Pro server for production use, such as a deployment assessed against the DISA Application Security and Development STIG. Settings marked Enterprise require an Enterprise license.
Steps marked Host change Windows rather than QSDA. Agree them with the server's administrators, because some of them affect every application on the server.
Limit network exposure
-
Open only the UI port. Browsers, the CLI and external API clients use the UI port, 5003 by default. The API port, 5000 by default, listens on loopback only and must not be opened in the firewall. See TCP Ports.
-
Host: With an Enterprise license, the UI listens on all network interfaces. Restrict inbound access to port 5003 with Windows Firewall to the networks that need QSDA, or place QSDA behind a reverse proxy.
-
Turn on authentication before opening the port (Enterprise). While no authentication method is selected, QSDA does not identify users, and everyone who can reach the UI has full administrative access. See Configure Enterprise Security.
In this state the UI offers only the Admin pages and Help. Analyze, Utilities, Insights and Settings are blocked until a login method is turned on. QSDA keeps accepting remote connections, but warns about it: the Control Panel and every UI page show a red warning, and each UI startup writes a warning to the UI log and a
Security:UnauthenticatedNetworkAccessentry to the UI audit log (qsda-ui-audit-<yyyyMM>.log). Alert on that entry in your SIEM. The warning disappears once Windows or Qlik login is turned on and the services are restarted.
Use HTTPS
- Use HTTPS (Enterprise) in Control Panel > Configuration > Service Parameters. Install a server-authentication certificate issued by your organization's CA in the Local Computer Personal store, and set HTTPS Certificate Thumbprint if automatic selection picks the wrong certificate. The Control Panel can create a self-signed certificate to get HTTPS running, but it does not meet DoD PKI requirements; replace it with a CA-issued certificate. Service Status > SSL Certs marks a self-signed certificate as such.
- Minimum TLS Version defaults to TLS 1.2 and 1.3. QSDA then refuses TLS 1.0 and TLS 1.1 connections, whatever the Windows settings allow. Choose TLS 1.3 only on Windows Server 2022 or later when all browsers and clients support it. Choose Operating system default only when your site manages TLS versions centrally through Windows policy.
- Over HTTPS, QSDA sends a
Strict-Transport-Securityheader with a one-year lifetime, so browsers that have visited the site refuse later HTTP connections to that host name.
Restrict TLS 1.2 cipher suites (Host)
Windows does not let an application choose its own cipher suites, so QSDA uses the suites Windows enables. By default, Windows enables CBC-mode suites and RSA key-exchange suites without forward secrecy for TLS 1.2. Security scanners report these as weak. TLS 1.3 uses only strong suites.
To leave only TLS 1.3 suites and ECDHE suites with AES-GCM, run these commands in an elevated PowerShell on the QSDA server:
# List the TLS 1.2 suites that use CBC mode, lack forward secrecy, or do not encrypt
$weak = (Get-TlsCipherSuite).Name | Where-Object { $_ -match '_CBC_|^TLS_RSA_|^TLS_PSK_|_NULL_|_3DES_|_RC4_' }
$weak
# Disable them
$weak | ForEach-Object { Disable-TlsCipherSuite -Name $_ }
Restart the server afterwards. This changes the suites for every application on the server that uses Windows TLS, including Remote Desktop and IIS, and clients that support only the removed suites, such as very old browsers, can no longer connect. Test the change first, and use your site's Group Policy (SSL Cipher Suite Order) instead if the server is managed centrally; Group Policy overrides the PowerShell setting. Enable-TlsCipherSuite -Name <suite> restores a suite.
To verify, scan the UI port from another machine with a TLS scanner, for example nmap --script ssl-enum-ciphers -p 5003 <server> or testssl.sh <server>:5003.
Authentication and authorization
- Select Windows, Qlik Server(s) or both in UI Security (Enterprise), and assign roles in Admin > Users & Security. Grant Administrator and Project Manager only to the people who need them. If you use Dynamic Users, review the role rules that apply to new users.
- Leave Use API Auth on in API Security. Create a separate API key for each integration, and revoke keys that are no longer used.
- Do not rely on the deprecated Admin Password. Use roles instead.
Limit the API surface
- Turn off Show API Documentation in API Security on production servers. The interactive API reference at
/api-docsand/swaggerthen returns 404, and the Help menu hides its link. The change takes effect without a restart. - Cross-origin (CORS) browser access to the API is off by default, because the UI reaches the API through its own proxy. Leave the
ApiCorsOriginslist inqsda-config.jsonempty unless a browser application on another origin must call the API directly; then list only that origin, for example"ApiCorsOrigins": ["https://portal.example.com"], and restart the services.
Secure the Qlik connections
- Validate the Qlik server's certificate. QSDA checks the certificate of Qlik Sense on Windows servers against the QSDA server's Windows trust store. Host: import the CA that issued the Qlik certificates into Local Computer > Trusted Root Certification Authorities (or Intermediate Certification Authorities for an intermediate CA). For CERTIFICATE and QLIKLOGIN connections, this is the
root.cerexported from the QMC with the client certificate. The certificate must also be issued to the host name used in the connection. - Clear Allow Untrusted Certificate on every connection in Admin > Connections (under Show Advanced). Connections created before version 3.8 keep working after the upgrade with this setting on, and the connection page and the log warn until it is cleared. Test Connection explains a rejected certificate, with its subject, issuer and thumbprint.
- Set Proxy Is HTTPS to Yes for proxy connections. See Advanced Properties.
- Use a Qlik user with only the access QSDA needs. See Qlik Sense Authorization Requirements.
- Store exported Qlik client certificates (
client.pfx) in a folder that only administrators and the QSDA service account can read.
Run the services with least privilege (Host)
The installer creates two Windows services that run as Local System:
| Service | Display name | Program |
|---|---|---|
Qsda.Api | QSDA Pro API Service | <install folder>\QsdaApi\Qsda.Service.exe |
Qsda.UI | QSDA Pro Web Service | <install folder>\QsdaUi\Qsda.UI.exe |
To run them under a dedicated low-privilege account instead, give that account:
- Log on as a service.
- Read and execute on the QSDA install folder (by default
C:\Program Files\Qsda Pro). - Modify on the QSDA data folder and on any log or repository folder moved elsewhere.
- Read on the private key of the HTTPS certificate, and read on the Qlik client certificate folders.
Then set the account on both services, for example with sc.exe config Qsda.Api obj= "DOMAIN\svc-qsda" password= "...", or in the Services console, and restart them. A group Managed Service Account avoids storing a password.
Installing a new QSDA version recreates both services with Local System. Reapply the service account after every upgrade.
Protect the data folder (Host)
QSDA keeps its configuration, encrypted connection secrets and API keys, the encryption key ring (key-*.xml), the license and its own key ring (license), the collection and user databases (repo) and the logs (log) in C:\ProgramData\EasyQlik\QSDA. See Data Privacy for what collections contain.
-
Restrict the folder. The installer gives the local Users group Modify access to the folder. Limit it to Local System, Administrators and, if used, the service account. In an elevated command prompt:
icacls "C:\ProgramData\EasyQlik\QSDA" /inheritance:r /remove:g *S-1-5-32-545 /grant:r *S-1-5-18:(OI)(CI)F *S-1-5-32-544:(OI)(CI)FThe SIDs are Users, Local System and Administrators, so the command works on any Windows language. Add the service account with
/grant:r "DOMAIN\svc-qsda:(OI)(CI)M". Apply the same permissions to a log or repository folder moved elsewhere in the Control Panel. Installing a new QSDA version restores the Users permission, so reapply this after every upgrade. The Control Panel then needs to run as an administrator to save the configuration. -
Encrypt the volume that holds the data folder with BitLocker or an equivalent.
-
Back up the data folder, and protect the backups like the folder itself, because they contain the key ring.
How secrets are encrypted
QSDA encrypts stored passwords, client secrets and API keys with ASP.NET Core Data Protection (AES-256-CBC with HMAC-SHA256). The keys in the key ring are themselves encrypted with Windows DPAPI for the local computer, so:
- A copy of the data folder, or a backup of it, cannot be decrypted on any other server.
- Any process on this server that can read the
key-*.xmlfiles can decrypt them. Restricting the folder, as described above, is what keeps other local users out.
The deprecated Admin Password is not encrypted. QSDA stores it as a salted one-way hash (PBKDF2 with SHA-256), which cannot be turned back into the password and does not depend on the key ring. The first time version 3.8 or later starts, it replaces an admin password encrypted by an earlier version with its hash.
Versions before 3.8 protected the keys with a certificate built into QSDA, which any copy of QSDA could use. The first time version 3.8 or later starts, it migrates both key rings: it re-encrypts every stored secret with a new DPAPI-protected key and re-protects the older keys with DPAPI. Only the encrypted values in each file change. The QSDA log records Migrated the key ring in <folder> to DPAPI for each key ring. If a stored value cannot be decrypted, the migration changes nothing and QSDA reports the value as described in If the key ring is lost or damaged. An interrupted migration runs again at the next start.
Backups taken before the upgrade still contain keys that any copy of QSDA can read. Once you have a backup taken after the upgrade, delete the older ones or protect them like the secrets they hold.
Back up and restore
Back up the whole data folder, including key-*.xml and the license folder, with the services stopped or with a tool that copies open files consistently. A key ring and the configuration files belong together: restore them from the same backup.
A backup restores only on the same Windows installation, because the keys are protected by that installation's DPAPI machine key. Restoring onto a reinstalled or rebuilt server works like moving to another server, below. To protect against losing the server itself, keep the connection passwords and secrets in your site's password vault.
Move QSDA to another server
The key ring cannot be decrypted on the new server, so the stored secrets must be entered again there:
- Install QSDA on the new server and stop the
Qsda.ApiandQsda.UIservices. - Copy the data folder from the old server, except the
key-*.xmlfiles and thelicensefolder. - Start the services. They stop and list each setting that cannot be decrypted. Clear those settings as described in If the key ring is lost or damaged, then start the services again.
- Enter the connection passwords and secrets again, and issue new API keys.
- Activate the license on the new server. A license is tied to the server it was activated on.
If the key ring is lost or damaged
QSDA does not start when a stored secret cannot be decrypted. Running without it would drop credentials silently, and the next save would replace the stored values. Instead, the QSDA services stop at startup and the Control Panel shows an error. The service log and the Windows Application event log name each affected setting, for example ServerConnection.json: ["Production"] > Password. No configuration file is changed, and the secrets themselves are never logged.
To recover:
- Stop the
Qsda.ApiandQsda.UIservices. - Restore the
key-*.xmlfiles to the data folder from a backup taken together with the configuration files. Leave any newerkey-*.xmlfile in place. - Start the services.
If there is no backup, the secrets cannot be recovered and must be entered again:
- In each file named in the error, set the listed value to
"". Forqsda-apikeys.jsonorqsda-apikey.json, delete the file instead. - Start the services.
- Enter the connection passwords and secrets and the proxy password again, and issue new API keys.
The admin password is stored as a hash that does not use the key ring, so it keeps working and does not need to be entered again.
Logging and monitoring (Host)
- QSDA writes application logs and monthly audit logs (
qsda-ui-audit-<yyyyMM>.logandqsda-service-audit-<yyyyMM>.log) to the log folder, by defaultC:\ProgramData\EasyQlik\QSDA\log. Forward both to your SIEM with a file-collection agent, so they are kept off the server, protected from change and available for reporting. - Include the log folder in backups, and monitor free disk space on its volume.
- Monitor the
Qsda.ApiandQsda.UIservices, and alert when either stops. - Use the Info log level in production. Debug and Trace write more detail about connections and requests.
- Monitor the install folder with your file integrity tool, so unexpected changes to QSDA programs are reported.
Checklist
| Area | Setting or step | Where |
|---|---|---|
| Network | Open only the UI port; restrict it to the networks that need it | Windows Firewall |
| Network | Select an authentication method before allowing remote access | Control Panel > UI Security |
| TLS | Use HTTPS with a certificate from your CA | Control Panel > Service Parameters |
| TLS | Minimum TLS Version: TLS 1.2 and 1.3, or TLS 1.3 only | Control Panel > Service Parameters |
| TLS | Disable CBC, non-forward-secret and NULL cipher suites | Windows (PowerShell or Group Policy) |
| Access | Assign roles; review Dynamic Users rules | Admin > Users & Security |
| API | Use API Auth on; one API key per integration | Control Panel > API Security; Admin > API Keys |
| API | Show API Documentation off | Control Panel > API Security |
| API | ApiCorsOrigins empty | qsda-config.json |
| Qlik | Import the Qlik CA; clear Allow Untrusted Certificate | Windows trust store; Admin > Connections |
| Host | Least-privilege service account (reapply after upgrades) | Windows Services |
| Host | Restrict the data folder (reapply after upgrades); BitLocker; backups | Windows |
| Host | After upgrading to 3.8, confirm the key ring migration; retire older backups | QSDA log; backup system |
| Host | Forward logs to the SIEM; monitor disk, services and files | Site monitoring tools |