Token Software Installation Guide

Transcription

1 This document explains how to install and how to remove the 3SKey token software. 02 December 2016

2 Table of Contents Table of Contents Preface Token Software Installation Prerequisites Obtain the Token Installation Software Download the installation software Unzip and run the software installation file Configure Internet Explorer Settings Configure Java Settings Install the Token Software in Interactive Mode Install the Token Software in Silent Mode Remove the Token Software Remove the Token Software in Interactive Mode Remove the Token Software in Silent Mode Legal Notices December

3 Preface Preface Purpose of the document Audience This document explains how to install and how to remove the token software for your 3SKey token. This document is for 3SKey token administrators, users and system administrators. Significant changes The following table lists significant changes since the March 2015 release. This does not include various edits that have been made. New information The configuration of Internet Explorer settings has been updated. Location Configure Internet Explorer Settings on page 8 The configuration of Java settings has been updated. Configure Java Settings on page 9 The token software installation procedure is the same for both token types (basic token and high token) and has been simplified. Updated screenshots have been added to illustrate the installation procedure in interactive mode Updated screenshots have been added to the installation procedure for silent mode due to the renaming of the properties file. Updated screenshots have been added to illustrate the removal procedures. Obtain the Token Installation Software on page 6 Install the Token Software in Interactive Mode on page 10 Install the Token Software in Silent Mode on page 15 Remove the Token Software on page December

4 Token Software Installation Prerequisites 1 Token Software Installation Prerequisites General prerequisites Administrator rights are required to install the necessary drivers and software. Your PC must be running one of the following operating systems: - Windows Vista (32-bit) with Service Pack 1 or higher - Windows 7 (32-bit or 64-bit), optionally with a Service Pack - Windows 8 (32-bit or 64-bit) - Windows 8.1 (32-bit or 64-bit) - Windows 10 (32-bit or 64- bit) - Windows Server 2008 R2 (32-bit or 64-bit) - Windows Server 2012 (64-bit) To access the 3SKey portal, you must use one of the following versions of Internet Explorer: - Internet Explorer 8.0 (32-bit) - Internet Explorer 9.0 (32-bit) - Internet Explorer 10.0 (32-bit) - Internet Explorer 11.0 (32-bit) For Windows 8 and above: make sure that you have switched to desktop mode before launching internet explorer. Your PC must have free space of at least 500 MB. To check this, open Windows Explorer, right-click the C: drive and select Properties. A System (C:) Properties window opens: 02 December

5 Token Software Installation Prerequisites To access the 3SKey portal, your system requires a 32-bit version of the Java Runtime Environment (JRE). SWIFT officially recommends Java version 8 for use with 3SKey portal. However, 1.6.0_32 for Java 6 and 1.7.0_7 for Java 7 are also supported. The Windows Script Host (WSH) must be enabled for the.vbs scripts used by the installer to execute properly. This setting is enabled by default. The Windows Smart Card Service must be started for the proper detection of the certificate by the SafeNet authentication client. This service is started by default. You can install the token software on a PC that is running either the 32-bit version or the 64-bit version of Windows. However, you must use the 32-bit versions of Internet Explorer and the Java Runtime Environment to access the 3SKey portal and configure your tokens. The installation procedure checks that the required versions are installed on your system. For more information, see Install the Token Software in Interactive Mode on page 10. 3SKey with Citrix or Microsoft Terminal Services The use of a 3SKey token is compatible with a Citrix environment or a Microsoft Terminal Services environment. For more information about setting up and using 3SKey in an environment that includes one of these technologies, see the 3SKey self help. 02 December

6 Obtain the Token Installation Software 2 Obtain the Token Installation Software Before you can use your token, you must obtain and download the token installation software. First, identify your token. There are two types of 3SKey tokens: 3SKey basic token (etoken PRO) The 3SKey basic token only stores a 3SKey certificate. 3SKey high token (etoken NG-FLASH) The 3SKey high token contains a 3SKey certificate and a 2GB Flash memory that can be used to store documents. The Flash memory contains a copy of the installation sources and the 3SKey. Regardless of token type, SWIFT recommends you download the latest version of the installation software from the 3SKey portal. 2.1 Download the installation software Procedure 1. For Windows 8 and above: From the Start window, click the Desktop tile to enter desktop mode. 2. Navigate to 3. On the Getting started page, there is a link that enables you to download the token installation software. Click the link. 4. Save the software installation file on your PC. The file name is 3SKey_token_install_v zip. 2.2 Unzip and run the software installation file Procedure 1. Navigate to the folder in which you saved the installation software zip file. Either unzip the archive and navigate to the extracted folder OR Double-click the zip file. In either case, the following window appears. 02 December

