/** * \mainpage Sentinel Licensing API * \file hasp_api.h Sentinel Licensing API declarations * * Copyright (C) 2013, SafeNet, Inc. All rights reserved. */ #ifndef __HASP_API_H__ #define __HASP_API_H__ #if !defined(WITH_AKSTYPES) && !defined(WITH_OEFTYPES) #if defined(_MSC_VER) || defined(__WATCOMC__) || defined(__BORLANDC__) typedef unsigned __int64 hasp_u64_t; typedef signed __int64 hasp_s64_t; #else typedef unsigned long long hasp_u64_t; typedef signed long long hasp_s64_t; #endif #if defined(_MSC_VER) typedef unsigned long hasp_u32_t; typedef signed long hasp_s32_t; #else typedef unsigned int hasp_u32_t; typedef signed int hasp_s32_t; #endif typedef unsigned short hasp_u16_t; typedef signed short hasp_s16_t; typedef signed char hasp_s8_t; typedef unsigned char hasp_u8_t; #endif #if defined(_WIN32) || defined(WIN32) || defined(_MSC_VER) || defined(__BORLANDC__) #if defined(__MINGW32__) #define HASP_CALLCONV __declspec(dllimport) __stdcall #else #define HASP_CALLCONV __stdcall #endif #else #define HASP_CALLCONV #endif #ifdef __cplusplus extern "C" { #endif /** * @defgroup hasp_feature_ids Legacy HASP HL Run-time API: Feature ID defines * * @{ */ /** * \brief Legacy HASP HL Run-time API: "Feature Type" mask * * AND-mask used to identify Feature type. */ #define HASP_FEATURETYPE_MASK 0xffff0000 /** * \brief Legacy HASP HL Run-time API: "Program Number Feature" type * * After AND-ing with HASP_FEATURETYPE_MASK the Feature type contain this value. */ #define HASP_PROGNUM_FEATURETYPE 0xffff0000 /** * \brief Legacy HASP HL Run-time API: "Program Number Mask" * * AND-mask used to extract the Program Number from a * "prognum" Feature ID. */ #define HASP_PROGNUM_MASK 0x000000ff /** * \brief Legacy HASP HL Run-time API: "Program Number Options" mask * * AND-mask used to identify Program Number options: * * * 3 bits of the mask are reserved for future extensions and currently unused. * Initialize them with zero. */ #define HASP_PROGNUM_OPT_MASK 0x0000ff00 /** * \brief Legacy HASP HL Run-time API: "Program Number" option * * Disables the search for local licenses. */ #define HASP_PROGNUM_OPT_NO_LOCAL 0x00008000 /** * \brief Legacy HASP HL Run-time API: "Program Number" option * * Disables the search for network licenses. */ #define HASP_PROGNUM_OPT_NO_REMOTE 0x00004000 /** * \brief Legacy HASP HL Run-time API: "Program Number" option * * Sets session count of network licenses to "per-process". */ #define HASP_PROGNUM_OPT_PROCESS 0x00002000 /** * \brief Legacy HASP HL Run-time API: "Program Number" option * * Enables the API to access "classic" (HASP4 or earlier) keys. */ #define HASP_PROGNUM_OPT_CLASSIC 0x00001000 /** * \brief Legacy HASP HL Run-time API: "Program Number" option * * Ignores the presence of terminal servers. */ #define HASP_PROGNUM_OPT_TS 0x00000800 /** * \brief The Sentinel default Feature ID * * Available in every Sentinel key. */ #define HASP_DEFAULT_FID 0 /** * \brief Legacy HASP HL Run-time API: The HASP default Feature ID * * Available in every legacy HASP hardware key. */ #define HASP_PROGNUM_DEFAULT_FID (HASP_DEFAULT_FID | HASP_PROGNUM_FEATURETYPE) /** * @} */ /** * @defgroup hasp_file_ids Memory File ID defines * * @{ */ /** * \brief Legacy HASP HL Run-time API: HASP4 memory file * * File ID for HASP4-compatible memory contents w/o FAS. */ #define HASP_FILEID_MAIN 0xfff0 /** * \brief Legacy HASP HL Run-time API: HASP4 FAS memory file * * (Dummy) File ID for the license data area of memory contents. */ #define HASP_FILEID_LICENSE 0xfff2 /** * \brief Sentinel secure writable memory file * * File ID for Sentinel secure writable memory. */ #define HASP_FILEID_RW 0xfff4 /** * \brief Sentinel secure read only memory file * * File ID for Sentinel read only memory. */ #define HASP_FILEID_RO 0xfff5 /** * \brief Sentinel dynamic memory file ID avaliable range * * File ID lower limit for Sentinel dynamic memory file. */ #define HASP_FILEID_DYNAMIC_FIRST 0x1 /** * \brief Sentinel dynamic memory file ID avaliable range * * File ID upper limit for Sentinel dynamic memory file. */ #define HASP_FILEID_DYNAMIC_LAST 0xffbf /** * @} */ /** * @defgroup hasp_error_codes Run-time API Status Codes * * @{ */ enum hasp_error_codes { /** Request successfully completed */ HASP_STATUS_OK = 0, /** Request exceeds memory range of a Sentinel file */ HASP_MEM_RANGE = 1, /** Legacy HASP HL Run-time API: Unknown/Invalid Feature ID option */ HASP_INV_PROGNUM_OPT = 2, /** System is out of memory */ HASP_INSUF_MEM = 3, /** Too many open Features/login sessions */ HASP_TMOF = 4, /** Access to Feature, Sentinel protection key or functionality denied */ HASP_ACCESS_DENIED = 5, /** Legacy decryption function cannot work on Feature */ HASP_INCOMPAT_FEATURE = 6, /** Sentinel protection key not available */ HASP_HASP_NOT_FOUND = 7, /* Deprecated - use HASP_HASP_NOT_FOUND */ HASP_CONTAINER_NOT_FOUND = 7, /** Encrypted/decrypted data length too short to execute function call */ HASP_TOO_SHORT = 8, /** Invalid login handle passed to function */ HASP_INV_HND = 9, /** Specified File ID not recognized by API */ HASP_INV_FILEID = 10, /** Installed driver or daemon too old to execute function */ HASP_OLD_DRIVER = 11, /** Real-time clock (rtc) not available */ HASP_NO_TIME = 12, /** Generic error from host system call */ HASP_SYS_ERR = 13, /** Required driver not installed */ HASP_NO_DRIVER = 14, /** Invalid XML format */ HASP_INV_FORMAT = 15, /** Unable to execute function in this context; the requested * functionality is not implemented */ HASP_REQ_NOT_SUPP = 16, /** Binary data passed to function does not contain valid update */ HASP_INV_UPDATE_OBJ = 17, /** Sentinel protection key not found */ HASP_KEYID_NOT_FOUND = 18, /** Required XML tags not found; Contents in binary data are missing * or invalid */ HASP_INV_UPDATE_DATA = 19, /** Update request not supported by Sentinel protection key */ HASP_INV_UPDATE_NOTSUPP = 20, /** Update counter set incorrectly */ HASP_INV_UPDATE_CNTR = 21, /** Invalid Vendor Code passed */ HASP_INV_VCODE = 22, /** Sentinel protection key does not support encryption type */ HASP_ENC_NOT_SUPP = 23, /** Passed time value outside supported value range */ HASP_INV_TIME = 24, /** Real-time clock battery out of power */ HASP_NO_BATTERY_POWER = 25, /** Acknowledge data requested by update, but ack_data parameter * is NULL */ HASP_NO_ACK_SPACE = 26, /** Program running on a terminal server */ HASP_TS_DETECTED = 27, /** Program running on a Remote Desktop */ HASP_RDP_DETECTED = 27, /** Requested Feature type not implemented */ HASP_FEATURE_TYPE_NOT_IMPL = 28, /** Unknown algorithm used in H2R/V2C file */ HASP_UNKNOWN_ALG = 29, /** Signature verification operation failed */ HASP_INV_SIG = 30, /** Requested Feature not available */ HASP_FEATURE_NOT_FOUND = 31, /** Access log not enabled */ HASP_NO_LOG = 32, /** Communication error between API and local Sentinel License Manager */ HASP_LOCAL_COMM_ERR = 33, /** Vendor Code not recognized by API */ HASP_UNKNOWN_VCODE = 34, /** Invalid XML specification */ HASP_INV_SPEC = 35, /** Invalid XML scope */ HASP_INV_SCOPE = 36, /** Too many Sentinel protection keys match the scope */ HASP_TOO_MANY_KEYS = 37, /** Too many concurrent user sessions currently connected */ HASP_TOO_MANY_USERS = 38, /** Session been interrupted */ HASP_BROKEN_SESSION = 39, /** Communication error between local and remote Sentinel License Managers */ HASP_REMOTE_COMM_ERR = 40, /** Feature expired */ HASP_FEATURE_EXPIRED = 41, /** Sentinel License Manager version too old */ HASP_OLD_LM = 42, /** Input/Output error occurred in secure storage area of Sentinel SL key OR * a USB error occurred when communicating with a Sentinel HL key */ HASP_DEVICE_ERR = 43, /** Update installation not permitted; This update was already applied */ HASP_UPDATE_BLOCKED = 44, /** System time has been tampered with */ HASP_TIME_ERR = 45, /** Communication error occurred in secure channel */ HASP_SCHAN_ERR = 46, /** Corrupt data exists in secure storage area of Sentinel SL protection key */ HASP_STORAGE_CORRUPT = 47, /** Unable to find Vendor library */ HASP_NO_VLIB = 48, /** Unable to load Vendor library */ HASP_INV_VLIB = 49, /** Unable to locate any Feature matching scope */ HASP_SCOPE_RESULTS_EMPTY = 50, /** Program running on a virtual machine */ HASP_VM_DETECTED = 51, /** Sentinel SL key incompatible with machine hardware; Sentinel SL key is locked * to different hardware. OR: * In the case of a V2C file, conflict between Sentinel SL key data and machine * hardware data; Sentinel SL key locked to different hardware */ HASP_HARDWARE_MODIFIED = 52, /** Login denied because of user restrictions */ HASP_USER_DENIED = 53, /** Trying to install a V2C file with an update counter that is out of * sequence with the update counter on the Sentinel protection key. * The update counter value in the V2C file is lower than the value in * Sentinel protection key. */ HASP_UPDATE_TOO_OLD = 54, /** Trying to install a V2C file with an update counter that is out of * sequence with update counter in the Sentinel protection key. The * first value in the V2C file is greater than the value in the * Sentinel protection key. */ HASP_UPDATE_TOO_NEW = 55, /** Vendor library version too old */ HASP_OLD_VLIB = 56, /** Upload via ACC failed, e.g. because of illegal format */ HASP_UPLOAD_ERROR = 57, /** Invalid XML "recipient" parameter */ HASP_INV_RECIPIENT = 58, /** Invalid XML "action" parameter */ HASP_INV_ACTION = 59, /* Deprecated - use HASP_INV_ACTION */ HASP_INV_DETACH_ACTION = 59, /** Scope does not specify a unique Product */ HASP_TOO_MANY_PRODUCTS = 60, /** Invalid Product information */ HASP_INV_PRODUCT = 61, /** Unknown Recipient; update can only be applied to the * Recipient specified in hasp_detach(), and not to this computer */ HASP_UNKNOWN_RECIPIENT = 62, /** Invalid duration */ HASP_INV_DURATION = 63, /** Cloned secure storage area detected */ HASP_CLONE_DETECTED = 64, /** Specified V2C update already installed in the LLM */ HASP_UPDATE_ALREADY_ADDED = 65, /** Specified Hasp Id is in Inactive state */ HASP_HASP_INACTIVE = 66, /** No detachable feature exists */ HASP_NO_DETACHABLE_FEATURE = 67, /** No detachable feature exists (typo kept for compatibility */ HASP_NO_DEATCHABLE_FEATURE = 67, /** Scope does not specify a unique host */ HASP_TOO_MANY_HOSTS = 68, /** Rehost is not allowed for any license */ HASP_REHOST_NOT_ALLOWED = 69, /** License is rehosted to other machine */ HASP_LICENSE_REHOSTED = 70, /** Old rehost license try to apply */ HASP_REHOST_ALREADY_APPLIED = 71, /** File not found or access denied */ HASP_CANNOT_READ_FILE = 72, /** Extension of license not allowed as number of detached * licenses is greater than current concurrency count */ HASP_EXTENSION_NOT_ALLOWED = 73, /** Detach of license not allowed as product * contains VM disabled feature and host machine is a virtual machine */ HASP_DETACH_DISABLED = 74, /** Rehost of license not allowed as container * contains VM disabled feature and host machine is a virtual machine */ HASP_REHOST_DISABLED = 75, /** Format SL-AdminMode or migrate SL-Legacy to SL-AdminMode not allowed * as container has detached license */ HASP_DETACHED_LICENSE_FOUND = 76, /** Recipient of the requested operation is older than expected */ HASP_RECIPIENT_OLD_LM = 77, /** Secure storage ID mismatch */ HASP_SECURE_STORE_ID_MISMATCH = 78, /** Duplicate Hostname found while key contains Hostname Fingerprinting */ HASP_DUPLICATE_HOSTNAME = 79, /** The Sentinel License Manager is required for this operation */ HASP_MISSING_LM = 80, /** Attempting to consume multiple executions during log in to a Feature. * However, the license for the Feature does not contain enough remaining executions */ HASP_FEATURE_INSUFFICIENT_EXECUTION_COUNT = 81, /** Attempting to perform an operation not compatible with target platform */ HASP_INCOMPATIBLE_PLATFORM = 82, /** The key is disabled due to suspected tampering */ HASP_HASP_DISABLED = 83, /** The key is inaccessible due to sharing */ HASP_SHARING_VIOLATION = 84, /** The session was killed due a network malfunction or manually from ACC */ HASP_KILLED_SESSION = 85, /** Program running on a virtual storage */ HASP_VS_DETECTED = 86, /** An identity is required */ HASP_IDENTITY_REQUIRED = 87, /** The identity is not authenticated */ HASP_IDENTITY_UNAUTHENTICATED = 88, /** The identity is disabled */ HASP_IDENTITY_DISABLED = 89, /** The identity doesn't have enough permission for the operation */ HASP_IDENTITY_DENIED = 90, /** A session for this identity from a different machine already exists */ HASP_IDENTITY_SHARING_VIOLATION = 91, /** The maximum number of machines usable by the identity was reached */ HASP_IDENTITY_TOO_MANY_MACHINES = 92, /** The server is not ready to authenticate */ HASP_IDENTITY_SERVER_NOT_READY = 93, /** API dispatcher: API for this Vendor Code was not found */ HASP_NO_API_DYLIB = 400, /** API dispatcher: Unable to load API; DLL possibly corrupt? */ HASP_INV_API_DYLIB = 401, /** Invalid function parameter */ HASP_INVALID_PARAMETER = 501, /** C++ API: Object incorrectly initialized */ HASP_INVALID_OBJECT = 500, /** C++ API: Logging in twice to the same object */ HASP_ALREADY_LOGGED_IN = 502, /** C++ API: Logging out twice of the same object */ HASP_ALREADY_LOGGED_OUT = 503, /** .NET API: Incorrect use of system or platform */ HASP_OPERATION_FAILED = 525, /* Internal use: no classic memory extension block available */ HASP_NO_EXTBLOCK = 600, /* Internal use: invalid port type */ HASP_INV_PORT_TYPE = 650, /* Internal use: invalid port value */ HASP_INV_PORT = 651, /* Dot-Net DLL found broken */ HASP_NET_DLL_BROKEN = 652, /** Requested function not implemented */ HASP_NOT_IMPL = 698, /** Internal error occurred in API */ HASP_INT_ERR = 699, /* Reserved for Sentinel helper libraries */ HASP_FIRST_HELPER = 2001, /* Reserved for Sentinel Activation API */ HASP_FIRST_HASP_ACT = 3001, HASP_NEXT_FREE_VALUES = 7001, }; /** * @} */ /** * @defgroup hasp_general Sentinel typedefs and macros * * @{ */ /** A Sentinel status code */ typedef enum hasp_error_codes hasp_status_t; /** Sentinel size type */ typedef hasp_u32_t hasp_size_t; /** Sentinel connection handle */ typedef hasp_u32_t hasp_handle_t; /** Sentinel Feature ID */ typedef hasp_u32_t hasp_feature_t; /** Sentinel File ID */ typedef hasp_u32_t hasp_fileid_t; /** Sentinel timestamp, representing elapsed seconds since * Jan-01-1970 0:00:00 GMT */ typedef hasp_u64_t hasp_time_t; /** Sentinel Vendor Code buffer */ typedef const void *hasp_vendor_code_t; /** format to retrieve update info (C2V) */ #define HASP_UPDATEINFO "" /* format to retrieve a small update info (C2V) */ #define HASP_FASTUPDATEINFO "" /** format to retrieve session info */ #define HASP_SESSIONINFO "" /** format to retrieve key/hardware info */ #define HASP_KEYINFO "" /** format to retrieve host fingerprint info */ #define HASP_FINGERPRINT "" /** format to retrieve recipient parameter for hasp_transfer */ #define HASP_RECIPIENT "" \ " " \ " " \ " " \ " " \ " " \ " " \ " " \ "" /* * Invalid handle value for hasp_login() and hasp_login_scope() functions. */ #define HASP_INVALID_HANDLE_VALUE 0 /** * \brief Minimum block size for hasp_encrypt() and hasp_decrypt() functions. */ #define HASP_MIN_BLOCK_SIZE 16 /** * \brief Minimum block size for hasp_legacy_encrypt() * and hasp_legacy_decrypt() legacy functions. */ #define HASP_MIN_BLOCK_SIZE_LEGACY 8 /** * @} */ /** * @defgroup hasp_basic The Basic Sentinel Licensing API * * @{ */ /** * \brief Logs into a Feature and thereby establishes a session context. * * Sentinel Licensing API Usage Notes
* This function establishes a context to a Sentinel protection key * containing a license for the requested Feature ID. * * The requisite Vendor Codes are stored in a VendorCodes folder in your * system. Without the correct Vendor Code, the function call cannot succeed. * * You can open up to 512 simultaneous login sessions. * * Legacy HASP Remarks
* For local prognum Features, concurrency is not handled and each login * performs a decrement if it is a counting license. * * Network "prognum" features continue to use the old HASP/Sentinel LM login logic, * with its inherent limitations. * * There is only support for concurrent usage of one server (global * server address). * * With "Program Number" features (see \ref HASP_FEATURETYPE_MASK), 8 * bits are reserved for legacy options (see \ref HASP_PROGNUM_OPT_MASK, * currently 5 bits are used): *
    *
  • only local
    • *
  • only remote
    • *
  • login is counted per process ID
    • *
  • disable terminal server check
    • *
  • enable access to old (HASP3/HASP4) keys
    • *
