Configuration Options

16min
Configuration Options for License Manager
The LicenseManager in the SDK provides several configuration options that allow you to tailor its behavior to your specific use cases, including air-gapped environments, logging control, offline support, and more.
Custom Logger (Resty)
The License Manager uses a Resty client to communicate with LicenseSpring’s API. By default, Resty logs to standard output. You can override this behavior by passing a custom logger using WithRestyLogger.
Go
WithRestyLogger(restyLogger resty.Logger)
WithRestyLogger(restyLogger resty.Logger)
﻿
Go
type CustomLogger struct{}

func (fl *CustomLogger) Debugf(format string, v ...interface{}) {}
func (fl *CustomLogger) Errorf(format string, v ...interface{}) {}
func (fl *CustomLogger) Warnf(format string, v ...interface{})  {}

lm_config := license_manager.LicenseManagerBasicConfiguration{
				OAuth:             false,
				ApiKey:            "your-api-key",
				SharedKey:         "your-shared-key",
				ProductCode:       "your-product-code",
				AuthData:          auth.FromKey("LICENSE-KEY"),
			}

lm, _ := license_manager.NewLicenseManager(
    lm_config,
    license_manager.WithRestyLogger(CustomLogger),
)

cfg.Manager = lm

lh, _ := license_handler.NewLicenseHandler(cfg)

type CustomLogger struct{}

func (fl *CustomLogger) Debugf(format string, v ...interface{}) {}
func (fl *CustomLogger) Errorf(format string, v ...interface{}) {}
func (fl *CustomLogger) Warnf(format string, v ...interface{})  {}

lm_config := license_manager.LicenseManagerBasicConfiguration{
				OAuth:             false,
				ApiKey:            "your-api-key",
				SharedKey:         "your-shared-key",
				ProductCode:       "your-product-code",
				AuthData:          auth.FromKey("LICENSE-KEY"),
			}

lm, _ := license_manager.NewLicenseManager(
    lm_config,
    license_manager.WithRestyLogger(CustomLogger),
)

cfg.Manager = lm

lh, _ := license_handler.NewLicenseHandler(cfg)
﻿
WithAirGapPublicKey
Go
WithAirGapPublicKey(airgappublickey string)
WithAirGapPublicKey(airgappublickey string)
﻿
This option is required for air-gapped licenses. The AirGap public key can be found on your LicenseSpring dashboard and is separate from your API and Shared keys.
WithGracePeriod
Go
WithGracePeriod(gracePeriod int)
WithGracePeriod(gracePeriod int)
﻿
By default, the SDK allows the license to be offline for 48 hours before invalidating it. This option lets you customize the duration of this grace period.
WithSyncPeriod
Go
WithSyncPeriod(syncPeriod int)
WithSyncPeriod(syncPeriod int)
﻿
Sets how frequently (in seconds) the SDK should try to synchronize the license with the server.
WithRestyVerbose
Go
WithRestyVerbose(verbose bool)
WithRestyVerbose(verbose bool)
﻿
When set to true, the SDK outputs detailed logs for LicenseClient operations.
WithVerifySignature
Go
WithVerifySignature(verifySig bool)
WithVerifySignature(verifySig bool)
﻿
When enabled, this option enforces signature verification on all responses from LicenseSpring.
WithEnableGuardFile
Go
WithEnableGuardFile(enableGuardFile bool)
WithEnableGuardFile(enableGuardFile bool)
﻿
This enables the use of guard files to protect against reuse of offline activation requests and ensure that hardware IDs match.
WithHardwareId
Go
WithHardwareId(hardwareId string)
WithHardwareId(hardwareId string)
﻿
Overrides the hardware ID used to identify the device.
WithAppName
Go
WithAppName(appName string)
WithAppName(appName string)
﻿
Overrides the App Name.
WithAppVersion
Go
WithAppVersion(appVersion string)
WithAppVersion(appVersion string)
﻿
Overrides the App Version.
WithServerPublicKey
Go
WithServerPublicKey(publicKey string)
WithServerPublicKey(publicKey string)
﻿
Overrides the server public key used to verify the signature in API responses. Setting up this value is mandatory if you are using a server other than LicenseSpring's servers.
WithHardwareIdAlgo
Go
WithHardwareIdAlgo(hardwareId string)
WithHardwareIdAlgo(hardwareId string)
﻿
Overrides the hardware ID used to identify the device. You can use this configuration option if you want to enable the built-in hardware ID module, which supports multiple hardware ID algorithms. You’ll need to select one of the supported algorithms from the list below:
HWIDAlgorithmWindowsFingerprint
HWIDAlgorithmComputerSystemProduct
HWIDAlgorithmCryptography
HWIDAlgorithmLinuxMachineID
HWIDAlgorithmCloudPlatform
Each algorithm generates the hardware ID differently depending on the operating system and environment. Choose the one that best fits your use case.
Go
const (
	Default HardwareIdAlgorithm = iota
	WindowsHardwareFingerprintId
	WindowsComputerSystemProductId
	WindowsCryptographyId
	LinuxMachineId
	CloudPlatformsId
)
const (
	Default HardwareIdAlgorithm = iota
	WindowsHardwareFingerprintId
	WindowsComputerSystemProductId
	WindowsCryptographyId
	LinuxMachineId
	CloudPlatformsId
)
﻿
WithMachineId
Go
WithMachineId()
WithMachineId()
﻿
Overrides the hardware ID and sets it to match the machine ID used in SDK v1.
 Use this option if you want to maintain compatibility with the hardware ID format from v1.
License Handler
Storage