keygen

package module

Go to main page

Versions in this module

v2

v2.9.0

Mar 12, 2024

v2.8.2

Mar 12, 2024

v2.8.1

Mar 12, 2024

v2.8.0

Feb 2, 2024

Changes in this version

+ var ErrComponentAlreadyActivated = errors.New("component is already activated")

+ var ErrComponentConflict = errors.New("component is duplicated")

+ var ErrComponentNotActivated = errors.New("component is not activated")

+ var ErrValidationComponentsMissing = errors.New("validation components scope is missing")

+ type Component struct

+ Created time.Time

+ Fingerprint string

+ ID string

+ MachineID string

+ Metadata map[string]interface{}

+ Name string

+ Type string

+ Updated time.Time

+ func (c *Component) SetData(to func(target interface{}) error) error

+ func (c *Component) SetID(id string) error

+ func (c *Component) SetType(t string) error

+ func (c Component) GetData() interface{}

+ func (c Component) GetID() string

+ func (c Component) GetType() string

+ func (c Component) UseExperimentalEmbeddedRelationshipData() bool

+ type Components []Component

+ func (c *Components) SetData(to func(target interface{}) error) error

type ErrorCode

+ const ErrorCodeComponentFingerprintConflict

+ const ErrorCodeComponentFingerprintTaken

type Machine

+ func (m *Machine) Components() (Components, error)

type MachineFileDataset

+ Components Components

type ValidationCode

+ const ValidationCodeComponentsScopeEmpty

+ const ValidationCodeComponentsScopeMismatch

+ const ValidationCodeComponentsScopeRequired

type ValidationResult

+ Detail string

+ Scope *ValidationScope

+ type ValidationScope struct

v2.8.0-beta.2

Sep 8, 2023

v2.8.0-beta.1

Sep 8, 2023

v2.7.0

Sep 7, 2023

Changes in this version

+ type CheckoutOption func(*CheckoutOptions) error

+ func CheckoutInclude(includes ...string) CheckoutOption

+ func CheckoutTTL(ttl time.Duration) CheckoutOption

+ type CheckoutOptions struct

+ Encrypt bool

+ Include string

+ TTL int

v2.6.1

Aug 3, 2023

v2.6.0

Jul 26, 2023

Changes in this version

+ var Package string

type UpgradeOptions

+ Package string

v2.5.0

Jun 28, 2023

Changes in this version

+ var Environment string

type ClientOptions

+ APIPrefix string

+ APIURL string

+ APIVersion string

+ Environment string

+ type EnvironmentError struct

+ Err *Error

+ func (e *EnvironmentError) Error() string

+ func (e *EnvironmentError) Unwrap() error

type ErrorCode

+ const ErrorCodeEnvironmentInvalid

+ const ErrorCodeEnvironmentNotSupported

v2.4.1

Apr 27, 2023

v2.4.0

Apr 17, 2023

Changes in this version

type UpgradeOptions

+ Product string

v2.3.1

Jan 27, 2023

v2.3.0

Jan 27, 2023

Changes in this version

type ErrorCode

+ const ErrorCodeLicenseExpired

+ const ErrorCodeLicenseSuspended

v2.2.1

Jul 18, 2022

v2.2.0

Jul 6, 2022

Changes in this version

type License

+ LastValidation *ValidationResult

+ type ValidationResult struct

+ Code ValidationCode

+ Valid bool

v2.1.0

Jul 5, 2022

Changes in this version

+ var ErrLicenseTooManyProcesses = errors.New("license has too many processes")

type ValidationCode

+ const ValidationCodeTooManyProcesses

v2.0.0

Jun 27, 2022

Changes in this version

+ const SDKVersion

+ var APIPrefix = "v1"

+ var APIURL = "https://api.keygen.sh"

+ var APIVersion = "1.1"

+ var Account string

+ var ErrHeartbeatDead = errors.New("heartbeat is dead")

+ var ErrHeartbeatPingFailed = errors.New("heartbeat ping failed")

