-
Notifications
You must be signed in to change notification settings - Fork 0
/
blobd.go
237 lines (213 loc) · 7.76 KB
/
blobd.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
// Copyright 2020 Michael J. Fromberger. All Rights Reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Program blobd exports a blob.Store via the Chirp V0 protocol.
//
// By default, building or installing this tool includes a minimal set of
// storage backends, "file" and "memory". To build with additional storage
// support, add build tags for each, for example:
//
// go install -tags badger,s3,gcs github.com/creachadair/ffstools/blobd@latest
//
// To include all available storage implementations, use the tag "all".
// The storage implementations currently supported include:
//
// Tag | Description
// ---------|--------------------------------------------------------------------------
// badger | BadgerDB https://godoc.org/github.com/dgraph-io/badger/v4
// bitcask | Bitcask https://godoc.org/git.mills.io/prologic/bitcask
// bolt | BoltDB https://godoc.org/go.etcd.io/bbolt
// file | Files https://godoc.org/github.com/creachadair/ffs/storage/filestore
// gcs | GCS https://godoc.org/cloud.google.com/go/storage
// leveldb | LevelDB https://godoc.org/github.com/syndtr/goleveldb/leveldb
// memory | In-memory https://godoc.org/github.com/creachadair/ffs/blob/memstore
// pebble | PebbleDB https://godoc.org/github.com/cockroachdb/pebble
// pogreb | Pogreb https://godoc.org/github.com/akrylysov/pogreb
// s3 | Amazon S3 https://godoc.org/github.com/aws/aws-sdk-go/service/s3
// sqlite | SQLite https://godoc.org/crawshaw.io/sqlite
//
// For information about Chirp v0, see:
// https://github.com/creachadair/chirp/blob/main/spec.md
package main
import (
"archive/zip"
"context"
"flag"
"fmt"
"log"
"os"
"os/signal"
"sort"
"strings"
"syscall"
"time"
"github.com/creachadair/command"
"github.com/creachadair/ctrl"
"github.com/creachadair/ffs/blob"
"github.com/creachadair/ffs/blob/memstore"
"github.com/creachadair/ffs/storage/filestore"
"github.com/creachadair/ffs/storage/zipstore"
"github.com/creachadair/ffstools/blobd/store"
"github.com/creachadair/ffstools/ffs/config"
)
var (
// Flags (see root.SetFlags below).
listenAddr string
storeAddr string
keyFile string
aeadStyle string
doSignKeys bool
bufferDB string
cacheSize int
doCompress bool
doReadOnly bool
doVersion bool
// FFS config file (see getListenAddr).
configPath = config.Path()
// These storage implementations are built in by default.
// To include other stores, build with -tags set to their names.
// The known implementations are in the store_*.go files.
stores = store.Registry{
"file": func(ctx context.Context, addr string) (blob.Store, error) {
if strings.HasSuffix(addr, ".zip") {
zf, err := zip.OpenReader(addr)
if err != nil {
return nil, err
}
return zipstore.New(zf, nil), nil
}
return filestore.Opener(ctx, addr)
},
"memory": memstore.Opener,
}
)
func main() {
// List the available storage drivers. Note we have to do this after main
// starts to ensure all the initializers are done with registration.
var storeNames []string
for key := range stores {
storeNames = append(storeNames, key)
}
sort.Strings(storeNames)
root := &command.C{
Name: command.ProgramName(),
Usage: `[options] -store <spec> -listen <addr>`,
Help: fmt.Sprintf(`
Start a server that serves content from the blob.Store described by the -store spec.
The server listens at the specified address, which may be a host:port or the path
of a Unix-domain socket.
A store spec is a storage type and address: type:address
The types understood are: %[1]s
If --listen is:
- A store label of the form @name: The address associated with that
name in the FFS config file is used.
- A host:port address: A TCP listener is created at that address.
- Otherwise: The address must be a path for a Unix-domain socket.
With --keyfile, the store is opened with encryption (set by --encryption).
If --keyfile begins with "@", the value is used as a key salt for HKDF
with the user-provided passphrase. Double the "@" to escape this meaning.
Otherwise the passphrase is used to unlock the key file.
If BLOBD_KEYFILE_PASSPHRASE is set in the environment, it is used as the
passphrase for the keyfile; otherwise blobd prompts at the terminal.
Use -cache to enable a memory cache over the underlying store.`, strings.Join(storeNames, ", ")),
SetFlags: func(_ *command.Env, fs *flag.FlagSet) {
fs.StringVar(&listenAddr, "listen", "", "Service address (required)")
fs.StringVar(&storeAddr, "store", "", "Store address (required)")
fs.StringVar(&keyFile, "keyfile", "", "Encryption key file (if empty, do not encrypt)")
fs.StringVar(&aeadStyle, "encryption", "chacha", `Encryption algorithm ("aes" or "chacha")`)
fs.BoolVar(&doSignKeys, "sign-keys", false, "Sign content addresses (ignored without -keyfile)")
fs.StringVar(&bufferDB, "buffer", "", "Write-behind buffer database")
fs.IntVar(&cacheSize, "cache", 0, "Memory cache size in MiB (0 means no cache)")
fs.BoolVar(&doCompress, "compress", false, "Enable zstd compression of blob data")
fs.BoolVar(&doReadOnly, "read-only", false, "Disallow modification of the store")
fs.BoolVar(&doVersion, "version", false, "Print version information and exit")
fs.StringVar(&configPath, "config", configPath, "PRIVATE:Configuration file path")
},
Run: blobd,
}
ctrl.Run(func() error {
command.RunOrFail(root.NewEnv(nil), os.Args[1:])
return nil
})
}
func blobd(env *command.Env) error {
switch {
case doVersion:
fmt.Println(command.GetVersionInfo())
return nil
case storeAddr == "":
ctrl.Exitf(1, "You must provide a non-empty --store address")
}
listenAddr := getListenAddr()
ctx := context.Background()
bs, buf := mustOpenStore(ctx)
defer func() {
// N.B. Invoke close with a fresh context, since the parent is likely to
// have been already canceled during shutdown. Set a timeout in case the
// close gets stuck, however.
cctx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
defer cancel()
if err := bs.Close(cctx); err != nil {
log.Printf("Warning: closing store: %v", err)
}
}()
log.Printf("Store address: %q", storeAddr)
if doReadOnly {
log.Print("Store is open in read-only mode")
}
if doCompress {
log.Print("Compression enabled (zstd)")
if keyFile != "" {
log.Printf(">> WARNING: Compression and encryption are both enabled")
}
}
if cacheSize > 0 {
log.Printf("Memory cache size: %d MiB", cacheSize)
}
if keyFile != "" {
log.Printf("Encryption key: %q", keyFile)
}
config := startConfig{
Address: listenAddr,
Store: bs,
Buffer: buf,
}
ctx, cancel := context.WithCancel(ctx)
defer cancel()
closer, loop := startChirpServer(ctx, config)
sig := make(chan os.Signal, 2)
signal.Notify(sig, syscall.SIGINT, syscall.SIGTERM)
go func() {
s, ok := <-sig
if ok {
log.Printf("Received signal: %v, closing listener", s)
cancel()
closer()
signal.Reset(syscall.SIGINT, syscall.SIGTERM)
}
}()
return loop.Wait()
}
func getListenAddr() string {
cfg, err := config.Load(configPath)
if err != nil {
ctrl.Fatalf("Unable to open config file: %v", err)
}
addr := cfg.ResolveAddress(listenAddr)
if addr == "" {
ctrl.Fatalf("You must provide a non-empty --listen address")
} else if strings.HasPrefix(addr, "@") {
ctrl.Fatalf("No service address for label %q", listenAddr)
}
return addr
}