Difference between revisions of "Upgrading Stunnel to the Latest Version"

From Vital Soft Wiki
Jump to: navigation, search
(Verify the TLS Level Used for the Connection)
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
'''DO NOT UPGRADE STUNNEL''' until you have been contacted by Vital Soft or Fiserv and told that it is ok to proceed.
+
'''NOTE:'''
 +
* You must upgrade stunnel on all workstations using Visimage3 prior to '''July 29th, 2025'''. 
 +
* Don't forget to also update any virtual machines that run Visimage3 scheduled jobs.
  
 
=== Prepare for Stunnel Upgrade ===
 
=== Prepare for Stunnel Upgrade ===
* Please note that installation does require a reboot of your PC / workstation.
+
* Please note that installation may require a reboot of your PC / workstation.
 
* You may need Admin level access to your PC to complete the install.
 
* You may need Admin level access to your PC to complete the install.
* Save copies of the following 3 files (in another location) - you will need them later in the upgrade process.
+
* Save copies of the following 2 files (in another location) - you will need them later in the upgrade process.
 
<pre>
 
<pre>
 
C:\Program Files\stunnel\certs.pem
 
C:\Program Files\stunnel\certs.pem
 
C:\Program Files\stunnel\stunnel.pem
 
C:\Program Files\stunnel\stunnel.pem
C:\Program Files\stunnel\stunnel.conf
 
 
</pre>
 
</pre>
 
