XML Tags for the Hasp.Config Method
This topic describes the Config method XML tags that are used to:
>Specify the Identity String to Be Used to Access a Cloud License
>Configure the Server Certificate for HTTPS
>Request the Credentials to Be Used to Access a Cloud License
>Specify the JWT to Be Used to Access a Cloud License
>Configure Collection of Usage Data
The hasp_config XML tags are described below.
Specify the Identity String to Be Used to Access a Cloud License
Use the <credentials> tag to specify one or more client identity strings for a given login session (for identity-based licensing).
You typically specify a single identity string, although you can specify multiple identity strings.
If you want to change the assigned identity string during a login session, include the <clear/> tag to clear the previously-assigned credentials. Otherwise, the new credentials are added to the previous ones.
Use the following syntax:
<?xml version="1.0" encoding="UTF-8" ?>
<haspconfig>
<credentials>
<clear/>
<identity>identityString</identity>
</credentials>
</haspconfig>
Configure the Server Certificate for HTTPS
Use the <server_config> tag to configure the server certificate for HTTPS.
<?xml version="1.0" encoding="UTF-8" ?>
<haspconfig>
<server_config>
<certificate>certificate-string</certificate>
<certificate_store>path</certificate_store>
</server_config>
</haspconfig>
Use the <certificate> tag to specify the certificate string.
For HTTPS to verify the server certificate, use the <certificate_store> tag to specify the trusted certificate path. If the path is not specified, the system certificate is used.
Request the Credentials to Be Used to Access a Cloud License
Applicable for: Sentinel EMS
For user-based licensing, use the <auth_config> tag to request login credentials from a user to access a cloud license.
<?xml version="1.0" encoding="UTF-8" ?>
<haspconfig>
<auth_config>
<hasp_auth_rte>1</hasp_auth_rte>
</auth_config>
</haspconfig>
Assign the value "1" for <hasp_auth_rte> to directs the embedded or external License Manager to launch the Authentication Run-time for user-based licensing.
The Authentication Run-time opens a login screen in a browser. The user can enter their credentials for accessing the cloud license required to access the protected application.
Specify the JWT to Be Used to Access a Cloud License
Applicable for: Sentinel EMS
Use the <credentials> tag to specify a JWT for a given login session. The identity string can be used by the Licensing API to set up identity-based secure tunnels with the License Manager service.
If you want to change the assigned JWT during a login session, include the <clear/> tag to clear the previously-assigned credentials. Otherwise, the new credentials are added to the previous ones.
Use the following syntax:
<?xml version="1.0" encoding="UTF-8" ?>
<haspconfig>
<credentials>
<clear/>
<jwt_token>tokenString@ServerAddress</jwt_token>
</credentials>
</haspconfig>
You can use user-based licensing with Sentinel EMS Identity Provider service to license protected applications.
For Sentinel IDP and user-based licensing for a licensed application running under Windows or Linux: You can use Hasp.Config Method to enable a licensing application to launch a login screen (using an embedded or external browser) without any coding.
For more information, see
Configure Collection of Usage Data
Applicable for: Sentinel EMS with Sentinel LDK CL Service
Sentinel EMS can collect usage data for Sentinel Data Platform. You can configure Sentinel EMS to:
> collect usage data globally for all applications, OR
>allow each individual login session for applications to determine whether usage data should be collected for that session.
For details on configuring Sentinel EMS, see Sentinel EMS User Guide for Sentinel LDK.
If usage data is being collected (either for all applications or for specific sessions), you have the option to include an application name or version (or both) in the collected data for each session.
Determining Whether Usage Data Should Be Collected for a Specific Session
If the Collect Usage Data attribute in Sentinel EMS is set to Set by Client Application, you use the Hasp.Config Method for a given session to choose whether to opt in or opt out for data collection:
Use the <usage_data_config> tag to configure the data collection behavior. For example:
<haspconfig>
<usage_data_config>
<user_option>opt-in</user_option>
</usage_data_config>
</haspconfig>
Assign the value opt-in or opt-out for <user_option> to indicate whether to opt in or opt out for usage data collection.
If Sentinel EMS is configured to collect usage data globally for all applications, the <user_option> tag is ignored.
When the Collect Usage Data attribute in Sentinel EMS is set to Set by Client Application, the behavior of Sentinel EMS for a given session is as follows:
>Usage data (including personal data) is collected if one of the following is true:
• hasp_config is not called.
• hasp_config is called without passing opt-in or opt-out.
• hasp_config is called and opt-in is passed.
>Usage data is not collected if hasp_config is called and opt-out is passed.
Including an Application Name or Version for Each Session
If usage data is being collected (either for all applications or for specific sessions), you have the option to include an application name or version (or both) in the collected data for a given session, using the Hasp.Config Method.
Use the <usage_data_config> tag to specify values for the application name or version to include in the collected usage data. For example:
<haspconfig>
<usage_data_config>
<app_name>DemoApp</app_name>
<app_version>1.0</app_version>
</usage_data_config>
</haspconfig>