* * \param feature_id Unique identifier for a specific Feature stored * in a Sentinel protection key * \param vendor_code Pointer to the Vendor Code * \param handle Pointer to the resulting session handle * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_HASP_NOT_FOUND
    • Required Sentinel * protection key not found *
  • HASP_FEATURE_NOT_FOUND
    • Cannot find requested * Feature *
  • HASP_FEATURE_TYPE_NOT_IMPL
    • Requested Feature * type not available *
  • HASP_TMOF
    • Too many open login sessions *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_INV_VCODE
    • Invalid Vendor Code *
  • HASP_NO_DRIVER
    • Driver not installed *
  • HASP_NO_VLIB
    • Vendor library cannot be found *
  • HASP_INV_VLIB
    • Vendor library cannot be loaded *
  • HASP_OLD_DRIVER
    • Driver too old *
  • HASP_UNKNOWN_VCODE
    • Vendor Code not recognized *
  • HASP_FEATURE_EXPIRED
    • Feature has expired *
  • HASP_TOO_MANY_USERS
    • Too many users currently * connected *
  • HASP_OLD_LM
    • Sentinel License Manager version * too old *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_TIME_ERR
    • System time has been tampered * with *
  • HASP_HARDWARE_MODIFIED
    • Sentinel SL key * incompatible with machine hardware; Sentinel SL key is * locked to different hardware *
  • HASP_TS_DETECTED
    • Program is running on a * Terminal Server *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
  • HASP_OLD_VLIB
    • Vendor Library version too old *
  • HASP_CLONE_DETECTED
    • Cloned Sentinel SL storage * detected. Feature unavailable *
