File:         readme.txt
Date:         21 Mar 2024
Description:  Smarx4NET 3.1 / Smarx4NET Core Package for the CRYPTO-BOX
******************************************************************************
3.0.20.1127 27Nov2020   AM
- Smarx4Net.dll/Smarx4NetCore.dll: IPv6 support added
[Package root]\SmarxOS-SDK\dotNET Core\Any CPU\Smarx4NetCore.dll
[Package root]\SmarxOS-SDK\Smarx4NET45\Any CPU\Smarx4Net.dll

3.1.24.125  05FEB2024   AM
- Smarx4Net.dll: SocketException bug fixed, increased connection speed
[Package root]\SmarxOS-SDK\Smarx4NET45\Any CPU\Smarx4Net.dll

3.1.24.321  21Mar2024   AM
- Smarx4NetCore.dll: SocketException bug fixed, increased connection speed
[Package root]\SmarxOS-SDK\dotNET Core\Any CPU\Smarx4NetCore.dll


Content:

1. Overview
2. General Requirements
3. Package Content
4. Notes for Developers switching from CBIOS4NET to Smarx4NET


1. Overview
-----------

Smarx4NET is an object oriented, component based Smarx API for C# developers. Smarx4NET combines 
all Smarx programming interfaces under one roof for .NET platform:  
- CBIOS (network mode) and DO API (including CDO support);
- RU API (Remote Update API) 

Smarx4NET covers the following types of MARX hardware:
- CRYPTO-BOX(R) XS/Versa (CBU XS/VS);
- CRYPTO-BOX(R) SC (CBU SC).

Compared to the CBIOS4NET interface (the corner stone of Smarx4NET), Smarx4NET is based on fully 
managed code which makes the implementation more flexible. There is no need for VC Redistributables 
anymore.

Smarx4NET supports .NET Framework 4.5.1+ and .NET Core 2.1 or later (Smarx4NET Core).
It is ideal for protecting multi-device applications for desktop and mobile usage.

Smarx4NET runs in network mode, which requires an installation of the CBIOS Server (either on the 
same computer or in the network):
https://www.marx.com/en/support/downloads#networktools

NOTE: 
a) For a general introduction to API implementation for the CRYPTO-BOX, please refer to the 
   White Paper "Implementation with API into the source code" at:
   https://www.marx.com/en/support/documents#whitepapers

b) When using Smarx4NET it is highly recommended to consider network based scenario for all your products when 
   they are protected with the same CRYPTO-BOX. Or at least to be careful when using local access in parallel 
   (e.g. via CBIOS4NET or other MARX libraries), especially:
   - Put all API commands which require UPW login into login/logout brackets 
   - Do not use LockBox function in local mode
   to make sure that CRYPTO-BOX is not blocked for Smarx4NET based applications!

c) For Developers Guide, see "CBIOS4NET/Smarx4NET API Reference for C#.NET Developers" at:
   https://www.marx.com/en/support/documents#whitepapers
   
d) If you are looking for CBIOS4NET based libraries and sample code instead, see latest "Smarx OS Professional 
   Protection Kit (PPK)" package.





2. General Requirements
-----------------------

Smarx4NET requires Framework.NET 4.5.1 or newer
Smarx4NET Core requires .NET Core 2.1 or newer


3. Package Content
------------------

3.1 Libraries
-------------

- Assembly for .NET 4.5
SmarxOS-SDK\Smarx4NET45\ReadMe.txt

- Assembly for .NET Core
SmarxOS-SDK\dotNET Core\ReadMe.txt

- MSI/MSM redistributables - Smarx4NET 4.5.x assembly installer
Redistributable\Smarx4NET\ReadMe.txt

3.2 Sample Projects
-------------------

- Sample projects for .NET 4.5 - CBIOS, DO, RFP and network licensing samples:
\SmarxOS-Samples\CBIOS\MSVS2013 (SMARX4NET)
\SmarxOS-Samples\DO\MSVS2013 (SMARX4NET)
\SmarxOS-Samples\RFP\MSVS2013 (SMARX4NET)
\SmarxOS-Samples\Network Licensing\MSVS2012 (SMARX4NET)

Besides basic network licensing functionality, the SmarxNetworkLicensing sample demonstrates how to 
handle typical situations, such as recognizing and handling CRYPTO-BOX unplug/plug events; or covering 
various network connectivity problems/CBIOS Network Server stopped responding situation.

- Sample projects for .NET Core - CBIOS, DO and RFP
\SmarxOS-Samples\DO\MSVS2017 (SMARX4NETCORE)
\SmarxOS-Samples\RFP\MSVS2017 (SMARX4NETCORE)


4. Notes for Developers switching from CBIOS4NET to Smarx4NET
-------------------------------------------------------------

I.    Network mode:
Some code modification is required for new Smarx4NET interface only.  Biggest advantage: There is no need 
to distribute VC Redistributable anymore (like for CBIOS4NET).

II.   Local mode:
More changes could be required here because of switching from local to network model.  Smarx4NET 3.0 introduces 
ILocalCBManager managing CBIOS Server service locally. The ILocalCBManager will connect to local host 
automatically; besides it will be able to test if CBIOS Server service is running and launch it if not.

When considering Smarx4NET for local mode it is necessary to install also the 'CBIOS Network Server.msi' component, 
for example:
msiexec /i "CBIOS Network Server.msi" /quiet
will install CBIOS Network Server as a service (by default) using quiet mode  (without UI).
For more details on CBIOS Network Server administration, see readme in the CBIOS Server package at:
https://www.marx.com/en/support/downloads#networktools

Compatibility CBIOS4NET issues:
DO Load / Save map issue: Smarx4NET is not compatible with CBIOS4NET map file.

More details on differences between CBIOS4NET and Smarx4NET can be found in the 
"CBIOS4NET/Smarx4NET API Reference for C#.NET Developers" at chapter 1.2:
https://www.marx.com/en/support/documents#whitepapers


**** Copyright (c) 2002, 2024 MARX(R) CryptoTech LP ****