api.go 51 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725
  1. // Copyright (C) 2014 The Syncthing Authors.
  2. //
  3. // This Source Code Form is subject to the terms of the Mozilla Public
  4. // License, v. 2.0. If a copy of the MPL was not distributed with this file,
  5. // You can obtain one at https://mozilla.org/MPL/2.0/.
  6. package api
  7. import (
  8. "bytes"
  9. "crypto/tls"
  10. "crypto/x509"
  11. "encoding/json"
  12. "errors"
  13. "fmt"
  14. "io"
  15. "io/ioutil"
  16. "log"
  17. "net"
  18. "net/http"
  19. "net/url"
  20. "os"
  21. "path/filepath"
  22. "reflect"
  23. "regexp"
  24. "runtime"
  25. "runtime/pprof"
  26. "sort"
  27. "strconv"
  28. "strings"
  29. "time"
  30. metrics "github.com/rcrowley/go-metrics"
  31. "github.com/thejerf/suture"
  32. "github.com/vitrun/qart/qr"
  33. "golang.org/x/crypto/bcrypt"
  34. "github.com/syncthing/syncthing/lib/build"
  35. "github.com/syncthing/syncthing/lib/config"
  36. "github.com/syncthing/syncthing/lib/connections"
  37. "github.com/syncthing/syncthing/lib/db"
  38. "github.com/syncthing/syncthing/lib/discover"
  39. "github.com/syncthing/syncthing/lib/events"
  40. "github.com/syncthing/syncthing/lib/fs"
  41. "github.com/syncthing/syncthing/lib/locations"
  42. "github.com/syncthing/syncthing/lib/logger"
  43. "github.com/syncthing/syncthing/lib/model"
  44. "github.com/syncthing/syncthing/lib/protocol"
  45. "github.com/syncthing/syncthing/lib/rand"
  46. "github.com/syncthing/syncthing/lib/sync"
  47. "github.com/syncthing/syncthing/lib/tlsutil"
  48. "github.com/syncthing/syncthing/lib/upgrade"
  49. "github.com/syncthing/syncthing/lib/ur"
  50. "github.com/syncthing/syncthing/lib/util"
  51. )
  52. // matches a bcrypt hash and not too much else
  53. var bcryptExpr = regexp.MustCompile(`^\$2[aby]\$\d+\$.{50,}`)
  54. const (
  55. DefaultEventMask = events.AllEvents &^ events.LocalChangeDetected &^ events.RemoteChangeDetected
  56. DiskEventMask = events.LocalChangeDetected | events.RemoteChangeDetected
  57. EventSubBufferSize = 1000
  58. defaultEventTimeout = time.Minute
  59. httpsCertLifetimeDays = 820
  60. )
  61. type service struct {
  62. suture.Service
  63. id protocol.DeviceID
  64. cfg config.Wrapper
  65. statics *staticsServer
  66. model model.Model
  67. eventSubs map[events.EventType]events.BufferedSubscription
  68. eventSubsMut sync.Mutex
  69. evLogger events.Logger
  70. discoverer discover.CachingMux
  71. connectionsService connections.Service
  72. fss model.FolderSummaryService
  73. urService *ur.Service
  74. systemConfigMut sync.Mutex // serializes posts to /rest/system/config
  75. cpu Rater
  76. contr Controller
  77. noUpgrade bool
  78. tlsDefaultCommonName string
  79. configChanged chan struct{} // signals intentional listener close due to config change
  80. started chan string // signals startup complete by sending the listener address, for testing only
  81. startedOnce chan struct{} // the service has started successfully at least once
  82. startupErr error
  83. listenerAddr net.Addr
  84. guiErrors logger.Recorder
  85. systemLog logger.Recorder
  86. }
  87. type Rater interface {
  88. Rate() float64
  89. }
  90. type Controller interface {
  91. ExitUpgrading()
  92. Restart()
  93. Shutdown()
  94. }
  95. type Service interface {
  96. suture.Service
  97. config.Committer
  98. WaitForStart() error
  99. }
  100. func New(id protocol.DeviceID, cfg config.Wrapper, assetDir, tlsDefaultCommonName string, m model.Model, defaultSub, diskSub events.BufferedSubscription, evLogger events.Logger, discoverer discover.CachingMux, connectionsService connections.Service, urService *ur.Service, fss model.FolderSummaryService, errors, systemLog logger.Recorder, cpu Rater, contr Controller, noUpgrade bool) Service {
  101. s := &service{
  102. id: id,
  103. cfg: cfg,
  104. statics: newStaticsServer(cfg.GUI().Theme, assetDir),
  105. model: m,
  106. eventSubs: map[events.EventType]events.BufferedSubscription{
  107. DefaultEventMask: defaultSub,
  108. DiskEventMask: diskSub,
  109. },
  110. eventSubsMut: sync.NewMutex(),
  111. evLogger: evLogger,
  112. discoverer: discoverer,
  113. connectionsService: connectionsService,
  114. fss: fss,
  115. urService: urService,
  116. systemConfigMut: sync.NewMutex(),
  117. guiErrors: errors,
  118. systemLog: systemLog,
  119. cpu: cpu,
  120. contr: contr,
  121. noUpgrade: noUpgrade,
  122. tlsDefaultCommonName: tlsDefaultCommonName,
  123. configChanged: make(chan struct{}),
  124. startedOnce: make(chan struct{}),
  125. }
  126. s.Service = util.AsService(s.serve)
  127. return s
  128. }
  129. func (s *service) WaitForStart() error {
  130. <-s.startedOnce
  131. return s.startupErr
  132. }
  133. func (s *service) getListener(guiCfg config.GUIConfiguration) (net.Listener, error) {
  134. httpsCertFile := locations.Get(locations.HTTPSCertFile)
  135. httpsKeyFile := locations.Get(locations.HTTPSKeyFile)
  136. cert, err := tls.LoadX509KeyPair(httpsCertFile, httpsKeyFile)
  137. // If the certificate has expired or will expire in the next month, fail
  138. // it and generate a new one.
  139. if err == nil {
  140. err = checkExpiry(cert)
  141. }
  142. if err != nil {
  143. l.Infoln("Loading HTTPS certificate:", err)
  144. l.Infoln("Creating new HTTPS certificate")
  145. // When generating the HTTPS certificate, use the system host name per
  146. // default. If that isn't available, use the "syncthing" default.
  147. var name string
  148. name, err = os.Hostname()
  149. if err != nil {
  150. name = s.tlsDefaultCommonName
  151. }
  152. cert, err = tlsutil.NewCertificate(httpsCertFile, httpsKeyFile, name, httpsCertLifetimeDays)
  153. }
  154. if err != nil {
  155. return nil, err
  156. }
  157. tlsCfg := tlsutil.SecureDefault()
  158. tlsCfg.Certificates = []tls.Certificate{cert}
  159. if guiCfg.Network() == "unix" {
  160. // When listening on a UNIX socket we should unlink before bind,
  161. // lest we get a "bind: address already in use". We don't
  162. // particularly care if this succeeds or not.
  163. os.Remove(guiCfg.Address())
  164. }
  165. rawListener, err := net.Listen(guiCfg.Network(), guiCfg.Address())
  166. if err != nil {
  167. return nil, err
  168. }
  169. listener := &tlsutil.DowngradingListener{
  170. Listener: rawListener,
  171. TLSConfig: tlsCfg,
  172. }
  173. return listener, nil
  174. }
  175. func sendJSON(w http.ResponseWriter, jsonObject interface{}) {
  176. w.Header().Set("Content-Type", "application/json; charset=utf-8")
  177. // Marshalling might fail, in which case we should return a 500 with the
  178. // actual error.
  179. bs, err := json.MarshalIndent(jsonObject, "", " ")
  180. if err != nil {
  181. // This Marshal() can't fail though.
  182. bs, _ = json.Marshal(map[string]string{"error": err.Error()})
  183. http.Error(w, string(bs), http.StatusInternalServerError)
  184. return
  185. }
  186. fmt.Fprintf(w, "%s\n", bs)
  187. }
  188. func (s *service) serve(stop chan struct{}) {
  189. listener, err := s.getListener(s.cfg.GUI())
  190. if err != nil {
  191. select {
  192. case <-s.startedOnce:
  193. // We let this be a loud user-visible warning as it may be the only
  194. // indication they get that the GUI won't be available.
  195. l.Warnln("Starting API/GUI:", err)
  196. default:
  197. // This is during initialization. A failure here should be fatal
  198. // as there will be no way for the user to communicate with us
  199. // otherwise anyway.
  200. s.startupErr = err
  201. close(s.startedOnce)
  202. }
  203. return
  204. }
  205. if listener == nil {
  206. // Not much we can do here other than exit quickly. The supervisor
  207. // will log an error at some point.
  208. return
  209. }
  210. s.listenerAddr = listener.Addr()
  211. defer listener.Close()
  212. s.cfg.Subscribe(s)
  213. defer s.cfg.Unsubscribe(s)
  214. // The GET handlers
  215. getRestMux := http.NewServeMux()
  216. getRestMux.HandleFunc("/rest/db/completion", s.getDBCompletion) // device folder
  217. getRestMux.HandleFunc("/rest/db/file", s.getDBFile) // folder file
  218. getRestMux.HandleFunc("/rest/db/ignores", s.getDBIgnores) // folder
  219. getRestMux.HandleFunc("/rest/db/need", s.getDBNeed) // folder [perpage] [page]
  220. getRestMux.HandleFunc("/rest/db/remoteneed", s.getDBRemoteNeed) // device folder [perpage] [page]
  221. getRestMux.HandleFunc("/rest/db/localchanged", s.getDBLocalChanged) // folder
  222. getRestMux.HandleFunc("/rest/db/status", s.getDBStatus) // folder
  223. getRestMux.HandleFunc("/rest/db/browse", s.getDBBrowse) // folder [prefix] [dirsonly] [levels]
  224. getRestMux.HandleFunc("/rest/folder/versions", s.getFolderVersions) // folder
  225. getRestMux.HandleFunc("/rest/folder/errors", s.getFolderErrors) // folder
  226. getRestMux.HandleFunc("/rest/folder/pullerrors", s.getFolderErrors) // folder (deprecated)
  227. getRestMux.HandleFunc("/rest/events", s.getIndexEvents) // [since] [limit] [timeout] [events]
  228. getRestMux.HandleFunc("/rest/events/disk", s.getDiskEvents) // [since] [limit] [timeout]
  229. getRestMux.HandleFunc("/rest/stats/device", s.getDeviceStats) // -
  230. getRestMux.HandleFunc("/rest/stats/folder", s.getFolderStats) // -
  231. getRestMux.HandleFunc("/rest/svc/deviceid", s.getDeviceID) // id
  232. getRestMux.HandleFunc("/rest/svc/lang", s.getLang) // -
  233. getRestMux.HandleFunc("/rest/svc/report", s.getReport) // -
  234. getRestMux.HandleFunc("/rest/svc/random/string", s.getRandomString) // [length]
  235. getRestMux.HandleFunc("/rest/system/browse", s.getSystemBrowse) // current
  236. getRestMux.HandleFunc("/rest/system/config", s.getSystemConfig) // -
  237. getRestMux.HandleFunc("/rest/system/config/insync", s.getSystemConfigInsync) // -
  238. getRestMux.HandleFunc("/rest/system/connections", s.getSystemConnections) // -
  239. getRestMux.HandleFunc("/rest/system/discovery", s.getSystemDiscovery) // -
  240. getRestMux.HandleFunc("/rest/system/error", s.getSystemError) // -
  241. getRestMux.HandleFunc("/rest/system/ping", s.restPing) // -
  242. getRestMux.HandleFunc("/rest/system/status", s.getSystemStatus) // -
  243. getRestMux.HandleFunc("/rest/system/upgrade", s.getSystemUpgrade) // -
  244. getRestMux.HandleFunc("/rest/system/version", s.getSystemVersion) // -
  245. getRestMux.HandleFunc("/rest/system/debug", s.getSystemDebug) // -
  246. getRestMux.HandleFunc("/rest/system/log", s.getSystemLog) // [since]
  247. getRestMux.HandleFunc("/rest/system/log.txt", s.getSystemLogTxt) // [since]
  248. // The POST handlers
  249. postRestMux := http.NewServeMux()
  250. postRestMux.HandleFunc("/rest/db/prio", s.postDBPrio) // folder file [perpage] [page]
  251. postRestMux.HandleFunc("/rest/db/ignores", s.postDBIgnores) // folder
  252. postRestMux.HandleFunc("/rest/db/override", s.postDBOverride) // folder
  253. postRestMux.HandleFunc("/rest/db/revert", s.postDBRevert) // folder
  254. postRestMux.HandleFunc("/rest/db/scan", s.postDBScan) // folder [sub...] [delay]
  255. postRestMux.HandleFunc("/rest/folder/versions", s.postFolderVersionsRestore) // folder <body>
  256. postRestMux.HandleFunc("/rest/system/config", s.postSystemConfig) // <body>
  257. postRestMux.HandleFunc("/rest/system/error", s.postSystemError) // <body>
  258. postRestMux.HandleFunc("/rest/system/error/clear", s.postSystemErrorClear) // -
  259. postRestMux.HandleFunc("/rest/system/ping", s.restPing) // -
  260. postRestMux.HandleFunc("/rest/system/reset", s.postSystemReset) // [folder]
  261. postRestMux.HandleFunc("/rest/system/restart", s.postSystemRestart) // -
  262. postRestMux.HandleFunc("/rest/system/shutdown", s.postSystemShutdown) // -
  263. postRestMux.HandleFunc("/rest/system/upgrade", s.postSystemUpgrade) // -
  264. postRestMux.HandleFunc("/rest/system/pause", s.makeDevicePauseHandler(true)) // [device]
  265. postRestMux.HandleFunc("/rest/system/resume", s.makeDevicePauseHandler(false)) // [device]
  266. postRestMux.HandleFunc("/rest/system/debug", s.postSystemDebug) // [enable] [disable]
  267. // Debug endpoints, not for general use
  268. debugMux := http.NewServeMux()
  269. debugMux.HandleFunc("/rest/debug/peerCompletion", s.getPeerCompletion)
  270. debugMux.HandleFunc("/rest/debug/httpmetrics", s.getSystemHTTPMetrics)
  271. debugMux.HandleFunc("/rest/debug/cpuprof", s.getCPUProf) // duration
  272. debugMux.HandleFunc("/rest/debug/heapprof", s.getHeapProf)
  273. debugMux.HandleFunc("/rest/debug/support", s.getSupportBundle)
  274. getRestMux.Handle("/rest/debug/", s.whenDebugging(debugMux))
  275. // A handler that splits requests between the two above and disables
  276. // caching
  277. restMux := noCacheMiddleware(metricsMiddleware(getPostHandler(getRestMux, postRestMux)))
  278. // The main routing handler
  279. mux := http.NewServeMux()
  280. mux.Handle("/rest/", restMux)
  281. mux.HandleFunc("/qr/", s.getQR)
  282. // Serve compiled in assets unless an asset directory was set (for development)
  283. mux.Handle("/", s.statics)
  284. // Handle the special meta.js path
  285. mux.HandleFunc("/meta.js", s.getJSMetadata)
  286. guiCfg := s.cfg.GUI()
  287. // Wrap everything in CSRF protection. The /rest prefix should be
  288. // protected, other requests will grant cookies.
  289. var handler http.Handler = newCsrfManager(s.id.String()[:5], "/rest", guiCfg, mux, locations.Get(locations.CsrfTokens))
  290. // Add our version and ID as a header to responses
  291. handler = withDetailsMiddleware(s.id, handler)
  292. // Wrap everything in basic auth, if user/password is set.
  293. if guiCfg.IsAuthEnabled() {
  294. handler = basicAuthAndSessionMiddleware("sessionid-"+s.id.String()[:5], guiCfg, s.cfg.LDAP(), handler, s.evLogger)
  295. }
  296. // Redirect to HTTPS if we are supposed to
  297. if guiCfg.UseTLS() {
  298. handler = redirectToHTTPSMiddleware(handler)
  299. }
  300. // Add the CORS handling
  301. handler = corsMiddleware(handler, guiCfg.InsecureAllowFrameLoading)
  302. if addressIsLocalhost(guiCfg.Address()) && !guiCfg.InsecureSkipHostCheck {
  303. // Verify source host
  304. handler = localhostMiddleware(handler)
  305. }
  306. handler = debugMiddleware(handler)
  307. srv := http.Server{
  308. Handler: handler,
  309. // ReadTimeout must be longer than SyncthingController $scope.refresh
  310. // interval to avoid HTTP keepalive/GUI refresh race.
  311. ReadTimeout: 15 * time.Second,
  312. // Prevent the HTTP server from logging stuff on its own. The things we
  313. // care about we log ourselves from the handlers.
  314. ErrorLog: log.New(ioutil.Discard, "", 0),
  315. }
  316. l.Infoln("GUI and API listening on", listener.Addr())
  317. l.Infoln("Access the GUI via the following URL:", guiCfg.URL())
  318. if s.started != nil {
  319. // only set when run by the tests
  320. s.started <- listener.Addr().String()
  321. }
  322. // Indicate successful initial startup, to ourselves and to interested
  323. // listeners (i.e. the thing that starts the browser).
  324. select {
  325. case <-s.startedOnce:
  326. default:
  327. close(s.startedOnce)
  328. }
  329. // Serve in the background
  330. serveError := make(chan error, 1)
  331. go func() {
  332. serveError <- srv.Serve(listener)
  333. }()
  334. // Wait for stop, restart or error signals
  335. select {
  336. case <-stop:
  337. // Shutting down permanently
  338. l.Debugln("shutting down (stop)")
  339. case <-s.configChanged:
  340. // Soft restart due to configuration change
  341. l.Debugln("restarting (config changed)")
  342. case <-serveError:
  343. // Restart due to listen/serve failure
  344. l.Warnln("GUI/API:", err, "(restarting)")
  345. }
  346. srv.Close()
  347. }
  348. // Complete implements suture.IsCompletable, which signifies to the supervisor
  349. // whether to stop restarting the service.
  350. func (s *service) Complete() bool {
  351. select {
  352. case <-s.startedOnce:
  353. return s.startupErr != nil
  354. default:
  355. }
  356. return false
  357. }
  358. func (s *service) String() string {
  359. return fmt.Sprintf("api.service@%p", s)
  360. }
  361. func (s *service) VerifyConfiguration(from, to config.Configuration) error {
  362. if to.GUI.Network() != "tcp" {
  363. return nil
  364. }
  365. _, err := net.ResolveTCPAddr("tcp", to.GUI.Address())
  366. return err
  367. }
  368. func (s *service) CommitConfiguration(from, to config.Configuration) bool {
  369. // No action required when this changes, so mask the fact that it changed at all.
  370. from.GUI.Debugging = to.GUI.Debugging
  371. if to.GUI == from.GUI {
  372. return true
  373. }
  374. if to.GUI.Theme != from.GUI.Theme {
  375. s.statics.setTheme(to.GUI.Theme)
  376. }
  377. // Tell the serve loop to restart
  378. s.configChanged <- struct{}{}
  379. return true
  380. }
  381. func getPostHandler(get, post http.Handler) http.Handler {
  382. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  383. switch r.Method {
  384. case "GET":
  385. get.ServeHTTP(w, r)
  386. case "POST":
  387. post.ServeHTTP(w, r)
  388. default:
  389. http.Error(w, "Method not allowed", http.StatusMethodNotAllowed)
  390. }
  391. })
  392. }
  393. func debugMiddleware(h http.Handler) http.Handler {
  394. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  395. t0 := time.Now()
  396. h.ServeHTTP(w, r)
  397. if shouldDebugHTTP() {
  398. ms := 1000 * time.Since(t0).Seconds()
  399. // The variable `w` is most likely a *http.response, which we can't do
  400. // much with since it's a non exported type. We can however peek into
  401. // it with reflection to get at the status code and number of bytes
  402. // written.
  403. var status, written int64
  404. if rw := reflect.Indirect(reflect.ValueOf(w)); rw.IsValid() && rw.Kind() == reflect.Struct {
  405. if rf := rw.FieldByName("status"); rf.IsValid() && rf.Kind() == reflect.Int {
  406. status = rf.Int()
  407. }
  408. if rf := rw.FieldByName("written"); rf.IsValid() && rf.Kind() == reflect.Int64 {
  409. written = rf.Int()
  410. }
  411. }
  412. l.Debugf("http: %s %q: status %d, %d bytes in %.02f ms", r.Method, r.URL.String(), status, written, ms)
  413. }
  414. })
  415. }
  416. func corsMiddleware(next http.Handler, allowFrameLoading bool) http.Handler {
  417. // Handle CORS headers and CORS OPTIONS request.
  418. // CORS OPTIONS request are typically sent by browser during AJAX preflight
  419. // when the browser initiate a POST request.
  420. //
  421. // As the OPTIONS request is unauthorized, this handler must be the first
  422. // of the chain (hence added at the end).
  423. //
  424. // See https://www.w3.org/TR/cors/ for details.
  425. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  426. // Process OPTIONS requests
  427. if r.Method == "OPTIONS" {
  428. // Add a generous access-control-allow-origin header for CORS requests
  429. w.Header().Add("Access-Control-Allow-Origin", "*")
  430. // Only GET/POST Methods are supported
  431. w.Header().Set("Access-Control-Allow-Methods", "GET, POST")
  432. // Only these headers can be set
  433. w.Header().Set("Access-Control-Allow-Headers", "Content-Type, X-API-Key")
  434. // The request is meant to be cached 10 minutes
  435. w.Header().Set("Access-Control-Max-Age", "600")
  436. // Indicate that no content will be returned
  437. w.WriteHeader(204)
  438. return
  439. }
  440. // Other security related headers that should be present.
  441. // https://www.owasp.org/index.php/Security_Headers
  442. if !allowFrameLoading {
  443. // We don't want to be rendered in an <iframe>,
  444. // <frame> or <object>. (Unless we do it ourselves.
  445. // This is also an escape hatch for people who serve
  446. // Syncthing GUI as part of their own website
  447. // through a proxy, so they don't need to set the
  448. // allowFrameLoading bool.)
  449. w.Header().Set("X-Frame-Options", "SAMEORIGIN")
  450. }
  451. // If the browser senses an XSS attack it's allowed to take
  452. // action. (How this would not always be the default I
  453. // don't fully understand.)
  454. w.Header().Set("X-XSS-Protection", "1; mode=block")
  455. // Our content type headers are correct. Don't guess.
  456. w.Header().Set("X-Content-Type-Options", "nosniff")
  457. // For everything else, pass to the next handler
  458. next.ServeHTTP(w, r)
  459. })
  460. }
  461. func metricsMiddleware(h http.Handler) http.Handler {
  462. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  463. t := metrics.GetOrRegisterTimer(r.URL.Path, nil)
  464. t0 := time.Now()
  465. h.ServeHTTP(w, r)
  466. t.UpdateSince(t0)
  467. })
  468. }
  469. func redirectToHTTPSMiddleware(h http.Handler) http.Handler {
  470. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  471. if r.TLS == nil {
  472. // Redirect HTTP requests to HTTPS
  473. r.URL.Host = r.Host
  474. r.URL.Scheme = "https"
  475. http.Redirect(w, r, r.URL.String(), http.StatusTemporaryRedirect)
  476. } else {
  477. h.ServeHTTP(w, r)
  478. }
  479. })
  480. }
  481. func noCacheMiddleware(h http.Handler) http.Handler {
  482. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  483. w.Header().Set("Cache-Control", "max-age=0, no-cache, no-store")
  484. w.Header().Set("Expires", time.Now().UTC().Format(http.TimeFormat))
  485. w.Header().Set("Pragma", "no-cache")
  486. h.ServeHTTP(w, r)
  487. })
  488. }
  489. func withDetailsMiddleware(id protocol.DeviceID, h http.Handler) http.Handler {
  490. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  491. w.Header().Set("X-Syncthing-Version", build.Version)
  492. w.Header().Set("X-Syncthing-ID", id.String())
  493. h.ServeHTTP(w, r)
  494. })
  495. }
  496. func localhostMiddleware(h http.Handler) http.Handler {
  497. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  498. if addressIsLocalhost(r.Host) {
  499. h.ServeHTTP(w, r)
  500. return
  501. }
  502. http.Error(w, "Host check error", http.StatusForbidden)
  503. })
  504. }
  505. func (s *service) whenDebugging(h http.Handler) http.Handler {
  506. return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
  507. if s.cfg.GUI().Debugging {
  508. h.ServeHTTP(w, r)
  509. return
  510. }
  511. http.Error(w, "Debugging disabled", http.StatusForbidden)
  512. })
  513. }
  514. func (s *service) restPing(w http.ResponseWriter, r *http.Request) {
  515. sendJSON(w, map[string]string{"ping": "pong"})
  516. }
  517. func (s *service) getJSMetadata(w http.ResponseWriter, r *http.Request) {
  518. meta, _ := json.Marshal(map[string]string{
  519. "deviceID": s.id.String(),
  520. })
  521. w.Header().Set("Content-Type", "application/javascript")
  522. fmt.Fprintf(w, "var metadata = %s;\n", meta)
  523. }
  524. func (s *service) getSystemVersion(w http.ResponseWriter, r *http.Request) {
  525. sendJSON(w, map[string]interface{}{
  526. "version": build.Version,
  527. "codename": build.Codename,
  528. "longVersion": build.LongVersion,
  529. "os": runtime.GOOS,
  530. "arch": runtime.GOARCH,
  531. "isBeta": build.IsBeta,
  532. "isCandidate": build.IsCandidate,
  533. "isRelease": build.IsRelease,
  534. })
  535. }
  536. func (s *service) getSystemDebug(w http.ResponseWriter, r *http.Request) {
  537. names := l.Facilities()
  538. enabled := l.FacilityDebugging()
  539. sort.Strings(enabled)
  540. sendJSON(w, map[string]interface{}{
  541. "facilities": names,
  542. "enabled": enabled,
  543. })
  544. }
  545. func (s *service) postSystemDebug(w http.ResponseWriter, r *http.Request) {
  546. w.Header().Set("Content-Type", "application/json; charset=utf-8")
  547. q := r.URL.Query()
  548. for _, f := range strings.Split(q.Get("enable"), ",") {
  549. if f == "" || l.ShouldDebug(f) {
  550. continue
  551. }
  552. l.SetDebug(f, true)
  553. l.Infof("Enabled debug data for %q", f)
  554. }
  555. for _, f := range strings.Split(q.Get("disable"), ",") {
  556. if f == "" || !l.ShouldDebug(f) {
  557. continue
  558. }
  559. l.SetDebug(f, false)
  560. l.Infof("Disabled debug data for %q", f)
  561. }
  562. }
  563. func (s *service) getDBBrowse(w http.ResponseWriter, r *http.Request) {
  564. qs := r.URL.Query()
  565. folder := qs.Get("folder")
  566. prefix := qs.Get("prefix")
  567. dirsonly := qs.Get("dirsonly") != ""
  568. levels, err := strconv.Atoi(qs.Get("levels"))
  569. if err != nil {
  570. levels = -1
  571. }
  572. sendJSON(w, s.model.GlobalDirectoryTree(folder, prefix, levels, dirsonly))
  573. }
  574. func (s *service) getDBCompletion(w http.ResponseWriter, r *http.Request) {
  575. var qs = r.URL.Query()
  576. var folder = qs.Get("folder")
  577. var deviceStr = qs.Get("device")
  578. device, err := protocol.DeviceIDFromString(deviceStr)
  579. if err != nil {
  580. http.Error(w, err.Error(), 500)
  581. return
  582. }
  583. sendJSON(w, s.model.Completion(device, folder).Map())
  584. }
  585. func (s *service) getDBStatus(w http.ResponseWriter, r *http.Request) {
  586. qs := r.URL.Query()
  587. folder := qs.Get("folder")
  588. if sum, err := s.fss.Summary(folder); err != nil {
  589. http.Error(w, err.Error(), http.StatusNotFound)
  590. } else {
  591. sendJSON(w, sum)
  592. }
  593. }
  594. func (s *service) postDBOverride(w http.ResponseWriter, r *http.Request) {
  595. var qs = r.URL.Query()
  596. var folder = qs.Get("folder")
  597. go s.model.Override(folder)
  598. }
  599. func (s *service) postDBRevert(w http.ResponseWriter, r *http.Request) {
  600. var qs = r.URL.Query()
  601. var folder = qs.Get("folder")
  602. go s.model.Revert(folder)
  603. }
  604. func getPagingParams(qs url.Values) (int, int) {
  605. page, err := strconv.Atoi(qs.Get("page"))
  606. if err != nil || page < 1 {
  607. page = 1
  608. }
  609. perpage, err := strconv.Atoi(qs.Get("perpage"))
  610. if err != nil || perpage < 1 {
  611. perpage = 1 << 16
  612. }
  613. return page, perpage
  614. }
  615. func (s *service) getDBNeed(w http.ResponseWriter, r *http.Request) {
  616. qs := r.URL.Query()
  617. folder := qs.Get("folder")
  618. page, perpage := getPagingParams(qs)
  619. progress, queued, rest := s.model.NeedFolderFiles(folder, page, perpage)
  620. // Convert the struct to a more loose structure, and inject the size.
  621. sendJSON(w, map[string]interface{}{
  622. "progress": toJsonFileInfoSlice(progress),
  623. "queued": toJsonFileInfoSlice(queued),
  624. "rest": toJsonFileInfoSlice(rest),
  625. "page": page,
  626. "perpage": perpage,
  627. })
  628. }
  629. func (s *service) getDBRemoteNeed(w http.ResponseWriter, r *http.Request) {
  630. qs := r.URL.Query()
  631. folder := qs.Get("folder")
  632. device := qs.Get("device")
  633. deviceID, err := protocol.DeviceIDFromString(device)
  634. if err != nil {
  635. http.Error(w, err.Error(), 500)
  636. return
  637. }
  638. page, perpage := getPagingParams(qs)
  639. if files, err := s.model.RemoteNeedFolderFiles(deviceID, folder, page, perpage); err != nil {
  640. http.Error(w, err.Error(), http.StatusNotFound)
  641. } else {
  642. sendJSON(w, map[string]interface{}{
  643. "files": toJsonFileInfoSlice(files),
  644. "page": page,
  645. "perpage": perpage,
  646. })
  647. }
  648. }
  649. func (s *service) getDBLocalChanged(w http.ResponseWriter, r *http.Request) {
  650. qs := r.URL.Query()
  651. folder := qs.Get("folder")
  652. page, perpage := getPagingParams(qs)
  653. files := s.model.LocalChangedFiles(folder, page, perpage)
  654. sendJSON(w, map[string]interface{}{
  655. "files": toJsonFileInfoSlice(files),
  656. "page": page,
  657. "perpage": perpage,
  658. })
  659. }
  660. func (s *service) getSystemConnections(w http.ResponseWriter, r *http.Request) {
  661. sendJSON(w, s.model.ConnectionStats())
  662. }
  663. func (s *service) getDeviceStats(w http.ResponseWriter, r *http.Request) {
  664. sendJSON(w, s.model.DeviceStatistics())
  665. }
  666. func (s *service) getFolderStats(w http.ResponseWriter, r *http.Request) {
  667. sendJSON(w, s.model.FolderStatistics())
  668. }
  669. func (s *service) getDBFile(w http.ResponseWriter, r *http.Request) {
  670. qs := r.URL.Query()
  671. folder := qs.Get("folder")
  672. file := qs.Get("file")
  673. gf, gfOk := s.model.CurrentGlobalFile(folder, file)
  674. lf, lfOk := s.model.CurrentFolderFile(folder, file)
  675. if !(gfOk || lfOk) {
  676. // This file for sure does not exist.
  677. http.Error(w, "No such object in the index", http.StatusNotFound)
  678. return
  679. }
  680. av := s.model.Availability(folder, gf, protocol.BlockInfo{})
  681. sendJSON(w, map[string]interface{}{
  682. "global": jsonFileInfo(gf),
  683. "local": jsonFileInfo(lf),
  684. "availability": av,
  685. })
  686. }
  687. func (s *service) getSystemConfig(w http.ResponseWriter, r *http.Request) {
  688. sendJSON(w, s.cfg.RawCopy())
  689. }
  690. func (s *service) postSystemConfig(w http.ResponseWriter, r *http.Request) {
  691. s.systemConfigMut.Lock()
  692. defer s.systemConfigMut.Unlock()
  693. to, err := config.ReadJSON(r.Body, s.id)
  694. r.Body.Close()
  695. if err != nil {
  696. l.Warnln("Decoding posted config:", err)
  697. http.Error(w, err.Error(), http.StatusBadRequest)
  698. return
  699. }
  700. if to.GUI.Password != s.cfg.GUI().Password {
  701. if to.GUI.Password != "" && !bcryptExpr.MatchString(to.GUI.Password) {
  702. hash, err := bcrypt.GenerateFromPassword([]byte(to.GUI.Password), 0)
  703. if err != nil {
  704. l.Warnln("bcrypting password:", err)
  705. http.Error(w, err.Error(), http.StatusInternalServerError)
  706. return
  707. }
  708. to.GUI.Password = string(hash)
  709. }
  710. }
  711. // Activate and save. Wait for the configuration to become active before
  712. // completing the request.
  713. if wg, err := s.cfg.Replace(to); err != nil {
  714. l.Warnln("Replacing config:", err)
  715. http.Error(w, err.Error(), http.StatusInternalServerError)
  716. return
  717. } else {
  718. wg.Wait()
  719. }
  720. if err := s.cfg.Save(); err != nil {
  721. l.Warnln("Saving config:", err)
  722. http.Error(w, err.Error(), http.StatusInternalServerError)
  723. return
  724. }
  725. }
  726. func (s *service) getSystemConfigInsync(w http.ResponseWriter, r *http.Request) {
  727. sendJSON(w, map[string]bool{"configInSync": !s.cfg.RequiresRestart()})
  728. }
  729. func (s *service) postSystemRestart(w http.ResponseWriter, r *http.Request) {
  730. s.flushResponse(`{"ok": "restarting"}`, w)
  731. go s.contr.Restart()
  732. }
  733. func (s *service) postSystemReset(w http.ResponseWriter, r *http.Request) {
  734. var qs = r.URL.Query()
  735. folder := qs.Get("folder")
  736. if len(folder) > 0 {
  737. if _, ok := s.cfg.Folders()[folder]; !ok {
  738. http.Error(w, "Invalid folder ID", 500)
  739. return
  740. }
  741. }
  742. if len(folder) == 0 {
  743. // Reset all folders.
  744. for folder := range s.cfg.Folders() {
  745. s.model.ResetFolder(folder)
  746. }
  747. s.flushResponse(`{"ok": "resetting database"}`, w)
  748. } else {
  749. // Reset a specific folder, assuming it's supposed to exist.
  750. s.model.ResetFolder(folder)
  751. s.flushResponse(`{"ok": "resetting folder `+folder+`"}`, w)
  752. }
  753. go s.contr.Restart()
  754. }
  755. func (s *service) postSystemShutdown(w http.ResponseWriter, r *http.Request) {
  756. s.flushResponse(`{"ok": "shutting down"}`, w)
  757. go s.contr.Shutdown()
  758. }
  759. func (s *service) flushResponse(resp string, w http.ResponseWriter) {
  760. w.Write([]byte(resp + "\n"))
  761. f := w.(http.Flusher)
  762. f.Flush()
  763. }
  764. func (s *service) getSystemStatus(w http.ResponseWriter, r *http.Request) {
  765. var m runtime.MemStats
  766. runtime.ReadMemStats(&m)
  767. tilde, _ := fs.ExpandTilde("~")
  768. res := make(map[string]interface{})
  769. res["myID"] = s.id.String()
  770. res["goroutines"] = runtime.NumGoroutine()
  771. res["alloc"] = m.Alloc
  772. res["sys"] = m.Sys - m.HeapReleased
  773. res["tilde"] = tilde
  774. if s.cfg.Options().LocalAnnEnabled || s.cfg.Options().GlobalAnnEnabled {
  775. res["discoveryEnabled"] = true
  776. discoErrors := make(map[string]string)
  777. discoMethods := 0
  778. for disco, err := range s.discoverer.ChildErrors() {
  779. discoMethods++
  780. if err != nil {
  781. discoErrors[disco] = err.Error()
  782. }
  783. }
  784. res["discoveryMethods"] = discoMethods
  785. res["discoveryErrors"] = discoErrors
  786. }
  787. res["connectionServiceStatus"] = s.connectionsService.ListenerStatus()
  788. res["lastDialStatus"] = s.connectionsService.ConnectionStatus()
  789. // cpuUsage.Rate() is in milliseconds per second, so dividing by ten
  790. // gives us percent
  791. res["cpuPercent"] = s.cpu.Rate() / 10 / float64(runtime.NumCPU())
  792. res["pathSeparator"] = string(filepath.Separator)
  793. res["urVersionMax"] = ur.Version
  794. res["uptime"] = s.urService.UptimeS()
  795. res["startTime"] = ur.StartTime
  796. res["guiAddressOverridden"] = s.cfg.GUI().IsOverridden()
  797. res["guiAddressUsed"] = s.listenerAddr.String()
  798. sendJSON(w, res)
  799. }
  800. func (s *service) getSystemError(w http.ResponseWriter, r *http.Request) {
  801. sendJSON(w, map[string][]logger.Line{
  802. "errors": s.guiErrors.Since(time.Time{}),
  803. })
  804. }
  805. func (s *service) postSystemError(w http.ResponseWriter, r *http.Request) {
  806. bs, _ := ioutil.ReadAll(r.Body)
  807. r.Body.Close()
  808. l.Warnln(string(bs))
  809. }
  810. func (s *service) postSystemErrorClear(w http.ResponseWriter, r *http.Request) {
  811. s.guiErrors.Clear()
  812. }
  813. func (s *service) getSystemLog(w http.ResponseWriter, r *http.Request) {
  814. q := r.URL.Query()
  815. since, err := time.Parse(time.RFC3339, q.Get("since"))
  816. if err != nil {
  817. l.Debugln(err)
  818. }
  819. sendJSON(w, map[string][]logger.Line{
  820. "messages": s.systemLog.Since(since),
  821. })
  822. }
  823. func (s *service) getSystemLogTxt(w http.ResponseWriter, r *http.Request) {
  824. q := r.URL.Query()
  825. since, err := time.Parse(time.RFC3339, q.Get("since"))
  826. if err != nil {
  827. l.Debugln(err)
  828. }
  829. w.Header().Set("Content-Type", "text/plain; charset=utf-8")
  830. for _, line := range s.systemLog.Since(since) {
  831. fmt.Fprintf(w, "%s: %s\n", line.When.Format(time.RFC3339), line.Message)
  832. }
  833. }
  834. type fileEntry struct {
  835. name string
  836. data []byte
  837. }
  838. func (s *service) getSupportBundle(w http.ResponseWriter, r *http.Request) {
  839. var files []fileEntry
  840. // Redacted configuration as a JSON
  841. if jsonConfig, err := json.MarshalIndent(getRedactedConfig(s), "", " "); err != nil {
  842. l.Warnln("Support bundle: failed to create config.json:", err)
  843. } else {
  844. files = append(files, fileEntry{name: "config.json.txt", data: jsonConfig})
  845. }
  846. // Log as a text
  847. var buflog bytes.Buffer
  848. for _, line := range s.systemLog.Since(time.Time{}) {
  849. fmt.Fprintf(&buflog, "%s: %s\n", line.When.Format(time.RFC3339), line.Message)
  850. }
  851. files = append(files, fileEntry{name: "log-inmemory.txt", data: buflog.Bytes()})
  852. // Errors as a JSON
  853. if errs := s.guiErrors.Since(time.Time{}); len(errs) > 0 {
  854. if jsonError, err := json.MarshalIndent(errs, "", " "); err != nil {
  855. l.Warnln("Support bundle: failed to create errors.json:", err)
  856. } else {
  857. files = append(files, fileEntry{name: "errors.json.txt", data: jsonError})
  858. }
  859. }
  860. // Panic files
  861. if panicFiles, err := filepath.Glob(filepath.Join(locations.GetBaseDir(locations.ConfigBaseDir), "panic*")); err == nil {
  862. for _, f := range panicFiles {
  863. if panicFile, err := ioutil.ReadFile(f); err != nil {
  864. l.Warnf("Support bundle: failed to load %s: %s", filepath.Base(f), err)
  865. } else {
  866. files = append(files, fileEntry{name: filepath.Base(f), data: panicFile})
  867. }
  868. }
  869. }
  870. // Archived log (default on Windows)
  871. if logFile, err := ioutil.ReadFile(locations.Get(locations.LogFile)); err == nil {
  872. files = append(files, fileEntry{name: "log-ondisk.txt", data: logFile})
  873. }
  874. // Version and platform information as a JSON
  875. if versionPlatform, err := json.MarshalIndent(map[string]string{
  876. "now": time.Now().Format(time.RFC3339),
  877. "version": build.Version,
  878. "codename": build.Codename,
  879. "longVersion": build.LongVersion,
  880. "os": runtime.GOOS,
  881. "arch": runtime.GOARCH,
  882. }, "", " "); err == nil {
  883. files = append(files, fileEntry{name: "version-platform.json.txt", data: versionPlatform})
  884. } else {
  885. l.Warnln("Failed to create versionPlatform.json: ", err)
  886. }
  887. // Report Data as a JSON
  888. if usageReportingData, err := json.MarshalIndent(s.urService.ReportData(), "", " "); err != nil {
  889. l.Warnln("Support bundle: failed to create versionPlatform.json:", err)
  890. } else {
  891. files = append(files, fileEntry{name: "usage-reporting.json.txt", data: usageReportingData})
  892. }
  893. // Heap and CPU Proofs as a pprof extension
  894. var heapBuffer, cpuBuffer bytes.Buffer
  895. filename := fmt.Sprintf("syncthing-heap-%s-%s-%s-%s.pprof", runtime.GOOS, runtime.GOARCH, build.Version, time.Now().Format("150405")) // hhmmss
  896. runtime.GC()
  897. if err := pprof.WriteHeapProfile(&heapBuffer); err == nil {
  898. files = append(files, fileEntry{name: filename, data: heapBuffer.Bytes()})
  899. }
  900. const duration = 4 * time.Second
  901. filename = fmt.Sprintf("syncthing-cpu-%s-%s-%s-%s.pprof", runtime.GOOS, runtime.GOARCH, build.Version, time.Now().Format("150405")) // hhmmss
  902. if err := pprof.StartCPUProfile(&cpuBuffer); err == nil {
  903. time.Sleep(duration)
  904. pprof.StopCPUProfile()
  905. files = append(files, fileEntry{name: filename, data: cpuBuffer.Bytes()})
  906. }
  907. // Add buffer files to buffer zip
  908. var zipFilesBuffer bytes.Buffer
  909. if err := writeZip(&zipFilesBuffer, files); err != nil {
  910. l.Warnln("Support bundle: failed to create support bundle zip:", err)
  911. http.Error(w, err.Error(), http.StatusInternalServerError)
  912. return
  913. }
  914. // Set zip file name and path
  915. zipFileName := fmt.Sprintf("support-bundle-%s-%s.zip", s.id.Short().String(), time.Now().Format("2006-01-02T150405"))
  916. zipFilePath := filepath.Join(locations.GetBaseDir(locations.ConfigBaseDir), zipFileName)
  917. // Write buffer zip to local zip file (back up)
  918. if err := ioutil.WriteFile(zipFilePath, zipFilesBuffer.Bytes(), 0600); err != nil {
  919. l.Warnln("Support bundle: support bundle zip could not be created:", err)
  920. }
  921. // Serve the buffer zip to client for download
  922. w.Header().Set("Content-Type", "application/zip")
  923. w.Header().Set("Content-Disposition", "attachment; filename="+zipFileName)
  924. io.Copy(w, &zipFilesBuffer)
  925. }
  926. func (s *service) getSystemHTTPMetrics(w http.ResponseWriter, r *http.Request) {
  927. stats := make(map[string]interface{})
  928. metrics.Each(func(name string, intf interface{}) {
  929. if m, ok := intf.(*metrics.StandardTimer); ok {
  930. pct := m.Percentiles([]float64{0.50, 0.95, 0.99})
  931. for i := range pct {
  932. pct[i] /= 1e6 // ns to ms
  933. }
  934. stats[name] = map[string]interface{}{
  935. "count": m.Count(),
  936. "sumMs": m.Sum() / 1e6, // ns to ms
  937. "ratesPerS": []float64{m.Rate1(), m.Rate5(), m.Rate15()},
  938. "percentilesMs": pct,
  939. }
  940. }
  941. })
  942. bs, _ := json.MarshalIndent(stats, "", " ")
  943. w.Write(bs)
  944. }
  945. func (s *service) getSystemDiscovery(w http.ResponseWriter, r *http.Request) {
  946. devices := make(map[string]discover.CacheEntry)
  947. if s.discoverer != nil {
  948. // Device ids can't be marshalled as keys so we need to manually
  949. // rebuild this map using strings. Discoverer may be nil if discovery
  950. // has not started yet.
  951. for device, entry := range s.discoverer.Cache() {
  952. devices[device.String()] = entry
  953. }
  954. }
  955. sendJSON(w, devices)
  956. }
  957. func (s *service) getReport(w http.ResponseWriter, r *http.Request) {
  958. version := ur.Version
  959. if val, _ := strconv.Atoi(r.URL.Query().Get("version")); val > 0 {
  960. version = val
  961. }
  962. sendJSON(w, s.urService.ReportDataPreview(version))
  963. }
  964. func (s *service) getRandomString(w http.ResponseWriter, r *http.Request) {
  965. length := 32
  966. if val, _ := strconv.Atoi(r.URL.Query().Get("length")); val > 0 {
  967. length = val
  968. }
  969. str := rand.String(length)
  970. sendJSON(w, map[string]string{"random": str})
  971. }
  972. func (s *service) getDBIgnores(w http.ResponseWriter, r *http.Request) {
  973. qs := r.URL.Query()
  974. folder := qs.Get("folder")
  975. ignores, patterns, err := s.model.GetIgnores(folder)
  976. if err != nil {
  977. http.Error(w, err.Error(), 500)
  978. return
  979. }
  980. sendJSON(w, map[string][]string{
  981. "ignore": ignores,
  982. "expanded": patterns,
  983. })
  984. }
  985. func (s *service) postDBIgnores(w http.ResponseWriter, r *http.Request) {
  986. qs := r.URL.Query()
  987. bs, err := ioutil.ReadAll(r.Body)
  988. r.Body.Close()
  989. if err != nil {
  990. http.Error(w, err.Error(), 500)
  991. return
  992. }
  993. var data map[string][]string
  994. err = json.Unmarshal(bs, &data)
  995. if err != nil {
  996. http.Error(w, err.Error(), 500)
  997. return
  998. }
  999. err = s.model.SetIgnores(qs.Get("folder"), data["ignore"])
  1000. if err != nil {
  1001. http.Error(w, err.Error(), 500)
  1002. return
  1003. }
  1004. s.getDBIgnores(w, r)
  1005. }
  1006. func (s *service) getIndexEvents(w http.ResponseWriter, r *http.Request) {
  1007. s.fss.OnEventRequest()
  1008. mask := s.getEventMask(r.URL.Query().Get("events"))
  1009. sub := s.getEventSub(mask)
  1010. s.getEvents(w, r, sub)
  1011. }
  1012. func (s *service) getDiskEvents(w http.ResponseWriter, r *http.Request) {
  1013. sub := s.getEventSub(DiskEventMask)
  1014. s.getEvents(w, r, sub)
  1015. }
  1016. func (s *service) getEvents(w http.ResponseWriter, r *http.Request, eventSub events.BufferedSubscription) {
  1017. qs := r.URL.Query()
  1018. sinceStr := qs.Get("since")
  1019. limitStr := qs.Get("limit")
  1020. timeoutStr := qs.Get("timeout")
  1021. since, _ := strconv.Atoi(sinceStr)
  1022. limit, _ := strconv.Atoi(limitStr)
  1023. timeout := defaultEventTimeout
  1024. if timeoutSec, timeoutErr := strconv.Atoi(timeoutStr); timeoutErr == nil && timeoutSec >= 0 { // 0 is a valid timeout
  1025. timeout = time.Duration(timeoutSec) * time.Second
  1026. }
  1027. // Flush before blocking, to indicate that we've received the request and
  1028. // that it should not be retried. Must set Content-Type header before
  1029. // flushing.
  1030. w.Header().Set("Content-Type", "application/json; charset=utf-8")
  1031. f := w.(http.Flusher)
  1032. f.Flush()
  1033. // If there are no events available return an empty slice, as this gets serialized as `[]`
  1034. evs := eventSub.Since(since, []events.Event{}, timeout)
  1035. if 0 < limit && limit < len(evs) {
  1036. evs = evs[len(evs)-limit:]
  1037. }
  1038. sendJSON(w, evs)
  1039. }
  1040. func (s *service) getEventMask(evs string) events.EventType {
  1041. eventMask := DefaultEventMask
  1042. if evs != "" {
  1043. eventList := strings.Split(evs, ",")
  1044. eventMask = 0
  1045. for _, ev := range eventList {
  1046. eventMask |= events.UnmarshalEventType(strings.TrimSpace(ev))
  1047. }
  1048. }
  1049. return eventMask
  1050. }
  1051. func (s *service) getEventSub(mask events.EventType) events.BufferedSubscription {
  1052. s.eventSubsMut.Lock()
  1053. bufsub, ok := s.eventSubs[mask]
  1054. if !ok {
  1055. evsub := s.evLogger.Subscribe(mask)
  1056. bufsub = events.NewBufferedSubscription(evsub, EventSubBufferSize)
  1057. s.eventSubs[mask] = bufsub
  1058. }
  1059. s.eventSubsMut.Unlock()
  1060. return bufsub
  1061. }
  1062. func (s *service) getSystemUpgrade(w http.ResponseWriter, r *http.Request) {
  1063. if s.noUpgrade {
  1064. http.Error(w, upgrade.ErrUpgradeUnsupported.Error(), 500)
  1065. return
  1066. }
  1067. opts := s.cfg.Options()
  1068. rel, err := upgrade.LatestRelease(opts.ReleasesURL, build.Version, opts.UpgradeToPreReleases)
  1069. if err != nil {
  1070. http.Error(w, err.Error(), 500)
  1071. return
  1072. }
  1073. res := make(map[string]interface{})
  1074. res["running"] = build.Version
  1075. res["latest"] = rel.Tag
  1076. res["newer"] = upgrade.CompareVersions(rel.Tag, build.Version) == upgrade.Newer
  1077. res["majorNewer"] = upgrade.CompareVersions(rel.Tag, build.Version) == upgrade.MajorNewer
  1078. sendJSON(w, res)
  1079. }
  1080. func (s *service) getDeviceID(w http.ResponseWriter, r *http.Request) {
  1081. qs := r.URL.Query()
  1082. idStr := qs.Get("id")
  1083. id, err := protocol.DeviceIDFromString(idStr)
  1084. if err == nil {
  1085. sendJSON(w, map[string]string{
  1086. "id": id.String(),
  1087. })
  1088. } else {
  1089. sendJSON(w, map[string]string{
  1090. "error": err.Error(),
  1091. })
  1092. }
  1093. }
  1094. func (s *service) getLang(w http.ResponseWriter, r *http.Request) {
  1095. lang := r.Header.Get("Accept-Language")
  1096. var langs []string
  1097. for _, l := range strings.Split(lang, ",") {
  1098. parts := strings.SplitN(l, ";", 2)
  1099. langs = append(langs, strings.ToLower(strings.TrimSpace(parts[0])))
  1100. }
  1101. sendJSON(w, langs)
  1102. }
  1103. func (s *service) postSystemUpgrade(w http.ResponseWriter, r *http.Request) {
  1104. opts := s.cfg.Options()
  1105. rel, err := upgrade.LatestRelease(opts.ReleasesURL, build.Version, opts.UpgradeToPreReleases)
  1106. if err != nil {
  1107. l.Warnln("getting latest release:", err)
  1108. http.Error(w, err.Error(), 500)
  1109. return
  1110. }
  1111. if upgrade.CompareVersions(rel.Tag, build.Version) > upgrade.Equal {
  1112. err = upgrade.To(rel)
  1113. if err != nil {
  1114. l.Warnln("upgrading:", err)
  1115. http.Error(w, err.Error(), 500)
  1116. return
  1117. }
  1118. s.flushResponse(`{"ok": "restarting"}`, w)
  1119. s.contr.ExitUpgrading()
  1120. }
  1121. }
  1122. func (s *service) makeDevicePauseHandler(paused bool) http.HandlerFunc {
  1123. return func(w http.ResponseWriter, r *http.Request) {
  1124. var qs = r.URL.Query()
  1125. var deviceStr = qs.Get("device")
  1126. var cfgs []config.DeviceConfiguration
  1127. if deviceStr == "" {
  1128. for _, cfg := range s.cfg.Devices() {
  1129. cfg.Paused = paused
  1130. cfgs = append(cfgs, cfg)
  1131. }
  1132. } else {
  1133. device, err := protocol.DeviceIDFromString(deviceStr)
  1134. if err != nil {
  1135. http.Error(w, err.Error(), 500)
  1136. return
  1137. }
  1138. cfg, ok := s.cfg.Devices()[device]
  1139. if !ok {
  1140. http.Error(w, "not found", http.StatusNotFound)
  1141. return
  1142. }
  1143. cfg.Paused = paused
  1144. cfgs = append(cfgs, cfg)
  1145. }
  1146. if _, err := s.cfg.SetDevices(cfgs); err != nil {
  1147. http.Error(w, err.Error(), 500)
  1148. }
  1149. }
  1150. }
  1151. func (s *service) postDBScan(w http.ResponseWriter, r *http.Request) {
  1152. qs := r.URL.Query()
  1153. folder := qs.Get("folder")
  1154. if folder != "" {
  1155. subs := qs["sub"]
  1156. err := s.model.ScanFolderSubdirs(folder, subs)
  1157. if err != nil {
  1158. http.Error(w, err.Error(), 500)
  1159. return
  1160. }
  1161. nextStr := qs.Get("next")
  1162. next, err := strconv.Atoi(nextStr)
  1163. if err == nil {
  1164. s.model.DelayScan(folder, time.Duration(next)*time.Second)
  1165. }
  1166. } else {
  1167. errors := s.model.ScanFolders()
  1168. if len(errors) > 0 {
  1169. http.Error(w, "Error scanning folders", 500)
  1170. sendJSON(w, errors)
  1171. return
  1172. }
  1173. }
  1174. }
  1175. func (s *service) postDBPrio(w http.ResponseWriter, r *http.Request) {
  1176. qs := r.URL.Query()
  1177. folder := qs.Get("folder")
  1178. file := qs.Get("file")
  1179. s.model.BringToFront(folder, file)
  1180. s.getDBNeed(w, r)
  1181. }
  1182. func (s *service) getQR(w http.ResponseWriter, r *http.Request) {
  1183. var qs = r.URL.Query()
  1184. var text = qs.Get("text")
  1185. code, err := qr.Encode(text, qr.M)
  1186. if err != nil {
  1187. http.Error(w, "Invalid", 500)
  1188. return
  1189. }
  1190. w.Header().Set("Content-Type", "image/png")
  1191. w.Write(code.PNG())
  1192. }
  1193. func (s *service) getPeerCompletion(w http.ResponseWriter, r *http.Request) {
  1194. tot := map[string]float64{}
  1195. count := map[string]float64{}
  1196. for _, folder := range s.cfg.Folders() {
  1197. for _, device := range folder.DeviceIDs() {
  1198. deviceStr := device.String()
  1199. if _, ok := s.model.Connection(device); ok {
  1200. tot[deviceStr] += s.model.Completion(device, folder.ID).CompletionPct
  1201. } else {
  1202. tot[deviceStr] = 0
  1203. }
  1204. count[deviceStr]++
  1205. }
  1206. }
  1207. comp := map[string]int{}
  1208. for device := range tot {
  1209. comp[device] = int(tot[device] / count[device])
  1210. }
  1211. sendJSON(w, comp)
  1212. }
  1213. func (s *service) getFolderVersions(w http.ResponseWriter, r *http.Request) {
  1214. qs := r.URL.Query()
  1215. versions, err := s.model.GetFolderVersions(qs.Get("folder"))
  1216. if err != nil {
  1217. http.Error(w, err.Error(), 500)
  1218. return
  1219. }
  1220. sendJSON(w, versions)
  1221. }
  1222. func (s *service) postFolderVersionsRestore(w http.ResponseWriter, r *http.Request) {
  1223. qs := r.URL.Query()
  1224. bs, err := ioutil.ReadAll(r.Body)
  1225. r.Body.Close()
  1226. if err != nil {
  1227. http.Error(w, err.Error(), 500)
  1228. return
  1229. }
  1230. var versions map[string]time.Time
  1231. err = json.Unmarshal(bs, &versions)
  1232. if err != nil {
  1233. http.Error(w, err.Error(), 500)
  1234. return
  1235. }
  1236. ferr, err := s.model.RestoreFolderVersions(qs.Get("folder"), versions)
  1237. if err != nil {
  1238. http.Error(w, err.Error(), 500)
  1239. return
  1240. }
  1241. sendJSON(w, ferr)
  1242. }
  1243. func (s *service) getFolderErrors(w http.ResponseWriter, r *http.Request) {
  1244. qs := r.URL.Query()
  1245. folder := qs.Get("folder")
  1246. page, perpage := getPagingParams(qs)
  1247. errors, err := s.model.FolderErrors(folder)
  1248. if err != nil {
  1249. http.Error(w, err.Error(), http.StatusNotFound)
  1250. return
  1251. }
  1252. start := (page - 1) * perpage
  1253. if start >= len(errors) {
  1254. errors = nil
  1255. } else {
  1256. errors = errors[start:]
  1257. if perpage < len(errors) {
  1258. errors = errors[:perpage]
  1259. }
  1260. }
  1261. sendJSON(w, map[string]interface{}{
  1262. "folder": folder,
  1263. "errors": errors,
  1264. "page": page,
  1265. "perpage": perpage,
  1266. })
  1267. }
  1268. func (s *service) getSystemBrowse(w http.ResponseWriter, r *http.Request) {
  1269. qs := r.URL.Query()
  1270. current := qs.Get("current")
  1271. // Default value or in case of error unmarshalling ends up being basic fs.
  1272. var fsType fs.FilesystemType
  1273. fsType.UnmarshalText([]byte(qs.Get("filesystem")))
  1274. sendJSON(w, browseFiles(current, fsType))
  1275. }
  1276. const (
  1277. matchExact int = iota
  1278. matchCaseIns
  1279. noMatch
  1280. )
  1281. func checkPrefixMatch(s, prefix string) int {
  1282. if strings.HasPrefix(s, prefix) {
  1283. return matchExact
  1284. }
  1285. if strings.HasPrefix(strings.ToLower(s), strings.ToLower(prefix)) {
  1286. return matchCaseIns
  1287. }
  1288. return noMatch
  1289. }
  1290. func browseFiles(current string, fsType fs.FilesystemType) []string {
  1291. if current == "" {
  1292. filesystem := fs.NewFilesystem(fsType, "")
  1293. if roots, err := filesystem.Roots(); err == nil {
  1294. return roots
  1295. }
  1296. return nil
  1297. }
  1298. search, _ := fs.ExpandTilde(current)
  1299. pathSeparator := string(fs.PathSeparator)
  1300. if strings.HasSuffix(current, pathSeparator) && !strings.HasSuffix(search, pathSeparator) {
  1301. search = search + pathSeparator
  1302. }
  1303. searchDir := filepath.Dir(search)
  1304. // The searchFile should be the last component of search, or empty if it
  1305. // ends with a path separator
  1306. var searchFile string
  1307. if !strings.HasSuffix(search, pathSeparator) {
  1308. searchFile = filepath.Base(search)
  1309. }
  1310. fs := fs.NewFilesystem(fsType, searchDir)
  1311. subdirectories, _ := fs.DirNames(".")
  1312. exactMatches := make([]string, 0, len(subdirectories))
  1313. caseInsMatches := make([]string, 0, len(subdirectories))
  1314. for _, subdirectory := range subdirectories {
  1315. info, err := fs.Stat(subdirectory)
  1316. if err != nil || !info.IsDir() {
  1317. continue
  1318. }
  1319. switch checkPrefixMatch(subdirectory, searchFile) {
  1320. case matchExact:
  1321. exactMatches = append(exactMatches, filepath.Join(searchDir, subdirectory)+pathSeparator)
  1322. case matchCaseIns:
  1323. caseInsMatches = append(caseInsMatches, filepath.Join(searchDir, subdirectory)+pathSeparator)
  1324. }
  1325. }
  1326. // sort to return matches in deterministic order (don't depend on file system order)
  1327. sort.Strings(exactMatches)
  1328. sort.Strings(caseInsMatches)
  1329. return append(exactMatches, caseInsMatches...)
  1330. }
  1331. func (s *service) getCPUProf(w http.ResponseWriter, r *http.Request) {
  1332. duration, err := time.ParseDuration(r.FormValue("duration"))
  1333. if err != nil {
  1334. duration = 30 * time.Second
  1335. }
  1336. filename := fmt.Sprintf("syncthing-cpu-%s-%s-%s-%s.pprof", runtime.GOOS, runtime.GOARCH, build.Version, time.Now().Format("150405")) // hhmmss
  1337. w.Header().Set("Content-Type", "application/octet-stream")
  1338. w.Header().Set("Content-Disposition", "attachment; filename="+filename)
  1339. if err := pprof.StartCPUProfile(w); err == nil {
  1340. time.Sleep(duration)
  1341. pprof.StopCPUProfile()
  1342. }
  1343. }
  1344. func (s *service) getHeapProf(w http.ResponseWriter, r *http.Request) {
  1345. filename := fmt.Sprintf("syncthing-heap-%s-%s-%s-%s.pprof", runtime.GOOS, runtime.GOARCH, build.Version, time.Now().Format("150405")) // hhmmss
  1346. w.Header().Set("Content-Type", "application/octet-stream")
  1347. w.Header().Set("Content-Disposition", "attachment; filename="+filename)
  1348. runtime.GC()
  1349. pprof.WriteHeapProfile(w)
  1350. }
  1351. func toJsonFileInfoSlice(fs []db.FileInfoTruncated) []jsonFileInfoTrunc {
  1352. res := make([]jsonFileInfoTrunc, len(fs))
  1353. for i, f := range fs {
  1354. res[i] = jsonFileInfoTrunc(f)
  1355. }
  1356. return res
  1357. }
  1358. // Type wrappers for nice JSON serialization
  1359. type jsonFileInfo protocol.FileInfo
  1360. func (f jsonFileInfo) MarshalJSON() ([]byte, error) {
  1361. m := fileIntfJSONMap(protocol.FileInfo(f))
  1362. m["numBlocks"] = len(f.Blocks)
  1363. return json.Marshal(m)
  1364. }
  1365. type jsonFileInfoTrunc db.FileInfoTruncated
  1366. func (f jsonFileInfoTrunc) MarshalJSON() ([]byte, error) {
  1367. m := fileIntfJSONMap(db.FileInfoTruncated(f))
  1368. m["numBlocks"] = nil // explicitly unknown
  1369. return json.Marshal(m)
  1370. }
  1371. func fileIntfJSONMap(f db.FileIntf) map[string]interface{} {
  1372. out := map[string]interface{}{
  1373. "name": f.FileName(),
  1374. "type": f.FileType().String(),
  1375. "size": f.FileSize(),
  1376. "deleted": f.IsDeleted(),
  1377. "invalid": f.IsInvalid(),
  1378. "ignored": f.IsIgnored(),
  1379. "mustRescan": f.MustRescan(),
  1380. "noPermissions": !f.HasPermissionBits(),
  1381. "modified": f.ModTime(),
  1382. "modifiedBy": f.FileModifiedBy().String(),
  1383. "sequence": f.SequenceNo(),
  1384. "version": jsonVersionVector(f.FileVersion()),
  1385. "localFlags": f.FileLocalFlags(),
  1386. }
  1387. if f.HasPermissionBits() {
  1388. out["permissions"] = fmt.Sprintf("%#o", f.FilePermissions())
  1389. }
  1390. return out
  1391. }
  1392. type jsonVersionVector protocol.Vector
  1393. func (v jsonVersionVector) MarshalJSON() ([]byte, error) {
  1394. res := make([]string, len(v.Counters))
  1395. for i, c := range v.Counters {
  1396. res[i] = fmt.Sprintf("%v:%d", c.ID, c.Value)
  1397. }
  1398. return json.Marshal(res)
  1399. }
  1400. func dirNames(dir string) []string {
  1401. fd, err := os.Open(dir)
  1402. if err != nil {
  1403. return nil
  1404. }
  1405. defer fd.Close()
  1406. fis, err := fd.Readdir(-1)
  1407. if err != nil {
  1408. return nil
  1409. }
  1410. var dirs []string
  1411. for _, fi := range fis {
  1412. if fi.IsDir() {
  1413. dirs = append(dirs, filepath.Base(fi.Name()))
  1414. }
  1415. }
  1416. sort.Strings(dirs)
  1417. return dirs
  1418. }
  1419. func addressIsLocalhost(addr string) bool {
  1420. host, _, err := net.SplitHostPort(addr)
  1421. if err != nil {
  1422. // There was no port, so we assume the address was just a hostname
  1423. host = addr
  1424. }
  1425. switch strings.ToLower(host) {
  1426. case "localhost", "localhost.":
  1427. return true
  1428. default:
  1429. ip := net.ParseIP(host)
  1430. if ip == nil {
  1431. // not an IP address
  1432. return false
  1433. }
  1434. return ip.IsLoopback()
  1435. }
  1436. }
  1437. func checkExpiry(cert tls.Certificate) error {
  1438. leaf := cert.Leaf
  1439. if leaf == nil {
  1440. // Leaf can be nil or not, depending on how parsed the certificate
  1441. // was when we got it.
  1442. if len(cert.Certificate) < 1 {
  1443. // can't happen
  1444. return errors.New("no certificate in certificate")
  1445. }
  1446. var err error
  1447. leaf, err = x509.ParseCertificate(cert.Certificate[0])
  1448. if err != nil {
  1449. return err
  1450. }
  1451. }
  1452. if leaf.Subject.String() != leaf.Issuer.String() ||
  1453. len(leaf.DNSNames) != 0 || len(leaf.IPAddresses) != 0 {
  1454. // The certificate is not self signed, or has DNS/IP attributes we don't
  1455. // add, so we leave it alone.
  1456. return nil
  1457. }
  1458. if leaf.NotAfter.Before(time.Now()) {
  1459. return errors.New("certificate has expired")
  1460. }
  1461. if leaf.NotAfter.Before(time.Now().Add(30 * 24 * time.Hour)) {
  1462. return errors.New("certificate will soon expire")
  1463. }
  1464. // On macOS, check for certificates issued on or after July 1st, 2019,
  1465. // with a longer validity time than 825 days.
  1466. cutoff := time.Date(2019, 7, 1, 0, 0, 0, 0, time.UTC)
  1467. if runtime.GOOS == "darwin" &&
  1468. leaf.NotBefore.After(cutoff) &&
  1469. leaf.NotAfter.Sub(leaf.NotBefore) > 825*24*time.Hour {
  1470. return errors.New("certificate incompatible with macOS 10.15 (Catalina)")
  1471. }
  1472. return nil
  1473. }