General-purpose Guardant API functions
General-purpose functions allow implementing service operations related to initialization, setup and deinitialization of Guardant API as well as performing the main operations with dongles:
- Search for a dongle meeting specified search criteria
- Initialize the dongle memory
- Read data from dongle memory
- Write data into dongle memory
- Set read/write locks on dongle memory
- Encrypt information using dongle hardware algorithms
List of general-purpose Guardant API functions:
| Name of function | Access code | Short description |
|---|---|---|
| GrdStartup | None | Initialize Guardant API |
| GrdStartupEx | None | Initialize a Guardant API copy with indicating path to GnClient.ini |
| GrdCleanup | None | Deinitializes Guardant API |
| GrdDllMain | None | Initializes network functions to be used in DLL |
| GrdGetLastError | None | Retrieves information on the last error from the secured container |
| GrdFormatMessage | None | Converts the error code into a text message |
| GrdGetInfo | None | Retrieves information from the secured container |
| GrdIsValidHandle | None | Checks validity of the secured container handle |
| GrdCreateHandle | None | Creates the secured container handle |
| GrdCloseHandle | None | Closes the secured container handle |
| GrdSetAccessCodes | Public and Read required, others - on demand | Places access codes into the secured container |
| GrdSetWorkMode | None | Sets the Guardant API operating mode |
| GrdSetFindMode | None | Sets the dongle search mode |
| GrdFind | Private Read | Finds a dongle meeting the search criteria |
| GrdLogin | Private Read | Logs in to the dongle |
| GrdLogout | Private Read | Logs out of the dongle |
| GrdLock | Private Read | Locks the dongle for the period of performing dongle op-erations requiring monopoly running mode |
| GrdUnlock | Private Read | Unlocks the dongle |
| GrdCheck | Private Read | Checks for dongle availability |
| GrdDecGP | Private Read+ Private Write | Decrements the GP counter |
| GrdRead | Private Read | Reads data from the dongle memory |
| GrdWrite | Private Write | Writes data into the dongle memory |
| GrdSign | Private Read | Calculate the digital signature of data array |
| GrdVerifySign | None | Check the digital signature of data array |
| GrdSeek | None | Moves the index to the current memory address of the dongle |
| GrdInit | Private master | Initializes the dongle memory |
| GrdProtect | Private master | Sets the read/write hardware locks and records the number of hardware algorithms and protected items |
| GrdTransform | Private Read | Converts data using a hardware or software implemented algorithm |
| GrdTransformEx | Private Read | Extended variant of GrdTransform |
| GrdCrypt | Private Read | Encrypts/decrypts data using a hardware or software algorithm |
| GrdCryptEx | Private Read | Extended variant of GrdCrypt |
| GrdHash | Private Read | Calculates the hash-function value using a hardware or software algorithm |
| GrdHashEx | Private Read | Extended variant of GrdHash |
| GrdCodeInit | Private Read | Initializes the fast reversible conversion password |
| GrdEnCode | None | Encrypts data using fast reversible conversion |
| GrdDeCode | None | Decrypts data using fast reversible conversion |
| GrdCRC | None | Calculates the CRC |
Guardant API functions for operating with protected items
Use special Guardant API functions to work with protected items:
| Name of function | Access code | Short description |
|---|---|---|
| GrdPI_Activate | Private Read and password for this operation, if set in the dongle | Activates a hardware algorithm/protected item |
| GrdPI_Deactivate | Deactivates a hardware algorithm or protected item | |
| GrdPI_Read | Reads data from a protected item | |
| GrdPI_Update | Updates data in a protected item | |
| GrdPI_GetCounter | Return algorithm launch counter value |
Guardant API functions for RTC dongles
| Name of function | Access code | Short description |
|---|---|---|
| GrdSetTime | Private Master | RTC dongle timer setting |
| GrdGetTime | Private Read | Receiving the dongle’s timer time |
| GrdPI_GetTimeLimit | Private Read | Recieving the remaining algorithm operating time |
| GrdMakeSystemTime | not need | Fill out TgrdSystemTime structure fields |
| GrdSplitSystemTime | not need | Receive the values of TgrdSystemTime structure fields |
| GrdTRU_GenerateQuestionTime | Private Read | Generating Encrypted Number-Question |
| GrdTRU_GenerateQuestionTimeEx | Private Read | Extended version of GrdTRU_GenerateQuestionTime |
| GrdTRU_DecryptQuestionTime | Private Read | Decrypting and Authenticating Number-Question |
| GrdTRU_DecryptQuestionTimeEx | Private Read | Extended version of GrdTRU_ DecryptQuestionTime |
Guardant API functions for Trusted Remote Update
Trusted Remote Update technology can be implemented not only by using the utilities of the Developer’s Kit. If necessary, developers can support this technology directly in their applications using the set of TRU functions:
| Name of function | Access code | Short description |
|---|---|---|
| GrdTRU_SetKey | Private Master | Initializes the dongle memory and writes a secret TRU key (see GrdInit) |
| GrdTRU_GenerateQuestion | Private Read | Generates a number-question |
| GrdTRU_GenerateQuestionEx | Private Read | Extended variant of GrdTRU_GenerateQuestion |
| GrdTRU_DecryptQuestion | Private Read | Decrypts and checks the validity of the number-question |
| GrdTRU_DecryptQuestionEx | Private Read | Extended variant of GrdTRU_DecryptQuestion |
| GrdTRU_SetAnswerProperties | None | Sets the parameters of the number-question |
| GrdTRU_EncryptAnswer | Private Read | Generates and encrypts a number-answer |
| GrdTRU_EncryptAnswerEx | Private Read | Extended variant of GrdTRU_EncryptAnswer |
| GrdTRU_ApplyAnswer | Private Read | Writes the number-answer into the dongle |
Guardant drivers API
You can use driver control functions implemented as a DLL in order to install, uninstall or configure Guardant drivers.
| Name of function | Short description |
|---|---|
| GrdDrvInstall | Installs Guardant drivers |
| GrdDrvUnInstall | Uninstalls Guardant drivers |
| GrdDrvIsInstalled | Checks for Guardant drivers availability in the system |
| GrdDrvGetVersion | Returns the Guardant drivers’ version installed in the system |
| GrdDrvSetPortUseState | Sets the port operating mode |
| GrdDrvGetPortUseState | Returns the current port operating mode |
| GrdDrvSetPrnPortTimeOut | Sets the timeout value for the LPT port |
| GrdDrvGetPrnPortTimeOut | Returns the current timeout value for the LPT port |
| GrdDrvSetPortProperties | Sets the LPT port operating parameters |
| GrdDrvGetPortProperties | Returns the current LPT port operating parameters |
| GrdDrvSetPortPropertiesAuto | Sets the default LPT port operating parameters |
| GrdDrvGetSystemInfo | Returns the system information on the configuration of LPT and USB ports |