generated from TBD54566975/tbd-project-template
-
Notifications
You must be signed in to change notification settings - Fork 55
/
service.go
218 lines (189 loc) · 6.73 KB
/
service.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
package keystore
import (
"context"
"fmt"
"time"
"github.com/TBD54566975/ssi-sdk/crypto"
sdkutil "github.com/TBD54566975/ssi-sdk/util"
"github.com/mr-tron/base58"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/tbd54566975/ssi-service/internal/keyaccess"
"golang.org/x/crypto/chacha20poly1305"
"github.com/tbd54566975/ssi-service/config"
"github.com/tbd54566975/ssi-service/internal/util"
"github.com/tbd54566975/ssi-service/pkg/service/framework"
"github.com/tbd54566975/ssi-service/pkg/storage"
)
type Service struct {
storage *Storage
config config.KeyStoreServiceConfig
}
func (s Service) Type() framework.Type {
return framework.KeyStore
}
func (s Service) Status() framework.Status {
ae := sdkutil.NewAppendError()
if s.storage == nil {
ae.AppendString("no storage configured")
}
if !ae.IsEmpty() {
return framework.Status{
Status: framework.StatusNotReady,
Message: fmt.Sprintf("key store service is not ready: %s", ae.Error().Error()),
}
}
return framework.Status{Status: framework.StatusReady}
}
func (s Service) Config() config.KeyStoreServiceConfig {
return s.config
}
// NewKeyStoreFromKeystoreStorage uses a keystore service directly from storage object
func NewKeyStoreFromKeystoreStorage(config config.KeyStoreServiceConfig, keyStoreStorage *Storage) (*Service, error) {
if keyStoreStorage == nil {
return nil, errors.New("no storage provided")
}
service := Service{
storage: keyStoreStorage,
config: config,
}
if !service.Status().IsReady() {
return nil, errors.New(service.Status().Message)
}
return &service, nil
}
func NewKeyStoreService(config config.KeyStoreServiceConfig, s storage.ServiceStorage) (*Service, error) {
// First, generate a service key
serviceKey, serviceKeySalt, err := GenerateServiceKey(config.ServiceKeyPassword)
if err != nil {
return nil, util.LoggingErrorMsg(err, "could not generate service key")
}
// Next, instantiate the key storage
keyStoreStorage, err := NewKeyStoreStorage(s, ServiceKey{
Base58Key: serviceKey,
Base58Salt: serviceKeySalt,
})
if err != nil {
return nil, util.LoggingErrorMsg(err, "could not instantiate storage for the keystore service")
}
service := Service{
storage: keyStoreStorage,
config: config,
}
if !service.Status().IsReady() {
return nil, errors.New(service.Status().Message)
}
return &service, nil
}
func (s Service) StoreKey(ctx context.Context, request StoreKeyRequest) error {
logrus.Debugf("storing key: %+v", request)
// check if the provided key type is supported. support entails being able to serialize/deserialize, in addition
// to facilitating signing/verification and encryption/decryption support.
if !crypto.IsSupportedKeyType(request.Type) {
return util.LoggingNewErrorf("unsupported key type: %s", request.Type)
}
key := StoredKey{
ID: request.ID,
Controller: request.Controller,
KeyType: request.Type,
Base58Key: request.PrivateKeyBase58,
CreatedAt: time.Now().Format(time.RFC3339),
}
if err := s.storage.StoreKey(ctx, key); err != nil {
return util.LoggingErrorMsgf(err, "could not store key: %s", request.ID)
}
return nil
}
func (s Service) GetKey(ctx context.Context, request GetKeyRequest) (*GetKeyResponse, error) {
logrus.Debugf("getting key: %+v", request)
id := request.ID
gotKey, err := s.storage.GetKey(ctx, id)
if err != nil {
return nil, util.LoggingErrorMsgf(err, "could not get key for key: %s", id)
}
if gotKey == nil {
return nil, util.LoggingErrorMsgf(err, "key with id<%s> could not be found", id)
}
// deserialize the key before returning
keyBytes, err := base58.Decode(gotKey.Base58Key)
if err != nil {
return nil, util.LoggingErrorMsg(err, "could not deserialize key from base58")
}
privKey, err := crypto.BytesToPrivKey(keyBytes, gotKey.KeyType)
if err != nil {
return nil, util.LoggingErrorMsg(err, "could not reconstruct private key from storage")
}
return &GetKeyResponse{
ID: gotKey.ID,
Type: gotKey.KeyType,
Controller: gotKey.Controller,
Key: privKey,
CreatedAt: gotKey.CreatedAt,
}, nil
}
func (s Service) GetKeyDetails(ctx context.Context, request GetKeyDetailsRequest) (*GetKeyDetailsResponse, error) {
logrus.Debugf("getting key: %+v", request)
id := request.ID
gotKeyDetails, err := s.storage.GetKeyDetails(ctx, id)
if err != nil {
return nil, util.LoggingErrorMsgf(err, "could not get key details for key: %s", id)
}
if gotKeyDetails == nil {
return nil, util.LoggingErrorMsgf(err, "key with id<%s> could not be found", id)
}
return &GetKeyDetailsResponse{
ID: gotKeyDetails.ID,
Type: gotKeyDetails.KeyType,
Controller: gotKeyDetails.Controller,
CreatedAt: gotKeyDetails.CreatedAt,
}, nil
}
// GenerateServiceKey using argon2 for key derivation generate a service key and corresponding salt,
// base58 encoding both values.
func GenerateServiceKey(skPassword string) (key, salt string, err error) {
saltBytes, err := util.GenerateSalt(util.Argon2SaltSize)
if err != nil {
err = errors.Wrap(err, "could not generate salt for service key")
return "", "", util.LoggingError(err)
}
keyBytes, err := util.Argon2KeyGen(skPassword, saltBytes, chacha20poly1305.KeySize)
if err != nil {
err = errors.Wrap(err, "could not generate key for service key")
return "", "", util.LoggingError(err)
}
key = base58.Encode(keyBytes)
salt = base58.Encode(saltBytes)
return
}
// EncryptKey encrypts another key with the service key using xchacha20-poly1305
func EncryptKey(serviceKey, key []byte) ([]byte, error) {
encryptedKey, err := util.XChaCha20Poly1305Encrypt(serviceKey, key)
if err != nil {
return nil, errors.Wrap(err, "could not encrypt key with service key")
}
return encryptedKey, nil
}
// DecryptKey encrypts another key with the service key using xchacha20-poly1305
func DecryptKey(serviceKey, encryptedKey []byte) ([]byte, error) {
decryptedKey, err := util.XChaCha20Poly1305Decrypt(serviceKey, encryptedKey)
if err != nil {
return nil, errors.Wrap(err, "could not decrypt key with service key")
}
return decryptedKey, nil
}
// Sign fetches the key in the store, and uses it to sign data. Data should be json or json-serializable.
func (s Service) Sign(ctx context.Context, keyID string, data any) (*keyaccess.JWT, error) {
gotKey, err := s.GetKey(ctx, GetKeyRequest{ID: keyID})
if err != nil {
return nil, util.LoggingErrorMsgf(err, "could not get key for signing schema for keyID<%s>", keyID)
}
keyAccess, err := keyaccess.NewJWKKeyAccess(gotKey.ID, gotKey.Key)
if err != nil {
return nil, util.LoggingErrorMsgf(err, "could not create key access for signing schema for keyID<%s>", keyID)
}
schemaToken, err := keyAccess.SignJSON(data)
if err != nil {
return nil, util.LoggingErrorMsgf(err, "could not sign schema for keyID<%s>", keyID)
}
return schemaToken, nil
}