syncthing/lib/upgrade/upgrade_supported.go

333 lines
7.1 KiB
Go
Raw Normal View History

2014-11-16 20:13:20 +00:00
// Copyright (C) 2014 The Syncthing Authors.
2014-09-29 19:43:32 +00:00
//
2015-03-07 20:36:35 +00:00
// 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/.
2014-06-01 20:50:14 +00:00
// +build !noupgrade
2014-06-16 07:52:14 +00:00
2014-07-31 14:01:23 +00:00
package upgrade
2014-05-02 08:01:09 +00:00
import (
"archive/tar"
"archive/zip"
"bytes"
2014-05-02 08:01:09 +00:00
"compress/gzip"
2015-08-21 08:13:31 +00:00
"crypto/tls"
2014-05-02 08:01:09 +00:00
"encoding/json"
"fmt"
"io"
"io/ioutil"
2014-05-02 08:01:09 +00:00
"net/http"
"os"
"path"
"path/filepath"
"runtime"
"sort"
2014-05-02 08:01:09 +00:00
"strings"
2015-08-21 08:13:31 +00:00
2015-10-13 18:52:22 +00:00
"github.com/syncthing/syncthing/lib/dialer"
2015-08-21 08:13:31 +00:00
"github.com/syncthing/syncthing/lib/signature"
2014-05-02 08:01:09 +00:00
)
const DisabledByCompilation = false
2015-08-21 08:13:31 +00:00
// This is an HTTP/HTTPS client that does *not* perform certificate
// validation. We do this because some systems where Syncthing runs have
// issues with old or missing CA roots. It doesn't actually matter that we
// load the upgrade insecurely as we verify an ECDSA signature of the actual
// binary contents before accepting the upgrade.
var insecureHTTP = &http.Client{
Transport: &http.Transport{
2015-10-13 18:52:22 +00:00
Dial: dialer.Dial,
Proxy: http.ProxyFromEnvironment,
2015-08-21 08:13:31 +00:00
TLSClientConfig: &tls.Config{
InsecureSkipVerify: true,
},
},
}
2015-04-28 20:32:10 +00:00
// LatestGithubReleases returns the latest releases, including prereleases or
// not depending on the argument
2015-09-10 12:16:44 +00:00
func LatestGithubReleases(releasesURL, version string) ([]Release, error) {
resp, err := insecureHTTP.Get(releasesURL)
2014-07-14 08:45:29 +00:00
if err != nil {
2015-04-09 20:44:36 +00:00
return nil, err
2014-07-14 08:45:29 +00:00
}
if resp.StatusCode > 299 {
2015-04-09 20:44:36 +00:00
return nil, fmt.Errorf("API call returned HTTP error: %s", resp.Status)
}
2014-07-14 08:45:29 +00:00
2014-07-31 14:01:23 +00:00
var rels []Release
2014-07-14 08:45:29 +00:00
json.NewDecoder(resp.Body).Decode(&rels)
resp.Body.Close()
2015-04-09 20:44:36 +00:00
return rels, nil
}
type SortByRelease []Release
func (s SortByRelease) Len() int {
return len(s)
}
func (s SortByRelease) Swap(i, j int) {
s[i], s[j] = s[j], s[i]
}
func (s SortByRelease) Less(i, j int) bool {
return CompareVersions(s[i].Tag, s[j].Tag) > 0
}
2015-09-10 12:16:44 +00:00
func LatestRelease(releasesURL, version string) (Release, error) {
rels, _ := LatestGithubReleases(releasesURL, version)
2015-04-09 20:44:36 +00:00
return SelectLatestRelease(version, rels)
}
func SelectLatestRelease(version string, rels []Release) (Release, error) {
if len(rels) == 0 {
2014-07-31 14:01:23 +00:00
return Release{}, ErrVersionUnknown
}
sort.Sort(SortByRelease(rels))
// Check for a beta build
beta := strings.Contains(version, "-")
2014-12-08 15:36:15 +00:00
for _, rel := range rels {
if rel.Prerelease && !beta {
continue
}
for _, asset := range rel.Assets {
assetName := path.Base(asset.Name)
// Check for the architecture
expectedRelease := releaseName(rel.Tag)
Implement facility based logger, debugging via REST API This implements a new debug/trace infrastructure based on a slightly hacked up logger. Instead of the traditional "if debug { ... }" I've rewritten the logger to have no-op Debugln and Debugf, unless debugging has been enabled for a given "facility". The "facility" is just a string, typically a package name. This will be slightly slower than before; but not that much as it's mostly a function call that returns immediately. For the cases where it matters (the Debugln takes a hex.Dump() of something for example, and it's not in a very occasional "if err != nil" branch) there is an l.ShouldDebug(facility) that is fast enough to be used like the old "if debug". The point of all this is that we can now toggle debugging for the various packages on and off at runtime. There's a new method /rest/system/debug that can be POSTed a set of facilities to enable and disable debug for, or GET from to get a list of facilities with descriptions and their current debug status. Similarly a /rest/system/log?since=... can grab the latest log entries, up to 250 of them (hardcoded constant in main.go) plus the initial few. Not implemented in this commit (but planned) is a simple debug GUI available on /debug that shows the current log in an easily pasteable format and has checkboxes to enable the various debug facilities. The debug instructions to a user then becomes "visit this URL, check these boxes, reproduce your problem, copy and paste the log". The actual log viewer on the hypothetical /debug URL can poll regularly for new log entries and this bypass the 250 line limit. The existing STTRACE=foo variable is still obeyed and just sets the start state of the system.
2015-10-03 15:25:21 +00:00
l.Debugf("expected release asset %q", expectedRelease)
l.Debugln("considering release", assetName)
if strings.HasPrefix(assetName, expectedRelease) {
return rel, nil
}
}
2014-07-14 08:45:29 +00:00
}
2014-12-08 15:36:15 +00:00
return Release{}, ErrVersionUnknown
2014-05-02 08:01:09 +00:00
}
// Upgrade to the given release, saving the previous binary with a ".old" extension.
func upgradeTo(binary string, rel Release) error {
expectedRelease := releaseName(rel.Tag)
Implement facility based logger, debugging via REST API This implements a new debug/trace infrastructure based on a slightly hacked up logger. Instead of the traditional "if debug { ... }" I've rewritten the logger to have no-op Debugln and Debugf, unless debugging has been enabled for a given "facility". The "facility" is just a string, typically a package name. This will be slightly slower than before; but not that much as it's mostly a function call that returns immediately. For the cases where it matters (the Debugln takes a hex.Dump() of something for example, and it's not in a very occasional "if err != nil" branch) there is an l.ShouldDebug(facility) that is fast enough to be used like the old "if debug". The point of all this is that we can now toggle debugging for the various packages on and off at runtime. There's a new method /rest/system/debug that can be POSTed a set of facilities to enable and disable debug for, or GET from to get a list of facilities with descriptions and their current debug status. Similarly a /rest/system/log?since=... can grab the latest log entries, up to 250 of them (hardcoded constant in main.go) plus the initial few. Not implemented in this commit (but planned) is a simple debug GUI available on /debug that shows the current log in an easily pasteable format and has checkboxes to enable the various debug facilities. The debug instructions to a user then becomes "visit this URL, check these boxes, reproduce your problem, copy and paste the log". The actual log viewer on the hypothetical /debug URL can poll regularly for new log entries and this bypass the 250 line limit. The existing STTRACE=foo variable is still obeyed and just sets the start state of the system.
2015-10-03 15:25:21 +00:00
l.Debugf("expected release asset %q", expectedRelease)
for _, asset := range rel.Assets {
assetName := path.Base(asset.Name)
Implement facility based logger, debugging via REST API This implements a new debug/trace infrastructure based on a slightly hacked up logger. Instead of the traditional "if debug { ... }" I've rewritten the logger to have no-op Debugln and Debugf, unless debugging has been enabled for a given "facility". The "facility" is just a string, typically a package name. This will be slightly slower than before; but not that much as it's mostly a function call that returns immediately. For the cases where it matters (the Debugln takes a hex.Dump() of something for example, and it's not in a very occasional "if err != nil" branch) there is an l.ShouldDebug(facility) that is fast enough to be used like the old "if debug". The point of all this is that we can now toggle debugging for the various packages on and off at runtime. There's a new method /rest/system/debug that can be POSTed a set of facilities to enable and disable debug for, or GET from to get a list of facilities with descriptions and their current debug status. Similarly a /rest/system/log?since=... can grab the latest log entries, up to 250 of them (hardcoded constant in main.go) plus the initial few. Not implemented in this commit (but planned) is a simple debug GUI available on /debug that shows the current log in an easily pasteable format and has checkboxes to enable the various debug facilities. The debug instructions to a user then becomes "visit this URL, check these boxes, reproduce your problem, copy and paste the log". The actual log viewer on the hypothetical /debug URL can poll regularly for new log entries and this bypass the 250 line limit. The existing STTRACE=foo variable is still obeyed and just sets the start state of the system.
2015-10-03 15:25:21 +00:00
l.Debugln("considering release", assetName)
if strings.HasPrefix(assetName, expectedRelease) {
2015-01-04 18:19:00 +00:00
return upgradeToURL(binary, asset.URL)
}
}
return ErrVersionUnknown
}
2014-12-22 11:07:04 +00:00
// Upgrade to the given release, saving the previous binary with a ".old" extension.
func upgradeToURL(binary string, url string) error {
fname, err := readRelease(filepath.Dir(binary), url)
if err != nil {
return err
}
old := binary + ".old"
2015-01-14 20:33:12 +00:00
os.Remove(old)
2014-12-22 11:07:04 +00:00
err = os.Rename(binary, old)
if err != nil {
return err
}
err = os.Rename(fname, binary)
if err != nil {
return err
}
return nil
}
func readRelease(dir, url string) (string, error) {
Implement facility based logger, debugging via REST API This implements a new debug/trace infrastructure based on a slightly hacked up logger. Instead of the traditional "if debug { ... }" I've rewritten the logger to have no-op Debugln and Debugf, unless debugging has been enabled for a given "facility". The "facility" is just a string, typically a package name. This will be slightly slower than before; but not that much as it's mostly a function call that returns immediately. For the cases where it matters (the Debugln takes a hex.Dump() of something for example, and it's not in a very occasional "if err != nil" branch) there is an l.ShouldDebug(facility) that is fast enough to be used like the old "if debug". The point of all this is that we can now toggle debugging for the various packages on and off at runtime. There's a new method /rest/system/debug that can be POSTed a set of facilities to enable and disable debug for, or GET from to get a list of facilities with descriptions and their current debug status. Similarly a /rest/system/log?since=... can grab the latest log entries, up to 250 of them (hardcoded constant in main.go) plus the initial few. Not implemented in this commit (but planned) is a simple debug GUI available on /debug that shows the current log in an easily pasteable format and has checkboxes to enable the various debug facilities. The debug instructions to a user then becomes "visit this URL, check these boxes, reproduce your problem, copy and paste the log". The actual log viewer on the hypothetical /debug URL can poll regularly for new log entries and this bypass the 250 line limit. The existing STTRACE=foo variable is still obeyed and just sets the start state of the system.
2015-10-03 15:25:21 +00:00
l.Debugf("loading %q", url)
2014-05-02 08:01:09 +00:00
req, err := http.NewRequest("GET", url, nil)
if err != nil {
return "", err
}
req.Header.Add("Accept", "application/octet-stream")
2015-08-21 08:13:31 +00:00
resp, err := insecureHTTP.Do(req)
2014-05-02 08:01:09 +00:00
if err != nil {
return "", err
}
defer resp.Body.Close()
switch runtime.GOOS {
case "windows":
return readZip(dir, resp.Body)
default:
return readTarGz(dir, resp.Body)
}
}
func readTarGz(dir string, r io.Reader) (string, error) {
gr, err := gzip.NewReader(r)
2014-05-02 08:01:09 +00:00
if err != nil {
return "", err
}
tr := tar.NewReader(gr)
2015-08-21 08:13:31 +00:00
var tempName string
var sig []byte
2014-05-02 08:01:09 +00:00
// Iterate through the files in the archive.
for {
hdr, err := tr.Next()
if err == io.EOF {
// end of tar archive
break
}
if err != nil {
return "", err
}
err = archiveFileVisitor(dir, &tempName, &sig, hdr.Name, tr)
2015-08-21 08:13:31 +00:00
if err != nil {
return "", err
}
2015-08-21 08:13:31 +00:00
if tempName != "" && sig != nil {
break
}
}
2015-08-21 08:13:31 +00:00
if err := verifyUpgrade(tempName, sig); err != nil {
return "", err
}
2015-08-21 08:13:31 +00:00
return tempName, nil
}
func readZip(dir string, r io.Reader) (string, error) {
body, err := ioutil.ReadAll(r)
if err != nil {
return "", err
}
archive, err := zip.NewReader(bytes.NewReader(body), int64(len(body)))
if err != nil {
return "", err
}
2015-08-21 08:13:31 +00:00
var tempName string
var sig []byte
// Iterate through the files in the archive.
for _, file := range archive.File {
2015-08-21 08:13:31 +00:00
inFile, err := file.Open()
if err != nil {
return "", err
}
err = archiveFileVisitor(dir, &tempName, &sig, file.Name, inFile)
2015-08-21 08:13:31 +00:00
inFile.Close()
if err != nil {
return "", err
}
2015-08-21 08:13:31 +00:00
if tempName != "" && sig != nil {
break
}
}
2014-05-02 08:01:09 +00:00
2015-08-21 08:13:31 +00:00
if err := verifyUpgrade(tempName, sig); err != nil {
return "", err
}
2015-08-21 08:13:31 +00:00
return tempName, nil
}
2015-08-21 08:13:31 +00:00
// archiveFileVisitor is called for each file in an archive. It may set
// tempFile and signature.
func archiveFileVisitor(dir string, tempFile *string, signature *[]byte, archivePath string, filedata io.Reader) error {
2015-08-21 08:13:31 +00:00
var err error
filename := path.Base(archivePath)
archiveDir := path.Dir(archivePath)
archiveDirs := strings.Split(archiveDir, "/")
if len(archiveDirs) > 1 {
//don't consider files in subfolders
return nil
}
l.Debugf("considering file %s", archivePath)
2015-08-21 08:13:31 +00:00
switch filename {
case "syncthing", "syncthing.exe":
l.Debugf("found upgrade binary %s", archivePath)
2015-08-21 08:13:31 +00:00
*tempFile, err = writeBinary(dir, filedata)
if err != nil {
return err
}
2015-08-21 08:13:31 +00:00
case "syncthing.sig", "syncthing.exe.sig":
l.Debugf("found signature %s", archivePath)
2015-08-21 08:13:31 +00:00
*signature, err = ioutil.ReadAll(filedata)
if err != nil {
return err
2014-05-02 08:01:09 +00:00
}
}
2015-08-21 08:13:31 +00:00
return nil
2014-05-02 08:01:09 +00:00
}
2015-08-21 08:13:31 +00:00
func verifyUpgrade(tempName string, sig []byte) error {
if tempName == "" {
return fmt.Errorf("no upgrade found")
}
if sig == nil {
return fmt.Errorf("no signature found")
}
Implement facility based logger, debugging via REST API This implements a new debug/trace infrastructure based on a slightly hacked up logger. Instead of the traditional "if debug { ... }" I've rewritten the logger to have no-op Debugln and Debugf, unless debugging has been enabled for a given "facility". The "facility" is just a string, typically a package name. This will be slightly slower than before; but not that much as it's mostly a function call that returns immediately. For the cases where it matters (the Debugln takes a hex.Dump() of something for example, and it's not in a very occasional "if err != nil" branch) there is an l.ShouldDebug(facility) that is fast enough to be used like the old "if debug". The point of all this is that we can now toggle debugging for the various packages on and off at runtime. There's a new method /rest/system/debug that can be POSTed a set of facilities to enable and disable debug for, or GET from to get a list of facilities with descriptions and their current debug status. Similarly a /rest/system/log?since=... can grab the latest log entries, up to 250 of them (hardcoded constant in main.go) plus the initial few. Not implemented in this commit (but planned) is a simple debug GUI available on /debug that shows the current log in an easily pasteable format and has checkboxes to enable the various debug facilities. The debug instructions to a user then becomes "visit this URL, check these boxes, reproduce your problem, copy and paste the log". The actual log viewer on the hypothetical /debug URL can poll regularly for new log entries and this bypass the 250 line limit. The existing STTRACE=foo variable is still obeyed and just sets the start state of the system.
2015-10-03 15:25:21 +00:00
l.Debugf("checking signature\n%s", sig)
2015-08-21 08:13:31 +00:00
fd, err := os.Open(tempName)
if err != nil {
return err
}
err = signature.Verify(SigningKey, sig, fd)
fd.Close()
if err != nil {
2015-08-21 08:13:31 +00:00
os.Remove(tempName)
return err
}
2015-08-21 08:13:31 +00:00
return nil
}
func writeBinary(dir string, inFile io.Reader) (filename string, err error) {
// Write the binary to a temporary file.
2015-08-21 08:13:31 +00:00
outFile, err := ioutil.TempFile(dir, "syncthing")
if err != nil {
return "", err
}
2015-08-21 08:13:31 +00:00
_, err = io.Copy(outFile, inFile)
if err != nil {
os.Remove(outFile.Name())
2015-08-21 08:13:31 +00:00
return "", err
}
err = outFile.Close()
if err != nil {
os.Remove(outFile.Name())
2015-08-21 08:13:31 +00:00
return "", err
}
err = os.Chmod(outFile.Name(), os.FileMode(0755))
if err != nil {
os.Remove(outFile.Name())
2015-08-21 08:13:31 +00:00
return "", err
}
2015-08-21 08:13:31 +00:00
return outFile.Name(), nil
}