+ var ErrHeartbeatRequired = errors.New("heartbeat is required")

+ var ErrLicenseExpired = errors.New("license is expired")

+ var ErrLicenseFileExpired = errors.New("license file is expired")

+ var ErrLicenseFileNotEncrypted = errors.New("license file is not encrypted")

+ var ErrLicenseFileNotGenuine = errors.New("license file is not genuine")

+ var ErrLicenseFileNotSupported = errors.New("license file is not supported")

+ var ErrLicenseFileSecretMissing = errors.New("license file secret is missing")

+ var ErrLicenseInvalid = errors.New("license is invalid")

+ var ErrLicenseKeyMissing = errors.New("license key is missing")

+ var ErrLicenseKeyNotGenuine = errors.New("license key is not genuine")

+ var ErrLicenseNotActivated = errors.New("license is not activated")

+ var ErrLicenseNotSigned = errors.New("license is not signed")

+ var ErrLicenseSchemeMissing = errors.New("license scheme is missing")

+ var ErrLicenseSchemeNotSupported = errors.New("license scheme is not supported")

+ var ErrLicenseSuspended = errors.New("license is suspended")

+ var ErrLicenseTooManyCores = errors.New("license has too many cores")

+ var ErrLicenseTooManyMachines = errors.New("license has too many machines")

+ var ErrMachineAlreadyActivated = errors.New("machine is already activated")

+ var ErrMachineFileExpired = errors.New("machine file is expired")

+ var ErrMachineFileNotEncrypted = errors.New("machine file is not encrypted")

+ var ErrMachineFileNotGenuine = errors.New("machine file is not genuine")

+ var ErrMachineFileNotSupported = errors.New("machine file is not supported")

+ var ErrMachineLimitExceeded = errors.New("machine limit has been exceeded")

+ var ErrMachineNotFound = errors.New("machine no longer exists")

+ var ErrProcessLimitExceeded = errors.New("process limit has been exceeded")

+ var ErrProcessNotFound = errors.New("process no longer exists")

+ var ErrPublicKeyInvalid = errors.New("public key is invalid")

+ var ErrPublicKeyMissing = errors.New("public key is missing")

+ var ErrReleaseLocationMissing = errors.New("release has no download URL")

+ var ErrRequestDateInvalid = errors.New("request date is invalid")

+ var ErrRequestDateMissing = errors.New("request date is missing")

+ var ErrRequestDateTooOld = errors.New("request date is too old")

+ var ErrRequestDigestInvalid = errors.New("request digest is invalid")

+ var ErrRequestDigestMissing = errors.New("request digest is missing")

+ var ErrRequestSignatureInvalid = errors.New("request signature is invalid")

+ var ErrRequestSignatureMissing = errors.New("request signature is missing")

+ var ErrResponseDateInvalid = errors.New("response date is invalid")

+ var ErrResponseDateMissing = errors.New("response date is missing")

+ var ErrResponseDateTooOld = errors.New("response date is too old")

+ var ErrResponseDigestInvalid = errors.New("response digest is invalid")

+ var ErrResponseDigestMissing = errors.New("response digest is missing")

+ var ErrResponseSignatureInvalid = errors.New("response signature is invalid")

+ var ErrResponseSignatureMissing = errors.New("response signature is missing")

+ var ErrSystemClockUnsynced = errors.New("system clock is out of sync")

+ var ErrUpgradeNotAvailable = errors.New("no upgrades available (already up-to-date)")

+ var ErrValidationFingerprintMissing = errors.New("validation fingerprint scope is missing")

+ var ErrValidationProductMissing = errors.New("validation product scope is missing")

+ var Ext = "" — darwin/amd64, js/wasm, linux/amd64

+ var Ext = "exe" — windows/amd64

+ var HTTPClient = cleanhttp.DefaultPooledClient()

+ var LicenseKey string

+ var Logger LeveledLogger = &logger

+ var MaxClockDrift = time.Duration(5) * time.Minute

+ var Product string

+ var Program = filepath.Base(os.Args[0])

+ var PublicKey string

