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
  • func (c *Client) ShallowClone() (sh *Client)
• type DHCP
• type RuntimeClient
• type Theme
  • func (t *Theme) UnmarshalText(b []byte) (err error)

Constants

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 {
	SafeSearch filtering.SafeSearch

	// BlockedServices is the configuration of blocked services of a client.
	BlockedServices *filtering.BlockedServices

	Name string

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

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

Client contains information about persistent clients.

func (*Client) ShallowClone

func (c *Client) ShallowClone() (sh *Client)

ShallowClone returns a deep copy of the client, except upstreamConfig, safeSearchConf, SafeSearch fields, because it's difficult to copy them.

type DHCP

type DHCP interface {
	// Leases returns all the DHCP leases.
	Leases() (leases []*dhcpsvc.Lease)

	// HostByIP returns the hostname of the DHCP client with the given IP
	// address.  The address will be netip.Addr{} if there is no such client,
	// due to an assumption that a DHCP client must always have a hostname.
	HostByIP(ip netip.Addr) (host string)

	// MACByIP returns the MAC address for the given IP address leased.  It
	// returns nil if there is no such client, due to an assumption that a DHCP
	// client must always have a MAC address.
	MACByIP(ip netip.Addr) (mac net.HardwareAddr)
}

DHCP is an interface for accessing DHCP lease data the [clientsContainer] needs.

type RuntimeClient

type RuntimeClient struct {
	// WHOIS is the filtered WHOIS data of a client.
	WHOIS *whois.Info

	// Host is the host name of a client.
	Host string

	// Source is the source from which the information about the client has
	// been obtained.
	Source client.Source
}

RuntimeClient is a client information about which has been obtained using the source described in the Source field.

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.