Copyright:    : MARX(R) CryptoTech LP
File          : readme.txt
Date:         : March 18, 2019
Description   : Smarx(R)OS distributive for GNU\Linux
Author:       : DB

*******************************************************************************
1. Overview
*******************************************************************************

This document contains description of Smarx(R)OS for Linux distributive.
The distributive includes all Smarx(R)OS solutions and technologies, 
currently supported for GNU\Linux based systems.

With this distributive you can:
   - manually protect your application using Smarx(R)OS API
   - use automatic protection (AutoCrypt)
   - program CRYPTO-BOX(R) USB hardware with licensing data
   - use both local and network licensing modes (Smarx(R)OS Network Server)
   - use Online License Management (OLM) with Smarx Cloud Security/Web API

   
*******************************************************************************
2. Distributive content
*******************************************************************************

This distributive includes the following files and folders:

   - readme.txt         - this file
   - 10-cryptobox.rules - example udev rules file
   
   - /autocrypt         - folder with AutoCrypt for Linux packages
                          and demo licensing scripts and CRYPTO-BOX(R) access 
                          codes

   - /smrxprog          - SmrxProg for Linux packages
                  
   - /api               - Smarx(R)OS API libraries and samples for Linux
                  
   - /network_server    - Smarx(R)OS Network Server for Linux
   
   - /web_api_client    - Smarx(R)OS Web API for Linux
                          (deprecated)
   - /SmarxAPI          - NEW! SmarxAPI and AutoCrypt API samples
   

*******************************************************************************
3. Supported Linux distributions
*******************************************************************************

This package was tested on the following Linux distributions:
   - Ubuntu 14.04, 16.04 and 18.04, 64bit
   - CentOS 6.10, 64bit
   - Fedora 29 Workstation, 64bit


*******************************************************************************
4. Usage notes
*******************************************************************************

Using CRYPTO-BOX(R) on Linux systems requires Read-Write permissions for 
CRYPTO-BOX(R) USB device through libusb library. By default only root has 
such permissions.

We support modern libusb-1.0 & libudev. If libusb or libudev is not installed 
on your system, it can be downloaded from it official site 
http://www.libusb.org/ and installed manually or installed using apt-get 
(Ubuntu Linux), yum (Fedora) or any other package management system.

For example, in Ubuntu command line execute command:
   $ sudo apt-get install libusb-1.0-0-dev
   $ sudo apt-get install libudev-dev
In Fedora Linux:
   $ sudo yum install libusb1-devel
   $ sudo yum install libudev-devel

You can use udev rules to configure CRYPTO-BOX(R) permissions.
Access rules can be set by installing packages containing them:
   - Smarx(R)OS Network Server
   - Smarx(R)OS AutoCrypt
   - Smarx(R)OS SmrxProg

Alternatively you can set access rules manually. Just copy 10-cryptobox.rules
file to /rules.d directory: (root rights required):
   $ sudo cp 10-cryptobox.rules /etc/udev/rules.d/
 
and reattach your CRYPTO-BOX(R) for signalizing udev system to reload rules.


*******************************************************************************
5. Version Information
*******************************************************************************

1.15.0421  21APR2015 KS  libusb-1.0 supported, rebuild with new CBIOS functions,
                         Support for latest Linux distributives (Ubuntu 14, 
						 CentOS 7, etc.) without usbfs support which lead to 
						 high processor load with our previous libraries
1.16.0304  04MAR2016 KS  CBIOS libraries: plug-in detection changed, libudev 
                         supported, fixed "bad package" message for server 
                         packages under Ubuntu
1.16.0630  30JUN2016 KS  CBIOS network mode stability improvements, updated 
                         Network Server (built with new CBIOS library)
1.17.1213  13DEC2017 KS  SmarxAPI samples included, CBIOS libraries with 
                         CBIOS2017 updates (extended networking support) and 
						 sample code, RFP library revised: fixed crossplatform 
						 usage scenarios, PIC mode supported
1.19.0207  07FEB2019 KS  New CBIOS static and dynamic libraries (libcbios.a /
                         libcbios.so): No delays when using CBIOS in network 
						 mode, updated Network Server (built with new CBIOS 
						 library)
1.19.0318  18MAR2019 KS  Java library (jnicbios): support for CBU SC 
                         extended AES/RSA encryption functions added
						 
*********** Copyright(c) 2002, 2019 MARX(R) CryptoTech LP *********************
*****************************************************************************/