+ var Token string

+ var UserAgent string

+ func VerifyWebhook(request *http.Request) error

+ type Artifact struct

+ Arch string

+ Checksum string

+ Created time.Time

+ Filename string

+ Filesize int64

+ Filetype string

+ ID string

+ Platform string

+ ReleaseId string

+ Signature string

+ Type string

+ URL string

+ Updated time.Time

+ func (a *Artifact) SetData(to func(target interface{}) error) error

+ func (a *Artifact) SetID(id string) error

+ func (a *Artifact) SetRelationships(relationships map[string]interface{}) error

+ func (a *Artifact) SetType(t string) error

+ type Client struct

+ HTTPClient *http.Client

+ func NewClient() *Client

+ func NewClientWithOptions(options *ClientOptions) *Client

+ func (c *Client) Delete(path string, params interface{}, model interface{}) (*Response, error)

+ func (c *Client) Get(path string, params interface{}, model interface{}) (*Response, error)

+ func (c *Client) Patch(path string, params interface{}, model interface{}) (*Response, error)

+ func (c *Client) Post(path string, params interface{}, model interface{}) (*Response, error)

+ func (c *Client) Put(path string, params interface{}, model interface{}) (*Response, error)

+ type ClientOptions struct

+ Account string

+ LicenseKey string

+ PublicKey string

+ Token string

+ UserAgent string

+ type Entitlement struct

+ Code EntitlementCode

+ Created time.Time

+ ID string

+ Metadata map[string]interface{}

+ Type string

+ Updated time.Time

+ func (e *Entitlement) SetData(to func(target interface{}) error) error

+ func (e *Entitlement) SetID(id string) error

+ func (e *Entitlement) SetType(t string) error

+ type EntitlementCode string

+ type Entitlements []Entitlement

+ func (e *Entitlements) SetData(to func(target interface{}) error) error

+ type Error struct

+ Code string

+ Detail string

+ Response *Response

+ Source string

+ Title string

+ func (e *Error) Error() string

+ type ErrorCode string

+ const ErrorCodeFingerprintTaken

+ const ErrorCodeLicenseInvalid

+ const ErrorCodeMachineHeartbeatDead

+ const ErrorCodeMachineLimitExceeded

+ const ErrorCodeNotFound

+ const ErrorCodeProcessHeartbeatDead

+ const ErrorCodeProcessLimitExceeded

+ const ErrorCodeTokenInvalid

+ type HeartbeatStatusCode string

+ const HeartbeatStatusCodeAlive

+ const HeartbeatStatusCodeDead

+ const HeartbeatStatusCodeNotStarted

+ const HeartbeatStatusCodeResurrected

+ type LeveledLogger interface

+ Debugf func(format string, v ...interface{})

+ Errorf func(format string, v ...interface{})

+ Infof func(format string, v ...interface{})

+ Warnf func(format string, v ...interface{})

+ type License struct

+ Created time.Time

+ Expiry *time.Time

+ ID string

+ Key string

+ LastValidated *time.Time

+ Metadata map[string]interface{}

+ Name string

+ PolicyId string

+ RequireHeartbeat bool

+ Scheme SchemeCode

+ Type string

+ Updated time.Time

+ func Validate(fingerprints ...string) (*License, error)

+ func (l *License) Activate(fingerprint string) (*Machine, error)

+ func (l *License) Checkout() (*LicenseFile, error)

+ func (l *License) Deactivate(id string) error

+ func (l *License) Entitlements() (Entitlements, error)

+ func (l *License) Machine(id string) (*Machine, error)

+ func (l *License) Machines() (Machines, error)

+ func (l *License) SetData(to func(target interface{}) error) error

+ func (l *License) SetID(id string) error

+ func (l *License) SetRelationships(relationships map[string]interface{}) error

+ func (l *License) SetType(t string) error

+ func (l *License) Validate(fingerprints ...string) error

+ func (l *License) Verify() ([]byte, error)

+ type LicenseFile struct

+ Certificate string

+ Expiry time.Time