* Download the latest version of stunnel [https://stunnel.org/downloads here].
 
* Download the latest version of stunnel [https://stunnel.org/downloads here].
 +
** Choose the file: stunnel-5.75-win64-installer.exe
 +
* Run Visimage, goto Edit Connections and make a note of the port number(s) you are using for LIVE/EOM and CERT.
 +
** You are probably using 30501 and 30502, or 30503 and 30504.
  
 
=== Uninstall the Previous Version of Stunnel ===
 
=== Uninstall the Previous Version of Stunnel ===
Line 17: Line 21:
 
Run the Windows Services program, locate the stunnel service and click Stop.
 
Run the Windows Services program, locate the stunnel service and click Stop.
 
</pre>
 
</pre>
* Uninstall the currently installed version (5.01) of stunnel by running the following program.
+
* Uninstall the currently installed version (5.01) of stunnel using Add/Remove Programs or by running the following program.
 
<pre>
 
<pre>
 
C:\Program Files\stunnel\uninstall.exe
 
C:\Program Files\stunnel\uninstall.exe
Line 28: Line 32:
 
** By default, stunnel will be installed in <code>C:\Program Files (x86)\</code>
 
** By default, stunnel will be installed in <code>C:\Program Files (x86)\</code>
 
** During installation you will be asked questions to create a default certificate.  This certificate will not be used, so you can enter whatever values you choose or just press Enter on all of the prompts.
 
** During installation you will be asked questions to create a default certificate.  This certificate will not be used, so you can enter whatever values you choose or just press Enter on all of the prompts.
** Do NOT run stunnel at the end of installation.
+
** Do '''NOT''' run stunnel at the end of installation.
  
 
=== Install the Certificates ===
 
=== Install the Certificates ===
 
* Copy the the saved certificate files from step 1 (certs.pem, stunnel.pem) into the following directory:
 
* Copy the the saved certificate files from step 1 (certs.pem, stunnel.pem) into the following directory:
 
<pre>
 
<pre>
C:\Program Files (x86)\stunnel\conf
+
C:\Program Files (x86)\stunnel\config
 
</pre>
 
</pre>
 +
 
=== Customize the Stunnel Configuration ===
 
=== Customize the Stunnel Configuration ===
* Edit the stunnel configuration file. The file is located here:
+
* Edit the stunnel configuration file.  
 +
* Run Notepad (or Notepad++) as Administrator
 +
* Open and edit the following file:
 
<pre>
 
<pre>
C:\Program Files (x86)\stunnel\conf\stunnel.conf
+
C:\Program Files (x86)\stunnel\config\stunnel.conf
 
</pre>
 
</pre>
 
* Remove the semi-colon comments from the debug and output lines (lines 11 & 12):
 
* Remove the semi-colon comments from the debug and output lines (lines 11 & 12):
Line 46: Line 53:
 
</pre>
 
</pre>
 
* Add the following lines after "output=stunnel.log":
 
* Add the following lines after "output=stunnel.log":
 +
** Check that the accept port numbers match what you are currently using.  If not, make the appropriate edits.
 
<pre>
 
<pre>
 
CAfile = certs.pem
 
CAfile = certs.pem
Line 53: Line 61:
 
; Prod connection to Linux
 
; Prod connection to Linux
 
client = yes
 
client = yes
accept = 30503
+
accept = 30501
 
connect = visimage.fiservapps.com:8004
 
connect = visimage.fiservapps.com:8004
  
Line 59: Line 67:
 
; Cert connection to Linux
 
; Cert connection to Linux
 
client = yes
 
client = yes
accept = 30504
+
accept = 30502
 
connect = visimage-cert.fiservapps.com:8004
 
connect = visimage-cert.fiservapps.com:8004
 
</pre>
 
</pre>
 +
 
=== Install the Stunnel Service ===
 
=== Install the Stunnel Service ===
* Install the stunnel '''service''' using Powershell.  If you installed stunnel for all users on the computer, you may need to run Powershell as the Administrator.
+
* Run Powershell as the Administrator and uninstall/reinstall the stunnel '''service'''
 
* When Windows Powershell is running, enter the following commands:
 
* When Windows Powershell is running, enter the following commands:
 +
** Paste the commands individually (not all 3 at once).
 
<pre>
 
<pre>
cd C:\Program Files (x86)\stunnel\bin
+
cd C:\"Program Files (x86)"\stunnel\bin
 
./stunnel -uninstall
 
./stunnel -uninstall
 
./stunnel -install
 
./stunnel -install
 
</pre>  
 
</pre>  
* Reboot your PC.
+
* Restart the "Stunnel TLS wrapper" service.  If Services is still running, exit and restart Services as the Administrator so that the list of services is refreshed.
 +
** If you receive an error, or the service does not restart, reboot your PC.
  
 
=== Verifying the Installation ===
 
=== Verifying the Installation ===
* Run Windows Services and verify that the stunnel service is running.  The service is now called "Stunnel TLS Wrapper".
+
* If you rebooted your PC, run Windows Services and verify that the stunnel service is running.  The service is now called "Stunnel TLS Wrapper".
 
* If the service is running, launch Visimage3 and test that you are able to successfully start server.
 
* If the service is running, launch Visimage3 and test that you are able to successfully start server.
 +
 +
=== Verify the TLS Level Used for the Connection ===
 +
* After successfully starting server in Visimage, open the <code>C:\Program Files (x86)\stunnel\config\stunnel.log</code> file.
 +
* Look for the following lines toward the bottom of the log file:
 +
<pre>
 +
TLS connected: new session negotiated
 +
TLSv1.3 ciphersuite: TLS... (256-bit encryption)
 +
</pre>
 +
* If your TLS level is 1.2 or 1.3 you are all set.
 +
* If the TLS level is 1.1 or lower, contact Vital Soft support for assistance.
  
 
[[Visimage3 Setup for Fiserv Online Clients|Back...]]
 
[[Visimage3 Setup for Fiserv Online Clients|Back...]]

Latest revision as of 18:07, 14 July 2025

NOTE:

  • You must upgrade stunnel on all workstations using Visimage3 prior to July 29th, 2025.
  • Don't forget to also update any virtual machines that run Visimage3 scheduled jobs.

Prepare for Stunnel Upgrade

  • Please note that installation may require a reboot of your PC / workstation.
  • You may need Admin level access to your PC to complete the install.
  • Save copies of the following 2 files (in another location) - you will need them later in the upgrade process.
C:\Program Files\stunnel\certs.pem
C:\Program Files\stunnel\stunnel.pem
  • Download the latest version of stunnel here.
    • Choose the file: stunnel-5.75-win64-installer.exe
  • Run Visimage, goto Edit Connections and make a note of the port number(s) you are using for LIVE/EOM and CERT.
    • You are probably using 30501 and 30502, or 30503 and 30504.

Uninstall the Previous Version of Stunnel

  • Stop the Stunnel service
Run the Windows Services program, locate the stunnel service and click Stop.
  • Uninstall the currently installed version (5.01) of stunnel using Add/Remove Programs or by running the following program.
C:\Program Files\stunnel\uninstall.exe
  • Verify that the C:\Program Files\stunnel directory was removed. If it remains, use File Manager to delete it.

Install Stunnel

  • Install the most recent version of stunnel (5.75 in June 2025.)
    • Choose the options that are appropriate for your organization.
    • By default, stunnel will be installed in C:\Program Files (x86)\
    • During installation you will be asked questions to create a default certificate. This certificate will not be used, so you can enter whatever values you choose or just press Enter on all of the prompts.
    • Do NOT run stunnel at the end of installation.

Install the Certificates

  • Copy the the saved certificate files from step 1 (certs.pem, stunnel.pem) into the following directory:
C:\Program Files (x86)\stunnel\config

Customize the Stunnel Configuration

  • Edit the stunnel configuration file.
  • Run Notepad (or Notepad++) as Administrator
  • Open and edit the following file:
C:\Program Files (x86)\stunnel\config\stunnel.conf
  • Remove the semi-colon comments from the debug and output lines (lines 11 & 12):
debug=info
output=stunnel.log
  • Add the following lines after "output=stunnel.log":
    • Check that the accept port numbers match what you are currently using. If not, make the appropriate edits.
CAfile = certs.pem
cert = stunnel.pem

[Visimage Linux Prod]
; Prod connection to Linux
client = yes
accept = 30501
connect = visimage.fiservapps.com:8004

[Visimage Linux Cert]
; Cert connection to Linux
client = yes
accept = 30502
connect = visimage-cert.fiservapps.com:8004

Install the Stunnel Service

  • Run Powershell as the Administrator and uninstall/reinstall the stunnel service
  • When Windows Powershell is running, enter the following commands:
    • Paste the commands individually (not all 3 at once).
cd C:\"Program Files (x86)"\stunnel\bin
./stunnel -uninstall
./stunnel -install
  • Restart the "Stunnel TLS wrapper" service. If Services is still running, exit and restart Services as the Administrator so that the list of services is refreshed.
    • If you receive an error, or the service does not restart, reboot your PC.

Verifying the Installation

  • If you rebooted your PC, run Windows Services and verify that the stunnel service is running. The service is now called "Stunnel TLS Wrapper".
  • If the service is running, launch Visimage3 and test that you are able to successfully start server.

Verify the TLS Level Used for the Connection

  • After successfully starting server in Visimage, open the C:\Program Files (x86)\stunnel\config\stunnel.log file.
  • Look for the following lines toward the bottom of the log file:
TLS connected: new session negotiated
TLSv1.3 ciphersuite: TLS... (256-bit encryption)
  • If your TLS level is 1.2 or 1.3 you are all set.
  • If the TLS level is 1.1 or lower, contact Vital Soft support for assistance.

Back...