mirror of
https://github.com/octoleo/syncthing.git
synced 2024-11-10 15:20:56 +00:00
ffe7a2fcd7
This adds a config to enable debug functions on the API server, which is
by default disabled. When enabled, the /rest/debug things become
available and become available without requiring a CSRF token (although
authentication is required if configured).
We also add a new endpoint /rest/debug/cpuprof?duration=15s (with the
duration being configurable, defaulting to 30s). This runs a CPU profile
for the duration and returns it as a file. It sets headers so that a
browser will save the file with an informative name.
The same is done for heap profiles, /rest/debug/heapprof, which does not
take any parameters.
The purpose of this is that any user can enable debugging under
advanced, then point their browser to the endpoint above and get a file
that contains a CPU or heap profile we can use, with the filename
telling us what version and architecture the profile is from.
On the command line, this becomes
curl -O -J http://localhost:8082/rest/debug/cpuprof?duration=5s
curl: Saved to filename
'syncthing-cpu-darwin-amd64-v0.14.3+4-g935bcc0-110307.pprof'
GitHub-Pull-Request: https://github.com/syncthing/syncthing/pull/3467
94 lines
2.6 KiB
Go
94 lines
2.6 KiB
Go
// Copyright (C) 2014 The Syncthing Authors.
|
|
//
|
|
// This Source Code Form is subject to the terms of the Mozilla Public
|
|
// License, v. 2.0. If a copy of the MPL was not distributed with this file,
|
|
// You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
package config
|
|
|
|
import (
|
|
"net/url"
|
|
"os"
|
|
"strings"
|
|
)
|
|
|
|
type GUIConfiguration struct {
|
|
Enabled bool `xml:"enabled,attr" json:"enabled" default:"true"`
|
|
RawAddress string `xml:"address" json:"address" default:"127.0.0.1:8384"`
|
|
User string `xml:"user,omitempty" json:"user"`
|
|
Password string `xml:"password,omitempty" json:"password"`
|
|
RawUseTLS bool `xml:"tls,attr" json:"useTLS"`
|
|
APIKey string `xml:"apikey,omitempty" json:"apiKey"`
|
|
InsecureAdminAccess bool `xml:"insecureAdminAccess,omitempty" json:"insecureAdminAccess"`
|
|
Theme string `xml:"theme" json:"theme" default:"default"`
|
|
Debugging bool `xml:"debugging,attr" json:"debugging"`
|
|
}
|
|
|
|
func (c GUIConfiguration) Address() string {
|
|
if override := os.Getenv("STGUIADDRESS"); override != "" {
|
|
// This value may be of the form "scheme://address:port" or just
|
|
// "address:port". We need to chop off the scheme. We try to parse it as
|
|
// an URL if it contains a slash. If that fails, return it as is and let
|
|
// some other error handling handle it.
|
|
|
|
if strings.Contains(override, "/") {
|
|
url, err := url.Parse(override)
|
|
if err != nil {
|
|
return override
|
|
}
|
|
return url.Host
|
|
}
|
|
|
|
return override
|
|
}
|
|
|
|
return c.RawAddress
|
|
}
|
|
|
|
func (c GUIConfiguration) UseTLS() bool {
|
|
if override := os.Getenv("STGUIADDRESS"); override != "" && strings.HasPrefix(override, "http") {
|
|
return strings.HasPrefix(override, "https:")
|
|
}
|
|
return c.RawUseTLS
|
|
}
|
|
|
|
func (c GUIConfiguration) URL() string {
|
|
u := url.URL{
|
|
Scheme: "http",
|
|
Host: c.Address(),
|
|
Path: "/",
|
|
}
|
|
|
|
if c.UseTLS() {
|
|
u.Scheme = "https"
|
|
}
|
|
|
|
if strings.HasPrefix(u.Host, ":") {
|
|
// Empty host, i.e. ":port", use IPv4 localhost
|
|
u.Host = "127.0.0.1" + u.Host
|
|
} else if strings.HasPrefix(u.Host, "0.0.0.0:") {
|
|
// IPv4 all zeroes host, convert to IPv4 localhost
|
|
u.Host = "127.0.0.1" + u.Host[7:]
|
|
} else if strings.HasPrefix(u.Host, "[::]:") {
|
|
// IPv6 all zeroes host, convert to IPv6 localhost
|
|
u.Host = "[::1]" + u.Host[4:]
|
|
}
|
|
|
|
return u.String()
|
|
}
|
|
|
|
// IsValidAPIKey returns true when the given API key is valid, including both
|
|
// the value in config and any overrides
|
|
func (c GUIConfiguration) IsValidAPIKey(apiKey string) bool {
|
|
switch apiKey {
|
|
case "":
|
|
return false
|
|
|
|
case c.APIKey, os.Getenv("STGUIAPIKEY"):
|
|
return true
|
|
|
|
default:
|
|
return false
|
|
}
|
|
}
|