Documentation
¶
Index ¶
- Variables
- func GetCacheDir() (string, error)
- type Config
- func (c *Config) AddFilterList(list FilterList) error
- func (c *Config) AddFilterLists(lists []FilterList) error
- func (c *Config) ExportDebugData() (string, error)
- func (c *Config) GetCAInstalled() bool
- func (c *Config) GetFilterLists() []FilterList
- func (c *Config) GetFilterListsByLocales(searchLocales []string) []FilterList
- func (c *Config) GetFirstLaunch() bool
- func (c *Config) GetIgnoredHosts() []string
- func (c *Config) GetKeyStorage() KeyStorageType
- func (c *Config) GetLocale() string
- func (c *Config) GetPACPort() int
- func (c *Config) GetPort() int
- func (c *Config) GetRouting() RoutingConfig
- func (c *Config) GetRules() []string
- func (c *Config) GetTargetTypeFilterLists(targetType FilterListType) []FilterList
- func (c *Config) GetUpdatePolicy() UpdatePolicyType
- func (c *Config) GetVersion() string
- func (c *Config) RemoveFilterList(url string) error
- func (c *Config) RunMigrations()
- func (c *Config) SetCAInstalled(caInstalled bool)
- func (c *Config) SetIgnoredHosts(hosts []string) error
- func (c *Config) SetKeyStorage(storage KeyStorageType) error
- func (c *Config) SetLocale(l string) error
- func (c *Config) SetPACPort(port int) error
- func (c *Config) SetPort(port int) error
- func (c *Config) SetRouting(routing RoutingConfig) error
- func (c *Config) SetRules(rules []string) error
- func (c *Config) SetUpdatePolicy(p UpdatePolicyType) error
- func (c *Config) ToggleFilterList(url string, enabled bool) error
- type DebugData
- type FilterList
- type FilterListType
- type KeyStorageType
- type RoutingConfig
- type RoutingMode
- type UpdatePolicyType
Constants ¶
This section is empty.
Variables ¶
var ( // ConfigDir is the path to the directory storing the application configuration. ConfigDir string // DataDir is the path to the directory storing the application data. DataDir string // Version is the current version of the application. Set at compile time for production builds using ldflags (see tasks in the /tasks/build directory). Version = "development" )
var KeyStorageEnum = []struct { Value KeyStorageType TSName string }{ {KeyStorageDisk, "DISK"}, {KeyStorageHardware, "HARDWARE"}, }
var RoutingModeEnum = []struct { Value RoutingMode TSName string }{ {RoutingModeBlocklist, "BLOCKLIST"}, {RoutingModeAllowlist, "ALLOWLIST"}, }
var UpdatePolicyEnum = []struct { Value UpdatePolicyType TSName string }{ {UpdatePolicyAutomatic, "AUTOMATIC"}, {UpdatePolicyPrompt, "PROMPT"}, {UpdatePolicyDisabled, "DISABLED"}, }
Functions ¶
func GetCacheDir ¶
Types ¶
type Config ¶
type Config struct {
Filter struct {
FilterLists []FilterList `json:"filterLists"`
// Deprecated: use Rules.
MyRules []string `json:"myRules"`
Rules []string `json:"rules"`
// Deprecated: assets are served by the proxy itself, under constants.LocalEndpointHost.
// omitempty keeps the dead key out of fresh configs; configs stamped by the
// v0.17.0 migration carry a non-zero value and keep serialising it.
AssetPort int `json:"assetPort,omitempty"`
} `json:"filter"`
Certmanager struct {
CAInstalled bool `json:"caInstalled"`
// KeyStorage describes the installed CA, not a pending choice. It only changes after the
// old CA has been uninstalled, so it always matches the CA that CAInstalled refers to.
KeyStorage KeyStorageType `json:"keyStorage"`
} `json:"certmanager"`
Proxy struct {
Port int `json:"port"`
IgnoredHosts []string `json:"ignoredHosts"`
PACPort int `json:"pacPort"`
Routing RoutingConfig `json:"routing"`
} `json:"proxy"`
UpdatePolicy UpdatePolicyType `json:"updatePolicy"`
Locale string `json:"locale"`
// contains filtered or unexported fields
}
Config stores and manages the configuration for the application. Although all fields are public, this is only for use by the JSON marshaller. All access to the Config should be done through the exported methods.
func (*Config) AddFilterList ¶
func (c *Config) AddFilterList(list FilterList) error
AddFilterList adds a new filter list to the list of enabled filter lists.
func (*Config) AddFilterLists ¶
func (c *Config) AddFilterLists(lists []FilterList) error
func (*Config) ExportDebugData ¶
func (*Config) GetCAInstalled ¶
GetCAInstalled returns whether the CA is installed.
func (*Config) GetFilterLists ¶
func (c *Config) GetFilterLists() []FilterList
GetFilterLists returns the list of enabled filter lists.
func (*Config) GetFilterListsByLocales ¶
func (c *Config) GetFilterListsByLocales(searchLocales []string) []FilterList
func (*Config) GetFirstLaunch ¶
func (*Config) GetIgnoredHosts ¶
GetIgnoredHosts returns the list of ignored hosts.
func (*Config) GetKeyStorage ¶ added in v0.26.0
func (c *Config) GetKeyStorage() KeyStorageType
GetKeyStorage returns where the installed CA's private key is stored.
func (*Config) GetPACPort ¶
func (*Config) GetRouting ¶
func (c *Config) GetRouting() RoutingConfig
func (*Config) GetTargetTypeFilterLists ¶
func (c *Config) GetTargetTypeFilterLists(targetType FilterListType) []FilterList
GetTargetTypeFilterLists returns the list of filter lists with particular type.
func (*Config) GetUpdatePolicy ¶
func (c *Config) GetUpdatePolicy() UpdatePolicyType
func (*Config) GetVersion ¶
func (*Config) RemoveFilterList ¶
RemoveFilterList removes a filter list from the list of enabled filter lists.
func (*Config) RunMigrations ¶
func (c *Config) RunMigrations()
RunMigrations brings the config, and any other state migrations touch, up to date with this build.
func (*Config) SetCAInstalled ¶
SetCAInstalled sets whether the CA is installed.
func (*Config) SetIgnoredHosts ¶
SetIgnoredHosts sets the list of ignored hosts.
func (*Config) SetKeyStorage ¶ added in v0.26.0
func (c *Config) SetKeyStorage(storage KeyStorageType) error
SetKeyStorage records where the CA's private key is stored. It must only be called while no CA is installed, which App.SetCAKeyStorage ensures.
func (*Config) SetPACPort ¶ added in v0.23.0
SetPACPort sets the port the PAC server is set to listen on.
func (*Config) SetRouting ¶
func (c *Config) SetRouting(routing RoutingConfig) error
func (*Config) SetUpdatePolicy ¶
func (c *Config) SetUpdatePolicy(p UpdatePolicyType) error
type FilterList ¶
type FilterListType ¶
type FilterListType string
const ( FilterListTypeGeneral FilterListType = "general" FilterListTypeAds FilterListType = "ads" FilterListTypePrivacy FilterListType = "privacy" FilterListTypeMalware FilterListType = "malware" FilterListTypeRegional FilterListType = "regional" FilterListTypeDigitalWellbeing FilterListType = "digitalWellbeing" FilterListTypeCustom FilterListType = "custom" )
type KeyStorageType ¶ added in v0.26.0
type KeyStorageType string
KeyStorageType says where the root CA's private key is stored.
const ( // KeyStorageDisk keeps the key in a PEM file in the data directory. KeyStorageDisk KeyStorageType = "disk" // KeyStorageHardware keeps the key in the Secure Enclave (macOS) or the TPM (Windows). KeyStorageHardware KeyStorageType = "hardware" )
type RoutingConfig ¶
type RoutingConfig struct {
Mode RoutingMode `json:"mode"`
AppPaths []string `json:"appPaths"`
}
type RoutingMode ¶
type RoutingMode string
const ( RoutingModeBlocklist RoutingMode = "blocklist" RoutingModeAllowlist RoutingMode = "allowlist" )
type UpdatePolicyType ¶
type UpdatePolicyType string
const ( UpdatePolicyAutomatic UpdatePolicyType = "automatic" UpdatePolicyPrompt UpdatePolicyType = "prompt" UpdatePolicyDisabled UpdatePolicyType = "disabled" )