Tools

Enable SSL encryption for a Microsoft SQL Server database

This article describes how to set up SSL encryption on a Microsoft SQL Server database for Web Help Desk.

First published date

10/19/2018 3:43 AM

Last published date

4/26/2020 4:00 AM

Overview

Follow the steps in this article to set up SSL encryption on a Microsoft® SQL Server® database connected to Web Help Desk.

Product section

Web Help Desk

Resolution

Set up the SSL connection

  1. Follow the steps in Encrypting Connections to SQL Server (© Microsoft 2018, available at https://www.microsoft.com/en-us/, obtained on November 20, 2018) to set up the SSL connection on the SQL Server database.

    When the ForceEncryption option for the database engine is set to Yes, all client/server communication is encrypted. This option denies access to clients that cannot support encryption.

  2. Start the database server with SSL enabled.

Enable SSL encryption for a new Web Help Desk installation

If you are upgrading Web Help Desk or installing the software for the first time, perform the following steps:

  1. Download and run the Web Help Desk installer.
  2. Follow the steps in the Getting Started Wizard.
  3. In the Select your Web Help Desk database window, add the database information.
    1. Select Use custom SQL Server database (advanced).
    2. In the Database Name field, enter:
      whd?ssl=true
  4. Complete the wizard.SSL is enabled. 

Enable SSL encryption for an existing Web Help Desk installation

If you are configuring SSL encryption for an existing WHD installation, perform the following steps:

  1. Navigate to the Web Help Desk home directory.
    • Microsoft® Windows®:  \Program Files\WebHelpDesk\bin\jre\lib\ext
    • Apple® OS X:  /Library/Java/Extensions
    • Linux: /usr/local/webhelpdesk/bin/jre/lib/ext
  2. Open the confdirectory.
  3. Open the .whd.properties file in a text editor. 
  4. Edit the following properties:
    • whd.db.port=1433
    • whd.db.sid=
    • whd.db.customUrl=
    • whd.db.subprotocol=microsoft
    • whd.db.password={DES}B/cdbZvGZws\=
    • whd.db.host=<server_name>
    • whd.db.useCustomUrl=NO
    • whd.db.name=whd:encrypt=true #
    • whd.db.username=whd
    • whd.db.embedded=NO
  5. Open the Web Help Desk home directory.
    • Apple® OS X: /Library/WebHelpDesk 
    • Microsoft® Windows®: \Program Files\WebHelpDesk 
    • Red Hat®/CentOS™/Fedora Linux: /usr/local/webhelpdesk
  6. Locate the Portecle application at:
    <WebHelpDesk>/bin/Portecle.jar
  7. Using Portecle, import the certificates to the following location:

    <WebHelpDesk>/bin/jre/lib/security/cacerts/<webhelpdesk_home>

  8. Start Web Help Desk.

If you are unable to connect to the SQL Server database, ensure that:

  • The appropriate certificate was imported into the cacerts directory.
  • The path to the Web Help Desk home directory is correct.

If you still cannot connect to the SQL Server database, collect the log files and contact SolarWinds Support.