ExtendedOptions.h

Go to the documentation of this file.

#ifndef LS_EXTENDED_OPTIONS_H
#define LS_EXTENDED_OPTIONS_H

#ifdef _MSC_VER
#pragma once
#pragma warning( push )
#pragma warning( disable : 4251 )
#endif

#include <vector>
#include "APIDef.h"
#include "CryptoProvider.h"
#include "PODTypes.h"

namespace LicenseSpring
{
    class LS_API NetworkInfo
    {
    public:
        NetworkInfo() = default;

        ~NetworkInfo();

        void setIp( const std::string& ip );

        const std::string& ip() const;

        void setMac( const std::string& mac );

        const std::string& mac() const;

        void setHostName( const std::string& hostName );

        const std::string& hostName() const; 

    private:
        std::string m_localIP;
        std::string m_hostName;
        std::string m_macAddress;
    };

    class LS_API ProxySettings
    {
    public:

        ProxySettings() = default;

        ProxySettings( const std::string& proxy, const std::string& user, const std::string& password );

        ~ProxySettings();

        bool fetchProxySettings( const std::string& serviceURL, const std::string& credentialTarget, bool throwExceptions = false );

        void setProxyUri( const std::string& uri );

        const std::string& getProxyUri() const;

        void setUser( const std::string& user );

        const std::string& getUser() const;

        void setPassword( const std::string& password );

        const std::string& getPassword() const;

        bool isValid() const; 

    private:
        std::string m_proxyUri; // e.g. "http://local.example.com:1080"
        std::string m_user;
        std::string m_password;
    };

    class LS_API ExtendedOptions
    {
    public:

        ExtendedOptions();

        ExtendedOptions( const std::wstring& licenseFilePath );

        ExtendedOptions( const std::wstring& licenseFilePath,
                         const std::string& hardwareID,
                         const ProxySettings& proxy = ProxySettings() );

        ~ExtendedOptions();

        void setLicenseFilePath( const std::wstring& filePath );

        const std::wstring& getLicenseFilePath() const;

        void setHardwareID( const std::string& ID );

        const std::string& getHardwareID() const;

        DeviceIDAlgorithm getDeviceIdAlgorithm() const;

        void setDeviceIdAlgorithm( DeviceIDAlgorithm algorithm );

        void collectNetworkInfo( bool collect );

        bool isCollectNetworkInfoEnabled() const;

        void enableLogging( bool enable );

        bool isLoggingEnabled() const;

        void enableGuardFile( bool enable );

        bool isGuardFileEnabled() const;

        void enableVMDetection( bool enable );

        bool isVMDetectionEnabled() const;

        void enableSSLCheck( bool enable );

        bool isSSLCheckEnabled() const;

        void setUseNativeTLS( bool value );

        bool isNativeTLSEnabled() const;

        void setGracePeriod( uint32_t value );

        uint32_t getGracePeriod() const;

        void setNetworkTimeout( long timeout );

        long getNetworkTimeout() const;

        void setProxySettings( const ProxySettings& settings );

        const ProxySettings& getProxySettings() const;

        void overrideNetworkInfo( const NetworkInfo& networkInfo );

        const NetworkInfo& getNetworkInfo() const;

        void overrideCryptoProvider( CryptoProvider::ptr_t cryptoProvider );

        CryptoProvider::ptr_t getCryptoProvider();

        void setAlternateServiceURL( const std::string& URL );

        const std::string& getAlternateServiceURL() const;

        void setAlternateKey( const std::string& key );

        void setAlternateKey( const std::vector<int32_t>& key );

        void setAlternateKey( const int32_t* key, std::size_t size );

        const std::string& getAlternateKey() const;

    private:
        std::wstring  m_licenseFilePath;
        std::string   m_hardwareID;
        std::string   m_serviceURL;
        std::string   m_key;
        bool          m_collectNetworkInfo; // false by default
        bool          m_enableVMDetection;  // false by default
        bool          m_enableGuardFile;    // true by default
        bool          m_enableSSLCheck;     // false by default
        bool          m_useNativeTLS;       // see isNativeTLSEnabled
        uint32_t      m_gracePeriod;        // in hours, default value is 48
        long          m_networkTimeout;     // in seconds, default is 5 seconds
        ProxySettings m_proxySettings;      // by default doesn't use any proxy
        NetworkInfo   m_networkInfo;
        DeviceIDAlgorithm m_deviceIDAlgorithm;
        CryptoProvider::ptr_t m_cryptoProvider;
    };

} // namespace LicenseSpring

#ifdef _MSC_VER
#pragma warning( pop )
#endif

#endif // LS_EXTENDED_OPTIONS_H