Readme file for FirmaSAT for Windows Trial Edition.
=============================================================

Version 10.70.40
Copyright (C) 2007-26 DI Management Services Pty Ltd. All rights reserved.

Contents
--------
	1. INSTALLING
	2. UNINSTALLING
	3. COMMAND-LINE UTILITY
	4. FILE LOCATIONS
	5. FILES IN THE DISTRIBUTION
	6. DOT-NET INTERFACE
	7. DOTNET CORE INTERFACE
	8. PYTHON AND JAVA INTERFACES
	9. MORE HELP

1 INSTALLING
---------------
To install on your PC: unzip and click on `Install.exe`. 
You MUST have administrator rights to run this setup program.

+ Requires Windows XP or above.
+ FirmaSAT does NOT require the CryptoSys(tm) PKI Toolkit.

2 UNINSTALLING
-----------------
To uninstall:-
1. Use (W11/W10/W8/W7/Vista)

        Start > Settings > Control Panel > Programs and Features
	
    or (XP)

        Start > Settings > Control Panel > Add/Remove Programs
	    
2. Select `FirmaSAT` and click 'Uninstall' or 'Remove'.

3 COMMAND-LINE UTILITY
--------------------------------
FirmaSAT.exe is a command-line program. To use,

    Start > All Programs > FirmaSAT > FirmaSAT-open
   
which will open a command-line window. Type in your instruction, beginning with `FirmaSAT`.
For Help, type

    FirmaSAT HELP
    FirmaSAT HELP-OPTIONS
   
En espanol,

    FirmaSat AYUDA
    FirmaSAT AYUDA-OPCIONES
   
To ensure that the program is installed properly, type

    FirmaSAT LIBINFO
   
4 FILE LOCATIONS
------------------
* The core Win32 DLL `diFirmaSAT2.dll` is installed in `%SYSTEMROOT%\system32` (typically
  `C:\Windows\system32`). This ensures it can be found by any program that calls it.
  
* On a 64-bit machine, the 32-bit version of `diFirmaSAT2.dll` is installed in
  `C:\Windows\SysWow64` and the 64-bit version is installed in
  `C:\Windows\System32`. Windows will automatically find the correct one depending
  on the application that calls it. 
  
* There is only one .NET class library `diFirmaSatNet.dll` which works on both
  Win32 and X64 platforms.

* The command-line program `FirmaSAT.exe` is installed in `%PROGRAMFILES%\FirmaSAT`. 
  (typically `C:\Program Files\FirmaSAT` or `C:\Program Files (x86)\FirmaSAT` on 64-bit)
  You will need to set the environment path to include this directory (use the batch file
  `SetupForFirmaSAT.bat` to do this temporarily).
  
* The installed command-line program `FirmaSAT.exe` is a 32-bit executable. It
  will work on both Win32 and X64 platforms. If you really need it, there is also
  a 64-bit version of `FirmaSAT.exe` in the X64 sub-folder. 

* Some test files are copied to `%ALLUSERSPROFILE%\FirmaSAT` and the shortcut
  `FirmaSAT-open` will open a command-line window in that directory.
  

5  FILES IN THE DISTRIBUTION
-----------------------------
The following files will be copied into the directory `%PROGRAMFILES%\FirmaSAT`:

* basFirmaSAT.bas - interface module required for VB6/VBA programs
* cd.bat - used by the FirmaSAT-open prompt
* diFirmaSat2.h	- interface file for C/C++ programmers
* diFirmaSAT2.lib - MSVC library interface for C/C++ programmers
* diFirmaSatNet.cs - source code for .NET library diFirmaSatNet.dll
* diFirmaSatNet.dll - library DLL for C#/VBNET programmers
* distrib.txt - how to distribute to your end users (or not for the Trial Edition)
* DoTests.bat - a set of command-line tests using FirmaSAT.exe
* FirmaSAT-open.bat - batch file to open a command-line window
* FirmaSAT.exe - the main command-line executable program
* FirmaSATtestfiles.zip - example files used in the tests
* licence.txt - your licence blurb
* sha256sums.txt - SHA-1 check sums of key files
* readme.txt - this file
* SetupForFirmaSAT.bat - another batch file used to setup the command-line window
* TestFirmaSat.bas - some tests in VB6/VBA
* TestFirmaSat.c - some tests in C/C++
* TestFirmaSat.cs - some tests in C#
* TestFirmaSat.vb - some tests in VBNET (VB2005/8/xx)
* uninstall.exe - used to uninstall the package (do not delete this file and 
  do not use this directly -- use `Control Panel > Programs & Features` 
  or `Add/Remove Programs`)

X64\
* diFirmaSAT2.dll - Core DLL compiled for 64-bit (x64) platform
* diFirmaSAT2.lib - MSVC library file (x64 version)
* FirmaSAT.exe - 64-bit version
* sha256sumsX64.txt - SHA-1 check sums
* readmeX64.txt - more info about using on 64-bit platforms

All the test files with "signed" in their name were generated from the
similarly-named file with "base" using the SAT-supplied test keys. 


6 DOT-NET INTERFACE
---------------------
The .NET interface allows programmers to call functions in FirmaSAT directly
from C# and VBNET (VB2010+) programs for .NET 4.0 and above. 

The core library `diFirmaSAT2.dll` _must_ be installed on your system. The .NET
interface requires you to add a reference to the .NET Class Library file
`diFirmaSatNet.dll` (the core DLL is found automatically provided it is in the
Library Search Path).

* In your application, add a reference to the library:

1. Project > Add Reference.
2. In the .NET tab, click on the Browse button to find and select the library 
   file `diFirmaSatNet.dll`.
3. Click on OK and the wizard will add the reference of the library to your project.

* Add the line (for C#)

    ```
    using FirmaSAT;
    ```

    or (for VBNET)

    ```
    Imports FirmaSAT
    ```

    to your code.

* Use the FirmaSAT methods at will, e.g. in C#

    ```
    using System;
    using FirmaSAT;
    class Program {
      static void Main() {
        int n = General.Version();
        Console.WriteLine("Version = {0}", n);
      }
    }
    ```

    or in VBNET

    ```
    Imports FirmaSAT
    Module Module1
      Sub Main()
        Dim n As Integer
        n = General.Version()
        Console.WriteLine("Version = {0}", n)
      End Sub
    End Module
    ```

7 DOTNET CORE INTERFACE
-------------------------
See [.NET Core Interface for FirmaSAT](https://cryptosys.net/firmasat/fsa-dotnet-core.html)


8 PYTHON AND JAVA INTERFACES
-----------------------------
See [Python Interface to FirmaSAT](https://cryptosys.net/firmasat/python.html) and
[Java Interface to FirmaSAT](http://cryptosys.net/firmasat/java.html).


9  HELP
----------------
+ [On-line manual](https://cryptosys.net/firmasat/manfsa/fsa_topofpage.html)
+ [Documentation](https://cryptosys.net/firmasat/en/docs.html)
+ [DotNet supplementary reference](https://cryptosys.net/firmasat/fsaDotNetManual.html)
+ [VBA supplementary reference](https://cryptosys.net/firmasat/basFirmaSAT.bas.manual.html)
+ [C/C++ supplementary reference](https://cryptosys.net/firmasat/diFirmaSat2_h_Ref.html)

For further help, visit <https://cryptosys.net/firmasat/>.

David Ireland  
DI Management Services Pty Limited  
t/a CryptoSys  
Australia  
<https://di-mgt.com.au/>  
<https://cryptosys.net/contact/>  
This file last updated: 2 January 2026
*****************************************
