mirror of
https://github.com/AdguardTeam/AdGuardHome.git
synced 2024-11-22 04:55:33 +03:00
all: sync with master
This commit is contained in:
parent
083991fb21
commit
30244f361f
23 changed files with 495 additions and 345 deletions
37
CHANGELOG.md
37
CHANGELOG.md
|
@ -12,7 +12,7 @@ and this project adheres to
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
## [v0.108.0] - 2022-12-01 (APPROX.)
|
## [v0.108.0] - TBA (APPROX.)
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
@ -33,6 +33,41 @@ See also the [v0.107.14 GitHub milestone][ms-v0.107.14].
|
||||||
|
|
||||||
### Security
|
### Security
|
||||||
|
|
||||||
|
A Cross-Site Request Forgery (CSRF) vulnerability has been discovered. The CVE
|
||||||
|
number is to be assigned. We thank Daniel Elkabes from Mend.io for reporting
|
||||||
|
this vulnerability to us.
|
||||||
|
|
||||||
|
#### `SameSite` Policy
|
||||||
|
|
||||||
|
The `SameSite` policy on the AdGuard Home session cookies is now set to `Lax`.
|
||||||
|
Which means that the only cross-site HTTP request for which the browser is
|
||||||
|
allowed to send the session cookie is navigating to the AdGuard Home domain.
|
||||||
|
|
||||||
|
**Users are strongly advised to log out, clear browser cache, and log in again
|
||||||
|
after updating.**
|
||||||
|
|
||||||
|
#### Removal Of Plain-Text APIs (BREAKING API CHANGE)
|
||||||
|
|
||||||
|
We have implemented several measures to prevent such vulnerabilities in the
|
||||||
|
future, but some of these measures break backwards compatibility for the sake of
|
||||||
|
better protection.
|
||||||
|
|
||||||
|
The following APIs, which previously accepted or returned `text/plain` data,
|
||||||
|
now accept or return data as JSON. All new formats for the request and response
|
||||||
|
bodies are documented in `openapi/openapi.yaml` and `openapi/CHANGELOG.md`.
|
||||||
|
|
||||||
|
- `GET /control/i18n/current_language`;
|
||||||
|
- `POST /control/dhcp/find_active_dhcp`;
|
||||||
|
- `POST /control/filtering/set_rules`;
|
||||||
|
- `POST /control/i18n/change_language`.
|
||||||
|
|
||||||
|
#### Stricter Content-Type Checks (BREAKING API CHANGE)
|
||||||
|
|
||||||
|
All JSON APIs now check if the request actually has the `application/json`
|
||||||
|
content-type.
|
||||||
|
|
||||||
|
#### Other Security Changes
|
||||||
|
|
||||||
- Weaker cipher suites that use the CBC (cipher block chaining) mode of
|
- Weaker cipher suites that use the CBC (cipher block chaining) mode of
|
||||||
operation have been disabled ([#2993]).
|
operation have been disabled ([#2993]).
|
||||||
|
|
||||||
|
|
18
SECURITY.md
Normal file
18
SECURITY.md
Normal file
|
@ -0,0 +1,18 @@
|
||||||
|
# Security Policy
|
||||||
|
|
||||||
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
|
Please send your vulnerability reports to <security@adguard.com>. To make sure
|
||||||
|
that your report reaches us, please:
|
||||||
|
|
||||||
|
1. Include the words “AdGuard Home” and “vulnerability” to the subject line as
|
||||||
|
well as a short description of the vulnerability. For example:
|
||||||
|
|
||||||
|
> AdGuard Home API vulnerability: possible XSS attack
|
||||||
|
|
||||||
|
2. Make sure that the message body contains a clear description of the
|
||||||
|
vulnerability.
|
||||||
|
|
||||||
|
If you have not received a reply to your email within 7 days, please make sure
|
||||||
|
to follow up with us again at <security@adguard.com>. Once again, make sure
|
||||||
|
that the word “vulnerability” is in the subject line.
|
|
@ -31,7 +31,9 @@ export const setRulesSuccess = createAction('SET_RULES_SUCCESS');
|
||||||
export const setRules = (rules) => async (dispatch) => {
|
export const setRules = (rules) => async (dispatch) => {
|
||||||
dispatch(setRulesRequest());
|
dispatch(setRulesRequest());
|
||||||
try {
|
try {
|
||||||
const normalizedRules = normalizeRulesTextarea(rules);
|
const normalizedRules = {
|
||||||
|
rules: normalizeRulesTextarea(rules)?.split('\n'),
|
||||||
|
};
|
||||||
await apiClient.setRules(normalizedRules);
|
await apiClient.setRules(normalizedRules);
|
||||||
dispatch(addSuccessToast('updated_custom_filtering_toast'));
|
dispatch(addSuccessToast('updated_custom_filtering_toast'));
|
||||||
dispatch(setRulesSuccess());
|
dispatch(setRulesSuccess());
|
||||||
|
|
|
@ -355,7 +355,7 @@ export const changeLanguageSuccess = createAction('CHANGE_LANGUAGE_SUCCESS');
|
||||||
export const changeLanguage = (lang) => async (dispatch) => {
|
export const changeLanguage = (lang) => async (dispatch) => {
|
||||||
dispatch(changeLanguageRequest());
|
dispatch(changeLanguageRequest());
|
||||||
try {
|
try {
|
||||||
await apiClient.changeLanguage(lang);
|
await apiClient.changeLanguage({ language: lang });
|
||||||
dispatch(changeLanguageSuccess());
|
dispatch(changeLanguageSuccess());
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
dispatch(addErrorToast({ error }));
|
dispatch(addErrorToast({ error }));
|
||||||
|
@ -370,8 +370,8 @@ export const getLanguageSuccess = createAction('GET_LANGUAGE_SUCCESS');
|
||||||
export const getLanguage = () => async (dispatch) => {
|
export const getLanguage = () => async (dispatch) => {
|
||||||
dispatch(getLanguageRequest());
|
dispatch(getLanguageRequest());
|
||||||
try {
|
try {
|
||||||
const language = await apiClient.getCurrentLanguage();
|
const langSettings = await apiClient.getCurrentLanguage();
|
||||||
dispatch(getLanguageSuccess(language));
|
dispatch(getLanguageSuccess(langSettings.language));
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
dispatch(addErrorToast({ error }));
|
dispatch(addErrorToast({ error }));
|
||||||
dispatch(getLanguageFailure());
|
dispatch(getLanguageFailure());
|
||||||
|
@ -421,7 +421,10 @@ export const findActiveDhcpFailure = createAction('FIND_ACTIVE_DHCP_FAILURE');
|
||||||
export const findActiveDhcp = (name) => async (dispatch, getState) => {
|
export const findActiveDhcp = (name) => async (dispatch, getState) => {
|
||||||
dispatch(findActiveDhcpRequest());
|
dispatch(findActiveDhcpRequest());
|
||||||
try {
|
try {
|
||||||
const activeDhcp = await apiClient.findActiveDhcp(name);
|
const req = {
|
||||||
|
interface: name,
|
||||||
|
};
|
||||||
|
const activeDhcp = await apiClient.findActiveDhcp(req);
|
||||||
dispatch(findActiveDhcpSuccess(activeDhcp));
|
dispatch(findActiveDhcpSuccess(activeDhcp));
|
||||||
const { check, interface_name, interfaces } = getState().dhcp;
|
const { check, interface_name, interfaces } = getState().dhcp;
|
||||||
const selectedInterface = getState().form[FORM_NAME.DHCP_INTERFACES].values.interface_name;
|
const selectedInterface = getState().form[FORM_NAME.DHCP_INTERFACES].values.interface_name;
|
||||||
|
|
|
@ -130,7 +130,7 @@ class Api {
|
||||||
const { path, method } = this.FILTERING_SET_RULES;
|
const { path, method } = this.FILTERING_SET_RULES;
|
||||||
const parameters = {
|
const parameters = {
|
||||||
data: rules,
|
data: rules,
|
||||||
headers: { 'Content-Type': 'text/plain' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
};
|
};
|
||||||
return this.makeRequest(path, method, parameters);
|
return this.makeRequest(path, method, parameters);
|
||||||
}
|
}
|
||||||
|
@ -173,12 +173,7 @@ class Api {
|
||||||
|
|
||||||
enableParentalControl() {
|
enableParentalControl() {
|
||||||
const { path, method } = this.PARENTAL_ENABLE;
|
const { path, method } = this.PARENTAL_ENABLE;
|
||||||
const parameter = 'sensitivity=TEEN'; // this parameter TEEN is hardcoded
|
return this.makeRequest(path, method);
|
||||||
const config = {
|
|
||||||
data: parameter,
|
|
||||||
headers: { 'Content-Type': 'text/plain' },
|
|
||||||
};
|
|
||||||
return this.makeRequest(path, method, config);
|
|
||||||
}
|
}
|
||||||
|
|
||||||
disableParentalControl() {
|
disableParentalControl() {
|
||||||
|
@ -240,11 +235,11 @@ class Api {
|
||||||
return this.makeRequest(path, method);
|
return this.makeRequest(path, method);
|
||||||
}
|
}
|
||||||
|
|
||||||
changeLanguage(lang) {
|
changeLanguage(config) {
|
||||||
const { path, method } = this.CHANGE_LANGUAGE;
|
const { path, method } = this.CHANGE_LANGUAGE;
|
||||||
const parameters = {
|
const parameters = {
|
||||||
data: lang,
|
data: config,
|
||||||
headers: { 'Content-Type': 'text/plain' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
};
|
};
|
||||||
return this.makeRequest(path, method, parameters);
|
return this.makeRequest(path, method, parameters);
|
||||||
}
|
}
|
||||||
|
@ -285,11 +280,11 @@ class Api {
|
||||||
return this.makeRequest(path, method, parameters);
|
return this.makeRequest(path, method, parameters);
|
||||||
}
|
}
|
||||||
|
|
||||||
findActiveDhcp(name) {
|
findActiveDhcp(req) {
|
||||||
const { path, method } = this.DHCP_FIND_ACTIVE;
|
const { path, method } = this.DHCP_FIND_ACTIVE;
|
||||||
const parameters = {
|
const parameters = {
|
||||||
data: name,
|
data: req,
|
||||||
headers: { 'Content-Type': 'text/plain' },
|
headers: { 'Content-Type': 'application/json' },
|
||||||
};
|
};
|
||||||
return this.makeRequest(path, method, parameters);
|
return this.makeRequest(path, method, parameters);
|
||||||
}
|
}
|
||||||
|
|
|
@ -2,10 +2,12 @@
|
||||||
package aghhttp
|
package aghhttp
|
||||||
|
|
||||||
import (
|
import (
|
||||||
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
"io"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
|
||||||
|
"github.com/AdguardTeam/AdGuardHome/internal/version"
|
||||||
"github.com/AdguardTeam/golibs/log"
|
"github.com/AdguardTeam/golibs/log"
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -34,3 +36,40 @@ func Error(r *http.Request, w http.ResponseWriter, code int, format string, args
|
||||||
log.Error("%s %s: %s", r.Method, r.URL, text)
|
log.Error("%s %s: %s", r.Method, r.URL, text)
|
||||||
http.Error(w, text, code)
|
http.Error(w, text, code)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// UserAgent returns the ID of the service as a User-Agent string. It can also
|
||||||
|
// be used as the value of the Server HTTP header.
|
||||||
|
func UserAgent() (ua string) {
|
||||||
|
return fmt.Sprintf("AdGuardHome/%s", version.Version())
|
||||||
|
}
|
||||||
|
|
||||||
|
// textPlainDeprMsg is the message returned to API users when they try to use
|
||||||
|
// an API that used to accept "text/plain" but doesn't anymore.
|
||||||
|
const textPlainDeprMsg = `using this api with the text/plain content-type is deprecated; ` +
|
||||||
|
`use application/json`
|
||||||
|
|
||||||
|
// WriteTextPlainDeprecated responds to the request with a message about
|
||||||
|
// deprecation and removal of a plain-text API if the request is made with the
|
||||||
|
// "text/plain" content-type.
|
||||||
|
func WriteTextPlainDeprecated(w http.ResponseWriter, r *http.Request) (isPlainText bool) {
|
||||||
|
if r.Header.Get(HdrNameContentType) != HdrValTextPlain {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
Error(r, w, http.StatusUnsupportedMediaType, textPlainDeprMsg)
|
||||||
|
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
|
||||||
|
// WriteJSONResponse sets the content-type header in w.Header() to
|
||||||
|
// "application/json", encodes resp to w, calls Error on any returned error, and
|
||||||
|
// returns it as well.
|
||||||
|
func WriteJSONResponse(w http.ResponseWriter, r *http.Request, resp any) (err error) {
|
||||||
|
w.Header().Set(HdrNameContentType, HdrValApplicationJSON)
|
||||||
|
err = json.NewEncoder(w).Encode(resp)
|
||||||
|
if err != nil {
|
||||||
|
Error(r, w, http.StatusInternalServerError, "encoding resp: %s", err)
|
||||||
|
}
|
||||||
|
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
22
internal/aghhttp/header.go
Normal file
22
internal/aghhttp/header.go
Normal file
|
@ -0,0 +1,22 @@
|
||||||
|
package aghhttp
|
||||||
|
|
||||||
|
// HTTP Headers
|
||||||
|
|
||||||
|
// HTTP header name constants.
|
||||||
|
//
|
||||||
|
// TODO(a.garipov): Remove unused.
|
||||||
|
const (
|
||||||
|
HdrNameAcceptEncoding = "Accept-Encoding"
|
||||||
|
HdrNameAccessControlAllowOrigin = "Access-Control-Allow-Origin"
|
||||||
|
HdrNameContentType = "Content-Type"
|
||||||
|
HdrNameContentEncoding = "Content-Encoding"
|
||||||
|
HdrNameServer = "Server"
|
||||||
|
HdrNameTrailer = "Trailer"
|
||||||
|
HdrNameUserAgent = "User-Agent"
|
||||||
|
)
|
||||||
|
|
||||||
|
// HTTP header value constants.
|
||||||
|
const (
|
||||||
|
HdrValApplicationJSON = "application/json"
|
||||||
|
HdrValTextPlain = "text/plain"
|
||||||
|
)
|
|
@ -5,11 +5,9 @@ package dhcpd
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"os"
|
"os"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/AdguardTeam/AdGuardHome/internal/aghalg"
|
"github.com/AdguardTeam/AdGuardHome/internal/aghalg"
|
||||||
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
||||||
|
@ -410,31 +408,37 @@ type dhcpSearchResult struct {
|
||||||
V6 dhcpSearchV6Result `json:"v6"`
|
V6 dhcpSearchV6Result `json:"v6"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// Perform the following tasks:
|
// findActiveServerReq is the JSON structure for the request to find active DHCP
|
||||||
// . Search for another DHCP server running
|
// servers.
|
||||||
// . Check if a static IP is configured for the network interface
|
type findActiveServerReq struct {
|
||||||
// Respond with results
|
Interface string `json:"interface"`
|
||||||
|
}
|
||||||
|
|
||||||
|
// handleDHCPFindActiveServer performs the following tasks:
|
||||||
|
// 1. searches for another DHCP server in the network;
|
||||||
|
// 2. check if a static IP is configured for the network interface;
|
||||||
|
// 3. responds with the results.
|
||||||
func (s *server) handleDHCPFindActiveServer(w http.ResponseWriter, r *http.Request) {
|
func (s *server) handleDHCPFindActiveServer(w http.ResponseWriter, r *http.Request) {
|
||||||
// This use of ReadAll is safe, because request's body is now limited.
|
if aghhttp.WriteTextPlainDeprecated(w, r) {
|
||||||
body, err := io.ReadAll(r.Body)
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
req := &findActiveServerReq{}
|
||||||
|
err := json.NewDecoder(r.Body).Decode(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
msg := fmt.Sprintf("failed to read request body: %s", err)
|
aghhttp.Error(r, w, http.StatusBadRequest, "reading req: %s", err)
|
||||||
log.Error(msg)
|
|
||||||
http.Error(w, msg, http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
ifaceName := strings.TrimSpace(string(body))
|
ifaceName := req.Interface
|
||||||
if ifaceName == "" {
|
if ifaceName == "" {
|
||||||
msg := "empty interface name specified"
|
aghhttp.Error(r, w, http.StatusBadRequest, "empty interface name")
|
||||||
log.Error(msg)
|
|
||||||
http.Error(w, msg, http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
result := dhcpSearchResult{
|
result := &dhcpSearchResult{
|
||||||
V4: dhcpSearchV4Result{
|
V4: dhcpSearchV4Result{
|
||||||
OtherServer: dhcpSearchOtherResult{
|
OtherServer: dhcpSearchOtherResult{
|
||||||
Found: "no",
|
Found: "no",
|
||||||
|
@ -459,6 +463,14 @@ func (s *server) handleDHCPFindActiveServer(w http.ResponseWriter, r *http.Reque
|
||||||
result.V4.StaticIP.IP = aghnet.GetSubnet(ifaceName).String()
|
result.V4.StaticIP.IP = aghnet.GetSubnet(ifaceName).String()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
setOtherDHCPResult(ifaceName, result)
|
||||||
|
|
||||||
|
_ = aghhttp.WriteJSONResponse(w, r, result)
|
||||||
|
}
|
||||||
|
|
||||||
|
// setOtherDHCPResult sets the results of the check for another DHCP server in
|
||||||
|
// result.
|
||||||
|
func setOtherDHCPResult(ifaceName string, result *dhcpSearchResult) {
|
||||||
found4, found6, err4, err6 := aghnet.CheckOtherDHCP(ifaceName)
|
found4, found6, err4, err6 := aghnet.CheckOtherDHCP(ifaceName)
|
||||||
if err4 != nil {
|
if err4 != nil {
|
||||||
result.V4.OtherServer.Found = "error"
|
result.V4.OtherServer.Found = "error"
|
||||||
|
@ -466,24 +478,13 @@ func (s *server) handleDHCPFindActiveServer(w http.ResponseWriter, r *http.Reque
|
||||||
} else if found4 {
|
} else if found4 {
|
||||||
result.V4.OtherServer.Found = "yes"
|
result.V4.OtherServer.Found = "yes"
|
||||||
}
|
}
|
||||||
|
|
||||||
if err6 != nil {
|
if err6 != nil {
|
||||||
result.V6.OtherServer.Found = "error"
|
result.V6.OtherServer.Found = "error"
|
||||||
result.V6.OtherServer.Error = err6.Error()
|
result.V6.OtherServer.Error = err6.Error()
|
||||||
} else if found6 {
|
} else if found6 {
|
||||||
result.V6.OtherServer.Found = "yes"
|
result.V6.OtherServer.Found = "yes"
|
||||||
}
|
}
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
err = json.NewEncoder(w).Encode(result)
|
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(
|
|
||||||
r,
|
|
||||||
w,
|
|
||||||
http.StatusInternalServerError,
|
|
||||||
"Failed to marshal DHCP found json: %s",
|
|
||||||
err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *server) handleDHCPAddStaticLease(w http.ResponseWriter, r *http.Request) {
|
func (s *server) handleDHCPAddStaticLease(w http.ResponseWriter, r *http.Request) {
|
||||||
|
|
|
@ -3,13 +3,11 @@ package filtering
|
||||||
import (
|
import (
|
||||||
"encoding/json"
|
"encoding/json"
|
||||||
"fmt"
|
"fmt"
|
||||||
"io"
|
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
"net/url"
|
"net/url"
|
||||||
"os"
|
"os"
|
||||||
"path/filepath"
|
"path/filepath"
|
||||||
"strings"
|
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
||||||
|
@ -249,16 +247,25 @@ func (d *DNSFilter) handleFilteringSetURL(w http.ResponseWriter, r *http.Request
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// filteringRulesReq is the JSON structure for settings custom filtering rules.
|
||||||
|
type filteringRulesReq struct {
|
||||||
|
Rules []string `json:"rules"`
|
||||||
|
}
|
||||||
|
|
||||||
func (d *DNSFilter) handleFilteringSetRules(w http.ResponseWriter, r *http.Request) {
|
func (d *DNSFilter) handleFilteringSetRules(w http.ResponseWriter, r *http.Request) {
|
||||||
// This use of ReadAll is safe, because request's body is now limited.
|
if aghhttp.WriteTextPlainDeprecated(w, r) {
|
||||||
body, err := io.ReadAll(r.Body)
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
req := &filteringRulesReq{}
|
||||||
|
err := json.NewDecoder(r.Body).Decode(req)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
aghhttp.Error(r, w, http.StatusBadRequest, "Failed to read request body: %s", err)
|
aghhttp.Error(r, w, http.StatusBadRequest, "reading req: %s", err)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
d.UserRules = strings.Split(string(body), "\n")
|
d.UserRules = req.Rules
|
||||||
d.ConfigModified()
|
d.ConfigModified()
|
||||||
d.EnableFilters(true)
|
d.EnableFilters(true)
|
||||||
}
|
}
|
|
@ -8,12 +8,14 @@ import (
|
||||||
"fmt"
|
"fmt"
|
||||||
"net"
|
"net"
|
||||||
"net/http"
|
"net/http"
|
||||||
|
"path"
|
||||||
"strconv"
|
"strconv"
|
||||||
"strings"
|
"strings"
|
||||||
"sync"
|
"sync"
|
||||||
"time"
|
"time"
|
||||||
|
|
||||||
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
||||||
|
"github.com/AdguardTeam/golibs/errors"
|
||||||
"github.com/AdguardTeam/golibs/log"
|
"github.com/AdguardTeam/golibs/log"
|
||||||
"github.com/AdguardTeam/golibs/netutil"
|
"github.com/AdguardTeam/golibs/netutil"
|
||||||
"github.com/AdguardTeam/golibs/timeutil"
|
"github.com/AdguardTeam/golibs/timeutil"
|
||||||
|
@ -32,7 +34,8 @@ const sessionTokenSize = 16
|
||||||
|
|
||||||
type session struct {
|
type session struct {
|
||||||
userName string
|
userName string
|
||||||
expire uint32 // expiration time (in seconds)
|
// expire is the expiration time, in seconds.
|
||||||
|
expire uint32
|
||||||
}
|
}
|
||||||
|
|
||||||
func (s *session) serialize() []byte {
|
func (s *session) serialize() []byte {
|
||||||
|
@ -65,26 +68,26 @@ func (s *session) deserialize(data []byte) bool {
|
||||||
// Auth - global object
|
// Auth - global object
|
||||||
type Auth struct {
|
type Auth struct {
|
||||||
db *bbolt.DB
|
db *bbolt.DB
|
||||||
blocker *authRateLimiter
|
raleLimiter *authRateLimiter
|
||||||
sessions map[string]*session
|
sessions map[string]*session
|
||||||
users []User
|
users []webUser
|
||||||
lock sync.Mutex
|
lock sync.Mutex
|
||||||
sessionTTL uint32
|
sessionTTL uint32
|
||||||
}
|
}
|
||||||
|
|
||||||
// User object
|
// webUser represents a user of the Web UI.
|
||||||
type User struct {
|
type webUser struct {
|
||||||
Name string `yaml:"name"`
|
Name string `yaml:"name"`
|
||||||
PasswordHash string `yaml:"password"` // bcrypt hash
|
PasswordHash string `yaml:"password"`
|
||||||
}
|
}
|
||||||
|
|
||||||
// InitAuth - create a global object
|
// InitAuth - create a global object
|
||||||
func InitAuth(dbFilename string, users []User, sessionTTL uint32, blocker *authRateLimiter) *Auth {
|
func InitAuth(dbFilename string, users []webUser, sessionTTL uint32, rateLimiter *authRateLimiter) *Auth {
|
||||||
log.Info("Initializing auth module: %s", dbFilename)
|
log.Info("Initializing auth module: %s", dbFilename)
|
||||||
|
|
||||||
a := &Auth{
|
a := &Auth{
|
||||||
sessionTTL: sessionTTL,
|
sessionTTL: sessionTTL,
|
||||||
blocker: blocker,
|
raleLimiter: rateLimiter,
|
||||||
sessions: make(map[string]*session),
|
sessions: make(map[string]*session),
|
||||||
users: users,
|
users: users,
|
||||||
}
|
}
|
||||||
|
@ -326,35 +329,25 @@ func newSessionToken() (data []byte, err error) {
|
||||||
return randData, nil
|
return randData, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// cookieTimeFormat is the format to be used in (time.Time).Format for cookie's
|
// newCookie creates a new authentication cookie.
|
||||||
// expiry field.
|
func (a *Auth) newCookie(req loginJSON, addr string) (c *http.Cookie, err error) {
|
||||||
const cookieTimeFormat = "Mon, 02 Jan 2006 15:04:05 GMT"
|
rateLimiter := a.raleLimiter
|
||||||
|
u, ok := a.findUser(req.Name, req.Password)
|
||||||
// cookieExpiryFormat returns the formatted exp to be used in cookie string.
|
if !ok {
|
||||||
// It's quite simple for now, but probably will be expanded in the future.
|
if rateLimiter != nil {
|
||||||
func cookieExpiryFormat(exp time.Time) (formatted string) {
|
rateLimiter.inc(addr)
|
||||||
return exp.Format(cookieTimeFormat)
|
|
||||||
}
|
|
||||||
|
|
||||||
func (a *Auth) httpCookie(req loginJSON, addr string) (cookie string, err error) {
|
|
||||||
blocker := a.blocker
|
|
||||||
u := a.UserFind(req.Name, req.Password)
|
|
||||||
if len(u.Name) == 0 {
|
|
||||||
if blocker != nil {
|
|
||||||
blocker.inc(addr)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
return "", err
|
return nil, errors.Error("invalid username or password")
|
||||||
}
|
}
|
||||||
|
|
||||||
if blocker != nil {
|
if rateLimiter != nil {
|
||||||
blocker.remove(addr)
|
rateLimiter.remove(addr)
|
||||||
}
|
}
|
||||||
|
|
||||||
var sess []byte
|
sess, err := newSessionToken()
|
||||||
sess, err = newSessionToken()
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return "", err
|
return nil, fmt.Errorf("generating token: %w", err)
|
||||||
}
|
}
|
||||||
|
|
||||||
now := time.Now().UTC()
|
now := time.Now().UTC()
|
||||||
|
@ -364,11 +357,15 @@ func (a *Auth) httpCookie(req loginJSON, addr string) (cookie string, err error)
|
||||||
expire: uint32(now.Unix()) + a.sessionTTL,
|
expire: uint32(now.Unix()) + a.sessionTTL,
|
||||||
})
|
})
|
||||||
|
|
||||||
return fmt.Sprintf(
|
return &http.Cookie{
|
||||||
"%s=%s; Path=/; HttpOnly; Expires=%s",
|
Name: sessionCookieName,
|
||||||
sessionCookieName, hex.EncodeToString(sess),
|
Value: hex.EncodeToString(sess),
|
||||||
cookieExpiryFormat(now.Add(cookieTTL)),
|
Path: "/",
|
||||||
), nil
|
Expires: now.Add(cookieTTL),
|
||||||
|
|
||||||
|
HttpOnly: true,
|
||||||
|
SameSite: http.SameSiteLaxMode,
|
||||||
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
// realIP extracts the real IP address of the client from an HTTP request using
|
// realIP extracts the real IP address of the client from an HTTP request using
|
||||||
|
@ -436,8 +433,8 @@ func handleLogin(w http.ResponseWriter, r *http.Request) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if blocker := Context.auth.blocker; blocker != nil {
|
if rateLimiter := Context.auth.raleLimiter; rateLimiter != nil {
|
||||||
if left := blocker.check(remoteAddr); left > 0 {
|
if left := rateLimiter.check(remoteAddr); left > 0 {
|
||||||
w.Header().Set("Retry-After", strconv.Itoa(int(left.Seconds())))
|
w.Header().Set("Retry-After", strconv.Itoa(int(left.Seconds())))
|
||||||
aghhttp.Error(r, w, http.StatusTooManyRequests, "auth: blocked for %s", left)
|
aghhttp.Error(r, w, http.StatusTooManyRequests, "auth: blocked for %s", left)
|
||||||
|
|
||||||
|
@ -445,10 +442,9 @@ func handleLogin(w http.ResponseWriter, r *http.Request) {
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
var cookie string
|
cookie, err := Context.auth.newCookie(req, remoteAddr)
|
||||||
cookie, err = Context.auth.httpCookie(req, remoteAddr)
|
|
||||||
if err != nil {
|
if err != nil {
|
||||||
aghhttp.Error(r, w, http.StatusBadRequest, "crypto rand reader: %s", err)
|
aghhttp.Error(r, w, http.StatusForbidden, "%s", err)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -462,20 +458,11 @@ func handleLogin(w http.ResponseWriter, r *http.Request) {
|
||||||
log.Error("auth: unknown ip")
|
log.Error("auth: unknown ip")
|
||||||
}
|
}
|
||||||
|
|
||||||
if len(cookie) == 0 {
|
|
||||||
log.Info("auth: failed to login user %q from ip %v", req.Name, ip)
|
|
||||||
|
|
||||||
time.Sleep(1 * time.Second)
|
|
||||||
|
|
||||||
http.Error(w, "invalid username or password", http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
log.Info("auth: user %q successfully logged in from ip %v", req.Name, ip)
|
log.Info("auth: user %q successfully logged in from ip %v", req.Name, ip)
|
||||||
|
|
||||||
|
http.SetCookie(w, cookie)
|
||||||
|
|
||||||
h := w.Header()
|
h := w.Header()
|
||||||
h.Set("Set-Cookie", cookie)
|
|
||||||
h.Set("Cache-Control", "no-store, no-cache, must-revalidate, proxy-revalidate")
|
h.Set("Cache-Control", "no-store, no-cache, must-revalidate, proxy-revalidate")
|
||||||
h.Set("Pragma", "no-cache")
|
h.Set("Pragma", "no-cache")
|
||||||
h.Set("Expires", "0")
|
h.Set("Expires", "0")
|
||||||
|
@ -484,17 +471,31 @@ func handleLogin(w http.ResponseWriter, r *http.Request) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func handleLogout(w http.ResponseWriter, r *http.Request) {
|
func handleLogout(w http.ResponseWriter, r *http.Request) {
|
||||||
cookie := r.Header.Get("Cookie")
|
respHdr := w.Header()
|
||||||
sess := parseCookie(cookie)
|
c, err := r.Cookie(sessionCookieName)
|
||||||
|
if err != nil {
|
||||||
|
// The only error that is returned from r.Cookie is [http.ErrNoCookie].
|
||||||
|
// The user is already logged out.
|
||||||
|
respHdr.Set("Location", "/login.html")
|
||||||
|
w.WriteHeader(http.StatusFound)
|
||||||
|
|
||||||
Context.auth.RemoveSession(sess)
|
return
|
||||||
|
}
|
||||||
|
|
||||||
w.Header().Set("Location", "/login.html")
|
Context.auth.RemoveSession(c.Value)
|
||||||
|
|
||||||
s := fmt.Sprintf("%s=; Path=/; HttpOnly; Expires=Thu, 01 Jan 1970 00:00:00 GMT",
|
c = &http.Cookie{
|
||||||
sessionCookieName)
|
Name: sessionCookieName,
|
||||||
w.Header().Set("Set-Cookie", s)
|
Value: "",
|
||||||
|
Path: "/",
|
||||||
|
Expires: time.Unix(0, 0),
|
||||||
|
|
||||||
|
HttpOnly: true,
|
||||||
|
SameSite: http.SameSiteLaxMode,
|
||||||
|
}
|
||||||
|
|
||||||
|
respHdr.Set("Location", "/login.html")
|
||||||
|
respHdr.Set("Set-Cookie", c.String())
|
||||||
w.WriteHeader(http.StatusFound)
|
w.WriteHeader(http.StatusFound)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -504,101 +505,108 @@ func RegisterAuthHandlers() {
|
||||||
httpRegister(http.MethodGet, "/control/logout", handleLogout)
|
httpRegister(http.MethodGet, "/control/logout", handleLogout)
|
||||||
}
|
}
|
||||||
|
|
||||||
func parseCookie(cookie string) string {
|
|
||||||
pairs := strings.Split(cookie, ";")
|
|
||||||
for _, pair := range pairs {
|
|
||||||
pair = strings.TrimSpace(pair)
|
|
||||||
kv := strings.SplitN(pair, "=", 2)
|
|
||||||
if len(kv) != 2 {
|
|
||||||
continue
|
|
||||||
}
|
|
||||||
if kv[0] == sessionCookieName {
|
|
||||||
return kv[1]
|
|
||||||
}
|
|
||||||
}
|
|
||||||
return ""
|
|
||||||
}
|
|
||||||
|
|
||||||
// optionalAuthThird return true if user should authenticate first.
|
// optionalAuthThird return true if user should authenticate first.
|
||||||
func optionalAuthThird(w http.ResponseWriter, r *http.Request) (authFirst bool) {
|
func optionalAuthThird(w http.ResponseWriter, r *http.Request) (mustAuth bool) {
|
||||||
authFirst = false
|
if glProcessCookie(r) {
|
||||||
|
log.Debug("auth: authentication is handled by GL-Inet submodule")
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
// redirect to login page if not authenticated
|
// redirect to login page if not authenticated
|
||||||
ok := false
|
isAuthenticated := false
|
||||||
cookie, err := r.Cookie(sessionCookieName)
|
cookie, err := r.Cookie(sessionCookieName)
|
||||||
|
if err != nil {
|
||||||
if glProcessCookie(r) {
|
// The only error that is returned from r.Cookie is [http.ErrNoCookie].
|
||||||
log.Debug("auth: authentication was handled by GL-Inet submodule")
|
// Check Basic authentication.
|
||||||
ok = true
|
user, pass, hasBasic := r.BasicAuth()
|
||||||
} else if err == nil {
|
if hasBasic {
|
||||||
r := Context.auth.checkSession(cookie.Value)
|
_, isAuthenticated = Context.auth.findUser(user, pass)
|
||||||
if r == checkSessionOK {
|
if !isAuthenticated {
|
||||||
ok = true
|
|
||||||
} else if r < 0 {
|
|
||||||
log.Debug("auth: invalid cookie value: %s", cookie)
|
|
||||||
}
|
|
||||||
} else {
|
|
||||||
// there's no Cookie, check Basic authentication
|
|
||||||
user, pass, ok2 := r.BasicAuth()
|
|
||||||
if ok2 {
|
|
||||||
u := Context.auth.UserFind(user, pass)
|
|
||||||
if len(u.Name) != 0 {
|
|
||||||
ok = true
|
|
||||||
} else {
|
|
||||||
log.Info("auth: invalid Basic Authorization value")
|
log.Info("auth: invalid Basic Authorization value")
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
} else {
|
||||||
|
res := Context.auth.checkSession(cookie.Value)
|
||||||
|
isAuthenticated = res == checkSessionOK
|
||||||
|
if !isAuthenticated {
|
||||||
|
log.Debug("auth: invalid cookie value: %s", cookie)
|
||||||
}
|
}
|
||||||
if !ok {
|
}
|
||||||
if r.URL.Path == "/" || r.URL.Path == "/index.html" {
|
|
||||||
|
if isAuthenticated {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
if p := r.URL.Path; p == "/" || p == "/index.html" {
|
||||||
if glProcessRedirect(w, r) {
|
if glProcessRedirect(w, r) {
|
||||||
log.Debug("auth: redirected to login page by GL-Inet submodule")
|
log.Debug("auth: redirected to login page by GL-Inet submodule")
|
||||||
} else {
|
} else {
|
||||||
|
log.Debug("auth: redirected to login page")
|
||||||
w.Header().Set("Location", "/login.html")
|
w.Header().Set("Location", "/login.html")
|
||||||
w.WriteHeader(http.StatusFound)
|
w.WriteHeader(http.StatusFound)
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
log.Debug("auth: responded with forbidden to %s %s", r.Method, p)
|
||||||
w.WriteHeader(http.StatusForbidden)
|
w.WriteHeader(http.StatusForbidden)
|
||||||
_, _ = w.Write([]byte("Forbidden"))
|
_, _ = w.Write([]byte("Forbidden"))
|
||||||
}
|
}
|
||||||
authFirst = true
|
|
||||||
}
|
|
||||||
|
|
||||||
return authFirst
|
return true
|
||||||
}
|
}
|
||||||
|
|
||||||
func optionalAuth(handler func(http.ResponseWriter, *http.Request)) func(http.ResponseWriter, *http.Request) {
|
// TODO(a.garipov): Use [http.Handler] consistently everywhere throughout the
|
||||||
|
// project.
|
||||||
|
func optionalAuth(
|
||||||
|
h func(http.ResponseWriter, *http.Request),
|
||||||
|
) (wrapped func(http.ResponseWriter, *http.Request)) {
|
||||||
return func(w http.ResponseWriter, r *http.Request) {
|
return func(w http.ResponseWriter, r *http.Request) {
|
||||||
if r.URL.Path == "/login.html" {
|
p := r.URL.Path
|
||||||
// redirect to dashboard if already authenticated
|
|
||||||
authRequired := Context.auth != nil && Context.auth.AuthRequired()
|
authRequired := Context.auth != nil && Context.auth.AuthRequired()
|
||||||
|
if p == "/login.html" {
|
||||||
cookie, err := r.Cookie(sessionCookieName)
|
cookie, err := r.Cookie(sessionCookieName)
|
||||||
if authRequired && err == nil {
|
if authRequired && err == nil {
|
||||||
r := Context.auth.checkSession(cookie.Value)
|
// Redirect to the dashboard if already authenticated.
|
||||||
if r == checkSessionOK {
|
res := Context.auth.checkSession(cookie.Value)
|
||||||
|
if res == checkSessionOK {
|
||||||
w.Header().Set("Location", "/")
|
w.Header().Set("Location", "/")
|
||||||
w.WriteHeader(http.StatusFound)
|
w.WriteHeader(http.StatusFound)
|
||||||
|
|
||||||
return
|
return
|
||||||
} else if r == checkSessionNotFound {
|
|
||||||
log.Debug("auth: invalid cookie value: %s", cookie)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
} else if strings.HasPrefix(r.URL.Path, "/assets/") ||
|
log.Debug("auth: invalid cookie value: %s", cookie)
|
||||||
strings.HasPrefix(r.URL.Path, "/login.") {
|
}
|
||||||
// process as usual
|
} else if isPublicResource(p) {
|
||||||
// no additional auth requirements
|
// Process as usual, no additional auth requirements.
|
||||||
} else if Context.auth != nil && Context.auth.AuthRequired() {
|
} else if authRequired {
|
||||||
if optionalAuthThird(w, r) {
|
if optionalAuthThird(w, r) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
handler(w, r)
|
h(w, r)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// isPublicResource returns true if p is a path to a public resource.
|
||||||
|
func isPublicResource(p string) (ok bool) {
|
||||||
|
isAsset, err := path.Match("/assets/*", p)
|
||||||
|
if err != nil {
|
||||||
|
// The only error that is returned from path.Match is
|
||||||
|
// [path.ErrBadPattern]. This is a programmer error.
|
||||||
|
panic(fmt.Errorf("bad asset pattern: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
isLogin, err := path.Match("/login.*", p)
|
||||||
|
if err != nil {
|
||||||
|
// Same as above.
|
||||||
|
panic(fmt.Errorf("bad login pattern: %w", err))
|
||||||
|
}
|
||||||
|
|
||||||
|
return isAsset || isLogin
|
||||||
|
}
|
||||||
|
|
||||||
type authHandler struct {
|
type authHandler struct {
|
||||||
handler http.Handler
|
handler http.Handler
|
||||||
}
|
}
|
||||||
|
@ -612,7 +620,7 @@ func optionalAuthHandler(handler http.Handler) http.Handler {
|
||||||
}
|
}
|
||||||
|
|
||||||
// UserAdd - add new user
|
// UserAdd - add new user
|
||||||
func (a *Auth) UserAdd(u *User, password string) {
|
func (a *Auth) UserAdd(u *webUser, password string) {
|
||||||
if len(password) == 0 {
|
if len(password) == 0 {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -631,31 +639,35 @@ func (a *Auth) UserAdd(u *User, password string) {
|
||||||
log.Debug("auth: added user: %s", u.Name)
|
log.Debug("auth: added user: %s", u.Name)
|
||||||
}
|
}
|
||||||
|
|
||||||
// UserFind - find a user
|
// findUser returns a user if there is one.
|
||||||
func (a *Auth) UserFind(login, password string) User {
|
func (a *Auth) findUser(login, password string) (u webUser, ok bool) {
|
||||||
a.lock.Lock()
|
a.lock.Lock()
|
||||||
defer a.lock.Unlock()
|
defer a.lock.Unlock()
|
||||||
for _, u := range a.users {
|
|
||||||
|
for _, u = range a.users {
|
||||||
if u.Name == login &&
|
if u.Name == login &&
|
||||||
bcrypt.CompareHashAndPassword([]byte(u.PasswordHash), []byte(password)) == nil {
|
bcrypt.CompareHashAndPassword([]byte(u.PasswordHash), []byte(password)) == nil {
|
||||||
return u
|
return u, true
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
return User{}
|
|
||||||
|
return webUser{}, false
|
||||||
}
|
}
|
||||||
|
|
||||||
// getCurrentUser returns the current user. It returns an empty User if the
|
// getCurrentUser returns the current user. It returns an empty User if the
|
||||||
// user is not found.
|
// user is not found.
|
||||||
func (a *Auth) getCurrentUser(r *http.Request) User {
|
func (a *Auth) getCurrentUser(r *http.Request) (u webUser) {
|
||||||
cookie, err := r.Cookie(sessionCookieName)
|
cookie, err := r.Cookie(sessionCookieName)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
// There's no Cookie, check Basic authentication.
|
// There's no Cookie, check Basic authentication.
|
||||||
user, pass, ok := r.BasicAuth()
|
user, pass, ok := r.BasicAuth()
|
||||||
if ok {
|
if ok {
|
||||||
return Context.auth.UserFind(user, pass)
|
u, _ = Context.auth.findUser(user, pass)
|
||||||
|
|
||||||
|
return u
|
||||||
}
|
}
|
||||||
|
|
||||||
return User{}
|
return webUser{}
|
||||||
}
|
}
|
||||||
|
|
||||||
a.lock.Lock()
|
a.lock.Lock()
|
||||||
|
@ -663,20 +675,20 @@ func (a *Auth) getCurrentUser(r *http.Request) User {
|
||||||
|
|
||||||
s, ok := a.sessions[cookie.Value]
|
s, ok := a.sessions[cookie.Value]
|
||||||
if !ok {
|
if !ok {
|
||||||
return User{}
|
return webUser{}
|
||||||
}
|
}
|
||||||
|
|
||||||
for _, u := range a.users {
|
for _, u = range a.users {
|
||||||
if u.Name == s.userName {
|
if u.Name == s.userName {
|
||||||
return u
|
return u
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return User{}
|
return webUser{}
|
||||||
}
|
}
|
||||||
|
|
||||||
// GetUsers - get users
|
// GetUsers - get users
|
||||||
func (a *Auth) GetUsers() []User {
|
func (a *Auth) GetUsers() []webUser {
|
||||||
a.lock.Lock()
|
a.lock.Lock()
|
||||||
users := a.users
|
users := a.users
|
||||||
a.lock.Unlock()
|
a.lock.Unlock()
|
||||||
|
|
|
@ -43,14 +43,14 @@ func TestAuth(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
fn := filepath.Join(dir, "sessions.db")
|
fn := filepath.Join(dir, "sessions.db")
|
||||||
|
|
||||||
users := []User{{
|
users := []webUser{{
|
||||||
Name: "name",
|
Name: "name",
|
||||||
PasswordHash: "$2y$05$..vyzAECIhJPfaQiOK17IukcQnqEgKJHy0iETyYqxn3YXJl8yZuo2",
|
PasswordHash: "$2y$05$..vyzAECIhJPfaQiOK17IukcQnqEgKJHy0iETyYqxn3YXJl8yZuo2",
|
||||||
}}
|
}}
|
||||||
a := InitAuth(fn, nil, 60, nil)
|
a := InitAuth(fn, nil, 60, nil)
|
||||||
s := session{}
|
s := session{}
|
||||||
|
|
||||||
user := User{Name: "name"}
|
user := webUser{Name: "name"}
|
||||||
a.UserAdd(&user, "password")
|
a.UserAdd(&user, "password")
|
||||||
|
|
||||||
assert.Equal(t, checkSessionNotFound, a.checkSession("notfound"))
|
assert.Equal(t, checkSessionNotFound, a.checkSession("notfound"))
|
||||||
|
@ -84,7 +84,8 @@ func TestAuth(t *testing.T) {
|
||||||
a.storeSession(sess, &s)
|
a.storeSession(sess, &s)
|
||||||
a.Close()
|
a.Close()
|
||||||
|
|
||||||
u := a.UserFind("name", "password")
|
u, ok := a.findUser("name", "password")
|
||||||
|
assert.True(t, ok)
|
||||||
assert.NotEmpty(t, u.Name)
|
assert.NotEmpty(t, u.Name)
|
||||||
|
|
||||||
time.Sleep(3 * time.Second)
|
time.Sleep(3 * time.Second)
|
||||||
|
@ -118,7 +119,7 @@ func TestAuthHTTP(t *testing.T) {
|
||||||
dir := t.TempDir()
|
dir := t.TempDir()
|
||||||
fn := filepath.Join(dir, "sessions.db")
|
fn := filepath.Join(dir, "sessions.db")
|
||||||
|
|
||||||
users := []User{
|
users := []webUser{
|
||||||
{Name: "name", PasswordHash: "$2y$05$..vyzAECIhJPfaQiOK17IukcQnqEgKJHy0iETyYqxn3YXJl8yZuo2"},
|
{Name: "name", PasswordHash: "$2y$05$..vyzAECIhJPfaQiOK17IukcQnqEgKJHy0iETyYqxn3YXJl8yZuo2"},
|
||||||
}
|
}
|
||||||
Context.auth = InitAuth(fn, users, 60, nil)
|
Context.auth = InitAuth(fn, users, 60, nil)
|
||||||
|
@ -150,18 +151,19 @@ func TestAuthHTTP(t *testing.T) {
|
||||||
assert.True(t, handlerCalled)
|
assert.True(t, handlerCalled)
|
||||||
|
|
||||||
// perform login
|
// perform login
|
||||||
cookie, err := Context.auth.httpCookie(loginJSON{Name: "name", Password: "password"}, "")
|
cookie, err := Context.auth.newCookie(loginJSON{Name: "name", Password: "password"}, "")
|
||||||
require.NoError(t, err)
|
require.NoError(t, err)
|
||||||
assert.NotEmpty(t, cookie)
|
require.NotNil(t, cookie)
|
||||||
|
|
||||||
// get /
|
// get /
|
||||||
handler2 = optionalAuth(handler)
|
handler2 = optionalAuth(handler)
|
||||||
w.hdr = make(http.Header)
|
w.hdr = make(http.Header)
|
||||||
r.Header.Set("Cookie", cookie)
|
r.Header.Set("Cookie", cookie.String())
|
||||||
r.URL = &url.URL{Path: "/"}
|
r.URL = &url.URL{Path: "/"}
|
||||||
handlerCalled = false
|
handlerCalled = false
|
||||||
handler2(&w, &r)
|
handler2(&w, &r)
|
||||||
assert.True(t, handlerCalled)
|
assert.True(t, handlerCalled)
|
||||||
|
|
||||||
r.Header.Del("Cookie")
|
r.Header.Del("Cookie")
|
||||||
|
|
||||||
// get / with basic auth
|
// get / with basic auth
|
||||||
|
@ -177,7 +179,7 @@ func TestAuthHTTP(t *testing.T) {
|
||||||
// get login page with a valid cookie - we're redirected to /
|
// get login page with a valid cookie - we're redirected to /
|
||||||
handler2 = optionalAuth(handler)
|
handler2 = optionalAuth(handler)
|
||||||
w.hdr = make(http.Header)
|
w.hdr = make(http.Header)
|
||||||
r.Header.Set("Cookie", cookie)
|
r.Header.Set("Cookie", cookie.String())
|
||||||
r.URL = &url.URL{Path: loginURL}
|
r.URL = &url.URL{Path: loginURL}
|
||||||
handlerCalled = false
|
handlerCalled = false
|
||||||
handler2(&w, &r)
|
handler2(&w, &r)
|
||||||
|
|
|
@ -93,13 +93,7 @@ func (clients *clientsContainer) handleGetClients(w http.ResponseWriter, r *http
|
||||||
|
|
||||||
data.Tags = clientTags
|
data.Tags = clientTags
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
_ = aghhttp.WriteJSONResponse(w, r, data)
|
||||||
e := json.NewEncoder(w).Encode(data)
|
|
||||||
if e != nil {
|
|
||||||
aghhttp.Error(r, w, http.StatusInternalServerError, "failed to encode to json: %v", e)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Convert JSON object to Client object
|
// Convert JSON object to Client object
|
||||||
|
@ -249,11 +243,7 @@ func (clients *clientsContainer) handleFindClient(w http.ResponseWriter, r *http
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
_ = aghhttp.WriteJSONResponse(w, r, data)
|
||||||
err := json.NewEncoder(w).Encode(data)
|
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(r, w, http.StatusInternalServerError, "Couldn't write response: %s", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// findRuntime looks up the IP in runtime and temporary storages, like
|
// findRuntime looks up the IP in runtime and temporary storages, like
|
||||||
|
|
|
@ -88,7 +88,7 @@ type configuration struct {
|
||||||
BindHost net.IP `yaml:"bind_host"` // BindHost is the IP address of the HTTP server to bind to
|
BindHost net.IP `yaml:"bind_host"` // BindHost is the IP address of the HTTP server to bind to
|
||||||
BindPort int `yaml:"bind_port"` // BindPort is the port the HTTP server
|
BindPort int `yaml:"bind_port"` // BindPort is the port the HTTP server
|
||||||
BetaBindPort int `yaml:"beta_bind_port"` // BetaBindPort is the port for new client
|
BetaBindPort int `yaml:"beta_bind_port"` // BetaBindPort is the port for new client
|
||||||
Users []User `yaml:"users"` // Users that can access HTTP server
|
Users []webUser `yaml:"users"` // Users that can access HTTP server
|
||||||
// AuthAttempts is the maximum number of failed login attempts a user
|
// AuthAttempts is the maximum number of failed login attempts a user
|
||||||
// can do before being blocked.
|
// can do before being blocked.
|
||||||
AuthAttempts uint `yaml:"auth_attempts"`
|
AuthAttempts uint `yaml:"auth_attempts"`
|
||||||
|
|
|
@ -146,13 +146,7 @@ func handleStatus(w http.ResponseWriter, r *http.Request) {
|
||||||
resp.IsDHCPAvailable = Context.dhcpServer != nil
|
resp.IsDHCPAvailable = Context.dhcpServer != nil
|
||||||
}
|
}
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
||||||
err = json.NewEncoder(w).Encode(resp)
|
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(r, w, http.StatusInternalServerError, "Unable to write response json: %s", err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type profileJSON struct {
|
type profileJSON struct {
|
||||||
|
@ -162,13 +156,16 @@ type profileJSON struct {
|
||||||
func handleGetProfile(w http.ResponseWriter, r *http.Request) {
|
func handleGetProfile(w http.ResponseWriter, r *http.Request) {
|
||||||
pj := profileJSON{}
|
pj := profileJSON{}
|
||||||
u := Context.auth.getCurrentUser(r)
|
u := Context.auth.getCurrentUser(r)
|
||||||
|
|
||||||
pj.Name = u.Name
|
pj.Name = u.Name
|
||||||
|
|
||||||
data, err := json.Marshal(pj)
|
data, err := json.Marshal(pj)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
aghhttp.Error(r, w, http.StatusInternalServerError, "json.Marshal: %s", err)
|
aghhttp.Error(r, w, http.StatusInternalServerError, "json.Marshal: %s", err)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
_, _ = w.Write(data)
|
_, _ = w.Write(data)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -207,11 +204,24 @@ func ensure(method string, handler func(http.ResponseWriter, *http.Request)) fun
|
||||||
log.Debug("%s %v", r.Method, r.URL)
|
log.Debug("%s %v", r.Method, r.URL)
|
||||||
|
|
||||||
if r.Method != method {
|
if r.Method != method {
|
||||||
http.Error(w, "This request must be "+method, http.StatusMethodNotAllowed)
|
aghhttp.Error(r, w, http.StatusMethodNotAllowed, "only %s is allowed", method)
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
if method == http.MethodPost || method == http.MethodPut || method == http.MethodDelete {
|
if method == http.MethodPost || method == http.MethodPut || method == http.MethodDelete {
|
||||||
|
if r.Header.Get(aghhttp.HdrNameContentType) != aghhttp.HdrValApplicationJSON {
|
||||||
|
aghhttp.Error(
|
||||||
|
r,
|
||||||
|
w,
|
||||||
|
http.StatusUnsupportedMediaType,
|
||||||
|
"only %s is allowed",
|
||||||
|
aghhttp.HdrValApplicationJSON,
|
||||||
|
)
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
Context.controlLock.Lock()
|
Context.controlLock.Lock()
|
||||||
defer Context.controlLock.Unlock()
|
defer Context.controlLock.Unlock()
|
||||||
}
|
}
|
||||||
|
|
|
@ -59,19 +59,7 @@ func (web *Web) handleInstallGetAddresses(w http.ResponseWriter, r *http.Request
|
||||||
data.Interfaces[iface.Name] = iface
|
data.Interfaces[iface.Name] = iface
|
||||||
}
|
}
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
_ = aghhttp.WriteJSONResponse(w, r, data)
|
||||||
err = json.NewEncoder(w).Encode(data)
|
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(
|
|
||||||
r,
|
|
||||||
w,
|
|
||||||
http.StatusInternalServerError,
|
|
||||||
"Unable to marshal default addresses to json: %s",
|
|
||||||
err,
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
type checkConfReqEnt struct {
|
type checkConfReqEnt struct {
|
||||||
|
@ -201,13 +189,7 @@ func (web *Web) handleInstallCheckConfig(w http.ResponseWriter, r *http.Request)
|
||||||
resp.StaticIP = handleStaticIP(req.DNS.IP, req.SetStaticIP)
|
resp.StaticIP = handleStaticIP(req.DNS.IP, req.SetStaticIP)
|
||||||
}
|
}
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
||||||
err = json.NewEncoder(w).Encode(resp)
|
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(r, w, http.StatusInternalServerError, "encoding the response: %s", err)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// handleStaticIP - handles static IP request
|
// handleStaticIP - handles static IP request
|
||||||
|
@ -424,7 +406,7 @@ func (web *Web) handleInstallConfigure(w http.ResponseWriter, r *http.Request) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
u := &User{
|
u := &webUser{
|
||||||
Name: req.Username,
|
Name: req.Username,
|
||||||
}
|
}
|
||||||
Context.auth.UserAdd(u, req.Password)
|
Context.auth.UserAdd(u, req.Password)
|
||||||
|
@ -688,19 +670,7 @@ func (web *Web) handleInstallGetAddressesBeta(w http.ResponseWriter, r *http.Req
|
||||||
|
|
||||||
data.Interfaces = ifaces
|
data.Interfaces = ifaces
|
||||||
|
|
||||||
w.Header().Set("Content-Type", "application/json")
|
_ = aghhttp.WriteJSONResponse(w, r, data)
|
||||||
err = json.NewEncoder(w).Encode(data)
|
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(
|
|
||||||
r,
|
|
||||||
w,
|
|
||||||
http.StatusInternalServerError,
|
|
||||||
"Unable to marshal default addresses to json: %s",
|
|
||||||
err,
|
|
||||||
)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// registerBetaInstallHandlers registers the install handlers for new client
|
// registerBetaInstallHandlers registers the install handlers for new client
|
||||||
|
|
|
@ -28,8 +28,6 @@ type temporaryError interface {
|
||||||
|
|
||||||
// Get the latest available version from the Internet
|
// Get the latest available version from the Internet
|
||||||
func handleGetVersionJSON(w http.ResponseWriter, r *http.Request) {
|
func handleGetVersionJSON(w http.ResponseWriter, r *http.Request) {
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
|
|
||||||
resp := &versionResponse{}
|
resp := &versionResponse{}
|
||||||
if Context.disableUpdate {
|
if Context.disableUpdate {
|
||||||
resp.Disabled = true
|
resp.Disabled = true
|
||||||
|
@ -71,10 +69,7 @@ func handleGetVersionJSON(w http.ResponseWriter, r *http.Request) {
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
err = json.NewEncoder(w).Encode(resp)
|
_ = aghhttp.WriteJSONResponse(w, r, resp)
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(r, w, http.StatusInternalServerError, "writing body: %s", err)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// requestVersionInfo sets the VersionInfo field of resp if it can reach the
|
// requestVersionInfo sets the VersionInfo field of resp if it can reach the
|
||||||
|
|
|
@ -409,7 +409,7 @@ func run(args options, clientBuildFS fs.FS) {
|
||||||
configureLogger(args)
|
configureLogger(args)
|
||||||
|
|
||||||
// Print the first message after logger is configured.
|
// Print the first message after logger is configured.
|
||||||
log.Println(version.Full())
|
log.Info(version.Full())
|
||||||
log.Debug("current working directory is %s", Context.workDir)
|
log.Debug("current working directory is %s", Context.workDir)
|
||||||
if args.runningAsService {
|
if args.runningAsService {
|
||||||
log.Info("AdGuard Home is running as a service")
|
log.Info("AdGuard Home is running as a service")
|
||||||
|
@ -455,9 +455,9 @@ func run(args options, clientBuildFS fs.FS) {
|
||||||
|
|
||||||
sessFilename := filepath.Join(Context.getDataDir(), "sessions.db")
|
sessFilename := filepath.Join(Context.getDataDir(), "sessions.db")
|
||||||
GLMode = args.glinetMode
|
GLMode = args.glinetMode
|
||||||
var arl *authRateLimiter
|
var rateLimiter *authRateLimiter
|
||||||
if config.AuthAttempts > 0 && config.AuthBlockMin > 0 {
|
if config.AuthAttempts > 0 && config.AuthBlockMin > 0 {
|
||||||
arl = newAuthRateLimiter(
|
rateLimiter = newAuthRateLimiter(
|
||||||
time.Duration(config.AuthBlockMin)*time.Minute,
|
time.Duration(config.AuthBlockMin)*time.Minute,
|
||||||
config.AuthAttempts,
|
config.AuthAttempts,
|
||||||
)
|
)
|
||||||
|
@ -469,7 +469,7 @@ func run(args options, clientBuildFS fs.FS) {
|
||||||
sessFilename,
|
sessFilename,
|
||||||
config.Users,
|
config.Users,
|
||||||
config.WebSessionTTLHours*60*60,
|
config.WebSessionTTLHours*60*60,
|
||||||
arl,
|
rateLimiter,
|
||||||
)
|
)
|
||||||
if Context.auth == nil {
|
if Context.auth == nil {
|
||||||
log.Fatalf("Couldn't initialize Auth module")
|
log.Fatalf("Couldn't initialize Auth module")
|
||||||
|
|
|
@ -1,10 +1,8 @@
|
||||||
package home
|
package home
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"fmt"
|
"encoding/json"
|
||||||
"io"
|
|
||||||
"net/http"
|
"net/http"
|
||||||
"strings"
|
|
||||||
|
|
||||||
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
"github.com/AdguardTeam/AdGuardHome/internal/aghhttp"
|
||||||
"github.com/AdguardTeam/golibs/log"
|
"github.com/AdguardTeam/golibs/log"
|
||||||
|
@ -51,43 +49,35 @@ var allowedLanguages = stringutil.NewSet(
|
||||||
"zh-tw",
|
"zh-tw",
|
||||||
)
|
)
|
||||||
|
|
||||||
func handleI18nCurrentLanguage(w http.ResponseWriter, _ *http.Request) {
|
// languageJSON is the JSON structure for language requests and responses.
|
||||||
w.Header().Set("Content-Type", "text/plain")
|
type languageJSON struct {
|
||||||
log.Printf("config.Language is %s", config.Language)
|
Language string `json:"language"`
|
||||||
_, err := fmt.Fprintf(w, "%s\n", config.Language)
|
}
|
||||||
if err != nil {
|
|
||||||
msg := fmt.Sprintf("Unable to write response json: %s", err)
|
|
||||||
log.Println(msg)
|
|
||||||
http.Error(w, msg, http.StatusInternalServerError)
|
|
||||||
|
|
||||||
return
|
func handleI18nCurrentLanguage(w http.ResponseWriter, r *http.Request) {
|
||||||
}
|
log.Printf("home: language is %s", config.Language)
|
||||||
|
|
||||||
|
_ = aghhttp.WriteJSONResponse(w, r, &languageJSON{
|
||||||
|
Language: config.Language,
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
func handleI18nChangeLanguage(w http.ResponseWriter, r *http.Request) {
|
func handleI18nChangeLanguage(w http.ResponseWriter, r *http.Request) {
|
||||||
// This use of ReadAll is safe, because request's body is now limited.
|
if aghhttp.WriteTextPlainDeprecated(w, r) {
|
||||||
body, err := io.ReadAll(r.Body)
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
langReq := &languageJSON{}
|
||||||
|
err := json.NewDecoder(r.Body).Decode(langReq)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
msg := fmt.Sprintf("failed to read request body: %s", err)
|
aghhttp.Error(r, w, http.StatusInternalServerError, "reading req: %s", err)
|
||||||
log.Println(msg)
|
|
||||||
http.Error(w, msg, http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
|
||||||
language := strings.TrimSpace(string(body))
|
lang := langReq.Language
|
||||||
if language == "" {
|
if !allowedLanguages.Has(lang) {
|
||||||
msg := "empty language specified"
|
aghhttp.Error(r, w, http.StatusBadRequest, "unknown language: %q", lang)
|
||||||
log.Println(msg)
|
|
||||||
http.Error(w, msg, http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
|
||||||
}
|
|
||||||
|
|
||||||
if !allowedLanguages.Has(language) {
|
|
||||||
msg := fmt.Sprintf("unknown language specified: %s", language)
|
|
||||||
log.Println(msg)
|
|
||||||
http.Error(w, msg, http.StatusBadRequest)
|
|
||||||
|
|
||||||
return
|
return
|
||||||
}
|
}
|
||||||
|
@ -96,7 +86,8 @@ func handleI18nChangeLanguage(w http.ResponseWriter, r *http.Request) {
|
||||||
config.Lock()
|
config.Lock()
|
||||||
defer config.Unlock()
|
defer config.Unlock()
|
||||||
|
|
||||||
config.Language = language
|
config.Language = lang
|
||||||
|
log.Printf("home: language is set to %s", lang)
|
||||||
}()
|
}()
|
||||||
|
|
||||||
onConfigModified()
|
onConfigModified()
|
||||||
|
|
|
@ -176,7 +176,8 @@ func handleServiceControlAction(opts options, clientBuildFS fs.FS) {
|
||||||
chooseSystem()
|
chooseSystem()
|
||||||
|
|
||||||
action := opts.serviceControlAction
|
action := opts.serviceControlAction
|
||||||
log.Printf("service: control action: %s", action)
|
log.Info(version.Full())
|
||||||
|
log.Info("service: control action: %s", action)
|
||||||
|
|
||||||
if action == "reload" {
|
if action == "reload" {
|
||||||
sendSigReload()
|
sendSigReload()
|
||||||
|
|
|
@ -680,8 +680,6 @@ func unmarshalTLS(r *http.Request) (tlsConfigSettingsExt, error) {
|
||||||
}
|
}
|
||||||
|
|
||||||
func marshalTLS(w http.ResponseWriter, r *http.Request, data tlsConfig) {
|
func marshalTLS(w http.ResponseWriter, r *http.Request, data tlsConfig) {
|
||||||
w.Header().Set("Content-Type", "application/json")
|
|
||||||
|
|
||||||
if data.CertificateChain != "" {
|
if data.CertificateChain != "" {
|
||||||
encoded := base64.StdEncoding.EncodeToString([]byte(data.CertificateChain))
|
encoded := base64.StdEncoding.EncodeToString([]byte(data.CertificateChain))
|
||||||
data.CertificateChain = encoded
|
data.CertificateChain = encoded
|
||||||
|
@ -692,16 +690,7 @@ func marshalTLS(w http.ResponseWriter, r *http.Request, data tlsConfig) {
|
||||||
data.PrivateKey = ""
|
data.PrivateKey = ""
|
||||||
}
|
}
|
||||||
|
|
||||||
err := json.NewEncoder(w).Encode(data)
|
_ = aghhttp.WriteJSONResponse(w, r, data)
|
||||||
if err != nil {
|
|
||||||
aghhttp.Error(
|
|
||||||
r,
|
|
||||||
w,
|
|
||||||
http.StatusInternalServerError,
|
|
||||||
"Failed to marshal json with TLS status: %s",
|
|
||||||
err,
|
|
||||||
)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// registerWebHandlers registers HTTP handlers for TLS configuration
|
// registerWebHandlers registers HTTP handlers for TLS configuration
|
||||||
|
|
|
@ -278,11 +278,11 @@ func upgradeSchema4to5(diskConf yobj) error {
|
||||||
log.Fatalf("Can't use password \"%s\": bcrypt.GenerateFromPassword: %s", passStr, err)
|
log.Fatalf("Can't use password \"%s\": bcrypt.GenerateFromPassword: %s", passStr, err)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
u := User{
|
u := webUser{
|
||||||
Name: nameStr,
|
Name: nameStr,
|
||||||
PasswordHash: string(hash),
|
PasswordHash: string(hash),
|
||||||
}
|
}
|
||||||
users := []User{u}
|
users := []webUser{u}
|
||||||
diskConf["users"] = users
|
diskConf["users"] = users
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
|
@ -4,6 +4,64 @@
|
||||||
|
|
||||||
## v0.108.0: API changes
|
## v0.108.0: API changes
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
## v0.107.14: BREAKING API CHANGES
|
||||||
|
|
||||||
|
A Cross-Site Request Forgery (CSRF) vulnerability has been discovered. We have
|
||||||
|
implemented several measures to prevent such vulnerabilities in the future, but
|
||||||
|
some of these measures break backwards compatibility for the sake of better
|
||||||
|
protection.
|
||||||
|
|
||||||
|
All new formats for the request and response bodies are documented in
|
||||||
|
`openapi.yaml`.
|
||||||
|
|
||||||
|
### `POST /control/filtering/set_rules` And Other Plain-Text APIs
|
||||||
|
|
||||||
|
The following APIs, which previously accepted or returned `text/plain` data,
|
||||||
|
now accept or return data as JSON.
|
||||||
|
|
||||||
|
#### `POST /control/filtering/set_rules`
|
||||||
|
|
||||||
|
Previously, the API accepted a raw list of filters as a plain-text file. Now,
|
||||||
|
the filters must be presented in a JSON object with the following format:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"rules":
|
||||||
|
[
|
||||||
|
"||example.com^",
|
||||||
|
"# comment",
|
||||||
|
"@@||www.example.com^"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `GET /control/i18n/current_language` And `POST /control/i18n/change_language`
|
||||||
|
|
||||||
|
Previously, these APIs accepted and returned the language code in plain text.
|
||||||
|
Now, they accept and return them in a JSON object with the following format:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"language": "en"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
#### `POST /control/dhcp/find_active_dhcp`
|
||||||
|
|
||||||
|
Previously, the API accepted the name of the network interface as a plain-text
|
||||||
|
string. Now, it must be contained within a JSON object with the following
|
||||||
|
format:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"interface": "eth0"
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## v0.107.12: API changes
|
## v0.107.12: API changes
|
||||||
|
|
||||||
### `GET /control/blocked_services/services`
|
### `GET /control/blocked_services/services`
|
||||||
|
@ -11,6 +69,8 @@
|
||||||
* The new `GET /control/blocked_services/services` HTTP API allows inspecting
|
* The new `GET /control/blocked_services/services` HTTP API allows inspecting
|
||||||
all available services.
|
all available services.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## v0.107.7: API changes
|
## v0.107.7: API changes
|
||||||
|
|
||||||
### The new optional field `"ecs"` in `QueryLogItem`
|
### The new optional field `"ecs"` in `QueryLogItem`
|
||||||
|
@ -24,6 +84,8 @@
|
||||||
`POST /install/configure` which means that the specified password does not
|
`POST /install/configure` which means that the specified password does not
|
||||||
meet the strength requirements.
|
meet the strength requirements.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## v0.107.3: API changes
|
## v0.107.3: API changes
|
||||||
|
|
||||||
### The new field `"version"` in `AddressesInfo`
|
### The new field `"version"` in `AddressesInfo`
|
||||||
|
@ -31,6 +93,8 @@
|
||||||
* The new field `"version"` in `GET /install/get_addresses` is the version of
|
* The new field `"version"` in `GET /install/get_addresses` is the version of
|
||||||
the AdGuard Home instance.
|
the AdGuard Home instance.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## v0.107.0: API changes
|
## v0.107.0: API changes
|
||||||
|
|
||||||
### The new field `"cached"` in `QueryLogItem`
|
### The new field `"cached"` in `QueryLogItem`
|
||||||
|
|
|
@ -413,6 +413,11 @@
|
||||||
- 'dhcp'
|
- 'dhcp'
|
||||||
'operationId': 'checkActiveDhcp'
|
'operationId': 'checkActiveDhcp'
|
||||||
'summary': 'Searches for an active DHCP server on the network'
|
'summary': 'Searches for an active DHCP server on the network'
|
||||||
|
'requestBody':
|
||||||
|
'content':
|
||||||
|
'application/json':
|
||||||
|
'schema':
|
||||||
|
'$ref': '#/components/schemas/DhcpFindActiveReq'
|
||||||
'responses':
|
'responses':
|
||||||
'200':
|
'200':
|
||||||
'description': 'OK.'
|
'description': 'OK.'
|
||||||
|
@ -667,24 +672,6 @@
|
||||||
- 'parental'
|
- 'parental'
|
||||||
'operationId': 'parentalEnable'
|
'operationId': 'parentalEnable'
|
||||||
'summary': 'Enable parental filtering'
|
'summary': 'Enable parental filtering'
|
||||||
'requestBody':
|
|
||||||
'content':
|
|
||||||
'text/plain':
|
|
||||||
'schema':
|
|
||||||
'type': 'string'
|
|
||||||
'enum':
|
|
||||||
- 'EARLY_CHILDHOOD'
|
|
||||||
- 'YOUNG'
|
|
||||||
- 'TEEN'
|
|
||||||
- 'MATURE'
|
|
||||||
'example': 'sensitivity=TEEN'
|
|
||||||
'description': |
|
|
||||||
Age sensitivity for parental filtering,
|
|
||||||
EARLY_CHILDHOOD is 3
|
|
||||||
YOUNG is 10
|
|
||||||
TEEN is 13
|
|
||||||
MATURE is 17
|
|
||||||
'required': true
|
|
||||||
'responses':
|
'responses':
|
||||||
'200':
|
'200':
|
||||||
'description': 'OK.'
|
'description': 'OK.'
|
||||||
|
@ -958,10 +945,9 @@
|
||||||
Change current language. Argument must be an ISO 639-1 two-letter code.
|
Change current language. Argument must be an ISO 639-1 two-letter code.
|
||||||
'requestBody':
|
'requestBody':
|
||||||
'content':
|
'content':
|
||||||
'text/plain':
|
'application/json':
|
||||||
'schema':
|
'schema':
|
||||||
'type': 'string'
|
'$ref': '#/components/schemas/LanguageSettings'
|
||||||
'example': 'en'
|
|
||||||
'description': >
|
'description': >
|
||||||
New language. It must be known to the server and must be an ISO 639-1
|
New language. It must be known to the server and must be an ISO 639-1
|
||||||
two-letter code.
|
two-letter code.
|
||||||
|
@ -980,10 +966,9 @@
|
||||||
'200':
|
'200':
|
||||||
'description': 'OK.'
|
'description': 'OK.'
|
||||||
'content':
|
'content':
|
||||||
'text/plain':
|
'application/json':
|
||||||
'examples':
|
'schema':
|
||||||
'response':
|
'$ref': '#/components/schemas/LanguageSettings'
|
||||||
'value': 'en'
|
|
||||||
'/install/get_addresses_beta':
|
'/install/get_addresses_beta':
|
||||||
'get':
|
'get':
|
||||||
'tags':
|
'tags':
|
||||||
|
@ -1777,6 +1762,16 @@
|
||||||
'additionalProperties':
|
'additionalProperties':
|
||||||
'$ref': '#/components/schemas/NetInterface'
|
'$ref': '#/components/schemas/NetInterface'
|
||||||
|
|
||||||
|
'DhcpFindActiveReq':
|
||||||
|
'description': >
|
||||||
|
Request for checking for other DHCP servers in the network.
|
||||||
|
'properties':
|
||||||
|
'interface':
|
||||||
|
'description': 'The name of the network interface'
|
||||||
|
'example': 'eth0'
|
||||||
|
'type': 'string'
|
||||||
|
'type': 'object'
|
||||||
|
|
||||||
'DhcpSearchResult':
|
'DhcpSearchResult':
|
||||||
'type': 'object'
|
'type': 'object'
|
||||||
'description': >
|
'description': >
|
||||||
|
@ -2692,6 +2687,15 @@
|
||||||
'description': 'The error message, an opaque string.'
|
'description': 'The error message, an opaque string.'
|
||||||
'type': 'string'
|
'type': 'string'
|
||||||
'type': 'object'
|
'type': 'object'
|
||||||
|
'LanguageSettings':
|
||||||
|
'description': 'Language settings object.'
|
||||||
|
'properties':
|
||||||
|
'language':
|
||||||
|
'description': 'The current language or the language to set.'
|
||||||
|
'type': 'string'
|
||||||
|
'required':
|
||||||
|
- 'language'
|
||||||
|
'type': 'object'
|
||||||
'securitySchemes':
|
'securitySchemes':
|
||||||
'basicAuth':
|
'basicAuth':
|
||||||
'type': 'http'
|
'type': 'http'
|
||||||
|
|
Loading…
Reference in a new issue