-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
validate.go
372 lines (327 loc) · 10.8 KB
/
validate.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
package validate
import (
"context"
"encoding/hex"
"encoding/json"
"errors"
"fmt"
"os/exec"
"github.com/lib/pq"
"github.com/pelletier/go-toml"
pkgerrors "github.com/pkg/errors"
libocr2 "github.com/smartcontractkit/libocr/offchainreporting2plus"
"github.com/smartcontractkit/chainlink-common/pkg/logger"
"github.com/smartcontractkit/chainlink-common/pkg/loop/reportingplugins"
"github.com/smartcontractkit/chainlink-common/pkg/types"
"github.com/smartcontractkit/chainlink/v2/core/config/env"
"github.com/smartcontractkit/chainlink/v2/core/services/job"
dkgconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/dkg/config"
lloconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/llo/config"
mercuryconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/mercury/config"
ocr2vrfconfig "github.com/smartcontractkit/chainlink/v2/core/services/ocr2/plugins/ocr2vrf/config"
"github.com/smartcontractkit/chainlink/v2/core/services/ocrcommon"
"github.com/smartcontractkit/chainlink/v2/plugins"
)
// ValidatedOracleSpecToml validates an oracle spec that came from TOML
func ValidatedOracleSpecToml(ctx context.Context, config OCR2Config, insConf InsecureConfig, tomlString string, rc plugins.RegistrarConfig) (job.Job, error) {
var jb = job.Job{}
var spec job.OCR2OracleSpec
tree, err := toml.Load(tomlString)
if err != nil {
return jb, pkgerrors.Wrap(err, "toml error on load")
}
// Note this validates all the fields which implement an UnmarshalText
// i.e. TransmitterAddress, PeerID...
err = tree.Unmarshal(&spec)
if err != nil {
return jb, pkgerrors.Wrap(err, "toml unmarshal error on spec")
}
err = tree.Unmarshal(&jb)
if err != nil {
return jb, pkgerrors.Wrap(err, "toml unmarshal error on job")
}
jb.OCR2OracleSpec = &spec
if jb.OCR2OracleSpec.P2PV2Bootstrappers == nil {
// Empty but non-null, field is non-nullable.
jb.OCR2OracleSpec.P2PV2Bootstrappers = pq.StringArray{}
}
if jb.Type != job.OffchainReporting2 {
return jb, pkgerrors.Errorf("the only supported type is currently 'offchainreporting2', got %s", jb.Type)
}
if _, ok := types.SupportedRelays[spec.Relay]; !ok {
return jb, pkgerrors.Errorf("no such relay %v supported", spec.Relay)
}
if len(spec.P2PV2Bootstrappers) > 0 {
_, err = ocrcommon.ParseBootstrapPeers(spec.P2PV2Bootstrappers)
if err != nil {
return jb, err
}
}
if err = validateSpec(ctx, tree, jb, rc); err != nil {
return jb, err
}
if err = validateTimingParameters(config, insConf, spec); err != nil {
return jb, err
}
return jb, nil
}
// Parameters that must be explicitly set by the operator.
var (
params = map[string]struct{}{
"type": {},
"schemaVersion": {},
"contractID": {},
"relay": {},
"relayConfig": {},
"pluginType": {},
"pluginConfig": {},
}
notExpectedParams = map[string]struct{}{
"isBootstrapPeer": {},
"juelsPerFeeCoinSource": {},
}
)
func validateTimingParameters(ocr2Conf OCR2Config, insConf InsecureConfig, spec job.OCR2OracleSpec) error {
lc, err := ToLocalConfig(ocr2Conf, insConf, spec)
if err != nil {
return err
}
return libocr2.SanityCheckLocalConfig(lc)
}
func validateSpec(ctx context.Context, tree *toml.Tree, spec job.Job, rc plugins.RegistrarConfig) error {
expected, notExpected := ocrcommon.CloneSet(params), ocrcommon.CloneSet(notExpectedParams)
if err := ocrcommon.ValidateExplicitlySetKeys(tree, expected, notExpected, "ocr2"); err != nil {
return err
}
switch spec.OCR2OracleSpec.PluginType {
case types.Median:
if spec.Pipeline.Source == "" {
return errors.New("no pipeline specified")
}
case types.DKG:
return validateDKGSpec(spec.OCR2OracleSpec.PluginConfig)
case types.OCR2VRF:
return validateOCR2VRFSpec(spec.OCR2OracleSpec.PluginConfig)
case types.OCR2Keeper:
return validateOCR2KeeperSpec(spec.OCR2OracleSpec.PluginConfig)
case types.Functions:
// TODO validator for DR-OCR spec: https://app.shortcut.com/chainlinklabs/story/54054/ocr-plugin-for-directrequest-ocr
return nil
case types.Mercury:
return validateOCR2MercurySpec(spec.OCR2OracleSpec.PluginConfig, *spec.OCR2OracleSpec.FeedID)
case types.LLO:
return validateOCR2LLOSpec(spec.OCR2OracleSpec.PluginConfig)
case types.GenericPlugin:
return validateGenericPluginSpec(ctx, spec.OCR2OracleSpec, rc)
case "":
return errors.New("no plugin specified")
default:
return pkgerrors.Errorf("invalid pluginType %s", spec.OCR2OracleSpec.PluginType)
}
return nil
}
type PipelineSpec struct {
Name string `json:"name"`
Spec string `json:"spec"`
}
type Config struct {
Pipelines []PipelineSpec `json:"pipelines"`
PluginConfig map[string]any `json:"pluginConfig"`
}
type innerConfig struct {
Command string `json:"command"`
EnvVars map[string]string `json:"envVars"`
ProviderType string `json:"providerType"`
PluginName string `json:"pluginName"`
TelemetryType string `json:"telemetryType"`
OCRVersion int `json:"OCRVersion"`
Config
}
type OCR2GenericPluginConfig struct {
innerConfig
}
func (o *OCR2GenericPluginConfig) UnmarshalJSON(data []byte) error {
err := json.Unmarshal(data, &o.innerConfig)
if err != nil {
return nil
}
m := map[string]any{}
err = json.Unmarshal(data, &m)
if err != nil {
return err
}
o.PluginConfig = m
return nil
}
type onchainSigningStrategyInner struct {
StrategyName string `json:"strategyName"`
Config job.JSONConfig `json:"config"`
}
type OCR2OnchainSigningStrategy struct {
onchainSigningStrategyInner
}
func (o *OCR2OnchainSigningStrategy) UnmarshalJSON(data []byte) error {
err := json.Unmarshal(data, &o.onchainSigningStrategyInner)
if err != nil {
return err
}
return nil
}
func (o *OCR2OnchainSigningStrategy) IsMultiChain() bool {
return o.StrategyName == "multi-chain"
}
func (o *OCR2OnchainSigningStrategy) PublicKey() (string, error) {
pk, ok := o.Config["publicKey"]
if !ok {
return "", nil
}
name, ok := pk.(string)
if !ok {
return "", fmt.Errorf("expected string publicKey value, but got: %T", pk)
}
return name, nil
}
func validateGenericPluginSpec(ctx context.Context, spec *job.OCR2OracleSpec, rc plugins.RegistrarConfig) error {
p := OCR2GenericPluginConfig{}
err := json.Unmarshal(spec.PluginConfig.Bytes(), &p)
if err != nil {
return err
}
if p.PluginName == "" {
return errors.New("generic config invalid: must provide plugin name")
}
if p.OCRVersion != 2 && p.OCRVersion != 3 {
return errors.New("generic config invalid: only OCR version 2 and 3 are supported")
}
onchainSigningStrategy := OCR2OnchainSigningStrategy{}
err = json.Unmarshal(spec.OnchainSigningStrategy.Bytes(), &onchainSigningStrategy)
if err != nil {
return err
}
pk, err := onchainSigningStrategy.PublicKey()
if err != nil {
return err
}
if pk == "" {
return errors.New("generic config invalid: must provide public key for the onchain signing strategy")
}
plugEnv := env.NewPlugin(p.PluginName)
command := p.Command
if command == "" {
command = plugEnv.Cmd.Get()
}
if command == "" {
return errors.New("generic config invalid: no command found")
}
_, err = exec.LookPath(command)
if err != nil {
return fmt.Errorf("failed to find binary %q", command)
}
envVars, err := plugins.ParseEnvFile(plugEnv.Env.Get())
if err != nil {
return fmt.Errorf("failed to parse env file: %w", err)
}
if len(p.EnvVars) > 0 {
for k, v := range p.EnvVars {
envVars = append(envVars, k+"="+v)
}
}
loopID := fmt.Sprintf("%s-%s-%s", p.PluginName, spec.ContractID, spec.GetID())
//Starting and stopping a LOOPP isn't efficient; ideally, we'd initiate the LOOPP once and then reference
//it later to conserve resources. This code will be revisited once BCF-3126 is implemented, and we have
//the ability to reference the LOOPP for future use.
cmdFn, grpcOpts, err := rc.RegisterLOOP(plugins.CmdConfig{
ID: loopID,
Cmd: command,
Env: envVars,
})
if err != nil {
return fmt.Errorf("failed to register loop: %w", err)
}
defer rc.UnregisterLOOP(loopID)
pluginLggr, _ := logger.New()
plugin := reportingplugins.NewLOOPPServiceValidation(pluginLggr, grpcOpts, cmdFn)
err = plugin.Start(ctx)
if err != nil {
return err
}
defer plugin.Close()
return plugin.ValidateConfig(ctx, spec.PluginConfig)
}
func validateDKGSpec(jsonConfig job.JSONConfig) error {
if jsonConfig == nil {
return errors.New("pluginConfig is empty")
}
var pluginConfig dkgconfig.PluginConfig
err := json.Unmarshal(jsonConfig.Bytes(), &pluginConfig)
if err != nil {
return pkgerrors.Wrap(err, "error while unmarshaling plugin config")
}
err = validateHexString(pluginConfig.EncryptionPublicKey, 32)
if err != nil {
return pkgerrors.Wrap(err, "validation error for encryptedPublicKey")
}
err = validateHexString(pluginConfig.SigningPublicKey, 32)
if err != nil {
return pkgerrors.Wrap(err, "validation error for signingPublicKey")
}
err = validateHexString(pluginConfig.KeyID, 32)
if err != nil {
return pkgerrors.Wrap(err, "validation error for keyID")
}
return nil
}
func validateHexString(val string, expectedLengthInBytes uint) error {
decoded, err := hex.DecodeString(val)
if err != nil {
return pkgerrors.Wrapf(err, "expected hex string but received %s", val)
}
if len(decoded) != int(expectedLengthInBytes) {
return fmt.Errorf("value: %s has unexpected length. Expected %d bytes", val, expectedLengthInBytes)
}
return nil
}
func validateOCR2VRFSpec(jsonConfig job.JSONConfig) error {
if jsonConfig == nil {
return errors.New("pluginConfig is empty")
}
var cfg ocr2vrfconfig.PluginConfig
err := json.Unmarshal(jsonConfig.Bytes(), &cfg)
if err != nil {
return pkgerrors.Wrap(err, "json unmarshal plugin config")
}
err = validateDKGSpec(job.JSONConfig{
"encryptionPublicKey": cfg.DKGEncryptionPublicKey,
"signingPublicKey": cfg.DKGSigningPublicKey,
"keyID": cfg.DKGKeyID,
})
if err != nil {
return err
}
if cfg.LinkEthFeedAddress == "" {
return errors.New("linkEthFeedAddress must be provided")
}
if cfg.DKGContractAddress == "" {
return errors.New("dkgContractAddress must be provided")
}
return nil
}
func validateOCR2KeeperSpec(jsonConfig job.JSONConfig) error {
return nil
}
func validateOCR2MercurySpec(jsonConfig job.JSONConfig, feedId [32]byte) error {
var pluginConfig mercuryconfig.PluginConfig
err := json.Unmarshal(jsonConfig.Bytes(), &pluginConfig)
if err != nil {
return pkgerrors.Wrap(err, "error while unmarshaling plugin config")
}
return pkgerrors.Wrap(mercuryconfig.ValidatePluginConfig(pluginConfig, feedId), "Mercury PluginConfig is invalid")
}
func validateOCR2LLOSpec(jsonConfig job.JSONConfig) error {
var pluginConfig lloconfig.PluginConfig
err := json.Unmarshal(jsonConfig.Bytes(), &pluginConfig)
if err != nil {
return pkgerrors.Wrap(err, "error while unmarshaling plugin config")
}
return pkgerrors.Wrap(pluginConfig.Validate(), "LLO PluginConfig is invalid")
}