headscale

package module

Go to main page

Versions in this module

v0

v0.0.14

Nov 2, 2023

v0.0.13

Aug 10, 2023

Changes in this version

type Headscale

+ func (h *Headscale) CreateOrUpdateUserACLPolicy(userID uint, policy ACLPolicy) (*UserACLPolicy, error)

v0.0.12

Jul 26, 2023

v0.0.11

May 18, 2023

v0.0.10

May 5, 2023

Changes in this version

type Headscale

+ func (h *Headscale) DestroyUserACLPolicy(userID uint) error

v0.0.9

May 4, 2023

Changes in this version

type ACLPolicy

+ func (policy ACLPolicy) ToProto() *v1.ACLPolicy

type Headscale

+ func (h *Headscale) CreateUserACLPolicy(userID uint, policy ACLPolicy) (*UserACLPolicy, error)

+ func (h *Headscale) ListMachinesByUserID(userID uint) ([]Machine, error)

type Machines

+ func (machines Machines) FilterByIP(ip netip.Addr) Machines

+ type UserACLPolicy struct

+ ACLPolicy ACLPolicy

+ CreatedAt time.Time

+ ID uint64

+ UpdatedAt time.Time

+ User User

+ UserID uint

v0.0.8

Apr 17, 2023

v0.0.7

Apr 14, 2023

v0.0.6

Apr 14, 2023

v0.0.5

Apr 14, 2023

v0.0.4

Apr 14, 2023

v0.0.3

Apr 14, 2023

v0.0.2

Apr 14, 2023

v0.0.1

Apr 14, 2023

Changes in this version

+ const AuthPrefix

+ const Base10

+ const Base8

+ const BitSize16

+ const BitSize32

+ const BitSize64

+ const ByteSize

+ const DisabledClientAuth

+ const EnforcedClientAuth

+ const ErrAPIKeyFailedToParse

+ const ErrCannotDecryptResponse

+ const ErrCannotParsePrefix

+ const ErrCouldNotAllocateIP

+ const ErrCouldNotConvertMachineInterface

+ const ErrDifferentRegisteredUser

+ const ErrHostnameTooLong

+ const ErrInvalidUserName

+ const ErrMachineAddressesInvalid

+ const ErrMachineNotFound

+ const ErrMachineNotFoundRegistrationCache

+ const ErrMachineRouteIsNotAvailable

+ const ErrPreAuthKeyACLTagInvalid

+ const ErrPreAuthKeyExpired

+ const ErrPreAuthKeyNotFound

+ const ErrRegisterMethodCLIDoesNotSupportExpire

+ const ErrRouteIsNotAvailable

+ const ErrSingleUseAuthKeyHasBeenUsed

+ const ErrUserExists

+ const ErrUserMismatch

+ const ErrUserNotFound

+ const ErrUserStillHasNodes

+ const HTTPReadTimeout

+ const HTTPShutdownTimeout

+ const JSONLogFormat

+ const MachineGivenNameHashLength

+ const MachineGivenNameTrimSize

+ const NoiseCapabilityVersion

+ const PermissionFallback

+ const Postgres

+ const ProtocolFC

+ const RegisterMethodAuthKey

+ const RegisterMethodCLI

+ const RegisterMethodOIDC

+ const RelaxedClientAuth

+ const Sqlite

+ const TextLogFormat

+ const ZstdCompression

+ var ExitRouteV4 = netip.MustParsePrefix("0.0.0.0/0")

+ var ExitRouteV6 = netip.MustParsePrefix("::/0")

+ var NodePublicKeyRegex = regexp.MustCompile("nodekey:[a-fA-F0-9]+")

+ func AbsolutePathFromConfigPath(path string) string

+ func CheckForFQDNRules(name string) error

+ func DiscoPublicKeyEnsurePrefix(discoKey string) string

+ func DiscoPublicKeyStripPrefix(discoKey key.DiscoPublic) string

+ func GenerateRandomBytes(n int) ([]byte, error)

+ func GenerateRandomStringDNSSafe(size int) (string, error)

+ func GenerateRandomStringURLSafe(n int) (string, error)

+ func GetDERPMap(cfg DERPConfig) *tailcfg.DERPMap

+ func GetDNSConfig() (*tailcfg.DNSConfig, string)

+ func GetFileMode(key string) fs.FileMode

+ func GetIPPrefixEndpoints(na netip.Prefix) (netip.Addr, netip.Addr)

