-
Notifications
You must be signed in to change notification settings - Fork 128
/
utils.go
442 lines (384 loc) · 12.3 KB
/
utils.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
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
/*
Copyright 2016, Cossack Labs Limited
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.
*/
// Package cmd contains shared settings/constants among most of Acra component utilities.
package cmd
import (
"context"
"encoding/base64"
"errors"
flag_ "flag"
"fmt"
"io"
"math/rand"
"net"
"os"
"os/signal"
"path/filepath"
"reflect"
"strconv"
"strings"
"sync"
"time"
"github.com/cossacklabs/acra/logging"
log "github.com/sirupsen/logrus"
"gopkg.in/yaml.v2"
"github.com/cossacklabs/acra/keystore"
"github.com/cossacklabs/acra/utils"
)
var (
config = flag_.String("config_file", "", "path to config")
dumpconfig = flag_.Bool("dump_config", false, "dump config")
generateMarkdownArgTable = flag_.Bool("generate_markdown_args_table", false, "Generate with yaml config markdown text file with descriptions of all args")
)
// Argument and configuration parsing errors.
var (
ErrDumpRequested = errors.New("configurtion dump requested")
)
func init() {
// override default usage message by ours
flag_.CommandLine.Usage = func() {
PrintFlags(flag_.CommandLine)
}
}
// SignalCallback callback function
type SignalCallback func()
// SignalHandler sends Signal to listeners and call registered callbacks
type SignalHandler struct {
ch chan os.Signal
listeners []net.Listener
callbacks []SignalCallback
signals []os.Signal
lock sync.RWMutex
}
// NewSignalHandler returns new SignalHandler registered for particular os.Signals
func NewSignalHandler(handledSignals []os.Signal) (*SignalHandler, error) {
return &SignalHandler{ch: make(chan os.Signal), signals: handledSignals}, nil
}
// AddListener to listeners list
func (handler *SignalHandler) AddListener(listener net.Listener) {
handler.lock.Lock()
handler.listeners = append(handler.listeners, listener)
handler.lock.Unlock()
}
// GetChannel returns channel of os.Signal
func (handler *SignalHandler) GetChannel() chan os.Signal {
return handler.ch
}
// AddCallback to callbacks list
func (handler *SignalHandler) AddCallback(callback SignalCallback) {
handler.lock.Lock()
handler.callbacks = append(handler.callbacks, callback)
handler.lock.Unlock()
}
// Register should be called as goroutine
func (handler *SignalHandler) Register() {
signal.Notify(handler.ch, handler.signals...)
<-handler.ch
handler.lock.RLock()
for _, listener := range handler.listeners {
listener.Close()
}
for _, callback := range handler.callbacks {
callback()
}
handler.lock.RUnlock()
os.Exit(0)
}
// RegisterWithContext is a no-exit version of Register function with context usage
func (handler *SignalHandler) RegisterWithContext(globalContext context.Context) {
signal.Notify(handler.ch, handler.signals...)
for {
select {
case <-handler.ch:
handler.lock.RLock()
for _, listener := range handler.listeners {
listener.Close()
}
for _, callback := range handler.callbacks {
callback()
}
handler.lock.RUnlock()
case <-globalContext.Done():
// got signal for shutdown, so just return
return
}
}
}
// ValidateClientID checks that clientID has digits, letters, _ - ' '
func ValidateClientID(clientID string) {
if !keystore.ValidateID([]byte(clientID)) {
log.WithField(logging.FieldKeyEventCode, logging.EventCodeErrorInvalidClientID).Errorf(
"Invalid client ID, %d <= len(client ID) <= %d, only digits, letters and '_', '-', ' ' characters",
keystore.MinClientIDLength, keystore.MaxClientIDLength)
os.Exit(1)
}
}
func isZeroValue(flag *flag_.Flag, value string) bool {
/* took from flag/flag.go */
// Build a zero value of the flag's Value type, and see if the
// result of calling its String method equals the value passed in.
// This works unless the Value type is itself an interface type.
typ := reflect.TypeOf(flag.Value)
var z reflect.Value
if typ.Kind() == reflect.Ptr {
z = reflect.New(typ.Elem())
} else {
z = reflect.Zero(typ)
}
if value == z.Interface().(flag_.Value).String() {
return true
}
switch value {
case "false":
return true
case "":
return true
case "0":
return true
}
return false
}
// PrintFlags pretty-prints CLI flag set with default values to stderr.
func PrintFlags(flags *flag_.FlagSet) {
/* took from flag/flag.go and overrided arg display format (-/--) */
flags.VisitAll(func(flag *flag_.Flag) {
var s string
if len(flag.Name) > 2 {
s = fmt.Sprintf(" --%s", flag.Name) // Two spaces before -; see next two comments.
} else {
s = fmt.Sprintf(" -%s", flag.Name) // Two spaces before -; see next two comments.
}
// Boolean flags of one ASCII letter are so common we
// treat them specially, putting their usage on the same line.
if len(s) <= 4 {
// space, space, '-', 'x'.
s += "\t"
} else {
// Four spaces before the tab triggers good alignment
// for both 4- and 8-space tab stops.
s += "\n \t"
}
s += flag.Usage
if !isZeroValue(flag, flag.DefValue) {
getter, ok := flag.Value.(flag_.Getter)
if !ok {
return
}
if _, ok := getter.Get().(string); ok {
// put quotes on the value
s += fmt.Sprintf(" (default %q)", flag.DefValue)
} else {
s += fmt.Sprintf(" (default %v)", flag.DefValue)
}
}
fmt.Fprint(os.Stderr, s, "\n")
})
}
func visitFlagSets(flagSets []*flag_.FlagSet, visit func(flag *flag_.Flag)) {
seenNames := make(map[string]struct{})
for _, flags := range flagSets {
flags.VisitAll(func(flag *flag_.Flag) {
if _, visited := seenNames[flag.Name]; !visited {
visit(flag)
seenNames[flag.Name] = struct{}{}
}
})
}
}
// GenerateYaml generates YAML file from CLI params
func GenerateYaml(output io.Writer, useDefault bool) {
GenerateYamlFromFlagSets([]*flag_.FlagSet{flag_.CommandLine}, output, useDefault)
}
// GenerateYamlFromFlagSets generates YAML file from CLI flag sets.
func GenerateYamlFromFlagSets(flagSets []*flag_.FlagSet, output io.Writer, useDefault bool) {
// write version as first line in yaml format
if _, err := fmt.Fprintf(output, "version: %s\n", utils.VERSION); err != nil {
panic(err)
}
visitFlagSets(flagSets, func(flag *flag_.Flag) {
var s string
if useDefault {
s = fmt.Sprintf("# %v\n%v: %v\n", flag.Usage, flag.Name, flag.DefValue)
} else {
s = fmt.Sprintf("# %v\n%v: %v\n", flag.Usage, flag.Name, flag.Value)
}
fmt.Fprint(output, s, "\n")
})
}
// GenerateMarkdownDoc generates Markdown file from CLI params
func GenerateMarkdownDoc(output io.Writer, serviceName string) {
GenerateMarkdownDocFromFlagSets([]*flag_.FlagSet{flag_.CommandLine}, output, serviceName)
}
// GenerateMarkdownDocFromFlagSets generates Markdown file from CLI flag sets.
func GenerateMarkdownDocFromFlagSets(flagSets []*flag_.FlagSet, output io.Writer, serviceName string) {
// escape column separator symbol from text
escapeColumn := func(text string) string {
return strings.Replace(text, "|", "\\|", -1)
}
// table header with service name
// |serviceName | arg name | rename to | default value | description|
// |:-: |:-: |:-: |:-: |:-: |
fmt.Fprintf(output, "|%v|||||\n|:-:|:-:|:-:|:-:|:-:|\n", serviceName)
visitFlagSets(flagSets, func(flag *flag_.Flag) {
fmt.Fprintf(output, "||%v||%v|%v|\n", flag.Name, flag.DefValue, escapeColumn(flag.Usage))
})
}
// ConfigPath returns path to configuration file.
// The given default value is used, unless it has been overridden on the command line.
func ConfigPath(defaultPath string) string {
if *config == "" {
return defaultPath
}
return *config
}
// DumpConfig writes CLI params to configPath
func DumpConfig(configPath, serviceName string, useDefault bool) error {
return DumpConfigFromFlagSets([]*flag_.FlagSet{flag_.CommandLine}, configPath, serviceName, useDefault)
}
// DumpConfigFromFlagSets writes CLI params to configPath
func DumpConfigFromFlagSets(flagSets []*flag_.FlagSet, configPath, serviceName string, useDefault bool) error {
absPath, err := filepath.Abs(ConfigPath(configPath))
if err != nil {
return err
}
dirPath := filepath.Dir(absPath)
err = os.MkdirAll(dirPath, 0744)
if err != nil {
return err
}
file, err := os.Create(absPath)
if err != nil {
return err
}
defer file.Close()
GenerateYamlFromFlagSets(flagSets, file, useDefault)
if *generateMarkdownArgTable {
file2, err := os.Create(fmt.Sprintf("%v/markdown_%v.md", dirPath, serviceName))
if err != nil {
return err
}
GenerateMarkdownDocFromFlagSets(flagSets, file2, serviceName)
}
log.Infof("Config dumped to %s", configPath)
return nil
}
func checkVersion(config map[string]string) error {
if config == nil || len(config) == 0 {
return nil
}
versionValue, ok := config["version"]
if !ok {
return errors.New("config hasn't version key")
}
version, err := utils.ParseVersion(versionValue)
if err != nil {
return err
}
serverVersion, err := utils.GetParsedVersion()
if err != nil {
return err
}
if serverVersion.CompareOnly(utils.MajorFlag|utils.MinorFlag, version) != utils.Equal {
return fmt.Errorf("config version \"%s\" is not supported, expects \"%s\" version", version.String(), serverVersion.String())
}
return nil
}
// ParseFlags parses CommandLine flags or return ErrDumpRequested if requested.
func ParseFlags(flags *flag_.FlagSet, arguments []string) error {
err := flags.Parse(arguments)
if *dumpconfig {
return ErrDumpRequested
}
return err
}
// ParseConfig parse service config by configPath if exists
func ParseConfig(configPath, serviceName string) (map[string]string, error) {
result := make(map[string]string)
if configPath == "" {
return result, nil
}
configPath = ConfigPath(configPath)
configAbsPath, err := filepath.Abs(configPath)
if err != nil {
return nil, err
}
exists, err := utils.FileExists(configAbsPath)
if err != nil {
return nil, err
}
if exists {
data, err := os.ReadFile(configPath)
if err != nil {
return nil, err
}
err = yaml.Unmarshal(data, &result)
if err != nil {
return nil, err
}
}
if err = checkVersion(result); err != nil {
return nil, err
}
return result, nil
}
// Argon2Params describes params for Argon2 hashing
type Argon2Params struct {
Time uint32
Memory uint32
Threads uint8
Length uint32
}
// UserAuth describes user params for password hashing: salt, params, hash
type UserAuth struct {
Salt string
Argon2Params
Hash []byte
}
// UserAuthString returns string representation of UserAuth
func (auth UserAuth) UserAuthString(userDataDelimiter string, paramsDelimiter string) string {
var userData []string
var argon2P []string
argon2P = append(argon2P, strconv.FormatUint(uint64(auth.Argon2Params.Time), 10))
argon2P = append(argon2P, strconv.FormatUint(uint64(auth.Argon2Params.Memory), 10))
argon2P = append(argon2P, strconv.FormatUint(uint64(auth.Argon2Params.Threads), 10))
argon2P = append(argon2P, strconv.FormatUint(uint64(auth.Argon2Params.Length), 10))
hash := base64.StdEncoding.EncodeToString(auth.Hash)
userData = append(userData, auth.Salt)
userData = append(userData, strings.Join(argon2P, paramsDelimiter))
userData = append(userData, hash)
return strings.Join(userData, userDataDelimiter)
}
const letterBytes = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
const (
letterIdxBits = 6 // 6 bits to represent a letter index
letterIdxMask = 1<<letterIdxBits - 1 // All 1-bits, as many as letterIdxBits
letterIdxMax = 63 / letterIdxBits // # of letter indices fitting in 63 bits
)
var randSrc = rand.NewSource(time.Now().UnixNano())
// RandomStringBytes getting random string using faster randSrc.Int63() and true distribution for letterBytes.
func RandomStringBytes(n int) string {
b := make([]byte, n)
// A randSrc.Int63() generates 63 random bits, enough for letterIdxMax characters!
for i, cache, remain := n-1, randSrc.Int63(), letterIdxMax; i >= 0; {
if remain == 0 {
cache, remain = randSrc.Int63(), letterIdxMax
}
if idx := int(cache & letterIdxMask); idx < len(letterBytes) {
b[i] = letterBytes[idx]
i--
}
cache >>= letterIdxBits
remain--
}
return string(b)
}