7 Obtain the Token Installation Software 2. Double-click the software installation file contained within the zip file. The Welcome to the SWIFT Token Client Installer window opens and you are ready to start the installation in Interactive Mode. Refer to Install the software on page December

8 Configure Internet Explorer Settings 3 Configure Internet Explorer Settings The required Internet Explorer settings are normally part of its default settings. If the default settings of Internet Explorer have been modified, then make sure that the correct settings are selected or enabled. You can access the settings by going to Internet Explorer > Tools > Internet Options > Advanced. SWIFT recommends correctly configuring the Internet Explorer Settings to improve PC performance and to avoid pop-up warning messages. Item HTTP 1.1 settings > Use HTTP 1.1 HTTP 1.1 settings > Use HTTP 1.1 through proxy connections Security > Check for server certificate revocation Security > Use SSL 2.0 Security > Use SSL 3.0 Security > Use TLS 1.0 Security > Use TLS 1.1 Security > Use TLS 1.2 Security > Warn about certificate address mismatch Setting Must NOT be selected Must NOT be selected Must NOT be selected It is recommended to select all TLS versions. It is recommended to select all TLS versions. 02 December

9 Configure Java Settings 4 Configure Java Settings The following settings of the Java plug-in are normally part of its default settings. If the default settings of the Java plug-in have been modified, then make sure that the following settings are configured as described. You can access the settings by going to the Java Control Panel > Advanced. Depending on the version of Java that you are using some of the settings may not be applicable. If a setting does not exist for your version, then please ignore it. SWIFT recommends correctly configuring the Java Settings to improve PC performance and to avoid pop up warning messages. Item Default Java for Browsers > Microsoft Internet Explorer Java Plug-in > Enable the next generation Java Plugin (requires browser restart) Secure Execution Environment > Allow users to grant permissions to signed content Perform certificate revocation checks on > Do not check (not recommended) Advanced Security Settings > Use certificates and keys in browser keystore Security > Use SSL 2.0 Security > Use SSL 3.0 Advanced Security Settings > Use TLS 1.0 Advanced Security Settings > Use TLS 1.1 Advanced Security Settings > Use TLS 1.2 Setting. It is mandatory to import the SWIFT CA into the browser. Must NOT be selected Must NOT be selected Can be selected. This option is NOT recommended for Java versions prior to: Java 7, update 79 Java 8, update 45 In case of any problems with Java settings, refer also to the article Issues related to Java. 02 December

10 Install the Token Software in Interactive Mode 5 Install the Token Software in Interactive Mode Install the software Prerequisites To install or remove the token software on a PC in interactive mode, you must have administrator rights for that PC. Note Procedure SWIFT recommends that you close all other applications running on the PC before installing the token software. 1. Remove all USB tokens. 2. After you double-click the software installation file, the Welcome to the SWIFT Token Client Installer window opens. This window informs you of the actions that are performed during installation. Click Next. 02 December

11 Install the Token Software in Interactive Mode The SWIFT Token Client Location window opens. Important Although it is possible to customise the options, SWIFT recommends that you accept the proposed installation options. 3. If you want to customise the installation, then you can do so by selecting or clearing the following options: Install SafeNet Authentication Client - the installer checks whether there is already an appropriate version of the SafeNet Authentication Client installed on the PC and installs it if needed. The SafeNet software contains the drivers needed for the token to be recognised. You can clear this box if you want to install the SafeNet software after the token software is installed. Install SWIFT Token Client - this configures the SWIFT environment on the PC and, therefore, you cannot modify this setting. Import SWIFT CA certificate - if you select this box, the installer automatically imports the SWIFT CA certificate on to your PC. Clear this box if your company policy does not allow you to import certificates. Depending on your Java version and settings, logging in to the 3SKey portal to activate and manage your tokens might not be possible if the SWIFT CA certificate is not installed. Note If you clear this option and you want to import the SWIFT CA certificate after the token software is installed, then refer to the 3SKey Troubleshooting Guide on under Documentation for the SWIFT CA certificate import procedure. Configure Browser settings - if you select this box, then the installer adds 3skey.com and swift.com to the Trusted Sites zone of Internet Explorer. It also enables TLS version 1.0, TLS 1.1 and TLS 1.2 on your internet browser and disables SSL 2.0 and SSL 3.0 as these options are considered not secure. Please check the recommended TLS and SSL settings in the section Configure Internet Explorer Settings on page 8 and the section Configure Java Settings on page 9. When you have selected your installation options, click Next. 4. The SWIFT Token Client Location window opens. 02 December