+ func GrpcSocketDialer(ctx context.Context, addr string) (net.Conn, error)

+ func IsCLIConfigured() bool

+ func IsStringInSlice(slice []string, str string) bool

+ func LoadConfig(path string, isFile bool) error

+ func MachinePublicKeyEnsurePrefix(machineKey string) string

+ func MachinePublicKeyStripPrefix(machineKey key.MachinePublic) string

+ func NodePublicKeyEnsurePrefix(nodeKey string) string

+ func NodePublicKeyStripPrefix(nodeKey key.NodePublic) string

+ func NormalizeToFQDNRules(name string, stripEmailDomain bool) (string, error)

+ func PrivateKeyEnsurePrefix(privateKey string) string

+ func SwaggerAPIv1(writer http.ResponseWriter, req *http.Request)

+ func SwaggerUI(writer http.ResponseWriter, req *http.Request)

+ type ACL struct

+ Action string

+ Destinations []string

+ Protocol string

+ Sources []string

+ type ACLConfig struct

+ PolicyPath string

+ func GetACLConfig() ACLConfig

+ type ACLPolicy struct

+ ACLs []ACL

+ AutoApprovers AutoApprovers

+ Groups Groups

+ Hosts Hosts

+ SSHs []SSH

+ TagOwners TagOwners

+ Tests []ACLTest

+ func (policy ACLPolicy) IsZero() bool

+ type ACLTest struct

+ Accept []string

+ Deny []string

+ Source string

+ type APIKey struct

+ CreatedAt *time.Time

+ Expiration *time.Time

+ Hash []byte

+ ID uint64

+ LastSeen *time.Time

+ Prefix string

+ type AppleMobileConfig struct

+ Payload string

+ URL string

+ UUID uuid.UUID

+ type AppleMobilePlatformConfig struct

+ URL string

+ UUID uuid.UUID

+ type AutoApprovers struct

+ ExitNode []string

+ Routes map[string][]string

+ func (autoApprovers *AutoApprovers) GetRouteApprovers(prefix netip.Prefix) ([]string, error)

+ type CLIConfig struct

+ APIKey string

+ Address string

+ Insecure bool

+ Timeout time.Duration

+ type Config struct

+ ACL ACLConfig

+ ACMEEmail string

+ ACMEURL string

+ Addr string

+ BaseDomain string

+ CLI CLIConfig

+ DBhost string

+ DBname string

+ DBpass string

+ DBpath string

+ DBport int

+ DBssl string

+ DBtype string

+ DBuser string

+ DERP DERPConfig

+ DNSConfig *tailcfg.DNSConfig

+ DisableUpdateCheck bool

+ EphemeralNodeInactivityTimeout time.Duration

+ GRPCAddr string

+ GRPCAllowInsecure bool

+ IPPrefixes []netip.Prefix

+ Log LogConfig

+ LogTail LogTailConfig

+ MetricsAddr string

+ NodeUpdateCheckInterval time.Duration

+ NoisePrivateKeyPath string

+ OIDC OIDCConfig

+ PrivateKeyPath string

+ RandomizeClientPort bool

+ ServerURL string

+ TLS TLSConfig

+ UnixSocket string

+ UnixSocketPermission fs.FileMode

+ func GetHeadscaleConfig() (*Config, error)

+ type DERPConfig struct

+ AutoUpdate bool

+ Paths []string

+ STUNAddr string

+ ServerEnabled bool

+ ServerRegionCode string

+ ServerRegionID int

+ ServerRegionName string

+ URLs []url.URL

+ UpdateFrequency time.Duration

+ func GetDERPConfig() DERPConfig

+ type DERPServer struct

+ type Error string

+ func (e Error) Error() string

+ type Groups map[string][]string

+ type Headscale struct

+ DERPMap *tailcfg.DERPMap

+ DERPServer *DERPServer

+ func NewHeadscale(cfg *Config) (*Headscale, error)

+ func (h *Headscale) AppleConfigMessage(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) ApplePlatformConfig(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) CreateAPIKey(expiration *time.Time) (string, *APIKey, error)

+ func (h *Headscale) CreatePreAuthKey(userName string, reusable bool, ephemeral bool, expiration *time.Time, ...) (*PreAuthKey, error)

+ func (h *Headscale) CreateUser(name string) (*User, error)

