Merged the restic-server by @bchapuis

Commit ID in fd0/restic-server at time of merge is
07fae00e7ddd8751b150e2ebf0bff8b2871c77ce

src/restic/cmd/restic-server/.gitignore

@@ -0,0 +1,24 @@
+# Compiled Object files, Static and Dynamic libs (Shared Objects)
+*.o
+*.a
+*.so
+
+# Folders
+_obj
+_test
+
+# Architecture specific extensions/prefixes
+*.[568vq]
+[568vq].out
+
+*.cgo1.go
+*.cgo2.c
+_cgo_defun.c
+_cgo_gotypes.go
+_cgo_export.*
+
+_testmain.go
+
+*.exe
+*.test
+*.prof

src/restic/cmd/restic-server/LICENSE

@@ -0,0 +1,24 @@
+Copyright (c) 2015, Bertil Chapuis
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

src/restic/cmd/restic-server/README.md

@@ -0,0 +1,29 @@
+# Restic Server
+
+Restic Server is a sample server that implement restic's rest backend api.
+It has been developed for demonstration purpose and is not intented to be used in production.
+
+## Getting started
+
+By default the server persists backup data in `/tmp/restic`. 
+Build and start the server with a custom persistence directory:
+
+```
+go build
+./restic-server -path /user/home/backup
+```
+
+The server use an `.htpasswd` file to specify users. You can create such a file at the root of the persistence directory by executing the following command. In order to append new user to the file, just omit the `-c` argument.
+
+```
+htpasswd -s -c .htpasswd username
+```
+
+By default the server uses http. This is not very secure since with Basic Authentication, username and passwords will be present in every request. In order to enable TLS support just add the `-tls` argument and add a private and public key at the root of your persistence directory. 
+
+Signed certificate are required by the restic backend but if you just want to test the feature you can generate unsigned keys with the following commands:
+
+```
+openssl genrsa -out private_key 2048
+openssl req -new -x509 -key private_key -out public_key -days 365
+```

src/restic/cmd/restic-server/handlers.go

