This interface is used for authenticating the application against the library. More...
Public Member Functions | |
| virtual bool | is_trial_license () const =0 |
| Indicates whether the license provided for authentication is a trial license. More... |
|
| virtual Uint64 | get_trial_seconds_left () const =0 |
| Returns the number of seconds left for trial licenses. More... |
|
| virtual const IString * | get_host_id () const =0 |
| Returns the host ID of the machine the program is running on. More... |
|
| virtual const IString * | get_last_error_message () const =0 |
| Returns the last error message related to authentication. More... |
|
| virtual bool | set_flexnet_default_license_path (const char *path)=0 |
| Sets the expected FlexNet license file location. More... |
|
| virtual void | set_flexnet_trial_license_data (const Uint8 *data, Size size)=0 |
| Sets the content of the FlexNet trial license. More... |
|
| virtual bool | is_flexnet_license_available () const =0 |
| Indicates whether a valid FlexNet license for the submitted response is available. More... |
|
Static Public Member Functions | |
| static Sint32 | authenticate (const INeuray *library, const char *vendor_key, Size vendor_key_length, const char *secret_key, Size secret_key_length, Sint32 count=1) |
| Convenience function implementing the full library authentication. More... |
|
 Static Public Member Functions inherited from mi::base::Interface_declare< 0x5a7d010a, 0x2a65, 0x43da, 0x92, 0xf2, 0xcd, 0xd9, 0xc8, 0x4b, 0x10, 0xd2 >
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface and of its ancestors. More... |
|
|
Static Public Member Functions inherited from mi::base::IInterface
| |
| static bool | compare_iid (const Uuid &iid) |
Compares the interface ID iid against the interface ID of this interface. More... |
|
Additional Inherited Members | |
|
Public Types inherited from mi::base::Interface_declare< 0x5a7d010a, 0x2a65, 0x43da, 0x92, 0xf2, 0xcd, 0xd9, 0xc8, 0x4b, 0x10, 0xd2 >
| |
| typedef Interface_declare< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11, IInterface > |
Self |
| Own type. More... |
|
| typedef Uuid_t< id1, id2, id3, id4, id5, id6, id7, id8, id9, id10, id11 > |
IID |
| Declares the interface ID (IID) of this interface. More... |
|
This interface is used for authenticating the application against the library.
Different variants of the Iray library use different mechanisms to prevent unauthorized use of the library. Two such variants are SPM-protected and non-SPM-protected binaries.
In non-SPM-protected variants the application needs to prove against the library that it has a valid secret key which enables it to start the Iray library.
|
inlinestatic |
Convenience function implementing the full library authentication.
The embedding application needs to pass in a pointer to the mi::neuraylib::INeuray interface, the vendor key and the secret key. The function will then perform the authentication towards the library.
The function is inline to avoid passing the secret key to the Iray library which would enable eavesdroppers to get the key. Keys are supposed to be entered as delivered to the application writer (which are hex encoded byte arrays).
| library | A pointer to an instance of mi::neuraylib::INeuray. The method attempts to authenticate this instance of the library. |
| vendor_key | The vendor key assigned to the application writer. |
| vendor_key_length | The size of the vendor key. |
| secret_key | The secret key provided to the application writer. |
| secret_key_length | The size of the secret key. |
| count | The number of licenses to retrieve. |
|
pure virtual |
Returns the host ID of the machine the program is running on.
The host ID is a unique identifier of the machine which can be used to lock a license to a machine.
|
pure virtual |
Returns the last error message related to authentication.
For example, if authentication via FlexNet failed, i.e., mi::neuraylib::INeuray::start() returns -6, then there might be a message providing a more detailed error description, originating from the FlexNet utilities.
NULL if there is no such error message available.
|
pure virtual |
Returns the number of seconds left for trial licenses.
This method returns sensible data only when called after Iray has been started or after mi::neuraylib::ILibrary_authenticator::is_flexnet_license_available().
|
pure virtual |
Indicates whether a valid FlexNet license for the submitted response is available.
Please note that this function can only be used after the response was submitted with the call mi::neuraylib::ILibrary_authenticator::authenticate().
true if a valid FlexNet license is available, false if no valid FlexNet license is availble, no response has been submitted yet, or the license has already been checked out.
|
pure virtual |
Indicates whether the license provided for authentication is a trial license.
This method can only be called after Iray has been started or after mi::neuraylib::ILibrary_authenticator::is_flexnet_license_available().
true if the license is a trial license, false otherwise (including Iray has not yet been started)
|
pure virtual |
Sets the expected FlexNet license file location.
To check out a feature, a FlexNet enabled application must first locate the license file. This function sets the default location where to start looking for the license file. The @ symbol cannot be used for file paths, as it is used for specifying FlexNet server addresses. Please note that this function should only be used after the response was submitted using mi::neuraylib::ILibrary_authenticator::authenticate(), otherwise the return value is meaningless.
true if a valid FlexNet (non-trial) license was found in this path or eventually configured environment variables.
|
pure virtual |
Sets the content of the FlexNet trial license.
Similar to set_flexnet_default_license_path(), except that for trial licenses the license data is passed in memory.