-
Notifications
You must be signed in to change notification settings - Fork 1
/
path_instances.go
306 lines (239 loc) · 9.36 KB
/
path_instances.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
package benigma
import (
"bytes"
"context"
"encoding/gob"
"strings"
"github.com/emedvedev/enigma"
"github.com/hashicorp/go-hclog"
"github.com/hashicorp/vault/sdk/framework"
"github.com/hashicorp/vault/sdk/logical"
)
func (b *enigmaBackend) getPathForInstances() *framework.Path {
return &framework.Path{
Pattern: "instances/?$",
Operations: map[logical.Operation]framework.OperationHandler{
logical.ListOperation: &framework.PathOperation{
Callback: b.listInstances,
Summary: "List the available Enigma machine instances",
},
},
HelpSynopsis: `List individual instances of Enigma machines.`,
}
}
func (b *enigmaBackend) getPathForInstanceOperations() *framework.Path {
return &framework.Path{
Pattern: "instances/" + framework.GenericNameRegex("id") + "$",
Fields: map[string]*framework.FieldSchema{
"id": {
Type: framework.TypeString,
Description: "The id of the Enigma model instance you are creating. Must be unique. Think of it as a machine's serial number.",
},
"keyboard": {
Type: framework.TypeString,
Description: "The text that is typed on the Enigma machine's keyboard.",
},
},
Operations: map[logical.Operation]framework.OperationHandler{
logical.ReadOperation: &framework.PathOperation{
Callback: b.readInstance,
Summary: "Returns the state of an Enigma machine instance",
},
logical.DeleteOperation: &framework.PathOperation{
Callback: b.deleteInstance,
Summary: "Deletes an instance of an Enigma machine instance",
},
logical.UpdateOperation: &framework.PathOperation{
Callback: b.encodeText,
Summary: "Encodes (encrypts or decrypts) text with this Enigma machine instance",
},
},
HelpSynopsis: `Operations on an individual instance of an Enigma machine.`,
HelpDescription: `This path is used to actually use an Enigma machines to encrypt (or decrypt) text. The state
of the machine is saved across invocations, as if you are communicating with someone on the other end.`,
}
}
func (b *enigmaBackend) getPathForInstanceCreation() *framework.Path {
return &framework.Path{
Pattern: "models/" + framework.GenericNameRegex("model") + "/instance/?$",
Fields: map[string]*framework.FieldSchema{
"model": {
Type: framework.TypeString,
Description: "The name of the Enigma model you want to produce an instance of.",
},
"id": {
Type: framework.TypeString,
Description: "The id of the Enigma model instance you are creating. Must be unique. Think of it as a machine's serial number.",
},
},
Operations: map[logical.Operation]framework.OperationHandler{
logical.CreateOperation: &framework.PathOperation{
Callback: b.createInstance,
Summary: "Process some text through this Engima instance. Will either encrypt or decrypt, depending on what you send it",
},
logical.UpdateOperation: &framework.PathOperation{
Callback: b.createInstance,
Summary: "Process some text through this Engima instance. Will either encrypt or decrypt, depending on what you send it",
},
},
HelpSynopsis: `Factory of individual instances of a given Enigma machine model`,
HelpDescription: `This path is used to create (and list) working copies of the Enigma machines, as if they were to be dispached to the
theater of operations. An instance will retain its state across Vault restart. Typically, the sender and
receiver of an encrypted message will each have an instance of the same model.`,
}
}
func (b *enigmaBackend) listInstances(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
entries, err := req.Storage.List(ctx, "instances/")
if err != nil {
return nil, err
}
return logical.ListResponse(entries), nil
}
func serializeEnigmaInstance(machine *enigma.Enigma, logger hclog.Logger) ([]byte, error) {
buf := &bytes.Buffer{}
enc := gob.NewEncoder(buf)
err := enc.Encode(machine)
if err != nil {
logger.Error("Unable to serialize enigma instnace", "len", buf.Len(), "error", err)
}
return buf.Bytes(), err
}
func deserializeEnigmaInstance(raw []byte) (*enigma.Enigma, error) {
var machine enigma.Enigma
b := bytes.Buffer{}
b.Write(raw)
d := gob.NewDecoder(&b)
err := d.Decode(&machine)
return &machine, err
}
func getStatefulInstanceFromStorage(id string, ctx context.Context, req *logical.Request, logger hclog.Logger) (*statefulInstanceEntry, error) {
logger.Trace("Looking for instance", "id", id)
jsonEntry, err := req.Storage.Get(ctx, "instances/"+id)
if err != nil {
logger.Error("Instance not found in cache", "id", id)
return nil, err
}
var instance statefulInstanceEntry
err = jsonEntry.DecodeJSON(&instance)
if err != nil {
logger.Error("Unable to deserialize instance found in cache")
return nil, err
}
return &instance, err
}
func (b *enigmaBackend) createInstance(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
model := data.Get("model").(string)
id := data.Get("id").(string)
original, exists := builtinModels[model]
if !exists {
return logical.ErrorResponse("Cannot only create instances of builtin models (for now)"), logical.ErrInvalidRequest
}
state, err := serializeEnigmaInstance(original, b.Logger())
if err != nil {
//Should really be an error 500 here, it is not the client's fault
return logical.ErrorResponse("Cannot create instances of builtin model"), logical.ErrInvalidRequest
}
instance := &statefulInstanceEntry{
instanceEntry: instanceEntry{
Model: model,
Id: id,
},
State: state,
Steps: 0,
}
// Convert the model to JSON to store it
jsonEntry, err := logical.StorageEntryJSON("instances/"+id, instance)
if err != nil {
return nil, err
}
/* The Value field of the jsonEntry blob looks like this (with id=z)
Offset(h) 00 01 02 03 04 05 06 07 08 09 0A 0B 0C 0D 0E 0F
-- -- -- -- -- -- -- -- -- -- -- -- -- -- -- --
00000000 7B 22 6D 6F 64 65 6C 22 3A 22 49 22 2C 22 69 64 {"model":"I","id
00000010 22 3A 22 7A 22 2C 22 73 74 61 74 65 22 3A 22 50 ":"z","state":"P
00000020 76 2B 42 41 77 45 42 42 6B 56 75 61 57 64 74 59 v+BAwEBBkVuaWdtY
00000030 51 48 2F 67 67 41 42 41 77 45 4A 55 6D 56 6D 62 QH/ggABAwEJUmVmb
*/
if err := req.Storage.Put(ctx, jsonEntry); err != nil {
return nil, err
}
return nil, nil
}
func (b *enigmaBackend) readInstance(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
id := data.Get("id").(string)
instance, err := getStatefulInstanceFromStorage(id, ctx, req, b.Logger())
if err != nil {
return logical.ErrorResponse("Unable to find or deserialize instance " + id), logical.ErrInvalidRequest
}
b.Logger().Debug("Returning instance", "model", instance.Model, "id", instance.Id)
return &logical.Response{
Data: map[string]interface{}{
"model": instance.Model,
"id": instance.Id,
"steps": instance.Steps,
},
}, nil
}
func (b *enigmaBackend) deleteInstance(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
id := data.Get("id").(string)
if err := req.Storage.Delete(ctx, "instances/"+id); err != nil {
b.Logger().Error("An error occured trying to delete the instance")
return logical.ErrorResponse("An error occured trying to delete the instance"), err
}
return nil, nil
}
func (b *enigmaBackend) encodeText(ctx context.Context, req *logical.Request, data *framework.FieldData) (*logical.Response, error) {
id := data.Get("id").(string)
instance, err := getStatefulInstanceFromStorage(id, ctx, req, b.Logger())
if err != nil {
return logical.ErrorResponse("Unable to read state of cached instance " + id), logical.ErrInvalidRequest
}
machine, err := deserializeEnigmaInstance(instance.State)
if err != nil {
b.Logger().Error("Deserialization failed", id, err)
return logical.ErrorResponse("Instance " + id + " has inconsistent state"), logical.ErrInvalidRequest
}
keyboard := data.Get("keyboard").(string)
if keyboard == "" {
b.Logger().Error("Nothing was typed on the keyboard")
return logical.ErrorResponse("The field keyboard is mandatory for processing"), logical.ErrInvalidRequest
}
uppercase := strings.ToUpper(keyboard)
sanitized := enigma.SanitizePlaintext(uppercase)
var warning []string
if uppercase != sanitized {
warning = make([]string, 1)
warning[0] = "Unsupported non-alphabetic characters removed from string"
b.Logger().Warn(warning[0])
}
lights := machine.EncodeString(sanitized)
b.Logger().Trace("Keyboard processed succesfully", "id", id)
state, err := serializeEnigmaInstance(machine, b.Logger())
instance.Steps = instance.Steps + len(keyboard)
instance.State = state
// Convert the model to JSON to store it
jsonEntry, err := logical.StorageEntryJSON("instances/"+id, instance)
if err != nil {
b.Logger().Error("Can't convert instance to JSON")
return logical.ErrorResponse("Internal error, can't convert instance to JSON"), err
}
if err := req.Storage.Put(ctx, jsonEntry); err != nil {
b.Logger().Error("Can't persist JSON instance")
return logical.ErrorResponse("Internal error, can't perstit JSON instance"), err
}
return &logical.Response{
Data: map[string]interface{}{
"lights": lights,
},
Warnings: warning,
}, nil
}
type instanceEntry struct {
Model string `json:"model"`
Id string `json:"id"`
}
type statefulInstanceEntry struct {
instanceEntry
State []byte `json:"state"`
Steps int `json:"steps"`
}