+ func (h *Headscale) DERPBootstrapDNSHandler(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) DERPHandler(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) DERPProbeHandler(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) DeleteMachine(machine *Machine) error

+ func (h *Headscale) DeleteMachineRoutes(m *Machine) error

+ func (h *Headscale) DeleteRoute(id uint64) error

+ func (h *Headscale) DestroyAPIKey(key APIKey) error

+ func (h *Headscale) DestroyPreAuthKey(pak PreAuthKey) error

+ func (h *Headscale) DestroyUser(name string) error

+ func (h *Headscale) DisableRoute(id uint64) error

+ func (h *Headscale) EnableAutoApprovedRoutes(machine *Machine) error

+ func (h *Headscale) EnableRoute(id uint64) error

+ func (h *Headscale) ExpireAPIKey(key *APIKey) error

+ func (h *Headscale) ExpireMachine(machine *Machine) error

+ func (h *Headscale) ExpirePreAuthKey(k *PreAuthKey) error

+ func (h *Headscale) GenerateGivenName(machineKey string, suppliedName string) (string, error)

+ func (h *Headscale) GetAPIKey(prefix string) (*APIKey, error)

+ func (h *Headscale) GetAPIKeyByID(id uint64) (*APIKey, error)

+ func (h *Headscale) GetAdvertisedRoutes(machine *Machine) ([]netip.Prefix, error)

+ func (h *Headscale) GetEnabledRoutes(machine *Machine) ([]netip.Prefix, error)

+ func (h *Headscale) GetMachine(user string, name string) (*Machine, error)

+ func (h *Headscale) GetMachineByAnyKey(machineKey key.MachinePublic, nodeKey key.NodePublic, ...) (*Machine, error)

+ func (h *Headscale) GetMachineByGivenName(user string, givenName string) (*Machine, error)

+ func (h *Headscale) GetMachineByID(id uint64) (*Machine, error)

+ func (h *Headscale) GetMachineByMachineKey(machineKey key.MachinePublic) (*Machine, error)

+ func (h *Headscale) GetMachineByNodeKey(nodeKey key.NodePublic) (*Machine, error)

+ func (h *Headscale) GetMachineRoutes(m *Machine) ([]Route, error)

+ func (h *Headscale) GetPreAuthKey(user string, key string) (*PreAuthKey, error)

+ func (h *Headscale) GetRoute(id uint64) (*Route, error)

+ func (h *Headscale) GetRoutes() ([]Route, error)

+ func (h *Headscale) GetUser(name string) (*User, error)

+ func (h *Headscale) HardDeleteMachine(machine *Machine) error

+ func (h *Headscale) HealthHandler(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) IsRoutesEnabled(machine *Machine, routeStr string) bool

+ func (h *Headscale) KeyHandler(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) ListAPIKeys() ([]APIKey, error)

+ func (h *Headscale) ListMachines() ([]Machine, error)

+ func (h *Headscale) ListMachinesByGivenName(givenName string) ([]Machine, error)

+ func (h *Headscale) ListMachinesByUser(name string) ([]Machine, error)

+ func (h *Headscale) ListPeers(machine *Machine) (Machines, error)

+ func (h *Headscale) ListPreAuthKeys(userName string) ([]PreAuthKey, error)

+ func (h *Headscale) ListUsers() ([]User, error)

+ func (h *Headscale) LoadACLPolicy(path string) error

+ func (h *Headscale) NewDERPServer() (*DERPServer, error)

+ func (h *Headscale) NoiseUpgradeHandler(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) OIDCCallback(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) RefreshMachine(machine *Machine, expiry time.Time) error

+ func (h *Headscale) RegisterMachine(machine Machine) (*Machine, error)

+ func (h *Headscale) RegisterMachineFromAuthCallback(nodeKeyStr string, userName string, machineExpiry *time.Time, ...) (*Machine, error)

+ func (h *Headscale) RegisterOIDC(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) RegisterWebAPI(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) RenameMachine(machine *Machine, newName string) error

+ func (h *Headscale) RenameUser(oldName, newName string) error

+ func (h *Headscale) Serve() error

+ func (h *Headscale) ServeSTUN()

+ func (h *Headscale) SetMachineUser(machine *Machine, username string) error

+ func (h *Headscale) SetTags(machine *Machine, tags []string) error

+ func (h *Headscale) TouchMachine(machine *Machine) error

+ func (h *Headscale) UpdateACLRules() error