12 Install the Token Software in Interactive Mode It shows the proposed folder location for the software installation files. If you want to change the default location, then click Browse... and navigate to the required folder for installation. However, the SafeNet authentication software is stored in a default folder that cannot be changed. The location of this software is shown in the field SafeNet Authentication Client Folder Name. Click Next. 5. The installer then runs a test to verify that the PC can support the token software installation. This can take a few moments to complete. If one or more of the configuration tests fail, then the System Configuration Test Results window opens. If all of the configuration tests are successful, then the SWIFT Token Client Installer confirmation window opens (see the next step). Note Windows 10 is wrongly reported during installation as not supported. Windows 10 is however fully supported and qualified. The tests compare the Recommended conditions for installation to the Actual conditions of the user's PC. The Result in each case appears as OK, as a Warning or an ERROR. If there is a Warning/ERROR, then an explanation appears in the lower half of the screen. In the case of a Warning, the installation can continue. In the case of an ERROR, it cannot. In the example above, the PC does not have a recommended version of Java installed on it. It is only a Warning because the installation can complete with a lower version of Java, but there can be problems when accessing the SWIFT portal. In this case, there is also a link directly to the Java web site from where you can download the latest version of Java software. Click Next. 6. The SWIFT Token Client Installer confirmation window opens. 02 December

13 Install the Token Software in Interactive Mode It confirms the actions that are performed during installation. Click Install to proceed with the installation. The installation can take a couple of minutes. Do not interrupt the installation procedure during this time. 7. The results of the installation appear. If there is a Warning, then an explanation appears at the bottom of the window. Click Next. 8. The Installation Complete window opens. 02 December

14 Install the Token Software in Interactive Mode Click Finish. 9. The Reboot notice window opens. Restart your computer to complete the installation. Click Restart now or Restart later. 02 December

15 Install the Token Software in Silent Mode 6 Install the Token Software in Silent Mode In silent mode, you can remotely install the token software without interactive user input. The installation procedure takes the input from a response file instead. You must extract the installer files to one location, and use a script to install the token software in silent mode. Prerequisites To install or remove the token software on PCs in silent mode, you must have administrator rights for all of the PCs involved. Note Procedure SWIFT recommends that you close all other applications running on the PC before installing the token software. 1. Extract the contents of the zip file, including the Silent subfolder to a folder of your choice. 2. Start a DOS command window and navigate to that folder. Execute the following command to start the silent installation: 3SKey_token_install.exe -silent silent\silentinstall.properties If you want to customise the installation, then you can do so by setting the options in the file silent-install.properties. This file provides the explanation of each option available. 02 December

16 Remove the Token Software 7 Remove the Token Software You must have administrator rights on each PC from which you want to remove the token software. 7.1 Remove the Token Software in Interactive Mode Procedure 1. From the Control Panel menu, ensure that you have the View by: Category option active. Click the link Uninstall a program. The Uninstall or change a program window opens. 2. Select the appropriate SWIFT Token Client program from the list and click Uninstall. The Welcome to the SWIFT Token Client Uninstaller window opens. 3. Click Next. Click Yes to confirm the uninstallation. The Uninstallation Complete window opens. Click Finish. The Reboot notice window opens. The token software is removed, but you must restart your computer for the uninstallation to take effect. You can choose to Restart now or Restart later. 7.2 Remove the Token Software in Silent Mode In silent mode, you can remotely uninstall the token software without interactive user input. To install or remove the token software on PCs in silent mode, you must have administrator rights for all of the PCs involved. 02 December

17 Remove the Token Software Note The directory in which the uninstall command is executed is important. The command must not be under the installation directory otherwise the uninstaller will not be able to remove some installation files. Execute the uninstaller as shown in the above example. The uninstall.exe-silent command line requires a response file as argument. A sample response file is present in the installation folder at %PDI_HOME%\..\config\silentuninstall.properties. 02 December

18 Legal Notices Legal Notices Copyright SWIFT All rights reserved. Disclaimer The information in this publication may change from time to time. You must always refer to the latest available version. Translations The English version of SWIFT documentation is the only official and binding version. Trademarks SWIFT is the trade name of S.W.I.F.T. SCRL. The following are registered trademarks of SWIFT: the SWIFT logo, SWIFT, SWIFTNet, Accord, Sibos, 3SKey, Innotribe, the Standards Forum logo, MyStandards, and SWIFT Institute. Other product, service, or company names in this publication are trade names, trademarks, or registered trademarks of their respective owners. 02 December