HASP_MACHINEINFO XML Tags

You can retrieve hardware identifiers from the target machine on which a license will be installed with the GetInfo function by specifying one of the following:

> HASP_MACHINEINFO predefined alias in the function call.

>Write following <haspformat> XML in the format parameter of the function call. (For more information, see Using XML Tags to Define Format.)

<?xml version="1.0" encoding="UTF-8"?>
<haspformat root="hasp_info">
  <host_machine_info>
    <element name="ethernet_address" />
    <element name="fqdn" />
    <element name="ssid" />
    <element name="ip" />
    <element name="sid" />
 </host_machine_info>
</haspformat>

The GetInfo function only supports fingerprint retrieval from the local machine. Remote machine are not supported. To enforce local access, include the following <haspscope> definition in your function call:

<haspscope>
  <license_manager hostname="localhost" />
</haspscope>

This scope ensures that the hardware identifiers are always collected from the same machine where the GetInfo function is executed.

The table below describes the XML elements used by the API to format the returned information.

Parent Tag	Child Tag	Description
None - root	`<hasp_info>`	Root element for all retrieved information using the GetInfo function.
`<hasp_info>`	`<host_machine_info>`	Machine information in raw format except SSID. See the table below for attributes that are part of this element.

The table below describes the attributes included in the <host_machine_info> tag.

Attribute	Description
<ethernet_address>	MAC address in the format XX-XX-XX-XX-XX-XX.
<fqdn>	FQDN (Fully Qualified Domain Name) in the format SERVER.DOMAIN.
<ssid>	Hash of the SSID (Secure Storage Identifier). A secure identifier tied to the storage system. Possible values are adminmode_ssid and usermode_ssid. >usermode_ssid represents the SSID value retrieved during user operation mode. >adminmode_ssid is applicable only to the localhost server. If the Admin License Manager (LM) server is not running, this value will not be retrieved.
<ip>	The IP address of the machine.
<sid>	The unique identifier for the machine in Windows (SID) or Linux (Machine ID).

The attributes provided in the <host_machine_info> tag> can be used as input to the Fingerprint Generator tool to generate a fingerprint for machines where outgoing file transmission is restricted.

Since these attributes must be entered manually into the Fingerprint Generator tool, the GetInfo function appends a single-digit checksum to the retrieved value for each attribute. The Fingerprint Generator tool uses this checksum to ensure that the value was specified correctly.

For more details, see Sentinel LDK Software Protection and Licensing Guide (for Sentinel EMS or Sentinel LDK-EMS).

Example

To retrieve the required hardware identifiers, pass the following XML structure as the format parameter in your get_info call:

<?xml version="1.0" encoding="UTF-8"?>
<haspformat root="hasp_info">
  <host_machine_info>
    <element name="ethernet_address" />
    <element name="fqdn" />
    <element name="ssid" />
    <element name="ip" />
    <element name="sid" />
 </host_machine_info>
</haspformat>

The API returns the hardware identifiers in the following format. For example:

<hasp_info>
  <host_machine_info>
    <ethernet_address>28-11-A8-64-39-26/A</ethernet_address>
    <fqdn>6v91rg3.gemalto.com/L</fqdn>
    <usermode_ssid>416802094/J</usermode_ssid>
    <adminmode_ssid>4147699404/S</adminmode_ssid>
    <ip>10.42.73.136/x</ip>
    <sid>S-1-5-21-607934185-3705741358-367491475/Q</sid>
 </host_machine_info>
<hasp_info>

Each hardware identifier is appended with a single-character checksum, separated by a slash (/), to verify the accuracy of manually-shared data. This checksum character helps confirm that the value is not mistyped or corrupted when communicated between the user and the vendor.

HASP_MACHINEINFO XML Tags

Related Topics