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
|
// Copyright (c) 2016 Martin Atkins
// Copyright (c) 2021 LEAP Encryption Access Project
// Permission is hereby granted, free of charge, to any person obtaining a copy of
// this software and associated documentation files (the "Software"), to deal in
// the Software without restriction, including without limitation the rights to
// use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
// of the Software, and to permit persons to whom the Software is furnished to do
// so, subject to the following conditions:
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
package management
import (
"fmt"
"testing"
)
// A key requirement of our event parsing is that it must never cause a
// panic, even if the OpenVPN process sends us malformed garbage.
//
// Therefore most of the tests in here are testing various tortured error
// cases, which are all expected to produce an event object, though the
// contents of that event object will be nonsensical if the OpenVPN server
// sends something nonsensical.
func TestMalformedEvent(t *testing.T) {
testCases := [][]byte{
[]byte(""),
[]byte("HTTP/1.1 200 OK"),
[]byte(" "),
[]byte("\x00"),
}
for i, testCase := range testCases {
event := upgradeEvent(testCase)
var malformed *MalformedEvent
var ok bool
if malformed, ok = event.(*MalformedEvent); !ok {
t.Errorf("test %d got %T; want %T", i, event, malformed)
continue
}
wantString := fmt.Sprintf("Malformed Event %q", testCase)
if gotString := malformed.String(); gotString != wantString {
t.Errorf("test %d String returned %q; want %q", i, gotString, wantString)
}
}
}
func TestUnknownEvent(t *testing.T) {
type TestCase struct {
Input []byte
WantType string
WantBody string
}
testCases := []TestCase{
{
Input: []byte("DUMMY:baz"),
WantType: "DUMMY",
WantBody: "baz",
},
{
Input: []byte("DUMMY:"),
WantType: "DUMMY",
WantBody: "",
},
{
Input: []byte("DUMMY:abc,123,456"),
WantType: "DUMMY",
WantBody: "abc,123,456",
},
}
for i, testCase := range testCases {
event := upgradeEvent(testCase.Input)
var unk *UnknownEvent
var ok bool
if unk, ok = event.(*UnknownEvent); !ok {
t.Errorf("test %d got %T; want %T", i, event, unk)
continue
}
if got, want := unk.Type(), testCase.WantType; got != want {
t.Errorf("test %d Type returned %q; want %q", i, got, want)
}
if got, want := unk.Body(), testCase.WantBody; got != want {
t.Errorf("test %d Body returned %q; want %q", i, got, want)
}
}
}
func TestHoldEvent(t *testing.T) {
testCases := [][]byte{
[]byte("HOLD:"),
[]byte("HOLD:waiting for hold release"),
}
for i, testCase := range testCases {
event := upgradeEvent(testCase)
var hold *HoldEvent
var ok bool
if hold, ok = event.(*HoldEvent); !ok {
t.Errorf("test %d got %T; want %T", i, event, hold)
continue
}
}
}
func TestEchoEvent(t *testing.T) {
type TestCase struct {
Input []byte
WantTimestamp string
WantMessage string
}
testCases := []TestCase{
{
Input: []byte("ECHO:123,foo"),
WantTimestamp: "123",
WantMessage: "foo",
},
{
Input: []byte("ECHO:123,"),
WantTimestamp: "123",
WantMessage: "",
},
{
Input: []byte("ECHO:,foo"),
WantTimestamp: "",
WantMessage: "foo",
},
{
Input: []byte("ECHO:,"),
WantTimestamp: "",
WantMessage: "",
},
{
Input: []byte("ECHO:"),
WantTimestamp: "",
WantMessage: "",
},
}
for i, testCase := range testCases {
event := upgradeEvent(testCase.Input)
var echo *EchoEvent
var ok bool
if echo, ok = event.(*EchoEvent); !ok {
t.Errorf("test %d got %T; want %T", i, event, echo)
continue
}
if got, want := echo.RawTimestamp(), testCase.WantTimestamp; got != want {
t.Errorf("test %d RawTimestamp returned %q; want %q", i, got, want)
}
if got, want := echo.Message(), testCase.WantMessage; got != want {
t.Errorf("test %d Message returned %q; want %q", i, got, want)
}
}
}
func TestStateEvent(t *testing.T) {
type TestCase struct {
Input []byte
WantTimestamp string
WantState string
WantDesc string
WantLocalAddr string
WantRemoteAddr string
}
testCases := []TestCase{
{
Input: []byte("STATE:"),
WantTimestamp: "",
WantState: "",
WantDesc: "",
WantLocalAddr: "",
WantRemoteAddr: "",
},
{
Input: []byte("STATE:,"),
WantTimestamp: "",
WantState: "",
WantDesc: "",
WantLocalAddr: "",
WantRemoteAddr: "",
},
{
Input: []byte("STATE:,,,,"),
WantTimestamp: "",
WantState: "",
WantDesc: "",
WantLocalAddr: "",
WantRemoteAddr: "",
},
{
Input: []byte("STATE:123,CONNECTED,good,172.16.0.1,192.168.4.1"),
WantTimestamp: "123",
WantState: "CONNECTED",
WantDesc: "good",
WantLocalAddr: "172.16.0.1",
WantRemoteAddr: "192.168.4.1",
},
{
Input: []byte("STATE:123,RECONNECTING,SIGHUP,,"),
WantTimestamp: "123",
WantState: "RECONNECTING",
WantDesc: "SIGHUP",
WantLocalAddr: "",
WantRemoteAddr: "",
},
{
Input: []byte("STATE:123,RECONNECTING,SIGHUP,,,extra"),
WantTimestamp: "123",
WantState: "RECONNECTING",
WantDesc: "SIGHUP",
WantLocalAddr: "",
WantRemoteAddr: "",
},
}
for i, testCase := range testCases {
event := upgradeEvent(testCase.Input)
var st *StateEvent
var ok bool
if st, ok = event.(*StateEvent); !ok {
t.Errorf("test %d got %T; want %T", i, event, st)
continue
}
if got, want := st.RawTimestamp(), testCase.WantTimestamp; got != want {
t.Errorf("test %d RawTimestamp returned %q; want %q", i, got, want)
}
if got, want := st.NewState(), testCase.WantState; got != want {
t.Errorf("test %d NewState returned %q; want %q", i, got, want)
}
if got, want := st.Description(), testCase.WantDesc; got != want {
t.Errorf("test %d Description returned %q; want %q", i, got, want)
}
if got, want := st.LocalTunnelAddr(), testCase.WantLocalAddr; got != want {
t.Errorf("test %d LocalTunnelAddr returned %q; want %q", i, got, want)
}
if got, want := st.RemoteAddr(), testCase.WantRemoteAddr; got != want {
t.Errorf("test %d RemoteAddr returned %q; want %q", i, got, want)
}
}
}
func TestByteCountEvent(t *testing.T) {
type TestCase struct {
Input []byte
WantClientId string
WantBytesIn int
WantBytesOut int
}
testCases := []TestCase{
{
Input: []byte("BYTECOUNT:"),
WantClientId: "",
WantBytesIn: 0,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT:123,456"),
WantClientId: "",
WantBytesIn: 123,
WantBytesOut: 456,
},
{
Input: []byte("BYTECOUNT:,"),
WantClientId: "",
WantBytesIn: 0,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT:5,"),
WantClientId: "",
WantBytesIn: 5,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT:,6"),
WantClientId: "",
WantBytesIn: 0,
WantBytesOut: 6,
},
{
Input: []byte("BYTECOUNT:6"),
WantClientId: "",
WantBytesIn: 6,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT:wrong,bad"),
WantClientId: "",
WantBytesIn: 0,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT:1,2,3"),
WantClientId: "",
WantBytesIn: 1,
WantBytesOut: 2,
},
{
// Intentionally malformed BYTECOUNT event sent as BYTECOUNT_CLI
Input: []byte("BYTECOUNT_CLI:123,456"),
WantClientId: "123",
WantBytesIn: 456,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT_CLI:"),
WantClientId: "",
WantBytesIn: 0,
WantBytesOut: 0,
},
{
Input: []byte("BYTECOUNT_CLI:abc123,123,456"),
WantClientId: "abc123",
WantBytesIn: 123,
WantBytesOut: 456,
},
{
Input: []byte("BYTECOUNT_CLI:abc123,123"),
WantClientId: "abc123",
WantBytesIn: 123,
WantBytesOut: 0,
},
}
for i, testCase := range testCases {
event := upgradeEvent(testCase.Input)
var bc *ByteCountEvent
var ok bool
if bc, ok = event.(*ByteCountEvent); !ok {
t.Errorf("test %d got %T; want %T", i, event, bc)
continue
}
if got, want := bc.ClientId(), testCase.WantClientId; got != want {
t.Errorf("test %d ClientId returned %q; want %q", i, got, want)
}
if got, want := bc.BytesIn(), testCase.WantBytesIn; got != want {
t.Errorf("test %d BytesIn returned %d; want %d", i, got, want)
}
if got, want := bc.BytesOut(), testCase.WantBytesOut; got != want {
t.Errorf("test %d BytesOut returned %d; want %d", i, got, want)
}
}
}
|
