NT CrypKey Driver Setup

=====================================================================
This driver is required to be installed on all NT platforms,
including all XP, Win 2000, and Win NT.
IMPORTANT NOTE:
This driver can be auto packed and installed by CrypKey Stealth.
(See readme.txt in the \Stealth directory.)
If you choose to use this install option, you need not read any further,
about this driver.
This driver setup is designed to be easily and transparently included in
your own software install.

This document contains:

1. Description of included files
2. How to use this Install.
3. How to Use the Uninstall
4. What it does internally
5. Revision history
1. Files
========
a. SetupEx.EXE - Is the driver install program.
b. CKS.EXE - is a self-extracting zipfile of the 6 required setup files
- DO NOT EXTRACT THESE - SetupEx.EXE expects to see this file as is!!
c. Readme.txt - this file
2. Instructions For Usage.
==========================
SetupEx.EXE [/S /U /F /D]
Simply include SetupEx.EXE and CKS.EXE in your Installation script -
lets assume Install Shield is being used. The script would make sure
that both SetupEx.EXE and CKS.EXE are copied into the Install directory
(i.e. the dir where the users program is being installed).
After the files are copied, the InstallShield Script would call SetupEx.EXE.
2.1 Error Code Return
SetupEx.EXE returns an error code if it runs into a problem.
This code is returned in 2 ways:
1) In the process termination code, which can be read
by the process that launched SETUPEX.EXE, if this is supported
2) If the above is not supported by your developemnet tool, the error code
is also written in ASCII to a file SETUPEX.XCO at termination
Some Installer programs are able to receive this error code. Processing
these is completely optional and not necessary.
The reported errors are below:
//These errors are more likely to be caused by a bug in your install
NTDRVR_INSTALL_ERR_NOT_NT -1
 NTDRVR_INSTALL_ERR_REMOTE_DRIVE -2
NTDRVR_INSTALL_ERR_CANNOT_COPY_FILE -3
NTDRVR_INSTALL_ERR_CANNOT_RUN_CKSETUP -4
NTDRVR_INSTALL_ERR_CKS_EXE_MISSING -5
NTDRVR_INSTALL_ERR_CANNOT_RUN_CKS_EXE -6
NTDRVR_INSTALL_ERR_MISSING_FILE -7
//NOTE! You get this error when you do not have permission to load driver fi
les
//Likely fixed by logging in as a local administrator of the machine
NTDRVR_INSTALL_ERR_REG_COULD_NOT_OPEN_SERVICEMANAGER -8
//These errors are unlikely and should be reported to us
NTDRVR_INSTALL_ERR_REG_COULD_NOT_OPEN_SERVICE -9
NTDRVR_INSTALL_ERR_REG_COULD_NOT_REGISTER_DIRECTORY -10
NTDRVR_INSTALL_ERR_STARTSERVICE_COULD_NOT_OPEN_SERVICEMANAGER-11
NTDRVR_INSTALL_ERR_STARTSERVICE_COULD_NOT_OPEN_SERVICE -12
NTDRVR_INSTALL_ERR_STARTSERVICE_COULD_NOT_START_SERVICE -13
NTDRVR_INSTALL_ERR_STOPSERVICE_COULD_NOT_OPEN_SERVICEMANAGER-14
NTDRVR_INSTALL_ERR_STOPSERVICE_COULD_NOT_OPEN_SERVICE -15
NTDRVR_INSTALL_ERR_STOPSERVICE_COULD_NOT_STOP_SERVICE -16
NTDRVR_INSTALL_ERR_REBOOT_NEEDED -17
2.2 Run Mode
There are two ways to use this program
2.2.2 Verbose Mode
Usage: SetupEx.EXE
In this mode, SetupEx.EXE will report on screen any errors it encounters.
It will do complete checking, and install if it can, and return an
error code if it can't.
Note that it will not report on screen if it encounters Win95/8, but
instead, it will do nothing and silently return.
The easiest strategy is, for any 32 platform, to just copy the files
into the install directory and run SetupEx.EXE. That is it.
The driver will set up the service, if it should be set up - i.e. it
is a local NT directory. If there is a problem, it will report the
problem to the user, thus doing all the necessary interface work for you.
If you use silent mode described below, you then must retrieve the error
code, and handle all errors yourself.
2.2.2 Silent Mode
Usage: SetupEx.EXE /S
In this mode, SetupEx.EXE will not put any dialogs on the screen.
It will do complete checking, and install if it can, and return an
error code if it can't.
Because it does not report any errors, it will be up to the install
program to handle errors. Note that the REBOOT_NEEDED error is not an
error, but it is information that needs to be acted on.
 2.3 Forced Install
Usage: SetupEx.EXE /F
The install will have no action if there is a driver with the same or a
more recent date already installed. However, you can force an older driver
to install by using the /F option.
Normally, this is a NOT recommended action, and may disable CrypKey
on the machine.
3. How to use the Uninstall:
============================
This driver has the ability to do partial and complete uninstalls.
If there are other programs using the driver, the uninstall will only
remove the directory SETUPEX.EXE is in from the configuration.
If there are no other programs using the driver, the uninstall will
stop the service, and remove all files used by the driver.
It is easy to use.
Uninstall Usage:
SetupEx.EXE /D
This will do all actions required. If there are no other directories using
the driver, it will delete all driver files, and put up a dialog notifying
the user that a reboot is required before another install can be done.
You can avoid this dialog by using the "silent mode":
SetupEx.EXE /D /S
Note that it if the user does try to do another install before booting,
and the service was removed, they will get an error -9:
"Register Directory: Unable to open CrypKey License Service
Reason: The specified service does not exist as an installed service"
This error will go away after rebooting.
If you wish to uninstall even if there are other programs using the driver,
you can use the command
SetupEx.EXE /U
WARNING: this will leave the other registered directories without a driver
to serve them. It is recommended that /D be used in release versions, and
/U be used for test purposes only.
The driver can be re-installed after a /U (you must reboot first). The
other registered directories, if any were present, will still be configured.
4. How it works internally:
===========================
The NT Driver Install will install all necessary files, and start the driver.
It will register the driver, so that it is started on all reboots
If there is a driver already present, the install will
- only install components if they are newer.
- only require a reboot if newer components are installed
- put up a dialog requesting a reboot if it is required
- not put up a reboot dialog but give an error code if /S is used
5. Revision History
===========================
2006-03-02
Driver updated to auto start activer server processes on driver start up. Driv
er will aslo shut down server processes when it is shut down.