-
Notifications
You must be signed in to change notification settings - Fork 10
/
lcp.go
373 lines (329 loc) · 11 KB
/
lcp.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
package relay
import (
"context"
"encoding/json"
"errors"
"fmt"
"log"
"os"
"path/filepath"
"time"
sdk "github.com/cosmos/cosmos-sdk/types"
clienttypes "github.com/cosmos/ibc-go/v7/modules/core/02-client/types"
ibcexported "github.com/cosmos/ibc-go/v7/modules/core/exported"
lcptypes "github.com/datachainlab/lcp/go/light-clients/lcp/types"
"github.com/datachainlab/lcp/go/relay/elc"
"github.com/datachainlab/lcp/go/relay/enclave"
"github.com/datachainlab/lcp/go/sgx/ias"
mapset "github.com/deckarep/golang-set/v2"
"github.com/hyperledger-labs/yui-relayer/core"
oias "github.com/oasisprotocol/oasis-core/go/common/sgx/ias"
)
const lastEnclaveKeyInfoFile = "last_eki"
var ErrLastEnclaveKeyInfoNotFound = errors.New("last enclave key info not found")
func (pr *Prover) loadLastEnclaveKey(ctx context.Context) (*enclave.EnclaveKeyInfo, error) {
path, err := pr.lastEnclaveKeyInfoFilePath()
if err != nil {
return nil, err
}
bz, err := os.ReadFile(path)
if err != nil {
if os.IsNotExist(err) {
return nil, fmt.Errorf("%v not found: %w", path, ErrLastEnclaveKeyInfoNotFound)
}
return nil, err
}
var eki enclave.EnclaveKeyInfo
if err := json.Unmarshal(bz, &eki); err != nil {
return nil, err
}
return &eki, nil
}
func (pr *Prover) saveLastEnclaveKey(ctx context.Context, eki *enclave.EnclaveKeyInfo) error {
path, err := pr.lastEnclaveKeyInfoFilePath()
if err != nil {
return err
}
f, err := os.CreateTemp(os.TempDir(), lastEnclaveKeyInfoFile)
if err != nil {
return err
}
defer f.Close()
bz, err := json.Marshal(eki)
if err != nil {
return err
}
if _, err := f.Write(bz); err != nil {
return err
}
if err := os.Rename(f.Name(), path); err != nil {
return err
}
return nil
}
func (pr *Prover) lastEnclaveKeyInfoFilePath() (string, error) {
path := filepath.Join(pr.homePath, "lcp", pr.originChain.ChainID())
if err := os.MkdirAll(path, os.ModePerm); err != nil {
return "", err
}
return filepath.Join(path, lastEnclaveKeyInfoFile), nil
}
// checkUpdateNeeded checks if the enclave key needs to be updated
// if the enclave key is missing or expired, it returns true
func (pr *Prover) checkUpdateNeeded(ctx context.Context, timestamp time.Time, eki *enclave.EnclaveKeyInfo) bool {
attestationTime := time.Unix(int64(eki.AttestationTime), 0)
// TODO consider appropriate buffer time
// For now, a half of expiration is used as a buffer time
if timestamp.After(attestationTime.Add(time.Duration(pr.config.KeyExpiration) * time.Second / 2)) {
return true
}
// check if the enclave key is still available in the LCP service
_, err := pr.lcpServiceClient.EnclaveKey(ctx, &enclave.QueryEnclaveKeyRequest{EnclaveKeyAddress: eki.EnclaveKeyAddress})
if err != nil {
log.Printf("checkUpdateNeeded: enclave key '%x' not found: error=%v", eki.EnclaveKeyAddress, err)
return true
}
return false
}
// ensureAvailableEnclaveKeyExists ensures that the active enclave key exists
// otherwise it tries to get a new enclave key
func (pr *Prover) ensureAvailableEnclaveKeyExists(ctx context.Context) error {
updated, err := pr.updateActiveEnclaveKeyIfNeeded(ctx)
if err != nil {
return err
}
log.Printf("updateActiveEnclaveKeyIfNeeded: updated=%v", updated)
return nil
}
// updateActiveEnclaveKeyIfNeeded updates a key if key is missing or expired
func (pr *Prover) updateActiveEnclaveKeyIfNeeded(ctx context.Context) (bool, error) {
if err := pr.initServiceClient(); err != nil {
return false, err
}
now := time.Now()
// 1. check if the active enclave key is missing or expired
if pr.activeEnclaveKey == nil {
// load last key if exists
lastEnclaveKey, err := pr.loadLastEnclaveKey(ctx)
if err == nil {
if !pr.checkUpdateNeeded(ctx, now, lastEnclaveKey) {
pr.activeEnclaveKey = lastEnclaveKey
return false, nil
} else {
log.Printf("last enclave key '0x%x' is found, but needs to be updated", lastEnclaveKey.EnclaveKeyAddress)
}
} else if errors.Is(err, ErrLastEnclaveKeyInfoNotFound) {
log.Printf("last enclave key not found: error=%v", err)
} else {
return false, err
}
} else if !pr.checkUpdateNeeded(ctx, now, pr.activeEnclaveKey) {
return false, nil
}
// 2. query the active enclave key from the LCP service
log.Println("need to get a new enclave key")
eki, err := pr.selectNewEnclaveKey(ctx)
if err != nil {
return false, err
}
log.Printf("selected available enclave key: %#v", eki)
if err := pr.registerEnclaveKey(eki); err != nil {
return false, err
}
// TODO should we wait for the block that contains a tx to be finalized?
log.Printf("enclave key successfully registered: %#v", eki)
if err := pr.saveLastEnclaveKey(ctx, eki); err != nil {
return false, err
}
pr.activeEnclaveKey = eki
return true, nil
}
// selectNewEnclaveKey selects a new enclave key from the LCP service
func (pr *Prover) selectNewEnclaveKey(ctx context.Context) (*enclave.EnclaveKeyInfo, error) {
res, err := pr.lcpServiceClient.AvailableEnclaveKeys(ctx, &enclave.QueryAvailableEnclaveKeysRequest{Mrenclave: pr.config.GetMrenclave()})
if err != nil {
return nil, err
} else if len(res.Keys) == 0 {
return nil, fmt.Errorf("no available enclave keys")
}
for _, eki := range res.Keys {
if err := ias.VerifyReport(eki.Report, eki.Signature, eki.SigningCert, time.Now()); err != nil {
return nil, err
}
avr, err := ias.ParseAndValidateAVR(eki.Report)
if err != nil {
return nil, err
}
if !pr.validateISVEnclaveQuoteStatus(avr.ISVEnclaveQuoteStatus) {
log.Printf("key '%x' is not allowed to use because of ISVEnclaveQuoteStatus: %v", eki.EnclaveKeyAddress, avr.ISVEnclaveQuoteStatus)
continue
}
if !pr.validateAdvisoryIDs(avr.AdvisoryIDs) {
log.Printf("key '%x' is not allowed to use because of advisory IDs: %v", eki.EnclaveKeyAddress, avr.AdvisoryIDs)
continue
}
return eki, nil
}
return nil, fmt.Errorf("no available enclave keys: all keys are not allowed to use")
}
func (pr *Prover) validateISVEnclaveQuoteStatus(s oias.ISVEnclaveQuoteStatus) bool {
if s == oias.QuoteOK {
return true
}
for _, status := range pr.config.AllowedQuoteStatuses {
if s.String() == status {
return true
}
}
return false
}
func (pr *Prover) validateAdvisoryIDs(ids []string) bool {
if len(ids) == 0 {
return true
}
allowedSet := mapset.NewSet(pr.config.AllowedAdvisoryIds...)
targetSet := mapset.NewSet(ids...)
return targetSet.Difference(allowedSet).Cardinality() == 0
}
func (pr *Prover) syncUpstreamHeader(includeState bool) ([]*elc.MsgUpdateClientResponse, error) {
// 1. check if the latest height of the client is less than the given height
res, err := pr.lcpServiceClient.Client(context.TODO(), &elc.QueryClientRequest{ClientId: pr.config.ElcClientId})
if err != nil {
return nil, err
}
latestHeader, err := pr.originProver.GetLatestFinalizedHeader()
if err != nil {
return nil, err
}
var clientState ibcexported.ClientState
if err := pr.codec.UnpackAny(res.ClientState, &clientState); err != nil {
return nil, err
}
if clientState.GetLatestHeight().GTE(latestHeader.GetHeight()) {
return nil, nil
}
log.Printf("syncUpstreamHeader try to update the client in ELC: latest=%v got=%v", clientState.GetLatestHeight(), latestHeader.GetHeight())
// 2. query the header from the upstream chain
headers, err := pr.originProver.SetupHeadersForUpdate(NewLCPQuerier(pr.lcpServiceClient, pr.config.ElcClientId), latestHeader)
if err != nil {
return nil, err
}
if len(headers) == 0 {
return nil, nil
}
// 3. send a request that contains a header from 2 to update the client in ELC
var responses []*elc.MsgUpdateClientResponse
for _, header := range headers {
anyHeader, err := clienttypes.PackClientMessage(header)
if err != nil {
return nil, err
}
res, err := pr.lcpServiceClient.UpdateClient(context.TODO(), &elc.MsgUpdateClient{
ClientId: pr.config.ElcClientId,
Header: anyHeader,
IncludeState: includeState,
Signer: pr.activeEnclaveKey.EnclaveKeyAddress,
})
if err != nil {
return nil, err
}
responses = append(responses, res)
}
return responses, nil
}
func (pr *Prover) registerEnclaveKey(eki *enclave.EnclaveKeyInfo) error {
if err := ias.VerifyReport(eki.Report, eki.Signature, eki.SigningCert, time.Now()); err != nil {
return err
}
if _, err := ias.ParseAndValidateAVR(eki.Report); err != nil {
return err
}
message := &lcptypes.RegisterEnclaveKeyMessage{
Report: eki.Report,
Signature: eki.Signature,
SigningCert: eki.SigningCert,
}
signer, err := pr.originChain.GetAddress()
if err != nil {
return err
}
msg, err := clienttypes.NewMsgUpdateClient(pr.path.ClientID, message, signer.String())
if err != nil {
return err
}
if _, err := pr.originChain.SendMsgs([]sdk.Msg{msg}); err != nil {
return err
}
return nil
}
func activateClient(pathEnd *core.PathEnd, src, dst *core.ProvableChain) error {
srcProver := src.Prover.(*Prover)
if err := srcProver.ensureAvailableEnclaveKeyExists(context.TODO()); err != nil {
return err
}
// 1. LCP synchronises with the latest header of the upstream chain
updates, err := srcProver.syncUpstreamHeader(true)
if err != nil {
return err
}
signer, err := dst.Chain.GetAddress()
if err != nil {
return err
}
// 2. Create a `MsgUpdateClient`s to apply to the LCP Client with the results of 1.
var msgs []sdk.Msg
for _, update := range updates {
message := &lcptypes.UpdateClientMessage{
Commitment: update.Commitment,
Signer: update.Signer,
Signature: update.Signature,
}
if err := message.ValidateBasic(); err != nil {
return err
}
msg, err := clienttypes.NewMsgUpdateClient(pathEnd.ClientID, message, signer.String())
if err != nil {
return err
}
msgs = append(msgs, msg)
}
// 3. Submit the msgs to the LCP Client
if _, err := dst.SendMsgs(msgs); err != nil {
return err
}
return nil
}
type LCPQuerier struct {
serviceClient LCPServiceClient
clientID string
}
var _ core.ChainInfoICS02Querier = (*LCPQuerier)(nil)
func NewLCPQuerier(serviceClient LCPServiceClient, clientID string) LCPQuerier {
return LCPQuerier{
serviceClient: serviceClient,
clientID: clientID,
}
}
func (q LCPQuerier) ChainID() string {
return "lcp"
}
// LatestHeight returns the latest height of the chain
func (q LCPQuerier) LatestHeight() (ibcexported.Height, error) {
return clienttypes.ZeroHeight(), nil
}
// QueryClientState returns the client state of dst chain
// height represents the height of dst chain
func (q LCPQuerier) QueryClientState(ctx core.QueryContext) (*clienttypes.QueryClientStateResponse, error) {
res, err := q.serviceClient.Client(ctx.Context(), &elc.QueryClientRequest{ClientId: q.clientID})
if err != nil {
return nil, err
}
return &clienttypes.QueryClientStateResponse{
ClientState: res.ClientState,
}, nil
}
// QueryClientConsensusState retrevies the latest consensus state for a client in state at a given height
func (q LCPQuerier) QueryClientConsensusState(ctx core.QueryContext, dstClientConsHeight ibcexported.Height) (*clienttypes.QueryConsensusStateResponse, error) {
// TODO add query_client_consensus support to ecall-handler
panic("not implemented error")
}