+ func (h *Headscale) UpdateMachineFromDatabase(machine *Machine) error

+ func (h *Headscale) UsePreAuthKey(k *PreAuthKey) error

+ func (h *Headscale) ValidateAPIKey(keyStr string) (bool, error)

+ func (h *Headscale) WindowsConfigMessage(writer http.ResponseWriter, req *http.Request)

+ func (h *Headscale) WindowsRegConfig(writer http.ResponseWriter, req *http.Request)

+ type HostInfo tailcfg.Hostinfo

+ func (hi *HostInfo) Scan(destination interface{}) error

+ func (hi HostInfo) Value() (driver.Value, error)

+ type Hosts map[string]netip.Prefix

+ func (hosts *Hosts) UnmarshalJSON(data []byte) error

+ func (hosts *Hosts) UnmarshalYAML(data []byte) error

+ type IDTokenClaims struct

+ Email string

+ Groups []string

+ Name string

+ Username string

+ type IPPrefix netip.Prefix

+ func (i *IPPrefix) Scan(destination interface{}) error

+ func (i IPPrefix) Value() (driver.Value, error)

+ type IPPrefixes []netip.Prefix

+ func (i *IPPrefixes) Scan(destination interface{}) error

+ func (i IPPrefixes) Value() (driver.Value, error)

+ type KV struct

+ Key string

+ Value string

+ type LetsEncryptConfig struct

+ CacheDir string

+ ChallengeType string

+ Hostname string

+ Listen string

+ type LogConfig struct

+ Format string

+ Level zerolog.Level

+ func GetLogConfig() LogConfig

+ type LogTailConfig struct

+ Enabled bool

+ func GetLogTailConfig() LogTailConfig

+ type Machine struct

+ AuthKey *PreAuthKey

+ AuthKeyID uint

+ CreatedAt time.Time

+ DeletedAt *time.Time

+ DiscoKey string

+ Endpoints StringList

+ Expiry *time.Time

+ ForcedTags StringList

+ GivenName string

+ HostInfo HostInfo

+ Hostname string

+ ID uint64

+ IPAddresses MachineAddresses

+ LastSeen *time.Time

+ LastSuccessfulUpdate *time.Time

+ MachineKey string

+ NodeKey string

+ RegisterMethod string

+ UpdatedAt time.Time

+ User User

+ UserID uint

+ func (machine *Machine) GetHostInfo() tailcfg.Hostinfo

+ func (machine Machine) String() string

+ type MachineAddresses []netip.Addr

+ func (ma *MachineAddresses) Scan(destination interface{}) error

+ func (ma MachineAddresses) ToStringSlice() []string

+ func (ma MachineAddresses) Value() (driver.Value, error)

+ type Machines []Machine

+ func (machines Machines) String() string

+ type MachinesP []*Machine

+ func (machines MachinesP) String() string

+ type OIDCConfig struct

+ AllowedDomains []string

+ AllowedGroups []string

+ AllowedUsers []string

+ ClientID string

+ ClientSecret string

+ Expiry time.Duration

+ ExtraParams map[string]string

+ Issuer string

+ OnlyStartIfOIDCIsAvailable bool

+ Scope []string

+ StripEmaildomain bool

+ UseExpiryFromToken bool

+ type PreAuthKey struct

+ ACLTags []PreAuthKeyACLTag

+ CreatedAt *time.Time

+ Ephemeral bool

+ Expiration *time.Time

+ ID uint64

+ Key string

+ Reusable bool

+ Used bool

+ User User

+ UserID uint

+ type PreAuthKeyACLTag struct

+ ID uint64

+ PreAuthKeyID uint64

+ Tag string

+ type Route struct

+ Advertised bool

+ Enabled bool

+ IsPrimary bool

+ Machine Machine

+ MachineID uint64

+ Prefix IPPrefix

+ func (r *Route) String() string

+ type Routes []Route

+ type SSH struct

+ Action string

+ CheckPeriod string

+ Destinations []string

+ Sources []string

+ Users []string

+ type StringList []string

+ func (i *StringList) Scan(destination interface{}) error

+ func (i StringList) Value() (driver.Value, error)

+ type TLSConfig struct

+ CertPath string

+ KeyPath string

+ LetsEncrypt LetsEncryptConfig

+ func GetTLSConfig() TLSConfig

+ type TagOwners map[string][]string

+ type User struct

+ Name string

+ type WindowsRegistryConfig struct

+ URL string

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