@@ -0,0 +1,157 @@
+package main
+
+import (
+	"encoding/json"
+	"io/ioutil"
+	"net/http"
+	"os"
+	"path/filepath"
+	"strings"
+	"time"
+)
+
+type Context struct {
+	path string
+}
+
+func AuthHandler(f *HtpasswdFile, h http.Handler) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		username, password, ok := r.BasicAuth()
+		if !ok {
+			http.Error(w, "401 unauthorized", 401)
+			return
+		}
+		if !f.Validate(username, password) {
+			http.Error(w, "401 unauthorized", 401)
+			return
+		}
+		h.ServeHTTP(w, r)
+	}
+}
+
+func CheckConfig(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		config := filepath.Join(c.path, "config")
+		if _, err := os.Stat(config); err != nil {
+			http.Error(w, "404 not found", 404)
+			return
+		}
+	}
+}
+
+func GetConfig(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		config := filepath.Join(c.path, "config")
+		bytes, err := ioutil.ReadFile(config)
+		if err != nil {
+			http.Error(w, "404 not found", 404)
+			return
+		}
+		w.Write(bytes)
+	}
+}
+
+func SaveConfig(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		config := filepath.Join(c.path, "config")
+		bytes, err := ioutil.ReadAll(r.Body)
+		if err != nil {
+			http.Error(w, "400 bad request", 400)
+			return
+		}
+		errw := ioutil.WriteFile(config, bytes, 0600)
+		if errw != nil {
+			http.Error(w, "500 internal server error", 500)
+			return
+		}
+		w.Write([]byte("200 ok"))
+	}
+}
+
+func ListBlobs(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := strings.Split(r.RequestURI, "/")
+		dir := vars[1]
+		path := filepath.Join(c.path, dir)
+		files, err := ioutil.ReadDir(path)
+		if err != nil {
+			http.Error(w, "404 not found", 404)
+			return
+		}
+		names := make([]string, len(files))
+		for i, f := range files {
+			names[i] = f.Name()
+		}
+		data, err := json.Marshal(names)
+		if err != nil {
+			http.Error(w, "500 internal server error", 500)
+			return
+		}
+		w.Write(data)
+	}
+}
+
+func CheckBlob(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := strings.Split(r.RequestURI, "/")
+		dir := vars[1]
+		name := vars[2]
+		path := filepath.Join(c.path, dir, name)
+		_, err := os.Stat(path)
+		if err != nil {
+			http.Error(w, "404 not found", 404)
+			return
+		}
+	}
+}
+
+func GetBlob(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := strings.Split(r.RequestURI, "/")
+		dir := vars[1]
+		name := vars[2]
+		path := filepath.Join(c.path, dir, name)
+		file, err := os.Open(path)
+		if err != nil {
+			http.Error(w, "404 not found", 404)
+			return
+		}
+		defer file.Close()
+		http.ServeContent(w, r, "", time.Unix(0, 0), file)
+	}
+}
+
+func SaveBlob(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := strings.Split(r.RequestURI, "/")
+		dir := vars[1]
+		name := vars[2]
+		path := filepath.Join(c.path, dir, name)
+		bytes, err := ioutil.ReadAll(r.Body)
+		if err != nil {
+			http.Error(w, "400 bad request", 400)
+			return
+		}
+		errw := ioutil.WriteFile(path, bytes, 0600)
+		if errw != nil {
+			http.Error(w, "500 internal server error", 500)
+			return
+		}
+		w.Write([]byte("200 ok"))
+	}
+}
+
+func DeleteBlob(c *Context) http.HandlerFunc {
+	return func(w http.ResponseWriter, r *http.Request) {
+		vars := strings.Split(r.RequestURI, "/")
+		dir := vars[1]
+		name := vars[2]
+		path := filepath.Join(c.path, dir, name)
+		err := os.Remove(path)
+		if err != nil {
+			http.Error(w, "500 internal server error", 500)
+			return
+		}
+		w.Write([]byte("200 ok"))
+	}
+}

src/restic/cmd/restic-server/htpasswd.go

@@ -0,0 +1,84 @@
+package main
+
+/*
+Copied from: github.com/bitly/oauth2_proxy
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+*/
+
+import (
+	"crypto/sha1"
+	"encoding/base64"
+	"encoding/csv"
+	"io"
+	"log"
+	"os"
+)
+
+// lookup passwords in a htpasswd file
+// The entries must have been created with -s for SHA encryption
+
+type HtpasswdFile struct {
+	Users map[string]string
+}
+
+func NewHtpasswdFromFile(path string) (*HtpasswdFile, error) {
+	r, err := os.Open(path)
+	if err != nil {
+		return nil, err
+	}
+	defer r.Close()
+	return NewHtpasswd(r)
+}
+
+func NewHtpasswd(file io.Reader) (*HtpasswdFile, error) {
+	csv_reader := csv.NewReader(file)
+	csv_reader.Comma = ':'
+	csv_reader.Comment = '#'
+	csv_reader.TrimLeadingSpace = true
+
+	records, err := csv_reader.ReadAll()
+	if err != nil {
+		return nil, err
+	}
+	h := &HtpasswdFile{Users: make(map[string]string)}
+	for _, record := range records {
+		h.Users[record[0]] = record[1]
+	}
+	return h, nil
+}
+
+func (h *HtpasswdFile) Validate(user string, password string) bool {
+	realPassword, exists := h.Users[user]
+	if !exists {
+		return false
+	}
+	if realPassword[:5] == "{SHA}" {
+		d := sha1.New()
+		d.Write([]byte(password))
+		if realPassword[5:] == base64.StdEncoding.EncodeToString(d.Sum(nil)) {
+			return true
+		}
+	} else {
+		log.Printf("Invalid htpasswd entry for %s. Must be a SHA entry.", user)
+	}
+	return false
+}

src/restic/cmd/restic-server/router.go

