-
Notifications
You must be signed in to change notification settings - Fork 1.7k
/
ocr2_keys_commands.go
288 lines (250 loc) · 7.71 KB
/
ocr2_keys_commands.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
package cmd
import (
"bytes"
"fmt"
"io"
"net/http"
"os"
"github.com/pkg/errors"
"github.com/urfave/cli"
"go.uber.org/multierr"
cutils "github.com/smartcontractkit/chainlink-common/pkg/utils"
"github.com/smartcontractkit/chainlink/v2/core/services/keystore/chaintype"
"github.com/smartcontractkit/chainlink/v2/core/store/models"
"github.com/smartcontractkit/chainlink/v2/core/utils"
"github.com/smartcontractkit/chainlink/v2/core/web/presenters"
)
func initOCR2KeysSubCmd(s *Shell) cli.Command {
return cli.Command{
Name: "ocr2",
Usage: "Remote commands for administering the node's off chain reporting keys",
Subcommands: cli.Commands{
{
Name: "create",
Usage: format(`Create an OCR2 key bundle, encrypted with password from the password file, and store it in the database`),
Action: s.CreateOCR2KeyBundle,
},
{
Name: "delete",
Usage: format(`Deletes the encrypted OCR2 key bundle matching the given ID`),
Flags: []cli.Flag{
cli.BoolFlag{
Name: "yes, y",
Usage: "skip the confirmation prompt",
},
cli.BoolFlag{
Name: "hard",
Usage: "hard-delete the key instead of archiving (irreversible!)",
},
},
Action: s.DeleteOCR2KeyBundle,
},
{
Name: "list",
Usage: format(`List available OCR2 key bundles`),
Action: s.ListOCR2KeyBundles,
},
{
Name: "import",
Usage: format(`Imports an OCR2 key bundle from a JSON file`),
Flags: []cli.Flag{
cli.StringFlag{
Name: "old-password, oldpassword, p",
Usage: "`FILE` containing the password used to encrypt the key in the JSON file",
},
},
Action: s.ImportOCR2Key,
},
{
Name: "export",
Usage: format(`Exports an OCR2 key bundle to a JSON file`),
Flags: []cli.Flag{
cli.StringFlag{
Name: "new-password, newpassword, p",
Usage: "`FILE` containing the password to encrypt the key (required)",
},
cli.StringFlag{
Name: "output, o",
Usage: "`FILE` where the JSON file will be saved (required)",
},
},
Action: s.ExportOCR2Key,
},
},
}
}
type OCR2KeyBundlePresenter struct {
JAID // Include this to overwrite the presenter JAID so it can correctly render the ID in JSON
presenters.OCR2KeysBundleResource
}
// RenderTable implements TableRenderer
func (p *OCR2KeyBundlePresenter) RenderTable(rt RendererTable) error {
headers := []string{"ID", "Type", "On-chain pubkey", "Off-chain pubkey", "Config pubkey"}
rows := [][]string{p.ToRow()}
if _, err := rt.Write([]byte("🔑 OCR Keys\n")); err != nil {
return err
}
renderList(headers, rows, rt.Writer)
return cutils.JustError(rt.Write([]byte("\n")))
}
func (p *OCR2KeyBundlePresenter) ToRow() []string {
return []string{
p.ID,
p.ChainType,
p.OnchainPublicKey,
p.OffChainPublicKey,
p.ConfigPublicKey,
}
}
type OCR2KeyBundlePresenters []OCR2KeyBundlePresenter
// RenderTable implements TableRenderer
func (ps OCR2KeyBundlePresenters) RenderTable(rt RendererTable) error {
headers := []string{"ID", "Type", "On-chain pubkey", "Off-chain pubkey", "Config pubkey"}
rows := [][]string{}
for _, p := range ps {
rows = append(rows, p.ToRow())
}
if _, err := rt.Write([]byte("🔑 OCR Keys\n")); err != nil {
return err
}
renderList(headers, rows, rt.Writer)
return cutils.JustError(rt.Write([]byte("\n")))
}
// ListOCR2KeyBundles lists the available OCR2 Key Bundles
func (s *Shell) ListOCR2KeyBundles(_ *cli.Context) error {
resp, err := s.HTTP.Get(s.ctx(), "/v2/keys/ocr2", nil)
if err != nil {
return s.errorOut(err)
}
defer func() {
if cerr := resp.Body.Close(); cerr != nil {
err = multierr.Append(err, cerr)
}
}()
var presenters OCR2KeyBundlePresenters
return s.renderAPIResponse(resp, &presenters)
}
// CreateOCR2KeyBundle creates an OCR2 key bundle and saves it to the keystore
func (s *Shell) CreateOCR2KeyBundle(c *cli.Context) error {
if !c.Args().Present() {
return s.errorOut(
errors.Errorf(`must pass the type to create, options are: %s`, chaintype.SupportedChainTypes.String()),
)
}
chainType := c.Args().Get(0)
resp, err := s.HTTP.Post(s.ctx(), fmt.Sprintf("/v2/keys/ocr2/%s", chainType), nil)
if err != nil {
return s.errorOut(err)
}
defer func() {
if cerr := resp.Body.Close(); cerr != nil {
err = multierr.Append(err, cerr)
}
}()
var presenter OCR2KeyBundlePresenter
return s.renderAPIResponse(resp, &presenter, "Created OCR key bundle")
}
// DeleteOCR2KeyBundle deletes an OCR2 key bundle
func (s *Shell) DeleteOCR2KeyBundle(c *cli.Context) error {
if !c.Args().Present() {
return s.errorOut(errors.New("Must pass the key ID to be deleted"))
}
id, err := models.Sha256HashFromHex(c.Args().Get(0))
if err != nil {
return s.errorOut(err)
}
if !confirmAction(c) {
return nil
}
var queryStr string
if c.Bool("hard") {
queryStr = "?hard=true"
}
resp, err := s.HTTP.Delete(s.ctx(), fmt.Sprintf("/v2/keys/ocr2/%s%s", id, queryStr))
if err != nil {
return s.errorOut(err)
}
defer func() {
if cerr := resp.Body.Close(); cerr != nil {
err = multierr.Append(err, cerr)
}
}()
var presenter OCR2KeyBundlePresenter
return s.renderAPIResponse(resp, &presenter, "OCR key bundle deleted")
}
// ImportOCR2Key imports OCR2 key bundle
func (s *Shell) ImportOCR2Key(c *cli.Context) (err error) {
if !c.Args().Present() {
return s.errorOut(errors.New("Must pass the filepath of the key to be imported"))
}
oldPasswordFile := c.String("old-password")
if len(oldPasswordFile) == 0 {
return s.errorOut(errors.New("Must specify --old-password/-p flag"))
}
oldPassword, err := os.ReadFile(oldPasswordFile)
if err != nil {
return s.errorOut(errors.Wrap(err, "Could not read password file"))
}
filepath := c.Args().Get(0)
keyJSON, err := os.ReadFile(filepath)
if err != nil {
return s.errorOut(err)
}
normalizedPassword := normalizePassword(string(oldPassword))
resp, err := s.HTTP.Post(s.ctx(), "/v2/keys/ocr2/import?oldpassword="+normalizedPassword, bytes.NewReader(keyJSON))
if err != nil {
return s.errorOut(err)
}
defer func() {
if cerr := resp.Body.Close(); cerr != nil {
err = multierr.Append(err, cerr)
}
}()
var presenter OCR2KeyBundlePresenter
return s.renderAPIResponse(resp, &presenter, "Imported OCR key bundle")
}
// ExportOCR2Key exports an OCR2 key bundle by ID
func (s *Shell) ExportOCR2Key(c *cli.Context) (err error) {
if !c.Args().Present() {
return s.errorOut(errors.New("Must pass the ID of the key to export"))
}
newPasswordFile := c.String("new-password")
if len(newPasswordFile) == 0 {
return s.errorOut(errors.New("Must specify --new-password/-p flag"))
}
newPassword, err := os.ReadFile(newPasswordFile)
if err != nil {
return s.errorOut(errors.Wrap(err, "Could not read password file"))
}
filepath := c.String("output")
if len(filepath) == 0 {
return s.errorOut(errors.New("Must specify --output/-o flag"))
}
ID := c.Args().Get(0)
normalizedPassword := normalizePassword(string(newPassword))
resp, err := s.HTTP.Post(s.ctx(), "/v2/keys/ocr2/export/"+ID+"?newpassword="+normalizedPassword, nil)
if err != nil {
return s.errorOut(errors.Wrap(err, "Could not make HTTP request"))
}
defer func() {
if cerr := resp.Body.Close(); cerr != nil {
err = multierr.Append(err, cerr)
}
}()
if resp.StatusCode != http.StatusOK {
return s.errorOut(fmt.Errorf("error exporting: %w", httpError(resp)))
}
keyJSON, err := io.ReadAll(resp.Body)
if err != nil {
return s.errorOut(errors.Wrap(err, "Could not read response body"))
}
err = utils.WriteFileWithMaxPerms(filepath, keyJSON, 0o600)
if err != nil {
return s.errorOut(errors.Wrapf(err, "Could not write %v", filepath))
}
_, err = os.Stderr.WriteString(fmt.Sprintf("Exported OCR key bundle %s to %s", ID, filepath))
if err != nil {
return s.errorOut(err)
}
return nil
}