Login Function

Description

Logs into a Feature, which establishes a session context.

Syntax

hasp_status_t HASP_CALLCONV hasp_login(
                hasp_feature_t feature_id,
                hasp_vendor_code_t vendor_code,
                hasp_handle_t * handle)

Parameters

`feature_id`	Unique identifier for a specific Feature stored in a Sentinel protection key
`vendor_code`	Bytes that contain the Vendor Code
`handle`	Pointer to the resulting session handle

Return Values

HASP_STATUS_OK

HASP_HASP_NOT_FOUND

HASP_FEATURE_NOT_FOUND

HASP_FEATURE_TYPE_NOT_IMPL

HASP_NO_BATTERY_POWER

HASP_HARDWARE_MODIFIED

HASP_SECURE_STORE_ID_MISMATCH

HASP_DUPLICATE_HOSTNAME

HASP_MISSING_LM

HASP_VS_DETECTED

HASP_REMOTE_SHARING_VIOLATION

HASP_MACHINE_DENIED

HASP_MACHINE_DISABLED

HASP_IDENTITY_RATE_LIMIT_EXCEEDED

HASP_IDENTITY_EXPIRED

HASP_FEATURE_START_DATE_NOT_REACHED

HASP_IDENTITY_TEMPORARILY_NOT_ACCESSIBLE

Usage Notes

This function establishes a context to a Sentinel protection key that contains a license for the requested Feature ID.

If the session is idle, the License Manager releases the session after 12 hours. (The timeout for the session is displayed in the Sessions page of Admin Control Center.) When one of the following functions is called, the session is refreshed and the timeout counter is reset to 12 hours: Login, LoginScope, Encrypt, Decrypt, GetSize, Read, Write, GetRealTimeClock.

If the Feature license expires while the login session is active, the login session (and therefore, the application) is allowed to continue. This is due to the fact that terminating the session may result in corruption of the application output or data.

The required Vendor Codes are stored in a VendorCodes folder in your system. Without the correct Vendor Code, the function call cannot succeed.

You can open simultaneous login sessions.

NOTE Important considerations:

>When the Login function is called for a Feature with a license type of Execution Count, Expiration Date, or Time Period, a write cycle is performed for the Sentinel protection key. Sentinel HL keys are certified to withstand a specific number of write cycles. For information on the number of write cycles for which Sentinel HL keys are certified, see the Sentinel HL Data Sheet.

>The V-Clock time is not automatically updated by the License Manager if you are using only Sentinel Licensing API to protect your application. To update the V-Clock time for a given protection key with Sentinel Licensing API, you must establish a session for the key (using the Loginfunction). While the session is active, you can continue to update the V-Clock time by calling any of the following additional functions: Read, Write, Encrypt, Decrypt, Logout.

For more information on V-Clock, see the Sentinel LDK Software Protection and Licensing Guide (for Sentinel EMS or Sentinel LDK-EMS).