mirror of
https://github.com/safing/portbase
synced 2025-09-01 10:09:50 +00:00
88 lines
2.5 KiB
Go
88 lines
2.5 KiB
Go
package api
|
|
|
|
import (
|
|
"flag"
|
|
|
|
"github.com/safing/portbase/config"
|
|
"github.com/safing/portbase/log"
|
|
)
|
|
|
|
// Config Keys
|
|
const (
|
|
CfgDefaultListenAddressKey = "core/listenAddress"
|
|
CfgAPIKeys = "core/apiKeys"
|
|
)
|
|
|
|
var (
|
|
listenAddressFlag string
|
|
listenAddressConfig config.StringOption
|
|
defaultListenAddress string
|
|
|
|
configuredAPIKeys config.StringArrayOption
|
|
)
|
|
|
|
func init() {
|
|
flag.StringVar(&listenAddressFlag, "api-address", "", "override api listen address")
|
|
}
|
|
|
|
func logFlagOverrides() {
|
|
if listenAddressFlag != "" {
|
|
log.Warning("api: api/listenAddress default config is being overridden by -api-address flag")
|
|
}
|
|
}
|
|
|
|
func getDefaultListenAddress() string {
|
|
// check if overridden
|
|
if listenAddressFlag != "" {
|
|
return listenAddressFlag
|
|
}
|
|
// return internal default
|
|
return defaultListenAddress
|
|
}
|
|
|
|
func registerConfig() error {
|
|
err := config.Register(&config.Option{
|
|
Name: "API Listen Address",
|
|
Key: CfgDefaultListenAddressKey,
|
|
Description: "Defines the IP address and port on which the internal API listens.",
|
|
OptType: config.OptTypeString,
|
|
ExpertiseLevel: config.ExpertiseLevelDeveloper,
|
|
ReleaseLevel: config.ReleaseLevelStable,
|
|
DefaultValue: getDefaultListenAddress(),
|
|
ValidationRegex: "^([0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}.[0-9]{1,3}:[0-9]{1,5}|\\[[:0-9A-Fa-f]+\\]:[0-9]{1,5})$",
|
|
RequiresRestart: true,
|
|
Annotations: config.Annotations{
|
|
config.DisplayOrderAnnotation: 513,
|
|
config.CategoryAnnotation: "Development",
|
|
},
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
listenAddressConfig = config.GetAsString(CfgDefaultListenAddressKey, getDefaultListenAddress())
|
|
|
|
err = config.Register(&config.Option{
|
|
Name: "API Keys",
|
|
Key: CfgAPIKeys,
|
|
Description: "Define API keys for priviledged access to the API. Every entry is a separate API key with respective permissions. Format is `<key>?read=<perm>&write=<perm>`. Permissions are `anyone`, `user` and `admin`, and may be omitted.",
|
|
OptType: config.OptTypeStringArray,
|
|
ExpertiseLevel: config.ExpertiseLevelDeveloper,
|
|
ReleaseLevel: config.ReleaseLevelStable,
|
|
DefaultValue: []string{},
|
|
Annotations: config.Annotations{
|
|
config.DisplayOrderAnnotation: 514,
|
|
config.CategoryAnnotation: "Development",
|
|
},
|
|
})
|
|
if err != nil {
|
|
return err
|
|
}
|
|
configuredAPIKeys = config.GetAsStringArray(CfgAPIKeys, []string{})
|
|
|
|
return nil
|
|
}
|
|
|
|
// SetDefaultAPIListenAddress sets the default listen address for the API.
|
|
func SetDefaultAPIListenAddress(address string) {
|
|
defaultListenAddress = address
|
|
}
|