@@ -0,0 +1,115 @@
+package main
+
+import (
+	"log"
+	"net/http"
+	"strings"
+)
+
+type Route struct {
+	path    []string
+	handler http.Handler
+}
+
+type Router struct {
+	routes map[string][]Route
+}
+
+func NewRouter() *Router {
+	return &Router{make(map[string][]Route)}
+}
+
+func (router *Router) Options(path string, handler http.Handler) {
+	router.Handle("OPTIONS", path, handler)
+}
+
+func (router *Router) OptionsFunc(path string, handler http.HandlerFunc) {
+	router.Handle("OPTIONS", path, handler)
+}
+
+func (router *Router) Get(path string, handler http.Handler) {
+	router.Handle("GET", path, handler)
+}
+
+func (router *Router) GetFunc(path string, handler http.HandlerFunc) {
+	router.Handle("GET", path, handler)
+}
+
+func (router *Router) Head(path string, handler http.Handler) {
+	router.Handle("HEAD", path, handler)
+}
+
+func (router *Router) HeadFunc(path string, handler http.HandlerFunc) {
+	router.Handle("HEAD", path, handler)
+}
+
+func (router *Router) Post(path string, handler http.Handler) {
+	router.Handle("POST", path, handler)
+}
+
+func (router *Router) PostFunc(path string, handler http.HandlerFunc) {
+	router.Handle("POST", path, handler)
+}
+
+func (router *Router) Put(path string, handler http.Handler) {
+	router.Handle("PUT", path, handler)
+}
+
+func (router *Router) PutFunc(path string, handler http.HandlerFunc) {
+	router.Handle("PUT", path, handler)
+}
+
+func (router *Router) Delete(path string, handler http.Handler) {
+	router.Handle("DELETE", path, handler)
+}
+
+func (router *Router) DeleteFunc(path string, handler http.HandlerFunc) {
+	router.Handle("DELETE", path, handler)
+}
+
+func (router *Router) Trace(path string, handler http.Handler) {
+	router.Handle("TRACE", path, handler)
+}
+
+func (router *Router) TraceFunc(path string, handler http.HandlerFunc) {
+	router.Handle("TRACE", path, handler)
+}
+
+func (router *Router) Connect(path string, handler http.Handler) {
+	router.Handle("Connect", path, handler)
+}
+
+func (router *Router) ConnectFunc(path string, handler http.HandlerFunc) {
+	router.Handle("Connect", path, handler)
+}
+
+func (router *Router) Handle(method string, uri string, handler http.Handler) {
+	routes := router.routes[method]
+	path := strings.Split(uri, "/")
+	routes = append(routes, Route{path, handler})
+	router.routes[method] = routes
+}
+
+func (router *Router) ServeHTTP(w http.ResponseWriter, r *http.Request) {
+	method := r.Method
+	uri := r.RequestURI
+	path := strings.Split(uri, "/")
+
+	log.Printf("%s %s", method, uri)
+
+ROUTE:
+	for _, route := range router.routes[method] {
+		if len(route.path) != len(path) {
+			continue
+		}
+		for i := 0; i < len(route.path); i++ {
+			if !strings.HasPrefix(route.path[i], ":") && route.path[i] != path[i] {
+				continue ROUTE
+			}
+		}
+		route.handler.ServeHTTP(w, r)
+		return
+	}
+
+	http.Error(w, "404 not found", 404)
+}

src/restic/cmd/restic-server/router_test.go

