Submit a ticketCall us

Announcing NCM 7.7
With NCM 7.7, you can examine the rules that make up an access control list for a Cisco ASA device. Then you can apply filters to display only rules that meet the specified criteria, order the rules by line number or by the hit count, and much more.
See new features and improvements.

Home > Success Center > Web Help Desk (WHD) > Web Help Desk Administrator Guide > Set up the application > Set up the certificates

Set up the certificates

Created by Steve.Hawkins, last modified by Steve.Hawkins on Sep 12, 2017

Views: 20 Votes: 0 Revisions: 2

Use Certificates to manage SSL and Apple Push Notification Services (APNS) certificates. 

When a web browser submits an HTTPS request to Web Help Desk, the SSL protocol requires the application to respond with a certificate to verify the authenticity of the server. The certificate contains a public key used for encryption and a digital signature from a Certification Authority (CA). The digital signature indicates which CA verified the authenticity of the server.

Web Help Desk stores the certificates in the Java keystore located at <WebHelpDesk>/conf/keystore.jks. You can also store the certificates in a separate Public-Key Cryptography Standards #12 (PKCS12) KeyStore, or Java KeyStore (JKS) that you create in Server Options

APNS certificates enable Web Help Desk to send notifications to an Apple device running Web Help Desk Mobile and a supported Apple iOS. When enabled, the device receives Short Message Service (SMS) text messages each time a customer ticket is created or updated.

SSL certificates

SSL certificates create a secure connection between Web Help Desk and an external resource. Web Help Desk supports the following SSL certificates:

  • Self-signed SSL certificate
  • Certificate from a Certificate Authority (CA)
  • Public-Key Cryptography Standards (PKCS) #12 certificate 

The Certificates page displays all certificates that are currently in the keystore and defined in the .conf file. In this example, the Apache Tomcat SSL certificate is installed in the keystore.

The following table lists some third-party applications used with Web Help Desk that require an SSL certificate.

Product SSL Certificate Function
Apache Tomcat Creates a secure connection to the Apache Tomcat web and application server.
Microsoft® Exchange Server®   Creates a secure connection to the Exchange server used to retrieve incoming Web Help Desk ticket emails sent from clients. 
PostgreSQL Creates a secure connection to an external PostgreSQL database. 

Upload an SSL certificate

Download the SSL certificate file in CER format from the certificate provider. After you unzip the file, upload the .p12 or .pfx certificate into Web Help Desk.  

  1. Download the SSL certificate from the third-party software website.
  2. Unzip the file. 
  3. Log in to Web Help Desk as an administrator.
  4. Click Setup > General > Certificates.
  5. Under Certificates in the keystore, click Upload, and then click Browse.
  6. Navigate to the unzipped file directory.
  7. Complete the on-screen prompts to install the SSL certificate.
  8. Click Restart to restart the Web Help Desk server.
    The SSL certificate is installed on the Web Help Desk server. 

Delete a certificate

  1. Select a certificate in the keystore.
  2. Click Delete.
  3. Follow prompts on your screen to delete the certificate.

Edit an alias

Some resources require the keypair to have a specific alias. For example, the Apache Tomcat web server requires its keypair to have a tomcat alias to enable HTTPS. To change the certificate alias, upload the certificate into the keystore. When you are finished, select the certificate and edit the alias.

If the alias name is empty or incorrect, the resource will not use the correct certificate and create its own certificate.

  1. Locate the alias name required for the certificate. 
  2. Select a certificate in the keystore.
  3. Click Edit Alias.
  4. Enter a new name for the certificate, and click Save.
    The new certificate name displays in the keystore list. 

Apple Push Notification Services certificates

APNS requires an APNS Certificate that establishes the communications link between APNS and the Apple device. This certificate is included with Web Help Desk.

The APNS panel displays the current APNS Certificate expiration date and allows you to upload a new APNS Certificate file when the existing file expires.

To enable APNS on an Apple device:

  1. Set up and register the device with the Web Help Desk server.
  2. Enable SMS on the Apple device.
  3. Send a test notification message to the Apple device to verify that APNS is enabled.

Set up and register a device

Install the Web Help Desk Mobile software and register the Apple device with the Web Help Desk server. 

  1. Locate the following Web Help Desk server information:
    • Host name or IP address
    • Port number (secure TCP 8443 or non-secure TCP 8081)
  2. Download Web Help Desk Mobile from the Apple iTunes site.
  3. Install the software on the Apple device.
  4. Complete the online registration form.
  5. Log in to Web Help Desk.
  6. Click Setup > Techs > Techs.
  7. Click your name in the Tech Name column.
  8. In the Account Info tab, scroll down to Mobile Devices Setup and verify that your Apple device displays as a registered device.

Enable the Short Message Service (SMS)

Enable Web Help Desk to send SMS text messages to the Apple device. 

  1. In the Account Info tab, click  to enter Edit mode.
  2. Scroll down to E-Mail Setup and select the SMS E-Mail Enabled checkbox.
    Additional options display under the setting.
  3. Enter the email address associated with the Apple device.
    For example, if the device uses Verizon email, enter joeadmin@vtext.com.

    Contact your mobile carrier for the proper email format.

  4. Select the minimum ticket priority that triggers an SMS e-mail to the Apple device.
  5. Select the minimum ticket alert level that triggers an SMS e-mail to the Apple device.
  6. (Optional) Select the Repeating check box to continue sending SMS e-mails until the ticket condition is updated.
  7. Click Save.

Send a test notification message

Verify that the Apple device receives APNS notifications from the Web Help Desk server. 

  1. Click Setup > General > Certificates in the Web Help Desk Console.
  2. Under Apple Push Notification Services, click Send Test Notification.
  3. Verify that you received a notification on your Apple device.
    APNS is configured for the Apple device.

Upload and install a new APNS certificate

When the APNS certificate expires, download a new APNS Certificate from the SolarWinds Customer Portal and install the certificate using the Web Help Desk Console.

  1. Download an updated APNS certificate.
    1. Log in to the SolarWinds Customer Portal.
    2. Click the License Management drop-down menu and select My Downloads.
    3. Click the Products drop-down menu and select Web Help Desk. 
    4. Under Additional Downloads, locate the Apple Push Notification (APN) Certificate.
    5. Click Download.
      The file is downloaded to the server. 
  2. Unzip the file contents to a network share. 
  3. Click Setup > General > Certificates in the Web Help Desk Console.
  4. Under Upload a new APNS Certificate file, click Browse.
  5. Navigate to the unzipped file.
  6. Complete the on-screen prompts to complete the upload.
  7. Click Restart to restart the Web Help Desk server.
    The new APNS certificate is installed and the new APNS certificate expiration date displays in the Certificates page.
 
Last modified
14:18, 12 Sep 2017

Tags

Classifications

Public