* * \sa hasp_login_scope() * \sa hasp_logout() * */ hasp_status_t HASP_CALLCONV hasp_login(hasp_feature_t feature_id, hasp_vendor_code_t vendor_code, hasp_handle_t *handle); /** * \brief Logs into a Feature to establish a session, according to * predefined search parameters. * * Sentinel Licensing API Usage Notes
* This function is used to specify conditions that describe where login * information is to searched for. * * The requisite Vendor Codes are stored in a VendorCodes folder in your * system. Without the correct Vendor Code, the function call cannot succeed. * * You can open up to 512 simultaneous login sessions. * * This function does not work with legacy HASP Features. * * \param feature_id Unique identifier for a specific Feature stored in * a Sentinel protection key * \param scope Definition of the search parameters for * this Feature ID. See the additional Sentinel API * Reference documentation for more information * about Scope XML Tags * \param vendor_code Pointer to the vendor code * \param handle Pointer to the resulting session handle * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_HASP_NOT_FOUND
    • Required Sentinel * protection key not found *
  • HASP_FEATURE_NOT_FOUND
    • Cannot find requested * Feature *
  • HASP_SCOPE_RESULTS_EMPTY
    • Unable to locate * a Feature matching the scope *
  • HASP_TMOF
    • Too many open login sessions *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_INV_VCODE
    • Invalid Vendor Code *
  • HASP_NO_DRIVER
    • Driver not installed *
  • HASP_NO_VLIB
    • Vendor library cannot be found *
  • HASP_INV_VLIB
    • Vendor library cannot be loaded *
  • HASP_OLD_DRIVER
    • Driver too old *
  • HASP_UNKNOWN_VCODE
    • Vendor Code not recognized *
  • HASP_INVALID_PARAMETER
    • Scope string too * long (max. length 32 kb) *
  • HASP_FEATURE_EXPIRED
    • Feature has expired *
  • HASP_TOO_MANY_USERS
    • Too many users currently * connected *
  • HASP_OLD_LM
    • Sentinel License Manager version * too old *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_TIME_ERR
    • System time has been tampered * with *
  • HASP_TS_DETECTED
    • Program is running on a * Terminal Server *
  • HASP_HARDWARE_MODIFIED
    • Sentinel SL key * incompatible with machine hardware; Sentinel SL key is * locked to different hardware *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
  • HASP_OLD_VLIB
    • Vendor Library version too old *
  • HASP_CLONE_DETECTED
    • Cloned Sentinel SL storage * detected. Feature unavailable *
* * \sa hasp_login() * \sa hasp_logout() * \sa hasp_get_info() * */ hasp_status_t HASP_CALLCONV hasp_login_scope(hasp_feature_t feature_id, const char *scope, hasp_vendor_code_t vendor_code, hasp_handle_t *handle); /** * \brief Logs out from a context or session. * * Sentinel Licensing API Usage Notes
* Use this function to end a connection to an API session object. Once * logged out from a session, all memory allocated for the session is released. * * \param handle Handle for the session being terminated * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \sa hasp_login() * \sa hasp_login_scope() * */ hasp_status_t HASP_CALLCONV hasp_logout(hasp_handle_t handle); /** * \brief Encrypts a buffer. * * Sentinel Licensing API Usage Notes
* Encrypts data using the encryption engine in the Sentinel protection key. * The specific session handle determines which Sentinel protection key and * which Feature ID encrypts the data buffer. The encryption key remains * in the Sentinel protection key. If the encryption fails, the buffer * is not modified. To decrypt the data buffer, use the \ref hasp_decrypt * function. * * \param handle Handle for the session * \param buffer Pointer to the buffer to be encrypted * \param length Size (in bytes) of the buffer to be encrypted * (16 bytes minimum) * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL secure storage, OR in case of a Sentinel HL key, * USB communication error *
  • HASP_TIME_ERR
    • System time has been tampered * with *
  • HASP_TOO_SHORT
    • Encryption data length is * too short *
  • HASP_ENC_NOT_SUPP
    • Sentinel protection key * does not support encryption type *
  • HASP_SCHAN_ERR
    • Communication error occurred * in secure channel OR Sentinel HL Firmware too old * (update to 3.25 or later) *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \sa hasp_decrypt() * */ hasp_status_t HASP_CALLCONV hasp_encrypt(hasp_handle_t handle, void *buffer, hasp_size_t length); /** * \brief Decrypts a buffer. * * Sentinel Licensing API Usage Notes
* Decrypts data using the decryption engine in the Sentinel protection key * The specific session handle determines which Sentinel protection key and * which Feature ID decrypts the data buffer. The decryption key remains * in the Sentinel protection key. If the decryption fails, the buffer * is not modified. To encrypt the data buffer, use the \ref hasp_encrypt * function. * * \param handle Handle for the session * \param buffer Pointer to the buffer to be decrypted * \param length Size (in bytes) of the buffer to be decrypted * (16 bytes minimum) * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_TIME_ERR
    • System time has been tampered * with *
  • HASP_TOO_SHORT
    • Decryption data length is * too short *
  • HASP_SCHAN_ERR
    • Communication error occurred * in secure channel OR Sentinel HL Firmware too old * (update to 3.25 or later) *
  • HASP_ENC_NOT_SUPP
    • Sentinel protection key * does not support encryption type *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \sa hasp_encrypt() * */ hasp_status_t HASP_CALLCONV hasp_decrypt(hasp_handle_t handle, void *buffer, hasp_size_t length); /** * \brief Reads the memory of a Sentinel protection key. * * Sentinel Licensing API Usage Notes
* Valid File IDs are \ref HASP_FILEID_RW and \ref HASP_FILEID_RO. * From Sentinel LDK 7.1, Sentinel HL Driverless keys support dynamic memory, * the File IDs can be from HASP_FILEID_DYNAMIC_FIRST(0x1) to HASP_FILEID_DYNAMIC_LAST(0xFFBF). * * Legacy HASP Remarks
* Valid File IDs are \ref HASP_FILEID_LICENSE and \ref HASP_FILEID_MAIN. * * \param handle Handle for the session * \param fileid Identifier for the file that is to be read * \param offset Byte offset in the file * \param length Number of bytes to be read from the file * \param buffer Pointer to the retrieved data * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_INV_FILEID
    • Unrecognized file identifier *
  • HASP_MEM_RANGE
    • Request exceeds the memory * range of a Sentinel file *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_SCHAN_ERR
    • Communication error occurred * in secure channel OR Sentinel HL Firmware too old * (update to 3.25 or later) *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \remark * Use the \ref hasp_get_size function to determine the size of the file you * want to read. * * \sa hasp_write() * \sa hasp_get_size() * */ hasp_status_t HASP_CALLCONV hasp_read(hasp_handle_t handle, hasp_fileid_t fileid, hasp_size_t offset, hasp_size_t length, void *buffer); /** * \brief Writes to the memory of a Sentinel protection key. * * Sentinel Licensing API Usage Notes
* Valid File ID is \ref HASP_FILEID_RW. * From Sentinel LDK 7.1, Sentinel HL Driverless keys support dynamic memory, * the File IDs can be from HASP_FILEID_DYNAMIC_FIRST(0x1) to HASP_FILEID_DYNAMIC_LAST(0xFFBF). * * Legacy HASP Remarks
* Depending on the provided session handle (either logged into the * default Feature or any other Feature), write access to the FAS memory * (\ref HASP_FILEID_LICENSE) is not permitted. * * \param handle Handle for the session * \param fileid Identifier for the file that is to be written * \param offset Byte offset in the file * \param length Number of bytes to be written to the file * \param buffer Pointer to the data * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_INV_FILEID
    • Unrecognized file identifier *
  • HASP_MEM_RANGE
    • Request exceeds the memory * range of a Sentinel file *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_SCHAN_ERR
    • Communication error occurred * in secure channel OR Sentinel HL Firmware too old * (update to 3.25 or later) *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \remark * Use the \ref hasp_get_size function to determine the size of the file you * want to write. * * \sa hasp_read() * \sa hasp_get_size() * */ hasp_status_t HASP_CALLCONV hasp_write(hasp_handle_t handle, hasp_fileid_t fileid, hasp_size_t offset, hasp_size_t length, const void *buffer); /** * \brief Retrieves the byte size of a memory file from a Sentinel protection key. * * This function is used to determine the file size of a Sentinel * memory file. * * Sentinel Licensing API Usage Notes
* From Sentinel LDK 7.1, Sentinel HL Driverless keys support dynamic memory, * the file IDs can be from HASP_FILEID_DYNAMIC_FIRST(0x1) to HASP_FILEID_DYNAMIC_LAST(0xFFBF). * * \param handle Handle for the session * \param fileid Identifier for the file that is to be queried. * \param size Pointer to the resulting file size * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_INV_FILEID
    • Unrecognized file identifier *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \sa hasp_read() * \sa hasp_write() * */ hasp_status_t HASP_CALLCONV hasp_get_size(hasp_handle_t handle, hasp_fileid_t fileid, hasp_size_t *size); /** * \brief Reads the current time. * * Sentinel Licensing API Usage Notes
* Only Sentinel HL keys with a Real-time clock (rtc) and Sentinel SL keys can * provide the current time. * * Primarily used to obtain reliable timestamps that are independent from * the system clock. * * Time values are returned as the number of seconds that have elapsed * since Jan-01-1970 0:00:00 UTC. * * Legacy HASP Remarks
* This request is only supported on locally accessed keys. Trying to * get the time from a remotely accessed key will return HASP_NO_TIME. * * \param handle Handle for the session * \param time Pointer to the current time * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
  • HASP_NO_BATTERY_POWER
    • Real-time clock has * run out of power *
  • HASP_NO_TIME
    • Real-time clock is not * available *
* * \sa hasp_datetime_to_hasptime() * \sa hasp_hasptime_to_datetime() * */ hasp_status_t HASP_CALLCONV hasp_get_rtc(hasp_handle_t handle, hasp_time_t *time); /** * @} */ /** * @defgroup hasp_classic Legacy HASP functionality for backward compatibility * * @{ */ /** * \brief Legacy HASP4 compatible encryption function. * * Sentinel Licensing API Usage Notes
* This function does not work with a Sentinel login handle. * * Legacy HASP Remarks
* The handle must have been obtained by calling \ref hasp_login() with * a "prognum" Feature ID. * * \param handle Handle for the session * \param buffer Pointer to the buffer to be encrypted * \param length Size in bytes of the buffer (min. 8 bytes) * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_TOO_SHORT
    • Encryption data length is * too short *
  • HASP_ENC_NOT_SUPP
    • Sentinel protection key * does not support encryption type *
  • HASP_HASP_NOT_FOUND
    • Required Sentinel * protection key not found *
* * \sa hasp_legacy_decrypt() * \sa hasp_encrypt() * \sa hasp_decrypt() * */ hasp_status_t HASP_CALLCONV hasp_legacy_encrypt(hasp_handle_t handle, void *buffer, hasp_size_t length); /** * \brief Legacy HASP4 compatible decryption function. * * Sentinel Licensing API Usage Notes
* This function does not work with a Sentinel login handle. * * Legacy HASP Remarks
* The handle must have been obtained by calling \ref hasp_login() with * a "prognum" Feature ID. * * \param handle Handle for the session * \param buffer Pointer to the buffer to be decrypted * \param length Size in bytes of the buffer (min. 8 bytes) * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_TOO_SHORT
    • Encryption data length is * too short *
  • HASP_ENC_NOT_SUPP
    • Sentinel protection key * does not support encryption type *
  • HASP_HASP_NOT_FOUND
    • Required Sentinel * protection key not found *
* * \sa hasp_legacy_encrypt() * \sa hasp_decrypt() * \sa hasp_encrypt() * */ hasp_status_t HASP_CALLCONV hasp_legacy_decrypt(hasp_handle_t handle, void *buffer, hasp_size_t length); /** * \brief Writes to HASP4-compatible real-time clock * * Sentinel Licensing API Usage Notes
* This function does not work with a Sentinel login handle. * * Legacy HASP Remarks
* The handle must have been obtained by calling \ref hasp_login() with * a "prognum" Feature ID. * * This request is only supported on locally accessed keys. Attempting to * set the time on a remotely accessed key will return HASP_NO_TIME. * * \param handle Handle for the session * \param new_time The new time value * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_HASP_NOT_FOUND
    • Required Sentinel * protection key not found *
  • HASP_NO_TIME
    • Real-time clock not available * OR access remote *
* * \sa hasp_get_rtc() * \sa hasp_datetime_to_hasptime() * \sa hasp_hasptime_to_datetime() * */ hasp_status_t HASP_CALLCONV hasp_legacy_set_rtc(hasp_handle_t handle, hasp_time_t new_time); /** * \brief Set the LM idle time. * * Sentinel Licensing API Usage Notes
* This function does not work with a Sentinel login handle. * * Legacy HASP Remarks
* The handle must have been obtained by calling \ref hasp_login() with * a "prognum" Feature ID. * * \param handle Handle for the session * \param idle_time The idle time in minutes * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_HASP_NOT_FOUND
    • Required Sentinel * protection key not found *
  • HASP_REQ_NOT_SUPP
    • Tried to set the idle time * for a local license *
* */ hasp_status_t HASP_CALLCONV hasp_legacy_set_idletime(hasp_handle_t handle, hasp_u16_t idle_time); /** * @} */ /** * @defgroup hasp_extended Extended Sentinel Licensing API functionality * * The extended API consists of functions that provide extended * functionality. This advanced functionality is sometimes necessary, * and addresses the "advanced" user. * * @{ */ /** * \brief Retrieves information about system components, according to * customizable search parameters, and presents it according to * customizable formats. * * Sentinel Licensing API Usage Notes
* You do not need to be logged in to a Sentinel Feature in order to use * this function. * * This function is used to specify conditions about where to search for * information. In addition, it enables you to specify conditions about * the format in which the retrieved information is presented. If * retrieved information is appropriately formatted, it can be used as * a template in the hasp_login_scope() function. * * The requisite Vendor Codes are stored in a VendorCodes folder in * your system. Without the correct Vendor Code, the function call * cannot succeed. * * This function allocates memory for the information it retrieves. To * release allocated memory resources, use the \ref hasp_free function. * * This function cannot be used to retrieve legacy HASP Features. * * \param scope Definition of the data that is to be searched, in XML * format. For more information, see the accompanying * Sentinel Licensing API help documentation * \param format Definition of the format in which the data is to be * displayed, in XML format. For more information, see the * accompanying Sentinel Licensing API help * documentation * \param vendor_code Pointer to the Vendor Code * \param info Pointer to the information that is retrieved, in XML * format * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_SCOPE_RESULTS_EMPTY
    • Unable to locate * a Feature matching the scope *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_INV_VCODE
    • Invalid Vendor Code *
  • HASP_UNKNOWN_VCODE
    • Vendor Code not recognized *
  • HASP_INVALID_PARAMETER
    • Scope or format string * too long (max. length 32 kb) *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
  • HASP_INV_FORMAT
    • Unrecognized format string *
  • HASP_INV_SCOPE
    • Unrecognized scope string *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_TOO_MANY_KEYS
    • In case of getting C2V: * Too many Sentinel protection keys match the scope *
  • HASP_TOO_MANY_HOSTS
    • In case of getting host * fingerrpint: Too many Sentinel License Manager * match the scope *
  • HASP_HASP_INACTIVE
    • In case of getting C2V: * Inactive Sentinel SL-AdminMode/SL-UserMode key-id *
* * \sa hasp_get_sessioninfo() * \sa hasp_free() * */ hasp_status_t HASP_CALLCONV hasp_get_info(const char *scope, const char *format, hasp_vendor_code_t vendor_code, char **info); /** * \brief Retrieves information regarding a session context. * * Memory for the information is allocated by this function and has to * be freed with the \ref hasp_free function. * * \param handle Handle for the session * \param format Definition for the type of output data structure, in * XML format. * There are three format options: *
    *
  • HASP_KEYINFO
    • For retrieving information on * the Sentinel protection key *
  • HASP_SESSIONINFO
    • For retrieving information on * the login session *
  • HASP_UPDATEINFO
    • For retrieving information on * a license update usually contained in a C2V file. * The retrieved information includes the current * state of the key, including update counters, * license availability and memory images *
* \param info Pointer to the information that is retrieved as XML text * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL secure storage, OR in case of a Sentinel HL key, * USB communication error *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
  • HASP_INV_FORMAT
    • Unrecognized format string *
  • HASP_INV_HND
    • Invalid input handle *
  • HASP_BROKEN_SESSION
    • Session has been * interrupted *
  • HASP_TIME_ERR
    • System time has been tampered * with *
* * \sa hasp_free() * \sa HASP_UPDATEINFO * \sa HASP_SESSIONINFO * \sa HASP_KEYINFO */ hasp_status_t HASP_CALLCONV hasp_get_sessioninfo(hasp_handle_t handle, const char *format, char **info); /** * \brief Frees memory resources utilized by other API functions. * * Used only in C code to release memory resources allocated to storing * retrieved data from API calls. * * \param info Pointer to the memory resources to be released * * \sa hasp_get_info() * \sa hasp_get_sessioninfo() * \sa hasp_update() * */ void HASP_CALLCONV hasp_free(char *info); /** * \brief Updates a Sentinel protection key. * * This function writes update information. Note that the Sentinel * protection key must be locally connected. * * The update code contains all necessary data to perform the update on * a deployed Sentinel protection key including: *
    *
  • The Sentinel protection key on which the updated information is * to be written
    • *
  • The necessary Vendor Code that is required to access the * Sentinel key
    • *
  • The actual update information
    • *
* * Depending on the update data, the function returns an acknowledgement * code that is signed/encrypted by the key. The code is evidence that * an update has been applied to a license. This function allocates memory * for the acknowledge data. To release allocated memory resources, use * \a hasp_free(). * * \param update_data Pointer to the complete update data. * \param ack_data Pointer to a buffer to retrieve the acknowledge data. * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_KEYID_NOT_FOUND
    • The Sentinel protection * key was not found *
  • HASP_INV_UPDATE_DATA
    • Required XML tags * not found; Contents in binary data are missing * or invalid *
  • HASP_INV_UPDATE_NOTSUPP
    • Update request is * not supported by Sentinel protection key *
  • HASP_INV_UPDATE_CNTR
    • Update counter not * set correctly *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL secure storage, OR in case of a Sentinel HL key, * USB communication error *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
  • HASP_NO_ACK_SPACE
    • Acknowledge data * requested by the update, but ack_data parameter * is NULL *
  • HASP_UNKNOWN_ALG
    • Unknown algorithm used * in V2C file *
  • HASP_INV_SIG
    • Signature verification failed *
  • HASP_TOO_MANY_KEYS
    • Too many Sentinel * protection keys match the scope *
  • HASP_HARDWARE_MODIFIED
    • Conflict between * Sentinel SL key data and machine hardware data; * Sentinel SL key locked to different hardware *
  • HASP_UPDATE_TOO_OLD
    • Trying to install a * V2C file with an update counter that is out of * sequence with the update counter in the Sentinel * protection key. The values of the update counter * in the file are lower than those in the Sentinel * protection key *
  • HASP_UPDATE_TOO_NEW
    • Trying to install a * V2C file with an update counter that is out of * sequence with the update counter in the Sentinel * protection key. The first value in the file is more * than 1 greater than the value in the Sentinel * protection key *
  • HASP_UNKNOWN_RECIPIENT
    • In case of an H2R: * Update can only be applied to the Recipient * specified in hasp_detach(), not to this machine *
  • HASP_HASP_INACTIVE
    • Inactive Sentinel * SL-AdminMode/SL-UserMode key-id *
  • HASP_UPDATE_ALREADY_ADDED
    • Sentinel * SL-AdminMode/SL-UserMode V2C update(s) already applied *
  • HASP_REHOST_ALREADY_APPLIED
    • In case of SL-AdminMode * /SL-UserMode H2H: Specified H2H already applied *
  • HASP_LICENSE_REHOSTED
    • In case of SL-AdminMode * /SL-UserMode V2C: Specified V2C already rehosted to another * host *
* * \sa hasp_free() * */ hasp_status_t HASP_CALLCONV hasp_update(const char *update_data, char **ack_data); /** * \brief Detaches or cancels an attached license, according to customizable * parameters. * * Starting from Sentinel LDK version 6.0, the "hasp_detach" API has been deprecated. * SafeNet recommends that user should use the "hasp_transfer" API to perform * the detach/cancel actions.This API has been retained for backward compatibility. * * Sentinel Licensing API Usage Notes
* You do not need to be logged in to a Sentinel Feature in order to use * this function. * * This function is used to detach a license for a Product (i.e. all Sentinel * Features and Memory files which belong to this Product) from a Sentinel * SL Protection key. The function returns a H2R file which must then be * applied on the recipient machine using hasp_update() or the ACC. * * This function only works with Sentinel SL Protection Keys; Sentinel HL * Protection Keys are ignored. * * This function can also be used on the recipient machine to cancel an * attached license. In this case, the recipient parameter is ignored and * should be set to NULL. For cancelling, the function returns a R2H file * which must be applied on the host machine using hasp_update() or the * ACC. If the detached Product is already expired, no R2H file will be * returned. * * The required Vendor Codes are stored in a VendorCodes folder in * your system. Without the correct Vendor Code, the function call * cannot succeed. * * \param detach_action Parameters for the operation, in XML format. For * more information, see the accompanying * Sentinel Licensing API help documentation. * \param scope Search parameters for the Product that is to be * detached * \param vc Pointer to the Vendor Code * \param recipient Definition in XML format of the recipient computer, * on which the detached Product will be installed. * This information can be retrieved using either * @a hasp_get_info or @a hasp_get_sessioninfo * together with the format specifier * @a HASP_RECIPIENT. * Set to NULL if an attached protection key is cancelled. * \param info Pointer to the information that is retrieved, in * XML format. This information is a V2C, which can * then be installed on the recipient computer * via @a hasp_update. Use @a hasp_free to release this * pointer after use. * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_DETACH_ACTION
    • Invalid XML * "detach_action" parameter *
  • HASP_INV_RECIPIENT
    • Invalid XML "recipient" * parameter *
  • HASP_TOO_MANY_PRODUCTS
    • Scope for hasp_detach * does not specify a unique Parameter *
  • HASP_TOO_MANY_USERS
    • Too many users currently * connected, or: at least one detachable Feature * does not have enough network seats available *
  • HASP_ACCESS_DENIED
    • Request cannot be * processed due to ACC restrictions *
  • HASP_FEATURE_EXPIRED
    • All detachable * Features are expired *
  • HASP_INV_PRODUCT
    • Invalid Product information *
  • HASP_INV_DURATION
    • In the case of a new * detachable license, duration exceeds maximum allowed * OR, in the case of a detachable license extension, * expiration date earlier than original date * or too short (if an existing detached Product is * extended, and the new expiration date is earlier * than the original expiration date) *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL secure storage, OR in case of a Sentinel HL key, * USB communication error *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_REMOTE_COMM_ERR
    • Communication error * between local and remote Sentinel License Manager *
* * \sa hasp_get_info() * \sa hasp_update() * \sa hasp_free() */ #if (_MSC_VER >= 1400) __declspec(deprecated) hasp_status_t HASP_CALLCONV hasp_detach(const char *detach_action, const char *scope, hasp_vendor_code_t vc, const char *recipient, char **info); #elif defined(__GNUC__) hasp_status_t HASP_CALLCONV hasp_detach(const char *detach_action, const char *scope, hasp_vendor_code_t vc, const char *recipient, char **info) __attribute__((deprecated)); #else hasp_status_t HASP_CALLCONV hasp_detach(const char *detach_action, const char *scope, hasp_vendor_code_t vc, const char *recipient, char **info); #endif /** * \brief: Deprecate the above API "hasp_detach()" , This API performs * same functionalities as "hasp_detach()" does. Along with this, * "hasp_transfer()" API is used to rehost the SL-AdminMode/SL-UserMode * V2C from one machine to another machine. * * Sentinel Licensing API Usage Notes
* You do not need to be logged in to a Sentinel Feature in * order to use this function. * * This function is used to perform the following task as per its * "action" parameter. * for "detach" action: detach a license for a Product (i.e. all * Sentinel Features and Memory files which * belong to this Product) from a Sentinel * SL/SL-AdminMode/SL-UserMode key. The function * returns a bufferwhich should be saved as H2R file. * * for "cancel" action: This action runs on the recipient machine to * cancel an attached license. In this case, the * recipient parameter is ignored and should be * set to NULL. For cancelling, the function returns * a buffer which must be applied on the host machine * using hasp_update() or ACC If the detached Product * is already expired, no buffer will be returned. * * for "rehost" action: create a tranferable a license for given container * (i.e. all Sentinel Features and Memory files * which belong to this container) from SL-AdminMode/ * SL-UserMode Protection key. The function returns * buffer on success which must be saved as V2C file. * hasp_update() or ACC is used to apply this on * destination machine. * * This function only works with Sentinel SL/SL-AdminMode/SL-UserMode * Protection Keys; Sentinel HL Protection Keys are ignored. * * The required Vendor Codes are stored in a VendorCodes folder in * your system. Without the correct Vendor Code, the function call * cannot succeed. * * \param action Parameters for the operation, in XML format. For * more information, see the accompanying * Sentinel Licensing API help documentation. * \param scope Search parameters for the conatiner-id that is to be * re-hosted. For more information, see the accompanying * Sentinel Licensing API help documentation. * \param vc Pointer to the Vendor Code * \param recipient Definition in XML format of the recipient computer, * on which the detached Product will be installed. * This information can be retrieved using either * @a hasp_get_info or @a hasp_get_sessioninfo * together with the format specifier * @a HASP_RECIPIENT. * \param info Pointer to the information that is retrieved, in * XML format. This information is a V2C, which can * then be installed on the destination computer * via @a hasp_update. Use @a hasp_free to release this * pointer after use. * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_ACTION
    • Invalid XML * "action" parameter *
  • HASP_INV_RECIPIENT
    • Invalid XML "recipient" * parameter *
  • HASP_TOO_MANY_PRODUCTS
    • Scope for hasp_transfer * for detach action does not specify a unique Parameter *
  • HASP_TOO_MANY_USERS
    • Too many users currently * connected, or: at least one detachable Feature * does not have enough network seats available *
  • HASP_ACCESS_DENIED
    • Request cannot be * processed due to ACC restrictions *
  • HASP_FEATURE_EXPIRED
    • All detachable * Features are expired *
  • HASP_INV_PRODUCT
    • Invalid Product information *
  • HASP_INV_DURATION
    • In the case of a new * detachable license, duration exceeds maximum allowed * OR, in the case of a detachable license extension, * expiration date earlier than original date * or too short (if an existing detached Product is * extended, and the new expiration date is earlier * than the original expiration date) *
  • HASP_TOO_MANY_KEYS
    • Scope for hasp_transfer * does not specify a unique Parameter *
  • HASP_ACCESS_DENIED
    • Request cannot be * processed due to ACC restrictions *
  • HASP_INSUF_MEM
    • Out of memory *
  • HASP_DEVICE_ERR
    • Input/Output error in Sentinel * SL/SL-AdminMode/SL-UserMode secure storage, OR in * case of a Sentinel HL key, USB communication error *
  • HASP_LOCAL_COMM_ERR
    • Communication error * between API and local Sentinel License Manager *
  • HASP_NO_DEATCHABLE_FEATURE
    • In case of H2R: * No detachable feature found in specified product *
    • Sentinel License Manager is * not supported to SL-AdminMode/ SL-UserMode *
    • SL-AdminMode/ * SL-UserMode container is inactive *
    • Specified * SL-AdminMode/SL-UserMode container is not * allowed for rehost *
