Hardware Key

in the floating server, when the hardware key is plugged in and a license requiring hardware key is added to the floating server, the server's hardware id changes to the serial number of the hardware key from then on, every other action in this server uses the new hardware id, as long as the hardware key is connected to the server multiple licenses can be activated using the same hardware key to successfully run the floating server with the hardware dongle, make sure that no other process is using smart card readers, as this will result in an error in the floating server more details on how to detect those services can be found at the end of this page activate a hardware key requiring license the following steps are required to activate a hardware key requiring license in the floating server 1\ create a hardware key requiring license follow the instructions on our hardware key licensing docid\ twasrtinmfw7pb0qewr6a page to create a new license that requires hardware keys 2 start the floating server launch the floating server and navigate to the configuration page 3 select the authentication method from the dropdown menu on the configuration page, select the method of license authentication key auth user auth ensure that the checkbox for hardware key licenses is selected when adding a license that requires a hardware key configuration page of the floating server 4\ plug in the hardware key ensure that a hardware key, which has been provisioned using the licensespring platform, is plugged into the server 5 add the license add the product that requires the hardware key (e g , "hwbased") to the floating server the server will recognize that the hardware key is connected hardware key box 6 confirm license activation after adding the product, the license will be successfully activated on the floating server the hardware id of the server will now change to the serial number of the hardware key, as long as the hardware key remains connected 7 observe the hardware id change the hardware id of the floating server will continue to use the hardware key’s serial number for all actions as long as the key is connected if the hardware key is disconnected, the hardware id will revert to its original value 8 view activation in licensespring in the licensespring platform, the license activation will be visible, showing that the hardware key’s serial number is being used as the hardware id the hardware id shown in the platform is the serial number of the hardware key 9\ add additional licenses additional licenses, whether they require hardware keys or not, can also be added to the floating server this includes both user based and license key authentication methods once a hardware key based license is added to the server, any subsequent actions involving that license will first verify the hardware key's validity the action will fail , if the key is invalid (e g , disconnected) invalid hardware key handling to address scenarios with missing or invalid hardware keys, we provide two solutions default behavior when a hardware key is missing or invalid, the server returns an error crash on missing hardware key if the crashifnohardwarekey flag is set to true during server setup, the server will crash when an invalid or missing hardware key is accessed this feature was introduced in version v1 6 0 and was implemented to accommodate specific use cases, such as managing hardware keys in high availability setups usage examples using the api to log in as an admin, add consumptions, feature consumptions, register a user, and register a user to a feature of a license that requires hardware key verification this example takes advantage of authentication mode to enforce role based access control if you are using the server without authentication mode, you can omit the authorization headers use user/pass to login curl u 'user1' 'pass1' http //localhost 8080/auth h "accept application/json" response {"message" "login successful","token" "eyjhbgcioijiuzi1niisinr5cci6ikpxvcj9 eyjlehaioje3mjy4ntu4otmsimlhdci6mtcynjc2otq5mywicm9szsi6imfkbwluiiwidxnlcm5hbwuioij1c2vymsj9 fhjefnu7x7iecs3brf36pvdqhrleziuwontfkhdjnja"} add the product using the "ishwkeyreq" parameter curl x get "http //localhost 8080/api/v4/addproduct?product=hwbased\&licensekey=wtus 5hhh v8yp wuhw\&ishwkeyreq=yes" h "authorization bearer {token here}" h "accept application/json" h "content type application/json" d '{}' add consumptions curl x post "http //localhost 8080/api/v4/add consumption" h "authorization bearer {token here}" h "accept application/json" h "content type application/json" d '{"product" "hwbased", "consumptions" 2}' add feature consumptions curl x post "http //localhost 8080/api/v4/add feature consumption" h "authorization bearer {token here}" h "accept application/json" h "content type application/json" d '{"product" "hwbased", "feature" "consfeature2", "consumptions" 2}' register user curl x post "http //localhost 8080/api/v4/register" h "authorization bearer {token here}" h "accept application/json" h "content type application/json" d '{ "product" "hwbased", "user" "user1", "os hostname" "", "ip local" "0 1 1 1", "user info" "", "registered at" "2024 08 26t12 21 59 776731 07 00", "borrowed until" "0001 01 01t00 00 00z" }' if no errors occur, the license object will be returned register user to feature curl x post "http //localhost 8080/api/v4/featureregister" h "authorization bearer {token here}" h "accept application/json" h "content type application/json" d '{ "product" "hwbased", "feature" "consfeature2", "user" "user2", "os hostname" "", "ip local" "0 1 1 1", "user info" "", "registered at" "2024 08 26t12 21 59 776731 07 00", "borrowed until" "0001 01 01t00 00 00z" }' response {"product" "hwbased","feature" "consfeature2","user" "user2","os hostname" "","ip local" "0 1 1 1","user info" "","registered at" "2024 09 19t12 39 16 356495803 07 00","borrowed until" "0001 01 01t00 00 00z"} unplug the hardware key or restart the server, then add consumption curl x post "http //localhost 8080/api/v4/add feature consumption" h "authorization bearer {token here}" h "accept application/json" h "content type application/json" d '{"product" "hwbased", "feature" "consfeature2", "consumptions" 2}' response {"code" "hardware key not accessible","message" "no available valid hardware key to perform the action adding feature consumption","status" 400} detect processes using smart card reader to find which processes are using a smart card reader on your machine, you can use the following methods depending on your operating system on linux use lsof the lsof command lists open files and the processes that have opened them since smart card readers are typically handled as devices, you can find processes interacting with them first, find the device file for your smart card reader this is usually in /dev and might be something like /dev/pcsc , /dev/ttyusb0 , or similar run the following command to check which processes are accessing the device lsof /dev/\<device name> example lsof /dev/ttyusb0 check pc/sc daemon if you’re using a pc/sc compliant smart card reader, the pcscd service manages the communication you can check if pcscd is running, and find its process id ps aux | grep pcscd use fuser the fuser command shows which processes are accessing a specific file or device fuser /dev/\<device name> on windows use task manager open the task manager (ctrl + shift + esc), and look for applications or services related to smart card access, like "smart card service" or "scardsvr" these may interact with the smart card reader use sc query you can also use the command prompt to query the status of the smart card service sc query scardsvr sysinternals tools the sysinternals process explorer https //docs microsoft com/en us/sysinternals/downloads/process explorer allows you to see what files, directories, and handles processes are using open process explorer and search for processes accessing smart card related files or drivers on macos use lsof similar to linux, you can use lsof to find processes using the smart card reader lsof | grep smartcard check the smart card daemon on macos, the pcsctest command can interact with the smart card reader and might provide information about active processes pcsctest these methods should help you identify which processes are interacting with your smart card reader