@@ -0,0 +1,58 @@
+package main
+
+import (
+	"io/ioutil"
+	"net/http"
+	"net/http/httptest"
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestRouter(t *testing.T) {
+	router := NewRouter()
+
+	getConfig := []byte("GET /config")
+	router.GetFunc("/config", func(w http.ResponseWriter, r *http.Request) {
+		w.Write(getConfig)
+	})
+
+	postConfig := []byte("POST /config")
+	router.PostFunc("/config", func(w http.ResponseWriter, r *http.Request) {
+		w.Write(postConfig)
+	})
+
+	getBlobs := []byte("GET /blobs/")
+	router.GetFunc("/blobs/", func(w http.ResponseWriter, r *http.Request) {
+		w.Write(getBlobs)
+	})
+
+	getBlob := []byte("GET /blobs/:sha")
+	router.GetFunc("/blobs/:sha", func(w http.ResponseWriter, r *http.Request) {
+		w.Write(getBlob)
+	})
+
+	server := httptest.NewServer(router)
+	defer server.Close()
+
+	getConfigResp, _ := http.Get(server.URL + "/config")
+	getConfigBody, _ := ioutil.ReadAll(getConfigResp.Body)
+	require.Equal(t, 200, getConfigResp.StatusCode)
+	require.Equal(t, string(getConfig), string(getConfigBody))
+
+	postConfigResp, _ := http.Post(server.URL+"/config", "binary/octet-stream", strings.NewReader("post test"))
+	postConfigBody, _ := ioutil.ReadAll(postConfigResp.Body)
+	require.Equal(t, 200, postConfigResp.StatusCode)
+	require.Equal(t, string(postConfig), string(postConfigBody))
+
+	getBlobsResp, _ := http.Get(server.URL + "/blobs/")
+	getBlobsBody, _ := ioutil.ReadAll(getBlobsResp.Body)
+	require.Equal(t, 200, getBlobsResp.StatusCode)
+	require.Equal(t, string(getBlobs), string(getBlobsBody))
+
+	getBlobResp, _ := http.Get(server.URL + "/blobs/test")
+	getBlobBody, _ := ioutil.ReadAll(getBlobResp.Body)
+	require.Equal(t, 200, getBlobResp.StatusCode)
+	require.Equal(t, string(getBlob), string(getBlobBody))
+}

src/restic/cmd/restic-server/server.go

@@ -0,0 +1,70 @@
+package main
+
+import (
+	"flag"
+	"log"
+	"net/http"
+	"os"
+	"path/filepath"
+)
+
+const (
+	HTTP  = ":8000"
+	HTTPS = ":8443"
+)
+
+func main() {
+	// Parse command-line args
+	var path = flag.String("path", "/tmp/restic", "specifies the path of the data directory")
+	var tls = flag.Bool("tls", false, "turns on tls support")
+	flag.Parse()
+
+	// Create the missing directories
+	dirs := []string{
+		"data",
+		"snapshots",
+		"index",
+		"locks",
+		"keys",
+	}
+	for _, d := range dirs {
+		os.MkdirAll(filepath.Join(*path, d), 0600)
+	}
+
+	// Define the routes
+	context := &Context{*path}
+	router := NewRouter()
+	router.HeadFunc("/config", CheckConfig(context))
+	router.GetFunc("/config", GetConfig(context))
+	router.PostFunc("/config", SaveConfig(context))
+	router.GetFunc("/:dir/", ListBlobs(context))
+	router.HeadFunc("/:dir/:name", CheckBlob(context))
+	router.GetFunc("/:type/:name", GetBlob(context))
+	router.PostFunc("/:type/:name", SaveBlob(context))
+	router.DeleteFunc("/:type/:name", DeleteBlob(context))
+
+	// Check for a password file
+	var handler http.Handler
+	htpasswdFile, err := NewHtpasswdFromFile(filepath.Join(*path, ".htpasswd"))
+	if err != nil {
+		log.Println("Authentication disabled")
+		handler = router
+	} else {
+		log.Println("Authentication enabled")
+		handler = AuthHandler(htpasswdFile, router)
+	}
+
+	// start the server
+	if !*tls {
+		log.Printf("start server on port %s\n", HTTP)
+		http.ListenAndServe(HTTP, handler)
+	} else {
+		privateKey := filepath.Join(*path, "private_key")
+		publicKey := filepath.Join(*path, "public_key")
+		log.Println("TLS enabled")
+		log.Printf("private key: %s", privateKey)
+		log.Printf("public key: %s", publicKey)
+		log.Printf("start server on port %s\n", HTTPS)
+		http.ListenAndServeTLS(HTTPS, publicKey, privateKey, handler)
+	}
+}