policy

Documentation

Overview

Package policy contains higher-level abstractions for accessing Windows enterprise policies.

Index

• func GetDurationPolicy(name string, defaultValue time.Duration) time.Duration
• func SelectControlURL(reg, disk string) string
• type PreferenceOptionPolicy
  • func GetPreferenceOptionPolicy(name string) PreferenceOptionPolicy
  • func (p PreferenceOptionPolicy) ShouldEnable(userChoice bool) bool
  • func (p PreferenceOptionPolicy) Show() bool
• type VisibilityPolicy
  • func GetVisibilityPolicy(name string) VisibilityPolicy
  • func (p VisibilityPolicy) Show() bool

Functions

func GetDurationPolicy

func GetDurationPolicy(name string, defaultValue time.Duration) time.Duration

GetDurationPolicy loads a policy from the registry that can be managed by an enterprise policy management system and describes a duration for some action. The registry value should be a string that time.ParseDuration understands. If the registry value is "" or can not be processed, defaultValue is returned instead.

func SelectControlURL

func SelectControlURL(reg, disk string) string

SelectControlURL returns the ControlURL to use based on a value in the registry (LoginURL) and the one on disk (in the GUI's prefs.conf). If both are empty, it returns a default value. (It always return a non-empty value)

See https://github.com/tailscale/tailscale/issues/2798 for some background.

Types

type PreferenceOptionPolicy

type PreferenceOptionPolicy int

PreferenceOptionPolicy is a policy that governs whether a boolean variable is forcibly assigned an administrator-defined value, or allowed to receive a user-defined value.

func GetPreferenceOptionPolicy

func GetPreferenceOptionPolicy(name string) PreferenceOptionPolicy

GetPreferenceOptionPolicy loads a policy from the registry that can be managed by an enterprise policy management system and allows administrative overrides of users' choices in a way that we do not want tailcontrol to have the authority to set. It describes user-decides/always/never options, where "always" and "never" remove the user's ability to make a selection. If not present or set to a different value, "user-decides" is the default.

func (PreferenceOptionPolicy) ShouldEnable

func (p PreferenceOptionPolicy) ShouldEnable(userChoice bool) bool

ShouldEnable checks if the choice administered by this policy should be enabled. If the administrator has chosen a setting, the administrator's setting is returned, otherwise userChoice is returned.

func (PreferenceOptionPolicy) Show

func (p PreferenceOptionPolicy) Show() bool

Show returns if the UI option that controls the choice administered by this policy should be shown. Currently this is true if and only if the policy is showChoiceByPolicy.

type VisibilityPolicy

type VisibilityPolicy byte

VisibilityPolicy is a policy that controls whether or not a particular component of a user interface is to be shown.

func GetVisibilityPolicy

func GetVisibilityPolicy(name string) VisibilityPolicy

GetVisibilityPolicy loads a policy from the registry that can be managed by an enterprise policy management system and describes show/hide decisions for UI elements. The registry value should be a string set to "show" (return true) or "hide" (return true). If not present or set to a different value, "show" (return false) is the default.

func (VisibilityPolicy) Show

func (p VisibilityPolicy) Show() bool

Show reports whether the UI option administered by this policy should be shown. Currently this is true if and only if the policy is visibleByPolicy.