* * \sa hasp_get_info() * \sa hasp_update() * \sa hasp_free() */ hasp_status_t HASP_CALLCONV hasp_transfer(const char *action, const char *scope, hasp_vendor_code_t vc, const char *recipient, char **info); /** * @} */ /** * @defgroup hasp_util Utility functions * * @{ */ /** * \brief Retrieves version and build number of the Sentinel library * * \param major_version Pointer to retrieve the major version number * \param minor_version Pointer to retrieve the minor version number * \param generation_version Pointer to retrieve the generation version number * \param build_number Pointer to retrieve the build number * \param vendor_code Pointer to the Vendor Code * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
* * \remark Any pointer other than the vendor_code can be NULL if its * information is not required. * */ hasp_status_t HASP_CALLCONV hasp_get_version(unsigned int *major_version, unsigned int *minor_version, unsigned int *generation_version, unsigned int *build_number, hasp_vendor_code_t vendor_code); /** * \brief Converts a date and time value to hasptime (the number of * elapsed seconds since January 1 1970). * * \param day Input for day value (range 1-31) * \param month Input for month value (range 1-12) * \param year Input for year value (range 1970+) * \param hour Input for hour value (range 0-23) * \param minute Input for minute value (range 0-59) * \param second Input for second value (range 0-59) * \param time Pointer to the resulting time value * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_TIME
    • Passed time value is outside * the supported value range *
* * \remark Time values are in UTC. * * \sa hasp_hasptime_to_datetime() * */ hasp_status_t HASP_CALLCONV hasp_datetime_to_hasptime(unsigned int day, unsigned int month, unsigned int year, unsigned int hour, unsigned int minute, unsigned int second, hasp_time_t *time); /** * \brief Converts a time value (elapsed seconds since January 1 1970) * into a date and time * * \param time The input time value * \param day Pointer to the day value * \param month Pointer to the month value * \param year Pointer to the year value * \param hour Pointer to the hour value * \param minute Pointer to the minute value * \param second Pointer to the second value * * \return
    *
  • HASP_STATUS_OK
    • Request was successfully * completed *
  • HASP_INV_TIME
    • Passed time value outside * of supported value range *
* * \remark Time values are in UTC. * * \sa hasp_datetime_to_hasptime() * */ hasp_status_t HASP_CALLCONV hasp_hasptime_to_datetime(hasp_time_t time, unsigned int *day, unsigned int *month, unsigned int *year, unsigned int *hour, unsigned int *minute, unsigned int *second); /** * @} */ #ifdef __cplusplus } // extern "C" #endif #endif /* __HASP_API_H__ */