/****************************************************************************** Copyright: : MARX(R) CryptoTech LP File: : readme.txt Date: : July 13, 2017 Description: : Smarx Cloud Security (WEB API) Client Proxy : Server Setup Version: : 6.0.706.713 (v. 6.0 build 6 of 13-Jul-2017) Target Operating Systems: : Win10-7/2012-2016 Server Applicable for Product: : CRYPTO-BOX(R) SC / XS / Versa, Smarx OS formatted, : firmware v2.2 or higher ******************************************************************************* 1. Version Information ******************************************************************************* 6.0.17.202 02FEB2017 KU Initial version 6.0.702.213 13FEB2017 KU Issues in Proxy logic fixed, installation dialog (when selecting network/localhost mode) was modified 6.0.705.615 15JUN2017 KU HTTPS support added 6.0.706.713 13JUL2017 KU Target dir fix ******************************************************************************* Files: WebSecClientSetup.exe - Cloud security client setup installquiet.bat - Batch example for quiet installation setup.iss - sample script for quiet installation https_support.txt - details on using https mode readme.txt - this file ******************************************************************************* 2. Overview ******************************************************************************* Smarx(R) Cloud Security (WEB API) furnishes web portals, online services, databases, or any other internet or intranet based application with a secure user identification - only users with a valid CRYPTO-BOX(R) have access to the content. It provides online authentication for many fields of application: support only for paying customers, access to content only for authorized service personnel, and much more. The Smarx Cloud Security client allows cloud-based applications to access the CRYPTO-BOX unit(s) attached to the USB port of any computer on the network by implementing the WEB API server component (available for PHP, Java/JSP or ASP.NET). It takes care of managing the remote connections and forwards license queries to the attached CRYPTO-BOX unit(s). The client can be any web browser running on the same computer as the proxy server, or even another device (including PCs, tablets, mobile phones, etc.) running in the same network (assumes that the client is running in network mode - see point 2 below for details). This setup will install the WEB API client. The latest version of the setup can be downloaded from our web page: https://www.marx.com/en/support/downloads?direct=network The WEB API server components are included to the WEB API package which can be bought directly at www.marx.com: https://www.marx.com/en/products/cloud-security-toolkit/151 Scroll down to the "Smarx Cloud Security (WEB API) White Paper" which provides further implementation details for the server side. ******************************************************************************* 3. Installation ******************************************************************************* 3.1. Normal Installation ------------------------------ Run WebSecClientSetup.exe to start the installation. During installation, the setup allows you to choose between different options. a) Transfer Protocol The setup asks you to specify the transfer protocol used between the client and the website. You can choose between "HTTP" (default) and "Both HTTP and HTTPS". The second option requires to install a certificate and submit the certificate hash. See included https_support.txt for further details. b) Client Installation Mode The next option to specify is the installation mode. There are two modes available: - Network License Management - Proxy Server will serve requests coming from web browser(s) running on any computer including this one (localhost), smartphones or tablets on the local network - Local License Management - Proxy Server will only serve requests from local web browser(s) running on this computer (localhost) Remark: The WEB API client component acts as proxy server between the client browser and the CRYPTO-BOX: Web Application (using the WEB API server component) <--> <--> Client Browser (running on any computer, tablet or smartphone) <--> <--> WEB API Client Component (Proxy Server) <--> CRYPTO-BOX c) Communication Port Choose the port used for communication with the client. Default value is 23789. Note: Port values from 23789 to 23791 are autodetected by browser ("Web API 6.0 js component"). Other port values are to be specified manually. d) Start Options The last options to choose is how the WEB API client component is launched: - Launch Cloud Security Client -> This will start the client directly after installation - Auto-start Cloud Security Client -> This will start the client automatically each time when Windows starts 3.2. Quiet Installation ------------------------------ You can use the following command line options to run the WEB API proxy server installation in quiet mode (no dialog messages/installation options displayed during setup). WebSecClientSetup.exe /s /f1"" - where setup.iss - is a script file with desired dialog choices. Note: You can use install.bat provided as ready-for-launch quiet Installation script. A setup.iss file provided uses the following (default) options settings (see point 2.1 for detailed explanation of these options): - Transfer Protocol set to "HTTP" - Client Installation Mode set to "Network License Management" - Communication Port value set to "23789" - Launch Cloud Security Client set to "Yes" - Auto-start Cloud Security Client set to "Yes" You may edit setup.iss yourself for custom options settings. To do so, execute: WebSecClientSetup.exe /r /f1"" and go through all the steps of installation (right to the finish). A setup.iss file will be created. ******************************************************************************* 4. Important Hints ******************************************************************************* If there are any problems with the detection of the proxy server, please make sure that: - The proxy server is running - If the proxy server is running but cannot be reached by another device in the same network, check your firewall settings You can use your browser to get information about the proxy server version and attached CRYPTO-BOXes: [http|https]://:/commands Example: http://localhost:23789/commands, http://192.168.1.100:23789/commands ******************************************************************************* 5. Technical support and updates ******************************************************************************* The latest version of the WEB API Client Setup is available at https://www.marx.com/en/support/downloads?direct=network For technical support and help on implementation issues please use our Support Ticket System under www.marx.com -> Support -> Support Ticket (MyMARX account and Premium or Business Support required, new customers will have free access to Support Ticket System for 3 months starting from their first purchase). More information on available Support Level Options can be found at www.marx.com -> Support -> Support Level Options ******************************************************************************* 6. Sales and Contact ******************************************************************************* If you have any questions or feedback, please use our contact form at www.marx.com -> About -> Contact U.S.A. ------------------------------ MARX CryptoTech LP 489 South Hill Street Buford, GA 30518 U.S.A. Phone: (+1) 770 904 0369 Fax: (+1) 678 730 1804 contact@marx.com www.marx.com Germany ------------------------------ MARX Software Security GmbH Vohburger Strasse 68 D-85104 Wackerstein Phone: (+49) 8403 / 9295-0 Fax: (+49) 8403 / 9295-40 contact-de@marx.com Sales: (+49) 8403 / 9295-19 or sales-de@marx.com www.marx.com /********* Copyright (c) 2002, 2017 MARX(R) CryptoTech LP ****************** *****************************************************************************/