/
util.go
367 lines (320 loc) · 11.4 KB
/
util.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
package util
import (
"context"
"crypto/tls"
"crypto/x509"
"errors"
"fmt"
"net"
"net/http"
"time"
"github.com/jzelinskie/stringz"
"github.com/rs/zerolog"
"github.com/rs/zerolog/log"
"github.com/spf13/pflag"
"google.golang.org/grpc"
"google.golang.org/grpc/credentials"
"google.golang.org/grpc/credentials/insecure"
"google.golang.org/grpc/keepalive"
"google.golang.org/grpc/test/bufconn"
"github.com/authzed/spicedb/pkg/x509util"
)
const BufferedNetwork string = "buffnet"
type GRPCServerConfig struct {
Address string
Network string
TLSCertPath string
TLSKeyPath string
MaxConnAge time.Duration
Enabled bool
BufferSize int
ClientCAPath string
MaxWorkers uint32
flagPrefix string
}
// RegisterGRPCServerFlags adds the following flags for use with
// GrpcServerFromFlags:
// - "$PREFIX-addr"
// - "$PREFIX-tls-cert-path"
// - "$PREFIX-tls-key-path"
// - "$PREFIX-max-conn-age"
func RegisterGRPCServerFlags(flags *pflag.FlagSet, config *GRPCServerConfig, flagPrefix, serviceName, defaultAddr string, defaultEnabled bool) {
flagPrefix = stringz.DefaultEmpty(flagPrefix, "grpc")
serviceName = stringz.DefaultEmpty(serviceName, "grpc")
defaultAddr = stringz.DefaultEmpty(defaultAddr, ":50051")
config.flagPrefix = flagPrefix
flags.StringVar(&config.Address, flagPrefix+"-addr", defaultAddr, "address to listen on to serve "+serviceName)
flags.StringVar(&config.Network, flagPrefix+"-network", "tcp", "network type to serve "+serviceName+` ("tcp", "tcp4", "tcp6", "unix", "unixpacket")`)
flags.StringVar(&config.TLSCertPath, flagPrefix+"-tls-cert-path", "", "local path to the TLS certificate used to serve "+serviceName)
flags.StringVar(&config.TLSKeyPath, flagPrefix+"-tls-key-path", "", "local path to the TLS key used to serve "+serviceName)
flags.DurationVar(&config.MaxConnAge, flagPrefix+"-max-conn-age", 30*time.Second, "how long a connection serving "+serviceName+" should be able to live")
flags.BoolVar(&config.Enabled, flagPrefix+"-enabled", defaultEnabled, "enable "+serviceName+" gRPC server")
flags.Uint32Var(&config.MaxWorkers, flagPrefix+"-max-workers", 0, "set the number of workers for this server (0 value means 1 worker per request)")
}
type (
DialFunc func(ctx context.Context, opts ...grpc.DialOption) (*grpc.ClientConn, error)
NetDialFunc func(ctx context.Context, s string) (net.Conn, error)
)
// Complete takes a set of default options and returns a completed server
func (c *GRPCServerConfig) Complete(level zerolog.Level, svcRegistrationFn func(server *grpc.Server), opts ...grpc.ServerOption) (RunnableGRPCServer, error) {
if !c.Enabled {
return &disabledGrpcServer{}, nil
}
if c.BufferSize == 0 {
c.BufferSize = 1024 * 1024
}
opts = append(opts, grpc.KeepaliveParams(keepalive.ServerParameters{
MaxConnectionAge: c.MaxConnAge,
}), grpc.NumStreamWorkers(c.MaxWorkers))
tlsOpts, err := c.tlsOpts()
if err != nil {
return nil, err
}
opts = append(opts, tlsOpts...)
clientCreds, err := c.clientCreds()
if err != nil {
return nil, err
}
l, dial, netDial, err := c.listenerAndDialer()
if err != nil {
return nil, fmt.Errorf("failed to listen on addr for gRPC server: %w", err)
}
log.WithLevel(level).Str("addr", c.Address).Str("network", c.Network).
Str("prefix", c.flagPrefix).Uint32("workers", c.MaxWorkers).Msg("grpc server started listening")
srv := grpc.NewServer(opts...)
svcRegistrationFn(srv)
return &completedGRPCServer{
opts: opts,
listener: l,
svcRegistrationFn: svcRegistrationFn,
listenFunc: func() error {
return srv.Serve(l)
},
dial: dial,
netDial: netDial,
prestopFunc: func() {
log.WithLevel(level).Str("addr", c.Address).Str("network", c.Network).
Str("prefix", c.flagPrefix).Msg("grpc server stopped listening")
},
stopFunc: srv.GracefulStop,
creds: clientCreds,
}, nil
}
func (c *GRPCServerConfig) listenerAndDialer() (net.Listener, DialFunc, NetDialFunc, error) {
if c.Network == BufferedNetwork {
bl := bufconn.Listen(c.BufferSize)
return bl, func(ctx context.Context, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
opts = append(opts, grpc.WithContextDialer(func(ctx context.Context, s string) (net.Conn, error) {
return bl.DialContext(ctx)
}))
return grpc.DialContext(ctx, BufferedNetwork, opts...)
}, func(ctx context.Context, s string) (net.Conn, error) {
return bl.DialContext(ctx)
}, nil
}
l, err := net.Listen(c.Network, c.Address)
if err != nil {
return nil, nil, nil, err
}
return l, func(ctx context.Context, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
return grpc.DialContext(ctx, c.Address, opts...)
}, nil, nil
}
func (c *GRPCServerConfig) tlsOpts() ([]grpc.ServerOption, error) {
switch {
case c.TLSCertPath == "" && c.TLSKeyPath == "":
log.Warn().Str("prefix", c.flagPrefix).Msg("grpc server serving plaintext")
return nil, nil
case c.TLSCertPath != "" && c.TLSKeyPath != "":
creds, err := credentials.NewServerTLSFromFile(c.TLSCertPath, c.TLSKeyPath)
if err != nil {
return nil, err
}
return []grpc.ServerOption{grpc.Creds(creds)}, nil
default:
return nil, nil
}
}
func (c *GRPCServerConfig) clientCreds() (credentials.TransportCredentials, error) {
switch {
case c.TLSCertPath == "" && c.TLSKeyPath == "":
return insecure.NewCredentials(), nil
case c.TLSCertPath != "" && c.TLSKeyPath != "":
var err error
var pool *x509.CertPool
if c.ClientCAPath != "" {
pool, err = x509util.CustomCertPool(c.ClientCAPath)
} else {
pool, err = x509.SystemCertPool()
}
if err != nil {
return nil, err
}
return credentials.NewTLS(&tls.Config{RootCAs: pool, MinVersion: tls.VersionTLS12}), nil
default:
return nil, nil
}
}
type RunnableGRPCServer interface {
WithOpts(opts ...grpc.ServerOption) RunnableGRPCServer
Listen() error
DialContext(ctx context.Context, opts ...grpc.DialOption) (*grpc.ClientConn, error)
NetDialContext(ctx context.Context, s string) (net.Conn, error)
Insecure() bool
GracefulStop()
}
type completedGRPCServer struct {
opts []grpc.ServerOption
listener net.Listener
svcRegistrationFn func(*grpc.Server)
listenFunc func() error
prestopFunc func()
stopFunc func()
dial func(context.Context, ...grpc.DialOption) (*grpc.ClientConn, error)
netDial func(ctx context.Context, s string) (net.Conn, error)
creds credentials.TransportCredentials
}
// WithOpts adds to the options for running the server
func (c *completedGRPCServer) WithOpts(opts ...grpc.ServerOption) RunnableGRPCServer {
c.opts = append(c.opts, opts...)
srv := grpc.NewServer(c.opts...)
c.svcRegistrationFn(srv)
c.listenFunc = func() error {
return srv.Serve(c.listener)
}
c.stopFunc = srv.GracefulStop
return c
}
// Listen runs a configured server
func (c *completedGRPCServer) Listen() error {
return c.listenFunc()
}
// DialContext starts a connection to grpc server
func (c *completedGRPCServer) DialContext(ctx context.Context, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
opts = append(opts, grpc.WithTransportCredentials(c.creds))
return c.dial(ctx, opts...)
}
// NetDialContext returns a low level net.Conn connection to the server
func (c *completedGRPCServer) NetDialContext(ctx context.Context, s string) (net.Conn, error) {
return c.netDial(ctx, s)
}
// Insecure returns true if the server is configured without TLS enabled
func (c *completedGRPCServer) Insecure() bool {
return c.creds.Info().SecurityProtocol == "insecure"
}
// GracefulStop stops a running server
func (c *completedGRPCServer) GracefulStop() {
c.prestopFunc()
c.stopFunc()
}
type disabledGrpcServer struct{}
// WithOpts adds to the options for running the server
func (d *disabledGrpcServer) WithOpts(opts ...grpc.ServerOption) RunnableGRPCServer {
return d
}
// Listen runs a configured server
func (d *disabledGrpcServer) Listen() error {
return nil
}
// Insecure returns true if the server is configured without TLS enabled
func (d *disabledGrpcServer) Insecure() bool {
return true
}
// DialContext starts a connection to grpc server
func (d *disabledGrpcServer) DialContext(ctx context.Context, opts ...grpc.DialOption) (*grpc.ClientConn, error) {
return nil, nil
}
// NetDialContext starts a connection to grpc server
func (d *disabledGrpcServer) NetDialContext(ctx context.Context, s string) (net.Conn, error) {
return nil, nil
}
// GracefulStop stops a running server
func (d *disabledGrpcServer) GracefulStop() {}
type HTTPServerConfig struct {
Address string
TLSCertPath string
TLSKeyPath string
Enabled bool
flagPrefix string
}
func (c *HTTPServerConfig) Complete(level zerolog.Level, handler http.Handler) (RunnableHTTPServer, error) {
if !c.Enabled {
return &disabledHTTPServer{}, nil
}
srv := &http.Server{
Addr: c.Address,
Handler: handler,
}
var serveFunc func() error
switch {
case c.TLSCertPath == "" && c.TLSKeyPath == "":
serveFunc = func() error {
log.Warn().Str("addr", srv.Addr).Str("prefix", c.flagPrefix).Msg("http server serving plaintext")
return srv.ListenAndServe()
}
case c.TLSCertPath != "" && c.TLSKeyPath != "":
serveFunc = func() error {
log.WithLevel(level).Str("addr", srv.Addr).Str("prefix", c.flagPrefix).Msg("https server started serving")
return srv.ListenAndServeTLS(c.TLSCertPath, c.TLSKeyPath)
}
default:
return nil, fmt.Errorf("failed to start http server: must provide both --%s-tls-cert-path and --%s-tls-key-path",
c.flagPrefix,
c.flagPrefix,
)
}
return &completedHTTPServer{
srvFunc: func() error {
if err := serveFunc(); err != nil && !errors.Is(err, http.ErrServerClosed) {
return fmt.Errorf("failed while serving https: %w", err)
}
return nil
},
closeFunc: func() {
if err := srv.Close(); err != nil {
log.Warn().Str("addr", srv.Addr).Str("prefix", c.flagPrefix).Err(err).Msg("error stopping http server")
}
log.WithLevel(level).Str("addr", srv.Addr).Str("prefix", c.flagPrefix).Msg("http server stopped serving")
},
enabled: c.Enabled,
}, nil
}
type RunnableHTTPServer interface {
ListenAndServe() error
Close()
}
type completedHTTPServer struct {
srvFunc func() error
closeFunc func()
enabled bool
}
func (c *completedHTTPServer) ListenAndServe() error {
if !c.enabled {
return nil
}
return c.srvFunc()
}
func (c *completedHTTPServer) Close() {
c.closeFunc()
}
// RegisterHTTPServerFlags adds the following flags for use with
// HttpServerFromFlags:
// - "$PREFIX-addr"
// - "$PREFIX-tls-cert-path"
// - "$PREFIX-tls-key-path"
// - "$PREFIX-enabled"
func RegisterHTTPServerFlags(flags *pflag.FlagSet, config *HTTPServerConfig, flagPrefix, serviceName, defaultAddr string, defaultEnabled bool) {
flagPrefix = stringz.DefaultEmpty(flagPrefix, "http")
serviceName = stringz.DefaultEmpty(serviceName, "http")
defaultAddr = stringz.DefaultEmpty(defaultAddr, ":8443")
config.flagPrefix = flagPrefix
flags.StringVar(&config.Address, flagPrefix+"-addr", defaultAddr, "address to listen on to serve "+serviceName)
flags.StringVar(&config.TLSCertPath, flagPrefix+"-tls-cert-path", "", "local path to the TLS certificate used to serve "+serviceName)
flags.StringVar(&config.TLSKeyPath, flagPrefix+"-tls-key-path", "", "local path to the TLS key used to serve "+serviceName)
flags.BoolVar(&config.Enabled, flagPrefix+"-enabled", defaultEnabled, "enable "+serviceName+" http server")
}
type disabledHTTPServer struct{}
func (d *disabledHTTPServer) ListenAndServe() error {
return nil
}
func (d *disabledHTTPServer) Close() {}