+ ID string

+ Issued time.Time

+ LicenseID string

+ TTL int

+ Type string

+ func (lic *LicenseFile) Decrypt(key string) (*LicenseFileDataset, error)

+ func (lic *LicenseFile) SetData(to func(target interface{}) error) error

+ func (lic *LicenseFile) SetID(id string) error

+ func (lic *LicenseFile) SetRelationships(relationships map[string]interface{}) error

+ func (lic *LicenseFile) SetType(t string) error

+ func (lic *LicenseFile) Verify() error

+ type LicenseFileDataset struct

+ Entitlements Entitlements

+ Expiry time.Time

+ Issued time.Time

+ License License

+ TTL int

+ func (lic *LicenseFileDataset) SetData(to func(target interface{}) error) error

+ func (lic *LicenseFileDataset) SetIncluded(relationships []*jsonapi.ResourceObject, ...) error

+ func (lic *LicenseFileDataset) SetMeta(to func(target interface{}) error) error

+ type LicenseFileError struct

+ Err error

+ func (e *LicenseFileError) Error() string

+ func (e *LicenseFileError) Unwrap() error

+ type LicenseKeyError struct

+ Err *Error

+ func (e *LicenseKeyError) Error() string

+ func (e *LicenseKeyError) Unwrap() error

+ type LicenseTokenError struct

+ Err *Error

+ func (e *LicenseTokenError) Error() string

+ func (e *LicenseTokenError) Unwrap() error

+ type LogLevel uint32

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelInfo

+ const LogLevelNone

+ const LogLevelWarn

+ type Machine struct

+ Cores int

+ Created time.Time

+ Fingerprint string

+ HeartbeatDuration int

+ HeartbeatStatus HeartbeatStatusCode

+ Hostname string

+ ID string

+ LicenseID string

+ Metadata map[string]interface{}

+ Name string

+ Platform string

+ RequireHeartbeat bool

+ Type string

+ Updated time.Time

+ func (m *Machine) Checkout() (*MachineFile, error)

+ func (m *Machine) Deactivate() error

+ func (m *Machine) Monitor() error

+ func (m *Machine) Processes() (Processes, error)

+ func (m *Machine) SetData(to func(target interface{}) error) error

+ func (m *Machine) SetID(id string) error

+ func (m *Machine) SetType(t string) error

+ func (m *Machine) Spawn(pid string) (*Process, error)

+ func (m Machine) GetData() interface{}

+ func (m Machine) GetID() string

+ func (m Machine) GetType() string

+ type MachineFile struct

+ Certificate string

+ Expiry time.Time

+ ID string

+ Issued time.Time

+ LicenseID string

+ MachineID string

+ TTL int

+ Type string

+ func (lic *MachineFile) Decrypt(key string) (*MachineFileDataset, error)

+ func (lic *MachineFile) SetData(to func(target interface{}) error) error

+ func (lic *MachineFile) SetID(id string) error

+ func (lic *MachineFile) SetRelationships(relationships map[string]interface{}) error

+ func (lic *MachineFile) SetType(t string) error

+ func (lic *MachineFile) Verify() error

+ type MachineFileDataset struct

+ Entitlements Entitlements

+ Expiry time.Time

+ Issued time.Time

+ License License

+ Machine Machine

+ TTL int

+ func (lic *MachineFileDataset) SetData(to func(target interface{}) error) error

+ func (lic *MachineFileDataset) SetIncluded(relationships []*jsonapi.ResourceObject, ...) error

+ func (lic *MachineFileDataset) SetMeta(to func(target interface{}) error) error

+ type MachineFileError struct

+ Err error

+ func (e *MachineFileError) Error() string

+ func (e *MachineFileError) Unwrap() error

+ type Machines []Machine

+ func (m *Machines) SetData(to func(target interface{}) error) error

+ type NotAuthorizedError struct

+ Err *Error

+ func (e *NotAuthorizedError) Error() string

+ func (e *NotAuthorizedError) Unwrap() error

+ type NotFoundError struct

