forked from open-policy-agent/opa
-
Notifications
You must be signed in to change notification settings - Fork 0
/
run.go
331 lines (266 loc) · 12.3 KB
/
run.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
// Copyright 2016 The OPA Authors. All rights reserved.
// Use of this source code is governed by an Apache2
// license that can be found in the LICENSE file.
package cmd
import (
"context"
"crypto/tls"
"crypto/x509"
"fmt"
"io/ioutil"
"os"
"path"
"time"
"github.com/spf13/cobra"
"github.com/open-policy-agent/opa/runtime"
"github.com/open-policy-agent/opa/server"
"github.com/open-policy-agent/opa/util"
)
const (
defaultAddr = ":8181" // default listening address for server
defaultHistoryFile = ".opa_history" // default filename for shell history
)
type runCmdParams struct {
rt runtime.Params
tlsCertFile string
tlsPrivateKeyFile string
tlsCACertFile string
tlsCertRefresh time.Duration
ignore []string
serverMode bool
skipVersionCheck bool
authentication *util.EnumFlag
authorization *util.EnumFlag
minTLSVersion *util.EnumFlag
logLevel *util.EnumFlag
logFormat *util.EnumFlag
algorithm string
scope string
pubKey string
pubKeyID string
skipBundleVerify bool
excludeVerifyFiles []string
}
func newRunParams() runCmdParams {
return runCmdParams{
rt: runtime.NewParams(),
authentication: util.NewEnumFlag("off", []string{"token", "tls", "off"}),
authorization: util.NewEnumFlag("off", []string{"basic", "off"}),
minTLSVersion: util.NewEnumFlag("1.2", []string{"1.0", "1.1", "1.2", "1.3"}),
logLevel: util.NewEnumFlag("info", []string{"debug", "info", "error"}),
logFormat: util.NewEnumFlag("json", []string{"text", "json", "json-pretty"}),
}
}
func init() {
cmdParams := newRunParams()
runCommand := &cobra.Command{
Use: "run",
Short: "Start OPA in interactive or server mode",
Long: `Start an instance of the Open Policy Agent (OPA).
To run the interactive shell:
$ opa run
To run the server:
$ opa run -s
The 'run' command starts an instance of the OPA runtime. The OPA runtime can be
started as an interactive shell or a server.
When the runtime is started as a shell, users can define rules and evaluate
expressions interactively. When the runtime is started as a server, OPA exposes
an HTTP API for managing policies, reading and writing data, and executing
queries.
The runtime can be initialized with one or more files that contain policies or
data. If the '--bundle' option is specified the paths will be treated as policy
bundles and loaded following standard bundle conventions. The path can be a
compressed archive file or a directory which will be treated as a bundle.
Without the '--bundle' flag OPA will recursively load ALL rego, JSON, and YAML
files.
When loading from directories, only files with known extensions are considered.
The current set of file extensions that OPA will consider are:
.json # JSON data
.yaml or .yml # YAML data
.rego # Rego file
Non-bundle data file and directory paths can be prefixed with the desired
destination in the data document with the following syntax:
<dotted-path>:<file-path>
To set a data file as the input document in the interactive shell use the
"repl.input" path prefix with the input file:
repl.input:<file-path>
Example:
$ opa run repl.input:input.json
Which will load the "input.json" file at path "data.repl.input".
Use the "help input" command in the interactive shell to see more options.
File paths can be specified as URLs to resolve ambiguity in paths containing colons:
$ opa run file:///c:/path/to/data.json
The 'run' command can also verify the signature of a signed bundle.
A signed bundle is a normal OPA bundle that includes a file
named ".signatures.json". For more information on signed bundles
see https://www.openpolicyagent.org/docs/latest/management-bundles/#signing.
The key to verify the signature of signed bundle can be provided
using the --verification-key flag. For example, for RSA family of algorithms,
the command expects a PEM file containing the public key.
For HMAC family of algorithms (eg. HS256), the secret can be provided
using the --verification-key flag.
The --verification-key-id flag can be used to optionally specify a name for the
key provided using the --verification-key flag.
The --signing-alg flag can be used to specify the signing algorithm.
The 'run' command uses RS256 (by default) as the signing algorithm.
The --scope flag can be used to specify the scope to use for
bundle signature verification.
Example:
$ opa run --verification-key secret --signing-alg HS256 --bundle bundle.tar.gz
The 'run' command will read the bundle "bundle.tar.gz", check the
".signatures.json" file and perform verification using the provided key.
An error will be generated if "bundle.tar.gz" does not contain a ".signatures.json" file.
For more information on the bundle verification process see
https://www.openpolicyagent.org/docs/latest/management-bundles/#signature-verification.
The 'run' command can ONLY be used with the --bundle flag to verify signatures
for existing bundle files or directories following the bundle structure.
To skip bundle verification, use the --skip-verify flag.
`,
Run: func(cmd *cobra.Command, args []string) {
ctx := context.Background()
rt, err := initRuntime(ctx, cmdParams, args)
if err != nil {
fmt.Println("error:", err)
os.Exit(1)
}
startRuntime(ctx, rt, cmdParams.serverMode)
},
}
addConfigFileFlag(runCommand.Flags(), &cmdParams.rt.ConfigFile)
runCommand.Flags().BoolVarP(&cmdParams.serverMode, "server", "s", false, "start the runtime in server mode")
runCommand.Flags().IntVar(&cmdParams.rt.ReadyTimeout, "ready-timeout", 0, "wait (in seconds) for configured plugins before starting server (value <= 0 disables ready check)")
runCommand.Flags().StringVarP(&cmdParams.rt.HistoryPath, "history", "H", historyPath(), "set path of history file")
cmdParams.rt.Addrs = runCommand.Flags().StringSliceP("addr", "a", []string{defaultAddr}, "set listening address of the server (e.g., [ip]:<port> for TCP, unix://<path> for UNIX domain socket)")
cmdParams.rt.DiagnosticAddrs = runCommand.Flags().StringSlice("diagnostic-addr", []string{}, "set read-only diagnostic listening address of the server for /health and /metric APIs (e.g., [ip]:<port> for TCP, unix://<path> for UNIX domain socket)")
runCommand.Flags().BoolVar(&cmdParams.rt.H2CEnabled, "h2c", false, "enable H2C for HTTP listeners")
runCommand.Flags().StringVarP(&cmdParams.rt.OutputFormat, "format", "f", "pretty", "set shell output format, i.e, pretty, json")
runCommand.Flags().BoolVarP(&cmdParams.rt.Watch, "watch", "w", false, "watch command line files for changes")
addMaxErrorsFlag(runCommand.Flags(), &cmdParams.rt.ErrorLimit)
runCommand.Flags().BoolVar(&cmdParams.rt.PprofEnabled, "pprof", false, "enables pprof endpoints")
runCommand.Flags().StringVar(&cmdParams.tlsCertFile, "tls-cert-file", "", "set path of TLS certificate file")
runCommand.Flags().StringVar(&cmdParams.tlsPrivateKeyFile, "tls-private-key-file", "", "set path of TLS private key file")
runCommand.Flags().StringVar(&cmdParams.tlsCACertFile, "tls-ca-cert-file", "", "set path of TLS CA cert file")
runCommand.Flags().DurationVar(&cmdParams.tlsCertRefresh, "tls-cert-refresh-period", 0, "set certificate refresh period")
runCommand.Flags().Var(cmdParams.authentication, "authentication", "set authentication scheme")
runCommand.Flags().Var(cmdParams.authorization, "authorization", "set authorization scheme")
runCommand.Flags().Var(cmdParams.minTLSVersion, "min-tls-version", "set minimum TLS version to be used by OPA's server")
runCommand.Flags().VarP(cmdParams.logLevel, "log-level", "l", "set log level")
runCommand.Flags().Var(cmdParams.logFormat, "log-format", "set log format")
runCommand.Flags().IntVar(&cmdParams.rt.GracefulShutdownPeriod, "shutdown-grace-period", 10, "set the time (in seconds) that the server will wait to gracefully shut down")
runCommand.Flags().IntVar(&cmdParams.rt.ShutdownWaitPeriod, "shutdown-wait-period", 0, "set the time (in seconds) that the server will wait before initiating shutdown")
addConfigOverrides(runCommand.Flags(), &cmdParams.rt.ConfigOverrides)
addConfigOverrideFiles(runCommand.Flags(), &cmdParams.rt.ConfigOverrideFiles)
addBundleModeFlag(runCommand.Flags(), &cmdParams.rt.BundleMode, false)
runCommand.Flags().BoolVar(&cmdParams.skipVersionCheck, "skip-version-check", false, "disables anonymous version reporting (see: https://www.openpolicyagent.org/docs/latest/privacy)")
addIgnoreFlag(runCommand.Flags(), &cmdParams.ignore)
// bundle verification config
addVerificationKeyFlag(runCommand.Flags(), &cmdParams.pubKey)
addVerificationKeyIDFlag(runCommand.Flags(), &cmdParams.pubKeyID, defaultPublicKeyID)
addSigningAlgFlag(runCommand.Flags(), &cmdParams.algorithm, defaultTokenSigningAlg)
addBundleVerificationScopeFlag(runCommand.Flags(), &cmdParams.scope)
addBundleVerificationSkipFlag(runCommand.Flags(), &cmdParams.skipBundleVerify, false)
addBundleVerificationExcludeFilesFlag(runCommand.Flags(), &cmdParams.excludeVerifyFiles)
usageTemplate := `Usage:
{{.UseLine}} [files]
Flags:
{{.LocalFlags.FlagUsages | trimRightSpace}}
`
runCommand.SetUsageTemplate(usageTemplate)
RootCommand.AddCommand(runCommand)
}
func initRuntime(ctx context.Context, params runCmdParams, args []string) (*runtime.Runtime, error) {
authenticationSchemes := map[string]server.AuthenticationScheme{
"token": server.AuthenticationToken,
"tls": server.AuthenticationTLS,
"off": server.AuthenticationOff,
}
authorizationScheme := map[string]server.AuthorizationScheme{
"basic": server.AuthorizationBasic,
"off": server.AuthorizationOff,
}
minTLSVersions := map[string]uint16{
"1.0": tls.VersionTLS10,
"1.1": tls.VersionTLS11,
"1.2": tls.VersionTLS12,
"1.3": tls.VersionTLS13,
}
cert, err := loadCertificate(params.tlsCertFile, params.tlsPrivateKeyFile)
if err != nil {
return nil, err
}
params.rt.CertificateFile = params.tlsCertFile
params.rt.CertificateKeyFile = params.tlsPrivateKeyFile
params.rt.CertificateRefresh = params.tlsCertRefresh
if params.tlsCACertFile != "" {
pool, err := loadCertPool(params.tlsCACertFile)
if err != nil {
return nil, err
}
params.rt.CertPool = pool
}
params.rt.Authentication = authenticationSchemes[params.authentication.String()]
params.rt.Authorization = authorizationScheme[params.authorization.String()]
params.rt.MinTLSVersion = minTLSVersions[params.minTLSVersion.String()]
params.rt.Certificate = cert
params.rt.Logging = runtime.LoggingConfig{
Level: params.logLevel.String(),
Format: params.logFormat.String(),
}
params.rt.Paths = args
params.rt.Filter = loaderFilter{
Ignore: params.ignore,
}.Apply
params.rt.EnableVersionCheck = !params.skipVersionCheck
params.rt.SkipBundleVerification = params.skipBundleVerify
bvc, err := buildVerificationConfig(params.pubKey, params.pubKeyID, params.algorithm, params.scope, params.excludeVerifyFiles)
if err != nil {
return nil, err
}
params.rt.BundleVerificationConfig = bvc
if params.rt.BundleVerificationConfig != nil && !params.rt.BundleMode {
return nil, fmt.Errorf("enable bundle mode (ie. --bundle) to verify bundle files or directories")
}
rt, err := runtime.NewRuntime(ctx, params.rt)
if err != nil {
return nil, err
}
rt.SetDistributedTracingLogging()
return rt, nil
}
func startRuntime(ctx context.Context, rt *runtime.Runtime, serverMode bool) {
if serverMode {
rt.StartServer(ctx)
} else {
rt.StartREPL(ctx)
}
}
func historyPath() string {
home := os.Getenv("HOME")
if len(home) == 0 {
return defaultHistoryFile
}
return path.Join(home, defaultHistoryFile)
}
func loadCertificate(tlsCertFile, tlsPrivateKeyFile string) (*tls.Certificate, error) {
if tlsCertFile != "" && tlsPrivateKeyFile != "" {
cert, err := tls.LoadX509KeyPair(tlsCertFile, tlsPrivateKeyFile)
if err != nil {
return nil, err
}
return &cert, nil
} else if tlsCertFile != "" || tlsPrivateKeyFile != "" {
return nil, fmt.Errorf("--tls-cert-file and --tls-private-key-file must be specified together")
}
return nil, nil
}
func loadCertPool(tlsCACertFile string) (*x509.CertPool, error) {
caCertPEM, err := ioutil.ReadFile(tlsCACertFile)
if err != nil {
return nil, fmt.Errorf("read CA cert file: %v", err)
}
pool := x509.NewCertPool()
if ok := pool.AppendCertsFromPEM(caCertPEM); !ok {
return nil, fmt.Errorf("failed to parse CA cert %q", tlsCACertFile)
}
return pool, nil
}