home

Documentation

Overview

Package home contains AdGuard Home's HTTP API methods.

Index

• Constants
• Variables
• func Main(clientBuildFS fs.FS)
• func RegisterAuthHandlers()
• type Auth
  • func InitAuth(dbFilename string, users []webUser, sessionTTL uint32, ...) *Auth
  • func (a *Auth) AuthRequired() bool
  • func (a *Auth) Close()
  • func (a *Auth) GetUsers() []webUser
  • func (a *Auth) RemoveSession(sess string)
  • func (a *Auth) UserAdd(u *webUser, password string)
• type Client
• type RDNS
  • func NewRDNS(exchanger dnsforward.RDNSExchanger, clients *clientsContainer, usePrivate bool) (rDNS *RDNS)
  • func (r *RDNS) Begin(ip netip.Addr)
• type RuntimeClient
• type RuntimeClientWHOISInfo
• type Theme
  • func (t *Theme) UnmarshalText(b []byte) (err error)
• type WHOIS
  • func (w *WHOIS) Begin(ip netip.Addr)
• type Web
  • func (web *Web) Close(ctx context.Context)
  • func (web *Web) Start()
  • func (web *Web) TLSConfigChanged(ctx context.Context, tlsConf tlsConfigSettings)

Constants

const (
	ClientSourceNone clientSource = iota
	ClientSourceWHOIS
	ClientSourceARP
	ClientSourceRDNS
	ClientSourceDHCP
	ClientSourceHostsFile
	ClientSourcePersistent
)

Clients information sources. The order determines the priority.

const MaxConnReadSize = 64 * 1024

MaxConnReadSize is an upper limit in bytes for reading from net.Conn.

const MaxFileSize = 1024 * 1024

MaxFileSize is a maximum file length in bytes.

const PasswordMinRunes = 8

PasswordMinRunes is the minimum length of user's password in runes.

Variables

var Context homeContext

Context - a global context object

var GLMode bool

GLMode - enable GL-Inet compatibility mode

Functions

func Main

func Main(clientBuildFS fs.FS)

Main is the entry point

func RegisterAuthHandlers

func RegisterAuthHandlers()

RegisterAuthHandlers - register handlers

Types

type Auth

type Auth struct {
	// contains filtered or unexported fields
}

Auth - global object

func InitAuth

func InitAuth(dbFilename string, users []webUser, sessionTTL uint32, rateLimiter *authRateLimiter) *Auth

InitAuth - create a global object

func (*Auth) AuthRequired

func (a *Auth) AuthRequired() bool

AuthRequired - if authentication is required

func (*Auth) Close

func (a *Auth) Close()

Close - close module

func (*Auth) GetUsers

func (a *Auth) GetUsers() []webUser

GetUsers - get users

func (*Auth) RemoveSession

func (a *Auth) RemoveSession(sess string)

RemoveSession - remove session

func (*Auth) UserAdd

func (a *Auth) UserAdd(u *webUser, password string)

UserAdd - add new user

type Client

type Client struct {
	Name string

	IDs             []string
	Tags            []string
	BlockedServices []string
	Upstreams       []string

	UseOwnSettings        bool
	FilteringEnabled      bool
	SafeSearchEnabled     bool
	SafeBrowsingEnabled   bool
	ParentalEnabled       bool
	UseOwnBlockedServices bool
	// contains filtered or unexported fields
}

Client contains information about persistent clients.

type RDNS

type RDNS struct {
	// contains filtered or unexported fields
}

RDNS resolves clients' addresses to enrich their metadata.

func NewRDNS

func NewRDNS(
	exchanger dnsforward.RDNSExchanger,
	clients *clientsContainer,
	usePrivate bool,
) (rDNS *RDNS)

NewRDNS creates and returns initialized RDNS.

func (*RDNS) Begin

func (r *RDNS) Begin(ip netip.Addr)

Begin adds the ip to the resolving queue if it is not cached or already resolved.

type RuntimeClient

type RuntimeClient struct {
	WHOISInfo *RuntimeClientWHOISInfo
	Host      string
	Source    clientSource
}

RuntimeClient information

type RuntimeClientWHOISInfo

type RuntimeClientWHOISInfo struct {
	City    string `json:"city,omitempty"`
	Country string `json:"country,omitempty"`
	Orgname string `json:"orgname,omitempty"`
}

RuntimeClientWHOISInfo is the filtered WHOIS data for a runtime client.

type Theme

type Theme string

Theme is an enum of all allowed UI themes.

const (
	ThemeAuto  Theme = "auto"
	ThemeLight Theme = "light"
	ThemeDark  Theme = "dark"
)

Allowed Theme values.

Keep in sync with client/src/helpers/constants.js.

func (*Theme) UnmarshalText

func (t *Theme) UnmarshalText(b []byte) (err error)

UnmarshalText implements encoding.TextUnmarshaler interface for *Theme.

type WHOIS

type WHOIS struct {
	// contains filtered or unexported fields
}

WHOIS - module context

func (*WHOIS) Begin

func (w *WHOIS) Begin(ip netip.Addr)

Begin - begin requesting WHOIS info

type Web

type Web struct {
	// contains filtered or unexported fields
}

Web is the web UI and API server.

func (*Web) Close

func (web *Web) Close(ctx context.Context)

Close gracefully shuts down the HTTP servers.

func (*Web) Start

func (web *Web) Start()

Start - start serving HTTP requests

func (*Web) TLSConfigChanged

func (web *Web) TLSConfigChanged(ctx context.Context, tlsConf tlsConfigSettings)

TLSConfigChanged updates the TLS configuration and restarts the HTTPS server if necessary.