+ Err *Error

+ func (e *NotFoundError) Error() string

+ func (e *NotFoundError) Unwrap() error

+ type Process struct

+ Created time.Time

+ ID string

+ Interval int

+ MachineID string

+ Metadata map[string]interface{}

+ Pid string

+ Status ProcessStatusCode

+ Type string

+ Updated time.Time

+ func (p *Process) Kill() error

+ func (p *Process) SetData(to func(target interface{}) error) error

+ func (p *Process) SetID(id string) error

+ func (p *Process) SetType(t string) error

+ func (p Process) GetData() interface{}

+ func (p Process) GetID() string

+ func (p Process) GetType() string

+ type ProcessStatusCode string

+ const ProcessStatusCodeAlive

+ const ProcessStatusCodeDead

+ type Processes []Process

+ func (p *Processes) SetData(to func(target interface{}) error) error

+ type RateLimitError struct

+ Count int

+ Err error

+ Limit int

+ Remaining int

+ Reset time.Time

+ RetryAfter int

+ Window string

+ func (e *RateLimitError) Error() string

+ func (e *RateLimitError) Unwrap() error

+ type Release struct

+ Channel string

+ Created time.Time

+ Description string

+ ID string

+ Metadata map[string]interface{}

+ Name string

+ Type string

+ Updated time.Time

+ Version string

+ func Upgrade(options UpgradeOptions) (*Release, error)

+ func (r *Release) Install() error

+ func (r *Release) SetData(to func(target interface{}) error) error

+ func (r *Release) SetID(id string) error

+ func (r *Release) SetType(t string) error

+ type Response struct

+ Body []byte

+ Document *jsonapi.Document

+ Headers http.Header

+ ID string

+ Request *http.Request

+ Size int

+ Status int

+ type SchemeCode string

+ const SchemeCodeEd25519

+ type UpgradeOptions struct

+ Channel string

+ Constraint string

+ CurrentVersion string

+ Filename string

+ PublicKey string

+ type ValidationCode string

+ const ValidationCodeEntitlementsEmpty

+ const ValidationCodeEntitlementsMissing

+ const ValidationCodeExpired

+ const ValidationCodeFingerprintScopeEmpty

+ const ValidationCodeFingerprintScopeMismatch

+ const ValidationCodeFingerprintScopeRequired

+ const ValidationCodeHeartbeatDead

+ const ValidationCodeHeartbeatNotStarted

+ const ValidationCodeMachineScopeMismatch

+ const ValidationCodeMachineScopeRequired

+ const ValidationCodeNoMachine

+ const ValidationCodeNoMachines

+ const ValidationCodeNotFound

+ const ValidationCodeOverdue

+ const ValidationCodePolicyScopeMismatch

+ const ValidationCodePolicyScopeRequired

+ const ValidationCodeProductScopeEmpty

+ const ValidationCodeProductScopeRequired

+ const ValidationCodeSuspended

+ const ValidationCodeTooManyCores

+ const ValidationCodeTooManyMachines

+ const ValidationCodeValid

v2.0.0-beta.17

Jun 15, 2022

v2.0.0-beta.16

Jun 15, 2022

v2.0.0-beta.15

Jun 9, 2022

v2.0.0-beta.14

Jun 9, 2022

v2.0.0-beta.13

Jun 9, 2022

v2.0.0-beta.12

Jun 9, 2022

v2.0.0-beta.11

Jun 6, 2022

v2.0.0-beta.10

Jun 6, 2022

v2.0.0-beta.9

Jun 6, 2022

v2.0.0-beta.8

Jun 6, 2022

v2.0.0-beta.7

Jun 6, 2022

v2.0.0-beta.6

Jun 2, 2022

v2.0.0-beta.5

May 31, 2022

v2.0.0-beta.4

May 27, 2022

v2.0.0-beta.3

May 27, 2022

v2.0.0-beta.2

May 27, 2022

v2.0.0-beta.1

May 26, 2022

Other modules containing this package

github.com/keygen-sh/keygen-go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL